Skip to content

Environment

Source code in docs_src/capo_workspaces_thin_client/types/environment.py
class Environment(TypedDict, closed=True):
    id: NotRequired["capo_workspaces_thin_client.types.environment_id.EnvironmentId"]
    """<p>The ID of the environment.</p>"""
    name: NotRequired[
        "capo_workspaces_thin_client.types.environment_name.EnvironmentName"
    ]
    """<p>The name of the environment.</p>"""
    desktop_arn: NotRequired["capo_workspaces_thin_client.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.</p>"""
    desktop_endpoint: NotRequired[
        "capo_workspaces_thin_client.types.desktop_endpoint.DesktopEndpoint"
    ]
    """<p>The URL for the identity provider login (only for environments that use AppStream 2.0).</p>"""
    desktop_type: NotRequired[
        "capo_workspaces_thin_client.types.desktop_type.DesktopType"
    ]
    """<p>The type of streaming desktop for the environment.</p>"""
    activation_code: NotRequired[
        "capo_workspaces_thin_client.types.activation_code.ActivationCode"
    ]
    """<p>The activation code to register a device to the environment.</p>"""
    registered_devices_count: NotRequired["int"]
    """<p>The number of devices registered to the environment.</p>"""
    software_set_update_schedule: NotRequired[
        "capo_workspaces_thin_client.types.software_set_update_schedule.SoftwareSetUpdateSchedule"
    ]
    """<p>An option to define if software updates should be applied within a maintenance window.</p>"""
    maintenance_window: NotRequired[
        "capo_workspaces_thin_client.types.maintenance_window.MaintenanceWindow"
    ]
    """<p>A specification for a time window to apply software updates.</p>"""
    software_set_update_mode: NotRequired[
        "capo_workspaces_thin_client.types.software_set_update_mode.SoftwareSetUpdateMode"
    ]
    """<p>An option to define which software updates to apply.</p>"""
    desired_software_set_id: NotRequired[
        "capo_workspaces_thin_client.types.software_set_id.SoftwareSetId"
    ]
    """<p>The ID of the software set to apply.</p>"""
    pending_software_set_id: NotRequired[
        "capo_workspaces_thin_client.types.software_set_id.SoftwareSetId"
    ]
    """<p>The ID of the software set that is pending to be installed.</p>"""
    pending_software_set_version: NotRequired["str"]
    """<p>The version of the software set that is pending to be installed.</p>"""
    software_set_compliance_status: NotRequired[
        "capo_workspaces_thin_client.types.environment_software_set_compliance_status.EnvironmentSoftwareSetComplianceStatus"
    ]
    """<p>Describes if the software currently installed on all devices in the environment is a supported version.</p>"""
    created_at: NotRequired["capo_workspaces_thin_client.types.timestamp.Timestamp"]
    """<p>The timestamp of when the environment was created.</p>"""
    updated_at: NotRequired["capo_workspaces_thin_client.types.timestamp.Timestamp"]
    """<p>The timestamp of when the device was updated.</p>"""
    arn: NotRequired["capo_workspaces_thin_client.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the environment.</p>"""
    kms_key_arn: NotRequired["capo_workspaces_thin_client.types.kms_key_arn.KmsKeyArn"]
    """<p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.</p>"""
    device_creation_tags: NotRequired[
        "capo_workspaces_thin_client.types.device_creation_tags_map.DeviceCreationTagsMap"
    ]
    """<p>The tag keys and optional values for the newly created devices for this environment.</p>"""

activation_code instance-attribute

activation_code: NotRequired[ActivationCode]

The activation code to register a device to the environment.

arn instance-attribute

arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the environment.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The timestamp of when the environment was created.

desired_software_set_id instance-attribute

desired_software_set_id: NotRequired[SoftwareSetId]

The ID of the software set to apply.

desktop_arn instance-attribute

desktop_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

desktop_endpoint instance-attribute

desktop_endpoint: NotRequired[DesktopEndpoint]

The URL for the identity provider login (only for environments that use AppStream 2.0).

desktop_type instance-attribute

desktop_type: NotRequired[DesktopType]

The type of streaming desktop for the environment.

device_creation_tags instance-attribute

device_creation_tags: NotRequired[DeviceCreationTagsMap]

The tag keys and optional values for the newly created devices for this environment.

id instance-attribute

id: NotRequired[EnvironmentId]

The ID of the environment.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the environment.

maintenance_window instance-attribute

maintenance_window: NotRequired[MaintenanceWindow]

A specification for a time window to apply software updates.

name instance-attribute

name: NotRequired[EnvironmentName]

The name of the environment.

pending_software_set_id instance-attribute

pending_software_set_id: NotRequired[SoftwareSetId]

The ID of the software set that is pending to be installed.

pending_software_set_version instance-attribute

pending_software_set_version: NotRequired[str]

The version of the software set that is pending to be installed.

registered_devices_count instance-attribute

registered_devices_count: NotRequired[int]

The number of devices registered to the environment.

software_set_compliance_status instance-attribute

software_set_compliance_status: NotRequired[EnvironmentSoftwareSetComplianceStatus]

Describes if the software currently installed on all devices in the environment is a supported version.

software_set_update_mode instance-attribute

software_set_update_mode: NotRequired[SoftwareSetUpdateMode]

An option to define which software updates to apply.

software_set_update_schedule instance-attribute

software_set_update_schedule: NotRequired[SoftwareSetUpdateSchedule]

An option to define if software updates should be applied within a maintenance window.

updated_at instance-attribute

updated_at: NotRequired[Timestamp]

The timestamp of when the device was updated.