Skip to content

CertificateDescription

Source code in docs_src/capo_iot/types/certificate_description.py
class CertificateDescription(TypedDict, closed=True):
    certificate_arn: NotRequired["capo_iot.types.certificate_arn.CertificateArn"]
    """<p>The ARN of the certificate.</p>"""
    certificate_id: NotRequired["capo_iot.types.certificate_id.CertificateId"]
    """<p>The ID of the certificate.</p>"""
    ca_certificate_id: NotRequired["capo_iot.types.certificate_id.CertificateId"]
    """<p>The certificate ID of the CA certificate used to sign this certificate.</p>"""
    status: NotRequired["capo_iot.types.certificate_status.CertificateStatus"]
    """<p>The status of the certificate.</p>"""
    certificate_pem: NotRequired["capo_iot.types.certificate_pem.CertificatePem"]
    """<p>The certificate data, in PEM format.</p>"""
    owned_by: NotRequired["capo_iot.types.aws_account_id.AwsAccountId"]
    """<p>The ID of the Amazon Web Services account that owns the certificate.</p>"""
    previous_owned_by: NotRequired["capo_iot.types.aws_account_id.AwsAccountId"]
    """<p>The ID of the Amazon Web Services account of the previous owner of the certificate.</p>"""
    creation_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The date and time the certificate was created.</p>"""
    last_modified_date: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The date and time the certificate was last modified.</p>"""
    customer_version: NotRequired["capo_iot.types.customer_version.CustomerVersion"]
    """<p>The customer version of the certificate.</p>"""
    transfer_data: NotRequired["capo_iot.types.transfer_data.TransferData"]
    """<p>The transfer data.</p>"""
    generation_id: NotRequired["capo_iot.types.generation_id.GenerationId"]
    """<p>The generation ID of the certificate.</p>"""
    validity: NotRequired["capo_iot.types.certificate_validity.CertificateValidity"]
    """<p>When the certificate is valid.</p>"""
    certificate_mode: NotRequired["capo_iot.types.certificate_mode.CertificateMode"]
    """<p>The mode of the certificate.</p> <p> <code>DEFAULT</code>: A certificate in <code>DEFAULT</code> mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in <code>DEFAULT</code> mode. Devices with certificates in <code>DEFAULT</code> mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.</p> <p> <code>SNI_ONLY</code>: A certificate in <code>SNI_ONLY</code> mode is registered without an issuer CA. Devices with certificates in <code>SNI_ONLY</code> mode must send the SNI extension when connecting to Amazon Web Services IoT Core. </p> <p>For more information about the value for SNI extension, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/transport-security.html">Transport security in IoT</a>.</p>"""

ca_certificate_id instance-attribute

ca_certificate_id: NotRequired[CertificateId]

The certificate ID of the CA certificate used to sign this certificate.

certificate_arn instance-attribute

certificate_arn: NotRequired[CertificateArn]

The ARN of the certificate.

certificate_id instance-attribute

certificate_id: NotRequired[CertificateId]

The ID of the certificate.

certificate_mode instance-attribute

certificate_mode: NotRequired[CertificateMode]

The mode of the certificate.

DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

For more information about the value for SNI extension, see Transport security in IoT.

certificate_pem instance-attribute

certificate_pem: NotRequired[CertificatePem]

The certificate data, in PEM format.

creation_date instance-attribute

creation_date: NotRequired[DateType]

The date and time the certificate was created.

customer_version instance-attribute

customer_version: NotRequired[CustomerVersion]

The customer version of the certificate.

generation_id instance-attribute

generation_id: NotRequired[GenerationId]

The generation ID of the certificate.

last_modified_date instance-attribute

last_modified_date: NotRequired[DateType]

The date and time the certificate was last modified.

owned_by instance-attribute

owned_by: NotRequired[AwsAccountId]

The ID of the Amazon Web Services account that owns the certificate.

previous_owned_by instance-attribute

previous_owned_by: NotRequired[AwsAccountId]

The ID of the Amazon Web Services account of the previous owner of the certificate.

status instance-attribute

status: NotRequired[CertificateStatus]

The status of the certificate.

transfer_data instance-attribute

transfer_data: NotRequired[TransferData]

The transfer data.

validity instance-attribute

validity: NotRequired[CertificateValidity]

When the certificate is valid.