com.amazonaws.services.support

Interface AWSSupport

All Known Subinterfaces:

AWSSupportAsync

All Known Implementing Classes:

AbstractAWSSupport, AbstractAWSSupportAsync, AWSSupportAsyncClient, AWSSupportClient

public interface AWSSupport

Interface for accessing AWS Support.

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.

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() Simplified method form for invoking the DescribeCases operation.
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() Simplified method form for invoking the DescribeServices operation.
DescribeServicesResult	describeServices(DescribeServicesRequest describeServicesRequest) Returns the current list of AWS services and a list of service categories that applies to each one.
DescribeSeverityLevelsResult	describeSeverityLevels() Simplified method form for invoking the DescribeSeverityLevels operation.
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() Simplified method form for invoking the ResolveCase operation.
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 ("https://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)

Overrides the default endpoint for this client ("https://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: "https://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: "https://support.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

void setRegion(Region region)

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. Must not be null and must be a region where the service is available.

See Also:

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

addAttachmentsToSet

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.

Parameters:

addAttachmentsToSetRequest - null

Returns:

Result of the AddAttachmentsToSet operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.

AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

AttachmentSetSizeLimitExceededException - A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

AttachmentLimitExceededException - The limit for the number of attachment sets created in a short period of time has been exceeded.

addCommunicationToCase

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.

Parameters:

addCommunicationToCaseRequest - To be written.

Returns:

Result of the AddCommunicationToCase operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

CaseIdNotFoundException - The requested CaseId could not be located.

AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.

AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

createCase

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.

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.

Parameters:

createCaseRequest - null

Returns:

Result of the CreateCase operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

CaseCreationLimitExceededException - The case creation limit for the account has been exceeded.

AttachmentSetIdNotFoundException - An attachment set with the specified ID could not be found.

AttachmentSetExpiredException - The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

describeAttachment

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.

Parameters:

describeAttachmentRequest - null

Returns:

Result of the DescribeAttachment operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

DescribeAttachmentLimitExceededException - The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

AttachmentIdNotFoundException - An attachment with the specified ID could not be found.

describeCases

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.

Parameters:

describeCasesRequest - null

Returns:

Result of the DescribeCases operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

CaseIdNotFoundException - The requested CaseId could not be located.

describeCases

DescribeCasesResult describeCases()

Simplified method form for invoking the DescribeCases operation.

See Also:

describeCases(DescribeCasesRequest)

describeCommunications

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.

Parameters:

describeCommunicationsRequest - null

Returns:

Result of the DescribeCommunications operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

CaseIdNotFoundException - The requested CaseId could not be located.

describeServices

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.

Parameters:

describeServicesRequest - null

Returns:

Result of the DescribeServices operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

describeServices

DescribeServicesResult describeServices()

Simplified method form for invoking the DescribeServices operation.

See Also:

describeServices(DescribeServicesRequest)

describeSeverityLevels

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.

Parameters:

describeSeverityLevelsRequest - null

Returns:

Result of the DescribeSeverityLevels operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

describeSeverityLevels

DescribeSeverityLevelsResult describeSeverityLevels()

Simplified method form for invoking the DescribeSeverityLevels operation.

See Also:

describeSeverityLevels(DescribeSeverityLevelsRequest)

describeTrustedAdvisorCheckRefreshStatuses

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.

Parameters:

describeTrustedAdvisorCheckRefreshStatusesRequest - null

Returns:

Result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

describeTrustedAdvisorCheckResult

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.

Parameters:

describeTrustedAdvisorCheckResultRequest - null

Returns:

Result of the DescribeTrustedAdvisorCheckResult operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

describeTrustedAdvisorCheckSummaries

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.

Parameters:

describeTrustedAdvisorCheckSummariesRequest - null

Returns:

Result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

describeTrustedAdvisorChecks

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.

Parameters:

describeTrustedAdvisorChecksRequest - null

Returns:

Result of the DescribeTrustedAdvisorChecks operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

refreshTrustedAdvisorCheck

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.

Parameters:

refreshTrustedAdvisorCheckRequest - null

Returns:

Result of the RefreshTrustedAdvisorCheck operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

resolveCase

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.

Parameters:

resolveCaseRequest - null

Returns:

Result of the ResolveCase operation returned by the service.

Throws:

InternalServerErrorException - An internal server error occurred.

CaseIdNotFoundException - The requested CaseId could not be located.

resolveCase

ResolveCaseResult resolveCase()

Simplified method form for invoking the ResolveCase operation.

See Also:

resolveCase(ResolveCaseRequest)

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.