Override an API's response status code using the AWS Management Console Override an API's request parameters and headers using the AWS Management Console Override an API's request parameters and headers using the AWS CLI Override an API's request parameters and headers using the SDK for JavaScript

Examples of overriding an API's request and response parameters and status codes

The following examples show how to create and test a mapping template override. The first two examples use AWS Management Console and the Example API as a starting point. The last two examples use the AWS CLI and the SDK for JavaScript.

Override an API's response status code using the AWS Management Console

To retrieve a pet using the PetStore sample API, you use the API method request of GET /pets/{petId}, where {petId} is a path parameter that can take a number at run time.

In this example, you'll override this GET method's response code by creating a mapping template that maps $context.responseOverride.status to 400 when an error condition is detected.

Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.
Under APIs, choose the PetStore API, and then choose Resources.
In the Resources tree, choose the GET method under /{petId}.
Choose the Test tab. You might need to choose the right arrow button to show the tab.
For petId, enter -1, and then choose Test.

In the results, you'll notice two things:

First, the Response body indicates an out-of-range error:
```
{
  "errors": [
    {
      "key": "GetPetRequest.petId",
      "message": "The value is out of range."
    }
  ]
}
```
Second, the last line under Log box ends with: Method completed with status: 200.
On the Integration response tab, for the Default - Response, choose Edit.
Choose Mapping templates.
Choose Add mapping template.
For Content type, enter application/json.

For Template body, enter the following:


#set($inputRoot = $input.path('$'))
$input.json("$")
#if($inputRoot.toString().contains("error"))
#set($context.responseOverride.status = 400)
#end

Choose Save.
Choose the Test tab.
For petId, enter -1.
In the results, the Response Body indicates an out-of-range error:
```
{
  "errors": [
    {
      "key": "GetPetRequest.petId",
      "message": "The value is out of range."
    }
  ]
}
```
However, the last line under Logs box now ends with: Method completed with status: 400.

Override an API's request parameters and headers using the AWS Management Console

In this example, you'll override the GET method's request header code by creating a mapping template that maps $context.requestOverride.header.header_name to a new header that combines two other headers.

Sign in to the API Gateway console at https://console.aws.amazon.com/apigateway.
Under APIs, choose the PetStore API.
In the Resources tree, choose the GET method under /pet.
On the Method request tab, for Method request settings, choose Edit.
Choose HTTP request headers, and then choose Add header.
For Name, enter header1.
Choose Add header, and then create a second header called header2.
Choose Save.
On the Integration request tab, for Integration request settings, choose Edit.
For Request body passthrough, select When there are no templates defined (recommended).

Choose Mapping templates, and then do the following:

Choose Add mapping template.
For Content type, enter application/json.

For Template body, enter the following:


#set($header1Override = "foo")
#set($header3Value = "$input.params('header1')$input.params('header2')")
$input.json("$")
#set($context.requestOverride.header.header3 = $header3Value)
#set($context.requestOverride.header.header1 = $header1Override)
#set($context.requestOverride.header.multivalueheader=[$header1Override, $header3Value])

Choose Save.
Choose the Test tab.
Under Headers for {pets}, copy the following code:
```
header1:header1Val
header2:header2Val
```

Choose Test.

In the Log, you should see an entry that includes this text:


Endpoint request headers: {header3=header1Valheader2Val, 
header2=header2Val, header1=foo, x-amzn-apigateway-api-id=<api-id>,
Accept=application/json, multivalueheader=foo,header1Valheader2Val}

Override an API's request parameters and headers using the AWS CLI

The following CLI example shows how to use the put-integration command to override a response code:


aws apigateway put-integration --rest-api-id <API_ID> --resource-id <PATH_TO_RESOURCE_ID> --http-method <METHOD> 
            --type <INTEGRATION_TYPE> --request-templates <REQUEST_TEMPLATE_MAP>

where <REQUEST_TEMPLATE_MAP> is a map from content type to a string of the template to apply. The structure of that map is as follows:


Content_type1=template_string,Content_type2=template_string

or, in JSON syntax:


{"content_type1": "template_string"
...}

The following example shows how to use the put-integration-response command to override an API's response code:


aws apigateway put-integration-response --rest-api-id <API_ID> --resource-id <PATH_TO_RESOURCE_ID> --http-method <METHOD> 
            --status-code <STATUS_CODE> --response-templates <RESPONSE_TEMPLATE_MAP>

where <RESPONSE_TEMPLATE_MAP> has the same format as <REQUEST_TEMPLATE_MAP> above.

Override an API's request parameters and headers using the SDK for JavaScript

The following example shows how to use the put-integration command to override a response code:

Request:


var params = {
  httpMethod: 'STRING_VALUE', /* required */
  resourceId: 'STRING_VALUE', /* required */
  restApiId: 'STRING_VALUE', /* required */
  type: HTTP | AWS | MOCK | HTTP_PROXY | AWS_PROXY, /* required */
  requestTemplates: {
    '<Content_type>': 'TEMPLATE_STRING',
    /* '<String>': ... */
  },
};
apigateway.putIntegration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Response:


var params = {
  httpMethod: 'STRING_VALUE', /* required */
  resourceId: 'STRING_VALUE', /* required */
  restApiId: 'STRING_VALUE', /* required */
  statusCode: 'STRING_VALUE', /* required */
  responseTemplates: {
    '<Content_type>': 'TEMPLATE_STRING',
    /* '<String>': ... */
  },
};
apigateway.putIntegrationResponse(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

Use a mapping template to override an API's request and response parameters and status codes

Set up request and response data mappings using the console