:doc:`WorkSpacesWeb <../../workspaces-web>` / Client / create_browser_settings

***********************
create_browser_settings
***********************



.. py:method:: WorkSpacesWeb.Client.create_browser_settings(**kwargs)

  

  Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateBrowserSettings>`_  


  **Request Syntax**
  ::

    response = client.create_browser_settings(
        tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        customerManagedKey='string',
        additionalEncryptionContext={
            'string': 'string'
        },
        browserPolicy='string',
        clientToken='string',
        webContentFilteringPolicy={
            'blockedCategories': [
                'Cults'|'Gambling'|'Nudity'|'Pornography'|'SexEducation'|'Tasteless'|'Violence'|'DownloadSites'|'ImageSharing'|'PeerToPeer'|'StreamingMediaAndDownloads'|'GenerativeAI'|'CriminalActivity'|'Hacking'|'HateAndIntolerance'|'IllegalDrug'|'IllegalSoftware'|'SchoolCheating'|'SelfHarm'|'Weapons'|'Chat'|'Games'|'InstantMessaging'|'ProfessionalNetwork'|'SocialNetworking'|'WebBasedEmail'|'ParkedDomains',
            ],
            'allowedUrls': [
                'string',
            ],
            'blockedUrls': [
                'string',
            ]
        }
    )
    
  :type tags: list
  :param tags: 

    The tags to add to the browser 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

        

      
    

  :type customerManagedKey: string
  :param customerManagedKey: 

    The custom managed key of the browser settings.

    

  
  :type additionalEncryptionContext: dict
  :param additionalEncryptionContext: 

    Additional encryption context of the browser settings.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  :type browserPolicy: string
  :param browserPolicy: 

    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

    

  
  :type clientToken: string
  :param clientToken: 

    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.

  
  :type webContentFilteringPolicy: dict
  :param webContentFilteringPolicy: 

    The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.

    

  
    - **blockedCategories** *(list) --* 

      Categories of websites that are blocked on the end user’s browsers.

      

    
      - *(string) --* 

      
  
    - **allowedUrls** *(list) --* 

      URLs and domains that are always accessible to end users.

      

    
      - *(string) --* 

      
  
    - **blockedUrls** *(list) --* 

      URLs and domains that end users cannot access.

      

    
      - *(string) --* 

      
  
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'browserSettingsArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **browserSettingsArn** *(string) --* 

        The ARN of the browser settings.

        
  
  **Exceptions**
  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.InternalServerException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ThrottlingException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ValidationException`

  
  *   :py:class:`WorkSpacesWeb.Client.exceptions.ConflictException`

  