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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)


3577
3578
3579
3580
3581
3582
3583
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3577

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

#name_queryString

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

Returns:

  • (String)


3577
3578
3579
3580
3581
3582
3583
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3577

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3577
3578
3579
3580
3581
3582
3583
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3577

class GetUsagePlanKeysRequest < Struct.new(
  :usage_plan_id,
  :position,
  :limit,
  :name_query)
  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)


3577
3578
3579
3580
3581
3582
3583
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3577

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