@aws-sdk/client-personalize 3.378.0 → 3.382.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.
@@ -6,10 +6,12 @@ import { PersonalizeServiceException as __BaseException } from "./PersonalizeSer
6
6
  */
7
7
  export interface AlgorithmImage {
8
8
  /**
9
+ * @public
9
10
  * <p>The name of the algorithm image.</p>
10
11
  */
11
12
  name?: string;
12
13
  /**
14
+ * @public
13
15
  * <p>The URI of the Docker container for the algorithm image.</p>
14
16
  */
15
17
  dockerURI: string | undefined;
@@ -22,14 +24,17 @@ export interface AlgorithmImage {
22
24
  */
23
25
  export interface DefaultCategoricalHyperParameterRange {
24
26
  /**
27
+ * @public
25
28
  * <p>The name of the hyperparameter.</p>
26
29
  */
27
30
  name?: string;
28
31
  /**
32
+ * @public
29
33
  * <p>A list of the categories for the hyperparameter.</p>
30
34
  */
31
35
  values?: string[];
32
36
  /**
37
+ * @public
33
38
  * <p>Whether the hyperparameter is tunable.</p>
34
39
  */
35
40
  isTunable?: boolean;
@@ -42,18 +47,22 @@ export interface DefaultCategoricalHyperParameterRange {
42
47
  */
43
48
  export interface DefaultContinuousHyperParameterRange {
44
49
  /**
50
+ * @public
45
51
  * <p>The name of the hyperparameter.</p>
46
52
  */
47
53
  name?: string;
48
54
  /**
55
+ * @public
49
56
  * <p>The minimum allowable value for the hyperparameter.</p>
50
57
  */
51
58
  minValue?: number;
52
59
  /**
60
+ * @public
53
61
  * <p>The maximum allowable value for the hyperparameter.</p>
54
62
  */
55
63
  maxValue?: number;
56
64
  /**
65
+ * @public
57
66
  * <p>Whether the hyperparameter is tunable.</p>
58
67
  */
59
68
  isTunable?: boolean;
@@ -66,18 +75,22 @@ export interface DefaultContinuousHyperParameterRange {
66
75
  */
67
76
  export interface DefaultIntegerHyperParameterRange {
68
77
  /**
78
+ * @public
69
79
  * <p>The name of the hyperparameter.</p>
70
80
  */
71
81
  name?: string;
72
82
  /**
83
+ * @public
73
84
  * <p>The minimum allowable value for the hyperparameter.</p>
74
85
  */
75
86
  minValue?: number;
76
87
  /**
88
+ * @public
77
89
  * <p>The maximum allowable value for the hyperparameter.</p>
78
90
  */
79
91
  maxValue?: number;
80
92
  /**
93
+ * @public
81
94
  * <p>Indicates whether the hyperparameter is tunable.</p>
82
95
  */
83
96
  isTunable?: boolean;
@@ -89,14 +102,17 @@ export interface DefaultIntegerHyperParameterRange {
89
102
  */
90
103
  export interface DefaultHyperParameterRanges {
91
104
  /**
105
+ * @public
92
106
  * <p>The integer-valued hyperparameters and their default ranges.</p>
93
107
  */
94
108
  integerHyperParameterRanges?: DefaultIntegerHyperParameterRange[];
95
109
  /**
110
+ * @public
96
111
  * <p>The continuous hyperparameters and their default ranges.</p>
97
112
  */
98
113
  continuousHyperParameterRanges?: DefaultContinuousHyperParameterRange[];
99
114
  /**
115
+ * @public
100
116
  * <p>The categorical hyperparameters and their default ranges.</p>
101
117
  */
102
118
  categoricalHyperParameterRanges?: DefaultCategoricalHyperParameterRange[];
@@ -107,44 +123,54 @@ export interface DefaultHyperParameterRanges {
107
123
  */
108
124
  export interface Algorithm {
109
125
  /**
126
+ * @public
110
127
  * <p>The name of the algorithm.</p>
111
128
  */
112
129
  name?: string;
113
130
  /**
131
+ * @public
114
132
  * <p>The Amazon Resource Name (ARN) of the algorithm.</p>
115
133
  */
116
134
  algorithmArn?: string;
117
135
  /**
136
+ * @public
118
137
  * <p>The URI of the Docker container for the algorithm image.</p>
119
138
  */
120
139
  algorithmImage?: AlgorithmImage;
121
140
  /**
141
+ * @public
122
142
  * <p>Specifies the default hyperparameters.</p>
123
143
  */
124
144
  defaultHyperParameters?: Record<string, string>;
125
145
  /**
146
+ * @public
126
147
  * <p>Specifies the default hyperparameters, their ranges, and whether they
127
148
  * are tunable. A tunable hyperparameter can
128
149
  * have its value determined during hyperparameter optimization (HPO).</p>
129
150
  */
130
151
  defaultHyperParameterRanges?: DefaultHyperParameterRanges;
131
152
  /**
153
+ * @public
132
154
  * <p>Specifies the default maximum number of training jobs and parallel training jobs.</p>
133
155
  */
134
156
  defaultResourceConfig?: Record<string, string>;
135
157
  /**
158
+ * @public
136
159
  * <p>The training input mode.</p>
137
160
  */
138
161
  trainingInputMode?: string;
139
162
  /**
163
+ * @public
140
164
  * <p>The Amazon Resource Name (ARN) of the role.</p>
141
165
  */
142
166
  roleArn?: string;
143
167
  /**
168
+ * @public
144
169
  * <p>The date and time (in Unix time) that the algorithm was created.</p>
145
170
  */
146
171
  creationDateTime?: Date;
147
172
  /**
173
+ * @public
148
174
  * <p>The date and time (in Unix time) that the algorithm was last updated.</p>
149
175
  */
150
176
  lastUpdatedDateTime?: Date;
@@ -155,6 +181,7 @@ export interface Algorithm {
155
181
  */
156
182
  export interface BatchInferenceJobConfig {
157
183
  /**
184
+ * @public
158
185
  * <p>A string to string map specifying the exploration configuration hyperparameters, including <code>explorationWeight</code> and
159
186
  * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
160
187
  * recommending items.
@@ -168,10 +195,12 @@ export interface BatchInferenceJobConfig {
168
195
  */
169
196
  export interface S3DataConfig {
170
197
  /**
198
+ * @public
171
199
  * <p>The file path of the Amazon S3 bucket.</p>
172
200
  */
173
201
  path: string | undefined;
174
202
  /**
203
+ * @public
175
204
  * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to
176
205
  * encrypt or decrypt the input and output files.</p>
177
206
  */
@@ -183,6 +212,7 @@ export interface S3DataConfig {
183
212
  */
184
213
  export interface BatchInferenceJobInput {
185
214
  /**
215
+ * @public
186
216
  * <p>The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the
187
217
  * same region as the API endpoint you are calling.</p>
188
218
  */
@@ -194,6 +224,7 @@ export interface BatchInferenceJobInput {
194
224
  */
195
225
  export interface BatchInferenceJobOutput {
196
226
  /**
227
+ * @public
197
228
  * <p>Information on the Amazon S3 bucket in which the batch inference job's output is stored.</p>
198
229
  */
199
230
  s3DataDestination: S3DataConfig | undefined;
@@ -206,10 +237,12 @@ export interface BatchInferenceJobOutput {
206
237
  */
207
238
  export interface Tag {
208
239
  /**
240
+ * @public
209
241
  * <p>One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.</p>
210
242
  */
211
243
  tagKey: string | undefined;
212
244
  /**
245
+ * @public
213
246
  * <p>The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).</p>
214
247
  */
215
248
  tagValue: string | undefined;
@@ -219,43 +252,52 @@ export interface Tag {
219
252
  */
220
253
  export interface CreateBatchInferenceJobRequest {
221
254
  /**
255
+ * @public
222
256
  * <p>The name of the batch inference job to create.</p>
223
257
  */
224
258
  jobName: string | undefined;
225
259
  /**
260
+ * @public
226
261
  * <p>The Amazon Resource Name (ARN) of the solution version that will be used to generate the
227
262
  * batch inference recommendations.</p>
228
263
  */
229
264
  solutionVersionArn: string | undefined;
230
265
  /**
266
+ * @public
231
267
  * <p>The ARN of the filter to apply to the batch inference job. For more information on using
232
268
  * filters, see
233
269
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p>
234
270
  */
235
271
  filterArn?: string;
236
272
  /**
273
+ * @public
237
274
  * <p>The number of recommendations to retrieve.</p>
238
275
  */
239
276
  numResults?: number;
240
277
  /**
278
+ * @public
241
279
  * <p>The Amazon S3 path that leads to the input file to base your recommendations on. The input
242
280
  * material must be in JSON format.</p>
243
281
  */
244
282
  jobInput: BatchInferenceJobInput | undefined;
245
283
  /**
284
+ * @public
246
285
  * <p>The path to the Amazon S3 bucket where the job's output will be stored.</p>
247
286
  */
248
287
  jobOutput: BatchInferenceJobOutput | undefined;
249
288
  /**
289
+ * @public
250
290
  * <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output
251
291
  * Amazon S3 buckets respectively.</p>
252
292
  */
253
293
  roleArn: string | undefined;
254
294
  /**
295
+ * @public
255
296
  * <p>The configuration details of a batch inference job.</p>
256
297
  */
257
298
  batchInferenceJobConfig?: BatchInferenceJobConfig;
258
299
  /**
300
+ * @public
259
301
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch inference job.</p>
260
302
  */
261
303
  tags?: Tag[];
@@ -265,6 +307,7 @@ export interface CreateBatchInferenceJobRequest {
265
307
  */
266
308
  export interface CreateBatchInferenceJobResponse {
267
309
  /**
310
+ * @public
268
311
  * <p>The ARN of the batch inference job.</p>
269
312
  */
270
313
  batchInferenceJobArn?: string;
@@ -347,6 +390,7 @@ export declare class TooManyTagsException extends __BaseException {
347
390
  */
348
391
  export interface BatchSegmentJobInput {
349
392
  /**
393
+ * @public
350
394
  * <p>The configuration details of an Amazon S3 input or output bucket.</p>
351
395
  */
352
396
  s3DataSource: S3DataConfig | undefined;
@@ -357,6 +401,7 @@ export interface BatchSegmentJobInput {
357
401
  */
358
402
  export interface BatchSegmentJobOutput {
359
403
  /**
404
+ * @public
360
405
  * <p>The configuration details of an Amazon S3 input or output bucket.</p>
361
406
  */
362
407
  s3DataDestination: S3DataConfig | undefined;
@@ -366,37 +411,45 @@ export interface BatchSegmentJobOutput {
366
411
  */
367
412
  export interface CreateBatchSegmentJobRequest {
368
413
  /**
414
+ * @public
369
415
  * <p>The name of the batch segment job to create.</p>
370
416
  */
371
417
  jobName: string | undefined;
372
418
  /**
419
+ * @public
373
420
  * <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate
374
421
  * batch segments.</p>
375
422
  */
376
423
  solutionVersionArn: string | undefined;
377
424
  /**
425
+ * @public
378
426
  * <p>The ARN of the filter to apply to the batch segment job. For more information on using
379
427
  * filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.</p>
380
428
  */
381
429
  filterArn?: string;
382
430
  /**
431
+ * @public
383
432
  * <p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>
384
433
  */
385
434
  numResults?: number;
386
435
  /**
436
+ * @public
387
437
  * <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
388
438
  */
389
439
  jobInput: BatchSegmentJobInput | undefined;
390
440
  /**
441
+ * @public
391
442
  * <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
392
443
  */
393
444
  jobOutput: BatchSegmentJobOutput | undefined;
394
445
  /**
446
+ * @public
395
447
  * <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output
396
448
  * Amazon S3 buckets respectively.</p>
397
449
  */
398
450
  roleArn: string | undefined;
399
451
  /**
452
+ * @public
400
453
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch segment job.</p>
401
454
  */
402
455
  tags?: Tag[];
@@ -406,6 +459,7 @@ export interface CreateBatchSegmentJobRequest {
406
459
  */
407
460
  export interface CreateBatchSegmentJobResponse {
408
461
  /**
462
+ * @public
409
463
  * <p>The ARN of the batch segment job.</p>
410
464
  */
411
465
  batchSegmentJobArn?: string;
@@ -416,6 +470,7 @@ export interface CreateBatchSegmentJobResponse {
416
470
  */
417
471
  export interface CampaignConfig {
418
472
  /**
473
+ * @public
419
474
  * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
420
475
  * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
421
476
  * recommending items. Provide <code>itemExplorationConfig</code> data only if your solution uses the
@@ -428,24 +483,29 @@ export interface CampaignConfig {
428
483
  */
429
484
  export interface CreateCampaignRequest {
430
485
  /**
486
+ * @public
431
487
  * <p>A name for the new campaign. The campaign name must be unique within your account.</p>
432
488
  */
433
489
  name: string | undefined;
434
490
  /**
491
+ * @public
435
492
  * <p>The Amazon Resource Name (ARN) of the solution version to deploy.</p>
436
493
  */
437
494
  solutionVersionArn: string | undefined;
438
495
  /**
496
+ * @public
439
497
  * <p>Specifies the requested minimum provisioned transactions (recommendations) per second that
440
498
  * Amazon Personalize will support. A high <code>minProvisionedTPS</code> will increase your bill. We recommend starting with 1 for <code>minProvisionedTPS</code> (the default). Track
441
499
  * your usage using Amazon CloudWatch metrics, and increase the <code>minProvisionedTPS</code> as necessary.</p>
442
500
  */
443
501
  minProvisionedTPS?: number;
444
502
  /**
503
+ * @public
445
504
  * <p>The configuration details of a campaign.</p>
446
505
  */
447
506
  campaignConfig?: CampaignConfig;
448
507
  /**
508
+ * @public
449
509
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the campaign.</p>
450
510
  */
451
511
  tags?: Tag[];
@@ -455,6 +515,7 @@ export interface CreateCampaignRequest {
455
515
  */
456
516
  export interface CreateCampaignResponse {
457
517
  /**
518
+ * @public
458
519
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
459
520
  */
460
521
  campaignArn?: string;
@@ -464,20 +525,24 @@ export interface CreateCampaignResponse {
464
525
  */
465
526
  export interface CreateDatasetRequest {
466
527
  /**
528
+ * @public
467
529
  * <p>The name for the dataset.</p>
468
530
  */
469
531
  name: string | undefined;
470
532
  /**
533
+ * @public
471
534
  * <p>The ARN of the schema to associate with the dataset. The schema
472
535
  * defines the dataset fields.</p>
473
536
  */
474
537
  schemaArn: string | undefined;
475
538
  /**
539
+ * @public
476
540
  * <p>The Amazon Resource Name (ARN) of the dataset group to add the dataset
477
541
  * to.</p>
478
542
  */
479
543
  datasetGroupArn: string | undefined;
480
544
  /**
545
+ * @public
481
546
  * <p>The type of dataset.</p>
482
547
  * <p>One of the following (case insensitive) values:</p>
483
548
  * <ul>
@@ -494,6 +559,7 @@ export interface CreateDatasetRequest {
494
559
  */
495
560
  datasetType: string | undefined;
496
561
  /**
562
+ * @public
497
563
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset.</p>
498
564
  */
499
565
  tags?: Tag[];
@@ -503,6 +569,7 @@ export interface CreateDatasetRequest {
503
569
  */
504
570
  export interface CreateDatasetResponse {
505
571
  /**
572
+ * @public
506
573
  * <p>The ARN of the dataset.</p>
507
574
  */
508
575
  datasetArn?: string;
@@ -526,6 +593,7 @@ export type IngestionMode = (typeof IngestionMode)[keyof typeof IngestionMode];
526
593
  */
527
594
  export interface DatasetExportJobOutput {
528
595
  /**
596
+ * @public
529
597
  * <p>The configuration details of an Amazon S3 input or output bucket.</p>
530
598
  */
531
599
  s3DataDestination: S3DataConfig | undefined;
@@ -535,15 +603,18 @@ export interface DatasetExportJobOutput {
535
603
  */
536
604
  export interface CreateDatasetExportJobRequest {
537
605
  /**
606
+ * @public
538
607
  * <p>The name for the dataset export job.</p>
539
608
  */
540
609
  jobName: string | undefined;
541
610
  /**
611
+ * @public
542
612
  * <p>The Amazon Resource Name (ARN) of the dataset that contains the data
543
613
  * to export.</p>
544
614
  */
545
615
  datasetArn: string | undefined;
546
616
  /**
617
+ * @public
547
618
  * <p>The data to export, based on how you imported the data. You can choose
548
619
  * to export only <code>BULK</code> data that you imported using a dataset
549
620
  * import job, only <code>PUT</code> data that you imported incrementally
@@ -553,15 +624,18 @@ export interface CreateDatasetExportJobRequest {
553
624
  */
554
625
  ingestionMode?: IngestionMode | string;
555
626
  /**
627
+ * @public
556
628
  * <p>The Amazon Resource Name (ARN) of the IAM service role that has
557
629
  * permissions to add data to your output Amazon S3 bucket.</p>
558
630
  */
559
631
  roleArn: string | undefined;
560
632
  /**
633
+ * @public
561
634
  * <p>The path to the Amazon S3 bucket where the job's output is stored.</p>
562
635
  */
563
636
  jobOutput: DatasetExportJobOutput | undefined;
564
637
  /**
638
+ * @public
565
639
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset export job.</p>
566
640
  */
567
641
  tags?: Tag[];
@@ -571,6 +645,7 @@ export interface CreateDatasetExportJobRequest {
571
645
  */
572
646
  export interface CreateDatasetExportJobResponse {
573
647
  /**
648
+ * @public
574
649
  * <p>The Amazon Resource Name (ARN) of the dataset export job.</p>
575
650
  */
576
651
  datasetExportJobArn?: string;
@@ -592,21 +667,25 @@ export type Domain = (typeof Domain)[keyof typeof Domain];
592
667
  */
593
668
  export interface CreateDatasetGroupRequest {
594
669
  /**
670
+ * @public
595
671
  * <p>The name for the new dataset group.</p>
596
672
  */
597
673
  name: string | undefined;
598
674
  /**
675
+ * @public
599
676
  * <p>The ARN of the Identity and Access Management (IAM) role that has permissions to access
600
677
  * the Key Management Service (KMS) key. Supplying an IAM role is only valid when also
601
678
  * specifying a KMS key.</p>
602
679
  */
603
680
  roleArn?: string;
604
681
  /**
682
+ * @public
605
683
  * <p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to
606
684
  * encrypt the datasets.</p>
607
685
  */
608
686
  kmsKeyArn?: string;
609
687
  /**
688
+ * @public
610
689
  * <p>The domain of the dataset group. Specify a domain to create a
611
690
  * Domain dataset group. The domain you specify determines the default
612
691
  * schemas for datasets and the use cases available for recommenders. If you
@@ -615,6 +694,7 @@ export interface CreateDatasetGroupRequest {
615
694
  */
616
695
  domain?: Domain | string;
617
696
  /**
697
+ * @public
618
698
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset group.</p>
619
699
  */
620
700
  tags?: Tag[];
@@ -624,10 +704,12 @@ export interface CreateDatasetGroupRequest {
624
704
  */
625
705
  export interface CreateDatasetGroupResponse {
626
706
  /**
707
+ * @public
627
708
  * <p>The Amazon Resource Name (ARN) of the new dataset group.</p>
628
709
  */
629
710
  datasetGroupArn?: string;
630
711
  /**
712
+ * @public
631
713
  * <p>The domain for the new Domain dataset group.</p>
632
714
  */
633
715
  domain?: Domain | string;
@@ -639,6 +721,7 @@ export interface CreateDatasetGroupResponse {
639
721
  */
640
722
  export interface DataSource {
641
723
  /**
724
+ * @public
642
725
  * <p>The path to the Amazon S3 bucket where the data that you want to upload to
643
726
  * your dataset is stored. For example: </p>
644
727
  * <p>
@@ -664,27 +747,33 @@ export type ImportMode = (typeof ImportMode)[keyof typeof ImportMode];
664
747
  */
665
748
  export interface CreateDatasetImportJobRequest {
666
749
  /**
750
+ * @public
667
751
  * <p>The name for the dataset import job.</p>
668
752
  */
669
753
  jobName: string | undefined;
670
754
  /**
755
+ * @public
671
756
  * <p>The ARN of the dataset that receives the imported data.</p>
672
757
  */
673
758
  datasetArn: string | undefined;
674
759
  /**
760
+ * @public
675
761
  * <p>The Amazon S3 bucket that contains the training data to import.</p>
676
762
  */
677
763
  dataSource: DataSource | undefined;
678
764
  /**
765
+ * @public
679
766
  * <p>The ARN of the IAM role that has permissions to read from the Amazon S3
680
767
  * data source.</p>
681
768
  */
682
769
  roleArn: string | undefined;
683
770
  /**
771
+ * @public
684
772
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the dataset import job.</p>
685
773
  */
686
774
  tags?: Tag[];
687
775
  /**
776
+ * @public
688
777
  * <p>Specify how to add the new records to an existing dataset. The default
689
778
  * import mode is <code>FULL</code>. If you haven't imported bulk records into the dataset previously, you
690
779
  * can only specify <code>FULL</code>.</p>
@@ -702,6 +791,7 @@ export interface CreateDatasetImportJobRequest {
702
791
  */
703
792
  importMode?: ImportMode | string;
704
793
  /**
794
+ * @public
705
795
  * <p>If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3</p>
706
796
  */
707
797
  publishAttributionMetricsToS3?: boolean;
@@ -711,6 +801,7 @@ export interface CreateDatasetImportJobRequest {
711
801
  */
712
802
  export interface CreateDatasetImportJobResponse {
713
803
  /**
804
+ * @public
714
805
  * <p>The ARN of the dataset import job.</p>
715
806
  */
716
807
  datasetImportJobArn?: string;
@@ -720,14 +811,17 @@ export interface CreateDatasetImportJobResponse {
720
811
  */
721
812
  export interface CreateEventTrackerRequest {
722
813
  /**
814
+ * @public
723
815
  * <p>The name for the event tracker.</p>
724
816
  */
725
817
  name: string | undefined;
726
818
  /**
819
+ * @public
727
820
  * <p>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</p>
728
821
  */
729
822
  datasetGroupArn: string | undefined;
730
823
  /**
824
+ * @public
731
825
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the event tracker.</p>
732
826
  */
733
827
  tags?: Tag[];
@@ -737,10 +831,12 @@ export interface CreateEventTrackerRequest {
737
831
  */
738
832
  export interface CreateEventTrackerResponse {
739
833
  /**
834
+ * @public
740
835
  * <p>The ARN of the event tracker.</p>
741
836
  */
742
837
  eventTrackerArn?: string;
743
838
  /**
839
+ * @public
744
840
  * <p>The ID of the event tracker. Include this ID in requests to the
745
841
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
746
842
  */
@@ -751,20 +847,24 @@ export interface CreateEventTrackerResponse {
751
847
  */
752
848
  export interface CreateFilterRequest {
753
849
  /**
850
+ * @public
754
851
  * <p>The name of the filter to create.</p>
755
852
  */
756
853
  name: string | undefined;
757
854
  /**
855
+ * @public
758
856
  * <p>The ARN of the dataset group that the filter will belong to.</p>
759
857
  */
760
858
  datasetGroupArn: string | undefined;
761
859
  /**
860
+ * @public
762
861
  * <p>The filter expression defines which items are included or excluded from recommendations. Filter expression must follow specific format rules.
763
862
  * For information about filter expression structure and syntax, see
764
863
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html">Filter expressions</a>.</p>
765
864
  */
766
865
  filterExpression: string | undefined;
767
866
  /**
867
+ * @public
768
868
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the filter.</p>
769
869
  */
770
870
  tags?: Tag[];
@@ -774,6 +874,7 @@ export interface CreateFilterRequest {
774
874
  */
775
875
  export interface CreateFilterResponse {
776
876
  /**
877
+ * @public
777
878
  * <p>The ARN of the new filter.</p>
778
879
  */
779
880
  filterArn?: string;
@@ -784,14 +885,17 @@ export interface CreateFilterResponse {
784
885
  */
785
886
  export interface MetricAttribute {
786
887
  /**
888
+ * @public
787
889
  * <p>The metric's event type.</p>
788
890
  */
789
891
  eventType: string | undefined;
790
892
  /**
893
+ * @public
791
894
  * <p>The metric's name. The name helps you identify the metric in Amazon CloudWatch or Amazon S3.</p>
792
895
  */
793
896
  metricName: string | undefined;
794
897
  /**
898
+ * @public
795
899
  * <p>The attribute's expression. Available functions are <code>SUM()</code> or <code>SAMPLECOUNT()</code>. For SUM() functions, provide the
796
900
  * dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).</p>
797
901
  */
@@ -803,10 +907,12 @@ export interface MetricAttribute {
803
907
  */
804
908
  export interface MetricAttributionOutput {
805
909
  /**
910
+ * @public
806
911
  * <p>The configuration details of an Amazon S3 input or output bucket.</p>
807
912
  */
808
913
  s3DataDestination?: S3DataConfig;
809
914
  /**
915
+ * @public
810
916
  * <p>The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket and add metrics to Amazon CloudWatch. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
811
917
  */
812
918
  roleArn: string | undefined;
@@ -816,20 +922,24 @@ export interface MetricAttributionOutput {
816
922
  */
817
923
  export interface CreateMetricAttributionRequest {
818
924
  /**
925
+ * @public
819
926
  * <p>A name for the metric attribution.</p>
820
927
  */
821
928
  name: string | undefined;
822
929
  /**
930
+ * @public
823
931
  * <p>The Amazon Resource Name (ARN) of the destination dataset group for the metric attribution.</p>
824
932
  */
825
933
  datasetGroupArn: string | undefined;
826
934
  /**
935
+ * @public
827
936
  * <p>A list of metric attributes for the metric attribution. Each metric attribute specifies an event type to track and a function.
828
937
  * Available functions are <code>SUM()</code> or <code>SAMPLECOUNT()</code>. For SUM() functions, provide the
829
938
  * dataset type (either Interactions or Items) and column to sum as a parameter. For example SUM(Items.PRICE).</p>
830
939
  */
831
940
  metrics: MetricAttribute[] | undefined;
832
941
  /**
942
+ * @public
833
943
  * <p>The output configuration details for the metric attribution.</p>
834
944
  */
835
945
  metricsOutputConfig: MetricAttributionOutput | undefined;
@@ -839,6 +949,7 @@ export interface CreateMetricAttributionRequest {
839
949
  */
840
950
  export interface CreateMetricAttributionResponse {
841
951
  /**
952
+ * @public
842
953
  * <p>The Amazon Resource Name (ARN) for the new metric attribution.</p>
843
954
  */
844
955
  metricAttributionArn?: string;
@@ -849,6 +960,7 @@ export interface CreateMetricAttributionResponse {
849
960
  */
850
961
  export interface TrainingDataConfig {
851
962
  /**
963
+ * @public
852
964
  * <p>Specifies the columns to exclude from training. Each key is a dataset type, and each value is a list of columns.
853
965
  * Exclude columns to control what data Amazon Personalize uses to generate recommendations.
854
966
  * For example, you might have a column that you want to use only to filter recommendations. You can
@@ -863,6 +975,7 @@ export interface TrainingDataConfig {
863
975
  */
864
976
  export interface RecommenderConfig {
865
977
  /**
978
+ * @public
866
979
  * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
867
980
  * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
868
981
  * recommending items. Provide <code>itemExplorationConfig</code> data only if your recommenders generate personalized recommendations for a user
@@ -870,6 +983,7 @@ export interface RecommenderConfig {
870
983
  */
871
984
  itemExplorationConfig?: Record<string, string>;
872
985
  /**
986
+ * @public
873
987
  * <p>Specifies the requested minimum provisioned recommendation requests per second that
874
988
  * Amazon Personalize will support. A high <code>minRecommendationRequestsPerSecond</code> will increase your bill. We recommend starting with 1 for <code>minRecommendationRequestsPerSecond</code> (the default). Track
875
989
  * your usage using Amazon CloudWatch metrics, and increase the <code>minRecommendationRequestsPerSecond</code>
@@ -877,6 +991,7 @@ export interface RecommenderConfig {
877
991
  */
878
992
  minRecommendationRequestsPerSecond?: number;
879
993
  /**
994
+ * @public
880
995
  * <p>
881
996
  * Specifies the training data configuration to use when creating a domain recommender.
882
997
  * </p>
@@ -888,24 +1003,29 @@ export interface RecommenderConfig {
888
1003
  */
889
1004
  export interface CreateRecommenderRequest {
890
1005
  /**
1006
+ * @public
891
1007
  * <p>The name of the recommender.</p>
892
1008
  */
893
1009
  name: string | undefined;
894
1010
  /**
1011
+ * @public
895
1012
  * <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
896
1013
  */
897
1014
  datasetGroupArn: string | undefined;
898
1015
  /**
1016
+ * @public
899
1017
  * <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group
900
1018
  * use case. Only Domain dataset group use cases can be used to create a recommender. For information about use cases see <a href="https://docs.aws.amazon.com/personalize/latest/dg/domain-use-cases.html">Choosing recommender use cases</a>.
901
1019
  * </p>
902
1020
  */
903
1021
  recipeArn: string | undefined;
904
1022
  /**
1023
+ * @public
905
1024
  * <p>The configuration details of the recommender.</p>
906
1025
  */
907
1026
  recommenderConfig?: RecommenderConfig;
908
1027
  /**
1028
+ * @public
909
1029
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the recommender.</p>
910
1030
  */
911
1031
  tags?: Tag[];
@@ -915,6 +1035,7 @@ export interface CreateRecommenderRequest {
915
1035
  */
916
1036
  export interface CreateRecommenderResponse {
917
1037
  /**
1038
+ * @public
918
1039
  * <p>The Amazon Resource Name (ARN) of the recommender.</p>
919
1040
  */
920
1041
  recommenderArn?: string;
@@ -924,14 +1045,17 @@ export interface CreateRecommenderResponse {
924
1045
  */
925
1046
  export interface CreateSchemaRequest {
926
1047
  /**
1048
+ * @public
927
1049
  * <p>The name for the schema.</p>
928
1050
  */
929
1051
  name: string | undefined;
930
1052
  /**
1053
+ * @public
931
1054
  * <p>A schema in Avro JSON format.</p>
932
1055
  */
933
1056
  schema: string | undefined;
934
1057
  /**
1058
+ * @public
935
1059
  * <p>The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify
936
1060
  * the domain you chose when you created the Domain dataset group.</p>
937
1061
  */
@@ -942,6 +1066,7 @@ export interface CreateSchemaRequest {
942
1066
  */
943
1067
  export interface CreateSchemaResponse {
944
1068
  /**
1069
+ * @public
945
1070
  * <p>The Amazon Resource Name (ARN) of the created schema.</p>
946
1071
  */
947
1072
  schemaArn?: string;
@@ -955,10 +1080,12 @@ export interface CreateSchemaResponse {
955
1080
  */
956
1081
  export interface AutoMLConfig {
957
1082
  /**
1083
+ * @public
958
1084
  * <p>The metric to optimize.</p>
959
1085
  */
960
1086
  metricName?: string;
961
1087
  /**
1088
+ * @public
962
1089
  * <p>The list of candidate recipes.</p>
963
1090
  */
964
1091
  recipeList?: string[];
@@ -969,10 +1096,12 @@ export interface AutoMLConfig {
969
1096
  */
970
1097
  export interface CategoricalHyperParameterRange {
971
1098
  /**
1099
+ * @public
972
1100
  * <p>The name of the hyperparameter.</p>
973
1101
  */
974
1102
  name?: string;
975
1103
  /**
1104
+ * @public
976
1105
  * <p>A list of the categories for the hyperparameter.</p>
977
1106
  */
978
1107
  values?: string[];
@@ -983,14 +1112,17 @@ export interface CategoricalHyperParameterRange {
983
1112
  */
984
1113
  export interface ContinuousHyperParameterRange {
985
1114
  /**
1115
+ * @public
986
1116
  * <p>The name of the hyperparameter.</p>
987
1117
  */
988
1118
  name?: string;
989
1119
  /**
1120
+ * @public
990
1121
  * <p>The minimum allowable value for the hyperparameter.</p>
991
1122
  */
992
1123
  minValue?: number;
993
1124
  /**
1125
+ * @public
994
1126
  * <p>The maximum allowable value for the hyperparameter.</p>
995
1127
  */
996
1128
  maxValue?: number;
@@ -1001,14 +1133,17 @@ export interface ContinuousHyperParameterRange {
1001
1133
  */
1002
1134
  export interface IntegerHyperParameterRange {
1003
1135
  /**
1136
+ * @public
1004
1137
  * <p>The name of the hyperparameter.</p>
1005
1138
  */
1006
1139
  name?: string;
1007
1140
  /**
1141
+ * @public
1008
1142
  * <p>The minimum allowable value for the hyperparameter.</p>
1009
1143
  */
1010
1144
  minValue?: number;
1011
1145
  /**
1146
+ * @public
1012
1147
  * <p>The maximum allowable value for the hyperparameter.</p>
1013
1148
  */
1014
1149
  maxValue?: number;
@@ -1020,14 +1155,17 @@ export interface IntegerHyperParameterRange {
1020
1155
  */
1021
1156
  export interface HyperParameterRanges {
1022
1157
  /**
1158
+ * @public
1023
1159
  * <p>The integer-valued hyperparameters and their ranges.</p>
1024
1160
  */
1025
1161
  integerHyperParameterRanges?: IntegerHyperParameterRange[];
1026
1162
  /**
1163
+ * @public
1027
1164
  * <p>The continuous hyperparameters and their ranges.</p>
1028
1165
  */
1029
1166
  continuousHyperParameterRanges?: ContinuousHyperParameterRange[];
1030
1167
  /**
1168
+ * @public
1031
1169
  * <p>The categorical hyperparameters and their ranges.</p>
1032
1170
  */
1033
1171
  categoricalHyperParameterRanges?: CategoricalHyperParameterRange[];
@@ -1042,14 +1180,17 @@ export interface HyperParameterRanges {
1042
1180
  */
1043
1181
  export interface HPOObjective {
1044
1182
  /**
1183
+ * @public
1045
1184
  * <p>The type of the metric. Valid values are <code>Maximize</code> and <code>Minimize</code>.</p>
1046
1185
  */
1047
1186
  type?: string;
1048
1187
  /**
1188
+ * @public
1049
1189
  * <p>The name of the metric.</p>
1050
1190
  */
1051
1191
  metricName?: string;
1052
1192
  /**
1193
+ * @public
1053
1194
  * <p>A regular expression for finding the metric in the training job logs.</p>
1054
1195
  */
1055
1196
  metricRegex?: string;
@@ -1060,6 +1201,7 @@ export interface HPOObjective {
1060
1201
  */
1061
1202
  export interface HPOResourceConfig {
1062
1203
  /**
1204
+ * @public
1063
1205
  * <p>The maximum number of training
1064
1206
  * jobs when you create a
1065
1207
  * solution
@@ -1069,6 +1211,7 @@ export interface HPOResourceConfig {
1069
1211
  */
1070
1212
  maxNumberOfTrainingJobs?: string;
1071
1213
  /**
1214
+ * @public
1072
1215
  * <p>The maximum number of parallel training
1073
1216
  * jobs when you create a
1074
1217
  * solution
@@ -1084,6 +1227,7 @@ export interface HPOResourceConfig {
1084
1227
  */
1085
1228
  export interface HPOConfig {
1086
1229
  /**
1230
+ * @public
1087
1231
  * <p>The metric to optimize during HPO.</p>
1088
1232
  * <note>
1089
1233
  * <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code>
@@ -1092,10 +1236,12 @@ export interface HPOConfig {
1092
1236
  */
1093
1237
  hpoObjective?: HPOObjective;
1094
1238
  /**
1239
+ * @public
1095
1240
  * <p>Describes the resource configuration for HPO.</p>
1096
1241
  */
1097
1242
  hpoResourceConfig?: HPOResourceConfig;
1098
1243
  /**
1244
+ * @public
1099
1245
  * <p>The hyperparameters and their allowable ranges.</p>
1100
1246
  */
1101
1247
  algorithmHyperParameterRanges?: HyperParameterRanges;
@@ -1121,10 +1267,12 @@ export type ObjectiveSensitivity = (typeof ObjectiveSensitivity)[keyof typeof Ob
1121
1267
  */
1122
1268
  export interface OptimizationObjective {
1123
1269
  /**
1270
+ * @public
1124
1271
  * <p>The numerical metadata column in an Items dataset related to the optimization objective. For example, VIDEO_LENGTH (to maximize streaming minutes), or PRICE (to maximize revenue).</p>
1125
1272
  */
1126
1273
  itemAttribute?: string;
1127
1274
  /**
1275
+ * @public
1128
1276
  * <p>Specifies how Amazon Personalize balances the importance of your optimization objective versus relevance.</p>
1129
1277
  */
1130
1278
  objectiveSensitivity?: ObjectiveSensitivity | string;
@@ -1135,33 +1283,40 @@ export interface OptimizationObjective {
1135
1283
  */
1136
1284
  export interface SolutionConfig {
1137
1285
  /**
1286
+ * @public
1138
1287
  * <p>Only events with a value greater than or equal to this threshold are
1139
1288
  * used for training a model.</p>
1140
1289
  */
1141
1290
  eventValueThreshold?: string;
1142
1291
  /**
1292
+ * @public
1143
1293
  * <p>Describes the properties for hyperparameter optimization (HPO).</p>
1144
1294
  */
1145
1295
  hpoConfig?: HPOConfig;
1146
1296
  /**
1297
+ * @public
1147
1298
  * <p>Lists the hyperparameter names and ranges.</p>
1148
1299
  */
1149
1300
  algorithmHyperParameters?: Record<string, string>;
1150
1301
  /**
1302
+ * @public
1151
1303
  * <p>Lists the feature transformation parameters.</p>
1152
1304
  */
1153
1305
  featureTransformationParameters?: Record<string, string>;
1154
1306
  /**
1307
+ * @public
1155
1308
  * <p>The <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_AutoMLConfig.html">AutoMLConfig</a> object containing a list of recipes to search
1156
1309
  * when AutoML is performed.</p>
1157
1310
  */
1158
1311
  autoMLConfig?: AutoMLConfig;
1159
1312
  /**
1313
+ * @public
1160
1314
  * <p>Describes the additional objective for the solution, such as maximizing streaming
1161
1315
  * minutes or increasing revenue. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/optimizing-solution-for-objective.html">Optimizing a solution</a>.</p>
1162
1316
  */
1163
1317
  optimizationObjective?: OptimizationObjective;
1164
1318
  /**
1319
+ * @public
1165
1320
  * <p>
1166
1321
  * Specifies the training data configuration to use when creating a custom solution version (trained model).
1167
1322
  * </p>
@@ -1173,10 +1328,12 @@ export interface SolutionConfig {
1173
1328
  */
1174
1329
  export interface CreateSolutionRequest {
1175
1330
  /**
1331
+ * @public
1176
1332
  * <p>The name for the solution.</p>
1177
1333
  */
1178
1334
  name: string | undefined;
1179
1335
  /**
1336
+ * @public
1180
1337
  * <p>Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe.
1181
1338
  * The default is <code>false</code>.</p>
1182
1339
  * <p>When performing AutoML, this parameter is always <code>true</code> and you
@@ -1184,6 +1341,7 @@ export interface CreateSolutionRequest {
1184
1341
  */
1185
1342
  performHPO?: boolean;
1186
1343
  /**
1344
+ * @public
1187
1345
  * <important>
1188
1346
  * <p>We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize
1189
1347
  * recipes. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html">Determining your use case.</a>
@@ -1199,15 +1357,18 @@ export interface CreateSolutionRequest {
1199
1357
  */
1200
1358
  performAutoML?: boolean;
1201
1359
  /**
1360
+ * @public
1202
1361
  * <p>The ARN of the recipe to use for model training. This is required when
1203
1362
  * <code>performAutoML</code> is false.</p>
1204
1363
  */
1205
1364
  recipeArn?: string;
1206
1365
  /**
1366
+ * @public
1207
1367
  * <p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>
1208
1368
  */
1209
1369
  datasetGroupArn: string | undefined;
1210
1370
  /**
1371
+ * @public
1211
1372
  * <p>When your have multiple event types (using an <code>EVENT_TYPE</code> schema field),
1212
1373
  * this parameter specifies which event type (for example, 'click' or 'like') is used for
1213
1374
  * training the model.</p>
@@ -1216,6 +1377,7 @@ export interface CreateSolutionRequest {
1216
1377
  */
1217
1378
  eventType?: string;
1218
1379
  /**
1380
+ * @public
1219
1381
  * <p>The configuration to use with the solution. When <code>performAutoML</code> is set to
1220
1382
  * true, Amazon Personalize only evaluates the <code>autoMLConfig</code> section
1221
1383
  * of the solution configuration.</p>
@@ -1226,6 +1388,7 @@ export interface CreateSolutionRequest {
1226
1388
  */
1227
1389
  solutionConfig?: SolutionConfig;
1228
1390
  /**
1391
+ * @public
1229
1392
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the solution.</p>
1230
1393
  */
1231
1394
  tags?: Tag[];
@@ -1235,6 +1398,7 @@ export interface CreateSolutionRequest {
1235
1398
  */
1236
1399
  export interface CreateSolutionResponse {
1237
1400
  /**
1401
+ * @public
1238
1402
  * <p>The ARN of the solution.</p>
1239
1403
  */
1240
1404
  solutionArn?: string;
@@ -1256,15 +1420,18 @@ export type TrainingMode = (typeof TrainingMode)[keyof typeof TrainingMode];
1256
1420
  */
1257
1421
  export interface CreateSolutionVersionRequest {
1258
1422
  /**
1423
+ * @public
1259
1424
  * <p>The name of the solution version.</p>
1260
1425
  */
1261
1426
  name?: string;
1262
1427
  /**
1428
+ * @public
1263
1429
  * <p>The Amazon Resource Name (ARN) of the solution containing the training configuration
1264
1430
  * information.</p>
1265
1431
  */
1266
1432
  solutionArn: string | undefined;
1267
1433
  /**
1434
+ * @public
1268
1435
  * <p>The scope of training to be performed when creating the solution version. The
1269
1436
  * <code>FULL</code> option trains the solution version based on the entirety of the input
1270
1437
  * solution's training data, while the <code>UPDATE</code> option processes only the data that
@@ -1281,6 +1448,7 @@ export interface CreateSolutionVersionRequest {
1281
1448
  */
1282
1449
  trainingMode?: TrainingMode | string;
1283
1450
  /**
1451
+ * @public
1284
1452
  * <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the solution version.</p>
1285
1453
  */
1286
1454
  tags?: Tag[];
@@ -1290,6 +1458,7 @@ export interface CreateSolutionVersionRequest {
1290
1458
  */
1291
1459
  export interface CreateSolutionVersionResponse {
1292
1460
  /**
1461
+ * @public
1293
1462
  * <p>The ARN of the new solution version.</p>
1294
1463
  */
1295
1464
  solutionVersionArn?: string;
@@ -1299,6 +1468,7 @@ export interface CreateSolutionVersionResponse {
1299
1468
  */
1300
1469
  export interface DeleteCampaignRequest {
1301
1470
  /**
1471
+ * @public
1302
1472
  * <p>The Amazon Resource Name (ARN) of the campaign to delete.</p>
1303
1473
  */
1304
1474
  campaignArn: string | undefined;
@@ -1308,6 +1478,7 @@ export interface DeleteCampaignRequest {
1308
1478
  */
1309
1479
  export interface DeleteDatasetRequest {
1310
1480
  /**
1481
+ * @public
1311
1482
  * <p>The Amazon Resource Name (ARN) of the dataset to delete.</p>
1312
1483
  */
1313
1484
  datasetArn: string | undefined;
@@ -1317,6 +1488,7 @@ export interface DeleteDatasetRequest {
1317
1488
  */
1318
1489
  export interface DeleteDatasetGroupRequest {
1319
1490
  /**
1491
+ * @public
1320
1492
  * <p>The ARN of the dataset group to delete.</p>
1321
1493
  */
1322
1494
  datasetGroupArn: string | undefined;
@@ -1326,6 +1498,7 @@ export interface DeleteDatasetGroupRequest {
1326
1498
  */
1327
1499
  export interface DeleteEventTrackerRequest {
1328
1500
  /**
1501
+ * @public
1329
1502
  * <p>The Amazon Resource Name (ARN) of the event tracker to delete.</p>
1330
1503
  */
1331
1504
  eventTrackerArn: string | undefined;
@@ -1335,6 +1508,7 @@ export interface DeleteEventTrackerRequest {
1335
1508
  */
1336
1509
  export interface DeleteFilterRequest {
1337
1510
  /**
1511
+ * @public
1338
1512
  * <p>The ARN of the filter to delete.</p>
1339
1513
  */
1340
1514
  filterArn: string | undefined;
@@ -1344,6 +1518,7 @@ export interface DeleteFilterRequest {
1344
1518
  */
1345
1519
  export interface DeleteMetricAttributionRequest {
1346
1520
  /**
1521
+ * @public
1347
1522
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
1348
1523
  */
1349
1524
  metricAttributionArn: string | undefined;
@@ -1353,6 +1528,7 @@ export interface DeleteMetricAttributionRequest {
1353
1528
  */
1354
1529
  export interface DeleteRecommenderRequest {
1355
1530
  /**
1531
+ * @public
1356
1532
  * <p>The Amazon Resource Name (ARN) of the recommender to delete.</p>
1357
1533
  */
1358
1534
  recommenderArn: string | undefined;
@@ -1362,6 +1538,7 @@ export interface DeleteRecommenderRequest {
1362
1538
  */
1363
1539
  export interface DeleteSchemaRequest {
1364
1540
  /**
1541
+ * @public
1365
1542
  * <p>The Amazon Resource Name (ARN) of the schema to delete.</p>
1366
1543
  */
1367
1544
  schemaArn: string | undefined;
@@ -1371,6 +1548,7 @@ export interface DeleteSchemaRequest {
1371
1548
  */
1372
1549
  export interface DeleteSolutionRequest {
1373
1550
  /**
1551
+ * @public
1374
1552
  * <p>The ARN of the solution to delete.</p>
1375
1553
  */
1376
1554
  solutionArn: string | undefined;
@@ -1380,6 +1558,7 @@ export interface DeleteSolutionRequest {
1380
1558
  */
1381
1559
  export interface DescribeAlgorithmRequest {
1382
1560
  /**
1561
+ * @public
1383
1562
  * <p>The Amazon Resource Name (ARN) of the algorithm to describe.</p>
1384
1563
  */
1385
1564
  algorithmArn: string | undefined;
@@ -1389,6 +1568,7 @@ export interface DescribeAlgorithmRequest {
1389
1568
  */
1390
1569
  export interface DescribeAlgorithmResponse {
1391
1570
  /**
1571
+ * @public
1392
1572
  * <p>A listing of the properties of the algorithm.</p>
1393
1573
  */
1394
1574
  algorithm?: Algorithm;
@@ -1398,6 +1578,7 @@ export interface DescribeAlgorithmResponse {
1398
1578
  */
1399
1579
  export interface DescribeBatchInferenceJobRequest {
1400
1580
  /**
1581
+ * @public
1401
1582
  * <p>The ARN of the batch inference job to describe.</p>
1402
1583
  */
1403
1584
  batchInferenceJobArn: string | undefined;
@@ -1408,49 +1589,60 @@ export interface DescribeBatchInferenceJobRequest {
1408
1589
  */
1409
1590
  export interface BatchInferenceJob {
1410
1591
  /**
1592
+ * @public
1411
1593
  * <p>The name of the batch inference job.</p>
1412
1594
  */
1413
1595
  jobName?: string;
1414
1596
  /**
1597
+ * @public
1415
1598
  * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
1416
1599
  */
1417
1600
  batchInferenceJobArn?: string;
1418
1601
  /**
1602
+ * @public
1419
1603
  * <p>The ARN of the filter used on the batch inference job.</p>
1420
1604
  */
1421
1605
  filterArn?: string;
1422
1606
  /**
1607
+ * @public
1423
1608
  * <p>If the batch inference job failed, the reason for the failure.</p>
1424
1609
  */
1425
1610
  failureReason?: string;
1426
1611
  /**
1612
+ * @public
1427
1613
  * <p>The Amazon Resource Name (ARN) of the solution version from which the batch inference job
1428
1614
  * was created.</p>
1429
1615
  */
1430
1616
  solutionVersionArn?: string;
1431
1617
  /**
1618
+ * @public
1432
1619
  * <p>The number of recommendations generated by the batch inference job. This number includes
1433
1620
  * the error messages generated for failed input records.</p>
1434
1621
  */
1435
1622
  numResults?: number;
1436
1623
  /**
1624
+ * @public
1437
1625
  * <p>The Amazon S3 path that leads to the input data used to generate the batch inference
1438
1626
  * job.</p>
1439
1627
  */
1440
1628
  jobInput?: BatchInferenceJobInput;
1441
1629
  /**
1630
+ * @public
1442
1631
  * <p>The Amazon S3 bucket that contains the output data generated by the batch inference job.</p>
1443
1632
  */
1444
1633
  jobOutput?: BatchInferenceJobOutput;
1445
1634
  /**
1635
+ * @public
1446
1636
  * <p>A string to string map of the configuration details of a batch inference job.</p>
1447
1637
  */
1448
1638
  batchInferenceJobConfig?: BatchInferenceJobConfig;
1449
1639
  /**
1640
+ * @public
1450
1641
  * <p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.</p>
1451
1642
  */
1452
1643
  roleArn?: string;
1453
1644
  /**
1645
+ * @public
1454
1646
  * <p>The status of the batch inference job. The status is one of the following values:</p>
1455
1647
  * <ul>
1456
1648
  * <li>
@@ -1469,10 +1661,12 @@ export interface BatchInferenceJob {
1469
1661
  */
1470
1662
  status?: string;
1471
1663
  /**
1664
+ * @public
1472
1665
  * <p>The time at which the batch inference job was created.</p>
1473
1666
  */
1474
1667
  creationDateTime?: Date;
1475
1668
  /**
1669
+ * @public
1476
1670
  * <p>The time at which the batch inference job was last updated.</p>
1477
1671
  */
1478
1672
  lastUpdatedDateTime?: Date;
@@ -1482,6 +1676,7 @@ export interface BatchInferenceJob {
1482
1676
  */
1483
1677
  export interface DescribeBatchInferenceJobResponse {
1484
1678
  /**
1679
+ * @public
1485
1680
  * <p>Information on the specified batch inference job.</p>
1486
1681
  */
1487
1682
  batchInferenceJob?: BatchInferenceJob;
@@ -1491,6 +1686,7 @@ export interface DescribeBatchInferenceJobResponse {
1491
1686
  */
1492
1687
  export interface DescribeBatchSegmentJobRequest {
1493
1688
  /**
1689
+ * @public
1494
1690
  * <p>The ARN of the batch segment job to describe.</p>
1495
1691
  */
1496
1692
  batchSegmentJobArn: string | undefined;
@@ -1501,42 +1697,52 @@ export interface DescribeBatchSegmentJobRequest {
1501
1697
  */
1502
1698
  export interface BatchSegmentJob {
1503
1699
  /**
1700
+ * @public
1504
1701
  * <p>The name of the batch segment job.</p>
1505
1702
  */
1506
1703
  jobName?: string;
1507
1704
  /**
1705
+ * @public
1508
1706
  * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
1509
1707
  */
1510
1708
  batchSegmentJobArn?: string;
1511
1709
  /**
1710
+ * @public
1512
1711
  * <p>The ARN of the filter used on the batch segment job.</p>
1513
1712
  */
1514
1713
  filterArn?: string;
1515
1714
  /**
1715
+ * @public
1516
1716
  * <p>If the batch segment job failed, the reason for the failure.</p>
1517
1717
  */
1518
1718
  failureReason?: string;
1519
1719
  /**
1720
+ * @public
1520
1721
  * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
1521
1722
  */
1522
1723
  solutionVersionArn?: string;
1523
1724
  /**
1725
+ * @public
1524
1726
  * <p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>
1525
1727
  */
1526
1728
  numResults?: number;
1527
1729
  /**
1730
+ * @public
1528
1731
  * <p>The Amazon S3 path that leads to the input data used to generate the batch segment job.</p>
1529
1732
  */
1530
1733
  jobInput?: BatchSegmentJobInput;
1531
1734
  /**
1735
+ * @public
1532
1736
  * <p>The Amazon S3 bucket that contains the output data generated by the batch segment job.</p>
1533
1737
  */
1534
1738
  jobOutput?: BatchSegmentJobOutput;
1535
1739
  /**
1740
+ * @public
1536
1741
  * <p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.</p>
1537
1742
  */
1538
1743
  roleArn?: string;
1539
1744
  /**
1745
+ * @public
1540
1746
  * <p>The status of the batch segment job. The status is one of the following values:</p>
1541
1747
  * <ul>
1542
1748
  * <li>
@@ -1555,10 +1761,12 @@ export interface BatchSegmentJob {
1555
1761
  */
1556
1762
  status?: string;
1557
1763
  /**
1764
+ * @public
1558
1765
  * <p>The time at which the batch segment job was created.</p>
1559
1766
  */
1560
1767
  creationDateTime?: Date;
1561
1768
  /**
1769
+ * @public
1562
1770
  * <p>The time at which the batch segment job last updated.</p>
1563
1771
  */
1564
1772
  lastUpdatedDateTime?: Date;
@@ -1568,6 +1776,7 @@ export interface BatchSegmentJob {
1568
1776
  */
1569
1777
  export interface DescribeBatchSegmentJobResponse {
1570
1778
  /**
1779
+ * @public
1571
1780
  * <p>Information on the specified batch segment job.</p>
1572
1781
  */
1573
1782
  batchSegmentJob?: BatchSegmentJob;
@@ -1577,6 +1786,7 @@ export interface DescribeBatchSegmentJobResponse {
1577
1786
  */
1578
1787
  export interface DescribeCampaignRequest {
1579
1788
  /**
1789
+ * @public
1580
1790
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
1581
1791
  */
1582
1792
  campaignArn: string | undefined;
@@ -1588,19 +1798,23 @@ export interface DescribeCampaignRequest {
1588
1798
  */
1589
1799
  export interface CampaignUpdateSummary {
1590
1800
  /**
1801
+ * @public
1591
1802
  * <p>The Amazon Resource Name (ARN) of the deployed solution version.</p>
1592
1803
  */
1593
1804
  solutionVersionArn?: string;
1594
1805
  /**
1806
+ * @public
1595
1807
  * <p>Specifies the requested minimum provisioned transactions (recommendations) per second that
1596
1808
  * Amazon Personalize will support.</p>
1597
1809
  */
1598
1810
  minProvisionedTPS?: number;
1599
1811
  /**
1812
+ * @public
1600
1813
  * <p>The configuration details of a campaign.</p>
1601
1814
  */
1602
1815
  campaignConfig?: CampaignConfig;
1603
1816
  /**
1817
+ * @public
1604
1818
  * <p>The status of the campaign update.</p>
1605
1819
  * <p>A campaign update can be in one of the following states:</p>
1606
1820
  * <ul>
@@ -1614,14 +1828,17 @@ export interface CampaignUpdateSummary {
1614
1828
  */
1615
1829
  status?: string;
1616
1830
  /**
1831
+ * @public
1617
1832
  * <p>If a campaign update fails, the reason behind the failure.</p>
1618
1833
  */
1619
1834
  failureReason?: string;
1620
1835
  /**
1836
+ * @public
1621
1837
  * <p>The date and time (in Unix time) that the campaign update was created.</p>
1622
1838
  */
1623
1839
  creationDateTime?: Date;
1624
1840
  /**
1841
+ * @public
1625
1842
  * <p>The date and time (in Unix time) that the campaign update was last updated.</p>
1626
1843
  */
1627
1844
  lastUpdatedDateTime?: Date;
@@ -1633,28 +1850,34 @@ export interface CampaignUpdateSummary {
1633
1850
  */
1634
1851
  export interface Campaign {
1635
1852
  /**
1853
+ * @public
1636
1854
  * <p>The name of the campaign.</p>
1637
1855
  */
1638
1856
  name?: string;
1639
1857
  /**
1858
+ * @public
1640
1859
  * <p>The Amazon Resource Name (ARN) of the campaign. </p>
1641
1860
  */
1642
1861
  campaignArn?: string;
1643
1862
  /**
1863
+ * @public
1644
1864
  * <p>The Amazon Resource Name (ARN) of a specific version of the solution.</p>
1645
1865
  */
1646
1866
  solutionVersionArn?: string;
1647
1867
  /**
1868
+ * @public
1648
1869
  * <p>Specifies the requested minimum provisioned transactions (recommendations) per second. A high <code>minProvisionedTPS</code> will increase your bill. We recommend starting with 1 for <code>minProvisionedTPS</code> (the default). Track
1649
1870
  * your usage using Amazon CloudWatch metrics, and increase the <code>minProvisionedTPS</code>
1650
1871
  * as necessary.</p>
1651
1872
  */
1652
1873
  minProvisionedTPS?: number;
1653
1874
  /**
1875
+ * @public
1654
1876
  * <p>The configuration details of a campaign.</p>
1655
1877
  */
1656
1878
  campaignConfig?: CampaignConfig;
1657
1879
  /**
1880
+ * @public
1658
1881
  * <p>The status of the campaign.</p>
1659
1882
  * <p>A campaign can be in one of the following states:</p>
1660
1883
  * <ul>
@@ -1668,18 +1891,22 @@ export interface Campaign {
1668
1891
  */
1669
1892
  status?: string;
1670
1893
  /**
1894
+ * @public
1671
1895
  * <p>If a campaign fails, the reason behind the failure.</p>
1672
1896
  */
1673
1897
  failureReason?: string;
1674
1898
  /**
1899
+ * @public
1675
1900
  * <p>The date and time (in Unix format) that the campaign was created.</p>
1676
1901
  */
1677
1902
  creationDateTime?: Date;
1678
1903
  /**
1904
+ * @public
1679
1905
  * <p>The date and time (in Unix format) that the campaign was last updated.</p>
1680
1906
  */
1681
1907
  lastUpdatedDateTime?: Date;
1682
1908
  /**
1909
+ * @public
1683
1910
  * <p>Provides a summary of the properties of a campaign update. For a complete listing, call the
1684
1911
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> API.</p>
1685
1912
  */
@@ -1690,6 +1917,7 @@ export interface Campaign {
1690
1917
  */
1691
1918
  export interface DescribeCampaignResponse {
1692
1919
  /**
1920
+ * @public
1693
1921
  * <p>The properties of the campaign.</p>
1694
1922
  */
1695
1923
  campaign?: Campaign;
@@ -1699,6 +1927,7 @@ export interface DescribeCampaignResponse {
1699
1927
  */
1700
1928
  export interface DescribeDatasetRequest {
1701
1929
  /**
1930
+ * @public
1702
1931
  * <p>The Amazon Resource Name (ARN) of the dataset to describe.</p>
1703
1932
  */
1704
1933
  datasetArn: string | undefined;
@@ -1709,22 +1938,27 @@ export interface DescribeDatasetRequest {
1709
1938
  */
1710
1939
  export interface DatasetUpdateSummary {
1711
1940
  /**
1941
+ * @public
1712
1942
  * <p>The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.</p>
1713
1943
  */
1714
1944
  schemaArn?: string;
1715
1945
  /**
1946
+ * @public
1716
1947
  * <p>The status of the dataset update. </p>
1717
1948
  */
1718
1949
  status?: string;
1719
1950
  /**
1951
+ * @public
1720
1952
  * <p>If updating a dataset fails, provides the reason why.</p>
1721
1953
  */
1722
1954
  failureReason?: string;
1723
1955
  /**
1956
+ * @public
1724
1957
  * <p>The creation date and time (in Unix time) of the dataset update.</p>
1725
1958
  */
1726
1959
  creationDateTime?: Date;
1727
1960
  /**
1961
+ * @public
1728
1962
  * <p>The last update date and time (in Unix time) of the dataset.</p>
1729
1963
  */
1730
1964
  lastUpdatedDateTime?: Date;
@@ -1735,19 +1969,23 @@ export interface DatasetUpdateSummary {
1735
1969
  */
1736
1970
  export interface Dataset {
1737
1971
  /**
1972
+ * @public
1738
1973
  * <p>The name of the dataset.</p>
1739
1974
  */
1740
1975
  name?: string;
1741
1976
  /**
1977
+ * @public
1742
1978
  * <p>The Amazon Resource Name (ARN) of the dataset that you want metadata
1743
1979
  * for.</p>
1744
1980
  */
1745
1981
  datasetArn?: string;
1746
1982
  /**
1983
+ * @public
1747
1984
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
1748
1985
  */
1749
1986
  datasetGroupArn?: string;
1750
1987
  /**
1988
+ * @public
1751
1989
  * <p>One of the following values:</p>
1752
1990
  * <ul>
1753
1991
  * <li>
@@ -1763,10 +2001,12 @@ export interface Dataset {
1763
2001
  */
1764
2002
  datasetType?: string;
1765
2003
  /**
2004
+ * @public
1766
2005
  * <p>The ARN of the associated schema.</p>
1767
2006
  */
1768
2007
  schemaArn?: string;
1769
2008
  /**
2009
+ * @public
1770
2010
  * <p>The status of the dataset.</p>
1771
2011
  * <p>A dataset can be in one of the following states:</p>
1772
2012
  * <ul>
@@ -1781,14 +2021,17 @@ export interface Dataset {
1781
2021
  */
1782
2022
  status?: string;
1783
2023
  /**
2024
+ * @public
1784
2025
  * <p>The creation date and time (in Unix time) of the dataset.</p>
1785
2026
  */
1786
2027
  creationDateTime?: Date;
1787
2028
  /**
2029
+ * @public
1788
2030
  * <p>A time stamp that shows when the dataset was updated.</p>
1789
2031
  */
1790
2032
  lastUpdatedDateTime?: Date;
1791
2033
  /**
2034
+ * @public
1792
2035
  * <p>Describes the latest update to the dataset.</p>
1793
2036
  */
1794
2037
  latestDatasetUpdate?: DatasetUpdateSummary;
@@ -1798,6 +2041,7 @@ export interface Dataset {
1798
2041
  */
1799
2042
  export interface DescribeDatasetResponse {
1800
2043
  /**
2044
+ * @public
1801
2045
  * <p>A listing of the dataset's properties.</p>
1802
2046
  */
1803
2047
  dataset?: Dataset;
@@ -1807,6 +2051,7 @@ export interface DescribeDatasetResponse {
1807
2051
  */
1808
2052
  export interface DescribeDatasetExportJobRequest {
1809
2053
  /**
2054
+ * @public
1810
2055
  * <p>The Amazon Resource Name (ARN) of the dataset export job to
1811
2056
  * describe.</p>
1812
2057
  */
@@ -1826,18 +2071,22 @@ export interface DescribeDatasetExportJobRequest {
1826
2071
  */
1827
2072
  export interface DatasetExportJob {
1828
2073
  /**
2074
+ * @public
1829
2075
  * <p>The name of the export job.</p>
1830
2076
  */
1831
2077
  jobName?: string;
1832
2078
  /**
2079
+ * @public
1833
2080
  * <p>The Amazon Resource Name (ARN) of the dataset export job.</p>
1834
2081
  */
1835
2082
  datasetExportJobArn?: string;
1836
2083
  /**
2084
+ * @public
1837
2085
  * <p>The Amazon Resource Name (ARN) of the dataset to export.</p>
1838
2086
  */
1839
2087
  datasetArn?: string;
1840
2088
  /**
2089
+ * @public
1841
2090
  * <p>The data to export, based on how you imported the data. You can choose
1842
2091
  * to export <code>BULK</code> data that you imported using a dataset import
1843
2092
  * job, <code>PUT</code> data that you imported incrementally (using the
@@ -1846,11 +2095,13 @@ export interface DatasetExportJob {
1846
2095
  */
1847
2096
  ingestionMode?: IngestionMode | string;
1848
2097
  /**
2098
+ * @public
1849
2099
  * <p>The Amazon Resource Name (ARN) of the IAM service role that has
1850
2100
  * permissions to add data to your output Amazon S3 bucket.</p>
1851
2101
  */
1852
2102
  roleArn?: string;
1853
2103
  /**
2104
+ * @public
1854
2105
  * <p>The status of the dataset export job.</p>
1855
2106
  * <p>A dataset export job can be in one of the following states:</p>
1856
2107
  * <ul>
@@ -1862,6 +2113,7 @@ export interface DatasetExportJob {
1862
2113
  */
1863
2114
  status?: string;
1864
2115
  /**
2116
+ * @public
1865
2117
  * <p>The path to the Amazon S3 bucket where the job's output is stored. For
1866
2118
  * example:</p>
1867
2119
  * <p>
@@ -1870,16 +2122,19 @@ export interface DatasetExportJob {
1870
2122
  */
1871
2123
  jobOutput?: DatasetExportJobOutput;
1872
2124
  /**
2125
+ * @public
1873
2126
  * <p>The creation date and time (in Unix time) of the dataset export
1874
2127
  * job.</p>
1875
2128
  */
1876
2129
  creationDateTime?: Date;
1877
2130
  /**
2131
+ * @public
1878
2132
  * <p>The date and time (in Unix time) the status of the dataset export job
1879
2133
  * was last updated.</p>
1880
2134
  */
1881
2135
  lastUpdatedDateTime?: Date;
1882
2136
  /**
2137
+ * @public
1883
2138
  * <p>If a dataset export job fails, provides the reason why.</p>
1884
2139
  */
1885
2140
  failureReason?: string;
@@ -1889,6 +2144,7 @@ export interface DatasetExportJob {
1889
2144
  */
1890
2145
  export interface DescribeDatasetExportJobResponse {
1891
2146
  /**
2147
+ * @public
1892
2148
  * <p>Information about the dataset export job, including the status.</p>
1893
2149
  * <p>The status is one of the following values:</p>
1894
2150
  * <ul>
@@ -1913,6 +2169,7 @@ export interface DescribeDatasetExportJobResponse {
1913
2169
  */
1914
2170
  export interface DescribeDatasetGroupRequest {
1915
2171
  /**
2172
+ * @public
1916
2173
  * <p>The Amazon Resource Name (ARN) of the dataset group to
1917
2174
  * describe.</p>
1918
2175
  */
@@ -1930,14 +2187,17 @@ export interface DescribeDatasetGroupRequest {
1930
2187
  */
1931
2188
  export interface DatasetGroup {
1932
2189
  /**
2190
+ * @public
1933
2191
  * <p>The name of the dataset group.</p>
1934
2192
  */
1935
2193
  name?: string;
1936
2194
  /**
2195
+ * @public
1937
2196
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
1938
2197
  */
1939
2198
  datasetGroupArn?: string;
1940
2199
  /**
2200
+ * @public
1941
2201
  * <p>The current status of the dataset group.</p>
1942
2202
  * <p>A dataset group can be in one of the following states:</p>
1943
2203
  * <ul>
@@ -1952,29 +2212,35 @@ export interface DatasetGroup {
1952
2212
  */
1953
2213
  status?: string;
1954
2214
  /**
2215
+ * @public
1955
2216
  * <p>The ARN of the IAM role that has permissions to create the dataset
1956
2217
  * group.</p>
1957
2218
  */
1958
2219
  roleArn?: string;
1959
2220
  /**
2221
+ * @public
1960
2222
  * <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to
1961
2223
  * encrypt the datasets.</p>
1962
2224
  */
1963
2225
  kmsKeyArn?: string;
1964
2226
  /**
2227
+ * @public
1965
2228
  * <p>The creation date and time (in Unix time) of the dataset group.</p>
1966
2229
  */
1967
2230
  creationDateTime?: Date;
1968
2231
  /**
2232
+ * @public
1969
2233
  * <p>The last update date and time (in Unix time) of the dataset
1970
2234
  * group.</p>
1971
2235
  */
1972
2236
  lastUpdatedDateTime?: Date;
1973
2237
  /**
2238
+ * @public
1974
2239
  * <p>If creating a dataset group fails, provides the reason why.</p>
1975
2240
  */
1976
2241
  failureReason?: string;
1977
2242
  /**
2243
+ * @public
1978
2244
  * <p>The domain of a Domain dataset group.</p>
1979
2245
  */
1980
2246
  domain?: Domain | string;
@@ -1984,6 +2250,7 @@ export interface DatasetGroup {
1984
2250
  */
1985
2251
  export interface DescribeDatasetGroupResponse {
1986
2252
  /**
2253
+ * @public
1987
2254
  * <p>A listing of the dataset group's properties.</p>
1988
2255
  */
1989
2256
  datasetGroup?: DatasetGroup;
@@ -1993,6 +2260,7 @@ export interface DescribeDatasetGroupResponse {
1993
2260
  */
1994
2261
  export interface DescribeDatasetImportJobRequest {
1995
2262
  /**
2263
+ * @public
1996
2264
  * <p>The Amazon Resource Name (ARN) of the dataset import job to
1997
2265
  * describe.</p>
1998
2266
  */
@@ -2012,28 +2280,34 @@ export interface DescribeDatasetImportJobRequest {
2012
2280
  */
2013
2281
  export interface DatasetImportJob {
2014
2282
  /**
2283
+ * @public
2015
2284
  * <p>The name of the import job.</p>
2016
2285
  */
2017
2286
  jobName?: string;
2018
2287
  /**
2288
+ * @public
2019
2289
  * <p>The ARN of the dataset import job.</p>
2020
2290
  */
2021
2291
  datasetImportJobArn?: string;
2022
2292
  /**
2293
+ * @public
2023
2294
  * <p>The Amazon Resource Name (ARN) of the dataset that receives the
2024
2295
  * imported data.</p>
2025
2296
  */
2026
2297
  datasetArn?: string;
2027
2298
  /**
2299
+ * @public
2028
2300
  * <p>The Amazon S3 bucket that contains the training data to import.</p>
2029
2301
  */
2030
2302
  dataSource?: DataSource;
2031
2303
  /**
2304
+ * @public
2032
2305
  * <p>The ARN of the IAM role that has permissions to read from the Amazon S3
2033
2306
  * data source.</p>
2034
2307
  */
2035
2308
  roleArn?: string;
2036
2309
  /**
2310
+ * @public
2037
2311
  * <p>The status of the dataset import job.</p>
2038
2312
  * <p>A dataset import job can be in one of the following states:</p>
2039
2313
  * <ul>
@@ -2045,24 +2319,29 @@ export interface DatasetImportJob {
2045
2319
  */
2046
2320
  status?: string;
2047
2321
  /**
2322
+ * @public
2048
2323
  * <p>The creation date and time (in Unix time) of the dataset import
2049
2324
  * job.</p>
2050
2325
  */
2051
2326
  creationDateTime?: Date;
2052
2327
  /**
2328
+ * @public
2053
2329
  * <p>The date and time (in Unix time) the dataset was last updated.</p>
2054
2330
  */
2055
2331
  lastUpdatedDateTime?: Date;
2056
2332
  /**
2333
+ * @public
2057
2334
  * <p>If a dataset import job fails, provides the reason why.</p>
2058
2335
  */
2059
2336
  failureReason?: string;
2060
2337
  /**
2338
+ * @public
2061
2339
  * <p>The import mode used by the dataset import job to import new
2062
2340
  * records.</p>
2063
2341
  */
2064
2342
  importMode?: ImportMode | string;
2065
2343
  /**
2344
+ * @public
2066
2345
  * <p>Whether the job publishes metrics to Amazon S3 for a metric attribution.</p>
2067
2346
  */
2068
2347
  publishAttributionMetricsToS3?: boolean;
@@ -2072,6 +2351,7 @@ export interface DatasetImportJob {
2072
2351
  */
2073
2352
  export interface DescribeDatasetImportJobResponse {
2074
2353
  /**
2354
+ * @public
2075
2355
  * <p>Information about the dataset import job, including the status.</p>
2076
2356
  * <p>The status is one of the following values:</p>
2077
2357
  * <ul>
@@ -2096,6 +2376,7 @@ export interface DescribeDatasetImportJobResponse {
2096
2376
  */
2097
2377
  export interface DescribeEventTrackerRequest {
2098
2378
  /**
2379
+ * @public
2099
2380
  * <p>The Amazon Resource Name (ARN) of the event tracker to describe.</p>
2100
2381
  */
2101
2382
  eventTrackerArn: string | undefined;
@@ -2106,27 +2387,33 @@ export interface DescribeEventTrackerRequest {
2106
2387
  */
2107
2388
  export interface EventTracker {
2108
2389
  /**
2390
+ * @public
2109
2391
  * <p>The name of the event tracker.</p>
2110
2392
  */
2111
2393
  name?: string;
2112
2394
  /**
2395
+ * @public
2113
2396
  * <p>The ARN of the event tracker.</p>
2114
2397
  */
2115
2398
  eventTrackerArn?: string;
2116
2399
  /**
2400
+ * @public
2117
2401
  * <p>The Amazon Web Services account that owns the event tracker.</p>
2118
2402
  */
2119
2403
  accountId?: string;
2120
2404
  /**
2405
+ * @public
2121
2406
  * <p>The ID of the event tracker. Include this ID in requests to the
2122
2407
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_UBS_PutEvents.html">PutEvents</a> API.</p>
2123
2408
  */
2124
2409
  trackingId?: string;
2125
2410
  /**
2411
+ * @public
2126
2412
  * <p>The Amazon Resource Name (ARN) of the dataset group that receives the event data.</p>
2127
2413
  */
2128
2414
  datasetGroupArn?: string;
2129
2415
  /**
2416
+ * @public
2130
2417
  * <p>The status of the event tracker.</p>
2131
2418
  * <p>An event tracker can be in one of the following states:</p>
2132
2419
  * <ul>
@@ -2140,10 +2427,12 @@ export interface EventTracker {
2140
2427
  */
2141
2428
  status?: string;
2142
2429
  /**
2430
+ * @public
2143
2431
  * <p>The date and time (in Unix format) that the event tracker was created.</p>
2144
2432
  */
2145
2433
  creationDateTime?: Date;
2146
2434
  /**
2435
+ * @public
2147
2436
  * <p>The date and time (in Unix time) that the event tracker was last updated.</p>
2148
2437
  */
2149
2438
  lastUpdatedDateTime?: Date;
@@ -2153,6 +2442,7 @@ export interface EventTracker {
2153
2442
  */
2154
2443
  export interface DescribeEventTrackerResponse {
2155
2444
  /**
2445
+ * @public
2156
2446
  * <p>An object that describes the event tracker.</p>
2157
2447
  */
2158
2448
  eventTracker?: EventTracker;
@@ -2162,6 +2452,7 @@ export interface DescribeEventTrackerResponse {
2162
2452
  */
2163
2453
  export interface DescribeFeatureTransformationRequest {
2164
2454
  /**
2455
+ * @public
2165
2456
  * <p>The Amazon Resource Name (ARN) of the feature transformation to describe.</p>
2166
2457
  */
2167
2458
  featureTransformationArn: string | undefined;
@@ -2173,26 +2464,32 @@ export interface DescribeFeatureTransformationRequest {
2173
2464
  */
2174
2465
  export interface FeatureTransformation {
2175
2466
  /**
2467
+ * @public
2176
2468
  * <p>The name of the feature transformation.</p>
2177
2469
  */
2178
2470
  name?: string;
2179
2471
  /**
2472
+ * @public
2180
2473
  * <p>The Amazon Resource Name (ARN) of the FeatureTransformation object.</p>
2181
2474
  */
2182
2475
  featureTransformationArn?: string;
2183
2476
  /**
2477
+ * @public
2184
2478
  * <p>Provides the default parameters for feature transformation.</p>
2185
2479
  */
2186
2480
  defaultParameters?: Record<string, string>;
2187
2481
  /**
2482
+ * @public
2188
2483
  * <p>The creation date and time (in Unix time) of the feature transformation.</p>
2189
2484
  */
2190
2485
  creationDateTime?: Date;
2191
2486
  /**
2487
+ * @public
2192
2488
  * <p>The last update date and time (in Unix time) of the feature transformation.</p>
2193
2489
  */
2194
2490
  lastUpdatedDateTime?: Date;
2195
2491
  /**
2492
+ * @public
2196
2493
  * <p>The status of the feature transformation.</p>
2197
2494
  * <p>A feature transformation can be in one of the following states:</p>
2198
2495
  * <ul>
@@ -2208,6 +2505,7 @@ export interface FeatureTransformation {
2208
2505
  */
2209
2506
  export interface DescribeFeatureTransformationResponse {
2210
2507
  /**
2508
+ * @public
2211
2509
  * <p>A listing of the FeatureTransformation properties.</p>
2212
2510
  */
2213
2511
  featureTransformation?: FeatureTransformation;
@@ -2217,6 +2515,7 @@ export interface DescribeFeatureTransformationResponse {
2217
2515
  */
2218
2516
  export interface DescribeFilterRequest {
2219
2517
  /**
2518
+ * @public
2220
2519
  * <p>The ARN of the filter to describe.</p>
2221
2520
  */
2222
2521
  filterArn: string | undefined;
@@ -2228,36 +2527,44 @@ export interface DescribeFilterRequest {
2228
2527
  */
2229
2528
  export interface Filter {
2230
2529
  /**
2530
+ * @public
2231
2531
  * <p>The name of the filter.</p>
2232
2532
  */
2233
2533
  name?: string;
2234
2534
  /**
2535
+ * @public
2235
2536
  * <p>The ARN of the filter.</p>
2236
2537
  */
2237
2538
  filterArn?: string;
2238
2539
  /**
2540
+ * @public
2239
2541
  * <p>The time at which the filter was created.</p>
2240
2542
  */
2241
2543
  creationDateTime?: Date;
2242
2544
  /**
2545
+ * @public
2243
2546
  * <p>The time at which the filter was last updated.</p>
2244
2547
  */
2245
2548
  lastUpdatedDateTime?: Date;
2246
2549
  /**
2550
+ * @public
2247
2551
  * <p>The ARN of the dataset group to which the filter belongs.</p>
2248
2552
  */
2249
2553
  datasetGroupArn?: string;
2250
2554
  /**
2555
+ * @public
2251
2556
  * <p>If the filter failed, the reason for its failure.</p>
2252
2557
  */
2253
2558
  failureReason?: string;
2254
2559
  /**
2560
+ * @public
2255
2561
  * <p>Specifies the type of item interactions to filter out of recommendation results. The
2256
2562
  * filter expression must follow specific format rules. For information about filter expression structure and syntax, see
2257
2563
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-expressions.html">Filter expressions</a>.</p>
2258
2564
  */
2259
2565
  filterExpression?: string;
2260
2566
  /**
2567
+ * @public
2261
2568
  * <p>The status of the filter.</p>
2262
2569
  */
2263
2570
  status?: string;
@@ -2267,6 +2574,7 @@ export interface Filter {
2267
2574
  */
2268
2575
  export interface DescribeFilterResponse {
2269
2576
  /**
2577
+ * @public
2270
2578
  * <p>The filter's details.</p>
2271
2579
  */
2272
2580
  filter?: Filter;
@@ -2276,6 +2584,7 @@ export interface DescribeFilterResponse {
2276
2584
  */
2277
2585
  export interface DescribeMetricAttributionRequest {
2278
2586
  /**
2587
+ * @public
2279
2588
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
2280
2589
  */
2281
2590
  metricAttributionArn: string | undefined;
@@ -2288,34 +2597,42 @@ export interface DescribeMetricAttributionRequest {
2288
2597
  */
2289
2598
  export interface MetricAttribution {
2290
2599
  /**
2600
+ * @public
2291
2601
  * <p>The metric attribution's name.</p>
2292
2602
  */
2293
2603
  name?: string;
2294
2604
  /**
2605
+ * @public
2295
2606
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
2296
2607
  */
2297
2608
  metricAttributionArn?: string;
2298
2609
  /**
2610
+ * @public
2299
2611
  * <p>The metric attribution's dataset group Amazon Resource Name (ARN).</p>
2300
2612
  */
2301
2613
  datasetGroupArn?: string;
2302
2614
  /**
2615
+ * @public
2303
2616
  * <p>The metric attribution's output configuration.</p>
2304
2617
  */
2305
2618
  metricsOutputConfig?: MetricAttributionOutput;
2306
2619
  /**
2620
+ * @public
2307
2621
  * <p>The metric attribution's status.</p>
2308
2622
  */
2309
2623
  status?: string;
2310
2624
  /**
2625
+ * @public
2311
2626
  * <p>The metric attribution's creation date time.</p>
2312
2627
  */
2313
2628
  creationDateTime?: Date;
2314
2629
  /**
2630
+ * @public
2315
2631
  * <p>The metric attribution's last updated date time.</p>
2316
2632
  */
2317
2633
  lastUpdatedDateTime?: Date;
2318
2634
  /**
2635
+ * @public
2319
2636
  * <p>The metric attribution's failure reason.</p>
2320
2637
  */
2321
2638
  failureReason?: string;
@@ -2325,6 +2642,7 @@ export interface MetricAttribution {
2325
2642
  */
2326
2643
  export interface DescribeMetricAttributionResponse {
2327
2644
  /**
2645
+ * @public
2328
2646
  * <p>The details of the metric attribution.</p>
2329
2647
  */
2330
2648
  metricAttribution?: MetricAttribution;
@@ -2334,6 +2652,7 @@ export interface DescribeMetricAttributionResponse {
2334
2652
  */
2335
2653
  export interface DescribeRecipeRequest {
2336
2654
  /**
2655
+ * @public
2337
2656
  * <p>The Amazon Resource Name (ARN) of the recipe to describe.</p>
2338
2657
  */
2339
2658
  recipeArn: string | undefined;
@@ -2346,35 +2665,43 @@ export interface DescribeRecipeRequest {
2346
2665
  */
2347
2666
  export interface Recipe {
2348
2667
  /**
2668
+ * @public
2349
2669
  * <p>The name of the recipe.</p>
2350
2670
  */
2351
2671
  name?: string;
2352
2672
  /**
2673
+ * @public
2353
2674
  * <p>The Amazon Resource Name (ARN) of the recipe.</p>
2354
2675
  */
2355
2676
  recipeArn?: string;
2356
2677
  /**
2678
+ * @public
2357
2679
  * <p>The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train
2358
2680
  * the model.</p>
2359
2681
  */
2360
2682
  algorithmArn?: string;
2361
2683
  /**
2684
+ * @public
2362
2685
  * <p>The ARN of the FeatureTransformation object.</p>
2363
2686
  */
2364
2687
  featureTransformationArn?: string;
2365
2688
  /**
2689
+ * @public
2366
2690
  * <p>The status of the recipe.</p>
2367
2691
  */
2368
2692
  status?: string;
2369
2693
  /**
2694
+ * @public
2370
2695
  * <p>The description of the recipe.</p>
2371
2696
  */
2372
2697
  description?: string;
2373
2698
  /**
2699
+ * @public
2374
2700
  * <p>The date and time (in Unix format) that the recipe was created.</p>
2375
2701
  */
2376
2702
  creationDateTime?: Date;
2377
2703
  /**
2704
+ * @public
2378
2705
  * <p>One of the following values:</p>
2379
2706
  * <ul>
2380
2707
  * <li>
@@ -2390,6 +2717,7 @@ export interface Recipe {
2390
2717
  */
2391
2718
  recipeType?: string;
2392
2719
  /**
2720
+ * @public
2393
2721
  * <p>The date and time (in Unix format) that the recipe was last updated.</p>
2394
2722
  */
2395
2723
  lastUpdatedDateTime?: Date;
@@ -2399,6 +2727,7 @@ export interface Recipe {
2399
2727
  */
2400
2728
  export interface DescribeRecipeResponse {
2401
2729
  /**
2730
+ * @public
2402
2731
  * <p>An object that describes the recipe.</p>
2403
2732
  */
2404
2733
  recipe?: Recipe;
@@ -2408,6 +2737,7 @@ export interface DescribeRecipeResponse {
2408
2737
  */
2409
2738
  export interface DescribeRecommenderRequest {
2410
2739
  /**
2740
+ * @public
2411
2741
  * <p>The Amazon Resource Name (ARN) of the recommender to describe.</p>
2412
2742
  */
2413
2743
  recommenderArn: string | undefined;
@@ -2419,18 +2749,22 @@ export interface DescribeRecommenderRequest {
2419
2749
  */
2420
2750
  export interface RecommenderUpdateSummary {
2421
2751
  /**
2752
+ * @public
2422
2753
  * <p>The configuration details of the recommender update.</p>
2423
2754
  */
2424
2755
  recommenderConfig?: RecommenderConfig;
2425
2756
  /**
2757
+ * @public
2426
2758
  * <p>The date and time (in Unix format) that the recommender update was created.</p>
2427
2759
  */
2428
2760
  creationDateTime?: Date;
2429
2761
  /**
2762
+ * @public
2430
2763
  * <p>The date and time (in Unix time) that the recommender update was last updated.</p>
2431
2764
  */
2432
2765
  lastUpdatedDateTime?: Date;
2433
2766
  /**
2767
+ * @public
2434
2768
  * <p>The status of the recommender update.</p>
2435
2769
  * <p>A recommender can be in one of the following states:</p>
2436
2770
  * <ul>
@@ -2447,6 +2781,7 @@ export interface RecommenderUpdateSummary {
2447
2781
  */
2448
2782
  status?: string;
2449
2783
  /**
2784
+ * @public
2450
2785
  * <p>If a recommender update fails, the reason behind the failure.</p>
2451
2786
  */
2452
2787
  failureReason?: string;
@@ -2458,35 +2793,43 @@ export interface RecommenderUpdateSummary {
2458
2793
  */
2459
2794
  export interface Recommender {
2460
2795
  /**
2796
+ * @public
2461
2797
  * <p>The Amazon Resource Name (ARN) of the recommender.</p>
2462
2798
  */
2463
2799
  recommenderArn?: string;
2464
2800
  /**
2801
+ * @public
2465
2802
  * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
2466
2803
  */
2467
2804
  datasetGroupArn?: string;
2468
2805
  /**
2806
+ * @public
2469
2807
  * <p>The name of the recommender.</p>
2470
2808
  */
2471
2809
  name?: string;
2472
2810
  /**
2811
+ * @public
2473
2812
  * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
2474
2813
  * </p>
2475
2814
  */
2476
2815
  recipeArn?: string;
2477
2816
  /**
2817
+ * @public
2478
2818
  * <p>The configuration details of the recommender.</p>
2479
2819
  */
2480
2820
  recommenderConfig?: RecommenderConfig;
2481
2821
  /**
2822
+ * @public
2482
2823
  * <p>The date and time (in Unix format) that the recommender was created.</p>
2483
2824
  */
2484
2825
  creationDateTime?: Date;
2485
2826
  /**
2827
+ * @public
2486
2828
  * <p>The date and time (in Unix format) that the recommender was last updated.</p>
2487
2829
  */
2488
2830
  lastUpdatedDateTime?: Date;
2489
2831
  /**
2832
+ * @public
2490
2833
  * <p>The status of the recommender.</p>
2491
2834
  * <p>A recommender can be in one of the following states:</p>
2492
2835
  * <ul>
@@ -2503,14 +2846,17 @@ export interface Recommender {
2503
2846
  */
2504
2847
  status?: string;
2505
2848
  /**
2849
+ * @public
2506
2850
  * <p>If a recommender fails, the reason behind the failure.</p>
2507
2851
  */
2508
2852
  failureReason?: string;
2509
2853
  /**
2854
+ * @public
2510
2855
  * <p>Provides a summary of the latest updates to the recommender. </p>
2511
2856
  */
2512
2857
  latestRecommenderUpdate?: RecommenderUpdateSummary;
2513
2858
  /**
2859
+ * @public
2514
2860
  * <p>Provides evaluation metrics that help you determine the performance
2515
2861
  * of a recommender. For more information, see
2516
2862
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/evaluating-recommenders.html">
@@ -2523,6 +2869,7 @@ export interface Recommender {
2523
2869
  */
2524
2870
  export interface DescribeRecommenderResponse {
2525
2871
  /**
2872
+ * @public
2526
2873
  * <p>The properties of the recommender.</p>
2527
2874
  */
2528
2875
  recommender?: Recommender;
@@ -2532,6 +2879,7 @@ export interface DescribeRecommenderResponse {
2532
2879
  */
2533
2880
  export interface DescribeSchemaRequest {
2534
2881
  /**
2882
+ * @public
2535
2883
  * <p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>
2536
2884
  */
2537
2885
  schemaArn: string | undefined;
@@ -2543,26 +2891,32 @@ export interface DescribeSchemaRequest {
2543
2891
  */
2544
2892
  export interface DatasetSchema {
2545
2893
  /**
2894
+ * @public
2546
2895
  * <p>The name of the schema.</p>
2547
2896
  */
2548
2897
  name?: string;
2549
2898
  /**
2899
+ * @public
2550
2900
  * <p>The Amazon Resource Name (ARN) of the schema.</p>
2551
2901
  */
2552
2902
  schemaArn?: string;
2553
2903
  /**
2904
+ * @public
2554
2905
  * <p>The schema.</p>
2555
2906
  */
2556
2907
  schema?: string;
2557
2908
  /**
2909
+ * @public
2558
2910
  * <p>The date and time (in Unix time) that the schema was created.</p>
2559
2911
  */
2560
2912
  creationDateTime?: Date;
2561
2913
  /**
2914
+ * @public
2562
2915
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
2563
2916
  */
2564
2917
  lastUpdatedDateTime?: Date;
2565
2918
  /**
2919
+ * @public
2566
2920
  * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
2567
2921
  */
2568
2922
  domain?: Domain | string;
@@ -2572,6 +2926,7 @@ export interface DatasetSchema {
2572
2926
  */
2573
2927
  export interface DescribeSchemaResponse {
2574
2928
  /**
2929
+ * @public
2575
2930
  * <p>The requested schema.</p>
2576
2931
  */
2577
2932
  schema?: DatasetSchema;
@@ -2581,6 +2936,7 @@ export interface DescribeSchemaResponse {
2581
2936
  */
2582
2937
  export interface DescribeSolutionRequest {
2583
2938
  /**
2939
+ * @public
2584
2940
  * <p>The Amazon Resource Name (ARN) of the solution to describe.</p>
2585
2941
  */
2586
2942
  solutionArn: string | undefined;
@@ -2593,6 +2949,7 @@ export interface DescribeSolutionRequest {
2593
2949
  */
2594
2950
  export interface AutoMLResult {
2595
2951
  /**
2952
+ * @public
2596
2953
  * <p>The Amazon Resource Name (ARN) of the best recipe.</p>
2597
2954
  */
2598
2955
  bestRecipeArn?: string;
@@ -2604,10 +2961,12 @@ export interface AutoMLResult {
2604
2961
  */
2605
2962
  export interface SolutionVersionSummary {
2606
2963
  /**
2964
+ * @public
2607
2965
  * <p>The Amazon Resource Name (ARN) of the solution version.</p>
2608
2966
  */
2609
2967
  solutionVersionArn?: string;
2610
2968
  /**
2969
+ * @public
2611
2970
  * <p>The status of the solution version.</p>
2612
2971
  * <p>A solution version can be in one of the following states:</p>
2613
2972
  * <ul>
@@ -2618,14 +2977,17 @@ export interface SolutionVersionSummary {
2618
2977
  */
2619
2978
  status?: string;
2620
2979
  /**
2980
+ * @public
2621
2981
  * <p>The date and time (in Unix time) that this version of a solution was created.</p>
2622
2982
  */
2623
2983
  creationDateTime?: Date;
2624
2984
  /**
2985
+ * @public
2625
2986
  * <p>The date and time (in Unix time) that the solution version was last updated.</p>
2626
2987
  */
2627
2988
  lastUpdatedDateTime?: Date;
2628
2989
  /**
2990
+ * @public
2629
2991
  * <p>If a solution version fails, the reason behind the failure.</p>
2630
2992
  */
2631
2993
  failureReason?: string;
@@ -2637,19 +2999,23 @@ export interface SolutionVersionSummary {
2637
2999
  */
2638
3000
  export interface Solution {
2639
3001
  /**
3002
+ * @public
2640
3003
  * <p>The name of the solution.</p>
2641
3004
  */
2642
3005
  name?: string;
2643
3006
  /**
3007
+ * @public
2644
3008
  * <p>The ARN of the solution.</p>
2645
3009
  */
2646
3010
  solutionArn?: string;
2647
3011
  /**
3012
+ * @public
2648
3013
  * <p>Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The
2649
3014
  * default is <code>false</code>.</p>
2650
3015
  */
2651
3016
  performHPO?: boolean;
2652
3017
  /**
3018
+ * @public
2653
3019
  * <important>
2654
3020
  * <p>We don't recommend enabling automated machine learning. Instead, match your use case to the available Amazon Personalize
2655
3021
  * recipes. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/determining-use-case.html">Determining your use case.</a>
@@ -2661,29 +3027,35 @@ export interface Solution {
2661
3027
  */
2662
3028
  performAutoML?: boolean;
2663
3029
  /**
3030
+ * @public
2664
3031
  * <p>The ARN of the recipe used to create the solution. This is required when
2665
3032
  * <code>performAutoML</code> is false.</p>
2666
3033
  */
2667
3034
  recipeArn?: string;
2668
3035
  /**
3036
+ * @public
2669
3037
  * <p>The Amazon Resource Name (ARN) of the dataset group that provides the training data.</p>
2670
3038
  */
2671
3039
  datasetGroupArn?: string;
2672
3040
  /**
3041
+ * @public
2673
3042
  * <p>The event type (for example, 'click' or 'like') that is used for training the model.
2674
3043
  * If no <code>eventType</code> is provided, Amazon Personalize uses all interactions for training with
2675
3044
  * equal weight regardless of type.</p>
2676
3045
  */
2677
3046
  eventType?: string;
2678
3047
  /**
3048
+ * @public
2679
3049
  * <p>Describes the configuration properties for the solution.</p>
2680
3050
  */
2681
3051
  solutionConfig?: SolutionConfig;
2682
3052
  /**
3053
+ * @public
2683
3054
  * <p>When <code>performAutoML</code> is true, specifies the best recipe found.</p>
2684
3055
  */
2685
3056
  autoMLResult?: AutoMLResult;
2686
3057
  /**
3058
+ * @public
2687
3059
  * <p>The status of the solution.</p>
2688
3060
  * <p>A solution can be in one of the following states:</p>
2689
3061
  * <ul>
@@ -2697,14 +3069,17 @@ export interface Solution {
2697
3069
  */
2698
3070
  status?: string;
2699
3071
  /**
3072
+ * @public
2700
3073
  * <p>The creation date and time (in Unix time) of the solution.</p>
2701
3074
  */
2702
3075
  creationDateTime?: Date;
2703
3076
  /**
3077
+ * @public
2704
3078
  * <p>The date and time (in Unix time) that the solution was last updated.</p>
2705
3079
  */
2706
3080
  lastUpdatedDateTime?: Date;
2707
3081
  /**
3082
+ * @public
2708
3083
  * <p>Describes the latest version of the solution, including the status and the ARN.</p>
2709
3084
  */
2710
3085
  latestSolutionVersion?: SolutionVersionSummary;
@@ -2714,6 +3089,7 @@ export interface Solution {
2714
3089
  */
2715
3090
  export interface DescribeSolutionResponse {
2716
3091
  /**
3092
+ * @public
2717
3093
  * <p>An object that describes the solution.</p>
2718
3094
  */
2719
3095
  solution?: Solution;
@@ -2723,6 +3099,7 @@ export interface DescribeSolutionResponse {
2723
3099
  */
2724
3100
  export interface DescribeSolutionVersionRequest {
2725
3101
  /**
3102
+ * @public
2726
3103
  * <p>The Amazon Resource Name (ARN) of the solution version.</p>
2727
3104
  */
2728
3105
  solutionVersionArn: string | undefined;
@@ -2734,6 +3111,7 @@ export interface DescribeSolutionVersionRequest {
2734
3111
  */
2735
3112
  export interface TunedHPOParams {
2736
3113
  /**
3114
+ * @public
2737
3115
  * <p>A list of the hyperparameter values of the best performing model.</p>
2738
3116
  */
2739
3117
  algorithmHyperParameters?: Record<string, string>;
@@ -2744,50 +3122,61 @@ export interface TunedHPOParams {
2744
3122
  */
2745
3123
  export interface SolutionVersion {
2746
3124
  /**
3125
+ * @public
2747
3126
  * <p>The name of the solution version.</p>
2748
3127
  */
2749
3128
  name?: string;
2750
3129
  /**
3130
+ * @public
2751
3131
  * <p>The ARN of the solution version.</p>
2752
3132
  */
2753
3133
  solutionVersionArn?: string;
2754
3134
  /**
3135
+ * @public
2755
3136
  * <p>The ARN of the solution.</p>
2756
3137
  */
2757
3138
  solutionArn?: string;
2758
3139
  /**
3140
+ * @public
2759
3141
  * <p>Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is
2760
3142
  * <code>false</code>.</p>
2761
3143
  */
2762
3144
  performHPO?: boolean;
2763
3145
  /**
3146
+ * @public
2764
3147
  * <p>When true, Amazon Personalize searches for the most optimal recipe according to the solution
2765
3148
  * configuration. When false (the default), Amazon Personalize uses <code>recipeArn</code>.</p>
2766
3149
  */
2767
3150
  performAutoML?: boolean;
2768
3151
  /**
3152
+ * @public
2769
3153
  * <p>The ARN of the recipe used in the solution.</p>
2770
3154
  */
2771
3155
  recipeArn?: string;
2772
3156
  /**
3157
+ * @public
2773
3158
  * <p>The event type (for example, 'click' or 'like') that is used for training the
2774
3159
  * model.</p>
2775
3160
  */
2776
3161
  eventType?: string;
2777
3162
  /**
3163
+ * @public
2778
3164
  * <p>The Amazon Resource Name (ARN) of the dataset group providing the training data.</p>
2779
3165
  */
2780
3166
  datasetGroupArn?: string;
2781
3167
  /**
3168
+ * @public
2782
3169
  * <p>Describes the configuration properties for the solution.</p>
2783
3170
  */
2784
3171
  solutionConfig?: SolutionConfig;
2785
3172
  /**
3173
+ * @public
2786
3174
  * <p>The time used to train the model. You are billed for the time it takes to train a model.
2787
3175
  * This field is visible only after Amazon Personalize successfully trains a model.</p>
2788
3176
  */
2789
3177
  trainingHours?: number;
2790
3178
  /**
3179
+ * @public
2791
3180
  * <p>The scope of training to be performed when creating the solution version. The
2792
3181
  * <code>FULL</code> option trains the solution version based on the entirety of the input
2793
3182
  * solution's training data, while the <code>UPDATE</code> option processes only the data that
@@ -2804,11 +3193,13 @@ export interface SolutionVersion {
2804
3193
  */
2805
3194
  trainingMode?: TrainingMode | string;
2806
3195
  /**
3196
+ * @public
2807
3197
  * <p>If hyperparameter optimization was performed, contains the hyperparameter values of the
2808
3198
  * best performing model.</p>
2809
3199
  */
2810
3200
  tunedHPOParams?: TunedHPOParams;
2811
3201
  /**
3202
+ * @public
2812
3203
  * <p>The status of the solution version.</p>
2813
3204
  * <p>A solution version can be in one of the following states:</p>
2814
3205
  * <ul>
@@ -2834,16 +3225,19 @@ export interface SolutionVersion {
2834
3225
  */
2835
3226
  status?: string;
2836
3227
  /**
3228
+ * @public
2837
3229
  * <p>If training a solution version fails, the reason for the failure.</p>
2838
3230
  */
2839
3231
  failureReason?: string;
2840
3232
  /**
3233
+ * @public
2841
3234
  * <p>The date and
2842
3235
  * time
2843
3236
  * (in Unix time) that this version of the solution was created.</p>
2844
3237
  */
2845
3238
  creationDateTime?: Date;
2846
3239
  /**
3240
+ * @public
2847
3241
  * <p>The date and time (in
2848
3242
  * Unix
2849
3243
  * time) that the solution was last updated.</p>
@@ -2855,6 +3249,7 @@ export interface SolutionVersion {
2855
3249
  */
2856
3250
  export interface DescribeSolutionVersionResponse {
2857
3251
  /**
3252
+ * @public
2858
3253
  * <p>The solution version.</p>
2859
3254
  */
2860
3255
  solutionVersion?: SolutionVersion;
@@ -2864,6 +3259,7 @@ export interface DescribeSolutionVersionResponse {
2864
3259
  */
2865
3260
  export interface GetSolutionMetricsRequest {
2866
3261
  /**
3262
+ * @public
2867
3263
  * <p>The Amazon Resource Name (ARN) of the solution version for which to get metrics.</p>
2868
3264
  */
2869
3265
  solutionVersionArn: string | undefined;
@@ -2873,10 +3269,12 @@ export interface GetSolutionMetricsRequest {
2873
3269
  */
2874
3270
  export interface GetSolutionMetricsResponse {
2875
3271
  /**
3272
+ * @public
2876
3273
  * <p>The same solution version ARN as specified in the request.</p>
2877
3274
  */
2878
3275
  solutionVersionArn?: string;
2879
3276
  /**
3277
+ * @public
2880
3278
  * <p>The metrics for the solution version. For more information, see
2881
3279
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/working-with-training-metrics.html">
2882
3280
  * Evaluating a solution version with metrics
@@ -2901,15 +3299,18 @@ export declare class InvalidNextTokenException extends __BaseException {
2901
3299
  */
2902
3300
  export interface ListBatchInferenceJobsRequest {
2903
3301
  /**
3302
+ * @public
2904
3303
  * <p>The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs
2905
3304
  * were created.</p>
2906
3305
  */
2907
3306
  solutionVersionArn?: string;
2908
3307
  /**
3308
+ * @public
2909
3309
  * <p>The token to request the next page of results.</p>
2910
3310
  */
2911
3311
  nextToken?: string;
2912
3312
  /**
3313
+ * @public
2913
3314
  * <p>The maximum number of batch inference job results to return in each page. The default
2914
3315
  * value is 100.</p>
2915
3316
  */
@@ -2923,14 +3324,17 @@ export interface ListBatchInferenceJobsRequest {
2923
3324
  */
2924
3325
  export interface BatchInferenceJobSummary {
2925
3326
  /**
3327
+ * @public
2926
3328
  * <p>The Amazon Resource Name (ARN) of the batch inference job.</p>
2927
3329
  */
2928
3330
  batchInferenceJobArn?: string;
2929
3331
  /**
3332
+ * @public
2930
3333
  * <p>The name of the batch inference job.</p>
2931
3334
  */
2932
3335
  jobName?: string;
2933
3336
  /**
3337
+ * @public
2934
3338
  * <p>The status of the batch inference job. The status is one of the following values:</p>
2935
3339
  * <ul>
2936
3340
  * <li>
@@ -2949,18 +3353,22 @@ export interface BatchInferenceJobSummary {
2949
3353
  */
2950
3354
  status?: string;
2951
3355
  /**
3356
+ * @public
2952
3357
  * <p>The time at which the batch inference job was created.</p>
2953
3358
  */
2954
3359
  creationDateTime?: Date;
2955
3360
  /**
3361
+ * @public
2956
3362
  * <p>The time at which the batch inference job was last updated.</p>
2957
3363
  */
2958
3364
  lastUpdatedDateTime?: Date;
2959
3365
  /**
3366
+ * @public
2960
3367
  * <p>If the batch inference job failed, the reason for the failure.</p>
2961
3368
  */
2962
3369
  failureReason?: string;
2963
3370
  /**
3371
+ * @public
2964
3372
  * <p>The ARN of the solution version used by the batch inference job.</p>
2965
3373
  */
2966
3374
  solutionVersionArn?: string;
@@ -2970,10 +3378,12 @@ export interface BatchInferenceJobSummary {
2970
3378
  */
2971
3379
  export interface ListBatchInferenceJobsResponse {
2972
3380
  /**
3381
+ * @public
2973
3382
  * <p>A list containing information on each job that is returned.</p>
2974
3383
  */
2975
3384
  batchInferenceJobs?: BatchInferenceJobSummary[];
2976
3385
  /**
3386
+ * @public
2977
3387
  * <p>The token to use to retrieve the next page of results. The value is <code>null</code> when
2978
3388
  * there are no more results to return.</p>
2979
3389
  */
@@ -2984,14 +3394,17 @@ export interface ListBatchInferenceJobsResponse {
2984
3394
  */
2985
3395
  export interface ListBatchSegmentJobsRequest {
2986
3396
  /**
3397
+ * @public
2987
3398
  * <p>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</p>
2988
3399
  */
2989
3400
  solutionVersionArn?: string;
2990
3401
  /**
3402
+ * @public
2991
3403
  * <p>The token to request the next page of results.</p>
2992
3404
  */
2993
3405
  nextToken?: string;
2994
3406
  /**
3407
+ * @public
2995
3408
  * <p>The maximum number of batch segment job results to return in each page. The default
2996
3409
  * value is 100.</p>
2997
3410
  */
@@ -3005,14 +3418,17 @@ export interface ListBatchSegmentJobsRequest {
3005
3418
  */
3006
3419
  export interface BatchSegmentJobSummary {
3007
3420
  /**
3421
+ * @public
3008
3422
  * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
3009
3423
  */
3010
3424
  batchSegmentJobArn?: string;
3011
3425
  /**
3426
+ * @public
3012
3427
  * <p>The name of the batch segment job.</p>
3013
3428
  */
3014
3429
  jobName?: string;
3015
3430
  /**
3431
+ * @public
3016
3432
  * <p>The status of the batch segment job. The status is one of the following values:</p>
3017
3433
  * <ul>
3018
3434
  * <li>
@@ -3031,18 +3447,22 @@ export interface BatchSegmentJobSummary {
3031
3447
  */
3032
3448
  status?: string;
3033
3449
  /**
3450
+ * @public
3034
3451
  * <p>The time at which the batch segment job was created.</p>
3035
3452
  */
3036
3453
  creationDateTime?: Date;
3037
3454
  /**
3455
+ * @public
3038
3456
  * <p>The time at which the batch segment job was last updated.</p>
3039
3457
  */
3040
3458
  lastUpdatedDateTime?: Date;
3041
3459
  /**
3460
+ * @public
3042
3461
  * <p>If the batch segment job failed, the reason for the failure.</p>
3043
3462
  */
3044
3463
  failureReason?: string;
3045
3464
  /**
3465
+ * @public
3046
3466
  * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
3047
3467
  */
3048
3468
  solutionVersionArn?: string;
@@ -3052,10 +3472,12 @@ export interface BatchSegmentJobSummary {
3052
3472
  */
3053
3473
  export interface ListBatchSegmentJobsResponse {
3054
3474
  /**
3475
+ * @public
3055
3476
  * <p>A list containing information on each job that is returned.</p>
3056
3477
  */
3057
3478
  batchSegmentJobs?: BatchSegmentJobSummary[];
3058
3479
  /**
3480
+ * @public
3059
3481
  * <p>The token to use to retrieve the next page of results. The value is <code>null</code> when
3060
3482
  * there are no more results to return.</p>
3061
3483
  */
@@ -3066,16 +3488,19 @@ export interface ListBatchSegmentJobsResponse {
3066
3488
  */
3067
3489
  export interface ListCampaignsRequest {
3068
3490
  /**
3491
+ * @public
3069
3492
  * <p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When
3070
3493
  * a solution is not specified, all the campaigns associated with the account are listed.</p>
3071
3494
  */
3072
3495
  solutionArn?: string;
3073
3496
  /**
3497
+ * @public
3074
3498
  * <p>A token returned from the previous call to <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListCampaigns.html">ListCampaigns</a> for getting
3075
3499
  * the next set of campaigns (if they exist).</p>
3076
3500
  */
3077
3501
  nextToken?: string;
3078
3502
  /**
3503
+ * @public
3079
3504
  * <p>The maximum number of campaigns to return.</p>
3080
3505
  */
3081
3506
  maxResults?: number;
@@ -3087,14 +3512,17 @@ export interface ListCampaignsRequest {
3087
3512
  */
3088
3513
  export interface CampaignSummary {
3089
3514
  /**
3515
+ * @public
3090
3516
  * <p>The name of the campaign.</p>
3091
3517
  */
3092
3518
  name?: string;
3093
3519
  /**
3520
+ * @public
3094
3521
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
3095
3522
  */
3096
3523
  campaignArn?: string;
3097
3524
  /**
3525
+ * @public
3098
3526
  * <p>The status of the campaign.</p>
3099
3527
  * <p>A campaign can be in one of the following states:</p>
3100
3528
  * <ul>
@@ -3108,14 +3536,17 @@ export interface CampaignSummary {
3108
3536
  */
3109
3537
  status?: string;
3110
3538
  /**
3539
+ * @public
3111
3540
  * <p>The date and time (in Unix time) that the campaign was created.</p>
3112
3541
  */
3113
3542
  creationDateTime?: Date;
3114
3543
  /**
3544
+ * @public
3115
3545
  * <p>The date and time (in Unix time) that the campaign was last updated.</p>
3116
3546
  */
3117
3547
  lastUpdatedDateTime?: Date;
3118
3548
  /**
3549
+ * @public
3119
3550
  * <p>If a campaign fails, the reason behind the failure.</p>
3120
3551
  */
3121
3552
  failureReason?: string;
@@ -3125,10 +3556,12 @@ export interface CampaignSummary {
3125
3556
  */
3126
3557
  export interface ListCampaignsResponse {
3127
3558
  /**
3559
+ * @public
3128
3560
  * <p>A list of the campaigns.</p>
3129
3561
  */
3130
3562
  campaigns?: CampaignSummary[];
3131
3563
  /**
3564
+ * @public
3132
3565
  * <p>A token for getting the next set of campaigns (if they exist).</p>
3133
3566
  */
3134
3567
  nextToken?: string;
@@ -3138,17 +3571,20 @@ export interface ListCampaignsResponse {
3138
3571
  */
3139
3572
  export interface ListDatasetExportJobsRequest {
3140
3573
  /**
3574
+ * @public
3141
3575
  * <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
3142
3576
  * export jobs for.</p>
3143
3577
  */
3144
3578
  datasetArn?: string;
3145
3579
  /**
3580
+ * @public
3146
3581
  * <p>A token returned from the previous call to
3147
3582
  * <code>ListDatasetExportJobs</code> for getting the next set of dataset
3148
3583
  * export jobs (if they exist).</p>
3149
3584
  */
3150
3585
  nextToken?: string;
3151
3586
  /**
3587
+ * @public
3152
3588
  * <p>The maximum number of dataset export jobs to return.</p>
3153
3589
  */
3154
3590
  maxResults?: number;
@@ -3160,14 +3596,17 @@ export interface ListDatasetExportJobsRequest {
3160
3596
  */
3161
3597
  export interface DatasetExportJobSummary {
3162
3598
  /**
3599
+ * @public
3163
3600
  * <p>The Amazon Resource Name (ARN) of the dataset export job.</p>
3164
3601
  */
3165
3602
  datasetExportJobArn?: string;
3166
3603
  /**
3604
+ * @public
3167
3605
  * <p>The name of the dataset export job.</p>
3168
3606
  */
3169
3607
  jobName?: string;
3170
3608
  /**
3609
+ * @public
3171
3610
  * <p>The status of the dataset export job.</p>
3172
3611
  * <p>A dataset export job can be in one of the following states:</p>
3173
3612
  * <ul>
@@ -3178,14 +3617,17 @@ export interface DatasetExportJobSummary {
3178
3617
  */
3179
3618
  status?: string;
3180
3619
  /**
3620
+ * @public
3181
3621
  * <p>The date and time (in Unix time) that the dataset export job was created.</p>
3182
3622
  */
3183
3623
  creationDateTime?: Date;
3184
3624
  /**
3625
+ * @public
3185
3626
  * <p>The date and time (in Unix time) that the dataset export job status was last updated.</p>
3186
3627
  */
3187
3628
  lastUpdatedDateTime?: Date;
3188
3629
  /**
3630
+ * @public
3189
3631
  * <p>If a dataset export job fails, the reason behind the failure.</p>
3190
3632
  */
3191
3633
  failureReason?: string;
@@ -3195,10 +3637,12 @@ export interface DatasetExportJobSummary {
3195
3637
  */
3196
3638
  export interface ListDatasetExportJobsResponse {
3197
3639
  /**
3640
+ * @public
3198
3641
  * <p>The list of dataset export jobs.</p>
3199
3642
  */
3200
3643
  datasetExportJobs?: DatasetExportJobSummary[];
3201
3644
  /**
3645
+ * @public
3202
3646
  * <p>A token for getting the next set of dataset export jobs (if they
3203
3647
  * exist).</p>
3204
3648
  */
@@ -3209,12 +3653,14 @@ export interface ListDatasetExportJobsResponse {
3209
3653
  */
3210
3654
  export interface ListDatasetGroupsRequest {
3211
3655
  /**
3656
+ * @public
3212
3657
  * <p>A token returned from the previous call to
3213
3658
  * <code>ListDatasetGroups</code> for getting the next set of dataset
3214
3659
  * groups (if they exist).</p>
3215
3660
  */
3216
3661
  nextToken?: string;
3217
3662
  /**
3663
+ * @public
3218
3664
  * <p>The maximum number of dataset groups to return.</p>
3219
3665
  */
3220
3666
  maxResults?: number;
@@ -3226,14 +3672,17 @@ export interface ListDatasetGroupsRequest {
3226
3672
  */
3227
3673
  export interface DatasetGroupSummary {
3228
3674
  /**
3675
+ * @public
3229
3676
  * <p>The name of the dataset group.</p>
3230
3677
  */
3231
3678
  name?: string;
3232
3679
  /**
3680
+ * @public
3233
3681
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
3234
3682
  */
3235
3683
  datasetGroupArn?: string;
3236
3684
  /**
3685
+ * @public
3237
3686
  * <p>The status of the dataset group.</p>
3238
3687
  * <p>A dataset group can be in one of the following states:</p>
3239
3688
  * <ul>
@@ -3247,18 +3696,22 @@ export interface DatasetGroupSummary {
3247
3696
  */
3248
3697
  status?: string;
3249
3698
  /**
3699
+ * @public
3250
3700
  * <p>The date and time (in Unix time) that the dataset group was created.</p>
3251
3701
  */
3252
3702
  creationDateTime?: Date;
3253
3703
  /**
3704
+ * @public
3254
3705
  * <p>The date and time (in Unix time) that the dataset group was last updated.</p>
3255
3706
  */
3256
3707
  lastUpdatedDateTime?: Date;
3257
3708
  /**
3709
+ * @public
3258
3710
  * <p>If creating a dataset group fails, the reason behind the failure.</p>
3259
3711
  */
3260
3712
  failureReason?: string;
3261
3713
  /**
3714
+ * @public
3262
3715
  * <p>The domain of a Domain dataset group.</p>
3263
3716
  */
3264
3717
  domain?: Domain | string;
@@ -3268,10 +3721,12 @@ export interface DatasetGroupSummary {
3268
3721
  */
3269
3722
  export interface ListDatasetGroupsResponse {
3270
3723
  /**
3724
+ * @public
3271
3725
  * <p>The list of your dataset groups.</p>
3272
3726
  */
3273
3727
  datasetGroups?: DatasetGroupSummary[];
3274
3728
  /**
3729
+ * @public
3275
3730
  * <p>A token for getting the next set of dataset groups (if they
3276
3731
  * exist).</p>
3277
3732
  */
@@ -3282,17 +3737,20 @@ export interface ListDatasetGroupsResponse {
3282
3737
  */
3283
3738
  export interface ListDatasetImportJobsRequest {
3284
3739
  /**
3740
+ * @public
3285
3741
  * <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
3286
3742
  * import jobs for.</p>
3287
3743
  */
3288
3744
  datasetArn?: string;
3289
3745
  /**
3746
+ * @public
3290
3747
  * <p>A token returned from the previous call to
3291
3748
  * <code>ListDatasetImportJobs</code> for getting the next set of dataset
3292
3749
  * import jobs (if they exist).</p>
3293
3750
  */
3294
3751
  nextToken?: string;
3295
3752
  /**
3753
+ * @public
3296
3754
  * <p>The maximum number of dataset import jobs to return.</p>
3297
3755
  */
3298
3756
  maxResults?: number;
@@ -3304,14 +3762,17 @@ export interface ListDatasetImportJobsRequest {
3304
3762
  */
3305
3763
  export interface DatasetImportJobSummary {
3306
3764
  /**
3765
+ * @public
3307
3766
  * <p>The Amazon Resource Name (ARN) of the dataset import job.</p>
3308
3767
  */
3309
3768
  datasetImportJobArn?: string;
3310
3769
  /**
3770
+ * @public
3311
3771
  * <p>The name of the dataset import job.</p>
3312
3772
  */
3313
3773
  jobName?: string;
3314
3774
  /**
3775
+ * @public
3315
3776
  * <p>The status of the dataset import job.</p>
3316
3777
  * <p>A dataset import job can be in one of the following states:</p>
3317
3778
  * <ul>
@@ -3322,18 +3783,22 @@ export interface DatasetImportJobSummary {
3322
3783
  */
3323
3784
  status?: string;
3324
3785
  /**
3786
+ * @public
3325
3787
  * <p>The date and time (in Unix time) that the dataset import job was created.</p>
3326
3788
  */
3327
3789
  creationDateTime?: Date;
3328
3790
  /**
3791
+ * @public
3329
3792
  * <p>The date and time (in Unix time) that the dataset import job status was last updated.</p>
3330
3793
  */
3331
3794
  lastUpdatedDateTime?: Date;
3332
3795
  /**
3796
+ * @public
3333
3797
  * <p>If a dataset import job fails, the reason behind the failure.</p>
3334
3798
  */
3335
3799
  failureReason?: string;
3336
3800
  /**
3801
+ * @public
3337
3802
  * <p>The import mode the dataset import job used to update the data in the dataset.
3338
3803
  * For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html">Updating existing bulk
3339
3804
  * data</a>.
@@ -3346,10 +3811,12 @@ export interface DatasetImportJobSummary {
3346
3811
  */
3347
3812
  export interface ListDatasetImportJobsResponse {
3348
3813
  /**
3814
+ * @public
3349
3815
  * <p>The list of dataset import jobs.</p>
3350
3816
  */
3351
3817
  datasetImportJobs?: DatasetImportJobSummary[];
3352
3818
  /**
3819
+ * @public
3353
3820
  * <p>A token for getting the next set of dataset import jobs (if they
3354
3821
  * exist).</p>
3355
3822
  */
@@ -3360,17 +3827,20 @@ export interface ListDatasetImportJobsResponse {
3360
3827
  */
3361
3828
  export interface ListDatasetsRequest {
3362
3829
  /**
3830
+ * @public
3363
3831
  * <p>The Amazon Resource Name (ARN) of the dataset group that contains the
3364
3832
  * datasets to list.</p>
3365
3833
  */
3366
3834
  datasetGroupArn?: string;
3367
3835
  /**
3836
+ * @public
3368
3837
  * <p>A token returned from the previous call to
3369
3838
  * <code>ListDatasetImportJobs</code> for getting the next set of dataset
3370
3839
  * import jobs (if they exist).</p>
3371
3840
  */
3372
3841
  nextToken?: string;
3373
3842
  /**
3843
+ * @public
3374
3844
  * <p>The maximum number of datasets to return.</p>
3375
3845
  */
3376
3846
  maxResults?: number;
@@ -3382,14 +3852,17 @@ export interface ListDatasetsRequest {
3382
3852
  */
3383
3853
  export interface DatasetSummary {
3384
3854
  /**
3855
+ * @public
3385
3856
  * <p>The name of the dataset.</p>
3386
3857
  */
3387
3858
  name?: string;
3388
3859
  /**
3860
+ * @public
3389
3861
  * <p>The Amazon Resource Name (ARN) of the dataset.</p>
3390
3862
  */
3391
3863
  datasetArn?: string;
3392
3864
  /**
3865
+ * @public
3393
3866
  * <p>The dataset type. One of the following values:</p>
3394
3867
  * <ul>
3395
3868
  * <li>
@@ -3408,6 +3881,7 @@ export interface DatasetSummary {
3408
3881
  */
3409
3882
  datasetType?: string;
3410
3883
  /**
3884
+ * @public
3411
3885
  * <p>The status of the dataset.</p>
3412
3886
  * <p>A dataset can be in one of the following states:</p>
3413
3887
  * <ul>
@@ -3421,10 +3895,12 @@ export interface DatasetSummary {
3421
3895
  */
3422
3896
  status?: string;
3423
3897
  /**
3898
+ * @public
3424
3899
  * <p>The date and time (in Unix time) that the dataset was created.</p>
3425
3900
  */
3426
3901
  creationDateTime?: Date;
3427
3902
  /**
3903
+ * @public
3428
3904
  * <p>The date and time (in Unix time) that the dataset was last updated.</p>
3429
3905
  */
3430
3906
  lastUpdatedDateTime?: Date;
@@ -3434,11 +3910,13 @@ export interface DatasetSummary {
3434
3910
  */
3435
3911
  export interface ListDatasetsResponse {
3436
3912
  /**
3913
+ * @public
3437
3914
  * <p>An array of <code>Dataset</code> objects. Each object provides
3438
3915
  * metadata information.</p>
3439
3916
  */
3440
3917
  datasets?: DatasetSummary[];
3441
3918
  /**
3919
+ * @public
3442
3920
  * <p>A token for getting the next set of datasets (if they exist).</p>
3443
3921
  */
3444
3922
  nextToken?: string;
@@ -3448,15 +3926,18 @@ export interface ListDatasetsResponse {
3448
3926
  */
3449
3927
  export interface ListEventTrackersRequest {
3450
3928
  /**
3929
+ * @public
3451
3930
  * <p>The ARN of a dataset group used to filter the response.</p>
3452
3931
  */
3453
3932
  datasetGroupArn?: string;
3454
3933
  /**
3934
+ * @public
3455
3935
  * <p>A token returned from the previous call to <code>ListEventTrackers</code> for getting
3456
3936
  * the next set of event trackers (if they exist).</p>
3457
3937
  */
3458
3938
  nextToken?: string;
3459
3939
  /**
3940
+ * @public
3460
3941
  * <p>The maximum number of event trackers to return.</p>
3461
3942
  */
3462
3943
  maxResults?: number;
@@ -3468,14 +3949,17 @@ export interface ListEventTrackersRequest {
3468
3949
  */
3469
3950
  export interface EventTrackerSummary {
3470
3951
  /**
3952
+ * @public
3471
3953
  * <p>The name of the event tracker.</p>
3472
3954
  */
3473
3955
  name?: string;
3474
3956
  /**
3957
+ * @public
3475
3958
  * <p>The Amazon Resource Name (ARN) of the event tracker.</p>
3476
3959
  */
3477
3960
  eventTrackerArn?: string;
3478
3961
  /**
3962
+ * @public
3479
3963
  * <p>The status of the event tracker.</p>
3480
3964
  * <p>An event tracker can be in one of the following states:</p>
3481
3965
  * <ul>
@@ -3489,10 +3973,12 @@ export interface EventTrackerSummary {
3489
3973
  */
3490
3974
  status?: string;
3491
3975
  /**
3976
+ * @public
3492
3977
  * <p>The date and time (in Unix time) that the event tracker was created.</p>
3493
3978
  */
3494
3979
  creationDateTime?: Date;
3495
3980
  /**
3981
+ * @public
3496
3982
  * <p>The date and time (in Unix time) that the event tracker was last updated.</p>
3497
3983
  */
3498
3984
  lastUpdatedDateTime?: Date;
@@ -3502,10 +3988,12 @@ export interface EventTrackerSummary {
3502
3988
  */
3503
3989
  export interface ListEventTrackersResponse {
3504
3990
  /**
3991
+ * @public
3505
3992
  * <p>A list of event trackers.</p>
3506
3993
  */
3507
3994
  eventTrackers?: EventTrackerSummary[];
3508
3995
  /**
3996
+ * @public
3509
3997
  * <p>A token for getting the next set of event trackers (if they exist).</p>
3510
3998
  */
3511
3999
  nextToken?: string;
@@ -3515,15 +4003,18 @@ export interface ListEventTrackersResponse {
3515
4003
  */
3516
4004
  export interface ListFiltersRequest {
3517
4005
  /**
4006
+ * @public
3518
4007
  * <p>The ARN of the dataset group that contains the filters.</p>
3519
4008
  */
3520
4009
  datasetGroupArn?: string;
3521
4010
  /**
4011
+ * @public
3522
4012
  * <p>A token returned from the previous call to <code>ListFilters</code> for getting the
3523
4013
  * next set of filters (if they exist).</p>
3524
4014
  */
3525
4015
  nextToken?: string;
3526
4016
  /**
4017
+ * @public
3527
4018
  * <p>The maximum number of filters to return.</p>
3528
4019
  */
3529
4020
  maxResults?: number;
@@ -3534,30 +4025,37 @@ export interface ListFiltersRequest {
3534
4025
  */
3535
4026
  export interface FilterSummary {
3536
4027
  /**
4028
+ * @public
3537
4029
  * <p>The name of the filter.</p>
3538
4030
  */
3539
4031
  name?: string;
3540
4032
  /**
4033
+ * @public
3541
4034
  * <p>The ARN of the filter.</p>
3542
4035
  */
3543
4036
  filterArn?: string;
3544
4037
  /**
4038
+ * @public
3545
4039
  * <p>The time at which the filter was created.</p>
3546
4040
  */
3547
4041
  creationDateTime?: Date;
3548
4042
  /**
4043
+ * @public
3549
4044
  * <p>The time at which the filter was last updated.</p>
3550
4045
  */
3551
4046
  lastUpdatedDateTime?: Date;
3552
4047
  /**
4048
+ * @public
3553
4049
  * <p>The ARN of the dataset group to which the filter belongs.</p>
3554
4050
  */
3555
4051
  datasetGroupArn?: string;
3556
4052
  /**
4053
+ * @public
3557
4054
  * <p>If the filter failed, the reason for the failure.</p>
3558
4055
  */
3559
4056
  failureReason?: string;
3560
4057
  /**
4058
+ * @public
3561
4059
  * <p>The status of the filter.</p>
3562
4060
  */
3563
4061
  status?: string;
@@ -3567,10 +4065,12 @@ export interface FilterSummary {
3567
4065
  */
3568
4066
  export interface ListFiltersResponse {
3569
4067
  /**
4068
+ * @public
3570
4069
  * <p>A list of returned filters.</p>
3571
4070
  */
3572
4071
  Filters?: FilterSummary[];
3573
4072
  /**
4073
+ * @public
3574
4074
  * <p>A token for getting the next set of filters (if they exist).</p>
3575
4075
  */
3576
4076
  nextToken?: string;
@@ -3580,14 +4080,17 @@ export interface ListFiltersResponse {
3580
4080
  */
3581
4081
  export interface ListMetricAttributionMetricsRequest {
3582
4082
  /**
4083
+ * @public
3583
4084
  * <p>The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.</p>
3584
4085
  */
3585
4086
  metricAttributionArn?: string;
3586
4087
  /**
4088
+ * @public
3587
4089
  * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
3588
4090
  */
3589
4091
  nextToken?: string;
3590
4092
  /**
4093
+ * @public
3591
4094
  * <p>The maximum number of metrics to return in one page of results.</p>
3592
4095
  */
3593
4096
  maxResults?: number;
@@ -3597,10 +4100,12 @@ export interface ListMetricAttributionMetricsRequest {
3597
4100
  */
3598
4101
  export interface ListMetricAttributionMetricsResponse {
3599
4102
  /**
4103
+ * @public
3600
4104
  * <p>The metrics for the specified metric attribution.</p>
3601
4105
  */
3602
4106
  metrics?: MetricAttribute[];
3603
4107
  /**
4108
+ * @public
3604
4109
  * <p>Specify the pagination token from a previous <code>ListMetricAttributionMetricsResponse</code> request to retrieve the next page of results.</p>
3605
4110
  */
3606
4111
  nextToken?: string;
@@ -3610,14 +4115,17 @@ export interface ListMetricAttributionMetricsResponse {
3610
4115
  */
3611
4116
  export interface ListMetricAttributionsRequest {
3612
4117
  /**
4118
+ * @public
3613
4119
  * <p>The metric attributions' dataset group Amazon Resource Name (ARN).</p>
3614
4120
  */
3615
4121
  datasetGroupArn?: string;
3616
4122
  /**
4123
+ * @public
3617
4124
  * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
3618
4125
  */
3619
4126
  nextToken?: string;
3620
4127
  /**
4128
+ * @public
3621
4129
  * <p>The maximum number of metric attributions to return in one page of results.</p>
3622
4130
  */
3623
4131
  maxResults?: number;
@@ -3628,26 +4136,32 @@ export interface ListMetricAttributionsRequest {
3628
4136
  */
3629
4137
  export interface MetricAttributionSummary {
3630
4138
  /**
4139
+ * @public
3631
4140
  * <p>The name of the metric attribution.</p>
3632
4141
  */
3633
4142
  name?: string;
3634
4143
  /**
4144
+ * @public
3635
4145
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
3636
4146
  */
3637
4147
  metricAttributionArn?: string;
3638
4148
  /**
4149
+ * @public
3639
4150
  * <p>The metric attribution's status.</p>
3640
4151
  */
3641
4152
  status?: string;
3642
4153
  /**
4154
+ * @public
3643
4155
  * <p>The metric attribution's creation date time.</p>
3644
4156
  */
3645
4157
  creationDateTime?: Date;
3646
4158
  /**
4159
+ * @public
3647
4160
  * <p>The metric attribution's last updated date time.</p>
3648
4161
  */
3649
4162
  lastUpdatedDateTime?: Date;
3650
4163
  /**
4164
+ * @public
3651
4165
  * <p>The metric attribution's failure reason.</p>
3652
4166
  */
3653
4167
  failureReason?: string;
@@ -3657,10 +4171,12 @@ export interface MetricAttributionSummary {
3657
4171
  */
3658
4172
  export interface ListMetricAttributionsResponse {
3659
4173
  /**
4174
+ * @public
3660
4175
  * <p>The list of metric attributions.</p>
3661
4176
  */
3662
4177
  metricAttributions?: MetricAttributionSummary[];
3663
4178
  /**
4179
+ * @public
3664
4180
  * <p>Specify the pagination token from a previous request to retrieve the next page of results.</p>
3665
4181
  */
3666
4182
  nextToken?: string;
@@ -3681,19 +4197,23 @@ export type RecipeProvider = (typeof RecipeProvider)[keyof typeof RecipeProvider
3681
4197
  */
3682
4198
  export interface ListRecipesRequest {
3683
4199
  /**
4200
+ * @public
3684
4201
  * <p>The default is <code>SERVICE</code>.</p>
3685
4202
  */
3686
4203
  recipeProvider?: RecipeProvider | string;
3687
4204
  /**
4205
+ * @public
3688
4206
  * <p>A token returned from the previous call to <code>ListRecipes</code> for getting
3689
4207
  * the next set of recipes (if they exist).</p>
3690
4208
  */
3691
4209
  nextToken?: string;
3692
4210
  /**
4211
+ * @public
3693
4212
  * <p>The maximum number of recipes to return.</p>
3694
4213
  */
3695
4214
  maxResults?: number;
3696
4215
  /**
4216
+ * @public
3697
4217
  * <p>
3698
4218
  * Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases)
3699
4219
  * for this domain are included in the response. If you don't specify a domain, all recipes are returned.
@@ -3708,26 +4228,32 @@ export interface ListRecipesRequest {
3708
4228
  */
3709
4229
  export interface RecipeSummary {
3710
4230
  /**
4231
+ * @public
3711
4232
  * <p>The name of the recipe.</p>
3712
4233
  */
3713
4234
  name?: string;
3714
4235
  /**
4236
+ * @public
3715
4237
  * <p>The Amazon Resource Name (ARN) of the recipe.</p>
3716
4238
  */
3717
4239
  recipeArn?: string;
3718
4240
  /**
4241
+ * @public
3719
4242
  * <p>The status of the recipe.</p>
3720
4243
  */
3721
4244
  status?: string;
3722
4245
  /**
4246
+ * @public
3723
4247
  * <p>The date and time (in Unix time) that the recipe was created.</p>
3724
4248
  */
3725
4249
  creationDateTime?: Date;
3726
4250
  /**
4251
+ * @public
3727
4252
  * <p>The date and time (in Unix time) that the recipe was last updated.</p>
3728
4253
  */
3729
4254
  lastUpdatedDateTime?: Date;
3730
4255
  /**
4256
+ * @public
3731
4257
  * <p>The domain of the recipe (if the recipe is a Domain dataset group use case).</p>
3732
4258
  */
3733
4259
  domain?: Domain | string;
@@ -3737,10 +4263,12 @@ export interface RecipeSummary {
3737
4263
  */
3738
4264
  export interface ListRecipesResponse {
3739
4265
  /**
4266
+ * @public
3740
4267
  * <p>The list of available recipes.</p>
3741
4268
  */
3742
4269
  recipes?: RecipeSummary[];
3743
4270
  /**
4271
+ * @public
3744
4272
  * <p>A token for getting the next set of recipes.</p>
3745
4273
  */
3746
4274
  nextToken?: string;
@@ -3750,16 +4278,19 @@ export interface ListRecipesResponse {
3750
4278
  */
3751
4279
  export interface ListRecommendersRequest {
3752
4280
  /**
4281
+ * @public
3753
4282
  * <p>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When
3754
4283
  * a Domain dataset group is not specified, all the recommenders associated with the account are listed.</p>
3755
4284
  */
3756
4285
  datasetGroupArn?: string;
3757
4286
  /**
4287
+ * @public
3758
4288
  * <p>A token returned from the previous call to <code>ListRecommenders</code> for getting
3759
4289
  * the next set of recommenders (if they exist).</p>
3760
4290
  */
3761
4291
  nextToken?: string;
3762
4292
  /**
4293
+ * @public
3763
4294
  * <p>The maximum number of recommenders to return.</p>
3764
4295
  */
3765
4296
  maxResults?: number;
@@ -3770,26 +4301,32 @@ export interface ListRecommendersRequest {
3770
4301
  */
3771
4302
  export interface RecommenderSummary {
3772
4303
  /**
4304
+ * @public
3773
4305
  * <p>The name of the recommender.</p>
3774
4306
  */
3775
4307
  name?: string;
3776
4308
  /**
4309
+ * @public
3777
4310
  * <p>The Amazon Resource Name (ARN) of the recommender.</p>
3778
4311
  */
3779
4312
  recommenderArn?: string;
3780
4313
  /**
4314
+ * @public
3781
4315
  * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
3782
4316
  */
3783
4317
  datasetGroupArn?: string;
3784
4318
  /**
4319
+ * @public
3785
4320
  * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.</p>
3786
4321
  */
3787
4322
  recipeArn?: string;
3788
4323
  /**
4324
+ * @public
3789
4325
  * <p>The configuration details of the recommender.</p>
3790
4326
  */
3791
4327
  recommenderConfig?: RecommenderConfig;
3792
4328
  /**
4329
+ * @public
3793
4330
  * <p>The status of the recommender. A recommender can be in one of the following states:</p>
3794
4331
  * <ul>
3795
4332
  * <li>
@@ -3805,10 +4342,12 @@ export interface RecommenderSummary {
3805
4342
  */
3806
4343
  status?: string;
3807
4344
  /**
4345
+ * @public
3808
4346
  * <p>The date and time (in Unix format) that the recommender was created.</p>
3809
4347
  */
3810
4348
  creationDateTime?: Date;
3811
4349
  /**
4350
+ * @public
3812
4351
  * <p>The date and time (in Unix format) that the recommender was last updated.</p>
3813
4352
  */
3814
4353
  lastUpdatedDateTime?: Date;
@@ -3818,10 +4357,12 @@ export interface RecommenderSummary {
3818
4357
  */
3819
4358
  export interface ListRecommendersResponse {
3820
4359
  /**
4360
+ * @public
3821
4361
  * <p>A list of the recommenders.</p>
3822
4362
  */
3823
4363
  recommenders?: RecommenderSummary[];
3824
4364
  /**
4365
+ * @public
3825
4366
  * <p>A token for getting the next set of recommenders (if they exist).</p>
3826
4367
  */
3827
4368
  nextToken?: string;
@@ -3831,11 +4372,13 @@ export interface ListRecommendersResponse {
3831
4372
  */
3832
4373
  export interface ListSchemasRequest {
3833
4374
  /**
4375
+ * @public
3834
4376
  * <p>A token returned from the previous call to <code>ListSchemas</code> for getting
3835
4377
  * the next set of schemas (if they exist).</p>
3836
4378
  */
3837
4379
  nextToken?: string;
3838
4380
  /**
4381
+ * @public
3839
4382
  * <p>The maximum number of schemas to return.</p>
3840
4383
  */
3841
4384
  maxResults?: number;
@@ -3847,22 +4390,27 @@ export interface ListSchemasRequest {
3847
4390
  */
3848
4391
  export interface DatasetSchemaSummary {
3849
4392
  /**
4393
+ * @public
3850
4394
  * <p>The name of the schema.</p>
3851
4395
  */
3852
4396
  name?: string;
3853
4397
  /**
4398
+ * @public
3854
4399
  * <p>The Amazon Resource Name (ARN) of the schema.</p>
3855
4400
  */
3856
4401
  schemaArn?: string;
3857
4402
  /**
4403
+ * @public
3858
4404
  * <p>The date and time (in Unix time) that the schema was created.</p>
3859
4405
  */
3860
4406
  creationDateTime?: Date;
3861
4407
  /**
4408
+ * @public
3862
4409
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
3863
4410
  */
3864
4411
  lastUpdatedDateTime?: Date;
3865
4412
  /**
4413
+ * @public
3866
4414
  * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
3867
4415
  */
3868
4416
  domain?: Domain | string;
@@ -3872,10 +4420,12 @@ export interface DatasetSchemaSummary {
3872
4420
  */
3873
4421
  export interface ListSchemasResponse {
3874
4422
  /**
4423
+ * @public
3875
4424
  * <p>A list of schemas.</p>
3876
4425
  */
3877
4426
  schemas?: DatasetSchemaSummary[];
3878
4427
  /**
4428
+ * @public
3879
4429
  * <p>A token used to get the next set of schemas (if they exist).</p>
3880
4430
  */
3881
4431
  nextToken?: string;
@@ -3885,15 +4435,18 @@ export interface ListSchemasResponse {
3885
4435
  */
3886
4436
  export interface ListSolutionsRequest {
3887
4437
  /**
4438
+ * @public
3888
4439
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
3889
4440
  */
3890
4441
  datasetGroupArn?: string;
3891
4442
  /**
4443
+ * @public
3892
4444
  * <p>A token returned from the previous call to <code>ListSolutions</code> for getting
3893
4445
  * the next set of solutions (if they exist).</p>
3894
4446
  */
3895
4447
  nextToken?: string;
3896
4448
  /**
4449
+ * @public
3897
4450
  * <p>The maximum number of solutions to return.</p>
3898
4451
  */
3899
4452
  maxResults?: number;
@@ -3905,14 +4458,17 @@ export interface ListSolutionsRequest {
3905
4458
  */
3906
4459
  export interface SolutionSummary {
3907
4460
  /**
4461
+ * @public
3908
4462
  * <p>The name of the solution.</p>
3909
4463
  */
3910
4464
  name?: string;
3911
4465
  /**
4466
+ * @public
3912
4467
  * <p>The Amazon Resource Name (ARN) of the solution.</p>
3913
4468
  */
3914
4469
  solutionArn?: string;
3915
4470
  /**
4471
+ * @public
3916
4472
  * <p>The status of the solution.</p>
3917
4473
  * <p>A solution can be in one of the following states:</p>
3918
4474
  * <ul>
@@ -3926,14 +4482,17 @@ export interface SolutionSummary {
3926
4482
  */
3927
4483
  status?: string;
3928
4484
  /**
4485
+ * @public
3929
4486
  * <p>The date and time (in Unix time) that the solution was created.</p>
3930
4487
  */
3931
4488
  creationDateTime?: Date;
3932
4489
  /**
4490
+ * @public
3933
4491
  * <p>The date and time (in Unix time) that the solution was last updated.</p>
3934
4492
  */
3935
4493
  lastUpdatedDateTime?: Date;
3936
4494
  /**
4495
+ * @public
3937
4496
  * <p>The Amazon Resource Name (ARN) of the recipe used by the solution.</p>
3938
4497
  */
3939
4498
  recipeArn?: string;
@@ -3943,10 +4502,12 @@ export interface SolutionSummary {
3943
4502
  */
3944
4503
  export interface ListSolutionsResponse {
3945
4504
  /**
4505
+ * @public
3946
4506
  * <p>A list of the current solutions.</p>
3947
4507
  */
3948
4508
  solutions?: SolutionSummary[];
3949
4509
  /**
4510
+ * @public
3950
4511
  * <p>A token for getting the next set of solutions (if they exist).</p>
3951
4512
  */
3952
4513
  nextToken?: string;
@@ -3956,15 +4517,18 @@ export interface ListSolutionsResponse {
3956
4517
  */
3957
4518
  export interface ListSolutionVersionsRequest {
3958
4519
  /**
4520
+ * @public
3959
4521
  * <p>The Amazon Resource Name (ARN) of the solution.</p>
3960
4522
  */
3961
4523
  solutionArn?: string;
3962
4524
  /**
4525
+ * @public
3963
4526
  * <p>A token returned from the previous call to <code>ListSolutionVersions</code> for getting
3964
4527
  * the next set of solution versions (if they exist).</p>
3965
4528
  */
3966
4529
  nextToken?: string;
3967
4530
  /**
4531
+ * @public
3968
4532
  * <p>The maximum number of solution versions to return.</p>
3969
4533
  */
3970
4534
  maxResults?: number;
@@ -3974,10 +4538,12 @@ export interface ListSolutionVersionsRequest {
3974
4538
  */
3975
4539
  export interface ListSolutionVersionsResponse {
3976
4540
  /**
4541
+ * @public
3977
4542
  * <p>A list of solution versions describing the version properties.</p>
3978
4543
  */
3979
4544
  solutionVersions?: SolutionVersionSummary[];
3980
4545
  /**
4546
+ * @public
3981
4547
  * <p>A token for getting the next set of solution versions (if they exist).</p>
3982
4548
  */
3983
4549
  nextToken?: string;
@@ -3987,6 +4553,7 @@ export interface ListSolutionVersionsResponse {
3987
4553
  */
3988
4554
  export interface ListTagsForResourceRequest {
3989
4555
  /**
4556
+ * @public
3990
4557
  * <p>The resource's Amazon Resource Name.</p>
3991
4558
  */
3992
4559
  resourceArn: string | undefined;
@@ -3996,6 +4563,7 @@ export interface ListTagsForResourceRequest {
3996
4563
  */
3997
4564
  export interface ListTagsForResourceResponse {
3998
4565
  /**
4566
+ * @public
3999
4567
  * <p>The resource's tags.</p>
4000
4568
  */
4001
4569
  tags?: Tag[];
@@ -4005,6 +4573,7 @@ export interface ListTagsForResourceResponse {
4005
4573
  */
4006
4574
  export interface StartRecommenderRequest {
4007
4575
  /**
4576
+ * @public
4008
4577
  * <p>The Amazon Resource Name (ARN) of the recommender to start.</p>
4009
4578
  */
4010
4579
  recommenderArn: string | undefined;
@@ -4014,6 +4583,7 @@ export interface StartRecommenderRequest {
4014
4583
  */
4015
4584
  export interface StartRecommenderResponse {
4016
4585
  /**
4586
+ * @public
4017
4587
  * <p>The Amazon Resource Name (ARN) of the recommender you started.</p>
4018
4588
  */
4019
4589
  recommenderArn?: string;
@@ -4023,6 +4593,7 @@ export interface StartRecommenderResponse {
4023
4593
  */
4024
4594
  export interface StopRecommenderRequest {
4025
4595
  /**
4596
+ * @public
4026
4597
  * <p>The Amazon Resource Name (ARN) of the recommender to stop.</p>
4027
4598
  */
4028
4599
  recommenderArn: string | undefined;
@@ -4032,6 +4603,7 @@ export interface StopRecommenderRequest {
4032
4603
  */
4033
4604
  export interface StopRecommenderResponse {
4034
4605
  /**
4606
+ * @public
4035
4607
  * <p>The Amazon Resource Name (ARN) of the recommender you stopped.</p>
4036
4608
  */
4037
4609
  recommenderArn?: string;
@@ -4041,6 +4613,7 @@ export interface StopRecommenderResponse {
4041
4613
  */
4042
4614
  export interface StopSolutionVersionCreationRequest {
4043
4615
  /**
4616
+ * @public
4044
4617
  * <p>The Amazon Resource Name (ARN) of the solution version you want to stop creating.</p>
4045
4618
  */
4046
4619
  solutionVersionArn: string | undefined;
@@ -4050,10 +4623,12 @@ export interface StopSolutionVersionCreationRequest {
4050
4623
  */
4051
4624
  export interface TagResourceRequest {
4052
4625
  /**
4626
+ * @public
4053
4627
  * <p>The resource's Amazon Resource Name (ARN).</p>
4054
4628
  */
4055
4629
  resourceArn: string | undefined;
4056
4630
  /**
4631
+ * @public
4057
4632
  * <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>
4058
4633
  */
4059
4634
  tags: Tag[] | undefined;
@@ -4080,10 +4655,12 @@ export declare class TooManyTagKeysException extends __BaseException {
4080
4655
  */
4081
4656
  export interface UntagResourceRequest {
4082
4657
  /**
4658
+ * @public
4083
4659
  * <p>The resource's Amazon Resource Name (ARN).</p>
4084
4660
  */
4085
4661
  resourceArn: string | undefined;
4086
4662
  /**
4663
+ * @public
4087
4664
  * <p>Keys to remove from the resource's tags.</p>
4088
4665
  */
4089
4666
  tagKeys: string[] | undefined;
@@ -4098,14 +4675,17 @@ export interface UntagResourceResponse {
4098
4675
  */
4099
4676
  export interface UpdateCampaignRequest {
4100
4677
  /**
4678
+ * @public
4101
4679
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
4102
4680
  */
4103
4681
  campaignArn: string | undefined;
4104
4682
  /**
4683
+ * @public
4105
4684
  * <p>The ARN of a new solution version to deploy.</p>
4106
4685
  */
4107
4686
  solutionVersionArn?: string;
4108
4687
  /**
4688
+ * @public
4109
4689
  * <p>Specifies the requested minimum provisioned transactions (recommendations) per second that
4110
4690
  * Amazon Personalize will support. A high <code>minProvisionedTPS</code> will increase your bill. We recommend starting with 1 for <code>minProvisionedTPS</code> (the default). Track
4111
4691
  * your usage using Amazon CloudWatch metrics, and increase the <code>minProvisionedTPS</code>
@@ -4113,6 +4693,7 @@ export interface UpdateCampaignRequest {
4113
4693
  */
4114
4694
  minProvisionedTPS?: number;
4115
4695
  /**
4696
+ * @public
4116
4697
  * <p>The configuration details of a campaign.</p>
4117
4698
  */
4118
4699
  campaignConfig?: CampaignConfig;
@@ -4122,6 +4703,7 @@ export interface UpdateCampaignRequest {
4122
4703
  */
4123
4704
  export interface UpdateCampaignResponse {
4124
4705
  /**
4706
+ * @public
4125
4707
  * <p>The same campaign ARN as given in the request.</p>
4126
4708
  */
4127
4709
  campaignArn?: string;
@@ -4131,10 +4713,12 @@ export interface UpdateCampaignResponse {
4131
4713
  */
4132
4714
  export interface UpdateDatasetRequest {
4133
4715
  /**
4716
+ * @public
4134
4717
  * <p>The Amazon Resource Name (ARN) of the dataset that you want to update.</p>
4135
4718
  */
4136
4719
  datasetArn: string | undefined;
4137
4720
  /**
4721
+ * @public
4138
4722
  * <p>The Amazon Resource Name (ARN) of the new schema you want use.</p>
4139
4723
  */
4140
4724
  schemaArn: string | undefined;
@@ -4144,6 +4728,7 @@ export interface UpdateDatasetRequest {
4144
4728
  */
4145
4729
  export interface UpdateDatasetResponse {
4146
4730
  /**
4731
+ * @public
4147
4732
  * <p>The Amazon Resource Name (ARN) of the dataset you updated.</p>
4148
4733
  */
4149
4734
  datasetArn?: string;
@@ -4153,18 +4738,22 @@ export interface UpdateDatasetResponse {
4153
4738
  */
4154
4739
  export interface UpdateMetricAttributionRequest {
4155
4740
  /**
4741
+ * @public
4156
4742
  * <p>Add new metric attributes to the metric attribution.</p>
4157
4743
  */
4158
4744
  addMetrics?: MetricAttribute[];
4159
4745
  /**
4746
+ * @public
4160
4747
  * <p>Remove metric attributes from the metric attribution.</p>
4161
4748
  */
4162
4749
  removeMetrics?: string[];
4163
4750
  /**
4751
+ * @public
4164
4752
  * <p>An output config for the metric attribution.</p>
4165
4753
  */
4166
4754
  metricsOutputConfig?: MetricAttributionOutput;
4167
4755
  /**
4756
+ * @public
4168
4757
  * <p>The Amazon Resource Name (ARN) for the metric attribution to update.</p>
4169
4758
  */
4170
4759
  metricAttributionArn?: string;
@@ -4174,6 +4763,7 @@ export interface UpdateMetricAttributionRequest {
4174
4763
  */
4175
4764
  export interface UpdateMetricAttributionResponse {
4176
4765
  /**
4766
+ * @public
4177
4767
  * <p>The Amazon Resource Name (ARN) for the metric attribution that you updated.</p>
4178
4768
  */
4179
4769
  metricAttributionArn?: string;
@@ -4183,10 +4773,12 @@ export interface UpdateMetricAttributionResponse {
4183
4773
  */
4184
4774
  export interface UpdateRecommenderRequest {
4185
4775
  /**
4776
+ * @public
4186
4777
  * <p>The Amazon Resource Name (ARN) of the recommender to modify.</p>
4187
4778
  */
4188
4779
  recommenderArn: string | undefined;
4189
4780
  /**
4781
+ * @public
4190
4782
  * <p>The configuration details of the recommender.</p>
4191
4783
  */
4192
4784
  recommenderConfig: RecommenderConfig | undefined;
@@ -4196,6 +4788,7 @@ export interface UpdateRecommenderRequest {
4196
4788
  */
4197
4789
  export interface UpdateRecommenderResponse {
4198
4790
  /**
4791
+ * @public
4199
4792
  * <p>The same recommender Amazon Resource Name (ARN) as given in the request.</p>
4200
4793
  */
4201
4794
  recommenderArn?: string;