aws-elixir

View Source AWS.WorkSpaces (aws-elixir v1.0.4)

Amazon WorkSpaces Service

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.

Link to this section Summary

Functions

accept_account_link_invitation(client, input, options \\ [])

Accepts the account link invitation.

associate_connection_alias(client, input, options \\ [])

Associates the specified connection alias with the specified directory to enable cross-Region redirection.

associate_ip_groups(client, input, options \\ [])

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

associate_workspace_application(client, input, options \\ [])

Associates the specified application to the specified WorkSpace.

authorize_ip_rules(client, input, options \\ [])

Adds one or more rules to the specified IP access control group.

copy_workspace_image(client, input, options \\ [])

Copies the specified image from the specified Region to the current Region.

create_account_link_invitation(client, input, options \\ [])

Creates the account link invitation.

create_connect_client_add_in(client, input, options \\ [])

Creates a client-add-in for Amazon Connect within a directory.

create_connection_alias(client, input, options \\ [])

Creates the specified connection alias for use with cross-Region redirection.

create_ip_group(client, input, options \\ [])

Creates an IP access control group.

create_standby_workspaces(client, input, options \\ [])

Creates a standby WorkSpace in a secondary Region.

create_tags(client, input, options \\ [])

Creates the specified tags for the specified WorkSpaces resource.

create_updated_workspace_image(client, input, options \\ [])

Creates a new updated WorkSpace image based on the specified source image.

create_workspace_bundle(client, input, options \\ [])

Creates the specified WorkSpace bundle.

create_workspace_image(client, input, options \\ [])

Creates a new WorkSpace image from an existing WorkSpace.

create_workspaces(client, input, options \\ [])

Creates one or more WorkSpaces.

create_workspaces_pool(client, input, options \\ [])

Creates a pool of WorkSpaces.

delete_account_link_invitation(client, input, options \\ [])

Deletes the account link invitation.

delete_client_branding(client, input, options \\ [])

Deletes customized client branding.

delete_connect_client_add_in(client, input, options \\ [])

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

delete_connection_alias(client, input, options \\ [])

Deletes the specified connection alias.

delete_ip_group(client, input, options \\ [])

Deletes the specified IP access control group.

delete_tags(client, input, options \\ [])

Deletes the specified tags from the specified WorkSpaces resource.

delete_workspace_bundle(client, input, options \\ [])

Deletes the specified WorkSpace bundle.

delete_workspace_image(client, input, options \\ [])

Deletes the specified image from your account.

deploy_workspace_applications(client, input, options \\ [])

Deploys associated applications to the specified WorkSpace

deregister_workspace_directory(client, input, options \\ [])

Deregisters the specified directory.

describe_account(client, input, options \\ [])

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

describe_account_modifications(client, input, options \\ [])

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

describe_application_associations(client, input, options \\ [])

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

describe_applications(client, input, options \\ [])

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

describe_bundle_associations(client, input, options \\ [])

Describes the associations between the applications and the specified bundle.

describe_client_branding(client, input, options \\ [])

Describes the specified client branding.

describe_client_properties(client, input, options \\ [])

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

describe_connect_client_add_ins(client, input, options \\ [])

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

describe_connection_alias_permissions(client, input, options \\ [])

Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias.

describe_connection_aliases(client, input, options \\ [])

Retrieves a list that describes the connection aliases used for cross-Region redirection.

describe_image_associations(client, input, options \\ [])

Describes the associations between the applications and the specified image.

describe_ip_groups(client, input, options \\ [])

Describes one or more of your IP access control groups.

describe_tags(client, input, options \\ [])

Describes the specified tags for the specified WorkSpaces resource.

describe_workspace_associations(client, input, options \\ [])

Describes the associations betweens applications and the specified WorkSpace.

describe_workspace_bundles(client, input, options \\ [])

Retrieves a list that describes the available WorkSpace bundles.

describe_workspace_directories(client, input, options \\ [])

Describes the available directories that are registered with Amazon WorkSpaces.

describe_workspace_image_permissions(client, input, options \\ [])

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

describe_workspace_images(client, input, options \\ [])

