Amazonka.PersonalizeEvents.Types

Service Configuration

defaultService :: Service

API version 2018-03-22 of the Amazon Personalize Events SDK configuration.

Errors

_InvalidInputException :: AsError a => Fold a ServiceError

Provide a valid value for the field or parameter.

_ResourceInUseException :: AsError a => Fold a ServiceError

The specified resource is in use.

_ResourceNotFoundException :: AsError a => Fold a ServiceError

Could not find the specified resource.

Event

data Event

Represents user interaction event information sent using the PutEvents API.

See: newEvent smart constructor.

Constructors

Event'

Fields

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

• eventValue :: Maybe Double

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

• impression :: Maybe (NonEmpty (Sensitive Text))

  A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

• itemId :: Maybe (Sensitive Text)

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

• metricAttribution :: Maybe MetricAttribution

  Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

• properties :: Maybe (Sensitive 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.

• recommendationId :: Maybe Text

  The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

  For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

• 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

ToJSON Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

toJSON :: Event -> Value

toEncoding :: Event -> Encoding

toJSONList :: [Event] -> Value

toEncodingList :: [Event] -> Encoding

Generic Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Associated Types

type Rep Event :: Type -> Type

Methods

from :: Event -> Rep Event x

to :: Rep Event x -> Event

Show Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

NFData Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

rnf :: Event -> ()

Eq Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

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

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

Hashable Event

Defined in Amazonka.PersonalizeEvents.Types.Event

Methods

hashWithSalt :: Int -> Event -> Int

hash :: Event -> Int

type Rep Event

Defined in Amazonka.PersonalizeEvents.Types.Event

type Rep Event = D1 ('MetaData "Event" "Amazonka.PersonalizeEvents.Types.Event" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "Event'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "eventValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :*: (S1 ('MetaSel ('Just "impression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty (Sensitive Text)))) :*: S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))) :*: ((S1 ('MetaSel ('Just "metricAttribution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MetricAttribution)) :*: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :*: (S1 ('MetaSel ('Just "recommendationId") '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

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: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:eventValue:Event', event_eventValue - The event value that corresponds to the EVENT_VALUE 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"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

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

$sel:metricAttribution:Event', event_metricAttribution - Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

$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:recommendationId:Event', event_recommendationId - The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

$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_eventId :: Lens' Event (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.

event_eventValue :: Lens' Event (Maybe Double)

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

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

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

event_itemId :: Lens' Event (Maybe Text)

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

event_metricAttribution :: Lens' Event (Maybe MetricAttribution)

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

event_properties :: Lens' Event (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.

event_recommendationId :: Lens' Event (Maybe Text)

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

event_eventType :: Lens' Event 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.

event_sentAt :: Lens' Event UTCTime

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

Item

data Item

Represents item metadata added to an Items dataset using the PutItems API. For more information see Importing Items Incrementally.

See: newItem smart constructor.

Constructors

Item'

Fields

• properties :: Maybe (Sensitive Text)

  A string map of item-specific metadata. Each element 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 schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

• itemId :: Text

  The ID associated with the item.

Instances

ToJSON Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

toJSON :: Item -> Value

toEncoding :: Item -> Encoding

toJSONList :: [Item] -> Value

toEncodingList :: [Item] -> Encoding

Generic Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Associated Types

type Rep Item :: Type -> Type

Methods

from :: Item -> Rep Item x

to :: Rep Item x -> Item

Show Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

NFData Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

rnf :: Item -> ()

Eq Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

(==) :: Item -> Item -> Bool

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

Hashable Item

Defined in Amazonka.PersonalizeEvents.Types.Item

Methods

hashWithSalt :: Int -> Item -> Int

hash :: Item -> Int

type Rep Item

Defined in Amazonka.PersonalizeEvents.Types.Item

type Rep Item = D1 ('MetaData "Item" "Amazonka.PersonalizeEvents.Types.Item" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "Item'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "itemId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newItem

Arguments

:: Text

$sel:itemId:Item'

-> Item

Create a value of Item 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:properties:Item', item_properties - A string map of item-specific metadata. Each element 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 schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

$sel:itemId:Item', item_itemId - The ID associated with the item.

item_properties :: Lens' Item (Maybe Text)

A string map of item-specific metadata. Each element 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 schema for the Items dataset. In the previous example, the numberOfRatings matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (|). For example, \"Horror|Action\".

item_itemId :: Lens' Item Text

The ID associated with the item.

MetricAttribution

data MetricAttribution

Contains information about a metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

See: newMetricAttribution smart constructor.

Constructors

MetricAttribution'

Fields

• eventAttributionSource :: Text

  The source of the event, such as a third party.

Instances

ToJSON MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

toJSON :: MetricAttribution -> Value

toEncoding :: MetricAttribution -> Encoding

toJSONList :: [MetricAttribution] -> Value

toEncodingList :: [MetricAttribution] -> Encoding

Generic MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Associated Types

type Rep MetricAttribution :: Type -> Type

Methods

from :: MetricAttribution -> Rep MetricAttribution x

to :: Rep MetricAttribution x -> MetricAttribution

Read MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

readsPrec :: Int -> ReadS MetricAttribution

readList :: ReadS [MetricAttribution]

readPrec :: ReadPrec MetricAttribution

readListPrec :: ReadPrec [MetricAttribution]

Show MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

showsPrec :: Int -> MetricAttribution -> ShowS

show :: MetricAttribution -> String

showList :: [MetricAttribution] -> ShowS

NFData MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

rnf :: MetricAttribution -> ()

Eq MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

(==) :: MetricAttribution -> MetricAttribution -> Bool

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

Hashable MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

Methods

hashWithSalt :: Int -> MetricAttribution -> Int

hash :: MetricAttribution -> Int

type Rep MetricAttribution

Defined in Amazonka.PersonalizeEvents.Types.MetricAttribution

type Rep MetricAttribution = D1 ('MetaData "MetricAttribution" "Amazonka.PersonalizeEvents.Types.MetricAttribution" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "MetricAttribution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "eventAttributionSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newMetricAttribution

Arguments

:: Text

$sel:eventAttributionSource:MetricAttribution'

-> MetricAttribution

Create a value of MetricAttribution 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:eventAttributionSource:MetricAttribution', metricAttribution_eventAttributionSource - The source of the event, such as a third party.

metricAttribution_eventAttributionSource :: Lens' MetricAttribution Text

The source of the event, such as a third party.

User

data User

Represents user metadata added to a Users dataset using the PutUsers API. For more information see Importing Users Incrementally.

See: newUser smart constructor.

Constructors

User'

Fields

• properties :: Maybe (Sensitive Text)

  A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

  The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

• userId :: Text

  The ID associated with the user.

Instances

ToJSON User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

toJSON :: User -> Value

toEncoding :: User -> Encoding

toJSONList :: [User] -> Value

toEncodingList :: [User] -> Encoding

Generic User

Defined in Amazonka.PersonalizeEvents.Types.User

Associated Types

type Rep User :: Type -> Type

Methods

from :: User -> Rep User x

to :: Rep User x -> User

Show User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

NFData User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

rnf :: User -> ()

Eq User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

(==) :: User -> User -> Bool

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

Hashable User

Defined in Amazonka.PersonalizeEvents.Types.User

Methods

hashWithSalt :: Int -> User -> Int

hash :: User -> Int

type Rep User

Defined in Amazonka.PersonalizeEvents.Types.User

type Rep User = D1 ('MetaData "User" "Amazonka.PersonalizeEvents.Types.User" "amazonka-personalize-events-2.0-Fi47jZEjr1NizLD1LiiPl" 'False) (C1 ('MetaCons "User'" 'PrefixI 'True) (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUser

Arguments

:: Text

$sel:userId:User'

-> User

Create a value of User 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:properties:User', user_properties - A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

$sel:userId:User', user_userId - The ID associated with the user.

user_properties :: Lens' User (Maybe Text)

A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"}.

The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the numberOfVideosWatched matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (|). For example, \"Member|Frequent shopper\".

user_userId :: Lens' User Text

The ID associated with the user.