list_user_settings

WorkSpacesWeb.Client.list_user_settings(**kwargs)

Retrieves a list of user settings.

See also: AWS API Documentation

Request Syntax

response = client.list_user_settings(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of results to be included in the next page.
• nextToken (string) -- The pagination token used to retrieve the next page of results for this operation.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • nextToken (string) --

    The pagination token used to retrieve the next page of results for this operation.

  • userSettings (list) --

    The user settings.

    • (dict) --

      The summary of user settings.

      • 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.AccessDeniedException
• WorkSpacesWeb.Client.exceptions.ThrottlingException
• WorkSpacesWeb.Client.exceptions.ValidationException