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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetUsagePlansRequest

Includes:

Structure

Defined in:

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key_id ⇒ String

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

• #limit ⇒ Integer

  The maximum number of returned results per page.

• #position ⇒ String

  The current pagination position in the paged result set.

Instance Attribute Details

#key_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4336

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

#limit ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-apigateway/types.rb', line 4336

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

#position ⇒ String

The current pagination position in the paged result set.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 4336

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