com.amazonaws.services.support
Interface AWSSupport

All Known Subinterfaces:

AWSSupportAsync

All Known Implementing Classes:

AWSSupportAsyncClient, AWSSupportClient

public interface AWSSupport

Interface for accessing AWSSupport. AWS Support

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 with your AWS Support cases programmatically. It is built on the AWS Query API programming model and provides HTTP methods that take parameters and return results in JSON format.

The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks you can run on your resources, specify checks to run and refresh, and check the status of checks you have submitted.

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 DescribeCaseCommunications 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:

• DescribeTrustedAdviserChecks
returns the list of checks that you can run against your AWS resources.
• Using the CheckId for a specific check returned by DescribeTrustedAdviserChecks, you can call DescribeTrustedAdvisorCheckResult
and obtain a new result for the check you specified.
• Using DescribeTrustedAdvisorCheckSummaries, you can get summaries for a set of Trusted Advisor checks.
• RefreshTrustedAdvisorCheck enables you to request that Trusted Advisor run the check again.
• gets statuses on the checks you are running.

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

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

Method Summary

AddCommunicationToCaseResult	addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest) This action adds additional customer communication to an AWS Support case.
CreateCaseResult	createCase(CreateCaseRequest createCaseRequest) Creates a new case in the AWS Support Center.
DescribeCasesResult	describeCases() This action returns a list of cases that you specify by passing one or more CaseIds.
DescribeCasesResult	describeCases(DescribeCasesRequest describeCasesRequest) This action returns a list of cases that you specify by passing one or more CaseIds.
DescribeCommunicationsResult	describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) This action returns communications regarding the support case.
DescribeServicesResult	describeServices() Returns the current list of AWS services and a list of service categories that applies to each one.
DescribeServicesResult	describeServices(DescribeServicesRequest describeServicesRequest) Returns the current list of AWS services and a list of service categories that applies to each one.
DescribeSeverityLevelsResult	describeSeverityLevels() This action returns the list of severity levels that you can assign to an AWS Support case.
DescribeSeverityLevelsResult	describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest) This action returns the list of severity levels that you can assign to an AWS Support case.
DescribeTrustedAdvisorCheckRefreshStatusesResult	describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) Returns the status of all refresh requests Trusted Advisor checks called using RefreshTrustedAdvisorCheck.
DescribeTrustedAdvisorCheckResultResult	describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) This action responds with the results of a Trusted Advisor check.
DescribeTrustedAdvisorChecksResult	describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) This action enables you to get a list of the available Trusted Advisor checks.
DescribeTrustedAdvisorCheckSummariesResult	describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) This action enables you to get the latest summaries for Trusted Advisor checks that you specify in your request.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
RefreshTrustedAdvisorCheckResult	refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest) This action enables you to query the service to request a refresh for a specific Trusted Advisor check.
ResolveCaseResult	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.
ResolveCaseResult	resolveCase(ResolveCaseRequest 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.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("support.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("support.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "support.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "support.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "support.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

describeCases

DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

This action returns a list of cases that you specify by passing one or more CaseIds. 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:

1. One or more CaseDetails data types.
2. One or more NextToken objects, strings that specifies where to paginate the returned records represented by CaseDetails .

Parameters:

describeCasesRequest - Container for the necessary parameters to execute the DescribeCases service method on AWSSupport.

Returns:

The response from the DescribeCases service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeTrustedAdvisorCheckRefreshStatuses

DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
                                                                                            throws AmazonServiceException,
                                                                                                   AmazonClientException

Returns the status of all refresh requests Trusted Advisor checks called using RefreshTrustedAdvisorCheck.

Parameters:

describeTrustedAdvisorCheckRefreshStatusesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses service method on AWSSupport.

Returns:

The response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeSeverityLevels

DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

This action 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.

Parameters:

describeSeverityLevelsRequest - Container for the necessary parameters to execute the DescribeSeverityLevels service method on AWSSupport.

Returns:

The response from the DescribeSeverityLevels service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeCommunications

DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

This action 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 number.

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.

Parameters:

describeCommunicationsRequest - Container for the necessary parameters to execute the DescribeCommunications service method on AWSSupport.

Returns:

The response from the DescribeCommunications service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

addCommunicationToCase

AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

This action adds additional customer communication to an AWS Support case. You use the CaseId value to identify the case to which you want to add communication. 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.

This action's response indicates the success or failure of the request.

This action implements a subset of the behavior on the AWS Support Your Support Cases web form.

Parameters:

addCommunicationToCaseRequest - Container for the necessary parameters to execute the AddCommunicationToCase service method on AWSSupport.

Returns:

The response from the AddCommunicationToCase service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

createCase

CreateCaseResult createCase(CreateCaseRequest createCaseRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new case in the AWS Support Center. This action is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:

1. ServiceCode. Represents a code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
2. CategoryCode . Represents a category for the service defined for the ServiceCode value. You also obtain the cateogory code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
3. SeverityCode . Represents a value that specifies the urgency of the case, and the time interval in which your service level agreement specifies a response from AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
4. Subject . Represents the Subject field on the AWS Support Center Open a new case page.
5. CommunicationBody . Represents the Description field on the AWS Support Center Open a new case page.
6. Language . Specifies the human language in which AWS Support handles the case. The API currently supports English and Japanese.
7. CcEmailAddresses . Represents the AWS Support Center CC field on the Open a new case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK .

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 DescribeCases request to retrieve existing AWS Support support cases.

Parameters:

createCaseRequest - Container for the necessary parameters to execute the CreateCase service method on AWSSupport.

Returns:

The response from the CreateCase service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseCreationLimitExceededException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeTrustedAdvisorChecks

DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

This action enables you to get a list of the available Trusted Advisor checks. You must specify a language code. English ("en") and Japanese ("jp") are currently supported. The response contains a list of TrustedAdvisorCheckDescription objects.

Parameters:

describeTrustedAdvisorChecksRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks service method on AWSSupport.

Returns:

The response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeTrustedAdvisorCheckResult

DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
                                                                          throws AmazonServiceException,
                                                                                 AmazonClientException

This action responds with the results of a Trusted Advisor check. Once you have obtained the list of available Trusted Advisor checks by calling DescribeTrustedAdvisorChecks, you specify the CheckId for the check you want to retrieve from AWS Support.

The response for this action contains a JSON-formatted TrustedAdvisorCheckResult object

, which is a container for the following three objects:

1. TrustedAdvisorCategorySpecificSummary
2. TrustedAdvisorResourceDetail
3. TrustedAdvisorResourcesSummary

In addition, the response contains the following fields:

1. Status . Overall status of the check.
2. Timestamp . Time at which Trusted Advisor last ran the check.
3. CheckId . Unique identifier for the specific check returned by the request.

Parameters:

describeTrustedAdvisorCheckResultRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult service method on AWSSupport.

Returns:

The response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

resolveCase

ResolveCaseResult resolveCase(ResolveCaseRequest resolveCaseRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Parameters:

resolveCaseRequest - Container for the necessary parameters to execute the ResolveCase service method on AWSSupport.

Returns:

The response from the ResolveCase service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

refreshTrustedAdvisorCheck

RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

This action enables you to query the service to request a refresh for a specific Trusted Advisor check. Your request body contains a CheckId for which you are querying. The response body contains a RefreshTrustedAdvisorCheckResult object containing Status and TimeUntilNextRefresh fields.

Parameters:

refreshTrustedAdvisorCheckRequest - Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck service method on AWSSupport.

Returns:

The response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeServices

DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Parameters:

describeServicesRequest - Container for the necessary parameters to execute the DescribeServices service method on AWSSupport.

Returns:

The response from the DescribeServices service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeTrustedAdvisorCheckSummaries

DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

This action enables you to get the latest summaries for Trusted Advisor checks that you specify in your request. You submit the list of Trusted Advisor checks for which you want summaries. You obtain these CheckIds by submitting a DescribeTrustedAdvisorChecks request.

The response body contains an array of TrustedAdvisorCheckSummary objects.

Parameters:

describeTrustedAdvisorCheckSummariesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries service method on AWSSupport.

Returns:

The response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeCases

DescribeCasesResult describeCases()
                                  throws AmazonServiceException,
                                         AmazonClientException

This action returns a list of cases that you specify by passing one or more CaseIds. 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:

1. One or more CaseDetails data types.
2. One or more NextToken objects, strings that specifies where to paginate the returned records represented by CaseDetails .

Returns:

The response from the DescribeCases service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeSeverityLevels

DescribeSeverityLevelsResult describeSeverityLevels()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

This action 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.

Returns:

The response from the DescribeSeverityLevels service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

resolveCase

ResolveCaseResult resolveCase()
                              throws AmazonServiceException,
                                     AmazonClientException

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Returns:

The response from the ResolveCase service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

CaseIdNotFoundException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

describeServices

DescribeServicesResult describeServices()
                                        throws AmazonServiceException,
                                               AmazonClientException

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.

Returns:

The response from the DescribeServices service method, as returned by AWSSupport.

Throws:

InternalServerErrorException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSSupport indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.