:doc:`WickrAdminAPI <../../wickr>` / Client / get_network_settings

********************
get_network_settings
********************



.. py:method:: WickrAdminAPI.Client.get_network_settings(**kwargs)

  

  Retrieves all network-level settings for a Wickr network, including client metrics, data retention, and other configuration options.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/wickr-2024-02-01/GetNetworkSettings>`_  


  **Request Syntax**
  ::

    response = client.get_network_settings(
        networkId='string'
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network whose settings will be retrieved.

    

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

    
    ::

      {
          'settings': [
              {
                  'optionName': 'string',
                  'value': 'string',
                  'type': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **settings** *(list) --* 

        A list of network settings, where each setting includes a name, value, and type.

        
        

        - *(dict) --* 

          Represents a single network-level configuration setting with its name, value, and data type. Settings control network-wide behaviors and features.

          
          

          - **optionName** *(string) --* 

            The name of the network setting (e.g., 'enableClientMetrics', 'dataRetention').

            
          

          - **value** *(string) --* 

            The current value of the setting as a string. Boolean values are represented as 'true' or 'false'.

            
          

          - **type** *(string) --* 

            The data type of the setting value (e.g., 'boolean', 'string', 'number').

            
      
    
  
  **Exceptions**
  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ValidationError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.BadRequestError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ResourceNotFoundError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.ForbiddenError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.UnauthorizedError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.InternalServerError`

  
  *   :py:class:`WickrAdminAPI.Client.exceptions.RateLimitError`

  