DescribeCertificatesCommand

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribeCertificatesCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeCertificatesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeCertificatesMessage
  CertificateIdentifier: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeCertificatesCommand(input);
const response = await client.send(command);
// { // CertificateMessage
//   Certificates: [ // CertificateList
//     { // Certificate
//       CertificateIdentifier: "STRING_VALUE",
//       CertificateType: "STRING_VALUE",
//       Thumbprint: "STRING_VALUE",
//       ValidFrom: new Date("TIMESTAMP"),
//       ValidTill: new Date("TIMESTAMP"),
//       CertificateArn: "STRING_VALUE",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeCertificatesCommand Input

Parameter
Type
Description
CertificateIdentifier
string | undefined

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

Filters
Filter[] | undefined

This parameter is not currently supported.

Marker
string | undefined

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

MaxRecords
number | undefined

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20

  • Maximum: 100

DescribeCertificatesCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Certificates
Certificate[] | undefined

A list of certificates for this Amazon Web Services account.

Marker
string | undefined

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

Throws

Name
Fault
Details
CertificateNotFoundFault
client

CertificateIdentifier doesn't refer to an existing certificate.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.