WorkSpaces Workspace

An AWS WorkSpaces Workspace is a managed, cloud-based virtual desktop that allows users to securely access applications, documents, and resources from any supported device. It provides a persistent Windows or Linux desktop experience, integrates with existing identity systems, and scales on demand. This service helps organizations reduce the complexity of managing hardware, improve security, and support remote or hybrid work environments.

aws.workspaces_workspace

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
bundle_idcorestringThe identifier of the bundle used to create the WorkSpace.
computer_namecorestringThe name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
data_replication_settingscorejsonIndicates the settings of the data replication.
directory_idcorestringThe identifier of the Directory Service directory for the WorkSpace.
error_codecorestringThe error code that is returned if the WorkSpace cannot be created.
error_messagecorestringThe text of the error message that is returned if the WorkSpace cannot be created.
ip_addresscorestringThe IP address of the WorkSpace.
modification_statescorejsonThe modification states of the WorkSpace.
related_workspacescorejsonThe standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
root_volume_encryption_enabledcoreboolIndicates whether the data stored on the root volume is encrypted.
standby_workspaces_propertiescorejsonThe properties of the standby WorkSpace
statecorestringThe 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). 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.
subnet_idcorestringThe identifier of the subnet for the WorkSpace.
tagscorehstore
user_namecorestringThe user for the WorkSpace.
user_volume_encryption_enabledcoreboolIndicates whether the data stored on the user volume is encrypted.
workspace_idcorestringThe identifier of the WorkSpace.
workspace_namecorestringThe name of the user-decoupled WorkSpace.
workspace_propertiescorejsonThe properties of the WorkSpace.