Amazon Pinpoint Email Service
API Reference (API Version 2018-07-26)

EventDestination

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

Contents

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.

Type: CloudWatchDestination object

Required: No

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.

Type: Boolean

Required: No

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.

Type: KinesisFirehoseDestination object

Required: No

MatchingEventTypes

The types of events that Amazon Pinpoint sends to the specified event destinations.

Type: Array of strings

Valid Values: SEND | REJECT | BOUNCE | COMPLAINT | DELIVERY | OPEN | CLICK | RENDERING_FAILURE

Required: Yes

Name

A name that identifies the event destination.

Type: String

Required: Yes

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.

Type: PinpointDestination object

Required: No

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.

Type: SnsDestination object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: