AWS CLI Command Reference

[ aws . acm ]

search-certificates

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 ListCertificates by supporting complex filter statements.

See also: AWS API Documentation

search-certificates is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: Results

Synopsis

  search-certificates
[--filter-statement <value>]
[--sort-by <value>]
[--sort-order <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--filter-statement (tagged union structure)

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

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: And, Or, Not, Filter.

And -> (list)

A list of filter statements that must all be true.

Constraints:

  • min: 1
  • max: 15

(tagged union structure)

A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: And, Or, Not, Filter.

And -> (list)

A list of filter statements that must all be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

Or -> (list)

A list of filter statements where at least one must be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

( … recursive … )Filter -> (tagged union structure)

A single certificate filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CertificateArn, X509AttributeFilter, AcmCertificateMetadataFilter.

CertificateArn -> (string)

Filter by certificate ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

X509AttributeFilter -> (tagged union structure)

Filter by X.509 certificate attributes.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Subject, SubjectAlternativeName, ExtendedKeyUsage, KeyUsage, KeyAlgorithm, SerialNumber, NotAfter, NotBefore.

Subject -> (tagged union structure)

Filter by certificate subject.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CommonName.

CommonName -> (structure)

Filter by common name in the subject.

Value -> (string) [required]

The value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

SubjectAlternativeName -> (tagged union structure)

Filter by subject alternative names.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DnsName.

DnsName -> (structure)

Filter by DNS name in subject alternative names.

Value -> (string) [required]

The DNS name value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

ExtendedKeyUsage -> (string)

Filter by extended key usage.

Possible values:

  • 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 -> (string)

Filter by key usage.

Possible values:

  • DIGITAL_SIGNATURE
  • NON_REPUDIATION
  • KEY_ENCIPHERMENT
  • DATA_ENCIPHERMENT
  • KEY_AGREEMENT
  • CERTIFICATE_SIGNING
  • CRL_SIGNING
  • ENCIPHER_ONLY
  • DECIPHER_ONLY
  • ANY
  • CUSTOM

KeyAlgorithm -> (string)

Filter by key algorithm.

Possible values:

  • RSA_1024
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_prime256v1
  • EC_secp384r1
  • EC_secp521r1

SerialNumber -> (string)

Filter by serial number.

Constraints:

  • min: 2
  • max: 59
  • pattern: [0-9a-f]{2}(:[0-9a-f]{2}){1,19}

NotAfter -> (structure)

Filter by certificate expiration date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

NotBefore -> (structure)

Filter by certificate validity start date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

AcmCertificateMetadataFilter -> (tagged union structure)

Filter by ACM certificate metadata.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Status, RenewalStatus, Type, InUse, Exported, ExportOption, ManagedBy, ValidationMethod.

Status -> (string)

Filter by certificate status.

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED

RenewalStatus -> (string)

Filter by certificate renewal status.

Possible values:

  • PENDING_AUTO_RENEWAL
  • PENDING_VALIDATION
  • SUCCESS
  • FAILED

Type -> (string)

Filter by certificate type.

Possible values:

  • IMPORTED
  • AMAZON_ISSUED
  • PRIVATE

InUse -> (boolean)

Filter by whether the certificate is in use.

Exported -> (boolean)

Filter by whether the certificate has been exported.

ExportOption -> (string)

Filter by certificate export option.

Possible values:

  • ENABLED
  • DISABLED

ManagedBy -> (string)

Filter by the entity that manages the certificate.

Possible values:

  • CLOUDFRONT

ValidationMethod -> (string)

Filter by validation method.

Possible values:

  • EMAIL
  • DNS
  • HTTP

Or -> (list)

A list of filter statements where at least one must be true.

Constraints:

  • min: 1
  • max: 15

(tagged union structure)

A filter statement used to search for certificates. Can contain AND, OR, NOT logical operators or a single filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: And, Or, Not, Filter.

And -> (list)

A list of filter statements that must all be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

Or -> (list)

A list of filter statements where at least one must be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

( … recursive … )Filter -> (tagged union structure)

A single certificate filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CertificateArn, X509AttributeFilter, AcmCertificateMetadataFilter.

CertificateArn -> (string)

Filter by certificate ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

X509AttributeFilter -> (tagged union structure)

Filter by X.509 certificate attributes.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Subject, SubjectAlternativeName, ExtendedKeyUsage, KeyUsage, KeyAlgorithm, SerialNumber, NotAfter, NotBefore.

Subject -> (tagged union structure)

Filter by certificate subject.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CommonName.

CommonName -> (structure)

Filter by common name in the subject.

Value -> (string) [required]

The value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

SubjectAlternativeName -> (tagged union structure)

Filter by subject alternative names.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DnsName.

DnsName -> (structure)

Filter by DNS name in subject alternative names.

Value -> (string) [required]

The DNS name value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

ExtendedKeyUsage -> (string)

Filter by extended key usage.

Possible values:

  • 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 -> (string)

Filter by key usage.

Possible values:

  • DIGITAL_SIGNATURE
  • NON_REPUDIATION
  • KEY_ENCIPHERMENT
  • DATA_ENCIPHERMENT
  • KEY_AGREEMENT
  • CERTIFICATE_SIGNING
  • CRL_SIGNING
  • ENCIPHER_ONLY
  • DECIPHER_ONLY
  • ANY
  • CUSTOM

KeyAlgorithm -> (string)

Filter by key algorithm.

Possible values:

  • RSA_1024
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_prime256v1
  • EC_secp384r1
  • EC_secp521r1

SerialNumber -> (string)

Filter by serial number.

Constraints:

  • min: 2
  • max: 59
  • pattern: [0-9a-f]{2}(:[0-9a-f]{2}){1,19}

NotAfter -> (structure)

Filter by certificate expiration date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

NotBefore -> (structure)

Filter by certificate validity start date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

AcmCertificateMetadataFilter -> (tagged union structure)

Filter by ACM certificate metadata.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Status, RenewalStatus, Type, InUse, Exported, ExportOption, ManagedBy, ValidationMethod.

Status -> (string)

Filter by certificate status.

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED

RenewalStatus -> (string)

Filter by certificate renewal status.

Possible values:

  • PENDING_AUTO_RENEWAL
  • PENDING_VALIDATION
  • SUCCESS
  • FAILED

Type -> (string)

Filter by certificate type.

Possible values:

  • IMPORTED
  • AMAZON_ISSUED
  • PRIVATE

InUse -> (boolean)

Filter by whether the certificate is in use.

Exported -> (boolean)

Filter by whether the certificate has been exported.

ExportOption -> (string)

Filter by certificate export option.

Possible values:

  • ENABLED
  • DISABLED

ManagedBy -> (string)

Filter by the entity that manages the certificate.

Possible values:

  • CLOUDFRONT

ValidationMethod -> (string)

Filter by validation method.

Possible values:

  • EMAIL
  • DNS
  • HTTP

Not -> (tagged union structure)

A filter statement that must not be true.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: And, Or, Not, Filter.

And -> (list)

A list of filter statements that must all be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

Or -> (list)

A list of filter statements where at least one must be true.

Constraints:

  • min: 1
  • max: 15

( … recursive … )

( … recursive … )Filter -> (tagged union structure)

A single certificate filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CertificateArn, X509AttributeFilter, AcmCertificateMetadataFilter.

CertificateArn -> (string)

Filter by certificate ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

X509AttributeFilter -> (tagged union structure)

Filter by X.509 certificate attributes.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Subject, SubjectAlternativeName, ExtendedKeyUsage, KeyUsage, KeyAlgorithm, SerialNumber, NotAfter, NotBefore.

Subject -> (tagged union structure)

Filter by certificate subject.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CommonName.

CommonName -> (structure)

Filter by common name in the subject.

Value -> (string) [required]

The value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

SubjectAlternativeName -> (tagged union structure)

Filter by subject alternative names.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DnsName.

DnsName -> (structure)

Filter by DNS name in subject alternative names.

Value -> (string) [required]

The DNS name value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

ExtendedKeyUsage -> (string)

Filter by extended key usage.

Possible values:

  • 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 -> (string)

Filter by key usage.

Possible values:

  • DIGITAL_SIGNATURE
  • NON_REPUDIATION
  • KEY_ENCIPHERMENT
  • DATA_ENCIPHERMENT
  • KEY_AGREEMENT
  • CERTIFICATE_SIGNING
  • CRL_SIGNING
  • ENCIPHER_ONLY
  • DECIPHER_ONLY
  • ANY
  • CUSTOM

KeyAlgorithm -> (string)

Filter by key algorithm.

Possible values:

  • RSA_1024
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_prime256v1
  • EC_secp384r1
  • EC_secp521r1

SerialNumber -> (string)

Filter by serial number.

Constraints:

  • min: 2
  • max: 59
  • pattern: [0-9a-f]{2}(:[0-9a-f]{2}){1,19}

NotAfter -> (structure)

Filter by certificate expiration date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

NotBefore -> (structure)

Filter by certificate validity start date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

AcmCertificateMetadataFilter -> (tagged union structure)

Filter by ACM certificate metadata.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Status, RenewalStatus, Type, InUse, Exported, ExportOption, ManagedBy, ValidationMethod.

Status -> (string)

Filter by certificate status.

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED

RenewalStatus -> (string)

Filter by certificate renewal status.

Possible values:

  • PENDING_AUTO_RENEWAL
  • PENDING_VALIDATION
  • SUCCESS
  • FAILED

Type -> (string)

Filter by certificate type.

Possible values:

  • IMPORTED
  • AMAZON_ISSUED
  • PRIVATE

InUse -> (boolean)

Filter by whether the certificate is in use.

Exported -> (boolean)

Filter by whether the certificate has been exported.

ExportOption -> (string)

Filter by certificate export option.

Possible values:

  • ENABLED
  • DISABLED

ManagedBy -> (string)

Filter by the entity that manages the certificate.

Possible values:

  • CLOUDFRONT

ValidationMethod -> (string)

Filter by validation method.

Possible values:

  • EMAIL
  • DNS
  • HTTP

Filter -> (tagged union structure)

A single certificate filter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CertificateArn, X509AttributeFilter, AcmCertificateMetadataFilter.

CertificateArn -> (string)

Filter by certificate ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

X509AttributeFilter -> (tagged union structure)

Filter by X.509 certificate attributes.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Subject, SubjectAlternativeName, ExtendedKeyUsage, KeyUsage, KeyAlgorithm, SerialNumber, NotAfter, NotBefore.

Subject -> (tagged union structure)

Filter by certificate subject.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: CommonName.

CommonName -> (structure)

Filter by common name in the subject.

Value -> (string) [required]

The value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

SubjectAlternativeName -> (tagged union structure)

Filter by subject alternative names.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DnsName.

DnsName -> (structure)

Filter by DNS name in subject alternative names.

Value -> (string) [required]

The DNS name value to match against.

Constraints:

  • min: 1
  • max: 256

ComparisonOperator -> (string) [required]

The comparison operator to use.

Possible values:

  • CONTAINS
  • EQUALS

ExtendedKeyUsage -> (string)

Filter by extended key usage.

Possible values:

  • 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 -> (string)

Filter by key usage.

Possible values:

  • DIGITAL_SIGNATURE
  • NON_REPUDIATION
  • KEY_ENCIPHERMENT
  • DATA_ENCIPHERMENT
  • KEY_AGREEMENT
  • CERTIFICATE_SIGNING
  • CRL_SIGNING
  • ENCIPHER_ONLY
  • DECIPHER_ONLY
  • ANY
  • CUSTOM

KeyAlgorithm -> (string)

Filter by key algorithm.

Possible values:

  • RSA_1024
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_prime256v1
  • EC_secp384r1
  • EC_secp521r1

SerialNumber -> (string)

Filter by serial number.

Constraints:

  • min: 2
  • max: 59
  • pattern: [0-9a-f]{2}(:[0-9a-f]{2}){1,19}

NotAfter -> (structure)

Filter by certificate expiration date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

NotBefore -> (structure)

Filter by certificate validity start date. The start date is inclusive.

Start -> (timestamp)

The start of the time range. This value is inclusive.

End -> (timestamp)

The end of the time range. This value is inclusive.

AcmCertificateMetadataFilter -> (tagged union structure)

Filter by ACM certificate metadata.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Status, RenewalStatus, Type, InUse, Exported, ExportOption, ManagedBy, ValidationMethod.

Status -> (string)

Filter by certificate status.

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED

RenewalStatus -> (string)

Filter by certificate renewal status.

Possible values:

  • PENDING_AUTO_RENEWAL
  • PENDING_VALIDATION
  • SUCCESS
  • FAILED

Type -> (string)

Filter by certificate type.

Possible values:

  • IMPORTED
  • AMAZON_ISSUED
  • PRIVATE

InUse -> (boolean)

Filter by whether the certificate is in use.

Exported -> (boolean)

Filter by whether the certificate has been exported.

ExportOption -> (string)

Filter by certificate export option.

Possible values:

  • ENABLED
  • DISABLED

ManagedBy -> (string)

Filter by the entity that manages the certificate.

Possible values:

  • CLOUDFRONT

ValidationMethod -> (string)

Filter by validation method.

Possible values:

  • EMAIL
  • DNS
  • HTTP

JSON Syntax:

{
  "And": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Or": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Filter": {
        "CertificateArn": "string",
        "X509AttributeFilter": {
          "Subject": {
            "CommonName": {
              "Value": "string",
              "ComparisonOperator": "CONTAINS"|"EQUALS"
            }
          },
          "SubjectAlternativeName": {
            "DnsName": {
              "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": {
            "Start": timestamp,
            "End": timestamp
          },
          "NotBefore": {
            "Start": timestamp,
            "End": timestamp
          }
        },
        "AcmCertificateMetadataFilter": {
          "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"
        }
      }
    }
    ...
  ],
  "Or": [
    {
      "And": [
        { ... recursive ... }
        ...
      ],
      "Or": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Filter": {
        "CertificateArn": "string",
        "X509AttributeFilter": {
          "Subject": {
            "CommonName": {
              "Value": "string",
              "ComparisonOperator": "CONTAINS"|"EQUALS"
            }
          },
          "SubjectAlternativeName": {
            "DnsName": {
              "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": {
            "Start": timestamp,
            "End": timestamp
          },
          "NotBefore": {
            "Start": timestamp,
            "End": timestamp
          }
        },
        "AcmCertificateMetadataFilter": {
          "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"
        }
      }
    }
    ...
  ],
  "Not": {
    "And": [
      { ... recursive ... }
      ...
    ],
    "Or": [
      { ... recursive ... }
      ...
    ],
    "Not": { ... recursive ... },
    "Filter": {
      "CertificateArn": "string",
      "X509AttributeFilter": {
        "Subject": {
          "CommonName": {
            "Value": "string",
            "ComparisonOperator": "CONTAINS"|"EQUALS"
          }
        },
        "SubjectAlternativeName": {
          "DnsName": {
            "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": {
          "Start": timestamp,
          "End": timestamp
        },
        "NotBefore": {
          "Start": timestamp,
          "End": timestamp
        }
      },
      "AcmCertificateMetadataFilter": {
        "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"
      }
    }
  },
  "Filter": {
    "CertificateArn": "string",
    "X509AttributeFilter": {
      "Subject": {
        "CommonName": {
          "Value": "string",
          "ComparisonOperator": "CONTAINS"|"EQUALS"
        }
      },
      "SubjectAlternativeName": {
        "DnsName": {
          "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": {
        "Start": timestamp,
        "End": timestamp
      },
      "NotBefore": {
        "Start": timestamp,
        "End": timestamp
      }
    },
    "AcmCertificateMetadataFilter": {
      "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"
    }
  }
}

--sort-by (string)

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.

Possible values:

  • 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

--sort-order (string)

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

Possible values:

  • ASCENDING
  • DESCENDING

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

Results -> (list)

A list of certificate search results containing certificate ARNs, X.509 attributes, and ACM metadata.

(structure)

Contains information about a certificate returned by the SearchCertificates action. This structure includes the certificate ARN, X.509 attributes, and ACM metadata.

CertificateArn -> (string)

The Amazon Resource Name (ARN) of the certificate.

Constraints:

  • min: 20
  • max: 2048
  • pattern: arn:[\w+=/,.@-]+:acm:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=,.@-]+)*

X509Attributes -> (structure)

X.509 certificate attributes such as subject, issuer, and validity period.

Issuer -> (structure)

The distinguished name of the certificate issuer.

CommonName -> (string)

The common name (CN) attribute.

DomainComponents -> (list)

The domain component attributes.

(string)

Country -> (string)

The country (C) attribute.

CustomAttributes -> (list)

A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

(structure)

Defines the X.500 relative distinguished name (RDN).

ObjectIdentifier -> (string)

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Value -> (string)

Specifies the attribute value of relative distinguished name (RDN).

DistinguishedNameQualifier -> (string)

The distinguished name qualifier attribute.

GenerationQualifier -> (string)

The generation qualifier attribute.

GivenName -> (string)

The given name attribute.

Initials -> (string)

The initials attribute.

Locality -> (string)

The locality (L) attribute.

Organization -> (string)

The organization (O) attribute.

OrganizationalUnit -> (string)

The organizational unit (OU) attribute.

Pseudonym -> (string)

The pseudonym attribute.

SerialNumber -> (string)

The serial number attribute.

State -> (string)

The state or province (ST) attribute.

Surname -> (string)

The surname attribute.

Title -> (string)

The title attribute.

Subject -> (structure)

The distinguished name of the certificate subject.

CommonName -> (string)

The common name (CN) attribute.

DomainComponents -> (list)

The domain component attributes.

(string)

Country -> (string)

The country (C) attribute.

CustomAttributes -> (list)

A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

(structure)

Defines the X.500 relative distinguished name (RDN).

ObjectIdentifier -> (string)

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Value -> (string)

Specifies the attribute value of relative distinguished name (RDN).

DistinguishedNameQualifier -> (string)

The distinguished name qualifier attribute.

GenerationQualifier -> (string)

The generation qualifier attribute.

GivenName -> (string)

The given name attribute.

Initials -> (string)

The initials attribute.

Locality -> (string)

The locality (L) attribute.

Organization -> (string)

The organization (O) attribute.

OrganizationalUnit -> (string)

The organizational unit (OU) attribute.

Pseudonym -> (string)

The pseudonym attribute.

SerialNumber -> (string)

The serial number attribute.

State -> (string)

The state or province (ST) attribute.

Surname -> (string)

The surname attribute.

Title -> (string)

The title attribute.

SubjectAlternativeNames -> (list)

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

(tagged union structure)

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280 . Only one of the following naming options should be provided.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: DirectoryName, DnsName, IpAddress, OtherName, RegisteredId, Rfc822Name, UniformResourceIdentifier.

DirectoryName -> (structure)

Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

CommonName -> (string)

The common name (CN) attribute.

DomainComponents -> (list)

The domain component attributes.

(string)

Country -> (string)

The country (C) attribute.

CustomAttributes -> (list)

A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

(structure)

Defines the X.500 relative distinguished name (RDN).

ObjectIdentifier -> (string)

Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).

Value -> (string)

Specifies the attribute value of relative distinguished name (RDN).

DistinguishedNameQualifier -> (string)

The distinguished name qualifier attribute.

GenerationQualifier -> (string)

The generation qualifier attribute.

GivenName -> (string)

The given name attribute.

Initials -> (string)

The initials attribute.

Locality -> (string)

The locality (L) attribute.

Organization -> (string)

The organization (O) attribute.

OrganizationalUnit -> (string)

The organizational unit (OU) attribute.

Pseudonym -> (string)

The pseudonym attribute.

SerialNumber -> (string)

The serial number attribute.

State -> (string)

The state or province (ST) attribute.

Surname -> (string)

The surname attribute.

Title -> (string)

The title attribute.

DnsName -> (string)

Represents GeneralName as a DNS name.

IpAddress -> (string)

Represents GeneralName as an IPv4 or IPv6 address.

OtherName -> (structure)

Represents GeneralName using an OtherName object.

ObjectIdentifier -> (string)

Specifies an OID.

Value -> (string)

Specifies an OID value.

RegisteredId -> (string)

Represents GeneralName as an object identifier (OID).

Rfc822Name -> (string)

Represents GeneralName as an RFC 822 email address.

UniformResourceIdentifier -> (string)

Represents GeneralName as a URI.

ExtendedKeyUsages -> (list)

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

(string)

Possible values:

  • 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 -> (string)

The algorithm that was used to generate the public-private key pair.

Possible values:

  • RSA_1024
  • RSA_2048
  • RSA_3072
  • RSA_4096
  • EC_prime256v1
  • EC_secp384r1
  • EC_secp521r1

KeyUsages -> (list)

A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

(string)

Possible values:

  • DIGITAL_SIGNATURE
  • NON_REPUDIATION
  • KEY_ENCIPHERMENT
  • DATA_ENCIPHERMENT
  • KEY_AGREEMENT
  • CERTIFICATE_SIGNING
  • CRL_SIGNING
  • ENCIPHER_ONLY
  • DECIPHER_ONLY
  • ANY
  • CUSTOM

SerialNumber -> (string)

The serial number assigned by the certificate authority.

Constraints:

  • min: 2
  • max: 59
  • pattern: [0-9a-f]{2}(:[0-9a-f]{2}){1,19}

NotAfter -> (timestamp)

The time after which the certificate is not valid.

NotBefore -> (timestamp)

The time before which the certificate is not valid.

CertificateMetadata -> (tagged union structure)

ACM-specific metadata about the certificate.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AcmCertificateMetadata.

AcmCertificateMetadata -> (structure)

Metadata for an ACM certificate.

CreatedAt -> (timestamp)

The time at which the certificate was requested.

Exported -> (boolean)

Indicates whether the certificate has been exported.

ImportedAt -> (timestamp)

The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED .

InUse -> (boolean)

Indicates whether the certificate is currently in use by an Amazon Web Services service.

IssuedAt -> (timestamp)

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED .

RenewalEligibility -> (string)

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

Possible values:

  • ELIGIBLE
  • INELIGIBLE

RevokedAt -> (timestamp)

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED .

Status -> (string)

The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails . ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation , and try again. If validation succeeds, the certificate enters status ISSUED.

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED

RenewalStatus -> (string)

The renewal status of the certificate.

Possible values:

  • PENDING_AUTO_RENEWAL
  • PENDING_VALIDATION
  • SUCCESS
  • FAILED

Type -> (string)

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED . For certificates that you imported with ImportCertificate , this value is IMPORTED . ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide .

Possible values:

  • IMPORTED
  • AMAZON_ISSUED
  • PRIVATE

ExportOption -> (string)

Indicates whether the certificate can be exported.

Possible values:

  • ENABLED
  • DISABLED

ManagedBy -> (string)

Identifies the Amazon Web Services service that manages the certificate issued by ACM.

Possible values:

  • CLOUDFRONT

ValidationMethod -> (string)

Specifies the domain validation method.

Possible values:

  • EMAIL
  • DNS
  • HTTP

NextToken -> (string)

When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.

Constraints:

  • min: 1
  • max: 10000
  • pattern: [\u0009\u000A\u000D\u0020-\u00FF]*
© Copyright 2026, Amazon Web Services. Created using Sphinx.