WorkSpaces / Paginator / DescribeWorkspaces

DescribeWorkspaces

class WorkSpaces.Paginator.DescribeWorkspaces

paginator = client.get_paginator('describe_workspaces')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspaces().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WorkspaceIds=[
        'string',
    ],
    DirectoryId='string',
    UserName='string',
    BundleId='string',
    WorkspaceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• WorkspaceIds (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) –

• DirectoryId (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.

• UserName (string) – The name of the directory user. You must specify this parameter with DirectoryId.

• BundleId (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.

• WorkspaceName (string) – The name of the user-decoupled WorkSpace.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

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,
            'WorkspaceName': 'string',
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
                'Protocols': [
                    'PCOIP'|'WSP',
                ],
                'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'|'RHEL_8'|'ROCKY_8',
                'GlobalAccelerator': {
                    'Mode': 'ENABLED_AUTO'|'DISABLED'|'INHERITED',
                    'PreferredProtocol': 'TCP'|'NONE'|'INHERITED'
                }
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ],
            'RelatedWorkspaces': [
                {
                    'WorkspaceId': 'string',
                    'Region': 'string',
                    'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'RESTORING'|'MAINTENANCE'|'ADMIN_MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
                    'Type': 'PRIMARY'|'STANDBY'
                },
            ],
            'DataReplicationSettings': {
                'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
                'RecoverySnapshotTime': datetime(2015, 1, 1)
            },
            'StandbyWorkspacesProperties': [
                {
                    'StandbyWorkspaceId': 'string',
                    'DataReplication': 'NO_REPLICATION'|'PRIMARY_AS_SOURCE',
                    'RecoverySnapshotTime': datetime(2015, 1, 1)
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Workspaces (list) –

    Information about the WorkSpaces.

    Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

    • (dict) –

      Describes a WorkSpace.

      • WorkspaceId (string) –

        The identifier of the WorkSpace.

      • DirectoryId (string) –

        The identifier of the Directory Service directory for the WorkSpace.

      • UserName (string) –

        The user for the WorkSpace.

      • IpAddress (string) –

        The IP address of the WorkSpace.

      • State (string) –

        The operational state of the WorkSpace.

        • PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).

        • AVAILABLE – The WorkSpace is running and has passed the health checks.

        • IMPAIRED – Refer to UNHEALTHY state.

        • UNHEALTHY – The WorkSpace is not responding to health checks.

        • REBOOTING – The WorkSpace is being rebooted (restarted).

        • STARTING – The WorkSpace is starting up and health checks are being run.

        • REBUILDING – The WorkSpace is being rebuilt.

        • RESTORING – The WorkSpace is being restored.

        • MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.

        • ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.

        • TERMINATING – The WorkSpace is being deleted.

        • TERMINATED – The WorkSpace has been deleted.

        • SUSPENDED – The WorkSpace has been suspended for image creation.

        • UPDATING – The WorkSpace is undergoing an update.

        • STOPPING – The WorkSpace is being stopped.

        • STOPPED – The WorkSpace has been stopped.

        • ERROR – The WorkSpace is an error state (for example, an error occurred during startup).

        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.

      • WorkspaceName (string) –

        The name of the user-decoupled WorkSpace.

      • WorkspaceProperties (dict) –

        The properties of the WorkSpace.

        • RunningMode (string) –

          The running mode. For more information, see Manage the WorkSpace Running Mode.

          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.

          Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

        • RunningModeAutoStopTimeoutInMinutes (integer) –

          The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

        • RootVolumeSizeGib (integer) –

          The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

        • UserVolumeSizeGib (integer) –

          The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

        • ComputeTypeName (string) –

          The compute type. For more information, see Amazon WorkSpaces Bundles.

        • Protocols (list) –

          The protocol. For more information, see Protocols for Amazon WorkSpaces.

          Note

          • Only available for WorkSpaces created with PCoIP bundles.

          • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly 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.

        • GlobalAccelerator (dict) –

          Indicates the Global Accelerator properties.

          • Mode (string) –

            Indicates if Global Accelerator for WorkSpaces is enabled, disabled, or the same mode as the associated directory.

          • PreferredProtocol (string) –

            Indicates the preferred protocol for Global Accelerator.

      • ModificationStates (list) –

        The modification states of the WorkSpace.

        • (dict) –

          Describes a WorkSpace modification.

          • Resource (string) –

            The resource.

          • State (string) –

            The modification state.

      • RelatedWorkspaces (list) –

        The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

        • (dict) –

          Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

          • WorkspaceId (string) –

            The identifier of the related WorkSpace.

          • Region (string) –

            The Region of the related WorkSpace.

          • State (string) –

            Indicates the state of the WorkSpace.

          • Type (string) –

            Indicates the type of WorkSpace.

      • DataReplicationSettings (dict) –

        Indicates the settings of the data replication.

        • DataReplication (string) –

          Indicates whether data replication is enabled, and if enabled, the type of data replication.

        • RecoverySnapshotTime (datetime) –

          The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.

      • StandbyWorkspacesProperties (list) –

        The properties of the standby WorkSpace

        • (dict) –

          Describes the properties of the related standby WorkSpaces.

          • StandbyWorkspaceId (string) –

            The identifier of the standby WorkSpace

          • DataReplication (string) –

            Indicates whether data replication is enabled, and if enabled, the type of data replication.

          • RecoverySnapshotTime (datetime) –

            The date and time at which the last successful snapshot was taken of the primary WorkSpace used for replicating data.