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

Class: Aws::APIGateway::Types::GetUsagePlansRequest

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 GetUsagePlansRequest data as a hash:

{
  position: "String",
  key_id: "String",
  limit: 1,
}

The GET request to get all the usage plans of the caller's account.

Instance Attribute Summary collapse

Instance Attribute Details

#key_idString

The identifier of the API key associated with the usage plans.

Returns:

  • (String)


3554
3555
3556
3557
3558
3559
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3554

class GetUsagePlansRequest < Struct.new(
  :position,
  :key_id,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)


3554
3555
3556
3557
3558
3559
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3554

class GetUsagePlansRequest < Struct.new(
  :position,
  :key_id,
  :limit)
  include Aws::Structure
end

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


3554
3555
3556
3557
3558
3559
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 3554

class GetUsagePlansRequest < Struct.new(
  :position,
  :key_id,
  :limit)
  include Aws::Structure
end