Describes a WorkSpace.
ContentsThe identifier of the bundle used to create the WorkSpace.
Type: String
Pattern: ^wsb-[0-9a-z]{8,63}$
Required: No
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
Indicates the settings of the data replication.
Type: DataReplicationSettings object
Required: No
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}$)|(wsd-[0-9a-z]{8,63}$)
Required: No
The error code that is returned if the WorkSpace cannot be created.
Type: String
Required: No
The text of the error message that is returned if the WorkSpace cannot be created.
Type: String
Required: No
The IP address of the WorkSpace.
Type: String
Required: No
The modification states of the WorkSpace.
Type: Array of ModificationState objects
Required: No
The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
Type: Array of RelatedWorkspaceProperties objects
Required: No
Indicates whether the data stored on the root volume is encrypted.
Type: Boolean
Required: No
The properties of the standby WorkSpace
Type: Array of StandbyWorkspacesProperties objects
Required: No
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 AWS.
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.
Type: String
Valid Values: PENDING | AVAILABLE | IMPAIRED | UNHEALTHY | REBOOTING | STARTING | REBUILDING | RESTORING | MAINTENANCE | ADMIN_MAINTENANCE | TERMINATING | TERMINATED | SUSPENDED | UPDATING | STOPPING | STOPPED | ERROR
Required: No
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
The user for the WorkSpace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Required: No
Indicates whether the data stored on the user volume is encrypted.
Type: Boolean
Required: No
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
The identifier of the WorkSpace.
Type: String
Pattern: ^ws-[0-9a-z]{8,63}$
Required: No
The name of the user-decoupled WorkSpace.
Type: String
Pattern: ^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$
Required: No
The properties of the WorkSpace.
Type: WorkspaceProperties object
Required: No
For more information about using this API in one of the language-specific AWS SDKs, see the following:
UserStorage
WorkspaceAccessProperties
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4