aws-sdk-personalizeevents 1.7.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3095ea8f3c60bdce9ecc0a78c308919e001f80a4d03e1b364edd4428aeba7352
-  data.tar.gz: c586c4a6b4fe3af6047a47d5f079eeb548b98362ff17549ccd73af46339df05b
+  metadata.gz: 7561a805789e196dbf2a49baf1ea571808e19bd11ba21667747459a508f7a4c0
+  data.tar.gz: 3b19910f6869f3d996a70c2d603b07d104cb8600d8cc477dd3a5165f3daebdf2
 SHA512:
-  metadata.gz: 48072522efc14f8c248d39330af78c8396d1b7dffad1d501468991d62631d0951be2ac1c5ac1b6551c9ba2623bc0727044ba52a8be6a3c1faef64e3935d214bd
-  data.tar.gz: 62638bd607d3007378c4162913c74c6c0c4414b0f6bdd6974c1bafacad9715ca4087e3beb04377cd1d1b495f43356ecff51e3e6c1ebb33fb0735fb914a1b972e
+  metadata.gz: 18078ac42ff16b634ce6a75df349b7391f98444a0b23a1799d49b64af027917d513d17d09f262a547a1bc0e2b0f676be02fe6131fa3d34c2abadb95054187e5d
+  data.tar.gz: 90da864cf279865f7039a62b422c746da0403a9a56bee724e56331b2d7f0e764a1a8fd766d6985916a16e222c4b1d0950acce2a85befb04279b706b1b997bda3

data/lib/aws-sdk-personalizeevents.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -42,9 +45,9 @@ require_relative 'aws-sdk-personalizeevents/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::PersonalizeEvents
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.12.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
@@ -69,6 +72,7 @@ module Aws::PersonalizeEvents
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -81,13 +85,28 @@ module Aws::PersonalizeEvents
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -97,10 +116,10 @@ module Aws::PersonalizeEvents
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -161,7 +180,7 @@ module Aws::PersonalizeEvents
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be a valid HTTP(S) URI.
+    #     to test or custom endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -308,7 +327,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
@@ -322,7 +342,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.
@@ -339,8 +363,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"],
     #       },
     #     ],
     #   })
@@ -367,7 +395,7 @@ module Aws::PersonalizeEvents
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeevents'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.12.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -16,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/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -17,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
@@ -34,39 +40,58 @@ 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
 
@@ -79,6 +104,7 @@ module Aws::PersonalizeEvents
     #
     class InvalidInputException < Struct.new(
       :message)
+      SENSITIVE = []
       include Aws::Structure
     end
 
@@ -93,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"],
     #           },
     #         ],
     #       }
@@ -113,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
@@ -127,6 +161,7 @@ module Aws::PersonalizeEvents
       :user_id,
       :session_id,
       :event_list)
+      SENSITIVE = []
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeevents
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-28 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement