PcaConnectorAd / Client / list_directory_registrations

list_directory_registrations#

PcaConnectorAd.Client.list_directory_registrations(**kwargs)#

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.

See also: AWS API Documentation

Request Syntax

response = client.list_directory_registrations(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.

  • NextToken (string) – Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

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)
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

Exceptions