com.amazonaws.services.support
Class AWSSupportAsyncClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.support.AWSSupportClient
          extended by com.amazonaws.services.support.AWSSupportAsyncClient
All Implemented Interfaces:
AWSSupport, AWSSupportAsync

public class AWSSupportAsyncClient
extends AWSSupportClient
implements AWSSupportAsync

Asynchronous client for accessing AWSSupport. All asynchronous calls made using this client are non-blocking. Callers could either process the result and handle the exceptions in the worker thread by providing a callback handler when making the call, or use the returned Future object to check the result of the call in the calling thread. AWS Support

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.


Field Summary
 
Fields inherited from class com.amazonaws.services.support.AWSSupportClient
jsonErrorUnmarshallers
 
Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
 
Constructor Summary
AWSSupportAsyncClient()
          Constructs a new asynchronous client to invoke service methods on AWSSupport.
AWSSupportAsyncClient(AWSCredentials awsCredentials)
          Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials.
AWSSupportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
          Constructs a new asynchronous client to invoke service methods on AWSSupport 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 AWSSupport using the specified AWS account credentials and executor service.
AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
          Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials provider.
AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
          Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified 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 AWSSupport 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 AWSSupport using the specified AWS account credentials provider and executor service.
AWSSupportAsyncClient(ClientConfiguration clientConfiguration)
          Constructs a new asynchronous client to invoke service methods on AWSSupport.
 
