Menu
Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

Workspace

Contains information about a WorkSpace.

Contents

BundleId

The identifier of the bundle that the WorkSpace was created from.

Type: String

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

Required: No

ComputerName

The name of the WorkSpace as seen by the operating system.

Type: String

Required: No

DirectoryId

The identifier of the AWS Directory Service directory that the WorkSpace belongs to.

Type: String

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

Required: No

ErrorCode

If the WorkSpace could not be created, this contains the error code.

Type: String

Required: No

ErrorMessage

If the WorkSpace could not be created, this contains a textual error message that describes the failure.

Type: String

Required: No

IpAddress

The IP address of the WorkSpace.

Type: String

Required: No

RootVolumeEncryptionEnabled

Specifies whether the data stored on the root volume, or C: drive, is encrypted.

Type: Boolean

Required: No

State

The operational state of the WorkSpace.

Type: String

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

Required: No

SubnetId

The identifier of the subnet that the WorkSpace is in.

Type: String

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

Required: No

UserName

The user that the WorkSpace is assigned to.

Type: String

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

Required: No

UserVolumeEncryptionEnabled

Specifies whether the data stored on the user volume, or D: drive, is encrypted.

Type: Boolean

Required: No

VolumeEncryptionKey

The KMS key used to encrypt data stored on your WorkSpace.

Type: String

Required: No

WorkspaceId

The identifier of the WorkSpace.

Type: String

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

Required: No

WorkspaceProperties

Describes the properties of a WorkSpace.

Type: WorkspaceProperties object

Required: No

See Also

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

On this page: