route_responses_list_only
Lists route_responses
in a region or regions, for all properties use route_responses
Overview
Name | route_responses_list_only |
Type | Resource |
Description | The 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*. |
Id | aws.apigatewayv2.route_responses_list_only |
Fields
Name | Datatype | Description |
---|---|---|
route_response_key | string | The route response key. |
response_parameters | undefined | The route response parameters. |
route_id | string | The route ID. |
model_selection_expression | string | The model selection expression for the route response. Supported only for WebSocket APIs. |
api_id | string | The API identifier. |
response_models | object | The response models for the route response. |
route_response_id | string | |
region | string | AWS region. |
Methods
Name | Accessible by | Required Params |
---|---|---|
list_resources | SELECT | region |
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