Method Summary
 Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest)
           Adds additional customer communication to an AWS Support case.
 Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest, AsyncHandler<AddCommunicationToCaseRequest,AddCommunicationToCaseResult> asyncHandler)
           Adds additional customer communication to an AWS Support case.
 Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest)
           Creates a new case in the AWS Support Center.
 Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest, AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
           Creates a new case in the AWS Support Center.
 Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest describeCasesRequest)
           Returns a list of cases that you specify by passing one or more case IDs.
 Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest describeCasesRequest, AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
           Returns a list of cases that you specify by passing one or more case IDs.
 Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest)
           Returns communications regarding the support case.
 Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest, AsyncHandler<DescribeCommunicationsRequest,DescribeCommunicationsResult> asyncHandler)
           Returns communications regarding the support case.
 Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest describeServicesRequest)
           Returns the current list of AWS services and a list of service categories that applies to each one.
 Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest describeServicesRequest, AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
           Returns the current list of AWS services and a list of service categories that applies to each one.
 Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest)
           Returns the list of severity levels that you can assign to an AWS Support case.
 Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest, AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
           Returns the list of severity levels that you can assign to an AWS Support case.
 Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest)
           Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
 Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest, AsyncHandler<DescribeTrustedAdvisorCheckRefreshStatusesRequest,DescribeTrustedAdvisorCheckRefreshStatusesResult> asyncHandler)
           Returns the refresh status of the Trusted Advisor checks that have the specified check IDs.
 Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest)
           Returns the results of the Trusted Advisor check that has the specified check ID.
 Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest, AsyncHandler<DescribeTrustedAdvisorCheckResultRequest,DescribeTrustedAdvisorCheckResultResult> asyncHandler)
           Returns the results of the Trusted Advisor check that has the specified check ID.
 Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest)
           Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata.
 Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest, AsyncHandler<DescribeTrustedAdvisorChecksRequest,DescribeTrustedAdvisorChecksResult> asyncHandler)
           Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata.
 Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest)
           Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
 Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest, AsyncHandler<DescribeTrustedAdvisorCheckSummariesRequest,DescribeTrustedAdvisorCheckSummariesResult> asyncHandler)
           Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs.
 ExecutorService getExecutorService()
          Returns the executor service used by this async client to execute requests.
 Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest)
           Requests a refresh of the Trusted Advisor check that has the specified check ID.
 Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest, AsyncHandler<RefreshTrustedAdvisorCheckRequest,RefreshTrustedAdvisorCheckResult> asyncHandler)
           Requests a refresh of the Trusted Advisor check that has the specified check ID.
 Future<ResolveCaseResult> resolveCaseAsync(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.
 Future<ResolveCaseResult> resolveCaseAsync(ResolveCaseRequest resolveCaseRequest, AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
           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 shutdown()
          Shuts down the client, releasing all managed resources.
 
Methods inherited from class com.amazonaws.services.support.AWSSupportClient
addCommunicationToCase, createCase, describeCases, describeCases, describeCommunications, describeServices, describeServices, describeSeverityLevels, describeSeverityLevels, describeTrustedAdvisorCheckRefreshStatuses, describeTrustedAdvisorCheckResult, describeTrustedAdvisorChecks, describeTrustedAdvisorCheckSummaries, getCachedResponseMetadata, refreshTrustedAdvisorCheck, resolveCase, resolveCase, setEndpoint, setEndpoint
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, 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
addCommunicationToCase, createCase, 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 AWSSupport. A credentials provider chain will be used that searches for credentials in this order:

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

See Also:
DefaultAWSCredentialsProviderChain

AWSSupportAsyncClient

public AWSSupportAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AWSSupport. A credentials provider chain will be used that searches for credentials in this order:

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

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

AWSSupportAsyncClient

public AWSSupportAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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

AWSSupportAsyncClient

public AWSSupportAsyncClient(AWSCredentials awsCredentials,
                             ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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 AWSSupport using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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 AWSSupport using the specified AWS account credentials provider. Default client settings will be used, and a fixed size thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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

AWSSupportAsyncClient

public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials provider and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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)
Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials provider and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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

AWSSupportAsyncClient

public AWSSupportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                             ClientConfiguration clientConfiguration,
                             ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AWSSupport using the specified AWS account credentials provider, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

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 async client to execute requests.

Returns:
The executor service used by this async client to execute requests.

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 call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:
shutdown in interface AWSSupport
Overrides:
shutdown in class AmazonWebServiceClient

describeCasesAsync

public Future<DescribeCasesResult> describeCasesAsync(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:

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

Specified by:
describeCasesAsync in interface AWSSupportAsync
Parameters:
describeCasesRequest - Container for the necessary parameters to execute the DescribeCases operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeCases service method, as returned by AWSSupport.
Throws:
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.

describeCasesAsync

public Future<DescribeCasesResult> describeCasesAsync(DescribeCasesRequest describeCasesRequest,
                                                      AsyncHandler<DescribeCasesRequest,DescribeCasesResult> asyncHandler)
                                               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:

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

Specified by:
describeCasesAsync in interface AWSSupportAsync
Parameters:
describeCasesRequest - Container for the necessary parameters to execute the DescribeCases operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeCases service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckRefreshStatusesAsync

public Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(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.

Specified by:
describeTrustedAdvisorCheckRefreshStatusesAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckRefreshStatusesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckRefreshStatusesAsync

public Future<DescribeTrustedAdvisorCheckRefreshStatusesResult> describeTrustedAdvisorCheckRefreshStatusesAsync(DescribeTrustedAdvisorCheckRefreshStatusesRequest describeTrustedAdvisorCheckRefreshStatusesRequest,
                                                                                                                AsyncHandler<DescribeTrustedAdvisorCheckRefreshStatusesRequest,DescribeTrustedAdvisorCheckRefreshStatusesResult> asyncHandler)
                                                                                                         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.

Specified by:
describeTrustedAdvisorCheckRefreshStatusesAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckRefreshStatusesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckRefreshStatuses operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckRefreshStatuses service method, as returned by AWSSupport.
Throws:
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.

describeSeverityLevelsAsync

public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(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.

Specified by:
describeSeverityLevelsAsync in interface AWSSupportAsync
Parameters:
describeSeverityLevelsRequest - Container for the necessary parameters to execute the DescribeSeverityLevels operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeSeverityLevels service method, as returned by AWSSupport.
Throws:
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.

describeSeverityLevelsAsync

public Future<DescribeSeverityLevelsResult> describeSeverityLevelsAsync(DescribeSeverityLevelsRequest describeSeverityLevelsRequest,
                                                                        AsyncHandler<DescribeSeverityLevelsRequest,DescribeSeverityLevelsResult> asyncHandler)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

Specified by:
describeSeverityLevelsAsync in interface AWSSupportAsync
Parameters:
describeSeverityLevelsRequest - Container for the necessary parameters to execute the DescribeSeverityLevels operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeSeverityLevels service method, as returned by AWSSupport.
Throws:
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.

describeCommunicationsAsync

public Future<DescribeCommunicationsResult> describeCommunicationsAsync(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.

Specified by:
describeCommunicationsAsync in interface AWSSupportAsync
Parameters:
describeCommunicationsRequest - Container for the necessary parameters to execute the DescribeCommunications operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeCommunications service method, as returned by AWSSupport.
Throws:
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.

describeCommunicationsAsync

public Future<DescribeCommunicationsResult> describeCommunicationsAsync(DescribeCommunicationsRequest describeCommunicationsRequest,
                                                                        AsyncHandler<DescribeCommunicationsRequest,DescribeCommunicationsResult> asyncHandler)
                                                                 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.

Specified by:
describeCommunicationsAsync in interface AWSSupportAsync
Parameters:
describeCommunicationsRequest - Container for the necessary parameters to execute the DescribeCommunications operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeCommunications service method, as returned by AWSSupport.
Throws:
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.

addCommunicationToCaseAsync

public Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(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.

Specified by:
addCommunicationToCaseAsync in interface AWSSupportAsync
Parameters:
addCommunicationToCaseRequest - Container for the necessary parameters to execute the AddCommunicationToCase operation on AWSSupport.
Returns:
A Java Future object containing the response from the AddCommunicationToCase service method, as returned by AWSSupport.
Throws:
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.

addCommunicationToCaseAsync

public Future<AddCommunicationToCaseResult> addCommunicationToCaseAsync(AddCommunicationToCaseRequest addCommunicationToCaseRequest,
                                                                        AsyncHandler<AddCommunicationToCaseRequest,AddCommunicationToCaseResult> asyncHandler)
                                                                 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.

Specified by:
addCommunicationToCaseAsync in interface AWSSupportAsync
Parameters:
addCommunicationToCaseRequest - Container for the necessary parameters to execute the AddCommunicationToCase operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the AddCommunicationToCase service method, as returned by AWSSupport.
Throws:
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.

createCaseAsync

public Future<CreateCaseResult> createCaseAsync(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:

  1. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
  2. 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.
  3. 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.
  4. Subject. The Subject field on the AWS Support Center Open a new case page.
  5. CommunicationBody. The Description field on the AWS Support Center Open a new case page.
  6. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
  7. CcEmailAddresses. The AWS Support Center CC field on the Open a new 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 .
  8. 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."

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.

Specified by:
createCaseAsync in interface AWSSupportAsync
Parameters:
createCaseRequest - Container for the necessary parameters to execute the CreateCase operation on AWSSupport.
Returns:
A Java Future object containing the response from the CreateCase service method, as returned by AWSSupport.
Throws:
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.

createCaseAsync

public Future<CreateCaseResult> createCaseAsync(CreateCaseRequest createCaseRequest,
                                                AsyncHandler<CreateCaseRequest,CreateCaseResult> asyncHandler)
                                         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:

  1. ServiceCode. The code for an AWS service. You obtain the ServiceCode by calling DescribeServices.
  2. 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.
  3. 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.
  4. Subject. The Subject field on the AWS Support Center Open a new case page.
  5. CommunicationBody. The Description field on the AWS Support Center Open a new case page.
  6. Language. The human language in which AWS Support handles the case. English and Japanese are currently supported.
  7. CcEmailAddresses. The AWS Support Center CC field on the Open a new 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 .
  8. 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."

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.

Specified by:
createCaseAsync in interface AWSSupportAsync
Parameters:
createCaseRequest - Container for the necessary parameters to execute the CreateCase operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the CreateCase service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorChecksAsync

public Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(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.

Specified by:
describeTrustedAdvisorChecksAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorChecksRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorChecksAsync

public Future<DescribeTrustedAdvisorChecksResult> describeTrustedAdvisorChecksAsync(DescribeTrustedAdvisorChecksRequest describeTrustedAdvisorChecksRequest,
                                                                                    AsyncHandler<DescribeTrustedAdvisorChecksRequest,DescribeTrustedAdvisorChecksResult> asyncHandler)
                                                                             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.

Specified by:
describeTrustedAdvisorChecksAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorChecksRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorChecks operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorChecks service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckResultAsync

public Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(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:

Specified by:
describeTrustedAdvisorCheckResultAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckResultRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckResultAsync

public Future<DescribeTrustedAdvisorCheckResultResult> describeTrustedAdvisorCheckResultAsync(DescribeTrustedAdvisorCheckResultRequest describeTrustedAdvisorCheckResultRequest,
                                                                                              AsyncHandler<DescribeTrustedAdvisorCheckResultRequest,DescribeTrustedAdvisorCheckResultResult> asyncHandler)
                                                                                       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:

Specified by:
describeTrustedAdvisorCheckResultAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckResultRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckResult operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckResult service method, as returned by AWSSupport.
Throws:
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.

resolveCaseAsync

public Future<ResolveCaseResult> resolveCaseAsync(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.

Specified by:
resolveCaseAsync in interface AWSSupportAsync
Parameters:
resolveCaseRequest - Container for the necessary parameters to execute the ResolveCase operation on AWSSupport.
Returns:
A Java Future object containing the response from the ResolveCase service method, as returned by AWSSupport.
Throws:
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.

resolveCaseAsync

public Future<ResolveCaseResult> resolveCaseAsync(ResolveCaseRequest resolveCaseRequest,
                                                  AsyncHandler<ResolveCaseRequest,ResolveCaseResult> asyncHandler)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Takes a CaseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

Specified by:
resolveCaseAsync in interface AWSSupportAsync
Parameters:
resolveCaseRequest - Container for the necessary parameters to execute the ResolveCase operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ResolveCase service method, as returned by AWSSupport.
Throws:
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.

refreshTrustedAdvisorCheckAsync

public Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(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:

Specified by:
refreshTrustedAdvisorCheckAsync in interface AWSSupportAsync
Parameters:
refreshTrustedAdvisorCheckRequest - Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AWSSupport.
Returns:
A Java Future object containing the response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.
Throws:
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.

refreshTrustedAdvisorCheckAsync

public Future<RefreshTrustedAdvisorCheckResult> refreshTrustedAdvisorCheckAsync(RefreshTrustedAdvisorCheckRequest refreshTrustedAdvisorCheckRequest,
                                                                                AsyncHandler<RefreshTrustedAdvisorCheckRequest,RefreshTrustedAdvisorCheckResult> asyncHandler)
                                                                         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:

Specified by:
refreshTrustedAdvisorCheckAsync in interface AWSSupportAsync
Parameters:
refreshTrustedAdvisorCheckRequest - Container for the necessary parameters to execute the RefreshTrustedAdvisorCheck operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RefreshTrustedAdvisorCheck service method, as returned by AWSSupport.
Throws:
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.

describeServicesAsync

public Future<DescribeServicesResult> describeServicesAsync(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.

Specified by:
describeServicesAsync in interface AWSSupportAsync
Parameters:
describeServicesRequest - Container for the necessary parameters to execute the DescribeServices operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeServices service method, as returned by AWSSupport.
Throws:
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.

describeServicesAsync

public Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest describeServicesRequest,
                                                            AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
                                                     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.

Specified by:
describeServicesAsync in interface AWSSupportAsync
Parameters:
describeServicesRequest - Container for the necessary parameters to execute the DescribeServices operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeServices service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckSummariesAsync

public Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(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.

Specified by:
describeTrustedAdvisorCheckSummariesAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckSummariesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AWSSupport.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.
Throws:
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.

describeTrustedAdvisorCheckSummariesAsync

public Future<DescribeTrustedAdvisorCheckSummariesResult> describeTrustedAdvisorCheckSummariesAsync(DescribeTrustedAdvisorCheckSummariesRequest describeTrustedAdvisorCheckSummariesRequest,
                                                                                                    AsyncHandler<DescribeTrustedAdvisorCheckSummariesRequest,DescribeTrustedAdvisorCheckSummariesResult> asyncHandler)
                                                                                             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.

Specified by:
describeTrustedAdvisorCheckSummariesAsync in interface AWSSupportAsync
Parameters:
describeTrustedAdvisorCheckSummariesRequest - Container for the necessary parameters to execute the DescribeTrustedAdvisorCheckSummaries operation on AWSSupport.
asyncHandler - Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTrustedAdvisorCheckSummaries service method, as returned by AWSSupport.
Throws:
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.


Copyright © 2016. All rights reserved.