Expand description

AWS Support

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.

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

  • If you call the AWS Support API from an account that does not have a Business or Enterprise Support plan, the SubscriptionRequiredException error message appears. For information about changing your support plan, see AWS Support.

The AWS Support service also exposes a set of AWS Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

The following list describes the AWS Support case management operations:

The following list describes the operations available from the AWS Support service for Trusted Advisor:

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

See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

If you’re using the service, you’re probably looking for AWSSupportClient and AWSSupport.


A client for the AWS Support API.

The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

An attachment to a case communication. The attachment consists of the file name and the content of the file.

The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

A JSON-formatted object that contains the metadata for a support case. It is contained in the response from a DescribeCases request. CaseDetails contains the following fields:

  • caseId - The support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

  • categoryCode - The category of problem for the support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

  • displayId - The identifier for the case on pages in the AWS Support Center.

  • language - The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English ("en") and Japanese ("ja"). Language parameters must be passed explicitly for operations that take them.

  • nextToken - A resumption point for pagination.

  • recentCommunications - One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

  • serviceCode - The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.

  • severityCode - The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

  • status - The status of the case in the AWS Support Center. Valid values:

    • opened

    • pending-customer-action

    • reopened

    • resolved

    • unassigned

    • work-in-progress

  • subject - The subject line of the case.

  • submittedBy - The email address of the account that submitted the case.

  • timeCreated - The time the case was created, in ISO-8601 format.

A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

A communication associated with a support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

The support case ID returned by a successful completion of the CreateCase operation.

The content and file name of the attachment returned by the DescribeAttachment operation.

Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

The communications returned by the DescribeCommunications operation.

The list of AWS services returned by the DescribeServices operation.

The list of severity levels returned by the DescribeSeverityLevels operation.

The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

The five most recent communications associated with the case.

The current refresh status of a Trusted Advisor check.

The status of the case returned by the ResolveCase operation.

Information about an AWS service returned by the DescribeServices operation.

A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a severity in the AWS Support User Guide.

The container for summary information that relates to the category of the Trusted Advisor check.

The description and metadata for a Trusted Advisor check.

The refresh status of a Trusted Advisor check.

The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

The estimated cost savings that might be realized if the recommended operations are taken.

Contains information about a resource identified by a Trusted Advisor check.

Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.


Errors returned by AddAttachmentsToSet

Errors returned by AddCommunicationToCase

Errors returned by CreateCase

Errors returned by DescribeAttachment

Errors returned by DescribeCases

Errors returned by DescribeCommunications

Errors returned by DescribeServices

Errors returned by DescribeSeverityLevels

Errors returned by DescribeTrustedAdvisorCheckRefreshStatuses

Errors returned by DescribeTrustedAdvisorCheckResult

Errors returned by DescribeTrustedAdvisorCheckSummaries

Errors returned by DescribeTrustedAdvisorChecks

Errors returned by RefreshTrustedAdvisorCheck

Errors returned by ResolveCase


Trait representing the capabilities of the AWS Support API. AWS Support clients implement this trait.