GetDirectoryRegistration - AWS Private CA Connector for Active Directory

GetDirectoryRegistration

A structure that contains information about your directory registration.

Request Syntax

GET /directoryRegistrations/DirectoryRegistrationArn 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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DirectoryRegistration": { "Arn": "string", "CreatedAt": number, "DirectoryId": "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.

DirectoryRegistration

The directory registration represents the authorization of the connector service with a directory.

Type: DirectoryRegistration object

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: