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

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

Overview

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

#limitInteger

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

Returns:

  • (Integer)


3047
3048
3049
3050
3051
3052
3053
3054
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3047

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

#name_queryString

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

Returns:

  • (String)


3047
3048
3049
3050
3051
3052
3053
3054
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3047

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3047
3048
3049
3050
3051
3052
3053
3054
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3047

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


3047
3048
3049
3050
3051
3052
3053
3054
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3047

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