aws-sdk-personalize 1.59.0 → 1.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1bbf9f9dfaa6c21ec60de92115714cf616ed34a13314feee44adda460b367b32
4
- data.tar.gz: e87dcd0cfb2a597c90352605368508874c53764348eb25b04dad8209f579a1fe
3
+ metadata.gz: d1da6af0db56f8c48cb2a224c8ce92c920417acfc5b29ff600eb82ddb8dbf82a
4
+ data.tar.gz: 4d142528e72269c236df306d3f7d6fdc1c263cb8939afb165b667f7f694698a8
5
5
  SHA512:
6
- metadata.gz: 45a8d39268c544f6f2b8c6006aa722ee2e9239eb8ea8d4ce02f52a83ed10ec4f42a4cab3cc7c30acd291ee6547c73b605a609d5a88cc92443dfcd432ea6e5c58
7
- data.tar.gz: 60a9bb3ca25d87016682be7d0d05e60c29ea348e2d5844b350e973df8fe967c3b599787d104c656bf609397815fac1af3dc1cea6dd97cf1b67f389e447a18728
6
+ metadata.gz: eb125d70ef1daf9339e98cc9aede0884549ca854ad934373abf2009086231e84f03f09b49accb43eab2c29538848a0f7f020f73b9fc9e7850cc5fa25853e234a
7
+ data.tar.gz: 7f5dbe932c9498748effa1c5069eb23f3b704a7e16a684d9e40baa105d3b3f175ff3ec4c5071e5968accf343b81f7962771e6394da8fec91a5254e677ce3a387
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.60.0 (2024-04-19)
5
+ ------------------
6
+
7
+ * Feature - This releases auto training capability while creating a solution and automatically syncing latest solution versions when creating/updating a campaign
8
+
4
9
  1.59.0 (2024-01-26)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.59.0
1
+ 1.60.0
@@ -638,8 +638,12 @@ module Aws::Personalize
638
638
  req.send_request(options)
639
639
  end
640
640
 
641
+ # You incur campaign costs while it is active. To avoid unnecessary
642
+ # costs, make sure to delete the campaign when you are finished. For
643
+ # information about campaign costs, see [Amazon Personalize pricing][1].
644
+ #
641
645
  # Creates a campaign that deploys a solution version. When a client
642
- # calls the [GetRecommendations][1] and [GetPersonalizedRanking][2]
646
+ # calls the [GetRecommendations][2] and [GetPersonalizedRanking][3]
643
647
  # APIs, a campaign is specified in the request.
644
648
  #
645
649
  # **Minimum Provisioned TPS and Auto-Scaling**
@@ -671,7 +675,7 @@ module Aws::Personalize
671
675
  # `minProvisionedTPS` as necessary.
672
676
  #
673
677
  # For more information about campaign costs, see [Amazon Personalize
674
- # pricing][3].
678
+ # pricing][1].
675
679
  #
676
680
  # **Status**
677
681
  #
@@ -701,9 +705,9 @@ module Aws::Personalize
701
705
  #
702
706
  #
703
707
  #
704
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
705
- # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
706
- # [3]: https://aws.amazon.com/personalize/pricing/
708
+ # [1]: https://aws.amazon.com/personalize/pricing/
709
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
710
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html
707
711
  # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
708
712
  # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html
709
713
  # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_UpdateCampaign.html
@@ -714,7 +718,22 @@ module Aws::Personalize
714
718
  # your account.
715
719
  #
716
720
  # @option params [required, String] :solution_version_arn
717
- # The Amazon Resource Name (ARN) of the solution version to deploy.
721
+ # The Amazon Resource Name (ARN) of the trained model to deploy with the
722
+ # campaign. To specify the latest solution version of your solution,
723
+ # specify the ARN of your *solution* in `SolutionArn/$LATEST` format.
724
+ # You must use this format if you set `syncWithLatestSolutionVersion` to
725
+ # `True` in the [CampaignConfig][1].
726
+ #
727
+ # To deploy a model that isn't the latest solution version of your
728
+ # solution, specify the ARN of the solution version.
729
+ #
730
+ # For more information about automatic campaign updates, see [Enabling
731
+ # automatic campaign updates][2].
732
+ #
733
+ #
734
+ #
735
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html
736
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
718
737
  #
719
738
  # @option params [Integer] :min_provisioned_tps
720
739
  # Specifies the requested minimum provisioned transactions
@@ -749,6 +768,7 @@ module Aws::Personalize
749
768
  # "ParameterName" => "ParameterValue",
750
769
  # },
751
770
  # enable_metadata_with_recommendations: false,
771
+ # sync_with_latest_solution_version: false,
752
772
  # },
753
773
  # tags: [
754
774
  # {
@@ -1653,22 +1673,40 @@ module Aws::Personalize
1653
1673
  req.send_request(options)
1654
1674
  end
1655
1675
 
1656
- # Creates the configuration for training a model. A trained model is
1657
- # known as a solution version. After the configuration is created, you
1658
- # train the model (create a solution version) by calling the
1659
- # [CreateSolutionVersion][1] operation. Every time you call
1660
- # `CreateSolutionVersion`, a new version of the solution is created.
1661
- #
1662
- # After creating a solution version, you check its accuracy by calling
1663
- # [GetSolutionMetrics][2]. When you are satisfied with the version, you
1664
- # deploy it using [CreateCampaign][3]. The campaign provides
1665
- # recommendations to a client through the [GetRecommendations][4] API.
1666
- #
1667
- # To train a model, Amazon Personalize requires training data and a
1668
- # recipe. The training data comes from the dataset group that you
1669
- # provide in the request. A recipe specifies the training algorithm and
1670
- # a feature transformation. You can specify one of the predefined
1671
- # recipes provided by Amazon Personalize.
1676
+ # After you create a solution, you can’t change its configuration. By
1677
+ # default, all new solutions use automatic training. With automatic
1678
+ # training, you incur training costs while your solution is active. You
1679
+ # can't stop automatic training for a solution. To avoid unnecessary
1680
+ # costs, make sure to delete the solution when you are finished. For
1681
+ # information about training costs, see [Amazon Personalize pricing][1].
1682
+ #
1683
+ # Creates the configuration for training a model (creating a solution
1684
+ # version). This configuration includes the recipe to use for model
1685
+ # training and optional training configuration, such as columns to use
1686
+ # in training and feature transformation parameters. For more
1687
+ # information about configuring a solution, see [Creating and
1688
+ # configuring a solution][2].
1689
+ #
1690
+ # By default, new solutions use automatic training to create solution
1691
+ # versions every 7 days. You can change the training frequency.
1692
+ # Automatic solution version creation starts one hour after the solution
1693
+ # is ACTIVE. If you manually create a solution version within the hour,
1694
+ # the solution skips the first automatic training. For more information,
1695
+ # see [Configuring automatic training][3].
1696
+ #
1697
+ # To turn off automatic training, set `performAutoTraining` to false. If
1698
+ # you turn off automatic training, you must manually create a solution
1699
+ # version by calling the [CreateSolutionVersion][4] operation.
1700
+ #
1701
+ # After training starts, you can get the solution version's Amazon
1702
+ # Resource Name (ARN) with the [ListSolutionVersions][5] API operation.
1703
+ # To get its status, use the [DescribeSolutionVersion][6].
1704
+ #
1705
+ # After training completes you can evaluate model accuracy by calling
1706
+ # [GetSolutionMetrics][7]. When you are satisfied with the solution
1707
+ # version, you deploy it using [CreateCampaign][8]. The campaign
1708
+ # provides recommendations to a client through the
1709
+ # [GetRecommendations][9] API.
1672
1710
  #
1673
1711
  # <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` for
1674
1712
  # solution hyperparameter optimization at this time.
@@ -1684,36 +1722,39 @@ module Aws::Personalize
1684
1722
  #
1685
1723
  # * DELETE PENDING &gt; DELETE IN\_PROGRESS
1686
1724
  #
1687
- # To get the status of the solution, call [DescribeSolution][5]. Wait
1688
- # until the status shows as ACTIVE before calling
1725
+ # To get the status of the solution, call [DescribeSolution][10]. If you
1726
+ # use manual training, the status must be ACTIVE before you call
1689
1727
  # `CreateSolutionVersion`.
1690
1728
  #
1691
1729
  # **Related APIs**
1692
1730
  #
1693
- # * [ListSolutions][6]
1731
+ # * [ListSolutions][11]
1694
1732
  #
1695
- # * [CreateSolutionVersion][1]
1733
+ # * [CreateSolutionVersion][4]
1696
1734
  #
1697
- # * [DescribeSolution][5]
1735
+ # * [DescribeSolution][10]
1698
1736
  #
1699
- # * [DeleteSolution][7]
1737
+ # * [DeleteSolution][12]
1700
1738
  # ^
1701
1739
  #
1702
- # * [ListSolutionVersions][8]
1740
+ # * [ListSolutionVersions][5]
1703
1741
  #
1704
- # * [DescribeSolutionVersion][9]
1742
+ # * [DescribeSolutionVersion][6]
1705
1743
  #
1706
1744
  #
1707
1745
  #
1708
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html
1709
- # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html
1710
- # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
1711
- # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1712
- # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
1713
- # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
1714
- # [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
1715
- # [8]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1716
- # [9]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1746
+ # [1]: https://aws.amazon.com/personalize/pricing/
1747
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html
1748
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html
1749
+ # [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html
1750
+ # [5]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1751
+ # [6]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1752
+ # [7]: https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html
1753
+ # [8]: https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html
1754
+ # [9]: https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html
1755
+ # [10]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html
1756
+ # [11]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutions.html
1757
+ # [12]: https://docs.aws.amazon.com/personalize/latest/dg/API_DeleteSolution.html
1717
1758
  #
1718
1759
  # @option params [required, String] :name
1719
1760
  # The name for the solution.
@@ -1744,6 +1785,29 @@ module Aws::Personalize
1744
1785
  #
1745
1786
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
1746
1787
  #
1788
+ # @option params [Boolean] :perform_auto_training
1789
+ # Whether the solution uses automatic training to create new solution
1790
+ # versions (trained models). The default is `True` and the solution
1791
+ # automatically creates new solution versions every 7 days. You can
1792
+ # change the training frequency by specifying a `schedulingExpression`
1793
+ # in the `AutoTrainingConfig` as part of solution configuration. For
1794
+ # more information about automatic training, see [Configuring automatic
1795
+ # training][1].
1796
+ #
1797
+ # Automatic solution version creation starts one hour after the solution
1798
+ # is ACTIVE. If you manually create a solution version within the hour,
1799
+ # the solution skips the first automatic training.
1800
+ #
1801
+ # After training starts, you can get the solution version's Amazon
1802
+ # Resource Name (ARN) with the [ListSolutionVersions][2] API operation.
1803
+ # To get its status, use the [DescribeSolutionVersion][3].
1804
+ #
1805
+ #
1806
+ #
1807
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html
1808
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1809
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1810
+ #
1747
1811
  # @option params [String] :recipe_arn
1748
1812
  # The Amazon Resource Name (ARN) of the recipe to use for model
1749
1813
  # training. This is required when `performAutoML` is false. For
@@ -1793,6 +1857,7 @@ module Aws::Personalize
1793
1857
  # name: "Name", # required
1794
1858
  # perform_hpo: false,
1795
1859
  # perform_auto_ml: false,
1860
+ # perform_auto_training: false,
1796
1861
  # recipe_arn: "Arn",
1797
1862
  # dataset_group_arn: "Arn", # required
1798
1863
  # event_type: "EventType",
@@ -1850,6 +1915,9 @@ module Aws::Personalize
1850
1915
  # "DatasetType" => ["ColumnName"],
1851
1916
  # },
1852
1917
  # },
1918
+ # auto_training_config: {
1919
+ # scheduling_expression: "SchedulingExpression",
1920
+ # },
1853
1921
  # },
1854
1922
  # tags: [
1855
1923
  # {
@@ -1972,7 +2040,7 @@ module Aws::Personalize
1972
2040
  # resp = client.create_solution_version({
1973
2041
  # name: "Name",
1974
2042
  # solution_arn: "Arn", # required
1975
- # training_mode: "FULL", # accepts FULL, UPDATE
2043
+ # training_mode: "FULL", # accepts FULL, UPDATE, AUTOTRAIN
1976
2044
  # tags: [
1977
2045
  # {
1978
2046
  # tag_key: "TagKey", # required
@@ -2427,6 +2495,7 @@ module Aws::Personalize
2427
2495
  # resp.campaign.campaign_config.item_exploration_config #=> Hash
2428
2496
  # resp.campaign.campaign_config.item_exploration_config["ParameterName"] #=> String
2429
2497
  # resp.campaign.campaign_config.enable_metadata_with_recommendations #=> Boolean
2498
+ # resp.campaign.campaign_config.sync_with_latest_solution_version #=> Boolean
2430
2499
  # resp.campaign.status #=> String
2431
2500
  # resp.campaign.failure_reason #=> String
2432
2501
  # resp.campaign.creation_date_time #=> Time
@@ -2436,6 +2505,7 @@ module Aws::Personalize
2436
2505
  # resp.campaign.latest_campaign_update.campaign_config.item_exploration_config #=> Hash
