route_responses

Creates, updates, deletes, gets or lists a route_responses resource.

Overview

Name	route_responses
Type	Resource
Id	aws.apigatewayv2.route_responses

Fields

The following fields are returned by SELECT queries:

get_route_response

Name	Datatype	Description
model_selection_expression	string	An expression used to extract information at runtime. See Selection Expressions for more information.
response_models	object	Represents the response models of a route response.
response_parameters	object	Represents the response parameters of a route response.
route_response_id	string	The identifier.
route_response_key	string	After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

get_route_responses

Name	Datatype	Description
model_selection_expression	string	An expression used to extract information at runtime. See Selection Expressions for more information.
response_models	object	Represents the response models of a route response.
response_parameters	object	Represents the response parameters of a route response.
route_response_id	string	The identifier.
route_response_key	string	After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_route_response	select	api_id, route_id, route_response_id, region		Gets a RouteResponse.
get_route_responses	select	api_id, route_id, region	maxResults, nextToken	Gets the RouteResponses for a Route.
create_route_response	insert	api_id, route_id, region, RouteResponseKey		Creates a RouteResponse for a Route.
update_route_response	update	api_id, route_id, route_response_id, region		Updates a RouteResponse.
delete_route_response	delete	api_id, route_id, route_response_id, region		Deletes a RouteResponse.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_id	string	The API identifier.
region	string	AWS region (default: us-east-1)
route_id	string	The route ID.
route_response_id	string	The route response ID.
maxResults	string	The maximum number of elements to be returned for this resource.
nextToken	string	The next page of elements from this collection. Not valid for the last element of the collection.

SELECT examples

get_route_response

Gets a RouteResponse.

SELECT
model_selection_expression,
response_models,
response_parameters,
route_response_id,
route_response_key
FROM aws.apigatewayv2.route_responses
WHERE api_id = '{{ api_id }}' -- required
AND route_id = '{{ route_id }}' -- required
AND route_response_id = '{{ route_response_id }}' -- required
AND region = '{{ region }}' -- required
;

get_route_responses

Gets the RouteResponses for a Route.

SELECT
model_selection_expression,
response_models,
response_parameters,
route_response_id,
route_response_key
FROM aws.apigatewayv2.route_responses
WHERE api_id = '{{ api_id }}' -- required
AND route_id = '{{ route_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_route_response

Creates a RouteResponse for a Route.

INSERT INTO aws.apigatewayv2.route_responses (
ModelSelectionExpression,
ResponseModels,
ResponseParameters,
RouteResponseKey,
api_id,
route_id,
region
)
SELECT 
'{{ ModelSelectionExpression }}',
'{{ ResponseModels }}',
'{{ ResponseParameters }}',
'{{ RouteResponseKey }}' /* required */,
'{{ api_id }}',
'{{ route_id }}',
'{{ region }}'
RETURNING
model_selection_expression,
response_models,
response_parameters,
route_response_id,
route_response_key
;

Manifest

# Description fields are for documentation purposes
- name: route_responses
props:
  - name: api_id
    value: "{{ api_id }}"
    description: Required parameter for the route_responses resource.
  - name: route_id
    value: "{{ route_id }}"
    description: Required parameter for the route_responses resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the route_responses resource.
  - name: ModelSelectionExpression
    value: "{{ ModelSelectionExpression }}"
    description: |
      An expression used to extract information at runtime. See Selection Expressions for more information.
  - name: ResponseModels
    value: "{{ ResponseModels }}"
    description: |
      The route models.
  - name: ResponseParameters
    value: "{{ ResponseParameters }}"
    description: |
      The route parameters.
  - name: RouteResponseKey
    value: "{{ RouteResponseKey }}"
    description: |
      After evaluating a selection expression, the result is compared against one or more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's associated selection key type.

UPDATE examples

update_route_response

Updates a RouteResponse.

UPDATE aws.apigatewayv2.route_responses
SET 
ModelSelectionExpression = '{{ ModelSelectionExpression }}',
ResponseModels = '{{ ResponseModels }}',
ResponseParameters = '{{ ResponseParameters }}',
RouteResponseKey = '{{ RouteResponseKey }}'
WHERE 
api_id = '{{ api_id }}' --required
AND route_id = '{{ route_id }}' --required
AND route_response_id = '{{ route_response_id }}' --required
AND region = '{{ region }}' --required
RETURNING
model_selection_expression,
response_models,
response_parameters,
route_response_id,
route_response_key;

DELETE examples

delete_route_response

Deletes a RouteResponse.

DELETE FROM aws.apigatewayv2.route_responses
WHERE api_id = '{{ api_id }}' --required
AND route_id = '{{ route_id }}' --required
AND route_response_id = '{{ route_response_id }}' --required
AND region = '{{ region }}' --required
;