Workspace

Describes a WorkSpace.

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

DirectoryId

The identifier of the AWS 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

State

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.

Type: String

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

WorkspaceProperties

The properties of the WorkSpace.

Type: WorkspaceProperties object

Required: No

Workspace

Contents

Note

See Also