Expand description
The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It 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
SubscriptionRequiredExceptionerror 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:
-
Service names, issue categories, and available severity levels. 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.
-
Case creation, case details, and case resolution. The CreateCase, DescribeCases, DescribeAttachment, and ResolveCase operations create AWS Support cases, retrieve information about cases, and resolve cases.
-
Case communication. The DescribeCommunications, AddCommunicationToCase, and AddAttachmentsToSet operations retrieve and add communications and attachments to AWS Support cases.
The following list describes the operations available from the AWS Support service for Trusted Advisor:
-
DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
-
Using the
checkIdfor a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check that you specified. -
DescribeTrustedAdvisorCheckSummaries returns summarized results for one or more Trusted Advisor checks.
-
RefreshTrustedAdvisorCheck requests that Trusted Advisor rerun a specified check.
-
DescribeTrustedAdvisorCheckRefreshStatuses reports the refresh status of one or more checks.
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.
Structs§
- AWSSupport
Client - A client for the AWS Support API.
- AddAttachments
ToSet Request - AddAttachments
ToSet Response The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
- AddCommunication
ToCase Request - AddCommunication
ToCase Response The result of the AddCommunicationToCase operation.
- Attachment
An attachment to a case communication. The attachment consists of the file name and the content of the file.
- Attachment
Details 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.
- Case
Details 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 AWS 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 AWS 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, andtimeCreated. -
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, andcritical. -
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.
-
- Category
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.
- Communication
A communication associated with an AWS 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.
- Create
Case Request - Create
Case Response The AWS Support case ID returned by a successful completion of the CreateCase operation.
- Describe
Attachment Request - Describe
Attachment Response The content and file name of the attachment returned by the DescribeAttachment operation.
- Describe
Cases Request - Describe
Cases Response Returns an array of CaseDetails objects and a
nextTokenthat defines a point for pagination in the result set.- Describe
Communications Request - Describe
Communications Response The communications returned by the DescribeCommunications operation.
- Describe
Services Request - Describe
Services Response The list of AWS services returned by the DescribeServices operation.
- Describe
Severity Levels Request - Describe
Severity Levels Response The list of severity levels returned by the DescribeSeverityLevels operation.
- Describe
Trusted Advisor Check Refresh Statuses Request - Describe
Trusted Advisor Check Refresh Statuses Response The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
- Describe
Trusted Advisor Check Result Request - Describe
Trusted Advisor Check Result Response The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
- Describe
Trusted Advisor Check Summaries Request - Describe
Trusted Advisor Check Summaries Response The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
- Describe
Trusted Advisor Checks Request - Describe
Trusted Advisor Checks Response Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
- Recent
Case Communications The five most recent communications associated with the case.
- Refresh
Trusted Advisor Check Request - Refresh
Trusted Advisor Check Response The current refresh status of a Trusted Advisor check.
- Resolve
Case Request - Resolve
Case Response The status of the case returned by the ResolveCase operation.
- Service
Information about an AWS service returned by the DescribeServices operation.
- Severity
Level 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.
- Trusted
Advisor Category Specific Summary The container for summary information that relates to the category of the Trusted Advisor check.
- Trusted
Advisor Check Description The description and metadata for a Trusted Advisor check.
- Trusted
Advisor Check Refresh Status The refresh status of a Trusted Advisor check.
- Trusted
Advisor Check Result The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.
- Trusted
Advisor Check Summary A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.
- Trusted
Advisor Cost Optimizing Summary The estimated cost savings that might be realized if the recommended operations are taken.
- Trusted
Advisor Resource Detail Contains information about a resource identified by a Trusted Advisor check.
- Trusted
Advisor Resources Summary Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.
Enums§
- AddAttachments
ToSet Error - Errors returned by AddAttachmentsToSet
- AddCommunication
ToCase Error - Errors returned by AddCommunicationToCase
- Create
Case Error - Errors returned by CreateCase
- Describe
Attachment Error - Errors returned by DescribeAttachment
- Describe
Cases Error - Errors returned by DescribeCases
- Describe
Communications Error - Errors returned by DescribeCommunications
- Describe
Services Error - Errors returned by DescribeServices
- Describe
Severity Levels Error - Errors returned by DescribeSeverityLevels
- Describe
Trusted Advisor Check Refresh Statuses Error - Errors returned by DescribeTrustedAdvisorCheckRefreshStatuses
- Describe
Trusted Advisor Check Result Error - Errors returned by DescribeTrustedAdvisorCheckResult
- Describe
Trusted Advisor Check Summaries Error - Errors returned by DescribeTrustedAdvisorCheckSummaries
- Describe
Trusted Advisor Checks Error - Errors returned by DescribeTrustedAdvisorChecks
- Refresh
Trusted Advisor Check Error - Errors returned by RefreshTrustedAdvisorCheck
- Resolve
Case Error - Errors returned by ResolveCase
Traits§
- AWSSupport
- Trait representing the capabilities of the AWS Support API. AWS Support clients implement this trait.