Package software.amazon.awssdk.services.workspaces

Interface WorkSpacesAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface WorkSpacesAsyncClient
extends AutoCloseable

Service client for accessing null asynchronously. This can be created using the static builder() method. Amazon WorkSpaces Service

This reference provides detailed information about the Amazon WorkSpaces operations.

Method Summary

Modifier and Type	Method	Description
static WorkSpacesAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a WorkSpacesAsyncClient.
static WorkSpacesAsyncClient	create()	Create a WorkSpacesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateTagsResponse>	createTags(CreateTagsRequest createTagsRequest)	Creates tags for a WorkSpace.
default CompletableFuture<CreateWorkspacesResponse>	createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)	Creates one or more WorkSpaces.
default CompletableFuture<DeleteTagsResponse>	deleteTags(DeleteTagsRequest deleteTagsRequest)	Deletes tags from a WorkSpace.
default CompletableFuture<DescribeTagsResponse>	describeTags(DescribeTagsRequest describeTagsRequest)	Describes tags for a WorkSpace.
default CompletableFuture<DescribeWorkspaceBundlesResponse>	describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)	Obtains information about the WorkSpace bundles that are available to your account in the specified region.
default CompletableFuture<DescribeWorkspaceDirectoriesResponse>	describeWorkspaceDirectories(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.
default CompletableFuture<DescribeWorkspacesResponse>	describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)	Obtains information about the specified WorkSpaces.
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse>	describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)	Describes the connection status of a specified WorkSpace.
default CompletableFuture<ModifyWorkspacePropertiesResponse>	modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)	Modifies the WorkSpace properties, including the running mode and AutoStop time.
default CompletableFuture<RebootWorkspacesResponse>	rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)	Reboots the specified WorkSpaces.
default CompletableFuture<RebuildWorkspacesResponse>	rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)	Rebuilds the specified WorkSpaces.
default CompletableFuture<StartWorkspacesResponse>	startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)	Starts the specified WorkSpaces.
default CompletableFuture<StopWorkspacesResponse>	stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)	Stops the specified WorkSpaces.
default CompletableFuture<TerminateWorkspacesResponse>	terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)	Terminates the specified WorkSpaces.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static WorkSpacesAsyncClient create()

Create a WorkSpacesAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static WorkSpacesAsyncClientBuilder builder()

Create a builder that can be used to configure and create a WorkSpacesAsyncClient.

createTags

default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)

Creates tags for a WorkSpace.

Parameters:

createTagsRequest - The request of the CreateTags operation.

Returns:

A Java Future containing the result of the CreateTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource could not be found.
• InvalidParameterValuesException One or more parameter values are not valid.
• ResourceLimitExceededException Your resource limits have been exceeded.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createWorkspaces

default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)

Creates one or more WorkSpaces.

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

Parameters:

createWorkspacesRequest - Contains the inputs for the CreateWorkspaces operation.

Returns:

A Java Future containing the result of the CreateWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceLimitExceededException Your resource limits have been exceeded.
• InvalidParameterValuesException One or more parameter values are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteTags

default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)

Deletes tags from a WorkSpace.

Parameters:

deleteTagsRequest - The request of the DeleteTags operation.

Returns:

A Java Future containing the result of the DeleteTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource could not be found.
• InvalidParameterValuesException One or more parameter values are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeTags

default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)

Describes tags for a WorkSpace.

Parameters:

describeTagsRequest - The request of the DescribeTags operation.

Returns:

A Java Future containing the result of the DescribeTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ResourceNotFoundException The resource could not be found.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeWorkspaceBundles

default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(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.

Parameters:

describeWorkspaceBundlesRequest - Contains the inputs for the DescribeWorkspaceBundles operation.

Returns:

A Java Future containing the result of the DescribeWorkspaceBundles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValuesException One or more parameter values are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeWorkspaceDirectories

default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(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.

Parameters:

describeWorkspaceDirectoriesRequest - Contains the inputs for the DescribeWorkspaceDirectories operation.

Returns:

A Java Future containing the result of the DescribeWorkspaceDirectories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValuesException One or more parameter values are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeWorkspaces

default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(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.

Parameters:

describeWorkspacesRequest - Contains the inputs for the DescribeWorkspaces operation.

Returns:

A Java Future containing the result of the DescribeWorkspaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValuesException One or more parameter values are not valid.
• ResourceUnavailableException The specified resource is not available.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeWorkspacesConnectionStatus

default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)

Describes the connection status of a specified WorkSpace.

Parameters:

describeWorkspacesConnectionStatusRequest -

Returns:

A Java Future containing the result of the DescribeWorkspacesConnectionStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValuesException One or more parameter values are not valid.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyWorkspaceProperties

default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)

Modifies the WorkSpace properties, including the running mode and AutoStop time.

Parameters:

modifyWorkspacePropertiesRequest -

Returns:

A Java Future containing the result of the ModifyWorkspaceProperties operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InvalidParameterValuesException One or more parameter values are not valid.
• InvalidResourceStateException The state of the WorkSpace is not valid for this operation.
• OperationInProgressException The properties of this WorkSpace are currently being modified. Try again in a moment.
• UnsupportedWorkspaceConfigurationException The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.
• ResourceNotFoundException The resource could not be found.
• AccessDeniedException The user is not authorized to access a resource.
• ResourceUnavailableException The specified resource is not available.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• WorkSpacesException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

rebootWorkspaces

default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(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.

Parameters:

rebootWorkspacesRequest - Contains the inputs for the RebootWorkspaces operation.

Returns:

A Java Future containing the result of the RebootWorkspaces operation returned by the service.

See Also:

AWS API Documentation

rebuildWorkspaces

default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(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.

Parameters:

rebuildWorkspacesRequest - Contains the inputs for the RebuildWorkspaces operation.

Returns:

A Java Future containing the result of the RebuildWorkspaces operation returned by the service.

See Also:

AWS API Documentation

startWorkspaces

default CompletableFuture<StartWorkspacesResponse> startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)

Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.

Parameters:

startWorkspacesRequest -

Returns:

A Java Future containing the result of the StartWorkspaces operation returned by the service.

See Also:

AWS API Documentation

stopWorkspaces

default CompletableFuture<StopWorkspacesResponse> stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)

Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

Parameters:

stopWorkspacesRequest -

Returns:

A Java Future containing the result of the StopWorkspaces operation returned by the service.

See Also:

AWS API Documentation

terminateWorkspaces

default CompletableFuture<TerminateWorkspacesResponse> terminateWorkspaces(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.

Parameters:

terminateWorkspacesRequest - Contains the inputs for the TerminateWorkspaces operation.

Returns:

A Java Future containing the result of the TerminateWorkspaces operation returned by the service.

See Also:

AWS API Documentation