Package software.amazon.awssdk.services.workspaces

Interface WorkSpacesClient

All Superinterfaces:

AutoCloseable

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

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

This reference provides detailed information about the Amazon WorkSpaces operations.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static WorkSpacesClient create()

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

builder

static WorkSpacesClientBuilder builder()

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

createTags

default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest)
                               throws ResourceNotFoundException,
                                      InvalidParameterValuesException,
                                      ResourceLimitExceededException,
                                      SdkBaseException,
                                      SdkClientException,
                                      WorkSpacesException

Creates tags for a WorkSpace.

Parameters:

createTagsRequest - The request of the CreateTags operation.

Returns:

Result of the CreateTags operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

createWorkspaces

default CreateWorkspacesResponse createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
                                           throws ResourceLimitExceededException,
                                                  InvalidParameterValuesException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  WorkSpacesException

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:

Result of the CreateWorkspaces operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteTags

default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest)
                               throws ResourceNotFoundException,
                                      InvalidParameterValuesException,
                                      SdkBaseException,
                                      SdkClientException,
                                      WorkSpacesException

Deletes tags from a WorkSpace.

Parameters:

deleteTagsRequest - The request of the DeleteTags operation.

Returns:

Result of the DeleteTags operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeTags

default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest)
                                   throws ResourceNotFoundException,
                                          SdkBaseException,
                                          SdkClientException,
                                          WorkSpacesException

Describes tags for a WorkSpace.

Parameters:

describeTagsRequest - The request of the DescribeTags operation.

Returns:

Result of the DescribeTags operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeWorkspaceBundles

default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
                                                           throws InvalidParameterValuesException,
                                                                  SdkBaseException,
                                                                  SdkClientException,
                                                                  WorkSpacesException

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:

Result of the DescribeWorkspaceBundles operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeWorkspaceDirectories

default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
                                                                   throws InvalidParameterValuesException,
                                                                          SdkBaseException,
                                                                          SdkClientException,
                                                                          WorkSpacesException

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:

Result of the DescribeWorkspaceDirectories operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeWorkspaces

default DescribeWorkspacesResponse describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
                                               throws InvalidParameterValuesException,
                                                      ResourceUnavailableException,
                                                      SdkBaseException,
                                                      SdkClientException,
                                                      WorkSpacesException

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:

Result of the DescribeWorkspaces operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeWorkspacesConnectionStatus

default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
                                                                               throws InvalidParameterValuesException,
                                                                                      SdkBaseException,
                                                                                      SdkClientException,
                                                                                      WorkSpacesException

Describes the connection status of a specified WorkSpace.

Parameters:

describeWorkspacesConnectionStatusRequest -

Returns:

Result of the DescribeWorkspacesConnectionStatus operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

modifyWorkspaceProperties

default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
                                                             throws InvalidParameterValuesException,
                                                                    InvalidResourceStateException,
                                                                    OperationInProgressException,
                                                                    UnsupportedWorkspaceConfigurationException,
                                                                    ResourceNotFoundException,
                                                                    AccessDeniedException,
                                                                    ResourceUnavailableException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    WorkSpacesException

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

Parameters:

modifyWorkspacePropertiesRequest -

Returns:

Result of the ModifyWorkspaceProperties operation returned by the service.

Throws:

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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

rebootWorkspaces

default RebootWorkspacesResponse rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
                                           throws SdkBaseException,
                                                  SdkClientException,
                                                  WorkSpacesException

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:

Result of the RebootWorkspaces operation returned by the service.

Throws:

SdkBaseException

SdkClientException

WorkSpacesException

See Also:

AWS API Documentation

rebuildWorkspaces

default RebuildWorkspacesResponse rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
                                             throws SdkBaseException,
                                                    SdkClientException,
                                                    WorkSpacesException

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:

Result of the RebuildWorkspaces operation returned by the service.

Throws:

SdkBaseException

SdkClientException

WorkSpacesException

See Also:

AWS API Documentation

startWorkspaces

default StartWorkspacesResponse startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
                                         throws SdkBaseException,
                                                SdkClientException,
                                                WorkSpacesException

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

Parameters:

startWorkspacesRequest -

Returns:

Result of the StartWorkspaces operation returned by the service.

Throws:

SdkBaseException

SdkClientException

WorkSpacesException

See Also:

AWS API Documentation

stopWorkspaces

default StopWorkspacesResponse stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
                                       throws SdkBaseException,
                                              SdkClientException,
                                              WorkSpacesException

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:

Result of the StopWorkspaces operation returned by the service.

Throws:

SdkBaseException

SdkClientException

WorkSpacesException

See Also:

AWS API Documentation

terminateWorkspaces

default TerminateWorkspacesResponse terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
                                                 throws SdkBaseException,
                                                        SdkClientException,
                                                        WorkSpacesException

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:

Result of the TerminateWorkspaces operation returned by the service.

Throws:

SdkBaseException

SdkClientException

WorkSpacesException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()