You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::GetUsagePlanKeyRequest

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

Overview

Note:

When making an API call, you may pass GetUsagePlanKeyRequest data as a hash:

{
  usage_plan_id: "String", # required
  key_id: "String", # required
}

The GET request to get a usage plan key of a given key identifier.

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

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

Returns:

  • (String)


3467
3468
3469
3470
3471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3467

class GetUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id)
  include Aws::Structure
end

#usage_plan_idString

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

Returns:

  • (String)


3467
3468
3469
3470
3471
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3467

class GetUsagePlanKeyRequest < Struct.new(
  :usage_plan_id,
  :key_id)
  include Aws::Structure
end