Amazon API Gateway Developer Guide 1.Dev [highlighted]
User Manual:
Open the PDF directly: View PDF
Page Count: 699 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- Amazon API Gateway
- Table of Contents
- What Is Amazon API Gateway?
- Creating, Deploying, and Invoking a WebSocket API in Amazon API Gateway
- About WebSocket APIs in API Gateway
- Create a WebSocket API in API Gateway
- Set up Routes for a WebSocket API in API Gateway
- Set up WebSocket API Integrations in API Gateway
- Set up Route Responses for a WebSocket API in API Gateway
- Deploy a WebSocket API in API Gateway
- Invoke a WebSocket API
- Control Access to a WebSocket API in API Gateway
- Monitor WebSocket API Execution with CloudWatch
- WebSocket Selection Expressions in API Gateway
- API Gateway WebSocket API Mapping Template Reference
- Creating a REST API in Amazon API Gateway
- Choose an Endpoint Type to Set up for an API Gateway API
- Initialize REST API Setup in API Gateway
- Set up an API Using the API Gateway Console
- Set up an Edge-Optimized API Using AWS CLI Commands
- Set up an Edge-Optimized API Using the AWS SDK for Node.js
- Set up an Edge-Optimized API Using the API Gateway REST API
- Set up an Edge-Optimized API by Importing OpenAPI Definitions
- Set up a Regional API in API Gateway
- Create a Private API in Amazon API Gateway
- Create an Interface VPC Endpoint for API Gateway execute-api
- Create a Private API Using the API Gateway Console
- Create a Private API Using the AWS CLI
- Create a Private API Using the AWS SDK for JavaScript
- Create a Private API Using the API Gateway REST API
- Set Up a Resource Policy for a Private API
- Deploy a Private API Using the API Gateway Console
- How to Invoke a Private API
- Private API Development Considerations
- Set up REST API Methods in API Gateway
- Set up REST API Integrations in API Gateway
- Set up an Integration Request in API Gateway
- Set up an Integration Response in API Gateway
- Set up Lambda Integrations in API Gateway
- Set up Lambda Proxy Integrations in API Gateway
- Understand API Gateway Lambda Proxy Integration
- Support for Multi-Value Headers and Query String Parameters
- Set up a Proxy Resource with Lambda Proxy Integration
- Set up Lambda Proxy Integration Using the AWS CLI
- Input Format of a Lambda Function for Proxy Integration
- Output Format of a Lambda Function for Proxy Integration
- Set up Lambda Custom Integrations in API Gateway
- Handle Lambda Errors in API Gateway
- Set up Lambda Proxy Integrations in API Gateway
- Set up HTTP Integrations in API Gateway
- Set up API Gateway Private Integrations
- Set up a Network Load Balancer for API Gateway Private Integrations
- Grant Permissions to Create a VPC Link
- Set up an API Gateway API with Private Integrations Using the API Gateway Console
- Set up an API Gateway API with Private Integrations Using the AWS CLI
- Set up API with Private Integrations Using OpenAPI
- Set up Mock Integrations in API Gateway
- Set up Gateway Responses to Customize Error Responses
- Set up API Gateway Request and Response Data Mappings
- Set up Request and Response Data Mappings Using the API Gateway Console
- Create Models and Mapping Templates for Request and Response Mappings
- Models
- Mapping Templates
- Tasks for Models and Mapping Templates
- Create a Model in API Gateway
- View a List of Models in API Gateway
- Use a Mapping Template to Override an API's Request and Response Parameters and Status Codes
- Tutorial: Override an API's Response Status Code with the API Gateway Console
- Tutorial: Override an API's Request Parameters and Headers with the API Gateway Console
- Examples: Override an API's Request Parameters and Headers with the API Gateway CLI
- Example: Override an API's Request Parameters and Headers Using the SDK for JavaScript
- Delete a Model in API Gateway
- Photos Example (API Gateway Models and Mapping Templates)
- News Article Example (API Gateway Models and Mapping Templates)
- Sales Invoice Example (API Gateway Models and Mapping Templates)
- Employee Record Example (API Gateway Models and Mapping Templates)
- Amazon API Gateway API Request and Response Data Mapping Reference
- API Gateway Mapping Template Reference
- Support Binary Payloads in API Gateway
- Content Type Conversions in API Gateway
- Enable Binary Support Using the API Gateway Console
- Enable Binary Support Using API Gateway REST API
- Import and Export Content Encodings
- Examples of Binary Support
- Enable Payload Compression for an API
- Enable Request Validation in API Gateway
- Import a REST API into API Gateway
- Controlling Access to an API in API Gateway
- Control Access to an API with Amazon API Gateway Resource Policies
- Control Access to an API with IAM Permissions
- API Gateway Permissions Model for Creating and Managing an API
- API Gateway Permissions Model for Invoking an API
- Control Access for Managing an API
- Control Cross-Account Access to Your API
- Control Access for Invoking an API
- IAM Policy Examples for Managing API Gateway APIs
- IAM Policy Examples for API Execution Permissions
- Create and Attach a Policy to an IAM User
- Use API Gateway Lambda Authorizers
- Types of API Gateway Lambda Authorizers
- Create an API Gateway Lambda Authorizer Lambda Function
- Input to an Amazon API Gateway Lambda Authorizer
- Output from an Amazon API Gateway Lambda Authorizer
- Configure Lambda Authorizer Using the API Gateway Console
- Call an API with API Gateway Lambda Authorizers
- Configure Cross-Account Lambda Authorizer
- Control Access to a REST API Using Amazon Cognito User Pools as Authorizer
- Enable CORS for an API Gateway REST API Resource
- Use Client-Side SSL Certificates for Authentication by the Backend
- Generate a Client Certificate Using the API Gateway Console
- Configure an API to Use SSL Certificates
- Test Invoke to Verify the Client Certificate Configuration
- Configure Backend HTTPS Server to Verify the Client Certificate
- Rotate an Expiring Client Certificate
- API Gateway-Supported Certificate Authorities for HTTP and HTTP Proxy Integrations
- Create and Use Usage Plans with API Keys
- What Are Usage Plans and API Keys?
- Steps to Configure a Usage Plan
- Choose an API Key Source
- Set Up API Keys Using the API Gateway Console
- Create, Configure, and Test Usage Plans with the API Gateway Console
- Set Up API Keys Using the API Gateway REST API
- Create, Configure, and Test Usage Plans Using the API Gateway CLI and REST API
- API Gateway API Key File Format
- Documenting a REST API in API Gateway
- Representation of API Documentation in API Gateway
- Document an API Using the API Gateway Console
- Document the API Entity
- Document a RESOURCE Entity
- Document a METHOD Entity
- Document a QUERY_PARAMETER Entity
- Document a PATH_PARAMETER Entity
- Document a REQUEST_HEADER Entity
- Document a REQUEST_BODY Entity
- Document a RESPONSE Entity
- Document a RESPONSE_HEADER Entity
- Document a RESPONSE_BODY Entity
- Document a MODEL Entity
- Document an AUTHORIZER Entity
- Document an API Using the API Gateway REST API
- Document the API Entity
- Document a RESOURCE Entity
- Document a METHOD Entity
- Document a QUERY_PARAMETER Entity
- Document a PATH_PARAMETER Entity
- Document a REQUEST_BODY Entity
- Document a REQUEST_HEADER Entity
- Document a RESPONSE Entity
- Document a RESPONSE_HEADER Entity
- Document an AUTHORIZER Entity
- Document a MODEL Entity
- Update Documentation Parts
- List Documentation Parts
- Publish API Documentation
- Import API Documentation
- Control Access to API Documentation
- Update and Maintain a REST API in Amazon API Gateway
- Deploying a REST API in Amazon API Gateway
- Deploy a REST API in in API Gateway
- Set up a Stage in API Gateway
- Set up a Stage Using the API Gateway Console
- Enable API Caching to Enhance Responsiveness
- Throttle API Requests for Better Throughput
- Set Up Client-Side SSL Authentication in API Gateway
- Use AWS WAF to Protect Your Amazon API Gateway API from Common Web Exploits
- Set up Tags for an API Stage in API Gateway
- Set Up CloudWatch API Logging in API Gateway
- Set Up X-Ray Tracing in API Gateway
- Set Up CloudTrail Logging in API Gateway
- Set up Stage Variables for a REST API Deployment
- Set up an API Gateway Canary Release Deployment
- Export a REST API from API Gateway
- Request to Export a REST API
- Download REST API OpenAPI Definition in JSON
- Download REST API OpenAPI Definition in YAML
- Download REST API OpenAPI Definition with Postman Extensions in JSON
- Download REST API OpenAPI Definition with API Gateway Integration in YAML
- Export REST API Using the API Gateway Console
- Generate an SDK for a REST API in API Gateway
- Set up Custom Domain Name for an API in API Gateway
- Get Certificates Ready in AWS Certificate Manager
- How to Create an Edge-Optimized Custom Domain Name
- Set up a Custom Domain Name for a Regional API in API Gateway
- Migrate a Custom Domain Name to a Different API Endpoint
- Publish Your API Gateway APIs
- Invoking a REST API in Amazon API Gateway
- Obtain an API's Invoke URL in the API Gateway Console
- Use the API Gateway Console to Test a REST API Method
- Use Postman to Call a REST API
- Call REST API through Generated SDKs
- Use a Java SDK Generated by API Gateway for a REST API
- Use an Android SDK Generated by API Gateway for a REST API
- Use a JavaScript SDK Generated by API Gateway for a REST API
- Use a Ruby SDK Generated by API Gateway for a REST API
- Use iOS SDK Generated by API Gateway for a REST API in Objective-C or Swift
- Call REST API through AWS Amplify JavaScript Library
- Tracing, Logging, and Monitoring an API Gateway API
- Trace API Gateway API Execution with AWS X-Ray
- Log Calls to Amazon API Gateway APIs with AWS CloudTrail
- Monitor API execution with Amazon CloudWatch
- API Gateway Extensions to OpenAPI
- x-amazon-apigateway-any-method Object
- x-amazon-apigateway-api-key-source Property
- x-amazon-apigateway-authorizer Object
- x-amazon-apigateway-authtype Property
- x-amazon-apigateway-binary-media-types Property
- x-amazon-apigateway-documentation Object
- x-amazon-apigateway-gateway-responses Object
- x-amazon-apigateway-gateway-responses.gatewayResponse Object
- x-amazon-apigateway-gateway-responses.responseParameters Object
- x-amazon-apigateway-gateway-responses.responseTemplates Object
- x-amazon-apigateway-integration Object
- x-amazon-apigateway-integration.requestTemplates Object
- x-amazon-apigateway-integration.requestParameters Object
- x-amazon-apigateway-integration.responses Object
- x-amazon-apigateway-integration.response Object
- x-amazon-apigateway-integration.responseTemplates Object
- x-amazon-apigateway-integration.responseParameters Object
- x-amazon-apigateway-request-validator Property
- x-amazon-apigateway-request-validators Object
- x-amazon-apigateway-request-validators.requestValidator Object
- Getting Started with REST APIs in Amazon API Gateway
- Get Ready to Build an API Gateway API
- Build an API Gateway API from an Example
- Build an API Gateway API with Lambda Integration
- Build an API Gateway API with Lambda Proxy Integration
- Build an API Gateway API with Cross-Account Lambda Proxy Integration
- Build an API Gateway API with Custom Lambda Integration
- Build an API Gateway API with HTTP Integrations
- Build an API with API Gateway Private Integration
- Build an API Gateway API with AWS Integration
- Samples and Tutorials
- Create a REST API for AWS Lambda Functions in API Gateway
- Set Up an IAM Role and Policy for an API to Invoke Lambda Functions
- Create a Lambda Function in the Backend
- Create API Resources for the Lambda Function
- Create a GET Method with Query Parameters to Call the Lambda Function
- Create a POST Method with a JSON Payload to Call the Lambda Function
- Create a GET Method with Path Parameters to Call the Lambda Function
- OpenAPI Definitions of Sample API Integrated with a Lambda Function
- Create a REST API as an Amazon S3 Proxy in API Gateway
- Set Up IAM Permissions for the API to Invoke Amazon S3 Actions
- Create API Resources to Represent Amazon S3 Resources
- Expose an API Method to List the Caller's Amazon S3 Buckets
- Expose API Methods to Access an Amazon S3 Bucket
- Expose API Methods to Access an Amazon S3 Object in a Bucket
- Call the API Using a REST API Client
- OpenAPI Definitions of the Sample API as an Amazon S3 Proxy
- Create a REST API as an Amazon Kinesis Proxy in API Gateway
- Create a REST API for AWS Lambda Functions in API Gateway
- Amazon API Gateway Version 1 and Version 2 API References
- Amazon API Gateway Limits and Known Issues
- Document History
- AWS Glossary