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

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



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

  

  Updates the properties of an existing bot in a Wickr network. This operation allows you to modify the bot's display name, security group, password, or suspension status.

  

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


  **Request Syntax**
  ::

    response = client.update_bot(
        networkId='string',
        botId='string',
        displayName='string',
        groupId='string',
        challenge='string',
        suspend=True|False
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network containing the bot to update.

    

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

    The unique identifier of the bot to update.

    

  
  :type displayName: string
  :param displayName: 

    The new display name for the bot.

    

  
  :type groupId: string
  :param groupId: 

    The ID of the new security group to assign the bot to.

    

  
  :type challenge: string
  :param challenge: 

    The new password for the bot account.

    

  
  :type suspend: boolean
  :param suspend: 

    Set to true to suspend the bot or false to unsuspend it. Omit this field for standard updates that don't affect suspension status.

    

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

    
    ::

      {
          'message': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **message** *(string) --* 

        A message indicating the result of the bot update operation.

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

  