aws-sdk-personalizeevents 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ef8b28cd60fa25a86092bfc88287b17184ef557e1ca297fb48843d23aa2341
-  data.tar.gz: a18efdcf7c1723a0ab8b6b88a5ec34b1920dc4c5b842feebd867451ea08386ea
+  metadata.gz: b0c509b86b648239c3070225e0757262480f0a3623a887e67cbe78ce8104a037
+  data.tar.gz: eec0f6099ad0d067e0c743ee9d4edc10e58ec8638596ee8ef482d696ede3b1d5
 SHA512:
-  metadata.gz: 2b074330a368b168c691264929675a9270be491135aa0c89b0c7fe42c10a6fb7b3f256f1bff0830e6cfbd848d54f6f8ccafa4239cd54e96e9db3129f2d256b7f
-  data.tar.gz: 9f5d4d280e75995a37c1104a90cb68f9c361871798e3308262f163402687e6eca4f99e6140126f0ac4f66ef0493e3844373e5bf24f91ed05d7c6e04d5050e55f
+  metadata.gz: 8ff73826cba180a4dba7e048bba530cb6ed8301e904fa846c01dc9a215188419f0ee538521e65da46d6421eec489ff60ab4821e95f21dd6aab08590227700159
+  data.tar.gz: 05d5da709ea58dfa2ca88a35b307a9941a6dc6c2aa4a706250184e04baff156b505daeaf6674ec72143d573c1ba454b48e1ef78af4b3c1183bc989eb9b897fcf

data/lib/aws-sdk-personalizeevents.rb

@@ -47,6 +47,6 @@ require_relative 'aws-sdk-personalizeevents/customizations'
 # @service
 module Aws::PersonalizeEvents
 
-  GEM_VERSION = '1.9.0'
+  GEM_VERSION = '1.10.0'
 
 end

data/lib/aws-sdk-personalizeevents/client.rb

@@ -312,7 +312,8 @@ module Aws::PersonalizeEvents
 
     # @!group API Operations
 
-    # Records user interaction event data.
+    # Records user interaction event data. For more information see
+    # event-record-api.
     #
     # @option params [required, String] :tracking_id
     #   The tracking ID for the event. The ID is generated by a call to the
@@ -326,7 +327,11 @@ module Aws::PersonalizeEvents
     #   The user associated with the event.
     #
     # @option params [required, String] :session_id
-    #   The session ID associated with the user's visit.
+    #   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
+    #   event-record-api.
     #
     # @option params [required, Array<Types::Event>] :event_list
     #   A list of event data from the session.
@@ -343,8 +348,12 @@ module Aws::PersonalizeEvents
     #       {
     #         event_id: "StringType",
     #         event_type: "StringType", # required
-    #         properties: "EventPropertiesJSON", # required
+    #         event_value: 1.0,
+    #         item_id: "ItemId",
+    #         properties: "EventPropertiesJSON",
     #         sent_at: Time.now, # required
+    #         recommendation_id: "RecommendationId",
+    #         impression: ["ItemId"],
     #       },
     #     ],
     #   })
@@ -371,7 +380,7 @@ module Aws::PersonalizeEvents
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeevents'
-      context[:gem_version] = '1.9.0'
+      context[:gem_version] = '1.10.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-personalizeevents/client_api.rb

@@ -18,19 +18,29 @@ module Aws::PersonalizeEvents
     Event = Shapes::StructureShape.new(name: 'Event')
     EventList = Shapes::ListShape.new(name: 'EventList')
     EventPropertiesJSON = Shapes::StringShape.new(name: 'EventPropertiesJSON')
+    FloatType = Shapes::FloatShape.new(name: 'FloatType')
+    Impression = Shapes::ListShape.new(name: 'Impression')
     InvalidInputException = Shapes::StructureShape.new(name: 'InvalidInputException')
+    ItemId = Shapes::StringShape.new(name: 'ItemId')
     PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
+    RecommendationId = Shapes::StringShape.new(name: 'RecommendationId')
     StringType = Shapes::StringShape.new(name: 'StringType')
     UserId = Shapes::StringShape.new(name: 'UserId')
 
     Event.add_member(:event_id, Shapes::ShapeRef.new(shape: StringType, location_name: "eventId"))
     Event.add_member(:event_type, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "eventType"))
-    Event.add_member(:properties, Shapes::ShapeRef.new(shape: EventPropertiesJSON, required: true, location_name: "properties", metadata: {"jsonvalue"=>true}))
+    Event.add_member(:event_value, Shapes::ShapeRef.new(shape: FloatType, location_name: "eventValue"))
+    Event.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemId, location_name: "itemId"))
+    Event.add_member(:properties, Shapes::ShapeRef.new(shape: EventPropertiesJSON, location_name: "properties", metadata: {"jsonvalue"=>true}))
     Event.add_member(:sent_at, Shapes::ShapeRef.new(shape: Date, required: true, location_name: "sentAt"))
