Welcome

The AWS Support API Reference is intended for programmers who need detailed information about the AWS Support operations and data types. You can use the API to manage your support cases programmatically. The AWS Support API uses HTTP methods that return results in JSON format.

Note

• You must have a Business, Enterprise On-Ramp, or Enterprise Support plan to use the AWS Support API.

• If you call the AWS Support API from an account that doesn't have a Business, Enterprise On-Ramp, or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

You can also use the AWS Support API to access features for AWS Trusted Advisor. You can return a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

You can manage your support cases with the following AWS Support API operations:

• The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.

• The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.

• The DescribeServices and DescribeSeverityLevels operations return AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase operation.

You can also use the AWS Support API to call the Trusted Advisor operations. For more information, see AWS Trusted Advisor in the AWS Support User Guide.

For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

For more information about this service and the endpoints to use, see About the AWS Support API in the AWS Support User Guide.

This document was last published on November 12, 2024.