class Aws::PersonalizeEvents::Types::Event
Represents user interaction event information sent using the `PutEvents` API.
@note When making an API call, you may pass Event
data as a hash: { event_id: "StringType", event_type: "StringType", # required event_value: 1.0, item_id: "ItemId", properties: "EventPropertiesJSON", sent_at: Time.now, # required recommendation_id: "RecommendationId", impression: ["ItemId"], }
@!attribute [rw] event_id
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. @return [String]
@!attribute [rw] event_type
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. @return [String]
@!attribute [rw] event_value
The event value that corresponds to the `EVENT_VALUE` field of the Interactions schema. @return [Float]
@!attribute [rw] item_id
The item ID key that corresponds to the `ITEM_ID` field of the Interactions schema. @return [String]
@!attribute [rw] 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. @return [String]
@!attribute [rw] sent_at
The timestamp (in Unix time) on the client side when the event occurred. @return [Time]
@!attribute [rw] recommendation_id
The ID of the recommendation. @return [String]
@!attribute [rw] impression
A list of item IDs that represents the sequence of items you have shown the user. For example, `["itemId1", "itemId2", "itemId3"]`. @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Event AWS API Documentation
Constants
- SENSITIVE