+    Event.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: RecommendationId, location_name: "recommendationId"))
+    Event.add_member(:impression, Shapes::ShapeRef.new(shape: Impression, location_name: "impression"))
     Event.struct_class = Types::Event
 
     EventList.member = Shapes::ShapeRef.new(shape: Event)
 
+    Impression.member = Shapes::ShapeRef.new(shape: ItemId)
+
     InvalidInputException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     InvalidInputException.struct_class = Types::InvalidInputException
 

data/lib/aws-sdk-personalizeevents/types.rb

@@ -19,8 +19,12 @@ module Aws::PersonalizeEvents
     #       {
     #         event_id: "StringType",
     #         event_type: "StringType", # required
-    #         properties: "EventPropertiesJSON", # required
+    #         event_value: 1.0,
+    #         item_id: "ItemId",
+    #         properties: "EventPropertiesJSON",
     #         sent_at: Time.now, # required
+    #         recommendation_id: "RecommendationId",
+    #         impression: ["ItemId"],
     #       }
     #
     # @!attribute [rw] event_id
@@ -36,39 +40,57 @@ module Aws::PersonalizeEvents
     #   field of the Interactions schema.
     #   @return [String]
     #
+    # @!attribute [rw] event_value
+    #   The event value that corresponds to the `EVENT_VALUE` field of the
+    #   Interactions schema.
+    #   @return [Float]
+    #
+    # @!attribute [rw] item_id
+    #   The item ID key that corresponds to the `ITEM_ID` field of the
+    #   Interactions schema.
+    #   @return [String]
+    #
     # @!attribute [rw] properties
     #   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.
+    #   For example, if a user rates a movie on your site, other than movie
+    #   ID (`itemId`) and rating (`eventValue`) , you might also send the
+    #   number of movie ratings made by the user.
     #
     #   Each item in the map consists of a key-value pair. For example,
     #
-    #   `\{"itemId": "movie1"\}`
-    #
-    #   `\{"itemId": "movie2", "eventValue": "4.5"\}`
-    #
-    #   `\{"itemId": "movie3", "eventValue": "3", "numberOfRatings": "12"\}`
+    #   `\{"numberOfRatings": "12"\}`
     #
     #   The keys use camel case names that match the fields in the
-    #   Interactions schema. The `itemId` and `eventValue` keys correspond
-    #   to the `ITEM_ID` and `EVENT_VALUE` fields. In the above example, the
-    #   `eventType` might be 'MovieRating' with `eventValue` being the
-    #   rating. The `numberOfRatings` would match the
-    #   'NUMBER\_OF\_RATINGS' field defined in the Interactions schema.
+    #   Interactions schema. In the above example, the `numberOfRatings`
+    #   would match the 'NUMBER\_OF\_RATINGS' field defined in the
+    #   Interactions schema.
     #   @return [String]
     #
     # @!attribute [rw] sent_at
-    #   The timestamp on the client side when the event occurred.
+    #   The timestamp (in Unix time) on the client side when the event
+    #   occurred.
     #   @return [Time]
     #
+    # @!attribute [rw] recommendation_id
+    #   The ID of the recommendation.
+    #   @return [String]
+    #
+    # @!attribute [rw] impression
+    #   A list of item IDs that represents the sequence of items you have
+    #   shown the user. For example, `["itemId1", "itemId2", "itemId3"]`.
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Event AWS API Documentation
     #
     class Event < Struct.new(
       :event_id,
       :event_type,
+      :event_value,
+      :item_id,
       :properties,
-      :sent_at)
+      :sent_at,
+      :recommendation_id,
+      :impression)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -97,8 +119,12 @@ module Aws::PersonalizeEvents
     #           {
     #             event_id: "StringType",
     #             event_type: "StringType", # required
-    #             properties: "EventPropertiesJSON", # required
+    #             event_value: 1.0,
+    #             item_id: "ItemId",
+    #             properties: "EventPropertiesJSON",
     #             sent_at: Time.now, # required
+    #             recommendation_id: "RecommendationId",
+    #             impression: ["ItemId"],
     #           },
     #         ],
     #       }
@@ -117,7 +143,11 @@ module Aws::PersonalizeEvents
     #   @return [String]
     #
     # @!attribute [rw] session_id
-    #   The session ID associated with the user's visit.
+    #   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 event-record-api.
     #   @return [String]
     #
     # @!attribute [rw] event_list

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeevents
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core