get_gateway_response¶
Operation¶
get_gateway_response
¶
get_gateway_response(request: GetGatewayResponseInput | GetGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayResponseInputDict]) -> GetGatewayResponseOutput
Gets a GatewayResponse of a specified response type on the given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayResponseInput | GetGatewayResponseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetGatewayResponseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayResponseOutput
|
An instance of |
get_gateway_response
async
¶
get_gateway_response(request: GetGatewayResponseInput | GetGatewayResponseInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetGatewayResponseInputDict]) -> GetGatewayResponseOutput
Gets a GatewayResponse of a specified response type on the given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetGatewayResponseInput | GetGatewayResponseInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetGatewayResponseInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetGatewayResponseOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetGatewayResponseOutput
dataclass
¶
Bases: _SerdeShape
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Attributes¶
default_response
class-attribute
instance-attribute
¶
default_response: bool = ...
A Boolean flag to indicate whether this GatewayResponse is the default
gateway response (true) or not (false). A default gateway response
is one generated by API Gateway without any customization by an API
developer.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
response_parameters
class-attribute
instance-attribute
¶
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
response_templates
class-attribute
instance-attribute
¶
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.