AWS API Changes

2022/11/17 - Amazon WorkSpaces - 1 new 4 updated api methods

Changes The release introduces CreateStandbyWorkspaces, an API that allows you to create standby WorkSpaces associated with a primary WorkSpace in another Region. DescribeWorkspaces now includes related WorkSpaces properties. DescribeWorkspaceBundles and CreateWorkspaceBundle now return more bundle details.

CreateStandbyWorkspaces (new)

Link ¶

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'
                },
            ]
        },
    ]
)

type PrimaryRegion

string

param PrimaryRegion

[REQUIRED]

The Region of the primary WorkSpace.

type StandbyWorkspaces

list

param StandbyWorkspaces

[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.

rtype

dict

returns

Response Syntax

{
    'FailedStandbyRequests': [
        {
            'StandbyWorkspaceRequest': {
                'PrimaryWorkspaceId': 'string',
                'VolumeEncryptionKey': 'string',
                'DirectoryId': 'string',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'PendingStandbyRequests': [
        {
            'UserName': 'string',
            'DirectoryId': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'WorkspaceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- FailedStandbyRequests (list) --
  
  Information about the Standby WorkSpace that could not be created.
  - (dict) --
    
    Describes the Standby WorkSpace that could not be created.
    - StandbyWorkspaceRequest (dict) --
      
      Information about the Standby WorkSpace that could not be created.
      - PrimaryWorkspaceId (string) --
        
        The identifier of the Standby WorkSpace.
      - VolumeEncryptionKey (string) --
        
        The volume encryption key of the Standby WorkSpace.
      - DirectoryId (string) --
        
        The identifier of the directory for the Standby WorkSpace.
      - Tags (list) --
        
        The tags associated with the Standby WorkSpace.
        
        (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The key of the tag.
        
        Value (string) --
        
        The value of the tag.
    - ErrorCode (string) --
      
      The error code that is returned if the Standby WorkSpace could not be created.
    - ErrorMessage (string) --
      
      The text of the error message that is returned if the Standby WorkSpace could not be created.
- PendingStandbyRequests (list) --
  
  Information about the Standby WorkSpace that was created.
  - (dict) --
    
    Information about the Standby WorkSpace.
    - UserName (string) --
      
      Describes the Standby WorkSpace that was created.
      
      Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
    - DirectoryId (string) --
      
      The identifier of the directory for the Standby WorkSpace.
    - State (string) --
      
      The operational state of the Standby WorkSpace.
    - WorkspaceId (string) --
      
      The identifier of the Standby WorkSpace.

CreateWorkspaceBundle (updated)

Link ¶
Changes (response)

{'WorkspaceBundle': {'BundleType': 'REGULAR | STANDBY',
                     'State': 'AVAILABLE | PENDING | ERROR'}}

Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle .

See also: AWS API Documentation

Request Syntax

client.create_workspace_bundle(
    BundleName='string',
    BundleDescription='string',
    ImageId='string',
    ComputeType={
        'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
    },
    UserStorage={
        'Capacity': 'string'
    },
    RootStorage={
        'Capacity': 'string'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type BundleName

string

param BundleName

[REQUIRED]

The name of the bundle.

type BundleDescription

string

param BundleDescription

[REQUIRED]

The description of the bundle.

type ImageId

string

param ImageId

[REQUIRED]

The identifier of the image that is used to create the bundle.

type ComputeType

dict

param ComputeType

[REQUIRED]

Describes the compute type of the bundle.

Name (string) --

The compute type.

type UserStorage

dict

param UserStorage

[REQUIRED]

Describes the user volume for a WorkSpace bundle.

Capacity (string) --

The size of the user volume.

type RootStorage

dict

param RootStorage

Describes the root volume for a WorkSpace bundle.

Capacity (string) --

The size of the root volume.

type Tags

list

param Tags

The tags associated with the bundle.

Note

To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags .

(dict) --

Describes a tag.
- Key (string) -- [REQUIRED]
  
  The key of the tag.
- Value (string) --
  
  The value of the tag.

rtype

dict

returns

Response Syntax

{
    'WorkspaceBundle': {
        'BundleId': 'string',
        'Name': 'string',
        'Owner': 'string',
        'Description': 'string',
        'ImageId': 'string',
        'RootStorage': {
            'Capacity': 'string'
        },
        'UserStorage': {
            'Capacity': 'string'
        },
        'ComputeType': {
            'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
        },
        'LastUpdatedTime': datetime(2015, 1, 1),
        'CreationTime': datetime(2015, 1, 1),
        'State': 'AVAILABLE'|'PENDING'|'ERROR',
        'BundleType': 'REGULAR'|'STANDBY'
    }
}

Response Structure

(dict) --
- WorkspaceBundle (dict) --
  
  Describes a WorkSpace bundle.
  - BundleId (string) --
    
    The identifier of the bundle.
  - Name (string) --
    
    The name of the bundle.
  - Owner (string) --
    
    The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
  - Description (string) --
    
    The description of the bundle.
  - ImageId (string) --
    
    The identifier of the image that was used to create the bundle.
  - RootStorage (dict) --
    
    The size of the root volume.
    - Capacity (string) --
      
      The size of the root volume.
  - UserStorage (dict) --
    
    The size of the user volume.
    - Capacity (string) --
      
      The size of the user volume.
  - ComputeType (dict) --
    
    The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles .
    - Name (string) --
      
      The compute type.
  - LastUpdatedTime (datetime) --
    
    The last time that the bundle was updated.
  - CreationTime (datetime) --
    
    The time when the bundle was created.
  - State (string) --
    
    The state of the WorkSpace bundle.
  - BundleType (string) --
    
    The type of WorkSpace bundle.

CreateWorkspaces (updated)

Link ¶
Changes (response)

{'PendingRequests': {'RelatedWorkspaces': [{'Region': 'string',
                                            'State': 'PENDING | AVAILABLE | '
                                                     'IMPAIRED | UNHEALTHY | '
                                                     'REBOOTING | STARTING | '
                                                     'REBUILDING | RESTORING | '
                                                     'MAINTENANCE | '
                                                     'ADMIN_MAINTENANCE | '
                                                     'TERMINATING | TERMINATED '
                                                     '| SUSPENDED | UPDATING | '
                                                     'STOPPING | STOPPED | '
                                                     'ERROR',
                                            'Type': 'PRIMARY | STANDBY',
                                            'WorkspaceId': '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 .

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',
                ]
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type Workspaces

list

param Workspaces

[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 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) --
- 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.

rtype

dict

returns

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',
                    ]
                },
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'PendingRequests': [
        {
            'WorkspaceId': 'string',
            'DirectoryId': 'string',
            'UserName': 'string',
            'IpAddress': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'BundleId': 'string',
            'SubnetId': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'ComputerName': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
                'Protocols': [
                    'PCOIP'|'WSP',
                ]
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ],
            'RelatedWorkspaces': [
                {
                    'WorkspaceId': 'string',
                    'Region': 'string',
                    'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
                    'Type': 'PRIMARY'|'STANDBY'
                },
            ]
        },
    ]
}

Response Structure

(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 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) --
      - 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 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) --
    - 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.

DescribeWorkspaceBundles (updated)

Link ¶
Changes (response)

{'Bundles': {'BundleType': 'REGULAR | STANDBY',
             'State': 'AVAILABLE | PENDING | ERROR'}}

Retrieves a list that describes the available WorkSpace bundles.

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

See also: AWS API Documentation

Request Syntax

client.describe_workspace_bundles(
    BundleIds=[
        'string',
    ],
    Owner='string',
    NextToken='string'
)

type BundleIds

list

param BundleIds

The identifiers of the bundles. You cannot combine this parameter with any other filter.

(string) --

type Owner

string

param Owner

The owner of the bundles. You cannot combine this parameter with any other filter.

To describe the bundles provided by Amazon Web Services, specify AMAZON . To describe the bundles that belong to your account, don't specify a value.

type NextToken

string

param NextToken

The token for the next set of results. (You received this token from a previous call.)

rtype

dict

returns

Response Syntax

{
    'Bundles': [
        {
            'BundleId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'Description': 'string',
            'ImageId': 'string',
            'RootStorage': {
                'Capacity': 'string'
            },
            'UserStorage': {
                'Capacity': 'string'
            },
            'ComputeType': {
                'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN'
            },
            'LastUpdatedTime': datetime(2015, 1, 1),
            'CreationTime': datetime(2015, 1, 1),
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'BundleType': 'REGULAR'|'STANDBY'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Bundles (list) --
  
  Information about the bundles.
  - (dict) --
    
    Describes a WorkSpace bundle.
    - BundleId (string) --
      
      The identifier of the bundle.
    - Name (string) --
      
      The name of the bundle.
    - Owner (string) --
      
      The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
    - Description (string) --
      
      The description of the bundle.
    - ImageId (string) --
      
      The identifier of the image that was used to create the bundle.
    - RootStorage (dict) --
      
      The size of the root volume.
      - Capacity (string) --
        
        The size of the root volume.
    - UserStorage (dict) --
      
      The size of the user volume.
      - Capacity (string) --
        
        The size of the user volume.
    - ComputeType (dict) --
      
      The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles .
      - Name (string) --
        
        The compute type.
    - LastUpdatedTime (datetime) --
      
      The last time that the bundle was updated.
    - CreationTime (datetime) --
      
      The time when the bundle was created.
    - State (string) --
      
      The state of the WorkSpace bundle.
    - BundleType (string) --
      
      The type of WorkSpace bundle.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.

DescribeWorkspaces (updated)

Link ¶
Changes (response)

{'Workspaces': {'RelatedWorkspaces': [{'Region': 'string',
                                       'State': 'PENDING | AVAILABLE | '
                                                'IMPAIRED | UNHEALTHY | '
                                                'REBOOTING | STARTING | '
                                                'REBUILDING | RESTORING | '
                                                'MAINTENANCE | '
                                                'ADMIN_MAINTENANCE | '
                                                'TERMINATING | TERMINATED | '
                                                'SUSPENDED | UPDATING | '
                                                'STOPPING | STOPPED | ERROR',
                                       'Type': 'PRIMARY | STANDBY',
                                       'WorkspaceId': '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'
)

type WorkspaceIds

list

param WorkspaceIds

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) --

type DirectoryId

string

param DirectoryId

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.

type UserName

string

param UserName

The name of the directory user. You must specify this parameter with DirectoryId .

type BundleId

string

param BundleId

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

type Limit

integer

param Limit

The maximum number of items to return.

type NextToken

string

param NextToken

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

rtype

dict

returns

Response Syntax

{
    'Workspaces': [
        {
            'WorkspaceId': 'string',
            'DirectoryId': 'string',
            'UserName': 'string',
            'IpAddress': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'BundleId': 'string',
            'SubnetId': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'ComputerName': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
                'Protocols': [
                    'PCOIP'|'WSP',
                ]
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ],
            'RelatedWorkspaces': [
                {
                    'WorkspaceId': 'string',
                    'Region': 'string',
                    'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
                    'Type': 'PRIMARY'|'STANDBY'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- Workspaces (list) --
  
  Information about the WorkSpaces.
  
  Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
  - (dict) --
    
    Describes a WorkSpace.
    - WorkspaceId (string) --
      
      The identifier of the WorkSpace.
    - DirectoryId (string) --
      
      The identifier of the Directory Service directory for the WorkSpace.
    - UserName (string) --
      
      The user for the WorkSpace.
    - IpAddress (string) --
      
      The IP address of the WorkSpace.
    - State (string) --
      
      The operational state of the WorkSpace.
      
      Note
      
      After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces . If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
    - BundleId (string) --
      
      The identifier of the bundle used to create the WorkSpace.
    - SubnetId (string) --
      
      The identifier of the subnet for the WorkSpace.
    - ErrorMessage (string) --
      
      The text of the error message that is returned if the WorkSpace cannot be created.
    - ErrorCode (string) --
      
      The error code that is returned if the WorkSpace cannot be created.
    - ComputerName (string) --
      
      The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace .
    - VolumeEncryptionKey (string) --
      
      The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
    - UserVolumeEncryptionEnabled (boolean) --
      
      Indicates whether the data stored on the user volume is encrypted.
    - RootVolumeEncryptionEnabled (boolean) --
      
      Indicates whether the data stored on the root volume is encrypted.
    - WorkspaceProperties (dict) --
      
      The properties of the WorkSpace.
      - RunningMode (string) --
        
        The running mode. For more information, see Manage the WorkSpace Running Mode .
        
        Note
        
        The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core .
      - RunningModeAutoStopTimeoutInMinutes (integer) --
        
        The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.
      - RootVolumeSizeGib (integer) --
        
        The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
      - UserVolumeSizeGib (integer) --
        
        The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace .
      - ComputeTypeName (string) --
        
        The compute type. For more information, see Amazon WorkSpaces Bundles .
      - Protocols (list) --
        
        The protocol. For more information, see Protocols for Amazon WorkSpaces .
        
        Note
        
        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) --
    - 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.