The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions 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 actions:
- Service names, issue categories, and available severity levels. The actions DescribeServices and DescribeSeverityLevels enable you to obtain AWS service names, service codes, service categories, and problem severity levels. You use these values when you call the CreateCase action.
- Case creation, case details, and case resolution. The actions CreateCase, DescribeCases, and ResolveCase enable you to create AWS Support cases, retrieve them, and resolve them.
- Case communication. The actions DescribeCommunications and AddCommunicationToCase enable you to retrieve and add communication to AWS Support cases.
The following list describes the actions available from the AWS Support service for Trusted Advisor:
- DescribeTrustedAdvisorChecks returns the list of checks that run against your AWS resources.
- Using the CheckId for a specific check returned by DescribeTrustedAdvisorChecks, you can call DescribeTrustedAdvisorCheckResult to obtain the results for the check 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 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.
Declaration Syntax| C# |
public class AmazonAWSSupportClient : AmazonWebServiceClient, AmazonAWSSupport, IDisposable
Members| All Members | Constructors | Methods | Events | ||
| Icon | Member | Description |
|---|---|---|
 | AmazonAWSSupportClient()()()() |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
 CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonAWSSupportClient(RegionEndpoint) |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonAWSSupportClient(AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonAWSSupportClient(AWSCredentials) |
Constructs AmazonAWSSupportClient with AWS Credentials
|
| AmazonAWSSupportClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Credentials
|
| AmazonAWSSupportClient(AWSCredentials, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Credentials and an
AmazonAWSSupportClient Configuration object.
|
| AmazonAWSSupportClient(String, String) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
|
| AmazonAWSSupportClient(String, String, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
|
| AmazonAWSSupportClient(String, String, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an
AmazonAWSSupportClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
| AmazonAWSSupportClient(String, String, String) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
|
| AmazonAWSSupportClient(String, String, String, RegionEndpoint) |
Constructs AmazonAWSSupportClient with AWS Access Key ID and AWS Secret Key
|
| AmazonAWSSupportClient(String, String, String, AmazonAWSSupportConfig) |
Constructs AmazonAWSSupportClient with AWS Access Key ID, AWS Secret Key and an
AmazonAWSSupportClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
| 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 behavior on the AWS Support Your Support Cases web form. |
 | AfterResponseEvent |
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.) |
| BeforeRequestEvent |
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.) |
| BeginAddCommunicationToCase(AddCommunicationToCaseRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the AddCommunicationToCase operation.
|
| BeginCreateCase(CreateCaseRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateCase 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 Open a new case page. Its parameters require you to specify the following information:
NOTE: The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case. A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases. |
| 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. The response returns the following in JSON format:
|
| DescribeCases()()()() | 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. The response returns the following in JSON format:
|
| DescribeCommunications(DescribeCommunicationsRequest) | Returns communications regarding the support case. You can use the AfterTime and BeforeTime parameters to filter by date. The CaseId parameter enables you to identify a specific case by its CaseId value. The MaxResults and NextToken parameters enable you to control the pagination of the result set. Set MaxResults to the number of cases you want displayed on each page, and use NextToken to specify the resumption of pagination. |
| 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 Open a new case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. |
| 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 Open a new case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes. |
| 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. |
| 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. |
| 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. |
| Dispose()()()() |
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.) |
| EndAddCommunicationToCase(IAsyncResult) |
Finishes the asynchronous execution of the AddCommunicationToCase operation.
|
| EndCreateCase(IAsyncResult) |
Finishes the asynchronous execution of the CreateCase 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.
|
| Equals(Object) | (Inherited from Object.) |
| ExceptionEvent |
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| 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 RefreshTrustedAdvisorCheckResult 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. |
| ResolveCase()()()() | Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed. |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceClient | |
| AmazonAWSSupportClient | |