personalizeevents/aws.sdk.kotlin.services.personalizeevents.model/ActionInteraction/Builder

Builder

Properties

The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.

eventId

var eventId: String?

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 distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

eventType

var eventType: String?

The type of action interaction event. You can specify Viewed, Taken, and Not Taken event types. For more information about action interaction event type data, see Event type data.

impression

var impression: List<String>?

A list of action IDs that represents the sequence of actions you have shown the user. For example, ["actionId1", "actionId2", "actionId3"]. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the Viewed event type.

properties

var properties: String?

A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.

recommendationId

var recommendationId: String?

The ID of the list of recommendations that contains the action the user interacted with.

sessionId

var sessionId: String?

The ID associated with the user's visit. Your application generates a unique sessionId when a user first visits your website or uses your application.

timestamp

var timestamp: Instant?

The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.

userId

var userId: String?

The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.