Skip to content

IdentityInfo

Source code in docs_src/capo_pinpoint_email/types/identity_info.py 
13
14
15
16
17
18
19
class IdentityInfo(TypedDict, closed=True):
    identity_type: NotRequired["capo_pinpoint_email.types.identity_type.IdentityType"]
    """<p>The email identity type. The identity type can be one of the following:</p> <ul> <li> <p> <code>EMAIL_ADDRESS</code> – The identity is an email address.</p> </li> <li> <p> <code>DOMAIN</code> – The identity is a domain.</p> </li> <li> <p> <code>MANAGED_DOMAIN</code> – The identity is a domain that is managed by AWS.</p> </li> </ul>"""
    identity_name: NotRequired["capo_pinpoint_email.types.identity.Identity"]
    """<p>The address or domain of the identity.</p>"""
    sending_enabled: "capo_pinpoint_email.types.enabled.Enabled"
    """<p>Indicates whether or not you can send email from the identity.</p> <p>In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.</p>"""

identity_name instance-attribute 

identity_name: NotRequired[Identity]

The address or domain of the identity.

identity_type instance-attribute 

identity_type: NotRequired[IdentityType]

The email identity type. The identity type can be one of the following:

  • EMAIL_ADDRESS – The identity is an email address.

  • DOMAIN – The identity is a domain.

  • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

sending_enabled instance-attribute 

sending_enabled: Enabled

Indicates whether or not you can send email from the identity.

In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.