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

**********************
get_data_retention_bot
**********************



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

  

  Retrieves information about the data retention bot in a Wickr network, including its status and whether the data retention service is enabled.

  

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


  **Request Syntax**
  ::

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

    The ID of the Wickr network containing the data retention bot.

    

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

    
    ::

      {
          'botName': 'string',
          'botExists': True|False,
          'isBotActive': True|False,
          'isDataRetentionBotRegistered': True|False,
          'isDataRetentionServiceEnabled': True|False,
          'isPubkeyMsgAcked': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **botName** *(string) --* 

        The name of the data retention bot.

        
      

      - **botExists** *(boolean) --* 

        Indicates whether a data retention bot exists in the network.

        
      

      - **isBotActive** *(boolean) --* 

        Indicates whether the data retention bot is active and operational.

        
      

      - **isDataRetentionBotRegistered** *(boolean) --* 

        Indicates whether the data retention bot has been registered with the network.

        
      

      - **isDataRetentionServiceEnabled** *(boolean) --* 

        Indicates whether the data retention service is enabled for the network.

        
      

      - **isPubkeyMsgAcked** *(boolean) --* 

        Indicates whether the public key message has been acknowledged by the bot.

        
  
  **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`

  