UsagePlan
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
Links
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):
|
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.
- 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 of0
starts on Sunday, and an offset of1
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.