You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PersonalizeEvents::Types::PutEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PutEventsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  tracking_id: "StringType", # required
  user_id: "UserId",
  session_id: "StringType", # required
  event_list: [ # required
    {
      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"],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#event_list ⇒ Array<Types::Event>

A list of event data from the session.

Returns:

  • (Array<Types::Event>) —

    A list of event data from the session.

#session_id ⇒ String

The session ID associated with the user\'s visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information see event-record-api.

Returns:

  • (String) —

    The session ID associated with the user\'s visit.

#tracking_id ⇒ String

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

Returns:

  • (String) —

    The tracking ID for the event.

#user_id ⇒ String

The user associated with the event.

Returns:

  • (String) —

    The user associated with the event.