aws-sdk-personalizeevents 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837d2e7a291a233b0ef5b48bc32c92b9583e7286e7d880f0f41295f184dd6979
-  data.tar.gz: 4ee8e46dec916f735d9865d84ef9aa60f91e421626d452b8ed72225ae613e919
+  metadata.gz: 8735f0d987228ae5e853e3729d7266a48d19360ac596c036ddb56920ad3955a5
+  data.tar.gz: 2cd912a21f0971aef32ef62b8f3d989fdb57d447b9553b41fb6f1933284fff80
 SHA512:
-  metadata.gz: 6b29065e0e4f9436320224e46484304de9c058bcc9280c761596eee4d79f1b3f22bb2bb22adf38a84dc1370629089de0b04333652da3c00237a1f607ebbc0845
-  data.tar.gz: f40e488ee1d9bcce94725ba48bb56e1c648807369459742ac81f977d419cb69f24b0b4ba568c0d5ef6509f4e582ef9817799962e1bc6a5041efb9a9f9c5db97e
+  metadata.gz: 5811a90d12f8ec89032627cf3620add3eb82fc6020aae1714f897028af0352c2e18a1c2227acdc74a4b60999e1b1be1d2f6c0c4cbc55e58328b78ae2cece70f4
+  data.tar.gz: 20a2bf8275b3e148c02bb9b310ac8068f858f26eec83e4f1064e83dc1c819db5995631d711a45533314fb6221e10935e319bb7c086a27284372df596a84011b2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.29.0 (2022-11-16)
+------------------
+
+* Feature - This release provides support for creation and use of metric attributions in AWS Personalize
+
 1.28.0 (2022-10-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.28.0
+1.29.0

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

@@ -418,6 +418,9 @@ module Aws::PersonalizeEvents
     #         sent_at: Time.now, # required
     #         recommendation_id: "RecommendationId",
     #         impression: ["ItemId"],
+    #         metric_attribution: {
+    #           event_attribution_source: "EventAttributionSource", # required
+    #         },
     #       },
     #     ],
     #   })
@@ -518,7 +521,7 @@ module Aws::PersonalizeEvents
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeevents'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -17,6 +17,7 @@ module Aws::PersonalizeEvents
     Date = Shapes::TimestampShape.new(name: 'Date')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     Event = Shapes::StructureShape.new(name: 'Event')
+    EventAttributionSource = Shapes::StringShape.new(name: 'EventAttributionSource')
     EventList = Shapes::ListShape.new(name: 'EventList')
     EventPropertiesJSON = Shapes::StringShape.new(name: 'EventPropertiesJSON')
     FloatType = Shapes::FloatShape.new(name: 'FloatType')
@@ -26,6 +27,7 @@ module Aws::PersonalizeEvents
     ItemId = Shapes::StringShape.new(name: 'ItemId')
     ItemList = Shapes::ListShape.new(name: 'ItemList')
     ItemProperties = Shapes::StringShape.new(name: 'ItemProperties')
+    MetricAttribution = Shapes::StructureShape.new(name: 'MetricAttribution')
     PutEventsRequest = Shapes::StructureShape.new(name: 'PutEventsRequest')
     PutItemsRequest = Shapes::StructureShape.new(name: 'PutItemsRequest')
     PutUsersRequest = Shapes::StructureShape.new(name: 'PutUsersRequest')
@@ -46,6 +48,7 @@ module Aws::PersonalizeEvents
     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.add_member(:metric_attribution, Shapes::ShapeRef.new(shape: MetricAttribution, location_name: "metricAttribution"))
     Event.struct_class = Types::Event
 
     EventList.member = Shapes::ShapeRef.new(shape: Event)
@@ -61,6 +64,9 @@ module Aws::PersonalizeEvents
 
     ItemList.member = Shapes::ShapeRef.new(shape: Item)
 
+    MetricAttribution.add_member(:event_attribution_source, Shapes::ShapeRef.new(shape: EventAttributionSource, required: true, location_name: "eventAttributionSource"))
+    MetricAttribution.struct_class = Types::MetricAttribution
+
     PutEventsRequest.add_member(:tracking_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "trackingId"))
     PutEventsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserId, location_name: "userId"))
     PutEventsRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "sessionId"))

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

