2024/12/19 - Amazon WorkSpaces - 5 updated api methods
Changes Added AWS Global Accelerator (AGA) support for WorkSpaces Personal.
{'Workspaces': {'WorkspaceProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO '
'| '
'DISABLED '
'| '
'INHERITED',
'PreferredProtocol': 'TCP '
'| '
'NONE '
'| '
'INHERITED'}}}}
Response {'FailedRequests': {'WorkspaceRequest': {'WorkspaceProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO '
'| '
'DISABLED '
'| '
'INHERITED',
'PreferredProtocol': 'TCP '
'| '
'NONE '
'| '
'INHERITED'}}}},
'PendingRequests': {'WorkspaceProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO '
'| '
'DISABLED '
'| '
'INHERITED',
'PreferredProtocol': 'TCP '
'| '
'NONE '
'| '
'INHERITED'}}}}
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
See also: AWS API Documentation
Request Syntax
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',
],
'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WorkspaceName': 'string'
},
]
)
list
[REQUIRED]
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
(dict) --
Describes the information used to create a WorkSpace.
DirectoryId (string) -- [REQUIRED]
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
UserName (string) -- [REQUIRED]
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.
The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.
BundleId (string) -- [REQUIRED]
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
VolumeEncryptionKey (string) --
The ARN of 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 WorkSpace properties.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
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.
(string) --
OperatingSystemName (string) --
The name of the operating system.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) -- [REQUIRED]
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
Tags (list) --
The tags for the WorkSpace.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
WorkspaceName (string) --
The name of the user-decoupled WorkSpace.
dict
Response Syntax
{
'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',
],
'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
}
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'WorkspaceName': '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,
'WorkspaceName': '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',
],
'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
}
},
'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'
},
],
'DataReplicationSettings': {
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': datetime(2015, 1, 1)
},
'StandbyWorkspacesProperties': [
{
'StandbyWorkspaceId': 'string',
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
(dict) --
FailedRequests (list) --
Information about the WorkSpaces that could not be created.
(dict) --
Describes a WorkSpace that cannot be created.
WorkspaceRequest (dict) --
Information about the WorkSpace.
DirectoryId (string) --
The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
UserName (string) --
The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.
The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.
BundleId (string) --
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
VolumeEncryptionKey (string) --
The ARN of 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 WorkSpace properties.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
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.
(string) --
OperatingSystemName (string) --
The name of the operating system.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) --
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
Tags (list) --
The tags for the WorkSpace.
(dict) --
Describes a tag.
Key (string) --
The key of the tag.
Value (string) --
The value of the tag.
WorkspaceName (string) --
The name of the user-decoupled WorkSpace.
ErrorCode (string) --
The error code that is returned if the WorkSpace cannot be created.
ErrorMessage (string) --
The text of the error message that is returned if the WorkSpace cannot be created.
PendingRequests (list) --
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.
(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.
PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
AVAILABLE – The WorkSpace is running and has passed the health checks.
IMPAIRED – Refer to UNHEALTHY state.
UNHEALTHY – The WorkSpace is not responding to health checks.
REBOOTING – The WorkSpace is being rebooted (restarted).
STARTING – The WorkSpace is starting up and health checks are being run.
REBUILDING – The WorkSpace is being rebuilt.
RESTORING – The WorkSpace is being restored.
MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
TERMINATING – The WorkSpace is being deleted.
TERMINATED – The WorkSpace has been deleted.
SUSPENDED – The WorkSpace has been suspended for image creation.
UPDATING – The WorkSpace is undergoing an update.
STOPPING – The WorkSpace is being stopped.
STOPPED – The WorkSpace has been stopped.
ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
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 ARN of 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.
WorkspaceName (string) --
The name of the user-decoupled WorkSpace.
WorkspaceProperties (dict) --
The properties of the WorkSpace.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
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.
(string) --
OperatingSystemName (string) --
The name of the operating system.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) --
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
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.
DataReplicationSettings (dict) --
Indicates the settings of the data replication.
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
RecoverySnapshotTime (datetime) --
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
StandbyWorkspacesProperties (list) --
The properties of the standby WorkSpace
(dict) --
Describes the properties of the related standby WorkSpaces.
StandbyWorkspaceId (string) --
The identifier of the standby WorkSpace
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
RecoverySnapshotTime (datetime) --
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
{'Directories': {'StreamingProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO '
'| '
'DISABLED',
'PreferredProtocol': 'TCP '
'| '
'NONE'}}}}
Describes the available directories that are registered with Amazon WorkSpaces.
See also: AWS API Documentation
Request Syntax
client.describe_workspace_directories(
DirectoryIds=[
'string',
],
WorkspaceDirectoryNames=[
'string',
],
Limit=123,
NextToken='string',
Filters=[
{
'Name': 'USER_IDENTITY_TYPE'|'WORKSPACE_TYPE',
'Values': [
'string',
]
},
]
)
list
The identifiers of the directories. If the value is null, all directories are retrieved.
(string) --
list
The names of the WorkSpace directories.
(string) --
integer
The maximum number of directories to return.
string
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
list
The filter condition for the WorkSpaces.
(dict) --
Describes the filter conditions for the WorkSpaces to return.
Name (string) -- [REQUIRED]
The name of the WorkSpaces to filter.
Values (list) -- [REQUIRED]
The values for filtering WorkSpaces
(string) --
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'|'CUSTOMER_MANAGED'|'AWS_IAM_IDENTITY_CENTER',
'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,
'InstanceIamRoleArn': 'string'
},
'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'
},
'MicrosoftEntraConfig': {
'TenantId': 'string',
'ApplicationConfigSecretArn': 'string'
},
'WorkspaceDirectoryName': 'string',
'WorkspaceDirectoryDescription': 'string',
'UserIdentityType': 'CUSTOMER_MANAGED'|'AWS_DIRECTORY_SERVICE'|'AWS_IAM_IDENTITY_CENTER',
'WorkspaceType': 'PERSONAL'|'POOLS',
'IDCConfig': {
'InstanceArn': 'string',
'ApplicationArn': 'string'
},
'ActiveDirectoryConfig': {
'DomainName': 'string',
'ServiceAccountSecretArn': 'string'
},
'StreamingProperties': {
'StreamingExperiencePreferredProtocol': 'TCP'|'UDP',
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'PRINTING_TO_LOCAL_DEVICE'|'SMART_CARD',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
'StorageConnectors': [
{
'ConnectorType': 'HOME_FOLDER',
'Status': 'ENABLED'|'DISABLED'
},
],
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED',
'PreferredProtocol': 'TCP'|'NONE'
}
},
'ErrorMessage': '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.
(string) --
DnsIpAddresses (list) --
The IP addresses of the DNS servers for the directory.
(string) --
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.
InstanceIamRoleArn (string) --
Indicates the IAM role ARN of the instance.
ipGroupIds (list) --
The identifiers of the IP access control groups associated with the directory.
(string) --
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.
If the setting is DISABLED, end users will be directed to login with their directory credentials.
If the setting is 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.
If the setting is 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.
MicrosoftEntraConfig (dict) --
Specifies details about Microsoft Entra configurations.
TenantId (string) --
The identifier of the tenant.
ApplicationConfigSecretArn (string) --
The Amazon Resource Name (ARN) of the application config.
WorkspaceDirectoryName (string) --
The name fo the WorkSpace directory.
WorkspaceDirectoryDescription (string) --
The description of the WorkSpace directory
UserIdentityType (string) --
Indicates the identity type of the specifired user.
WorkspaceType (string) --
Indicates whether the directory's WorkSpace type is personal or pools.
IDCConfig (dict) --
Specifies details about identity center configurations.
InstanceArn (string) --
The Amazon Resource Name (ARN) of the identity center instance.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the application.
ActiveDirectoryConfig (dict) --
Information about the Active Directory config.
DomainName (string) --
The name of the domain.
ServiceAccountSecretArn (string) --
Indicates the secret ARN on the service account.
StreamingProperties (dict) --
The streaming properties to configure.
StreamingExperiencePreferredProtocol (string) --
Indicates the type of preferred protocol for the streaming experience.
UserSettings (list) --
Indicates the permission settings asscoiated with the user.
(dict) --
Information about the user's permission settings.
Action (string) --
Indicates the type of action.
Permission (string) --
Indicates if the setting is enabled or disabled.
MaximumLength (integer) --
Indicates the maximum character length for the specified user setting.
StorageConnectors (list) --
Indicates the storage connector used
(dict) --
Describes the storage connector.
ConnectorType (string) --
The type of connector used to save user files.
Status (string) --
Indicates if the storage connetor is enabled or disabled.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) --
Indicates if Global Accelerator for directory is enabled or disabled.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
ErrorMessage (string) --
The error message returned.
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.
{'Workspaces': {'WorkspaceProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO '
'| '
'DISABLED '
'| '
'INHERITED',
'PreferredProtocol': 'TCP '
'| '
'NONE '
'| '
'INHERITED'}}}}
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
client.describe_workspaces(
WorkspaceIds=[
'string',
],
DirectoryId='string',
UserName='string',
BundleId='string',
Limit=123,
NextToken='string',
WorkspaceName='string'
)
list
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.
(string) --
string
The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.
string
The name of the directory user. You must specify this parameter with DirectoryId.
string
The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.
integer
The maximum number of items to return.
string
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
string
The name of the user-decoupled WorkSpace.
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,
'WorkspaceName': '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',
],
'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
}
},
'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'
},
],
'DataReplicationSettings': {
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': datetime(2015, 1, 1)
},
'StandbyWorkspacesProperties': [
{
'StandbyWorkspaceId': 'string',
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': datetime(2015, 1, 1)
},
]
},
],
'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.
PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
AVAILABLE – The WorkSpace is running and has passed the health checks.
IMPAIRED – Refer to UNHEALTHY state.
UNHEALTHY – The WorkSpace is not responding to health checks.
REBOOTING – The WorkSpace is being rebooted (restarted).
STARTING – The WorkSpace is starting up and health checks are being run.
REBUILDING – The WorkSpace is being rebuilt.
RESTORING – The WorkSpace is being restored.
MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
TERMINATING – The WorkSpace is being deleted.
TERMINATED – The WorkSpace has been deleted.
SUSPENDED – The WorkSpace has been suspended for image creation.
UPDATING – The WorkSpace is undergoing an update.
STOPPING – The WorkSpace is being stopped.
STOPPED – The WorkSpace has been stopped.
ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
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 ARN of 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.
WorkspaceName (string) --
The name of the user-decoupled WorkSpace.
WorkspaceProperties (dict) --
The properties of the WorkSpace.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
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.
(string) --
OperatingSystemName (string) --
The name of the operating system.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) --
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
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.
DataReplicationSettings (dict) --
Indicates the settings of the data replication.
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
RecoverySnapshotTime (datetime) --
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
StandbyWorkspacesProperties (list) --
The properties of the standby WorkSpace
(dict) --
Describes the properties of the related standby WorkSpaces.
StandbyWorkspaceId (string) --
The identifier of the standby WorkSpace
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
RecoverySnapshotTime (datetime) --
The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.
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.
{'StreamingProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO | '
'DISABLED',
'PreferredProtocol': 'TCP | '
'NONE'}}}
Modifies the specified streaming properties.
See also: AWS API Documentation
Request Syntax
client.modify_streaming_properties(
ResourceId='string',
StreamingProperties={
'StreamingExperiencePreferredProtocol': 'TCP'|'UDP',
'UserSettings': [
{
'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'PRINTING_TO_LOCAL_DEVICE'|'SMART_CARD',
'Permission': 'ENABLED'|'DISABLED',
'MaximumLength': 123
},
],
'StorageConnectors': [
{
'ConnectorType': 'HOME_FOLDER',
'Status': 'ENABLED'|'DISABLED'
},
],
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED',
'PreferredProtocol': 'TCP'|'NONE'
}
}
)
string
[REQUIRED]
The identifier of the resource.
dict
The streaming properties to configure.
StreamingExperiencePreferredProtocol (string) --
Indicates the type of preferred protocol for the streaming experience.
UserSettings (list) --
Indicates the permission settings asscoiated with the user.
(dict) --
Information about the user's permission settings.
Action (string) -- [REQUIRED]
Indicates the type of action.
Permission (string) -- [REQUIRED]
Indicates if the setting is enabled or disabled.
MaximumLength (integer) --
Indicates the maximum character length for the specified user setting.
StorageConnectors (list) --
Indicates the storage connector used
(dict) --
Describes the storage connector.
ConnectorType (string) -- [REQUIRED]
The type of connector used to save user files.
Status (string) -- [REQUIRED]
Indicates if the storage connetor is enabled or disabled.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) -- [REQUIRED]
Indicates if Global Accelerator for directory is enabled or disabled.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
dict
Response Syntax
{}
Response Structure
(dict) --
{'WorkspaceProperties': {'GlobalAccelerator': {'Mode': 'ENABLED_AUTO | '
'DISABLED | INHERITED',
'PreferredProtocol': 'TCP | '
'NONE | '
'INHERITED'}}}
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
See also: AWS API Documentation
Request Syntax
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',
],
'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
'GlobalAccelerator': {
'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
}
},
DataReplication='NO_REPLICATION'|'PRIMARY_AS_SOURCE'
)
string
[REQUIRED]
The identifier of the WorkSpace.
dict
The properties of the WorkSpace.
RunningMode (string) --
The running mode. For more information, see Manage the WorkSpace Running Mode.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
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.
(string) --
OperatingSystemName (string) --
The name of the operating system.
GlobalAccelerator (dict) --
Indicates the Global Accelerator properties.
Mode (string) -- [REQUIRED]
Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.
PreferredProtocol (string) --
Indicates the preferred protocol for Global Accelerator.
string
Indicates the data replication status.
dict
Response Syntax
{}
Response Structure
(dict) --