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

Description¶

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

Usage¶

apigateway_create_usage_plan(name, description, apiStages, throttle,
  quota, tags)

Arguments¶

name

[required] The name of the usage plan.
description

The description of the usage plan.
apiStages

The associated API stages of the usage plan.
throttle

The throttling limits of the usage plan.
quota

The quota of the usage plan.
tags

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 aws:. The tag value can be up to 256 characters.

Value¶

A list with the following syntax:

list(
  id = "string",
  name = "string",
  description = "string",
  apiStages = list(
    list(
      apiId = "string",
      stage = "string",
      throttle = list(
        list(
          burstLimit = 123,
          rateLimit = 123.0
        )
      )
    )
  ),
  throttle = list(
    burstLimit = 123,
    rateLimit = 123.0
  ),
  quota = list(
    limit = 123,
    offset = 123,
    period = "DAY"|"WEEK"|"MONTH"
  ),
  productCode = "string",
  tags = list(
    "string"
  )
)

Request syntax¶

svc$create_usage_plan(
  name = "string",
  description = "string",
  apiStages = list(
    list(
      apiId = "string",
      stage = "string",
      throttle = list(
        list(
          burstLimit = 123,
          rateLimit = 123.0
        )
      )
    )
  ),
  throttle = list(
    burstLimit = 123,
    rateLimit = 123.0
  ),
  quota = list(
    limit = 123,
    offset = 123,
    period = "DAY"|"WEEK"|"MONTH"
  ),
  tags = list(
    "string"
  )
)