Documentation

This structure is returned in the response object of ListCertificates action.

See: newCertificateSummary smart constructor.

Create a value of CertificateSummary 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:CertificateSummary', certificateSummary_certificateArn - Amazon Resource Name (ARN) of the certificate. This is of the form:

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

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

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

$sel:domainName:CertificateSummary', certificateSummary_domainName - Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

$sel:exported:CertificateSummary', certificateSummary_exported - Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

$sel:extendedKeyUsages:CertificateSummary', certificateSummary_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:hasAdditionalSubjectAlternativeNames:CertificateSummary', certificateSummary_hasAdditionalSubjectAlternativeNames - When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

$sel:inUse:CertificateSummary', certificateSummary_inUse - Indicates whether the certificate is currently in use by any Amazon Web Services resources.

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

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

$sel:keyUsages:CertificateSummary', certificateSummary_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:CertificateSummary', certificateSummary_notAfter - The time after which the certificate is not valid.

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

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

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

$sel:status:CertificateSummary', certificateSummary_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:subjectAlternativeNameSummaries:CertificateSummary', certificateSummary_subjectAlternativeNameSummaries - 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.

When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

$sel:type':CertificateSummary', certificateSummary_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.

Amazon Resource Name (ARN) of the certificate. This is of the form:

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

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

The time at which the certificate was requested.

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

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

When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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

Indicates whether the certificate is currently in use by any Amazon Web Services resources.

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

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.

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

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

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.

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.

When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

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.