@Generated(value="software.amazon.awssdk:codegen") public interface WorkSpacesAsyncClient extends SdkClient
builder()
method.
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AssociateIpGroupsResponse> |
associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
|
default CompletableFuture<AssociateIpGroupsResponse> |
associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
|
default CompletableFuture<AuthorizeIpRulesResponse> |
authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
|
default CompletableFuture<AuthorizeIpRulesResponse> |
authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
|
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<CreateIpGroupResponse> |
createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest)
Creates an IP access control group.
|
default CompletableFuture<CreateIpGroupResponse> |
createIpGroup(CreateIpGroupRequest createIpGroupRequest)
Creates an IP access control group.
|
default CompletableFuture<CreateTagsResponse> |
createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates the specified tags for the specified WorkSpace.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified 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<DeleteIpGroupResponse> |
deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest)
Deletes the specified IP access control group.
|
default CompletableFuture<DeleteIpGroupResponse> |
deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
Deletes the specified IP access control group.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from the specified WorkSpace.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpace.
|
default CompletableFuture<DeleteWorkspaceImageResponse> |
deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest)
Deletes the specified image from your account.
|
default CompletableFuture<DeleteWorkspaceImageResponse> |
deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
Deletes the specified image from your account.
|
default CompletableFuture<DescribeAccountResponse> |
describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
|
default CompletableFuture<DescribeAccountResponse> |
describeAccount(DescribeAccountRequest describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
|
default CompletableFuture<DescribeAccountModificationsResponse> |
describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the
specified account.
|
default CompletableFuture<DescribeAccountModificationsResponse> |
describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the
specified account.
|
default CompletableFuture<DescribeClientPropertiesResponse> |
describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
default CompletableFuture<DescribeClientPropertiesResponse> |
describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
default CompletableFuture<DescribeIpGroupsResponse> |
describeIpGroups()
Describes one or more of your IP access control groups.
|
default CompletableFuture<DescribeIpGroupsResponse> |
describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest)
Describes one or more of your IP access control groups.
|
default CompletableFuture<DescribeIpGroupsResponse> |
describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
Describes one or more of your IP access control groups.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags for the specified WorkSpace.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpace.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles()
Retrieves a list that describes the available WorkSpace bundles.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default CompletableFuture<DescribeWorkspaceBundlesResponse> |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesPublisher |
describeWorkspaceBundlesPaginator()
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesPublisher |
describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default DescribeWorkspaceBundlesPublisher |
describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
|
default CompletableFuture<DescribeWorkspaceDirectoriesResponse> |
describeWorkspaceDirectories()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceDirectoriesResponse> |
describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceDirectoriesResponse> |
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceImagesResponse> |
describeWorkspaceImages()
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default CompletableFuture<DescribeWorkspaceImagesResponse> |
describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default CompletableFuture<DescribeWorkspaceImagesResponse> |
describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
default CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces()
Describes the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesResponse> |
describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus()
Describes the connection status of the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
|
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
|
default DescribeWorkspacesPublisher |
describeWorkspacesPaginator()
Describes the specified WorkSpaces.
|
default DescribeWorkspacesPublisher |
describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default DescribeWorkspacesPublisher |
describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
|
default CompletableFuture<DisassociateIpGroupsResponse> |
disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
|
default CompletableFuture<DisassociateIpGroupsResponse> |
disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
|
default CompletableFuture<ImportWorkspaceImageResponse> |
importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
|
default CompletableFuture<ImportWorkspaceImageResponse> |
importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces.
|
default CompletableFuture<ListAvailableManagementCidrRangesResponse> |
listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management
interface when you enable bring your own license (BYOL).
|
default CompletableFuture<ListAvailableManagementCidrRangesResponse> |
listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management
interface when you enable bring your own license (BYOL).
|
default CompletableFuture<ModifyAccountResponse> |
modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
|
default CompletableFuture<ModifyAccountResponse> |
modifyAccount(ModifyAccountRequest modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
|
default CompletableFuture<ModifyClientPropertiesResponse> |
modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
|
default CompletableFuture<ModifyClientPropertiesResponse> |
modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
|
default CompletableFuture<ModifyWorkspacePropertiesResponse> |
modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
|
default CompletableFuture<ModifyWorkspacePropertiesResponse> |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
|
default CompletableFuture<ModifyWorkspaceStateResponse> |
modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
|
default CompletableFuture<ModifyWorkspaceStateResponse> |
modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
|
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 WorkSpace.
|
default CompletableFuture<RebuildWorkspacesResponse> |
rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
|
default CompletableFuture<RevokeIpRulesResponse> |
revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
|
default CompletableFuture<RevokeIpRulesResponse> |
revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
|
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.
|
default CompletableFuture<UpdateRulesOfIpGroupResponse> |
updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
|
default CompletableFuture<UpdateRulesOfIpGroupResponse> |
updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
|
serviceName
close
static 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<AssociateIpGroupsResponse> associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
associateIpGroupsRequest
- default CompletableFuture<AssociateIpGroupsResponse> associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest)
Associates the specified IP access control group with the specified directory.
This is a convenience which creates an instance of the AssociateIpGroupsRequest.Builder
avoiding the need
to create one manually via AssociateIpGroupsRequest.builder()
associateIpGroupsRequest
- A Consumer
that will call methods on AssociateIpGroupsRequest.Builder
to create a request.default CompletableFuture<AuthorizeIpRulesResponse> authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
authorizeIpRulesRequest
- default CompletableFuture<AuthorizeIpRulesResponse> authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest)
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
This is a convenience which creates an instance of the AuthorizeIpRulesRequest.Builder
avoiding the need
to create one manually via AuthorizeIpRulesRequest.builder()
authorizeIpRulesRequest
- A Consumer
that will call methods on AuthorizeIpRulesRequest.Builder
to create a request.default CompletableFuture<CreateIpGroupResponse> createIpGroup(CreateIpGroupRequest createIpGroupRequest)
Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
createIpGroupRequest
- default CompletableFuture<CreateIpGroupResponse> createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest)
Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
This is a convenience which creates an instance of the CreateIpGroupRequest.Builder
avoiding the need to
create one manually via CreateIpGroupRequest.builder()
createIpGroupRequest
- A Consumer
that will call methods on CreateIpGroupRequest.Builder
to create a request.default CompletableFuture<CreateTagsResponse> createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified WorkSpace.
createTagsRequest
- default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates the specified tags for the specified 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.default CompletableFuture<CreateWorkspacesResponse> createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest)
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
createWorkspacesRequest
- 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.default CompletableFuture<DeleteIpGroupResponse> deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest)
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroupRequest
- default CompletableFuture<DeleteIpGroupResponse> deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest)
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
This is a convenience which creates an instance of the DeleteIpGroupRequest.Builder
avoiding the need to
create one manually via DeleteIpGroupRequest.builder()
deleteIpGroupRequest
- A Consumer
that will call methods on DeleteIpGroupRequest.Builder
to create a request.default CompletableFuture<DeleteTagsResponse> deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpace.
deleteTagsRequest
- default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from the specified 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.default CompletableFuture<DeleteWorkspaceImageResponse> deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest)
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image.
deleteWorkspaceImageRequest
- default CompletableFuture<DeleteWorkspaceImageResponse> deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest)
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image.
This is a convenience which creates an instance of the DeleteWorkspaceImageRequest.Builder
avoiding the
need to create one manually via DeleteWorkspaceImageRequest.builder()
deleteWorkspaceImageRequest
- A Consumer
that will call methods on DeleteWorkspaceImageRequest.Builder
to create a
request.default CompletableFuture<DescribeAccountResponse> describeAccount(DescribeAccountRequest describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
describeAccountRequest
- default CompletableFuture<DescribeAccountResponse> describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest)
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the DescribeAccountRequest.Builder
avoiding the need
to create one manually via DescribeAccountRequest.builder()
describeAccountRequest
- A Consumer
that will call methods on DescribeAccountRequest.Builder
to create a request.default CompletableFuture<DescribeAccountModificationsResponse> describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
describeAccountModificationsRequest
- default CompletableFuture<DescribeAccountModificationsResponse> describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest)
Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the DescribeAccountModificationsRequest.Builder
avoiding the need to create one manually via DescribeAccountModificationsRequest.builder()
describeAccountModificationsRequest
- A Consumer
that will call methods on DescribeAccountModificationsRequest.Builder
to create
a request.default CompletableFuture<DescribeClientPropertiesResponse> describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientPropertiesRequest
- default CompletableFuture<DescribeClientPropertiesResponse> describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
This is a convenience which creates an instance of the DescribeClientPropertiesRequest.Builder
avoiding
the need to create one manually via DescribeClientPropertiesRequest.builder()
describeClientPropertiesRequest
- A Consumer
that will call methods on DescribeClientPropertiesRequest.Builder
to create a
request.default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest)
Describes one or more of your IP access control groups.
describeIpGroupsRequest
- default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest)
Describes one or more of your IP access control groups.
This is a convenience which creates an instance of the DescribeIpGroupsRequest.Builder
avoiding the need
to create one manually via DescribeIpGroupsRequest.builder()
describeIpGroupsRequest
- A Consumer
that will call methods on DescribeIpGroupsRequest.Builder
to create a request.default CompletableFuture<DescribeIpGroupsResponse> describeIpGroups()
Describes one or more of your IP access control groups.
default CompletableFuture<DescribeTagsResponse> describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpace.
describeTagsRequest
- default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags for the specified 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.default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundlesRequest
- default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
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.default CompletableFuture<DescribeWorkspaceBundlesResponse> describeWorkspaceBundles()
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator()
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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 DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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
- default DescribeWorkspaceBundlesPublisher describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest)
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesPublisher publisher = client.describeWorkspaceBundlesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
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.default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesRequest
- default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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.default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator()
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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 DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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
- default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesPublisher publisher = client.describeWorkspaceDirectoriesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
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.default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImagesRequest
- default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest)
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
This is a convenience which creates an instance of the DescribeWorkspaceImagesRequest.Builder
avoiding
the need to create one manually via DescribeWorkspaceImagesRequest.builder()
describeWorkspaceImagesRequest
- A Consumer
that will call methods on DescribeWorkspaceImagesRequest.Builder
to create a
request.default CompletableFuture<DescribeWorkspaceImagesResponse> describeWorkspaceImages()
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
describeWorkspacesRequest
- default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
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.default CompletableFuture<DescribeWorkspacesResponse> describeWorkspaces()
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatusRequest
- default CompletableFuture<DescribeWorkspacesConnectionStatusResponse> describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest)
Describes the connection status of the specified WorkSpaces.
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 the specified WorkSpaces.
default DescribeWorkspacesPublisher describeWorkspacesPaginator()
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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 DescribeWorkspacesPublisher describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest)
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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
- default DescribeWorkspacesPublisher describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest)
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
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 subscribe helper method
software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesPublisher publisher = client.describeWorkspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(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.
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.default CompletableFuture<DisassociateIpGroupsResponse> disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
disassociateIpGroupsRequest
- default CompletableFuture<DisassociateIpGroupsResponse> disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest)
Disassociates the specified IP access control group from the specified directory.
This is a convenience which creates an instance of the DisassociateIpGroupsRequest.Builder
avoiding the
need to create one manually via DisassociateIpGroupsRequest.builder()
disassociateIpGroupsRequest
- A Consumer
that will call methods on DisassociateIpGroupsRequest.Builder
to create a
request.default CompletableFuture<ImportWorkspaceImageResponse> importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
importWorkspaceImageRequest
- default CompletableFuture<ImportWorkspaceImageResponse> importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest)
Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
This is a convenience which creates an instance of the ImportWorkspaceImageRequest.Builder
avoiding the
need to create one manually via ImportWorkspaceImageRequest.builder()
importWorkspaceImageRequest
- A Consumer
that will call methods on ImportWorkspaceImageRequest.Builder
to create a
request.default CompletableFuture<ListAvailableManagementCidrRangesResponse> listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
listAvailableManagementCidrRangesRequest
- default CompletableFuture<ListAvailableManagementCidrRangesResponse> listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest)
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
This is a convenience which creates an instance of the ListAvailableManagementCidrRangesRequest.Builder
avoiding the need to create one manually via ListAvailableManagementCidrRangesRequest.builder()
listAvailableManagementCidrRangesRequest
- A Consumer
that will call methods on ListAvailableManagementCidrRangesRequest.Builder
to
create a request.default CompletableFuture<ModifyAccountResponse> modifyAccount(ModifyAccountRequest modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
modifyAccountRequest
- default CompletableFuture<ModifyAccountResponse> modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest)
Modifies the configuration of bring your own license (BYOL) for the specified account.
This is a convenience which creates an instance of the ModifyAccountRequest.Builder
avoiding the need to
create one manually via ModifyAccountRequest.builder()
modifyAccountRequest
- A Consumer
that will call methods on ModifyAccountRequest.Builder
to create a request.default CompletableFuture<ModifyClientPropertiesResponse> modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
modifyClientPropertiesRequest
- default CompletableFuture<ModifyClientPropertiesResponse> modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces client.
This is a convenience which creates an instance of the ModifyClientPropertiesRequest.Builder
avoiding the
need to create one manually via ModifyClientPropertiesRequest.builder()
modifyClientPropertiesRequest
- A Consumer
that will call methods on ModifyClientPropertiesRequest.Builder
to create a
request.default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
modifyWorkspacePropertiesRequest
- default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties.
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<ModifyWorkspaceStateResponse> modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
.
WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in
this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE
state.
modifyWorkspaceStateRequest
- default CompletableFuture<ModifyWorkspaceStateResponse> modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest)
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE
.
WorkSpaces in this state do not respond to requests to reboot, stop, start, or rebuild. An AutoStop WorkSpace in
this state is not stopped. Users can log into a WorkSpace in the ADMIN_MAINTENANCE
state.
This is a convenience which creates an instance of the ModifyWorkspaceStateRequest.Builder
avoiding the
need to create one manually via ModifyWorkspaceStateRequest.builder()
modifyWorkspaceStateRequest
- A Consumer
that will call methods on ModifyWorkspaceStateRequest.Builder
to create a
request.default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
or UNHEALTHY
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspacesRequest
- default CompletableFuture<RebootWorkspacesResponse> rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest)
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
or UNHEALTHY
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
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.default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, or
UNHEALTHY
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspacesRequest
- default CompletableFuture<RebuildWorkspacesResponse> rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest)
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
, ERROR
, or
UNHEALTHY
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
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.default CompletableFuture<RevokeIpRulesResponse> revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
revokeIpRulesRequest
- default CompletableFuture<RevokeIpRulesResponse> revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest)
Removes one or more rules from the specified IP access control group.
This is a convenience which creates an instance of the RevokeIpRulesRequest.Builder
avoiding the need to
create one manually via RevokeIpRulesRequest.builder()
revokeIpRulesRequest
- A Consumer
that will call methods on RevokeIpRulesRequest.Builder
to create a request.default CompletableFuture<StartWorkspacesResponse> startWorkspaces(StartWorkspacesRequest startWorkspacesRequest)
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop
and a state of
STOPPED
.
startWorkspacesRequest
- default CompletableFuture<StartWorkspacesResponse> startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest)
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has 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.
You cannot stop a WorkSpace unless it has 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.
You cannot stop a WorkSpace unless it has 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 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
- 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 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.default CompletableFuture<UpdateRulesOfIpGroupResponse> updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroupRequest
- default CompletableFuture<UpdateRulesOfIpGroupResponse> updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest)
Replaces the current rules of the specified IP access control group with the specified rules.
This is a convenience which creates an instance of the UpdateRulesOfIpGroupRequest.Builder
avoiding the
need to create one manually via UpdateRulesOfIpGroupRequest.builder()
updateRulesOfIpGroupRequest
- A Consumer
that will call methods on UpdateRulesOfIpGroupRequest.Builder
to create a
request.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.