Skip to content

GatewayResponse

Source code in docs_src/capo_api_gateway/types/gateway_response.py
class GatewayResponse(TypedDict, closed=True):
    response_type: NotRequired[
        "capo_api_gateway.types.gateway_response_type.GatewayResponseType"
    ]
    """<p>The response type of the associated GatewayResponse.</p>"""
    status_code: NotRequired["capo_api_gateway.types.status_code.StatusCode"]
    """<p>The HTTP status code for this GatewayResponse.</p>"""
    response_parameters: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.</p>"""
    response_templates: NotRequired[
        "capo_api_gateway.types.map_of_string_to_string.MapOfStringToString"
    ]
    """<p>Response templates of the GatewayResponse as a string-to-string map of key-value pairs.</p>"""
    default_response: "capo_api_gateway.types.boolean.Boolean"
    """<p>A Boolean flag to indicate whether this GatewayResponse is the default gateway response (<code>true</code>) or not (<code>false</code>). A default gateway response is one generated by API Gateway without any customization by an API developer. </p>"""

default_response instance-attribute

default_response: Boolean

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 instance-attribute

response_parameters: NotRequired[MapOfStringToString]

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

response_templates instance-attribute

response_templates: NotRequired[MapOfStringToString]

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

response_type instance-attribute

response_type: NotRequired[GatewayResponseType]

The response type of the associated GatewayResponse.

status_code instance-attribute

status_code: NotRequired[StatusCode]

The HTTP status code for this GatewayResponse.