2437
2506
  # resp.campaign.latest_campaign_update.campaign_config.item_exploration_config["ParameterName"] #=> String
2438
2507
  # resp.campaign.latest_campaign_update.campaign_config.enable_metadata_with_recommendations #=> Boolean
2508
+ # resp.campaign.latest_campaign_update.campaign_config.sync_with_latest_solution_version #=> Boolean
2439
2509
  # resp.campaign.latest_campaign_update.status #=> String
2440
2510
  # resp.campaign.latest_campaign_update.failure_reason #=> String
2441
2511
  # resp.campaign.latest_campaign_update.creation_date_time #=> Time
@@ -2969,6 +3039,7 @@ module Aws::Personalize
2969
3039
  # resp.solution.solution_arn #=> String
2970
3040
  # resp.solution.perform_hpo #=> Boolean
2971
3041
  # resp.solution.perform_auto_ml #=> Boolean
3042
+ # resp.solution.perform_auto_training #=> Boolean
2972
3043
  # resp.solution.recipe_arn #=> String
2973
3044
  # resp.solution.dataset_group_arn #=> String
2974
3045
  # resp.solution.event_type #=> String
@@ -3002,12 +3073,15 @@ module Aws::Personalize
3002
3073
  # resp.solution.solution_config.training_data_config.excluded_dataset_columns #=> Hash
3003
3074
  # resp.solution.solution_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
3004
3075
  # resp.solution.solution_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
3076
+ # resp.solution.solution_config.auto_training_config.scheduling_expression #=> String
3005
3077
  # resp.solution.auto_ml_result.best_recipe_arn #=> String
3006
3078
  # resp.solution.status #=> String
3007
3079
  # resp.solution.creation_date_time #=> Time
3008
3080
  # resp.solution.last_updated_date_time #=> Time
3009
3081
  # resp.solution.latest_solution_version.solution_version_arn #=> String
3010
3082
  # resp.solution.latest_solution_version.status #=> String
3083
+ # resp.solution.latest_solution_version.training_mode #=> String, one of "FULL", "UPDATE", "AUTOTRAIN"
3084
+ # resp.solution.latest_solution_version.training_type #=> String, one of "AUTOMATIC", "MANUAL"
3011
3085
  # resp.solution.latest_solution_version.creation_date_time #=> Time
3012
3086
  # resp.solution.latest_solution_version.last_updated_date_time #=> Time
3013
3087
  # resp.solution.latest_solution_version.failure_reason #=> String
@@ -3081,14 +3155,16 @@ module Aws::Personalize
3081
3155
  # resp.solution_version.solution_config.training_data_config.excluded_dataset_columns #=> Hash
3082
3156
  # resp.solution_version.solution_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
3083
3157
  # resp.solution_version.solution_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
3158
+ # resp.solution_version.solution_config.auto_training_config.scheduling_expression #=> String
3084
3159
  # resp.solution_version.training_hours #=> Float
3085
- # resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE"
3160
+ # resp.solution_version.training_mode #=> String, one of "FULL", "UPDATE", "AUTOTRAIN"
3086
3161
  # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters #=> Hash
3087
3162
  # resp.solution_version.tuned_hpo_params.algorithm_hyper_parameters["ParameterName"] #=> String
3088
3163
  # resp.solution_version.status #=> String
3089
3164
  # resp.solution_version.failure_reason #=> String
3090
3165
  # resp.solution_version.creation_date_time #=> Time
3091
3166
  # resp.solution_version.last_updated_date_time #=> Time
3167
+ # resp.solution_version.training_type #=> String, one of "AUTOMATIC", "MANUAL"
3092
3168
  #
3093
3169
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeSolutionVersion AWS API Documentation
3094
3170
  #
@@ -3915,6 +3991,8 @@ module Aws::Personalize
3915
3991
  # resp.solution_versions #=> Array
3916
3992
  # resp.solution_versions[0].solution_version_arn #=> String
3917
3993
  # resp.solution_versions[0].status #=> String
3994
+ # resp.solution_versions[0].training_mode #=> String, one of "FULL", "UPDATE", "AUTOTRAIN"
3995
+ # resp.solution_versions[0].training_type #=> String, one of "AUTOMATIC", "MANUAL"
3918
3996
  # resp.solution_versions[0].creation_date_time #=> Time
3919
3997
  # resp.solution_versions[0].last_updated_date_time #=> Time
3920
3998
  # resp.solution_versions[0].failure_reason #=> String
@@ -3929,11 +4007,11 @@ module Aws::Personalize
3929
4007
  req.send_request(options)
3930
4008
  end
3931
4009
 
3932
- # Returns a list of solutions that use the given dataset group. When a
3933
- # dataset group is not specified, all the solutions associated with the
3934
- # account are listed. The response provides the properties for each
3935
- # solution, including the Amazon Resource Name (ARN). For more
3936
- # information on solutions, see [CreateSolution][1].
4010
+ # Returns a list of solutions in a given dataset group. When a dataset
4011
+ # group is not specified, all the solutions associated with the account
4012
+ # are listed. The response provides the properties for each solution,
4013
+ # including the Amazon Resource Name (ARN). For more information on
4014
+ # solutions, see [CreateSolution][1].
3937
4015
  #
3938
4016
  #
3939
4017
  #
@@ -3991,7 +4069,7 @@ module Aws::Personalize
3991
4069
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
3992
4070
  #
3993
4071
  # @option params [required, String] :resource_arn
3994
- # The resource's Amazon Resource Name.
4072
+ # The resource's Amazon Resource Name (ARN).
3995
4073
  #
3996
4074
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3997
4075
  #
@@ -4121,7 +4199,7 @@ module Aws::Personalize
4121
4199
  #
4122
4200
  # @option params [required, Array<Types::Tag>] :tags
4123
4201
  # Tags to apply to the resource. For more information see [Tagging
4124
- # Amazon Personalize recources][1].
4202
+ # Amazon Personalize resources][1].
4125
4203
  #
4126
4204
  #
4127
4205
  #
@@ -4150,17 +4228,18 @@ module Aws::Personalize
4150
4228
  req.send_request(options)
4151
4229
  end
4152
4230
 
4153
- # Remove [tags][1] that are attached to a resource.
4231
+ # Removes the specified tags that are attached to a resource. For more
4232
+ # information, see [Removing tags from Amazon Personalize resources][1].
4154
4233
  #
4155
4234
  #
4156
4235
  #
4157
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
4236
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html
4158
4237
  #
4159
4238
  # @option params [required, String] :resource_arn
4160
4239
  # The resource's Amazon Resource Name (ARN).
4161
4240
  #
4162
4241
  # @option params [required, Array<String>] :tag_keys
