Struct aws_sdk_sesv2::types::builders::EventDestinationBuilder
source · #[non_exhaustive]pub struct EventDestinationBuilder { /* private fields */ }
Expand description
A builder for EventDestination
.
Implementations§
source§impl EventDestinationBuilder
impl EventDestinationBuilder
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A name that identifies the event destination.
This field is required.sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A name that identifies the event destination.
sourcepub fn enabled(self, input: bool) -> Self
pub fn enabled(self, input: bool) -> Self
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 set_enabled(self, input: Option<bool>) -> Self
pub fn set_enabled(self, input: Option<bool>) -> Self
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 get_enabled(&self) -> &Option<bool>
pub fn get_enabled(&self) -> &Option<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, input: EventType) -> Self
pub fn matching_event_types(self, input: EventType) -> Self
Appends an item to matching_event_types
.
To override the contents of this collection use set_matching_event_types
.
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 theSendTemplatedEmail
orSendBulkTemplatedEmail
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 set_matching_event_types(self, input: Option<Vec<EventType>>) -> Self
pub fn set_matching_event_types(self, input: Option<Vec<EventType>>) -> Self
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 theSendTemplatedEmail
orSendBulkTemplatedEmail
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 get_matching_event_types(&self) -> &Option<Vec<EventType>>
pub fn get_matching_event_types(&self) -> &Option<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 theSendTemplatedEmail
orSendBulkTemplatedEmail
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,
input: KinesisFirehoseDestination,
) -> Self
pub fn kinesis_firehose_destination( self, input: KinesisFirehoseDestination, ) -> Self
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 set_kinesis_firehose_destination(
self,
input: Option<KinesisFirehoseDestination>,
) -> Self
pub fn set_kinesis_firehose_destination( self, input: Option<KinesisFirehoseDestination>, ) -> Self
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 get_kinesis_firehose_destination(
&self,
) -> &Option<KinesisFirehoseDestination>
pub fn get_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, input: CloudWatchDestination) -> Self
pub fn cloud_watch_destination(self, input: CloudWatchDestination) -> Self
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 set_cloud_watch_destination(
self,
input: Option<CloudWatchDestination>,
) -> Self
pub fn set_cloud_watch_destination( self, input: Option<CloudWatchDestination>, ) -> Self
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 get_cloud_watch_destination(&self) -> &Option<CloudWatchDestination>
pub fn get_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, input: SnsDestination) -> Self
pub fn sns_destination(self, input: SnsDestination) -> Self
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 set_sns_destination(self, input: Option<SnsDestination>) -> Self
pub fn set_sns_destination(self, input: Option<SnsDestination>) -> Self
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 get_sns_destination(&self) -> &Option<SnsDestination>
pub fn get_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, input: EventBridgeDestination) -> Self
pub fn event_bridge_destination(self, input: EventBridgeDestination) -> Self
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 set_event_bridge_destination(
self,
input: Option<EventBridgeDestination>,
) -> Self
pub fn set_event_bridge_destination( self, input: Option<EventBridgeDestination>, ) -> Self
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 get_event_bridge_destination(&self) -> &Option<EventBridgeDestination>
pub fn get_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, input: PinpointDestination) -> Self
pub fn pinpoint_destination(self, input: PinpointDestination) -> Self
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.
sourcepub fn set_pinpoint_destination(
self,
input: Option<PinpointDestination>,
) -> Self
pub fn set_pinpoint_destination( self, input: Option<PinpointDestination>, ) -> Self
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.
sourcepub fn get_pinpoint_destination(&self) -> &Option<PinpointDestination>
pub fn get_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.
sourcepub fn build(self) -> Result<EventDestination, BuildError>
pub fn build(self) -> Result<EventDestination, BuildError>
Consumes the builder and constructs a EventDestination
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for EventDestinationBuilder
impl Clone for EventDestinationBuilder
source§fn clone(&self) -> EventDestinationBuilder
fn clone(&self) -> EventDestinationBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for EventDestinationBuilder
impl Debug for EventDestinationBuilder
source§impl Default for EventDestinationBuilder
impl Default for EventDestinationBuilder
source§fn default() -> EventDestinationBuilder
fn default() -> EventDestinationBuilder
source§impl PartialEq for EventDestinationBuilder
impl PartialEq for EventDestinationBuilder
source§fn eq(&self, other: &EventDestinationBuilder) -> bool
fn eq(&self, other: &EventDestinationBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for EventDestinationBuilder
Auto Trait Implementations§
impl Freeze for EventDestinationBuilder
impl RefUnwindSafe for EventDestinationBuilder
impl Send for EventDestinationBuilder
impl Sync for EventDestinationBuilder
impl Unpin for EventDestinationBuilder
impl UnwindSafe for EventDestinationBuilder
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> 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 more