About the Amazon Web Services Support API - Amazon Web Services Support
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

About the Amazon Web Services Support API

The Amazon Web Services Support API provides access to some of the features in the Amazon Support Center.

The API provides two different groups of operations:

Note

You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the Amazon Web Services Support API. For more information, see Amazon Web Services Support.

For more information about the operations and data types provided by Amazon Web Services Support, see the Amazon Web Services Support API Reference.

Support case management

You can use the API to perform the following tasks:

  • Open a support case

  • Get a list and detailed information about recent support cases

  • Filter your search for support cases by dates and case identifiers, including resolved cases

  • Add communications and file attachments to your cases, and add the email recipients for case correspondences

  • Resolve your cases

The Amazon Web Services Support API supports CloudTrail logging for support case management operations. For more information, see Logging Amazon Web Services Support API calls with Amazon CloudTrail.

For code examples that demonstrate how to manage the entire life cycle of a support case, see Code examples for Amazon Web Services Support using Amazon SDKs..

Amazon Trusted Advisor

You can use the Trusted Advisor operations to perform the following tasks:

  • Get the names and identifiers for the Trusted Advisor checks

  • Request that a Trusted Advisor check be run against your Amazon account and resources

  • Get summaries and detailed information for your Trusted Advisor check results

  • Refresh your Trusted Advisor checks

  • Get the status of each Trusted Advisor check

The Amazon Web Services Support API supports CloudTrail logging for Trusted Advisor operations. For more information, see Amazon Trusted Advisor information in CloudTrail logging.

You can use Amazon CloudWatch Events to monitor for changes to your check results for Trusted Advisor. For more information, see Monitoring Amazon Trusted Advisor check results with Amazon EventBridge.

For example Java code that demonstrates how to use the Trusted Advisor operations, see Using Trusted Advisor as a web service.

Endpoints

Amazon Web Services Support is a global service. This means that any endpoint that you use will update your support cases in the Support Center Console.

For example, if you use the US East (N. Virginia) endpoint to create a case, you can use the US West (Oregon) or Europe (Ireland) endpoint to add a correspondence to the same case.

You can use the following endpoints for the Amazon Web Services Support API:

https://support.cn-north-1.amazonaws.com.cn

Important
  • If you call the CreateCase operation to create test support cases, we recommend that you include a subject line, such as TEST CASE-Please ignore. After you're done with your test support case, call the ResolveCase operation to resolve it.

  • To call the Amazon Trusted Advisor operations in the Amazon Web Services Support API, you must use the US East (N. Virginia) endpoint. Currently, the US West (Oregon) and Europe (Ireland) endpoints don't support the Trusted Advisor operations.

For more information about Amazon endpoints, see Amazon Web Services Support endpoints and quotas in the Amazon Web Services General Reference.

Support in Amazon SDKs

The Amazon Command Line Interface (Amazon CLI), and the Amazon Software Development Kits (SDKs) include support for the Amazon Web Services Support API.

For a list of languages that support the Amazon Web Services Support API, choose an operation name, such as CreateCase, and in the See Also section, choose your preferred language.