Content Encoding

01 Sign in to AWS Management Console.

02 Navigate to API Gateway dashboard at https://console.aws.amazon.com/apigateway/.

03 In the left navigation panel, select APIs to open the APIs listing page.

04 Choose the API that you want to examine by clicking on the API name (link).

05 In the navigation panel, within the API submenu, click Settings to access the selected API configuration.

06 On the API Settings page, within Content Encoding section, check the Content Encoding enabled configuration setting. If Content Encoding enabled setting checkbox is unchecked, the Content Encoding feature is not enabled for the selected Amazon API Gateway API, therefore the API payload is not compressed.

07 Repeat steps no. 4 – 6 to determine the feature status for other AWS API Gateway APIs available in the current region.

08 Change the AWS region from the navigation bar and repeat the audit process for other regions.

01 Run get-rest-apis command (OSX/Linux/UNIX) using custom query filters to list the IDs of the APIs available within the selected region:

aws apigateway get-rest-apis
	--region us-east-1
	--output table
	--query 'items[*].id'

02 The command output should return a table with the requested API IDs:

----------------
|  GetRestApis |
+--------------+
|  abcdabcdab  |
|  aaaabbbbab  |
+--------------+ 

03 Run get-rest-api command (OSX/Linux/UNIX) using the ID of the API that you want to examine and custom query filters to get the minimumCompressionSize configuration attribute value:

aws apigateway get-rest-api
	--region us-east-1
	--rest-api-id abcdabcdab
	--query 'minimumCompressionSize' 

04 The command output should return the minimumCompressionSize value, a nullable integer (between 0 and 10485760) that is used to enable compression:

null

05 Repeat step no. 3 and 4 to determine the feature status for other AWS API Gateway APIs available in the current region.

06 Change the AWS region by updating the --region command parameter value and repeat steps no. 1 – 5 to perform the entire audit process for other regions.

01 Sign in to AWS Management Console.

02 Navigate to API Gateway dashboard at https://console.aws.amazon.com/apigateway/.

03 In the left navigation panel, select APIs to open the APIs listing page.

04 Choose the API that you want to reconfigure (see Audit section part I to identify the right resource), then click on its name to access the API details and configuration.

05 In the navigation panel, in the API submenu, click Settings to access the selected API configuration.

06 On the Settings page, within Content Encoding section, perform the following:

1. Select Content Encoding enabled checkbox to enable API payload compression.
2. Set your own threshold value for the minimumCompressionSize attribute within the within Minimum body size required for compression box. The minimumCompressionSize configuration attribute measures the compression threshold and requires a non-negative integer value between 0 and 10485760 (10M bytes). If your API payload size is smaller than this value, compression is not applied. Setting it to zero allows compression for any payload size.

07 Click Save Changes to apply the configuration changes and enable API payload compression for the selected Amazon API Gateway API.

08 Repeat steps no. 4 – 7 to enable the Content Encoding feature (i.e. API payload compression) for other APIs available within the current region.

09 Change the AWS region from the navigation bar and repeat the process for other regions.

01 Run update-rest-api command (OSX/Linux/UNIX) using the ID of the API that you want to reconfigure as identifier (see Audit section part II to identify the right resource) to enable API payload compression for the selected Amazon API Gateway API using a threshold value of 5Kb for the minimumCompressionSize attribute which represents the minimum body size required for payload compression:

aws apigateway update-rest-api
	--region us-east-1
	--rest-api-id abcdabcdab
	--patch-operations op=replace,path=/minimumCompressionSize,value=5000

02 The command output should return the request metadata:

{
    "apiKeySource": "HEADER",
    "description": "REST sample API that integrates via HTTP with CC endpoints",
    "endpointConfiguration": {
        "types": [
            "REGIONAL"
        ]
    },
    "minimumCompressionSize": 5000,
    "createdDate": 1539965965,
    "id": "abcdabcdab",
    "name": "SampleAPI"
} 

03 Repeat step no. 1 and 2 to enable API payload compression (i.e. Content Encoding) for other APIs available in the selected region.

04 Change the AWS region by updating the --region command parameter value and repeat the entire process for other regions.