Return Count from Lambda into the "Response Header" of the API

Question

A customer is using API Gateway to return information via Lambda. However, they would like to put a count from Lambda into the "Response Header" of the API, which is returned to the requester, instead of in the body of the response.

In API Gateway how can I take the response from Lambda and map the "count" field into the header of the HTTP response?

Accepted Answer

If you return the count in a header from the Lambda function you can just reference it using `integration.response.header.header-name`.

To return a header from the Lambda function just return something like this:

{
        "statusCode": 200,
        "headers": {
            "header1Name": "header1Value",
            "header2Name": "header2Value",
        },
        "body": "...",
    }

For more information see [here](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings-execution-console.html). You will see that it describes that only headers from the backend can be mapped to headers in the response.

Return Count from Lambda into the "Response Header" of the API

Relevant questions

Return a custom header from lambda authorizer in API-gateway (HTTP api)

Lambda response compression to API Gateway and client