/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include 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.See Also:
AWS
* API Reference
A name that identifies the event destination.
*/ inline const Aws::String& GetName() const{ return m_name; } /** *A name that identifies the event destination.
*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *A name that identifies the event destination.
*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *A name that identifies the event destination.
*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *A name that identifies the event destination.
*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *A name that identifies the event destination.
*/ inline EventDestination& WithName(const Aws::String& value) { SetName(value); return *this;} /** *A name that identifies the event destination.
*/ inline EventDestination& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *A name that identifies the event destination.
*/ inline EventDestination& WithName(const char* value) { SetName(value); return *this;} /** *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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline const KinesisFirehoseDestination& GetKinesisFirehoseDestination() const{ return m_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.
*/ inline bool KinesisFirehoseDestinationHasBeenSet() const { return m_kinesisFirehoseDestinationHasBeenSet; } /** *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.
*/ inline void SetKinesisFirehoseDestination(const KinesisFirehoseDestination& value) { m_kinesisFirehoseDestinationHasBeenSet = true; m_kinesisFirehoseDestination = value; } /** *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.
*/ inline void SetKinesisFirehoseDestination(KinesisFirehoseDestination&& value) { m_kinesisFirehoseDestinationHasBeenSet = true; m_kinesisFirehoseDestination = std::move(value); } /** *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.
*/ inline EventDestination& WithKinesisFirehoseDestination(const KinesisFirehoseDestination& value) { SetKinesisFirehoseDestination(value); return *this;} /** *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.
*/ inline EventDestination& WithKinesisFirehoseDestination(KinesisFirehoseDestination&& value) { SetKinesisFirehoseDestination(std::move(value)); return *this;} /** *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.
*/ inline const CloudWatchDestination& GetCloudWatchDestination() const{ return m_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.
*/ inline bool CloudWatchDestinationHasBeenSet() const { return m_cloudWatchDestinationHasBeenSet; } /** *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.
*/ inline void SetCloudWatchDestination(const CloudWatchDestination& value) { m_cloudWatchDestinationHasBeenSet = true; m_cloudWatchDestination = value; } /** *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.
*/ inline void SetCloudWatchDestination(CloudWatchDestination&& value) { m_cloudWatchDestinationHasBeenSet = true; m_cloudWatchDestination = std::move(value); } /** *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.
*/ inline EventDestination& WithCloudWatchDestination(const CloudWatchDestination& value) { SetCloudWatchDestination(value); return *this;} /** *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.
*/ inline EventDestination& WithCloudWatchDestination(CloudWatchDestination&& value) { SetCloudWatchDestination(std::move(value)); return *this;} /** *An object that defines an Amazon SNS destination for email events. You can * use Amazon SNS to send notification when certain email events occur.
*/ inline const SnsDestination& GetSnsDestination() const{ return m_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.
*/ inline bool SnsDestinationHasBeenSet() const { return m_snsDestinationHasBeenSet; } /** *An object that defines an Amazon SNS destination for email events. You can * use Amazon SNS to send notification when certain email events occur.
*/ inline void SetSnsDestination(const SnsDestination& value) { m_snsDestinationHasBeenSet = true; m_snsDestination = value; } /** *An object that defines an Amazon SNS destination for email events. You can * use Amazon SNS to send notification when certain email events occur.
*/ inline void SetSnsDestination(SnsDestination&& value) { m_snsDestinationHasBeenSet = true; m_snsDestination = std::move(value); } /** *An object that defines an Amazon SNS destination for email events. You can * use Amazon SNS to send notification when certain email events occur.
*/ inline EventDestination& WithSnsDestination(const SnsDestination& value) { SetSnsDestination(value); return *this;} /** *An object that defines an Amazon SNS destination for email events. You can * use Amazon SNS to send notification when certain email events occur.
*/ inline EventDestination& WithSnsDestination(SnsDestination&& value) { SetSnsDestination(std::move(value)); return *this;} /** *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.
*/ inline const PinpointDestination& GetPinpointDestination() const{ return m_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.
*/ inline bool PinpointDestinationHasBeenSet() const { return m_pinpointDestinationHasBeenSet; } /** *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.
*/ inline void SetPinpointDestination(const PinpointDestination& value) { m_pinpointDestinationHasBeenSet = true; m_pinpointDestination = value; } /** *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.
*/ inline void SetPinpointDestination(PinpointDestination&& value) { m_pinpointDestinationHasBeenSet = true; m_pinpointDestination = std::move(value); } /** *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.
*/ inline EventDestination& WithPinpointDestination(const PinpointDestination& value) { SetPinpointDestination(value); return *this;} /** *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.
*/ inline EventDestination& WithPinpointDestination(PinpointDestination&& value) { SetPinpointDestination(std::move(value)); return *this;} private: Aws::String m_name; bool m_nameHasBeenSet = false; bool m_enabled; bool m_enabledHasBeenSet = false; Aws::Vector