Workspace ¶

class Workspace(TypedDict, closed=True):
    workspace_id: NotRequired["capo_workspaces.types.workspace_id.WorkspaceId"]
    """<p>The identifier of the WorkSpace.</p>"""
    directory_id: NotRequired["capo_workspaces.types.directory_id.DirectoryId"]
    """<p>The identifier of the Directory Service directory for the WorkSpace.</p>"""
    user_name: NotRequired["capo_workspaces.types.user_name.UserName"]
    """<p>The user for the WorkSpace.</p>"""
    ip_address: NotRequired["capo_workspaces.types.ip_address.IpAddress"]
    """<p>The IP address of the WorkSpace.</p>"""
    ipv6_address: NotRequired["capo_workspaces.types.ipv6_address.Ipv6Address"]
    """<p>The IPv6 address of the WorkSpace.</p>"""
    state: NotRequired["capo_workspaces.types.workspace_state.WorkspaceState"]
    """<p>The operational state of the WorkSpace.</p> <ul> <li> <p> <code>PENDING</code> – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).</p> </li> <li> <p> <code>AVAILABLE</code> – The WorkSpace is running and has passed the health checks.</p> </li> <li> <p> <code>IMPAIRED</code> – Refer to <code>UNHEALTHY</code> state.</p> </li> <li> <p> <code>UNHEALTHY</code> – The WorkSpace is not responding to health checks.</p> </li> <li> <p> <code>REBOOTING</code> – The WorkSpace is being rebooted (restarted).</p> </li> <li> <p> <code>STARTING</code> – The WorkSpace is starting up and health checks are being run.</p> </li> <li> <p> <code>REBUILDING</code> – The WorkSpace is being rebuilt.</p> </li> <li> <p> <code>RESTORING</code> – The WorkSpace is being restored.</p> </li> <li> <p> <code>MAINTENANCE</code> – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.</p> </li> <li> <p> <code>ADMIN_MAINTENANCE</code> – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.</p> </li> <li> <p> <code>TERMINATING</code> – The WorkSpace is being deleted.</p> </li> <li> <p> <code>TERMINATED</code> – The WorkSpace has been deleted.</p> </li> <li> <p> <code>SUSPENDED</code> – The WorkSpace has been suspended for image creation.</p> </li> <li> <p> <code>UPDATING</code> – The WorkSpace is undergoing an update.</p> </li> <li> <p> <code>STOPPING</code> – The WorkSpace is being stopped.</p> </li> <li> <p> <code>STOPPED</code> – The WorkSpace has been stopped.</p> </li> <li> <p> <code>ERROR </code> – The WorkSpace is an error state (for example, an error occurred during startup).</p> </li> </ul> <note> <p>After a WorkSpace is terminated, the <code>TERMINATED</code> 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 <a href="https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html"> DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.</p> </note>"""
    bundle_id: NotRequired["capo_workspaces.types.bundle_id.BundleId"]
    """<p>The identifier of the bundle used to create the WorkSpace.</p>"""
    subnet_id: NotRequired["capo_workspaces.types.subnet_id.SubnetId"]
    """<p>The identifier of the subnet for the WorkSpace.</p>"""
    error_message: NotRequired["capo_workspaces.types.description.Description"]
    """<p>The text of the error message that is returned if the WorkSpace cannot be created.</p>"""
    error_code: NotRequired[
        "capo_workspaces.types.workspace_error_code.WorkspaceErrorCode"
    ]
    """<p>The error code that is returned if the WorkSpace cannot be created.</p>"""
    computer_name: NotRequired["capo_workspaces.types.computer_name.ComputerName"]
    """<p>The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see <a href="https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html"> Launch a WorkSpace</a>. </p>"""
    volume_encryption_key: NotRequired[
        "capo_workspaces.types.volume_encryption_key.VolumeEncryptionKey"
    ]
    """<p>The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.</p>"""
    user_volume_encryption_enabled: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether the data stored on the user volume is encrypted.</p>"""
    root_volume_encryption_enabled: NotRequired[
        "capo_workspaces.types.boolean_object.BooleanObject"
    ]
    """<p>Indicates whether the data stored on the root volume is encrypted.</p>"""
    workspace_name: NotRequired["capo_workspaces.types.workspace_name.WorkspaceName"]
    """<p>The name of the user-decoupled WorkSpace.</p>"""
    workspace_properties: NotRequired[
        "capo_workspaces.types.workspace_properties.WorkspaceProperties"
    ]
    """<p>The properties of the WorkSpace.</p>"""
    modification_states: NotRequired[
        "capo_workspaces.types.modification_state_list.ModificationStateList"
    ]
    """<p>The modification states of the WorkSpace.</p>"""
    related_workspaces: NotRequired[
        "capo_workspaces.types.related_workspaces.RelatedWorkspaces"
    ]
    """<p>The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.</p>"""
    data_replication_settings: NotRequired[
        "capo_workspaces.types.data_replication_settings.DataReplicationSettings"
    ]
    """<p>Indicates the settings of the data replication.</p>"""
    standby_workspaces_properties: NotRequired[
        "capo_workspaces.types.standby_workspaces_properties_list.StandbyWorkspacesPropertiesList"
    ]
    """<p>The properties of the standby WorkSpace</p>"""