Amazon.WorkSpaces.Model

Container for the parameters to the AcceptAccountLinkInvitation operation. Accepts the account link invitation.

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

This is the response object from the AcceptAccountLinkInvitation operation.

The user is not authorized to access a resource.

Information about about the account link.

Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.

Information about the Active Directory config.

The specified application is not supported.

Describes the association between an application and an application resource.

The persistent application settings for WorkSpaces Pools users.

Describes the persistent application settings for WorkSpaces Pools users.

Container for the parameters to the AssociateConnectionAlias operation. Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

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

This is the response object from the AssociateConnectionAlias operation.

Container for the parameters to the AssociateIpGroups operation. Associates the specified IP access control group with the specified directory.

This is the response object from the AssociateIpGroups operation.

Container for the parameters to the AssociateWorkspaceApplication operation. Associates the specified application to the specified WorkSpace.

This is the response object from the AssociateWorkspaceApplication operation.

Indicates the reason that the association deployment failed, including the error code and error message.

Container for the parameters to the AuthorizeIpRules operation. Adds one or more rules to the specified IP access control group.

This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

This is the response object from the AuthorizeIpRules operation.

Describes the association between an application and a bundle resource.

Describes the user capacity for a pool of WorkSpaces.

Describes the capacity status for a pool of WorkSpaces.

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

Describes an Amazon WorkSpaces client.

Information about the Amazon WorkSpaces client.

The compute type of the WorkSpace is not compatible with the application.

Describes the compute type of the bundle.

The TargetAccountId is already linked or invited.

Describes an Amazon Connect client add-in.

Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Container for the parameters to the CopyWorkspaceImage operation. 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.

This is the response object from the CopyWorkspaceImage operation.

Container for the parameters to the CreateAccountLinkInvitation operation. Creates the account link invitation.

This is the response object from the CreateAccountLinkInvitation operation.

Container for the parameters to the CreateConnectClientAddIn operation. Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.

This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.

This is the response object from the CreateConnectClientAddIn operation.

Container for the parameters to the CreateConnectionAlias operation. Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

This is the response object from the CreateConnectionAlias operation.

Container for the parameters to the CreateIpGroup operation. Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

This is the response object from the CreateIpGroup operation.

Container for the parameters to the CreateStandbyWorkspaces operation. Creates a standby WorkSpace in a secondary Region.

This is the response object from the CreateStandbyWorkspaces operation.

Container for the parameters to the CreateTags operation. Creates the specified tags for the specified WorkSpaces resource.

This is the response object from the CreateTags operation.

Container for the parameters to the CreateUpdatedWorkspaceImage operation. 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.

This is the response object from the CreateUpdatedWorkspaceImage operation.

Container for the parameters to the CreateWorkspaceBundle operation. Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.

This is the response object from the CreateWorkspaceBundle operation.

Container for the parameters to the CreateWorkspaceImage operation. Creates a new WorkSpace image from an existing WorkSpace.

This is the response object from the CreateWorkspaceImage operation.

Container for the parameters to the CreateWorkspacesPool operation. Creates a pool of WorkSpaces.

This is the response object from the CreateWorkspacesPool operation.

Container for the parameters to the CreateWorkspaces operation. Creates one or more WorkSpaces.

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

This is the response object from the CreateWorkspaces operation.

Describes the data replication settings.

Returns default client branding attributes that were imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you don't include sensitive information.

The default client branding attributes to be imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you do not include sensitive information.

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Container for the parameters to the DeleteAccountLinkInvitation operation. Deletes the account link invitation.

This is the response object from the DeleteAccountLinkInvitation operation.

Container for the parameters to the DeleteClientBranding operation. Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

After you delete your customized client branding, your login portal reverts to the default client branding.

This is the response object from the DeleteClientBranding operation.

Container for the parameters to the DeleteConnectClientAddIn operation. Deletes a client-add-in for Amazon Connect that is configured within a directory.

This is the response object from the DeleteConnectClientAddIn operation.

Container for the parameters to the DeleteConnectionAlias operation. 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.

This is the response object from the DeleteConnectionAlias operation.

Container for the parameters to the DeleteIpGroup operation. Deletes the specified IP access control group.

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

