Skip to content

DkimAttributes

Source code in docs_src/capo_sesv2/types/dkim_attributes.py
class DkimAttributes(TypedDict, closed=True):
    signing_enabled: "capo_sesv2.types.enabled.Enabled"
    """<p>If the value is <code>true</code>, then the messages that you send from the identity are signed using DKIM. If the value is <code>false</code>, then the messages that you send from the identity aren't DKIM-signed.</p>"""
    status: NotRequired["capo_sesv2.types.dkim_status.DkimStatus"]
    """<p>Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:</p> <ul> <li> <p> <code>PENDING</code> – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.</p> </li> <li> <p> <code>NOT_STARTED</code> – The DKIM verification process hasn't been initiated for the domain.</p> </li> </ul>"""
    tokens: NotRequired["capo_sesv2.types.dns_token_list.DnsTokenList"]
    """<p>If you used <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a> to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.</p> <p>If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.</p> <p>Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.</p>"""
    signing_hosted_zone: NotRequired["capo_sesv2.types.hosted_zone.HostedZone"]
    """<p>The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication.</p> <p>When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example:</p> <p> <code> selector1._domainkey.yourdomain.com CNAME selector1.<SigningHostedZone> </code> </p> <p> <code> selector2._domainkey.yourdomain.com CNAME selector2.<SigningHostedZone> </code> </p> <p> <code> selector3._domainkey.yourdomain.com CNAME selector3.<SigningHostedZone> </code> </p>"""
    signing_attributes_origin: NotRequired[
        "capo_sesv2.types.dkim_signing_attributes_origin.DkimSigningAttributesOrigin"
    ]
    """<p>A string that indicates how DKIM was configured for the identity. These are the possible values:</p> <ul> <li> <p> <code>AWS_SES</code> – Indicates that DKIM was configured for the identity by using <a href="https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html">Easy DKIM</a>.</p> </li> <li> <p> <code>EXTERNAL</code> – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).</p> </li> <li> <p> <code>AWS_SES_<REGION></code> – Indicates that DKIM was configured for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using <a href="https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-deed.html">Deterministic Easy-DKIM (DEED)</a>. <code><REGION></code> is the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. Amazon SES uses this format for every Amazon Web Services Region in which it supports DEED. For example, a parent identity in <code>us-east-1</code> is reported as <code>AWS_SES_US_EAST_1</code>.</p> </li> </ul>"""
    next_signing_key_length: NotRequired[
        "capo_sesv2.types.dkim_signing_key_length.DkimSigningKeyLength"
    ]
    """<p>[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.</p>"""
    current_signing_key_length: NotRequired[
        "capo_sesv2.types.dkim_signing_key_length.DkimSigningKeyLength"
    ]
    """<p>[Easy DKIM] The key length of the DKIM key pair in use.</p>"""
    last_key_generation_timestamp: NotRequired["capo_sesv2.types.timestamp.Timestamp"]
    """<p>[Easy DKIM] The last time a key pair was generated for this identity.</p>"""

current_signing_key_length instance-attribute

current_signing_key_length: NotRequired[DkimSigningKeyLength]

[Easy DKIM] The key length of the DKIM key pair in use.

last_key_generation_timestamp instance-attribute

last_key_generation_timestamp: NotRequired[Timestamp]

[Easy DKIM] The last time a key pair was generated for this identity.

next_signing_key_length instance-attribute

next_signing_key_length: NotRequired[DkimSigningKeyLength]

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

signing_attributes_origin instance-attribute

signing_attributes_origin: NotRequired[DkimSigningAttributesOrigin]

A string that indicates how DKIM was configured for the identity. These are the possible values:

  • AWS_SES – Indicates that DKIM was configured for the identity by using Easy DKIM.

  • EXTERNAL – Indicates that DKIM was configured for the identity by using Bring Your Own DKIM (BYODKIM).

  • AWS_SES_ – Indicates that DKIM was configured for the identity by replicating the signing attributes of a parent identity in another Amazon Web Services Region, using Deterministic Easy-DKIM (DEED). is the Amazon Web Services Region of the parent identity, in uppercase with each hyphen replaced by an underscore. Amazon SES uses this format for every Amazon Web Services Region in which it supports DEED. For example, a parent identity in us-east-1 is reported as AWS_SES_US_EAST_1.

signing_enabled instance-attribute

signing_enabled: Enabled

If the value is true, then the messages that you send from the identity are signed using DKIM. If the value is false, then the messages that you send from the identity aren't DKIM-signed.

signing_hosted_zone instance-attribute

signing_hosted_zone: NotRequired[HostedZone]

The hosted zone where Amazon SES publishes the DKIM public key TXT records for this email identity. This value indicates the DNS zone that customers must reference when configuring their CNAME records for DKIM authentication.

When configuring DKIM for your domain, create CNAME records in your DNS that point to the selectors in this hosted zone. For example:

selector1._domainkey.yourdomain.com CNAME selector1.

selector2._domainkey.yourdomain.com CNAME selector2.

selector3._domainkey.yourdomain.com CNAME selector3.

status instance-attribute

status: NotRequired[DkimStatus]

Describes whether or not Amazon SES has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

  • PENDING – The verification process was initiated, but Amazon SES hasn't yet detected the DKIM records in the DNS configuration for the domain.

  • SUCCESS – The verification process completed successfully.

  • FAILED – The verification process failed. This typically occurs when Amazon SES fails to find the DKIM records in the DNS configuration of the domain.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon SES from determining the DKIM authentication status of the domain.

  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

tokens instance-attribute

tokens: NotRequired[DnsTokenList]

If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete.

If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key.

Regardless of the DKIM authentication method you use, Amazon SES searches for the appropriate records in the DNS configuration of the domain for up to 72 hours.