Class AWSSupportAsyncClient
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceClient
-
- com.amazonaws.services.support.AWSSupportClient
-
- com.amazonaws.services.support.AWSSupportAsyncClient
-
- All Implemented Interfaces:
AWSSupport
,AWSSupportAsync
@ThreadSafe public class AWSSupportAsyncClient extends AWSSupportClient implements AWSSupportAsync
Interface for accessing AWS Support asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept anAsyncHandler
can be used to receive notification when an asynchronous operation 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 inherited from class com.amazonaws.services.support.AWSSupportClient
configFactory
-
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
-
Constructor Summary
Constructors Constructor Description AWSSupportAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS Support.AWSSupportAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials.AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider.AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Support using the provided AWS account credentials provider and client configuration options.AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider, executor service, and client configuration options.AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider and executor service.AWSSupportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials, executor service, and client configuration options.AWSSupportAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials and executor service.AWSSupportAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Support.
-
Method Summary
-
Methods inherited from class com.amazonaws.services.support.AWSSupportClient
addAttachmentsToSet, addCommunicationToCase, createCase, describeAttachment, describeCases, describeCases, describeCommunications, describeServices, describeServices, describeSeverityLevels, describeSeverityLevels, describeTrustedAdvisorCheckRefreshStatuses, describeTrustedAdvisorCheckResult, describeTrustedAdvisorChecks, describeTrustedAdvisorCheckSummaries, getCachedResponseMetadata, refreshTrustedAdvisorCheck, resolveCase, resolveCase
-
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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
addAttachmentsToSet, addCommunicationToCase, createCase, describeAttachment, describeCases, describeCases, describeCommunications, describeServices, describeServices, describeSeverityLevels, describeSeverityLevels, describeTrustedAdvisorCheckRefreshStatuses, describeTrustedAdvisorCheckResult, describeTrustedAdvisorChecks, describeTrustedAdvisorCheckSummaries, getCachedResponseMetadata, refreshTrustedAdvisorCheck, resolveCase, resolveCase, setEndpoint, setRegion
-
-
-
-
Constructor Detail
-
AWSSupportAsyncClient
public AWSSupportAsyncClient()
Constructs a new asynchronous client to invoke service methods on AWS Support. 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
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Support. 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
- Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
- Instance profile credentials delivered through the Amazon EC2 metadata service
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via
ClientConfiguration.getMaxConnections()
.- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to AWS Support (ex: proxy settings, retry counts, etc).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials.Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials and executor service. Default client settings will be used.- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials, executor service, and client configuration options.- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider. Default client settings will be used.Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.- See Also:
Executors.newFixedThreadPool(int)
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWS Support using the provided AWS account credentials provider and client configuration options.Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via
ClientConfiguration.getMaxConnections()
.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).- See Also:
DefaultAWSCredentialsProviderChain
,Executors.newFixedThreadPool(int)
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider and executor service. Default client settings will be used.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService
- The executor service by which all asynchronous requests will be executed.
-
AWSSupportAsyncClient
public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWS Support using the specified AWS account credentials provider, executor service, and client configuration options.- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- Client configuration options (ex: max retry limit, proxy settings, etc).executorService
- The executor service by which all asynchronous requests will be executed.
-
-
Method Detail
-
getExecutorService
public ExecutorService getExecutorService()
Returns the executor service used by this client to execute async requests.- Returns:
- The executor service used by this client to execute async requests.
-
addAttachmentsToSetAsync
public Future<AddAttachmentsToSetResult> addAttachmentsToSetAsync(AddAttachmentsToSetRequest request)
Description copied from interface:AWSSupportAsync
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 anAttachmentSetId
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:
addAttachmentsToSetAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the AddAttachmentsToSet operation returned by the service.
-
addAttachmentsToSetAsync
public Future<AddAttachmentsToSetResult> addAttachmentsToSetAsync(AddAttachmentsToSetRequest request, AsyncHandler<AddAttachmentsToSetRequest,AddAttachmentsToSetResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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 anAttachmentSetId
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:
addAttachmentsToSetAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddAttachmentsToSet operation returned by the service.
-
addCommunicationToCaseAsync
public Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest request)
Description copied from interface:AWSSupportAsync
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 theCcEmailAddresses
value. TheCommunicationBody
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:
addCommunicationToCaseAsync
in interfaceAWSSupportAsync
- Parameters:
request
- To be written.- Returns:
- A Java Future containing the result of the AddCommunicationToCase operation returned by the service.
-
addCommunicationToCaseAsync
public Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest request, AsyncHandler<AddCommunicationToCaseRequest,AddCommunicationToCaseResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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 theCcEmailAddresses
value. TheCommunicationBody
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:
addCommunicationToCaseAsync
in interfaceAWSSupportAsync
- Parameters:
request
- To be written.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the AddCommunicationToCase operation returned by the service.
-
createCaseAsync
public Future<CreateCaseResult> createCaseAsync(CreateCaseRequest request)
Description copied from interface:AWSSupportAsync
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:
- 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."
- ServiceCode. The code for an AWS service. You obtain the
ServiceCode
by calling DescribeServices. - 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. - 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.
- Subject. The Subject field on the AWS Support Center Create Case page.
- CommunicationBody. The Description field on the AWS Support Center Create Case page.
- AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
- Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
- 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.
- Specified by:
createCaseAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the CreateCase operation returned by the service.
-
createCaseAsync
public Future<CreateCaseResult> createCaseAsync(CreateCaseRequest request, AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
- 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."
- ServiceCode. The code for an AWS service. You obtain the
ServiceCode
by calling DescribeServices. - 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. - 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.
- Subject. The Subject field on the AWS Support Center Create Case page.
- CommunicationBody. The Description field on the AWS Support Center Create Case page.
- AttachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.
- Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
- 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.
- Specified by:
createCaseAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the CreateCase operation returned by the service.
-
describeAttachmentAsync
public Future<DescribeAttachmentResult> describeAttachmentAsync(DescribeAttachmentRequest request)
Description copied from interface:AWSSupportAsync
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:
describeAttachmentAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeAttachment operation returned by the service.
-
describeAttachmentAsync
public Future<DescribeAttachmentResult> describeAttachmentAsync(DescribeAttachmentRequest request, AsyncHandler<DescribeAttachmentRequest,DescribeAttachmentResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeAttachmentAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeAttachment operation returned by the service.
-
describeCasesAsync
public Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest request)
Description copied from interface:AWSSupportAsync
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
andBeforeTime
request parameters. You can set values for theIncludeResolvedCases
andIncludeCommunications
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:
- One or more CaseDetails data types.
- One or more
NextToken
values, which specify where to paginate the returned records represented by theCaseDetails
objects.
- Specified by:
describeCasesAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeCases operation returned by the service.
-
describeCasesAsync
public Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest request, AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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
andBeforeTime
request parameters. You can set values for theIncludeResolvedCases
andIncludeCommunications
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:
- One or more CaseDetails data types.
- One or more
NextToken
values, which specify where to paginate the returned records represented by theCaseDetails
objects.
- Specified by:
describeCasesAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeCases operation returned by the service.
-
describeCasesAsync
public Future<DescribeCasesResult> describeCasesAsync()
Simplified method form for invoking the DescribeCases operation.- Specified by:
describeCasesAsync
in interfaceAWSSupportAsync
- See Also:
describeCasesAsync(DescribeCasesRequest)
-
describeCasesAsync
public Future<DescribeCasesResult> describeCasesAsync(AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
Simplified method form for invoking the DescribeCases operation with an AsyncHandler.- Specified by:
describeCasesAsync
in interfaceAWSSupportAsync
- See Also:
describeCasesAsync(DescribeCasesRequest, com.amazonaws.handlers.AsyncHandler)
-
describeCommunicationsAsync
public Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest request)
Description copied from interface:AWSSupportAsync
Returns communications (and attachments) for one or more support cases. You can use the
AfterTime
andBeforeTime
parameters to filter by date. You can use theCaseId
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
andNextToken
parameters to control the pagination of the result set. SetMaxResults
to the number of cases you want displayed on each page, and useNextToken
to specify the resumption of pagination.- Specified by:
describeCommunicationsAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeCommunications operation returned by the service.
-
describeCommunicationsAsync
public Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest request, AsyncHandler<DescribeCommunicationsRequest,DescribeCommunicationsResult> asyncHandler)
Description copied from interface:AWSSupportAsync
Returns communications (and attachments) for one or more support cases. You can use the
AfterTime
andBeforeTime
parameters to filter by date. You can use theCaseId
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
andNextToken
parameters to control the pagination of the result set. SetMaxResults
to the number of cases you want displayed on each page, and useNextToken
to specify the resumption of pagination.- Specified by:
describeCommunicationsAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeCommunications operation returned by the service.
-
describeServicesAsync
public Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest request)
Description copied from interface:AWSSupportAsync
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:
describeServicesAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeServices operation returned by the service.
-
describeServicesAsync
public Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest request, AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeServicesAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeServices operation returned by the service.
-
describeServicesAsync
public Future<DescribeServicesResult> describeServicesAsync()
Simplified method form for invoking the DescribeServices operation.- Specified by:
describeServicesAsync
in interfaceAWSSupportAsync
- See Also:
describeServicesAsync(DescribeServicesRequest)
-
describeServicesAsync
public Future<DescribeServicesResult> describeServicesAsync(AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
Simplified method form for invoking the DescribeServices operation with an AsyncHandler.- Specified by:
describeServicesAsync
in interfaceAWSSupportAsync
- See Also:
describeServicesAsync(DescribeServicesRequest, com.amazonaws.handlers.AsyncHandler)
-
describeSeverityLevelsAsync
public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest request)
Description copied from interface:AWSSupportAsync
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:
describeSeverityLevelsAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeSeverityLevels operation returned by the service.
-
describeSeverityLevelsAsync
public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest request, AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeSeverityLevelsAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeSeverityLevels operation returned by the service.
-
describeSeverityLevelsAsync
public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync()
Simplified method form for invoking the DescribeSeverityLevels operation.- Specified by:
describeSeverityLevelsAsync
in interfaceAWSSupportAsync
- See Also:
describeSeverityLevelsAsync(DescribeSeverityLevelsRequest)
-
describeSeverityLevelsAsync
public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
Simplified method form for invoking the DescribeSeverityLevels operation with an AsyncHandler.- Specified by:
describeSeverityLevelsAsync
in interfaceAWSSupportAsync
- See Also:
describeSeverityLevelsAsync(DescribeSeverityLevelsRequest, com.amazonaws.handlers.AsyncHandler)
-
describeTrustedAdvisorCheckRefreshStatusesAsync
public Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest request)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorCheckRefreshStatusesAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
-
describeTrustedAdvisorCheckRefreshStatusesAsync
public Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest request, AsyncHandler<DescribeTrustedAdvisorCheckRefreshStatusesRequest,DescribeTrustedAdvisorCheckRefreshStatusesResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorCheckRefreshStatusesAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckRefreshStatuses operation returned by the service.
-
describeTrustedAdvisorCheckResultAsync
public Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest request)
Description copied from interface:AWSSupportAsync
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:
- 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:
describeTrustedAdvisorCheckResultAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
-
describeTrustedAdvisorCheckResultAsync
public Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest request, AsyncHandler<DescribeTrustedAdvisorCheckResultRequest,DescribeTrustedAdvisorCheckResultResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
- 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:
describeTrustedAdvisorCheckResultAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckResult operation returned by the service.
-
describeTrustedAdvisorCheckSummariesAsync
public Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest request)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorCheckSummariesAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
-
describeTrustedAdvisorCheckSummariesAsync
public Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest request, AsyncHandler<DescribeTrustedAdvisorCheckSummariesRequest,DescribeTrustedAdvisorCheckSummariesResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorCheckSummariesAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorCheckSummaries operation returned by the service.
-
describeTrustedAdvisorChecksAsync
public Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest request)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorChecksAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorChecks operation returned by the service.
-
describeTrustedAdvisorChecksAsync
public Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest request, AsyncHandler<DescribeTrustedAdvisorChecksRequest,DescribeTrustedAdvisorChecksResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
describeTrustedAdvisorChecksAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the DescribeTrustedAdvisorChecks operation returned by the service.
-
refreshTrustedAdvisorCheckAsync
public Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest request)
Description copied from interface:AWSSupportAsync
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:
refreshTrustedAdvisorCheckAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the RefreshTrustedAdvisorCheck operation returned by the service.
-
refreshTrustedAdvisorCheckAsync
public Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest request, AsyncHandler<RefreshTrustedAdvisorCheckRequest,RefreshTrustedAdvisorCheckResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
refreshTrustedAdvisorCheckAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the RefreshTrustedAdvisorCheck operation returned by the service.
-
resolveCaseAsync
public Future<ResolveCaseResult> resolveCaseAsync(ResolveCaseRequest request)
Description copied from interface:AWSSupportAsync
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:
resolveCaseAsync
in interfaceAWSSupportAsync
- Returns:
- A Java Future containing the result of the ResolveCase operation returned by the service.
-
resolveCaseAsync
public Future<ResolveCaseResult> resolveCaseAsync(ResolveCaseRequest request, AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
Description copied from interface:AWSSupportAsync
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:
resolveCaseAsync
in interfaceAWSSupportAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.- Returns:
- A Java Future containing the result of the ResolveCase operation returned by the service.
-
resolveCaseAsync
public Future<ResolveCaseResult> resolveCaseAsync()
Simplified method form for invoking the ResolveCase operation.- Specified by:
resolveCaseAsync
in interfaceAWSSupportAsync
- See Also:
resolveCaseAsync(ResolveCaseRequest)
-
resolveCaseAsync
public Future<ResolveCaseResult> resolveCaseAsync(AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
Simplified method form for invoking the ResolveCase operation with an AsyncHandler.- Specified by:
resolveCaseAsync
in interfaceAWSSupportAsync
- See Also:
resolveCaseAsync(ResolveCaseRequest, com.amazonaws.handlers.AsyncHandler)
-
shutdown
public void shutdown()
Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should callgetExecutorService().shutdown()
followed bygetExecutorService().awaitTermination()
prior to calling this method.- Specified by:
shutdown
in interfaceAWSSupport
- Overrides:
shutdown
in classAmazonWebServiceClient
-
-