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

*****************
update_guest_user
*****************



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

  

  Updates the block status of a guest user in a Wickr network. This operation allows you to block or unblock a guest user from accessing the network.

  

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


  **Request Syntax**
  ::

    response = client.update_guest_user(
        networkId='string',
        usernameHash='string',
        block=True|False
    )
    
  :type networkId: string
  :param networkId: **[REQUIRED]** 

    The ID of the Wickr network where the guest user's status will be updated.

    

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

    The username hash (unique identifier) of the guest user to update.

    

  
  :type block: boolean
  :param block: **[REQUIRED]** 

    Set to true to block the guest user or false to unblock them.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        A message indicating the result of the 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`

  