This product is not supported for your selected Datadog site. ().
This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

aws_apigateway_usageplan

account_id

Type: STRING

api_stages

Type: UNORDERED_LIST_STRUCT
Provider name: apiStages
Description: The associated API stages of a usage plan.

  • api_id
    Type: STRING
    Provider name: apiId
    Description: API Id of the associated API stage in a usage plan.
  • stage
    Type: STRING
    Provider name: stage
    Description: API stage name of the associated API stage in a usage plan.
  • throttle
    Type: STRING
    Provider name: throttle
    Description: Map containing method level throttling information for API stage in a usage plan.

description

Type: STRING
Provider name: description
Description: The description of a usage plan.

id

Type: STRING
Provider name: id
Description: The identifier of a UsagePlan resource.

name

Type: STRING
Provider name: name
Description: The name of a usage plan.

product_code

Type: STRING
Provider name: productCode
Description: The Amazon Web Services Marketplace product identifier to associate with the usage plan as a SaaS product on the Amazon Web Services Marketplace.

quota

Type: STRUCT
Provider name: quota
Description: The target maximum number of permitted requests per a given unit time interval.

  • limit
    Type: INT32
    Provider name: limit
    Description: The target maximum number of requests that can be made in a given time period.
  • offset
    Type: INT32
    Provider name: offset
    Description: The number of requests subtracted from the given limit in the initial time period.
  • period
    Type: STRING
    Provider name: period
    Description: The time period in which the limit applies. Valid values are “DAY”, “WEEK” or “MONTH”.

tags

Type: UNORDERED_LIST_STRING

throttle

Type: STRUCT
Provider name: throttle
Description: A map containing method level throttling information for API stage in a usage plan.

  • burst_limit
    Type: INT32
    Provider name: burstLimit
    Description: The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
  • rate_limit
    Type: DOUBLE
    Provider name: rateLimit
    Description: The API target request rate limit.