Skip to content

Get Usage Plan Key

apigateway_get_usage_plan_key R Documentation

Gets a usage plan key of a given key identifier

Description

Gets a usage plan key of a given key identifier.

Usage

apigateway_get_usage_plan_key(usagePlanId, keyId)

Arguments

usagePlanId

[required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

keyId

[required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

Value

A list with the following syntax:

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

Request syntax

svc$get_usage_plan_key(
  usagePlanId = "string",
  keyId = "string"
)