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.Pinpoint.Types.EventFilter

Description

Synopsis

data EventFilter = EventFilter' {
- filterType :: FilterType
- dimensions :: EventDimensions
}
newEventFilter :: FilterType -> EventDimensions -> EventFilter
eventFilter_filterType :: Lens' EventFilter FilterType
eventFilter_dimensions :: Lens' EventFilter EventDimensions

Documentation

data EventFilter Source #

Specifies the settings for an event that causes a campaign to be sent or a journey activity to be performed.

See: newEventFilter smart constructor.

Constructors

EventFilter'

Fields

filterType :: FilterType
The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
dimensions :: EventDimensions
The dimensions for the event filter to use for the campaign or the journey activity.

Instances

Instances details

FromJSON EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods parseJSON :: Value -> Parser EventFilter # parseJSONList :: Value -> Parser [EventFilter] #
ToJSON EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods toJSON :: EventFilter -> Value # toEncoding :: EventFilter -> Encoding # toJSONList :: [EventFilter] -> Value # toEncodingList :: [EventFilter] -> Encoding #
Generic EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Associated Types type Rep EventFilter :: Type -> Type # Methods from :: EventFilter -> Rep EventFilter x # to :: Rep EventFilter x -> EventFilter #
Read EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods readsPrec :: Int -> ReadS EventFilter # readList :: ReadS [EventFilter] # readPrec :: ReadPrec EventFilter # readListPrec :: ReadPrec [EventFilter] #
Show EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods showsPrec :: Int -> EventFilter -> ShowS # show :: EventFilter -> String # showList :: [EventFilter] -> ShowS #
NFData EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods rnf :: EventFilter -> () #
Eq EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods (==) :: EventFilter -> EventFilter -> Bool # (/=) :: EventFilter -> EventFilter -> Bool #
Hashable EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter Methods hashWithSalt :: Int -> EventFilter -> Int # hash :: EventFilter -> Int #
type Rep EventFilter Source #
Instance details Defined in Amazonka.Pinpoint.Types.EventFilter type Rep EventFilter = D1 ('MetaData "EventFilter" "Amazonka.Pinpoint.Types.EventFilter" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "EventFilter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterType) :*: S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EventDimensions)))

newEventFilter Source #

Arguments

:: FilterType	`$sel:filterType:EventFilter'`
-> EventDimensions	`$sel:dimensions:EventFilter'`
-> EventFilter

Create a value of EventFilter 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:filterType:EventFilter', eventFilter_filterType - The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

$sel:dimensions:EventFilter', eventFilter_dimensions - The dimensions for the event filter to use for the campaign or the journey activity.

eventFilter_filterType :: Lens' EventFilter FilterType Source #

The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.

eventFilter_dimensions :: Lens' EventFilter EventDimensions Source #

The dimensions for the event filter to use for the campaign or the journey activity.