Retrieves a list that describes one or more specified images, if the image identifiers are provided.

describe_workspace_snapshots(client, input, options \\ [])

Describes the snapshots for the specified WorkSpace.

describe_workspaces(client, input, options \\ [])

Describes the specified WorkSpaces.

describe_workspaces_connection_status(client, input, options \\ [])

Describes the connection status of the specified WorkSpaces.

describe_workspaces_pool_sessions(client, input, options \\ [])

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

describe_workspaces_pools(client, input, options \\ [])

Describes the specified WorkSpaces Pools.

disassociate_connection_alias(client, input, options \\ [])

Disassociates a connection alias from a directory.

disassociate_ip_groups(client, input, options \\ [])

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

disassociate_workspace_application(client, input, options \\ [])

Disassociates the specified application from a WorkSpace.

get_account_link(client, input, options \\ [])

Retrieves account link information.

import_client_branding(client, input, options \\ [])

Imports client branding.

import_workspace_image(client, input, options \\ [])

Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.

list_account_links(client, input, options \\ [])

Lists all account links.

list_available_management_cidr_ranges(client, input, options \\ [])

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

metadata()
migrate_workspace(client, input, options \\ [])

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

modify_account(client, input, options \\ [])

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

modify_certificate_based_auth_properties(client, input, options \\ [])

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

modify_client_properties(client, input, options \\ [])

Modifies the properties of the specified Amazon WorkSpaces clients.

modify_saml_properties(client, input, options \\ [])

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.

modify_selfservice_permissions(client, input, options \\ [])

Modifies the self-service WorkSpace management capabilities for your users.

modify_streaming_properties(client, input, options \\ [])

Modifies the specified streaming properties.

modify_workspace_access_properties(client, input, options \\ [])

Specifies which devices and operating systems users can use to access their WorkSpaces.

modify_workspace_creation_properties(client, input, options \\ [])

Modify the default properties used to create WorkSpaces.

modify_workspace_properties(client, input, options \\ [])

Modifies the specified WorkSpace properties.

modify_workspace_state(client, input, options \\ [])

Sets the state of the specified WorkSpace.

reboot_workspaces(client, input, options \\ [])

Reboots the specified WorkSpaces.

rebuild_workspaces(client, input, options \\ [])

Rebuilds the specified WorkSpace.

register_workspace_directory(client, input, options \\ [])

Registers the specified directory.

reject_account_link_invitation(client, input, options \\ [])

Rejects the account link invitation.

restore_workspace(client, input, options \\ [])

Restores the specified WorkSpace to its last known healthy state.

revoke_ip_rules(client, input, options \\ [])

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

start_workspaces(client, input, options \\ [])

Starts the specified WorkSpaces.

start_workspaces_pool(client, input, options \\ [])

Starts the specified pool.

stop_workspaces(client, input, options \\ [])

Stops the specified WorkSpaces.

stop_workspaces_pool(client, input, options \\ [])

Stops the specified pool.

terminate_workspaces(client, input, options \\ [])

Terminates the specified WorkSpaces.

terminate_workspaces_pool(client, input, options \\ [])

Terminates the specified pool.

terminate_workspaces_pool_session(client, input, options \\ [])

Terminates the pool session.

update_connect_client_add_in(client, input, options \\ [])

Updates a Amazon Connect client add-in.

update_connection_alias_permission(client, input, options \\ [])

Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.

update_rules_of_ip_group(client, input, options \\ [])

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

update_workspace_bundle(client, input, options \\ [])

Updates a WorkSpace bundle with a new image.

update_workspace_image_permission(client, input, options \\ [])

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.

update_workspaces_pool(client, input, options \\ [])

Updates the specified pool.

Link to this section Functions

Link to this function

associate_connection_alias(client, input, options \\ [])

View Source

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.

Link to this function

associate_ip_groups(client, input, options \\ [])

View Source

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

Link to this function

associate_workspace_application(client, input, options \\ [])

View Source

Associates the specified application to the specified WorkSpace.

Link to this function

authorize_ip_rules(client, input, options \\ [])

View Source

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.

Link to this function

copy_workspace_image(client, input, options \\ [])

