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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetGatewayResponsesRequest as input to an Aws::Client method, you can use a vanilla 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 collapse

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) —

    The maximum number of returned results per page.

#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) —

    The current pagination position in the paged result set.

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.