Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.PinpointEmail.Types.EventDestination

Description

Synopsis

data EventDestination = EventDestination' {
- cloudWatchDestination :: Maybe CloudWatchDestination
- enabled :: Maybe Bool
- kinesisFirehoseDestination :: Maybe KinesisFirehoseDestination
- pinpointDestination :: Maybe PinpointDestination
- snsDestination :: Maybe SnsDestination
- name :: Text
- matchingEventTypes :: [EventType]
}
newEventDestination :: Text -> EventDestination
eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination)
eventDestination_enabled :: Lens' EventDestination (Maybe Bool)
eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination)
eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination)
eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination)
eventDestination_name :: Lens' EventDestination Text
eventDestination_matchingEventTypes :: Lens' EventDestination [EventType]

Documentation

data EventDestination Source #

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. 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: newEventDestination smart constructor.

Constructors

EventDestination'

Fields

cloudWatchDestination :: Maybe 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.
enabled :: Maybe 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.
kinesisFirehoseDestination :: Maybe 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.
pinpointDestination :: Maybe PinpointDestination
An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.
snsDestination :: Maybe 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.
name :: Text
A name that identifies the event destination.
matchingEventTypes :: [EventType]
The types of events that Amazon Pinpoint sends to the specified event destinations.

Instances

Instances details

FromJSON EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods parseJSON :: Value -> Parser EventDestination # parseJSONList :: Value -> Parser [EventDestination] #
Generic EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Associated Types type Rep EventDestination :: Type -> Type # Methods from :: EventDestination -> Rep EventDestination x # to :: Rep EventDestination x -> EventDestination #
Read EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods readsPrec :: Int -> ReadS EventDestination # readList :: ReadS [EventDestination] # readPrec :: ReadPrec EventDestination # readListPrec :: ReadPrec [EventDestination] #
Show EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods showsPrec :: Int -> EventDestination -> ShowS # show :: EventDestination -> String # showList :: [EventDestination] -> ShowS #
NFData EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods rnf :: EventDestination -> () #
Eq EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods (==) :: EventDestination -> EventDestination -> Bool # (/=) :: EventDestination -> EventDestination -> Bool #
Hashable EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination Methods hashWithSalt :: Int -> EventDestination -> Int # hash :: EventDestination -> Int #
type Rep EventDestination Source #
Instance details Defined in Amazonka.PinpointEmail.Types.EventDestination type Rep EventDestination = D1 ('MetaData "EventDestination" "Amazonka.PinpointEmail.Types.EventDestination" "amazonka-pinpoint-email-2.0-EgVsRBIHQXMGA9Xbyu2BvI" 'False) (C1 ('MetaCons "EventDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudWatchDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchDestination)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "kinesisFirehoseDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisFirehoseDestination)))) :: ((S1 ('MetaSel ('Just "pinpointDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PinpointDestination)) :: S1 ('MetaSel ('Just "snsDestination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SnsDestination))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "matchingEventTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [EventType])))))

newEventDestination Source #

Arguments

:: Text	`$sel:name:EventDestination'`
-> EventDestination

Create a value of EventDestination with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cloudWatchDestination:EventDestination', eventDestination_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.

$sel:enabled:EventDestination', eventDestination_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.

$sel:kinesisFirehoseDestination:EventDestination', eventDestination_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.

$sel:pinpointDestination:EventDestination', eventDestination_pinpointDestination - An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

$sel:snsDestination:EventDestination', eventDestination_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.

$sel:name:EventDestination', eventDestination_name - A name that identifies the event destination.

$sel:matchingEventTypes:EventDestination', eventDestination_matchingEventTypes - The types of events that Amazon Pinpoint sends to the specified event destinations.

eventDestination_cloudWatchDestination :: Lens' EventDestination (Maybe CloudWatchDestination) Source #

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.

eventDestination_enabled :: Lens' EventDestination (Maybe Bool) Source #

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.

eventDestination_kinesisFirehoseDestination :: Lens' EventDestination (Maybe KinesisFirehoseDestination) Source #

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.

eventDestination_pinpointDestination :: Lens' EventDestination (Maybe PinpointDestination) Source #

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

eventDestination_snsDestination :: Lens' EventDestination (Maybe SnsDestination) Source #

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

eventDestination_name :: Lens' EventDestination Text Source #

A name that identifies the event destination.

eventDestination_matchingEventTypes :: Lens' EventDestination [EventType] Source #

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