Skip to content

CertificateDetail

Source code in docs_src/capo_acm/types/certificate_detail.py
class CertificateDetail(TypedDict, closed=True):
    certificate_arn: NotRequired["capo_acm.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""
    domain_name: NotRequired["capo_acm.types.domain_name_string.DomainNameString"]
    """<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>"""
    subject_alternative_names: NotRequired["capo_acm.types.domain_list.DomainList"]
    """<p>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. </p>"""
    managed_by: NotRequired[
        "capo_acm.types.certificate_managed_by.CertificateManagedBy"
    ]
    """<p>Identifies the Amazon Web Services service that manages the certificate issued by ACM.</p>"""
    domain_validation_options: NotRequired[
        "capo_acm.types.domain_validation_list.DomainValidationList"
    ]
    """<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>"""
    serial: NotRequired["capo_acm.types.string.String"]
    """<p>The serial number of the certificate.</p>"""
    subject: NotRequired["capo_acm.types.string.String"]
    """<p>The name of the entity that is associated with the public key contained in the certificate.</p>"""
    issuer: NotRequired["capo_acm.types.string.String"]
    """<p>The name of the certificate authority that issued and signed the certificate.</p>"""
    created_at: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The time at which the certificate was requested.</p>"""
    issued_at: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>"""
    imported_at: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The date and time when the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>"""
    status: NotRequired["capo_acm.types.certificate_status.CertificateStatus"]
    """<p>The status of the certificate.</p> <p>A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html">Certificate request fails</a>. 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 <a href="https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html">DNS validation</a> or <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html">Email validation</a>, and try again. If validation succeeds, the certificate enters status ISSUED. </p>"""
    revoked_at: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>"""
    revocation_reason: NotRequired["capo_acm.types.revocation_reason.RevocationReason"]
    """<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>"""
    not_before: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The time before which the certificate is not valid.</p>"""
    not_after: NotRequired["capo_acm.types.t_stamp.TStamp"]
    """<p>The time after which the certificate is not valid.</p>"""
    key_algorithm: NotRequired["capo_acm.types.key_algorithm.KeyAlgorithm"]
    """<p>The algorithm that was used to generate the public-private key pair.</p>"""
    signature_algorithm: NotRequired["capo_acm.types.string.String"]
    """<p>The algorithm that was used to sign the certificate.</p>"""
    in_use_by: NotRequired["capo_acm.types.in_use_list.InUseList"]
    """<p>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. </p>"""
    failure_reason: NotRequired["capo_acm.types.failure_reason.FailureReason"]
    """<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed">Certificate Request Failed</a> in the <i>Certificate Manager User Guide</i>. </p>"""
    type: NotRequired["capo_acm.types.certificate_type.CertificateType"]
    """<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing Certificates</a> in the <i>Certificate Manager User Guide</i>. </p>"""
    renewal_summary: NotRequired["capo_acm.types.renewal_summary.RenewalSummary"]
    """<p>Contains information about the status of ACM's <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html">managed renewal</a> for the certificate. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"""
    key_usages: NotRequired["capo_acm.types.key_usage_list.KeyUsageList"]
    """<p>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.</p>"""
    extended_key_usages: NotRequired[
        "capo_acm.types.extended_key_usage_list.ExtendedKeyUsageList"
    ]
    """<p>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). </p>"""
    certificate_authority_arn: NotRequired["capo_acm.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate. This has the following format: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>"""
    renewal_eligibility: NotRequired[
        "capo_acm.types.renewal_eligibility.RenewalEligibility"
    ]
    """<p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>"""
    options: NotRequired["capo_acm.types.certificate_options.CertificateOptions"]
    """<p>Contains the certificate options. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.</p>"""
    update_summary: NotRequired["capo_acm.types.update_summary.UpdateSummary"]
    """<p>Contains information about the most recent update to the certificate. This field exists only when the certificate type is <code>AMAZON_ISSUED</code> and a certificate update has been requested.</p>"""
    certificate_key_pair_origin: NotRequired[
        "capo_acm.types.certificate_key_pair_origin.CertificateKeyPairOrigin"
    ]
    """<p>The origin of the certificate's key pair.</p>"""
    acme_endpoint_arn: NotRequired["capo_acm.types.arn.Arn"]
    """<p>The ARN of the ACME endpoint used to issue the certificate.</p>"""
    acme_account_id: NotRequired["capo_acm.types.acme_account_id.AcmeAccountId"]
    """<p>The ACME account identifier associated with the certificate.</p>"""

acme_account_id instance-attribute

acme_account_id: NotRequired[AcmeAccountId]

The ACME account identifier associated with the certificate.

acme_endpoint_arn instance-attribute

acme_endpoint_arn: NotRequired[Arn]

The ARN of the ACME endpoint used to issue the certificate.

certificate_arn instance-attribute

certificate_arn: NotRequired[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_authority_arn instance-attribute

certificate_authority_arn: NotRequired[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_key_pair_origin instance-attribute

certificate_key_pair_origin: NotRequired[CertificateKeyPairOrigin]

The origin of the certificate's key pair.

created_at instance-attribute

created_at: NotRequired[TStamp]

The time at which the certificate was requested.

domain_name instance-attribute

domain_name: NotRequired[DomainNameString]

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

domain_validation_options instance-attribute

domain_validation_options: NotRequired[DomainValidationList]

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.

extended_key_usages instance-attribute

extended_key_usages: NotRequired[ExtendedKeyUsageList]

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

failure_reason instance-attribute

failure_reason: NotRequired[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.

imported_at instance-attribute

imported_at: NotRequired[TStamp]

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

in_use_by instance-attribute

in_use_by: NotRequired[InUseList]

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.

issued_at instance-attribute

issued_at: NotRequired[TStamp]

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

issuer instance-attribute

issuer: NotRequired[String]

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

key_algorithm instance-attribute

key_algorithm: NotRequired[KeyAlgorithm]

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

key_usages instance-attribute

key_usages: NotRequired[KeyUsageList]

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.

managed_by instance-attribute

managed_by: NotRequired[CertificateManagedBy]

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

not_after instance-attribute

not_after: NotRequired[TStamp]

The time after which the certificate is not valid.

not_before instance-attribute

not_before: NotRequired[TStamp]

The time before which the certificate is not valid.

options instance-attribute

options: NotRequired[CertificateOptions]

Contains the certificate options. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.

renewal_eligibility instance-attribute

renewal_eligibility: NotRequired[RenewalEligibility]

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

renewal_summary instance-attribute

renewal_summary: NotRequired[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.

revocation_reason instance-attribute

revocation_reason: NotRequired[RevocationReason]

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

revoked_at instance-attribute

revoked_at: NotRequired[TStamp]

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

serial instance-attribute

serial: NotRequired[String]

The serial number of the certificate.

signature_algorithm instance-attribute

signature_algorithm: NotRequired[String]

The algorithm that was used to sign the certificate.

status instance-attribute

status: NotRequired[CertificateStatus]

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.

subject instance-attribute

subject: NotRequired[String]

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

subject_alternative_names instance-attribute

subject_alternative_names: NotRequired[DomainList]

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.

type instance-attribute

type: NotRequired[CertificateType]

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.

update_summary instance-attribute

update_summary: NotRequired[UpdateSummary]

Contains information about the most recent update to the certificate. This field exists only when the certificate type is AMAZON_ISSUED and a certificate update has been requested.