Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeCertificate

Displays information about the certificate registered for secure LDAP or client certificate authentication.

Request Syntax


{
   "CertificateId": "string",
   "DirectoryId": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CertificateId

The identifier of the certificate.

Type: String

Pattern: ^c-[0-9a-f]{10}$

Required: Yes

DirectoryId

The identifier of the directory.

Type: String

Pattern: ^d-[0-9a-f]{10}$

Required: Yes

Response Syntax


{
   "Certificate": { 
      "CertificateId": "string",
      "ClientCertAuthSettings": { 
         "OCSPUrl": "string"
      },
      "CommonName": "string",
      "ExpiryDateTime": number,
      "RegisteredDateTime": number,
      "State": "string",
      "StateReason": "string",
      "Type": "string"
   }
}

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.

Certificate

Information about the certificate, including registered date time, certificate state, the reason for the state, expiration date time, and certificate common name.

Type: Certificate object

Errors

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

CertificateDoesNotExistException

The certificate is not present in the system for describe or deregister activities.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 400

ClientException

A client exception has occurred.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

Message: The descriptive message for the exception.
RequestId: The AWS request identifier.

HTTP Status Code: 400