You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApiGatewayV2::Types::IntegrationResponse

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents an integration response.

Instance Attribute Summary collapse

Instance Attribute Details

#content_handling_strategyString

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.

Possible values:

  • CONVERT_TO_BINARY
  • CONVERT_TO_TEXT

Returns:

  • (String)

    Specifies how to handle response payload content type conversions.

#integration_response_idString

The integration response ID.

Returns:

  • (String)

    The integration response ID.

#integration_response_keyString

The integration response key.

Returns:

  • (String)

    The integration response key.

#response_parametersHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    A key-value map specifying response parameters that are passed to the method response from the backend.

#response_templatesHash<String,String>

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.

Returns:

  • (Hash<String,String>)

    The collection of response templates for the integration response as a string-to-string map of key-value pairs.

#template_selection_expressionString

The template selection expressions for the integration response.

Returns:

  • (String)

    The template selection expressions for the integration response.