Skip to content

PutGatewayResponseRequest

Source code in docs_src/capo_api_gateway/types/put_gateway_response_request.py
class PutGatewayResponseRequest(TypedDict, closed=True):
    rest_api_id: "capo_api_gateway.types.string.String"
    """<p>The string identifier of the associated RestApi.</p>"""
    response_type: "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 of the 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>"""

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: GatewayResponseType

The response type of the associated GatewayResponse

rest_api_id instance-attribute

rest_api_id: String

The string identifier of the associated RestApi.

status_code instance-attribute

status_code: NotRequired[StatusCode]

The HTTP status code of the GatewayResponse.