WorkSpacesWeb / Client / update_user_settings

update_user_settings#

WorkSpacesWeb.Client.update_user_settings(**kwargs)#

Updates the user settings.

See also: AWS API Documentation

Request Syntax

response = client.update_user_settings(
    clientToken='string',
    copyAllowed='Disabled'|'Enabled',
    disconnectTimeoutInMinutes=123,
    downloadAllowed='Disabled'|'Enabled',
    idleDisconnectTimeoutInMinutes=123,
    pasteAllowed='Disabled'|'Enabled',
    printAllowed='Disabled'|'Enabled',
    uploadAllowed='Disabled'|'Enabled',
    userSettingsArn='string'
)
Parameters:

  • clientToken (string) –

    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 return the result from the original successful request.

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

    This field is autopopulated if not provided.

  • copyAllowed (string) – Specifies whether the user can copy text from the streaming session to the local device.

  • 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.

  • uploadAllowed (string) – Specifies whether the user can upload files from the local device to the streaming session.

  • userSettingsArn (string) –

    [REQUIRED]

    The ARN of the user settings.

Return type:

dict

Returns:

Response Syntax

{
    'userSettings': {
        'associatedPortalArns': [
            'string',
        ],
        'copyAllowed': 'Disabled'|'Enabled',
        'disconnectTimeoutInMinutes': 123,
        'downloadAllowed': 'Disabled'|'Enabled',
        'idleDisconnectTimeoutInMinutes': 123,
        'pasteAllowed': 'Disabled'|'Enabled',
        'printAllowed': 'Disabled'|'Enabled',
        'uploadAllowed': 'Disabled'|'Enabled',
        'userSettingsArn': 'string'
    }
}

Response Structure

  • (dict) –

    • userSettings (dict) –

      The user settings.

      • associatedPortalArns (list) –

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

        • (string) –

      • copyAllowed (string) –

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

      • 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.

      • 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