@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonWorkspacesAsync extends AmazonWorkspaces
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonWorkspacesAsync
instead.
This reference provides detailed information about the Amazon WorkSpaces operations.
ENDPOINT_PREFIX
createTags, createWorkspaces, deleteTags, describeTags, describeWorkspaceBundles, describeWorkspaceBundles, describeWorkspaceDirectories, describeWorkspaceDirectories, describeWorkspaces, describeWorkspaces, describeWorkspacesConnectionStatus, getCachedResponseMetadata, modifyWorkspaceProperties, rebootWorkspaces, rebuildWorkspaces, setEndpoint, setRegion, shutdown, startWorkspaces, stopWorkspaces, terminateWorkspaces
Future<CreateTagsResult> createTagsAsync(CreateTagsRequest createTagsRequest)
Creates tags for a WorkSpace.
createTagsRequest
- The request of the CreateTags operation.Future<CreateTagsResult> createTagsAsync(CreateTagsRequest createTagsRequest, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)
Creates tags for a WorkSpace.
createTagsRequest
- The request of the CreateTags operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest
- Contains the inputs for the CreateWorkspaces operation.Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest createWorkspacesRequest, AsyncHandler<CreateWorkspacesRequest,CreateWorkspacesResult> asyncHandler)
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest
- Contains the inputs for the CreateWorkspaces operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest)
Deletes tags from a WorkSpace.
deleteTagsRequest
- The request of the DeleteTags operation.Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest deleteTagsRequest, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)
Deletes tags from a WorkSpace.
deleteTagsRequest
- The request of the DeleteTags operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest describeTagsRequest)
Describes tags for a WorkSpace.
describeTagsRequest
- The request of the DescribeTags operation.Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest describeTagsRequest, AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler)
Describes tags for a WorkSpace.
describeTagsRequest
- The request of the DescribeTags operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
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.
describeWorkspaceBundlesRequest
- Contains the inputs for the DescribeWorkspaceBundles operation.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.
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.
describeWorkspaceBundlesRequest
- Contains the inputs for the DescribeWorkspaceBundles operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync()
Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(AsyncHandler<DescribeWorkspaceBundlesRequest,DescribeWorkspaceBundlesResult> asyncHandler)
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.
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.
describeWorkspaceDirectoriesRequest
- Contains the inputs for the DescribeWorkspaceDirectories operation.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.
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.
describeWorkspaceDirectoriesRequest
- Contains the inputs for the DescribeWorkspaceDirectories operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync()
Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(AsyncHandler<DescribeWorkspaceDirectoriesRequest,DescribeWorkspaceDirectoriesResult> asyncHandler)
Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest)
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.
describeWorkspacesRequest
- Contains the inputs for the DescribeWorkspaces operation.Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest describeWorkspacesRequest, AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler)
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.
describeWorkspacesRequest
- Contains the inputs for the DescribeWorkspaces operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DescribeWorkspacesResult> describeWorkspacesAsync()
Future<DescribeWorkspacesResult> describeWorkspacesAsync(AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler)
Future<DescribeWorkspacesConnectionStatusResult> describeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
describeWorkspacesConnectionStatusRequest
- Future<DescribeWorkspacesConnectionStatusResult> describeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest, AsyncHandler<DescribeWorkspacesConnectionStatusRequest,DescribeWorkspacesConnectionStatusResult> asyncHandler)
Describes the connection status of a specified WorkSpace.
describeWorkspacesConnectionStatusRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ModifyWorkspacePropertiesResult> modifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
modifyWorkspacePropertiesRequest
- Future<ModifyWorkspacePropertiesResult> modifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest, AsyncHandler<ModifyWorkspacePropertiesRequest,ModifyWorkspacePropertiesResult> asyncHandler)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
modifyWorkspacePropertiesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE
,
IMPAIRED
, or INOPERABLE
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesRequest
- Contains the inputs for the RebootWorkspaces operation.Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest rebootWorkspacesRequest, AsyncHandler<RebootWorkspacesRequest,RebootWorkspacesResult> asyncHandler)
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of AVAILABLE
,
IMPAIRED
, or INOPERABLE
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesRequest
- Contains the inputs for the RebootWorkspaces operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest)
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
.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspacesRequest
- Contains the inputs for the RebuildWorkspaces operation.Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest rebuildWorkspacesRequest, AsyncHandler<RebuildWorkspacesRequest,RebuildWorkspacesResult> asyncHandler)
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
.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspacesRequest
- Contains the inputs for the RebuildWorkspaces operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartWorkspacesResult> startWorkspacesAsync(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
startWorkspacesRequest
- Future<StartWorkspacesResult> startWorkspacesAsync(StartWorkspacesRequest startWorkspacesRequest, AsyncHandler<StartWorkspacesRequest,StartWorkspacesResult> asyncHandler)
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
startWorkspacesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StopWorkspacesResult> stopWorkspacesAsync(StopWorkspacesRequest stopWorkspacesRequest)
Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesRequest
- Future<StopWorkspacesResult> stopWorkspacesAsync(StopWorkspacesRequest stopWorkspacesRequest, AsyncHandler<StopWorkspacesRequest,StopWorkspacesResult> asyncHandler)
Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest)
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
.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
terminateWorkspacesRequest
- Contains the inputs for the TerminateWorkspaces operation.Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest terminateWorkspacesRequest, AsyncHandler<TerminateWorkspacesRequest,TerminateWorkspacesResult> asyncHandler)
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
.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated.
terminateWorkspacesRequest
- Contains the inputs for the TerminateWorkspaces operation.asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.