Describes the specified WorkSpaces¶

Description¶

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.

Usage¶

workspaces_describe_workspaces(WorkspaceIds, DirectoryId, UserName,
  BundleId, Limit, NextToken, WorkspaceName)

Arguments¶

WorkspaceIds

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

Because the create_workspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call describe_workspaces with this identifier, no information is returned.
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.
UserName

The name of the directory user. You must specify this parameter with DirectoryId.
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.
Limit

The maximum number of items to return.
NextToken

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

The name of the user-decoupled WorkSpace.

Value¶

A list with the following syntax:

list(
  Workspaces = list(
    list(
      WorkspaceId = "string",
      DirectoryId = "string",
      UserName = "string",
      IpAddress = "string",
      Ipv6Address = "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 = list(
        RunningMode = "AUTO_STOP"|"ALWAYS_ON"|"MANUAL",
        RunningModeAutoStopTimeoutInMinutes = 123,
        RootVolumeSizeGib = 123,
        UserVolumeSizeGib = 123,
        ComputeTypeName = "VALUE"|"STANDARD"|"PERFORMANCE"|"POWER"|"GRAPHICS"|"POWERPRO"|"GENERALPURPOSE_4XLARGE"|"GENERALPURPOSE_8XLARGE"|"GRAPHICSPRO"|"GRAPHICS_G4DN"|"GRAPHICSPRO_G4DN"|"GRAPHICS_G6_XLARGE"|"GRAPHICS_G6_2XLARGE"|"GRAPHICS_G6_4XLARGE"|"GRAPHICS_G6_8XLARGE"|"GRAPHICS_G6_16XLARGE"|"GRAPHICS_GR6_4XLARGE"|"GRAPHICS_GR6_8XLARGE"|"GRAPHICS_G6F_LARGE"|"GRAPHICS_G6F_XLARGE"|"GRAPHICS_G6F_2XLARGE"|"GRAPHICS_G6F_4XLARGE"|"GRAPHICS_GR6F_4XLARGE"|"GRAPHICS_G7_2XLARGE"|"GRAPHICS_G7_4XLARGE"|"GRAPHICS_G7_8XLARGE"|"GRAPHICS_G7_12XLARGE",
        Protocols = list(
          "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"|"WINDOWS_SERVER_2025"|"RHEL_8"|"ROCKY_8",
        GlobalAccelerator = list(
          Mode = "ENABLED_AUTO"|"DISABLED"|"INHERITED",
          PreferredProtocol = "TCP"|"NONE"|"INHERITED"
        ),
        NestedVirtualizationEnabled = TRUE|FALSE
      ),
      ModificationStates = list(
        list(
          Resource = "ROOT_VOLUME"|"USER_VOLUME"|"COMPUTE_TYPE"|"PROTOCOL"|"NESTED_VIRTUALIZATION",
          State = "UPDATE_INITIATED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"
        )
      ),
      RelatedWorkspaces = list(
        list(
          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 = list(
        DataReplication = "NO_REPLICATION"|"PRIMARY_AS_SOURCE",
        RecoverySnapshotTime = as.POSIXct(
          "2015-01-01"
        )
      ),
      StandbyWorkspacesProperties = list(
        list(
          StandbyWorkspaceId = "string",
          DataReplication = "NO_REPLICATION"|"PRIMARY_AS_SOURCE",
          RecoverySnapshotTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_workspaces(
  WorkspaceIds = list(
    "string"
  ),
  DirectoryId = "string",
  UserName = "string",
  BundleId = "string",
  Limit = 123,
  NextToken = "string",
  WorkspaceName = "string"
)