Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.PersonalizeEvents.Types.Event

Description

Synopsis

data Event = Event' {
- recommendationId :: Maybe Text
- eventValue :: Maybe Double
- itemId :: Maybe Text
- impression :: Maybe (NonEmpty Text)
- eventId :: Maybe Text
- properties :: Maybe Text
- eventType :: Text
- sentAt :: POSIX
}
newEvent :: Text -> UTCTime -> Event
event_recommendationId :: Lens' Event (Maybe Text)
event_eventValue :: Lens' Event (Maybe Double)
event_itemId :: Lens' Event (Maybe Text)
event_impression :: Lens' Event (Maybe (NonEmpty Text))
event_eventId :: Lens' Event (Maybe Text)
event_properties :: Lens' Event (Maybe Text)
event_eventType :: Lens' Event Text
event_sentAt :: Lens' Event UTCTime

Documentation

data Event Source #

Represents user interaction event information sent using the PutEvents API.

See: newEvent smart constructor.

Constructors

Event'

Fields

recommendationId :: Maybe Text
The ID of the recommendation.
eventValue :: Maybe Double
The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
itemId :: Maybe Text
The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
impression :: Maybe (NonEmpty Text)
A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"].
eventId :: Maybe Text
An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.
properties :: Maybe Text
A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.
Each item in the map consists of a key-value pair. For example,
```
{"numberOfRatings": "12"}
```
The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.
eventType :: Text
The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.
sentAt :: POSIX
The timestamp (in Unix time) on the client side when the event occurred.

Instances

Instances details

Eq Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods (==) :: Event -> Event -> Bool # (/=) :: Event -> Event -> Bool #
Read Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods readsPrec :: Int -> ReadS Event # readList :: ReadS [Event] # readPrec :: ReadPrec Event # readListPrec :: ReadPrec [Event] #
Show Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
Generic Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Associated Types type Rep Event :: Type -> Type # Methods from :: Event -> Rep Event x # to :: Rep Event x -> Event #
NFData Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods rnf :: Event -> () #
Hashable Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods hashWithSalt :: Int -> Event -> Int # hash :: Event -> Int #
ToJSON Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event Methods toJSON :: Event -> Value # toEncoding :: Event -> Encoding # toJSONList :: [Event] -> Value # toEncodingList :: [Event] -> Encoding #
type Rep Event Source #
Instance details Defined in Amazonka.PersonalizeEvents.Types.Event type Rep Event = D1 ('MetaData "Event" "Amazonka.PersonalizeEvents.Types.Event" "libZSservicesZSamazonka-personalize-eventsZSamazonka-personalize-events" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "recommendationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "impression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))))) :: ((S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "eventType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sentAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newEvent Source #

Arguments

:: Text	`$sel:eventType:Event'`
-> UTCTime	`$sel:sentAt: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:recommendationId:Event', event_recommendationId - The ID of the recommendation.

$sel:eventValue:Event', event_eventValue - The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

$sel:itemId:Event', event_itemId - The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

$sel:impression:Event', event_impression - A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"].

$sel:eventId:Event', event_eventId - An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

$sel:properties:Event', event_properties - A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

$sel:eventType:Event', event_eventType - The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

$sel:sentAt:Event', event_sentAt - The timestamp (in Unix time) on the client side when the event occurred.

event_recommendationId :: Lens' Event (Maybe Text) Source #

The ID of the recommendation.

event_eventValue :: Lens' Event (Maybe Double) Source #

The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

event_itemId :: Lens' Event (Maybe Text) Source #

The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

event_impression :: Lens' Event (Maybe (NonEmpty Text)) Source #

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"].

event_eventId :: Lens' Event (Maybe Text) Source #

An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

event_properties :: Lens' Event (Maybe Text) Source #

A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

event_eventType :: Lens' Event Text Source #

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

event_sentAt :: Lens' Event UTCTime Source #

The timestamp (in Unix time) on the client side when the event occurred.