:doc:`WorkMail <../../workmail>` / Paginator / ListGroupMembers

****************
ListGroupMembers
****************



.. py:class:: WorkMail.Paginator.ListGroupMembers

  ::

    
    paginator = client.get_paginator('list_group_members')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`WorkMail.Client.list_group_members`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          OrganizationId='string',
          GroupId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 which the members (users or groups) are associated.

       

      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 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**

      
      ::

        {
            'Members': [
                {
                    'Id': 'string',
                    'Name': 'string',
                    'Type': 'GROUP'|'USER',
                    'State': 'ENABLED'|'DISABLED'|'DELETED',
                    'EnabledDate': datetime(2015, 1, 1),
                    'DisabledDate': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Members** *(list) --* 

          The members associated to the group.

          
          

          - *(dict) --* 

            The representation of a user or group.

            
            

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

              The identifier of the member.

              
            

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

              The name of the member.

              
            

            - **Type** *(string) --* 

              A member can be a user or group.

              
            

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

              The state of the member, which can be ENABLED, DISABLED, or DELETED.

              
            

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

              The date indicating when the member was enabled for WorkMail use.

              
            

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

              The date indicating when the member was disabled from WorkMail use.

              
        
      
    