@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_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateConnectionAliasResponse> |
associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest)
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
|
default CompletableFuture<AssociateConnectionAliasResponse> |
associateConnectionAlias(Consumer<AssociateConnectionAliasRequest.Builder> associateConnectionAliasRequest)
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
|
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. |
default CompletableFuture<CopyWorkspaceImageResponse> |
copyWorkspaceImage(Consumer<CopyWorkspaceImageRequest.Builder> copyWorkspaceImageRequest)
Copies the specified image from the specified Region to the current Region.
|
default CompletableFuture<CopyWorkspaceImageResponse> |
copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)
Copies the specified image from the specified Region to the current Region.
|
static WorkSpacesAsyncClient |
create()
Create a
WorkSpacesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateConnectionAliasResponse> |
createConnectionAlias(Consumer<CreateConnectionAliasRequest.Builder> createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection.
|
default CompletableFuture<CreateConnectionAliasResponse> |
createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection.
|
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 WorkSpaces resource.
|
default CompletableFuture<CreateTagsResponse> |
createTags(CreateTagsRequest createTagsRequest)
Creates the specified tags for the specified WorkSpaces resource.
|
default CompletableFuture<CreateWorkspaceBundleResponse> |
createWorkspaceBundle(Consumer<CreateWorkspaceBundleRequest.Builder> createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle.
|
default CompletableFuture<CreateWorkspaceBundleResponse> |
createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle.
|
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<DeleteConnectionAliasResponse> |
deleteConnectionAlias(Consumer<DeleteConnectionAliasRequest.Builder> deleteConnectionAliasRequest)
Deletes the specified connection alias.
|
default CompletableFuture<DeleteConnectionAliasResponse> |
deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)
Deletes the specified connection alias.
|
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 WorkSpaces resource.
|
default CompletableFuture<DeleteTagsResponse> |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags from the specified WorkSpaces resource.
|
default CompletableFuture<DeleteWorkspaceBundleResponse> |
deleteWorkspaceBundle(Consumer<DeleteWorkspaceBundleRequest.Builder> deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle.
|
default CompletableFuture<DeleteWorkspaceBundleResponse> |
deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle.
|
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<DeregisterWorkspaceDirectoryResponse> |
deregisterWorkspaceDirectory(Consumer<DeregisterWorkspaceDirectoryRequest.Builder> deregisterWorkspaceDirectoryRequest)
Deregisters the specified directory.
|
default CompletableFuture<DeregisterWorkspaceDirectoryResponse> |
deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)
Deregisters the specified directory.
|
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<DescribeConnectionAliasesResponse> |
describeConnectionAliases(Consumer<DescribeConnectionAliasesRequest.Builder> describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection.
|
default CompletableFuture<DescribeConnectionAliasesResponse> |
describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection.
|
default CompletableFuture<DescribeConnectionAliasPermissionsResponse> |
describeConnectionAliasPermissions(Consumer<DescribeConnectionAliasPermissionsRequest.Builder> describeConnectionAliasPermissionsRequest)
Describes the permissions that the owner of a connection alias has granted to another AWS account for the
specified connection alias.
|
default CompletableFuture<DescribeConnectionAliasPermissionsResponse> |
describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest)
Describes the permissions that the owner of a connection alias has granted to another AWS account for the
specified connection alias.
|
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 WorkSpaces resource.
|
default CompletableFuture<DescribeTagsResponse> |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags for the specified WorkSpaces resource.
|
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 directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceDirectoriesResponse> |
describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceDirectoriesResponse> |
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator()
Describes the available directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
|
default DescribeWorkspaceDirectoriesPublisher |
describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest)
Describes the available directories that are registered with Amazon WorkSpaces.
|
default CompletableFuture<DescribeWorkspaceImagePermissionsResponse> |
describeWorkspaceImagePermissions(Consumer<DescribeWorkspaceImagePermissionsRequest.Builder> describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
|
default CompletableFuture<DescribeWorkspaceImagePermissionsResponse> |
describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
|
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 CompletableFuture<DescribeWorkspaceSnapshotsResponse> |
describeWorkspaceSnapshots(Consumer<DescribeWorkspaceSnapshotsRequest.Builder> describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
|
default CompletableFuture<DescribeWorkspaceSnapshotsResponse> |
describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
|
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<DisassociateConnectionAliasResponse> |
disassociateConnectionAlias(Consumer<DisassociateConnectionAliasRequest.Builder> disassociateConnectionAliasRequest)
Disassociates a connection alias from a directory.
|
default CompletableFuture<DisassociateConnectionAliasResponse> |
disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest)
Disassociates a connection alias from a directory.
|
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 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
|
default CompletableFuture<ImportWorkspaceImageResponse> |
importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest)
Imports the specified 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<MigrateWorkspaceResponse> |
migrateWorkspace(Consumer<MigrateWorkspaceRequest.Builder> migrateWorkspaceRequest)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
volume.
|
default CompletableFuture<MigrateWorkspaceResponse> |
migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
volume.
|
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 clients.
|
default CompletableFuture<ModifyClientPropertiesResponse> |
modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces clients.
|
default CompletableFuture<ModifySelfservicePermissionsResponse> |
modifySelfservicePermissions(Consumer<ModifySelfservicePermissionsRequest.Builder> modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users.
|
default CompletableFuture<ModifySelfservicePermissionsResponse> |
modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users.
|
default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> |
modifyWorkspaceAccessProperties(Consumer<ModifyWorkspaceAccessPropertiesRequest.Builder> modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces.
|
default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> |
modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces.
|
default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> |
modifyWorkspaceCreationProperties(Consumer<ModifyWorkspaceCreationPropertiesRequest.Builder> modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
|
default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> |
modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
|
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<RegisterWorkspaceDirectoryResponse> |
registerWorkspaceDirectory(Consumer<RegisterWorkspaceDirectoryRequest.Builder> registerWorkspaceDirectoryRequest)
Registers the specified directory.
|
default CompletableFuture<RegisterWorkspaceDirectoryResponse> |
registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)
Registers the specified directory.
|
default CompletableFuture<RestoreWorkspaceResponse> |
restoreWorkspace(Consumer<RestoreWorkspaceRequest.Builder> restoreWorkspaceRequest)
Restores the specified WorkSpace to its last known healthy state.
|
default CompletableFuture<RestoreWorkspaceResponse> |
restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)
Restores the specified WorkSpace to its last known healthy state.
|
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<UpdateConnectionAliasPermissionResponse> |
updateConnectionAliasPermission(Consumer<UpdateConnectionAliasPermissionRequest.Builder> updateConnectionAliasPermissionRequest)
Shares or unshares a connection alias with one account by specifying whether that account has permission to
associate the connection alias with a directory.
|
default CompletableFuture<UpdateConnectionAliasPermissionResponse> |
updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest)
Shares or unshares a connection alias with one account by specifying whether that account has permission to
associate the connection alias with a directory.
|
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.
|
default CompletableFuture<UpdateWorkspaceBundleResponse> |
updateWorkspaceBundle(Consumer<UpdateWorkspaceBundleRequest.Builder> updateWorkspaceBundleRequest)
Updates a WorkSpace bundle with a new image.
|
default CompletableFuture<UpdateWorkspaceBundleResponse> |
updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)
Updates a WorkSpace bundle with a new image.
|
default CompletableFuture<UpdateWorkspaceImagePermissionResponse> |
updateWorkspaceImagePermission(Consumer<UpdateWorkspaceImagePermissionRequest.Builder> updateWorkspaceImagePermissionRequest)
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has
permission to copy the image.
|
default CompletableFuture<UpdateWorkspaceImagePermissionResponse> |
updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest)
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has
permission to copy the image.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static WorkSpacesAsyncClient create()
WorkSpacesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static WorkSpacesAsyncClientBuilder builder()
WorkSpacesAsyncClient.default CompletableFuture<AssociateConnectionAliasResponse> associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest)
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
associateConnectionAliasRequest - default CompletableFuture<AssociateConnectionAliasResponse> associateConnectionAlias(Consumer<AssociateConnectionAliasRequest.Builder> associateConnectionAliasRequest)
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
This is a convenience which creates an instance of the AssociateConnectionAliasRequest.Builder avoiding
the need to create one manually via AssociateConnectionAliasRequest.builder()
associateConnectionAliasRequest - A Consumer that will call methods on AssociateConnectionAliasRequest.Builder to create a
request.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<CopyWorkspaceImageResponse> copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest)
Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
copyWorkspaceImageRequest - default CompletableFuture<CopyWorkspaceImageResponse> copyWorkspaceImage(Consumer<CopyWorkspaceImageRequest.Builder> copyWorkspaceImageRequest)
Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
This is a convenience which creates an instance of the CopyWorkspaceImageRequest.Builder avoiding the
need to create one manually via CopyWorkspaceImageRequest.builder()
copyWorkspaceImageRequest - A Consumer that will call methods on CopyWorkspaceImageRequest.Builder to create a
request.default CompletableFuture<CreateConnectionAliasResponse> createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
createConnectionAliasRequest - default CompletableFuture<CreateConnectionAliasResponse> createConnectionAlias(Consumer<CreateConnectionAliasRequest.Builder> createConnectionAliasRequest)
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
This is a convenience which creates an instance of the CreateConnectionAliasRequest.Builder avoiding the
need to create one manually via CreateConnectionAliasRequest.builder()
createConnectionAliasRequest - A Consumer that will call methods on CreateConnectionAliasRequest.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 WorkSpaces resource.
createTagsRequest - default CompletableFuture<CreateTagsResponse> createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest)
Creates the specified tags for the specified WorkSpaces resource.
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<CreateWorkspaceBundleResponse> createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
createWorkspaceBundleRequest - default CompletableFuture<CreateWorkspaceBundleResponse> createWorkspaceBundle(Consumer<CreateWorkspaceBundleRequest.Builder> createWorkspaceBundleRequest)
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
This is a convenience which creates an instance of the CreateWorkspaceBundleRequest.Builder avoiding the
need to create one manually via CreateWorkspaceBundleRequest.builder()
createWorkspaceBundleRequest - A Consumer that will call methods on CreateWorkspaceBundleRequest.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<DeleteConnectionAliasResponse> deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest)
Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
deleteConnectionAliasRequest - default CompletableFuture<DeleteConnectionAliasResponse> deleteConnectionAlias(Consumer<DeleteConnectionAliasRequest.Builder> deleteConnectionAliasRequest)
Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
This is a convenience which creates an instance of the DeleteConnectionAliasRequest.Builder avoiding the
need to create one manually via DeleteConnectionAliasRequest.builder()
deleteConnectionAliasRequest - A Consumer that will call methods on DeleteConnectionAliasRequest.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 WorkSpaces resource.
deleteTagsRequest - default CompletableFuture<DeleteTagsResponse> deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags from the specified WorkSpaces resource.
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<DeleteWorkspaceBundleResponse> deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
deleteWorkspaceBundleRequest - default CompletableFuture<DeleteWorkspaceBundleResponse> deleteWorkspaceBundle(Consumer<DeleteWorkspaceBundleRequest.Builder> deleteWorkspaceBundleRequest)
Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
This is a convenience which creates an instance of the DeleteWorkspaceBundleRequest.Builder avoiding the
need to create one manually via DeleteWorkspaceBundleRequest.builder()
deleteWorkspaceBundleRequest - A Consumer that will call methods on DeleteWorkspaceBundleRequest.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 and unshare the image if it is shared with other accounts.
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 and unshare the image if it is shared with other accounts.
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<DeregisterWorkspaceDirectoryResponse> deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest)
Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
deregisterWorkspaceDirectoryRequest - default CompletableFuture<DeregisterWorkspaceDirectoryResponse> deregisterWorkspaceDirectory(Consumer<DeregisterWorkspaceDirectoryRequest.Builder> deregisterWorkspaceDirectoryRequest)
Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
This is a convenience which creates an instance of the DeregisterWorkspaceDirectoryRequest.Builder
avoiding the need to create one manually via DeregisterWorkspaceDirectoryRequest.builder()
deregisterWorkspaceDirectoryRequest - A Consumer that will call methods on DeregisterWorkspaceDirectoryRequest.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<DescribeConnectionAliasPermissionsResponse> describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest)
Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasPermissionsRequest - default CompletableFuture<DescribeConnectionAliasPermissionsResponse> describeConnectionAliasPermissions(Consumer<DescribeConnectionAliasPermissionsRequest.Builder> describeConnectionAliasPermissionsRequest)
Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
This is a convenience which creates an instance of the DescribeConnectionAliasPermissionsRequest.Builder
avoiding the need to create one manually via DescribeConnectionAliasPermissionsRequest.builder()
describeConnectionAliasPermissionsRequest - A Consumer that will call methods on DescribeConnectionAliasPermissionsRequest.Builder to
create a request.default CompletableFuture<DescribeConnectionAliasesResponse> describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliasesRequest - default CompletableFuture<DescribeConnectionAliasesResponse> describeConnectionAliases(Consumer<DescribeConnectionAliasesRequest.Builder> describeConnectionAliasesRequest)
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
This is a convenience which creates an instance of the DescribeConnectionAliasesRequest.Builder avoiding
the need to create one manually via DescribeConnectionAliasesRequest.builder()
describeConnectionAliasesRequest - A Consumer that will call methods on DescribeConnectionAliasesRequest.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 WorkSpaces resource.
describeTagsRequest - default CompletableFuture<DescribeTagsResponse> describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags for the specified WorkSpaces resource.
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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectoriesRequest - default CompletableFuture<DescribeWorkspaceDirectoriesResponse> describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest)
Describes the available 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 directories that are registered with Amazon WorkSpaces.
default DescribeWorkspaceDirectoriesPublisher describeWorkspaceDirectoriesPaginator()
Describes the available 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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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 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.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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<DescribeWorkspaceImagePermissionsResponse> describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
describeWorkspaceImagePermissionsRequest - default CompletableFuture<DescribeWorkspaceImagePermissionsResponse> describeWorkspaceImagePermissions(Consumer<DescribeWorkspaceImagePermissionsRequest.Builder> describeWorkspaceImagePermissionsRequest)
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
This is a convenience which creates an instance of the DescribeWorkspaceImagePermissionsRequest.Builder
avoiding the need to create one manually via DescribeWorkspaceImagePermissionsRequest.builder()
describeWorkspaceImagePermissionsRequest - A Consumer that will call methods on DescribeWorkspaceImagePermissionsRequest.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<DescribeWorkspaceSnapshotsResponse> describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
describeWorkspaceSnapshotsRequest - default CompletableFuture<DescribeWorkspaceSnapshotsResponse> describeWorkspaceSnapshots(Consumer<DescribeWorkspaceSnapshotsRequest.Builder> describeWorkspaceSnapshotsRequest)
Describes the snapshots for the specified WorkSpace.
This is a convenience which creates an instance of the DescribeWorkspaceSnapshotsRequest.Builder avoiding
the need to create one manually via DescribeWorkspaceSnapshotsRequest.builder()
describeWorkspaceSnapshotsRequest - A Consumer that will call methods on DescribeWorkspaceSnapshotsRequest.Builder to create a
request.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.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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.
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
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<DisassociateConnectionAliasResponse> disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest)
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
disassociateConnectionAliasRequest - default CompletableFuture<DisassociateConnectionAliasResponse> disassociateConnectionAlias(Consumer<DisassociateConnectionAliasRequest.Builder> disassociateConnectionAliasRequest)
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
This is a convenience which creates an instance of the DisassociateConnectionAliasRequest.Builder
avoiding the need to create one manually via DisassociateConnectionAliasRequest.builder()
disassociateConnectionAliasRequest - A Consumer that will call methods on DisassociateConnectionAliasRequest.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 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
importWorkspaceImageRequest - default CompletableFuture<ImportWorkspaceImageResponse> importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest)
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
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).
This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL,
you'll receive an AccessDeniedException error.
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).
This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL,
you'll receive an AccessDeniedException error.
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<MigrateWorkspaceResponse> migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
user volume from the last available snapshot of the original WorkSpace. During migration, the original
D:\Users\%USERNAME% user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
migrateWorkspaceRequest - default CompletableFuture<MigrateWorkspaceResponse> migrateWorkspace(Consumer<MigrateWorkspaceRequest.Builder> migrateWorkspaceRequest)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
user volume from the last available snapshot of the original WorkSpace. During migration, the original
D:\Users\%USERNAME% user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
This is a convenience which creates an instance of the MigrateWorkspaceRequest.Builder avoiding the need
to create one manually via MigrateWorkspaceRequest.builder()
migrateWorkspaceRequest - A Consumer that will call methods on MigrateWorkspaceRequest.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 clients.
modifyClientPropertiesRequest - default CompletableFuture<ModifyClientPropertiesResponse> modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest)
Modifies the properties of the specified Amazon WorkSpaces clients.
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<ModifySelfservicePermissionsResponse> modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
modifySelfservicePermissionsRequest - default CompletableFuture<ModifySelfservicePermissionsResponse> modifySelfservicePermissions(Consumer<ModifySelfservicePermissionsRequest.Builder> modifySelfservicePermissionsRequest)
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
This is a convenience which creates an instance of the ModifySelfservicePermissionsRequest.Builder
avoiding the need to create one manually via ModifySelfservicePermissionsRequest.builder()
modifySelfservicePermissionsRequest - A Consumer that will call methods on ModifySelfservicePermissionsRequest.Builder to create
a request.default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
modifyWorkspaceAccessPropertiesRequest - default CompletableFuture<ModifyWorkspaceAccessPropertiesResponse> modifyWorkspaceAccessProperties(Consumer<ModifyWorkspaceAccessPropertiesRequest.Builder> modifyWorkspaceAccessPropertiesRequest)
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
This is a convenience which creates an instance of the ModifyWorkspaceAccessPropertiesRequest.Builder
avoiding the need to create one manually via ModifyWorkspaceAccessPropertiesRequest.builder()
modifyWorkspaceAccessPropertiesRequest - A Consumer that will call methods on ModifyWorkspaceAccessPropertiesRequest.Builder to
create a request.default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
modifyWorkspaceCreationPropertiesRequest - default CompletableFuture<ModifyWorkspaceCreationPropertiesResponse> modifyWorkspaceCreationProperties(Consumer<ModifyWorkspaceCreationPropertiesRequest.Builder> modifyWorkspaceCreationPropertiesRequest)
Modify the default properties used to create WorkSpaces.
This is a convenience which creates an instance of the ModifyWorkspaceCreationPropertiesRequest.Builder
avoiding the need to create one manually via ModifyWorkspaceCreationPropertiesRequest.builder()
modifyWorkspaceCreationPropertiesRequest - A Consumer that will call methods on ModifyWorkspaceCreationPropertiesRequest.Builder to
create a request.default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
modifyWorkspacePropertiesRequest - default CompletableFuture<ModifyWorkspacePropertiesResponse> modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest)
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
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, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot 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, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot 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,
UNHEALTHY, STOPPED, or REBOOTING.
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,
UNHEALTHY, STOPPED, or REBOOTING.
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<RegisterWorkspaceDirectoryResponse> registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest)
Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
registerWorkspaceDirectoryRequest - default CompletableFuture<RegisterWorkspaceDirectoryResponse> registerWorkspaceDirectory(Consumer<RegisterWorkspaceDirectoryRequest.Builder> registerWorkspaceDirectoryRequest)
Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
This is a convenience which creates an instance of the RegisterWorkspaceDirectoryRequest.Builder avoiding
the need to create one manually via RegisterWorkspaceDirectoryRequest.builder()
registerWorkspaceDirectoryRequest - A Consumer that will call methods on RegisterWorkspaceDirectoryRequest.Builder to create a
request.default CompletableFuture<RestoreWorkspaceResponse> restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest)
Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
restoreWorkspaceRequest - default CompletableFuture<RestoreWorkspaceResponse> restoreWorkspace(Consumer<RestoreWorkspaceRequest.Builder> restoreWorkspaceRequest)
Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
This is a convenience which creates an instance of the RestoreWorkspaceRequest.Builder avoiding the need
to create one manually via RestoreWorkspaceRequest.builder()
restoreWorkspaceRequest - A Consumer that will call methods on RestoreWorkspaceRequest.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 AWS Support 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. After a
WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using DescribeWorkSpaces. If
the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
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 AWS Support 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. After a
WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated,
check for the WorkSpace ID by using DescribeWorkSpaces. If
the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the AWS Directory Services pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
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<UpdateConnectionAliasPermissionResponse> updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest)
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
updateConnectionAliasPermissionRequest - default CompletableFuture<UpdateConnectionAliasPermissionResponse> updateConnectionAliasPermission(Consumer<UpdateConnectionAliasPermissionRequest.Builder> updateConnectionAliasPermissionRequest)
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call
DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED
.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
This is a convenience which creates an instance of the UpdateConnectionAliasPermissionRequest.Builder
avoiding the need to create one manually via UpdateConnectionAliasPermissionRequest.builder()
updateConnectionAliasPermissionRequest - A Consumer that will call methods on UpdateConnectionAliasPermissionRequest.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.default CompletableFuture<UpdateWorkspaceBundleResponse> updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest)
Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
updateWorkspaceBundleRequest - default CompletableFuture<UpdateWorkspaceBundleResponse> updateWorkspaceBundle(Consumer<UpdateWorkspaceBundleRequest.Builder> updateWorkspaceBundleRequest)
Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
This is a convenience which creates an instance of the UpdateWorkspaceBundleRequest.Builder avoiding the
need to create one manually via UpdateWorkspaceBundleRequest.builder()
updateWorkspaceBundleRequest - A Consumer that will call methods on UpdateWorkspaceBundleRequest.Builder to create a
request.default CompletableFuture<UpdateWorkspaceImagePermissionResponse> updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest)
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
updateWorkspaceImagePermissionRequest - default CompletableFuture<UpdateWorkspaceImagePermissionResponse> updateWorkspaceImagePermission(Consumer<UpdateWorkspaceImagePermissionRequest.Builder> updateWorkspaceImagePermissionRequest)
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
This is a convenience which creates an instance of the UpdateWorkspaceImagePermissionRequest.Builder
avoiding the need to create one manually via UpdateWorkspaceImagePermissionRequest.builder()
updateWorkspaceImagePermissionRequest - A Consumer that will call methods on UpdateWorkspaceImagePermissionRequest.Builder to
create a request.