CmdID / aws / aws apigateway

aws apigateway create-usage-plan

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

1 example 6 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a usage plan with throttle and quota limits that resets at the beginning of the month

The following create-usage-plan example creates a usage plan with throttle and quota limits that resets at the beginning of the month.

aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH

Identify

--nameThe name of the usage plan.

--descriptionThe description of the usage plan.

--throttleThe throttling limits of the usage plan.

--quotaThe quota of the usage plan.

Its output

{
    "id": "a1b2c3",
    "name": "New Usage Plan",
    "description": "A new usage plan",
    "apiStages": [],
    "throttle": {
        "burstLimit": 10,
        "rateLimit": 5.0
    },
    "quota": {
        "limit": 500,
        "offset": 0,
        "period": "MONTH"
    }
}

For more information, see Set up usage plans for REST APIs in API Gateway in the Amazon API Gateway Developer Guide.

Options

6 in the AWS CLI reference

--api-stagesThe associated API stages of the usage plan.

--descriptionThe description of the usage plan.

--nameThe name of the usage plan.

--quotaThe quota of the usage plan.

--tagsThe key-value map of strings.

--throttleThe throttling limits of the usage plan.