Skip to content

EventDestination

Source code in docs_src/capo_ses/types/event_destination.py
class EventDestination(TypedDict, closed=True):
    name: "capo_ses.types.event_destination_name.EventDestinationName"
    """<p>The name of the event destination. The name must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain 64 characters or fewer.</p> </li> </ul>"""
    enabled: "capo_ses.types.enabled.Enabled"
    """<p>Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to <code>true</code> to enable publishing to this destination; set to <code>false</code> to prevent publishing to this destination. The default value is <code>false</code>.</p>"""
    matching_event_types: "capo_ses.types.event_types.EventTypes"
    """<p>The type of email sending events to publish to the event destination.</p> <ul> <li> <p> <code>send</code> - The call was successful and Amazon SES is attempting to deliver the email.</p> </li> <li> <p> <code>reject</code> - Amazon SES determined that the email contained a virus and rejected it.</p> </li> <li> <p> <code>bounce</code> - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.</p> </li> <li> <p> <code>complaint</code> - The recipient marked the email as spam.</p> </li> <li> <p> <code>delivery</code> - Amazon SES successfully delivered the email to the recipient's mail server.</p> </li> <li> <p> <code>open</code> - The recipient received the email and opened it in their email client.</p> </li> <li> <p> <code>click</code> - The recipient clicked one or more links in the email.</p> </li> <li> <p> <code>renderingFailure</code> - Amazon SES did not send the email because of a template rendering issue.</p> </li> </ul>"""
    kinesis_firehose_destination: NotRequired[
        "capo_ses.types.kinesis_firehose_destination.KinesisFirehoseDestination"
    ]
    """<p>An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.</p>"""
    cloud_watch_destination: NotRequired[
        "capo_ses.types.cloud_watch_destination.CloudWatchDestination"
    ]
    """<p>An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.</p>"""
    sns_destination: NotRequired["capo_ses.types.sns_destination.SNSDestination"]
    """<p>An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.</p>"""

cloud_watch_destination instance-attribute

cloud_watch_destination: NotRequired[CloudWatchDestination]

An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

enabled instance-attribute

enabled: Enabled

Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

kinesis_firehose_destination instance-attribute

kinesis_firehose_destination: NotRequired[KinesisFirehoseDestination]

An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

matching_event_types instance-attribute

matching_event_types: EventTypes

The type of email sending events to publish to the event destination.

  • send - The call was successful and Amazon SES is attempting to deliver the email.

  • reject - Amazon SES determined that the email contained a virus and rejected it.

  • bounce - The recipient's mail server permanently rejected the email. This corresponds to a hard bounce.

  • complaint - The recipient marked the email as spam.

  • delivery - Amazon SES successfully delivered the email to the recipient's mail server.

  • open - The recipient received the email and opened it in their email client.

  • click - The recipient clicked one or more links in the email.

  • renderingFailure - Amazon SES did not send the email because of a template rendering issue.

name instance-attribute

The name of the event destination. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Contain 64 characters or fewer.

sns_destination instance-attribute

sns_destination: NotRequired[SNSDestination]

An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.