Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListServicePrincipalNames

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

Request Syntax


GET /directoryRegistrations/DirectoryRegistrationArn/servicePrincipalNames?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DirectoryRegistrationArn

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

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: ^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration\/d-[0-9a-f]{10}$

Required: Yes

MaxResults

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.

Valid Range: Minimum value of 1. Maximum value of 1000.

NextToken

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.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^(?:[A-Za-z0-9_-]{4})*(?:[A-Za-z0-9_-]{2}==|[A-Za-z0-9_-]{3}=)?$

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ServicePrincipalNames": [ 
      { 
         "ConnectorArn": "string",
         "CreatedAt": number,
         "DirectoryRegistrationArn": "string",
         "Status": "string",
         "StatusReason": "string",
         "UpdatedAt": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: ^(?:[A-Za-z0-9_-]{4})*(?:[A-Za-z0-9_-]{2}==|[A-Za-z0-9_-]{3}=)?$

ServicePrincipalNames

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

Type: Array of ServicePrincipalNameSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your AWS Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an AWS Organizations service control policy (SCP) that affects your AWS account.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.

HTTP Status Code: 400