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

**************
describe_group
**************



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

  

  Returns the data available for the group.

  

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


  **Request Syntax**
  ::

    response = client.describe_group(
        OrganizationId='string',
        GroupId='string'
    )
    
  :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 described.

     

    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
    

    

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

    
    ::

      {
          'GroupId': 'string',
          'Name': 'string',
          'Email': 'string',
          'State': 'ENABLED'|'DISABLED'|'DELETED',
          'EnabledDate': datetime(2015, 1, 1),
          'DisabledDate': datetime(2015, 1, 1),
          'HiddenFromGlobalAddressList': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The identifier of the described group.

        
      

      - **Name** *(string) --* 

        The name of the described group.

        
      

      - **Email** *(string) --* 

        The email of the described group.

        
      

      - **State** *(string) --* 

        The state of the user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

        
      

      - **EnabledDate** *(datetime) --* 

        The date and time when a user was registered to WorkMail, in UNIX epoch time format.

        
      

      - **DisabledDate** *(datetime) --* 

        The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

        
      

      - **HiddenFromGlobalAddressList** *(boolean) --* 

        If the value is set to *true*, the group is hidden from the address book.

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

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

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

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

  