Skip to content

CreateEnvironmentRequest

Source code in docs_src/capo_workspaces_thin_client/types/create_environment_request.py
class CreateEnvironmentRequest(TypedDict, closed=True):
    name: NotRequired[
        "capo_workspaces_thin_client.types.environment_name.EnvironmentName"
    ]
    """<p>The name for the environment.</p>"""
    desktop_arn: "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>"""
    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>"""
    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 to use to encrypt the environment.</p>"""
    client_token: NotRequired[
        "capo_workspaces_thin_client.types.client_token.ClientToken"
    ]
    """<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotentParameterMismatch</code> error.</p>"""
    tags: NotRequired["capo_workspaces_thin_client.types.tags_map.TagsMap"]
    """<p>A map of the key-value pairs of the tag or tags to assign to the resource.</p>"""
    device_creation_tags: NotRequired[
        "capo_workspaces_thin_client.types.device_creation_tags_map.DeviceCreationTagsMap"
    ]
    """<p>A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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: 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).

device_creation_tags instance-attribute

device_creation_tags: NotRequired[DeviceCreationTagsMap]

A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

kms_key_arn instance-attribute

kms_key_arn: NotRequired[KmsKeyArn]

The Amazon Resource Name (ARN) of the Key Management Service key to use 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 for the environment.

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.

tags instance-attribute

tags: NotRequired[TagsMap]

A map of the key-value pairs of the tag or tags to assign to the resource.