PcaConnectorAd / Paginator / ListDirectoryRegistrations

ListDirectoryRegistrations#

class PcaConnectorAd.Paginator.ListDirectoryRegistrations#
paginator = client.get_paginator('list_directory_registrations')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from PcaConnectorAd.Client.list_directory_registrations().

See also: AWS API Documentation

Request Syntax

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

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

{
    'DirectoryRegistrations': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'DirectoryId': 'string',
            'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
            'StatusReason': 'DIRECTORY_ACCESS_DENIED'|'DIRECTORY_RESOURCE_NOT_FOUND'|'DIRECTORY_NOT_ACTIVE'|'DIRECTORY_NOT_REACHABLE'|'DIRECTORY_TYPE_NOT_SUPPORTED'|'INTERNAL_FAILURE',
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • DirectoryRegistrations (list) –

      Summary information about each directory registration you have created.

      • (dict) –

        The directory registration represents the authorization of the connector service with the Active Directory.

        • Arn (string) –

          The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.

        • CreatedAt (datetime) –

          The date and time that the directory registration was created.

        • DirectoryId (string) –

          The identifier of the Active Directory.

        • Status (string) –

          Status of the directory registration.

        • StatusReason (string) –

          Additional information about the directory registration status if the status is failed.

        • UpdatedAt (datetime) –

          The date and time that the directory registration was updated.