Skip to content

DescribedCertificate

Source code in docs_src/capo_transfer/types/described_certificate.py
class DescribedCertificate(TypedDict, closed=True):
    arn: "capo_transfer.types.arn.Arn"
    """<p>The unique Amazon Resource Name (ARN) for the certificate.</p>"""
    certificate_id: NotRequired["capo_transfer.types.certificate_id.CertificateId"]
    """<p>An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.</p>"""
    usage: NotRequired[
        "capo_transfer.types.certificate_usage_type.CertificateUsageType"
    ]
    """<p>Specifies how this certificate is used. It can be used in the following ways:</p> <ul> <li> <p> <code>SIGNING</code>: For signing AS2 messages</p> </li> <li> <p> <code>ENCRYPTION</code>: For encrypting AS2 messages</p> </li> <li> <p> <code>TLS</code>: For securing AS2 communications sent over HTTPS</p> </li> </ul>"""
    status: NotRequired[
        "capo_transfer.types.certificate_status_type.CertificateStatusType"
    ]
    """<p>A certificate's status can be either <code>ACTIVE</code> or <code>INACTIVE</code>.</p> <p>You can set <code>ActiveDate</code> and <code>InactiveDate</code> in the <code>UpdateCertificate</code> call. If you set values for these parameters, those values are used to determine whether the certificate has a status of <code>ACTIVE</code> or <code>INACTIVE</code>.</p> <p>If you don't set values for <code>ActiveDate</code> and <code>InactiveDate</code>, we use the <code>NotBefore</code> and <code>NotAfter</code> date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.</p>"""
    certificate: NotRequired[
        "capo_transfer.types.certificate_body_type.CertificateBodyType"
    ]
    """<p>The file name for the certificate.</p>"""
    certificate_chain: NotRequired[
        "capo_transfer.types.certificate_chain_type.CertificateChainType"
    ]
    """<p>The list of certificates that make up the chain for the certificate.</p>"""
    active_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>An optional date that specifies when the certificate becomes active. If you do not specify a value, <code>ActiveDate</code> takes the same value as <code>NotBeforeDate</code>, which is specified by the CA. </p>"""
    inactive_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>An optional date that specifies when the certificate becomes inactive. If you do not specify a value, <code>InactiveDate</code> takes the same value as <code>NotAfterDate</code>, which is specified by the CA.</p>"""
    serial: NotRequired["capo_transfer.types.cert_serial.CertSerial"]
    """<p>The serial number for the certificate.</p>"""
    not_before_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>The earliest date that the certificate is valid.</p>"""
    not_after_date: NotRequired["capo_transfer.types.cert_date.CertDate"]
    """<p>The final date that the certificate is valid.</p>"""
    type: NotRequired["capo_transfer.types.certificate_type.CertificateType"]
    """<p>If a private key has been specified for the certificate, its type is <code>CERTIFICATE_WITH_PRIVATE_KEY</code>. If there is no private key, the type is <code>CERTIFICATE</code>.</p>"""
    description: NotRequired["capo_transfer.types.description.Description"]
    """<p>The name or description that's used to identity the certificate. </p>"""
    tags: NotRequired["capo_transfer.types.tags.Tags"]
    """<p>Key-value pairs that can be used to group and search for certificates.</p>"""

active_date instance-attribute

active_date: NotRequired[CertDate]

An optional date that specifies when the certificate becomes active. If you do not specify a value, ActiveDate takes the same value as NotBeforeDate, which is specified by the CA.

arn instance-attribute

arn: Arn

The unique Amazon Resource Name (ARN) for the certificate.

certificate instance-attribute

certificate: NotRequired[CertificateBodyType]

The file name for the certificate.

certificate_chain instance-attribute

certificate_chain: NotRequired[CertificateChainType]

The list of certificates that make up the chain for the certificate.

certificate_id instance-attribute

certificate_id: NotRequired[CertificateId]

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

description instance-attribute

description: NotRequired[Description]

The name or description that's used to identity the certificate.

inactive_date instance-attribute

inactive_date: NotRequired[CertDate]

An optional date that specifies when the certificate becomes inactive. If you do not specify a value, InactiveDate takes the same value as NotAfterDate, which is specified by the CA.

not_after_date instance-attribute

not_after_date: NotRequired[CertDate]

The final date that the certificate is valid.

not_before_date instance-attribute

not_before_date: NotRequired[CertDate]

The earliest date that the certificate is valid.

serial instance-attribute

serial: NotRequired[CertSerial]

The serial number for the certificate.

status instance-attribute

status: NotRequired[CertificateStatusType]

A certificate's status can be either ACTIVE or INACTIVE.

You can set ActiveDate and InactiveDate in the UpdateCertificate call. If you set values for these parameters, those values are used to determine whether the certificate has a status of ACTIVE or INACTIVE.

If you don't set values for ActiveDate and InactiveDate, we use the NotBefore and NotAfter date as specified on the X509 certificate to determine when a certificate is active and when it is inactive.

tags instance-attribute

tags: NotRequired[Tags]

Key-value pairs that can be used to group and search for certificates.

type instance-attribute

type: NotRequired[CertificateType]

If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

usage instance-attribute

usage: NotRequired[CertificateUsageType]

Specifies how this certificate is used. It can be used in the following ways:

  • SIGNING: For signing AS2 messages

  • ENCRYPTION: For encrypting AS2 messages

  • TLS: For securing AS2 communications sent over HTTPS