WorkMail / Paginator / ListGroupMembers

ListGroupMembers

class WorkMail.Paginator.ListGroupMembers

paginator = client.get_paginator('list_group_members')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkMail.Client.list_group_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OrganizationId='string',
    GroupId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier for the organization under which the group exists.

• GroupId (string) –

  [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

• PaginationConfig (dict) –

  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.

Return type:

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.