WorkSpacesWeb / Client / create_user_settings

create_user_settings

WorkSpacesWeb.Client.create_user_settings(**kwargs)

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

See also: AWS API Documentation

Request Syntax

response = client.create_user_settings(
    additionalEncryptionContext={
        'string': 'string'
    },
    clientToken='string',
    cookieSynchronizationConfiguration={
        'allowlist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': 'string'
            },
        ],
        'blocklist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': 'string'
            },
        ]
    },
    copyAllowed='Disabled'|'Enabled',
    customerManagedKey='string',
    disconnectTimeoutInMinutes=123,
    downloadAllowed='Disabled'|'Enabled',
    idleDisconnectTimeoutInMinutes=123,
    pasteAllowed='Disabled'|'Enabled',
    printAllowed='Disabled'|'Enabled',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    uploadAllowed='Disabled'|'Enabled'
)

Parameters:

• additionalEncryptionContext (dict) –

  The additional encryption context of the user settings.

  • (string) –

    • (string) –

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

  This field is autopopulated if not provided.

• cookieSynchronizationConfiguration (dict) –

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

  • allowlist (list) – [REQUIRED]

    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) – [REQUIRED]

        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) – [REQUIRED]

        The domain of the cookie.

      • name (string) –

        The name of the cookie.

      • path (string) –

        The path of the cookie.

• copyAllowed (string) –

  [REQUIRED]

  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.

• disconnectTimeoutInMinutes (integer) – The amount of time that a streaming session remains active after users disconnect.

• downloadAllowed (string) –

  [REQUIRED]

  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) –

  [REQUIRED]

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

• printAllowed (string) –

  [REQUIRED]

  Specifies whether the user can print to the local device.

• tags (list) –

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

  • (dict) –

    The tag.

    • Key (string) – [REQUIRED]

      The key of the tag.

    • Value (string) – [REQUIRED]

      The value of the tag

• uploadAllowed (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'userSettingsArn': 'string'
}

Response Structure

• (dict) –

  • userSettingsArn (string) –

    The ARN of the user settings.

Exceptions

• WorkSpacesWeb.Client.exceptions.InternalServerException

• WorkSpacesWeb.Client.exceptions.AccessDeniedException

• WorkSpacesWeb.Client.exceptions.ThrottlingException

• WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException

• WorkSpacesWeb.Client.exceptions.ValidationException

• WorkSpacesWeb.Client.exceptions.ConflictException