DirectoryServiceData / Paginator / ListGroups

ListGroups

class DirectoryServiceData.Paginator.ListGroups

paginator = client.get_paginator('list_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• DirectoryId (string) –

  [REQUIRED]

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

• Realm (string) –

  The domain name associated with the directory.

  Note

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

  This value is case insensitive.

• 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',
    'Groups': [
        {
            'GroupScope': 'DomainLocal'|'Global'|'Universal'|'BuiltinLocal',
            'GroupType': 'Distribution'|'Security',
            'SAMAccountName': 'string',
            'SID': 'string'
        },
    ],
    'Realm': 'string'
}

Response Structure

• (dict) –

  • DirectoryId (string) –

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

  • Groups (list) –

    The group information that the request returns.

    • (dict) –

      A structure containing a subset of fields of a group object from a directory.

      • GroupScope (string) –

        The scope of the AD group. For details, see Active Directory security groups.

      • GroupType (string) –

        The AD group type. For details, see Active Directory security group type.

      • SAMAccountName (string) –

        The name of the group.

      • SID (string) –

        The unique security identifier (SID) of the group.

  • Realm (string) –

    The domain name associated with the group.