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

**********
update_bot
**********



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

  

  Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

  

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


  **Request Syntax**
  ::

    response = client.update_bot(
        AccountId='string',
        BotId='string',
        Disabled=True|False
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Chime account ID.

    

  
  :type BotId: string
  :param BotId: **[REQUIRED]** 

    The bot ID.

    

  
  :type Disabled: boolean
  :param Disabled: 

    When true, stops the specified bot from running in your account.

    

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

    
    ::

      {
          'Bot': {
              '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'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Bot** *(dict) --* 

        The updated bot details.

        
        

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

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

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

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

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

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

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

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

  