AWS.WorkSpaces — AWS SDK for JavaScript (original) (raw)

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptAccountLinkInvitation(params = {}, callback) ⇒ AWS.Request

Accepts the account link invitation.

There's currently no unlinking capability after you accept the account linking invitation.

associateConnectionAlias(params = {}, callback) ⇒ AWS.Request

associateIpGroups(params = {}, callback) ⇒ AWS.Request

Associates the specified IP access control group with the specified directory.

associateWorkspaceApplication(params = {}, callback) ⇒ AWS.Request

Associates the specified application to the specified WorkSpace.

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.

copyWorkspaceImage(params = {}, callback) ⇒ AWS.Request

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.

createAccountLinkInvitation(params = {}, callback) ⇒ AWS.Request

Creates the account link invitation.

createConnectClientAddIn(params = {}, callback) ⇒ AWS.Request

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.

createConnectionAlias(params = {}, callback) ⇒ AWS.Request

createIpGroup(params = {}, callback) ⇒ AWS.Request

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.

createStandbyWorkspaces(params = {}, callback) ⇒ AWS.Request

Creates a standby WorkSpace in a secondary Region.

createTags(params = {}, callback) ⇒ AWS.Request

Creates the specified tags for the specified WorkSpaces resource.

createUpdatedWorkspaceImage(params = {}, callback) ⇒ AWS.Request

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.

Note:

• 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.

createWorkspaceBundle(params = {}, callback) ⇒ AWS.Request

createWorkspaceImage(params = {}, callback) ⇒ AWS.Request

Creates a new WorkSpace image from an existing WorkSpace.

createWorkspaces(params = {}, callback) ⇒ AWS.Request

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

Note:

• 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?

createWorkspacesPool(params = {}, callback) ⇒ AWS.Request

Creates a pool of WorkSpaces.

deleteAccountLinkInvitation(params = {}, callback) ⇒ AWS.Request

Deletes the account link invitation.

deleteClientBranding(params = {}, callback) ⇒ AWS.Request

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.

deleteConnectClientAddIn(params = {}, callback) ⇒ AWS.Request

Deletes a client-add-in for Amazon Connect that is configured within a directory.

