aws-sdk-personalizeevents 1.38.0 → 1.39.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 357b75ca275768e87e923193db7cb82b9a64e28e02fcbec1608f3d27f874fccc
4
- data.tar.gz: a78fd96e224757b70319e1f71d65a6a8d443be4329ed17313b412961a0b7a86b
3
+ metadata.gz: d7716f86fdbfc145ede7e4c37f225d5b15137d1e02f0b3c6ed53f1780f6b8069
4
+ data.tar.gz: 8e2ad4a338aa093bada89b20460ae7d83bc1e7bcc933ad9d5c03034c7e7f1848
5
5
  SHA512:
6
- metadata.gz: 1888cba91dda6fd0793142f72012172a8881a35f0ef8763c88af6c216b6b814e088f139ddd72731b0ec2902b5cbaa0d7113512044283906ced487c9396b02040
7
- data.tar.gz: 1be66f935271c474841fb917ef9e5659281829c8a8006ac450e688d5f09ee4f3af57d766d871d02eea90e3b6684058f3bdd626eb39d1a55b6c4d5f06af18f632
6
+ metadata.gz: 7e461ce7b6dfcb9d3df1476c6150c0061a0b9a6dbcd94a1f4b2425d1f593e62d479f27a908c2c3abb083292dcd643d3eadf25aa010f822ebe167dcfc68664f63
7
+ data.tar.gz: 9067d10e5a02e62f4b437a3b1bc8669c33733e0c4cae7f3927813b5e255082aa2c8556ac78cd1933dd0cc5fa324e024aa04447893abdd4a8abc4a12f55bab2de
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.39.0 (2023-11-27)
5
+ ------------------
6
+
7
+ * Feature - This release enables PutActions and PutActionInteractions
8
+
4
9
  1.38.0 (2023-11-22)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.38.0
1
+ 1.39.0
@@ -388,12 +388,106 @@ module Aws::PersonalizeEvents
388
388
 
389
389
  # @!group API Operations
390
390
 
391
- # Records user interaction event data. For more information see
392
- # [Recording Events][1].
391
+ # Records action interaction event data. An *action interaction* event
392
+ # is an interaction between a user and an *action*. For example, a user
393
+ # taking an action, such a enrolling in a membership program or
394
+ # downloading your app.
393
395
  #
396
+ # For more information about recording action interactions, see
397
+ # [Recording action interaction events][1]. For more information about
398
+ # actions in an Actions dataset, see [Actions dataset][2].
394
399
  #
395
400
  #
