get_gateway_responses¶
Operation¶
async
¶
get_gateway_responses(input: GetGatewayResponsesInput, plugins: list[Plugin] | None = None) -> GetGatewayResponsesOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetGatewayResponsesInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetGatewayResponsesOutput
|
An instance of |
Input¶
dataclass
¶
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.
Attributes¶
class-attribute
instance-attribute
¶
limit: int | None = None
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.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
Output¶
dataclass
¶
The collection of the GatewayResponse instances of a RestApi as a
responseType-to-GatewayResponse object map of key-value pairs. As
such, pagination is not supported for querying this collection.
Attributes¶
class-attribute
instance-attribute
¶
items: list[GatewayResponse] | None = None
Returns the entire collection, because of no pagination support.
class-attribute
instance-attribute
¶
position: str | None = None
The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.