put_gateway_response¶
Operation¶
async
¶
put_gateway_response(input: PutGatewayResponseInput, plugins: list[Plugin] | None = None) -> PutGatewayResponseOutput
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutGatewayResponseInput
|
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 |
|---|---|
PutGatewayResponseOutput
|
An instance of |
Input¶
dataclass
¶
Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.
Attributes¶
class-attribute
instance-attribute
¶
response_parameters: dict[str, str] | None = None
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
class-attribute
instance-attribute
¶
response_templates: dict[str, str] | None = None
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
class-attribute
instance-attribute
¶
response_type: GatewayResponseType | None = None
The response type of the associated GatewayResponse
class-attribute
instance-attribute
¶
rest_api_id: str | None = None
The string identifier of the associated RestApi.
class-attribute
instance-attribute
¶
status_code: str | None = None
The HTTP status code of the GatewayResponse.
Output¶
dataclass
¶
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
Attributes¶
class-attribute
instance-attribute
¶
default_response: bool = False
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.
class-attribute
instance-attribute
¶
response_parameters: dict[str, str] | None = None
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
class-attribute
instance-attribute
¶
response_templates: dict[str, str] | None = None
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
class-attribute
instance-attribute
¶
response_type: GatewayResponseType | None = None
The response type of the associated GatewayResponse.
class-attribute
instance-attribute
¶
status_code: str | None = None
The HTTP status code for this GatewayResponse.