Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListCertificates

For the specified directory, lists all the certificates registered for a secure LDAP or client certificate authentication.

Request Syntax


{
   "DirectoryId": "string",
   "Limit": number,
   "NextToken": "string"
}

Request Parameters

The request accepts the following data in JSON format.

DirectoryId

The identifier of the directory.

Type: String

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

Required: Yes

Limit

The number of items that should show up on one page

Type: Integer

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

Required: No

NextToken

A token for requesting another page of certificates if the NextToken response element indicates that more certificates are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

Type: String

Required: No

Response Syntax


{
   "CertificatesInfo": [ 
      { 
         "CertificateId": "string",
         "CommonName": "string",
         "ExpiryDateTime": number,
         "State": "string",
         "Type": "string"
      }
   ],
   "NextToken": "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.

CertificatesInfo

A list of certificates with basic details including certificate ID, certificate common name, certificate state.

Type: Array of CertificateInfo objects

NextToken

Indicates whether another page of certificates is available when the number of available certificates exceeds the page limit.

Type: String

Errors

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

ClientException

A client exception has occurred.

HTTP Status Code: 400

DirectoryDoesNotExistException

The specified directory does not exist in the system.

HTTP Status Code: 400

InvalidNextTokenException

The NextToken value is not valid.

HTTP Status Code: 400

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 400

ServiceException

An exception has occurred in AWS Directory Service.

HTTP Status Code: 500

UnsupportedOperationException

The operation is not supported.

HTTP Status Code: 400