Retrieves a list of certificate ARNs and domain names¶

Description¶

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

By default, this action does not return certificates with a CertificateKeyPairOrigin of ACME. To include ACME certificates, specify ACME in the CertificateKeyPairOrigins filter.

Usage¶

acm_list_certificates(CertificateStatuses, CertificateKeyPairOrigins,
  Includes, NextToken, MaxItems, SortBy, SortOrder)

Arguments¶

CertificateStatuses

Filter the certificate list by status value.
CertificateKeyPairOrigins

Filter the certificate list by certificate key pair origin. Specify one or more CertificateKeyPairOrigin values. Default filtering returns only certificates with key pair origin of AWS_MANAGED and CUSTOMER_PROVIDED.
Includes

Filter the certificate list. For more information, see the Filters structure.
NextToken

Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
MaxItems

Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
SortBy

Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
SortOrder

Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  CertificateSummaryList = list(
    list(
      CertificateArn = "string",
      DomainName = "string",
      SubjectAlternativeNameSummaries = list(
        "string"
      ),
      HasAdditionalSubjectAlternativeNames = TRUE|FALSE,
      Status = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED",
      Type = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE",
      KeyAlgorithm = "RSA_1024"|"RSA_2048"|"RSA_3072"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1",
      KeyUsages = list(
        "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM"
      ),
      ExtendedKeyUsages = list(
        "TLS_WEB_SERVER_AUTHENTICATION"|"TLS_WEB_CLIENT_AUTHENTICATION"|"CODE_SIGNING"|"EMAIL_PROTECTION"|"TIME_STAMPING"|"OCSP_SIGNING"|"IPSEC_END_SYSTEM"|"IPSEC_TUNNEL"|"IPSEC_USER"|"ANY"|"NONE"|"CUSTOM"
      ),
      ExportOption = "ENABLED"|"DISABLED",
      InUse = TRUE|FALSE,
      Exported = TRUE|FALSE,
      RenewalEligibility = "ELIGIBLE"|"INELIGIBLE",
      NotBefore = as.POSIXct(
        "2015-01-01"
      ),
      NotAfter = as.POSIXct(
        "2015-01-01"
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      IssuedAt = as.POSIXct(
        "2015-01-01"
      ),
      ImportedAt = as.POSIXct(
        "2015-01-01"
      ),
      RevokedAt = as.POSIXct(
        "2015-01-01"
      ),
      ManagedBy = "CLOUDFRONT",
      CertificateKeyPairOrigin = "AWS_MANAGED"|"ACME"|"CUSTOMER_PROVIDED"
    )
  )
)

Request syntax¶

svc$list_certificates(
  CertificateStatuses = list(
    "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED"
  ),
  CertificateKeyPairOrigins = list(
    "AWS_MANAGED"|"ACME"|"CUSTOMER_PROVIDED"
  ),
  Includes = list(
    extendedKeyUsage = list(
      "TLS_WEB_SERVER_AUTHENTICATION"|"TLS_WEB_CLIENT_AUTHENTICATION"|"CODE_SIGNING"|"EMAIL_PROTECTION"|"TIME_STAMPING"|"OCSP_SIGNING"|"IPSEC_END_SYSTEM"|"IPSEC_TUNNEL"|"IPSEC_USER"|"ANY"|"NONE"|"CUSTOM"
    ),
    keyUsage = list(
      "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM"
    ),
    keyTypes = list(
      "RSA_1024"|"RSA_2048"|"RSA_3072"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1"
    ),
    exportOption = "ENABLED"|"DISABLED",
    managedBy = "CLOUDFRONT"
  ),
  NextToken = "string",
  MaxItems = 123,
  SortBy = "CREATED_AT",
  SortOrder = "ASCENDING"|"DESCENDING"
)