4163
- # Keys to remove from the resource's tags.
4242
+ # The keys of the tags to be removed.
4164
4243
  #
4165
4244
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4166
4245
  #
@@ -4182,8 +4261,17 @@ module Aws::Personalize
4182
4261
 
4183
4262
  # Updates a campaign to deploy a retrained solution version with an
4184
4263
  # existing campaign, change your campaign's `minProvisionedTPS`, or
4185
- # modify your campaign's configuration, such as the exploration
4186
- # configuration.
4264
+ # modify your campaign's configuration. For example, you can set
4265
+ # `enableMetadataWithRecommendations` to true for an existing campaign.
4266
+ #
4267
+ # To update a campaign to start automatically using the latest solution
4268
+ # version, specify the following:
4269
+ #
4270
+ # * For the `SolutionVersionArn` parameter, specify the Amazon Resource
4271
+ # Name (ARN) of your solution in `SolutionArn/$LATEST` format.
4272
+ #
4273
+ # * In the `campaignConfig`, set `syncWithLatestSolutionVersion` to
4274
+ # `true`.
4187
4275
  #
4188
4276
  # To update a campaign, the campaign status must be ACTIVE or CREATE
4189
4277
  # FAILED. Check the campaign status using the [DescribeCampaign][1]
@@ -4210,7 +4298,22 @@ module Aws::Personalize
4210
4298
  # The Amazon Resource Name (ARN) of the campaign.
4211
4299
  #
4212
4300
  # @option params [String] :solution_version_arn
4213
- # The ARN of a new solution version to deploy.
4301
+ # The Amazon Resource Name (ARN) of a new model to deploy. To specify
4302
+ # the latest solution version of your solution, specify the ARN of your
4303
+ # *solution* in `SolutionArn/$LATEST` format. You must use this format
4304
+ # if you set `syncWithLatestSolutionVersion` to `True` in the
4305
+ # [CampaignConfig][1].
4306
+ #
4307
+ # To deploy a model that isn't the latest solution version of your
4308
+ # solution, specify the ARN of the solution version.
4309
+ #
4310
+ # For more information about automatic campaign updates, see [Enabling
4311
+ # automatic campaign updates][2].
4312
+ #
4313
+ #
4314
+ #
4315
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html
4316
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
4214
4317
  #
4215
4318
  # @option params [Integer] :min_provisioned_tps
4216
4319
  # Specifies the requested minimum provisioned transactions
@@ -4238,6 +4341,7 @@ module Aws::Personalize
4238
4341
  # "ParameterName" => "ParameterValue",
4239
4342
  # },
4240
4343
  # enable_metadata_with_recommendations: false,
4344
+ # sync_with_latest_solution_version: false,
4241
4345
  # },
4242
4346
  # })
4243
4347
  #
@@ -4410,7 +4514,7 @@ module Aws::Personalize
4410
4514
  params: params,
4411
4515
  config: config)
4412
4516
  context[:gem_name] = 'aws-sdk-personalize'
4413
- context[:gem_version] = '1.59.0'
4517
+ context[:gem_version] = '1.60.0'
4414
4518
  Seahorse::Client::Request.new(handlers, context)
4415
4519
  end
4416
4520
 
@@ -20,6 +20,7 @@ module Aws::Personalize
20
20
  ArnList = Shapes::ListShape.new(name: 'ArnList')
21
21
  AutoMLConfig = Shapes::StructureShape.new(name: 'AutoMLConfig')
22
22
  AutoMLResult = Shapes::StructureShape.new(name: 'AutoMLResult')
23
+ AutoTrainingConfig = Shapes::StructureShape.new(name: 'AutoTrainingConfig')
23
24
  AvroSchema = Shapes::StringShape.new(name: 'AvroSchema')
24
25
  BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
25
26
  BatchInferenceJobConfig = Shapes::StructureShape.new(name: 'BatchInferenceJobConfig')
@@ -240,6 +241,7 @@ module Aws::Personalize
240
241
  ParameterName = Shapes::StringShape.new(name: 'ParameterName')
241
242
  ParameterValue = Shapes::StringShape.new(name: 'ParameterValue')
242
243
  PerformAutoML = Shapes::BooleanShape.new(name: 'PerformAutoML')
244
+ PerformAutoTraining = Shapes::BooleanShape.new(name: 'PerformAutoTraining')
243
245
  PerformHPO = Shapes::BooleanShape.new(name: 'PerformHPO')
244
246
  Recipe = Shapes::StructureShape.new(name: 'Recipe')
245
247
  RecipeProvider = Shapes::StringShape.new(name: 'RecipeProvider')
@@ -258,6 +260,7 @@ module Aws::Personalize
258
260
  RoleArn = Shapes::StringShape.new(name: 'RoleArn')
259
261
  S3DataConfig = Shapes::StructureShape.new(name: 'S3DataConfig')
260
262
  S3Location = Shapes::StringShape.new(name: 'S3Location')
263
+ SchedulingExpression = Shapes::StringShape.new(name: 'SchedulingExpression')
261
264
  Schemas = Shapes::ListShape.new(name: 'Schemas')
262
265
  Solution = Shapes::StructureShape.new(name: 'Solution')
263
266
  SolutionConfig = Shapes::StructureShape.new(name: 'SolutionConfig')
@@ -287,6 +290,7 @@ module Aws::Personalize
287
290
  TrainingHours = Shapes::FloatShape.new(name: 'TrainingHours')
288
291
  TrainingInputMode = Shapes::StringShape.new(name: 'TrainingInputMode')
289
292
  TrainingMode = Shapes::StringShape.new(name: 'TrainingMode')
293
+ TrainingType = Shapes::StringShape.new(name: 'TrainingType')
290
294
  TransactionsPerSecond = Shapes::IntegerShape.new(name: 'TransactionsPerSecond')
291
295
  Tunable = Shapes::BooleanShape.new(name: 'Tunable')
292
296
  TunedHPOParams = Shapes::StructureShape.new(name: 'TunedHPOParams')
@@ -326,6 +330,9 @@ module Aws::Personalize
326
330
  AutoMLResult.add_member(:best_recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "bestRecipeArn"))
327
331
  AutoMLResult.struct_class = Types::AutoMLResult
328
332
 
333
+ AutoTrainingConfig.add_member(:scheduling_expression, Shapes::ShapeRef.new(shape: SchedulingExpression, location_name: "schedulingExpression"))
334
+ AutoTrainingConfig.struct_class = Types::AutoTrainingConfig
335
+
329
336
  BatchInferenceJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
330
337
  BatchInferenceJob.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
331
338
  BatchInferenceJob.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
@@ -409,6 +416,7 @@ module Aws::Personalize
409
416
 
