:doc:`Chime <../../chime>` / Client / list_bots

*********
list_bots
*********



.. py:method:: Chime.Client.list_bots(**kwargs)

  

  Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListBots>`_  


  **Request Syntax**
  ::

    response = client.list_bots(
        AccountId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Chime account ID.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call. The default is 10.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results.

    

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

    
    ::

      {
          'Bots': [
              {
                  'BotId': 'string',
                  'UserId': 'string',
                  'DisplayName': 'string',
                  'BotType': 'ChatBot',
                  'Disabled': True|False,
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'UpdatedTimestamp': datetime(2015, 1, 1),
                  'BotEmail': 'string',
                  'SecurityToken': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Bots** *(list) --* 

        List of bots and bot details.

        
        

        - *(dict) --* 

          A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

          
          

          - **BotId** *(string) --* 

            The bot ID.

            
          

          - **UserId** *(string) --* 

            The unique ID for the bot user.

            
          

          - **DisplayName** *(string) --* 

            The bot display name.

            
          

          - **BotType** *(string) --* 

            The bot type.

            
          

          - **Disabled** *(boolean) --* 

            When true, the bot is stopped from running in your account.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The bot creation timestamp, in ISO 8601 format.

            
          

          - **UpdatedTimestamp** *(datetime) --* 

            The updated bot timestamp, in ISO 8601 format.

            
          

          - **BotEmail** *(string) --* 

            The bot email address.

            
          

          - **SecurityToken** *(string) --* 

            The security token used to authenticate Amazon Chime with the outgoing event endpoint.

            
      
    
      

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

        The token to use to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`Chime.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`Chime.Client.exceptions.ServiceFailureException`

  
  *   :py:class:`Chime.Client.exceptions.ForbiddenException`

  
  *   :py:class:`Chime.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`Chime.Client.exceptions.BadRequestException`

  
  *   :py:class:`Chime.Client.exceptions.NotFoundException`

  
  *   :py:class:`Chime.Client.exceptions.ThrottledClientException`

  