@@ -25,6 +25,9 @@ module Aws::PersonalizeEvents
     #         sent_at: Time.now, # required
     #         recommendation_id: "RecommendationId",
     #         impression: ["ItemId"],
+    #         metric_attribution: {
+    #           event_attribution_source: "EventAttributionSource", # required
+    #         },
     #       }
     #
     # @!attribute [rw] event_id
@@ -73,14 +76,44 @@ module Aws::PersonalizeEvents
     #   @return [Time]
     #
     # @!attribute [rw] recommendation_id
-    #   The ID of the recommendation.
+    #   The ID of the list of recommendations that contains the item the
+    #   user interacted with. Provide a `recommendationId` to have Amazon
+    #   Personalize implicitly record the recommendations you show your user
+    #   as impressions data. Or provide a `recommendationId` if you use a
+    #   metric attribution to measure the impact of recommendations.
+    #
+    #   For more information on recording impressions data, see [Recording
+    #   impressions data][1]. For more information on creating a metric
+    #   attribution see [Measuring impact of recommendations][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data
+    #   [2]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
     #   @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"]`.
+    #   Provide a list of items to manually record impressions data for an
+    #   event. For more information on recording impressions data, see
+    #   [Recording impressions data][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data
     #   @return [Array<String>]
     #
+    # @!attribute [rw] metric_attribution
+    #   Contains information about the metric attribution associated with an
+    #   event. For more information about metric attributions, see
+    #   [Measuring impact of recommendations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
+    #   @return [Types::MetricAttribution]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/Event AWS API Documentation
     #
     class Event < Struct.new(
@@ -91,8 +124,9 @@ module Aws::PersonalizeEvents
       :properties,
       :sent_at,
       :recommendation_id,
-      :impression)
-      SENSITIVE = []
+      :impression,
+      :metric_attribution)
+      SENSITIVE = [:item_id, :properties]
       include Aws::Structure
     end
 
@@ -147,6 +181,33 @@ module Aws::PersonalizeEvents
     class Item < Struct.new(
       :item_id,
       :properties)
+      SENSITIVE = [:properties]
+      include Aws::Structure
+    end
+
+    # Contains information about a metric attribution associated with an
+    # event. For more information about metric attributions, see [Measuring
+    # impact of recommendations][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
+    #
+    # @note When making an API call, you may pass MetricAttribution
+    #   data as a hash:
+    #
+    #       {
+    #         event_attribution_source: "EventAttributionSource", # required
+    #       }
+    #
+    # @!attribute [rw] event_attribution_source
+    #   The source of the event, such as a third party.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-events-2018-03-22/MetricAttribution AWS API Documentation
+    #
+    class MetricAttribution < Struct.new(
+      :event_attribution_source)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -168,6 +229,9 @@ module Aws::PersonalizeEvents
     #             sent_at: Time.now, # required
     #             recommendation_id: "RecommendationId",
     #             impression: ["ItemId"],
+    #             metric_attribution: {
+    #               event_attribution_source: "EventAttributionSource", # required
+    #             },
     #           },
     #         ],
     #       }
@@ -208,7 +272,7 @@ module Aws::PersonalizeEvents
       :user_id,
       :session_id,
       :event_list)
-      SENSITIVE = []
+      SENSITIVE = [:user_id]
       include Aws::Structure
     end
 
@@ -338,7 +402,7 @@ module Aws::PersonalizeEvents
     class User < Struct.new(
       :user_id,
       :properties)
-      SENSITIVE = []
+      SENSITIVE = [:properties]
       include Aws::Structure
     end
 

data/lib/aws-sdk-personalizeevents.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalizeevents/customizations'
 # @!group service
 module Aws::PersonalizeEvents
 
-  GEM_VERSION = '1.28.0'
+  GEM_VERSION = '1.29.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeevents
 version: !ruby/object:Gem::Version
-  version: 1.28.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core