Documentation

Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.

See: newCertificateDetail smart constructor.

Create a value of CertificateDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:CertificateDetail', certificateDetail_certificateArn - 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.

$sel:certificateAuthorityArn:CertificateDetail', certificateDetail_certificateAuthorityArn - 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

$sel:createdAt:CertificateDetail', certificateDetail_createdAt - The time at which the certificate was requested.

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

CertificateDetail, certificateDetail_domainValidationOptions - Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

$sel:extendedKeyUsages:CertificateDetail', certificateDetail_extendedKeyUsages - 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).

$sel:failureReason:CertificateDetail', certificateDetail_failureReason - 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.

$sel:importedAt:CertificateDetail', certificateDetail_importedAt - The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

$sel:inUseBy:CertificateDetail', certificateDetail_inUseBy - A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

$sel:issuedAt:CertificateDetail', certificateDetail_issuedAt - The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

$sel:issuer:CertificateDetail', certificateDetail_issuer - The name of the certificate authority that issued and signed the certificate.

$sel:keyAlgorithm:CertificateDetail', certificateDetail_keyAlgorithm - The algorithm that was used to generate the public-private key pair.

$sel:keyUsages:CertificateDetail', certificateDetail_keyUsages - 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.

$sel:notAfter:CertificateDetail', certificateDetail_notAfter - The time after which the certificate is not valid.

$sel:notBefore:CertificateDetail', certificateDetail_notBefore - The time before which the certificate is not valid.

$sel:options:CertificateDetail', certificateDetail_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.

$sel:renewalEligibility:CertificateDetail', certificateDetail_renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

$sel:renewalSummary:CertificateDetail', certificateDetail_renewalSummary - Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.

$sel:revocationReason:CertificateDetail', certificateDetail_revocationReason - The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.

$sel:revokedAt:CertificateDetail', certificateDetail_revokedAt - The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

$sel:serial:CertificateDetail', certificateDetail_serial - The serial number of the certificate.

$sel:signatureAlgorithm:CertificateDetail', certificateDetail_signatureAlgorithm - The algorithm that was used to sign the certificate.

$sel:status:CertificateDetail', certificateDetail_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.

$sel:subject:CertificateDetail', certificateDetail_subject - The name of the entity that is associated with the public key contained in the certificate.

$sel:subjectAlternativeNames:CertificateDetail', certificateDetail_subjectAlternativeNames - 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.

$sel:type':CertificateDetail', certificateDetail_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.

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.

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

The time at which the certificate was requested.

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

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED.

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).

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.

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

A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.

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

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

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

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.

The time after which the certificate is not valid.

The time before which the certificate is not valid.

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.

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

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

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

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

The serial number of the certificate.

The algorithm that was used to sign the certificate.

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.

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

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.

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.