Get Usage Plan Keys

apigateway_get_usage_plan_keys

R Documentation

Gets all the usage plan keys representing the API keys added to a specified usage plan¶

Description¶

Gets all the usage plan keys representing the API keys added to a specified usage plan.

Usage¶

apigateway_get_usage_plan_keys(usagePlanId, position, limit, nameQuery)

Arguments¶

usagePlanId: [required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
position: The current pagination position in the paged result set.
limit: The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
nameQuery: A query parameter specifying the name of the to-be-returned usage plan keys.

Value¶

A list with the following syntax:

list(
  position = "string",
  items = list(
    list(
      id = "string",
      type = "string",
      value = "string",
      name = "string"
    )
  )
)

Request syntax¶

svc$get_usage_plan_keys(
  usagePlanId = "string",
  position = "string",
  limit = 123,
  nameQuery = "string"
)