aws-sdk-personalize 1.79.0 → 1.80.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccde37a1846e44b941c5c1365e7f7cfa2066906b03cb5e3eb546560050eddb46
-  data.tar.gz: 862795db6e148698597d37f8482b77950012c1cd7fba4a282aaa0c12bcf0b404
+  metadata.gz: c0bcb5d3d3fea0384d2fd07194e367ae52e713060d39d8d1eff58fc460610b51
+  data.tar.gz: d256a4fe1c74237bd8e82b53766ec06c6681b1a67111f6f25335dcc475090001
 SHA512:
-  metadata.gz: 2c5b79172a5c49791278649554bef9ff117e13168b85ab2e1d3cd28a8b0582a452fec0ca78211e55367c775b4120bd8a7685611b4e4ba6a857c9cb01ae8aabe1
-  data.tar.gz: ed20d66e4952f7e4fd37cfd4e68c4046c0c199d2a0b63ad0b98289d54452ac897c7e5a75aa1ba7226758ad903f8b7596640d1ed36756bc02aaf17eb30dd63a4d
+  metadata.gz: 9c77f3c9f452a857b3122496618235a948fb7a3f68d14b2a4e5ff8cc35fa323756723b2d6fea1b364a8357a8a0ebaba18e95a32e6f72aa95becb76344f47901e
+  data.tar.gz: bc4ca147516b798002f8d8ab2c86bf3dbcdaf60296f57cec81cd51f6c57807ef4711c2b7e01b591b54c7ea30c9a48a890f78dfc5a1742254547c49f74153c979

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.80.0 (2025-04-07)
+------------------
+
+* Feature - Add support for eventsConfig for CreateSolution, UpdateSolution, DescribeSolution, DescribeSolutionVersion. Add support for GetSolutionMetrics to return weighted NDCG metrics when eventsConfig is enabled for the solution.
+
 1.79.0 (2025-02-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.79.0
+1.80.0

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

@@ -2097,6 +2097,15 @@ module Aws::Personalize
     #         metric_name: "MetricName",
     #         recipe_list: ["Arn"],
     #       },
+    #       events_config: {
+    #         event_parameters_list: [
+    #           {
+    #             event_type: "EventType",
+    #             event_value_threshold: 1.0,
+    #             weight: 1.0,
+    #           },
+    #         ],
+    #       },
     #       optimization_objective: {
     #         item_attribute: "ItemAttribute",
     #         objective_sensitivity: "LOW", # accepts LOW, MEDIUM, HIGH, OFF
@@ -2286,12 +2295,12 @@ module Aws::Personalize
 
     # Deletes a dataset. You can't delete a dataset if an associated
     # `DatasetImportJob` or `SolutionVersion` is in the CREATE PENDING or IN
-    # PROGRESS state. For more information on datasets, see
-    # [CreateDataset][1].
+    # PROGRESS state. For more information about deleting datasets, see
+    # [Deleting a dataset][1].
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/delete-dataset.html
     #
     # @option params [required, String] :dataset_arn
     #   The Amazon Resource Name (ARN) of the dataset to delete.
@@ -3301,6 +3310,10 @@ module Aws::Personalize
     #   resp.solution.solution_config.auto_ml_config.metric_name #=> String
     #   resp.solution.solution_config.auto_ml_config.recipe_list #=> Array
     #   resp.solution.solution_config.auto_ml_config.recipe_list[0] #=> String
+    #   resp.solution.solution_config.events_config.event_parameters_list #=> Array
+    #   resp.solution.solution_config.events_config.event_parameters_list[0].event_type #=> String
+    #   resp.solution.solution_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
+    #   resp.solution.solution_config.events_config.event_parameters_list[0].weight #=> Float
     #   resp.solution.solution_config.optimization_objective.item_attribute #=> String
     #   resp.solution.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
     #   resp.solution.solution_config.training_data_config.excluded_dataset_columns #=> Hash
@@ -3319,6 +3332,10 @@ module Aws::Personalize
     #   resp.solution.latest_solution_version.last_updated_date_time #=> Time
     #   resp.solution.latest_solution_version.failure_reason #=> String
     #   resp.solution.latest_solution_update.solution_update_config.auto_training_config.scheduling_expression #=> String
+    #   resp.solution.latest_solution_update.solution_update_config.events_config.event_parameters_list #=> Array
+    #   resp.solution.latest_solution_update.solution_update_config.events_config.event_parameters_list[0].event_type #=> String
+    #   resp.solution.latest_solution_update.solution_update_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
+    #   resp.solution.latest_solution_update.solution_update_config.events_config.event_parameters_list[0].weight #=> Float
     #   resp.solution.latest_solution_update.status #=> String
     #   resp.solution.latest_solution_update.perform_auto_training #=> Boolean
     #   resp.solution.latest_solution_update.creation_date_time #=> Time
@@ -3389,6 +3406,10 @@ module Aws::Personalize
     #   resp.solution_version.solution_config.auto_ml_config.metric_name #=> String
     #   resp.solution_version.solution_config.auto_ml_config.recipe_list #=> Array
     #   resp.solution_version.solution_config.auto_ml_config.recipe_list[0] #=> String
+    #   resp.solution_version.solution_config.events_config.event_parameters_list #=> Array
+    #   resp.solution_version.solution_config.events_config.event_parameters_list[0].event_type #=> String
+    #   resp.solution_version.solution_config.events_config.event_parameters_list[0].event_value_threshold #=> Float
+    #   resp.solution_version.solution_config.events_config.event_parameters_list[0].weight #=> Float
     #   resp.solution_version.solution_config.optimization_objective.item_attribute #=> String
     #   resp.solution_version.solution_config.optimization_objective.objective_sensitivity #=> String, one of "LOW", "MEDIUM", "HIGH", "OFF"
     #   resp.solution_version.solution_config.training_data_config.excluded_dataset_columns #=> Hash
@@ -4855,6 +4876,15 @@ module Aws::Personalize
     #       auto_training_config: {
     #         scheduling_expression: "SchedulingExpression",
     #       },
+    #       events_config: {
+    #         event_parameters_list: [
+    #           {
+    #             event_type: "EventType",
+    #             event_value_threshold: 1.0,
+    #             weight: 1.0,
+    #           },
+    #         ],
+    #       },
     #     },
     #   })
     #
@@ -4889,7 +4919,7 @@ module Aws::Personalize
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.79.0'
+      context[:gem_version] = '1.80.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -159,11 +159,16 @@ module Aws::Personalize
     DockerURI = Shapes::StringShape.new(name: 'DockerURI')
     Domain = Shapes::StringShape.new(name: 'Domain')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
+    EventParameters = Shapes::StructureShape.new(name: 'EventParameters')
+    EventParametersList = Shapes::ListShape.new(name: 'EventParametersList')
     EventTracker = Shapes::StructureShape.new(name: 'EventTracker')
     EventTrackerSummary = Shapes::StructureShape.new(name: 'EventTrackerSummary')
     EventTrackers = Shapes::ListShape.new(name: 'EventTrackers')
     EventType = Shapes::StringShape.new(name: 'EventType')
+    EventTypeThresholdValue = Shapes::FloatShape.new(name: 'EventTypeThresholdValue')
+    EventTypeWeight = Shapes::FloatShape.new(name: 'EventTypeWeight')
     EventValueThreshold = Shapes::StringShape.new(name: 'EventValueThreshold')
+    EventsConfig = Shapes::StructureShape.new(name: 'EventsConfig')
     ExcludedDatasetColumns = Shapes::MapShape.new(name: 'ExcludedDatasetColumns')
     FailureReason = Shapes::StringShape.new(name: 'FailureReason')
     FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
@@ -935,6 +940,13 @@ module Aws::Personalize
     DescribeSolutionVersionResponse.add_member(:solution_version, Shapes::ShapeRef.new(shape: SolutionVersion, location_name: "solutionVersion"))
     DescribeSolutionVersionResponse.struct_class = Types::DescribeSolutionVersionResponse
 
+    EventParameters.add_member(:event_type, Shapes::ShapeRef.new(shape: EventType, location_name: "eventType"))
+    EventParameters.add_member(:event_value_threshold, Shapes::ShapeRef.new(shape: EventTypeThresholdValue, location_name: "eventValueThreshold"))
+    EventParameters.add_member(:weight, Shapes::ShapeRef.new(shape: EventTypeWeight, location_name: "weight"))
+    EventParameters.struct_class = Types::EventParameters
+
+    EventParametersList.member = Shapes::ShapeRef.new(shape: EventParameters)
+
     EventTracker.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
     EventTracker.add_member(:event_tracker_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "eventTrackerArn"))
     EventTracker.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "accountId"))
