GetIntegrationResponseResult

data class GetIntegrationResponseResult(val contentHandlingStrategy: String? = null, val integrationResponseId: String? = null, val integrationResponseKey: String? = null, val responseParameters: Any? = null, val responseTemplates: Any? = null, val templateSelectionExpression: String? = null)

Constructors

Link copied to clipboard
constructor(contentHandlingStrategy: String? = null, integrationResponseId: String? = null, integrationResponseKey: String? = null, responseParameters: Any? = null, responseTemplates: Any? = null, templateSelectionExpression: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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: `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.

Link copied to clipboard

The integration response ID.

Link copied to clipboard

The integration response key.

Link copied to clipboard
val responseParameters: Any? = null

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. Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

Link copied to clipboard
val responseTemplates: Any? = null

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. Search the CloudFormation User Guide for AWS::ApiGatewayV2::IntegrationResponse for more information about the expected schema for this property.

Link copied to clipboard

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