WorkSpacesWeb / Client / update_user_settings

update_user_settings¶

WorkSpacesWeb.Client.update_user_settings(**kwargs)¶

Updates the user settings.

Request Syntax

response = client.update_user_settings(
    userSettingsArn='string',
    copyAllowed='Disabled'|'Enabled',
    pasteAllowed='Disabled'|'Enabled',
    downloadAllowed='Disabled'|'Enabled',
    uploadAllowed='Disabled'|'Enabled',
    printAllowed='Disabled'|'Enabled',
    disconnectTimeoutInMinutes=123,
    idleDisconnectTimeoutInMinutes=123,
    clientToken='string',
    cookieSynchronizationConfiguration={
        'allowlist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': 'string'
            },
        ],
        'blocklist': [
            {
                'domain': 'string',
                'name': 'string',
                'path': 'string'
            },
        ]
    },
    deepLinkAllowed='Disabled'|'Enabled',
    toolbarConfiguration={
        'toolbarType': 'Floating'|'Docked',
        'visualMode': 'Dark'|'Light',
        'hiddenToolbarItems': [
            'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
        ],
        'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600'
    },
    brandingConfigurationInput={
        'logo': {
            'blob': b'bytes',
            's3Uri': 'string'
        },
        'wallpaper': {
            'blob': b'bytes',
            's3Uri': 'string'
        },
        'favicon': {
            'blob': b'bytes',
            's3Uri': 'string'
        },
        'localizedStrings': {
            'string': {
                'browserTabTitle': 'string',
                'welcomeText': 'string',
                'loginTitle': 'string',
                'loginDescription': 'string',
                'loginButtonText': 'string',
                'contactLink': 'string',
                'contactButtonText': 'string',
                'loadingText': 'string'
            }
        },
        'colorTheme': 'Light'|'Dark',
        'termsOfService': 'string'
    }
)

Parameters:

userSettingsArn (string) –
[REQUIRED]

The ARN of the user settings.
copyAllowed (string) – Specifies whether the user can copy text from the streaming session to the local device.
pasteAllowed (string) – Specifies whether the user can paste text from the local device to the streaming session.
downloadAllowed (string) – Specifies whether the user can download files from the streaming session to the local device.
uploadAllowed (string) – Specifies whether the user can upload files from the local device to the streaming session.
printAllowed (string) – Specifies whether the user can print to the local device.
disconnectTimeoutInMinutes (integer) – The amount of time that a streaming session remains active after users disconnect.
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.
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 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.

If the allowlist and blocklist are empty, the configuration becomes null.
- 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.
deepLinkAllowed (string) – Specifies whether the user can use deep links that open automatically when connecting to a session.
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.
- toolbarType (string) –
  
  The type of toolbar displayed during the session.
- visualMode (string) –
  
  The visual mode of the toolbar.
- hiddenToolbarItems (list) –
  
  The list of toolbar items to be hidden.
  - (string) –
- maxDisplayResolution (string) –
  
  The maximum display resolution that is allowed for the session.
brandingConfigurationInput (dict) –
The branding configuration that customizes the appearance of the web portal for end users. When updating user settings without an existing branding configuration, all fields (logo, favicon, wallpaper, localized strings, and color theme) are required except for terms of service. When updating user settings with an existing branding configuration, all fields are optional.
- logo (dict) –
  
  The logo image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: blob, s3Uri.
  - blob (bytes) –
    
    The image provided as a binary image file.
  - s3Uri (string) –
    
    The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.
- wallpaper (dict) –
  
  The wallpaper image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: blob, s3Uri.
  - blob (bytes) –
    
    The image provided as a binary image file.
  - s3Uri (string) –
    
    The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.
- favicon (dict) –
  
  The favicon image for the portal. Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.
  
  Note
  This is a Tagged Union structure. Only one of the following top level keys can be set: blob, s3Uri.
  - blob (bytes) –
    
    The image provided as a binary image file.
  - s3Uri (string) –
    
    The S3 URI pointing to the image file. The URI must use the format s3://bucket-name/key-name. You must have read access to the S3 object.
