Get Usage Plans

apigateway_get_usage_plans

R Documentation

Gets all the usage plans of the caller's account¶

Description¶

Gets all the usage plans of the caller's account.

Usage¶

apigateway_get_usage_plans(position, keyId, limit)

Arguments¶

position

The current pagination position in the paged result set.

keyId

The identifier of the API key associated with the usage plans.

limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Value¶

A list with the following syntax:

list(
  position = "string",
  items = list(
    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_plans(
  position = "string",
  keyId = "string",
  limit = 123
)