2023/11/27 - Amazon WorkSpaces - 4 updated api methods
Changes The release introduces Multi-Region Resilience one-way data replication that allows you to replicate data from your primary WorkSpace to a standby WorkSpace in another AWS Region. DescribeWorkspaces now returns the status of data replication.
{'StandbyWorkspaces': {'DataReplication': 'NO_REPLICATION | PRIMARY_AS_SOURCE'}}
Response {'FailedStandbyRequests': {'StandbyWorkspaceRequest': {'DataReplication': 'NO_REPLICATION '
'| '
'PRIMARY_AS_SOURCE'}}}
Creates a standby WorkSpace in a secondary Region.
See also: AWS API Documentation
Request Syntax
client.create_standby_workspaces(
PrimaryRegion='string',
StandbyWorkspaces=[
{
'PrimaryWorkspaceId': 'string',
'VolumeEncryptionKey': 'string',
'DirectoryId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE'
},
]
)
string
[REQUIRED]
The Region of the primary WorkSpace.
list
[REQUIRED]
Information about the standby WorkSpace to be created.
(dict) --
Describes a standby WorkSpace.
PrimaryWorkspaceId (string) -- [REQUIRED]
The identifier of the standby WorkSpace.
VolumeEncryptionKey (string) --
The volume encryption key of the standby WorkSpace.
DirectoryId (string) -- [REQUIRED]
The identifier of the directory for the standby WorkSpace.
Tags (list) --
The tags associated with the standby WorkSpace.
(dict) --
Describes a tag.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
dict
Response Syntax
{
'FailedStandbyRequests': [
{
'StandbyWorkspaceRequest': {
'PrimaryWorkspaceId': 'string',
'VolumeEncryptionKey': 'string',
'DirectoryId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE'
},
'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.
DataReplication (string) --
Indicates whether data replication is enabled, and if enabled, the type of data replication.
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.
{'PendingRequests': {'DataReplicationSettings': {'DataReplication': 'NO_REPLICATION '
'| '
'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': 'timestamp'},
'StandbyWorkspacesProperties': [{'DataReplication': 'NO_REPLICATION '
'| '
'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': 'timestamp',
'StandbyWorkspaceId': 'string'}]}}
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
Note
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
You don't need to specify the PCOIP protocol for Linux bundles because WSP is the default protocol for those bundles.
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'
},
'Tags': [
{
'Key': 'string',
'Value': '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.
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.
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
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP .
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
(string) --
OperatingSystemName (string) --
The name of the operating system.
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.
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'
},
'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',
],
'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'
},
'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.
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.
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
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP .
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
(string) --
OperatingSystemName (string) --
The name of the operating system.
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.
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.
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 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 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
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP .
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
(string) --
OperatingSystemName (string) --
The name of the operating system.
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.
{'Workspaces': {'DataReplicationSettings': {'DataReplication': 'NO_REPLICATION '
'| '
'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': 'timestamp'},
'StandbyWorkspacesProperties': [{'DataReplication': 'NO_REPLICATION '
'| '
'PRIMARY_AS_SOURCE',
'RecoverySnapshotTime': 'timestamp',
'StandbyWorkspaceId': 'string'}]}}
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'
)
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.
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',
],
'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'
},
'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.
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 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 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
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP .
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
(string) --
OperatingSystemName (string) --
The name of the operating system.
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.
{'DataReplication': 'NO_REPLICATION | PRIMARY_AS_SOURCE'}
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
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
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'
},
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.
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
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP .
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
(string) --
OperatingSystemName (string) --
The name of the operating system.
string
Indicates the data replication status.
dict
Response Syntax
{}
Response Structure
(dict) --