:doc:`WickrAdminAPI <../../wickr>` / Paginator / ListBots

********
ListBots
********



.. py:class:: WickrAdminAPI.Paginator.ListBots

  ::

    
    paginator = client.get_paginator('list_bots')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`WickrAdminAPI.Client.list_bots`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          networkId='string',
          sortFields='string',
          sortDirection='ASC'|'DESC',
          displayName='string',
          username='string',
          status=123,
          groupId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type networkId: string
    :param networkId: **[REQUIRED]** 

      The ID of the Wickr network from which to list bots.

      

    
    :type sortFields: string
    :param sortFields: 

      The fields to sort bots by. Multiple fields can be specified by separating them with '+'. Accepted values include 'username', 'firstName', 'displayName', 'status', and 'groupId'.

      

    
    :type sortDirection: string
    :param sortDirection: 

      The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.

      

    
    :type displayName: string
    :param displayName: 

      Filter results to only include bots with display names matching this value.

      

    
    :type username: string
    :param username: 

      Filter results to only include bots with usernames matching this value.

      

    
    :type status: integer
    :param status: 

      Filter results to only include bots with this status (1 for pending, 2 for active).

      

    
    :type groupId: string
    :param groupId: 

      Filter results to only include bots belonging to this security group.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'bots': [
                {
                    'botId': 'string',
                    'displayName': 'string',
                    'username': 'string',
                    'uname': 'string',
                    'pubkey': 'string',
                    'status': 123,
                    'groupId': 'string',
                    'hasChallenge': True|False,
                    'suspended': True|False,
                    'lastLogin': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **bots** *(list) --* 

          A list of bot objects matching the specified filters and within the current page.

          
          

          - *(dict) --* 

            Represents a bot account in a Wickr network with all its informational fields.

            
            

            - **botId** *(string) --* 

              The unique identifier of the bot.

              
            

            - **displayName** *(string) --* 

              The display name of the bot that is visible to users.

              
            

            - **username** *(string) --* 

              The username of the bot.

              
            

            - **uname** *(string) --* 

              The unique username hash identifier for the bot.

              
            

            - **pubkey** *(string) --* 

              The public key of the bot used for encryption.

              
            

            - **status** *(integer) --* 

              The current status of the bot (1 for pending, 2 for active).

              
            

            - **groupId** *(string) --* 

              The ID of the security group to which the bot belongs.

              
            

            - **hasChallenge** *(boolean) --* 

              Indicates whether the bot has a password set.

              
            

            - **suspended** *(boolean) --* 

              Indicates whether the bot is currently suspended.

              
            

            - **lastLogin** *(string) --* 

              The timestamp of the bot's last login.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    