410
417
  CampaignConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
411
418
  CampaignConfig.add_member(:enable_metadata_with_recommendations, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableMetadataWithRecommendations"))
419
+ CampaignConfig.add_member(:sync_with_latest_solution_version, Shapes::ShapeRef.new(shape: Boolean, location_name: "syncWithLatestSolutionVersion"))
412
420
  CampaignConfig.struct_class = Types::CampaignConfig
413
421
 
414
422
  CampaignSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -578,6 +586,7 @@ module Aws::Personalize
578
586
  CreateSolutionRequest.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
579
587
  CreateSolutionRequest.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: Boolean, location_name: "performHPO"))
580
588
  CreateSolutionRequest.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: PerformAutoML, location_name: "performAutoML"))
589
+ CreateSolutionRequest.add_member(:perform_auto_training, Shapes::ShapeRef.new(shape: PerformAutoTraining, location_name: "performAutoTraining"))
581
590
  CreateSolutionRequest.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recipeArn"))
582
591
  CreateSolutionRequest.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "datasetGroupArn"))
583
592
  CreateSolutionRequest.add_member(:event_type, Shapes::ShapeRef.new(shape: EventType, location_name: "eventType"))
@@ -1247,6 +1256,7 @@ module Aws::Personalize
1247
1256
  Solution.add_member(:solution_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionArn"))
1248
1257
  Solution.add_member(:perform_hpo, Shapes::ShapeRef.new(shape: PerformHPO, location_name: "performHPO"))
1249
1258
  Solution.add_member(:perform_auto_ml, Shapes::ShapeRef.new(shape: PerformAutoML, location_name: "performAutoML"))
1259
+ Solution.add_member(:perform_auto_training, Shapes::ShapeRef.new(shape: PerformAutoTraining, location_name: "performAutoTraining"))
1250
1260
  Solution.add_member(:recipe_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "recipeArn"))
1251
1261
  Solution.add_member(:dataset_group_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "datasetGroupArn"))
1252
1262
  Solution.add_member(:event_type, Shapes::ShapeRef.new(shape: EventType, location_name: "eventType"))
@@ -1265,6 +1275,7 @@ module Aws::Personalize
1265
1275
  SolutionConfig.add_member(:auto_ml_config, Shapes::ShapeRef.new(shape: AutoMLConfig, location_name: "autoMLConfig"))
1266
1276
  SolutionConfig.add_member(:optimization_objective, Shapes::ShapeRef.new(shape: OptimizationObjective, location_name: "optimizationObjective"))
1267
1277
  SolutionConfig.add_member(:training_data_config, Shapes::ShapeRef.new(shape: TrainingDataConfig, location_name: "trainingDataConfig"))
1278
+ SolutionConfig.add_member(:auto_training_config, Shapes::ShapeRef.new(shape: AutoTrainingConfig, location_name: "autoTrainingConfig"))
1268
1279
  SolutionConfig.struct_class = Types::SolutionConfig
1269
1280
 
1270
1281
  SolutionSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -1291,10 +1302,13 @@ module Aws::Personalize
1291
1302
  SolutionVersion.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
1292
1303
  SolutionVersion.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
1293
1304
  SolutionVersion.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
1305
+ SolutionVersion.add_member(:training_type, Shapes::ShapeRef.new(shape: TrainingType, location_name: "trainingType"))
1294
1306
  SolutionVersion.struct_class = Types::SolutionVersion
1295
1307
 
1296
1308
  SolutionVersionSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
1297
1309
  SolutionVersionSummary.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
1310
+ SolutionVersionSummary.add_member(:training_mode, Shapes::ShapeRef.new(shape: TrainingMode, location_name: "trainingMode"))
1311
+ SolutionVersionSummary.add_member(:training_type, Shapes::ShapeRef.new(shape: TrainingType, location_name: "trainingType"))
1298
1312
  SolutionVersionSummary.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
1299
1313
  SolutionVersionSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
1300
1314
  SolutionVersionSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
@@ -138,6 +138,32 @@ module Aws::Personalize
138
138
  include Aws::Structure
139
139
  end
140
140
 
141
+ # The automatic training configuration to use when `performAutoTraining`
142
+ # is true.
143
+ #
144
+ # @!attribute [rw] scheduling_expression
145
+ # Specifies how often to automatically train new solution versions.
146
+ # Specify a rate expression in rate(*value* *unit*) format. For value,
147
+ # specify a number between 1 and 30. For unit, specify `day` or
148
+ # `days`. For example, to automatically create a new solution version
149
+ # every 5 days, specify `rate(5 days)`. The default is every 7 days.
150
+ #
151
+ # For more information about auto training, see [Creating and
152
+ # configuring a solution][1].
153
+ #
154
+ #
155
+ #
156
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html
157
+ # @return [String]
158
+ #
159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/AutoTrainingConfig AWS API Documentation
160
+ #
161
+ class AutoTrainingConfig < Struct.new(
162
+ :scheduling_expression)
163
+ SENSITIVE = []
164
+ include Aws::Structure
165
+ end
166
+
141
167
  # Contains information on a batch inference job.
142
168
  #
143
169
  # @!attribute [rw] job_name
@@ -545,8 +571,8 @@ module Aws::Personalize
545
571
  # @return [String]
546
572
  #
547
573
  # @!attribute [rw] solution_version_arn
548
- # The Amazon Resource Name (ARN) of a specific version of the
549
- # solution.
574
+ # The Amazon Resource Name (ARN) of the solution version the campaign
575
+ # uses.
550
576
  # @return [String]
551
577
  #
552
578
  # @!attribute [rw] min_provisioned_tps
@@ -643,11 +669,28 @@ module Aws::Personalize
643
669
  # [2]: https://aws.amazon.com/personalize/pricing/
644
670
  # @return [Boolean]
645
671
  #
672
+ # @!attribute [rw] sync_with_latest_solution_version
673
+ # Whether the campaign automatically updates to use the latest
674
+ # solution version (trained model) of a solution. If you specify
675
+ # `True`, you must specify the ARN of your *solution* for the
676
+ # `SolutionVersionArn` parameter. It must be in `SolutionArn/$LATEST`
677
+ # format. The default is `False` and you must manually update the
678
+ # campaign to deploy the latest solution version.
679
+ #
680
+ # For more information about automatic campaign updates, see [Enabling
681
+ # automatic campaign updates][1].
682
+ #
683
+ #
684
+ #
685
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
686
+ # @return [Boolean]
687
+ #
646
688
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
647
689
  #
648
690
  class CampaignConfig < Struct.new(
649
691
  :item_exploration_config,
650
- :enable_metadata_with_recommendations)
692
+ :enable_metadata_with_recommendations,
693
+ :sync_with_latest_solution_version)
651
694
  SENSITIVE = []
