#[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 event_bridge_destination: Option<EventBridgeDestination>,
pub pinpoint_destination: Option<PinpointDestination>,
}
Expand description
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)§
This struct is marked as non-exhaustive
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 theSendEmail
orSendBulkEmail
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 notifications when certain email events occur.
event_bridge_destination: Option<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.
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§
Source§impl EventDestination
impl EventDestination
Sourcepub fn enabled(&self) -> bool
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.
Sourcepub fn matching_event_types(&self) -> &[EventType]
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 theSendEmail
orSendBulkEmail
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.
Sourcepub fn kinesis_firehose_destination(
&self,
) -> Option<&KinesisFirehoseDestination>
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.
Sourcepub fn cloud_watch_destination(&self) -> Option<&CloudWatchDestination>
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.
Sourcepub fn sns_destination(&self) -> Option<&SnsDestination>
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 notifications when certain email events occur.
Sourcepub fn event_bridge_destination(&self) -> Option<&EventBridgeDestination>
pub fn event_bridge_destination(&self) -> Option<&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.
Sourcepub fn pinpoint_destination(&self) -> Option<&PinpointDestination>
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.
Source§impl EventDestination
impl EventDestination
Sourcepub fn builder() -> EventDestinationBuilder
pub fn builder() -> EventDestinationBuilder
Creates a new builder-style object to manufacture EventDestination
.
Trait Implementations§
Source§impl Clone for EventDestination
impl Clone for EventDestination
Source§fn clone(&self) -> EventDestination
fn clone(&self) -> EventDestination
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for EventDestination
impl Debug for EventDestination
Source§impl PartialEq for EventDestination
impl PartialEq for EventDestination
impl StructuralPartialEq for EventDestination
Auto Trait Implementations§
impl Freeze for EventDestination
impl RefUnwindSafe for EventDestination
impl Send for EventDestination
impl Sync for EventDestination
impl Unpin for EventDestination
impl UnwindSafe for EventDestination
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);