public class AWSSupportClient extends AmazonWebServiceClient implements AWSSupport
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:
The following list describes the operations available from the AWS Support service for Trusted Advisor:
CheckId
for a specific check returned by
DescribeTrustedAdvisorChecks, you can call
DescribeTrustedAdvisorCheckResult to obtain the results for the check
you specified.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.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AWS Support exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AWSSupportClient()
Constructs a new client to invoke service methods on AWS Support.
|
AWSSupportClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWS Support using
the specified AWS account credentials.
|
AWSSupportClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Support using
the specified AWS account credentials and client configuration options.
|
AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWS Support using
the specified AWS account credentials provider.
|
AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS Support 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 AWS Support 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 AWS Support.
|
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. |
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, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AWSSupportClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AWSSupportClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to AWS Support (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AWSSupportClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AWSSupportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AWS Support (ex: proxy settings, retry counts, etc.).public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AWS Support (ex: proxy settings, retry counts, etc.).public AWSSupportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 AWS Support (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic 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.
addAttachmentsToSet
in interface AWSSupport
addAttachmentsToSetRequest
- 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.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.
addCommunicationToCase
in interface AWSSupport
addCommunicationToCaseRequest
- To be written.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.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:
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.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.
createCase
in interface AWSSupport
createCaseRequest
- 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.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.
describeAttachment
in interface AWSSupport
describeAttachmentRequest
- 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.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:
NextToken
values, which specify where to
paginate the returned records represented by the CaseDetails
objects.describeCases
in interface AWSSupport
describeCasesRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested CaseId
could not be located.public DescribeCasesResult describeCases()
AWSSupport
describeCases
in interface AWSSupport
AWSSupport.describeCases(DescribeCasesRequest)
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.
describeCommunications
in interface AWSSupport
describeCommunicationsRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested CaseId
could not be located.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.
describeServices
in interface AWSSupport
describeServicesRequest
- InternalServerErrorException
- An internal server error occurred.public DescribeServicesResult describeServices()
AWSSupport
describeServices
in interface AWSSupport
AWSSupport.describeServices(DescribeServicesRequest)
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.
describeSeverityLevels
in interface AWSSupport
describeSeverityLevelsRequest
- InternalServerErrorException
- An internal server error occurred.public DescribeSeverityLevelsResult describeSeverityLevels()
AWSSupport
describeSeverityLevels
in interface AWSSupport
AWSSupport.describeSeverityLevels(DescribeSeverityLevelsRequest)
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.
describeTrustedAdvisorCheckRefreshStatuses
in interface AWSSupport
describeTrustedAdvisorCheckRefreshStatusesRequest
- InternalServerErrorException
- An internal server error occurred.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:
In addition, the response contains these fields:
describeTrustedAdvisorCheckResult
in interface AWSSupport
describeTrustedAdvisorCheckResultRequest
- InternalServerErrorException
- An internal server error occurred.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.
describeTrustedAdvisorCheckSummaries
in interface AWSSupport
describeTrustedAdvisorCheckSummariesRequest
- InternalServerErrorException
- An internal server error occurred.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.
describeTrustedAdvisorChecks
in interface AWSSupport
describeTrustedAdvisorChecksRequest
- InternalServerErrorException
- An internal server error occurred.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:
refreshTrustedAdvisorCheck
in interface AWSSupport
refreshTrustedAdvisorCheckRequest
- InternalServerErrorException
- An internal server error occurred.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.
resolveCase
in interface AWSSupport
resolveCaseRequest
- InternalServerErrorException
- An internal server error occurred.CaseIdNotFoundException
- The requested CaseId
could not be located.public ResolveCaseResult resolveCase()
AWSSupport
resolveCase
in interface AWSSupport
AWSSupport.resolveCase(ResolveCaseRequest)
public 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 the request.
getCachedResponseMetadata
in interface AWSSupport
request
- The originally executed requestCopyright © 2015. All rights reserved.