aws-sdk-personalize 1.44.0 → 1.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5841fd66452d1da47a89a6310821edf33407cbc23880dbb38057624366a857ce
-  data.tar.gz: cc730ac589190486c08e0d58b3055fb907d6aba973f201bf8c3bcdf7d868f180
+  metadata.gz: 6cb4bb9c7ee70652f3c644264762f3a0cffe6902ad8e7bb21f4aa55e6d4dadfd
+  data.tar.gz: aba40a8129081ba4765deadc6bbc3f80add89cc26f63ee6a2c46500b67279478
 SHA512:
-  metadata.gz: b2e7224bb310abf0496429f16e47d1ee19aa54bed373ba47e9184fcd0e69f973b4ff3e19837285388a8b776f89afab13d2c81c325dc5de52649c52a23f80c383
-  data.tar.gz: b88146ee1fe3d0b4d3566829a6fe2e8109290752768e6281e8710e42bd50fce3b8822eb23096b2d927e03dd5b98f5a68a5df45676219a86953a4f06ae90d43d7
+  metadata.gz: f1d6a04dfbe7a537a94cc560c7f4fbf17baebeac3ebc7583af1839a7ed8088c9ee0edeba5d40a632d14cea1e4083a83c72a939f2a5e59a403db9ff81d74c907b
+  data.tar.gz: 84317573eed5c4bad5b909bf4da7d1513e9f2ce1930d9a035bb69f7bd18ca0b318caeedeb5c5f05bc0cd285e0ee5e59b739ede810b6018274fed22953315ba10

data/CHANGELOG.md

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

data/VERSION

@@ -1 +1 @@
-1.44.0
+1.45.0

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

@@ -1089,6 +1089,10 @@ module Aws::Personalize
     #     in your dataset. Amazon Personalize replaces any record with the
     #     same ID with the new one.
     #
+    # @option params [Boolean] :publish_attribution_metrics_to_s3
+    #   If you created a metric attribution, specify whether to publish
+    #   metrics for this import job to Amazon S3
+    #
     # @return [Types::CreateDatasetImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateDatasetImportJobResponse#dataset_import_job_arn #dataset_import_job_arn} => String
@@ -1109,6 +1113,7 @@ module Aws::Personalize
     #       },
     #     ],
     #     import_mode: "FULL", # accepts FULL, INCREMENTAL
+    #     publish_attribution_metrics_to_s3: false,
     #   })
     #
     # @example Response structure
@@ -1276,6 +1281,71 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Creates a metric attribution. A metric attribution creates reports on
+    # the data that you import into Amazon Personalize. Depending on how you
+    # imported the data, you can view reports in Amazon CloudWatch or Amazon
+    # S3. For more information, see [Measuring impact of
+    # recommendations][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html
+    #
+    # @option params [required, String] :name
+    #   A name for the metric attribution.
+    #
+    # @option params [required, String] :dataset_group_arn
+    #   The Amazon Resource Name (ARN) of the destination dataset group for
+    #   the metric attribution.
+    #
+    # @option params [required, Array<Types::MetricAttribute>] :metrics
+    #   A list of metric attributes for the metric attribution. Each metric
+    #   attribute specifies an event type to track and a function. Available
+    #   functions are `SUM()` or `SAMPLECOUNT()`. For SUM() functions, provide
+    #   the dataset type (either Interactions or Items) and column to sum as a
+    #   parameter. For example SUM(Items.PRICE).
+    #
+    # @option params [required, Types::MetricAttributionOutput] :metrics_output_config
+    #   The output configuration details for the metric attribution.
+    #
+    # @return [Types::CreateMetricAttributionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateMetricAttributionResponse#metric_attribution_arn #metric_attribution_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_metric_attribution({
+    #     name: "Name", # required
+    #     dataset_group_arn: "Arn", # required
+    #     metrics: [ # required
+    #       {
+    #         event_type: "EventType", # required
+    #         metric_name: "MetricName", # required
+    #         expression: "MetricExpression", # required
+    #       },
+    #     ],
+    #     metrics_output_config: { # required
+    #       s3_data_destination: {
+    #         path: "S3Location", # required
+    #         kms_key_arn: "KmsKeyArn",
+    #       },
+    #       role_arn: "RoleArn", # required
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_attribution_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateMetricAttribution AWS API Documentation
+    #
+    # @overload create_metric_attribution(params = {})
+    # @param [Hash] params ({})
+    def create_metric_attribution(params = {}, options = {})
+      req = build_request(:create_metric_attribution, params)
+      req.send_request(options)
+    end
+
     # Creates a recommender with the recipe (a Domain dataset group use
     # case) you specify. You create recommenders for a Domain dataset group
     # and specify the recommender's Amazon Resource Name (ARN) when you
