Skip to content

/AWS1/CL_SE2EVENTDESTINATION

In the Amazon SES API v2, events include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays. 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.

CONSTRUCTOR

IMPORTING

Required arguments:

IV_NAME TYPE /AWS1/SE2EVENTDESTINATIONNAME /AWS1/SE2EVENTDESTINATIONNAME

A name that identifies the event destination.

IT_MATCHINGEVENTTYPES TYPE /AWS1/CL_SE2EVENTTYPES_W=>TT_EVENTTYPES TT_EVENTTYPES

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

  • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

  • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

  • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

  • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

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

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

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

  • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

  • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

  • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

Optional arguments:

IV_ENABLED TYPE /AWS1/SE2ENABLED /AWS1/SE2ENABLED

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.

IO_KINESISFIREHOSEDST TYPE REF TO /AWS1/CL_SE2KINESISFIREHOSEDST /AWS1/CL_SE2KINESISFIREHOSEDST

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.

IO_CLOUDWATCHDESTINATION TYPE REF TO /AWS1/CL_SE2CLOUDWATCHDST /AWS1/CL_SE2CLOUDWATCHDST

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.

IO_SNSDESTINATION TYPE REF TO /AWS1/CL_SE2SNSDESTINATION /AWS1/CL_SE2SNSDESTINATION

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

IO_EVENTBRIDGEDESTINATION TYPE REF TO /AWS1/CL_SE2EVENTBRIDGEDST /AWS1/CL_SE2EVENTBRIDGEDST

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

IO_PINPOINTDESTINATION TYPE REF TO /AWS1/CL_SE2PINPOINTDST /AWS1/CL_SE2PINPOINTDST

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

Queryable Attributes

Name

A name that identifies the event destination.

Accessible with the following methods

Method Description
GET_NAME() Getter for NAME, with configurable default
ASK_NAME() Getter for NAME w/ exceptions if field has no value
HAS_NAME() Determine if NAME has a value

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.

Accessible with the following methods

Method Description
GET_ENABLED() Getter for ENABLED

MatchingEventTypes

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

  • SEND - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)

  • REJECT - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.

  • BOUNCE - (Hard bounce) The recipient's mail server permanently rejected the email. (Soft bounces are only included when SES fails to deliver the email after retrying for a period of time.)

  • COMPLAINT - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.

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

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

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

  • RENDERING_FAILURE - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail API operations.)

  • DELIVERY_DELAY - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.

  • SUBSCRIPTION - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an unsubscribe link as part of your subscription management.

Accessible with the following methods

Method Description
GET_MATCHINGEVENTTYPES() Getter for MATCHINGEVENTTYPES, with configurable default
ASK_MATCHINGEVENTTYPES() Getter for MATCHINGEVENTTYPES w/ exceptions if field has no
HAS_MATCHINGEVENTTYPES() Determine if MATCHINGEVENTTYPES has a value

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.

Accessible with the following methods

Method Description
GET_KINESISFIREHOSEDST() Getter for KINESISFIREHOSEDESTINATION

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.

Accessible with the following methods

Method Description
GET_CLOUDWATCHDESTINATION() Getter for CLOUDWATCHDESTINATION

SnsDestination

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

Accessible with the following methods

Method Description
GET_SNSDESTINATION() Getter for SNSDESTINATION

EventBridgeDestination

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

Accessible with the following methods

Method Description
GET_EVENTBRIDGEDESTINATION() Getter for EVENTBRIDGEDESTINATION

PinpointDestination

An object that defines an Amazon Pinpoint project destination for email events. You can send email event data to a Amazon Pinpoint project to view metrics using the Transactional Messaging dashboards that are built in to Amazon Pinpoint. For more information, see Transactional Messaging Charts in the Amazon Pinpoint User Guide.

Accessible with the following methods

Method Description
GET_PINPOINTDESTINATION() Getter for PINPOINTDESTINATION

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_EVENTDESTINATIONS

TYPES TT_EVENTDESTINATIONS TYPE STANDARD TABLE OF REF TO /AWS1/CL_SE2EVENTDESTINATION WITH DEFAULT KEY
.