AWS::ApiGateway::Method IntegrationResponse - AWS CloudFormation

AWS::ApiGateway::Method IntegrationResponse

IntegrationResponse is a property of the Amazon API Gateway Method Integration property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "ContentHandling" : String, "ResponseParameters" : {Key : Value, ...}, "ResponseTemplates" : {Key : Value, ...}, "SelectionPattern" : String, "StatusCode" : String }

YAML

ContentHandling: String ResponseParameters: Key : Value ResponseTemplates: Key : Value SelectionPattern: String StatusCode: String

Properties

ContentHandling

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

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

Required: No

Type: String

Allowed values: CONVERT_TO_BINARY | CONVERT_TO_TEXT

Update requires: No interruption

ResponseParameters

A key-value map specifying response parameters that are passed to the method response from the back end. 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.

Required: No

Type: Map of String

Update requires: No interruption

ResponseTemplates

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

Required: No

Type: Map of String

Update requires: No interruption

SelectionPattern

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

Required: No

Type: String

Update requires: No interruption

StatusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Required: Yes

Type: String

Update requires: No interruption

See also

  • Method in the Amazon API Gateway REST API Reference