:doc:`WorkDocs <../../workdocs>` / Paginator / DescribeGroups

**************
DescribeGroups
**************



.. py:class:: WorkDocs.Paginator.DescribeGroups

  ::

    
    paginator = client.get_paginator('describe_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`WorkDocs.Client.describe_groups`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AuthenticationToken='string',
          SearchQuery='string',
          OrganizationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Groups': [
                {
                    'Id': 'string',
                    'Name': 'string'
                },
            ],
            'NextToken': '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.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    