@@ -954,6 +966,9 @@ module Aws::Personalize
 
     EventTrackers.member = Shapes::ShapeRef.new(shape: EventTrackerSummary)
 
+    EventsConfig.add_member(:event_parameters_list, Shapes::ShapeRef.new(shape: EventParametersList, location_name: "eventParametersList"))
+    EventsConfig.struct_class = Types::EventsConfig
+
     ExcludedDatasetColumns.key = Shapes::ShapeRef.new(shape: DatasetType)
     ExcludedDatasetColumns.value = Shapes::ShapeRef.new(shape: ColumnNamesList)
 
@@ -1337,6 +1352,7 @@ module Aws::Personalize
     SolutionConfig.add_member(:algorithm_hyper_parameters, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "algorithmHyperParameters"))
     SolutionConfig.add_member(:feature_transformation_parameters, Shapes::ShapeRef.new(shape: FeatureTransformationParameters, location_name: "featureTransformationParameters"))
     SolutionConfig.add_member(:auto_ml_config, Shapes::ShapeRef.new(shape: AutoMLConfig, location_name: "autoMLConfig"))
+    SolutionConfig.add_member(:events_config, Shapes::ShapeRef.new(shape: EventsConfig, location_name: "eventsConfig"))
     SolutionConfig.add_member(:optimization_objective, Shapes::ShapeRef.new(shape: OptimizationObjective, location_name: "optimizationObjective"))
     SolutionConfig.add_member(:training_data_config, Shapes::ShapeRef.new(shape: TrainingDataConfig, location_name: "trainingDataConfig"))
     SolutionConfig.add_member(:auto_training_config, Shapes::ShapeRef.new(shape: AutoTrainingConfig, location_name: "autoTrainingConfig"))
