AWS Documentation » Amazon API Gateway » Developer Guide » Creating, Deploying, and Invoking a REST API in Amazon API Gateway » Creating a REST API in Amazon API Gateway » Set up API Gateway Request and Response Data Mappings » Amazon API Gateway API Request and Response Data Mapping Reference » Integration Passthrough Behaviors

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Integration Passthrough Behaviors

With non-proxy integrations, when a method request carries a payload and either the Content-Type header does not match any specified mapping template or no mapping template is defined, you can choose to pass the client-supplied request payload through the integration request to the backend without transformation. The process is known as integration passthrough.

For proxy integrations, API Gateway passes the entire request through to your backend, and you do not have the option to modify the passthrough behaviors.

The actual passthrough behavior of an incoming request is determined by the option you choose for a specified mapping template, during integration request set-up, and the Content Type header that a client set in the incoming request. The following examples illustrate the possible passthrough behaviors.

Example 1: One mapping template is defined in the integration request for the application/json content type.

Content-Type header\Selected passthrough option	WHEN_NO_MATCH	WHEN_NO_TEMPLATE	NEVER
None (default to application/json	The request payload is transformed using the template.	The request payload is transformed using the template.	The request payload is transformed using the template.
application/json	The request payload is transformed using the template.	The request payload is transformed using the template.	The request payload is transformed using the template.
application/xml	The request payload is not transformed and is sent to the backend as-is.	The request is rejected with an HTTP 415 Unsupported Media Type response.	The request is rejected with an HTTP 415 Unsupported Media Type response.

Example 2: One mapping template is defined in the integration request for the application/xml content type.

Content-Type header\Selected passthrough option	WHEN_NO_MATCH	WHEN_NO_TEMPLATE	NEVER
None (default to application/json	The request payload is not transformed and is sent to the backend as-is.	The request is rejected with an HTTP 415 Unsupported Media Type response.	The request is rejected with an HTTP 415 Unsupported Media Type response.
application/json	The request payload is not transformed and is sent to the backend as-is.	The request is rejected with an HTTP 415 Unsupported Media Type response.	The request is rejected with an HTTP 415 Unsupported Media Type response.
application/xml	The request payload is transformed using the template.	The request payload is transformed using the template.	The request payload is transformed using the template.