Struct aws_sdk_sesv2::types::EventDestination

#[non_exhaustive]
pub struct EventDestination {
    pub name: String,
    pub enabled: bool,
    pub matching_event_types: Vec<EventType>,
    pub kinesis_firehose_destination: Option<KinesisFirehoseDestination>,
    pub cloud_watch_destination: Option<CloudWatchDestination>,
    pub sns_destination: Option<SnsDestination>,
    pub pinpoint_destination: Option<PinpointDestination>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

A name that identifies the event destination.

enabled: bool

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.

matching_event_types: Vec<EventType>

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.

kinesis_firehose_destination: Option<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.

cloud_watch_destination: Option<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.

sns_destination: Option<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.

pinpoint_destination: Option<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.

Implementations

impl EventDestination

pub fn name(&self) -> &str

A name that identifies the event destination.

pub fn enabled(&self) -> bool

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.

pub fn matching_event_types(&self) -> &[EventType]

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.

pub fn kinesis_firehose_destination( &self ) -> Option<&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.

pub fn cloud_watch_destination(&self) -> Option<&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.

pub fn sns_destination(&self) -> Option<&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.

pub fn pinpoint_destination(&self) -> Option<&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.

impl EventDestination

pub fn builder() -> EventDestinationBuilder

Creates a new builder-style object to manufacture EventDestination.

Trait Implementations

impl Clone for EventDestination

fn clone(&self) -> EventDestination

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EventDestination

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EventDestination

fn eq(&self, other: &EventDestination) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EventDestination