Amazon API Gateway Method Integration IntegrationResponse
IntegrationResponse is a property of the Amazon API Gateway Method Integration IntegrationResponse property
that specifies the response that Amazon API Gateway (API Gateway) sends after a method's
back end finishes processing a request.
Syntax
JSON
Copy{ "ResponseParameters" : {String:String, ...}, "ResponseTemplates" : {String:String, ...}, "SelectionPattern" :String, "StatusCode" :String}
YAML
CopyResponseParameters:String:StringResponseTemplates:String:StringSelectionPattern:StringStatusCode:String
Properties
ResponseParameters-
The response parameters from the back-end response that API Gateway sends to the method response. Specify response parameters as key-value pairs (string-to-string mappings).
Use the destination as the key and the source as the value:
-
The destination must be an existing response parameter in the
MethodResponseproperty. -
The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on the destination specified in the request.
For more information, see API Gateway API Request and Response Parameter-Mapping Reference in the API Gateway Developer Guide.
Required: No
Type: Mapping of key-value pairs
-
ResponseTemplates-
The templates used to transform the integration response body. Specify templates as key-value pairs (string-to-string maps), with a content type as the key and a template as the value. For more information, see API Gateway API Request and Response Payload-Mapping Template Reference in the API Gateway Developer Guide.
Required: No
Type: Mapping of key-value pairs
SelectionPattern-
A regular expression that specifies which error strings or status codes from the back end map to the integration response.
Required: No
Type: String
StatusCode-
The status code that API Gateway uses to map the integration response to a
MethodResponsestatus code.Required: Yes
Type: String
