Interface WorkSpacesClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateConnectionAliasResponse
associateConnectionAlias
(Consumer<AssociateConnectionAliasRequest.Builder> associateConnectionAliasRequest) Associates the specified connection alias with the specified directory to enable cross-Region redirection.default AssociateConnectionAliasResponse
associateConnectionAlias
(AssociateConnectionAliasRequest associateConnectionAliasRequest) Associates the specified connection alias with the specified directory to enable cross-Region redirection.default AssociateIpGroupsResponse
associateIpGroups
(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest) Associates the specified IP access control group with the specified directory.default AssociateIpGroupsResponse
associateIpGroups
(AssociateIpGroupsRequest associateIpGroupsRequest) Associates the specified IP access control group with the specified directory.associateWorkspaceApplication
(Consumer<AssociateWorkspaceApplicationRequest.Builder> associateWorkspaceApplicationRequest) Associates the specified application to the specified WorkSpace.associateWorkspaceApplication
(AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest) Associates the specified application to the specified WorkSpace.default AuthorizeIpRulesResponse
authorizeIpRules
(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest) Adds one or more rules to the specified IP access control group.default AuthorizeIpRulesResponse
authorizeIpRules
(AuthorizeIpRulesRequest authorizeIpRulesRequest) Adds one or more rules to the specified IP access control group.static WorkSpacesClientBuilder
builder()
Create a builder that can be used to configure and create aWorkSpacesClient
.default CopyWorkspaceImageResponse
copyWorkspaceImage
(Consumer<CopyWorkspaceImageRequest.Builder> copyWorkspaceImageRequest) Copies the specified image from the specified Region to the current Region.default CopyWorkspaceImageResponse
copyWorkspaceImage
(CopyWorkspaceImageRequest copyWorkspaceImageRequest) Copies the specified image from the specified Region to the current Region.static WorkSpacesClient
create()
Create aWorkSpacesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateConnectClientAddInResponse
createConnectClientAddIn
(Consumer<CreateConnectClientAddInRequest.Builder> createConnectClientAddInRequest) Creates a client-add-in for Amazon Connect within a directory.default CreateConnectClientAddInResponse
createConnectClientAddIn
(CreateConnectClientAddInRequest createConnectClientAddInRequest) Creates a client-add-in for Amazon Connect within a directory.default CreateConnectionAliasResponse
createConnectionAlias
(Consumer<CreateConnectionAliasRequest.Builder> createConnectionAliasRequest) Creates the specified connection alias for use with cross-Region redirection.default CreateConnectionAliasResponse
createConnectionAlias
(CreateConnectionAliasRequest createConnectionAliasRequest) Creates the specified connection alias for use with cross-Region redirection.default CreateIpGroupResponse
createIpGroup
(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest) Creates an IP access control group.default CreateIpGroupResponse
createIpGroup
(CreateIpGroupRequest createIpGroupRequest) Creates an IP access control group.default CreateStandbyWorkspacesResponse
createStandbyWorkspaces
(Consumer<CreateStandbyWorkspacesRequest.Builder> createStandbyWorkspacesRequest) Creates a standby WorkSpace in a secondary Region.default CreateStandbyWorkspacesResponse
createStandbyWorkspaces
(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest) Creates a standby WorkSpace in a secondary Region.default CreateTagsResponse
createTags
(Consumer<CreateTagsRequest.Builder> createTagsRequest) Creates the specified tags for the specified WorkSpaces resource.default CreateTagsResponse
createTags
(CreateTagsRequest createTagsRequest) Creates the specified tags for the specified WorkSpaces resource.createUpdatedWorkspaceImage
(Consumer<CreateUpdatedWorkspaceImageRequest.Builder> createUpdatedWorkspaceImageRequest) Creates a new updated WorkSpace image based on the specified source image.createUpdatedWorkspaceImage
(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest) Creates a new updated WorkSpace image based on the specified source image.default CreateWorkspaceBundleResponse
createWorkspaceBundle
(Consumer<CreateWorkspaceBundleRequest.Builder> createWorkspaceBundleRequest) Creates the specified WorkSpace bundle.default CreateWorkspaceBundleResponse
createWorkspaceBundle
(CreateWorkspaceBundleRequest createWorkspaceBundleRequest) Creates the specified WorkSpace bundle.default CreateWorkspaceImageResponse
createWorkspaceImage
(Consumer<CreateWorkspaceImageRequest.Builder> createWorkspaceImageRequest) Creates a new WorkSpace image from an existing WorkSpace.default CreateWorkspaceImageResponse
createWorkspaceImage
(CreateWorkspaceImageRequest createWorkspaceImageRequest) Creates a new WorkSpace image from an existing WorkSpace.default CreateWorkspacesResponse
createWorkspaces
(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest) Creates one or more WorkSpaces.default CreateWorkspacesResponse
createWorkspaces
(CreateWorkspacesRequest createWorkspacesRequest) Creates one or more WorkSpaces.default DeleteClientBrandingResponse
deleteClientBranding
(Consumer<DeleteClientBrandingRequest.Builder> deleteClientBrandingRequest) Deletes customized client branding.default DeleteClientBrandingResponse
deleteClientBranding
(DeleteClientBrandingRequest deleteClientBrandingRequest) Deletes customized client branding.default DeleteConnectClientAddInResponse
deleteConnectClientAddIn
(Consumer<DeleteConnectClientAddInRequest.Builder> deleteConnectClientAddInRequest) Deletes a client-add-in for Amazon Connect that is configured within a directory.default DeleteConnectClientAddInResponse
deleteConnectClientAddIn
(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest) Deletes a client-add-in for Amazon Connect that is configured within a directory.default DeleteConnectionAliasResponse
deleteConnectionAlias
(Consumer<DeleteConnectionAliasRequest.Builder> deleteConnectionAliasRequest) Deletes the specified connection alias.default DeleteConnectionAliasResponse
deleteConnectionAlias
(DeleteConnectionAliasRequest deleteConnectionAliasRequest) Deletes the specified connection alias.default DeleteIpGroupResponse
deleteIpGroup
(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest) Deletes the specified IP access control group.default DeleteIpGroupResponse
deleteIpGroup
(DeleteIpGroupRequest deleteIpGroupRequest) Deletes the specified IP access control group.default DeleteTagsResponse
deleteTags
(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) Deletes the specified tags from the specified WorkSpaces resource.default DeleteTagsResponse
deleteTags
(DeleteTagsRequest deleteTagsRequest) Deletes the specified tags from the specified WorkSpaces resource.default DeleteWorkspaceBundleResponse
deleteWorkspaceBundle
(Consumer<DeleteWorkspaceBundleRequest.Builder> deleteWorkspaceBundleRequest) Deletes the specified WorkSpace bundle.default DeleteWorkspaceBundleResponse
deleteWorkspaceBundle
(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest) Deletes the specified WorkSpace bundle.default DeleteWorkspaceImageResponse
deleteWorkspaceImage
(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest) Deletes the specified image from your account.default DeleteWorkspaceImageResponse
deleteWorkspaceImage
(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest) Deletes the specified image from your account.deployWorkspaceApplications
(Consumer<DeployWorkspaceApplicationsRequest.Builder> deployWorkspaceApplicationsRequest) Deploys associated applications to the specified WorkSpacedeployWorkspaceApplications
(DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest) Deploys associated applications to the specified WorkSpacederegisterWorkspaceDirectory
(Consumer<DeregisterWorkspaceDirectoryRequest.Builder> deregisterWorkspaceDirectoryRequest) Deregisters the specified directory.deregisterWorkspaceDirectory
(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest) Deregisters the specified directory.default DescribeAccountResponse
describeAccount
(Consumer<DescribeAccountRequest.Builder> describeAccountRequest) Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.default DescribeAccountResponse
describeAccount
(DescribeAccountRequest describeAccountRequest) Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.describeAccountModifications
(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest) Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.describeAccountModifications
(DescribeAccountModificationsRequest describeAccountModificationsRequest) Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.describeApplicationAssociations
(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest) Describes the associations between the application and the specified associated resources.describeApplicationAssociations
(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest) Describes the associations between the application and the specified associated resources.describeApplicationAssociationsPaginator
(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest) This is a variant ofdescribeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation.describeApplicationAssociationsPaginator
(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest) This is a variant ofdescribeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation.default DescribeApplicationsResponse
describeApplications
(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.default DescribeApplicationsResponse
describeApplications
(DescribeApplicationsRequest describeApplicationsRequest) Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.default DescribeApplicationsIterable
describeApplicationsPaginator
(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) This is a variant ofdescribeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation.default DescribeApplicationsIterable
describeApplicationsPaginator
(DescribeApplicationsRequest describeApplicationsRequest) This is a variant ofdescribeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation.describeBundleAssociations
(Consumer<DescribeBundleAssociationsRequest.Builder> describeBundleAssociationsRequest) Describes the associations between the applications and the specified bundle.describeBundleAssociations
(DescribeBundleAssociationsRequest describeBundleAssociationsRequest) Describes the associations between the applications and the specified bundle.default DescribeClientBrandingResponse
describeClientBranding
(Consumer<DescribeClientBrandingRequest.Builder> describeClientBrandingRequest) Describes the specified client branding.default DescribeClientBrandingResponse
describeClientBranding
(DescribeClientBrandingRequest describeClientBrandingRequest) Describes the specified client branding.default DescribeClientPropertiesResponse
describeClientProperties
(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest) Retrieves a list that describes one or more specified Amazon WorkSpaces clients.default DescribeClientPropertiesResponse
describeClientProperties
(DescribeClientPropertiesRequest describeClientPropertiesRequest) Retrieves a list that describes one or more specified Amazon WorkSpaces clients.describeConnectClientAddIns
(Consumer<DescribeConnectClientAddInsRequest.Builder> describeConnectClientAddInsRequest) Retrieves a list of Amazon Connect client add-ins that have been created.describeConnectClientAddIns
(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest) Retrieves a list of Amazon Connect client add-ins that have been created.describeConnectionAliases
(Consumer<DescribeConnectionAliasesRequest.Builder> describeConnectionAliasesRequest) Retrieves a list that describes the connection aliases used for cross-Region redirection.describeConnectionAliases
(DescribeConnectionAliasesRequest describeConnectionAliasesRequest) Retrieves a list that describes the connection aliases used for cross-Region redirection.describeConnectionAliasPermissions
(Consumer<DescribeConnectionAliasPermissionsRequest.Builder> describeConnectionAliasPermissionsRequest) Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.describeConnectionAliasPermissions
(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest) Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.describeImageAssociations
(Consumer<DescribeImageAssociationsRequest.Builder> describeImageAssociationsRequest) Describes the associations between the applications and the specified image.describeImageAssociations
(DescribeImageAssociationsRequest describeImageAssociationsRequest) Describes the associations between the applications and the specified image.default DescribeIpGroupsResponse
Describes one or more of your IP access control groups.default DescribeIpGroupsResponse
describeIpGroups
(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest) Describes one or more of your IP access control groups.default DescribeIpGroupsResponse
describeIpGroups
(DescribeIpGroupsRequest describeIpGroupsRequest) Describes one or more of your IP access control groups.default DescribeTagsResponse
describeTags
(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) Describes the specified tags for the specified WorkSpaces resource.default DescribeTagsResponse
describeTags
(DescribeTagsRequest describeTagsRequest) Describes the specified tags for the specified WorkSpaces resource.describeWorkspaceAssociations
(Consumer<DescribeWorkspaceAssociationsRequest.Builder> describeWorkspaceAssociationsRequest) Describes the associations betweens applications and the specified WorkSpace.describeWorkspaceAssociations
(DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest) Describes the associations betweens applications and the specified WorkSpace.default DescribeWorkspaceBundlesResponse
Retrieves a list that describes the available WorkSpace bundles.default DescribeWorkspaceBundlesResponse
describeWorkspaceBundles
(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) Retrieves a list that describes the available WorkSpace bundles.default DescribeWorkspaceBundlesResponse
describeWorkspaceBundles
(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) Retrieves a list that describes the available WorkSpace bundles.default DescribeWorkspaceBundlesIterable
This is a variant ofdescribeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.default DescribeWorkspaceBundlesIterable
describeWorkspaceBundlesPaginator
(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) This is a variant ofdescribeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.default DescribeWorkspaceBundlesIterable
describeWorkspaceBundlesPaginator
(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) This is a variant ofdescribeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation.Describes the available directories that are registered with Amazon WorkSpaces.describeWorkspaceDirectories
(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) Describes the available directories that are registered with Amazon WorkSpaces.describeWorkspaceDirectories
(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) Describes the available directories that are registered with Amazon WorkSpaces.This is a variant ofdescribeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.describeWorkspaceDirectoriesPaginator
(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) This is a variant ofdescribeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.describeWorkspaceDirectoriesPaginator
(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) This is a variant ofdescribeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation.describeWorkspaceImagePermissions
(Consumer<DescribeWorkspaceImagePermissionsRequest.Builder> describeWorkspaceImagePermissionsRequest) Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.describeWorkspaceImagePermissions
(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest) Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.default DescribeWorkspaceImagesResponse
Retrieves a list that describes one or more specified images, if the image identifiers are provided.default DescribeWorkspaceImagesResponse
describeWorkspaceImages
(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest) Retrieves a list that describes one or more specified images, if the image identifiers are provided.default DescribeWorkspaceImagesResponse
describeWorkspaceImages
(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest) Retrieves a list that describes one or more specified images, if the image identifiers are provided.default DescribeWorkspacesResponse
Describes the specified WorkSpaces.default DescribeWorkspacesResponse
describeWorkspaces
(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) Describes the specified WorkSpaces.default DescribeWorkspacesResponse
describeWorkspaces
(DescribeWorkspacesRequest describeWorkspacesRequest) Describes the specified WorkSpaces.Describes the connection status of the specified WorkSpaces.describeWorkspacesConnectionStatus
(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest) Describes the connection status of the specified WorkSpaces.describeWorkspacesConnectionStatus
(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) Describes the connection status of the specified WorkSpaces.describeWorkspaceSnapshots
(Consumer<DescribeWorkspaceSnapshotsRequest.Builder> describeWorkspaceSnapshotsRequest) Describes the snapshots for the specified WorkSpace.describeWorkspaceSnapshots
(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest) Describes the snapshots for the specified WorkSpace.default DescribeWorkspacesIterable
This is a variant ofdescribeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.default DescribeWorkspacesIterable
describeWorkspacesPaginator
(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) This is a variant ofdescribeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.default DescribeWorkspacesIterable
describeWorkspacesPaginator
(DescribeWorkspacesRequest describeWorkspacesRequest) This is a variant ofdescribeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation.disassociateConnectionAlias
(Consumer<DisassociateConnectionAliasRequest.Builder> disassociateConnectionAliasRequest) Disassociates a connection alias from a directory.disassociateConnectionAlias
(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest) Disassociates a connection alias from a directory.default DisassociateIpGroupsResponse
disassociateIpGroups
(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest) Disassociates the specified IP access control group from the specified directory.default DisassociateIpGroupsResponse
disassociateIpGroups
(DisassociateIpGroupsRequest disassociateIpGroupsRequest) Disassociates the specified IP access control group from the specified directory.disassociateWorkspaceApplication
(Consumer<DisassociateWorkspaceApplicationRequest.Builder> disassociateWorkspaceApplicationRequest) Disassociates the specified application from a WorkSpace.disassociateWorkspaceApplication
(DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest) Disassociates the specified application from a WorkSpace.default ImportClientBrandingResponse
importClientBranding
(Consumer<ImportClientBrandingRequest.Builder> importClientBrandingRequest) Imports client branding.default ImportClientBrandingResponse
importClientBranding
(ImportClientBrandingRequest importClientBrandingRequest) Imports client branding.default ImportWorkspaceImageResponse
importWorkspaceImage
(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest) Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.default ImportWorkspaceImageResponse
importWorkspaceImage
(ImportWorkspaceImageRequest importWorkspaceImageRequest) Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.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).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 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 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 ModifyAccountResponse
modifyAccount
(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest) Modifies the configuration of Bring Your Own License (BYOL) for the specified account.default ModifyAccountResponse
modifyAccount
(ModifyAccountRequest modifyAccountRequest) Modifies the configuration of Bring Your Own License (BYOL) for the specified account.modifyCertificateBasedAuthProperties
(Consumer<ModifyCertificateBasedAuthPropertiesRequest.Builder> modifyCertificateBasedAuthPropertiesRequest) Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.modifyCertificateBasedAuthProperties
(ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest) Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.default ModifyClientPropertiesResponse
modifyClientProperties
(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest) Modifies the properties of the specified Amazon WorkSpaces clients.default ModifyClientPropertiesResponse
modifyClientProperties
(ModifyClientPropertiesRequest modifyClientPropertiesRequest) Modifies the properties of the specified Amazon WorkSpaces clients.default ModifySamlPropertiesResponse
modifySamlProperties
(Consumer<ModifySamlPropertiesRequest.Builder> modifySamlPropertiesRequest) Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.default ModifySamlPropertiesResponse
modifySamlProperties
(ModifySamlPropertiesRequest modifySamlPropertiesRequest) Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.modifySelfservicePermissions
(Consumer<ModifySelfservicePermissionsRequest.Builder> modifySelfservicePermissionsRequest) Modifies the self-service WorkSpace management capabilities for your users.modifySelfservicePermissions
(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest) Modifies the self-service WorkSpace management capabilities for your users.modifyWorkspaceAccessProperties
(Consumer<ModifyWorkspaceAccessPropertiesRequest.Builder> modifyWorkspaceAccessPropertiesRequest) Specifies which devices and operating systems users can use to access their WorkSpaces.modifyWorkspaceAccessProperties
(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest) Specifies which devices and operating systems users can use to access their WorkSpaces.modifyWorkspaceCreationProperties
(Consumer<ModifyWorkspaceCreationPropertiesRequest.Builder> modifyWorkspaceCreationPropertiesRequest) Modify the default properties used to create WorkSpaces.modifyWorkspaceCreationProperties
(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest) Modify the default properties used to create WorkSpaces.modifyWorkspaceProperties
(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest) Modifies the specified WorkSpace properties.modifyWorkspaceProperties
(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) Modifies the specified WorkSpace properties.default ModifyWorkspaceStateResponse
modifyWorkspaceState
(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest) Sets the state of the specified WorkSpace.default ModifyWorkspaceStateResponse
modifyWorkspaceState
(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest) Sets the state of the specified WorkSpace.default RebootWorkspacesResponse
rebootWorkspaces
(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest) Reboots the specified WorkSpaces.default RebootWorkspacesResponse
rebootWorkspaces
(RebootWorkspacesRequest rebootWorkspacesRequest) Reboots the specified WorkSpaces.default RebuildWorkspacesResponse
rebuildWorkspaces
(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest) Rebuilds the specified WorkSpace.default RebuildWorkspacesResponse
rebuildWorkspaces
(RebuildWorkspacesRequest rebuildWorkspacesRequest) Rebuilds the specified WorkSpace.registerWorkspaceDirectory
(Consumer<RegisterWorkspaceDirectoryRequest.Builder> registerWorkspaceDirectoryRequest) Registers the specified directory.registerWorkspaceDirectory
(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest) Registers the specified directory.default RestoreWorkspaceResponse
restoreWorkspace
(Consumer<RestoreWorkspaceRequest.Builder> restoreWorkspaceRequest) Restores the specified WorkSpace to its last known healthy state.default RestoreWorkspaceResponse
restoreWorkspace
(RestoreWorkspaceRequest restoreWorkspaceRequest) Restores the specified WorkSpace to its last known healthy state.default RevokeIpRulesResponse
revokeIpRules
(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest) Removes one or more rules from the specified IP access control group.default RevokeIpRulesResponse
revokeIpRules
(RevokeIpRulesRequest revokeIpRulesRequest) Removes one or more rules from the specified IP access control group.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartWorkspacesResponse
startWorkspaces
(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest) Starts the specified WorkSpaces.default StartWorkspacesResponse
startWorkspaces
(StartWorkspacesRequest startWorkspacesRequest) Starts the specified WorkSpaces.default StopWorkspacesResponse
stopWorkspaces
(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest) Stops the specified WorkSpaces.default StopWorkspacesResponse
stopWorkspaces
(StopWorkspacesRequest stopWorkspacesRequest) Stops the specified WorkSpaces.default TerminateWorkspacesResponse
terminateWorkspaces
(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest) Terminates the specified WorkSpaces.default TerminateWorkspacesResponse
terminateWorkspaces
(TerminateWorkspacesRequest terminateWorkspacesRequest) Terminates the specified WorkSpaces.default UpdateConnectClientAddInResponse
updateConnectClientAddIn
(Consumer<UpdateConnectClientAddInRequest.Builder> updateConnectClientAddInRequest) Updates a Amazon Connect client add-in.default UpdateConnectClientAddInResponse
updateConnectClientAddIn
(UpdateConnectClientAddInRequest updateConnectClientAddInRequest) Updates a Amazon Connect client add-in.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.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 UpdateRulesOfIpGroupResponse
updateRulesOfIpGroup
(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest) Replaces the current rules of the specified IP access control group with the specified rules.default UpdateRulesOfIpGroupResponse
updateRulesOfIpGroup
(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest) Replaces the current rules of the specified IP access control group with the specified rules.default UpdateWorkspaceBundleResponse
updateWorkspaceBundle
(Consumer<UpdateWorkspaceBundleRequest.Builder> updateWorkspaceBundleRequest) Updates a WorkSpace bundle with a new image.default UpdateWorkspaceBundleResponse
updateWorkspaceBundle
(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest) Updates a WorkSpace bundle with a new image.updateWorkspaceImagePermission
(Consumer<UpdateWorkspaceImagePermissionRequest.Builder> updateWorkspaceImagePermissionRequest) Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image.updateWorkspaceImagePermission
(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest) Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateConnectionAlias
default AssociateConnectionAliasResponse associateConnectionAlias(AssociateConnectionAliasRequest associateConnectionAliasRequest) throws ResourceAssociatedException, AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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
.- Parameters:
associateConnectionAliasRequest
-- Returns:
- Result of the AssociateConnectionAlias operation returned by the service.
- See Also:
-
associateConnectionAlias
default AssociateConnectionAliasResponse associateConnectionAlias(Consumer<AssociateConnectionAliasRequest.Builder> associateConnectionAliasRequest) throws ResourceAssociatedException, AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaAssociateConnectionAliasRequest.builder()
- Parameters:
associateConnectionAliasRequest
- AConsumer
that will call methods onAssociateConnectionAliasRequest.Builder
to create a request.- Returns:
- Result of the AssociateConnectionAlias operation returned by the service.
- See Also:
-
associateIpGroups
default AssociateIpGroupsResponse associateIpGroups(AssociateIpGroupsRequest associateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Associates the specified IP access control group with the specified directory.
- Parameters:
associateIpGroupsRequest
-- Returns:
- Result of the AssociateIpGroups operation returned by the service.
- See Also:
-
associateIpGroups
default AssociateIpGroupsResponse associateIpGroups(Consumer<AssociateIpGroupsRequest.Builder> associateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaAssociateIpGroupsRequest.builder()
- Parameters:
associateIpGroupsRequest
- AConsumer
that will call methods onAssociateIpGroupsRequest.Builder
to create a request.- Returns:
- Result of the AssociateIpGroups operation returned by the service.
- See Also:
-
associateWorkspaceApplication
default AssociateWorkspaceApplicationResponse associateWorkspaceApplication(AssociateWorkspaceApplicationRequest associateWorkspaceApplicationRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceAlreadyExistsException, ResourceInUseException, ResourceNotFoundException, ComputeNotCompatibleException, OperatingSystemNotCompatibleException, ApplicationNotSupportedException, IncompatibleApplicationsException, AwsServiceException, SdkClientException, WorkSpacesException Associates the specified application to the specified WorkSpace.
- Parameters:
associateWorkspaceApplicationRequest
-- Returns:
- Result of the AssociateWorkspaceApplication operation returned by the service.
- See Also:
-
associateWorkspaceApplication
default AssociateWorkspaceApplicationResponse associateWorkspaceApplication(Consumer<AssociateWorkspaceApplicationRequest.Builder> associateWorkspaceApplicationRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceAlreadyExistsException, ResourceInUseException, ResourceNotFoundException, ComputeNotCompatibleException, OperatingSystemNotCompatibleException, ApplicationNotSupportedException, IncompatibleApplicationsException, AwsServiceException, SdkClientException, WorkSpacesException Associates the specified application to the specified WorkSpace.
This is a convenience which creates an instance of the
AssociateWorkspaceApplicationRequest.Builder
avoiding the need to create one manually viaAssociateWorkspaceApplicationRequest.builder()
- Parameters:
associateWorkspaceApplicationRequest
- AConsumer
that will call methods onAssociateWorkspaceApplicationRequest.Builder
to create a request.- Returns:
- Result of the AssociateWorkspaceApplication operation returned by the service.
- See Also:
-
authorizeIpRules
default AuthorizeIpRulesResponse authorizeIpRules(AuthorizeIpRulesRequest authorizeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
authorizeIpRulesRequest
-- Returns:
- Result of the AuthorizeIpRules operation returned by the service.
- See Also:
-
authorizeIpRules
default AuthorizeIpRulesResponse authorizeIpRules(Consumer<AuthorizeIpRulesRequest.Builder> authorizeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaAuthorizeIpRulesRequest.builder()
- Parameters:
authorizeIpRulesRequest
- AConsumer
that will call methods onAuthorizeIpRulesRequest.Builder
to create a request.- Returns:
- Result of the AuthorizeIpRules operation returned by the service.
- See Also:
-
copyWorkspaceImage
default CopyWorkspaceImageResponse copyWorkspaceImage(CopyWorkspaceImageRequest copyWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceUnavailableException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
- Parameters:
copyWorkspaceImageRequest
-- Returns:
- Result of the CopyWorkspaceImage operation returned by the service.
- See Also:
-
copyWorkspaceImage
default CopyWorkspaceImageResponse copyWorkspaceImage(Consumer<CopyWorkspaceImageRequest.Builder> copyWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, ResourceUnavailableException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account 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 viaCopyWorkspaceImageRequest.builder()
- Parameters:
copyWorkspaceImageRequest
- AConsumer
that will call methods onCopyWorkspaceImageRequest.Builder
to create a request.- Returns:
- Result of the CopyWorkspaceImage operation returned by the service.
- See Also:
-
createConnectClientAddIn
default CreateConnectClientAddInResponse createConnectClientAddIn(CreateConnectClientAddInRequest createConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceCreationFailedException, ResourceAlreadyExistsException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
- Parameters:
createConnectClientAddInRequest
-- Returns:
- Result of the CreateConnectClientAddIn operation returned by the service.
- See Also:
-
createConnectClientAddIn
default CreateConnectClientAddInResponse createConnectClientAddIn(Consumer<CreateConnectClientAddInRequest.Builder> createConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceCreationFailedException, ResourceAlreadyExistsException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
This is a convenience which creates an instance of the
CreateConnectClientAddInRequest.Builder
avoiding the need to create one manually viaCreateConnectClientAddInRequest.builder()
- Parameters:
createConnectClientAddInRequest
- AConsumer
that will call methods onCreateConnectClientAddInRequest.Builder
to create a request.- Returns:
- Result of the CreateConnectClientAddIn operation returned by the service.
- See Also:
-
createConnectionAlias
default CreateConnectionAliasResponse createConnectionAlias(CreateConnectionAliasRequest createConnectionAliasRequest) throws ResourceAlreadyExistsException, AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
- Parameters:
createConnectionAliasRequest
-- Returns:
- Result of the CreateConnectionAlias operation returned by the service.
- See Also:
-
createConnectionAlias
default CreateConnectionAliasResponse createConnectionAlias(Consumer<CreateConnectionAliasRequest.Builder> createConnectionAliasRequest) throws ResourceAlreadyExistsException, AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaCreateConnectionAliasRequest.builder()
- Parameters:
createConnectionAliasRequest
- AConsumer
that will call methods onCreateConnectionAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateConnectionAlias operation returned by the service.
- See Also:
-
createIpGroup
default CreateIpGroupResponse createIpGroup(CreateIpGroupRequest createIpGroupRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
createIpGroupRequest
-- Returns:
- Result of the CreateIpGroup operation returned by the service.
- See Also:
-
createIpGroup
default CreateIpGroupResponse createIpGroup(Consumer<CreateIpGroupRequest.Builder> createIpGroupRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceCreationFailedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaCreateIpGroupRequest.builder()
- Parameters:
createIpGroupRequest
- AConsumer
that will call methods onCreateIpGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateIpGroup operation returned by the service.
- See Also:
-
createStandbyWorkspaces
default CreateStandbyWorkspacesResponse createStandbyWorkspaces(CreateStandbyWorkspacesRequest createStandbyWorkspacesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException Creates a standby WorkSpace in a secondary Region.
- Parameters:
createStandbyWorkspacesRequest
-- Returns:
- Result of the CreateStandbyWorkspaces operation returned by the service.
- See Also:
-
createStandbyWorkspaces
default CreateStandbyWorkspacesResponse createStandbyWorkspaces(Consumer<CreateStandbyWorkspacesRequest.Builder> createStandbyWorkspacesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException Creates a standby WorkSpace in a secondary Region.
This is a convenience which creates an instance of the
CreateStandbyWorkspacesRequest.Builder
avoiding the need to create one manually viaCreateStandbyWorkspacesRequest.builder()
- Parameters:
createStandbyWorkspacesRequest
- AConsumer
that will call methods onCreateStandbyWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the CreateStandbyWorkspaces operation returned by the service.
- See Also:
-
createTags
default CreateTagsResponse createTags(CreateTagsRequest createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException Creates the specified tags for the specified WorkSpaces resource.
- Parameters:
createTagsRequest
-- Returns:
- Result of the CreateTags operation returned by the service.
- See Also:
-
createTags
default CreateTagsResponse createTags(Consumer<CreateTagsRequest.Builder> createTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, ResourceLimitExceededException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaCreateTagsRequest.builder()
- Parameters:
createTagsRequest
- AConsumer
that will call methods onCreateTagsRequest.Builder
to create a request.- Returns:
- Result of the CreateTags operation returned by the service.
- See Also:
-
createUpdatedWorkspaceImage
default CreateUpdatedWorkspaceImageResponse createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest createUpdatedWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
-
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
-
Microsoft Windows updates and other application updates are not included in the update process.
-
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
- Parameters:
createUpdatedWorkspaceImageRequest
-- Returns:
- Result of the CreateUpdatedWorkspaceImage operation returned by the service.
- See Also:
-
-
createUpdatedWorkspaceImage
default CreateUpdatedWorkspaceImageResponse createUpdatedWorkspaceImage(Consumer<CreateUpdatedWorkspaceImageRequest.Builder> createUpdatedWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
-
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
-
Microsoft Windows updates and other application updates are not included in the update process.
-
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
This is a convenience which creates an instance of the
CreateUpdatedWorkspaceImageRequest.Builder
avoiding the need to create one manually viaCreateUpdatedWorkspaceImageRequest.builder()
- Parameters:
createUpdatedWorkspaceImageRequest
- AConsumer
that will call methods onCreateUpdatedWorkspaceImageRequest.Builder
to create a request.- Returns:
- Result of the CreateUpdatedWorkspaceImage operation returned by the service.
- See Also:
-
-
createWorkspaceBundle
default CreateWorkspaceBundleResponse createWorkspaceBundle(CreateWorkspaceBundleRequest createWorkspaceBundleRequest) throws ResourceUnavailableException, ResourceAlreadyExistsException, ResourceLimitExceededException, InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
- Parameters:
createWorkspaceBundleRequest
-- Returns:
- Result of the CreateWorkspaceBundle operation returned by the service.
- See Also:
-
createWorkspaceBundle
default CreateWorkspaceBundleResponse createWorkspaceBundle(Consumer<CreateWorkspaceBundleRequest.Builder> createWorkspaceBundleRequest) throws ResourceUnavailableException, ResourceAlreadyExistsException, ResourceLimitExceededException, InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaCreateWorkspaceBundleRequest.builder()
- Parameters:
createWorkspaceBundleRequest
- AConsumer
that will call methods onCreateWorkspaceBundleRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkspaceBundle operation returned by the service.
- See Also:
-
createWorkspaceImage
default CreateWorkspaceImageResponse createWorkspaceImage(CreateWorkspaceImageRequest createWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates a new WorkSpace image from an existing WorkSpace.
- Parameters:
createWorkspaceImageRequest
-- Returns:
- Result of the CreateWorkspaceImage operation returned by the service.
- See Also:
-
createWorkspaceImage
default CreateWorkspaceImageResponse createWorkspaceImage(Consumer<CreateWorkspaceImageRequest.Builder> createWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, InvalidResourceStateException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates a new WorkSpace image from an existing WorkSpace.
This is a convenience which creates an instance of the
CreateWorkspaceImageRequest.Builder
avoiding the need to create one manually viaCreateWorkspaceImageRequest.builder()
- Parameters:
createWorkspaceImageRequest
- AConsumer
that will call methods onCreateWorkspaceImageRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkspaceImage operation returned by the service.
- See Also:
-
createWorkspaces
default CreateWorkspacesResponse createWorkspaces(CreateWorkspacesRequest createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
-
The
MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. -
You don't need to specify the
PCOIP
protocol for Linux bundles becauseWSP
is the default protocol for those bundles. -
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
- Parameters:
createWorkspacesRequest
-- Returns:
- Result of the CreateWorkspaces operation returned by the service.
- See Also:
-
-
createWorkspaces
default CreateWorkspacesResponse createWorkspaces(Consumer<CreateWorkspacesRequest.Builder> createWorkspacesRequest) throws ResourceLimitExceededException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
-
The
MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core. -
You don't need to specify the
PCOIP
protocol for Linux bundles becauseWSP
is the default protocol for those bundles. -
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
This is a convenience which creates an instance of the
CreateWorkspacesRequest.Builder
avoiding the need to create one manually viaCreateWorkspacesRequest.builder()
- Parameters:
createWorkspacesRequest
- AConsumer
that will call methods onCreateWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the CreateWorkspaces operation returned by the service.
- See Also:
-
-
deleteClientBranding
default DeleteClientBrandingResponse deleteClientBranding(DeleteClientBrandingRequest deleteClientBrandingRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
- Parameters:
deleteClientBrandingRequest
-- Returns:
- Result of the DeleteClientBranding operation returned by the service.
- See Also:
-
deleteClientBranding
default DeleteClientBrandingResponse deleteClientBranding(Consumer<DeleteClientBrandingRequest.Builder> deleteClientBrandingRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
This is a convenience which creates an instance of the
DeleteClientBrandingRequest.Builder
avoiding the need to create one manually viaDeleteClientBrandingRequest.builder()
- Parameters:
deleteClientBrandingRequest
- AConsumer
that will call methods onDeleteClientBrandingRequest.Builder
to create a request.- Returns:
- Result of the DeleteClientBranding operation returned by the service.
- See Also:
-
deleteConnectClientAddIn
default DeleteConnectClientAddInResponse deleteConnectClientAddIn(DeleteConnectClientAddInRequest deleteConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes a client-add-in for Amazon Connect that is configured within a directory.
- Parameters:
deleteConnectClientAddInRequest
-- Returns:
- Result of the DeleteConnectClientAddIn operation returned by the service.
- See Also:
-
deleteConnectClientAddIn
default DeleteConnectClientAddInResponse deleteConnectClientAddIn(Consumer<DeleteConnectClientAddInRequest.Builder> deleteConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes a client-add-in for Amazon Connect that is configured within a directory.
This is a convenience which creates an instance of the
DeleteConnectClientAddInRequest.Builder
avoiding the need to create one manually viaDeleteConnectClientAddInRequest.builder()
- Parameters:
deleteConnectClientAddInRequest
- AConsumer
that will call methods onDeleteConnectClientAddInRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnectClientAddIn operation returned by the service.
- See Also:
-
deleteConnectionAlias
default DeleteConnectionAliasResponse deleteConnectionAlias(DeleteConnectionAliasRequest deleteConnectionAliasRequest) throws ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
deleteConnectionAliasRequest
-- Returns:
- Result of the DeleteConnectionAlias operation returned by the service.
- See Also:
-
deleteConnectionAlias
default DeleteConnectionAliasResponse deleteConnectionAlias(Consumer<DeleteConnectionAliasRequest.Builder> deleteConnectionAliasRequest) throws ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDeleteConnectionAliasRequest.builder()
- Parameters:
deleteConnectionAliasRequest
- AConsumer
that will call methods onDeleteConnectionAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnectionAlias operation returned by the service.
- See Also:
-
deleteIpGroup
default DeleteIpGroupResponse deleteIpGroup(DeleteIpGroupRequest deleteIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
- Parameters:
deleteIpGroupRequest
-- Returns:
- Result of the DeleteIpGroup operation returned by the service.
- See Also:
-
deleteIpGroup
default DeleteIpGroupResponse deleteIpGroup(Consumer<DeleteIpGroupRequest.Builder> deleteIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDeleteIpGroupRequest.builder()
- Parameters:
deleteIpGroupRequest
- AConsumer
that will call methods onDeleteIpGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteIpGroup operation returned by the service.
- See Also:
-
deleteTags
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Deletes the specified tags from the specified WorkSpaces resource.
- Parameters:
deleteTagsRequest
-- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteTags
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceNotFoundException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDeleteTagsRequest.builder()
- Parameters:
deleteTagsRequest
- AConsumer
that will call methods onDeleteTagsRequest.Builder
to create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
- See Also:
-
deleteWorkspaceBundle
default DeleteWorkspaceBundleResponse deleteWorkspaceBundle(DeleteWorkspaceBundleRequest deleteWorkspaceBundleRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
- Parameters:
deleteWorkspaceBundleRequest
-- Returns:
- Result of the DeleteWorkspaceBundle operation returned by the service.
- See Also:
-
deleteWorkspaceBundle
default DeleteWorkspaceBundleResponse deleteWorkspaceBundle(Consumer<DeleteWorkspaceBundleRequest.Builder> deleteWorkspaceBundleRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceAssociatedException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDeleteWorkspaceBundleRequest.builder()
- Parameters:
deleteWorkspaceBundleRequest
- AConsumer
that will call methods onDeleteWorkspaceBundleRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkspaceBundle operation returned by the service.
- See Also:
-
deleteWorkspaceImage
default DeleteWorkspaceImageResponse deleteWorkspaceImage(DeleteWorkspaceImageRequest deleteWorkspaceImageRequest) throws ResourceAssociatedException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
deleteWorkspaceImageRequest
-- Returns:
- Result of the DeleteWorkspaceImage operation returned by the service.
- See Also:
-
deleteWorkspaceImage
default DeleteWorkspaceImageResponse deleteWorkspaceImage(Consumer<DeleteWorkspaceImageRequest.Builder> deleteWorkspaceImageRequest) throws ResourceAssociatedException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDeleteWorkspaceImageRequest.builder()
- Parameters:
deleteWorkspaceImageRequest
- AConsumer
that will call methods onDeleteWorkspaceImageRequest.Builder
to create a request.- Returns:
- Result of the DeleteWorkspaceImage operation returned by the service.
- See Also:
-
deployWorkspaceApplications
default DeployWorkspaceApplicationsResponse deployWorkspaceApplications(DeployWorkspaceApplicationsRequest deployWorkspaceApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceInUseException, ResourceNotFoundException, IncompatibleApplicationsException, AwsServiceException, SdkClientException, WorkSpacesException Deploys associated applications to the specified WorkSpace
- Parameters:
deployWorkspaceApplicationsRequest
-- Returns:
- Result of the DeployWorkspaceApplications operation returned by the service.
- See Also:
-
deployWorkspaceApplications
default DeployWorkspaceApplicationsResponse deployWorkspaceApplications(Consumer<DeployWorkspaceApplicationsRequest.Builder> deployWorkspaceApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceInUseException, ResourceNotFoundException, IncompatibleApplicationsException, AwsServiceException, SdkClientException, WorkSpacesException Deploys associated applications to the specified WorkSpace
This is a convenience which creates an instance of the
DeployWorkspaceApplicationsRequest.Builder
avoiding the need to create one manually viaDeployWorkspaceApplicationsRequest.builder()
- Parameters:
deployWorkspaceApplicationsRequest
- AConsumer
that will call methods onDeployWorkspaceApplicationsRequest.Builder
to create a request.- Returns:
- Result of the DeployWorkspaceApplications operation returned by the service.
- See Also:
-
deregisterWorkspaceDirectory
default DeregisterWorkspaceDirectoryResponse deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest deregisterWorkspaceDirectoryRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, WorkSpacesException 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 Directory Service 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.
- Parameters:
deregisterWorkspaceDirectoryRequest
-- Returns:
- Result of the DeregisterWorkspaceDirectory operation returned by the service.
- See Also:
-
deregisterWorkspaceDirectory
default DeregisterWorkspaceDirectoryResponse deregisterWorkspaceDirectory(Consumer<DeregisterWorkspaceDirectoryRequest.Builder> deregisterWorkspaceDirectoryRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, InvalidResourceStateException, AwsServiceException, SdkClientException, WorkSpacesException 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 Directory Service 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 viaDeregisterWorkspaceDirectoryRequest.builder()
- Parameters:
deregisterWorkspaceDirectoryRequest
- AConsumer
that will call methods onDeregisterWorkspaceDirectoryRequest.Builder
to create a request.- Returns:
- Result of the DeregisterWorkspaceDirectory operation returned by the service.
- See Also:
-
describeAccount
default DescribeAccountResponse describeAccount(DescribeAccountRequest describeAccountRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
- Parameters:
describeAccountRequest
-- Returns:
- Result of the DescribeAccount operation returned by the service.
- See Also:
-
describeAccount
default DescribeAccountResponse describeAccount(Consumer<DescribeAccountRequest.Builder> describeAccountRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeAccountRequest.builder()
- Parameters:
describeAccountRequest
- AConsumer
that will call methods onDescribeAccountRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccount operation returned by the service.
- See Also:
-
describeAccountModifications
default DescribeAccountModificationsResponse describeAccountModifications(DescribeAccountModificationsRequest describeAccountModificationsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
- Parameters:
describeAccountModificationsRequest
-- Returns:
- Result of the DescribeAccountModifications operation returned by the service.
- See Also:
-
describeAccountModifications
default DescribeAccountModificationsResponse describeAccountModifications(Consumer<DescribeAccountModificationsRequest.Builder> describeAccountModificationsRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeAccountModificationsRequest.builder()
- Parameters:
describeAccountModificationsRequest
- AConsumer
that will call methods onDescribeAccountModificationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountModifications operation returned by the service.
- See Also:
-
describeApplicationAssociations
default DescribeApplicationAssociationsResponse describeApplicationAssociations(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the application and the specified associated resources.
- Parameters:
describeApplicationAssociationsRequest
-- Returns:
- Result of the DescribeApplicationAssociations operation returned by the service.
- See Also:
-
describeApplicationAssociations
default DescribeApplicationAssociationsResponse describeApplicationAssociations(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the application and the specified associated resources.
This is a convenience which creates an instance of the
DescribeApplicationAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationAssociationsRequest.builder()
- Parameters:
describeApplicationAssociationsRequest
- AConsumer
that will call methods onDescribeApplicationAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeApplicationAssociations operation returned by the service.
- See Also:
-
describeApplicationAssociationsPaginator
default DescribeApplicationAssociationsIterable describeApplicationAssociationsPaginator(DescribeApplicationAssociationsRequest describeApplicationAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client.describeApplicationAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client .describeApplicationAssociationsPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client.describeApplicationAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation.- Parameters:
describeApplicationAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeApplicationAssociationsPaginator
default DescribeApplicationAssociationsIterable describeApplicationAssociationsPaginator(Consumer<DescribeApplicationAssociationsRequest.Builder> describeApplicationAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client.describeApplicationAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client .describeApplicationAssociationsPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationAssociationsIterable responses = client.describeApplicationAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeApplicationAssociations(software.amazon.awssdk.services.workspaces.model.DescribeApplicationAssociationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeApplicationAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationAssociationsRequest.builder()
- Parameters:
describeApplicationAssociationsRequest
- AConsumer
that will call methods onDescribeApplicationAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeApplications
default DescribeApplicationsResponse describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
- Parameters:
describeApplicationsRequest
-- Returns:
- Result of the DescribeApplications operation returned by the service.
- See Also:
-
describeApplications
default DescribeApplicationsResponse describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
This is a convenience which creates an instance of the
DescribeApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationsRequest.builder()
- Parameters:
describeApplicationsRequest
- AConsumer
that will call methods onDescribeApplicationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeApplications operation returned by the service.
- See Also:
-
describeApplicationsPaginator
default DescribeApplicationsIterable describeApplicationsPaginator(DescribeApplicationsRequest describeApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client.describeApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client .describeApplicationsPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client.describeApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation.- Parameters:
describeApplicationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeApplicationsPaginator
default DescribeApplicationsIterable describeApplicationsPaginator(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client.describeApplicationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client .describeApplicationsPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeApplicationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeApplicationsIterable responses = client.describeApplicationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults 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
describeApplications(software.amazon.awssdk.services.workspaces.model.DescribeApplicationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationsRequest.builder()
- Parameters:
describeApplicationsRequest
- AConsumer
that will call methods onDescribeApplicationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeBundleAssociations
default DescribeBundleAssociationsResponse describeBundleAssociations(DescribeBundleAssociationsRequest describeBundleAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the applications and the specified bundle.
- Parameters:
describeBundleAssociationsRequest
-- Returns:
- Result of the DescribeBundleAssociations operation returned by the service.
- See Also:
-
describeBundleAssociations
default DescribeBundleAssociationsResponse describeBundleAssociations(Consumer<DescribeBundleAssociationsRequest.Builder> describeBundleAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the applications and the specified bundle.
This is a convenience which creates an instance of the
DescribeBundleAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeBundleAssociationsRequest.builder()
- Parameters:
describeBundleAssociationsRequest
- AConsumer
that will call methods onDescribeBundleAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeBundleAssociations operation returned by the service.
- See Also:
-
describeClientBranding
default DescribeClientBrandingResponse describeClientBranding(DescribeClientBrandingRequest describeClientBrandingRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
- Parameters:
describeClientBrandingRequest
-- Returns:
- Result of the DescribeClientBranding operation returned by the service.
- See Also:
-
describeClientBranding
default DescribeClientBrandingResponse describeClientBranding(Consumer<DescribeClientBrandingRequest.Builder> describeClientBrandingRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.
This is a convenience which creates an instance of the
DescribeClientBrandingRequest.Builder
avoiding the need to create one manually viaDescribeClientBrandingRequest.builder()
- Parameters:
describeClientBrandingRequest
- AConsumer
that will call methods onDescribeClientBrandingRequest.Builder
to create a request.- Returns:
- Result of the DescribeClientBranding operation returned by the service.
- See Also:
-
describeClientProperties
default DescribeClientPropertiesResponse describeClientProperties(DescribeClientPropertiesRequest describeClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
- Parameters:
describeClientPropertiesRequest
-- Returns:
- Result of the DescribeClientProperties operation returned by the service.
- See Also:
-
describeClientProperties
default DescribeClientPropertiesResponse describeClientProperties(Consumer<DescribeClientPropertiesRequest.Builder> describeClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeClientPropertiesRequest.builder()
- Parameters:
describeClientPropertiesRequest
- AConsumer
that will call methods onDescribeClientPropertiesRequest.Builder
to create a request.- Returns:
- Result of the DescribeClientProperties operation returned by the service.
- See Also:
-
describeConnectClientAddIns
default DescribeConnectClientAddInsResponse describeConnectClientAddIns(DescribeConnectClientAddInsRequest describeConnectClientAddInsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list of Amazon Connect client add-ins that have been created.
- Parameters:
describeConnectClientAddInsRequest
-- Returns:
- Result of the DescribeConnectClientAddIns operation returned by the service.
- See Also:
-
describeConnectClientAddIns
default DescribeConnectClientAddInsResponse describeConnectClientAddIns(Consumer<DescribeConnectClientAddInsRequest.Builder> describeConnectClientAddInsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list of Amazon Connect client add-ins that have been created.
This is a convenience which creates an instance of the
DescribeConnectClientAddInsRequest.Builder
avoiding the need to create one manually viaDescribeConnectClientAddInsRequest.builder()
- Parameters:
describeConnectClientAddInsRequest
- AConsumer
that will call methods onDescribeConnectClientAddInsRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectClientAddIns operation returned by the service.
- See Also:
-
describeConnectionAliasPermissions
default DescribeConnectionAliasPermissionsResponse describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest describeConnectionAliasPermissionsRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
- Parameters:
describeConnectionAliasPermissionsRequest
-- Returns:
- Result of the DescribeConnectionAliasPermissions operation returned by the service.
- See Also:
-
describeConnectionAliasPermissions
default DescribeConnectionAliasPermissionsResponse describeConnectionAliasPermissions(Consumer<DescribeConnectionAliasPermissionsRequest.Builder> describeConnectionAliasPermissionsRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services 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 viaDescribeConnectionAliasPermissionsRequest.builder()
- Parameters:
describeConnectionAliasPermissionsRequest
- AConsumer
that will call methods onDescribeConnectionAliasPermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectionAliasPermissions operation returned by the service.
- See Also:
-
describeConnectionAliases
default DescribeConnectionAliasesResponse describeConnectionAliases(DescribeConnectionAliasesRequest describeConnectionAliasesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
- Parameters:
describeConnectionAliasesRequest
-- Returns:
- Result of the DescribeConnectionAliases operation returned by the service.
- See Also:
-
describeConnectionAliases
default DescribeConnectionAliasesResponse describeConnectionAliases(Consumer<DescribeConnectionAliasesRequest.Builder> describeConnectionAliasesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeConnectionAliasesRequest.builder()
- Parameters:
describeConnectionAliasesRequest
- AConsumer
that will call methods onDescribeConnectionAliasesRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnectionAliases operation returned by the service.
- See Also:
-
describeImageAssociations
default DescribeImageAssociationsResponse describeImageAssociations(DescribeImageAssociationsRequest describeImageAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the applications and the specified image.
- Parameters:
describeImageAssociationsRequest
-- Returns:
- Result of the DescribeImageAssociations operation returned by the service.
- See Also:
-
describeImageAssociations
default DescribeImageAssociationsResponse describeImageAssociations(Consumer<DescribeImageAssociationsRequest.Builder> describeImageAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations between the applications and the specified image.
This is a convenience which creates an instance of the
DescribeImageAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeImageAssociationsRequest.builder()
- Parameters:
describeImageAssociationsRequest
- AConsumer
that will call methods onDescribeImageAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeImageAssociations operation returned by the service.
- See Also:
-
describeIpGroups
default DescribeIpGroupsResponse describeIpGroups(DescribeIpGroupsRequest describeIpGroupsRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Describes one or more of your IP access control groups.
- Parameters:
describeIpGroupsRequest
-- Returns:
- Result of the DescribeIpGroups operation returned by the service.
- See Also:
-
describeIpGroups
default DescribeIpGroupsResponse describeIpGroups(Consumer<DescribeIpGroupsRequest.Builder> describeIpGroupsRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeIpGroupsRequest.builder()
- Parameters:
describeIpGroupsRequest
- AConsumer
that will call methods onDescribeIpGroupsRequest.Builder
to create a request.- Returns:
- Result of the DescribeIpGroups operation returned by the service.
- See Also:
-
describeIpGroups
default DescribeIpGroupsResponse describeIpGroups() throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesExceptionDescribes one or more of your IP access control groups.
- Returns:
- Result of the DescribeIpGroups operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the specified tags for the specified WorkSpaces resource.
- Parameters:
describeTagsRequest
-- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeTags
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeTagsRequest.builder()
- Parameters:
describeTagsRequest
- AConsumer
that will call methods onDescribeTagsRequest.Builder
to create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- See Also:
-
describeWorkspaceAssociations
default DescribeWorkspaceAssociationsResponse describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest describeWorkspaceAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations betweens applications and the specified WorkSpace.
- Parameters:
describeWorkspaceAssociationsRequest
-- Returns:
- Result of the DescribeWorkspaceAssociations operation returned by the service.
- See Also:
-
describeWorkspaceAssociations
default DescribeWorkspaceAssociationsResponse describeWorkspaceAssociations(Consumer<DescribeWorkspaceAssociationsRequest.Builder> describeWorkspaceAssociationsRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Describes the associations betweens applications and the specified WorkSpace.
This is a convenience which creates an instance of the
DescribeWorkspaceAssociationsRequest.Builder
avoiding the need to create one manually viaDescribeWorkspaceAssociationsRequest.builder()
- Parameters:
describeWorkspaceAssociationsRequest
- AConsumer
that will call methods onDescribeWorkspaceAssociationsRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceAssociations operation returned by the service.
- See Also:
-
describeWorkspaceBundles
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
- Parameters:
describeWorkspaceBundlesRequest
-- Returns:
- Result of the DescribeWorkspaceBundles operation returned by the service.
- See Also:
-
describeWorkspaceBundles
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspaceBundlesRequest.builder()
- Parameters:
describeWorkspaceBundlesRequest
- AConsumer
that will call methods onDescribeWorkspaceBundlesRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceBundles operation returned by the service.
- See Also:
-
describeWorkspaceBundles
default DescribeWorkspaceBundlesResponse describeWorkspaceBundles() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesExceptionRetrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
- Returns:
- Result of the DescribeWorkspaceBundles operation returned by the service.
- See Also:
-
describeWorkspaceBundlesPaginator
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesExceptionThis is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client .describeWorkspaceBundlesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceBundlesPaginator
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(DescribeWorkspaceBundlesRequest describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client .describeWorkspaceBundlesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeWorkspaceBundlesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceBundlesPaginator
default DescribeWorkspaceBundlesIterable describeWorkspaceBundlesPaginator(Consumer<DescribeWorkspaceBundlesRequest.Builder> describeWorkspaceBundlesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaceBundles(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client .describeWorkspaceBundlesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceBundlesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceBundlesIterable responses = client.describeWorkspaceBundlesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeWorkspaceBundlesRequest.builder()
- Parameters:
describeWorkspaceBundlesRequest
- AConsumer
that will call methods onDescribeWorkspaceBundlesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceDirectories
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Describes the available directories that are registered with Amazon WorkSpaces.
- Parameters:
describeWorkspaceDirectoriesRequest
-- Returns:
- Result of the DescribeWorkspaceDirectories operation returned by the service.
- See Also:
-
describeWorkspaceDirectories
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspaceDirectoriesRequest.builder()
- Parameters:
describeWorkspaceDirectoriesRequest
- AConsumer
that will call methods onDescribeWorkspaceDirectoriesRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceDirectories operation returned by the service.
- See Also:
-
describeWorkspaceDirectories
default DescribeWorkspaceDirectoriesResponse describeWorkspaceDirectories() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesExceptionDescribes the available directories that are registered with Amazon WorkSpaces.
- Returns:
- Result of the DescribeWorkspaceDirectories operation returned by the service.
- See Also:
-
describeWorkspaceDirectoriesPaginator
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesExceptionThis is a variant of
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client .describeWorkspaceDirectoriesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceDirectoriesPaginator
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(DescribeWorkspaceDirectoriesRequest describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client .describeWorkspaceDirectoriesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeWorkspaceDirectoriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceDirectoriesPaginator
default DescribeWorkspaceDirectoriesIterable describeWorkspaceDirectoriesPaginator(Consumer<DescribeWorkspaceDirectoriesRequest.Builder> describeWorkspaceDirectoriesRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaceDirectories(software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client .describeWorkspaceDirectoriesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspaceDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspaceDirectoriesIterable responses = client.describeWorkspaceDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeWorkspaceDirectoriesRequest.builder()
- Parameters:
describeWorkspaceDirectoriesRequest
- AConsumer
that will call methods onDescribeWorkspaceDirectoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspaceImagePermissions
default DescribeWorkspaceImagePermissionsResponse describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest describeWorkspaceImagePermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
- Parameters:
describeWorkspaceImagePermissionsRequest
-- Returns:
- Result of the DescribeWorkspaceImagePermissions operation returned by the service.
- See Also:
-
describeWorkspaceImagePermissions
default DescribeWorkspaceImagePermissionsResponse describeWorkspaceImagePermissions(Consumer<DescribeWorkspaceImagePermissionsRequest.Builder> describeWorkspaceImagePermissionsRequest) throws ResourceNotFoundException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
This is a convenience which creates an instance of the
DescribeWorkspaceImagePermissionsRequest.Builder
avoiding the need to create one manually viaDescribeWorkspaceImagePermissionsRequest.builder()
- Parameters:
describeWorkspaceImagePermissionsRequest
- AConsumer
that will call methods onDescribeWorkspaceImagePermissionsRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceImagePermissions operation returned by the service.
- See Also:
-
describeWorkspaceImages
default DescribeWorkspaceImagesResponse describeWorkspaceImages(DescribeWorkspaceImagesRequest describeWorkspaceImagesRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
- Parameters:
describeWorkspaceImagesRequest
-- Returns:
- Result of the DescribeWorkspaceImages operation returned by the service.
- See Also:
-
describeWorkspaceImages
default DescribeWorkspaceImagesResponse describeWorkspaceImages(Consumer<DescribeWorkspaceImagesRequest.Builder> describeWorkspaceImagesRequest) throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspaceImagesRequest.builder()
- Parameters:
describeWorkspaceImagesRequest
- AConsumer
that will call methods onDescribeWorkspaceImagesRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceImages operation returned by the service.
- See Also:
-
describeWorkspaceImages
default DescribeWorkspaceImagesResponse describeWorkspaceImages() throws AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesExceptionRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
- Returns:
- Result of the DescribeWorkspaceImages operation returned by the service.
- See Also:
-
describeWorkspaceSnapshots
default DescribeWorkspaceSnapshotsResponse describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest describeWorkspaceSnapshotsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Describes the snapshots for the specified WorkSpace.
- Parameters:
describeWorkspaceSnapshotsRequest
-- Returns:
- Result of the DescribeWorkspaceSnapshots operation returned by the service.
- See Also:
-
describeWorkspaceSnapshots
default DescribeWorkspaceSnapshotsResponse describeWorkspaceSnapshots(Consumer<DescribeWorkspaceSnapshotsRequest.Builder> describeWorkspaceSnapshotsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspaceSnapshotsRequest.builder()
- Parameters:
describeWorkspaceSnapshotsRequest
- AConsumer
that will call methods onDescribeWorkspaceSnapshotsRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaceSnapshots operation returned by the service.
- See Also:
-
describeWorkspaces
default DescribeWorkspacesResponse describeWorkspaces(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
describeWorkspacesRequest
-- Returns:
- Result of the DescribeWorkspaces operation returned by the service.
- See Also:
-
describeWorkspaces
default DescribeWorkspacesResponse describeWorkspaces(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspacesRequest.builder()
- Parameters:
describeWorkspacesRequest
- AConsumer
that will call methods onDescribeWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspaces operation returned by the service.
- See Also:
-
describeWorkspaces
default DescribeWorkspacesResponse describeWorkspaces() throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesExceptionDescribes 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.
- Returns:
- Result of the DescribeWorkspaces operation returned by the service.
- See Also:
-
describeWorkspacesPaginator
default DescribeWorkspacesIterable describeWorkspacesPaginator() throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesExceptionThis is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client .describeWorkspacesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspacesPaginator
default DescribeWorkspacesIterable describeWorkspacesPaginator(DescribeWorkspacesRequest describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client .describeWorkspacesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.iterator().forEachRemaining(....);
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.- Parameters:
describeWorkspacesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspacesPaginator
default DescribeWorkspacesIterable describeWorkspacesPaginator(Consumer<DescribeWorkspacesRequest.Builder> describeWorkspacesRequest) throws InvalidParameterValuesException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException This is a variant of
describeWorkspaces(software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client .describeWorkspacesPaginator(request); for (software.amazon.awssdk.services.workspaces.model.DescribeWorkspacesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.workspaces.paginators.DescribeWorkspacesIterable responses = client.describeWorkspacesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeWorkspacesRequest.builder()
- Parameters:
describeWorkspacesRequest
- AConsumer
that will call methods onDescribeWorkspacesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeWorkspacesConnectionStatus
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Describes the connection status of the specified WorkSpaces.
- Parameters:
describeWorkspacesConnectionStatusRequest
-- Returns:
- Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
- See Also:
-
describeWorkspacesConnectionStatus
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus(Consumer<DescribeWorkspacesConnectionStatusRequest.Builder> describeWorkspacesConnectionStatusRequest) throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDescribeWorkspacesConnectionStatusRequest.builder()
- Parameters:
describeWorkspacesConnectionStatusRequest
- AConsumer
that will call methods onDescribeWorkspacesConnectionStatusRequest.Builder
to create a request.- Returns:
- Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
- See Also:
-
describeWorkspacesConnectionStatus
default DescribeWorkspacesConnectionStatusResponse describeWorkspacesConnectionStatus() throws InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesExceptionDescribes the connection status of the specified WorkSpaces.
- Returns:
- Result of the DescribeWorkspacesConnectionStatus operation returned by the service.
- See Also:
-
disassociateConnectionAlias
default DisassociateConnectionAliasResponse disassociateConnectionAlias(DisassociateConnectionAliasRequest disassociateConnectionAliasRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different 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
.- Parameters:
disassociateConnectionAliasRequest
-- Returns:
- Result of the DisassociateConnectionAlias operation returned by the service.
- See Also:
-
disassociateConnectionAlias
default DisassociateConnectionAliasResponse disassociateConnectionAlias(Consumer<DisassociateConnectionAliasRequest.Builder> disassociateConnectionAliasRequest) throws AccessDeniedException, ResourceNotFoundException, InvalidParameterValuesException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different 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 viaDisassociateConnectionAliasRequest.builder()
- Parameters:
disassociateConnectionAliasRequest
- AConsumer
that will call methods onDisassociateConnectionAliasRequest.Builder
to create a request.- Returns:
- Result of the DisassociateConnectionAlias operation returned by the service.
- See Also:
-
disassociateIpGroups
default DisassociateIpGroupsResponse disassociateIpGroups(DisassociateIpGroupsRequest disassociateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Disassociates the specified IP access control group from the specified directory.
- Parameters:
disassociateIpGroupsRequest
-- Returns:
- Result of the DisassociateIpGroups operation returned by the service.
- See Also:
-
disassociateIpGroups
default DisassociateIpGroupsResponse disassociateIpGroups(Consumer<DisassociateIpGroupsRequest.Builder> disassociateIpGroupsRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaDisassociateIpGroupsRequest.builder()
- Parameters:
disassociateIpGroupsRequest
- AConsumer
that will call methods onDisassociateIpGroupsRequest.Builder
to create a request.- Returns:
- Result of the DisassociateIpGroups operation returned by the service.
- See Also:
-
disassociateWorkspaceApplication
default DisassociateWorkspaceApplicationResponse disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest disassociateWorkspaceApplicationRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Disassociates the specified application from a WorkSpace.
- Parameters:
disassociateWorkspaceApplicationRequest
-- Returns:
- Result of the DisassociateWorkspaceApplication operation returned by the service.
- See Also:
-
disassociateWorkspaceApplication
default DisassociateWorkspaceApplicationResponse disassociateWorkspaceApplication(Consumer<DisassociateWorkspaceApplicationRequest.Builder> disassociateWorkspaceApplicationRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceInUseException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Disassociates the specified application from a WorkSpace.
This is a convenience which creates an instance of the
DisassociateWorkspaceApplicationRequest.Builder
avoiding the need to create one manually viaDisassociateWorkspaceApplicationRequest.builder()
- Parameters:
disassociateWorkspaceApplicationRequest
- AConsumer
that will call methods onDisassociateWorkspaceApplicationRequest.Builder
to create a request.- Returns:
- Result of the DisassociateWorkspaceApplication operation returned by the service.
- See Also:
-
importClientBranding
default ImportClientBrandingResponse importClientBranding(ImportClientBrandingRequest importClientBrandingRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
-
You must specify at least one platform type when importing client branding.
-
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
-
In each platform type, the
SupportEmail
andSupportLink
parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. -
Imported data can take up to a minute to appear in the WorkSpaces client.
- Parameters:
importClientBrandingRequest
-- Returns:
- Result of the ImportClientBranding operation returned by the service.
- See Also:
-
-
importClientBranding
default ImportClientBrandingResponse importClientBranding(Consumer<ImportClientBrandingRequest.Builder> importClientBrandingRequest) throws InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
-
You must specify at least one platform type when importing client branding.
-
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
-
In each platform type, the
SupportEmail
andSupportLink
parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both. -
Imported data can take up to a minute to appear in the WorkSpaces client.
This is a convenience which creates an instance of the
ImportClientBrandingRequest.Builder
avoiding the need to create one manually viaImportClientBrandingRequest.builder()
- Parameters:
importClientBrandingRequest
- AConsumer
that will call methods onImportClientBrandingRequest.Builder
to create a request.- Returns:
- Result of the ImportClientBranding operation returned by the service.
- See Also:
-
-
importWorkspaceImage
default ImportWorkspaceImageResponse importWorkspaceImage(ImportWorkspaceImageRequest importWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
- Parameters:
importWorkspaceImageRequest
-- Returns:
- Result of the ImportWorkspaceImage operation returned by the service.
- See Also:
-
importWorkspaceImage
default ImportWorkspaceImageResponse importWorkspaceImage(Consumer<ImportWorkspaceImageRequest.Builder> importWorkspaceImageRequest) throws ResourceLimitExceededException, ResourceAlreadyExistsException, ResourceNotFoundException, OperationNotSupportedException, AccessDeniedException, InvalidParameterValuesException, AwsServiceException, SdkClientException, WorkSpacesException Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services 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 viaImportWorkspaceImageRequest.builder()
- Parameters:
importWorkspaceImageRequest
- AConsumer
that will call methods onImportWorkspaceImageRequest.Builder
to create a request.- Returns:
- Result of the ImportWorkspaceImage operation returned by the service.
- See Also:
-
listAvailableManagementCidrRanges
default ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest listAvailableManagementCidrRangesRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 Amazon Web Services 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.
- Parameters:
listAvailableManagementCidrRangesRequest
-- Returns:
- Result of the ListAvailableManagementCidrRanges operation returned by the service.
- See Also:
-
listAvailableManagementCidrRanges
default ListAvailableManagementCidrRangesResponse listAvailableManagementCidrRanges(Consumer<ListAvailableManagementCidrRangesRequest.Builder> listAvailableManagementCidrRangesRequest) throws InvalidParameterValuesException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 Amazon Web Services 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 viaListAvailableManagementCidrRangesRequest.builder()
- Parameters:
listAvailableManagementCidrRangesRequest
- AConsumer
that will call methods onListAvailableManagementCidrRangesRequest.Builder
to create a request.- Returns:
- Result of the ListAvailableManagementCidrRanges operation returned by the service.
- See Also:
-
migrateWorkspace
default MigrateWorkspaceResponse migrateWorkspace(MigrateWorkspaceRequest migrateWorkspaceRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, OperationNotSupportedException, OperationInProgressException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException 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 toD:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A newD:\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.
- Parameters:
migrateWorkspaceRequest
-- Returns:
- Result of the MigrateWorkspace operation returned by the service.
- See Also:
-
migrateWorkspace
default MigrateWorkspaceResponse migrateWorkspace(Consumer<MigrateWorkspaceRequest.Builder> migrateWorkspaceRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, OperationNotSupportedException, OperationInProgressException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException 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 toD:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A newD:\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 viaMigrateWorkspaceRequest.builder()
- Parameters:
migrateWorkspaceRequest
- AConsumer
that will call methods onMigrateWorkspaceRequest.Builder
to create a request.- Returns:
- Result of the MigrateWorkspace operation returned by the service.
- See Also:
-
modifyAccount
default ModifyAccountResponse modifyAccount(ModifyAccountRequest modifyAccountRequest) throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException, ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
- Parameters:
modifyAccountRequest
-- Returns:
- Result of the ModifyAccount operation returned by the service.
- See Also:
-
modifyAccount
default ModifyAccountResponse modifyAccount(Consumer<ModifyAccountRequest.Builder> modifyAccountRequest) throws InvalidParameterValuesException, AccessDeniedException, InvalidResourceStateException, ResourceUnavailableException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaModifyAccountRequest.builder()
- Parameters:
modifyAccountRequest
- AConsumer
that will call methods onModifyAccountRequest.Builder
to create a request.- Returns:
- Result of the ModifyAccount operation returned by the service.
- See Also:
-
modifyCertificateBasedAuthProperties
default ModifyCertificateBasedAuthPropertiesResponse modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest modifyCertificateBasedAuthPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
- Parameters:
modifyCertificateBasedAuthPropertiesRequest
-- Returns:
- Result of the ModifyCertificateBasedAuthProperties operation returned by the service.
- See Also:
-
modifyCertificateBasedAuthProperties
default ModifyCertificateBasedAuthPropertiesResponse modifyCertificateBasedAuthProperties(Consumer<ModifyCertificateBasedAuthPropertiesRequest.Builder> modifyCertificateBasedAuthPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
This is a convenience which creates an instance of the
ModifyCertificateBasedAuthPropertiesRequest.Builder
avoiding the need to create one manually viaModifyCertificateBasedAuthPropertiesRequest.builder()
- Parameters:
modifyCertificateBasedAuthPropertiesRequest
- AConsumer
that will call methods onModifyCertificateBasedAuthPropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifyCertificateBasedAuthProperties operation returned by the service.
- See Also:
-
modifyClientProperties
default ModifyClientPropertiesResponse modifyClientProperties(ModifyClientPropertiesRequest modifyClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the properties of the specified Amazon WorkSpaces clients.
- Parameters:
modifyClientPropertiesRequest
-- Returns:
- Result of the ModifyClientProperties operation returned by the service.
- See Also:
-
modifyClientProperties
default ModifyClientPropertiesResponse modifyClientProperties(Consumer<ModifyClientPropertiesRequest.Builder> modifyClientPropertiesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaModifyClientPropertiesRequest.builder()
- Parameters:
modifyClientPropertiesRequest
- AConsumer
that will call methods onModifyClientPropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifyClientProperties operation returned by the service.
- See Also:
-
modifySamlProperties
default ModifySamlPropertiesResponse modifySamlProperties(ModifySamlPropertiesRequest modifySamlPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
- Parameters:
modifySamlPropertiesRequest
-- Returns:
- Result of the ModifySamlProperties operation returned by the service.
- See Also:
-
modifySamlProperties
default ModifySamlPropertiesResponse modifySamlProperties(Consumer<ModifySamlPropertiesRequest.Builder> modifySamlPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
This is a convenience which creates an instance of the
ModifySamlPropertiesRequest.Builder
avoiding the need to create one manually viaModifySamlPropertiesRequest.builder()
- Parameters:
modifySamlPropertiesRequest
- AConsumer
that will call methods onModifySamlPropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifySamlProperties operation returned by the service.
- See Also:
-
modifySelfservicePermissions
default ModifySelfservicePermissionsResponse modifySelfservicePermissions(ModifySelfservicePermissionsRequest modifySelfservicePermissionsRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
- Parameters:
modifySelfservicePermissionsRequest
-- Returns:
- Result of the ModifySelfservicePermissions operation returned by the service.
- See Also:
-
modifySelfservicePermissions
default ModifySelfservicePermissionsResponse modifySelfservicePermissions(Consumer<ModifySelfservicePermissionsRequest.Builder> modifySelfservicePermissionsRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaModifySelfservicePermissionsRequest.builder()
- Parameters:
modifySelfservicePermissionsRequest
- AConsumer
that will call methods onModifySelfservicePermissionsRequest.Builder
to create a request.- Returns:
- Result of the ModifySelfservicePermissions operation returned by the service.
- See Also:
-
modifyWorkspaceAccessProperties
default ModifyWorkspaceAccessPropertiesResponse modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest modifyWorkspaceAccessPropertiesRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
- Parameters:
modifyWorkspaceAccessPropertiesRequest
-- Returns:
- Result of the ModifyWorkspaceAccessProperties operation returned by the service.
- See Also:
-
modifyWorkspaceAccessProperties
default ModifyWorkspaceAccessPropertiesResponse modifyWorkspaceAccessProperties(Consumer<ModifyWorkspaceAccessPropertiesRequest.Builder> modifyWorkspaceAccessPropertiesRequest) throws ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaModifyWorkspaceAccessPropertiesRequest.builder()
- Parameters:
modifyWorkspaceAccessPropertiesRequest
- AConsumer
that will call methods onModifyWorkspaceAccessPropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifyWorkspaceAccessProperties operation returned by the service.
- See Also:
-
modifyWorkspaceCreationProperties
default ModifyWorkspaceCreationPropertiesResponse modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest modifyWorkspaceCreationPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Modify the default properties used to create WorkSpaces.
- Parameters:
modifyWorkspaceCreationPropertiesRequest
-- Returns:
- Result of the ModifyWorkspaceCreationProperties operation returned by the service.
- See Also:
-
modifyWorkspaceCreationProperties
default ModifyWorkspaceCreationPropertiesResponse modifyWorkspaceCreationProperties(Consumer<ModifyWorkspaceCreationPropertiesRequest.Builder> modifyWorkspaceCreationPropertiesRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaModifyWorkspaceCreationPropertiesRequest.builder()
- Parameters:
modifyWorkspaceCreationPropertiesRequest
- AConsumer
that will call methods onModifyWorkspaceCreationPropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifyWorkspaceCreationProperties operation returned by the service.
- See Also:
-
modifyWorkspaceProperties
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The
MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.- Parameters:
modifyWorkspacePropertiesRequest
-- Returns:
- Result of the ModifyWorkspaceProperties operation returned by the service.
- See Also:
-
modifyWorkspaceProperties
default ModifyWorkspacePropertiesResponse modifyWorkspaceProperties(Consumer<ModifyWorkspacePropertiesRequest.Builder> modifyWorkspacePropertiesRequest) throws InvalidParameterValuesException, InvalidResourceStateException, OperationInProgressException, UnsupportedWorkspaceConfigurationException, ResourceNotFoundException, AccessDeniedException, ResourceUnavailableException, AwsServiceException, SdkClientException, WorkSpacesException Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The
MANUAL
running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
This is a convenience which creates an instance of the
ModifyWorkspacePropertiesRequest.Builder
avoiding the need to create one manually viaModifyWorkspacePropertiesRequest.builder()
- Parameters:
modifyWorkspacePropertiesRequest
- AConsumer
that will call methods onModifyWorkspacePropertiesRequest.Builder
to create a request.- Returns:
- Result of the ModifyWorkspaceProperties operation returned by the service.
- See Also:
-
modifyWorkspaceState
default ModifyWorkspaceStateResponse modifyWorkspaceState(ModifyWorkspaceStateRequest modifyWorkspaceStateRequest) throws InvalidParameterValuesException, InvalidResourceStateException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 theADMIN_MAINTENANCE
state.- Parameters:
modifyWorkspaceStateRequest
-- Returns:
- Result of the ModifyWorkspaceState operation returned by the service.
- See Also:
-
modifyWorkspaceState
default ModifyWorkspaceStateResponse modifyWorkspaceState(Consumer<ModifyWorkspaceStateRequest.Builder> modifyWorkspaceStateRequest) throws InvalidParameterValuesException, InvalidResourceStateException, ResourceNotFoundException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 theADMIN_MAINTENANCE
state.
This is a convenience which creates an instance of the
ModifyWorkspaceStateRequest.Builder
avoiding the need to create one manually viaModifyWorkspaceStateRequest.builder()
- Parameters:
modifyWorkspaceStateRequest
- AConsumer
that will call methods onModifyWorkspaceStateRequest.Builder
to create a request.- Returns:
- Result of the ModifyWorkspaceState operation returned by the service.
- See Also:
-
rebootWorkspaces
default RebootWorkspacesResponse rebootWorkspaces(RebootWorkspacesRequest rebootWorkspacesRequest) throws OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is
AVAILABLE
,UNHEALTHY
, orREBOOTING
. Reboot a WorkSpace in theREBOOTING
state only if your WorkSpace has been stuck in theREBOOTING
state for over 20 minutes.This operation is asynchronous and returns before the WorkSpaces have rebooted.
- Parameters:
rebootWorkspacesRequest
-- Returns:
- Result of the RebootWorkspaces operation returned by the service.
- See Also:
-
rebootWorkspaces
default RebootWorkspacesResponse rebootWorkspaces(Consumer<RebootWorkspacesRequest.Builder> rebootWorkspacesRequest) throws OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is
AVAILABLE
,UNHEALTHY
, orREBOOTING
. Reboot a WorkSpace in theREBOOTING
state only if your WorkSpace has been stuck in theREBOOTING
state for over 20 minutes.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 viaRebootWorkspacesRequest.builder()
- Parameters:
rebootWorkspacesRequest
- AConsumer
that will call methods onRebootWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the RebootWorkspaces operation returned by the service.
- See Also:
-
rebuildWorkspaces
default RebuildWorkspacesResponse rebuildWorkspaces(RebuildWorkspacesRequest rebuildWorkspacesRequest) throws OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is
AVAILABLE
,ERROR
,UNHEALTHY
,STOPPED
, orREBOOTING
.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.
- Parameters:
rebuildWorkspacesRequest
-- Returns:
- Result of the RebuildWorkspaces operation returned by the service.
- See Also:
-
rebuildWorkspaces
default RebuildWorkspacesResponse rebuildWorkspaces(Consumer<RebuildWorkspacesRequest.Builder> rebuildWorkspacesRequest) throws OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is
AVAILABLE
,ERROR
,UNHEALTHY
,STOPPED
, orREBOOTING
.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 viaRebuildWorkspacesRequest.builder()
- Parameters:
rebuildWorkspacesRequest
- AConsumer
that will call methods onRebuildWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the RebuildWorkspaces operation returned by the service.
- See Also:
-
registerWorkspaceDirectory
default RegisterWorkspaceDirectoryResponse registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest registerWorkspaceDirectoryRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, AccessDeniedException, WorkspacesDefaultRoleNotFoundException, InvalidResourceStateException, UnsupportedNetworkConfigurationException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
registerWorkspaceDirectoryRequest
-- Returns:
- Result of the RegisterWorkspaceDirectory operation returned by the service.
- See Also:
-
registerWorkspaceDirectory
default RegisterWorkspaceDirectoryResponse registerWorkspaceDirectory(Consumer<RegisterWorkspaceDirectoryRequest.Builder> registerWorkspaceDirectoryRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, AccessDeniedException, WorkspacesDefaultRoleNotFoundException, InvalidResourceStateException, UnsupportedNetworkConfigurationException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaRegisterWorkspaceDirectoryRequest.builder()
- Parameters:
registerWorkspaceDirectoryRequest
- AConsumer
that will call methods onRegisterWorkspaceDirectoryRequest.Builder
to create a request.- Returns:
- Result of the RegisterWorkspaceDirectory operation returned by the service.
- See Also:
-
restoreWorkspace
default RestoreWorkspaceResponse restoreWorkspace(RestoreWorkspaceRequest restoreWorkspaceRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is
AVAILABLE
,ERROR
,UNHEALTHY
, orSTOPPED
.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.
- Parameters:
restoreWorkspaceRequest
-- Returns:
- Result of the RestoreWorkspace operation returned by the service.
- See Also:
-
restoreWorkspace
default RestoreWorkspaceResponse restoreWorkspace(Consumer<RestoreWorkspaceRequest.Builder> restoreWorkspaceRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is
AVAILABLE
,ERROR
,UNHEALTHY
, orSTOPPED
.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 viaRestoreWorkspaceRequest.builder()
- Parameters:
restoreWorkspaceRequest
- AConsumer
that will call methods onRestoreWorkspaceRequest.Builder
to create a request.- Returns:
- Result of the RestoreWorkspace operation returned by the service.
- See Also:
-
revokeIpRules
default RevokeIpRulesResponse revokeIpRules(RevokeIpRulesRequest revokeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Removes one or more rules from the specified IP access control group.
- Parameters:
revokeIpRulesRequest
-- Returns:
- Result of the RevokeIpRules operation returned by the service.
- See Also:
-
revokeIpRules
default RevokeIpRulesResponse revokeIpRules(Consumer<RevokeIpRulesRequest.Builder> revokeIpRulesRequest) throws InvalidParameterValuesException, ResourceNotFoundException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaRevokeIpRulesRequest.builder()
- Parameters:
revokeIpRulesRequest
- AConsumer
that will call methods onRevokeIpRulesRequest.Builder
to create a request.- Returns:
- Result of the RevokeIpRules operation returned by the service.
- See Also:
-
startWorkspaces
default StartWorkspacesResponse startWorkspaces(StartWorkspacesRequest startWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of
AutoStop
and a state ofSTOPPED
.- Parameters:
startWorkspacesRequest
-- Returns:
- Result of the StartWorkspaces operation returned by the service.
- See Also:
-
startWorkspaces
default StartWorkspacesResponse startWorkspaces(Consumer<StartWorkspacesRequest.Builder> startWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of
AutoStop
and a state ofSTOPPED
.
This is a convenience which creates an instance of the
StartWorkspacesRequest.Builder
avoiding the need to create one manually viaStartWorkspacesRequest.builder()
- Parameters:
startWorkspacesRequest
- AConsumer
that will call methods onStartWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the StartWorkspaces operation returned by the service.
- See Also:
-
stopWorkspaces
default StopWorkspacesResponse stopWorkspaces(StopWorkspacesRequest stopWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of
AutoStop
and a state ofAVAILABLE
,IMPAIRED
,UNHEALTHY
, orERROR
.- Parameters:
stopWorkspacesRequest
-- Returns:
- Result of the StopWorkspaces operation returned by the service.
- See Also:
-
stopWorkspaces
default StopWorkspacesResponse stopWorkspaces(Consumer<StopWorkspacesRequest.Builder> stopWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of
AutoStop
and a state ofAVAILABLE
,IMPAIRED
,UNHEALTHY
, orERROR
.
This is a convenience which creates an instance of the
StopWorkspacesRequest.Builder
avoiding the need to create one manually viaStopWorkspacesRequest.builder()
- Parameters:
stopWorkspacesRequest
- AConsumer
that will call methods onStopWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the StopWorkspaces operation returned by the service.
- See Also:
-
terminateWorkspaces
default TerminateWorkspacesResponse terminateWorkspaces(TerminateWorkspacesRequest terminateWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services 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 Directory Service 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.
- Parameters:
terminateWorkspacesRequest
-- Returns:
- Result of the TerminateWorkspaces operation returned by the service.
- See Also:
-
terminateWorkspaces
default TerminateWorkspacesResponse terminateWorkspaces(Consumer<TerminateWorkspacesRequest.Builder> terminateWorkspacesRequest) throws AwsServiceException, SdkClientException, WorkSpacesException Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services 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 Directory Service 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 viaTerminateWorkspacesRequest.builder()
- Parameters:
terminateWorkspacesRequest
- AConsumer
that will call methods onTerminateWorkspacesRequest.Builder
to create a request.- Returns:
- Result of the TerminateWorkspaces operation returned by the service.
- See Also:
-
updateConnectClientAddIn
default UpdateConnectClientAddInResponse updateConnectClientAddIn(UpdateConnectClientAddInRequest updateConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
- Parameters:
updateConnectClientAddInRequest
-- Returns:
- Result of the UpdateConnectClientAddIn operation returned by the service.
- See Also:
-
updateConnectClientAddIn
default UpdateConnectClientAddInResponse updateConnectClientAddIn(Consumer<UpdateConnectClientAddInRequest.Builder> updateConnectClientAddInRequest) throws InvalidParameterValuesException, ResourceNotFoundException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
This is a convenience which creates an instance of the
UpdateConnectClientAddInRequest.Builder
avoiding the need to create one manually viaUpdateConnectClientAddInRequest.builder()
- Parameters:
updateConnectClientAddInRequest
- AConsumer
that will call methods onUpdateConnectClientAddInRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnectClientAddIn operation returned by the service.
- See Also:
-
updateConnectionAliasPermission
default UpdateConnectionAliasPermissionResponse updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest updateConnectionAliasPermissionRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException, ResourceAssociatedException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
updateConnectionAliasPermissionRequest
-- Returns:
- Result of the UpdateConnectionAliasPermission operation returned by the service.
- See Also:
-
-
updateConnectionAliasPermission
default UpdateConnectionAliasPermissionResponse updateConnectionAliasPermission(Consumer<UpdateConnectionAliasPermissionRequest.Builder> updateConnectionAliasPermissionRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceLimitExceededException, ResourceNotFoundException, ResourceAssociatedException, InvalidResourceStateException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaUpdateConnectionAliasPermissionRequest.builder()
- Parameters:
updateConnectionAliasPermissionRequest
- AConsumer
that will call methods onUpdateConnectionAliasPermissionRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnectionAliasPermission operation returned by the service.
- See Also:
-
-
updateRulesOfIpGroup
default UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest updateRulesOfIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException Replaces the current rules of the specified IP access control group with the specified rules.
- Parameters:
updateRulesOfIpGroupRequest
-- Returns:
- Result of the UpdateRulesOfIpGroup operation returned by the service.
- See Also:
-
updateRulesOfIpGroup
default UpdateRulesOfIpGroupResponse updateRulesOfIpGroup(Consumer<UpdateRulesOfIpGroupRequest.Builder> updateRulesOfIpGroupRequest) throws InvalidParameterValuesException, ResourceNotFoundException, ResourceLimitExceededException, InvalidResourceStateException, AccessDeniedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaUpdateRulesOfIpGroupRequest.builder()
- Parameters:
updateRulesOfIpGroupRequest
- AConsumer
that will call methods onUpdateRulesOfIpGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateRulesOfIpGroup operation returned by the service.
- See Also:
-
updateWorkspaceBundle
default UpdateWorkspaceBundleResponse updateWorkspaceBundle(UpdateWorkspaceBundleRequest updateWorkspaceBundleRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, ResourceUnavailableException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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.
- Parameters:
updateWorkspaceBundleRequest
-- Returns:
- Result of the UpdateWorkspaceBundle operation returned by the service.
- See Also:
-
updateWorkspaceBundle
default UpdateWorkspaceBundleResponse updateWorkspaceBundle(Consumer<UpdateWorkspaceBundleRequest.Builder> updateWorkspaceBundleRequest) throws AccessDeniedException, InvalidParameterValuesException, ResourceNotFoundException, ResourceUnavailableException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException 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 viaUpdateWorkspaceBundleRequest.builder()
- Parameters:
updateWorkspaceBundleRequest
- AConsumer
that will call methods onUpdateWorkspaceBundleRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorkspaceBundle operation returned by the service.
- See Also:
-
updateWorkspaceImagePermission
default UpdateWorkspaceImagePermissionResponse updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest updateWorkspaceImagePermissionRequest) throws ResourceNotFoundException, ResourceUnavailableException, AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Shares or unshares an image with one account in the same Amazon Web Services 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 Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services 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 Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
- Parameters:
updateWorkspaceImagePermissionRequest
-- Returns:
- Result of the UpdateWorkspaceImagePermission operation returned by the service.
- See Also:
-
-
updateWorkspaceImagePermission
default UpdateWorkspaceImagePermissionResponse updateWorkspaceImagePermission(Consumer<UpdateWorkspaceImagePermissionRequest.Builder> updateWorkspaceImagePermissionRequest) throws ResourceNotFoundException, ResourceUnavailableException, AccessDeniedException, InvalidParameterValuesException, OperationNotSupportedException, AwsServiceException, SdkClientException, WorkSpacesException Shares or unshares an image with one account in the same Amazon Web Services 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 Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services 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 Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
This is a convenience which creates an instance of the
UpdateWorkspaceImagePermissionRequest.Builder
avoiding the need to create one manually viaUpdateWorkspaceImagePermissionRequest.builder()
- Parameters:
updateWorkspaceImagePermissionRequest
- AConsumer
that will call methods onUpdateWorkspaceImagePermissionRequest.Builder
to create a request.- Returns:
- Result of the UpdateWorkspaceImagePermission operation returned by the service.
- See Also:
-
-
create
Create aWorkSpacesClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWorkSpacesClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-