Class: Aws::APIGateway::Types::GetUsagePlanKeysRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetUsagePlanKeysRequest data as a 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.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#limit ⇒ Integer

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

Returns:

  • (Integer) 


4283
4284
4285
4286
4287
4288
4289
4290
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4283

class GetUsagePlanKeysRequest < Struct.new(
  :usage_plan_id,
  :position,
  :limit,
  :name_query)
  SENSITIVE = []
  include Aws::Structure
end

#name_query ⇒ String

A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4283

class GetUsagePlanKeysRequest < Struct.new(
  :usage_plan_id,
  :position,
  :limit,
  :name_query)
  SENSITIVE = []
  include Aws::Structure
end

#position ⇒ String

The current pagination position in the paged result set.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4283

class GetUsagePlanKeysRequest < Struct.new(
  :usage_plan_id,
  :position,
  :limit,
  :name_query)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


4283
4284
4285
4286
4287
4288
4289
4290
 
# File 'lib/aws-sdk-apigateway/types.rb', line 4283

class GetUsagePlanKeysRequest < Struct.new(
  :usage_plan_id,
  :position,
  :limit,
  :name_query)
  SENSITIVE = []
  include Aws::Structure
end