Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472221377.0 KB

Creates a RouteResponse for a Route.

post/v2/apis/{apiId}/routes/{routeId}/routeresponses

Path parameters

apiIdstring required

The API identifier.

routeIdstring required

The route ID.

Request body

modelSelectionExpressionstring

An expression used to extract information at runtime. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for more information.

responseModelsobject

The route models.

responseParametersobject

The route parameters.

routeResponseKeystring required

After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions">Selection Expressions</a> for a list of expressions and each expression's associated selection key type.

Response

Success

ModelSelectionExpressionstring

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

ResponseModelsobject

Represents the response models of a route response.

ResponseParametersobject

Represents the response parameters of a route response.

RouteResponseIdstring

Represents the identifier of a route response.

RouteResponseKeystring

Represents the route response key of a route response.