aws-sdk-personalizeevents 1.9.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0b120105f555c6a740796d1a3914e986da6d49c134f1ead63701ca5b3d2e1438
|
4
|
+
data.tar.gz: 06bb21430e9d02bd44b24c7c3487653cad4bd8e2ae9573ead8170ef4b1d8920e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a83536240854bdc8e84684d906befc076b3c06089cf502cfe320475d69c59ae8ca17bfa95737aabd80450853e8dec5d0af36da85d0591a9cb69d1c2b66a50d11
|
7
|
+
data.tar.gz: 8865de0f092984e3303d00328b75f47290444601298da59bb1bfd670212716b253a51295a81bf3d60ad725eb620e4116ede47b9c1b1a5769e99c6a3b48fbd150
|
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-personalizeevents/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::PersonalizeEvents
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.14.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::PersonalizeEvents
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::PersonalizeEvents
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -312,7 +327,8 @@ module Aws::PersonalizeEvents
|
|
312
327
|
|
313
328
|
# @!group API Operations
|
314
329
|
|
315
|
-
# Records user interaction event data.
|
330
|
+
# Records user interaction event data. For more information see
|
331
|
+
# event-record-api.
|
316
332
|
#
|
317
333
|
# @option params [required, String] :tracking_id
|
318
334
|
# The tracking ID for the event. The ID is generated by a call to the
|
@@ -326,7 +342,11 @@ module Aws::PersonalizeEvents
|
|
326
342
|
# The user associated with the event.
|
327
343
|
#
|
328
344
|
# @option params [required, String] :session_id
|
329
|
-
# The session ID associated with the user's visit.
|
345
|
+
# The session ID associated with the user's visit. Your application
|
346
|
+
# generates the sessionId when a user first visits your website or uses
|
347
|
+
# your application. Amazon Personalize uses the sessionId to associate
|
348
|
+
# events with the user before they log in. For more information see
|
349
|
+
# event-record-api.
|
330
350
|
#
|
331
351
|
# @option params [required, Array<Types::Event>] :event_list
|
332
352
|
# A list of event data from the session.
|
@@ -343,8 +363,12 @@ module Aws::PersonalizeEvents
|
|
343
363
|
# {
|
344
364
|
# event_id: "StringType",
|
345
365
|
# event_type: "StringType", # required
|
346
|
-
#
|
366
|
+
# event_value: 1.0,
|
367
|
+
# item_id: "ItemId",
|
368
|
+
# properties: "EventPropertiesJSON",
|
347
369
|
# sent_at: Time.now, # required
|
370
|
+
# recommendation_id: "RecommendationId",
|
371
|
+
# impression: ["ItemId"],
|
348
372
|
# },
|
349
373
|
# ],
|
350
374
|
# })
|
@@ -358,6 +382,72 @@ module Aws::PersonalizeEvents
|
|
358
382
|
req.send_request(options)
|
359
383
|
end
|
360
384
|
|
385
|
+
# Adds one or more items to an Items dataset. For more information see
|
386
|
+
# importing-items.
|
387
|
+
#
|
388
|
+
# @option params [required, String] :dataset_arn
|
389
|
+
# The Amazon Resource Number (ARN) of the Items dataset you are adding
|
390
|
+
# the item or items to.
|
391
|
+
#
|
392
|
+
# @option params [required, Array<Types::Item>] :items
|
393
|
+
# A list of item data.
|
394
|
+
#
|
395
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
396
|
+
#
|
397
|
+
# @example Request syntax with placeholder values
|
398
|
+
#
|
399
|
+
# resp = client.put_items({
|
400
|
+
# dataset_arn: "Arn", # required
|
401
|
+
# items: [ # required
|
402
|
+
# {
|
403
|
+
# item_id: "StringType", # required
|
404
|
+
# properties: "ItemProperties",
|
405
|
+
# },
|
406
|
+
# ],
|
407
|
+
# })
|
408
|
+
#
|
409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutItems AWS API Documentation
|
410
|
+
#
|
411
|
+
# @overload put_items(params = {})
|
412
|
+
# @param [Hash] params ({})
|
413
|
+
def put_items(params = {}, options = {})
|
414
|
+
req = build_request(:put_items, params)
|
415
|
+
req.send_request(options)
|
416
|
+
end
|
417
|
+
|
418
|
+
# Adds one or more users to a Users dataset. For more information see
|
419
|
+
# importing-users.
|
420
|
+
#
|
421
|
+
# @option params [required, String] :dataset_arn
|
422
|
+
# The Amazon Resource Number (ARN) of the Users dataset you are adding
|
423
|
+
# the user or users to.
|
424
|
+
#
|
425
|
+
# @option params [required, Array<Types::User>] :users
|
426
|
+
# A list of user data.
|
427
|
+
#
|
428
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
429
|
+
#
|
430
|
+
# @example Request syntax with placeholder values
|
431
|
+
#
|
432
|
+
# resp = client.put_users({
|
433
|
+
# dataset_arn: "Arn", # required
|
434
|
+
# users: [ # required
|
435
|
+
# {
|
436
|
+
# user_id: "StringType", # required
|
437
|
+
# properties: "UserProperties",
|
438
|
+
# },
|
439
|
+
# ],
|
440
|
+
# })
|
441
|
+
#
|
442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutUsers AWS API Documentation
|
443
|
+
#
|
444
|
+
# @overload put_users(params = {})
|
445
|
+
# @param [Hash] params ({})
|
446
|
+
def put_users(params = {}, options = {})
|
447
|
+
req = build_request(:put_users, params)
|
448
|
+
req.send_request(options)
|
449
|
+
end
|
450
|
+
|
361
451
|
# @!endgroup
|
362
452
|
|
363
453
|
# @param params ({})
|
@@ -371,7 +461,7 @@ module Aws::PersonalizeEvents
|
|
371
461
|
params: params,
|
372
462
|
config: config)
|
373
463
|
context[:gem_name] = 'aws-sdk-personalizeevents'
|
374
|
-
context[:gem_version] = '1.
|
464
|
+
context[:gem_version] = '1.14.0'
|
375
465
|
Seahorse::Client::Request.new(handlers, context)
|
376
466
|
end
|
377
467
|
|
@@ -13,33 +13,76 @@ module Aws::PersonalizeEvents
|
|
13
13
|
|
14
14
|
include Seahorse::Model
|
15
15
|
|
16
|
+
Arn = Shapes::StringShape.new(name: 'Arn')
|
16
17
|
Date = Shapes::TimestampShape.new(name: 'Date')
|
17
18
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
18
19
|
Event = Shapes::StructureShape.new(name: 'Event')
|
19
20
|
EventList = Shapes::ListShape.new(name: 'EventList')
|
20
21
|
EventPropertiesJSON = Shapes::StringShape.new(name: 'EventPropertiesJSON')
|
22
|
+
FloatType = Shapes::FloatShape.new(name: 'FloatType')
|
23
|
+
Impression = Shapes::ListShape.new(name: 'Impression')
|
21
24
|
InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
|
25
|
+
Item = Shapes::StructureShape.new(name: 'Item')
|
26
|
+
ItemId = Shapes::StringShape.new(name: 'ItemId')
|
27
|
+
ItemList = Shapes::ListShape.new(name: 'ItemList')
|
28
|
+
ItemProperties = Shapes::StringShape.new(name: 'ItemProperties')
|
22
29
|
PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
|
30
|
+
PutItemsRequest = Shapes::StructureShape.new(name: 'PutItemsRequest')
|
31
|
+
PutUsersRequest = Shapes::StructureShape.new(name: 'PutUsersRequest')
|
32
|
+
RecommendationId = Shapes::StringShape.new(name: 'RecommendationId')
|
33
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
23
34
|
StringType = Shapes::StringShape.new(name: 'StringType')
|
35
|
+
User = Shapes::StructureShape.new(name: 'User')
|
24
36
|
UserId = Shapes::StringShape.new(name: 'UserId')
|
37
|
+
UserList = Shapes::ListShape.new(name: 'UserList')
|
38
|
+
UserProperties = Shapes::StringShape.new(name: 'UserProperties')
|
25
39
|
|
26
40
|
Event.add_member(:event_id, Shapes::ShapeRef.new(shape: StringType, location_name: "eventId"))
|
27
41
|
Event.add_member(:event_type, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "eventType"))
|
28
|
-
Event.add_member(:
|
42
|
+
Event.add_member(:event_value, Shapes::ShapeRef.new(shape: FloatType, location_name: "eventValue"))
|
43
|
+
Event.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemId, location_name: "itemId"))
|
44
|
+
Event.add_member(:properties, Shapes::ShapeRef.new(shape: EventPropertiesJSON, location_name: "properties", metadata: {"jsonvalue"=>true}))
|
29
45
|
Event.add_member(:sent_at, Shapes::ShapeRef.new(shape: Date, required: true, location_name: "sentAt"))
|
46
|
+
Event.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationId, location_name: "recommendationId"))
|
47
|
+
Event.add_member(:impression, Shapes::ShapeRef.new(shape: Impression, location_name: "impression"))
|
30
48
|
Event.struct_class = Types::Event
|
31
49
|
|
32
50
|
EventList.member = Shapes::ShapeRef.new(shape: Event)
|
33
51
|
|
52
|
+
Impression.member = Shapes::ShapeRef.new(shape: ItemId)
|
53
|
+
|
34
54
|
InvalidInputException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
|
35
55
|
InvalidInputException.struct_class = Types::InvalidInputException
|
36
56
|
|
57
|
+
Item.add_member(:item_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "itemId"))
|
58
|
+
Item.add_member(:properties, Shapes::ShapeRef.new(shape: ItemProperties, location_name: "properties", metadata: {"jsonvalue"=>true}))
|
59
|
+
Item.struct_class = Types::Item
|
60
|
+
|
61
|
+
ItemList.member = Shapes::ShapeRef.new(shape: Item)
|
62
|
+
|
37
63
|
PutEventsRequest.add_member(:tracking_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "trackingId"))
|
38
64
|
PutEventsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, location_name: "userId"))
|
39
65
|
PutEventsRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "sessionId"))
|
40
66
|
PutEventsRequest.add_member(:event_list, Shapes::ShapeRef.new(shape: EventList, required: true, location_name: "eventList"))
|
41
67
|
PutEventsRequest.struct_class = Types::PutEventsRequest
|
42
68
|
|
69
|
+
PutItemsRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
|
70
|
+
PutItemsRequest.add_member(:items, Shapes::ShapeRef.new(shape: ItemList, required: true, location_name: "items"))
|
71
|
+
PutItemsRequest.struct_class = Types::PutItemsRequest
|
72
|
+
|
73
|
+
PutUsersRequest.add_member(:dataset_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetArn"))
|
74
|
+
PutUsersRequest.add_member(:users, Shapes::ShapeRef.new(shape: UserList, required: true, location_name: "users"))
|
75
|
+
PutUsersRequest.struct_class = Types::PutUsersRequest
|
76
|
+
|
77
|
+
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
|
78
|
+
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
79
|
+
|
80
|
+
User.add_member(:user_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "userId"))
|
81
|
+
User.add_member(:properties, Shapes::ShapeRef.new(shape: UserProperties, location_name: "properties", metadata: {"jsonvalue"=>true}))
|
82
|
+
User.struct_class = Types::User
|
83
|
+
|
84
|
+
UserList.member = Shapes::ShapeRef.new(shape: User)
|
85
|
+
|
43
86
|
|
44
87
|
# @api private
|
45
88
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -66,6 +109,26 @@ module Aws::PersonalizeEvents
|
|
66
109
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
67
110
|
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
68
111
|
end)
|
112
|
+
|
113
|
+
api.add_operation(:put_items, Seahorse::Model::Operation.new.tap do |o|
|
114
|
+
o.name = "PutItems"
|
115
|
+
o.http_method = "POST"
|
116
|
+
o.http_request_uri = "/items"
|
117
|
+
o.input = Shapes::ShapeRef.new(shape: PutItemsRequest)
|
118
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
119
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
120
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
121
|
+
end)
|
122
|
+
|
123
|
+
api.add_operation(:put_users, Seahorse::Model::Operation.new.tap do |o|
|
124
|
+
o.name = "PutUsers"
|
125
|
+
o.http_method = "POST"
|
126
|
+
o.http_request_uri = "/users"
|
127
|
+
o.input = Shapes::ShapeRef.new(shape: PutUsersRequest)
|
128
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
129
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidInputException)
|
130
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
131
|
+
end)
|
69
132
|
end
|
70
133
|
|
71
134
|
end
|
@@ -28,6 +28,7 @@ module Aws::PersonalizeEvents
|
|
28
28
|
#
|
29
29
|
# ## Error Classes
|
30
30
|
# * {InvalidInputException}
|
31
|
+
# * {ResourceNotFoundException}
|
31
32
|
#
|
32
33
|
# Additionally, error classes are dynamically generated for service errors based on the error code
|
33
34
|
# if they are not defined above.
|
@@ -50,5 +51,20 @@ module Aws::PersonalizeEvents
|
|
50
51
|
end
|
51
52
|
end
|
52
53
|
|
54
|
+
class ResourceNotFoundException < ServiceError
|
55
|
+
|
56
|
+
# @param [Seahorse::Client::RequestContext] context
|
57
|
+
# @param [String] message
|
58
|
+
# @param [Aws::PersonalizeEvents::Types::ResourceNotFoundException] data
|
59
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
60
|
+
super(context, message, data)
|
61
|
+
end
|
62
|
+
|
63
|
+
# @return [String]
|
64
|
+
def message
|
65
|
+
@message || @data[:message]
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
53
69
|
end
|
54
70
|
end
|
@@ -19,8 +19,12 @@ module Aws::PersonalizeEvents
|
|
19
19
|
# {
|
20
20
|
# event_id: "StringType",
|
21
21
|
# event_type: "StringType", # required
|
22
|
-
#
|
22
|
+
# event_value: 1.0,
|
23
|
+
# item_id: "ItemId",
|
24
|
+
# properties: "EventPropertiesJSON",
|
23
25
|
# sent_at: Time.now, # required
|
26
|
+
# recommendation_id: "RecommendationId",
|
27
|
+
# impression: ["ItemId"],
|
24
28
|
# }
|
25
29
|
#
|
26
30
|
# @!attribute [rw] event_id
|
@@ -32,43 +36,62 @@ module Aws::PersonalizeEvents
|
|
32
36
|
# @return [String]
|
33
37
|
#
|
34
38
|
# @!attribute [rw] event_type
|
35
|
-
# The type of event
|
36
|
-
# field of
|
39
|
+
# The type of event, such as click or download. This property
|
40
|
+
# corresponds to the `EVENT_TYPE` field of your Interactions schema
|
41
|
+
# and depends on the types of events you are tracking.
|
42
|
+
# @return [String]
|
43
|
+
#
|
44
|
+
# @!attribute [rw] event_value
|
45
|
+
# The event value that corresponds to the `EVENT_VALUE` field of the
|
46
|
+
# Interactions schema.
|
47
|
+
# @return [Float]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] item_id
|
50
|
+
# The item ID key that corresponds to the `ITEM_ID` field of the
|
51
|
+
# Interactions schema.
|
37
52
|
# @return [String]
|
38
53
|
#
|
39
54
|
# @!attribute [rw] properties
|
40
55
|
# A string map of event-specific data that you might choose to record.
|
41
|
-
# For example, if a user rates a movie on your site,
|
42
|
-
#
|
43
|
-
# user.
|
56
|
+
# For example, if a user rates a movie on your site, other than movie
|
57
|
+
# ID (`itemId`) and rating (`eventValue`) , you might also send the
|
58
|
+
# number of movie ratings made by the user.
|
44
59
|
#
|
45
60
|
# Each item in the map consists of a key-value pair. For example,
|
46
61
|
#
|
47
|
-
# `\{"
|
48
|
-
#
|
49
|
-
# `\{"itemId": "movie2", "eventValue": "4.5"\}`
|
50
|
-
#
|
51
|
-
# `\{"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"\}`
|
62
|
+
# `\{"numberOfRatings": "12"\}`
|
52
63
|
#
|
53
64
|
# The keys use camel case names that match the fields in the
|
54
|
-
# Interactions schema.
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# rating. The `numberOfRatings` would match the
|
58
|
-
# 'NUMBER\_OF\_RATINGS' field defined in the Interactions schema.
|
65
|
+
# Interactions schema. In the above example, the `numberOfRatings`
|
66
|
+
# would match the 'NUMBER\_OF\_RATINGS' field defined in the
|
67
|
+
# Interactions schema.
|
59
68
|
# @return [String]
|
60
69
|
#
|
61
70
|
# @!attribute [rw] sent_at
|
62
|
-
# The timestamp on the client side when the event
|
71
|
+
# The timestamp (in Unix time) on the client side when the event
|
72
|
+
# occurred.
|
63
73
|
# @return [Time]
|
64
74
|
#
|
75
|
+
# @!attribute [rw] recommendation_id
|
76
|
+
# The ID of the recommendation.
|
77
|
+
# @return [String]
|
78
|
+
#
|
79
|
+
# @!attribute [rw] impression
|
80
|
+
# A list of item IDs that represents the sequence of items you have
|
81
|
+
# shown the user. For example, `["itemId1", "itemId2", "itemId3"]`.
|
82
|
+
# @return [Array<String>]
|
83
|
+
#
|
65
84
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Event AWS API Documentation
|
66
85
|
#
|
67
86
|
class Event < Struct.new(
|
68
87
|
:event_id,
|
69
88
|
:event_type,
|
89
|
+
:event_value,
|
90
|
+
:item_id,
|
70
91
|
:properties,
|
71
|
-
:sent_at
|
92
|
+
:sent_at,
|
93
|
+
:recommendation_id,
|
94
|
+
:impression)
|
72
95
|
SENSITIVE = []
|
73
96
|
include Aws::Structure
|
74
97
|
end
|
@@ -86,6 +109,41 @@ module Aws::PersonalizeEvents
|
|
86
109
|
include Aws::Structure
|
87
110
|
end
|
88
111
|
|
112
|
+
# Represents item metadata added to an Items dataset using the
|
113
|
+
# `PutItems` API.
|
114
|
+
#
|
115
|
+
# @note When making an API call, you may pass Item
|
116
|
+
# data as a hash:
|
117
|
+
#
|
118
|
+
# {
|
119
|
+
# item_id: "StringType", # required
|
120
|
+
# properties: "ItemProperties",
|
121
|
+
# }
|
122
|
+
#
|
123
|
+
# @!attribute [rw] item_id
|
124
|
+
# The ID associated with the item.
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @!attribute [rw] properties
|
128
|
+
# A string map of item-specific metadata. Each element in the map
|
129
|
+
# consists of a key-value pair. For example,
|
130
|
+
#
|
131
|
+
# `\{"numberOfRatings": "12"\}`
|
132
|
+
#
|
133
|
+
# The keys use camel case names that match the fields in the Items
|
134
|
+
# schema. In the above example, the `numberOfRatings` would match the
|
135
|
+
# 'NUMBER\_OF\_RATINGS' field defined in the Items schema.
|
136
|
+
# @return [String]
|
137
|
+
#
|
138
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Item AWS API Documentation
|
139
|
+
#
|
140
|
+
class Item < Struct.new(
|
141
|
+
:item_id,
|
142
|
+
:properties)
|
143
|
+
SENSITIVE = []
|
144
|
+
include Aws::Structure
|
145
|
+
end
|
146
|
+
|
89
147
|
# @note When making an API call, you may pass PutEventsRequest
|
90
148
|
# data as a hash:
|
91
149
|
#
|
@@ -97,8 +155,12 @@ module Aws::PersonalizeEvents
|
|
97
155
|
# {
|
98
156
|
# event_id: "StringType",
|
99
157
|
# event_type: "StringType", # required
|
100
|
-
#
|
158
|
+
# event_value: 1.0,
|
159
|
+
# item_id: "ItemId",
|
160
|
+
# properties: "EventPropertiesJSON",
|
101
161
|
# sent_at: Time.now, # required
|
162
|
+
# recommendation_id: "RecommendationId",
|
163
|
+
# impression: ["ItemId"],
|
102
164
|
# },
|
103
165
|
# ],
|
104
166
|
# }
|
@@ -117,7 +179,11 @@ module Aws::PersonalizeEvents
|
|
117
179
|
# @return [String]
|
118
180
|
#
|
119
181
|
# @!attribute [rw] session_id
|
120
|
-
# The session ID associated with the user's visit.
|
182
|
+
# The session ID associated with the user's visit. Your application
|
183
|
+
# generates the sessionId when a user first visits your website or
|
184
|
+
# uses your application. Amazon Personalize uses the sessionId to
|
185
|
+
# associate events with the user before they log in. For more
|
186
|
+
# information see event-record-api.
|
121
187
|
# @return [String]
|
122
188
|
#
|
123
189
|
# @!attribute [rw] event_list
|
@@ -135,5 +201,116 @@ module Aws::PersonalizeEvents
|
|
135
201
|
include Aws::Structure
|
136
202
|
end
|
137
203
|
|
204
|
+
# @note When making an API call, you may pass PutItemsRequest
|
205
|
+
# data as a hash:
|
206
|
+
#
|
207
|
+
# {
|
208
|
+
# dataset_arn: "Arn", # required
|
209
|
+
# items: [ # required
|
210
|
+
# {
|
211
|
+
# item_id: "StringType", # required
|
212
|
+
# properties: "ItemProperties",
|
213
|
+
# },
|
214
|
+
# ],
|
215
|
+
# }
|
216
|
+
#
|
217
|
+
# @!attribute [rw] dataset_arn
|
218
|
+
# The Amazon Resource Number (ARN) of the Items dataset you are adding
|
219
|
+
# the item or items to.
|
220
|
+
# @return [String]
|
221
|
+
#
|
222
|
+
# @!attribute [rw] items
|
223
|
+
# A list of item data.
|
224
|
+
# @return [Array<Types::Item>]
|
225
|
+
#
|
226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutItemsRequest AWS API Documentation
|
227
|
+
#
|
228
|
+
class PutItemsRequest < Struct.new(
|
229
|
+
:dataset_arn,
|
230
|
+
:items)
|
231
|
+
SENSITIVE = []
|
232
|
+
include Aws::Structure
|
233
|
+
end
|
234
|
+
|
235
|
+
# @note When making an API call, you may pass PutUsersRequest
|
236
|
+
# data as a hash:
|
237
|
+
#
|
238
|
+
# {
|
239
|
+
# dataset_arn: "Arn", # required
|
240
|
+
# users: [ # required
|
241
|
+
# {
|
242
|
+
# user_id: "StringType", # required
|
243
|
+
# properties: "UserProperties",
|
244
|
+
# },
|
245
|
+
# ],
|
246
|
+
# }
|
247
|
+
#
|
248
|
+
# @!attribute [rw] dataset_arn
|
249
|
+
# The Amazon Resource Number (ARN) of the Users dataset you are adding
|
250
|
+
# the user or users to.
|
251
|
+
# @return [String]
|
252
|
+
#
|
253
|
+
# @!attribute [rw] users
|
254
|
+
# A list of user data.
|
255
|
+
# @return [Array<Types::User>]
|
256
|
+
#
|
257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/PutUsersRequest AWS API Documentation
|
258
|
+
#
|
259
|
+
class PutUsersRequest < Struct.new(
|
260
|
+
:dataset_arn,
|
261
|
+
:users)
|
262
|
+
SENSITIVE = []
|
263
|
+
include Aws::Structure
|
264
|
+
end
|
265
|
+
|
266
|
+
# Could not find the specified resource.
|
267
|
+
#
|
268
|
+
# @!attribute [rw] message
|
269
|
+
# @return [String]
|
270
|
+
#
|
271
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/ResourceNotFoundException AWS API Documentation
|
272
|
+
#
|
273
|
+
class ResourceNotFoundException < Struct.new(
|
274
|
+
:message)
|
275
|
+
SENSITIVE = []
|
276
|
+
include Aws::Structure
|
277
|
+
end
|
278
|
+
|
279
|
+
# Represents user metadata added to a Users dataset using the `PutUsers`
|
280
|
+
# API.
|
281
|
+
#
|
282
|
+
# @note When making an API call, you may pass User
|
283
|
+
# data as a hash:
|
284
|
+
#
|
285
|
+
# {
|
286
|
+
# user_id: "StringType", # required
|
287
|
+
# properties: "UserProperties",
|
288
|
+
# }
|
289
|
+
#
|
290
|
+
# @!attribute [rw] user_id
|
291
|
+
# The ID associated with the user.
|
292
|
+
# @return [String]
|
293
|
+
#
|
294
|
+
# @!attribute [rw] properties
|
295
|
+
# A string map of user-specific metadata. Each element in the map
|
296
|
+
# consists of a key-value pair. For example,
|
297
|
+
#
|
298
|
+
# `\{"numberOfVideosWatched": "45"\}`
|
299
|
+
#
|
300
|
+
# The keys use camel case names that match the fields in the Users
|
301
|
+
# schema. In the above example, the `numberOfVideosWatched` would
|
302
|
+
# match the 'NUMBER\_OF\_VIDEOS\_WATCHED' field defined in the Users
|
303
|
+
# schema.
|
304
|
+
# @return [String]
|
305
|
+
#
|
306
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/User AWS API Documentation
|
307
|
+
#
|
308
|
+
class User < Struct.new(
|
309
|
+
:user_id,
|
310
|
+
:properties)
|
311
|
+
SENSITIVE = []
|
312
|
+
include Aws::Structure
|
313
|
+
end
|
314
|
+
|
138
315
|
end
|
139
316
|
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.
|
4
|
+
version: 1.14.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: 2020-
|
11
|
+
date: 2020-10-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|