Getting Started with Amazon AWS
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon AWS.

Amazon API Gateway

Amazon API Gateway is a fully managed service that makes it easy for developers to create, publish, maintain, monitor, and secure APIs at any scale. With a few clicks in the AWS Management Console, you can create an API that acts as a "front door" for applications to access data, business logic, or functionality from your back-end services, such as workloads running on Amazon Elastic Compute Cloud (Amazon EC2), code running on AWS Lambda, or any web application.

Amazon API Gateway handles all the tasks involved in accepting and processing up to hundreds of thousands of concurrent API calls, including traffic management, authorization and access control, monitoring, and API version management. Amazon API Gateway has no minimum fees or startup costs. You pay only for the API calls you receive and the amount of data transferred out.

Please note the following Amazon AWS implementation particulars, which are potentially relevant to all services in the Beijing and Ningxia Regions.

  • To use services in the Beijing and Ningxia Regions, you need an account and credentials specific to the Beijing and Ningxia Regions. Accounts and credentials for other AWS Regions will not work for services operating in the Beijing and Ningxia Regions. Likewise, accounts and credentials for the Beijing and Ningxia Regions will not work for other AWS Regions.

  • There are two Availability Zones in the Beijing Region.

  • There are three Availability Zones in the Ningxia Region.

  • In AWS Identity and Access Management (IAM), you can grant or deny a service access to resources using the Principal policy element. Service principal values vary by Region.

  • The domain for both the Beijing and Ningxia Regions is www.amazonaws.cn.

  • The endpoints for services in the China (Beijing) Region and the China (Ningxia) Region are different from other global endpoints.

    • The endpoint domain for both the Beijing and Ningxia Regions is amazonaws.com.cn.

    • For an endpoint in the China (Beijing) Region, the Region value should be cn-north-1.

    • For an endpoint in the China (Ningxia) Region, the Region value should be cn-northwest-1.

    • For example, the endpoint for Elastic Load Balancing in the Beijing Region is elasticloadbalancing.cn-north-1.amazonaws.com.cn.

    Endpoint syntax varies from service to service. For more information, see China (Beijing), China (Ningxia), and the service-specific documentation.

  • In the China Regions, the Amazon Resource Name (ARN) syntax includes a cn.

    For example: arn:aws-cn:iam::123456789012:user/division_abc/subdivision_xyz/Bob.

  • The EC2-Classic platform is not supported.

  • AWS Marketplace is not supported.

  • The free usage tier is not available in the China Regions.

Note

The AWS documentation might show code examples for endpoints and ARNs that are not specific for the Beijing and Ningxia Regions. When using examples, verify you are using the correct endpoints and ARNs for your Region.

Language Options

Chinese is the default language for Amazon AWS documentation. To switch to the English version of the page, use the language selection dropdown at the top of the page. Note: Selecting a different language will update the language cookie, making it the default language.

Chinese-language URL syntax:
http://docs.amazonaws.cn/aws/latest/userguide/introduction.html
English-language URL syntax:
http://docs.amazonaws.cn/en_us/aws/latest/userguide/introduction.html

Feature Availability and Implementation Differences

The Amazon AWS implementation of Amazon API Gateway is unique in the following ways:

  • Because Amazon CloudFront is not available in the Beijing and Ningxia Regions, to call API Gateway APIs in the Beijing and Ningxia Regions, you must use Beijing Region-specific or Ningxia Region-specific endpoints.

  • Because Amazon CloudFront is not available in the Beijing and Ningxia Regions, edge-optimized APIs and edge-optimized custom domain names are not supported.

  • Because AWS Certificate Manager is not available in the Beijing and Ningxia Regions, you must upload the certificate content to API Gateway.

  • Filing for Internet Content Provider (ICP) recordal—If you want to service API requests in the Beijing Region that can be accessed without authentication, you must obtain an ICP license. For information about filing for ICP recordal, see Billing and Payment. You may also need to refile for ICP whitelisting for API Gateway in the Ningxia Region even if you already filed for it in the Beijing Region.

  • The following API Gateway features are either unavailable in the Beijing and Ningxia Regions or require an ICP license:

    • API Gateway serves unauthenticated API requests only if the API owner’s Amazon AWS account is associated with a valid ICP license. As a result, creating an API using a Lambda authorizer or no authorizer requires an ICP license.

    • You can configure an API using a custom authorizer or no authorizer, but the API can only be accessed if your Amazon AWS account is associated with an ICP license.

    • You cannot use Alias A records for custom domain names. You must create a CNAME that points to the regional custom domain endpoint.

  • The following API Gateway features are unavailable in the Beijing and Ningxia Regions:

    • API Gateway private integrations

    • API Gateway private APIs

User Guides

Amazon AWS user guides are available in HTML and PDF, in both Chinese and English. API guides are available in HTML and PDF, in English only. Currently, the API guides are not available in the Beijing and Ningxia Regions. Links to API guides will take you to the global AWS site. Note that some features and functionality described in the guides may not be available in the current Amazon AWS release.