integration_response

Gets an individual integration_response resource

Overview

Name	integration_response
Type	Resource
Description	integration_response
Id	awscc.apigatewayv2.integration_response

Fields

Name	Datatype	Description
integration_response_id	string
response_templates	object	The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
template_selection_expression	string	The template selection expression for the integration response. Supported only for WebSocket APIs.
response_parameters	object	A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of ``method.response.header.{name}``, where name is a valid and unique header name. The mapped non-static value must match the pattern of ``integration.response.header.{name}`` or ``integration.response.body.{JSON-expression}``, where ``{name}`` is a valid and unique response header name and ``{JSON-expression}`` is a valid JSON expression without the ``$`` prefix.
content_handling_strategy	string	Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are ``CONVERT_TO_BINARY`` and ``CONVERT_TO_TEXT``, with the following behaviors:<br/> ``CONVERT_TO_BINARY``: Converts a response payload from a Base64-encoded string to the corresponding binary blob.<br/> ``CONVERT_TO_TEXT``: Converts a response payload from a binary blob to a Base64-encoded string.<br/> If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
integration_id	string	The integration ID.
integration_response_key	string	The integration response key.
api_id	string	The API identifier.
region	string	AWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
integration_response_id,
response_templates,
template_selection_expression,
response_parameters,
content_handling_strategy,
integration_id,
integration_response_key,
api_id
FROM awscc.apigatewayv2.integration_response
WHERE data__Identifier = '<ApiId>|<IntegrationId>|<IntegrationResponseId>';

Permissions

To operate on the integration_response resource, the following permissions are required:

Read

apigateway:GET

Update

apigateway:PATCH,
apigateway:PUT,
apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE