Skip to content

AwsCertificateManagerCertificateDetails

Source code in docs_src/capo_securityhub/types/aws_certificate_manager_certificate_details.py
class AwsCertificateManagerCertificateDetails(TypedDict, closed=True):
    certificate_authority_arn: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The ARN of the private certificate authority (CA) that will be used to issue the certificate.</p>"""
    created_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the certificate was requested.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    domain_name: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.</p>"""
    domain_validation_options: NotRequired[
        "capo_securityhub.types.aws_certificate_manager_certificate_domain_validation_options.AwsCertificateManagerCertificateDomainValidationOptions"
    ]
    """<p>Contains information about the initial validation of each domain name that occurs as a result of the <code>RequestCertificate</code> request.</p> <p>Only provided if the certificate type is <code>AMAZON_ISSUED</code>.</p>"""
    extended_key_usages: NotRequired[
        "capo_securityhub.types.aws_certificate_manager_certificate_extended_key_usages.AwsCertificateManagerCertificateExtendedKeyUsages"
    ]
    """<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>"""
    failure_reason: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>For a failed certificate request, the reason for the failure.</p> <p>Valid values: <code>NO_AVAILABLE_CONTACTS</code> | <code>ADDITIONAL_VERIFICATION_REQUIRED</code> | <code>DOMAIN_NOT_ALLOWED</code> | <code>INVALID_PUBLIC_DOMAIN</code> | <code>DOMAIN_VALIDATION_DENIED</code> | <code>CAA_ERROR</code> | <code>PCA_LIMIT_EXCEEDED</code> | <code>PCA_INVALID_ARN</code> | <code>PCA_INVALID_STATE</code> | <code>PCA_REQUEST_FAILED</code> | <code>PCA_NAME_CONSTRAINTS_VALIDATION</code> | <code>PCA_RESOURCE_NOT_FOUND</code> | <code>PCA_INVALID_ARGS</code> | <code>PCA_INVALID_DURATION</code> | <code>PCA_ACCESS_DENIED</code> | <code>SLR_NOT_FOUND</code> | <code>OTHER</code> </p>"""
    imported_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the certificate was imported. Provided if the certificate type is <code>IMPORTED</code>.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    in_use_by: NotRequired["capo_securityhub.types.string_list.StringList"]
    """<p>The list of ARNs for the Amazon Web Services resources that use the certificate.</p>"""
    issued_at: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>Indicates when the certificate was issued. Provided if the certificate type is <code>AMAZON_ISSUED</code>.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    issuer: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the certificate authority that issued and signed the certificate.</p>"""
    key_algorithm: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The algorithm that was used to generate the public-private key pair.</p> <p>Valid values: <code>RSA_2048</code> | <code>RSA_1024</code> |<code> RSA_4096</code> | <code>EC_prime256v1</code> | <code>EC_secp384r1</code> | <code>EC_secp521r1</code> </p>"""
    key_usages: NotRequired[
        "capo_securityhub.types.aws_certificate_manager_certificate_key_usages.AwsCertificateManagerCertificateKeyUsages"
    ]
    """<p>A list of key usage X.509 v3 extension objects.</p>"""
    not_after: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The time after which the certificate becomes invalid.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    not_before: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The time before which the certificate is not valid.</p> <p>For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/Welcome.html#timestamps">Timestamps</a>.</p>"""
    options: NotRequired[
        "capo_securityhub.types.aws_certificate_manager_certificate_options.AwsCertificateManagerCertificateOptions"
    ]
    """<p>Provides a value that specifies whether to add the certificate to a transparency log.</p>"""
    renewal_eligibility: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>Whether the certificate is eligible for renewal.</p> <p>Valid values: <code>ELIGIBLE</code> | <code>INELIGIBLE</code> </p>"""
    renewal_summary: NotRequired[
        "capo_securityhub.types.aws_certificate_manager_certificate_renewal_summary.AwsCertificateManagerCertificateRenewalSummary"
    ]
    """<p>Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"""
    serial: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The serial number of the certificate.</p>"""
    signature_algorithm: NotRequired[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ]
    """<p>The algorithm that was used to sign the certificate.</p>"""
    status: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The status of the certificate.</p> <p>Valid values: <code>PENDING_VALIDATION</code> | <code>ISSUED</code> | <code>INACTIVE</code> | <code>EXPIRED</code> | <code>VALIDATION_TIMED_OUT</code> | <code>REVOKED</code> | <code>FAILED</code> </p>"""
    subject: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The name of the entity that is associated with the public key contained in the certificate.</p>"""
    subject_alternative_names: NotRequired[
        "capo_securityhub.types.string_list.StringList"
    ]
    """<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.</p> <p>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>"""
    type: NotRequired["capo_securityhub.types.non_empty_string.NonEmptyString"]
    """<p>The source of the certificate. For certificates that Certificate Manager provides, <code>Type</code> is <code>AMAZON_ISSUED</code>. For certificates that are imported with <code>ImportCertificate</code>, <code>Type</code> is <code>IMPORTED</code>.</p> <p>Valid values: <code>IMPORTED</code> | <code>AMAZON_ISSUED</code> | <code>PRIVATE</code> </p>"""

certificate_authority_arn instance-attribute

certificate_authority_arn: NotRequired[NonEmptyString]

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

created_at instance-attribute

created_at: NotRequired[NonEmptyString]

Indicates when the certificate was requested.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

domain_name instance-attribute

domain_name: NotRequired[NonEmptyString]

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

domain_validation_options instance-attribute

domain_validation_options: NotRequired[
    AwsCertificateManagerCertificateDomainValidationOptions
]

Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

Only provided if the certificate type is AMAZON_ISSUED.

extended_key_usages instance-attribute

extended_key_usages: NotRequired[AwsCertificateManagerCertificateExtendedKeyUsages]

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[NonEmptyString]

For a failed certificate request, the reason for the failure.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

imported_at instance-attribute

imported_at: NotRequired[NonEmptyString]

Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

in_use_by instance-attribute

in_use_by: NotRequired[StringList]

The list of ARNs for the Amazon Web Services resources that use the certificate.

issued_at instance-attribute

issued_at: NotRequired[NonEmptyString]

Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

issuer instance-attribute

issuer: NotRequired[NonEmptyString]

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

key_algorithm instance-attribute

key_algorithm: NotRequired[NonEmptyString]

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

Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

key_usages instance-attribute

A list of key usage X.509 v3 extension objects.

not_after instance-attribute

not_after: NotRequired[NonEmptyString]

The time after which the certificate becomes invalid.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

not_before instance-attribute

not_before: NotRequired[NonEmptyString]

The time before which the certificate is not valid.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

options instance-attribute

Provides a value that specifies whether to add the certificate to a transparency log.

renewal_eligibility instance-attribute

renewal_eligibility: NotRequired[NonEmptyString]

Whether the certificate is eligible for renewal.

Valid values: ELIGIBLE | INELIGIBLE

renewal_summary instance-attribute

renewal_summary: NotRequired[AwsCertificateManagerCertificateRenewalSummary]

Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

serial instance-attribute

serial: NotRequired[NonEmptyString]

The serial number of the certificate.

signature_algorithm instance-attribute

signature_algorithm: NotRequired[NonEmptyString]

The algorithm that was used to sign the certificate.

status instance-attribute

status: NotRequired[NonEmptyString]

The status of the certificate.

Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

subject instance-attribute

subject: NotRequired[NonEmptyString]

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[StringList]

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[NonEmptyString]

The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE