@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonWorkspacesAsyncClient extends AmazonWorkspacesClient implements AmazonWorkspacesAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.
configFactoryclient, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffsetENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonWorkspacesAsyncClient()
Deprecated.
|
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonWorkspacesAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
associateConnectionAlias, associateIpGroups, authorizeIpRules, builder, copyWorkspaceImage, createConnectionAlias, createIpGroup, createTags, createWorkspaces, deleteConnectionAlias, deleteIpGroup, deleteTags, deleteWorkspaceImage, deregisterWorkspaceDirectory, describeAccount, describeAccountModifications, describeClientProperties, describeConnectionAliases, describeConnectionAliasPermissions, describeIpGroups, describeTags, describeWorkspaceBundles, describeWorkspaceBundles, describeWorkspaceDirectories, describeWorkspaceDirectories, describeWorkspaceImagePermissions, describeWorkspaceImages, describeWorkspaces, describeWorkspaces, describeWorkspacesConnectionStatus, describeWorkspaceSnapshots, disassociateConnectionAlias, disassociateIpGroups, getCachedResponseMetadata, importWorkspaceImage, listAvailableManagementCidrRanges, migrateWorkspace, modifyAccount, modifyClientProperties, modifySelfservicePermissions, modifyWorkspaceAccessProperties, modifyWorkspaceCreationProperties, modifyWorkspaceProperties, modifyWorkspaceState, rebootWorkspaces, rebuildWorkspaces, registerWorkspaceDirectory, restoreWorkspace, revokeIpRules, startWorkspaces, stopWorkspaces, terminateWorkspaces, updateConnectionAliasPermission, updateRulesOfIpGroup, updateWorkspaceImagePermissionaddRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffsetclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitassociateConnectionAlias, associateIpGroups, authorizeIpRules, copyWorkspaceImage, createConnectionAlias, createIpGroup, createTags, createWorkspaces, deleteConnectionAlias, deleteIpGroup, deleteTags, deleteWorkspaceImage, deregisterWorkspaceDirectory, describeAccount, describeAccountModifications, describeClientProperties, describeConnectionAliases, describeConnectionAliasPermissions, describeIpGroups, describeTags, describeWorkspaceBundles, describeWorkspaceBundles, describeWorkspaceDirectories, describeWorkspaceDirectories, describeWorkspaceImagePermissions, describeWorkspaceImages, describeWorkspaces, describeWorkspaces, describeWorkspacesConnectionStatus, describeWorkspaceSnapshots, disassociateConnectionAlias, disassociateIpGroups, getCachedResponseMetadata, importWorkspaceImage, listAvailableManagementCidrRanges, migrateWorkspace, modifyAccount, modifyClientProperties, modifySelfservicePermissions, modifyWorkspaceAccessProperties, modifyWorkspaceCreationProperties, modifyWorkspaceProperties, modifyWorkspaceState, rebootWorkspaces, rebuildWorkspaces, registerWorkspaceDirectory, restoreWorkspace, revokeIpRules, setEndpoint, setRegion, startWorkspaces, stopWorkspaces, terminateWorkspaces, updateConnectionAliasPermission, updateRulesOfIpGroup, updateWorkspaceImagePermission@Deprecated public AmazonWorkspacesAsyncClient()
AmazonWorkspacesAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonWorkspacesAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon WorkSpaces (ex: proxy
settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
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).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AmazonWorkspacesAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.public static AmazonWorkspacesAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AssociateConnectionAliasResult> associateConnectionAliasAsync(AssociateConnectionAliasRequest request)
AmazonWorkspacesAsyncAssociates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
associateConnectionAliasAsync in interface AmazonWorkspacesAsyncpublic Future<AssociateConnectionAliasResult> associateConnectionAliasAsync(AssociateConnectionAliasRequest request, AsyncHandler<AssociateConnectionAliasRequest,AssociateConnectionAliasResult> asyncHandler)
AmazonWorkspacesAsyncAssociates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
associateConnectionAliasAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<AssociateIpGroupsResult> associateIpGroupsAsync(AssociateIpGroupsRequest request)
AmazonWorkspacesAsyncAssociates the specified IP access control group with the specified directory.
associateIpGroupsAsync in interface AmazonWorkspacesAsyncpublic Future<AssociateIpGroupsResult> associateIpGroupsAsync(AssociateIpGroupsRequest request, AsyncHandler<AssociateIpGroupsRequest,AssociateIpGroupsResult> asyncHandler)
AmazonWorkspacesAsyncAssociates the specified IP access control group with the specified directory.
associateIpGroupsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<AuthorizeIpRulesResult> authorizeIpRulesAsync(AuthorizeIpRulesRequest request)
AmazonWorkspacesAsyncAdds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
authorizeIpRulesAsync in interface AmazonWorkspacesAsyncpublic Future<AuthorizeIpRulesResult> authorizeIpRulesAsync(AuthorizeIpRulesRequest request, AsyncHandler<AuthorizeIpRulesRequest,AuthorizeIpRulesResult> asyncHandler)
AmazonWorkspacesAsyncAdds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
authorizeIpRulesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<CopyWorkspaceImageResult> copyWorkspaceImageAsync(CopyWorkspaceImageRequest request)
AmazonWorkspacesAsyncCopies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
copyWorkspaceImageAsync in interface AmazonWorkspacesAsyncpublic Future<CopyWorkspaceImageResult> copyWorkspaceImageAsync(CopyWorkspaceImageRequest request, AsyncHandler<CopyWorkspaceImageRequest,CopyWorkspaceImageResult> asyncHandler)
AmazonWorkspacesAsyncCopies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
copyWorkspaceImageAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<CreateConnectionAliasResult> createConnectionAliasAsync(CreateConnectionAliasRequest request)
AmazonWorkspacesAsyncCreates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
createConnectionAliasAsync in interface AmazonWorkspacesAsyncpublic Future<CreateConnectionAliasResult> createConnectionAliasAsync(CreateConnectionAliasRequest request, AsyncHandler<CreateConnectionAliasRequest,CreateConnectionAliasResult> asyncHandler)
AmazonWorkspacesAsyncCreates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
createConnectionAliasAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<CreateIpGroupResult> createIpGroupAsync(CreateIpGroupRequest request)
AmazonWorkspacesAsyncCreates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
createIpGroupAsync in interface AmazonWorkspacesAsyncpublic Future<CreateIpGroupResult> createIpGroupAsync(CreateIpGroupRequest request, AsyncHandler<CreateIpGroupRequest,CreateIpGroupResult> asyncHandler)
AmazonWorkspacesAsyncCreates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
createIpGroupAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request)
AmazonWorkspacesAsyncCreates the specified tags for the specified WorkSpaces resource.
createTagsAsync in interface AmazonWorkspacesAsyncpublic Future<CreateTagsResult> createTagsAsync(CreateTagsRequest request, AsyncHandler<CreateTagsRequest,CreateTagsResult> asyncHandler)
AmazonWorkspacesAsyncCreates the specified tags for the specified WorkSpaces resource.
createTagsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest request)
AmazonWorkspacesAsyncCreates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<CreateWorkspacesResult> createWorkspacesAsync(CreateWorkspacesRequest request, AsyncHandler<CreateWorkspacesRequest,CreateWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncCreates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DeleteConnectionAliasResult> deleteConnectionAliasAsync(DeleteConnectionAliasRequest request)
AmazonWorkspacesAsyncDeletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
deleteConnectionAliasAsync in interface AmazonWorkspacesAsyncpublic Future<DeleteConnectionAliasResult> deleteConnectionAliasAsync(DeleteConnectionAliasRequest request, AsyncHandler<DeleteConnectionAliasRequest,DeleteConnectionAliasResult> asyncHandler)
AmazonWorkspacesAsyncDeletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
deleteConnectionAliasAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DeleteIpGroupResult> deleteIpGroupAsync(DeleteIpGroupRequest request)
AmazonWorkspacesAsyncDeletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroupAsync in interface AmazonWorkspacesAsyncpublic Future<DeleteIpGroupResult> deleteIpGroupAsync(DeleteIpGroupRequest request, AsyncHandler<DeleteIpGroupRequest,DeleteIpGroupResult> asyncHandler)
AmazonWorkspacesAsyncDeletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroupAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request)
AmazonWorkspacesAsyncDeletes the specified tags from the specified WorkSpaces resource.
deleteTagsAsync in interface AmazonWorkspacesAsyncpublic Future<DeleteTagsResult> deleteTagsAsync(DeleteTagsRequest request, AsyncHandler<DeleteTagsRequest,DeleteTagsResult> asyncHandler)
AmazonWorkspacesAsyncDeletes the specified tags from the specified WorkSpaces resource.
deleteTagsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DeleteWorkspaceImageResult> deleteWorkspaceImageAsync(DeleteWorkspaceImageRequest request)
AmazonWorkspacesAsyncDeletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
deleteWorkspaceImageAsync in interface AmazonWorkspacesAsyncpublic Future<DeleteWorkspaceImageResult> deleteWorkspaceImageAsync(DeleteWorkspaceImageRequest request, AsyncHandler<DeleteWorkspaceImageRequest,DeleteWorkspaceImageResult> asyncHandler)
AmazonWorkspacesAsyncDeletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
deleteWorkspaceImageAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DeregisterWorkspaceDirectoryResult> deregisterWorkspaceDirectoryAsync(DeregisterWorkspaceDirectoryRequest request)
AmazonWorkspacesAsyncDeregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
deregisterWorkspaceDirectoryAsync in interface AmazonWorkspacesAsyncpublic Future<DeregisterWorkspaceDirectoryResult> deregisterWorkspaceDirectoryAsync(DeregisterWorkspaceDirectoryRequest request, AsyncHandler<DeregisterWorkspaceDirectoryRequest,DeregisterWorkspaceDirectoryResult> asyncHandler)
AmazonWorkspacesAsyncDeregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
deregisterWorkspaceDirectoryAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeAccountResult> describeAccountAsync(DescribeAccountRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeAccountResult> describeAccountAsync(DescribeAccountRequest request, AsyncHandler<DescribeAccountRequest,DescribeAccountResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeAccountModificationsResult> describeAccountModificationsAsync(DescribeAccountModificationsRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountModificationsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeAccountModificationsResult> describeAccountModificationsAsync(DescribeAccountModificationsRequest request, AsyncHandler<DescribeAccountModificationsRequest,DescribeAccountModificationsResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountModificationsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeClientPropertiesResult> describeClientPropertiesAsync(DescribeClientPropertiesRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientPropertiesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeClientPropertiesResult> describeClientPropertiesAsync(DescribeClientPropertiesRequest request, AsyncHandler<DescribeClientPropertiesRequest,DescribeClientPropertiesResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientPropertiesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeConnectionAliasPermissionsResult> describeConnectionAliasPermissionsAsync(DescribeConnectionAliasPermissionsRequest request)
AmazonWorkspacesAsyncDescribes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasPermissionsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeConnectionAliasPermissionsResult> describeConnectionAliasPermissionsAsync(DescribeConnectionAliasPermissionsRequest request, AsyncHandler<DescribeConnectionAliasPermissionsRequest,DescribeConnectionAliasPermissionsResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasPermissionsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeConnectionAliasesResult> describeConnectionAliasesAsync(DescribeConnectionAliasesRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeConnectionAliasesResult> describeConnectionAliasesAsync(DescribeConnectionAliasesRequest request, AsyncHandler<DescribeConnectionAliasesRequest,DescribeConnectionAliasesResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeIpGroupsResult> describeIpGroupsAsync(DescribeIpGroupsRequest request)
AmazonWorkspacesAsyncDescribes one or more of your IP access control groups.
describeIpGroupsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeIpGroupsResult> describeIpGroupsAsync(DescribeIpGroupsRequest request, AsyncHandler<DescribeIpGroupsRequest,DescribeIpGroupsResult> asyncHandler)
AmazonWorkspacesAsyncDescribes one or more of your IP access control groups.
describeIpGroupsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request)
AmazonWorkspacesAsyncDescribes the specified tags for the specified WorkSpaces resource.
describeTagsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeTagsResult> describeTagsAsync(DescribeTagsRequest request, AsyncHandler<DescribeTagsRequest,DescribeTagsResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the specified tags for the specified WorkSpaces resource.
describeTagsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest request, AsyncHandler<DescribeWorkspaceBundlesRequest,DescribeWorkspaceBundlesResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync()
describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsyncdescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest)public Future<DescribeWorkspaceBundlesResult> describeWorkspaceBundlesAsync(AsyncHandler<DescribeWorkspaceBundlesRequest,DescribeWorkspaceBundlesResult> asyncHandler)
describeWorkspaceBundlesAsync in interface AmazonWorkspacesAsyncdescribeWorkspaceBundlesAsync(DescribeWorkspaceBundlesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest request)
AmazonWorkspacesAsyncDescribes the available directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest request, AsyncHandler<DescribeWorkspaceDirectoriesRequest,DescribeWorkspaceDirectoriesResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the available directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync()
describeWorkspaceDirectoriesAsync in interface AmazonWorkspacesAsyncdescribeWorkspaceDirectoriesAsync(DescribeWorkspaceDirectoriesRequest)public Future<DescribeWorkspaceDirectoriesResult> describeWorkspaceDirectoriesAsync(AsyncHandler<DescribeWorkspaceDirectoriesRequest,DescribeWorkspaceDirectoriesResult> asyncHandler)
public Future<DescribeWorkspaceImagePermissionsResult> describeWorkspaceImagePermissionsAsync(DescribeWorkspaceImagePermissionsRequest request)
AmazonWorkspacesAsyncDescribes the permissions that the owner of an image has granted to other AWS accounts for an image.
describeWorkspaceImagePermissionsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspaceImagePermissionsResult> describeWorkspaceImagePermissionsAsync(DescribeWorkspaceImagePermissionsRequest request, AsyncHandler<DescribeWorkspaceImagePermissionsRequest,DescribeWorkspaceImagePermissionsResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the permissions that the owner of an image has granted to other AWS accounts for an image.
describeWorkspaceImagePermissionsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspaceImagesResult> describeWorkspaceImagesAsync(DescribeWorkspaceImagesRequest request)
AmazonWorkspacesAsyncRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImagesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspaceImagesResult> describeWorkspaceImagesAsync(DescribeWorkspaceImagesRequest request, AsyncHandler<DescribeWorkspaceImagesRequest,DescribeWorkspaceImagesResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImagesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspaceSnapshotsResult> describeWorkspaceSnapshotsAsync(DescribeWorkspaceSnapshotsRequest request)
AmazonWorkspacesAsyncDescribes the snapshots for the specified WorkSpace.
describeWorkspaceSnapshotsAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspaceSnapshotsResult> describeWorkspaceSnapshotsAsync(DescribeWorkspaceSnapshotsRequest request, AsyncHandler<DescribeWorkspaceSnapshotsRequest,DescribeWorkspaceSnapshotsResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the snapshots for the specified WorkSpace.
describeWorkspaceSnapshotsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest request)
AmazonWorkspacesAsyncDescribes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
describeWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspacesResult> describeWorkspacesAsync(DescribeWorkspacesRequest request, AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
describeWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DescribeWorkspacesResult> describeWorkspacesAsync()
describeWorkspacesAsync in interface AmazonWorkspacesAsyncdescribeWorkspacesAsync(DescribeWorkspacesRequest)public Future<DescribeWorkspacesResult> describeWorkspacesAsync(AsyncHandler<DescribeWorkspacesRequest,DescribeWorkspacesResult> asyncHandler)
describeWorkspacesAsync in interface AmazonWorkspacesAsyncdescribeWorkspacesAsync(DescribeWorkspacesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeWorkspacesConnectionStatusResult> describeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest request)
AmazonWorkspacesAsyncDescribes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatusAsync in interface AmazonWorkspacesAsyncpublic Future<DescribeWorkspacesConnectionStatusResult> describeWorkspacesConnectionStatusAsync(DescribeWorkspacesConnectionStatusRequest request, AsyncHandler<DescribeWorkspacesConnectionStatusRequest,DescribeWorkspacesConnectionStatusResult> asyncHandler)
AmazonWorkspacesAsyncDescribes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatusAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DisassociateConnectionAliasResult> disassociateConnectionAliasAsync(DisassociateConnectionAliasRequest request)
AmazonWorkspacesAsyncDisassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
disassociateConnectionAliasAsync in interface AmazonWorkspacesAsyncpublic Future<DisassociateConnectionAliasResult> disassociateConnectionAliasAsync(DisassociateConnectionAliasRequest request, AsyncHandler<DisassociateConnectionAliasRequest,DisassociateConnectionAliasResult> asyncHandler)
AmazonWorkspacesAsyncDisassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
disassociateConnectionAliasAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<DisassociateIpGroupsResult> disassociateIpGroupsAsync(DisassociateIpGroupsRequest request)
AmazonWorkspacesAsyncDisassociates the specified IP access control group from the specified directory.
disassociateIpGroupsAsync in interface AmazonWorkspacesAsyncpublic Future<DisassociateIpGroupsResult> disassociateIpGroupsAsync(DisassociateIpGroupsRequest request, AsyncHandler<DisassociateIpGroupsRequest,DisassociateIpGroupsResult> asyncHandler)
AmazonWorkspacesAsyncDisassociates the specified IP access control group from the specified directory.
disassociateIpGroupsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ImportWorkspaceImageResult> importWorkspaceImageAsync(ImportWorkspaceImageRequest request)
AmazonWorkspacesAsyncImports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
importWorkspaceImageAsync in interface AmazonWorkspacesAsyncpublic Future<ImportWorkspaceImageResult> importWorkspaceImageAsync(ImportWorkspaceImageRequest request, AsyncHandler<ImportWorkspaceImageRequest,ImportWorkspaceImageResult> asyncHandler)
AmazonWorkspacesAsyncImports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
importWorkspaceImageAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ListAvailableManagementCidrRangesResult> listAvailableManagementCidrRangesAsync(ListAvailableManagementCidrRangesRequest request)
AmazonWorkspacesAsyncRetrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL,
you'll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
listAvailableManagementCidrRangesAsync in interface AmazonWorkspacesAsyncpublic Future<ListAvailableManagementCidrRangesResult> listAvailableManagementCidrRangesAsync(ListAvailableManagementCidrRangesRequest request, AsyncHandler<ListAvailableManagementCidrRangesRequest,ListAvailableManagementCidrRangesResult> asyncHandler)
AmazonWorkspacesAsyncRetrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL,
you'll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
listAvailableManagementCidrRangesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<MigrateWorkspaceResult> migrateWorkspaceAsync(MigrateWorkspaceRequest request)
AmazonWorkspacesAsyncMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
user volume from the last available snapshot of the original WorkSpace. During migration, the original
D:\Users\%USERNAME% user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
migrateWorkspaceAsync in interface AmazonWorkspacesAsyncpublic Future<MigrateWorkspaceResult> migrateWorkspaceAsync(MigrateWorkspaceRequest request, AsyncHandler<MigrateWorkspaceRequest,MigrateWorkspaceResult> asyncHandler)
AmazonWorkspacesAsyncMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
user volume from the last available snapshot of the original WorkSpace. During migration, the original
D:\Users\%USERNAME% user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
migrateWorkspaceAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyAccountResult> modifyAccountAsync(ModifyAccountRequest request)
AmazonWorkspacesAsyncModifies the configuration of Bring Your Own License (BYOL) for the specified account.
modifyAccountAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyAccountResult> modifyAccountAsync(ModifyAccountRequest request, AsyncHandler<ModifyAccountRequest,ModifyAccountResult> asyncHandler)
AmazonWorkspacesAsyncModifies the configuration of Bring Your Own License (BYOL) for the specified account.
modifyAccountAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyClientPropertiesResult> modifyClientPropertiesAsync(ModifyClientPropertiesRequest request)
AmazonWorkspacesAsyncModifies the properties of the specified Amazon WorkSpaces clients.
modifyClientPropertiesAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyClientPropertiesResult> modifyClientPropertiesAsync(ModifyClientPropertiesRequest request, AsyncHandler<ModifyClientPropertiesRequest,ModifyClientPropertiesResult> asyncHandler)
AmazonWorkspacesAsyncModifies the properties of the specified Amazon WorkSpaces clients.
modifyClientPropertiesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifySelfservicePermissionsResult> modifySelfservicePermissionsAsync(ModifySelfservicePermissionsRequest request)
AmazonWorkspacesAsyncModifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
modifySelfservicePermissionsAsync in interface AmazonWorkspacesAsyncpublic Future<ModifySelfservicePermissionsResult> modifySelfservicePermissionsAsync(ModifySelfservicePermissionsRequest request, AsyncHandler<ModifySelfservicePermissionsRequest,ModifySelfservicePermissionsResult> asyncHandler)
AmazonWorkspacesAsyncModifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
modifySelfservicePermissionsAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyWorkspaceAccessPropertiesResult> modifyWorkspaceAccessPropertiesAsync(ModifyWorkspaceAccessPropertiesRequest request)
AmazonWorkspacesAsyncSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
modifyWorkspaceAccessPropertiesAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyWorkspaceAccessPropertiesResult> modifyWorkspaceAccessPropertiesAsync(ModifyWorkspaceAccessPropertiesRequest request, AsyncHandler<ModifyWorkspaceAccessPropertiesRequest,ModifyWorkspaceAccessPropertiesResult> asyncHandler)
AmazonWorkspacesAsyncSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
modifyWorkspaceAccessPropertiesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyWorkspaceCreationPropertiesResult> modifyWorkspaceCreationPropertiesAsync(ModifyWorkspaceCreationPropertiesRequest request)
AmazonWorkspacesAsyncModify the default properties used to create WorkSpaces.
modifyWorkspaceCreationPropertiesAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyWorkspaceCreationPropertiesResult> modifyWorkspaceCreationPropertiesAsync(ModifyWorkspaceCreationPropertiesRequest request, AsyncHandler<ModifyWorkspaceCreationPropertiesRequest,ModifyWorkspaceCreationPropertiesResult> asyncHandler)
AmazonWorkspacesAsyncModify the default properties used to create WorkSpaces.
modifyWorkspaceCreationPropertiesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyWorkspacePropertiesResult> modifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest request)
AmazonWorkspacesAsyncModifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
modifyWorkspacePropertiesAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyWorkspacePropertiesResult> modifyWorkspacePropertiesAsync(ModifyWorkspacePropertiesRequest request, AsyncHandler<ModifyWorkspacePropertiesRequest,ModifyWorkspacePropertiesResult> asyncHandler)
AmazonWorkspacesAsyncModifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
modifyWorkspacePropertiesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<ModifyWorkspaceStateResult> modifyWorkspaceStateAsync(ModifyWorkspaceStateRequest request)
AmazonWorkspacesAsyncSets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE.
WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
modifyWorkspaceStateAsync in interface AmazonWorkspacesAsyncpublic Future<ModifyWorkspaceStateResult> modifyWorkspaceStateAsync(ModifyWorkspaceStateRequest request, AsyncHandler<ModifyWorkspaceStateRequest,ModifyWorkspaceStateResult> asyncHandler)
AmazonWorkspacesAsyncSets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE.
WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
modifyWorkspaceStateAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest request)
AmazonWorkspacesAsyncReboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<RebootWorkspacesResult> rebootWorkspacesAsync(RebootWorkspacesRequest request, AsyncHandler<RebootWorkspacesRequest,RebootWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncReboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest request)
AmazonWorkspacesAsyncRebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<RebuildWorkspacesResult> rebuildWorkspacesAsync(RebuildWorkspacesRequest request, AsyncHandler<RebuildWorkspacesRequest,RebuildWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncRebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<RegisterWorkspaceDirectoryResult> registerWorkspaceDirectoryAsync(RegisterWorkspaceDirectoryRequest request)
AmazonWorkspacesAsyncRegisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
registerWorkspaceDirectoryAsync in interface AmazonWorkspacesAsyncpublic Future<RegisterWorkspaceDirectoryResult> registerWorkspaceDirectoryAsync(RegisterWorkspaceDirectoryRequest request, AsyncHandler<RegisterWorkspaceDirectoryRequest,RegisterWorkspaceDirectoryResult> asyncHandler)
AmazonWorkspacesAsyncRegisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
registerWorkspaceDirectoryAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<RestoreWorkspaceResult> restoreWorkspaceAsync(RestoreWorkspaceRequest request)
AmazonWorkspacesAsyncRestores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
restoreWorkspaceAsync in interface AmazonWorkspacesAsyncpublic Future<RestoreWorkspaceResult> restoreWorkspaceAsync(RestoreWorkspaceRequest request, AsyncHandler<RestoreWorkspaceRequest,RestoreWorkspaceResult> asyncHandler)
AmazonWorkspacesAsyncRestores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
restoreWorkspaceAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<RevokeIpRulesResult> revokeIpRulesAsync(RevokeIpRulesRequest request)
AmazonWorkspacesAsyncRemoves one or more rules from the specified IP access control group.
revokeIpRulesAsync in interface AmazonWorkspacesAsyncpublic Future<RevokeIpRulesResult> revokeIpRulesAsync(RevokeIpRulesRequest request, AsyncHandler<RevokeIpRulesRequest,RevokeIpRulesResult> asyncHandler)
AmazonWorkspacesAsyncRemoves one or more rules from the specified IP access control group.
revokeIpRulesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<StartWorkspacesResult> startWorkspacesAsync(StartWorkspacesRequest request)
AmazonWorkspacesAsyncStarts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
startWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<StartWorkspacesResult> startWorkspacesAsync(StartWorkspacesRequest request, AsyncHandler<StartWorkspacesRequest,StartWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncStarts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
startWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<StopWorkspacesResult> stopWorkspacesAsync(StopWorkspacesRequest request)
AmazonWorkspacesAsyncStops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<StopWorkspacesResult> stopWorkspacesAsync(StopWorkspacesRequest request, AsyncHandler<StopWorkspacesRequest,StopWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncStops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest request)
AmazonWorkspacesAsyncTerminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support 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. After a
WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using DescribeWorkSpaces. If
the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
terminateWorkspacesAsync in interface AmazonWorkspacesAsyncpublic Future<TerminateWorkspacesResult> terminateWorkspacesAsync(TerminateWorkspacesRequest request, AsyncHandler<TerminateWorkspacesRequest,TerminateWorkspacesResult> asyncHandler)
AmazonWorkspacesAsyncTerminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support 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. After a
WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using DescribeWorkSpaces. If
the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
terminateWorkspacesAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<UpdateConnectionAliasPermissionResult> updateConnectionAliasPermissionAsync(UpdateConnectionAliasPermissionRequest request)
AmazonWorkspacesAsyncShares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
updateConnectionAliasPermissionAsync in interface AmazonWorkspacesAsyncpublic Future<UpdateConnectionAliasPermissionResult> updateConnectionAliasPermissionAsync(UpdateConnectionAliasPermissionRequest request, AsyncHandler<UpdateConnectionAliasPermissionRequest,UpdateConnectionAliasPermissionResult> asyncHandler)
AmazonWorkspacesAsyncShares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
updateConnectionAliasPermissionAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<UpdateRulesOfIpGroupResult> updateRulesOfIpGroupAsync(UpdateRulesOfIpGroupRequest request)
AmazonWorkspacesAsyncReplaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroupAsync in interface AmazonWorkspacesAsyncpublic Future<UpdateRulesOfIpGroupResult> updateRulesOfIpGroupAsync(UpdateRulesOfIpGroupRequest request, AsyncHandler<UpdateRulesOfIpGroupRequest,UpdateRulesOfIpGroupResult> asyncHandler)
AmazonWorkspacesAsyncReplaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroupAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public Future<UpdateWorkspaceImagePermissionResult> updateWorkspaceImagePermissionAsync(UpdateWorkspaceImagePermissionRequest request)
AmazonWorkspacesAsyncShares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
updateWorkspaceImagePermissionAsync in interface AmazonWorkspacesAsyncpublic Future<UpdateWorkspaceImagePermissionResult> updateWorkspaceImagePermissionAsync(UpdateWorkspaceImagePermissionRequest request, AsyncHandler<UpdateWorkspaceImagePermissionRequest,UpdateWorkspaceImagePermissionResult> asyncHandler)
AmazonWorkspacesAsyncShares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
updateWorkspaceImagePermissionAsync in interface AmazonWorkspacesAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonWorkspacesshutdown in class AmazonWorkspacesClientCopyright © 2020. All rights reserved.