ApiGatewayV2 / Client / get_route_response

get_route_response#

ApiGatewayV2.Client.get_route_response(**kwargs)#

Gets a RouteResponse.

See also: AWS API Documentation

Request Syntax

response = client.get_route_response(
    ApiId='string',
    RouteId='string',
    RouteResponseId='string'
)
Parameters:

  • ApiId (string) –

    [REQUIRED]

    The API identifier.

  • RouteId (string) –

    [REQUIRED]

    The route ID.

  • RouteResponseId (string) –

    [REQUIRED]

    The route response ID.

Return type:

dict

Returns:

Response Syntax

{
    'ModelSelectionExpression': 'string',
    'ResponseModels': {
        'string': 'string'
    },
    'ResponseParameters': {
        'string': {
            'Required': True|False
        }
    },
    'RouteResponseId': 'string',
    'RouteResponseKey': 'string'
}

Response Structure

  • (dict) –

    Success

    • ModelSelectionExpression (string) –

      Represents the model selection expression of a route response. Supported only for WebSocket APIs.

    • ResponseModels (dict) –

      Represents the response models of a route response.

      • (string) –

        • (string) –

          A string with a length between [1-128].

    • ResponseParameters (dict) –

      Represents the response parameters of a route response.

      • (string) –

        • (dict) –

          Validation constraints imposed on parameters of a request (path, query string, headers).

          • Required (boolean) –

            Whether or not the parameter is required.

    • RouteResponseId (string) –

      Represents the identifier of a route response.

    • RouteResponseKey (string) –

      Represents the route response key of a route response.

Exceptions