GatewayResponse¶
Structure Class¶
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.