PcaConnectorAd / Client / get_service_principal_name

get_service_principal_name#

PcaConnectorAd.Client.get_service_principal_name(**kwargs)#

Lists the service principal name that the connector uses to authenticate with Active Directory.

See also: AWS API Documentation

Request Syntax

response = client.get_service_principal_name(
    ConnectorArn='string',
    DirectoryRegistrationArn='string'
)
Parameters:

  • ConnectorArn (string) –

    [REQUIRED]

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

  • DirectoryRegistrationArn (string) –

    [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ServicePrincipalName': {
        'ConnectorArn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'DirectoryRegistrationArn': 'string',
        'Status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED',
        'StatusReason': 'DIRECTORY_ACCESS_DENIED'|'DIRECTORY_NOT_REACHABLE'|'DIRECTORY_RESOURCE_NOT_FOUND'|'SPN_EXISTS_ON_DIFFERENT_AD_OBJECT'|'INTERNAL_FAILURE',
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • ServicePrincipalName (dict) –

      The service principal name that the connector uses to authenticate with Active Directory.

      • ConnectorArn (string) –

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

      • CreatedAt (datetime) –

        The date and time that the service principal name was created.

      • DirectoryRegistrationArn (string) –

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

      • Status (string) –

        The status of a service principal name.

      • StatusReason (string) –

        Additional information for the status of a service principal name if the status is failed.

      • UpdatedAt (datetime) –

        The date and time that the service principal name was updated.

Exceptions

  • PcaConnectorAd.Client.exceptions.AccessDeniedException

  • PcaConnectorAd.Client.exceptions.ValidationException

  • PcaConnectorAd.Client.exceptions.ResourceNotFoundException

  • PcaConnectorAd.Client.exceptions.ThrottlingException

  • PcaConnectorAd.Client.exceptions.InternalServerException