Workspace

Gets and sets the property BundleId.

The identifier of the bundle used to create the WorkSpace.

Gets and sets the property 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.

Gets and sets the property DataReplicationSettings.

Indicates the settings of the data replication.

Gets and sets the property DirectoryId.

The identifier of the Directory Service directory for the WorkSpace.

Gets and sets the property ErrorCode.

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

Gets and sets the property ErrorMessage.

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

Gets and sets the property IpAddress.

The IP address of the WorkSpace.

Gets and sets the property ModificationStates.

The modification states of the WorkSpace.

Gets and sets the property RelatedWorkspaces.

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

Gets and sets the property RootVolumeEncryptionEnabled.

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

Gets and sets the property StandbyWorkspacesProperties.

The properties of the standby WorkSpace

Gets and sets the property 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 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).

Gets and sets the property SubnetId.

The identifier of the subnet for the WorkSpace.

Gets and sets the property UserName.

The user for the WorkSpace.

Gets and sets the property UserVolumeEncryptionEnabled.

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

Gets and sets the property VolumeEncryptionKey.

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

Gets and sets the property WorkspaceId.

The identifier of the WorkSpace.

Gets and sets the property WorkspaceName.

The name of the user-decoupled WorkSpace.

Gets and sets the property WorkspaceProperties.

The properties of the WorkSpace.