Get Usage Plan

apigateway_get_usage_plan

R Documentation

Gets a usage plan of a given plan identifier¶

Description¶

Gets a usage plan of a given plan identifier.

Usage¶

apigateway_get_usage_plan(usagePlanId)

Arguments¶

usagePlanId: [required] The identifier of the UsagePlan resource to be retrieved.

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$get_usage_plan(
  usagePlanId = "string"
)