@@ -1351,6 +1367,7 @@ module Aws::Personalize
     SolutionSummary.struct_class = Types::SolutionSummary
 
     SolutionUpdateConfig.add_member(:auto_training_config, Shapes::ShapeRef.new(shape: AutoTrainingConfig, location_name: "autoTrainingConfig"))
+    SolutionUpdateConfig.add_member(:events_config, Shapes::ShapeRef.new(shape: EventsConfig, location_name: "eventsConfig"))
     SolutionUpdateConfig.struct_class = Types::SolutionUpdateConfig
 
     SolutionUpdateSummary.add_member(:solution_update_config, Shapes::ShapeRef.new(shape: SolutionUpdateConfig, location_name: "solutionUpdateConfig"))

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

@@ -3379,6 +3379,33 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # Describes the parameters of events, which are used in solution
+    # creation.
+    #
+    # @!attribute [rw] event_type
+    #   The name of the event type to be considered for solution creation.
+    #   @return [String]
+    #
+    # @!attribute [rw] event_value_threshold
+    #   The threshold of the event type. Only events with a value greater or
+    #   equal to this threshold will be considered for solution creation.
+    #   @return [Float]
+    #
+    # @!attribute [rw] weight
+    #   The weight of the event type. A higher weight means higher
+    #   importance of the event type for the created solution.
+    #   @return [Float]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/EventParameters AWS API Documentation
+    #
+    class EventParameters < Struct.new(
+      :event_type,
+      :event_value_threshold,
+      :weight)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about an event tracker.
     #
     # @!attribute [rw] name
@@ -3490,6 +3517,22 @@ module Aws::Personalize
       include Aws::Structure
     end
 
+    # Describes the configuration of events, which are used in solution
+    # creation.
+    #
+    # @!attribute [rw] event_parameters_list
+    #   A list of event parameters, which includes event types and their
+    #   event value thresholds and weights.
+    #   @return [Array<Types::EventParameters>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/EventsConfig AWS API Documentation
+    #
+    class EventsConfig < Struct.new(
+      :event_parameters_list)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides feature transformation information. Feature transformation is
     # the process of modifying raw input data into a form more suitable for
     # model training.
@@ -5364,6 +5407,12 @@ module Aws::Personalize
     #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html
     #   @return [Types::AutoMLConfig]
     #
+    # @!attribute [rw] events_config
+    #   Describes the configuration of an event, which includes a list of
+    #   event parameters. You can specify up to 10 event parameters. Events
+    #   are used in solution creation.
+    #   @return [Types::EventsConfig]
+    #
     # @!attribute [rw] optimization_objective
     #   Describes the additional objective for the solution, such as
     #   maximizing streaming minutes or increasing revenue. For more
@@ -5391,6 +5440,7 @@ module Aws::Personalize
       :algorithm_hyper_parameters,
       :feature_transformation_parameters,
       :auto_ml_config,
+      :events_config,
       :optimization_objective,
       :training_data_config,
       :auto_training_config)
