Skip to content

Describe Certificates

docdb_describe_certificates R Documentation

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

Description

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

Usage

docdb_describe_certificates(CertificateIdentifier, Filters, MaxRecords,
  Marker)

Arguments

CertificateIdentifier

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

This parameter is not currently supported.

MaxRecords

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

Marker

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

Value

A list with the following syntax: 

list(
  Certificates = list(
    list(
      CertificateIdentifier = "string",
      CertificateType = "string",
      Thumbprint = "string",
      ValidFrom = as.POSIXct(
        "2015-01-01"
      ),
      ValidTill = as.POSIXct(
        "2015-01-01"
      ),
      CertificateArn = "string"
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_certificates(
  CertificateIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)