@aws-sdk/client-personalize 3.554.0 → 3.559.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.
package/dist-cjs/index.js CHANGED
@@ -104,6 +104,7 @@ __export(src_exports, {
104
104
  TooManyTagKeysException: () => TooManyTagKeysException,
105
105
  TooManyTagsException: () => TooManyTagsException,
106
106
  TrainingMode: () => TrainingMode,
107
+ TrainingType: () => TrainingType,
107
108
  UntagResourceCommand: () => UntagResourceCommand,
108
109
  UpdateCampaignCommand: () => UpdateCampaignCommand,
109
110
  UpdateDatasetCommand: () => UpdateDatasetCommand,
@@ -430,9 +431,14 @@ var ObjectiveSensitivity = {
430
431
  OFF: "OFF"
431
432
  };
432
433
  var TrainingMode = {
434
+ AUTOTRAIN: "AUTOTRAIN",
433
435
  FULL: "FULL",
434
436
  UPDATE: "UPDATE"
435
437
  };
438
+ var TrainingType = {
439
+ AUTOMATIC: "AUTOMATIC",
440
+ MANUAL: "MANUAL"
441
+ };
436
442
  var _InvalidNextTokenException = class _InvalidNextTokenException extends PersonalizeServiceException {
437
443
  /**
438
444
  * @internal
@@ -1857,6 +1863,7 @@ var se_CreateSolutionRequest = /* @__PURE__ */ __name((input, context) => {
1857
1863
  eventType: [],
1858
1864
  name: [],
1859
1865
  performAutoML: [],
1866
+ performAutoTraining: [],
1860
1867
  performHPO: [],
1861
1868
  recipeArn: [],
1862
1869
  solutionConfig: (_) => se_SolutionConfig(_, context),
@@ -1881,6 +1888,7 @@ var se_SolutionConfig = /* @__PURE__ */ __name((input, context) => {
1881
1888
  return (0, import_smithy_client.take)(input, {
1882
1889
  algorithmHyperParameters: import_smithy_client._json,
1883
1890
  autoMLConfig: import_smithy_client._json,
1891
+ autoTrainingConfig: import_smithy_client._json,
1884
1892
  eventValueThreshold: [],
1885
1893
  featureTransformationParameters: import_smithy_client._json,
1886
1894
  hpoConfig: (_) => se_HPOConfig(_, context),
@@ -2582,6 +2590,7 @@ var de_Solution = /* @__PURE__ */ __name((output, context) => {
2582
2590
  latestSolutionVersion: (_) => de_SolutionVersionSummary(_, context),
2583
2591
  name: import_smithy_client.expectString,
2584
2592
  performAutoML: import_smithy_client.expectBoolean,
2593
+ performAutoTraining: import_smithy_client.expectBoolean,
2585
2594
  performHPO: import_smithy_client.expectBoolean,
2586
2595
  recipeArn: import_smithy_client.expectString,
2587
2596
  solutionArn: import_smithy_client.expectString,
@@ -2593,6 +2602,7 @@ var de_SolutionConfig = /* @__PURE__ */ __name((output, context) => {
2593
2602
  return (0, import_smithy_client.take)(output, {
2594
2603
  algorithmHyperParameters: import_smithy_client._json,
2595
2604
  autoMLConfig: import_smithy_client._json,
2605
+ autoTrainingConfig: import_smithy_client._json,
2596
2606
  eventValueThreshold: import_smithy_client.expectString,
2597
2607
  featureTransformationParameters: import_smithy_client._json,
2598
2608
  hpoConfig: (_) => de_HPOConfig(_, context),
@@ -2633,6 +2643,7 @@ var de_SolutionVersion = /* @__PURE__ */ __name((output, context) => {
2633
2643
  status: import_smithy_client.expectString,
2634
2644
  trainingHours: import_smithy_client.limitedParseDouble,
2635
2645
  trainingMode: import_smithy_client.expectString,
2646
+ trainingType: import_smithy_client.expectString,
2636
2647
  tunedHPOParams: import_smithy_client._json
2637
2648
  });
2638
2649
  }, "de_SolutionVersion");
@@ -2648,7 +2659,9 @@ var de_SolutionVersionSummary = /* @__PURE__ */ __name((output, context) => {
2648
2659
  failureReason: import_smithy_client.expectString,
2649
2660
  lastUpdatedDateTime: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
2650
2661
  solutionVersionArn: import_smithy_client.expectString,
2651
- status: import_smithy_client.expectString
2662
+ status: import_smithy_client.expectString,
2663
+ trainingMode: import_smithy_client.expectString,
2664
+ trainingType: import_smithy_client.expectString
2652
2665
  });
2653
2666
  }, "de_SolutionVersionSummary");
2654
2667
  var deserializeMetadata = /* @__PURE__ */ __name((output) => ({
@@ -4061,6 +4074,7 @@ var paginateListSolutions = (0, import_core.createPaginator)(PersonalizeClient,
4061
4074
  ImportMode,
4062
4075
  ObjectiveSensitivity,
4063
4076
  TrainingMode,
4077
+ TrainingType,
4064
4078
  InvalidNextTokenException,
4065
4079
  RecipeProvider,
4066
4080
  TooManyTagKeysException,
@@ -96,9 +96,14 @@ export const ObjectiveSensitivity = {
96
96
  OFF: "OFF",
97
97
  };
98
98
  export const TrainingMode = {
99
+ AUTOTRAIN: "AUTOTRAIN",
99
100
  FULL: "FULL",
100
101
  UPDATE: "UPDATE",
101
102
  };
103
+ export const TrainingType = {
104
+ AUTOMATIC: "AUTOMATIC",
105
+ MANUAL: "MANUAL",
106
+ };
102
107
  export class InvalidNextTokenException extends __BaseException {
103
108
  constructor(opts) {
104
109
  super({
@@ -1378,6 +1378,7 @@ const se_CreateSolutionRequest = (input, context) => {
1378
1378
  eventType: [],
1379
1379
  name: [],
1380
1380
  performAutoML: [],
1381
+ performAutoTraining: [],
1381
1382
  performHPO: [],
1382
1383
  recipeArn: [],
1383
1384
  solutionConfig: (_) => se_SolutionConfig(_, context),
@@ -1402,6 +1403,7 @@ const se_SolutionConfig = (input, context) => {
1402
1403
  return take(input, {
1403
1404
  algorithmHyperParameters: _json,
1404
1405
  autoMLConfig: _json,
1406
+ autoTrainingConfig: _json,
1405
1407
  eventValueThreshold: [],
1406
1408
  featureTransformationParameters: _json,
1407
1409
  hpoConfig: (_) => se_HPOConfig(_, context),
@@ -2133,6 +2135,7 @@ const de_Solution = (output, context) => {
2133
2135
  latestSolutionVersion: (_) => de_SolutionVersionSummary(_, context),
2134
2136
  name: __expectString,
2135
2137
  performAutoML: __expectBoolean,
2138
+ performAutoTraining: __expectBoolean,
2136
2139
  performHPO: __expectBoolean,
2137
2140
  recipeArn: __expectString,
2138
2141
  solutionArn: __expectString,
@@ -2144,6 +2147,7 @@ const de_SolutionConfig = (output, context) => {
2144
2147
  return take(output, {
2145
2148
  algorithmHyperParameters: _json,
2146
2149
  autoMLConfig: _json,
2150
+ autoTrainingConfig: _json,
2147
2151
  eventValueThreshold: __expectString,
2148
2152
  featureTransformationParameters: _json,
2149
2153
  hpoConfig: (_) => de_HPOConfig(_, context),
@@ -2186,6 +2190,7 @@ const de_SolutionVersion = (output, context) => {
2186
2190
  status: __expectString,
2187
2191
  trainingHours: __limitedParseDouble,
2188
2192
  trainingMode: __expectString,
2193
+ trainingType: __expectString,
2189
2194
  tunedHPOParams: _json,
2190
2195
  });
2191
2196
  };
@@ -2204,6 +2209,8 @@ const de_SolutionVersionSummary = (output, context) => {
2204
2209
  lastUpdatedDateTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
2205
2210
  solutionVersionArn: __expectString,
2206
2211
  status: __expectString,
2212
+ trainingMode: __expectString,
2213
+ trainingType: __expectString,
2207
2214
  });
2208
2215
  };
2209
2216
  const deserializeMetadata = (output) => ({
@@ -26,7 +26,11 @@ declare const CreateCampaignCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Creates a campaign that deploys a solution version. When a client calls the
29
+ * <important>
30
+ * <p> You incur campaign costs while it is active. To avoid unnecessary costs, make sure to delete the campaign when you are finished. For information about campaign
31
+ * costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>.</p>
32
+ * </important>
33
+ * <p>Creates a campaign that deploys a solution version. When a client calls the
30
34
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a>
31
35
  * and
32
36
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetPersonalizedRanking.html">GetPersonalizedRanking</a>
@@ -112,6 +116,7 @@ declare const CreateCampaignCommand_base: {
112
116
  * "<keys>": "STRING_VALUE",
113
117
  * },
114
118
  * enableMetadataWithRecommendations: true || false,
119
+ * syncWithLatestSolutionVersion: true || false,
115
120
  * },
116
121
  * tags: [ // Tags
117
122
  * { // Tag
@@ -26,19 +26,32 @@ declare const CreateSolutionCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Creates the configuration for training a model. A trained model is known as
30
- * a solution version. After the configuration is created, you train the model (create a solution version)
31
- * by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation. Every time you call
32
- * <code>CreateSolutionVersion</code>, a new version of the solution is created.</p>
33
- * <p>After creating a solution version, you check its accuracy by calling
34
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the version, you
29
+ * <important>
30
+ * <p>After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while
31
+ * your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training
32
+ * costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>.</p>
33
+ * </important>
34
+ * <p>Creates the configuration for training a model (creating a solution version). This configuration
35
+ * includes the recipe to use for model training and optional training configuration, such as columns to use
36
+ * in training and feature transformation parameters. For more information about configuring a solution, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.
37
+ * </p>
38
+ * <p>
39
+ * By default, new solutions use automatic training to create solution versions every 7 days. You can change the training frequency.
40
+ * Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within
41
+ * the hour, the solution skips the first automatic training. For more information,
42
+ * see <a href="https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html">Configuring automatic training</a>.</p>
43
+ * <p>
44
+ * To turn off automatic training, set <code>performAutoTraining</code> to false. If you turn off automatic training, you must manually create a solution version
45
+ * by calling the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolutionVersion.html">CreateSolutionVersion</a> operation.</p>
46
+ * <p>After training starts, you can
47
+ * get the solution version's Amazon Resource Name (ARN) with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a> API operation.
48
+ * To get its status, use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>.
49
+ * </p>
50
+ * <p>After training completes you can evaluate model accuracy by calling
51
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_GetSolutionMetrics.html">GetSolutionMetrics</a>. When you are satisfied with the solution version, you
35
52
  * deploy it using <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>. The campaign provides recommendations
36
53
  * to a client through the
37
54
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> API.</p>
38
- * <p>To train a model, Amazon Personalize requires training data and a recipe. The training data
39
- * comes from the dataset group that you provide in the request. A recipe specifies
40
- * the training algorithm and a feature transformation. You can specify one of the predefined
41
- * recipes provided by Amazon Personalize. </p>
42
55
  * <note>
43
56
  * <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code>
44
57
  * for solution hyperparameter optimization at this time.</p>
@@ -55,8 +68,8 @@ declare const CreateSolutionCommand_base: {
55
68
  * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
56
69
  * </li>
57
70
  * </ul>
58
- * <p>To get the status of the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>. Wait
59
- * until the status shows as ACTIVE before calling <code>CreateSolutionVersion</code>.</p>
71
+ * <p>To get the status of the solution, call <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a>. If you use
72
+ * manual training, the status must be ACTIVE before you call <code>CreateSolutionVersion</code>.</p>
60
73
  * <p class="title">
61
74
  * <b>Related APIs</b>
62
75
  * </p>
@@ -104,6 +117,7 @@ declare const CreateSolutionCommand_base: {
104
117
  * name: "STRING_VALUE", // required
105
118
  * performHPO: true || false,
106
119
  * performAutoML: true || false,
120
+ * performAutoTraining: true || false,
107
121
  * recipeArn: "STRING_VALUE",
108
122
  * datasetGroupArn: "STRING_VALUE", // required
109
123
  * eventType: "STRING_VALUE",
@@ -167,6 +181,9 @@ declare const CreateSolutionCommand_base: {
167
181
  * ],
168
182
  * },
169
183
  * },
184
+ * autoTrainingConfig: { // AutoTrainingConfig
185
+ * schedulingExpression: "STRING_VALUE",
186
+ * },
170
187
  * },
171
188
  * tags: [ // Tags
172
189
  * { // Tag
@@ -102,7 +102,7 @@ declare const CreateSolutionVersionCommand_base: {
102
102
  * const input = { // CreateSolutionVersionRequest
103
103
  * name: "STRING_VALUE",
104
104
  * solutionArn: "STRING_VALUE", // required
105
- * trainingMode: "FULL" || "UPDATE",
105
+ * trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
106
106
  * tags: [ // Tags
107
107
  * { // Tag
108
108
  * tagKey: "STRING_VALUE", // required
@@ -61,6 +61,7 @@ declare const DescribeCampaignCommand_base: {
61
61
  * // "<keys>": "STRING_VALUE",
62
62
  * // },
63
63
  * // enableMetadataWithRecommendations: true || false,
64
+ * // syncWithLatestSolutionVersion: true || false,
64
65
  * // },
65
66
  * // status: "STRING_VALUE",
66
67
  * // failureReason: "STRING_VALUE",
@@ -74,6 +75,7 @@ declare const DescribeCampaignCommand_base: {
74
75
  * // "<keys>": "STRING_VALUE",
75
76
  * // },
76
77
  * // enableMetadataWithRecommendations: true || false,
78
+ * // syncWithLatestSolutionVersion: true || false,
77
79
  * // },
78
80
  * // status: "STRING_VALUE",
79
81
  * // failureReason: "STRING_VALUE",
@@ -45,6 +45,7 @@ declare const DescribeSolutionCommand_base: {
45
45
  * // solutionArn: "STRING_VALUE",
46
46
  * // performHPO: true || false,
47
47
  * // performAutoML: true || false,
48
+ * // performAutoTraining: true || false,
48
49
  * // recipeArn: "STRING_VALUE",
49
50
  * // datasetGroupArn: "STRING_VALUE",
50
51
  * // eventType: "STRING_VALUE",
@@ -108,6 +109,9 @@ declare const DescribeSolutionCommand_base: {
108
109
  * // ],
109
110
  * // },
110
111
  * // },
112
+ * // autoTrainingConfig: { // AutoTrainingConfig
113
+ * // schedulingExpression: "STRING_VALUE",
114
+ * // },
111
115
  * // },
112
116
  * // autoMLResult: { // AutoMLResult
113
117
  * // bestRecipeArn: "STRING_VALUE",
@@ -118,6 +122,8 @@ declare const DescribeSolutionCommand_base: {
118
122
  * // latestSolutionVersion: { // SolutionVersionSummary
119
123
  * // solutionVersionArn: "STRING_VALUE",
120
124
  * // status: "STRING_VALUE",
125
+ * // trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
126
+ * // trainingType: "AUTOMATIC" || "MANUAL",
121
127
  * // creationDateTime: new Date("TIMESTAMP"),
122
128
  * // lastUpdatedDateTime: new Date("TIMESTAMP"),
123
129
  * // failureReason: "STRING_VALUE",
@@ -109,9 +109,12 @@ declare const DescribeSolutionVersionCommand_base: {
109
109
  * // ],
110
110
  * // },
111
111
  * // },
112
+ * // autoTrainingConfig: { // AutoTrainingConfig
113
+ * // schedulingExpression: "STRING_VALUE",
114
+ * // },
112
115
  * // },
113
116
  * // trainingHours: Number("double"),
114
- * // trainingMode: "FULL" || "UPDATE",
117
+ * // trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
115
118
  * // tunedHPOParams: { // TunedHPOParams
116
119
  * // algorithmHyperParameters: {
117
120
  * // "<keys>": "STRING_VALUE",
@@ -121,6 +124,7 @@ declare const DescribeSolutionVersionCommand_base: {
121
124
  * // failureReason: "STRING_VALUE",
122
125
  * // creationDateTime: new Date("TIMESTAMP"),
123
126
  * // lastUpdatedDateTime: new Date("TIMESTAMP"),
127
+ * // trainingType: "AUTOMATIC" || "MANUAL",
124
128
  * // },
125
129
  * // };
126
130
  *
@@ -47,6 +47,8 @@ declare const ListSolutionVersionsCommand_base: {
47
47
  * // { // SolutionVersionSummary
48
48
  * // solutionVersionArn: "STRING_VALUE",
49
49
  * // status: "STRING_VALUE",
50
+ * // trainingMode: "FULL" || "UPDATE" || "AUTOTRAIN",
51
+ * // trainingType: "AUTOMATIC" || "MANUAL",
50
52
  * // creationDateTime: new Date("TIMESTAMP"),
51
53
  * // lastUpdatedDateTime: new Date("TIMESTAMP"),
52
54
  * // failureReason: "STRING_VALUE",
@@ -26,7 +26,7 @@ declare const ListSolutionsCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Returns a list of solutions that use the given dataset group.
29
+ * <p>Returns a list of solutions in a given dataset group.
30
30
  * When a dataset group is not specified, all the solutions associated with the account are listed.
31
31
  * The response provides the properties for each solution, including the Amazon Resource Name (ARN).
32
32
  * For more information on solutions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>.</p>
@@ -26,7 +26,7 @@ declare const UntagResourceCommand_base: {
26
26
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
27
27
  };
28
28
  /**
29
- * <p>Remove <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> that are attached to a resource.</p>
29
+ * <p>Removes the specified tags that are attached to a resource. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tags-remove.html">Removing tags from Amazon Personalize resources</a>.</p>
30
30
  * @example
31
31
  * Use a bare-bones client and the command you need to make an API call.
32
32
  * ```javascript
@@ -28,8 +28,19 @@ declare const UpdateCampaignCommand_base: {
28
28
  /**
29
29
  * <p>
30
30
  * Updates a campaign to deploy a retrained solution version with an existing campaign, change your campaign's <code>minProvisionedTPS</code>,
31
- * or modify your campaign's configuration, such as the exploration configuration.
32
- * </p>
31
+ * or modify your campaign's configuration. For example, you can set <code>enableMetadataWithRecommendations</code> to true for an existing campaign.</p>
32
+ * <p>
33
+ * To update a campaign to start automatically using the latest solution version, specify the following:</p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>For the <code>SolutionVersionArn</code> parameter, specify the Amazon Resource Name (ARN) of your solution in
37
+ * <code>SolutionArn/$LATEST</code> format. </p>
38
+ * </li>
39
+ * <li>
40
+ * <p> In the <code>campaignConfig</code>, set <code>syncWithLatestSolutionVersion</code> to <code>true</code>.
41
+ * </p>
42
+ * </li>
43
+ * </ul>
33
44
  * <p>To update a campaign, the campaign status must be ACTIVE or CREATE FAILED.
34
45
  * Check the campaign status using the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> operation.</p>
35
46
  * <note>
@@ -54,6 +65,7 @@ declare const UpdateCampaignCommand_base: {
54
65
  * "<keys>": "STRING_VALUE",
55
66
  * },
56
67
  * enableMetadataWithRecommendations: true || false,
68
+ * syncWithLatestSolutionVersion: true || false,
57
69
  * },
58
70
  * };
59
71
  * const command = new UpdateCampaignCommand(input);
@@ -243,7 +243,7 @@ export interface BatchInferenceJobOutput {
243
243
  }
244
244
  /**
245
245
  * <p>The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
246
- * For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">Tagging Amazon Personalize recources</a>.
246
+ * For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">Tagging Amazon Personalize resources</a>.
247
247
  * </p>
248
248
  * @public
249
249
  */
@@ -536,6 +536,18 @@ export interface CampaignConfig {
536
536
  * @public
537
537
  */
538
538
  enableMetadataWithRecommendations?: boolean;
539
+ /**
540
+ * <p>Whether the campaign automatically updates to use the latest solution version (trained model) of a solution. If you specify <code>True</code>,
541
+ * you must specify the ARN of your <i>solution</i> for the <code>SolutionVersionArn</code> parameter. It must be in <code>SolutionArn/$LATEST</code> format.
542
+ * The default is <code>False</code> and you must manually update the campaign to deploy the latest solution version.
543
+ * </p>
544
+ * <p>
545
+ * For more information about automatic campaign updates, see
546
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>.
547
+ * </p>
548
+ * @public
549
+ */
550
+ syncWithLatestSolutionVersion?: boolean;
539
551
  }
540
552
  /**
541
553
  * @public
@@ -547,7 +559,18 @@ export interface CreateCampaignRequest {
547
559
  */
548
560
  name: string | undefined;
549
561
  /**
550
- * <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
562
+ * <p>The Amazon Resource Name (ARN) of the trained model to deploy with the campaign. To specify the latest solution version of your solution,
563
+ * specify the ARN of your <i>solution</i> in <code>SolutionArn/$LATEST</code> format.
564
+ * You must use this format if you set <code>syncWithLatestSolutionVersion</code> to <code>True</code> in the
565
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html">CampaignConfig</a>.
566
+ * </p>
567
+ * <p>
568
+ * To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.
569
+ * </p>
570
+ * <p>
571
+ * For more information about automatic campaign updates, see
572
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>.
573
+ * </p>
551
574
  * @public
552
575
  */
553
576
  solutionVersionArn: string | undefined;
@@ -1026,7 +1049,8 @@ export interface CreateMetricAttributionResponse {
1026
1049
  export interface TrainingDataConfig {
1027
1050
  /**
1028
1051
  * <p>Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns.
1029
- * Exclude columns to control what data Amazon Personalize uses to generate recommendations.
1052
+ * Exclude columns to control what data Amazon Personalize uses to generate recommendations.</p>
1053
+ * <p>
1030
1054
  * For example, you might have a column that you want to use only to filter recommendations. You can
1031
1055
  * exclude this column from training and Amazon Personalize considers it only when filtering.
1032
1056
  * </p>
@@ -1165,6 +1189,21 @@ export interface AutoMLConfig {
1165
1189
  */
1166
1190
  recipeList?: string[];
1167
1191
  }
1192
+ /**
1193
+ * <p>The automatic training configuration to use when <code>performAutoTraining</code> is true.</p>
1194
+ * @public
1195
+ */
1196
+ export interface AutoTrainingConfig {
1197
+ /**
1198
+ * <p>Specifies how often to automatically train new solution versions. Specify a rate expression in rate(<i>value</i>
1199
+ * <i>unit</i>) format.
1200
+ * For value, specify a number between 1 and 30. For unit, specify <code>day</code> or <code>days</code>.
1201
+ * For example, to automatically create a new solution version every 5 days, specify <code>rate(5 days)</code>. The default is every 7 days.</p>
1202
+ * <p>For more information about auto training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.</p>
1203
+ * @public
1204
+ */
1205
+ schedulingExpression?: string;
1206
+ }
1168
1207
  /**
1169
1208
  * <p>Provides the name and range of a categorical hyperparameter.</p>
1170
1209
  * @public
@@ -1397,6 +1436,11 @@ export interface SolutionConfig {
1397
1436
  * @public
1398
1437
  */
1399
1438
  trainingDataConfig?: TrainingDataConfig;
1439
+ /**
1440
+ * <p>Specifies the automatic training configuration to use.</p>
1441
+ * @public
1442
+ */
1443
+ autoTrainingConfig?: AutoTrainingConfig;
1400
1444
  }
1401
1445
  /**
1402
1446
  * @public
@@ -1430,11 +1474,28 @@ export interface CreateSolutionRequest {
1430
1474
  * @public
1431
1475
  */
1432
1476
  performAutoML?: boolean;
1477
+ /**
1478
+ * <p>Whether the solution uses automatic training to create new solution versions (trained models). The default is
1479
+ * <code>True</code> and the solution automatically creates new solution versions every 7 days. You can change the training
1480
+ * frequency by specifying a <code>schedulingExpression</code> in the <code>AutoTrainingConfig</code> as part of solution
1481
+ * configuration. For more information about automatic training,
1482
+ * see <a href="https://docs.aws.amazon.com/personalize/latest/dg/solution-config-auto-training.html">Configuring automatic training</a>.</p>
1483
+ * <p>
1484
+ * Automatic solution version creation starts one hour after the solution is ACTIVE. If you manually create a solution version within
1485
+ * the hour, the solution skips the first automatic training.
1486
+ * </p>
1487
+ * <p>
1488
+ * After training starts, you can
1489
+ * get the solution version's Amazon Resource Name (ARN) with the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListSolutionVersions.html">ListSolutionVersions</a> API operation.
1490
+ * To get its status, use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a>.
1491
+ * </p>
1492
+ * @public
1493
+ */
1494
+ performAutoTraining?: boolean;
1433
1495
  /**
1434
1496
  * <p>The Amazon Resource Name (ARN) of the recipe to use for model training. This is required when
1435
1497
  * <code>performAutoML</code> is false. For information about different Amazon Personalize recipes and their ARNs,
1436
1498
  * see <a href="https://docs.aws.amazon.com/personalize/latest/dg/working-with-predefined-recipes.html">Choosing a recipe</a>.
1437
- *
1438
1499
  * </p>
1439
1500
  * @public
1440
1501
  */
@@ -1485,6 +1546,7 @@ export interface CreateSolutionResponse {
1485
1546
  * @enum
1486
1547
  */
1487
1548
  export declare const TrainingMode: {
1549
+ readonly AUTOTRAIN: "AUTOTRAIN";
1488
1550
  readonly FULL: "FULL";
1489
1551
  readonly UPDATE: "UPDATE";
1490
1552
  };
@@ -1953,7 +2015,7 @@ export interface Campaign {
1953
2015
  */
1954
2016
  campaignArn?: string;
1955
2017
  /**
1956
- * <p>The Amazon Resource Name (ARN) of a specific version of the solution.</p>
2018
+ * <p>The Amazon Resource Name (ARN) of the solution version the campaign uses.</p>
1957
2019
  * @public
1958
2020
  */
1959
2021
  solutionVersionArn?: string;
@@ -3060,6 +3122,18 @@ export interface AutoMLResult {
3060
3122
  */
3061
3123
  bestRecipeArn?: string;
3062
3124
  }
3125
+ /**
3126
+ * @public
3127
+ * @enum
3128
+ */
3129
+ export declare const TrainingType: {
3130
+ readonly AUTOMATIC: "AUTOMATIC";
3131
+ readonly MANUAL: "MANUAL";
3132
+ };
3133
+ /**
3134
+ * @public
3135
+ */
3136
+ export type TrainingType = (typeof TrainingType)[keyof typeof TrainingType];
3063
3137
  /**
3064
3138
  * <p>Provides a summary of the properties of a solution version. For a complete listing, call the
3065
3139
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a> API.</p>
@@ -3082,6 +3156,21 @@ export interface SolutionVersionSummary {
3082
3156
  * @public
3083
3157
  */
3084
3158
  status?: string;
3159
+ /**
3160
+ * <p>The scope of training to be performed when creating the solution version. A
3161
+ * <code>FULL</code> training considers all of the data in your dataset group.
3162
+ * An <code>UPDATE</code> processes only the data that
3163
+ * has changed since the latest training. Only solution versions created with the User-Personalization
3164
+ * recipe can use <code>UPDATE</code>.
3165
+ * </p>
3166
+ * @public
3167
+ */
3168
+ trainingMode?: TrainingMode;
3169
+ /**
3170
+ * <p>Whether the solution version was created automatically or manually.</p>
3171
+ * @public
3172
+ */
3173
+ trainingType?: TrainingType;
3085
3174
  /**
3086
3175
  * <p>The date and time (in Unix time) that this version of a solution was created.</p>
3087
3176
  * @public
@@ -3099,8 +3188,15 @@ export interface SolutionVersionSummary {
3099
3188
  failureReason?: string;
3100
3189
  }
3101
3190
  /**
3102
- * <p>An object that provides information about a solution. A solution is a trained model
3103
- * that can be deployed as a campaign.</p>
3191
+ * <important>
3192
+ * <p>After you create a solution, you can’t change its configuration. By default, all new solutions use automatic training. With automatic training, you incur training costs while
3193
+ * your solution is active. You can't stop automatic training for a solution. To avoid unnecessary costs, make sure to delete the solution when you are finished. For information about training
3194
+ * costs, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>.</p>
3195
+ * </important>
3196
+ * <p>An object that provides information about a solution. A solution includes the custom recipe, customized parameters, and
3197
+ * trained models (Solution Versions) that Amazon Personalize uses to generate recommendations. </p>
3198
+ * <p>After you create a solution, you can’t change its configuration. If you need to make changes, you can <a href="https://docs.aws.amazon.com/personalize/latest/dg/cloning-solution.html">clone the solution</a> with the Amazon Personalize console
3199
+ * or create a new one.</p>
3104
3200
  * @public
3105
3201
  */
3106
3202
  export interface Solution {
@@ -3132,6 +3228,13 @@ export interface Solution {
3132
3228
  * @public
3133
3229
  */
3134
3230
  performAutoML?: boolean;
3231
+ /**
3232
+ * <p>Specifies whether the solution automatically creates solution versions. The default is <code>True</code>
3233
+ * and the solution automatically creates new solution versions every 7 days.</p>
3234
+ * <p>For more information about auto training, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/customizing-solution-config.html">Creating and configuring a solution</a>.</p>
3235
+ * @public
3236
+ */
3237
+ performAutoTraining?: boolean;
3135
3238
  /**
3136
3239
  * <p>The ARN of the recipe used to create the solution. This is required when
3137
3240
  * <code>performAutoML</code> is false.</p>
@@ -3282,19 +3385,12 @@ export interface SolutionVersion {
3282
3385
  */
3283
3386
  trainingHours?: number;
3284
3387
  /**
3285
- * <p>The scope of training to be performed when creating the solution version. The
3286
- * <code>FULL</code> option trains the solution version based on the entirety of the input
3287
- * solution's training data, while the <code>UPDATE</code> option processes only the data that
3288
- * has changed in comparison to the input solution. Choose <code>UPDATE</code> when you want to
3289
- * incrementally update your solution version instead of creating an entirely new one.</p>
3290
- * <important>
3291
- * <p>The <code>UPDATE</code> option can only be used when you already have an active solution
3292
- * version created from the input solution using the <code>FULL</code> option and the input
3293
- * solution was trained with the
3294
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a>
3295
- * recipe or the
3296
- * <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html">HRNN-Coldstart</a> recipe.</p>
3297
- * </important>
3388
+ * <p>The scope of training to be performed when creating the solution version. A
3389
+ * <code>FULL</code> training considers all of the data in your dataset group.
3390
+ * An <code>UPDATE</code> processes only the data that
3391
+ * has changed since the latest training. Only solution versions created with the User-Personalization
3392
+ * recipe can use <code>UPDATE</code>.
3393
+ * </p>
3298
3394
  * @public
3299
3395
  */
3300
3396
  trainingMode?: TrainingMode;
@@ -3349,6 +3445,11 @@ export interface SolutionVersion {
3349
3445
  * @public
3350
3446
  */
3351
3447
  lastUpdatedDateTime?: Date;
3448
+ /**
3449
+ * <p>Whether the solution version was created automatically or manually.</p>
3450
+ * @public
3451
+ */
3452
+ trainingType?: TrainingType;
3352
3453
  }
3353
3454
  /**
3354
3455
  * @public
@@ -4664,7 +4765,7 @@ export interface ListSolutionVersionsResponse {
4664
4765
  */
4665
4766
  export interface ListTagsForResourceRequest {
4666
4767
  /**
4667
- * <p>The resource's Amazon Resource Name.</p>
4768
+ * <p>The resource's Amazon Resource Name (ARN).</p>
4668
4769
  * @public
4669
4770
  */
4670
4771
  resourceArn: string | undefined;
@@ -4739,7 +4840,7 @@ export interface TagResourceRequest {
4739
4840
  */
4740
4841
  resourceArn: string | undefined;
4741
4842
  /**
4742
- * <p>Tags to apply to the resource. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">Tagging Amazon Personalize recources</a>.</p>
4843
+ * <p>Tags to apply to the resource. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">Tagging Amazon Personalize resources</a>.</p>
4743
4844
  * @public
4744
4845
  */
4745
4846
  tags: Tag[] | undefined;
@@ -4771,7 +4872,7 @@ export interface UntagResourceRequest {
4771
4872
  */
4772
4873
  resourceArn: string | undefined;
4773
4874
  /**
4774
- * <p>Keys to remove from the resource's tags.</p>
4875
+ * <p>The keys of the tags to be removed.</p>
4775
4876
  * @public
4776
4877
  */
4777
4878
  tagKeys: string[] | undefined;
@@ -4791,7 +4892,18 @@ export interface UpdateCampaignRequest {
4791
4892
  */
4792
4893
  campaignArn: string | undefined;
4793
4894
  /**
4794
- * <p>The ARN of a new solution version to deploy.</p>
4895
+ * <p>The Amazon Resource Name (ARN) of a new model to deploy. To specify the latest solution version of your solution,
4896
+ * specify the ARN of your <i>solution</i> in <code>SolutionArn/$LATEST</code> format.
4897
+ * You must use this format if you set <code>syncWithLatestSolutionVersion</code> to <code>True</code> in the
4898
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CampaignConfig.html">CampaignConfig</a>.
4899
+ * </p>
4900
+ * <p>
4901
+ * To deploy a model that isn't the latest solution version of your solution, specify the ARN of the solution version.
4902
+ * </p>
4903
+ * <p>
4904
+ * For more information about automatic campaign updates, see
4905
+ * <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-automatic-latest-sv-update">Enabling automatic campaign updates</a>.
4906
+ * </p>
4795
4907
  * @public
4796
4908
  */
4797
4909
  solutionVersionArn?: string;
@@ -147,6 +147,7 @@ export interface CreateBatchSegmentJobResponse {
147
147
  export interface CampaignConfig {
148
148
  itemExplorationConfig?: Record<string, string>;
149
149
  enableMetadataWithRecommendations?: boolean;
150
+ syncWithLatestSolutionVersion?: boolean;
150
151
  }
151
152
  export interface CreateCampaignRequest {
152
153
  name: string | undefined;
@@ -291,6 +292,9 @@ export interface AutoMLConfig {
291
292
  metricName?: string;
292
293
  recipeList?: string[];
293
294
  }
295
+ export interface AutoTrainingConfig {
296
+ schedulingExpression?: string;
297
+ }
294
298
  export interface CategoricalHyperParameterRange {
295
299
  name?: string;
296
300
  values?: string[];
@@ -344,11 +348,13 @@ export interface SolutionConfig {
344
348
  autoMLConfig?: AutoMLConfig;
345
349
  optimizationObjective?: OptimizationObjective;
346
350
  trainingDataConfig?: TrainingDataConfig;
351
+ autoTrainingConfig?: AutoTrainingConfig;
347
352
  }
348
353
  export interface CreateSolutionRequest {
349
354
  name: string | undefined;
350
355
  performHPO?: boolean;
351
356
  performAutoML?: boolean;
357
+ performAutoTraining?: boolean;
352
358
  recipeArn?: string;
353
359
  datasetGroupArn: string | undefined;
354
360
  eventType?: string;
@@ -359,6 +365,7 @@ export interface CreateSolutionResponse {
359
365
  solutionArn?: string;
360
366
  }
361
367
  export declare const TrainingMode: {
368
+ readonly AUTOTRAIN: "AUTOTRAIN";
362
369
  readonly FULL: "FULL";
363
370
  readonly UPDATE: "UPDATE";
364
371
  };
@@ -679,9 +686,16 @@ export interface DescribeSolutionRequest {
679
686
  export interface AutoMLResult {
680
687
  bestRecipeArn?: string;
681
688
  }
689
+ export declare const TrainingType: {
690
+ readonly AUTOMATIC: "AUTOMATIC";
691
+ readonly MANUAL: "MANUAL";
692
+ };
693
+ export type TrainingType = (typeof TrainingType)[keyof typeof TrainingType];
682
694
  export interface SolutionVersionSummary {
683
695
  solutionVersionArn?: string;
684
696
  status?: string;
697
+ trainingMode?: TrainingMode;
698
+ trainingType?: TrainingType;
685
699
  creationDateTime?: Date;
686
700
  lastUpdatedDateTime?: Date;
687
701
  failureReason?: string;
@@ -691,6 +705,7 @@ export interface Solution {
691
705
  solutionArn?: string;
692
706
  performHPO?: boolean;
693
707
  performAutoML?: boolean;
708
+ performAutoTraining?: boolean;
694
709
  recipeArn?: string;
695
710
  datasetGroupArn?: string;
696
711
  eventType?: string;
@@ -727,6 +742,7 @@ export interface SolutionVersion {
727
742
  failureReason?: string;
728
743
  creationDateTime?: Date;
729
744
  lastUpdatedDateTime?: Date;
745
+ trainingType?: TrainingType;
730
746
  }
731
747
  export interface DescribeSolutionVersionResponse {
732
748
  solutionVersion?: SolutionVersion;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-personalize",
3
3
  "description": "AWS SDK for JavaScript Personalize Client for Node.js, Browser and React Native",
4
- "version": "3.554.0",
4
+ "version": "3.559.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-personalize",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.554.0",
24
- "@aws-sdk/core": "3.554.0",
25
- "@aws-sdk/credential-provider-node": "3.554.0",
23
+ "@aws-sdk/client-sts": "3.556.0",
24
+ "@aws-sdk/core": "3.556.0",
25
+ "@aws-sdk/credential-provider-node": "3.556.0",
26
26
  "@aws-sdk/middleware-host-header": "3.535.0",
27
27
  "@aws-sdk/middleware-logger": "3.535.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.535.0",