GetEmailIdentityResponse ¶

class GetEmailIdentityResponse(TypedDict, closed=True):
    identity_type: NotRequired["capo_sesv2.types.identity_type.IdentityType"]
    """<p>The email identity type. Note: the <code>MANAGED_DOMAIN</code> identity type is not supported.</p>"""
    feedback_forwarding_status: "capo_sesv2.types.enabled.Enabled"
    """<p>The feedback forwarding configuration for the identity.</p> <p>If the value is <code>true</code>, you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the <code>Return-Path</code> header of the original email.</p> <p>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 (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).</p>"""
    verified_for_sending_status: "capo_sesv2.types.enabled.Enabled"
    """<p>Specifies whether or not the identity is verified. 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_sesv2.types.dkim_attributes.DkimAttributes"]
    """<p>An object that contains information about the DKIM attributes for the identity.</p>"""
    mail_from_attributes: NotRequired[
        "capo_sesv2.types.mail_from_attributes.MailFromAttributes"
    ]
    """<p>An object that contains information about the Mail-From attributes for the email identity.</p>"""
    policies: NotRequired["capo_sesv2.types.policy_map.PolicyMap"]
    """<p>A map of policy names to policies.</p>"""
    tags: NotRequired["capo_sesv2.types.tag_list.TagList"]
    """<p>An array of objects that define the tags (keys and values) that are associated with the email identity.</p>"""
    configuration_set_name: NotRequired[
        "capo_sesv2.types.configuration_set_name.ConfigurationSetName"
    ]
    """<p>The configuration set used by default when sending from this identity.</p>"""
    verification_status: NotRequired[
        "capo_sesv2.types.verification_status.VerificationStatus"
    ]
    """<p>The verification status of the identity. 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 been able to verify the identity.</p> </li> <li> <p> <code>SUCCESS</code> – The verification process completed successfully.</p> </li> <li> <p> <code>FAILED</code> – The verification process failed.</p> </li> <li> <p> <code>TEMPORARY_FAILURE</code> – A temporary issue is preventing Amazon SES from determining the verification status of the identity.</p> </li> <li> <p> <code>NOT_STARTED</code> – The verification process hasn't been initiated for the identity.</p> </li> </ul>"""
    verification_info: NotRequired[
        "capo_sesv2.types.verification_info.VerificationInfo"
    ]
    """<p>An object that contains additional information about the verification status for the identity.</p>"""