ExAws.ApiGateway v0.9.4 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

Disassociate an existing API key to the specified usage plan

Gets the ApiKey resource with the specified key identifier

Gets the ApiKeys resource representing the set of ApiKey resources to identify clients for all of your APIs

Gets the RestApis resource representing the collection of RestApi resources for all of your APIs

Gets the UsagePlans resource as the collection of UsagePlan resources of the caller's account

Get usage for specific api key

Link to this section Types

Link to this type

associate_usage_plan_opts() View Source
associate_usage_plan_opts() :: [
  usageplanId: binary(),
  keyId: binary(),
  keyType: binary()
]

Link to this type

create_apis_keys_opts() View Source
create_apis_keys_opts() :: [
  name: binary(),
  description: binary(),
  customerId: binary(),
  enabled: boolean()
]

Link to this type

usage_by_api_key_opts() View Source
usage_by_api_key_opts() :: [
  usageplanId: binary(),
  keyId: binary(),
  startDate: binary(),
  endDate: binary(),
  limit: integer()
]

Link to this section Functions

Link to this function

associate_usage_plan(data) View Source
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 :: create_apis_keys_opts()) :: ExAws.Operation.JSON.t()

Create a new api key

Link to this function

disassociate_usage_plan(data) View Source
disassociate_usage_plan(data :: associate_usage_plan_opts()) ::
  ExAws.Operation.JSON.t()

Disassociate an existing API key to the specified usage plan

Link to this function

get_api_key(keyId) View Source
get_api_key(keyId :: binary()) :: ExAws.Operation.JSON.t()

Gets the ApiKey resource with the specified key identifier.

Gets the ApiKeys resource representing the set of ApiKey resources to identify clients for all of your APIs.

Gets the RestApis resource representing the collection of RestApi resources for all of your APIs.

Link to this function

get_usage_plans() View Source
get_usage_plans() :: ExAws.Operation.JSON.t()

Gets the UsagePlans resource as the collection of UsagePlan resources of the caller's account.

Link to this function

usage_by_api_key(params) View Source
usage_by_api_key(params :: usage_by_api_key_opts()) :: ExAws.Operation.JSON.t()

Get usage for specific api key