Amazon API Gateway REST API Reference

UsagePlan

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.


Relation Description Method Templated
self

A relation that refers to the current resource.

 GET No
usageplan:update

Updates a specified usage plan.

 PATCH No
usageplan:delete

Deletes a specified usage plan.

 DELETE No
usage:get

Gets the usage data of a usage plan in a specified time interval.

This link relation offers the following templated variable(s):

  • keyId: Optional.

    The Id of the API key associated with the resultant usage data.

  • startDate: Required.

    [Required] The starting date (e.g., 2016-01-01) of the usage data.

  • endDate: Required.

    [Required] The ending date (e.g., 2016-12-31) of the usage data.

  • limit: Optional.

    The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

 GET Yes
usageplan:usageplankeys

Gets the collection of UsagePlanKey resources added to associate specified API keys with the given usage plan.

 GET No
usageplankey:create

Creates a UsagePlanKey resource.

 POST No


Properties

{
  "id" : "String",
  "name" : "String",
  "description" : "String",
  "apiStages" : [ {
    "apiId" : "String",
    "stage" : "String",
    "throttle" : {
      "String" : {
        "burstLimit" : "Integer",
        "rateLimit" : "Double"
      }
    }
  } ],
  "throttle" : {
    "burstLimit" : "Integer",
    "rateLimit" : "Double"
  },
  "quota" : {
    "limit" : "Integer",
    "offset" : "Integer",
    "period" : "String"
  },
  "productCode" : "String",
  "tags" : {
    "String" : "String"
  }
}

  • id

  • The identifier of a UsagePlan resource.

  • name

  • The name of a usage plan.

  • description

  • The description of a usage plan.

  • apiStages

  • The associated API stages of a usage plan.

    • apiId

    • API Id of the associated API stage in a usage plan.

    • stage

    • API stage name of the associated API stage in a usage plan.

    • throttle

    • Map containing method level throttling information for API stage in a usage plan.

      • burstLimit

      • The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

      • rateLimit

      • The API request steady-state rate limit.

  • quota

  • The maximum number of permitted requests per a given unit time interval.

  • limit

  • The maximum number of requests that can be made in a given time period.

  • offset

  • The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

  • period

  • The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

  • productCode

  • The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

  • tags

  • The collection of tags. Each tag element is associated with a given resource.

Remarks

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

See Also

Create and Use Usage Plans