Create Integration Response

apigatewayv2_create_integration_response

R Documentation

Creates an IntegrationResponses

Description

Creates an IntegrationResponses.

Usage

apigatewayv2_create_integration_response(ApiId, ContentHandlingStrategy,
  IntegrationId, IntegrationResponseKey, ResponseParameters,
  ResponseTemplates, TemplateSelectionExpression)

Arguments

ApiId

[required] The API identifier.

ContentHandlingStrategy

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

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.

IntegrationId

[required] The integration ID.

IntegrationResponseKey

[required] The integration response key.

ResponseParameters

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.

ResponseTemplates

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.

TemplateSelectionExpression

The template selection expression for the integration response. Supported only for WebSocket APIs.

Value

A list with the following syntax:

list(
  ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
  IntegrationResponseId = "string",
  IntegrationResponseKey = "string",
  ResponseParameters = list(
    "string"
  ),
  ResponseTemplates = list(
    "string"
  ),
  TemplateSelectionExpression = "string"
)

Request syntax

svc$create_integration_response(
  ApiId = "string",
  ContentHandlingStrategy = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
  IntegrationId = "string",
  IntegrationResponseKey = "string",
  ResponseParameters = list(
    "string"
  ),
  ResponseTemplates = list(
    "string"
  ),
  TemplateSelectionExpression = "string"
)