URI HTTP methods Schemas Properties See also

RouteResponse

Represents a route response. Supported only for WebSocket APIs.

URI

/v2/apis/apiId/routes/routeId/routeresponses/routeResponseId

HTTP methods

GET

Operation ID: GetRouteResponse

Gets a RouteResponse.

Path parameters
Name	Type	Required	Description
`routeResponseId`	String	True	The route response ID.
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`200`	`RouteResponse`	Success
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

DELETE

Operation ID: DeleteRouteResponse

Deletes a RouteResponse.

Path parameters
Name	Type	Required	Description
`routeResponseId`	String	True	The route response ID.
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`204`	None	The request has succeeded, and there is no additional content to send in the response payload body.
`404`	`NotFoundException`	The resource specified in the request was not found.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

PATCH

Operation ID: UpdateRouteResponse

Updates a RouteResponse.

Path parameters
Name	Type	Required	Description
`routeResponseId`	String	True	The route response ID.
`apiId`	String	True	The API identifier.
`routeId`	String	True	The route ID.

Responses
Status code	Response model	Description
`200`	`RouteResponse`	Success
`400`	`BadRequestException`	One of the parameters in the request is invalid.
`404`	`NotFoundException`	The resource specified in the request was not found.
`409`	`ConflictException`	The resource already exists.
`429`	`LimitExceededException`	The client is sending more than the allowed number of requests per unit of time.

Schemas

Request bodies


{
  "routeResponseKey": "string",
  "responseParameters": {
  },
  "responseModels": {
  },
  "modelSelectionExpression": "string"
}

Response bodies


{
  "routeResponseId": "string",
  "routeResponseKey": "string",
  "responseParameters": {
  },
  "responseModels": {
  },
  "modelSelectionExpression": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "resourceType": "string"
}


{
  "message": "string"
}


{
  "message": "string",
  "limitType": "string"
}

Properties

BadRequestException

The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

ConflictException

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.

LimitExceededException

A limit has been exceeded. See the accompanying error message for details.

Property	Type	Required	Description
`limitType`	string	False	The limit type.
`message`	string	False	Describes the error encountered.

NotFoundException

The resource specified in the request was not found. See the message field for more information.

Property	Type	Required	Description
`message`	string	False	Describes the error encountered.
`resourceType`	string	False	The resource type.

ParameterConstraints

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

Property	Type	Required	Description
`required`	boolean	False	Whether or not the parameter is required.

RouteModels

The route models.

Property	Type	Required	Description
`*`	string	False

RouteParameters

The route parameters.

Property	Type	Required	Description
`*`	object	False

RouteResponse

Represents a route response.

Property	Type	Required	Description
`modelSelectionExpression`	string	False	Represents the model selection expression of a route response. Supported only for WebSocket APIs.
`responseModels`	RouteModels	False	Represents the response models of a route response.
`responseParameters`	RouteParameters	False	Represents the response parameters of a route response.
`routeResponseId`	string	False	Represents the identifier of a route response.
`routeResponseKey`	string	True	Represents the route response key of a route response.

UpdateRouteResponseInput

Represents the input parameters for an UpdateRouteResponse request.

Property	Type	Required	Description
`modelSelectionExpression`	string	False	The model selection expression for the route response. Supported only for WebSocket APIs.
`responseModels`	RouteModels	False	The response models for the route response.
`responseParameters`	RouteParameters	False	The route response parameters.
`routeResponseKey`	string	False	The route response key.