Skip to content

GatewayResponse

Structure Class

GatewayResponse 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_parameters class-attribute instance-attribute
response_parameters: dict[str, str] | None = ...

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: dict[str, str] | None = ...

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

response_type class-attribute instance-attribute
response_type: str | None = ...

The response type of the associated GatewayResponse.

status_code class-attribute instance-attribute
status_code: str | None = ...

The HTTP status code for this GatewayResponse.