# Amazon API Gateway Developer Guide > Build, deploy, maintain and call cloud-based APIs using Amazon API Gateway with this Developer Guide. - [Prerequisites](https://docs.aws.amazon.com/apigateway/latest/developerguide/setting-up.md) - [Get started](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started.md) - [API Gateway ARNs](https://docs.aws.amazon.com/apigateway/latest/developerguide/arn-format-reference.md) - [API references](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-ref.md) - [Document history](https://docs.aws.amazon.com/apigateway/latest/developerguide/history.md) ## [What is Amazon API Gateway?](https://docs.aws.amazon.com/apigateway/latest/developerguide/welcome.md) - [API Gateway use cases](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-overview-developer-experience.md): The following use cases section presents an overview of the different types of API Gateway APIs and the different kinds of developers who use API Gateway. - [API Gateway concepts](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.md): Defines API Gateway basic concepts. - [Choose between REST APIs and HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vs-rest.md): Learn the differences between REST APIs and HTTP APIs. - [Get started with the REST API console](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-rest-new-console.md): Get started with the API Gateway REST API console. ## [Tutorials and workshops](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-tutorials.md) ### [REST API tutorials](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-rest-tutorials.md) Use hands-on tutorials to learn about Amazon API Gateway REST APIs. ### [Choose a Lambda integration tutorial](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-lambda-integration.md) Learn how to create and test an API to expose a Lambda function with the Lambda integration using the API Gateway console. - [Tutorial: Create a REST API with a Lambda proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy-for-lambda.md): Learn how to build and test an API with Lambda proxy integration using the API Gateway console. - [Tutorial: Create a REST API with a Lambda non-proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-lambda-non-proxy-integration.md): Learn how to create and test an API method to expose a Lambda function with the Lambda custom integration using the API Gateway console. - [Tutorial: Create a REST API with a cross-account Lambda proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-cross-account-lambda-integrations.md): Learn how to build and test an API with cross-account Lambda proxy integration using the API Gateway console. - [Tutorial: Create a REST API by importing an example](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-from-example.md): Learn how to create an API in API Gateway with the help of an example. ### [Choose an HTTP integration tutorial](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-http-integrations.md) Learn how to create an API with HTTP proxy integration or HTTP non-proxy integration. - [Tutorial: Create a REST API with an HTTP proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-as-simple-proxy-for-http.md): Build and test an API with HTTP proxy integration using the API Gateway console. - [Tutorial: Create a REST API with an HTTP non-proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.md): Learn how to create an API Gateway API with the HTTP custom integration using the API Gateway console. - [Tutorial: Create a REST API with a private integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-with-private-integration.md): Create a private integration - [Tutorial: Create a REST API with an AWS integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-aws-proxy.md): Learn how to integrate API Gateway with an AWS service proxy. ### [Tutorial: Create a calculator REST API with three integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-lambda.md) Learn two ways to configure a REST API in Amazon API Gateway as a service proxy for AWS Lambda. - [OpenAPI definitions of a sample API for a Lambda function](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-as-lambda-proxy-export-swagger-with-extensions.md) ### [Tutorial: Create a REST API as an Amazon S3 proxy](https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-s3.md) Learn how to create and configure a REST API in API Gateway as an Amazon S3 proxy. - [OpenAPI definitions of a sample API as an Amazon S3 proxy](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-as-s3-proxy-export-swagger-with-extensions.md): The following OpenAPI definitions describes an API that works as an Amazon S3 proxy. - [Call the API using a REST API client](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-as-s3-proxy-test-using-postman.md): To provide an end-to-end tutorial, we now show how to call the API using Postman, which supports the AWS IAM authorization. ### [Tutorial: Create a REST API as an Amazon Kinesis proxy](https://docs.aws.amazon.com/apigateway/latest/developerguide/integrating-api-with-aws-services-kinesis.md) Learn how to create and configure a REST API in API Gateway as an AWS proxy for Kinesis. - [OpenAPI definitions of a sample API as a Kinesis proxy](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-as-kinesis-proxy-export-swagger-with-extensions.md): A sample API as a Kinesis proxy in OpenAPI Specification. - [Tutorial: Create a REST API using AWS SDKs or the AWS CLI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-cli-sdk.md): Create and test an edge-optimized API using an AWS SDKs or the AWS CLI - [Tutorial: Create a private REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/private-api-tutorial.md): Learn to create a private REST API in API Gateway that is only accessible from within an Amazon VPC. ### [HTTP API tutorials](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-http-tutorials.md) Provide hands-on tutorials to learn about Amazon API Gateway HTTP APIs. - [Tutorial: Build a CRUD HTTP API with Lambda and DynamoDB](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-dynamo-db.md): Learn to create an Amazon API Gateway HTTP API that invokes an AWS Lambda function to create, update, or delete data in Amazon DynamoDB. - [Tutorial: Create an HTTP API with a private integration to Amazon ECS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-private-integration.md): Learn to create an Amazon API Gateway HTTP API that uses a VPC link to integrate with an Amazon ECS service in an Amazon VPC. ### [WebSocket API tutorials](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-websocket-tutorials.md) Provide hands-on tutorials to learn about Amazon API Gateway WebSocket APIs. - [Tutorial: Create a WebSocket chat app](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-chat-app.md): Learn to create a serverless chat application that uses an API Gateway WebSocket API. - [Tutorial: Create a WebSocket API with an AWS integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-step-functions-tutorial.md): Learn to create a serverless application that uses an API Gateway WebSocket API and Step Functions. ## [API Gateway REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.md) ### [Develop](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-develop.md) Learn about developing REST APIs. ### [API Gateway endpoint types](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-endpoint-types.md) Learn about the supported API endpoint types in API Gateway. - [Change a public or private API endpoint type](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-api-migration.md): Learn how to change the type of API from edge-optimized to Regional, from Regional to edge-optimized, or from public to private or private to regional. ### [Security policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-security-policies.md) Learn how to configure security policies for your REST APIs - [Supported security policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-security-policies-list.md): All supported security policies for API Gateway REST APIs and custom domain names. - [How to change a security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-security-policies-update.md): How to update your security policy. ### [IP address types for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-ip-address-type.md) Learn about changing the IP address type - [Change the IP address type of a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-ip-address-type-change.md): You can change the IP address type by updating the API’s configuration. ### [Methods](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings.md) Learn how to set up a REST API Gateway API method as a frontend programming interface for the client to access the integrated backend. - [Set up method request](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.md): Setting up a method request involves performing the following tasks, after creating a RestApi resource: - [Set up method response](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-response.md): An API method response encapsulates the output of an API method request that the client will receive. - [Set up method using the console](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-set-up-method-using-console.md): When you create a method using the REST API console, you configure both the integration request and the method request. ### [Access control](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.md) Learn how to control and manage access to a REST API in Amazon API Gateway. ### [Use API Gateway resource policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.md) Learn how to use resource policies to control access to your Amazon API Gateway resources. - [Access policy language overview for Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-policy-language-overview.md): Learn the access policy language overview of Amazon API Gateway. - [How resource policies affect authorization workflow](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-authorization-flow.md): Understand how resource policies work with other authorization mechanisms to control access to your Amazon API Gateway resources. - [API Gateway resource policy examples](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies-examples.md): Learn example API Gateway resource policies. - [Create and attach an API Gateway resource policy to an API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies-create-attach.md): Learn how to attach a resource policy to your REST API. - [AWS condition keys that can be used in API Gateway resource policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies-aws-condition-keys.md): Learn condition keys that can be used in API Gateway resource policies. ### [Use IAM permissions](https://docs.aws.amazon.com/apigateway/latest/developerguide/permissions.md) Learn how to provide access permissions to users for Amazon API Gateway actions and resources. - [Control access for invoking an API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-control-access-using-iam-policies-to-invoke-api.md): In this section, you learn about the permissions model for controlling access to your API using IAM permissions. - [IAM policy examples for API execution permissions](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-iam-policy-examples-for-api-execution.md): For permissions model and other background information, see Control access for invoking an API. - [Use VPC endpoint policies for private APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-vpc-endpoint-policies.md): Learn how to create endpoint policies for VPC endpoints in Amazon API Gateway. - [Using tags to control access to a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-tags.md): Learn how to enable and configure attribute-based access control of an API in Amazon API Gateway. ### [Use Lambda authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.md) Enable an Amazon API Gateway Lambda authorizer to authenticate API requests. - [Configure a Lambda authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization.md): Learn how to configure an API Gateway Lambda authorizer in the API Gateway console and using the AWS CLI. - [Input to a Lambda authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-input.md): Learn the format of input to a Lambda authorizer - [Output from an API Gateway Lambda authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.md): Learn about the output from an API Gateway Lambda authorizer. - [Call an API with Lambda authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/call-api-with-api-gateway-lambda-authorization.md): Learn how to invoke an API Gateway API Lambda authorizer. - [Configure a cross-account Lambda authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-lambda-authorizer-cross-account-lambda-authorizer.md): Learn how to configure a cross-account API Gateway Lambda authorizer. - [Control access based on an identity’s attributes with Verified Permissions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-lambda-authorizer-verified-permissions.md): Create a Lambda authorizer using Verified Permissions. ### [Use Amazon Cognito user pool as authorizer for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.md) Learn how to use an Amazon Cognito user pool to authorize calling an API method. - [Create an Amazon Cognito user pool for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-create-cognito-user-pool.md): Learn how to create an Amazon Cognito user pool for a REST API. - [Integrate a REST API with an Amazon Cognito user pool](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enable-cognito-user-pool.md): Learn how to integrate a REST API with an Amazon Cognito user pool. - [Call a REST API integrated with a user pool](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-invoke-api-integrated-with-cognito-user-pool.md): Learn how to call a REST API integrated with an Amazon Cognito user pool - [Configure cross-account Amazon Cognito authorizer for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-cross-account-cognito-authorizer.md): Learn how to configure a cross-account API Gateway Amazon Cognito authorizer. - [Create an Amazon Cognito authorizer for a REST API using CloudFormation](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-cognito-authorizer-cfn.md): Learn how to create an Amazon Cognito authorizer for a REST API using CloudFormation ### [Integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-integration-settings.md) Learn how to configure an integration request and integration response of a method with a backend. ### [Integration request](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-integration-settings-integration-request.md) Learn how to set up an integration request in API Gateway. - [Basic tasks of an API integration request](https://docs.aws.amazon.com/apigateway/latest/developerguide/integration-request-basic-setup.md): An integration request is an HTTP request that API Gateway submits to the backend, passing along the client-submitted request data, and transforming the data, if necessary. - [Choose an API integration type](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-integration-types.md): Learn about the supported API integration types in API Gateway. - [Set up proxy integrations with a proxy resource](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.md): Learn about the proxy resource and the proxy integration in API Gateway. - [Set up integration request using the console](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-method-settings-console.md): Learn how to set up an API integration request using the API Gateway console. - [Integration response](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-integration-settings-integration-response.md): Learn how to set up an integration response in API Gateway ### [Lambda integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-integrations.md) Learn how to configure Lambda integrations in API Gateway. ### [Lambda proxy integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.md) Learn how to configure a Lambda proxy integration request and integration response in API Gateway. - [Set up Lambda proxy integration for API Gateway using the AWS CLI](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integration-using-cli.md): In this section, we show how to set up an API with the Lambda proxy integration using the AWS CLI. - [Set up a proxy resource with Lambda proxy integration with an OpenAPI definition](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-lambda-proxy-integration-on-proxy-resource.md): To set up a proxy resource with the Lambda proxy integration type, create an API resource with a greedy path parameter (for example, /parent/{proxy+}) and integrate this resource with a Lambda function backend (for example, arn:aws:lambda:us-west-2:123456789012:function:SimpleLambda4ProxyResource) on the ANY method. - [Set up Lambda custom integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-custom-integrations.md): Learn how to configure a Lambda custom integration request and integration response in API Gateway. - [Set up asynchronous invocation of the backend Lambda function](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-integration-async.md): Learn about Lambda asynchronous invocation in Lambda integrations. - [Handle Lambda errors in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/handle-errors-in-lambda-integration.md): How to handle Lambda errors in API Gateway. - [HTTP integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/setup-http-integrations.md): Learn how to configure HTTP integrations in API Gateway. ### [Stream the integration response for your proxy integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-transfer-mode.md) Learn how to set the response transfer mode for your proxy integrations - [Set up an HTTP proxy integration with payload response streaming](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-streaming-http.md): Learn how to set the response transfer mode for a new HTTP proxy integration ### [Set up a Lambda proxy integration with payload response streaming](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-transfer-mode-lambda.md) Learn how to set the response transfer mode for a new Lambda proxy integration - [Configure a Lambda proxy integration with payload response streaming](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-streaming-lambda-configure.md): Learn how to create a Lambda proxy integration with response streaming. - [Troubleshoot issues with response streaming](https://docs.aws.amazon.com/apigateway/latest/developerguide/response-streaming-troubleshoot.md): Learn how to troubleshoot the response transfer mode for your integrations ### [Private integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/private-integration.md) Learn how to set up private integrations for a REST API. - [VPC links V2](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-vpc-links-v2.md): Learn about working with VPC links for private integrations. - [Set up a private integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-private-integration.md): Learn how to set up private integrations for a REST API. ### [Private integration using VPC links V1 (legacy)](https://docs.aws.amazon.com/apigateway/latest/developerguide/vpc-links-v1.md) - [Set up a Network Load Balancer for private integrations (legacy)](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-nlb-for-vpclink-using-console.md): Learn how to set up a Network Load Balancer for private integrations. - [Grant permissions for API Gateway to create a VPC link (legacy)](https://docs.aws.amazon.com/apigateway/latest/developerguide/grant-permissions-to-create-vpclink.md): Learn how to grant permissions to create a VPC link. - [Set up an API with private integrations using AWS CLI (legacy)](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-api-with-vpclink-cli.md): Learn how to set up an API Gateway API with private integrations. - [API Gateway accounts used for private integrations (legacy)](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-api-with-vpclink-accounts.md): Learn how to set up an API Gateway API with private integrations. ### [Mock integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration.md) Learn how to configure mock integration for a method in API Gateway. - [Enable mock integration using the API Gateway console](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-mock-integration-console.md): You must have a method available in API Gateway. ### [Request validation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.md) Describes how to turn on request validation on methods for API Gateway. - [Data models for REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings-models.md): Learn about what a data model is for API Gateway. - [Set up basic request validation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-validation-set-up.md): Learn how to set up basic request validation in API Gateway. - [AWS CloudFormation template of a sample API with basic request validation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-validation-sample-cloudformation.md): CloudFormation example of request validation ### [Data transformations](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-data-transformations.md) Learn how to set up request data mappings in integration request and how to set response data mappings in integration response. ### [Parameter mapping](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-parameter-mapping.md) How to map parameters in API Gateway. - [Parameter mapping examples](https://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.md): Set up data mappings from an API method request to the method response parameters in Amazon API Gateway. - [Parameter mapping source reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-parameter-mapping-sources.md): Reference for parameter mapping ### [Mapping template transformations](https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.md) In Amazon API Gateway, pass an API request response payload between your API methods and the backend HTTP, AWS Lambda or AWS integrations. - [Method request behavior for payloads without mapping templates](https://docs.aws.amazon.com/apigateway/latest/developerguide/integration-passthrough-behaviors.md): How you can configure method request behavior for payloads without mapping templates in API Gateway - [Additional mapping template example](https://docs.aws.amazon.com/apigateway/latest/developerguide/example-photos.md): Additional example for data mapping template transformations. - [Override your API's request and response parameters and status codes](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.md): Learn about mapping template overrides for your API's request and response parameters and status codes. - [Tutorial: Modify the integration request and response for integrations to AWS services](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-data-transformations-in-api-gateway.md): Learn how to set up a data transformation in API Gateway. - [Examples using variables for mapping template transformations](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-variable-examples.md): Example using context, input, and util variables. - [Variables for data transformations](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.md): Reference for variables and functions used in data transformations ### [Gateway responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-gatewayResponse-definition.md) Learn how to set up gateway responses to customize error responses. - [Set up a gateway response for a REST API using the API Gateway console](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-gateway-response-using-the-console.md): Learn how to set up a gateway response for a REST API. - [Set up a gateway response using the API Gateway REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-gateway-response-using-the-api.md): Learn how to set up a gateway response for a REST API. - [Set up gateway response customization in OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-gateway-responses-in-swagger.md): You can use the x-amazon-apigateway-gateway-responses extension at the API root level to customize gateway responses in OpenAPI. - [Gateway response types for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.md): Learn about the gateway response types. ### [CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors.md) Learn what cross-origin resource sharing (CORS) is, whether you want to enable it, and how to enable CORS methods in API Gateway. - [Enable CORS using the console](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-cors-console.md): Learn how to enable CORS on a resource using the API Gateway console. - [Enable CORS using OpenAPI definition](https://docs.aws.amazon.com/apigateway/latest/developerguide/enable-cors-for-resource-using-swagger-importer-tool.md): Learn how to enable CORS on a resource using an OpenAPI definition. - [Test CORS for an API Gateway API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-test-cors.md): Learn how to test CORS. ### [Binary media types](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.md) Set up content encoding conversion in API Gateway to support binary media types. - [Content type conversions in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-workflow.md): Convert content types in API Gateway. - [Enabling binary support using the API Gateway console](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-configure-with-console.md): Enable binary support in the API Gateway console. - [Enabling binary support using the API Gateway REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-configure-with-control-service-api.md): Enable binary support using the API Gateway REST API. - [Import and export content encodings for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings-import-and-export.md): Import and export content encodings using an API Gateway extension to the API's OpenAPI definition file. - [Return binary media from a Lambda proxy integration in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/lambda-proxy-binary-media.md): Example code to return binary media and text data from an AWS Lambda proxy integration. - [Access binary files in Amazon S3 through an API Gateway API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-content-encodings-examples-image-s3.md): Examples showing how to access binary files in Amazon S3 using an API Gateway API. - [Access binary files in Lambda using an API Gateway API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-content-encodings-examples-image-lambda.md): Example showing how to access binary files in Lambda using an API Gateway API. ### [Invoke](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-call-api.md) Learn how to call a deployed REST API in Amazon API Gateway. - [Use the console to test a REST API method](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-test-method.md): Learn how to test a method in API Gateway. - [Use a Java SDK generated by API Gateway for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-call-apigateway-generated-java-sdk.md): In this section, we outline the steps to use a Java SDK generated by API Gateway for a REST API, by using the Simple Calculator API as an example. - [Use an Android SDK generated by API Gateway for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk-android.md): How to use an Android SDK that you generated by using API Gateway. - [Use a JavaScript SDK generated by API Gateway for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk-javascript.md): How to use a JavaScript SDK that you generated by API Gateway. - [Use a Ruby SDK generated by API Gateway for a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-call-sdk-ruby.md): How to use a Ruby SDK generated by API Gateway. - [Use iOS SDK generated by API Gateway for a REST API in Objective-C or Swift](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk-ios.md): How to use an iOS SDK that you generated by using API Gateway. ### [OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.md) Learn how to import an API into API Gateway with an OpenAPI definition file. - [Import an edge-optimized API](https://docs.aws.amazon.com/apigateway/latest/developerguide/import-edge-optimized-api.md): Learn how to import an edge-optimized API into API Gateway - [Import a Regional API](https://docs.aws.amazon.com/apigateway/latest/developerguide/import-export-api-endpoints.md): Learn how to import the OpenAPI defintion of a Regional API. - [Import an OpenAPI file to update an existing API definition](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-update.md): You can import API definitions only to update an existing API, without changing its endpoint configuration, as well as stages and stage variables, or references to API keys. - [Set the OpenAPI basePath property](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-basePath.md): In OpenAPI 2.0, you can use the basePath property to provide one or more path parts that precede each path defined in the paths property. - [AWS variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/import-api-aws-variables.md): You can use the following AWS variables in OpenAPI definitions. - [Errors and warnings from importing your API into API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api-errors-warnings.md): When you import your external definition file into API Gateway, API Gateway might generate warnings and errors. - [Export a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-export-api.md): Export an existing REST API from API Gateway to OpenAPI and other API definition files. ### [Publish](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-publish.md) Learn about publishing REST APIs. ### [Deploy REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-deploy-api.md) Learn how to deploy a REST API in Amazon API Gateway. - [Create a deployment](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-deployments.md): Learn how to set up and manage API deployments in Amazon API Gateway. ### [Set up a stage](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.md) Learn how to set up and manage stages in Amazon API Gateway. - [Add a stage to an Amazon Bedrock AgentCore Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/mcp-server.md): Use an AgentCore Gateway to expose your REST API into a Model Context Protocol (MCP)-compatible tool. - [Delete a stage](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-delete-stage.md): Learn how to delete a stage in API Gateway. - [Set up tags](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-tags.md): Learn how to set up and manage tags in Amazon API Gateway. ### [Use stage variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/stage-variables.md) Learn how to work with stage variables in Amazon API Gateway. - [Set up stage variables for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-set-stage-variables-aws-console.md): Learn how to work with stage variables in Amazon API Gateway. - [Stage variables reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/aws-api-gateway-stage-variables-reference.md): Learn about the stage variable reference for REST APIs. ### [Set up a canary release deployment](https://docs.aws.amazon.com/apigateway/latest/developerguide/canary-release.md) Learn how to set up a canary release deployment to test API updates in Amazon API Gateway. - [Create a canary release deployment](https://docs.aws.amazon.com/apigateway/latest/developerguide/create-canary-deployment.md): You create a canary release deployment when deploying the API with canary settings as an additional input to the deployment creation operation. - [Update a canary release](https://docs.aws.amazon.com/apigateway/latest/developerguide/update-canary-deployment.md): After a canary release is deployed, you may want to adjust the percentage of the canary traffic or enable or disable the use of a stage cache to optimize the test performance. - [Promote a canary release](https://docs.aws.amazon.com/apigateway/latest/developerguide/promote-canary-deployment.md): When you promote a canary release, the canary release replaces the current stage settings. - [Turn off a canary release](https://docs.aws.amazon.com/apigateway/latest/developerguide/delete-canary-deployment.md): To turn off a canary release deployment is to set the canarySettings to null to remove it from the stage. - [Redeploy a REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/updating-api.md): Update a REST API in Amazon API Gateway. ### [Custom domain names](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.md) Learn how to set up a custom domain name for a REST API in API Gateway. - [Get certificates ready in AWS Certificate Manager](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-specify-certificate-for-custom-domain-name.md): Before setting up a custom domain name for an API, you must have an SSL/TLS certificate ready in AWS Certificate Manager. - [Set up a Regional custom domain name](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.md): Learn how to create and maintain a custom domain name for an API Gateway Regional API endpoint. - [Set up an edge-optimized custom domain name in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-edge-optimized-custom-domain-name.md): Learn how to create an edge-optimized custom domain name. - [Migrate custom domain names](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-migrate.md): Learn how to migrate a custom domain name between a Regional API endpoint and an edge-optimized API endpoint. ### [Send traffic to your APIs through your custom domain name in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-mode.md) Learn about the different ways you can send traffic to your APIs through your custom domain name in API Gateway. - [Set the routing mode for your custom domain name](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-routing-mode.md): How to set the routing mode for custom domain names. ### [Routing rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.md) Learn about REST API routing rules. - [Examples of how API Gateway evaluates routing rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules-examples.md): Examples of how API Gateway evaluates routing rules - [How to use routing rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-routing-rules-use.md): How to create and update the priority of a routing rule. - [Recreate an API mapping using routing rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules-recreate-api-mapping.md): Recreate an API mapping using routing rules - [Troubleshooting issues with routing rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules-troubleshoot.md): How to troubleshoot your routing rules - [API mappings](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-mappings.md): Learn about REST API mappings for custom domain names. - [IP address types for custom domain names in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-custom-domain-ip-address-type.md): Learn about changing the IP address type for custom domain names - [Choose a security policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.md): Learn how to choose a security policy for your custom domain. - [Disable the default endpoint](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-disable-default-endpoint.md): Learn how to disable the default endpoint for a REST API in API Gateway. - [DNS failover](https://docs.aws.amazon.com/apigateway/latest/developerguide/dns-failover.md): Learn to configure DNS failover for a multi-Region API Gateway architecture. ### [Optimize](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-optimize.md) Learn about optimizing REST APIs. - [Cache settings](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.md): Learn how to enable Amazon API Gateway caching to enhance your API's performance. ### [Content encoding](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-gzip-compression-decompression.md) In API Gateway, learn how to enable GZIP compression of a response payload and decompression of a request payload. - [Enable payload compression for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-enable-compression.md): Learn how to enable and disable compression for an API by using the API Gateway console, the AWS CLI, and the API Gateway REST API. - [Call a method with a compressed payload](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-make-request-with-compressed-payload.md): Learn how to make an API request with a compressed payload. - [Receive a response with a compressed payload](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-receive-response-with-compressed-payload.md): Learn how to receive an API response with a compressed payload. ### [Distribute](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-distribute.md) Learn about distributing REST APIs. ### [Usage plans](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.md) Learn how to create, configure, and optimize API usage plans in Amazon API Gateway. - [Choose an API key source in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-key-source.md): Learn about choosing a key source for your API key - [API Gateway API key file format](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.md): See the API key file format for an API Gateway usage plan. - [Set up API keys for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-setup-api-keys.md): Learn how to set up API keys. - [Set up usage plans for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans.md): Create, configure, and test usage plans. - [Maintain a usage plan for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-usage-plan-manage-usage.md): Maintaining a usage plan involves monitoring the used and remaining quotas over a given time period and, if needed, extending the remaining quotas by a specified amount. - [Create and configure API keys and usage plans with CloudFormation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-usage-plan-cfn.md): Learn how to create, configure, and test API keys and usage plans with CloudFormation. - [Configure a method to use API keys with an OpenAPI definition](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-usage-plan-oas.md): You can use an OpenAPI definition to require API keys on a method. - [Test usage plans for REST APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-usage-plan-test-with-postman.md): Learn how to test a usage plan with the API Gateway CLI and REST API. - [Call a method using an API key](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-key-call.md): Depending on the API key source type you choose, use one of the following procedures to use header-sourced API keys or authorizer-returned API keys in method invocation: ### [API documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api.md) Learn how to provide documentation support for an API Gateway REST API. - [Representation of API documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.md): Describes representation of API documentation in API Gateway. - [Document an API using the API Gateway console](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-quick-start-with-console.md): Use the API Gateway console to document an API. - [Publish API documentation using the API Gateway console](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-documenting-api-with-console.md): Use the API Gateway console to publish API documentation. - [Document an API using the API Gateway REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-quick-start-with-restapi.md): Use the API Gateway REST API to document an API. - [Publish API documentation using the API Gateway REST API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-quick-start-publishing.md): Get a documentation snapshot and associate it with an API stage in API Gateway. - [Import API documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-quick-start-import-export.md): Import documentation parts from OpenAPI to an API using API Gateway. - [Control access to API documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-provision-and-consumption.md): Control access to your API documentation. ### [SDK generation](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk.md) Learn how to generate a language-specific and platform-specific SDK for an API you created in API Gateway. - [Simple calculator Lambda function](https://docs.aws.amazon.com/apigateway/latest/developerguide/simple-calc-nodejs-lambda-function.md): Demonstrates a simple calculator Lambda function. - [Simple calculator API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/simple-calc-lambda-api.md): Demonstrates a simple calculator API in API Gateway. - [Simple calculator API OpenAPI definition](https://docs.aws.amazon.com/apigateway/latest/developerguide/simple-calc-lambda-api-swagger-definition.md): Demonstrates a simple calculator API OpenAPI definition. - [Generate the Java SDK of an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/generate-java-sdk-of-an-api.md): The following procedure shows how to generate the Java SDK of an API in API Gateway. - [Generate the Android SDK of an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/generate-android-sdk-of-an-api.md): Learn how to generate the Android SDK of an API. - [Generate the iOS SDK of an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/generate-ios-sdk-of-an-api.md): Learn how to generate the iOS SDK of an API. - [Generate the JavaScript SDK of a REST API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/generate-javascript-sdk-of-an-api.md): Learn how to generate the JavaScript SDK of an API. - [Generate the Ruby SDK of an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/generate-ruby-sdk-of-an-api.md): Learn how to generate the Ruby SDK of an API. - [Generate SDKs for an API using AWS CLI commands in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-generate-sdk-cli.md): Learn how to generate the SDKs for an API using AWS CLI commands. - [Sell your APIs as SaaS](https://docs.aws.amazon.com/apigateway/latest/developerguide/sell-api-as-saas-on-aws-marketplace.md): Learn how to sell your APIs as a Software as a Service (SaaS) product through AWS Marketplace. ### [Protect](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-protect.md) Learn about protecting REST APIs. - [Require client certificates](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-mutual-tls.md): Learn how to require client certificates for mutual TLS authentication on your REST API. ### [Backend client certificates](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-backend-authentication.md) Learn how to configure API Gateway to present client certificates to backend services for mutual TLS authentication. - [How it works](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-backend-auth-overview.md): Learn how API Gateway presents client certificates to backend services during the TLS handshake. - [Use your own ACM certificate](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-acm-client-certificates.md): Learn how to import or issue a certificate in AWS Certificate Manager and configure API Gateway to present it to backend services for mutual TLS. - [API Gateway-generated certificates](https://docs.aws.amazon.com/apigateway/latest/developerguide/getting-started-client-side-ssl-authentication.md): Learn how to generate and use an API Gateway self-signed certificate for backend authentication. - [Supported certificate authorities for HTTP and HTTP proxy integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-supported-certificate-authorities-for-http-endpoints.md): Learn how to enable client-side SSL Authentication of an API using API Gateway console. - [AWS WAF](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.md): Learn how to configure AWS WAF to protect your Amazon API Gateway APIs. - [Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.md): Understand and change API request throttling limits on an account level, stage level, and method level. ### [Private REST APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-apis.md) Provides an overview of API Gateway private APIs. - [Create a private API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-api-create.md): Learn how to create a private REST API ### [Custom domain names for private APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.md) Provides an overview of API Gateway custom domain names for private APIs. - [API providers and API consumers](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-associations.md): Provides an overview of API Gateway private custom domains providers and consumers. - [Tutorial: Create and invoke a custom domain name for private APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-tutorial.md): Shows how to create a private custom domain name in your own account ### [Working with cross-account private custom domain names](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-other-accounts.md) Work with a private custom domain name in another AWS account. - [API provider: Share your private custom domain name using AWS RAM](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-provider-share.md): Shows how provide access to API consumers in other accounts using AWS RAM. - [API provider: Stop sharing a private custom domain name using AWS RAM](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-provider-stop-sharing.md): Shows how deny access to API consumers in other accounts using AWS RAM. - [API provider: Share your private custom domain name using the API Gateway AWS CLI](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-provider-share-cli.md): Shows how provide access to API consumers in other accounts using the API Gateway AWS CLI. - [API consumer: Associate your VPC endpoint with a private custom domain name shared with you](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-consumer-create.md): Create an association with a private custom domain name in another AWS account. - [API consumer: Delete your domain name access association with a private custom domain name](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-consumer-delete-domain-name-access-association.md): Delete an association with a private custom domain name in another AWS account. - [Create a custom domain name for private APIs using CloudFormation](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains-cfn.md): CloudFormation example of a private custom domain name - [Invoke a private API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-api-test-invoke-url.md): Learn how to specify the base invoke URL of a private API. ### [Monitor](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-monitor.md) Learn about monitoring REST APIs. ### [CloudWatch metrics](https://docs.aws.amazon.com/apigateway/latest/developerguide/monitoring-cloudwatch.md) Learn how to monitor your REST API API with CloudWatch metrics. - [Amazon API Gateway dimensions and metrics](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-metrics-and-dimensions.md): The metrics and dimensions that API Gateway sends to Amazon CloudWatch are listed below. - [View metrics with the API dashboard](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-dashboard.md): Learn how to view CloudWatch metrics of a deployed API using the API Dashboard in the API Gateway Console. - [View metrics in the CloudWatch console](https://docs.aws.amazon.com/apigateway/latest/developerguide/metrics_dimensions_view_in_cloud_watch.md): Metrics are grouped first by the service namespace, and then by the various dimension combinations within each namespace. - [View log event in the CloudWatch console](https://docs.aws.amazon.com/apigateway/latest/developerguide/view-cloudwatch-log-events-in-cloudwatch-console.md): The following section explains the necessary prerequisites and how to view API Gateway log events in the CloudWatch console. - [Monitoring tools in AWS for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/monitoring_automated_manual.md): Configure AWS tools to monitor API Gateway. ### [CloudWatch logs](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.md) Learn how to set up CloudWatch logging in Amazon API Gateway. ### [Execution logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-execution-logging.md) Learn about execution logging for REST APIs, including standard logging and Amazon CloudWatch Logs delivery. - [Create a log delivery](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-create-log-delivery.md): Create a Amazon CloudWatch Logs delivery to route REST API execution logs to your own destinations. - [Verify log delivery](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-verify-log-delivery.md): Verify that your Amazon CloudWatch Logs delivery is routing REST API execution logs to your destinations. - [Delete a log delivery](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-delete-log-delivery.md): Delete a Amazon CloudWatch Logs delivery to stop routing execution logs to your destinations. ### [Access logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-access-logging.md) Learn how to set up access logging for REST APIs. - [Firehose](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-logging-to-kinesis.md): Learn how to use Amazon Data Firehose as a destination for access logging. - [Variables for access logging for API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-variables-for-access-logging.md): Reference for variables access logging, etc. ### [X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.md) Learn how to use AWS X-Ray to trace API invocation. - [Set up AWS X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.md): Learn how to enable AWS X-Ray in Amazon API Gateway. - [Use AWS X-Ray service maps and trace views](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-using-xray-maps.md): Learn how to use AWS X-Ray service maps and trace views in Amazon API Gateway. - [Configure AWS X-Ray sampling rules](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-configuring-xray-sampling-rules.md): Learn how to configure AWS X-Ray sampling rules. - [X-Ray traces](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-understanding-xray-traces.md): Learn how to understand AWS X-Ray traces. ## [API Gateway portals](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals.md) ### [Portal product](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-portal-product.md) Learn about what a portal product is. - [Create a portal product](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-create-portal-product.md): Learn how to create a portal product - [Create a product REST endpoint](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-create-product-rest-endpoint.md): Learn how to create a portal product - [Create a product page](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-create-product-page.md): Learn how to create a portal product - [Update a portal product](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-update-portal-product.md): Learn how to update a portal product - [Update a product REST endpoint](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-update-product-endpoint.md): Learn how to update a product endpoint - [Update product page](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-update-product-page.md): Learn how to update a product page ### [Share portal products](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-share-resources.md) Learn how to share a product - [Share your portal product with a portal owner](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-share-products.md): Learn how to share a product - [Add a shared portal product to your portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-use-shared-products.md): Learn how to share a product - [Enable try it for a product REST endpoint in your portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-try-it.md): Learn how to try a product in your portal - [Delete a portal product](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-delete-product.md): Learn how to delete a portal product - [Create a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-create-portal.md): Learn how to create a portal - [Update a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-update-portal.md): Learn how to update your portal - [Preview a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-prview-portal.md): Learn how to preview your portal - [Publish a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-publish-portal.md): Learn how to create a product - [Use a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-use-portal.md): Learn how to use an API portal - [Disable a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-disable-portal.md): Learn how to disable an API portal - [Delete a portal](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-portals-delete-portal.md): Learn how to delete an API portal ## [API Gateway HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.md) ### [Develop](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.md) Learn about developing HTTP APIs. - [Routes](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.md): Learn about developing HTTP API routes. - [IP address types for HTTP APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.md): Learn about changing the IP address type ### [Access control](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control.md) Learn how to control access to an HTTP API. - [Lambda authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-lambda-authorizer.md): Learn about AWS Lambda authorizers for Amazon API Gateway HTTP APIs. - [JWT authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.md): Learn about JWT authorization for HTTP APIs. - [IAM authorization](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-access-control-iam.md): Learn about IAM authorization for Amazon API Gateway HTTP APIs. ### [Integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.md) Learn about developing HTTP API integrations. - [AWS Lambda integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.md): Learn about developing HTTP API AWS Lambda integrations. - [HTTP integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-http.md): Learn about developing HTTP API HTTP proxy integrations. ### [AWS service integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.md) Learn about developing HTTP API AWS service integrations. - [AWS service integrations reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services-reference.md): Learn about the required and optional parameters for HTTP API AWS service integrations. - [Private integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-private.md): Learn about developing HTTP API private integrations. - [CORS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.md): Learn how to configure CORS for an HTTP API. - [Parameter mapping](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.md): Learn how to set up parameter mapping to modify API requests and responses for Amazon API Gateway HTTP APIs. ### [OpenAPI](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.md) Learn about importing OpenAPI definitions for HTTP APIs. - [Export](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.md): Learn about exporting an OpenAPI 3.0 definition of an API Gateway HTTP API. ### [Publish](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-publish.md) Learn about publishing HTTP APIs. ### [Stages](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.md) Learn about HTTP API stages. - [Use stage variables for HTTP APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.stage-variables.md): Learn about HTTP API stages in API Gateway. - [API Gateway stage variables reference for HTTP APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.stage-variables-reference.md): Learn about the HTTP API stages variable reference. - [Security policy for HTTP APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ciphers.md): Learn about the security policy for your HTTP APIs. ### [Custom domain names](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-custom-domain-names.md) Learn how to set up a custom domain name for an HTTP API in API Gateway. - [API mappings](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-mappings.md): Learn about HTTP API API mappings for custom domain names. - [Disable the default endpoint](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-disable-default-endpoint.md): Learn how to disable the default endpoint for an HTTP API in API Gateway. - [IP address types for custom domain names for HTTP APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-custom-domain-names-ip-address-type.md): Learn about changing the IP address type ### [Protect](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-protect.md) Learn about protecting HTTP APIs by throttling requests and enabling mutual TLS authentication. - [Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-throttling.md): Learn about protecting HTTP APIs by throttling requests. - [Mutual TLS](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-mutual-tls.md): Learn about configuring mutual TLS authentication for an HTTP API. ### [Monitor](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-monitor.md) Learn about monitoring HTTP APIs. - [Metrics](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-metrics.md): Learn about metrics for HTTP APIs. ### [Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging.md) Learn how to configure logging for an HTTP API. - [Logging variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging-variables.md): Learn about the access logging variables for HTTP APIs. ### [Troubleshooting](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-troubleshooting.md) Learn about troubleshooting for HTTP APIs. - [Lambda integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-troubleshooting-lambda.md): Learn about troubleshooting Lambda integrations for HTTP APIs. - [JWT authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-troubleshooting-jwt.md): Learn about troubleshooting JWT authorizers for HTTP APIs. ## [API Gateway WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.md) ### [Overview of WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-overview.md) Learn about WebSocket APIs - [Manage connected users and client apps](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-keys-connect-disconnect.md): Learn about how to manage connected users and client apps for WebSocket APIs. - [Invoke your backend integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-routes-integrations.md): Learn about invoking your backend integration. - [WebSocket selection expressions](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.md): Learn about WebSocket selection expressions ### [Develop](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop.md) Learn about developing WebSocket APIs. - [Create and configure](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-create-empty-api.md): Learn how to create a WebSocket API. - [IP address types for WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-ip-address-type.md): Learn about changing the IP address type ### [Routes](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop-routes.md) Learn about developing WebSocket API routes. - [Set up WebSocket API route responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-route-response.md): Learn how to set up a route response for a WebSocket API. - [Subprotocol support](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-connect-route-subprotocol.md): Learn how to configure a WebSocket API $connect route that requires that clients use a supported subprotocol. ### [Access control](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-control-access.md) Learn how to control access to a WebSocket API. - [Control access to WebSocket APIs with IAM authorization](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-control-access-iam.md): Learn how to use IAM authorization for a WebSocket API - [Control access to WebSocket APIs with AWS Lambda REQUEST authorizers](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-lambda-auth.md): Learn how to create a Lambda authorizer function. ### [Integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.md) Learn how to add integrations to a WebSocket API. - [Integration request](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.md): Setting up an integration request involves the following: - [Integration responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.md): The following section provides a brief overview of integration responses for WebSocket API and how to set up an integration response for a WebSocket API. - [Request validation](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-request-validation.md): Learn how to validate requests for WebSocket APIs. ### [Data transformations](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-data-transformations.md) Learn how to set up request and response data transformations for WebSocket APIs. - [Data mapping](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-data-mapping.md): Learn how to set up data mapping for WebSocket APIs. - [WebSocket mapping template reference](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-mapping-template-reference.md): Learn about the mapping template reference for API Gateway for WebSocket APIs. - [Binary media types](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-develop-binary-media-types.md): Learn about working with binary media types for WebSocket APIs. ### [Invoke](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api.md) Learn how to invoke a WebSocket API. - [Use wscat to connect to a WebSocket API and send messages to it](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-wscat.md): Learn how to use wscat to connect to a WebSocket API. - [Use @connections commands in your backend service](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.md): Learn how to use @connections commands in your backend service for a WebSocket API. ### [Publish](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-publish.md) Learn about publishing WebSocket APIs. - [Stages](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-stages.md): Learn about WebSocket API stages. - [Deploy a WebSocket API](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-set-up-websocket-deployment.md): Learn how to set up and manage WebSocket API deployments in Amazon API Gateway. - [Security policy for WebSocket APIs in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-ciphers.md): Learn about the security policy for WebSocket APIs. ### [Custom domain names](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-custom-domain-names.md) Learn how to set up a custom domain name for a WebSocket API in API Gateway. - [API mappings](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-mappings.md): Learn about WebSocket API mappings for custom domain names. - [IP address types for custom domain names for WebSocket APIs](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-custom-domain-names-ip-address-type.md): Learn about changing the IP address type - [Disable the default endpoint](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-disable-default-endpoint.md): Learn how to disable the default endpoint for an WebSocket API in API Gateway. - [Protect](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-protect.md): Learn about protecting WebSocket APIs by throttling requests. ### [Monitor](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-monitor.md) Learn about monitoring WebSocket APIs. - [Metrics](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.md): Learn about monitoring WebSocket API with CloudWatch metrics - [Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/websocket-api-logging.md): Learn how to configure logging for a WebSocket API. ## [OpenAPI extensions](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions.md) - [x-amazon-apigateway-any-method](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-any-method.md): Specifies the OpenAPI Operation Object for the API Gateway catch-all ANY method in an OpenAPI Path Item Object. - [x-amazon-apigateway-cors](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-cors-configuration.md): Specifies the cross-origin resource sharing (CORS) configuration for an HTTP API. - [x-amazon-apigateway-api-key-source](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.md): Specify the source to receive an API key to throttle API methods that require a key. - [x-amazon-apigateway-auth](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-auth.md): Defines an authorization type to be applied for authorization of method invocations in API Gateway. - [x-amazon-apigateway-authorizer](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authorizer.md): Defines a Lambda authorizer, Amazon Cognito user pool, or JWT authorizer to be applied for authorization of method invocations in API Gateway. - [x-amazon-apigateway-authtype](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-authtype.md): For REST APIs, this extension can be used to define a custom type of a Lambda authorizer. - [x-amazon-apigateway-binary-media-type](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.md): Specifies the list of binary media types to be supported by API Gateway, such as application/octet-stream and image/jpeg. - [x-amazon-apigateway-documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-documentation.md): Defines the documentation parts to be imported into API Gateway. - [x-amazon-apigateway-endpoint-access-mode](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-endpoint-access-mode.md): Specifies a the endpoint access mode for a REST API or custom domain name. - [x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.md): Specifies details of the endpoint configuration for an API. - [x-amazon-apigateway-gateway-responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.md): Defines the gateway responses for an API as a string-to-GatewayResponse map of key-value pairs. - [x-amazon-apigateway-gateway-responses.gatewayResponse](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.gatewayResponse.md): Defines a gateway response of a given response type, including the status code, any applicable response parameters, or response templates. - [x-amazon-apigateway-gateway-responses.responseParameters](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseParameters.md): Defines a string-to-string map of key-value pairs to generate gateway response parameters from the incoming request parameters or using literal strings. - [x-amazon-apigateway-gateway-responses.responseTemplates](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-gateway-responses.responseTemplates.md): Defines GatewayResponse mapping templates, as a string-to-string map of key-value pairs, for a given gateway response. - [x-amazon-apigateway-importexport-version](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-importexport-version.md): Specifies the version of the API Gateway import and export algorithm for HTTP APIs. - [x-amazon-apigateway-integration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration.md): Specifies details of the backend integration used for this method. - [x-amazon-apigateway-integrations](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integrations.md): Defines a collection of integrations. - [x-amazon-apigateway-integration.requestTemplates](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestTemplates.md): Specifies mapping templates for a request payload of the specified MIME types. - [x-amazon-apigateway-integration.requestParameters](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-requestParameters.md): For REST APIs, specifies mappings from named method request parameters to integration request parameters. - [x-amazon-apigateway-integration.responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responses.md): Defines the method's responses and specifies parameter mappings or payload mappings from integration responses to method responses. - [x-amazon-apigateway-integration.response](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-response.md): Defines a response and specifies parameter mappings or payload mappings from the integration response to the method response. - [x-amazon-apigateway-integration.responseTemplates](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseTemplates.md): Specifies mapping templates for a response payload of the specified MIME types. - [x-amazon-apigateway-integration.responseParameters](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-integration-responseParameters.md): Specifies mappings from integration method response parameters to method response parameters. - [x-amazon-apigateway-integration.tlsConfig](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-extensions-integration-tls-config.md): Specifies the TLS configuration for an integration. - [x-amazon-apigateway-minimum-compression-size](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-minimum-compression-size.md): Specifies the minimum compression size for a REST API. - [x-amazon-apigateway-policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-policy.md): Specifies a resource policy for a REST API. - [x-amazon-apigateway-request-validator](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validator.md): Specifies a request validator, by referencing a request_validator_name of the x-amazon-apigateway-request-validators object map, to enable request validation on the containing API or a method. - [x-amazon-apigateway-request-validators](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.md): Defines the supported request validators for the containing API as a map between a validator name and the associated request validation rules. - [x-amazon-apigateway-request-validators.requestValidator](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-request-validators.requestValidator.md): Specifies the validation rules of a request validator as part of the x-amazon-apigateway-request-validators object map definition. - [x-amazon-apigateway-security-policy](https://docs.aws.amazon.com/apigateway/latest/developerguide/openapi-extensions-security-policy.md): Specifies a security policy for a REST API. - [x-amazon-apigateway-tag-value](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-openapi-extensions-x-amazon-apigateway-tag-value.md): Specifies the value of an AWS tag for an HTTP API. ## [Security](https://docs.aws.amazon.com/apigateway/latest/developerguide/security.md) ### [Data protection](https://docs.aws.amazon.com/apigateway/latest/developerguide/data-protection.md) Learn how the AWS shared responsibility model applies to data protection in Amazon API Gateway. - [Data encryption](https://docs.aws.amazon.com/apigateway/latest/developerguide/data-protection-encryption.md): Learn how the AWS shared responsibility model applies to data encryption in Amazon API Gateway. - [Internetwork traffic privacy](https://docs.aws.amazon.com/apigateway/latest/developerguide/security-traffic-privacy.md): Learn how Amazon API Gateway supports internetwork traffic privacy. ### [Identity and access management](https://docs.aws.amazon.com/apigateway/latest/developerguide/security-iam.md) How to authenticate requests and manage access your API Gateway resources. - [How Amazon API Gateway works with IAM](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.md): Before you use IAM to manage access to API Gateway, you should understand what IAM features are available to use with API Gateway. - [Identity-based policy examples](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_id-based-policy-examples.md): By default, IAM users and roles don't have permission to create or modify API Gateway resources. - [Resource-based policy examples](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_resource-based-policy-examples.md): For resource-based policy examples, see API Gateway resource policy examples. - [Troubleshooting](https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_troubleshoot.md): Use the following information to help you diagnose and fix common issues that you might encounter when working with API Gateway and IAM. - [Using service-linked roles](https://docs.aws.amazon.com/apigateway/latest/developerguide/using-service-linked-roles.md): How to use service-linked roles to give API Gateway access to resources in your AWS account. ### [Logging and monitoring](https://docs.aws.amazon.com/apigateway/latest/developerguide/security-monitoring.md) Tools in API Gateway for monitoring resources and responding to incidents. - [Working with CloudTrail](https://docs.aws.amazon.com/apigateway/latest/developerguide/cloudtrail.md): Learn about logging Amazon API Gateway with AWS CloudTrail. - [Working with AWS Config](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-config.md): Learn how to monitor API configuration using AWS Config. - [Compliance validation](https://docs.aws.amazon.com/apigateway/latest/developerguide/compliance-validation.md): Learn what AWS services are in scope of a specific compliance program. - [Resilience](https://docs.aws.amazon.com/apigateway/latest/developerguide/disaster-recovery-resiliency.md): Learn how AWS architecture supports data redundancy, and learn about specific Amazon API Gateway features for data resiliency. - [Infrastructure security](https://docs.aws.amazon.com/apigateway/latest/developerguide/infrastructure-security.md): Learn how Amazon API Gateway isolates service traffic. - [Configuration and vulnerability analysis](https://docs.aws.amazon.com/apigateway/latest/developerguide/vulnerability-analysis.md): Learn how the AWS shared responsibility model applies to vulnerability analysis in Amazon API Gateway. - [Best practices](https://docs.aws.amazon.com/apigateway/latest/developerguide/security-best-practices.md): Learn security best practices for Amazon API Gateway. ## [Tagging](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.md) - [API Gateway resources that can be tagged](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging-supported-resources.md): Tags can be set on the following HTTP API or WebSocket API resources in the Amazon API Gateway V2 API: - [Attribute-based access control](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging-iam-policy.md): Conditions in AWS Identity and Access Management policies are part of the syntax that you use to specify permissions to API Gateway resources. ## [Quotas and important notes](https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.md) - [REST API quotas](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-execution-service-limits-table.md): Quotas for configuring and running a REST API - [HTTP API quotas](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-quotas.md): Learn about quotas for an HTTP API. - [Portal quotas](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-portal-quotas.md): Quotas for a portal - [WebSocket API quotas](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-execution-service-websocket-limits-table.md): Learn about quotas for a WebSocket API. - [Important notes](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-known-issues.md): The following section details notes that might impact your use of API Gateway. ## Full content The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass: - [Complete guide (single file)](https://docs.aws.amazon.com/apigateway/latest/developerguide/full.md)