Workspace - Amazon WorkSpaces Service
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Workspace

Describes a WorkSpace.

Contents

BundleId

The identifier of the bundle used to create the WorkSpace.

Type: String

Pattern: ^wsb-[0-9a-z]{8,63}$

Required: No

ComputerName

The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

Type: String

Required: No

DataReplicationSettings

Indicates the settings of the data replication.

Type: DataReplicationSettings object

Required: No

DirectoryId

The identifier of the Amazon Directory Service directory for the WorkSpace.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: No

ErrorCode

The error code that is returned if the WorkSpace cannot be created.

Type: String

Required: No

ErrorMessage

The text of the error message that is returned if the WorkSpace cannot be created.

Type: String

Required: No

IpAddress

The IP address of the WorkSpace.

Type: String

Required: No

ModificationStates

The modification states of the WorkSpace.

Type: Array of ModificationState objects

Required: No

RelatedWorkspaces

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

Type: Array of RelatedWorkspaceProperties objects

Required: No

RootVolumeEncryptionEnabled

Indicates whether the data stored on the root volume is encrypted.

Type: Boolean

Required: No

StandbyWorkspacesProperties

The properties of the standby WorkSpace

Type: Array of StandbyWorkspacesProperties objects

Required: No

State

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.

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

Type: String

Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR

Required: No

SubnetId

The identifier of the subnet for the WorkSpace.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

UserName

The user for the WorkSpace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

UserVolumeEncryptionEnabled

Indicates whether the data stored on the user volume is encrypted.

Type: Boolean

Required: No

VolumeEncryptionKey

The ARN of the symmetric Amazon KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

Type: String

Required: No

WorkspaceId

The identifier of the WorkSpace.

Type: String

Pattern: ^ws-[0-9a-z]{8,63}$

Required: No

WorkspaceName

The name of the user-decoupled WorkSpace.

Type: String

Pattern: ^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$

Required: No

WorkspaceProperties

The properties of the WorkSpace.

Type: WorkspaceProperties object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: