Workspace class

Describes a WorkSpace.

  • @JsonSerializable(includeIfNull: false, explicitToJson: true, createFactory: true, createToJson: false)


Workspace({String bundleId, String computerName, String directoryId, String errorCode, String errorMessage, String ipAddress, List<ModificationState> modificationStates, bool rootVolumeEncryptionEnabled, WorkspaceState state, String subnetId, String userName, bool userVolumeEncryptionEnabled, String volumeEncryptionKey, String workspaceId, WorkspaceProperties workspaceProperties})
Workspace.fromJson(Map<String, dynamic> json)


bundleId String
The identifier of the bundle used to create the WorkSpace.
@JsonKey(name: 'BundleId'), final
computerName String
The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
@JsonKey(name: 'ComputerName'), final
directoryId String
The identifier of the AWS Directory Service directory for the WorkSpace.
@JsonKey(name: 'DirectoryId'), final
errorCode String
The error code that is returned if the WorkSpace cannot be created.
@JsonKey(name: 'ErrorCode'), final
errorMessage String
The text of the error message that is returned if the WorkSpace cannot be created.
@JsonKey(name: 'ErrorMessage'), final
hashCode int
The hash code for this object. [...]
read-only, inherited
ipAddress String
The IP address of the WorkSpace.
@JsonKey(name: 'IpAddress'), final
modificationStates List<ModificationState>
The modification states of the WorkSpace.
@JsonKey(name: 'ModificationStates'), final
rootVolumeEncryptionEnabled bool
Indicates whether the data stored on the root volume is encrypted.
@JsonKey(name: 'RootVolumeEncryptionEnabled'), final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
state WorkspaceState
The operational state of the WorkSpace. 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.
@JsonKey(name: 'State'), final
subnetId String
The identifier of the subnet for the WorkSpace.
@JsonKey(name: 'SubnetId'), final
userName String
The user for the WorkSpace.
@JsonKey(name: 'UserName'), final
userVolumeEncryptionEnabled bool
Indicates whether the data stored on the user volume is encrypted.
@JsonKey(name: 'UserVolumeEncryptionEnabled'), final
volumeEncryptionKey String
The symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs.
@JsonKey(name: 'VolumeEncryptionKey'), final
workspaceId String
The identifier of the WorkSpace.
@JsonKey(name: 'WorkspaceId'), final
workspaceProperties WorkspaceProperties
The properties of the WorkSpace.
@JsonKey(name: 'WorkspaceProperties'), final


noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
toString() String
A string representation of this object. [...]


operator ==(Object other) bool
The equality operator. [...]