This is the response object from the DeleteIpGroup operation.

Container for the parameters to the DeleteTags operation. Deletes the specified tags from the specified WorkSpaces resource.

This is the response object from the DeleteTags operation.

Container for the parameters to the DeleteWorkspaceBundle operation. Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.

This is the response object from the DeleteWorkspaceBundle operation.

Container for the parameters to the DeleteWorkspaceImage operation. Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.

This is the response object from the DeleteWorkspaceImage operation.

Container for the parameters to the DeployWorkspaceApplications operation. Deploys associated applications to the specified WorkSpace

This is the response object from the DeployWorkspaceApplications operation.

Container for the parameters to the DeregisterWorkspaceDirectory operation. Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.

This is the response object from the DeregisterWorkspaceDirectory operation.

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

This is the response object from the DescribeAccountModifications operation.

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

This is the response object from the DescribeAccount operation.

Container for the parameters to the DescribeApplicationAssociations operation. Describes the associations between the application and the specified associated resources.

This is the response object from the DescribeApplicationAssociations operation.

Container for the parameters to the DescribeApplications operation. Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

This is the response object from the DescribeApplications operation.

Container for the parameters to the DescribeBundleAssociations operation. Describes the associations between the applications and the specified bundle.

This is the response object from the DescribeBundleAssociations operation.

Container for the parameters to the DescribeClientBranding operation. Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.

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

This is the response object from the DescribeClientBranding operation.

Container for the parameters to the DescribeClientProperties operation. Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

This is the response object from the DescribeClientProperties operation.

Container for the parameters to the DescribeConnectClientAddIns operation. Retrieves a list of Amazon Connect client add-ins that have been created.

This is the response object from the DescribeConnectClientAddIns operation.

Container for the parameters to the DescribeConnectionAliases operation. Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

This is the response object from the DescribeConnectionAliases operation.

Container for the parameters to the DescribeConnectionAliasPermissions operation. Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

This is the response object from the DescribeConnectionAliasPermissions operation.

Container for the parameters to the DescribeImageAssociations operation. Describes the associations between the applications and the specified image.

This is the response object from the DescribeImageAssociations operation.

Container for the parameters to the DescribeIpGroups operation. Describes one or more of your IP access control groups.

This is the response object from the DescribeIpGroups operation.

Container for the parameters to the DescribeTags operation. Describes the specified tags for the specified WorkSpaces resource.

This is the response object from the DescribeTags operation.

Container for the parameters to the DescribeWorkspaceAssociations operation. Describes the associations betweens applications and the specified WorkSpace.

This is the response object from the DescribeWorkspaceAssociations operation.

Container for the parameters to the DescribeWorkspaceBundles operation. Retrieves a list that describes the available WorkSpace bundles.

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

This is the response object from the DescribeWorkspaceBundles operation.

Describes the filter conditions for the WorkSpaces to return.

Container for the parameters to the DescribeWorkspaceDirectories operation. Describes the available directories that are registered with Amazon WorkSpaces.

This is the response object from the DescribeWorkspaceDirectories operation.

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

This is the response object from the DescribeWorkspaceImagePermissions operation.

Container for the parameters to the DescribeWorkspaceImages operation. Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

This is the response object from the DescribeWorkspaceImages operation.

Container for the parameters to the DescribeWorkspacesConnectionStatus operation. Describes the connection status of the specified WorkSpaces.

This is the response object from the DescribeWorkspacesConnectionStatus operation.

Container for the parameters to the DescribeWorkspaceSnapshots operation. Describes the snapshots for the specified WorkSpace.

This is the response object from the DescribeWorkspaceSnapshots operation.

Container for the parameters to the DescribeWorkspacesPoolSessions operation. Retrieves a list that describes the streaming sessions for a specified pool.

This is the response object from the DescribeWorkspacesPoolSessions operation.

Describes the filter conditions for WorkSpaces Pools to return.

Container for the parameters to the DescribeWorkspacesPools operation. Describes the specified WorkSpaces Pools.

This is the response object from the DescribeWorkspacesPools operation.

Container for the parameters to the DescribeWorkspaces operation. Describes the specified WorkSpaces.

You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

