Skip to content

CreateRouteResponseRequest

Source code in docs_src/capo_apigatewayv2/types/create_route_response_request.py
class CreateRouteResponseRequest(TypedDict, closed=True):
    api_id: "capo_apigatewayv2.types.__string.__string"
    """<p>The API identifier.</p>"""
    model_selection_expression: NotRequired[
        "capo_apigatewayv2.types.selection_expression.SelectionExpression"
    ]
    """<p>The model selection expression for the route response. Supported only for WebSocket APIs.</p>"""
    response_models: NotRequired["capo_apigatewayv2.types.route_models.RouteModels"]
    """<p>The response models for the route response.</p>"""
    response_parameters: NotRequired[
        "capo_apigatewayv2.types.route_parameters.RouteParameters"
    ]
    """<p>The route response parameters.</p>"""
    route_id: "capo_apigatewayv2.types.__string.__string"
    """<p>The route ID.</p>"""
    route_response_key: NotRequired[
        "capo_apigatewayv2.types.selection_key.SelectionKey"
    ]
    """<p>The route response key.</p>"""

api_id instance-attribute

api_id: __string

The API identifier.

model_selection_expression instance-attribute

model_selection_expression: NotRequired[SelectionExpression]

The model selection expression for the route response. Supported only for WebSocket APIs.

response_models instance-attribute

response_models: NotRequired[RouteModels]

The response models for the route response.

response_parameters instance-attribute

response_parameters: NotRequired[RouteParameters]

The route response parameters.

route_id instance-attribute

route_id: __string

The route ID.

route_response_key instance-attribute

route_response_key: NotRequired[SelectionKey]

The route response key.