public interface AWSSupport
The AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.
The following list describes the AWS Support case management actions:
The following list describes the actions available from the AWS Support service for Trusted Advisor:
For authentication of requests, AWS Support uses Signature Version 4 Signing Process .
See the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.
Modifier and Type | Method and Description |
---|---|
AddAttachmentsToSetResult |
addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest) |
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) |
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 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()
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 ("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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
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.
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.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
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.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
DescribeTrustedAdvisorCheckRefreshStatusesResult describeTrustedAdvisorCheckRefreshStatuses(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest) throws AmazonServiceException, AmazonClientException
Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
describeTrustedAdvisorCheckRefreshStatusesRequest
- Container for
the necessary parameters to execute the
DescribeTrustedAdvisorCheckRefreshStatuses service method on
AWSSupport.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.DescribeCasesResult describeCases(DescribeCasesRequest describeCasesRequest) 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.
The response returns the following in JSON format:
NextToken
values, which specify where to
paginate the returned records represented by the
CaseDetails
objects.describeCasesRequest
- Container for the necessary parameters to
execute the DescribeCases service method on AWSSupport.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.AddAttachmentsToSetResult addAttachmentsToSet(AddAttachmentsToSetRequest addAttachmentsToSetRequest) throws AmazonServiceException, AmazonClientException
addAttachmentsToSetRequest
- Container for the necessary
parameters to execute the AddAttachmentsToSet service method on
AWSSupport.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.DescribeSeverityLevelsResult describeSeverityLevels(DescribeSeverityLevelsRequest describeSeverityLevelsRequest) 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.
describeSeverityLevelsRequest
- Container for the necessary
parameters to execute the DescribeSeverityLevels service method on
AWSSupport.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.DescribeCommunicationsResult describeCommunications(DescribeCommunicationsRequest describeCommunicationsRequest) throws AmazonServiceException, AmazonClientException
Returns communications regarding the support case. You can use the
AfterTime
and BeforeTime
parameters to
filter by date. The CaseId
parameter enables you to
identify a specific case by its CaseId
value.
The MaxResults
and NextToken
parameters
enable you to control the pagination of the result set. Set
MaxResults
to the number of cases you want displayed on
each page, and use NextToken
to specify the resumption of
pagination.
describeCommunicationsRequest
- Container for the necessary
parameters to execute the DescribeCommunications service method on
AWSSupport.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.DescribeAttachmentResult describeAttachment(DescribeAttachmentRequest describeAttachmentRequest) throws AmazonServiceException, AmazonClientException
describeAttachmentRequest
- Container for the necessary
parameters to execute the DescribeAttachment service method on
AWSSupport.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.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.
resolveCaseRequest
- Container for the necessary parameters to
execute the ResolveCase service method on AWSSupport.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.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.
describeServicesRequest
- Container for the necessary parameters
to execute the DescribeServices service method on AWSSupport.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.AddCommunicationToCaseResult addCommunicationToCase(AddCommunicationToCaseRequest addCommunicationToCaseRequest) throws AmazonServiceException, AmazonClientException
Adds additional customer communication to an AWS Support case. You
use the CaseId
value to identify the case to add
communication to. You can list a set of email addresses to copy on the
communication using the CcEmailAddresses
value. The
CommunicationBody
value contains the text of the
communication.
The response indicates the success or failure of the request.
This operation implements a subset of the behavior on the AWS Support Your Support Cases web form.
addCommunicationToCaseRequest
- Container for the necessary
parameters to execute the AddCommunicationToCase service method on
AWSSupport.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.CreateCaseResult createCase(CreateCaseRequest createCaseRequest) throws AmazonServiceException, AmazonClientException
Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:
ServiceCode
by calling DescribeServices. ServiceCode
value. You also obtain the category code
for a service by calling DescribeServices. Each AWS service defines
its own set of category codes. NOTE: The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases.
createCaseRequest
- Container for the necessary parameters to
execute the CreateCase service method on AWSSupport.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.DescribeTrustedAdvisorChecksResult describeTrustedAdvisorChecks(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest) throws AmazonServiceException, AmazonClientException
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.
describeTrustedAdvisorChecksRequest
- Container for the necessary
parameters to execute the DescribeTrustedAdvisorChecks service method
on AWSSupport.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.DescribeTrustedAdvisorCheckResultResult describeTrustedAdvisorCheckResult(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest) throws AmazonServiceException, AmazonClientException
Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a TrustedAdvisorCheckResult object, which contains these three objects:
In addition, the response contains these fields:
describeTrustedAdvisorCheckResultRequest
- Container for the
necessary parameters to execute the DescribeTrustedAdvisorCheckResult
service method on AWSSupport.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.RefreshTrustedAdvisorCheckResult refreshTrustedAdvisorCheck(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest) throws AmazonServiceException, AmazonClientException
Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.
The response contains a RefreshTrustedAdvisorCheckResult object, which contains these fields:
refreshTrustedAdvisorCheckRequest
- Container for the necessary
parameters to execute the RefreshTrustedAdvisorCheck service method on
AWSSupport.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.DescribeTrustedAdvisorCheckSummariesResult describeTrustedAdvisorCheckSummaries(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest) throws AmazonServiceException, AmazonClientException
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.
describeTrustedAdvisorCheckSummariesRequest
- Container for the
necessary parameters to execute the
DescribeTrustedAdvisorCheckSummaries service method on AWSSupport.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.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.
The response returns the following in JSON format:
NextToken
values, which specify where to
paginate the returned records represented by the
CaseDetails
objects.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.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.
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.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.
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.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.
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request
- The originally executed request.Copyright © 2014. All rights reserved.