Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14120262383.5 KB

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

post/usageplans

Request body

namestring required

The name of the usage plan.

descriptionstring

The description of the usage plan.

tagsobject

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.

Response

Success

idstring

The identifier of a UsagePlan resource.

namestring

The name of a usage plan.

descriptionstring

The description of a usage plan.

productCodestring

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

tagsobject

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