Amazonka.Pinpoint.Types.Event

Documentation

data Event

Specifies information about an event that reports data to Amazon Pinpoint.

See: newEvent smart constructor.

Constructors

Event'

Fields

• appPackageName :: Maybe Text

  The package name of the app that's recording the event.

• appTitle :: Maybe Text

  The title of the app that's recording the event.

• appVersionCode :: Maybe Text

  The version number of the app that's recording the event.

• attributes :: Maybe (HashMap Text Text)

  One or more custom attributes that are associated with the event.

• clientSdkVersion :: Maybe Text

  The version of the SDK that's running on the client device.

• metrics :: Maybe (HashMap Text Double)

  One or more custom metrics that are associated with the event.

• sdkName :: Maybe Text

  The name of the SDK that's being used to record the event.

• session :: Maybe Session

  Information about the session in which the event occurred.

• eventType :: Text

  The name of the event.

• timestamp :: Text

  The date and time, in ISO 8601 format, when the event occurred.

Instances

ToJSON Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

Generic Event

Defined in Amazonka.Pinpoint.Types.Event

Associated Types

type Rep Event :: Type -> Type

Methods

from :: Event -> Rep Event x

to :: Rep Event x -> Event

Read Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

readsPrec :: Int -> ReadS Event

readList :: ReadS [Event]

readPrec :: ReadPrec Event

readListPrec :: ReadPrec [Event]

Show Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

NFData Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

rnf :: Event -> ()

Eq Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

(==) :: Event -> Event -> Bool

(/=) :: Event -> Event -> Bool

Hashable Event

Defined in Amazonka.Pinpoint.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int

hash :: Event -> Int

type Rep Event

Defined in Amazonka.Pinpoint.Types.Event

type Rep Event = D1 ('MetaData "Event" "Amazonka.Pinpoint.Types.Event" "amazonka-pinpoint-2.0-GBFs9S7wa7bFiDe66NqAzt" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "appPackageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "appTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "appVersionCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "clientSdkVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "metrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Double))) :*: S1 ('MetaSel ('Just "sdkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "session") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Session)) :*: (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newEvent

Arguments

:: Text

$sel:eventType:Event'

-> Text

$sel:timestamp:Event'

-> Event

Create a value of Event 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:appPackageName:Event', event_appPackageName - The package name of the app that's recording the event.

$sel:appTitle:Event', event_appTitle - The title of the app that's recording the event.

$sel:appVersionCode:Event', event_appVersionCode - The version number of the app that's recording the event.

$sel:attributes:Event', event_attributes - One or more custom attributes that are associated with the event.

$sel:clientSdkVersion:Event', event_clientSdkVersion - The version of the SDK that's running on the client device.

$sel:metrics:Event', event_metrics - One or more custom metrics that are associated with the event.

$sel:sdkName:Event', event_sdkName - The name of the SDK that's being used to record the event.

$sel:session:Event', event_session - Information about the session in which the event occurred.

$sel:eventType:Event', event_eventType - The name of the event.

$sel:timestamp:Event', event_timestamp - The date and time, in ISO 8601 format, when the event occurred.

event_appPackageName :: Lens' Event (Maybe Text)

The package name of the app that's recording the event.

event_appTitle :: Lens' Event (Maybe Text)

The title of the app that's recording the event.

event_appVersionCode :: Lens' Event (Maybe Text)

The version number of the app that's recording the event.

event_attributes :: Lens' Event (Maybe (HashMap Text Text))

One or more custom attributes that are associated with the event.

event_clientSdkVersion :: Lens' Event (Maybe Text)

The version of the SDK that's running on the client device.

event_metrics :: Lens' Event (Maybe (HashMap Text Double))

One or more custom metrics that are associated with the event.

event_sdkName :: Lens' Event (Maybe Text)

The name of the SDK that's being used to record the event.

event_session :: Lens' Event (Maybe Session)

Information about the session in which the event occurred.

event_eventType :: Lens' Event Text

The name of the event.

event_timestamp :: Lens' Event Text

The date and time, in ISO 8601 format, when the event occurred.