Amazon Personalize Events Update: Adds support implicit and explicit impression input

Author: AWS

.changes/next-release/feature-AmazonPersonalizeEvents-5cdd6cc.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "Amazon Personalize Events",
+    "description": "Adds support implicit and explicit impression input"
+}

services/personalizeevents/src/main/resources/codegen-resources/service-2.json

@@ -22,7 +22,7 @@
       "errors":[
         {"shape":"InvalidInputException"}
       ],
-      "documentation":"<p>Records user interaction event data.</p>"
+      "documentation":"<p>Records user interaction event data. For more information see <a>event-record-api</a>.</p>"
     }
   },
   "shapes":{
@@ -32,7 +32,6 @@
       "type":"structure",
       "required":[
         "eventType",
-        "properties",
         "sentAt"
       ],
       "members":{
@@ -44,14 +43,30 @@
           "shape":"StringType",
           "documentation":"<p>The type of event. This property corresponds to the <code>EVENT_TYPE</code> field of the Interactions schema.</p>"
         },
+        "eventValue":{
+          "shape":"FloatType",
+          "documentation":"<p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Interactions schema.</p>"
+        },
+        "itemId":{
+          "shape":"ItemId",
+          "documentation":"<p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Interactions schema.</p>"
+        },
         "properties":{
           "shape":"EventPropertiesJSON",
-          "documentation":"<p>A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, you might send the movie ID and rating, and the number of movie ratings made by the user.</p> <p>Each item in the map consists of a key-value pair. For example,</p> <p> <code>{\"itemId\": \"movie1\"}</code> </p> <p> <code>{\"itemId\": \"movie2\", \"eventValue\": \"4.5\"}</code> </p> <p> <code>{\"itemId\": \"movie3\", \"eventValue\": \"3\", \"numberOfRatings\": \"12\"}</code> </p> <p>The keys use camel case names that match the fields in the Interactions schema. The <code>itemId</code> and <code>eventValue</code> keys correspond to the <code>ITEM_ID</code> and <code>EVENT_VALUE</code> fields. In the above example, the <code>eventType</code> might be 'MovieRating' with <code>eventValue</code> being the rating. The <code>numberOfRatings</code> would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>",
+          "documentation":"<p>A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (<code>itemId</code>) and rating (<code>eventValue</code>) , you might also send the number of movie ratings made by the user.</p> <p>Each item in the map consists of a key-value pair. For example,</p> <p> <code>{\"numberOfRatings\": \"12\"}</code> </p> <p>The keys use camel case names that match the fields in the Interactions schema. In the above example, the <code>numberOfRatings</code> would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.</p>",
           "jsonvalue":true
         },
         "sentAt":{
           "shape":"Date",
-          "documentation":"<p>The timestamp on the client side when the event occurred.</p>"
+          "documentation":"<p>The timestamp (in Unix time) on the client side when the event occurred.</p>"
+        },
+        "recommendationId":{
+          "shape":"RecommendationId",
+          "documentation":"<p>The ID of the recommendation.</p>"
+        },
+        "impression":{
+          "shape":"Impression",
+          "documentation":"<p>A list of item IDs that represents the sequence of items you have shown the user. For example, <code>[\"itemId1\", \"itemId2\", \"itemId3\"]</code>.</p>"
         }
       },
       "documentation":"<p>Represents user interaction event information sent using the <code>PutEvents</code> API.</p>"
@@ -67,6 +82,13 @@
       "max":1024,
       "min":1
     },
+    "FloatType":{"type":"float"},
+    "Impression":{
+      "type":"list",
+      "member":{"shape":"ItemId"},
+      "max":25,
+      "min":1
+    },
     "InvalidInputException":{
       "type":"structure",
       "members":{
@@ -76,6 +98,11 @@
       "error":{"httpStatusCode":400},
       "exception":true
     },
+    "ItemId":{
+      "type":"string",
+      "max":256,
+      "min":1
+    },
     "PutEventsRequest":{
       "type":"structure",
       "required":[
@@ -94,14 +121,19 @@
         },
         "sessionId":{
           "shape":"StringType",
-          "documentation":"<p>The session ID associated with the user's visit.</p>"
+          "documentation":"<p>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 <a>event-record-api</a>.</p>"
         },
         "eventList":{
           "shape":"EventList",
           "documentation":"<p>A list of event data from the session.</p>"
         }
       }
     },
+    "RecommendationId":{
+      "type":"string",
+      "max":40,
+      "min":1
+    },
     "StringType":{
       "type":"string",
       "max":256,
@@ -113,5 +145,5 @@
       "min":1
     }
   },
-  "documentation":"<p/>"
+  "documentation":"<p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use it for model training either alone or combined with historical data. For more information see <a>recording-events</a>.</p>"
 }