WorkSpacesWeb / Client / get_user_settings

get_user_settings

WorkSpacesWeb.Client.get_user_settings(**kwargs)

Gets user settings.

See also: AWS API Documentation

Request Syntax

response = client.get_user_settings(
    userSettingsArn='string'
)

Parameters:

userSettingsArn (string) –

[REQUIRED]

The ARN of the user settings.

Return type:

dict

Returns:

Response Syntax

{
    'userSettings': {
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'associatedPortalArns': [
            'string',
        ],
        'cookieSynchronizationConfiguration': {
            'allowlist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ],
            'blocklist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ]
        },
        'copyAllowed': 'Disabled'|'Enabled',
        'customerManagedKey': 'string',
        'deepLinkAllowed': 'Disabled'|'Enabled',
        'disconnectTimeoutInMinutes': 123,
        'downloadAllowed': 'Disabled'|'Enabled',
        'idleDisconnectTimeoutInMinutes': 123,
        'pasteAllowed': 'Disabled'|'Enabled',
        'printAllowed': 'Disabled'|'Enabled',
        'toolbarConfiguration': {
            'hiddenToolbarItems': [
                'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
            ],
            'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600',
            'toolbarType': 'Floating'|'Docked',
            'visualMode': 'Dark'|'Light'
        },
        'uploadAllowed': 'Disabled'|'Enabled',
        'userSettingsArn': 'string'
    }
}

Response Structure

• (dict) –

  • userSettings (dict) –

    The user settings.

    • additionalEncryptionContext (dict) –

      The additional encryption context of the user settings.

      • (string) –

        • (string) –

    • associatedPortalArns (list) –

      A list of web portal ARNs that this user settings is associated with.

      • (string) –

    • cookieSynchronizationConfiguration (dict) –

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

      • allowlist (list) –

        The list of cookie specifications that are allowed to be synchronized to the remote browser.

        • (dict) –

          Specifies a single cookie or set of cookies in an end user’s browser.

          • domain (string) –

            The domain of the cookie.

          • name (string) –

            The name of the cookie.

          • path (string) –

            The path of the cookie.

      • blocklist (list) –

        The list of cookie specifications that are blocked from being synchronized to the remote browser.

        • (dict) –

          Specifies a single cookie or set of cookies in an end user’s browser.

          • domain (string) –

            The domain of the cookie.

          • name (string) –

            The name of the cookie.

          • path (string) –

            The path of the cookie.

    • copyAllowed (string) –

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

    • customerManagedKey (string) –

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

    • deepLinkAllowed (string) –

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

    • disconnectTimeoutInMinutes (integer) –

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

    • downloadAllowed (string) –

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

    • idleDisconnectTimeoutInMinutes (integer) –

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

    • pasteAllowed (string) –

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

    • printAllowed (string) –

      Specifies whether the user can print to the local device.

    • toolbarConfiguration (dict) –

      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.

      • hiddenToolbarItems (list) –

        The list of toolbar items to be hidden.

        • (string) –

      • maxDisplayResolution (string) –

        The maximum display resolution that is allowed for the session.

      • toolbarType (string) –

        The type of toolbar displayed during the session.

      • visualMode (string) –

        The visual mode of the toolbar.

    • uploadAllowed (string) –

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

    • userSettingsArn (string) –

      The ARN of the user settings.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException

• WorkSpacesWeb.Client.exceptions.ResourceNotFoundException

• WorkSpacesWeb.Client.exceptions.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ValidationException