- localizedStrings (dict) –
  
  A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.
  - (string) –
    - (dict) –
      
      Localized text strings for a specific language that customize the web portal.
      - browserTabTitle (string) – [REQUIRED]
        
        The text displayed in the browser tab title.
      - welcomeText (string) – [REQUIRED]
        
        The welcome text displayed on the sign-in page.
      - loginTitle (string) –
        
        The title text for the login section. This field is optional and defaults to “Sign In”.
      - loginDescription (string) –
        
        The description text for the login section. This field is optional and defaults to “Sign in to your session”.
      - loginButtonText (string) –
        
        The text displayed on the login button. This field is optional and defaults to “Sign In”.
      - contactLink (string) –
        
        A contact link URL. The URL must start with https:// or mailto:. If not provided, the contact button will be hidden from the web portal screen.
      - contactButtonText (string) –
        
        The text displayed on the contact button. This field is optional and defaults to “Contact us”.
      - loadingText (string) –
        
        The text displayed during session loading. This field is optional and defaults to “Loading your session”.
- colorTheme (string) –
  
  The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.
- termsOfService (string) –
  
  The terms of service text in Markdown format. To remove existing terms of service, provide an empty string.

Return type:

dict

Returns:

Response Syntax

{
    'userSettings': {
        'userSettingsArn': 'string',
        'associatedPortalArns': [
            'string',
        ],
        'copyAllowed': 'Disabled'|'Enabled',
        'pasteAllowed': 'Disabled'|'Enabled',
        'downloadAllowed': 'Disabled'|'Enabled',
        'uploadAllowed': 'Disabled'|'Enabled',
        'printAllowed': 'Disabled'|'Enabled',
        'disconnectTimeoutInMinutes': 123,
        'idleDisconnectTimeoutInMinutes': 123,
        'cookieSynchronizationConfiguration': {
            'allowlist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ],
            'blocklist': [
                {
                    'domain': 'string',
                    'name': 'string',
                    'path': 'string'
                },
            ]
        },
        'customerManagedKey': 'string',
        'additionalEncryptionContext': {
            'string': 'string'
        },
        'deepLinkAllowed': 'Disabled'|'Enabled',
        'toolbarConfiguration': {
            'toolbarType': 'Floating'|'Docked',
            'visualMode': 'Dark'|'Light',
            'hiddenToolbarItems': [
                'Windows'|'DualMonitor'|'FullScreen'|'Webcam'|'Microphone',
            ],
            'maxDisplayResolution': 'size4096X2160'|'size3840X2160'|'size3440X1440'|'size2560X1440'|'size1920X1080'|'size1280X720'|'size1024X768'|'size800X600'
        },
        'brandingConfiguration': {
            'logo': {
                'mimeType': 'image/png'|'image/jpeg'|'image/x-icon',
                'fileExtension': 'string',
                'lastUploadTimestamp': datetime(2015, 1, 1)
            },
            'wallpaper': {
                'mimeType': 'image/png'|'image/jpeg'|'image/x-icon',
                'fileExtension': 'string',
                'lastUploadTimestamp': datetime(2015, 1, 1)
            },
            'favicon': {
                'mimeType': 'image/png'|'image/jpeg'|'image/x-icon',
                'fileExtension': 'string',
                'lastUploadTimestamp': datetime(2015, 1, 1)
            },
            'localizedStrings': {
                'string': {
                    'browserTabTitle': 'string',
                    'welcomeText': 'string',
                    'loginTitle': 'string',
                    'loginDescription': 'string',
                    'loginButtonText': 'string',
                    'contactLink': 'string',
                    'contactButtonText': 'string',
                    'loadingText': 'string'
                }
            },
            'colorTheme': 'Light'|'Dark',
            'termsOfService': 'string'
        }
    }
}

