Skip to content

GetEmailIdentityResponse

Source code in docs_src/capo_pinpoint_email/types/get_email_identity_response.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class GetEmailIdentityResponse(TypedDict, closed=True):
    identity_type: NotRequired["capo_pinpoint_email.types.identity_type.IdentityType"]
    """<p>The email identity type.</p>"""
    feedback_forwarding_status: "capo_pinpoint_email.types.enabled.Enabled"
    """<p>The feedback forwarding configuration for the identity.</p> <p>If the value is <code>true</code>, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.</p> <p>When you set this value to <code>false</code>, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).</p>"""
    verified_for_sending_status: "capo_pinpoint_email.types.enabled.Enabled"
    """<p>Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the <a href="https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-email-manage-verify.html">Amazon Pinpoint User Guide</a>.</p>"""
    dkim_attributes: NotRequired[
        "capo_pinpoint_email.types.dkim_attributes.DkimAttributes"
    ]
    """<p>An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.</p>"""
    mail_from_attributes: NotRequired[
        "capo_pinpoint_email.types.mail_from_attributes.MailFromAttributes"
    ]
    """<p>An object that contains information about the Mail-From attributes for the email identity.</p>"""
    tags: NotRequired["capo_pinpoint_email.types.tag_list.TagList"]
    """<p>An array of objects that define the tags (keys and values) that are associated with the email identity.</p>"""

dkim_attributes instance-attribute 

dkim_attributes: NotRequired[DkimAttributes]

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

feedback_forwarding_status instance-attribute 

feedback_forwarding_status: Enabled

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

identity_type instance-attribute 

identity_type: NotRequired[IdentityType]

The email identity type.

mail_from_attributes instance-attribute 

mail_from_attributes: NotRequired[MailFromAttributes]

An object that contains information about the Mail-From attributes for the email identity.

tags instance-attribute 

tags: NotRequired[TagList]

An array of objects that define the tags (keys and values) that are associated with the email identity.

verified_for_sending_status instance-attribute 

verified_for_sending_status: Enabled

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.