UsagePlan
Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using AWS Budgets to monitor costs and AWS WAF to manage API requests.
Contents
- apiStages
-
The associated API stages of a usage plan.
Type: Array of ApiStage objects
Required: No
- description
-
The description of a usage plan.
Type: String
Required: No
- id
-
The identifier of a UsagePlan resource.
Type: String
Required: No
- name
-
The name of a usage plan.
Type: String
Required: No
- productCode
-
The AWS Marketplace product identifier to associate with the usage plan as a SaaS product on the AWS Marketplace.
Type: String
Required: No
- quota
-
The target maximum number of permitted requests per a given unit time interval.
Type: QuotaSettings object
Required: No
-
The collection of tags. Each tag element is associated with a given resource.
Type: String to string map
Required: No
- throttle
-
A map containing method level throttling information for API stage in a usage plan.
Type: ThrottleSettings object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
