:doc:`WorkMail <../../workmail>` / Client / update_group

************
update_group
************



.. py:method:: WorkMail.Client.update_group(**kwargs)

  

  Updates attributes in a group.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workmail-2017-10-01/UpdateGroup>`_  


  **Request Syntax**
  ::

    response = client.update_group(
        OrganizationId='string',
        GroupId='string',
        HiddenFromGlobalAddressList=True|False
    )
    
  :type OrganizationId: string
  :param OrganizationId: **[REQUIRED]** 

    The identifier for the organization under which the group exists.

    

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

    The identifier for the group to be updated.

     

    The identifier can accept *GroupId*, *Groupname*, or *email*. The following identity formats are available:

     

    
    * Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
     
    * Email address: group@domain.tld
     
    * Group name: group
    

    

  
  :type HiddenFromGlobalAddressList: boolean
  :param HiddenFromGlobalAddressList: 

    If enabled, the group is hidden from the global address list.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.EntityNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.EntityStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationNotFoundException`

  
  *   :py:class:`WorkMail.Client.exceptions.OrganizationStateException`

  
  *   :py:class:`WorkMail.Client.exceptions.UnsupportedOperationException`

  
  *   :py:class:`WorkMail.Client.exceptions.InvalidParameterException`

  