com.amazonaws.services.workspaces

Interface AmazonWorkspacesAsync

All Superinterfaces:

AmazonWorkspaces

All Known Implementing Classes:

AmazonWorkspacesAsyncClient

public interface AmazonWorkspacesAsync
extends AmazonWorkspaces

Interface for accessing AmazonWorkspaces asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler. Amazon WorkSpaces Service

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

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.
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.
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 interface com.amazonaws.services.workspaces.AmazonWorkspaces

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

Method Detail

createWorkspacesAsync

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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.