Skip to content

EventDestinationDefinition

Source code in docs_src/capo_pinpoint_email/types/event_destination_definition.py
class EventDestinationDefinition(TypedDict, closed=True):
    enabled: "capo_pinpoint_email.types.enabled.Enabled"
    """<p>If <code>true</code>, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this <code>EventDestinationDefinition</code>.</p> <p>If <code>false</code>, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.</p>"""
    matching_event_types: NotRequired[
        "capo_pinpoint_email.types.event_types.EventTypes"
    ]
    """<p>An array that specifies which events Amazon Pinpoint should send to the destinations in this <code>EventDestinationDefinition</code>.</p>"""
    kinesis_firehose_destination: NotRequired[
        "capo_pinpoint_email.types.kinesis_firehose_destination.KinesisFirehoseDestination"
    ]
    """<p>An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.</p>"""
    cloud_watch_destination: NotRequired[
        "capo_pinpoint_email.types.cloud_watch_destination.CloudWatchDestination"
    ]
    """<p>An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.</p>"""
    sns_destination: NotRequired[
        "capo_pinpoint_email.types.sns_destination.SnsDestination"
    ]
    """<p>An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.</p>"""
    pinpoint_destination: NotRequired[
        "capo_pinpoint_email.types.pinpoint_destination.PinpointDestination"
    ]
    """<p>An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.</p>"""

cloud_watch_destination instance-attribute

cloud_watch_destination: NotRequired[CloudWatchDestination]

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

enabled instance-attribute

enabled: Enabled

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

kinesis_firehose_destination instance-attribute

kinesis_firehose_destination: NotRequired[KinesisFirehoseDestination]

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

matching_event_types instance-attribute

matching_event_types: NotRequired[EventTypes]

An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

pinpoint_destination instance-attribute

pinpoint_destination: NotRequired[PinpointDestination]

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

sns_destination instance-attribute

sns_destination: NotRequired[SnsDestination]

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.