This is the response object from the DescribeWorkspaces operation.

Container for the parameters to the DisassociateConnectionAlias operation. Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

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

This is the response object from the DisassociateConnectionAlias operation.

Container for the parameters to the DisassociateIpGroups operation. Disassociates the specified IP access control group from the specified directory.

This is the response object from the DisassociateIpGroups operation.

Container for the parameters to the DisassociateWorkspaceApplication operation. Disassociates the specified application from a WorkSpace.

This is the response object from the DisassociateWorkspaceApplication operation.

Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.

Describes the standby WorkSpace that could not be created.

Describes a WorkSpace that cannot be created.

Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

Container for the parameters to the GetAccountLink operation. Retrieves account link information.

This is the response object from the GetAccountLink operation.

Specifies the configurations of the identity center.

Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.

Describes the association between an application and an image resource.

Container for the parameters to the ImportClientBranding operation. 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

This is the response object from the ImportClientBranding operation.

Container for the parameters to the ImportWorkspaceImage operation. Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.

This is the response object from the ImportWorkspaceImage operation.

The specified application is not compatible with the resource.

Unexpected server error occured.

One or more parameter values are not valid.

The state of the resource is not valid for this operation.

The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.

Client branding attributes are public facing. Ensure you do not include sensitive information.

The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.

Client branding attributes are public facing. Ensure you do not include sensitive information.

Describes a rule for an IP access control group.

Container for the parameters to the ListAccountLinks operation. Lists all account links.

This is the response object from the ListAccountLinks operation.

Container for the parameters to the ListAvailableManagementCidrRanges operation. Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).

This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an AccessDeniedException error.

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

This is the response object from the ListAvailableManagementCidrRanges operation.

Specifies the configurations of the Microsoft Entra.

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

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

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

This is the response object from the MigrateWorkspace operation.

Describes a WorkSpace modification.

Container for the parameters to the ModifyAccount operation. Modifies the configuration of Bring Your Own License (BYOL) for the specified account.

This is the response object from the ModifyAccount operation.

Container for the parameters to the ModifyCertificateBasedAuthProperties operation. Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

This is the response object from the ModifyCertificateBasedAuthProperties operation.

Container for the parameters to the ModifyClientProperties operation. Modifies the properties of the specified Amazon WorkSpaces clients.

This is the response object from the ModifyClientProperties operation.

Container for the parameters to the ModifySamlProperties operation. Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

This is the response object from the ModifySamlProperties operation.

Container for the parameters to the ModifySelfservicePermissions operation. Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

This is the response object from the ModifySelfservicePermissions operation.

Container for the parameters to the ModifyStreamingProperties operation. Modifies the specified streaming properties.

This is the response object from the ModifyStreamingProperties operation.

Container for the parameters to the ModifyWorkspaceAccessProperties operation. Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.

This is the response object from the ModifyWorkspaceAccessProperties operation.

Container for the parameters to the ModifyWorkspaceCreationProperties operation. Modify the default properties used to create WorkSpaces.

This is the response object from the ModifyWorkspaceCreationProperties operation.

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

The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

This is the response object from the ModifyWorkspaceProperties operation.

Container for the parameters to the ModifyWorkspaceState operation. Sets the state of the specified WorkSpace.

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

This is the response object from the ModifyWorkspaceState operation.

Describes the network details of a WorkSpaces Pool.

The operating system that the image is running.

The operating system of the WorkSpace is not compatible with the application.

The properties of this WorkSpace are currently being modified. Try again in a moment.

This operation is not supported.

Information about the standby WorkSpace.

Describes the information used to reboot a WorkSpace.

Container for the parameters to the RebootWorkspaces operation. 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.

This is the response object from the RebootWorkspaces operation.

Describes the information used to rebuild a WorkSpace.

Container for the parameters to the RebuildWorkspaces operation. Rebuilds the specified WorkSpace.

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

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

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

This is the response object from the RebuildWorkspaces operation.

Container for the parameters to the RegisterWorkspaceDirectory operation. Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

This is the response object from the RegisterWorkspaceDirectory operation.

Container for the parameters to the RejectAccountLinkInvitation operation. Rejects the account link invitation.