396
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html
401
+ #
402
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-action-interaction-events.html
403
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/actions-datasets.html
404
+ #
405
+ # @option params [required, String] :tracking_id
406
+ # The ID of your action interaction event tracker. When you create an
407
+ # Action interactions dataset, Amazon Personalize creates an action
408
+ # interaction event tracker for you. For more information, see [Action
409
+ # interaction event tracker ID][1].
410
+ #
411
+ #
412
+ #
413
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html
414
+ #
415
+ # @option params [required, Array<Types::ActionInteraction>] :action_interactions
416
+ # A list of action interaction events from the session.
417
+ #
418
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
419
+ #
420
+ # @example Request syntax with placeholder values
421
+ #
422
+ # resp = client.put_action_interactions({
423
+ # tracking_id: "StringType", # required
424
+ # action_interactions: [ # required
425
+ # {
426
+ # action_id: "ActionId", # required
427
+ # user_id: "UserId",
428
+ # session_id: "StringType", # required
429
+ # timestamp: Time.now, # required
430
+ # event_type: "StringType", # required
431
+ # event_id: "StringType",
432
+ # recommendation_id: "RecommendationId",
433
+ # impression: ["ActionId"],
434
+ # properties: "ActionInteractionProperties",
435
+ # },
436
+ # ],
437
+ # })
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutActionInteractions AWS API Documentation
440
+ #
441
+ # @overload put_action_interactions(params = {})
442
+ # @param [Hash] params ({})
443
+ def put_action_interactions(params = {}, options = {})
444
+ req = build_request(:put_action_interactions, params)
445
+ req.send_request(options)
446
+ end
447
+
448
+ # Adds one or more actions to an Actions dataset. For more information
449
+ # see [Importing actions individually][1].
450
+ #
451
+ #
452
+ #
453
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html
454
+ #
455
+ # @option params [required, String] :dataset_arn
456
+ # The Amazon Resource Name (ARN) of the Actions dataset you are adding
457
+ # the action or actions to.
458
+ #
459
+ # @option params [required, Array<Types::Action>] :actions
460
+ # A list of action data.
461
+ #
462
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
463
+ #
464
+ # @example Request syntax with placeholder values
465
+ #
466
+ # resp = client.put_actions({
467
+ # dataset_arn: "Arn", # required
468
+ # actions: [ # required
469
+ # {
470
+ # action_id: "StringType", # required
471
+ # properties: "ActionProperties",
472
+ # },
473
+ # ],
474
+ # })
475
+ #
476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutActions AWS API Documentation
477
+ #
478
+ # @overload put_actions(params = {})
479
+ # @param [Hash] params ({})
480
+ def put_actions(params = {}, options = {})
481
+ req = build_request(:put_actions, params)
482
+ req.send_request(options)
483
+ end
484
+
485
+ # Records item interaction event data. For more information see
486
+ # [Recording item interaction events][1].
487
+ #
488
+ #
489
+ #
490
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html
397
491
  #
398
492
  # @option params [required, String] :tracking_id
399
493
  # The tracking ID for the event. The ID is generated by a call to the
@@ -411,11 +505,11 @@ module Aws::PersonalizeEvents
411
505
  # generates the sessionId when a user first visits your website or uses
412
506
  # your application. Amazon Personalize uses the sessionId to associate
413
507
  # events with the user before they log in. For more information, see
414
- # [Recording Events][1].
508
+ # [Recording item interaction events][1].
415
509
  #
416
510
  #
417
511
  #
418
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html
512
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html
419
513
  #
420
514
  # @option params [required, Array<Types::Event>] :event_list
421
515
  # A list of event data from the session.
@@ -455,7 +549,7 @@ module Aws::PersonalizeEvents
455
549
  end
456
550
 
457
551
  # Adds one or more items to an Items dataset. For more information see
458
- # [Importing Items Incrementally][1].
552
+ # [Importing items individually][1].
459
553
  #
460
554
  #
461
555
  #
@@ -492,7 +586,7 @@ module Aws::PersonalizeEvents
492
586
  end
493
587
 
494
588
  # Adds one or more users to a Users dataset. For more information see
495
- # [Importing Users Incrementally][1].
589
+ # [Importing users individually][1].
496
590
  #
497
591
  #
498
592
  #
@@ -541,7 +635,7 @@ module Aws::PersonalizeEvents
541
635
  params: params,
542
636
  config: config)
543
637
  context[:gem_name] = 'aws-sdk-personalizeevents'
544
- context[:gem_version] = '1.38.0'
638
+ context[:gem_version] = '1.39.0'
545
639
  Seahorse::Client::Request.new(handlers, context)
546
640
  end
547
641
 
@@ -13,6 +13,14 @@ module Aws::PersonalizeEvents
13
13
 
14
14
  include Seahorse::Model
15
15
 
16
+ Action = Shapes::StructureShape.new(name: 'Action')
17
+ ActionId = Shapes::StringShape.new(name: 'ActionId')
18
+ ActionImpression = Shapes::ListShape.new(name: 'ActionImpression')
19
+ ActionInteraction = Shapes::StructureShape.new(name: 'ActionInteraction')
20
+ ActionInteractionProperties = Shapes::StringShape.new(name: 'ActionInteractionProperties')
21
+ ActionInteractionsList = Shapes::ListShape.new(name: 'ActionInteractionsList')
22
+ ActionList = Shapes::ListShape.new(name: 'ActionList')
23
+ ActionProperties = Shapes::StringShape.new(name: 'ActionProperties')
16
24
  Arn = Shapes::StringShape.new(name: 'Arn')
