DirectoryServiceData / Paginator / ListUsers

ListUsers

class DirectoryServiceData.Paginator.ListUsers

paginator = client.get_paginator('list_users')

paginate(**kwargs)

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

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 user.

• Realm (string) –

  The domain name that’s associated with the user.

  Note

  This parameter is optional, so you can return users outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users 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',
    'Realm': 'string',
    'Users': [
        {
            'Enabled': True|False,
            'GivenName': 'string',
            'SAMAccountName': 'string',
            'SID': 'string',
            'Surname': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • DirectoryId (string) –

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

  • Realm (string) –

    The domain that’s associated with the user.

  • Users (list) –

    The user information that the request returns.

    • (dict) –

      A structure containing a subset of the fields of a user object from a directory.

      • Enabled (boolean) –

        Indicates whether the user account is active.

      • GivenName (string) –

        The first name of the user.

      • SAMAccountName (string) –

        The name of the user.

      • SID (string) –

        The unique security identifier (SID) of the user.

      • Surname (string) –

        The last name of the user.