652
695
  include Aws::Structure
653
696
  end
@@ -988,7 +1031,23 @@ module Aws::Personalize
988
1031
  # @return [String]
989
1032
  #
990
1033
  # @!attribute [rw] solution_version_arn
991
- # The Amazon Resource Name (ARN) of the solution version to deploy.
1034
+ # The Amazon Resource Name (ARN) of the trained model to deploy with
1035
+ # the campaign. To specify the latest solution version of your
1036
+ # solution, specify the ARN of your *solution* in
1037
+ # `SolutionArn/$LATEST` format. You must use this format if you set
1038
+ # `syncWithLatestSolutionVersion` to `True` in the
1039
+ # [CampaignConfig][1].
1040
+ #
1041
+ # To deploy a model that isn't the latest solution version of your
1042
+ # solution, specify the ARN of the solution version.
1043
+ #
1044
+ # For more information about automatic campaign updates, see [Enabling
1045
+ # automatic campaign updates][2].
1046
+ #
1047
+ #
1048
+ #
1049
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html
1050
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
992
1051
  # @return [String]
993
1052
  #
994
1053
  # @!attribute [rw] min_provisioned_tps
@@ -1554,6 +1613,30 @@ module Aws::Personalize
1554
1613
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html
1555
1614
  # @return [Boolean]
1556
1615
  #
1616
+ # @!attribute [rw] perform_auto_training
1617
+ # Whether the solution uses automatic training to create new solution
1618
+ # versions (trained models). The default is `True` and the solution
1619
+ # automatically creates new solution versions every 7 days. You can
1620
+ # change the training frequency by specifying a `schedulingExpression`
1621
+ # in the `AutoTrainingConfig` as part of solution configuration. For
1622
+ # more information about automatic training, see [Configuring
1623
+ # automatic training][1].
1624
+ #
1625
+ # Automatic solution version creation starts one hour after the
1626
+ # solution is ACTIVE. If you manually create a solution version within
1627
+ # the hour, the solution skips the first automatic training.
1628
+ #
1629
+ # After training starts, you can get the solution version's Amazon
1630
+ # Resource Name (ARN) with the [ListSolutionVersions][2] API
1631
+ # operation. To get its status, use the [DescribeSolutionVersion][3].
1632
+ #
1633
+ #
1634
+ #
1635
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html
1636
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html
1637
+ # [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html
1638
+ # @return [Boolean]
1639
+ #
1557
1640
  # @!attribute [rw] recipe_arn
1558
1641
  # The Amazon Resource Name (ARN) of the recipe to use for model
1559
1642
  # training. This is required when `performAutoML` is false. For
@@ -1604,6 +1687,7 @@ module Aws::Personalize
1604
1687
  :name,
1605
1688
  :perform_hpo,
1606
1689
  :perform_auto_ml,
1690
+ :perform_auto_training,
1607
1691
  :recipe_arn,
1608
1692
  :dataset_group_arn,
1609
1693
  :event_type,
@@ -4212,7 +4296,7 @@ module Aws::Personalize
4212
4296
  end
4213
4297
 
4214
4298
  # @!attribute [rw] resource_arn
4215
- # The resource's Amazon Resource Name.
4299
+ # The resource's Amazon Resource Name (ARN).
4216
4300
  # @return [String]
4217
4301
  #
4218
4302
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListTagsForResourceRequest AWS API Documentation
@@ -4850,8 +4934,26 @@ module Aws::Personalize
4850
4934
  include Aws::Structure
4851
4935
  end
4852
4936
 
4853
- # An object that provides information about a solution. A solution is a
4854
- # trained model that can be deployed as a campaign.
4937
+ # After you create a solution, you can’t change its configuration. By
4938
+ # default, all new solutions use automatic training. With automatic
4939
+ # training, you incur training costs while your solution is active. You
4940
+ # can't stop automatic training for a solution. To avoid unnecessary
4941
+ # costs, make sure to delete the solution when you are finished. For
4942
+ # information about training costs, see [Amazon Personalize pricing][1].
4943
+ #
4944
+ # An object that provides information about a solution. A solution
4945
+ # includes the custom recipe, customized parameters, and trained models
4946
+ # (Solution Versions) that Amazon Personalize uses to generate
4947
+ # recommendations.
4948
+ #
4949
+ # After you create a solution, you can’t change its configuration. If
4950
+ # you need to make changes, you can [clone the solution][2] with the
4951
+ # Amazon Personalize console or create a new one.
4952
+ #
4953
+ #
4954
+ #
4955
+ # [1]: https://aws.amazon.com/personalize/pricing/
4956
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html
4855
4957
  #
4856
4958
  # @!attribute [rw] name
4857
4959
  # The name of the solution.
@@ -4881,6 +4983,19 @@ module Aws::Personalize
4881
4983
  # [1]: https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html
4882
4984
  # @return [Boolean]
4883
4985
  #
4986
+ # @!attribute [rw] perform_auto_training
4987
+ # Specifies whether the solution automatically creates solution
4988
+ # versions. The default is `True` and the solution automatically
4989
+ # creates new solution versions every 7 days.
4990
+ #
4991
+ # For more information about auto training, see [Creating and
4992
+ # configuring a solution][1].
4993
+ #
4994
+ #
4995
+ #
4996
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html
4997
+ # @return [Boolean]
4998
+ #
4884
4999
  # @!attribute [rw] recipe_arn
4885
5000
  # The ARN of the recipe used to create the solution. This is required
4886
5001
  # when `performAutoML` is false.
@@ -4937,6 +5052,7 @@ module Aws::Personalize
4937
5052
  :solution_arn,
4938
5053
  :perform_hpo,
4939
5054
  :perform_auto_ml,
5055
+ :perform_auto_training,
4940
5056
  :recipe_arn,
4941
5057
  :dataset_group_arn,
4942
5058
  :event_type,
@@ -4993,6 +5109,10 @@ module Aws::Personalize
4993
5109
  # custom solution version (trained model).
4994
5110
  # @return [Types::TrainingDataConfig]
4995
5111
  #
5112
+ # @!attribute [rw] auto_training_config
5113
+ # Specifies the automatic training configuration to use.
5114
+ # @return [Types::AutoTrainingConfig]
5115
+ #
4996
5116
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionConfig AWS API Documentation
4997
5117
  #
4998
5118
  class SolutionConfig < Struct.new(
@@ -5002,7 +5122,8 @@ module Aws::Personalize
5002
5122
  :feature_transformation_parameters,
5003
5123
  :auto_ml_config,
5004
5124
  :optimization_objective,
5005
- :training_data_config)
5125
+ :training_data_config,
5126
+ :auto_training_config)
5006
5127
  SENSITIVE = []
