About the AWS Support API - AWS Support

About the AWS Support API

The AWS Support API provides access to some of the features in the AWS Support Center.

The API provides two different groups of operations:

Note

You must have a Business or Enterprise Support plan to use the AWS Support API. For more information, see AWS Support.

For more information about the operations and data types provided by AWS Support, see the AWS 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 AWS Support API supports CloudTrail logging for support case management operations. For more information, see Logging AWS Support API calls with AWS CloudTrail.

For example Java code that demonstrates how to manage the entire life cycle of a support case, see Programming an AWS Support case.

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 AWS 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 AWS Support API supports CloudTrail logging for Trusted Advisor operations. For more information, see AWS 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 Trusted Advisor check results with Amazon CloudWatch Events.

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

Endpoint

You can use the following endpoint to access the AWS Support API:

  • https://support.us-east-1.amazonaws.com

Important

The AWS Support endpoint creates cases in the production database. If you're creating test support cases, we recommend that you include a subject line, such as TEST CASE-Please ignore, when you call the CreateCase operation. After you're done testing, call the ResolveCase operation to resolve the case.

For more information about using AWS endpoints, see Regions and endpoints in the Amazon Web Services General Reference.

Support in AWS SDKs

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

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