Skip to content
AWS for Query.Farm

aws.acm.describe_certificate

Example SQL Queries

SELECT * FROM
aws.acm.describe_certificate
WHERE
"certificate_arn" = 'VALUE';

Description

Returns detailed metadata about the specified ACM certificate.

If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

Table Definition

Column NameColumn Data Type
certificate_arn Required Input Column

The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
certificate

Metadata about an ACM certificate.

STRUCT(
    "certificate_arn" VARCHAR,
    "domain_name" VARCHAR,
    "subject_alternative_names" VARCHAR[],
    "domain_validation_options" STRUCT(
        "domain_name" VARCHAR,
        "validation_emails" VARCHAR[],
        "validation_domain" VARCHAR,
        "validation_status" VARCHAR,
        "resource_record" STRUCT(
            "name" VARCHAR,
            "type" VARCHAR,
            "value" VARCHAR
        ),
        "validation_method" VARCHAR
    )[],
    "serial" VARCHAR,
    "subject" VARCHAR,
    "issuer" VARCHAR,
    "created_at" TIMESTAMP_S,
    "issued_at" TIMESTAMP_S,
    "imported_at" TIMESTAMP_S,
    "status" VARCHAR,
    "revoked_at" TIMESTAMP_S,
    "revocation_reason" VARCHAR,
    "not_before" TIMESTAMP_S,
    "not_after" TIMESTAMP_S,
    "key_algorithm" VARCHAR,
    "signature_algorithm" VARCHAR,
    "in_use_by" VARCHAR[],
    "failure_reason" VARCHAR,
    "type" VARCHAR,
    "renewal_summary" STRUCT(
        "renewal_status" VARCHAR,
        "domain_validation_options" STRUCT(
            "domain_name" VARCHAR,
            "validation_emails" VARCHAR[],
            "validation_domain" VARCHAR,
            "validation_status" VARCHAR,
            "resource_record" STRUCT(
                "name" VARCHAR,
                "type" VARCHAR,
                "value" VARCHAR
            ),
            "validation_method" VARCHAR
        )[],
        "renewal_status_reason" VARCHAR,
        "updated_at" TIMESTAMP_S
    ),
    "key_usages" STRUCT(
        "name" VARCHAR
    )[],
    "extended_key_usages" STRUCT(
        "name" VARCHAR,
        "oid" VARCHAR
    )[],
    "certificate_authority_arn" VARCHAR,
    "renewal_eligibility" VARCHAR,
    "options" STRUCT(
        "certificate_transparency_logging_preference" VARCHAR
    )
)
Show child fields
certificate.certificate_arn

The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

certificate.certificate_authority_arn

The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

certificate.created_at

The time at which the certificate was requested.

certificate.domain_name

The fully qualified domain name for the certificate, such as www.example.com or example.com.

certificate.domain_validation_options[]
Show child fields
certificate.domain_validation_options[].domain_name

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

certificate.domain_validation_options[].resource_record

Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

Show child fields
certificate.domain_validation_options[].resource_record.name

The name of the DNS record to create in your domain. This is supplied by ACM.

certificate.domain_validation_options[].resource_record.type

The type of DNS record. Currently this can be CNAME.

certificate.domain_validation_options[].resource_record.value

The value of the CNAME record to add to your DNS database. This is supplied by ACM.

certificate.domain_validation_options[].validation_domain

The domain name that ACM used to send domain validation emails.

certificate.domain_validation_options[].validation_emails[]
certificate.domain_validation_options[].validation_method

Specifies the domain validation method.

certificate.domain_validation_options[].validation_status

The validation status of the domain name. This can be one of the following values:

  • PENDING_VALIDATION

  • SUCCESS

  • FAILED

certificate.extended_key_usages[]
Show child fields
certificate.extended_key_usages[].name

The name of an Extended Key Usage value.

certificate.extended_key_usages[].oid

An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.

  • 1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)

  • 1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)

  • 1.3.6.1.5.5.7.3.3 (CODE_SIGNING)

  • 1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)

  • 1.3.6.1.5.5.7.3.8 (TIME_STAMPING)

  • 1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)

  • 1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)

  • 1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)

  • 1.3.6.1.5.5.7.3.7 (IPSEC_USER)

certificate.failure_reason

The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.

certificate.imported_at

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

certificate.in_use_by[]
certificate.issued_at

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

certificate.issuer

The name of the certificate authority that issued and signed the certificate.

certificate.key_algorithm

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

certificate.key_usages[]
Show child fields
certificate.key_usages[].name

A string value that contains a Key Usage extension name.

certificate.not_after

The time after which the certificate is not valid.

certificate.not_before

The time before which the certificate is not valid.

certificate.options

Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.

Show child fields
certificate.options.certificate_transparency_logging_preference

You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.

certificate.renewal_eligibility

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

certificate.renewal_summary

Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

Show child fields
certificate.renewal_summary.domain_validation_options[]
Show child fields
certificate.renewal_summary.domain_validation_options[].domain_name

A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.

certificate.renewal_summary.domain_validation_options[].resource_record

Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.

Note: The CNAME information that you need does not include the name of your domain. If you include
 your domain name in the DNS database CNAME record, validation fails.
 For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.

Show child fields
certificate.renewal_summary.domain_validation_options[].resource_record.name

The name of the DNS record to create in your domain. This is supplied by ACM.

certificate.renewal_summary.domain_validation_options[].resource_record.type

The type of DNS record. Currently this can be CNAME.

certificate.renewal_summary.domain_validation_options[].resource_record.value

The value of the CNAME record to add to your DNS database. This is supplied by ACM.

certificate.renewal_summary.domain_validation_options[].validation_domain

The domain name that ACM used to send domain validation emails.

certificate.renewal_summary.domain_validation_options[].validation_emails[]
certificate.renewal_summary.domain_validation_options[].validation_method

Specifies the domain validation method.

certificate.renewal_summary.domain_validation_options[].validation_status

The validation status of the domain name. This can be one of the following values:

  • PENDING_VALIDATION

  • SUCCESS

  • FAILED

certificate.renewal_summary.renewal_status

The status of ACM's managed renewal of the certificate.

certificate.renewal_summary.renewal_status_reason

The reason that a renewal request was unsuccessful.

certificate.renewal_summary.updated_at

The time at which the renewal summary was last updated.

certificate.revocation_reason

The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

certificate.revoked_at

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

certificate.serial

The serial number of the certificate.

certificate.signature_algorithm

The algorithm that was used to sign the certificate.

certificate.status

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.

certificate.subject

The name of the entity that is associated with the public key contained in the certificate.

certificate.subject_alternative_names[]
certificate.type

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.