View Source

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.

Link to this function

create_connect_client_add_in(client, input, options \\ [])

View Source

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.

Link to this function

create_connection_alias(client, input, options \\ [])

View Source

Creates the specified connection alias for use with cross-Region redirection.

For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link to this function

create_ip_group(client, input, options \\ [])

View Source

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.

Link to this function

create_standby_workspaces(client, input, options \\ [])

View Source

Creates a standby WorkSpace in a secondary Region.

Link to this function

create_tags(client, input, options \\ [])

View Source

Creates the specified tags for the specified WorkSpaces resource.

Link to this function

create_updated_workspace_image(client, input, options \\ [])

View Source

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.

Link to this function

create_workspace_bundle(client, input, options \\ [])

View Source

Creates the specified WorkSpace bundle.

For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

Link to this function

create_workspace_image(client, input, options \\ [])

View Source

Creates a new WorkSpace image from an existing WorkSpace.

Link to this function

create_workspaces(client, input, options \\ [])

View Source

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 because DCV (formerly 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?

Link to this function

create_workspaces_pool(client, input, options \\ [])

View Source

Creates a pool of WorkSpaces.

Link to this function

delete_client_branding(client, input, options \\ [])

View Source

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.

Link to this function

delete_connect_client_add_in(client, input, options \\ [])

View Source

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

Link to this function

delete_connection_alias(client, input, options \\ [])

View Source

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.

Link to this function

delete_ip_group(client, input, options \\ [])

View Source

Deletes the specified IP access control group.

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

Link to this function

delete_tags(client, input, options \\ [])

View Source

Deletes the specified tags from the specified WorkSpaces resource.

Link to this function

delete_workspace_bundle(client, input, options \\ [])

View Source

Deletes the specified WorkSpace bundle.

For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

Link to this function

delete_workspace_image(client, input, options \\ [])

View Source

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.

Link to this function

deploy_workspace_applications(client, input, options \\ [])

View Source

Deploys associated applications to the specified WorkSpace

Link to this function

deregister_workspace_directory(client, input, options \\ [])

View Source

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.

Link to this function

describe_account(client, input, options \\ [])

View Source

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

Link to this function

describe_account_modifications(client, input, options \\ [])

View Source

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

Link to this function

describe_application_associations(client, input, options \\ [])

View Source

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

Link to this function

describe_applications(client, input, options \\ [])

View Source

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

Link to this function

describe_bundle_associations(client, input, options \\ [])

View Source

Describes the associations between the applications and the specified bundle.

Link to this function

describe_client_branding(client, input, options \\ [])

View Source

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.

Link to this function

describe_client_properties(client, input, options \\ [])

View Source

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

Link to this function

describe_connect_client_add_ins(client, input, options \\ [])

View Source

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

Link to this function

describe_connection_alias_permissions(client, input, options \\ [])

View Source

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.

Link to this function

describe_connection_aliases(client, input, options \\ [])

View Source

Retrieves a list that describes the connection aliases used for cross-Region redirection.

For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Link to this function

describe_image_associations(client, input, options \\ [])

View Source

Describes the associations between the applications and the specified image.

Link to this function

describe_ip_groups(client, input, options \\ [])

View Source

Describes one or more of your IP access control groups.

Link to this function

describe_tags(client, input, options \\ [])

View Source

Describes the specified tags for the specified WorkSpaces resource.

Link to this function

describe_workspace_associations(client, input, options \\ [])

View Source

Describes the associations betweens applications and the specified WorkSpace.

Link to this function

describe_workspace_bundles(client, input, options \\ [])

View Source

Retrieves a list that describes the available WorkSpace bundles.

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

Link to this function

describe_workspace_directories(client, input, options \\ [])

View Source

Describes the available directories that are registered with Amazon WorkSpaces.

Link to this function

describe_workspace_image_permissions(client, input, options \\ [])

View Source

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

Link to this function

describe_workspace_images(client, input, options \\ [])

View Source

Retrieves a list that describes one or more specified images, if the image identifiers are provided.

Otherwise, all images in the account are described.

Link to this function

describe_workspace_snapshots(client, input, options \\ [])

View Source

Describes the snapshots for the specified WorkSpace.

Link to this function

describe_workspaces(client, input, options \\ [])

View Source

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.

Link to this function

describe_workspaces_connection_status(client, input, options \\ [])

View Source

Describes the connection status of the specified WorkSpaces.

Link to this function

describe_workspaces_pool_sessions(client, input, options \\ [])

View Source

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

Link to this function

describe_workspaces_pools(client, input, options \\ [])

View Source

Describes the specified WorkSpaces Pools.

Link to this function

disassociate_connection_alias(client, input, options \\ [])

View Source

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.

Link to this function

disassociate_ip_groups(client, input, options \\ [])

View Source

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

Link to this function

disassociate_workspace_application(client, input, options \\ [])

View Source

Disassociates the specified application from a WorkSpace.

Link to this function

get_account_link(client, input, options \\ [])

View Source

Retrieves account link information.

Link to this function

import_client_branding(client, input, options \\ [])

View Source

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

Link to this function

import_workspace_image(client, input, options \\ [])

View Source

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.

Link to this function

list_account_links(client, input, options \\ [])

View Source

Lists all account links.

Link to this function

list_available_management_cidr_ranges(client, input, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

migrate_workspace(client, input, options \\ [])

View Source

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.

Link to this function

modify_account(client, input, options \\ [])

View Source

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

Link to this function

modify_certificate_based_auth_properties(client, input, options \\ [])

View Source

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

Link to this function

modify_client_properties(client, input, options \\ [])

View Source

Modifies the properties of the specified Amazon WorkSpaces clients.

Link to this function

modify_saml_properties(client, input, options \\ [])

View Source

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.

Link to this function

modify_selfservice_permissions(client, input, options \\ [])

View Source

Modifies the self-service WorkSpace management capabilities for your users.

For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Link to this function

modify_streaming_properties(client, input, options \\ [])

View Source

Modifies the specified streaming properties.

Link to this function

modify_workspace_access_properties(client, input, options \\ [])

View Source

Specifies which devices and operating systems users can use to access their WorkSpaces.

For more information, see Control Device Access.

Link to this function

modify_workspace_creation_properties(client, input, options \\ [])

View Source

Modify the default properties used to create WorkSpaces.

Link to this function

modify_workspace_properties(client, input, options \\ [])

View Source

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.

Link to this function

modify_workspace_state(client, input, options \\ [])

View Source

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.

Link to this function

reboot_workspaces(client, input, options \\ [])

View Source

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.

Link to this function

rebuild_workspaces(client, input, options \\ [])

View Source

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.

Link to this function

register_workspace_directory(client, input, options \\ [])

View Source

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.

Link to this function

restore_workspace(client, input, options \\ [])

View Source

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.

Link to this function

revoke_ip_rules(client, input, options \\ [])

View Source

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

Link to this function

start_workspaces(client, input, options \\ [])

View Source

Starts the specified WorkSpaces.

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

Link to this function

start_workspaces_pool(client, input, options \\ [])

View Source

Starts the specified pool.

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

Link to this function

stop_workspaces(client, input, options \\ [])

View Source

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.

Link to this function

stop_workspaces_pool(client, input, options \\ [])

View Source

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.

Link to this function

terminate_workspaces(client, input, options \\ [])

View Source

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.

Link to this function

terminate_workspaces_pool(client, input, options \\ [])

View Source

Terminates the specified pool.

Link to this function

terminate_workspaces_pool_session(client, input, options \\ [])

View Source

Terminates the pool session.

Link to this function

update_connect_client_add_in(client, input, options \\ [])

View Source

Updates a Amazon Connect client add-in.

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

Link to this function

update_connection_alias_permission(client, input, options \\ [])

View Source

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.

Link to this function

update_rules_of_ip_group(client, input, options \\ [])

View Source

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

Link to this function

update_workspace_bundle(client, input, options \\ [])

View Source

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.

Link to this function

update_workspace_image_permission(client, input, options \\ [])

View Source

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.

Link to this function

update_workspaces_pool(client, input, options \\ [])

View Source

Updates the specified pool.