Skip to content

Creates a RouteResponse for a Route

Description

Creates a RouteResponse for a Route.

Usage

apigatewayv2_create_route_response(ApiId, ModelSelectionExpression,
  ResponseModels, ResponseParameters, RouteId, RouteResponseKey)

Arguments

  • ApiId

    [required] The API identifier.

  • ModelSelectionExpression

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

  • ResponseModels

    The response models for the route response.

  • ResponseParameters

    The route response parameters.

  • RouteId

    [required] The route ID.

  • RouteResponseKey

    [required] The route response key.

Value

A list with the following syntax:

list(
  ModelSelectionExpression = "string",
  ResponseModels = list(
    "string"
  ),
  ResponseParameters = list(
    list(
      Required = TRUE|FALSE
    )
  ),
  RouteResponseId = "string",
  RouteResponseKey = "string"
)

Request syntax

svc$create_route_response(
  ApiId = "string",
  ModelSelectionExpression = "string",
  ResponseModels = list(
    "string"
  ),
  ResponseParameters = list(
    list(
      Required = TRUE|FALSE
    )
  ),
  RouteId = "string",
  RouteResponseKey = "string"
)