@Generated(value="software.amazon.awssdk:codegen") public interface WorkSpacesClient extends SdkClient, SdkAutoCloseable
builder()
method.
This reference provides detailed information about the Amazon WorkSpaces operations.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates tags for a WorkSpace.
|
default CreateTagsResponse |
createTags(CreateTagsRequest createTagsRequest)
Creates tags for a WorkSpace.
|
default CreateWorkspacesResponse |
createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default CreateWorkspacesResponse |
createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes tags from a WorkSpace.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes tags from a WorkSpace.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes tags for a WorkSpace.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes tags for a WorkSpace.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles()
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesResponse |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesIterable |
describeWorkspaceBundlesPaginator()
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesIterable |
describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceDirectoriesResponse |
describeWorkspaceDirectories()
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon
WorkSpaces and are available to your account.
|
default DescribeWorkspaceDirectoriesResponse |
describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> 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 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 DescribeWorkspaceDirectoriesIterable |
describeWorkspaceDirectoriesPaginator()
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon
WorkSpaces and are available to your account.
|
default DescribeWorkspaceDirectoriesIterable |
describeWorkspaceDirectoriesPaginator(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()
Obtains information about the specified WorkSpaces.
|
default DescribeWorkspacesResponse |
describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default DescribeWorkspacesResponse |
describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus()
Describes the connection status of a specified WorkSpace.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
|
default DescribeWorkspacesConnectionStatusResponse |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
|
default DescribeWorkspacesIterable |
describeWorkspacesPaginator()
Obtains information about the specified WorkSpaces.
|
default DescribeWorkspacesIterable |
describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default ModifyWorkspacePropertiesResponse |
modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
|
default ModifyWorkspacePropertiesResponse |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
|
default RebootWorkspacesResponse |
rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default RebootWorkspacesResponse |
rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default RebuildWorkspacesResponse |
rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest)
Rebuilds the specified WorkSpaces.
|
default RebuildWorkspacesResponse |
rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpaces.
|
static ServiceMetadata |
serviceMetadata() |
default StartWorkspacesResponse |
startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default StartWorkspacesResponse |
startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default StopWorkspacesResponse |
stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default StopWorkspacesResponse |
stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default TerminateWorkspacesResponse |
terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
default TerminateWorkspacesResponse |
terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
serviceName
close
static final String SERVICE_NAME
static WorkSpacesClient create()
WorkSpacesClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from
the DefaultCredentialsProvider
.static WorkSpacesClientBuilder builder()
WorkSpacesClient
.default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, SdkServiceException, SdkClientException, WorkSpacesException
Creates tags for a WorkSpace.
createTagsRequest
- The request of the CreateTags operation.ResourceNotFoundException
- The resource could not be found.InvalidParameterValuesException
- One or more parameter values are not valid.ResourceLimitExceededException
- Your resource limits have been exceeded.SdkException
- 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 type.SdkServiceException
default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, SdkServiceException, SdkClientException, WorkSpacesException
Creates tags for a WorkSpace.
createTagsRequest
- The request of the CreateTags operation.ResourceNotFoundException
- The resource could not be found.InvalidParameterValuesException
- One or more parameter values are not valid.ResourceLimitExceededException
- Your resource limits have been exceeded.SdkException
- 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 type.SdkServiceException
default CreateWorkspacesResponse createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest
- Contains the inputs for the CreateWorkspaces operation.ResourceLimitExceededException
- Your resource limits have been exceeded.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default CreateWorkspacesResponse createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest
- Contains the inputs for the CreateWorkspaces operation.ResourceLimitExceededException
- Your resource limits have been exceeded.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Deletes tags from a WorkSpace.
deleteTagsRequest
- The request of the DeleteTags operation.ResourceNotFoundException
- The resource could not be found.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Deletes tags from a WorkSpace.
deleteTagsRequest
- The request of the DeleteTags operation.ResourceNotFoundException
- The resource could not be found.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, SdkServiceException, SdkClientException, WorkSpacesException
Describes tags for a WorkSpace.
describeTagsRequest
- The request of the DescribeTags operation.ResourceNotFoundException
- The resource could not be found.SdkException
- 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 type.SdkServiceException
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, SdkServiceException, SdkClientException, WorkSpacesException
Describes tags for a WorkSpace.
describeTagsRequest
- The request of the DescribeTags operation.ResourceNotFoundException
- The resource could not be found.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles() throws InvalidParameterValuesException, SdkServiceException, 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.
InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)
,
AWS API Documentationdefault DescribeWorkspaceBundlesResponse describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
describeWorkspaceBundlesRequest
- Contains the inputs for the DescribeWorkspaceBundles operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
describeWorkspaceBundlesRequest
- Contains the inputs for the DescribeWorkspaceBundles operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator() throws InvalidParameterValuesException, SdkServiceException, 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.
This is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client .describeWorkspaceBundlesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest)
,
AWS API Documentationdefault DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
This is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client .describeWorkspaceBundlesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
describeWorkspaceBundlesRequest
- Contains the inputs for the DescribeWorkspaceBundles operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories() throws InvalidParameterValuesException, SdkServiceException, 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.
InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)
,
AWS API Documentationdefault DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
describeWorkspaceDirectoriesRequest
- Contains the inputs for the DescribeWorkspaceDirectories operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
describeWorkspaceDirectoriesRequest
- Contains the inputs for the DescribeWorkspaceDirectories operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator() throws InvalidParameterValuesException, SdkServiceException, 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.
This is a variant of
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client .describeWorkspaceDirectoriesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest)
,
AWS API Documentationdefault DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, SdkServiceException, 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.
This is a variant of
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client .describeWorkspaceDirectoriesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
describeWorkspaceDirectoriesRequest
- Contains the inputs for the DescribeWorkspaceDirectories operation.InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspacesResponse describeWorkspaces() throws InvalidParameterValuesException, ResourceUnavailableException, SdkServiceException, 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.
InvalidParameterValuesException
- One or more parameter values are not valid.ResourceUnavailableException
- The specified resource is not available.SdkException
- 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 type.SdkServiceException
describeWorkspaces(DescribeWorkspacesRequest)
,
AWS
API Documentationdefault DescribeWorkspacesResponse describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, SdkServiceException, 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.
describeWorkspacesRequest
- Contains the inputs for the DescribeWorkspaces operation.InvalidParameterValuesException
- One or more parameter values are not valid.ResourceUnavailableException
- The specified resource is not available.SdkException
- 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 type.SdkServiceException
default DescribeWorkspacesResponse describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, SdkServiceException, 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.
describeWorkspacesRequest
- Contains the inputs for the DescribeWorkspaces operation.InvalidParameterValuesException
- One or more parameter values are not valid.ResourceUnavailableException
- The specified resource is not available.SdkException
- 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 type.SdkServiceException
default DescribeWorkspacesIterable describeWorkspacesPaginator() throws InvalidParameterValuesException, ResourceUnavailableException, SdkServiceException, 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.
This is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client .describeWorkspacesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
InvalidParameterValuesException
- One or more parameter values are not valid.ResourceUnavailableException
- The specified resource is not available.SdkException
- 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 type.SdkServiceException
describeWorkspacesPaginator(DescribeWorkspacesRequest)
,
AWS
API Documentationdefault DescribeWorkspacesIterable describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, SdkServiceException, 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.
This is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client .describeWorkspacesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
describeWorkspacesRequest
- Contains the inputs for the DescribeWorkspaces operation.InvalidParameterValuesException
- One or more parameter values are not valid.ResourceUnavailableException
- The specified resource is not available.SdkException
- 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 type.SdkServiceException
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus() throws InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Describes the connection status of a specified WorkSpace.
InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest)
,
AWS API Documentationdefault DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Describes the connection status of a specified WorkSpace.
describeWorkspacesConnectionStatusRequest
- InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, SdkServiceException, SdkClientException, WorkSpacesException
Describes the connection status of a specified WorkSpace.
describeWorkspacesConnectionStatusRequest
- InvalidParameterValuesException
- One or more parameter values are not valid.SdkException
- 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 type.SdkServiceException
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, SdkServiceException, SdkClientException, WorkSpacesException
Modifies the WorkSpace properties, including the running mode and AutoStop time.
modifyWorkspacePropertiesRequest
- 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.SdkException
- 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 type.SdkServiceException
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, SdkServiceException, SdkClientException, WorkSpacesException
Modifies the WorkSpace properties, including the running mode and AutoStop time.
modifyWorkspacePropertiesRequest
- 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.SdkException
- 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 type.SdkServiceException
default RebootWorkspacesResponse rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) throws SdkServiceException, 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.
rebootWorkspacesRequest
- Contains the inputs for the RebootWorkspaces operation.SdkException
- 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 type.SdkServiceException
default RebootWorkspacesResponse rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest) throws SdkServiceException, 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.
rebootWorkspacesRequest
- Contains the inputs for the RebootWorkspaces operation.SdkException
- 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 type.SdkServiceException
default RebuildWorkspacesResponse rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) throws SdkServiceException, 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.
rebuildWorkspacesRequest
- Contains the inputs for the RebuildWorkspaces operation.SdkException
- 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 type.SdkServiceException
default RebuildWorkspacesResponse rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest) throws SdkServiceException, 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.
rebuildWorkspacesRequest
- Contains the inputs for the RebuildWorkspaces operation.SdkException
- 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 type.SdkServiceException
default StartWorkspacesResponse startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) throws SdkServiceException, SdkClientException, WorkSpacesException
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
startWorkspacesRequest
- SdkException
- 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 type.SdkServiceException
default StartWorkspacesResponse startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest) throws SdkServiceException, SdkClientException, WorkSpacesException
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
startWorkspacesRequest
- SdkException
- 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 type.SdkServiceException
default StopWorkspacesResponse stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) throws SdkServiceException, SdkClientException, WorkSpacesException
Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesRequest
- SdkException
- 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 type.SdkServiceException
default StopWorkspacesResponse stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest) throws SdkServiceException, SdkClientException, WorkSpacesException
Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesRequest
- SdkException
- 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 type.SdkServiceException
default TerminateWorkspacesResponse terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) throws SdkServiceException, 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.
terminateWorkspacesRequest
- Contains the inputs for the TerminateWorkspaces operation.SdkException
- 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 type.SdkServiceException
default TerminateWorkspacesResponse terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest) throws SdkServiceException, 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.
terminateWorkspacesRequest
- Contains the inputs for the TerminateWorkspaces operation.SdkException
- 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 type.SdkServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.