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

**************
get_bots_count
**************



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

  

  Retrieves the count of bots in a Wickr network, categorized by their status (pending, active, and total).

  

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


  **Request Syntax**
  ::

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

    The ID of the Wickr network for which to retrieve bot counts.

    

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

    
    ::

      {
          'pending': 123,
          'active': 123,
          'total': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **pending** *(integer) --* 

        The number of bots with pending status (invited but not yet activated).

        
      

      - **active** *(integer) --* 

        The number of bots with active status.

        
      

      - **total** *(integer) --* 

        The total number of bots in the network (active and pending).

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

  