Skip to main content

route_responses_list_only

Lists route_responses in a region or regions, for all properties use route_responses

Overview

Nameroute_responses_list_only
TypeResource
DescriptionThe AWS::ApiGatewayV2::RouteResponse resource creates a route response for a WebSocket API. For more information, see [Set up Route Responses for a WebSocket API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.html) in the *API Gateway Developer Guide*.
Idaws.apigatewayv2.route_responses_list_only

Fields

NameDatatypeDescription
route_response_keystringThe route response key.
response_parametersundefinedThe route response parameters.
route_idstringThe route ID.
model_selection_expressionstringThe model selection expression for the route response. Supported only for WebSocket APIs.
api_idstringThe API identifier.
response_modelsobjectThe response models for the route response.
route_response_idstring
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Lists all route_responses in a region.

SELECT
region,
api_id,
route_id,
route_response_id
FROM aws.apigatewayv2.route_responses_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the route_responses_list_only resource, see route_responses