@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonWorkspaces extends Object implements AmazonWorkspaces
AmazonWorkspaces. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AcceptAccountLinkInvitationResult |
acceptAccountLinkInvitation(AcceptAccountLinkInvitationRequest request)
Accepts the account link invitation.
|
AssociateConnectionAliasResult |
associateConnectionAlias(AssociateConnectionAliasRequest request)
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
|
AssociateIpGroupsResult |
associateIpGroups(AssociateIpGroupsRequest request)
Associates the specified IP access control group with the specified directory.
|
AssociateWorkspaceApplicationResult |
associateWorkspaceApplication(AssociateWorkspaceApplicationRequest request)
Associates the specified application to the specified WorkSpace.
|
AuthorizeIpRulesResult |
authorizeIpRules(AuthorizeIpRulesRequest request)
Adds one or more rules to the specified IP access control group.
|
CopyWorkspaceImageResult |
copyWorkspaceImage(CopyWorkspaceImageRequest request)
Copies the specified image from the specified Region to the current Region.
|
CreateAccountLinkInvitationResult |
createAccountLinkInvitation(CreateAccountLinkInvitationRequest request)
Creates the account link invitation.
|
CreateConnectClientAddInResult |
createConnectClientAddIn(CreateConnectClientAddInRequest request)
Creates a client-add-in for Amazon Connect within a directory.
|
CreateConnectionAliasResult |
createConnectionAlias(CreateConnectionAliasRequest request)
Creates the specified connection alias for use with cross-Region redirection.
|
CreateIpGroupResult |
createIpGroup(CreateIpGroupRequest request)
Creates an IP access control group.
|
CreateStandbyWorkspacesResult |
createStandbyWorkspaces(CreateStandbyWorkspacesRequest request)
Creates a standby WorkSpace in a secondary Region.
|
CreateTagsResult |
createTags(CreateTagsRequest request)
Creates the specified tags for the specified WorkSpaces resource.
|
CreateUpdatedWorkspaceImageResult |
createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest request)
Creates a new updated WorkSpace image based on the specified source image.
|
CreateWorkspaceBundleResult |
createWorkspaceBundle(CreateWorkspaceBundleRequest request)
Creates the specified WorkSpace bundle.
|
CreateWorkspaceImageResult |
createWorkspaceImage(CreateWorkspaceImageRequest request)
Creates a new WorkSpace image from an existing WorkSpace.
|
CreateWorkspacesResult |
createWorkspaces(CreateWorkspacesRequest request)
Creates one or more WorkSpaces.
|
CreateWorkspacesPoolResult |
createWorkspacesPool(CreateWorkspacesPoolRequest request)
Creates a pool of WorkSpaces.
|
DeleteAccountLinkInvitationResult |
deleteAccountLinkInvitation(DeleteAccountLinkInvitationRequest request)
Deletes the account link invitation.
|
DeleteClientBrandingResult |
deleteClientBranding(DeleteClientBrandingRequest request)
Deletes customized client branding.
|
DeleteConnectClientAddInResult |
deleteConnectClientAddIn(DeleteConnectClientAddInRequest request)
Deletes a client-add-in for Amazon Connect that is configured within a directory.
|
DeleteConnectionAliasResult |
deleteConnectionAlias(DeleteConnectionAliasRequest request)
Deletes the specified connection alias.
|
DeleteIpGroupResult |
deleteIpGroup(DeleteIpGroupRequest request)
Deletes the specified IP access control group.
|
DeleteTagsResult |
deleteTags(DeleteTagsRequest request)
Deletes the specified tags from the specified WorkSpaces resource.
|
DeleteWorkspaceBundleResult |
deleteWorkspaceBundle(DeleteWorkspaceBundleRequest request)
Deletes the specified WorkSpace bundle.
|
DeleteWorkspaceImageResult |
deleteWorkspaceImage(DeleteWorkspaceImageRequest request)
Deletes the specified image from your account.
|
DeployWorkspaceApplicationsResult |
deployWorkspaceApplications(DeployWorkspaceApplicationsRequest request)
Deploys associated applications to the specified WorkSpace
|
DeregisterWorkspaceDirectoryResult |
deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest request)
Deregisters the specified directory.
|
DescribeAccountResult |
describeAccount(DescribeAccountRequest request)
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
|
DescribeAccountModificationsResult |
describeAccountModifications(DescribeAccountModificationsRequest request)
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the
specified account.
|
DescribeApplicationAssociationsResult |
describeApplicationAssociations(DescribeApplicationAssociationsRequest request)
Describes the associations between the application and the specified associated resources.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest request)
Describes the specified applications by filtering based on their compute types, license availability, operating
systems, and owners.
|
DescribeBundleAssociationsResult |
describeBundleAssociations(DescribeBundleAssociationsRequest request)
Describes the associations between the applications and the specified bundle.
|
DescribeClientBrandingResult |
describeClientBranding(DescribeClientBrandingRequest request)
Describes the specified client branding.
|
DescribeClientPropertiesResult |
describeClientProperties(DescribeClientPropertiesRequest request)
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
|
DescribeConnectClientAddInsResult |
describeConnectClientAddIns(DescribeConnectClientAddInsRequest request)
Retrieves a list of Amazon Connect client add-ins that have been created.
|
DescribeConnectionAliasesResult |
describeConnectionAliases(DescribeConnectionAliasesRequest request)
Retrieves a list that describes the connection aliases used for cross-Region redirection.
|
DescribeConnectionAliasPermissionsResult |
describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest request)
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account
for the specified connection alias.
|
DescribeImageAssociationsResult |
describeImageAssociations(DescribeImageAssociationsRequest request)
Describes the associations between the applications and the specified image.
|
DescribeIpGroupsResult |
describeIpGroups(DescribeIpGroupsRequest request)
Describes one or more of your IP access control groups.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest request)
Describes the specified tags for the specified WorkSpaces resource.
|
DescribeWorkspaceAssociationsResult |
describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest request)
Describes the associations betweens applications and the specified WorkSpace.
|
DescribeWorkspaceBundlesResult |
describeWorkspaceBundles()
Simplified method form for invoking the DescribeWorkspaceBundles operation.
|
DescribeWorkspaceBundlesResult |
describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request)
Retrieves a list that describes the available WorkSpace bundles.
|
DescribeWorkspaceDirectoriesResult |
describeWorkspaceDirectories()
Simplified method form for invoking the DescribeWorkspaceDirectories operation.
|
DescribeWorkspaceDirectoriesResult |
describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request)
Describes the available directories that are registered with Amazon WorkSpaces.
|
DescribeWorkspaceImagePermissionsResult |
describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest request)
Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an
image.
|
DescribeWorkspaceImagesResult |
describeWorkspaceImages(DescribeWorkspaceImagesRequest request)
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
|
DescribeWorkspacesResult |
describeWorkspaces()
Simplified method form for invoking the DescribeWorkspaces operation.
|
DescribeWorkspacesResult |
describeWorkspaces(DescribeWorkspacesRequest request)
Describes the specified WorkSpaces.
|
DescribeWorkspacesConnectionStatusResult |
describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request)
Describes the connection status of the specified WorkSpaces.
|
DescribeWorkspaceSnapshotsResult |
describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest request)
Describes the snapshots for the specified WorkSpace.
|
DescribeWorkspacesPoolsResult |
describeWorkspacesPools(DescribeWorkspacesPoolsRequest request)
Describes the specified WorkSpaces Pools.
|
DescribeWorkspacesPoolSessionsResult |
describeWorkspacesPoolSessions(DescribeWorkspacesPoolSessionsRequest request)
Retrieves a list that describes the streaming sessions for a specified pool.
|
DisassociateConnectionAliasResult |
disassociateConnectionAlias(DisassociateConnectionAliasRequest request)
Disassociates a connection alias from a directory.
|
DisassociateIpGroupsResult |
disassociateIpGroups(DisassociateIpGroupsRequest request)
Disassociates the specified IP access control group from the specified directory.
|
DisassociateWorkspaceApplicationResult |
disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest request)
Disassociates the specified application from a WorkSpace.
|
GetAccountLinkResult |
getAccountLink(GetAccountLinkRequest request)
Retrieves account link information.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ImportClientBrandingResult |
importClientBranding(ImportClientBrandingRequest request)
Imports client branding.
|
ImportWorkspaceImageResult |
importWorkspaceImage(ImportWorkspaceImageRequest request)
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
|
ListAccountLinksResult |
listAccountLinks(ListAccountLinksRequest request)
Lists all account links.
|
ListAvailableManagementCidrRangesResult |
listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request)
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).
|
MigrateWorkspaceResult |
migrateWorkspace(MigrateWorkspaceRequest request)
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user
volume.
|
ModifyAccountResult |
modifyAccount(ModifyAccountRequest request)
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
|
ModifyCertificateBasedAuthPropertiesResult |
modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest request)
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
|
ModifyClientPropertiesResult |
modifyClientProperties(ModifyClientPropertiesRequest request)
Modifies the properties of the specified Amazon WorkSpaces clients.
|
ModifySamlPropertiesResult |
modifySamlProperties(ModifySamlPropertiesRequest request)
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.
|
ModifySelfservicePermissionsResult |
modifySelfservicePermissions(ModifySelfservicePermissionsRequest request)
Modifies the self-service WorkSpace management capabilities for your users.
|
ModifyStreamingPropertiesResult |
modifyStreamingProperties(ModifyStreamingPropertiesRequest request)
Modifies the specified streaming properties.
|
ModifyWorkspaceAccessPropertiesResult |
modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest request)
Specifies which devices and operating systems users can use to access their WorkSpaces.
|
ModifyWorkspaceCreationPropertiesResult |
modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest request)
Modify the default properties used to create WorkSpaces.
|
ModifyWorkspacePropertiesResult |
modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request)
Modifies the specified WorkSpace properties.
|
ModifyWorkspaceStateResult |
modifyWorkspaceState(ModifyWorkspaceStateRequest request)
Sets the state of the specified WorkSpace.
|
RebootWorkspacesResult |
rebootWorkspaces(RebootWorkspacesRequest request)
Reboots the specified WorkSpaces.
|
RebuildWorkspacesResult |
rebuildWorkspaces(RebuildWorkspacesRequest request)
Rebuilds the specified WorkSpace.
|
RegisterWorkspaceDirectoryResult |
registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest request)
Registers the specified directory.
|
RejectAccountLinkInvitationResult |
rejectAccountLinkInvitation(RejectAccountLinkInvitationRequest request)
Rejects the account link invitation.
|
RestoreWorkspaceResult |
restoreWorkspace(RestoreWorkspaceRequest request)
Restores the specified WorkSpace to its last known healthy state.
|
RevokeIpRulesResult |
revokeIpRules(RevokeIpRulesRequest request)
Removes one or more rules from the specified IP access control group.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://workspaces.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonWorkspaces.setEndpoint(String), sets the regional endpoint for this client's
service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartWorkspacesResult |
startWorkspaces(StartWorkspacesRequest request)
Starts the specified WorkSpaces.
|
StartWorkspacesPoolResult |
startWorkspacesPool(StartWorkspacesPoolRequest request)
Starts the specified pool.
|
StopWorkspacesResult |
stopWorkspaces(StopWorkspacesRequest request)
Stops the specified WorkSpaces.
|
StopWorkspacesPoolResult |
stopWorkspacesPool(StopWorkspacesPoolRequest request)
Stops the specified pool.
|
TerminateWorkspacesResult |
terminateWorkspaces(TerminateWorkspacesRequest request)
Terminates the specified WorkSpaces.
|
TerminateWorkspacesPoolResult |
terminateWorkspacesPool(TerminateWorkspacesPoolRequest request)
Terminates the specified pool.
|
TerminateWorkspacesPoolSessionResult |
terminateWorkspacesPoolSession(TerminateWorkspacesPoolSessionRequest request)
Terminates the pool session.
|
UpdateConnectClientAddInResult |
updateConnectClientAddIn(UpdateConnectClientAddInRequest request)
Updates a Amazon Connect client add-in.
|
UpdateConnectionAliasPermissionResult |
updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest request)
Shares or unshares a connection alias with one account by specifying whether that account has permission to
associate the connection alias with a directory.
|
UpdateRulesOfIpGroupResult |
updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request)
Replaces the current rules of the specified IP access control group with the specified rules.
|
UpdateWorkspaceBundleResult |
updateWorkspaceBundle(UpdateWorkspaceBundleRequest request)
Updates a WorkSpace bundle with a new image.
|
UpdateWorkspaceImagePermissionResult |
updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest request)
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.
|
UpdateWorkspacesPoolResult |
updateWorkspacesPool(UpdateWorkspacesPoolRequest request)
Updates the specified pool.
|
public void setEndpoint(String endpoint)
AmazonWorkspaces
Callers can pass in just the endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the
protocol (ex: "https://workspaces.us-east-1.amazonaws.com"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonWorkspacesendpoint - The endpoint (ex: "workspaces.us-east-1.amazonaws.com") or a full URL, including the protocol (ex:
"https://workspaces.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will
communicate with.public void setRegion(Region region)
AmazonWorkspacesAmazonWorkspaces.setEndpoint(String), sets the regional endpoint for this client's
service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonWorkspacesregion - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public AcceptAccountLinkInvitationResult acceptAccountLinkInvitation(AcceptAccountLinkInvitationRequest request)
AmazonWorkspacesAccepts the account link invitation.
There's currently no unlinking capability after you accept the account linking invitation.
acceptAccountLinkInvitation in interface AmazonWorkspacespublic AssociateConnectionAliasResult associateConnectionAlias(AssociateConnectionAliasRequest request)
AmazonWorkspacesAssociates 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
.
associateConnectionAlias in interface AmazonWorkspacespublic AssociateIpGroupsResult associateIpGroups(AssociateIpGroupsRequest request)
AmazonWorkspacesAssociates the specified IP access control group with the specified directory.
associateIpGroups in interface AmazonWorkspacespublic AssociateWorkspaceApplicationResult associateWorkspaceApplication(AssociateWorkspaceApplicationRequest request)
AmazonWorkspacesAssociates the specified application to the specified WorkSpace.
associateWorkspaceApplication in interface AmazonWorkspacespublic AuthorizeIpRulesResult authorizeIpRules(AuthorizeIpRulesRequest request)
AmazonWorkspacesAdds 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.
authorizeIpRules in interface AmazonWorkspacespublic CopyWorkspaceImageResult copyWorkspaceImage(CopyWorkspaceImageRequest request)
AmazonWorkspacesCopies 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.
copyWorkspaceImage in interface AmazonWorkspacespublic CreateAccountLinkInvitationResult createAccountLinkInvitation(CreateAccountLinkInvitationRequest request)
AmazonWorkspacesCreates the account link invitation.
createAccountLinkInvitation in interface AmazonWorkspacespublic CreateConnectClientAddInResult createConnectClientAddIn(CreateConnectClientAddInRequest request)
AmazonWorkspacesCreates 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.
createConnectClientAddIn in interface AmazonWorkspacespublic CreateConnectionAliasResult createConnectionAlias(CreateConnectionAliasRequest request)
AmazonWorkspacesCreates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
createConnectionAlias in interface AmazonWorkspacespublic CreateIpGroupResult createIpGroup(CreateIpGroupRequest request)
AmazonWorkspacesCreates 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.
createIpGroup in interface AmazonWorkspacespublic CreateStandbyWorkspacesResult createStandbyWorkspaces(CreateStandbyWorkspacesRequest request)
AmazonWorkspacesCreates a standby WorkSpace in a secondary Region.
createStandbyWorkspaces in interface AmazonWorkspacespublic CreateTagsResult createTags(CreateTagsRequest request)
AmazonWorkspacesCreates the specified tags for the specified WorkSpaces resource.
createTags in interface AmazonWorkspacespublic CreateUpdatedWorkspaceImageResult createUpdatedWorkspaceImage(CreateUpdatedWorkspaceImageRequest request)
AmazonWorkspacesCreates 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.
createUpdatedWorkspaceImage in interface AmazonWorkspacespublic CreateWorkspaceBundleResult createWorkspaceBundle(CreateWorkspaceBundleRequest request)
AmazonWorkspacesCreates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
createWorkspaceBundle in interface AmazonWorkspacespublic CreateWorkspaceImageResult createWorkspaceImage(CreateWorkspaceImageRequest request)
AmazonWorkspacesCreates a new WorkSpace image from an existing WorkSpace.
createWorkspaceImage in interface AmazonWorkspacespublic CreateWorkspacesResult createWorkspaces(CreateWorkspacesRequest request)
AmazonWorkspacesCreates 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 because WSP is the
default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
createWorkspaces in interface AmazonWorkspacespublic CreateWorkspacesPoolResult createWorkspacesPool(CreateWorkspacesPoolRequest request)
AmazonWorkspacesCreates a pool of WorkSpaces.
createWorkspacesPool in interface AmazonWorkspacespublic DeleteAccountLinkInvitationResult deleteAccountLinkInvitation(DeleteAccountLinkInvitationRequest request)
AmazonWorkspacesDeletes the account link invitation.
deleteAccountLinkInvitation in interface AmazonWorkspacespublic DeleteClientBrandingResult deleteClientBranding(DeleteClientBrandingRequest request)
AmazonWorkspacesDeletes 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.
deleteClientBranding in interface AmazonWorkspacespublic DeleteConnectClientAddInResult deleteConnectClientAddIn(DeleteConnectClientAddInRequest request)
AmazonWorkspacesDeletes a client-add-in for Amazon Connect that is configured within a directory.
deleteConnectClientAddIn in interface AmazonWorkspacespublic DeleteConnectionAliasResult deleteConnectionAlias(DeleteConnectionAliasRequest request)
AmazonWorkspacesDeletes 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.
deleteConnectionAlias in interface AmazonWorkspacespublic DeleteIpGroupResult deleteIpGroup(DeleteIpGroupRequest request)
AmazonWorkspacesDeletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
deleteIpGroup in interface AmazonWorkspacespublic DeleteTagsResult deleteTags(DeleteTagsRequest request)
AmazonWorkspacesDeletes the specified tags from the specified WorkSpaces resource.
deleteTags in interface AmazonWorkspacespublic DeleteWorkspaceBundleResult deleteWorkspaceBundle(DeleteWorkspaceBundleRequest request)
AmazonWorkspacesDeletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
deleteWorkspaceBundle in interface AmazonWorkspacespublic DeleteWorkspaceImageResult deleteWorkspaceImage(DeleteWorkspaceImageRequest request)
AmazonWorkspacesDeletes 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.
deleteWorkspaceImage in interface AmazonWorkspacespublic DeployWorkspaceApplicationsResult deployWorkspaceApplications(DeployWorkspaceApplicationsRequest request)
AmazonWorkspacesDeploys associated applications to the specified WorkSpace
deployWorkspaceApplications in interface AmazonWorkspacespublic DeregisterWorkspaceDirectoryResult deregisterWorkspaceDirectory(DeregisterWorkspaceDirectoryRequest request)
AmazonWorkspacesDeregisters 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.
deregisterWorkspaceDirectory in interface AmazonWorkspacespublic DescribeAccountResult describeAccount(DescribeAccountRequest request)
AmazonWorkspacesRetrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccount in interface AmazonWorkspacespublic DescribeAccountModificationsResult describeAccountModifications(DescribeAccountModificationsRequest request)
AmazonWorkspacesRetrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
describeAccountModifications in interface AmazonWorkspacespublic DescribeApplicationAssociationsResult describeApplicationAssociations(DescribeApplicationAssociationsRequest request)
AmazonWorkspacesDescribes the associations between the application and the specified associated resources.
describeApplicationAssociations in interface AmazonWorkspacespublic DescribeApplicationsResult describeApplications(DescribeApplicationsRequest request)
AmazonWorkspacesDescribes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
describeApplications in interface AmazonWorkspacespublic DescribeBundleAssociationsResult describeBundleAssociations(DescribeBundleAssociationsRequest request)
AmazonWorkspacesDescribes the associations between the applications and the specified bundle.
describeBundleAssociations in interface AmazonWorkspacespublic DescribeClientBrandingResult describeClientBranding(DescribeClientBrandingRequest request)
AmazonWorkspacesDescribes 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.
describeClientBranding in interface AmazonWorkspacespublic DescribeClientPropertiesResult describeClientProperties(DescribeClientPropertiesRequest request)
AmazonWorkspacesRetrieves a list that describes one or more specified Amazon WorkSpaces clients.
describeClientProperties in interface AmazonWorkspacespublic DescribeConnectClientAddInsResult describeConnectClientAddIns(DescribeConnectClientAddInsRequest request)
AmazonWorkspacesRetrieves a list of Amazon Connect client add-ins that have been created.
describeConnectClientAddIns in interface AmazonWorkspacespublic DescribeConnectionAliasPermissionsResult describeConnectionAliasPermissions(DescribeConnectionAliasPermissionsRequest request)
AmazonWorkspacesDescribes 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.
describeConnectionAliasPermissions in interface AmazonWorkspacespublic DescribeConnectionAliasesResult describeConnectionAliases(DescribeConnectionAliasesRequest request)
AmazonWorkspacesRetrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
describeConnectionAliases in interface AmazonWorkspacespublic DescribeImageAssociationsResult describeImageAssociations(DescribeImageAssociationsRequest request)
AmazonWorkspacesDescribes the associations between the applications and the specified image.
describeImageAssociations in interface AmazonWorkspacespublic DescribeIpGroupsResult describeIpGroups(DescribeIpGroupsRequest request)
AmazonWorkspacesDescribes one or more of your IP access control groups.
describeIpGroups in interface AmazonWorkspacespublic DescribeTagsResult describeTags(DescribeTagsRequest request)
AmazonWorkspacesDescribes the specified tags for the specified WorkSpaces resource.
describeTags in interface AmazonWorkspacespublic DescribeWorkspaceAssociationsResult describeWorkspaceAssociations(DescribeWorkspaceAssociationsRequest request)
AmazonWorkspacesDescribes the associations betweens applications and the specified WorkSpace.
describeWorkspaceAssociations in interface AmazonWorkspacespublic DescribeWorkspaceBundlesResult describeWorkspaceBundles(DescribeWorkspaceBundlesRequest request)
AmazonWorkspacesRetrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
describeWorkspaceBundles in interface AmazonWorkspacespublic DescribeWorkspaceBundlesResult describeWorkspaceBundles()
AmazonWorkspacesdescribeWorkspaceBundles in interface AmazonWorkspacesAmazonWorkspaces.describeWorkspaceBundles(DescribeWorkspaceBundlesRequest)public DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest request)
AmazonWorkspacesDescribes the available directories that are registered with Amazon WorkSpaces.
describeWorkspaceDirectories in interface AmazonWorkspacespublic DescribeWorkspaceDirectoriesResult describeWorkspaceDirectories()
AmazonWorkspacesdescribeWorkspaceDirectories in interface AmazonWorkspacesAmazonWorkspaces.describeWorkspaceDirectories(DescribeWorkspaceDirectoriesRequest)public DescribeWorkspaceImagePermissionsResult describeWorkspaceImagePermissions(DescribeWorkspaceImagePermissionsRequest request)
AmazonWorkspacesDescribes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
describeWorkspaceImagePermissions in interface AmazonWorkspacespublic DescribeWorkspaceImagesResult describeWorkspaceImages(DescribeWorkspaceImagesRequest request)
AmazonWorkspacesRetrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
describeWorkspaceImages in interface AmazonWorkspacespublic DescribeWorkspaceSnapshotsResult describeWorkspaceSnapshots(DescribeWorkspaceSnapshotsRequest request)
AmazonWorkspacesDescribes the snapshots for the specified WorkSpace.
describeWorkspaceSnapshots in interface AmazonWorkspacespublic DescribeWorkspacesResult describeWorkspaces(DescribeWorkspacesRequest request)
AmazonWorkspacesDescribes 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.
describeWorkspaces in interface AmazonWorkspacespublic DescribeWorkspacesResult describeWorkspaces()
AmazonWorkspacesdescribeWorkspaces in interface AmazonWorkspacesAmazonWorkspaces.describeWorkspaces(DescribeWorkspacesRequest)public DescribeWorkspacesConnectionStatusResult describeWorkspacesConnectionStatus(DescribeWorkspacesConnectionStatusRequest request)
AmazonWorkspacesDescribes the connection status of the specified WorkSpaces.
describeWorkspacesConnectionStatus in interface AmazonWorkspacespublic DescribeWorkspacesPoolSessionsResult describeWorkspacesPoolSessions(DescribeWorkspacesPoolSessionsRequest request)
AmazonWorkspacesRetrieves a list that describes the streaming sessions for a specified pool.
describeWorkspacesPoolSessions in interface AmazonWorkspacespublic DescribeWorkspacesPoolsResult describeWorkspacesPools(DescribeWorkspacesPoolsRequest request)
AmazonWorkspacesDescribes the specified WorkSpaces Pools.
describeWorkspacesPools in interface AmazonWorkspacespublic DisassociateConnectionAliasResult disassociateConnectionAlias(DisassociateConnectionAliasRequest request)
AmazonWorkspacesDisassociates 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
.
disassociateConnectionAlias in interface AmazonWorkspacespublic DisassociateIpGroupsResult disassociateIpGroups(DisassociateIpGroupsRequest request)
AmazonWorkspacesDisassociates the specified IP access control group from the specified directory.
disassociateIpGroups in interface AmazonWorkspacespublic DisassociateWorkspaceApplicationResult disassociateWorkspaceApplication(DisassociateWorkspaceApplicationRequest request)
AmazonWorkspacesDisassociates the specified application from a WorkSpace.
disassociateWorkspaceApplication in interface AmazonWorkspacespublic GetAccountLinkResult getAccountLink(GetAccountLinkRequest request)
AmazonWorkspacesRetrieves account link information.
getAccountLink in interface AmazonWorkspacespublic ImportClientBrandingResult importClientBranding(ImportClientBrandingRequest request)
AmazonWorkspacesImports 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 and SupportLink 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.
importClientBranding in interface AmazonWorkspacespublic ImportWorkspaceImageResult importWorkspaceImage(ImportWorkspaceImageRequest request)
AmazonWorkspacesImports 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.
importWorkspaceImage in interface AmazonWorkspacespublic ListAccountLinksResult listAccountLinks(ListAccountLinksRequest request)
AmazonWorkspacesLists all account links.
listAccountLinks in interface AmazonWorkspacespublic ListAvailableManagementCidrRangesResult listAvailableManagementCidrRanges(ListAvailableManagementCidrRangesRequest request)
AmazonWorkspacesRetrieves 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.
listAvailableManagementCidrRanges in interface AmazonWorkspacespublic MigrateWorkspaceResult migrateWorkspace(MigrateWorkspaceRequest request)
AmazonWorkspacesMigrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the
user volume from the last available snapshot of the original WorkSpace. During migration, the original
D:\Users\%USERNAME% user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is
generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
migrateWorkspace in interface AmazonWorkspacespublic ModifyAccountResult modifyAccount(ModifyAccountRequest request)
AmazonWorkspacesModifies the configuration of Bring Your Own License (BYOL) for the specified account.
modifyAccount in interface AmazonWorkspacespublic ModifyCertificateBasedAuthPropertiesResult modifyCertificateBasedAuthProperties(ModifyCertificateBasedAuthPropertiesRequest request)
AmazonWorkspacesModifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
modifyCertificateBasedAuthProperties in interface AmazonWorkspacespublic ModifyClientPropertiesResult modifyClientProperties(ModifyClientPropertiesRequest request)
AmazonWorkspacesModifies the properties of the specified Amazon WorkSpaces clients.
modifyClientProperties in interface AmazonWorkspacespublic ModifySamlPropertiesResult modifySamlProperties(ModifySamlPropertiesRequest request)
AmazonWorkspacesModifies 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.
modifySamlProperties in interface AmazonWorkspacespublic ModifySelfservicePermissionsResult modifySelfservicePermissions(ModifySelfservicePermissionsRequest request)
AmazonWorkspacesModifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
modifySelfservicePermissions in interface AmazonWorkspacespublic ModifyStreamingPropertiesResult modifyStreamingProperties(ModifyStreamingPropertiesRequest request)
AmazonWorkspacesModifies the specified streaming properties.
modifyStreamingProperties in interface AmazonWorkspacespublic ModifyWorkspaceAccessPropertiesResult modifyWorkspaceAccessProperties(ModifyWorkspaceAccessPropertiesRequest request)
AmazonWorkspacesSpecifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
modifyWorkspaceAccessProperties in interface AmazonWorkspacespublic ModifyWorkspaceCreationPropertiesResult modifyWorkspaceCreationProperties(ModifyWorkspaceCreationPropertiesRequest request)
AmazonWorkspacesModify the default properties used to create WorkSpaces.
modifyWorkspaceCreationProperties in interface AmazonWorkspacespublic ModifyWorkspacePropertiesResult modifyWorkspaceProperties(ModifyWorkspacePropertiesRequest request)
AmazonWorkspacesModifies 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.
modifyWorkspaceProperties in interface AmazonWorkspacespublic ModifyWorkspaceStateResult modifyWorkspaceState(ModifyWorkspaceStateRequest request)
AmazonWorkspacesSets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE.
WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE
state.
modifyWorkspaceState in interface AmazonWorkspacespublic RebootWorkspacesResult rebootWorkspaces(RebootWorkspacesRequest request)
AmazonWorkspacesReboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE, UNHEALTHY, or
REBOOTING. Reboot a WorkSpace in the REBOOTING state only if your WorkSpace has been
stuck in the REBOOTING state for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
rebootWorkspaces in interface AmazonWorkspacespublic RebuildWorkspacesResult rebuildWorkspaces(RebuildWorkspacesRequest request)
AmazonWorkspacesRebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
rebuildWorkspaces in interface AmazonWorkspacespublic RegisterWorkspaceDirectoryResult registerWorkspaceDirectory(RegisterWorkspaceDirectoryRequest request)
AmazonWorkspacesRegisters 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.
registerWorkspaceDirectory in interface AmazonWorkspacespublic RejectAccountLinkInvitationResult rejectAccountLinkInvitation(RejectAccountLinkInvitationRequest request)
AmazonWorkspacesRejects the account link invitation.
rejectAccountLinkInvitation in interface AmazonWorkspacespublic RestoreWorkspaceResult restoreWorkspace(RestoreWorkspaceRequest request)
AmazonWorkspacesRestores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR,
UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
restoreWorkspace in interface AmazonWorkspacespublic RevokeIpRulesResult revokeIpRules(RevokeIpRulesRequest request)
AmazonWorkspacesRemoves one or more rules from the specified IP access control group.
revokeIpRules in interface AmazonWorkspacespublic StartWorkspacesResult startWorkspaces(StartWorkspacesRequest request)
AmazonWorkspacesStarts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of
STOPPED.
startWorkspaces in interface AmazonWorkspacespublic StartWorkspacesPoolResult startWorkspacesPool(StartWorkspacesPoolRequest request)
AmazonWorkspacesStarts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED
.
startWorkspacesPool in interface AmazonWorkspacespublic StopWorkspacesResult stopWorkspaces(StopWorkspacesRequest request)
AmazonWorkspacesStops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspaces in interface AmazonWorkspacespublic StopWorkspacesPoolResult stopWorkspacesPool(StopWorkspacesPoolRequest request)
AmazonWorkspacesStops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of AutoStop and a state of
AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.
stopWorkspacesPool in interface AmazonWorkspacespublic TerminateWorkspacesResult terminateWorkspaces(TerminateWorkspacesRequest request)
AmazonWorkspacesTerminates 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.
terminateWorkspaces in interface AmazonWorkspacespublic TerminateWorkspacesPoolResult terminateWorkspacesPool(TerminateWorkspacesPoolRequest request)
AmazonWorkspacesTerminates the specified pool.
terminateWorkspacesPool in interface AmazonWorkspacespublic TerminateWorkspacesPoolSessionResult terminateWorkspacesPoolSession(TerminateWorkspacesPoolSessionRequest request)
AmazonWorkspacesTerminates the pool session.
terminateWorkspacesPoolSession in interface AmazonWorkspacespublic UpdateConnectClientAddInResult updateConnectClientAddIn(UpdateConnectClientAddInRequest request)
AmazonWorkspacesUpdates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
updateConnectClientAddIn in interface AmazonWorkspacespublic UpdateConnectionAliasPermissionResult updateConnectionAliasPermission(UpdateConnectionAliasPermissionRequest request)
AmazonWorkspacesShares 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.
updateConnectionAliasPermission in interface AmazonWorkspacespublic UpdateRulesOfIpGroupResult updateRulesOfIpGroup(UpdateRulesOfIpGroupRequest request)
AmazonWorkspacesReplaces the current rules of the specified IP access control group with the specified rules.
updateRulesOfIpGroup in interface AmazonWorkspacespublic UpdateWorkspaceBundleResult updateWorkspaceBundle(UpdateWorkspaceBundleRequest request)
AmazonWorkspacesUpdates 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.
updateWorkspaceBundle in interface AmazonWorkspacespublic UpdateWorkspaceImagePermissionResult updateWorkspaceImagePermission(UpdateWorkspaceImagePermissionRequest request)
AmazonWorkspacesShares 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.
updateWorkspaceImagePermission in interface AmazonWorkspacespublic UpdateWorkspacesPoolResult updateWorkspacesPool(UpdateWorkspacesPoolRequest request)
AmazonWorkspacesUpdates the specified pool.
updateWorkspacesPool in interface AmazonWorkspacespublic void shutdown()
AmazonWorkspacesshutdown in interface AmazonWorkspacespublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonWorkspacesResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonWorkspacesrequest - The originally executed request.