Skip to content

CreateUserSettingsRequest

Source code in docs_src/capo_workspaces_web/types/create_user_settings_request.py
class CreateUserSettingsRequest(TypedDict, closed=True):
    copy_allowed: "capo_workspaces_web.types.enabled_type.EnabledType"
    """<p>Specifies whether the user can copy text from the streaming session to the local device.</p>"""
    paste_allowed: "capo_workspaces_web.types.enabled_type.EnabledType"
    """<p>Specifies whether the user can paste text from the local device to the streaming session.</p>"""
    download_allowed: "capo_workspaces_web.types.enabled_type.EnabledType"
    """<p>Specifies whether the user can download files from the streaming session to the local device.</p>"""
    upload_allowed: "capo_workspaces_web.types.enabled_type.EnabledType"
    """<p>Specifies whether the user can upload files from the local device to the streaming session.</p>"""
    print_allowed: "capo_workspaces_web.types.enabled_type.EnabledType"
    """<p>Specifies whether the user can print to the local device.</p>"""
    tags: NotRequired["capo_workspaces_web.types.tag_list.TagList"]
    """<p>The tags to add to the user settings resource. A tag is a key-value pair.</p>"""
    disconnect_timeout_in_minutes: NotRequired[
        "capo_workspaces_web.types.disconnect_timeout_in_minutes.DisconnectTimeoutInMinutes"
    ]
    """<p>The amount of time that a streaming session remains active after users disconnect.</p>"""
    idle_disconnect_timeout_in_minutes: NotRequired[
        "capo_workspaces_web.types.idle_disconnect_timeout_in_minutes.IdleDisconnectTimeoutInMinutes"
    ]
    """<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.</p>"""
    client_token: NotRequired["capo_workspaces_web.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. </p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p>"""
    cookie_synchronization_configuration: NotRequired[
        "capo_workspaces_web.types.cookie_synchronization_configuration.CookieSynchronizationConfiguration"
    ]
    """<p>The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.</p>"""
    customer_managed_key: NotRequired["capo_workspaces_web.types.key_arn.keyArn"]
    """<p>The customer managed key used to encrypt sensitive information in the user settings.</p>"""
    additional_encryption_context: NotRequired[
        "capo_workspaces_web.types.encryption_context_map.EncryptionContextMap"
    ]
    """<p>The additional encryption context of the user settings.</p>"""
    deep_link_allowed: NotRequired["capo_workspaces_web.types.enabled_type.EnabledType"]
    """<p>Specifies whether the user can use deep links that open automatically when connecting to a session.</p>"""
    toolbar_configuration: NotRequired[
        "capo_workspaces_web.types.toolbar_configuration.ToolbarConfiguration"
    ]
    """<p>The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.</p>"""
    branding_configuration_input: NotRequired[
        "capo_workspaces_web.types.branding_configuration_create_input.BrandingConfigurationCreateInput"
    ]
    """<p>The branding configuration input that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, localized strings, color theme, and optionally a wallpaper and terms of service.</p>"""
    web_authn_allowed: NotRequired["capo_workspaces_web.types.enabled_type.EnabledType"]
    """<p>Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.</p>"""

additional_encryption_context instance-attribute

additional_encryption_context: NotRequired[EncryptionContextMap]

The additional encryption context of the user settings.

branding_configuration_input instance-attribute

branding_configuration_input: NotRequired[BrandingConfigurationCreateInput]

The branding configuration input that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, localized strings, color theme, and optionally a wallpaper and terms of service.

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

cookie_synchronization_configuration instance-attribute

cookie_synchronization_configuration: NotRequired[CookieSynchronizationConfiguration]

The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

copy_allowed instance-attribute

copy_allowed: EnabledType

Specifies whether the user can copy text from the streaming session to the local device.

customer_managed_key instance-attribute

customer_managed_key: NotRequired[keyArn]

The customer managed key used to encrypt sensitive information in the user settings.

deep_link_allowed: NotRequired[EnabledType]

Specifies whether the user can use deep links that open automatically when connecting to a session.

disconnect_timeout_in_minutes instance-attribute

disconnect_timeout_in_minutes: NotRequired[DisconnectTimeoutInMinutes]

The amount of time that a streaming session remains active after users disconnect.

download_allowed instance-attribute

download_allowed: EnabledType

Specifies whether the user can download files from the streaming session to the local device.

idle_disconnect_timeout_in_minutes instance-attribute

idle_disconnect_timeout_in_minutes: NotRequired[IdleDisconnectTimeoutInMinutes]

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

paste_allowed instance-attribute

paste_allowed: EnabledType

Specifies whether the user can paste text from the local device to the streaming session.

print_allowed instance-attribute

print_allowed: EnabledType

Specifies whether the user can print to the local device.

tags instance-attribute

tags: NotRequired[TagList]

The tags to add to the user settings resource. A tag is a key-value pair.

toolbar_configuration instance-attribute

toolbar_configuration: NotRequired[ToolbarConfiguration]

The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

upload_allowed instance-attribute

upload_allowed: EnabledType

Specifies whether the user can upload files from the local device to the streaming session.

web_authn_allowed instance-attribute

web_authn_allowed: NotRequired[EnabledType]

Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.