@@ -5456,10 +5506,17 @@ module Aws::Personalize
     #   `performAutoTraining` is true.
     #   @return [Types::AutoTrainingConfig]
     #
+    # @!attribute [rw] events_config
+    #   Describes the configuration of an event, which includes a list of
+    #   event parameters. You can specify up to 10 event parameters. Events
+    #   are used in solution creation.
+    #   @return [Types::EventsConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionUpdateConfig AWS API Documentation
     #
     class SolutionUpdateConfig < Struct.new(
-      :auto_training_config)
+      :auto_training_config,
+      :events_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -5787,7 +5844,7 @@ module Aws::Personalize
     class Tag < Struct.new(
       :tag_key,
       :tag_value)
-      SENSITIVE = []
+      SENSITIVE = [:tag_key, :tag_value]
       include Aws::Structure
     end
 
@@ -5911,7 +5968,7 @@ module Aws::Personalize
     class UntagResourceRequest < Struct.new(
       :resource_arn,
       :tag_keys)
-      SENSITIVE = []
+      SENSITIVE = [:tag_keys]
       include Aws::Structure
     end
 

data/lib/aws-sdk-personalize.rb

@@ -54,7 +54,7 @@ module Aws::Personalize
   autoload :EndpointProvider, 'aws-sdk-personalize/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-personalize/endpoints'
 
-  GEM_VERSION = '1.79.0'
+  GEM_VERSION = '1.80.0'
 
 end
 

data/sig/client.rbs

@@ -435,6 +435,15 @@ module Aws
                                  metric_name: ::String?,
                                  recipe_list: Array[::String]?
                                }?,
+                               events_config: {
+                                 event_parameters_list: Array[
+                                   {
+                                     event_type: ::String?,
+                                     event_value_threshold: ::Float?,
+                                     weight: ::Float?
+                                   },
+                                 ]?
+                               }?,
                                optimization_objective: {
                                  item_attribute: ::String?,
                                  objective_sensitivity: ("LOW" | "MEDIUM" | "HIGH" | "OFF")?
@@ -1081,6 +1090,15 @@ module Aws
                              ?solution_update_config: {
                                auto_training_config: {
                                  scheduling_expression: ::String?
+                               }?,
+                               events_config: {
+                                 event_parameters_list: Array[
+                                   {
+                                     event_type: ::String?,
+                                     event_value_threshold: ::Float?,
+                                     weight: ::Float?
+                                   },
+                                 ]?
                                }?
                              }
                            ) -> _UpdateSolutionResponseSuccess

data/sig/types.rbs

@@ -819,6 +819,13 @@ module Aws::Personalize
       SENSITIVE: []
     end
 
+    class EventParameters
+      attr_accessor event_type: ::String
+      attr_accessor event_value_threshold: ::Float
+      attr_accessor weight: ::Float
+      SENSITIVE: []
+    end
+
     class EventTracker
       attr_accessor name: ::String
       attr_accessor event_tracker_arn: ::String
@@ -840,6 +847,11 @@ module Aws::Personalize
       SENSITIVE: []
     end
 
+    class EventsConfig
+      attr_accessor event_parameters_list: ::Array[Types::EventParameters]
+      SENSITIVE: []
+    end
+
     class FeatureTransformation
       attr_accessor name: ::String
       attr_accessor feature_transformation_arn: ::String
@@ -1322,6 +1334,7 @@ module Aws::Personalize
       attr_accessor algorithm_hyper_parameters: ::Hash[::String, ::String]
       attr_accessor feature_transformation_parameters: ::Hash[::String, ::String]
       attr_accessor auto_ml_config: Types::AutoMLConfig
+      attr_accessor events_config: Types::EventsConfig
       attr_accessor optimization_objective: Types::OptimizationObjective
       attr_accessor training_data_config: Types::TrainingDataConfig
       attr_accessor auto_training_config: Types::AutoTrainingConfig
@@ -1340,6 +1353,7 @@ module Aws::Personalize
 
     class SolutionUpdateConfig
       attr_accessor auto_training_config: Types::AutoTrainingConfig
+      attr_accessor events_config: Types::EventsConfig
       SENSITIVE: []
     end
 
@@ -1413,7 +1427,7 @@ module Aws::Personalize
     class Tag
       attr_accessor tag_key: ::String
       attr_accessor tag_value: ::String
-      SENSITIVE: []
+      SENSITIVE: [:tag_key, :tag_value]
     end
 
     class TagResourceRequest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalize
 version: !ruby/object:Gem::Version
-  version: 1.79.0
+  version: 1.80.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core