[ aws . apigateway ]
get-usage-plan¶
Description¶
Gets a usage plan of a given plan identifier.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-usage-plan
--usage-plan-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--usage-plan-id (string)
[Required] The identifier of the UsagePlan resource to be retrieved.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To get the details of a Usage Plan
Command:
aws apigateway get-usage-plan --usage-plan-id a1b2c3
Output¶
id -> (string)
The identifier of a UsagePlan resource.
name -> (string)
The name of a usage plan.
description -> (string)
The description of a usage plan.
apiStages -> (list)
The associated API stages of a usage plan.
(structure)
API stage name of the associated API stage in a usage plan.
apiId -> (string)
API Id of the associated API stage in a usage plan.
stage -> (string)
API stage name of the associated API stage in a usage plan.
throttle -> (map)
Map containing method level throttling information for API stage in a usage plan.
key -> (string)
value -> (structure)
The API request rate limits.
burstLimit -> (integer)
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 -> (double)
The API request steady-state rate limit.
throttle -> (structure)
The request throttle limits of a usage plan.
burstLimit -> (integer)
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 -> (double)
The API request steady-state rate limit.
quota -> (structure)
The maximum number of permitted requests per a given unit time interval.
limit -> (integer)
The maximum number of requests that can be made in a given time period.
offset -> (integer)
The number of requests subtracted from the given limit in the initial time period.
period -> (string)
The time period in which the limit applies. Valid values are “DAY”, “WEEK” or “MONTH”.
productCode -> (string)
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
tags -> (map)
The collection of tags. Each tag element is associated with a given resource.
key -> (string)
value -> (string)