17
25
  Date = Shapes::TimestampShape.new(name: 'Date')
18
26
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
@@ -28,6 +36,8 @@ module Aws::PersonalizeEvents
28
36
  ItemList = Shapes::ListShape.new(name: 'ItemList')
29
37
  ItemProperties = Shapes::StringShape.new(name: 'ItemProperties')
30
38
  MetricAttribution = Shapes::StructureShape.new(name: 'MetricAttribution')
39
+ PutActionInteractionsRequest = Shapes::StructureShape.new(name: 'PutActionInteractionsRequest')
40
+ PutActionsRequest = Shapes::StructureShape.new(name: 'PutActionsRequest')
31
41
  PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
32
42
  PutItemsRequest = Shapes::StructureShape.new(name: 'PutItemsRequest')
33
43
  PutUsersRequest = Shapes::StructureShape.new(name: 'PutUsersRequest')
@@ -40,6 +50,27 @@ module Aws::PersonalizeEvents
40
50
  UserList = Shapes::ListShape.new(name: 'UserList')
41
51
  UserProperties = Shapes::StringShape.new(name: 'UserProperties')
42
52
 
53
+ Action.add_member(:action_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "actionId"))
54
+ Action.add_member(:properties, Shapes::ShapeRef.new(shape: ActionProperties, location_name: "properties", metadata: {"jsonvalue"=>true}))
55
+ Action.struct_class = Types::Action
56
+
57
+ ActionImpression.member = Shapes::ShapeRef.new(shape: ActionId)
58
+
59
+ ActionInteraction.add_member(:action_id, Shapes::ShapeRef.new(shape: ActionId, required: true, location_name: "actionId"))
60
+ ActionInteraction.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, location_name: "userId"))
61
+ ActionInteraction.add_member(:session_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "sessionId"))
62
+ ActionInteraction.add_member(:timestamp, Shapes::ShapeRef.new(shape: Date, required: true, location_name: "timestamp"))
63
+ ActionInteraction.add_member(:event_type, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "eventType"))
64
+ ActionInteraction.add_member(:event_id, Shapes::ShapeRef.new(shape: StringType, location_name: "eventId"))
65
+ ActionInteraction.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationId, location_name: "recommendationId"))
66
+ ActionInteraction.add_member(:impression, Shapes::ShapeRef.new(shape: ActionImpression, location_name: "impression"))
67
+ ActionInteraction.add_member(:properties, Shapes::ShapeRef.new(shape: ActionInteractionProperties, location_name: "properties", metadata: {"jsonvalue"=>true}))
68
+ ActionInteraction.struct_class = Types::ActionInteraction
69
+
70
+ ActionInteractionsList.member = Shapes::ShapeRef.new(shape: ActionInteraction)
71
+
72
+ ActionList.member = Shapes::ShapeRef.new(shape: Action)
73
+
43
74
  Event.add_member(:event_id, Shapes::ShapeRef.new(shape: StringType, location_name: "eventId"))
44
75
  Event.add_member(:event_type, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "eventType"))
45
76
  Event.add_member(:event_value, Shapes::ShapeRef.new(shape: FloatType, location_name: "eventValue"))
@@ -67,6 +98,14 @@ module Aws::PersonalizeEvents
67
98
  MetricAttribution.add_member(:event_attribution_source, Shapes::ShapeRef.new(shape: EventAttributionSource, required: true, location_name: "eventAttributionSource"))
68
99
  MetricAttribution.struct_class = Types::MetricAttribution
69
100
 
