PcaConnectorAd / Client / get_directory_registration

get_directory_registration#

PcaConnectorAd.Client.get_directory_registration(**kwargs)#

A structure that contains information about your directory registration.

See also: AWS API Documentation

Request Syntax

response = client.get_directory_registration(
    DirectoryRegistrationArn='string'
)
Parameters:

DirectoryRegistrationArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'DirectoryRegistration': {
        '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) –

    • DirectoryRegistration (dict) –

      The directory registration represents the authorization of the connector service with a 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.

Exceptions

  • PcaConnectorAd.Client.exceptions.AccessDeniedException

  • PcaConnectorAd.Client.exceptions.ValidationException

  • PcaConnectorAd.Client.exceptions.ResourceNotFoundException

  • PcaConnectorAd.Client.exceptions.ThrottlingException

  • PcaConnectorAd.Client.exceptions.InternalServerException