Retrieves a list of certificates matching search criteria¶

Description¶

Retrieves a list of certificates matching search criteria. You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than list_certificates by supporting complex filter statements.

Usage¶

acm_search_certificates(FilterStatement, MaxResults, NextToken, SortBy,
  SortOrder)

Arguments¶

FilterStatement

A filter statement that defines the search criteria. You can combine multiple filters using AND, OR, and NOT logical operators to create complex queries.
MaxResults

The maximum number of results to return in the response. Default is 100.
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.
SortBy

Specifies the field to sort results by. Valid values are CREATED_AT, NOT_AFTER, STATUS, RENEWAL_STATUS, EXPORTED, IN_USE, NOT_BEFORE, KEY_ALGORITHM, TYPE, CERTIFICATE_ARN, COMMON_NAME, REVOKED_AT, RENEWAL_ELIGIBILITY, ISSUED_AT, MANAGED_BY, EXPORT_OPTION, VALIDATION_METHOD, and IMPORTED_AT.
SortOrder

Specifies the order of sorted results. Valid values are ASCENDING or DESCENDING.

Value¶

A list with the following syntax:

list(
  Results = list(
    list(
      CertificateArn = "string",
      X509Attributes = list(
        Issuer = list(
          CommonName = "string",
          DomainComponents = list(
            "string"
          ),
          Country = "string",
          CustomAttributes = list(
            list(
              ObjectIdentifier = "string",
              Value = "string"
            )
          ),
          DistinguishedNameQualifier = "string",
          GenerationQualifier = "string",
          GivenName = "string",
          Initials = "string",
          Locality = "string",
          Organization = "string",
          OrganizationalUnit = "string",
          Pseudonym = "string",
          SerialNumber = "string",
          State = "string",
          Surname = "string",
          Title = "string"
        ),
        Subject = list(
          CommonName = "string",
          DomainComponents = list(
            "string"
          ),
          Country = "string",
          CustomAttributes = list(
            list(
              ObjectIdentifier = "string",
              Value = "string"
            )
          ),
          DistinguishedNameQualifier = "string",
          GenerationQualifier = "string",
          GivenName = "string",
          Initials = "string",
          Locality = "string",
          Organization = "string",
          OrganizationalUnit = "string",
          Pseudonym = "string",
          SerialNumber = "string",
          State = "string",
          Surname = "string",
          Title = "string"
        ),
        SubjectAlternativeNames = list(
          list(
            DirectoryName = list(
              CommonName = "string",
              DomainComponents = list(
                "string"
              ),
              Country = "string",
              CustomAttributes = list(
                list(
                  ObjectIdentifier = "string",
                  Value = "string"
                )
              ),
              DistinguishedNameQualifier = "string",
              GenerationQualifier = "string",
              GivenName = "string",
              Initials = "string",
              Locality = "string",
              Organization = "string",
              OrganizationalUnit = "string",
              Pseudonym = "string",
              SerialNumber = "string",
              State = "string",
              Surname = "string",
              Title = "string"
            ),
            DnsName = "string",
            IpAddress = "string",
            OtherName = list(
              ObjectIdentifier = "string",
              Value = "string"
            ),
            RegisteredId = "string",
            Rfc822Name = "string",
            UniformResourceIdentifier = "string"
          )
        ),
        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"
        ),
        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"
        ),
        SerialNumber = "string",
        NotAfter = as.POSIXct(
          "2015-01-01"
        ),
        NotBefore = as.POSIXct(
          "2015-01-01"
        )
      ),
      CertificateMetadata = list(
        AcmCertificateMetadata = list(
          CreatedAt = as.POSIXct(
            "2015-01-01"
          ),
          Exported = TRUE|FALSE,
          ImportedAt = as.POSIXct(
            "2015-01-01"
          ),
          InUse = TRUE|FALSE,
          IssuedAt = as.POSIXct(
            "2015-01-01"
          ),
          RenewalEligibility = "ELIGIBLE"|"INELIGIBLE",
          RevokedAt = as.POSIXct(
            "2015-01-01"
          ),
          Status = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED",
          RenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED",
          Type = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE",
          ExportOption = "ENABLED"|"DISABLED",
          ManagedBy = "CLOUDFRONT",
          ValidationMethod = "EMAIL"|"DNS"|"HTTP",
          CertificateKeyPairOrigin = "AWS_MANAGED"|"ACME"|"CUSTOMER_PROVIDED",
          AcmeEndpointArn = "string",
          AcmeAccountId = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$search_certificates(
  FilterStatement = list(
    And = list(
      list()
    ),
    Or = list(
      list()
    ),
    Not = list(),
    Filter = list(
      CertificateArn = "string",
      X509AttributeFilter = list(
        Subject = list(
          CommonName = list(
            Value = "string",
            ComparisonOperator = "CONTAINS"|"EQUALS"
          )
        ),
        SubjectAlternativeName = list(
          DnsName = list(
            Value = "string",
            ComparisonOperator = "CONTAINS"|"EQUALS"
          )
        ),
        ExtendedKeyUsage = "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 = "DIGITAL_SIGNATURE"|"NON_REPUDIATION"|"KEY_ENCIPHERMENT"|"DATA_ENCIPHERMENT"|"KEY_AGREEMENT"|"CERTIFICATE_SIGNING"|"CRL_SIGNING"|"ENCIPHER_ONLY"|"DECIPHER_ONLY"|"ANY"|"CUSTOM",
        KeyAlgorithm = "RSA_1024"|"RSA_2048"|"RSA_3072"|"RSA_4096"|"EC_prime256v1"|"EC_secp384r1"|"EC_secp521r1",
        SerialNumber = "string",
        NotAfter = list(
          Start = as.POSIXct(
            "2015-01-01"
          ),
          End = as.POSIXct(
            "2015-01-01"
          )
        ),
        NotBefore = list(
          Start = as.POSIXct(
            "2015-01-01"
          ),
          End = as.POSIXct(
            "2015-01-01"
          )
        )
      ),
      AcmCertificateMetadataFilter = list(
        Status = "PENDING_VALIDATION"|"ISSUED"|"INACTIVE"|"EXPIRED"|"VALIDATION_TIMED_OUT"|"REVOKED"|"FAILED",
        RenewalStatus = "PENDING_AUTO_RENEWAL"|"PENDING_VALIDATION"|"SUCCESS"|"FAILED",
        Type = "IMPORTED"|"AMAZON_ISSUED"|"PRIVATE",
        InUse = TRUE|FALSE,
        Exported = TRUE|FALSE,
        ExportOption = "ENABLED"|"DISABLED",
        ManagedBy = "CLOUDFRONT",
        ValidationMethod = "EMAIL"|"DNS"|"HTTP",
        CertificateKeyPairOrigin = "AWS_MANAGED"|"ACME"|"CUSTOMER_PROVIDED",
        AcmeEndpointArn = "string",
        AcmeAccountId = "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string",
  SortBy = "CREATED_AT"|"NOT_AFTER"|"STATUS"|"RENEWAL_STATUS"|"EXPORTED"|"IN_USE"|"NOT_BEFORE"|"KEY_ALGORITHM"|"TYPE"|"CERTIFICATE_ARN"|"COMMON_NAME"|"REVOKED_AT"|"RENEWAL_ELIGIBILITY"|"ISSUED_AT"|"MANAGED_BY"|"EXPORT_OPTION"|"VALIDATION_METHOD"|"IMPORTED_AT"|"ACME_ENDPOINT_ARN"|"ACME_ACCOUNT_ID"|"CERTIFICATE_KEY_PAIR_ORIGIN",
  SortOrder = "ASCENDING"|"DESCENDING"
)