Response Structure

(dict) –
- userSettings (dict) –
  
  The user settings.
  - userSettingsArn (string) –
    
    The ARN of 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.
  - pasteAllowed (string) –
    
    Specifies whether the user can paste text from the local device to the streaming session.
  - downloadAllowed (string) –
    
    Specifies whether the user can download files from the streaming session to the local device.
  - uploadAllowed (string) –
    
    Specifies whether the user can upload files from the local device to the streaming session.
  - printAllowed (string) –
    
    Specifies whether the user can print to the local device.
  - disconnectTimeoutInMinutes (integer) –
    
    The amount of time that a streaming session remains active after users disconnect.
  - 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.
  - 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.
  - customerManagedKey (string) –
    
    The customer managed key used to encrypt sensitive information in the user settings.
  - additionalEncryptionContext (dict) –
    
    The additional encryption context of the user settings.
    - (string) –
      - (string) –
  - deepLinkAllowed (string) –
    
    Specifies whether the user can use deep links that open automatically when connecting to a session.
  - 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.
    - toolbarType (string) –
      
      The type of toolbar displayed during the session.
    - visualMode (string) –
      
      The visual mode of the toolbar.
    - hiddenToolbarItems (list) –
      
      The list of toolbar items to be hidden.
      - (string) –
    - maxDisplayResolution (string) –
      
      The maximum display resolution that is allowed for the session.
  - brandingConfiguration (dict) –
    
    The branding configuration output that customizes the appearance of the web portal for end users.
    - logo (dict) –
      
      Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.
      - mimeType (string) –
        
        The MIME type of the image.
      - fileExtension (string) –
        
        The file extension of the image.
      - lastUploadTimestamp (datetime) –
        
        The timestamp when the image was last uploaded.
    - wallpaper (dict) –
      
      Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.
      - mimeType (string) –
        
        The MIME type of the image.
      - fileExtension (string) –
        
        The file extension of the image.
      - lastUploadTimestamp (datetime) –
        
        The timestamp when the image was last uploaded.
    - favicon (dict) –
      
      Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.
      - mimeType (string) –
        
        The MIME type of the image.
      - fileExtension (string) –
        
        The file extension of the image.
      - lastUploadTimestamp (datetime) –
        
        The timestamp when the image was last uploaded.
    - localizedStrings (dict) –
      
      A map of localized text strings for different languages, allowing the portal to display content in the user’s preferred language.
      - (string) –
        
        (dict) –
        
        Localized text strings for a specific language that customize the web portal.
        
        browserTabTitle (string) –
        
        The text displayed in the browser tab title.
        
        welcomeText (string) –
        
        The welcome text displayed on the sign-in page.
        
        loginTitle (string) –
        
        The title text for the login section. This field is optional and defaults to “Sign In”.
        
        loginDescription (string) –
        
        The description text for the login section. This field is optional and defaults to “Sign in to your session”.
        
        loginButtonText (string) –
        
        The text displayed on the login button. This field is optional and defaults to “Sign In”.
        
        contactLink (string) –
        
        A contact link URL. The URL must start with https:// or mailto:. If not provided, the contact button will be hidden from the web portal screen.
        
        contactButtonText (string) –
        
        The text displayed on the contact button. This field is optional and defaults to “Contact us”.
        
        loadingText (string) –
        
        The text displayed during session loading. This field is optional and defaults to “Loading your session”.
    - colorTheme (string) –
      
      The color theme for components on the web portal.
    - termsOfService (string) –
      
      The terms of service text in Markdown format that users must accept before accessing the portal.

Exceptions

WorkSpacesWeb.Client.exceptions.InternalServerException
WorkSpacesWeb.Client.exceptions.ResourceNotFoundException
WorkSpacesWeb.Client.exceptions.AccessDeniedException
WorkSpacesWeb.Client.exceptions.ThrottlingException
WorkSpacesWeb.Client.exceptions.ValidationException