com.amazonaws.services.workspaces

Class AmazonWorkspacesAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.workspaces.AmazonWorkspacesClient

com.amazonaws.services.workspaces.AmazonWorkspacesAsyncClient

All Implemented Interfaces:

AmazonWorkspaces, AmazonWorkspacesAsync

public class AmazonWorkspacesAsyncClient
extends AmazonWorkspacesClient
implements AmazonWorkspacesAsync

Asynchronous client for accessing AmazonWorkspaces. 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. Amazon WorkSpaces Service

This is the Amazon WorkSpaces API Reference . This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.

Field Summary

Fields inherited from class com.amazonaws.services.workspaces.AmazonWorkspacesClient

jsonErrorUnmarshallers

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonWorkspacesAsyncClient() Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces.
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials.
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials, executor service, and client configuration options.
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials and executor service.
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider.
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider and client configuration options.
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider, executor service, and client configuration options.
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces using the specified AWS account credentials provider and executor service.
AmazonWorkspacesAsyncClient(ClientConfiguration clientConfiguration) Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces.

Method Summary

Methods

Modifier and Type	Method and Description
Future<CreateWorkspacesResult>	createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest) Creates one or more WorkSpaces.
Future<CreateWorkspacesResult>	createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest, AsyncHandler<CreateWorkspacesRequest,CreateWorkspacesResult> asyncHandler) Creates one or more WorkSpaces.
Future<DescribeWorkspaceBundlesResult>	describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) Obtains information about the WorkSpace bundles that are available to your account in the specified region.
Future<DescribeWorkspaceBundlesResult>	describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest, AsyncHandler<DescribeWorkspaceBundlesRequest,DescribeWorkspaceBundlesResult> asyncHandler) Obtains information about the WorkSpace bundles that are available to your account in the specified region.
Future<DescribeWorkspaceDirectoriesResult>	describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
Future<DescribeWorkspaceDirectoriesResult>	describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest, AsyncHandler<DescribeWorkspaceDirectoriesRequest,DescribeWorkspaceDirectoriesResult> asyncHandler) Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
Future<DescribeWorkspacesResult>	describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest) Obtains information about the specified WorkSpaces.
Future<DescribeWorkspacesResult>	describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest, AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler) Obtains information about the specified WorkSpaces.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<RebootWorkspacesResult>	rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest) Reboots the specified WorkSpaces.
Future<RebootWorkspacesResult>	rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest, AsyncHandler<RebootWorkspacesRequest,RebootWorkspacesResult> asyncHandler) Reboots the specified WorkSpaces.
Future<RebuildWorkspacesResult>	rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest) Rebuilds the specified WorkSpaces.
Future<RebuildWorkspacesResult>	rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest, AsyncHandler<RebuildWorkspacesRequest,RebuildWorkspacesResult> asyncHandler) Rebuilds the specified WorkSpaces.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TerminateWorkspacesResult>	terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest) Terminates the specified WorkSpaces.
Future<TerminateWorkspacesResult>	terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest, AsyncHandler<TerminateWorkspacesRequest,TerminateWorkspacesResult> asyncHandler) Terminates the specified WorkSpaces.

Methods inherited from class com.amazonaws.services.workspaces.AmazonWorkspacesClient

createWorkspaces, describeWorkspaceBundles, describeWorkspaceBundles, describeWorkspaceDirectories, describeWorkspaceDirectories, describeWorkspaces, describeWorkspaces, getCachedResponseMetadata, rebootWorkspaces, rebuildWorkspaces, setEndpoint, setEndpoint, terminateWorkspaces

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, 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.workspaces.AmazonWorkspaces

createWorkspaces, describeWorkspaceBundles, describeWorkspaceBundles, describeWorkspaceDirectories, describeWorkspaceDirectories, describeWorkspaces, describeWorkspaces, getCachedResponseMetadata, rebootWorkspaces, rebuildWorkspaces, setEndpoint, setRegion, terminateWorkspaces

Constructor Detail

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

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

See Also:

DefaultAWSCredentialsProviderChain

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces. 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
• Instance profile credentials delivered through the Amazon EC2 metadata service

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 AmazonWorkspaces (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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.

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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.

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials,
                           ClientConfiguration clientConfiguration,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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.

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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.

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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.

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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).

AmazonWorkspacesAsyncClient

public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                           ClientConfiguration clientConfiguration,
                           ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonWorkspaces 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 AmazonWorkspaces

Overrides:

shutdown in class AmazonWebServiceClient

createWorkspacesAsync

public Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Creates one or more WorkSpaces.

NOTE: This operation is asynchronous and returns before the WorkSpaces are created.

Specified by:

createWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

createWorkspacesRequest - Container for the necessary parameters to execute the CreateWorkspaces operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the CreateWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

createWorkspacesAsync

public Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest,
                                                   AsyncHandler<CreateWorkspacesRequest,CreateWorkspacesResult> asyncHandler)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Creates one or more WorkSpaces.

NOTE: This operation is asynchronous and returns before the WorkSpaces are created.

Specified by:

createWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

createWorkspacesRequest - Container for the necessary parameters to execute the CreateWorkspaces operation on AmazonWorkspaces.

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 CreateWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceBundlesAsync

public Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspaceBundlesRequest - Container for the necessary parameters to execute the DescribeWorkspaceBundles operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceBundlesAsync

public Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest,
                                                                   AsyncHandler<DescribeWorkspaceBundlesRequest,DescribeWorkspaceBundlesResult> asyncHandler)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

Obtains information about the WorkSpace bundles that are available to your account in the specified region.

You can filter the results with either the BundleIds parameter, or the Owner parameter, but not both.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspaceBundlesRequest - Container for the necessary parameters to execute the DescribeWorkspaceBundles operation on AmazonWorkspaces.

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 DescribeWorkspaceBundles service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebootWorkspacesAsync

public Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE , IMPAIRED , or INOPERABLE .

NOTE: This operation is asynchronous and will return before the WorkSpaces have rebooted.

Specified by:

rebootWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

rebootWorkspacesRequest - Container for the necessary parameters to execute the RebootWorkspaces operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the RebootWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebootWorkspacesAsync

public Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest,
                                                   AsyncHandler<RebootWorkspacesRequest,RebootWorkspacesResult> asyncHandler)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

Reboots the specified WorkSpaces.

To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE , IMPAIRED , or INOPERABLE .

NOTE: This operation is asynchronous and will return before the WorkSpaces have rebooted.

Specified by:

rebootWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

rebootWorkspacesRequest - Container for the necessary parameters to execute the RebootWorkspaces operation on AmazonWorkspaces.

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 RebootWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspacesAsync

public Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId , DirectoryId , or WorkspaceIds , can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspacesRequest - Container for the necessary parameters to execute the DescribeWorkspaces operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the DescribeWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspacesAsync

public Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest,
                                                       AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler)
                                                         throws AmazonServiceException,
                                                                AmazonClientException

Obtains information about the specified WorkSpaces.

Only one of the filter parameters, such as BundleId , DirectoryId , or WorkspaceIds , can be specified at a time.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspacesRequest - Container for the necessary parameters to execute the DescribeWorkspaces operation on AmazonWorkspaces.

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 DescribeWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceDirectoriesAsync

public Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspaceDirectoriesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspaceDirectoriesRequest - Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

describeWorkspaceDirectoriesAsync

public Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest,
                                                                           AsyncHandler<DescribeWorkspaceDirectoriesRequest,DescribeWorkspaceDirectoriesResult> asyncHandler)
                                                                             throws AmazonServiceException,
                                                                                    AmazonClientException

Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the NextToken response member contains a token that you pass in the next call to this operation to retrieve the next set of items.

Specified by:

describeWorkspaceDirectoriesAsync in interface AmazonWorkspacesAsync

Parameters:

describeWorkspaceDirectoriesRequest - Container for the necessary parameters to execute the DescribeWorkspaceDirectories operation on AmazonWorkspaces.

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 DescribeWorkspaceDirectories service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebuildWorkspacesAsync

public Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

• The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
• The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.

Specified by:

rebuildWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

rebuildWorkspacesRequest - Container for the necessary parameters to execute the RebuildWorkspaces operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the RebuildWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

rebuildWorkspacesAsync

public Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest,
                                                     AsyncHandler<RebuildWorkspacesRequest,RebuildWorkspacesResult> asyncHandler)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

Rebuilds the specified WorkSpaces.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:

• The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
• The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.

To be able to rebuild a WorkSpace, the WorkSpace must have a State of AVAILABLE or ERROR .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.

Specified by:

rebuildWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

rebuildWorkspacesRequest - Container for the necessary parameters to execute the RebuildWorkspaces operation on AmazonWorkspaces.

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 RebuildWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

terminateWorkspacesAsync

public Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely terminated.

Specified by:

terminateWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

terminateWorkspacesRequest - Container for the necessary parameters to execute the TerminateWorkspaces operation on AmazonWorkspaces.

Returns:

A Java Future object containing the response from the TerminateWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.

terminateWorkspacesAsync

public Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest,
                                                         AsyncHandler<TerminateWorkspacesRequest,TerminateWorkspacesResult> asyncHandler)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED .

NOTE: This operation is asynchronous and will return before the WorkSpaces have been completely terminated.

Specified by:

terminateWorkspacesAsync in interface AmazonWorkspacesAsync

Parameters:

terminateWorkspacesRequest - Container for the necessary parameters to execute the TerminateWorkspaces operation on AmazonWorkspaces.

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 TerminateWorkspaces service method, as returned by AmazonWorkspaces.

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 AmazonWorkspaces indicating either a problem with the data in the request, or a server side issue.