5007
5128
  include Aws::Structure
5008
5129
  end
@@ -5114,22 +5235,10 @@ module Aws::Personalize
5114
5235
  #
5115
5236
  # @!attribute [rw] training_mode
5116
5237
  # The scope of training to be performed when creating the solution
5117
- # version. The `FULL` option trains the solution version based on the
5118
- # entirety of the input solution's training data, while the `UPDATE`
5119
- # option processes only the data that has changed in comparison to the
5120
- # input solution. Choose `UPDATE` when you want to incrementally
5121
- # update your solution version instead of creating an entirely new
5122
- # one.
5123
- #
5124
- # The `UPDATE` option can only be used when you already have an active
5125
- # solution version created from the input solution using the `FULL`
5126
- # option and the input solution was trained with the
5127
- # [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
5128
- #
5129
- #
5130
- #
5131
- # [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
5132
- # [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
5238
+ # version. A `FULL` training considers all of the data in your dataset
5239
+ # group. An `UPDATE` processes only the data that has changed since
5240
+ # the latest training. Only solution versions created with the
5241
+ # User-Personalization recipe can use `UPDATE`.
5133
5242
  # @return [String]
5134
5243
  #
5135
5244
  # @!attribute [rw] tuned_hpo_params
@@ -5168,6 +5277,10 @@ module Aws::Personalize
5168
5277
  # The date and time (in Unix time) that the solution was last updated.
5169
5278
  # @return [Time]
5170
5279
  #
5280
+ # @!attribute [rw] training_type
5281
+ # Whether the solution version was created automatically or manually.
5282
+ # @return [String]
5283
+ #
5171
5284
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/SolutionVersion AWS API Documentation
5172
5285
  #
5173
5286
  class SolutionVersion < Struct.new(
@@ -5186,7 +5299,8 @@ module Aws::Personalize
5186
5299
  :status,
5187
5300
  :failure_reason,
5188
5301
  :creation_date_time,
5189
- :last_updated_date_time)
5302
+ :last_updated_date_time,
5303
+ :training_type)
5190
5304
  SENSITIVE = []
5191
5305
  include Aws::Structure
5192
5306
  end
@@ -5213,6 +5327,18 @@ module Aws::Personalize
5213
5327
  # ^
5214
5328
  # @return [String]
5215
5329
  #
5330
+ # @!attribute [rw] training_mode
5331
+ # The scope of training to be performed when creating the solution
5332
+ # version. A `FULL` training considers all of the data in your dataset
5333
+ # group. An `UPDATE` processes only the data that has changed since
5334
+ # the latest training. Only solution versions created with the
5335
+ # User-Personalization recipe can use `UPDATE`.
5336
+ # @return [String]
5337
+ #
5338
+ # @!attribute [rw] training_type
5339
+ # Whether the solution version was created automatically or manually.
5340
+ # @return [String]
5341
+ #
5216
5342
  # @!attribute [rw] creation_date_time
5217
5343
  # The date and time (in Unix time) that this version of a solution was
5218
5344
  # created.
@@ -5232,6 +5358,8 @@ module Aws::Personalize
5232
5358
  class SolutionVersionSummary < Struct.new(
5233
5359
  :solution_version_arn,
5234
5360
  :status,
5361
+ :training_mode,
5362
+ :training_type,
5235
5363
  :creation_date_time,
5236
5364
  :last_updated_date_time,
5237
5365
  :failure_reason)
@@ -5303,7 +5431,7 @@ module Aws::Personalize
5303
5431
  # The optional metadata that you apply to resources to help you
5304
5432
  # categorize and organize them. Each tag consists of a key and an
5305
5433
  # optional value, both of which you define. For more information see
5306
- # [Tagging Amazon Personalize recources][1].
5434
+ # [Tagging Amazon Personalize resources][1].
5307
5435
  #
5308
5436
  #
5309
5437
  #
@@ -5334,7 +5462,7 @@ module Aws::Personalize
5334
5462
  #
5335
5463
  # @!attribute [rw] tags
5336
5464
  # Tags to apply to the resource. For more information see [Tagging
5337
- # Amazon Personalize recources][1].
5465
+ # Amazon Personalize resources][1].
5338
5466
  #
5339
5467
  #
5340
5468
  #
@@ -5405,10 +5533,11 @@ module Aws::Personalize
5405
5533
  # Specifies the columns to exclude from training. Each key is a
5406
5534
  # dataset type, and each value is a list of columns. Exclude columns
5407
5535
  # to control what data Amazon Personalize uses to generate
5408
- # recommendations. For example, you might have a column that you want
5409
- # to use only to filter recommendations. You can exclude this column
5410
- # from training and Amazon Personalize considers it only when
5411
- # filtering.
5536
+ # recommendations.
5537
+ #
5538
+ # For example, you might have a column that you want to use only to
5539
+ # filter recommendations. You can exclude this column from training
5540
+ # and Amazon Personalize considers it only when filtering.
5412
5541
  # @return [Hash<String,Array<String>>]
5413
5542
  #
5414
5543
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/TrainingDataConfig AWS API Documentation
@@ -5439,7 +5568,7 @@ module Aws::Personalize
5439
5568
  # @return [String]
5440
5569
  #
5441
5570
  # @!attribute [rw] tag_keys
5442
- # Keys to remove from the resource's tags.
5571
+ # The keys of the tags to be removed.
5443
5572
  # @return [Array<String>]
5444
5573
  #
5445
5574
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/UntagResourceRequest AWS API Documentation
@@ -5460,7 +5589,22 @@ module Aws::Personalize
5460
5589
  # @return [String]
5461
5590
  #
5462
5591
  # @!attribute [rw] solution_version_arn
5463
- # The ARN of a new solution version to deploy.
5592
+ # The Amazon Resource Name (ARN) of a new model to deploy. To specify
5593
+ # the latest solution version of your solution, specify the ARN of
5594
+ # your *solution* in `SolutionArn/$LATEST` format. You must use this
5595
+ # format if you set `syncWithLatestSolutionVersion` to `True` in the
5596
+ # [CampaignConfig][1].
5597
+ #
5598
+ # To deploy a model that isn't the latest solution version of your
5599
+ # solution, specify the ARN of the solution version.
5600
+ #
5601
+ # For more information about automatic campaign updates, see [Enabling
5602
+ # automatic campaign updates][2].
5603
+ #
5604
+ #
5605
+ #
5606
+ # [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html
5607
+ # [2]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update
5464
5608
  # @return [String]
5465
5609
  #
