Amazon API Gateway
Developer Guide

Document History

The following table describes the important changes to the documentation since the last release of the API Gateway Developer Guide.

  • Latest documentation update: April 11, 2017

Change Description Date Changed
Validating method requests Configure basic request validators on the API level or method levels so that API Gateway can validate incoming requests. API Gateway verifies that required parameters are set and not blank, and verifies that the format of applicable payloads conforms to the configured model. For more information, see Enable Basic Request Validation for an API in API Gateway. April 11, 2017
Integrating with ACM Use ACM Certificates for your API's custom domain names. You can create a certificate in AWS Certificate Manager or import an existing PEM-formatted certificate into ACM. You then refer to the certificate's ARN when setting a custom domain name for your APIs. For more information, see Use Custom Domain Name as API Gateway API Host Name. March 9, 2017
Generating and calling a Java SDK of an API Let API Gateway generate the Java SDK for your API and use the SDK to call the API in your Java client. For more information, see Use a Java SDK Generated by API Gateway. January 13, 2017
Integrating with AWS Marketplace Sell your API in a usage plan as a SaaS product through AWS Marketplace. Use AWS Marketplace to extend the reach of your API. Rely on AWS Marketplace for customer billing on your behalf. Let API Gateway handle user authorization and usage metering. For more information, see Selling an API as SaaS. December 1, 2016
Enabling Documentation Support for your API Add documentation for API entities in DocumentationPart resources in API Gateway. Associate a snapshot of the collection DocumentationPart instances with an API stage to create a DocumentationVersion. Publish API documentation by exporting a documentation version to an external file, such as a Swagger file. For more information, see Documenting an API. December 1, 2016
Updated custom authorizer A customer authorizer Lambda function now returns the caller's principal identifier. The function also can return other information as key-value pairs of the context map and an IAM policy. For more information, see Output from an Amazon API Gateway Custom Authorizer. December 1, 2016
Supporting binary payloads Set binaryMediaTypes on your API to support binary payloads of a request or response. Set the contentHandling property on an Integration or IntegrationResponse to specify whether to handle a binary payload as the native binary blob, as a Base64-enocded string, or as a passthrough without modifications. For more information, see Enable Support for Binary Payloads in API Gateway. November 17, 2016
Enabling a proxy integration with an HTTP or Lambda back end through a proxy resource of an API. Create a proxy resource with a greedy path parameter of the form {proxy+} and the catch-all ANY method. The proxy resource is integrated with an HTTP or Lambda back end using the HTTP or Lambda proxy integration, respectively. For more information, see Configure Proxy Integration with a Proxy Resource. September 20, 2016
Extending selected APIs in API Gateway as product offerings for your customers by providing one or more usage plans. Create a usage plan in API Gateway to enable selected API clients to access specified API stages at agreed-upon request rates and quotas. For more information, see Use API Gateway Usage Plans. August 11, 2016
Enabling method-level authorization with a user pool in Amazon Cognito Create a user pool in Amazon Cognito and use it as your own identity provider. You can configure the user pool as a method-level authorizer to grant access for users who are registered with the user pool. For more information, see Use Amazon Cognito User Pools. July 28, 2016
Enabling Amazon CloudWatch metrics and dimensions under the AWS/ApiGateway namespace. The API Gateway metrics are now standardized under the CloudWatch namespace of AWS/ApiGateway. You can view them in both the API Gateway console and the Amazon CloudWatch console. For more information, see Amazon API Gateway Dimensions and Metrics. July 28, 2016
Enabling certificate rotation for a custom domain name Certificate rotation allows you to upload and renew an expiring certificate for a custom domain name. For more information, see Rotate a Certificate Imported into ACM. April 27, 2016
Documenting changes for the updated Amazon API Gateway console. Learn how to create and set up an API using the updated API Gateway console. For more information, see Create an API Gateway API from an Example and Build an API Gateway API to Expose an HTTP Endpoint. April 5, 2016
Enabling the Import API feature to create a new or update an existing API from external API definitions. With the Import API features, you can create a new API or update an existing one by uploading an external API definition expressed in Swagger 2.0 with the API Gateway extensions. For more information about the Import API, see Import an API. April 5, 2016
Exposing the $input.body variable to access the raw payload as string and the $util.parseJson() function to turn a JSON string into a JSON object in a mapping template. For more information about $input.body and $util.parseJson(), see Request and Response Payload-Mapping Reference. April 5, 2016
Enabling client requests with method-level cache invalidation, and improving request throttling management. Flush API stage-level cache and invalidate individual cache entry. For more information, see Flush the API Stage Cache in API Gateway and Invalidate an API Gateway Cache Entry. Improve the console experience for managing API request throttling. For more information, see Manage API Request Throttling. March 25, 2016
Enabling and calling API Gateway API using custom authorization Create and configure an AWS Lambda function to implement custom authorization. The function returns an IAM policy document that grants the Allow or Deny permissions to client requests of an API Gateway API. For more information, see Use API Gateway Custom Authorizers. February 11, 2016
Importing and exporting API Gateway API using a Swagger definition file and extensions Create and update your API Gateway API using the Swagger specification with the API Gateway extensions. Import the Swagger definitions using the API Gateway Importer. Export an API Gateway API to a Swagger definition file using the API Gateway console or API Gateway Export API. For more information, see Import and Export API. December 18, 2015
Mapping request or response body or body's JSON fields to request or response parameters. Map method request body or its JSON fields into integration request's path, query string, or headers. Map integration response body or its JSON fields into request response's headers. For more information, see Request and Response Data Mapping. December 18, 2015
Working with Stage Variables in Amazon API Gateway Learn how to associate configuration attributes with a deployment stage of an API in Amazon API Gateway. For more information, see Manage API Gateway API Deployment with Stage Variables. November 5, 2015
How to: Enable CORS for a Method It is now easier to enable cross-origin resource sharing (CORS) for methods in Amazon API Gateway. For more information, see Enable CORS for a Resource. November 3, 2015
How to: Use Client Side SSL Authentication Use Amazon API Gateway to generate SSL certificates that you can use to authenticate calls to your HTTP backend. For more information, see Use Client-Side SSL Certificates. September 22, 2015
Mock integration of methods

Learn how to mock-integrate an API with Amazon API Gateway. This feature enables developers to generate API responses from API Gateway directly without the need for a final integration back end beforehand.

September 1, 2015
Amazon Cognito Identity support Amazon API Gateway has expanded the scope of the $context variable so that it now returns information about Amazon Cognito Identity when requests are signed with Amazon Cognito credentials. In addition, we have added a $util variable for escaping characters in JavaScript and encoding URLs and strings. For more information, see Request and Response Payload-Mapping Reference. August 28, 2015
Swagger integration Use the Swagger import tool on GitHub to import Swagger API definitions into Amazon API Gateway. Learn more about Import and Export API to create and deploy APIs and methods using the import tool. With the Swagger importer tool you can also update existing APIs. July 21, 2015
Mapping Template Reference

Read about the $input parameter and its functions in the Request and Response Payload-Mapping Reference.

July 18, 2015
Initial public release

This is the initial public release of the Amazon API Gateway Developer Guide.

July 9, 2015