ExAws.ApiGateway v0.9.2 ExAws.ApiGateway View Source
Operations on ExAws ApiGateway
Read more on AWS Gateway API : Official documentation
Examples
See some examples
Getting all the ApiKeys resource
iex> ExAws.ApiGateway.get_apis_keys() |> ExAws.request(region: @region)
{:ok,
[
%ExAws.ApiGateway.UsagePlan{
api_stages: %{"apiId" => "...", "stage" => "dev", "throttle" => nil},
description: nil,
id: "...",
name: "Basic",
quota: %{"limit" => 10000000, "offset" => 0, "period" => "MONTH"},
throttle: nil
},
...
]}
Link to this section Summary
Functions
Associate an existing API key to the specified usage plan
Create a new api key
Get all API keys
Get all APIs
Get all usage plans
Get usage for specific api key
Link to this section Types
Link to this type
associate_usage_plan_opts() View Source
Link to this type
create_apis_keys_opts() View Source
Link to this type
usage_by_api_key_opts() View Source
Link to this section Functions
Link to this function
associate_usage_plan(data)
View Source
associate_usage_plan(data)
View Source
associate_usage_plan(data :: associate_usage_plan_opts()) ::
ExAws.Operation.JSON.t()
associate_usage_plan(data :: associate_usage_plan_opts()) :: ExAws.Operation.JSON.t()
Associate an existing API key to the specified usage plan
Link to this function
create_apis_keys(data)
View Source
create_apis_keys(data)
View Source
create_apis_keys(data :: create_apis_keys_opts()) :: ExAws.Operation.JSON.t()
create_apis_keys(data :: create_apis_keys_opts()) :: ExAws.Operation.JSON.t()
Create a new api key
Link to this function
get_apis_keys()
View Source
get_apis_keys()
View Source
get_apis_keys() :: ExAws.Operation.JSON.t()
get_apis_keys() :: ExAws.Operation.JSON.t()
Get all API keys
Link to this function
get_rest_apis()
View Source
get_rest_apis()
View Source
get_rest_apis() :: ExAws.Operation.JSON.t()
get_rest_apis() :: ExAws.Operation.JSON.t()
Get all APIs
Link to this function
get_usage_plans()
View Source
get_usage_plans()
View Source
get_usage_plans() :: ExAws.Operation.JSON.t()
get_usage_plans() :: ExAws.Operation.JSON.t()
Get all usage plans
Link to this function
usage_by_api_key(params)
View Source
usage_by_api_key(params)
View Source
usage_by_api_key(params :: usage_by_api_key_opts()) :: ExAws.Operation.JSON.t()
usage_by_api_key(params :: usage_by_api_key_opts()) :: ExAws.Operation.JSON.t()
Get usage for specific api key