com.amazonaws.services.support

Class AWSSupportClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.support.AWSSupportClient

All Implemented Interfaces:

AWSSupport

Direct Known Subclasses:

AWSSupportAsyncClient

public class AWSSupportClient
extends AmazonWebServiceClient
implements AWSSupport

Client for accessing AWSSupport. All service calls made using this client are blocking, and will not return until the service call completes.

AWS Support

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:

• 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 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 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.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSSupport exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSSupportClient() Constructs a new client to invoke service methods on AWSSupport.
AWSSupportClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials.
AWSSupportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials and client configuration options.
AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider.
AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider and client configuration options.
AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSSupportClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSSupport.

Method Summary

Methods

Modifier and Type	Method and Description
AddAttachmentsToSetResult	addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest) Adds one or more attachments to an attachment set.
AddCommunicationToCaseResult	addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest) Adds additional customer communication to an AWS Support case.
CreateCaseResult	createCase(CreateCaseRequest createCaseRequest) Creates a new case in the AWS Support Center.
DescribeAttachmentResult	describeAttachment(DescribeAttachmentRequest describeAttachmentRequest) Returns the attachment that has the specified ID.
DescribeCasesResult	describeCases() Returns a list of cases that you specify by passing one or more case IDs.
DescribeCasesResult	describeCases(DescribeCasesRequest describeCasesRequest) Returns a list of cases that you specify by passing one or more case IDs.
DescribeCommunicationsResult	describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) Returns communications (and attachments) for one or more support cases.
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() Returns the list of severity levels that you can assign to an AWS Support case.
DescribeSeverityLevelsResult	describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest) Returns the list of severity levels that you can assign to an AWS Support case.
DescribeTrustedAdvisorCheckRefreshStatusesResult	describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
DescribeTrustedAdvisorCheckResultResult	describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) Returns the results of the Trusted Advisor check that has the specified check ID.
DescribeTrustedAdvisorChecksResult	describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata.
DescribeTrustedAdvisorCheckSummariesResult	describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
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) Requests a refresh of the Trusted Advisor check that has the specified check ID.
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.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.support.AWSSupport

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSSupport exceptions.

Constructor Detail

AWSSupportClient

public AWSSupportClient()

Constructs a new client to invoke service methods on AWSSupport. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSSupportClient

public AWSSupportClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSupport. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSSupport (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSSupportClient

public AWSSupportClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSSupportClient

public AWSSupportClient(AWSCredentials awsCredentials,
                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSSupport (ex: proxy settings, retry counts, etc.).

AWSSupportClient

public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSSupportClient

public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider,
                ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSSupport (ex: proxy settings, retry counts, etc.).

AWSSupportClient

public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider,
                ClientConfiguration clientConfiguration,
                RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSSupport using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSSupport (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeTrustedAdvisorCheckRefreshStatuses

public DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)

Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

Specified by:

describeTrustedAdvisorCheckRefreshStatuses in interface AWSSupport

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.

describeCases

public DescribeCasesResult describeCases(DescribeCasesRequest 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:

1. One or more CaseDetails data types.
2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Specified by:

describeCases in interface AWSSupport

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.

addAttachmentsToSet

public AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest 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 ExpiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

Specified by:

addAttachmentsToSet in interface AWSSupport

Parameters:

addAttachmentsToSetRequest - Container for the necessary parameters to execute the AddAttachmentsToSet service method on AWSSupport.

Returns:

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

Throws:

AttachmentSetIdNotFoundException

AttachmentLimitExceededException

AttachmentSetExpiredException

InternalServerErrorException

AttachmentSetSizeLimitExceededException

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

public DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest 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.

Specified by:

describeSeverityLevels in interface AWSSupport

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

public DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest 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 MaxResults and NextToken parameters 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.

Specified by:

describeCommunications in interface AWSSupport

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.

describeAttachment

public DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest 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.

Specified by:

describeAttachment in interface AWSSupport

Parameters:

describeAttachmentRequest - Container for the necessary parameters to execute the DescribeAttachment service method on AWSSupport.

Returns:

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

Throws:

DescribeAttachmentLimitExceededException

AttachmentIdNotFoundException

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

public 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.

Specified by:

resolveCase in interface AWSSupport

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.

describeServices

public DescribeServicesResult describeServices(DescribeServicesRequest 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 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.

Specified by:

describeServices in interface AWSSupport

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.

addCommunicationToCase

public AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest 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.

Specified by:

addCommunicationToCase in interface AWSSupport

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:

AttachmentSetIdNotFoundException

AttachmentSetExpiredException

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

public CreateCaseResult createCase(CreateCaseRequest 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:

1. IssueType. The type of issue for the case. You can specify either "customer-service" or "technical." If you do not indicate a value, the default is "technical."
2. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
3. CategoryCode. The category for the service defined for the ServiceCode value. You also obtain the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.
4. SeverityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You obtain the SeverityCode by calling DescribeSeverityLevels.
5. Subject. The Subject field on the AWS Support Center Create Case page.
6. CommunicationBody. The Description field on the AWS Support Center Create Case page.
7. AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
8. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
9. CcEmailAddresses. The AWS Support Center CC field on the Create 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: 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.

Specified by:

createCase in interface AWSSupport

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:

AttachmentSetIdNotFoundException

AttachmentSetExpiredException

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

public DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest 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.

Specified by:

describeTrustedAdvisorChecks in interface AWSSupport

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

public DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest 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:

• TrustedAdvisorCategorySpecificSummary
• TrustedAdvisorResourceDetail
• TrustedAdvisorResourcesSummary

In addition, the response contains these fields:

• Status. The alert status of the check: "ok" (green), "warning" (yellow), "error" (red), or "not_available".
• Timestamp. The time of the last refresh of the check.
• CheckId. The unique identifier for the check.

Specified by:

describeTrustedAdvisorCheckResult in interface AWSSupport

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.

refreshTrustedAdvisorCheck

public RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest 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:

• Status. The refresh status of the check: "none", "enqueued", "processing", "success", or "abandoned".
• MillisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.
• CheckId. The unique identifier for the check.

Specified by:

refreshTrustedAdvisorCheck in interface AWSSupport

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.

describeTrustedAdvisorCheckSummaries

public DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest 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.

Specified by:

describeTrustedAdvisorCheckSummaries in interface AWSSupport

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

public DescribeCasesResult describeCases()
                                  throws AmazonServiceException,
                                         AmazonClientException

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:

1. One or more CaseDetails data types.
2. One or more NextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

Specified by:

describeCases in interface 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.

describeSeverityLevels

public DescribeSeverityLevelsResult describeSeverityLevels()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Specified by:

describeSeverityLevels in interface 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.

resolveCase

public 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.

Specified by:

resolveCase in interface 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.

describeServices

public 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 Create 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.

Specified by:

describeServices in interface 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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints 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.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface AWSSupport

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSupport

Parameters:

request - The originally executed request

Returns:

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