@@ -1721,6 +1791,9 @@ module Aws::Personalize
     # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
     # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
     #
+    # @option params [String] :name
+    #   The name of the solution version.
+    #
     # @option params [required, String] :solution_arn
     #   The Amazon Resource Name (ARN) of the solution containing the training
     #   configuration information.
@@ -1757,6 +1830,7 @@ module Aws::Personalize
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_solution_version({
+    #     name: "Name",
     #     solution_arn: "Arn", # required
     #     training_mode: "FULL", # accepts FULL, UPDATE
     #     tags: [
@@ -1919,6 +1993,28 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Deletes a metric attribution.
+    #
+    # @option params [required, String] :metric_attribution_arn
+    #   The metric attribution's Amazon Resource Name (ARN).
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_metric_attribution({
+    #     metric_attribution_arn: "Arn", # required
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DeleteMetricAttribution AWS API Documentation
+    #
+    # @overload delete_metric_attribution(params = {})
+    # @param [Hash] params ({})
+    def delete_metric_attribution(params = {}, options = {})
+      req = build_request(:delete_metric_attribution, params)
+      req.send_request(options)
+    end
+
     # Deactivates and removes a recommender. A deleted recommender can no
     # longer be specified in a [GetRecommendations][1] request.
     #
@@ -2366,6 +2462,7 @@ module Aws::Personalize
     #   resp.dataset_import_job.last_updated_date_time #=> Time
     #   resp.dataset_import_job.failure_reason #=> String
     #   resp.dataset_import_job.import_mode #=> String, one of "FULL", "INCREMENTAL"
+    #   resp.dataset_import_job.publish_attribution_metrics_to_s3 #=> Boolean
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDatasetImportJob AWS API Documentation
     #
@@ -2487,6 +2584,43 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Describes a metric attribution.
+    #
+    # @option params [required, String] :metric_attribution_arn
+    #   The metric attribution's Amazon Resource Name (ARN).
+    #
+    # @return [Types::DescribeMetricAttributionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeMetricAttributionResponse#metric_attribution #metric_attribution} => Types::MetricAttribution
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_metric_attribution({
+    #     metric_attribution_arn: "Arn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_attribution.name #=> String
+    #   resp.metric_attribution.metric_attribution_arn #=> String
+    #   resp.metric_attribution.dataset_group_arn #=> String
+    #   resp.metric_attribution.metrics_output_config.s3_data_destination.path #=> String
+    #   resp.metric_attribution.metrics_output_config.s3_data_destination.kms_key_arn #=> String
+    #   resp.metric_attribution.metrics_output_config.role_arn #=> String
+    #   resp.metric_attribution.status #=> String
+    #   resp.metric_attribution.creation_date_time #=> Time
+    #   resp.metric_attribution.last_updated_date_time #=> Time
+    #   resp.metric_attribution.failure_reason #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeMetricAttribution AWS API Documentation
+    #
+    # @overload describe_metric_attribution(params = {})
+    # @param [Hash] params ({})
+    def describe_metric_attribution(params = {}, options = {})
+      req = build_request(:describe_metric_attribution, params)
+      req.send_request(options)
+    end
+
     # Describes a recipe.
     #
     # A recipe contains three items:
@@ -2748,6 +2882,7 @@ module Aws::Personalize
     #
     # @example Response structure
     #
+    #   resp.solution_version.name #=> String
     #   resp.solution_version.solution_version_arn #=> String
     #   resp.solution_version.solution_arn #=> String
     #   resp.solution_version.perform_hpo #=> Boolean
@@ -3318,6 +3453,99 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Lists the metrics for the metric attribution.
+    #
+    # @option params [String] :metric_attribution_arn
+    #   The Amazon Resource Name (ARN) of the metric attribution to retrieve
+    #   attributes for.
+    #
+    # @option params [String] :next_token
+    #   Specify the pagination token from a previous request to retrieve the
+    #   next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of metrics to return in one page of results.
+    #
+    # @return [Types::ListMetricAttributionMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListMetricAttributionMetricsResponse#metrics #metrics} => Array&lt;Types::MetricAttribute&gt;
+    #   * {Types::ListMetricAttributionMetricsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_metric_attribution_metrics({
+    #     metric_attribution_arn: "Arn",
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metrics #=> Array
+    #   resp.metrics[0].event_type #=> String
+    #   resp.metrics[0].metric_name #=> String
+    #   resp.metrics[0].expression #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributionMetrics AWS API Documentation
+    #
+    # @overload list_metric_attribution_metrics(params = {})
+    # @param [Hash] params ({})
+    def list_metric_attribution_metrics(params = {}, options = {})
+      req = build_request(:list_metric_attribution_metrics, params)
+      req.send_request(options)
+    end
+
+    # Lists metric attributions.
+    #
+    # @option params [String] :dataset_group_arn
+    #   The metric attributions' dataset group Amazon Resource Name (ARN).
+    #
+    # @option params [String] :next_token
+    #   Specify the pagination token from a previous request to retrieve the
+    #   next page of results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of metric attributions to return in one page of
+    #   results.
+    #
+    # @return [Types::ListMetricAttributionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListMetricAttributionsResponse#metric_attributions #metric_attributions} => Array&lt;Types::MetricAttributionSummary&gt;
+    #   * {Types::ListMetricAttributionsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_metric_attributions({
+    #     dataset_group_arn: "Arn",
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_attributions #=> Array
+    #   resp.metric_attributions[0].name #=> String
+    #   resp.metric_attributions[0].metric_attribution_arn #=> String
+    #   resp.metric_attributions[0].status #=> String
+    #   resp.metric_attributions[0].creation_date_time #=> Time
+    #   resp.metric_attributions[0].last_updated_date_time #=> Time
+    #   resp.metric_attributions[0].failure_reason #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListMetricAttributions AWS API Documentation
+    #
+    # @overload list_metric_attributions(params = {})
+    # @param [Hash] params ({})
+    def list_metric_attributions(params = {}, options = {})
+      req = build_request(:list_metric_attributions, params)
+      req.send_request(options)
+    end
+
     # Returns a list of available recipes. The response provides the
     # properties for each recipe, including the recipe's Amazon Resource
     # Name (ARN).
@@ -3575,6 +3803,7 @@ module Aws::Personalize
     #   resp.solutions[0].status #=> String
     #   resp.solutions[0].creation_date_time #=> Time
     #   resp.solutions[0].last_updated_date_time #=> Time
+    #   resp.solutions[0].recipe_arn #=> String
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListSolutions AWS API Documentation
@@ -3846,6 +4075,58 @@ module Aws::Personalize
       req.send_request(options)
     end
 
+    # Updates a metric attribution.
+    #
+    # @option params [Array<Types::MetricAttribute>] :add_metrics
+    #   Add new metric attributes to the metric attribution.
+    #
+    # @option params [Array<String>] :remove_metrics
+    #   Remove metric attributes from the metric attribution.
+    #
+    # @option params [Types::MetricAttributionOutput] :metrics_output_config
+    #   An output config for the metric attribution.
+    #
+    # @option params [String] :metric_attribution_arn
+    #   The Amazon Resource Name (ARN) for the metric attribution to update.
+    #
+    # @return [Types::UpdateMetricAttributionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateMetricAttributionResponse#metric_attribution_arn #metric_attribution_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_metric_attribution({
+    #     add_metrics: [
+    #       {
+    #         event_type: "EventType", # required
+    #         metric_name: "MetricName", # required
+    #         expression: "MetricExpression", # required
+    #       },
+    #     ],
+    #     remove_metrics: ["MetricName"],
+    #     metrics_output_config: {
+    #       s3_data_destination: {
+    #         path: "S3Location", # required
+    #         kms_key_arn: "KmsKeyArn",
+    #       },
+    #       role_arn: "RoleArn", # required
+    #     },
+    #     metric_attribution_arn: "Arn",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.metric_attribution_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UpdateMetricAttribution AWS API Documentation
+    #
+    # @overload update_metric_attribution(params = {})
+    # @param [Hash] params ({})
+    def update_metric_attribution(params = {}, options = {})
+      req = build_request(:update_metric_attribution, params)
+      req.send_request(options)
+    end
+
     # Updates the recommender to modify the recommender configuration.
     #
     # @option params [required, String] :recommender_arn
@@ -3896,7 +4177,7 @@ module Aws::Personalize
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalize'
-      context[:gem_version] = '1.44.0'
+      context[:gem_version] = '1.45.0'
       Seahorse::Client::Request.new(handlers, context)
     end