This is the response object from the RejectAccountLinkInvitation operation.

Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

The specified resource already exists.

The resource is associated with a directory.

The resource could not be created.

The specified resource is currently in use.

Your resource limits have been exceeded.

The resource could not be found.

The specified resource is not available.

Container for the parameters to the RestoreWorkspace operation. Restores the specified WorkSpace to its last known healthy state.

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

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

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

This is the response object from the RestoreWorkspace operation.

Container for the parameters to the RevokeIpRules operation. Removes one or more rules from the specified IP access control group.

This is the response object from the RevokeIpRules operation.

Describes the root volume for a WorkSpace bundle.

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.

Describes a snapshot.

Describes a standby WorkSpace.

Describes the properties of the related standby WorkSpaces.

Information used to start a WorkSpace.

Container for the parameters to the StartWorkspacesPool operation. Starts the specified pool.

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

This is the response object from the StartWorkspacesPool operation.

Container for the parameters to the StartWorkspaces operation. Starts the specified WorkSpaces.

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

This is the response object from the StartWorkspaces operation.

Describes the information used to stop a WorkSpace.

Container for the parameters to the StopWorkspacesPool operation. 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.

This is the response object from the StopWorkspacesPool operation.

Container for the parameters to the StopWorkspaces operation. 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.

This is the response object from the StopWorkspaces operation.

Describes the storage connector.

Describes the streaming properties.

Describes a tag.

Describes the information used to terminate a WorkSpace.

Container for the parameters to the TerminateWorkspacesPool operation. Terminates the specified pool.

This is the response object from the TerminateWorkspacesPool operation.

Container for the parameters to the TerminateWorkspacesPoolSession operation. Terminates the pool session.

This is the response object from the TerminateWorkspacesPoolSession operation.

Container for the parameters to the TerminateWorkspaces operation. 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.

This is the response object from the TerminateWorkspaces operation.

Describes the timeout settings for a pool of WorkSpaces.

The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see Configure a VPC for Amazon WorkSpaces.

The configuration of this WorkSpace is not supported for this operation. For more information, see Required Configuration and Service Components for WorkSpaces .

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

This is the response object from the UpdateConnectClientAddIn operation.

Container for the parameters to the UpdateConnectionAliasPermission operation. Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

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

• To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.

This is the response object from the UpdateConnectionAliasPermission operation.

Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.

Only Windows 10 WorkSpace images can be programmatically updated at this time.

Container for the parameters to the UpdateRulesOfIpGroup operation. Replaces the current rules of the specified IP access control group with the specified rules.

This is the response object from the UpdateRulesOfIpGroup operation.

Container for the parameters to the UpdateWorkspaceBundle operation. Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.

Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.

This is the response object from the UpdateWorkspaceBundle operation.

Container for the parameters to the UpdateWorkspaceImagePermission operation. 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.

This is the response object from the UpdateWorkspaceImagePermission operation.

Container for the parameters to the UpdateWorkspacesPool operation. Updates the specified pool.

This is the response object from the UpdateWorkspacesPool operation.

Information about the user's permission settings.

Describes the user volume for a WorkSpace bundle.

You either haven't provided a TargetAccountId or are using the same value for TargetAccountId and SourceAccountId.

Describes a WorkSpace.

The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.

Describes the WorkSpace application.

Describes the WorkSpace application deployment.

Describes a WorkSpace bundle.

Describes the connection status of a WorkSpace.

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

Describes a directory that is used with Amazon WorkSpaces.

Describes a WorkSpace image.

Describes a WorkSpace.

Describes the information used to create a WorkSpace.

Describes the association between an application and a WorkSpace resource.

The workspaces_DefaultRole role could not be found. 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.

Describes an IP access control group.

Paginators for the WorkSpaces service

Describes a pool of WorkSpaces.

Describes a pool error.

Describes a pool session.

Paginator for the DescribeApplicationAssociations operation

Paginator for the DescribeApplications operation

Paginator for the DescribeWorkspaceBundles operation

Paginator for the DescribeWorkspaceDirectories operation

Paginator for the DescribeWorkspaces operation

Paginator for the ListAccountLinks operation

Paginators for the WorkSpaces service