AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
The AWS Support service also exposes a set of 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:
CheckId
for a specific
check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult
to obtain the results for the check you specified.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.
Namespace: Amazon.AWSSupport
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonAWSSupport IDisposable
The IAmazonAWSSupport type exposes the following members
Name | Description | |
---|---|---|
AddAttachmentsToSet(AddAttachmentsToSetRequest) |
Adds one or more attachments to an attachment set. If an AttachmentSetId
is not specified, a new attachment set is created, and the ID of the set is returned
in the response. If an AttachmentSetId is specified, the attachments
are added to the specified set, if it exists.
An attachment set is a temporary container for attachments that are to be added to
a case or case communication. The set is available for one hour after it is created;
the |
|
AddCommunicationToCase(AddCommunicationToCaseRequest) |
Adds additional customer communication to an AWS Support case. You use the CaseId
value to identify the case to add communication to. You can list a set of email addresses
to copy on the communication using the CcEmailAddresses value. The CommunicationBody
value contains the text of the communication.
The response indicates the success or failure of the request. This operation implements a subset of the features of the AWS Support Center. |
|
BeginAddAttachmentsToSet(AddAttachmentsToSetRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddAttachmentsToSet operation. | |
BeginAddCommunicationToCase(AddCommunicationToCaseRequest, AsyncCallback, object) | Initiates the asynchronous execution of the AddCommunicationToCase operation. | |
BeginCreateCase(CreateCaseRequest, AsyncCallback, object) | Initiates the asynchronous execution of the CreateCase operation. | |
BeginDescribeAttachment(DescribeAttachmentRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeAttachment operation. | |
BeginDescribeCases(DescribeCasesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeCases operation. | |
BeginDescribeCommunications(DescribeCommunicationsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeCommunications operation. | |
BeginDescribeServices(DescribeServicesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeServices operation. | |
BeginDescribeSeverityLevels(DescribeSeverityLevelsRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeSeverityLevels operation. | |
BeginDescribeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. | |
BeginDescribeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. | |
BeginDescribeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeTrustedAdvisorChecks operation. | |
BeginDescribeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest, AsyncCallback, object) | Initiates the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. | |
BeginRefreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest, AsyncCallback, object) | Initiates the asynchronous execution of the RefreshTrustedAdvisorCheck operation. | |
BeginResolveCase(ResolveCaseRequest, AsyncCallback, object) | Initiates the asynchronous execution of the ResolveCase operation. | |
CreateCase(CreateCaseRequest) |
Creates a new case in the AWS Support Center. This operation is modeled on the behavior
of the AWS Support Center Create
Case page. Its parameters require you to specify the following information:
To add additional communication or attachments to an existing case, use AddCommunicationToCase. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases. |
|
DescribeAttachment(DescribeAttachmentRequest) | Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation. | |
DescribeCases(DescribeCasesRequest) |
Returns a list of cases that you specify by passing one or more case IDs. In addition,
you can filter the cases by date by setting values for the AfterTime
and BeforeTime request parameters. You can set values for the IncludeResolvedCases
and IncludeCommunications request parameters to control how much information
is returned.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error. The response returns the following in JSON format:
|
|
DescribeCommunications(DescribeCommunicationsRequest) |
Returns communications (and attachments) for one or more support cases. You can use
the AfterTime and BeforeTime parameters to filter by date.
You can use the CaseId parameter to restrict the results to a particular
case.
Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.
You can use the |
|
DescribeServices() |
Returns the current list of AWS services and a list of service categories that applies
to each one. You then use service names and categories in your CreateCase requests.
Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in
the Service and Category drop-down lists on the AWS Support Center Create Case page.
The values in those fields, however, do not necessarily match the service codes and
categories returned by the |
|
DescribeServices(DescribeServicesRequest) |
Returns the current list of AWS services and a list of service categories that applies
to each one. You then use service names and categories in your CreateCase requests.
Each AWS service has its own set of categories.
The service codes and category codes correspond to the values that are displayed in
the Service and Category drop-down lists on the AWS Support Center Create Case page.
The values in those fields, however, do not necessarily match the service codes and
categories returned by the |
|
DescribeSeverityLevels() | Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. | |
DescribeSeverityLevels(DescribeSeverityLevelsRequest) | Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request. | |
DescribeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest) | Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks. | |
DescribeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest) |
Returns the results of the Trusted Advisor check that has the specified check ID.
Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects: In addition, the response contains these fields:
|
|
DescribeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest) | Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English ("en") and Japanese ("ja") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. | |
DescribeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest) |
Returns the summaries of the results of the Trusted Advisor checks that have the specified
check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains an array of TrustedAdvisorCheckSummary objects. |
|
EndAddAttachmentsToSet(IAsyncResult) | Finishes the asynchronous execution of the AddAttachmentsToSet operation. | |
EndAddCommunicationToCase(IAsyncResult) | Finishes the asynchronous execution of the AddCommunicationToCase operation. | |
EndCreateCase(IAsyncResult) | Finishes the asynchronous execution of the CreateCase operation. | |
EndDescribeAttachment(IAsyncResult) | Finishes the asynchronous execution of the DescribeAttachment operation. | |
EndDescribeCases(IAsyncResult) | Finishes the asynchronous execution of the DescribeCases operation. | |
EndDescribeCommunications(IAsyncResult) | Finishes the asynchronous execution of the DescribeCommunications operation. | |
EndDescribeServices(IAsyncResult) | Finishes the asynchronous execution of the DescribeServices operation. | |
EndDescribeSeverityLevels(IAsyncResult) | Finishes the asynchronous execution of the DescribeSeverityLevels operation. | |
EndDescribeTrustedAdvisorCheckRefreshStatuses(IAsyncResult) | Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckRefreshStatuses operation. | |
EndDescribeTrustedAdvisorCheckResult(IAsyncResult) | Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckResult operation. | |
EndDescribeTrustedAdvisorChecks(IAsyncResult) | Finishes the asynchronous execution of the DescribeTrustedAdvisorChecks operation. | |
EndDescribeTrustedAdvisorCheckSummaries(IAsyncResult) | Finishes the asynchronous execution of the DescribeTrustedAdvisorCheckSummaries operation. | |
EndRefreshTrustedAdvisorCheck(IAsyncResult) | Finishes the asynchronous execution of the RefreshTrustedAdvisorCheck operation. | |
EndResolveCase(IAsyncResult) | Finishes the asynchronous execution of the ResolveCase operation. | |
RefreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest) |
Requests a refresh of the Trusted Advisor check that has the specified check ID. Check
IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:
|
|
ResolveCase(ResolveCaseRequest) |
Takes a CaseId and returns the initial state of the case along with the
state of the case after the call to ResolveCase completed.
|
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8