101
+ PutActionInteractionsRequest.add_member(:tracking_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "trackingId"))
102
+ PutActionInteractionsRequest.add_member(:action_interactions, Shapes::ShapeRef.new(shape: ActionInteractionsList, required: true, location_name: "actionInteractions"))
103
+ PutActionInteractionsRequest.struct_class = Types::PutActionInteractionsRequest
104
+
105
+ PutActionsRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
106
+ PutActionsRequest.add_member(:actions, Shapes::ShapeRef.new(shape: ActionList, required: true, location_name: "actions"))
107
+ PutActionsRequest.struct_class = Types::PutActionsRequest
108
+
70
109
  PutEventsRequest.add_member(:tracking_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "trackingId"))
71
110
  PutEventsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, location_name: "userId"))
72
111
  PutEventsRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "sessionId"))
@@ -111,6 +150,28 @@ module Aws::PersonalizeEvents
111
150
  "uid" => "personalize-events-2018-03-22",
112
151
  }
113
152
 
153
+ api.add_operation(:put_action_interactions, Seahorse::Model::Operation.new.tap do |o|
154
+ o.name = "PutActionInteractions"
155
+ o.http_method = "POST"
156
+ o.http_request_uri = "/action-interactions"
157
+ o.input = Shapes::ShapeRef.new(shape: PutActionInteractionsRequest)
158
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
159
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
160
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
161
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
162
+ end)
163
+
164
+ api.add_operation(:put_actions, Seahorse::Model::Operation.new.tap do |o|
165
+ o.name = "PutActions"
166
+ o.http_method = "POST"
167
+ o.http_request_uri = "/actions"
168
+ o.input = Shapes::ShapeRef.new(shape: PutActionsRequest)
169
+ o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
170
+ o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
171
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
172
+ o.errors << Shapes::ShapeRef.new(shape: ResourceInUseException)
173
+ end)
174
+
114
175
  api.add_operation(:put_events, Seahorse::Model::Operation.new.tap do |o|
115
176
  o.name = "PutEvents"
116
177
  o.http_method = "POST"
@@ -32,7 +32,7 @@ module Aws::PersonalizeEvents
32
32
  raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
33
  end
34
34
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
+ if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
36
36
  return Aws::Endpoints::Endpoint.new(url: "https://personalize-events-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
37
  end
38
38
  raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
@@ -12,6 +12,34 @@ module Aws::PersonalizeEvents
12
12
  # @api private
13
13
  module Endpoints
14
14
 
15
+ class PutActionInteractions
16
+ def self.build(context)
17
+ unless context.config.regional_endpoint
18
+ endpoint = context.config.endpoint.to_s
19
+ end
20
+ Aws::PersonalizeEvents::EndpointParameters.new(
21
+ region: context.config.region,
22
+ use_dual_stack: context.config.use_dualstack_endpoint,
23
+ use_fips: context.config.use_fips_endpoint,
24
+ endpoint: endpoint,
25
+ )
26
+ end
27
+ end
28
+
29
+ class PutActions
30
+ def self.build(context)
31
+ unless context.config.regional_endpoint
32
+ endpoint = context.config.endpoint.to_s
33
+ end
34
+ Aws::PersonalizeEvents::EndpointParameters.new(
35
+ region: context.config.region,
36
+ use_dual_stack: context.config.use_dualstack_endpoint,
37
+ use_fips: context.config.use_fips_endpoint,
38
+ endpoint: endpoint,
39
+ )
40
+ end
41
+ end
42
+
15
43
  class PutEvents
16
44
  def self.build(context)
17
45
  unless context.config.regional_endpoint
@@ -56,6 +56,10 @@ module Aws::PersonalizeEvents
56
56
 
57
57
  def parameters_for_operation(context)
58
58
  case context.operation_name
59
+ when :put_action_interactions
60
+ Aws::PersonalizeEvents::Endpoints::PutActionInteractions.build(context)
61
+ when :put_actions
62
+ Aws::PersonalizeEvents::Endpoints::PutActions.build(context)
59
63
  when :put_events
60
64
  Aws::PersonalizeEvents::Endpoints::PutEvents.build(context)
61
65
  when :put_items
@@ -10,31 +10,166 @@
10
10
  module Aws::PersonalizeEvents
11
11
  module Types
12
12
 
13
- # Represents user interaction event information sent using the
13
+ # Represents action metadata added to an Action dataset using the
14
+ # `PutActions` API. For more information see [Importing actions
15
+ # individually][1].
16
+ #
17
+ #
18
+ #
19
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/importing-actions.html
20
+ #
21
+ # @!attribute [rw] action_id
22
+ # The ID associated with the action.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] properties
26
+ # A string map of action-specific metadata. Each element in the map
27
+ # consists of a key-value pair. For example, `\{"value": "100"\}`.
28
+ #
29
+ # The keys use camel case names that match the fields in the schema
30
+ # for the Actions dataset. In the previous example, the `value`
31
+ # matches the 'VALUE' field defined in the Actions schema. For
32
+ # categorical string data, to include multiple categories for a single
33
+ # action, separate each category with a pipe separator (`|`). For
34
+ # example, `"Deluxe|Premium"`.
35
+ # @return [String]
36
+ #
37
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Action AWS API Documentation
38
+ #
39
+ class Action < Struct.new(
40
+ :action_id,
41
+ :properties)
42
+ SENSITIVE = [:properties]
43
+ include Aws::Structure
44
+ end
45
+
46
+ # Represents an action interaction event sent using the
47
+ # `PutActionInteractions` API.
48
+ #
49
+ # @!attribute [rw] action_id
50
+ # The ID of the action the user interacted with. This corresponds to
51
+ # the `ACTION_ID` field of the Action interaction schema.
52
+ # @return [String]
53
+ #
54
+ # @!attribute [rw] user_id
55
+ # The ID of the user who interacted with the action. This corresponds
56
+ # to the `USER_ID` field of the Action interaction schema.
57
+ # @return [String]
58
+ #
59
+ # @!attribute [rw] session_id
60
+ # The ID associated with the user's visit. Your application generates
61
+ # a unique `sessionId` when a user first visits your website or uses
62
+ # your application.
63
+ # @return [String]
64
+ #
65
+ # @!attribute [rw] timestamp
66
+ # The timestamp for when the action interaction event occurred.
67
+ # Timestamps must be in Unix epoch time format, in seconds.
68
+ # @return [Time]
69
+ #
70
+ # @!attribute [rw] event_type
71
+ # The type of action interaction event. You can specify `Viewed`,
72
+ # `Taken`, and `Not Taken` event types. For more information about
73
+ # action interaction event type data, see [Event type data][1].
74
+ #
75
+ #
76
+ #
77
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-event-type-data.html
78
+ # @return [String]
79
+ #
80
+ # @!attribute [rw] event_id
81
+ # An ID associated with the event. If an event ID is not provided,
82
+ # Amazon Personalize generates a unique ID for the event. An event ID
83
+ # is not used as an input to the model. Amazon Personalize uses the
84
+ # event ID to distinguish unique events. Any subsequent events after
85
+ # the first with the same event ID are not used in model training.
86
+ # @return [String]
87
+ #
88
+ # @!attribute [rw] recommendation_id
89
+ # The ID of the list of recommendations that contains the action the
90
+ # user interacted with.
91
+ # @return [String]
92
+ #
93
+ # @!attribute [rw] impression
94
+ # A list of action IDs that represents the sequence of actions you
95
+ # have shown the user. For example, `["actionId1", "actionId2",
96
+ # "actionId3"]`. Amazon Personalize doesn't use impressions data from
97
+ # action interaction events. Instead, record multiple events for each
98
+ # action and use the `Viewed` event type.
99
+ # @return [Array<String>]
100
+ #
101
+ # @!attribute [rw] properties
102
+ # A string map of event-specific data that you might choose to record.
103
+ # For example, if a user takes an action, other than the action ID,
104
+ # you might also send the number of actions taken by the user.
105
+ #
106
+ # Each item in the map consists of a key-value pair. For example,
107
+ #
108
+ # `\{"numberOfActions": "12"\}`
109
+ #
110
+ # The keys use camel case names that match the fields in the Action
111
+ # interactions schema. In the above example, the `numberOfActions`
112
+ # would match the 'NUMBER\_OF\_ACTIONS' field defined in the Action
113
+ # interactions schema.
114
+ #
115
+ # The following can't be included as a keyword for properties (case
116
+ # insensitive).
117
+ #
118
+ # * userId
119
+ #
120
+ # * sessionId
121
+ #
122
+ # * eventType
123
+ #
124
+ # * timestamp
125
+ #
126
+ # * recommendationId
127
+ #
128
+ # * impression
129
+ # @return [String]
130
+ #
131
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/ActionInteraction AWS API Documentation
132
+ #
133
+ class ActionInteraction < Struct.new(
134
+ :action_id,
135
+ :user_id,
136
+ :session_id,
137
+ :timestamp,
138
+ :event_type,
139
+ :event_id,
140
+ :recommendation_id,
141
+ :impression,
142
+ :properties)
143
+ SENSITIVE = [:action_id, :user_id, :properties]
144
+ include Aws::Structure
145
+ end
146
+
147
+ # Represents item interaction event information sent using the
14
148
  # `PutEvents` API.
15
149
  #
16
150
  # @!attribute [rw] event_id
17
151
  # An ID associated with the event. If an event ID is not provided,
18
152
  # Amazon Personalize generates a unique ID for the event. An event ID
19
153
  # is not used as an input to the model. Amazon Personalize uses the
20
- # event ID to distinquish unique events. Any subsequent events after
154
+ # event ID to distinguish unique events. Any subsequent events after
21
155
  # the first with the same event ID are not used in model training.
22
156
  # @return [String]
23
157
  #
24
158
  # @!attribute [rw] event_type
25
159
  # The type of event, such as click or download. This property
26
- # corresponds to the `EVENT_TYPE` field of your Interactions schema
27
- # and depends on the types of events you are tracking.
160
+ # corresponds to the `EVENT_TYPE` field of your Item interactions
161
+ # dataset's schema and depends on the types of events you are
162
+ # tracking.
28
163
  # @return [String]
29
164
  #
30
165
  # @!attribute [rw] event_value
31
166
  # The event value that corresponds to the `EVENT_VALUE` field of the
32
- # Interactions schema.
167
+ # Item interactions schema.
33
168
  # @return [Float]
34
169
  #
35
170
  # @!attribute [rw] item_id
36
- # The item ID key that corresponds to the `ITEM_ID` field of the
37
- # Interactions schema.
171
+ # The item ID key that corresponds to the `ITEM_ID` field of the Item
172
+ # interactions dataset's schema.
38
173
  # @return [String]
39
174
  #
40
175
  # @!attribute [rw] properties
@@ -47,10 +182,25 @@ module Aws::PersonalizeEvents
47
182
  #
48
183
  # `\{"numberOfRatings": "12"\}`
49
184
  #
50
- # The keys use camel case names that match the fields in the
51
- # Interactions schema. In the above example, the `numberOfRatings`
52
- # would match the 'NUMBER\_OF\_RATINGS' field defined in the
53
- # Interactions schema.
185
+ # The keys use camel case names that match the fields in the Item
186
+ # interactions dataset's schema. In the above example, the
187
+ # `numberOfRatings` would match the 'NUMBER\_OF\_RATINGS' field
188
+ # defined in the Item interactions dataset's schema.
189
+ #
190
+ # The following can't be included as a keyword for properties (case
191
+ # insensitive).
192
+ #
193
+ # * userId
194
+ #
195
+ # * sessionId
196
+ #
197
+ # * eventType
198
+ #
199
+ # * timestamp
200
+ #
201
+ # * recommendationId
202
+ #
203
+ # * impression
54
204
  # @return [String]
55
205
  #
56
206
  # @!attribute [rw] sent_at
@@ -127,8 +277,8 @@ module Aws::PersonalizeEvents
127
277
  end
128
278
 
129
279
  # Represents item metadata added to an Items dataset using the
130
- # `PutItems` API. For more information see [Importing Items
131
- # Incrementally][1].
280
+ # `PutItems` API. For more information see [Importing items
281
+ # individually][1].
132
282
  #
133
283
  #
134
284
  #
@@ -180,6 +330,48 @@ module Aws::PersonalizeEvents
180
330
  include Aws::Structure
181
331
  end
182
332
 
333
+ # @!attribute [rw] tracking_id
334
+ # The ID of your action interaction event tracker. When you create an
335
+ # Action interactions dataset, Amazon Personalize creates an action
336
+ # interaction event tracker for you. For more information, see [Action
337
+ # interaction event tracker ID][1].
338
+ #
339
+ #
340
+ #
341
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/action-interaction-tracker-id.html
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] action_interactions
345
+ # A list of action interaction events from the session.
346
+ # @return [Array<Types::ActionInteraction>]
347
+ #
348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutActionInteractionsRequest AWS API Documentation
349
+ #
350
+ class PutActionInteractionsRequest < Struct.new(
351
+ :tracking_id,
352
+ :action_interactions)
353
+ SENSITIVE = []
354
+ include Aws::Structure
355
+ end
356
+
357
+ # @!attribute [rw] dataset_arn
358
+ # The Amazon Resource Name (ARN) of the Actions dataset you are adding
359
+ # the action or actions to.
360
+ # @return [String]
361
+ #
362
+ # @!attribute [rw] actions
363
+ # A list of action data.
364
+ # @return [Array<Types::Action>]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutActionsRequest AWS API Documentation
367
+ #
368
+ class PutActionsRequest < Struct.new(
369
+ :dataset_arn,
370
+ :actions)
371
+ SENSITIVE = []
372
+ include Aws::Structure
373
+ end
374
+
183
375
  # @!attribute [rw] tracking_id
184
376
  # The tracking ID for the event. The ID is generated by a call to the
185
377
  # [CreateEventTracker][1] API.
@@ -198,11 +390,11 @@ module Aws::PersonalizeEvents
198
390
  # generates the sessionId when a user first visits your website or
199
391
  # uses your application. Amazon Personalize uses the sessionId to
200
392
  # associate events with the user before they log in. For more
201
- # information, see [Recording Events][1].
393
+ # information, see [Recording item interaction events][1].
202
394
  #
203
395
  #
204
396
  #
205
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html
397
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-item-interaction-events.html
206
398
  # @return [String]
207
399
  #
208
400
  # @!attribute [rw] event_list
@@ -283,7 +475,7 @@ module Aws::PersonalizeEvents
283
475
  end
284
476
 
285
477
  # Represents user metadata added to a Users dataset using the `PutUsers`
286
- # API. For more information see [Importing Users Incrementally][1].
478
+ # API. For more information see [Importing users individually][1].
287
479
  #
288
480
  #
289
481
  #
@@ -32,7 +32,7 @@ require_relative 'aws-sdk-personalizeevents/customizations'
32
32
  # structure.
33
33
  #
34
34
  # personalize_events = Aws::PersonalizeEvents::Client.new
35
- # resp = personalize_events.put_events(params)
35
+ # resp = personalize_events.put_action_interactions(params)
36
36
  #
37
37
  # See {Client} for more information.
38
38
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalizeevents/customizations'
52
52
  # @!group service
53
53
  module Aws::PersonalizeEvents
54
54
 
55
- GEM_VERSION = '1.38.0'
55
+ GEM_VERSION = '1.39.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalizeevents
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.38.0
4
+ version: 1.39.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-22 00:00:00.000000000 Z
11
+ date: 2023-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core