@Generated(value="software.amazon.awssdk:codegen") public interface WorkSpacesAsyncClient 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 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(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates tags for a WorkSpace.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest)
Creates tags for a WorkSpace.
|
default CompletableFuture<CreateWorkspacesResponse> |
createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default CompletableFuture<CreateWorkspacesResponse> |
createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes tags from a WorkSpace.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes tags from a WorkSpace.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes tags for a WorkSpace.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes tags for a WorkSpace.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles()
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesPublisher |
describeWorkspaceBundlesPaginator()
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default DescribeWorkspaceBundlesPublisher |
describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
|
default CompletableFuture<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 CompletableFuture<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 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 DescribeWorkspaceDirectoriesPublisher |
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 DescribeWorkspaceDirectoriesPublisher |
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 CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces()
Obtains information about the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus()
Describes the connection status of a specified WorkSpace.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
|
default DescribeWorkspacesPublisher |
describeWorkspacesPaginator()
Obtains information about the specified WorkSpaces.
|
default DescribeWorkspacesPublisher |
describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
Obtains information about the specified WorkSpaces.
|
default CompletableFuture<ModifyWorkspacePropertiesResponse> |
modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
|
default CompletableFuture<ModifyWorkspacePropertiesResponse> |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
|
default CompletableFuture<RebootWorkspacesResponse> |
rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default CompletableFuture<RebootWorkspacesResponse> |
rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
|
default CompletableFuture<RebuildWorkspacesResponse> |
rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest)
Rebuilds the specified WorkSpaces.
|
default CompletableFuture<RebuildWorkspacesResponse> |
rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpaces.
|
default CompletableFuture<StartWorkspacesResponse> |
startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default CompletableFuture<StartWorkspacesResponse> |
startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
|
default CompletableFuture<StopWorkspacesResponse> |
stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default CompletableFuture<StopWorkspacesResponse> |
stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest)
Stops the specified WorkSpaces.
|
default CompletableFuture<TerminateWorkspacesResponse> |
terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
default CompletableFuture<TerminateWorkspacesResponse> |
terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest)
Terminates the specified WorkSpaces.
|
serviceNameclosestatic final String SERVICE_NAME
static WorkSpacesAsyncClient create()
WorkSpacesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkSpacesAsyncClientBuilder builder()
WorkSpacesAsyncClient.default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)
Creates tags for a WorkSpace.
createTagsRequest - The request of the CreateTags operation.default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates tags for a WorkSpace.
This is a convenience which creates an instance of the CreateTagsRequest.Builder avoiding the need to
create one manually via CreateTagsRequest.builder()
createTagsRequest - A Consumer that will call methods on CreateTagsRequest.Builder to create a request. The
request of the CreateTags operation.default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest - Contains the inputs for the CreateWorkspaces operation.default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest)
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
This is a convenience which creates an instance of the CreateWorkspacesRequest.Builder avoiding the need
to create one manually via CreateWorkspacesRequest.builder()
createWorkspacesRequest - A Consumer that will call methods on CreateWorkspacesRequest.Builder to create a request.
Contains the inputs for the CreateWorkspaces operation.default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes tags from a WorkSpace.
deleteTagsRequest - The request of the DeleteTags operation.default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes tags from a WorkSpace.
This is a convenience which creates an instance of the DeleteTagsRequest.Builder avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest - A Consumer that will call methods on DeleteTagsRequest.Builder to create a request. The
request of the DeleteTags operation.default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
Describes tags for a WorkSpace.
describeTagsRequest - The request of the DescribeTags operation.default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes tags for a WorkSpace.
This is a convenience which creates an instance of the DescribeTagsRequest.Builder avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on DescribeTagsRequest.Builder to create a request. The
request of the DescribeTags operation.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.
describeWorkspaceBundlesRequest - Contains the inputs for the DescribeWorkspaceBundles operation.default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeWorkspaceBundlesRequest.Builder avoiding
the need to create one manually via DescribeWorkspaceBundlesRequest.builder()
describeWorkspaceBundlesRequest - A Consumer that will call methods on DescribeWorkspaceBundlesRequest.Builder to create a
request. Contains the inputs for the DescribeWorkspaceBundles operation.default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles()
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.
default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(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.
This is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.
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.
describeWorkspaceDirectoriesRequest - Contains the inputs for the DescribeWorkspaceDirectories operation.default CompletableFuture<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.
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 convenience which creates an instance of the DescribeWorkspaceDirectoriesRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceDirectoriesRequest.builder()
describeWorkspaceDirectoriesRequest - A Consumer that will call methods on DescribeWorkspaceDirectoriesRequest.Builder to create
a request. Contains the inputs for the DescribeWorkspaceDirectories operation.default CompletableFuture<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.
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.
default DescribeWorkspaceDirectoriesPublisher 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.
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.
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.
describeWorkspacesRequest - Contains the inputs for the DescribeWorkspaces operation.default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> 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.
This is a convenience which creates an instance of the DescribeWorkspacesRequest.Builder avoiding the
need to create one manually via DescribeWorkspacesRequest.builder()
describeWorkspacesRequest - A Consumer that will call methods on DescribeWorkspacesRequest.Builder to create a
request. Contains the inputs for the DescribeWorkspaces operation.default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces()
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.
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
describeWorkspacesConnectionStatusRequest - default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of a specified WorkSpace.
This is a convenience which creates an instance of the DescribeWorkspacesConnectionStatusRequest.Builder
avoiding the need to create one manually via DescribeWorkspacesConnectionStatusRequest.builder()
describeWorkspacesConnectionStatusRequest - A Consumer that will call methods on DescribeWorkspacesConnectionStatusRequest.Builder to
create a request.default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus()
Describes the connection status of a specified WorkSpace.
default DescribeWorkspacesPublisher describeWorkspacesPaginator(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.
This is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.default DescribeWorkspacesPublisher describeWorkspacesPaginator()
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 publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.
default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
modifyWorkspacePropertiesRequest - default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the WorkSpace properties, including the running mode and AutoStop time.
This is a convenience which creates an instance of the ModifyWorkspacePropertiesRequest.Builder avoiding
the need to create one manually via ModifyWorkspacePropertiesRequest.builder()
modifyWorkspacePropertiesRequest - A Consumer that will call methods on ModifyWorkspacePropertiesRequest.Builder to create a
request.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.
rebootWorkspacesRequest - Contains the inputs for the RebootWorkspaces operation.default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> 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.
This is a convenience which creates an instance of the RebootWorkspacesRequest.Builder avoiding the need
to create one manually via RebootWorkspacesRequest.builder()
rebootWorkspacesRequest - A Consumer that will call methods on RebootWorkspacesRequest.Builder to create a request.
Contains the inputs for the RebootWorkspaces operation.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.
rebuildWorkspacesRequest - Contains the inputs for the RebuildWorkspaces operation.default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> 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.
This is a convenience which creates an instance of the RebuildWorkspacesRequest.Builder avoiding the need
to create one manually via RebuildWorkspacesRequest.builder()
rebuildWorkspacesRequest - A Consumer that will call methods on RebuildWorkspacesRequest.Builder to create a request.
Contains the inputs for the RebuildWorkspaces operation.default CompletableFuture<StartWorkspacesResponse> startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
startWorkspacesRequest - default CompletableFuture<StartWorkspacesResponse> startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)
Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.
This is a convenience which creates an instance of the StartWorkspacesRequest.Builder avoiding the need
to create one manually via StartWorkspacesRequest.builder()
startWorkspacesRequest - A Consumer that will call methods on StartWorkspacesRequest.Builder to create a request.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.
stopWorkspacesRequest - default CompletableFuture<StopWorkspacesResponse> stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest)
Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
This is a convenience which creates an instance of the StopWorkspacesRequest.Builder avoiding the need to
create one manually via StopWorkspacesRequest.builder()
stopWorkspacesRequest - A Consumer that will call methods on StopWorkspacesRequest.Builder to create a request.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.
terminateWorkspacesRequest - Contains the inputs for the TerminateWorkspaces operation.default CompletableFuture<TerminateWorkspacesResponse> terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> 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.
This is a convenience which creates an instance of the TerminateWorkspacesRequest.Builder avoiding the
need to create one manually via TerminateWorkspacesRequest.builder()
terminateWorkspacesRequest - A Consumer that will call methods on TerminateWorkspacesRequest.Builder to create a
request. Contains the inputs for the TerminateWorkspaces operation.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.