You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetUsagePlanKeysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetUsagePlanKeysRequest
- Defined in:
- (unknown)
Overview
When passing GetUsagePlanKeysRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
usage_plan_id: "String", # required
position: "String",
limit: 1,
name_query: "String",
}
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
Instance Attribute Summary collapse
-
#limit ⇒ Integer
The maximum number of returned results per page.
-
#name_query ⇒ String
A query parameter specifying the name of the to-be-returned usage plan keys.
-
#position ⇒ String
The current pagination position in the paged result set.
-
#usage_plan_id ⇒ String
[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
Instance Attribute Details
#limit ⇒ Integer
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
#name_query ⇒ String
A query parameter specifying the name of the to-be-returned usage plan keys.
#position ⇒ String
The current pagination position in the paged result set.
#usage_plan_id ⇒ String
[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.