aws-sdk-personalizeevents 1.28.0 → 1.30.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-personalizeevents/client.rb +4 -1
- data/lib/aws-sdk-personalizeevents/client_api.rb +6 -0
- data/lib/aws-sdk-personalizeevents/endpoint_provider.rb +35 -95
- data/lib/aws-sdk-personalizeevents/types.rb +56 -82
- data/lib/aws-sdk-personalizeevents.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0add54276279852bd67e21c3da8e5ac5d6156326a35927959a4f11adfe38a97f
|
4
|
+
data.tar.gz: c2ebdb382b11bcb47274fee77bafff132ffac0cc3f5cbe1788a9adf425285fc4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 838b59eff59a50a6f3f65fd5b16c4603597f307fa4b7b5a30c5fb16887fd2194886eef2f74b2ac54881984959f7c4f60727eed86e7b787c9724fec805b1b3a49
|
7
|
+
data.tar.gz: 9e9980b2c1c11ccf3eb30db25d311a498f4219918753d38a1a8eb020c48d2b5f4d9d3f29891273798f3c6c42298985f24479460589b1a97687c2752eb21ae383
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,18 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.30.0 (2023-01-18)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
* Issue - Replace runtime endpoint resolution approach with generated ruby code.
|
10
|
+
|
11
|
+
1.29.0 (2022-11-16)
|
12
|
+
------------------
|
13
|
+
|
14
|
+
* Feature - This release provides support for creation and use of metric attributions in AWS Personalize
|
15
|
+
|
4
16
|
1.28.0 (2022-10-25)
|
5
17
|
------------------
|
6
18
|
|
@@ -150,4 +162,4 @@ Unreleased Changes
|
|
150
162
|
1.0.0 (2019-06-10)
|
151
163
|
------------------
|
152
164
|
|
153
|
-
* Feature - Initial release of `aws-sdk-personalizeevents`.
|
165
|
+
* Feature - Initial release of `aws-sdk-personalizeevents`.
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.30.0
|
@@ -418,6 +418,9 @@ module Aws::PersonalizeEvents
|
|
418
418
|
# sent_at: Time.now, # required
|
419
419
|
# recommendation_id: "RecommendationId",
|
420
420
|
# impression: ["ItemId"],
|
421
|
+
# metric_attribution: {
|
422
|
+
# event_attribution_source: "EventAttributionSource", # required
|
423
|
+
# },
|
421
424
|
# },
|
422
425
|
# ],
|
423
426
|
# })
|
@@ -518,7 +521,7 @@ module Aws::PersonalizeEvents
|
|
518
521
|
params: params,
|
519
522
|
config: config)
|
520
523
|
context[:gem_name] = 'aws-sdk-personalizeevents'
|
521
|
-
context[:gem_version] = '1.
|
524
|
+
context[:gem_version] = '1.30.0'
|
522
525
|
Seahorse::Client::Request.new(handlers, context)
|
523
526
|
end
|
524
527
|
|
@@ -17,6 +17,7 @@ module Aws::PersonalizeEvents
|
|
17
17
|
Date = Shapes::TimestampShape.new(name: 'Date')
|
18
18
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
19
19
|
Event = Shapes::StructureShape.new(name: 'Event')
|
20
|
+
EventAttributionSource = Shapes::StringShape.new(name: 'EventAttributionSource')
|
20
21
|
EventList = Shapes::ListShape.new(name: 'EventList')
|
21
22
|
EventPropertiesJSON = Shapes::StringShape.new(name: 'EventPropertiesJSON')
|
22
23
|
FloatType = Shapes::FloatShape.new(name: 'FloatType')
|
@@ -26,6 +27,7 @@ module Aws::PersonalizeEvents
|
|
26
27
|
ItemId = Shapes::StringShape.new(name: 'ItemId')
|
27
28
|
ItemList = Shapes::ListShape.new(name: 'ItemList')
|
28
29
|
ItemProperties = Shapes::StringShape.new(name: 'ItemProperties')
|
30
|
+
MetricAttribution = Shapes::StructureShape.new(name: 'MetricAttribution')
|
29
31
|
PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
|
30
32
|
PutItemsRequest = Shapes::StructureShape.new(name: 'PutItemsRequest')
|
31
33
|
PutUsersRequest = Shapes::StructureShape.new(name: 'PutUsersRequest')
|
@@ -46,6 +48,7 @@ module Aws::PersonalizeEvents
|
|
46
48
|
Event.add_member(:sent_at, Shapes::ShapeRef.new(shape: Date, required: true, location_name: "sentAt"))
|
47
49
|
Event.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationId, location_name: "recommendationId"))
|
48
50
|
Event.add_member(:impression, Shapes::ShapeRef.new(shape: Impression, location_name: "impression"))
|
51
|
+
Event.add_member(:metric_attribution, Shapes::ShapeRef.new(shape: MetricAttribution, location_name: "metricAttribution"))
|
49
52
|
Event.struct_class = Types::Event
|
50
53
|
|
51
54
|
EventList.member = Shapes::ShapeRef.new(shape: Event)
|
@@ -61,6 +64,9 @@ module Aws::PersonalizeEvents
|
|
61
64
|
|
62
65
|
ItemList.member = Shapes::ShapeRef.new(shape: Item)
|
63
66
|
|
67
|
+
MetricAttribution.add_member(:event_attribution_source, Shapes::ShapeRef.new(shape: EventAttributionSource, required: true, location_name: "eventAttributionSource"))
|
68
|
+
MetricAttribution.struct_class = Types::MetricAttribution
|
69
|
+
|
64
70
|
PutEventsRequest.add_member(:tracking_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "trackingId"))
|
65
71
|
PutEventsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, location_name: "userId"))
|
66
72
|
PutEventsRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "sessionId"))
|
@@ -9,103 +9,43 @@
|
|
9
9
|
|
10
10
|
module Aws::PersonalizeEvents
|
11
11
|
class EndpointProvider
|
12
|
-
def
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
12
|
+
def resolve_endpoint(parameters)
|
13
|
+
region = parameters.region
|
14
|
+
use_dual_stack = parameters.use_dual_stack
|
15
|
+
use_fips = parameters.use_fips
|
16
|
+
endpoint = parameters.endpoint
|
17
|
+
if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
|
18
|
+
if Aws::Endpoints::Matchers.set?(endpoint) && (url = Aws::Endpoints::Matchers.parse_url(endpoint))
|
19
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
20
|
+
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
21
|
+
end
|
22
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
23
|
+
raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
|
24
|
+
end
|
25
|
+
return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
|
26
|
+
end
|
27
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
28
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
29
|
+
return Aws::Endpoints::Endpoint.new(url: "https://personalize-events-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
30
|
+
end
|
31
|
+
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
32
|
+
end
|
33
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
34
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
|
35
|
+
return Aws::Endpoints::Endpoint.new(url: "https://personalize-events-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
36
|
+
end
|
37
|
+
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
38
|
+
end
|
39
|
+
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
40
|
+
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
41
|
+
return Aws::Endpoints::Endpoint.new(url: "https://personalize-events.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
42
|
+
end
|
43
|
+
raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
|
44
|
+
end
|
45
|
+
return Aws::Endpoints::Endpoint.new(url: "https://personalize-events.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
21
46
|
end
|
22
|
-
|
23
|
-
end
|
47
|
+
raise ArgumentError, 'No endpoint could be resolved'
|
24
48
|
|
25
|
-
def resolve_endpoint(parameters)
|
26
|
-
@provider.resolve_endpoint(parameters)
|
27
49
|
end
|
28
|
-
|
29
|
-
# @api private
|
30
|
-
RULES = <<-JSON
|
31
|
-
eyJ2ZXJzaW9uIjoiMS4wIiwicGFyYW1ldGVycyI6eyJSZWdpb24iOnsiYnVp
|
32
|
-
bHRJbiI6IkFXUzo6UmVnaW9uIiwicmVxdWlyZWQiOmZhbHNlLCJkb2N1bWVu
|
33
|
-
dGF0aW9uIjoiVGhlIEFXUyByZWdpb24gdXNlZCB0byBkaXNwYXRjaCB0aGUg
|
34
|
-
cmVxdWVzdC4iLCJ0eXBlIjoiU3RyaW5nIn0sIlVzZUR1YWxTdGFjayI6eyJi
|
35
|
-
dWlsdEluIjoiQVdTOjpVc2VEdWFsU3RhY2siLCJyZXF1aXJlZCI6dHJ1ZSwi
|
36
|
-
ZGVmYXVsdCI6ZmFsc2UsImRvY3VtZW50YXRpb24iOiJXaGVuIHRydWUsIHVz
|
37
|
-
ZSB0aGUgZHVhbC1zdGFjayBlbmRwb2ludC4gSWYgdGhlIGNvbmZpZ3VyZWQg
|
38
|
-
ZW5kcG9pbnQgZG9lcyBub3Qgc3VwcG9ydCBkdWFsLXN0YWNrLCBkaXNwYXRj
|
39
|
-
aGluZyB0aGUgcmVxdWVzdCBNQVkgcmV0dXJuIGFuIGVycm9yLiIsInR5cGUi
|
40
|
-
OiJCb29sZWFuIn0sIlVzZUZJUFMiOnsiYnVpbHRJbiI6IkFXUzo6VXNlRklQ
|
41
|
-
UyIsInJlcXVpcmVkIjp0cnVlLCJkZWZhdWx0IjpmYWxzZSwiZG9jdW1lbnRh
|
42
|
-
dGlvbiI6IldoZW4gdHJ1ZSwgc2VuZCB0aGlzIHJlcXVlc3QgdG8gdGhlIEZJ
|
43
|
-
UFMtY29tcGxpYW50IHJlZ2lvbmFsIGVuZHBvaW50LiBJZiB0aGUgY29uZmln
|
44
|
-
dXJlZCBlbmRwb2ludCBkb2VzIG5vdCBoYXZlIGEgRklQUyBjb21wbGlhbnQg
|
45
|
-
ZW5kcG9pbnQsIGRpc3BhdGNoaW5nIHRoZSByZXF1ZXN0IHdpbGwgcmV0dXJu
|
46
|
-
IGFuIGVycm9yLiIsInR5cGUiOiJCb29sZWFuIn0sIkVuZHBvaW50Ijp7ImJ1
|
47
|
-
aWx0SW4iOiJTREs6OkVuZHBvaW50IiwicmVxdWlyZWQiOmZhbHNlLCJkb2N1
|
48
|
-
bWVudGF0aW9uIjoiT3ZlcnJpZGUgdGhlIGVuZHBvaW50IHVzZWQgdG8gc2Vu
|
49
|
-
ZCB0aGlzIHJlcXVlc3QiLCJ0eXBlIjoiU3RyaW5nIn19LCJydWxlcyI6W3si
|
50
|
-
Y29uZGl0aW9ucyI6W3siZm4iOiJhd3MucGFydGl0aW9uIiwiYXJndiI6W3si
|
51
|
-
cmVmIjoiUmVnaW9uIn1dLCJhc3NpZ24iOiJQYXJ0aXRpb25SZXN1bHQifV0s
|
52
|
-
InR5cGUiOiJ0cmVlIiwicnVsZXMiOlt7ImNvbmRpdGlvbnMiOlt7ImZuIjoi
|
53
|
-
aXNTZXQiLCJhcmd2IjpbeyJyZWYiOiJFbmRwb2ludCJ9XX0seyJmbiI6InBh
|
54
|
-
cnNlVVJMIiwiYXJndiI6W3sicmVmIjoiRW5kcG9pbnQifV0sImFzc2lnbiI6
|
55
|
-
InVybCJ9XSwidHlwZSI6InRyZWUiLCJydWxlcyI6W3siY29uZGl0aW9ucyI6
|
56
|
-
W3siZm4iOiJib29sZWFuRXF1YWxzIiwiYXJndiI6W3sicmVmIjoiVXNlRklQ
|
57
|
-
UyJ9LHRydWVdfV0sImVycm9yIjoiSW52YWxpZCBDb25maWd1cmF0aW9uOiBG
|
58
|
-
SVBTIGFuZCBjdXN0b20gZW5kcG9pbnQgYXJlIG5vdCBzdXBwb3J0ZWQiLCJ0
|
59
|
-
eXBlIjoiZXJyb3IifSx7ImNvbmRpdGlvbnMiOltdLCJ0eXBlIjoidHJlZSIs
|
60
|
-
InJ1bGVzIjpbeyJjb25kaXRpb25zIjpbeyJmbiI6ImJvb2xlYW5FcXVhbHMi
|
61
|
-
LCJhcmd2IjpbeyJyZWYiOiJVc2VEdWFsU3RhY2sifSx0cnVlXX1dLCJlcnJv
|
62
|
-
ciI6IkludmFsaWQgQ29uZmlndXJhdGlvbjogRHVhbHN0YWNrIGFuZCBjdXN0
|
63
|
-
b20gZW5kcG9pbnQgYXJlIG5vdCBzdXBwb3J0ZWQiLCJ0eXBlIjoiZXJyb3Ii
|
64
|
-
fSx7ImNvbmRpdGlvbnMiOltdLCJlbmRwb2ludCI6eyJ1cmwiOnsicmVmIjoi
|
65
|
-
RW5kcG9pbnQifSwicHJvcGVydGllcyI6e30sImhlYWRlcnMiOnt9fSwidHlw
|
66
|
-
ZSI6ImVuZHBvaW50In1dfV19LHsiY29uZGl0aW9ucyI6W3siZm4iOiJib29s
|
67
|
-
ZWFuRXF1YWxzIiwiYXJndiI6W3sicmVmIjoiVXNlRklQUyJ9LHRydWVdfSx7
|
68
|
-
ImZuIjoiYm9vbGVhbkVxdWFscyIsImFyZ3YiOlt7InJlZiI6IlVzZUR1YWxT
|
69
|
-
dGFjayJ9LHRydWVdfV0sInR5cGUiOiJ0cmVlIiwicnVsZXMiOlt7ImNvbmRp
|
70
|
-
dGlvbnMiOlt7ImZuIjoiYm9vbGVhbkVxdWFscyIsImFyZ3YiOlt0cnVlLHsi
|
71
|
-
Zm4iOiJnZXRBdHRyIiwiYXJndiI6W3sicmVmIjoiUGFydGl0aW9uUmVzdWx0
|
72
|
-
In0sInN1cHBvcnRzRklQUyJdfV19LHsiZm4iOiJib29sZWFuRXF1YWxzIiwi
|
73
|
-
YXJndiI6W3RydWUseyJmbiI6ImdldEF0dHIiLCJhcmd2IjpbeyJyZWYiOiJQ
|
74
|
-
YXJ0aXRpb25SZXN1bHQifSwic3VwcG9ydHNEdWFsU3RhY2siXX1dfV0sInR5
|
75
|
-
cGUiOiJ0cmVlIiwicnVsZXMiOlt7ImNvbmRpdGlvbnMiOltdLCJlbmRwb2lu
|
76
|
-
dCI6eyJ1cmwiOiJodHRwczovL3BlcnNvbmFsaXplLWV2ZW50cy1maXBzLntS
|
77
|
-
ZWdpb259LntQYXJ0aXRpb25SZXN1bHQjZHVhbFN0YWNrRG5zU3VmZml4fSIs
|
78
|
-
InByb3BlcnRpZXMiOnt9LCJoZWFkZXJzIjp7fX0sInR5cGUiOiJlbmRwb2lu
|
79
|
-
dCJ9XX0seyJjb25kaXRpb25zIjpbXSwiZXJyb3IiOiJGSVBTIGFuZCBEdWFs
|
80
|
-
U3RhY2sgYXJlIGVuYWJsZWQsIGJ1dCB0aGlzIHBhcnRpdGlvbiBkb2VzIG5v
|
81
|
-
dCBzdXBwb3J0IG9uZSBvciBib3RoIiwidHlwZSI6ImVycm9yIn1dfSx7ImNv
|
82
|
-
bmRpdGlvbnMiOlt7ImZuIjoiYm9vbGVhbkVxdWFscyIsImFyZ3YiOlt7InJl
|
83
|
-
ZiI6IlVzZUZJUFMifSx0cnVlXX1dLCJ0eXBlIjoidHJlZSIsInJ1bGVzIjpb
|
84
|
-
eyJjb25kaXRpb25zIjpbeyJmbiI6ImJvb2xlYW5FcXVhbHMiLCJhcmd2Ijpb
|
85
|
-
dHJ1ZSx7ImZuIjoiZ2V0QXR0ciIsImFyZ3YiOlt7InJlZiI6IlBhcnRpdGlv
|
86
|
-
blJlc3VsdCJ9LCJzdXBwb3J0c0ZJUFMiXX1dfV0sInR5cGUiOiJ0cmVlIiwi
|
87
|
-
cnVsZXMiOlt7ImNvbmRpdGlvbnMiOltdLCJlbmRwb2ludCI6eyJ1cmwiOiJo
|
88
|
-
dHRwczovL3BlcnNvbmFsaXplLWV2ZW50cy1maXBzLntSZWdpb259LntQYXJ0
|
89
|
-
aXRpb25SZXN1bHQjZG5zU3VmZml4fSIsInByb3BlcnRpZXMiOnt9LCJoZWFk
|
90
|
-
ZXJzIjp7fX0sInR5cGUiOiJlbmRwb2ludCJ9XX0seyJjb25kaXRpb25zIjpb
|
91
|
-
XSwiZXJyb3IiOiJGSVBTIGlzIGVuYWJsZWQgYnV0IHRoaXMgcGFydGl0aW9u
|
92
|
-
IGRvZXMgbm90IHN1cHBvcnQgRklQUyIsInR5cGUiOiJlcnJvciJ9XX0seyJj
|
93
|
-
b25kaXRpb25zIjpbeyJmbiI6ImJvb2xlYW5FcXVhbHMiLCJhcmd2IjpbeyJy
|
94
|
-
ZWYiOiJVc2VEdWFsU3RhY2sifSx0cnVlXX1dLCJ0eXBlIjoidHJlZSIsInJ1
|
95
|
-
bGVzIjpbeyJjb25kaXRpb25zIjpbeyJmbiI6ImJvb2xlYW5FcXVhbHMiLCJh
|
96
|
-
cmd2IjpbdHJ1ZSx7ImZuIjoiZ2V0QXR0ciIsImFyZ3YiOlt7InJlZiI6IlBh
|
97
|
-
cnRpdGlvblJlc3VsdCJ9LCJzdXBwb3J0c0R1YWxTdGFjayJdfV19XSwidHlw
|
98
|
-
ZSI6InRyZWUiLCJydWxlcyI6W3siY29uZGl0aW9ucyI6W10sImVuZHBvaW50
|
99
|
-
Ijp7InVybCI6Imh0dHBzOi8vcGVyc29uYWxpemUtZXZlbnRzLntSZWdpb259
|
100
|
-
LntQYXJ0aXRpb25SZXN1bHQjZHVhbFN0YWNrRG5zU3VmZml4fSIsInByb3Bl
|
101
|
-
cnRpZXMiOnt9LCJoZWFkZXJzIjp7fX0sInR5cGUiOiJlbmRwb2ludCJ9XX0s
|
102
|
-
eyJjb25kaXRpb25zIjpbXSwiZXJyb3IiOiJEdWFsU3RhY2sgaXMgZW5hYmxl
|
103
|
-
ZCBidXQgdGhpcyBwYXJ0aXRpb24gZG9lcyBub3Qgc3VwcG9ydCBEdWFsU3Rh
|
104
|
-
Y2siLCJ0eXBlIjoiZXJyb3IifV19LHsiY29uZGl0aW9ucyI6W10sImVuZHBv
|
105
|
-
aW50Ijp7InVybCI6Imh0dHBzOi8vcGVyc29uYWxpemUtZXZlbnRzLntSZWdp
|
106
|
-
b259LntQYXJ0aXRpb25SZXN1bHQjZG5zU3VmZml4fSIsInByb3BlcnRpZXMi
|
107
|
-
Ont9LCJoZWFkZXJzIjp7fX0sInR5cGUiOiJlbmRwb2ludCJ9XX1dfQ==
|
108
|
-
|
109
|
-
JSON
|
110
50
|
end
|
111
51
|
end
|
@@ -13,20 +13,6 @@ module Aws::PersonalizeEvents
|
|
13
13
|
# Represents user interaction event information sent using the
|
14
14
|
# `PutEvents` API.
|
15
15
|
#
|
16
|
-
# @note When making an API call, you may pass Event
|
17
|
-
# data as a hash:
|
18
|
-
#
|
19
|
-
# {
|
20
|
-
# event_id: "StringType",
|
21
|
-
# event_type: "StringType", # required
|
22
|
-
# event_value: 1.0,
|
23
|
-
# item_id: "ItemId",
|
24
|
-
# properties: "EventPropertiesJSON",
|
25
|
-
# sent_at: Time.now, # required
|
26
|
-
# recommendation_id: "RecommendationId",
|
27
|
-
# impression: ["ItemId"],
|
28
|
-
# }
|
29
|
-
#
|
30
16
|
# @!attribute [rw] event_id
|
31
17
|
# An ID associated with the event. If an event ID is not provided,
|
32
18
|
# Amazon Personalize generates a unique ID for the event. An event ID
|
@@ -73,14 +59,44 @@ module Aws::PersonalizeEvents
|
|
73
59
|
# @return [Time]
|
74
60
|
#
|
75
61
|
# @!attribute [rw] recommendation_id
|
76
|
-
# The ID of the
|
62
|
+
# The ID of the list of recommendations that contains the item the
|
63
|
+
# user interacted with. Provide a `recommendationId` to have Amazon
|
64
|
+
# Personalize implicitly record the recommendations you show your user
|
65
|
+
# as impressions data. Or provide a `recommendationId` if you use a
|
66
|
+
# metric attribution to measure the impact of recommendations.
|
67
|
+
#
|
68
|
+
# For more information on recording impressions data, see [Recording
|
69
|
+
# impressions data][1]. For more information on creating a metric
|
70
|
+
# attribution see [Measuring impact of recommendations][2].
|
71
|
+
#
|
72
|
+
#
|
73
|
+
#
|
74
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data
|
75
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
77
76
|
# @return [String]
|
78
77
|
#
|
79
78
|
# @!attribute [rw] impression
|
80
79
|
# A list of item IDs that represents the sequence of items you have
|
81
80
|
# shown the user. For example, `["itemId1", "itemId2", "itemId3"]`.
|
81
|
+
# Provide a list of items to manually record impressions data for an
|
82
|
+
# event. For more information on recording impressions data, see
|
83
|
+
# [Recording impressions data][1].
|
84
|
+
#
|
85
|
+
#
|
86
|
+
#
|
87
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data
|
82
88
|
# @return [Array<String>]
|
83
89
|
#
|
90
|
+
# @!attribute [rw] metric_attribution
|
91
|
+
# Contains information about the metric attribution associated with an
|
92
|
+
# event. For more information about metric attributions, see
|
93
|
+
# [Measuring impact of recommendations][1].
|
94
|
+
#
|
95
|
+
#
|
96
|
+
#
|
97
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
98
|
+
# @return [Types::MetricAttribution]
|
99
|
+
#
|
84
100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Event AWS API Documentation
|
85
101
|
#
|
86
102
|
class Event < Struct.new(
|
@@ -91,8 +107,9 @@ module Aws::PersonalizeEvents
|
|
91
107
|
:properties,
|
92
108
|
:sent_at,
|
93
109
|
:recommendation_id,
|
94
|
-
:impression
|
95
|
-
|
110
|
+
:impression,
|
111
|
+
:metric_attribution)
|
112
|
+
SENSITIVE = [:item_id, :properties]
|
96
113
|
include Aws::Structure
|
97
114
|
end
|
98
115
|
|
@@ -117,14 +134,6 @@ module Aws::PersonalizeEvents
|
|
117
134
|
#
|
118
135
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html
|
119
136
|
#
|
120
|
-
# @note When making an API call, you may pass Item
|
121
|
-
# data as a hash:
|
122
|
-
#
|
123
|
-
# {
|
124
|
-
# item_id: "StringType", # required
|
125
|
-
# properties: "ItemProperties",
|
126
|
-
# }
|
127
|
-
#
|
128
137
|
# @!attribute [rw] item_id
|
129
138
|
# The ID associated with the item.
|
130
139
|
# @return [String]
|
@@ -147,31 +156,30 @@ module Aws::PersonalizeEvents
|
|
147
156
|
class Item < Struct.new(
|
148
157
|
:item_id,
|
149
158
|
:properties)
|
150
|
-
SENSITIVE = []
|
159
|
+
SENSITIVE = [:properties]
|
151
160
|
include Aws::Structure
|
152
161
|
end
|
153
162
|
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
# {
|
158
|
-
# tracking_id: "StringType", # required
|
159
|
-
# user_id: "UserId",
|
160
|
-
# session_id: "StringType", # required
|
161
|
-
# event_list: [ # required
|
162
|
-
# {
|
163
|
-
# event_id: "StringType",
|
164
|
-
# event_type: "StringType", # required
|
165
|
-
# event_value: 1.0,
|
166
|
-
# item_id: "ItemId",
|
167
|
-
# properties: "EventPropertiesJSON",
|
168
|
-
# sent_at: Time.now, # required
|
169
|
-
# recommendation_id: "RecommendationId",
|
170
|
-
# impression: ["ItemId"],
|
171
|
-
# },
|
172
|
-
# ],
|
173
|
-
# }
|
163
|
+
# Contains information about a metric attribution associated with an
|
164
|
+
# event. For more information about metric attributions, see [Measuring
|
165
|
+
# impact of recommendations][1].
|
174
166
|
#
|
167
|
+
#
|
168
|
+
#
|
169
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
|
170
|
+
#
|
171
|
+
# @!attribute [rw] event_attribution_source
|
172
|
+
# The source of the event, such as a third party.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/MetricAttribution AWS API Documentation
|
176
|
+
#
|
177
|
+
class MetricAttribution < Struct.new(
|
178
|
+
:event_attribution_source)
|
179
|
+
SENSITIVE = []
|
180
|
+
include Aws::Structure
|
181
|
+
end
|
182
|
+
|
175
183
|
# @!attribute [rw] tracking_id
|
176
184
|
# The tracking ID for the event. The ID is generated by a call to the
|
177
185
|
# [CreateEventTracker][1] API.
|
@@ -208,23 +216,10 @@ module Aws::PersonalizeEvents
|
|
208
216
|
:user_id,
|
209
217
|
:session_id,
|
210
218
|
:event_list)
|
211
|
-
SENSITIVE = []
|
219
|
+
SENSITIVE = [:user_id]
|
212
220
|
include Aws::Structure
|
213
221
|
end
|
214
222
|
|
215
|
-
# @note When making an API call, you may pass PutItemsRequest
|
216
|
-
# data as a hash:
|
217
|
-
#
|
218
|
-
# {
|
219
|
-
# dataset_arn: "Arn", # required
|
220
|
-
# items: [ # required
|
221
|
-
# {
|
222
|
-
# item_id: "StringType", # required
|
223
|
-
# properties: "ItemProperties",
|
224
|
-
# },
|
225
|
-
# ],
|
226
|
-
# }
|
227
|
-
#
|
228
223
|
# @!attribute [rw] dataset_arn
|
229
224
|
# The Amazon Resource Name (ARN) of the Items dataset you are adding
|
230
225
|
# the item or items to.
|
@@ -243,19 +238,6 @@ module Aws::PersonalizeEvents
|
|
243
238
|
include Aws::Structure
|
244
239
|
end
|
245
240
|
|
246
|
-
# @note When making an API call, you may pass PutUsersRequest
|
247
|
-
# data as a hash:
|
248
|
-
#
|
249
|
-
# {
|
250
|
-
# dataset_arn: "Arn", # required
|
251
|
-
# users: [ # required
|
252
|
-
# {
|
253
|
-
# user_id: "StringType", # required
|
254
|
-
# properties: "UserProperties",
|
255
|
-
# },
|
256
|
-
# ],
|
257
|
-
# }
|
258
|
-
#
|
259
241
|
# @!attribute [rw] dataset_arn
|
260
242
|
# The Amazon Resource Name (ARN) of the Users dataset you are adding
|
261
243
|
# the user or users to.
|
@@ -307,14 +289,6 @@ module Aws::PersonalizeEvents
|
|
307
289
|
#
|
308
290
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html
|
309
291
|
#
|
310
|
-
# @note When making an API call, you may pass User
|
311
|
-
# data as a hash:
|
312
|
-
#
|
313
|
-
# {
|
314
|
-
# user_id: "StringType", # required
|
315
|
-
# properties: "UserProperties",
|
316
|
-
# }
|
317
|
-
#
|
318
292
|
# @!attribute [rw] user_id
|
319
293
|
# The ID associated with the user.
|
320
294
|
# @return [String]
|
@@ -338,7 +312,7 @@ module Aws::PersonalizeEvents
|
|
338
312
|
class User < Struct.new(
|
339
313
|
:user_id,
|
340
314
|
:properties)
|
341
|
-
SENSITIVE = []
|
315
|
+
SENSITIVE = [:properties]
|
342
316
|
include Aws::Structure
|
343
317
|
end
|
344
318
|
|
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.30.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:
|
11
|
+
date: 2023-01-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|