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

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

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 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 Amazon API Gateway-generated default GatewayResponses collection for the supported response types.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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

Returns:

  • (Integer)


2907
2908
2909
2910
2911
2912
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2907

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

#positionString

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)


2907
2908
2909
2910
2911
2912
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2907

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


2907
2908
2909
2910
2911
2912
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2907

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