2023/10/05 - Amazon WorkSpaces - 8 new 3 updated api methods
Changes This release introduces Manage applications. This feature allows users to manage their WorkSpaces applications by associating or disassociating their WorkSpaces with applications. The DescribeWorkspaces API will now additionally return OperatingSystemName in its responses.
Deploys associated applications to the specified WorkSpace
See also: AWS API Documentation
Request Syntax
client.deploy_workspace_applications(
WorkspaceId='string',
Force=True|False
)
string
[REQUIRED]
The identifier of the WorkSpace.
boolean
Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.
dict
Response Syntax
{
'Deployment': {
'Associations': [
{
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
},
'WorkspaceId': 'string'
},
]
}
}
Response Structure
(dict) --
Deployment (dict) --
The list of deployed associations and information about them.
Associations (list) --
The associations between the applications and the associated resources.
(dict) --
Describes the association between an application and a WorkSpace resource.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource types of the associated resource.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the WorkSpace resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
WorkspaceId (string) --
The identifier of the WorkSpace.
Describes the associations between the applications and the specified image.
See also: AWS API Documentation
Request Syntax
client.describe_image_associations(
ImageId='string',
AssociatedResourceTypes=[
'APPLICATION',
]
)
string
[REQUIRED]
The identifier of the image.
list
[REQUIRED]
The resource types of the associated resource.
(string) --
dict
Response Syntax
{
'Associations': [
{
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'ImageId': 'string',
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Associations (list) --
List of information about the specified associations.
(dict) --
Describes the association between an application and an image resource.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource type of the associated resources.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
ImageId (string) --
The identifier of the image.
State (string) --
The status of the image resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
Describes the associations between the applications and the specified bundle.
See also: AWS API Documentation
Request Syntax
client.describe_bundle_associations(
BundleId='string',
AssociatedResourceTypes=[
'APPLICATION',
]
)
string
[REQUIRED]
The identifier of the bundle.
list
[REQUIRED]
The resource types of the associated resource.
(string) --
dict
Response Syntax
{
'Associations': [
{
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'BundleId': 'string',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Associations (list) --
List of information about the specified associations.
(dict) --
Describes the association between an application and a bundle resource.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource type of the associated resources.
BundleId (string) --
The identifier of the bundle.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the bundle resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
Disassociates the specified application from a WorkSpace.
See also: AWS API Documentation
Request Syntax
client.disassociate_workspace_application(
WorkspaceId='string',
ApplicationId='string'
)
string
[REQUIRED]
The identifier of the WorkSpace.
string
[REQUIRED]
The identifier of the application.
dict
Response Syntax
{
'Association': {
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
},
'WorkspaceId': 'string'
}
}
Response Structure
(dict) --
Association (dict) --
Information about the targeted association.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource types of the associated resource.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the WorkSpace resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
WorkspaceId (string) --
The identifier of the WorkSpace.
Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
See also: AWS API Documentation
Request Syntax
client.describe_applications(
ApplicationIds=[
'string',
],
ComputeTypeNames=[
'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
],
LicenseType='LICENSED'|'UNLICENSED',
OperatingSystemNames=[
'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',
],
Owner='string',
MaxResults=123,
NextToken='string'
)
list
The identifiers of one or more applications.
(string) --
list
The compute types supported by the applications.
(string) --
string
The license availability for the applications.
list
The operating systems supported by the applications.
(string) --
string
The owner of the applications.
integer
The maximum number of applications 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
{
'Applications': [
{
'ApplicationId': 'string',
'Created': datetime(2015, 1, 1),
'Description': 'string',
'LicenseType': 'LICENSED'|'UNLICENSED',
'Name': 'string',
'Owner': 'string',
'State': 'PENDING'|'ERROR'|'AVAILABLE'|'UNINSTALL_ONLY',
'SupportedComputeTypeNames': [
'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
],
'SupportedOperatingSystemNames': [
'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',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Applications (list) --
List of information about the specified applications.
(dict) --
Describes the WorkSpace application.
ApplicationId (string) --
The identifier of the application.
Created (datetime) --
The time the application is created.
Description (string) --
The description of the WorkSpace application.
LicenseType (string) --
The license availability for the applications.
Name (string) --
The name of the WorkSpace application.
Owner (string) --
The owner of the WorkSpace application.
State (string) --
The status of WorkSpace application.
SupportedComputeTypeNames (list) --
The supported compute types of the WorkSpace application.
(string) --
SupportedOperatingSystemNames (list) --
The supported operating systems of the WorkSpace application.
(string) --
NextToken (string) --
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Describes the associations between the application and the specified associated resources.
See also: AWS API Documentation
Request Syntax
client.describe_application_associations(
MaxResults=123,
NextToken='string',
ApplicationId='string',
AssociatedResourceTypes=[
'WORKSPACE'|'BUNDLE'|'IMAGE',
]
)
integer
The maximum number of associations 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
[REQUIRED]
The identifier of the specified application.
list
[REQUIRED]
The resource type of the associated resources.
(string) --
dict
Response Syntax
{
'Associations': [
{
'ApplicationId': 'string',
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'WORKSPACE'|'BUNDLE'|'IMAGE',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Associations (list) --
List of associations and information about them.
(dict) --
Describes the association between an application and an application resource.
ApplicationId (string) --
The identifier of the application.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource type of the associated resource.
Created (datetime) --
The time the association was created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the application resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
NextToken (string) --
If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
Describes the associations betweens applications and the specified WorkSpace.
See also: AWS API Documentation
Request Syntax
client.describe_workspace_associations(
WorkspaceId='string',
AssociatedResourceTypes=[
'APPLICATION',
]
)
string
[REQUIRED]
The identifier of the WorkSpace.
list
[REQUIRED]
The resource types of the associated resources.
(string) --
dict
Response Syntax
{
'Associations': [
{
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
},
'WorkspaceId': 'string'
},
]
}
Response Structure
(dict) --
Associations (list) --
List of information about the specified associations.
(dict) --
Describes the association between an application and a WorkSpace resource.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource types of the associated resource.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the WorkSpace resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
WorkspaceId (string) --
The identifier of the WorkSpace.
Associates the specified application to the specified WorkSpace.
See also: AWS API Documentation
Request Syntax
client.associate_workspace_application(
WorkspaceId='string',
ApplicationId='string'
)
string
[REQUIRED]
The identifier of the WorkSpace.
string
[REQUIRED]
The identifier of the application.
dict
Response Syntax
{
'Association': {
'AssociatedResourceId': 'string',
'AssociatedResourceType': 'APPLICATION',
'Created': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'State': 'PENDING_INSTALL'|'PENDING_INSTALL_DEPLOYMENT'|'PENDING_UNINSTALL'|'PENDING_UNINSTALL_DEPLOYMENT'|'INSTALLING'|'UNINSTALLING'|'ERROR'|'COMPLETED'|'REMOVED',
'StateReason': {
'ErrorCode': 'ValidationError.InsufficientDiskSpace'|'ValidationError.InsufficientMemory'|'ValidationError.UnsupportedOperatingSystem'|'DeploymentError.InternalServerError'|'DeploymentError.WorkspaceUnreachable',
'ErrorMessage': 'string'
},
'WorkspaceId': 'string'
}
}
Response Structure
(dict) --
Association (dict) --
Information about the association between the specified WorkSpace and the specified application.
AssociatedResourceId (string) --
The identifier of the associated resource.
AssociatedResourceType (string) --
The resource types of the associated resource.
Created (datetime) --
The time the association is created.
LastUpdatedTime (datetime) --
The time the association status was last updated.
State (string) --
The status of the WorkSpace resource association.
StateReason (dict) --
The reason the association deployment failed.
ErrorCode (string) --
The error code of the association deployment failure.
ErrorMessage (string) --
The error message of the association deployment failure.
WorkspaceId (string) --
The identifier of the WorkSpace.
{'Workspaces': {'WorkspaceProperties': {'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'}}}
Response {'FailedRequests': {'WorkspaceRequest': {'WorkspaceProperties': {'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'}}},
'PendingRequests': {'WorkspaceProperties': {'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'}}}
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
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'
},
]
},
]
}
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.
{'Workspaces': {'WorkspaceProperties': {'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'}}}
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'
},
]
},
],
'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.
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.
{'WorkspaceProperties': {'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'}}
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'
}
)
string
[REQUIRED]
The identifier of the WorkSpace.
dict
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
(dict) --