DirectoryServiceData / Paginator / ListGroupMembers

ListGroupMembers

class DirectoryServiceData.Paginator.ListGroupMembers

paginator = client.get_paginator('list_group_members')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryId='string',
    MemberRealm='string',
    Realm='string',
    SAMAccountName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• DirectoryId (string) –

  [REQUIRED]

  The identifier (ID) of the directory that’s associated with the group.

• MemberRealm (string) –

  The domain name that’s associated with the group member. This parameter defaults to the Managed Microsoft AD domain.

  Note

  This parameter is optional and case insensitive.

• Realm (string) –

  The domain name that’s associated with the group.

  Note

  This parameter is optional, so you can return members from a group outside of your Managed Microsoft AD domain. When no value is defined, only members of your Managed Microsoft AD groups are returned.

  This value is case insensitive.

• SAMAccountName (string) –

  [REQUIRED]

  The name of the 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

{
    'DirectoryId': 'string',
    'MemberRealm': 'string',
    'Members': [
        {
            'MemberType': 'USER'|'GROUP'|'COMPUTER',
            'SAMAccountName': 'string',
            'SID': 'string'
        },
    ],
    'Realm': 'string'
}

Response Structure

• (dict) –

  • DirectoryId (string) –

    Identifier (ID) of the directory associated with the group.

  • MemberRealm (string) –

    The domain name that’s associated with the member.

  • Members (list) –

    The member information that the request returns.

    • (dict) –

      A member object that contains identifying information for a specified member.

      • MemberType (string) –

        The AD type of the member object.

      • SAMAccountName (string) –

        The name of the group member.

      • SID (string) –

        The unique security identifier (SID) of the group member.

  • Realm (string) –

    The domain name that’s associated with the group.