:doc:`WorkDocs <../../workdocs>` / Client / describe_groups

***************
describe_groups
***************



.. py:method:: WorkDocs.Client.describe_groups(**kwargs)

  

  Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeGroups>`_  


  **Request Syntax**
  ::

    response = client.describe_groups(
        AuthenticationToken='string',
        SearchQuery='string',
        OrganizationId='string',
        Marker='string',
        Limit=123
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: 

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

    

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

    A query to describe groups by group name.

    

  
  :type OrganizationId: string
  :param OrganizationId: 

    The ID of the organization.

    

  
  :type Marker: string
  :param Marker: 

    The marker for the next set of results. (You received this marker from a previous call.)

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of items to return with this call.

    

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

    
    ::

      {
          'Groups': [
              {
                  'Id': 'string',
                  'Name': 'string'
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Groups** *(list) --* 

        The list of groups.

        
        

        - *(dict) --* 

          Describes the metadata of a user group.

          
          

          - **Id** *(string) --* 

            The ID of the user group.

            
          

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

            The name of the group.

            
      
    
      

      - **Marker** *(string) --* 

        The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

        
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedOperationException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedResourceAccessException`

  
  *   :py:class:`WorkDocs.Client.exceptions.FailedDependencyException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ServiceUnavailableException`

  