Class: Aws::APIGateway::Types::GetGatewayResponsesRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetGatewayResponsesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

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

{
  rest_api_id: "String", # required
  position: "String",
  limit: 1,
}

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

Instance Attribute Summary

• #limit ⇒ Integer

  The maximum number of returned results per page.

• #position ⇒ String

  The current pagination position in the paged result set.

• #rest_api_id ⇒ String

  [Required] The string identifier of the associated RestApi.

Instance Attribute Details

#limit ⇒ Integer

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

Returns:

• (Integer)

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

class GetGatewayResponsesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end

#position ⇒ String

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

Returns:

• (String)

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

class GetGatewayResponsesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

• (String)

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

class GetGatewayResponsesRequest < Struct.new(
  :rest_api_id,
  :position,
  :limit)
  include Aws::Structure
end