create_route_response

ApiGatewayV2.Client.create_route_response(**kwargs)

Creates a RouteResponse for a Route.

See also: AWS API Documentation

Request Syntax

response = client.create_route_response(
    ApiId='string',
    ModelSelectionExpression='string',
    ResponseModels={
        'string': 'string'
    },
    ResponseParameters={
        'string': {
            'Required': True|False
        }
    },
    RouteId='string',
    RouteResponseKey='string'
)

Parameters

• ApiId (string) --

  [REQUIRED]

  The API identifier.

• ModelSelectionExpression (string) -- The model selection expression for the route response. Supported only for WebSocket APIs.
• ResponseModels (dict) --

  The response models for the route response.

  • (string) --
    • (string) --

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

• ResponseParameters (dict) --

  The route response parameters.

  • (string) --
    • (dict) --

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

      • Required (boolean) --

        Whether or not the parameter is required.

• RouteId (string) --

  [REQUIRED]

  The route ID.

• RouteResponseKey (string) --

  [REQUIRED]

  The route response key.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  The request has succeeded and has resulted in the creation of a resource.

  • 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

• ApiGatewayV2.Client.exceptions.NotFoundException
• ApiGatewayV2.Client.exceptions.TooManyRequestsException
• ApiGatewayV2.Client.exceptions.BadRequestException
• ApiGatewayV2.Client.exceptions.ConflictException