5466
5610
  # @!attribute [rw] min_provisioned_tps
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalize/customizations'
52
52
  # @!group service
53
53
  module Aws::Personalize
54
54
 
55
- GEM_VERSION = '1.59.0'
55
+ GEM_VERSION = '1.60.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -157,7 +157,8 @@ module Aws
157
157
  ?min_provisioned_tps: ::Integer,
158
158
  ?campaign_config: {
159
159
  item_exploration_config: Hash[::String, ::String]?,
160
- enable_metadata_with_recommendations: bool?
160
+ enable_metadata_with_recommendations: bool?,
161
+ sync_with_latest_solution_version: bool?
161
162
  },
162
163
  ?tags: Array[
163
164
  {
@@ -363,6 +364,7 @@ module Aws
363
364
  name: ::String,
364
365
  ?perform_hpo: bool,
365
366
  ?perform_auto_ml: bool,
367
+ ?perform_auto_training: bool,
366
368
  ?recipe_arn: ::String,
367
369
  dataset_group_arn: ::String,
368
370
  ?event_type: ::String,
@@ -413,6 +415,9 @@ module Aws
413
415
  }?,
414
416
  training_data_config: {
415
417
  excluded_dataset_columns: Hash[::String, Array[::String]]?
418
+ }?,
419
+ auto_training_config: {
420
+ scheduling_expression: ::String?
416
421
  }?
417
422
  },
418
423
  ?tags: Array[
@@ -432,7 +437,7 @@ module Aws
432
437
  def create_solution_version: (
433
438
  ?name: ::String,
434
439
  solution_arn: ::String,
435
- ?training_mode: ("FULL" | "UPDATE"),
440
+ ?training_mode: ("FULL" | "UPDATE" | "AUTOTRAIN"),
436
441
  ?tags: Array[
437
442
  {
438
443
  tag_key: ::String,
@@ -956,7 +961,8 @@ module Aws
956
961
  ?min_provisioned_tps: ::Integer,
957
962
  ?campaign_config: {
958
963
  item_exploration_config: Hash[::String, ::String]?,
959
- enable_metadata_with_recommendations: bool?
964
+ enable_metadata_with_recommendations: bool?,
965
+ sync_with_latest_solution_version: bool?
960
966
  }
961
967
  ) -> _UpdateCampaignResponseSuccess
962
968
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCampaignResponseSuccess
data/sig/types.rbs CHANGED
@@ -39,6 +39,11 @@ module Aws::Personalize
39
39
  SENSITIVE: []
40
40
  end
41
41
 
42
+ class AutoTrainingConfig
43
+ attr_accessor scheduling_expression: ::String
44
+ SENSITIVE: []
45
+ end
46
+
42
47
  class BatchInferenceJob
43
48
  attr_accessor job_name: ::String
44
49
  attr_accessor batch_inference_job_arn: ::String
@@ -139,6 +144,7 @@ module Aws::Personalize
139
144
  class CampaignConfig
140
145
  attr_accessor item_exploration_config: ::Hash[::String, ::String]
141
146
  attr_accessor enable_metadata_with_recommendations: bool
147
+ attr_accessor sync_with_latest_solution_version: bool
142
148
  SENSITIVE: []
143
149
  end
144
150
 
@@ -356,6 +362,7 @@ module Aws::Personalize
356
362
  attr_accessor name: ::String
357
363
  attr_accessor perform_hpo: bool
358
364
  attr_accessor perform_auto_ml: bool
365
+ attr_accessor perform_auto_training: bool
359
366
  attr_accessor recipe_arn: ::String
360
367
  attr_accessor dataset_group_arn: ::String
361
368
  attr_accessor event_type: ::String
@@ -372,7 +379,7 @@ module Aws::Personalize
372
379
  class CreateSolutionVersionRequest
373
380
  attr_accessor name: ::String
374
381
  attr_accessor solution_arn: ::String
375
- attr_accessor training_mode: ("FULL" | "UPDATE")
382
+ attr_accessor training_mode: ("FULL" | "UPDATE" | "AUTOTRAIN")
376
383
  attr_accessor tags: ::Array[Types::Tag]
377
384
  SENSITIVE: []
378
385
  end
@@ -1233,6 +1240,7 @@ module Aws::Personalize
1233
1240
  attr_accessor solution_arn: ::String
1234
1241
  attr_accessor perform_hpo: bool
1235
1242
  attr_accessor perform_auto_ml: bool
1243
+ attr_accessor perform_auto_training: bool
1236
1244
  attr_accessor recipe_arn: ::String
1237
1245
  attr_accessor dataset_group_arn: ::String
1238
1246
  attr_accessor event_type: ::String
@@ -1253,6 +1261,7 @@ module Aws::Personalize
1253
1261
  attr_accessor auto_ml_config: Types::AutoMLConfig
1254
1262
  attr_accessor optimization_objective: Types::OptimizationObjective
1255
1263
  attr_accessor training_data_config: Types::TrainingDataConfig
1264
+ attr_accessor auto_training_config: Types::AutoTrainingConfig
1256
1265
  SENSITIVE: []
1257
1266
  end
1258
1267
 
@@ -1277,18 +1286,21 @@ module Aws::Personalize
1277
1286
  attr_accessor dataset_group_arn: ::String
1278
1287
  attr_accessor solution_config: Types::SolutionConfig
1279
1288
  attr_accessor training_hours: ::Float
1280
- attr_accessor training_mode: ("FULL" | "UPDATE")
1289
+ attr_accessor training_mode: ("FULL" | "UPDATE" | "AUTOTRAIN")
1281
1290
  attr_accessor tuned_hpo_params: Types::TunedHPOParams
1282
1291
  attr_accessor status: ::String
1283
1292
  attr_accessor failure_reason: ::String
1284
1293
  attr_accessor creation_date_time: ::Time
1285
1294
  attr_accessor last_updated_date_time: ::Time
1295
+ attr_accessor training_type: ("AUTOMATIC" | "MANUAL")
1286
1296
  SENSITIVE: []
1287
1297
  end
1288
1298
 
1289
1299
  class SolutionVersionSummary
1290
1300
  attr_accessor solution_version_arn: ::String
1291
1301
  attr_accessor status: ::String
1302
+ attr_accessor training_mode: ("FULL" | "UPDATE" | "AUTOTRAIN")
1303
+ attr_accessor training_type: ("AUTOMATIC" | "MANUAL")
1292
1304
  attr_accessor creation_date_time: ::Time
1293
1305
  attr_accessor last_updated_date_time: ::Time
1294
1306
  attr_accessor failure_reason: ::String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalize
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.59.0
4
+ version: 1.60.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-01-26 00:00:00.000000000 Z
11
+ date: 2024-04-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core