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.EventDimensions

Description

Documentation

data EventDimensions Source #

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

See: newEventDimensions smart constructor.

Constructors

EventDimensions'

Fields

attributes :: Maybe (HashMap Text AttributeDimension)
One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
eventType :: Maybe SetDimension
The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
metrics :: Maybe (HashMap Text MetricDimension)
One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

Instances

Instances details

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

newEventDimensions :: EventDimensions Source #

Create a value of EventDimensions 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:attributes:EventDimensions', eventDimensions_attributes - One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

$sel:eventType:EventDimensions', eventDimensions_eventType - The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

$sel:metrics:EventDimensions', eventDimensions_metrics - One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

eventDimensions_attributes :: Lens' EventDimensions (Maybe (HashMap Text AttributeDimension)) Source #

One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

eventDimensions_eventType :: Lens' EventDimensions (Maybe SetDimension) Source #

The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.

eventDimensions_metrics :: Lens' EventDimensions (Maybe (HashMap Text MetricDimension)) Source #

One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.