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

************
create_group
************



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

  

  Creates a group that can be used in WorkMail by calling the  RegisterToWorkMail operation.

  

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


  **Request Syntax**
  ::

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

    The organization under which the group is to be created.

    

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

    The name of the group.

    

  
  :type HiddenFromGlobalAddressList: boolean
  :param HiddenFromGlobalAddressList: 

    If this parameter is enabled, the group will be hidden from the address book.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **GroupId** *(string) --* 

        The identifier of the group.

        
  
  **Exceptions**
  
  *   :py:class:`WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException`

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

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

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

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

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

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

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

  