deleteConnectionAlias(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

deleteIpGroup(params = {}, callback) ⇒ AWS.Request

Deletes the specified IP access control group.

You cannot delete an IP access control group that is associated with a directory.

deleteTags(params = {}, callback) ⇒ AWS.Request

Deletes the specified tags from the specified WorkSpaces resource.

deleteWorkspaceBundle(params = {}, callback) ⇒ AWS.Request

deleteWorkspaceImage(params = {}, callback) ⇒ AWS.Request

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.

deployWorkspaceApplications(params = {}, callback) ⇒ AWS.Request

Deploys associated applications to the specified WorkSpace

deregisterWorkspaceDirectory(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

describeAccount(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.

describeAccountModifications(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.

describeApplicationAssociations(params = {}, callback) ⇒ AWS.Request

Describes the associations between the application and the specified associated resources.

describeApplications(params = {}, callback) ⇒ AWS.Request

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

describeBundleAssociations(params = {}, callback) ⇒ AWS.Request

Describes the associations between the applications and the specified bundle.

describeClientBranding(params = {}, callback) ⇒ AWS.Request

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.

Note: Only device types that have branding information configured will be shown in the response.

describeClientProperties(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

describeConnectClientAddIns(params = {}, callback) ⇒ AWS.Request

Retrieves a list of Amazon Connect client add-ins that have been created.

describeConnectionAliases(params = {}, callback) ⇒ AWS.Request

describeConnectionAliasPermissions(params = {}, callback) ⇒ AWS.Request

describeImageAssociations(params = {}, callback) ⇒ AWS.Request

Describes the associations between the applications and the specified image.

describeIpGroups(params = {}, callback) ⇒ AWS.Request

Describes one or more of your IP access control groups.

describeTags(params = {}, callback) ⇒ AWS.Request

Describes the specified tags for the specified WorkSpaces resource.

describeWorkspaceAssociations(params = {}, callback) ⇒ AWS.Request

Describes the associations betweens applications and the specified WorkSpace.

describeWorkspaceBundles(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

describeWorkspaceDirectories(params = {}, callback) ⇒ AWS.Request

Describes the available directories that are registered with Amazon WorkSpaces.

describeWorkspaceImagePermissions(params = {}, callback) ⇒ AWS.Request

Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.

describeWorkspaceImages(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

describeWorkspaces(params = {}, callback) ⇒ AWS.Request

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.

describeWorkspacesConnectionStatus(params = {}, callback) ⇒ AWS.Request

Describes the connection status of the specified WorkSpaces.

describeWorkspaceSnapshots(params = {}, callback) ⇒ AWS.Request

Describes the snapshots for the specified WorkSpace.

describeWorkspacesPools(params = {}, callback) ⇒ AWS.Request

Describes the specified WorkSpaces Pools.

describeWorkspacesPoolSessions(params = {}, callback) ⇒ AWS.Request

Retrieves a list that describes the streaming sessions for a specified pool.

disassociateConnectionAlias(params = {}, callback) ⇒ AWS.Request

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.

Note: Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

disassociateIpGroups(params = {}, callback) ⇒ AWS.Request

Disassociates the specified IP access control group from the specified directory.

disassociateWorkspaceApplication(params = {}, callback) ⇒ AWS.Request

Disassociates the specified application from a WorkSpace.

getAccountLink(params = {}, callback) ⇒ AWS.Request

Retrieves account link information.

importClientBranding(params = {}, callback) ⇒ AWS.Request

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

Note:

• 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.

importWorkspaceImage(params = {}, callback) ⇒ AWS.Request

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.

listAccountLinks(params = {}, callback) ⇒ AWS.Request

listAvailableManagementCidrRanges(params = {}, callback) ⇒ AWS.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).

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.

migrateWorkspace(params = {}, callback) ⇒ AWS.Request

Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.

The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.

For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.

modifyAccount(params = {}, callback) ⇒ AWS.Request

Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

modifyCertificateBasedAuthProperties(params = {}, callback) ⇒ AWS.Request

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

modifyClientProperties(params = {}, callback) ⇒ AWS.Request

Modifies the properties of the specified Amazon WorkSpaces clients.

modifySamlProperties(params = {}, callback) ⇒ AWS.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.

modifySelfservicePermissions(params = {}, callback) ⇒ AWS.Request

modifyStreamingProperties(params = {}, callback) ⇒ AWS.Request

Modifies the specified streaming properties.

modifyWorkspaceAccessProperties(params = {}, callback) ⇒ AWS.Request

Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

modifyWorkspaceCreationProperties(params = {}, callback) ⇒ AWS.Request

Modify the default properties used to create WorkSpaces.

modifyWorkspaceProperties(params = {}, callback) ⇒ AWS.Request

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Note: 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.

modifyWorkspaceState(params = {}, callback) ⇒ AWS.Request

Sets the state of the specified WorkSpace.

To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

rebootWorkspaces(params = {}, callback) ⇒ AWS.Request

Reboots 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.

rebuildWorkspaces(params = {}, callback) ⇒ AWS.Request

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

registerWorkspaceDirectory(params = {}, callback) ⇒ AWS.Request

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.

rejectAccountLinkInvitation(params = {}, callback) ⇒ AWS.Request

Rejects the account link invitation.

restoreWorkspace(params = {}, callback) ⇒ AWS.Request

Restores the specified WorkSpace to its last known healthy state.

You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.

Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

This operation is asynchronous and returns before the WorkSpace is completely restored.

revokeIpRules(params = {}, callback) ⇒ AWS.Request

Removes one or more rules from the specified IP access control group.

startWorkspaces(params = {}, callback) ⇒ AWS.Request

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop or Manual and a state of STOPPED.

startWorkspacesPool(params = {}, callback) ⇒ AWS.Request

Starts the specified pool.

You cannot start a pool unless it has a running mode of AutoStop and a state of STOPPED.

stopWorkspaces(params = {}, callback) ⇒ AWS.Request

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop or Manual and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

stopWorkspacesPool(params = {}, callback) ⇒ AWS.Request

Stops 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.

terminateWorkspaces(params = {}, callback) ⇒ AWS.Request

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.

Note: 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.

terminateWorkspacesPool(params = {}, callback) ⇒ AWS.Request

Terminates the specified pool.

terminateWorkspacesPoolSession(params = {}, callback) ⇒ AWS.Request

Terminates the pool session.

updateConnectClientAddIn(params = {}, callback) ⇒ AWS.Request

Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.

updateConnectionAliasPermission(params = {}, callback) ⇒ AWS.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. 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.

Note:

• 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.

updateRulesOfIpGroup(params = {}, callback) ⇒ AWS.Request

Replaces the current rules of the specified IP access control group with the specified rules.

updateWorkspaceBundle(params = {}, callback) ⇒ AWS.Request

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.

updateWorkspaceImagePermission(params = {}, callback) ⇒ AWS.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. 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.

Note:

• 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.

updateWorkspacesPool(params = {}, callback) ⇒ AWS.Request

Updates the specified pool.