AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb

Overview

Note:

When making an API call, you may pass PutEventsRequest data as a 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"],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_listArray<Types::Event>

A list of event data from the session.

Returns:



206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 206

class PutEventsRequest < Struct.new(
  :tracking_id,
  :user_id,
  :session_id,
  :event_list)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

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 Recording Events.

Returns:

  • (String)


206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 206

class PutEventsRequest < Struct.new(
  :tracking_id,
  :user_id,
  :session_id,
  :event_list)
  SENSITIVE = []
  include Aws::Structure
end

#tracking_idString

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

Returns:

  • (String)


206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 206

class PutEventsRequest < Struct.new(
  :tracking_id,
  :user_id,
  :session_id,
  :event_list)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

The user associated with the event.

Returns:

  • (String)


206
207
208
209
210
211
212
213
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 206

class PutEventsRequest < Struct.new(
  :tracking_id,
  :user_id,
  :session_id,
  :event_list)
  SENSITIVE = []
  include Aws::Structure
end