Table of Contents
WorkSpaces.Client¶A low-level client representing Amazon WorkSpaces
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.
import boto3
client = boto3.client('workspaces')
These are the available methods:
associate_connection_alias()associate_ip_groups()authorize_ip_rules()can_paginate()close()copy_workspace_image()create_connect_client_add_in()create_connection_alias()create_ip_group()create_standby_workspaces()create_tags()create_updated_workspace_image()create_workspace_bundle()create_workspace_image()create_workspaces()delete_client_branding()delete_connect_client_add_in()delete_connection_alias()delete_ip_group()delete_tags()delete_workspace_bundle()delete_workspace_image()deregister_workspace_directory()describe_account()describe_account_modifications()describe_client_branding()describe_client_properties()describe_connect_client_add_ins()describe_connection_alias_permissions()describe_connection_aliases()describe_ip_groups()describe_tags()describe_workspace_bundles()describe_workspace_directories()describe_workspace_image_permissions()describe_workspace_images()describe_workspace_snapshots()describe_workspaces()describe_workspaces_connection_status()disassociate_connection_alias()disassociate_ip_groups()get_paginator()get_waiter()import_client_branding()import_workspace_image()list_available_management_cidr_ranges()migrate_workspace()modify_account()modify_certificate_based_auth_properties()modify_client_properties()modify_saml_properties()modify_selfservice_permissions()modify_workspace_access_properties()modify_workspace_creation_properties()modify_workspace_properties()modify_workspace_state()reboot_workspaces()rebuild_workspaces()register_workspace_directory()restore_workspace()revoke_ip_rules()start_workspaces()stop_workspaces()terminate_workspaces()update_connect_client_add_in()update_connection_alias_permission()update_rules_of_ip_group()update_workspace_bundle()update_workspace_image_permission()associate_connection_alias(**kwargs)¶Associates the specified connection alias with the specified directory to enable cross-Region redirection. 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 .
See also: AWS API Documentation
Request Syntax
response = client.associate_connection_alias(
AliasId='string',
ResourceId='string'
)
[REQUIRED]
The identifier of the connection alias.
[REQUIRED]
The identifier of the directory to associate the connection alias with.
dict
Response Syntax
{
'ConnectionIdentifier': 'string'
}
Response Structure
(dict) --
ConnectionIdentifier (string) --
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
Exceptions
WorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionassociate_ip_groups(**kwargs)¶Associates the specified IP access control group with the specified directory.
See also: AWS API Documentation
Request Syntax
response = client.associate_ip_groups(
DirectoryId='string',
GroupIds=[
'string',
]
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The identifiers of one or more IP access control groups.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionAdds 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.
See also: AWS API Documentation
Request Syntax
response = client.authorize_ip_rules(
GroupId='string',
UserRules=[
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
The rules to add to the group.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
copy_workspace_image(**kwargs)¶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.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.copy_workspace_image(
Name='string',
Description='string',
SourceImageId='string',
SourceRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the image.
[REQUIRED]
The identifier of the source image.
[REQUIRED]
The identifier of the source Region.
The tags for the image.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the image.
Exceptions
WorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptioncreate_connect_client_add_in(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_connect_client_add_in(
ResourceId='string',
Name='string',
URL='string'
)
[REQUIRED]
The directory identifier for which to configure the client add-in.
[REQUIRED]
The name of the client add-in.
[REQUIRED]
The endpoint URL of the Amazon Connect client add-in.
dict
Response Syntax
{
'AddInId': 'string'
}
Response Structure
(dict) --
AddInId (string) --
The client add-in identifier.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceCreationFailedExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptioncreate_connection_alias(**kwargs)¶Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.create_connection_alias(
ConnectionString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com .
Warning
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
The tags to associate with the connection alias.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'AliasId': 'string'
}
Response Structure
(dict) --
AliasId (string) --
The identifier of the connection alias.
Exceptions
WorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptioncreate_ip_group(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_ip_group(
GroupName='string',
GroupDesc='string',
UserRules=[
{
'ipRule': 'string',
'ruleDesc': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the group.
The rules to add to the group.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'GroupId': 'string'
}
Response Structure
(dict) --
GroupId (string) --
The identifier of the group.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceCreationFailedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptioncreate_standby_workspaces(**kwargs)¶Creates a standby WorkSpace in a secondary Region.
See also: AWS API Documentation
Request Syntax
response = client.create_standby_workspaces(
PrimaryRegion='string',
StandbyWorkspaces=[
{
'PrimaryWorkspaceId': 'string',
'VolumeEncryptionKey': 'string',
'DirectoryId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The Region of the primary WorkSpace.
[REQUIRED]
Information about the standby WorkSpace to be created.
Describes a standby WorkSpace.
The identifier of the standby WorkSpace.
The volume encryption key of the standby WorkSpace.
The identifier of the directory for the standby WorkSpace.
The tags associated with the standby WorkSpace.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'FailedStandbyRequests': [
{
'StandbyWorkspaceRequest': {
'PrimaryWorkspaceId': 'string',
'VolumeEncryptionKey': 'string',
'DirectoryId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'PendingStandbyRequests': [
{
'UserName': 'string',
'DirectoryId': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'WorkspaceId': 'string'
},
]
}
Response Structure
(dict) --
FailedStandbyRequests (list) --
Information about the standby WorkSpace that could not be created.
(dict) --
Describes the standby WorkSpace that could not be created.
StandbyWorkspaceRequest (dict) --
Information about the standby WorkSpace that could not be created.
PrimaryWorkspaceId (string) --
The identifier of the standby WorkSpace.
VolumeEncryptionKey (string) --
The volume encryption key of the standby WorkSpace.
DirectoryId (string) --
The identifier of the directory for the standby WorkSpace.
Tags (list) --
The tags associated with the standby WorkSpace.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
ErrorCode (string) --
The error code that is returned if the standby WorkSpace could not be created.
ErrorMessage (string) --
The text of the error message that is returned if the standby WorkSpace could not be created.
PendingStandbyRequests (list) --
Information about the standby WorkSpace that was created.
(dict) --
Information about the standby WorkSpace.
UserName (string) --
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
DirectoryId (string) --
The identifier of the directory for the standby WorkSpace.
State (string) --
The operational state of the standby WorkSpace.
WorkspaceId (string) --
The identifier of the standby WorkSpace.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionCreates the specified tags for the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
[REQUIRED]
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptioncreate_updated_workspace_image(**kwargs)¶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
See also: AWS API Documentation
Request Syntax
response = client.create_updated_workspace_image(
Name='string',
Description='string',
SourceImageId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the new updated WorkSpace image.
[REQUIRED]
A description of whether updates for the WorkSpace image are available.
[REQUIRED]
The identifier of the source WorkSpace image.
The tags that you want to add to the new updated WorkSpace image.
Note
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags .
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the new updated WorkSpace image.
Exceptions
WorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptioncreate_workspace_bundle(**kwargs)¶Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace_bundle(
BundleName='string',
BundleDescription='string',
ImageId='string',
ComputeType={
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
},
UserStorage={
'Capacity': 'string'
},
RootStorage={
'Capacity': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the bundle.
[REQUIRED]
The description of the bundle.
[REQUIRED]
The identifier of the image that is used to create the bundle.
[REQUIRED]
Describes the compute type of the bundle.
The compute type.
[REQUIRED]
Describes the user volume for a WorkSpace bundle.
The size of the user volume.
Describes the root volume for a WorkSpace bundle.
The size of the root volume.
The tags associated with the bundle.
Note
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags .
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'WorkspaceBundle': {
'BundleId': 'string',
'Name': 'string',
'Owner': 'string',
'Description': 'string',
'ImageId': 'string',
'RootStorage': {
'Capacity': 'string'
},
'UserStorage': {
'Capacity': 'string'
},
'ComputeType': {
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
},
'LastUpdatedTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'BundleType': 'REGULAR'|'STANDBY'
}
}
Response Structure
(dict) --
WorkspaceBundle (dict) --
Describes a WorkSpace bundle.
BundleId (string) --
The identifier of the bundle.
Name (string) --
The name of the bundle.
Owner (string) --
The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
Description (string) --
The description of the bundle.
ImageId (string) --
The identifier of the image that was used to create the bundle.
RootStorage (dict) --
The size of the root volume.
Capacity (string) --
The size of the root volume.
UserStorage (dict) --
The size of the user volume.
Capacity (string) --
The size of the user volume.
ComputeType (dict) --
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
Name (string) --
The compute type.
LastUpdatedTime (datetime) --
The last time that the bundle was updated.
CreationTime (datetime) --
The time when the bundle was created.
State (string) --
The state of the WorkSpace bundle.
BundleType (string) --
The type of WorkSpace bundle.
Exceptions
WorkSpaces.Client.exceptions.ResourceUnavailableExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptioncreate_workspace_image(**kwargs)¶Creates a new WorkSpace image from an existing WorkSpace.
See also: AWS API Documentation
Request Syntax
response = client.create_workspace_image(
Name='string',
Description='string',
WorkspaceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the new WorkSpace image.
[REQUIRED]
The description of the new WorkSpace image.
[REQUIRED]
The identifier of the source WorkSpace
The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags .
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'ImageId': 'string',
'Name': 'string',
'Description': 'string',
'OperatingSystem': {
'Type': 'WINDOWS'|'LINUX'
},
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'RequiredTenancy': 'DEFAULT'|'DEDICATED',
'Created': datetime(2015, 1, 1),
'OwnerAccountId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the new WorkSpace image.
Name (string) --
The name of the image.
Description (string) --
The description of the image.
OperatingSystem (dict) --
The operating system that the image is running.
Type (string) --
The operating system.
State (string) --
The availability status of the image.
RequiredTenancy (string) --
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
Created (datetime) --
The date when the image was created.
OwnerAccountId (string) --
The identifier of the Amazon Web Services account that owns the image.
Exceptions
WorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptioncreate_workspaces(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.create_workspaces(
Workspaces=[
{
'DirectoryId': 'string',
'UserName': 'string',
'BundleId': 'string',
'VolumeEncryptionKey': 'string',
'UserVolumeEncryptionEnabled': True|False,
'RootVolumeEncryptionEnabled': True|False,
'WorkspaceProperties': {
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
Describes the information used to create a WorkSpace.
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The WorkSpace properties.
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The compute type. For more information, see Amazon WorkSpaces Bundles.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .The tags for the WorkSpace.
Describes a tag.
The key of the tag.
The value of the tag.
{
'FailedRequests': [
{
'WorkspaceRequest': {
'DirectoryId': 'string',
'UserName': 'string',
'BundleId': 'string',
'VolumeEncryptionKey': 'string',
'UserVolumeEncryptionEnabled': True|False,
'RootVolumeEncryptionEnabled': True|False,
'WorkspaceProperties': {
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'PendingRequests': [
{
'WorkspaceId': 'string',
'DirectoryId': 'string',
'UserName': 'string',
'IpAddress': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'BundleId': 'string',
'SubnetId': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'ComputerName': 'string',
'VolumeEncryptionKey': 'string',
'UserVolumeEncryptionEnabled': True|False,
'RootVolumeEncryptionEnabled': True|False,
'WorkspaceProperties': {
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
},
'ModificationStates': [
{
'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
},
],
'RelatedWorkspaces': [
{
'WorkspaceId': 'string',
'Region': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'Type': 'PRIMARY'|'STANDBY'
},
]
},
]
}
Response Structure
Information about the WorkSpaces that could not be created.
Describes a WorkSpace that cannot be created.
Information about the WorkSpace.
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The WorkSpace properties.
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The compute type. For more information, see Amazon WorkSpaces Bundles.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .The tags for the WorkSpace.
Describes a tag.
The key of the tag.
The value of the tag.
The error code that is returned if the WorkSpace cannot be created.
The text of the error message that is returned if the WorkSpace cannot be created.
Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
Describes a WorkSpace.
The identifier of the WorkSpace.
The identifier of the Directory Service directory for the WorkSpace.
The user for the WorkSpace.
The IP address of the WorkSpace.
The operational state of the WorkSpace.
Note
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.
The identifier of the bundle used to create the WorkSpace.
The identifier of the subnet for the WorkSpace.
The text of the error message that is returned if the WorkSpace cannot be created.
The error code that is returned if the WorkSpace cannot be created.
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The properties of the WorkSpace.
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The compute type. For more information, see Amazon WorkSpaces Bundles.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .The modification states of the WorkSpace.
Describes a WorkSpace modification.
The resource.
The modification state.
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
The identifier of the related WorkSpace.
The Region of the related WorkSpace.
Indicates the state of the WorkSpace.
Indicates the type of WorkSpace.
Exceptions
WorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondelete_client_branding(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_client_branding(
ResourceId='string',
Platforms=[
'DeviceTypeWindows'|'DeviceTypeOsx'|'DeviceTypeAndroid'|'DeviceTypeIos'|'DeviceTypeLinux'|'DeviceTypeWeb',
]
)
[REQUIRED]
The directory identifier of the WorkSpace for which you want to delete client branding.
[REQUIRED]
The device type for which you want to delete client branding.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondelete_connect_client_add_in(**kwargs)¶Deletes a client-add-in for Amazon Connect that is configured within a directory.
See also: AWS API Documentation
Request Syntax
response = client.delete_connect_client_add_in(
AddInId='string',
ResourceId='string'
)
[REQUIRED]
The identifier of the client add-in to delete.
[REQUIRED]
The directory identifier for which the client add-in is configured.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondelete_connection_alias(**kwargs)¶Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection_alias(
AliasId='string'
)
[REQUIRED]
The identifier of the connection alias to delete.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptiondelete_ip_group(**kwargs)¶Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
See also: AWS API Documentation
Request Syntax
response = client.delete_ip_group(
GroupId='string'
)
[REQUIRED]
The identifier of the IP access control group.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionDeletes the specified tags from the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
ResourceId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondelete_workspace_bundle(**kwargs)¶Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace_bundle(
BundleId='string'
)
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondelete_workspace_image(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace_image(
ImageId='string'
)
[REQUIRED]
The identifier of the image.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionderegister_workspace_directory(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.deregister_workspace_directory(
DirectoryId='string'
)
[REQUIRED]
The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptiondescribe_account()¶Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
See also: AWS API Documentation
Request Syntax
response = client.describe_account()
{
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string'
}
Response Structure
The status of BYOL (whether BYOL is enabled or disabled).
The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
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.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_account_modifications(**kwargs)¶Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
See also: AWS API Documentation
Request Syntax
response = client.describe_account_modifications(
NextToken='string'
)
NextToken from a previous call that was paginated, provide this token to receive the next set of results.{
'AccountModifications': [
{
'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string',
'StartTime': datetime(2015, 1, 1),
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
The list of modifications to the configuration of BYOL.
Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
The state of the modification to the configuration of BYOL.
The status of BYOL (whether BYOL is being enabled or disabled).
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
The timestamp when the modification of the BYOL configuration was started.
The error code that is returned if the configuration of BYOL cannot be modified.
The text of the error message that is returned if the configuration of BYOL cannot be modified.
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_client_branding(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_branding(
ResourceId='string'
)
[REQUIRED]
The directory identifier of the WorkSpace for which you want to view client branding information.
{
'DeviceTypeWindows': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeOsx': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeAndroid': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeIos': {
'LogoUrl': 'string',
'Logo2xUrl': 'string',
'Logo3xUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeLinux': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeWeb': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
}
}
Response Structure
The branding information for Windows devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information for macOS devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information for Android devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information for iOS devices.
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information for Linux devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information for Web access.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_client_properties(**kwargs)¶Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_properties(
ResourceIds=[
'string',
]
)
[REQUIRED]
The resource identifier, in the form of directory IDs.
{
'ClientPropertiesList': [
{
'ResourceId': 'string',
'ClientProperties': {
'ReconnectEnabled': 'ENABLED'|'DISABLED',
'LogUploadEnabled': 'ENABLED'|'DISABLED'
}
},
]
}
Response Structure
Information about the specified Amazon WorkSpaces clients.
Information about the Amazon WorkSpaces client.
The resource identifier, in the form of a directory ID.
Information about the Amazon WorkSpaces client.
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_connect_client_add_ins(**kwargs)¶Retrieves a list of Amazon Connect client add-ins that have been created.
See also: AWS API Documentation
Request Syntax
response = client.describe_connect_client_add_ins(
ResourceId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The directory identifier for which the client add-in is configured.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'AddIns': [
{
'AddInId': 'string',
'ResourceId': 'string',
'Name': 'string',
'URL': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AddIns (list) --
Information about client add-ins.
(dict) --
Describes an Amazon Connect client add-in.
AddInId (string) --
The client add-in identifier.
ResourceId (string) --
The directory identifier for which the client add-in is configured.
Name (string) --
The name of the client add in.
URL (string) --
The endpoint URL of the client add-in.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_connection_alias_permissions(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_connection_alias_permissions(
AliasId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the connection alias.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'AliasId': 'string',
'ConnectionAliasPermissions': [
{
'SharedAccountId': 'string',
'AllowAssociation': True|False
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AliasId (string) --
The identifier of the connection alias.
ConnectionAliasPermissions (list) --
The permissions associated with a connection alias.
(dict) --
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.
SharedAccountId (string) --
The identifier of the Amazon Web Services account that the connection alias is shared with.
AllowAssociation (boolean) --
Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptiondescribe_connection_aliases(**kwargs)¶Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_connection_aliases(
AliasIds=[
'string',
],
ResourceId='string',
Limit=123,
NextToken='string'
)
The identifiers of the connection aliases to describe.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'ConnectionAliases': [
{
'ConnectionString': 'string',
'AliasId': 'string',
'State': 'CREATING'|'CREATED'|'DELETING',
'OwnerAccountId': 'string',
'Associations': [
{
'AssociationStatus': 'NOT_ASSOCIATED'|'ASSOCIATED_WITH_OWNER_ACCOUNT'|'ASSOCIATED_WITH_SHARED_ACCOUNT'|'PENDING_ASSOCIATION'|'PENDING_DISASSOCIATION',
'AssociatedAccountId': 'string',
'ResourceId': 'string',
'ConnectionIdentifier': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConnectionAliases (list) --
Information about the specified connection aliases.
(dict) --
Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
ConnectionString (string) --
The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com .
AliasId (string) --
The identifier of the connection alias.
State (string) --
The current state of the connection alias.
OwnerAccountId (string) --
The identifier of the Amazon Web Services account that owns the connection alias.
Associations (list) --
The association status of the connection alias.
(dict) --
Describes a connection alias association that is used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
AssociationStatus (string) --
The association status of the connection alias.
AssociatedAccountId (string) --
The identifier of the Amazon Web Services account that associated the connection alias with a directory.
ResourceId (string) --
The identifier of the directory associated with a connection alias.
ConnectionIdentifier (string) --
The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptiondescribe_ip_groups(**kwargs)¶Describes one or more of your IP access control groups.
See also: AWS API Documentation
Request Syntax
response = client.describe_ip_groups(
GroupIds=[
'string',
],
NextToken='string',
MaxResults=123
)
The identifiers of one or more IP access control groups.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'Result': [
{
'groupId': 'string',
'groupName': 'string',
'groupDesc': 'string',
'userRules': [
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Result (list) --
Information about the IP access control groups.
(dict) --
Describes an IP access control group.
groupId (string) --
The identifier of the group.
groupName (string) --
The name of the group.
groupDesc (string) --
The description of the group.
userRules (list) --
The rules.
(dict) --
Describes a rule for an IP access control group.
ipRule (string) --
The IP address range, in CIDR notation.
ruleDesc (string) --
The description.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionDescribes the specified tags for the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
ResourceId='string'
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags.
Describes a tag.
The key of the tag.
The value of the tag.
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptiondescribe_workspace_bundles(**kwargs)¶Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace_bundles(
BundleIds=[
'string',
],
Owner='string',
NextToken='string'
)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON . To describe the bundles that belong to your account, don't specify a value.
dict
Response Syntax
{
'Bundles': [
{
'BundleId': 'string',
'Name': 'string',
'Owner': 'string',
'Description': 'string',
'ImageId': 'string',
'RootStorage': {
'Capacity': 'string'
},
'UserStorage': {
'Capacity': 'string'
},
'ComputeType': {
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
},
'LastUpdatedTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'BundleType': 'REGULAR'|'STANDBY'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Bundles (list) --
Information about the bundles.
(dict) --
Describes a WorkSpace bundle.
BundleId (string) --
The identifier of the bundle.
Name (string) --
The name of the bundle.
Owner (string) --
The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
Description (string) --
The description of the bundle.
ImageId (string) --
The identifier of the image that was used to create the bundle.
RootStorage (dict) --
The size of the root volume.
Capacity (string) --
The size of the root volume.
UserStorage (dict) --
The size of the user volume.
Capacity (string) --
The size of the user volume.
ComputeType (dict) --
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
Name (string) --
The compute type.
LastUpdatedTime (datetime) --
The last time that the bundle was updated.
CreationTime (datetime) --
The time when the bundle was created.
State (string) --
The state of the WorkSpace bundle.
BundleType (string) --
The type of WorkSpace bundle.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondescribe_workspace_directories(**kwargs)¶Describes the available directories that are registered with Amazon WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace_directories(
DirectoryIds=[
'string',
],
Limit=123,
NextToken='string'
)
The identifiers of the directories. If the value is null, all directories are retrieved.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'Directories': [
{
'DirectoryId': 'string',
'Alias': 'string',
'DirectoryName': 'string',
'RegistrationCode': 'string',
'SubnetIds': [
'string',
],
'DnsIpAddresses': [
'string',
],
'CustomerUserName': 'string',
'IamRoleId': 'string',
'DirectoryType': 'SIMPLE_AD'|'AD_CONNECTOR',
'WorkspaceSecurityGroupId': 'string',
'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR',
'WorkspaceCreationProperties': {
'EnableWorkDocs': True|False,
'EnableInternetAccess': True|False,
'DefaultOu': 'string',
'CustomSecurityGroupId': 'string',
'UserEnabledAsLocalAdministrator': True|False,
'EnableMaintenanceMode': True|False
},
'ipGroupIds': [
'string',
],
'WorkspaceAccessProperties': {
'DeviceTypeWindows': 'ALLOW'|'DENY',
'DeviceTypeOsx': 'ALLOW'|'DENY',
'DeviceTypeWeb': 'ALLOW'|'DENY',
'DeviceTypeIos': 'ALLOW'|'DENY',
'DeviceTypeAndroid': 'ALLOW'|'DENY',
'DeviceTypeChromeOs': 'ALLOW'|'DENY',
'DeviceTypeZeroClient': 'ALLOW'|'DENY',
'DeviceTypeLinux': 'ALLOW'|'DENY'
},
'Tenancy': 'DEDICATED'|'SHARED',
'SelfservicePermissions': {
'RestartWorkspace': 'ENABLED'|'DISABLED',
'IncreaseVolumeSize': 'ENABLED'|'DISABLED',
'ChangeComputeType': 'ENABLED'|'DISABLED',
'SwitchRunningMode': 'ENABLED'|'DISABLED',
'RebuildWorkspace': 'ENABLED'|'DISABLED'
},
'SamlProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
'UserAccessUrl': 'string',
'RelayStateParameterName': 'string'
},
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED',
'CertificateAuthorityArn': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Directories (list) --
Information about the directories.
(dict) --
Describes a directory that is used with Amazon WorkSpaces.
DirectoryId (string) --
The directory identifier.
Alias (string) --
The directory alias.
DirectoryName (string) --
The name of the directory.
RegistrationCode (string) --
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
SubnetIds (list) --
The identifiers of the subnets used with the directory.
DnsIpAddresses (list) --
The IP addresses of the DNS servers for the directory.
CustomerUserName (string) --
The user name for the service account.
IamRoleId (string) --
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
DirectoryType (string) --
The directory type.
WorkspaceSecurityGroupId (string) --
The identifier of the security group that is assigned to new WorkSpaces.
State (string) --
The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.
WorkspaceCreationProperties (dict) --
The default creation properties for all WorkSpaces in the directory.
EnableWorkDocs (boolean) --
Specifies whether the directory is enabled for Amazon WorkDocs.
EnableInternetAccess (boolean) --
Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
DefaultOu (string) --
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
CustomSecurityGroupId (string) --
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
UserEnabledAsLocalAdministrator (boolean) --
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
EnableMaintenanceMode (boolean) --
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
ipGroupIds (list) --
The identifiers of the IP access control groups associated with the directory.
WorkspaceAccessProperties (dict) --
The devices and operating systems that users can use to access WorkSpaces.
DeviceTypeWindows (string) --
Indicates whether users can use Windows clients to access their WorkSpaces.
DeviceTypeOsx (string) --
Indicates whether users can use macOS clients to access their WorkSpaces.
DeviceTypeWeb (string) --
Indicates whether users can access their WorkSpaces through a web browser.
DeviceTypeIos (string) --
Indicates whether users can use iOS devices to access their WorkSpaces.
DeviceTypeAndroid (string) --
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
DeviceTypeChromeOs (string) --
Indicates whether users can use Chromebooks to access their WorkSpaces.
DeviceTypeZeroClient (string) --
Indicates whether users can use zero client devices to access their WorkSpaces.
DeviceTypeLinux (string) --
Indicates whether users can use Linux clients to access their WorkSpaces.
Tenancy (string) --
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images.
SelfservicePermissions (dict) --
The default self-service permissions for WorkSpaces in the directory.
RestartWorkspace (string) --
Specifies whether users can restart their WorkSpace.
IncreaseVolumeSize (string) --
Specifies whether users can increase the volume size of the drives on their WorkSpace.
ChangeComputeType (string) --
Specifies whether users can change the compute type (bundle) for their WorkSpace.
SwitchRunningMode (string) --
Specifies whether users can switch the running mode of their WorkSpace.
RebuildWorkspace (string) --
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
SamlProperties (dict) --
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.
Status (string) --
Indicates the status of SAML 2.0 authentication. These statuses include the following.
DISABLED , end users will be directed to login with their directory credentials.ENABLED , end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.UserAccessUrl (string) --
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
RelayStateParameterName (string) --
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondescribe_workspace_image_permissions(**kwargs)¶Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace_image_permissions(
ImageId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The identifier of the image.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'ImageId': 'string',
'ImagePermissions': [
{
'SharedAccountId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the image.
ImagePermissions (list) --
The identifiers of the Amazon Web Services accounts that the image has been shared with.
(dict) --
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.
SharedAccountId (string) --
The identifier of the Amazon Web Services account that an image has been shared with.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondescribe_workspace_images(**kwargs)¶Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace_images(
ImageIds=[
'string',
],
ImageType='OWNED'|'SHARED',
NextToken='string',
MaxResults=123
)
The identifier of the image.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'Images': [
{
'ImageId': 'string',
'Name': 'string',
'Description': 'string',
'OperatingSystem': {
'Type': 'WINDOWS'|'LINUX'
},
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'RequiredTenancy': 'DEFAULT'|'DEDICATED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'Created': datetime(2015, 1, 1),
'OwnerAccountId': 'string',
'Updates': {
'UpdateAvailable': True|False,
'Description': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes a WorkSpace image.
ImageId (string) --
The identifier of the image.
Name (string) --
The name of the image.
Description (string) --
The description of the image.
OperatingSystem (dict) --
The operating system that the image is running.
Type (string) --
The operating system.
State (string) --
The status of the image.
RequiredTenancy (string) --
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images.
ErrorCode (string) --
The error code that is returned for the image.
ErrorMessage (string) --
The text of the error message that is returned for the image.
Created (datetime) --
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
OwnerAccountId (string) --
The identifier of the Amazon Web Services account that owns the image.
Updates (dict) --
The updates (if any) that are available for the specified image.
UpdateAvailable (boolean) --
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
Description (string) --
A description of whether updates for the WorkSpace image are pending or available.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_workspace_snapshots(**kwargs)¶Describes the snapshots for the specified WorkSpace.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspace_snapshots(
WorkspaceId='string'
)
[REQUIRED]
The identifier of the WorkSpace.
{
'RebuildSnapshots': [
{
'SnapshotTime': datetime(2015, 1, 1)
},
],
'RestoreSnapshots': [
{
'SnapshotTime': datetime(2015, 1, 1)
},
]
}
Response Structure
Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
Describes a snapshot.
The time when the snapshot was created.
Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
Describes a snapshot.
The time when the snapshot was created.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptiondescribe_workspaces(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspaces(
WorkspaceIds=[
'string',
],
DirectoryId='string',
UserName='string',
BundleId='string',
Limit=123,
NextToken='string'
)
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
UserName ). You cannot combine this parameter with any other filter.DirectoryId .NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'Workspaces': [
{
'WorkspaceId': 'string',
'DirectoryId': 'string',
'UserName': 'string',
'IpAddress': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'BundleId': 'string',
'SubnetId': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'ComputerName': 'string',
'VolumeEncryptionKey': 'string',
'UserVolumeEncryptionEnabled': True|False,
'RootVolumeEncryptionEnabled': True|False,
'WorkspaceProperties': {
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
},
'ModificationStates': [
{
'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
},
],
'RelatedWorkspaces': [
{
'WorkspaceId': 'string',
'Region': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'Type': 'PRIMARY'|'STANDBY'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Workspaces (list) --
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
(dict) --
Describes a WorkSpace.
WorkspaceId (string) --
The identifier of the WorkSpace.
DirectoryId (string) --
The identifier of the Directory Service directory for the WorkSpace.
UserName (string) --
The user for the WorkSpace.
IpAddress (string) --
The IP address of the WorkSpace.
State (string) --
The operational state of the WorkSpace.
Note
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.
BundleId (string) --
The identifier of the bundle used to create the WorkSpace.
SubnetId (string) --
The identifier of the subnet for the WorkSpace.
ErrorMessage (string) --
The text of the error message that is returned if the WorkSpace cannot be created.
ErrorCode (string) --
The error code that is returned if the WorkSpace cannot be created.
ComputerName (string) --
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
VolumeEncryptionKey (string) --
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
UserVolumeEncryptionEnabled (boolean) --
Indicates whether the data stored on the user volume is encrypted.
RootVolumeEncryptionEnabled (boolean) --
Indicates whether the data stored on the root volume is encrypted.
WorkspaceProperties (dict) --
The properties of the WorkSpace.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
RunningModeAutoStopTimeoutInMinutes (integer) --
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
RootVolumeSizeGib (integer) --
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
UserVolumeSizeGib (integer) --
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
ComputeTypeName (string) --
The compute type. For more information, see Amazon WorkSpaces Bundles.
Protocols (list) --
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .ModificationStates (list) --
The modification states of the WorkSpace.
(dict) --
Describes a WorkSpace modification.
Resource (string) --
The resource.
State (string) --
The modification state.
RelatedWorkspaces (list) --
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
(dict) --
Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
WorkspaceId (string) --
The identifier of the related WorkSpace.
Region (string) --
The Region of the related WorkSpace.
State (string) --
Indicates the state of the WorkSpace.
Type (string) --
Indicates the type of WorkSpace.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptiondescribe_workspaces_connection_status(**kwargs)¶Describes the connection status of the specified WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.describe_workspaces_connection_status(
WorkspaceIds=[
'string',
],
NextToken='string'
)
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'WorkspacesConnectionStatus': [
{
'WorkspaceId': 'string',
'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
WorkspacesConnectionStatus (list) --
Information about the connection status of the WorkSpace.
(dict) --
Describes the connection status of a WorkSpace.
WorkspaceId (string) --
The identifier of the WorkSpace.
ConnectionState (string) --
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
ConnectionStateCheckTimestamp (datetime) --
The timestamp of the connection status check.
LastKnownUserConnectionTimestamp (datetime) --
The timestamp of the last known user connection.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptiondisassociate_connection_alias(**kwargs)¶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 .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_connection_alias(
AliasId='string'
)
[REQUIRED]
The identifier of the connection alias to disassociate.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptiondisassociate_ip_groups(**kwargs)¶Disassociates the specified IP access control group from the specified directory.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_ip_groups(
DirectoryId='string',
GroupIds=[
'string',
]
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The identifiers of one or more IP access control groups.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
import_client_branding(**kwargs)¶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
SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.See also: AWS API Documentation
Request Syntax
response = client.import_client_branding(
ResourceId='string',
DeviceTypeWindows={
'Logo': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
DeviceTypeOsx={
'Logo': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
DeviceTypeAndroid={
'Logo': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
DeviceTypeIos={
'Logo': b'bytes',
'Logo2x': b'bytes',
'Logo3x': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
DeviceTypeLinux={
'Logo': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
DeviceTypeWeb={
'Logo': b'bytes',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
}
)
[REQUIRED]
The directory identifier of the WorkSpace for which you want to import client branding.
The branding information to import for Windows devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information to import for macOS devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information to import for Android devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information to import for iOS devices.
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information to import for Linux devices.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
The branding information to import for web access.
The logo. The only image format accepted is a binary data object that is converted from a .png file.
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
dict
Response Syntax
{
'DeviceTypeWindows': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeOsx': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeAndroid': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeIos': {
'LogoUrl': 'string',
'Logo2xUrl': 'string',
'Logo3xUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeLinux': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
},
'DeviceTypeWeb': {
'LogoUrl': 'string',
'SupportEmail': 'string',
'SupportLink': 'string',
'ForgotPasswordLink': 'string',
'LoginMessage': {
'string': 'string'
}
}
}
Response Structure
(dict) --
DeviceTypeWindows (dict) --
The branding information configured for Windows devices.
LogoUrl (string) --
The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
DeviceTypeOsx (dict) --
The branding information configured for macOS devices.
LogoUrl (string) --
The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
DeviceTypeAndroid (dict) --
The branding information configured for Android devices.
LogoUrl (string) --
The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
DeviceTypeIos (dict) --
The branding information configured for iOS devices.
LogoUrl (string) --
The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
Logo2xUrl (string) --
The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
Logo3xUrl (string) --
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
Note
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines .
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
DeviceTypeLinux (dict) --
The branding information configured for Linux devices.
LogoUrl (string) --
The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
DeviceTypeWeb (dict) --
The branding information configured for web access.
LogoUrl (string) --
The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail (string) --
The support email. The company's customer support email address.
Note
SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .SupportLink (string) --
The support link. The link for the company's customer support page for their WorkSpace.
Note
SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.workspaces-feedback@amazon.com .ForgotPasswordLink (string) --
The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.
LoginMessage (dict) --
The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US . The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul .
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionimport_workspace_image(**kwargs)¶Imports the specified Windows 10 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.
See also: AWS API Documentation
Request Syntax
response = client.import_workspace_image(
Ec2ImageId='string',
IngestionProcess='BYOL_REGULAR'|'BYOL_GRAPHICS'|'BYOL_GRAPHICSPRO'|'BYOL_GRAPHICS_G4DN'|'BYOL_REGULAR_WSP'|'BYOL_REGULAR_BYOP'|'BYOL_GRAPHICS_G4DN_BYOP',
ImageName='string',
ImageDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Applications=[
'Microsoft_Office_2016'|'Microsoft_Office_2019',
]
)
[REQUIRED]
The identifier of the EC2 image.
[REQUIRED]
The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP . To use PCoIP, specify a value that does not end in _WSP . To use BYOP, specify a value that ends in _BYOP .
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR , BYOL_REGULAR_WSP , or BYOL_REGULAR_BYOP , depending on the protocol.
Note
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
[REQUIRED]
The name of the WorkSpace image.
[REQUIRED]
The description of the WorkSpace image.
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Note
Although this parameter is an array, only one item is allowed at this time.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the WorkSpace image.
Exceptions
WorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceAlreadyExistsExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionlist_available_management_cidr_ranges(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.list_available_management_cidr_ranges(
ManagementCidrRangeConstraint='string',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
NextToken from a previous call that was paginated, provide this token to receive the next set of results.dict
Response Syntax
{
'ManagementCidrRanges': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ManagementCidrRanges (list) --
The list of available IP address ranges, specified as IPv4 CIDR blocks.
NextToken (string) --
The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionmigrate_workspace(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.migrate_workspace(
SourceWorkspaceId='string',
BundleId='string'
)
[REQUIRED]
The identifier of the WorkSpace to migrate from.
[REQUIRED]
The identifier of the target bundle type to migrate the WorkSpace to.
dict
Response Syntax
{
'SourceWorkspaceId': 'string',
'TargetWorkspaceId': 'string'
}
Response Structure
(dict) --
SourceWorkspaceId (string) --
The original identifier of the WorkSpace that is being migrated.
TargetWorkspaceId (string) --
The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.OperationInProgressExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionmodify_account(**kwargs)¶Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
See also: AWS API Documentation
Request Syntax
response = client.modify_account(
DedicatedTenancySupport='ENABLED',
DedicatedTenancyManagementCidrRange='string'
)
ListAvailableManagementCidrRanges operation.dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionmodify_certificate_based_auth_properties(**kwargs)¶Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.modify_certificate_based_auth_properties(
ResourceId='string',
CertificateBasedAuthProperties={
'Status': 'DISABLED'|'ENABLED',
'CertificateAuthorityArn': 'string'
},
PropertiesToDelete=[
'CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN',
]
)
[REQUIRED]
The resource identifiers, in the form of directory IDs.
The properties of the certificate-based authentication.
The status of the certificate-based authentication properties.
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
The properties of the certificate-based authentication you want to delete.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionmodify_client_properties(**kwargs)¶Modifies the properties of the specified Amazon WorkSpaces clients.
See also: AWS API Documentation
Request Syntax
response = client.modify_client_properties(
ResourceId='string',
ClientProperties={
'ReconnectEnabled': 'ENABLED'|'DISABLED',
'LogUploadEnabled': 'ENABLED'|'DISABLED'
}
)
[REQUIRED]
The resource identifiers, in the form of directory IDs.
[REQUIRED]
Information about the Amazon WorkSpaces client.
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled, the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionmodify_saml_properties(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.modify_saml_properties(
ResourceId='string',
SamlProperties={
'Status': 'DISABLED'|'ENABLED'|'ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
'UserAccessUrl': 'string',
'RelayStateParameterName': 'string'
},
PropertiesToDelete=[
'SAML_PROPERTIES_USER_ACCESS_URL'|'SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME',
]
)
[REQUIRED]
The directory identifier for which you want to configure SAML properties.
The properties for configuring SAML 2.0 authentication.
Indicates the status of SAML 2.0 authentication. These statuses include the following.
DISABLED , end users will be directed to login with their directory credentials.ENABLED , end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionmodify_selfservice_permissions(**kwargs)¶Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
See also: AWS API Documentation
Request Syntax
response = client.modify_selfservice_permissions(
ResourceId='string',
SelfservicePermissions={
'RestartWorkspace': 'ENABLED'|'DISABLED',
'IncreaseVolumeSize': 'ENABLED'|'DISABLED',
'ChangeComputeType': 'ENABLED'|'DISABLED',
'SwitchRunningMode': 'ENABLED'|'DISABLED',
'RebuildWorkspace': 'ENABLED'|'DISABLED'
}
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The permissions to enable or disable self-service capabilities.
Specifies whether users can restart their WorkSpace.
Specifies whether users can increase the volume size of the drives on their WorkSpace.
Specifies whether users can change the compute type (bundle) for their WorkSpace.
Specifies whether users can switch the running mode of their WorkSpace.
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionmodify_workspace_access_properties(**kwargs)¶Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
See also: AWS API Documentation
Request Syntax
response = client.modify_workspace_access_properties(
ResourceId='string',
WorkspaceAccessProperties={
'DeviceTypeWindows': 'ALLOW'|'DENY',
'DeviceTypeOsx': 'ALLOW'|'DENY',
'DeviceTypeWeb': 'ALLOW'|'DENY',
'DeviceTypeIos': 'ALLOW'|'DENY',
'DeviceTypeAndroid': 'ALLOW'|'DENY',
'DeviceTypeChromeOs': 'ALLOW'|'DENY',
'DeviceTypeZeroClient': 'ALLOW'|'DENY',
'DeviceTypeLinux': 'ALLOW'|'DENY'
}
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The device types and operating systems to enable or disable for access.
Indicates whether users can use Windows clients to access their WorkSpaces.
Indicates whether users can use macOS clients to access their WorkSpaces.
Indicates whether users can access their WorkSpaces through a web browser.
Indicates whether users can use iOS devices to access their WorkSpaces.
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
Indicates whether users can use Chromebooks to access their WorkSpaces.
Indicates whether users can use zero client devices to access their WorkSpaces.
Indicates whether users can use Linux clients to access their WorkSpaces.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionmodify_workspace_creation_properties(**kwargs)¶Modify the default properties used to create WorkSpaces.
See also: AWS API Documentation
Request Syntax
response = client.modify_workspace_creation_properties(
ResourceId='string',
WorkspaceCreationProperties={
'EnableWorkDocs': True|False,
'EnableInternetAccess': True|False,
'DefaultOu': 'string',
'CustomSecurityGroupId': 'string',
'UserEnabledAsLocalAdministrator': True|False,
'EnableMaintenanceMode': True|False
}
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The default properties for creating WorkSpaces.
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
Note
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide . To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide .
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
Indicates whether internet access is enabled for your WorkSpaces.
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value" , where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com .
Warning
The identifier of your custom security group.
Indicates whether users are local administrators of their WorkSpaces.
Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionmodify_workspace_properties(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.modify_workspace_properties(
WorkspaceId='string',
WorkspaceProperties={
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
}
)
[REQUIRED]
The identifier of the WorkSpace.
[REQUIRED]
The properties of the WorkSpace.
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The compute type. For more information, see Amazon WorkSpaces Bundles.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationInProgressExceptionWorkSpaces.Client.exceptions.UnsupportedWorkspaceConfigurationExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionmodify_workspace_state(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.modify_workspace_state(
WorkspaceId='string',
WorkspaceState='AVAILABLE'|'ADMIN_MAINTENANCE'
)
[REQUIRED]
The identifier of the WorkSpace.
[REQUIRED]
The WorkSpace state.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionreboot_workspaces(**kwargs)¶Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY .
This operation is asynchronous and returns before the WorkSpaces have rebooted.
See also: AWS API Documentation
Request Syntax
response = client.reboot_workspaces(
RebootWorkspaceRequests=[
{
'WorkspaceId': 'string'
},
]
)
[REQUIRED]
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
Describes the information used to reboot a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be rebooted.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Exceptions
WorkSpaces.Client.exceptions.OperationNotSupportedExceptionrebuild_workspaces(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.rebuild_workspaces(
RebuildWorkspaceRequests=[
{
'WorkspaceId': 'string'
},
]
)
[REQUIRED]
The WorkSpace to rebuild. You can specify a single WorkSpace.
Describes the information used to rebuild a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpace that could not be rebuilt.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Exceptions
WorkSpaces.Client.exceptions.OperationNotSupportedExceptionregister_workspace_directory(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.register_workspace_directory(
DirectoryId='string',
SubnetIds=[
'string',
],
EnableWorkDocs=True|False,
EnableSelfService=True|False,
Tenancy='DEDICATED'|'SHARED',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
[REQUIRED]
Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.The tags associated with the directory.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.WorkspacesDefaultRoleNotFoundExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.UnsupportedNetworkConfigurationExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionrestore_workspace(**kwargs)¶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.
See also: AWS API Documentation
Request Syntax
response = client.restore_workspace(
WorkspaceId='string'
)
[REQUIRED]
The identifier of the WorkSpace.
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionrevoke_ip_rules(**kwargs)¶Removes one or more rules from the specified IP access control group.
See also: AWS API Documentation
Request Syntax
response = client.revoke_ip_rules(
GroupId='string',
UserRules=[
'string',
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
The rules to remove from the group.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionstart_workspaces(**kwargs)¶Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED .
See also: AWS API Documentation
Request Syntax
response = client.start_workspaces(
StartWorkspaceRequests=[
{
'WorkspaceId': 'string'
},
]
)
[REQUIRED]
The WorkSpaces to start. You can specify up to 25 WorkSpaces.
Information used to start a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be started.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
stop_workspaces(**kwargs)¶Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE , IMPAIRED , UNHEALTHY , or ERROR .
See also: AWS API Documentation
Request Syntax
response = client.stop_workspaces(
StopWorkspaceRequests=[
{
'WorkspaceId': 'string'
},
]
)
[REQUIRED]
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
Describes the information used to stop a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be stopped.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
terminate_workspaces(**kwargs)¶Terminates the specified WorkSpaces.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.terminate_workspaces(
TerminateWorkspaceRequests=[
{
'WorkspaceId': 'string'
},
]
)
[REQUIRED]
The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
Describes the information used to terminate a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be terminated.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), restored ( RestoreWorkspace ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
update_connect_client_add_in(**kwargs)¶Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
See also: AWS API Documentation
Request Syntax
response = client.update_connect_client_add_in(
AddInId='string',
ResourceId='string',
Name='string',
URL='string'
)
[REQUIRED]
The identifier of the client add-in to update.
[REQUIRED]
The directory identifier for which the client add-in is configured.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionupdate_connection_alias_permission(**kwargs)¶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
CREATED .See also: AWS API Documentation
Request Syntax
response = client.update_connection_alias_permission(
AliasId='string',
ConnectionAliasPermission={
'SharedAccountId': 'string',
'AllowAssociation': True|False
}
)
[REQUIRED]
The identifier of the connection alias that you want to update permissions for.
[REQUIRED]
Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
The identifier of the Amazon Web Services account that the connection alias is shared with.
Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceAssociatedExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionupdate_rules_of_ip_group(**kwargs)¶Replaces the current rules of the specified IP access control group with the specified rules.
See also: AWS API Documentation
Request Syntax
response = client.update_rules_of_ip_group(
GroupId='string',
UserRules=[
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
One or more rules.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceLimitExceededExceptionWorkSpaces.Client.exceptions.InvalidResourceStateExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionupdate_workspace_bundle(**kwargs)¶Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Warning
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.
See also: AWS API Documentation
Request Syntax
response = client.update_workspace_bundle(
BundleId='string',
ImageId='string'
)
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionupdate_workspace_image_permission(**kwargs)¶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
See also: AWS API Documentation
Request Syntax
response = client.update_workspace_image_permission(
ImageId='string',
AllowCopyImage=True|False,
SharedAccountId='string'
)
[REQUIRED]
The identifier of the image.
[REQUIRED]
The permission to copy the image. This permission can be revoked only after an image has been shared.
[REQUIRED]
The identifier of the Amazon Web Services account to share or unshare the image with.
Warning
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
dict
Response Syntax
{}
Response Structure
Exceptions
WorkSpaces.Client.exceptions.ResourceNotFoundExceptionWorkSpaces.Client.exceptions.ResourceUnavailableExceptionWorkSpaces.Client.exceptions.AccessDeniedExceptionWorkSpaces.Client.exceptions.InvalidParameterValuesExceptionWorkSpaces.Client.exceptions.OperationNotSupportedExceptionThe available paginators are:
WorkSpaces.Paginator.DescribeAccountModificationsWorkSpaces.Paginator.DescribeIpGroupsWorkSpaces.Paginator.DescribeWorkspaceBundlesWorkSpaces.Paginator.DescribeWorkspaceDirectoriesWorkSpaces.Paginator.DescribeWorkspaceImagesWorkSpaces.Paginator.DescribeWorkspacesWorkSpaces.Paginator.DescribeWorkspacesConnectionStatusWorkSpaces.Paginator.ListAvailableManagementCidrRangesWorkSpaces.Paginator.DescribeAccountModifications¶paginator = client.get_paginator('describe_account_modifications')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_account_modifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'AccountModifications': [
{
'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string',
'StartTime': datetime(2015, 1, 1),
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
}
Response Structure
The list of modifications to the configuration of BYOL.
Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account.
The state of the modification to the configuration of BYOL.
The status of BYOL (whether BYOL is being enabled or disabled).
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
The timestamp when the modification of the BYOL configuration was started.
The error code that is returned if the configuration of BYOL cannot be modified.
The text of the error message that is returned if the configuration of BYOL cannot be modified.
WorkSpaces.Paginator.DescribeIpGroups¶paginator = client.get_paginator('describe_ip_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_ip_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GroupIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifiers of one or more IP access control groups.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Result': [
{
'groupId': 'string',
'groupName': 'string',
'groupDesc': 'string',
'userRules': [
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
},
],
}
Response Structure
(dict) --
Result (list) --
Information about the IP access control groups.
(dict) --
Describes an IP access control group.
groupId (string) --
The identifier of the group.
groupName (string) --
The name of the group.
groupDesc (string) --
The description of the group.
userRules (list) --
The rules.
(dict) --
Describes a rule for an IP access control group.
ipRule (string) --
The IP address range, in CIDR notation.
ruleDesc (string) --
The description.
WorkSpaces.Paginator.DescribeWorkspaceBundles¶paginator = client.get_paginator('describe_workspace_bundles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspace_bundles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
BundleIds=[
'string',
],
Owner='string',
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON . To describe the bundles that belong to your account, don't specify a value.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Bundles': [
{
'BundleId': 'string',
'Name': 'string',
'Owner': 'string',
'Description': 'string',
'ImageId': 'string',
'RootStorage': {
'Capacity': 'string'
},
'UserStorage': {
'Capacity': 'string'
},
'ComputeType': {
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
},
'LastUpdatedTime': datetime(2015, 1, 1),
'CreationTime': datetime(2015, 1, 1),
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'BundleType': 'REGULAR'|'STANDBY'
},
],
}
Response Structure
(dict) --
Bundles (list) --
Information about the bundles.
(dict) --
Describes a WorkSpace bundle.
BundleId (string) --
The identifier of the bundle.
Name (string) --
The name of the bundle.
Owner (string) --
The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
Description (string) --
The description of the bundle.
ImageId (string) --
The identifier of the image that was used to create the bundle.
RootStorage (dict) --
The size of the root volume.
Capacity (string) --
The size of the root volume.
UserStorage (dict) --
The size of the user volume.
Capacity (string) --
The size of the user volume.
ComputeType (dict) --
The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
Name (string) --
The compute type.
LastUpdatedTime (datetime) --
The last time that the bundle was updated.
CreationTime (datetime) --
The time when the bundle was created.
State (string) --
The state of the WorkSpace bundle.
BundleType (string) --
The type of WorkSpace bundle.
WorkSpaces.Paginator.DescribeWorkspaceDirectories¶paginator = client.get_paginator('describe_workspace_directories')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspace_directories().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
DirectoryIds=[
'string',
],
Limit=123,
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The identifiers of the directories. If the value is null, all directories are retrieved.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Directories': [
{
'DirectoryId': 'string',
'Alias': 'string',
'DirectoryName': 'string',
'RegistrationCode': 'string',
'SubnetIds': [
'string',
],
'DnsIpAddresses': [
'string',
],
'CustomerUserName': 'string',
'IamRoleId': 'string',
'DirectoryType': 'SIMPLE_AD'|'AD_CONNECTOR',
'WorkspaceSecurityGroupId': 'string',
'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR',
'WorkspaceCreationProperties': {
'EnableWorkDocs': True|False,
'EnableInternetAccess': True|False,
'DefaultOu': 'string',
'CustomSecurityGroupId': 'string',
'UserEnabledAsLocalAdministrator': True|False,
'EnableMaintenanceMode': True|False
},
'ipGroupIds': [
'string',
],
'WorkspaceAccessProperties': {
'DeviceTypeWindows': 'ALLOW'|'DENY',
'DeviceTypeOsx': 'ALLOW'|'DENY',
'DeviceTypeWeb': 'ALLOW'|'DENY',
'DeviceTypeIos': 'ALLOW'|'DENY',
'DeviceTypeAndroid': 'ALLOW'|'DENY',
'DeviceTypeChromeOs': 'ALLOW'|'DENY',
'DeviceTypeZeroClient': 'ALLOW'|'DENY',
'DeviceTypeLinux': 'ALLOW'|'DENY'
},
'Tenancy': 'DEDICATED'|'SHARED',
'SelfservicePermissions': {
'RestartWorkspace': 'ENABLED'|'DISABLED',
'IncreaseVolumeSize': 'ENABLED'|'DISABLED',
'ChangeComputeType': 'ENABLED'|'DISABLED',
'SwitchRunningMode': 'ENABLED'|'DISABLED',
'RebuildWorkspace': 'ENABLED'|'DISABLED'
},
'SamlProperties': {
'Status': 'DISABLED'|'ENABLED'|'ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
'UserAccessUrl': 'string',
'RelayStateParameterName': 'string'
},
'CertificateBasedAuthProperties': {
'Status': 'DISABLED'|'ENABLED',
'CertificateAuthorityArn': 'string'
}
},
],
}
Response Structure
(dict) --
Directories (list) --
Information about the directories.
(dict) --
Describes a directory that is used with Amazon WorkSpaces.
DirectoryId (string) --
The directory identifier.
Alias (string) --
The directory alias.
DirectoryName (string) --
The name of the directory.
RegistrationCode (string) --
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
SubnetIds (list) --
The identifiers of the subnets used with the directory.
DnsIpAddresses (list) --
The IP addresses of the DNS servers for the directory.
CustomerUserName (string) --
The user name for the service account.
IamRoleId (string) --
The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
DirectoryType (string) --
The directory type.
WorkspaceSecurityGroupId (string) --
The identifier of the security group that is assigned to new WorkSpaces.
State (string) --
The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.
WorkspaceCreationProperties (dict) --
The default creation properties for all WorkSpaces in the directory.
EnableWorkDocs (boolean) --
Specifies whether the directory is enabled for Amazon WorkDocs.
EnableInternetAccess (boolean) --
Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.
DefaultOu (string) --
The organizational unit (OU) in the directory for the WorkSpace machine accounts.
CustomSecurityGroupId (string) --
The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.
UserEnabledAsLocalAdministrator (boolean) --
Specifies whether WorkSpace users are local administrators on their WorkSpaces.
EnableMaintenanceMode (boolean) --
Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.
ipGroupIds (list) --
The identifiers of the IP access control groups associated with the directory.
WorkspaceAccessProperties (dict) --
The devices and operating systems that users can use to access WorkSpaces.
DeviceTypeWindows (string) --
Indicates whether users can use Windows clients to access their WorkSpaces.
DeviceTypeOsx (string) --
Indicates whether users can use macOS clients to access their WorkSpaces.
DeviceTypeWeb (string) --
Indicates whether users can access their WorkSpaces through a web browser.
DeviceTypeIos (string) --
Indicates whether users can use iOS devices to access their WorkSpaces.
DeviceTypeAndroid (string) --
Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
DeviceTypeChromeOs (string) --
Indicates whether users can use Chromebooks to access their WorkSpaces.
DeviceTypeZeroClient (string) --
Indicates whether users can use zero client devices to access their WorkSpaces.
DeviceTypeLinux (string) --
Indicates whether users can use Linux clients to access their WorkSpaces.
Tenancy (string) --
Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images.
SelfservicePermissions (dict) --
The default self-service permissions for WorkSpaces in the directory.
RestartWorkspace (string) --
Specifies whether users can restart their WorkSpace.
IncreaseVolumeSize (string) --
Specifies whether users can increase the volume size of the drives on their WorkSpace.
ChangeComputeType (string) --
Specifies whether users can change the compute type (bundle) for their WorkSpace.
SwitchRunningMode (string) --
Specifies whether users can switch the running mode of their WorkSpace.
RebuildWorkspace (string) --
Specifies whether users can rebuild the operating system of a WorkSpace to its original state.
SamlProperties (dict) --
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.
Status (string) --
Indicates the status of SAML 2.0 authentication. These statuses include the following.
DISABLED , end users will be directed to login with their directory credentials.ENABLED , end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.UserAccessUrl (string) --
The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
RelayStateParameterName (string) --
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
CertificateBasedAuthProperties (dict) --
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
Status (string) --
The status of the certificate-based authentication properties.
CertificateAuthorityArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
WorkSpaces.Paginator.DescribeWorkspaceImages¶paginator = client.get_paginator('describe_workspace_images')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspace_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ImageIds=[
'string',
],
ImageType='OWNED'|'SHARED',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifier of the image.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Images': [
{
'ImageId': 'string',
'Name': 'string',
'Description': 'string',
'OperatingSystem': {
'Type': 'WINDOWS'|'LINUX'
},
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'RequiredTenancy': 'DEFAULT'|'DEDICATED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'Created': datetime(2015, 1, 1),
'OwnerAccountId': 'string',
'Updates': {
'UpdateAvailable': True|False,
'Description': 'string'
}
},
],
}
Response Structure
(dict) --
Images (list) --
Information about the images.
(dict) --
Describes a WorkSpace image.
ImageId (string) --
The identifier of the image.
Name (string) --
The name of the image.
Description (string) --
The description of the image.
OperatingSystem (dict) --
The operating system that the image is running.
Type (string) --
The operating system.
State (string) --
The status of the image.
RequiredTenancy (string) --
Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images.
ErrorCode (string) --
The error code that is returned for the image.
ErrorMessage (string) --
The text of the error message that is returned for the image.
Created (datetime) --
The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
OwnerAccountId (string) --
The identifier of the Amazon Web Services account that owns the image.
Updates (dict) --
The updates (if any) that are available for the specified image.
UpdateAvailable (boolean) --
Indicates whether updated drivers or other components are available for the specified WorkSpace image.
Description (string) --
A description of whether updates for the WorkSpace image are pending or available.
WorkSpaces.Paginator.DescribeWorkspaces¶paginator = client.get_paginator('describe_workspaces')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspaces().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
WorkspaceIds=[
'string',
],
DirectoryId='string',
UserName='string',
BundleId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
UserName ). You cannot combine this parameter with any other filter.DirectoryId .A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Workspaces': [
{
'WorkspaceId': 'string',
'DirectoryId': 'string',
'UserName': 'string',
'IpAddress': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'BundleId': 'string',
'SubnetId': 'string',
'ErrorMessage': 'string',
'ErrorCode': 'string',
'ComputerName': 'string',
'VolumeEncryptionKey': 'string',
'UserVolumeEncryptionEnabled': True|False,
'RootVolumeEncryptionEnabled': True|False,
'WorkspaceProperties': {
'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
'RunningModeAutoStopTimeoutInMinutes': 123,
'RootVolumeSizeGib': 123,
'UserVolumeSizeGib': 123,
'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
'Protocols': [
'PCOIP'|'WSP',
]
},
'ModificationStates': [
{
'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
},
],
'RelatedWorkspaces': [
{
'WorkspaceId': 'string',
'Region': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
'Type': 'PRIMARY'|'STANDBY'
},
]
},
],
}
Response Structure
(dict) --
Workspaces (list) --
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
(dict) --
Describes a WorkSpace.
WorkspaceId (string) --
The identifier of the WorkSpace.
DirectoryId (string) --
The identifier of the Directory Service directory for the WorkSpace.
UserName (string) --
The user for the WorkSpace.
IpAddress (string) --
The IP address of the WorkSpace.
State (string) --
The operational state of the WorkSpace.
Note
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.
BundleId (string) --
The identifier of the bundle used to create the WorkSpace.
SubnetId (string) --
The identifier of the subnet for the WorkSpace.
ErrorMessage (string) --
The text of the error message that is returned if the WorkSpace cannot be created.
ErrorCode (string) --
The error code that is returned if the WorkSpace cannot be created.
ComputerName (string) --
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
VolumeEncryptionKey (string) --
The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
UserVolumeEncryptionEnabled (boolean) --
Indicates whether the data stored on the user volume is encrypted.
RootVolumeEncryptionEnabled (boolean) --
Indicates whether the data stored on the root volume is encrypted.
WorkspaceProperties (dict) --
The properties of the WorkSpace.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Note
The MANUAL 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.
RunningModeAutoStopTimeoutInMinutes (integer) --
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
RootVolumeSizeGib (integer) --
The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
UserVolumeSizeGib (integer) --
The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
ComputeTypeName (string) --
The compute type. For more information, see Amazon WorkSpaces Bundles.
Protocols (list) --
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Note
Protocols property is case sensitive. Ensure you use PCOIP or WSP .ModificationStates (list) --
The modification states of the WorkSpace.
(dict) --
Describes a WorkSpace modification.
Resource (string) --
The resource.
State (string) --
The modification state.
RelatedWorkspaces (list) --
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
(dict) --
Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
WorkspaceId (string) --
The identifier of the related WorkSpace.
Region (string) --
The Region of the related WorkSpace.
State (string) --
Indicates the state of the WorkSpace.
Type (string) --
Indicates the type of WorkSpace.
WorkSpaces.Paginator.DescribeWorkspacesConnectionStatus¶paginator = client.get_paginator('describe_workspaces_connection_status')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspaces_connection_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
WorkspaceIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'WorkspacesConnectionStatus': [
{
'WorkspaceId': 'string',
'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
WorkspacesConnectionStatus (list) --
Information about the connection status of the WorkSpace.
(dict) --
Describes the connection status of a WorkSpace.
WorkspaceId (string) --
The identifier of the WorkSpace.
ConnectionState (string) --
The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.
ConnectionStateCheckTimestamp (datetime) --
The timestamp of the connection status check.
LastKnownUserConnectionTimestamp (datetime) --
The timestamp of the last known user connection.
WorkSpaces.Paginator.ListAvailableManagementCidrRanges¶paginator = client.get_paginator('list_available_management_cidr_ranges')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from WorkSpaces.Client.list_available_management_cidr_ranges().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ManagementCidrRangeConstraint='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ManagementCidrRanges': [
'string',
],
}
Response Structure
(dict) --
ManagementCidrRanges (list) --
The list of available IP address ranges, specified as IPv4 CIDR blocks.