@aws-sdk/client-personalize 3.295.0 → 3.297.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.
Files changed (88) hide show
  1. package/dist-types/Personalize.d.ts +67 -0
  2. package/dist-types/PersonalizeClient.d.ts +24 -4
  3. package/dist-types/commands/CreateBatchInferenceJobCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateCampaignCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +16 -0
  10. package/dist-types/commands/CreateEventTrackerCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateFilterCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateMetricAttributionCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateRecommenderCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateSchemaCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateSolutionCommand.d.ts +16 -0
  16. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteCampaignCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteEventTrackerCommand.d.ts +16 -0
  21. package/dist-types/commands/DeleteFilterCommand.d.ts +16 -0
  22. package/dist-types/commands/DeleteMetricAttributionCommand.d.ts +16 -0
  23. package/dist-types/commands/DeleteRecommenderCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteSchemaCommand.d.ts +16 -0
  25. package/dist-types/commands/DeleteSolutionCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeAlgorithmCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeBatchInferenceJobCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeCampaignCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeEventTrackerCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeFeatureTransformationCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeFilterCommand.d.ts +16 -0
  37. package/dist-types/commands/DescribeMetricAttributionCommand.d.ts +16 -0
  38. package/dist-types/commands/DescribeRecipeCommand.d.ts +16 -0
  39. package/dist-types/commands/DescribeRecommenderCommand.d.ts +16 -0
  40. package/dist-types/commands/DescribeSchemaCommand.d.ts +16 -0
  41. package/dist-types/commands/DescribeSolutionCommand.d.ts +16 -0
  42. package/dist-types/commands/DescribeSolutionVersionCommand.d.ts +16 -0
  43. package/dist-types/commands/GetSolutionMetricsCommand.d.ts +16 -0
  44. package/dist-types/commands/ListBatchInferenceJobsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListCampaignsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDatasetGroupsCommand.d.ts +16 -0
  49. package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListEventTrackersCommand.d.ts +16 -0
  52. package/dist-types/commands/ListFiltersCommand.d.ts +16 -0
  53. package/dist-types/commands/ListMetricAttributionMetricsCommand.d.ts +16 -0
  54. package/dist-types/commands/ListMetricAttributionsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListRecipesCommand.d.ts +16 -0
  56. package/dist-types/commands/ListRecommendersCommand.d.ts +16 -0
  57. package/dist-types/commands/ListSchemasCommand.d.ts +16 -0
  58. package/dist-types/commands/ListSolutionVersionsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListSolutionsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  61. package/dist-types/commands/StartRecommenderCommand.d.ts +16 -0
  62. package/dist-types/commands/StopRecommenderCommand.d.ts +16 -0
  63. package/dist-types/commands/StopSolutionVersionCreationCommand.d.ts +16 -0
  64. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  65. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  66. package/dist-types/commands/UpdateCampaignCommand.d.ts +16 -0
  67. package/dist-types/commands/UpdateMetricAttributionCommand.d.ts +16 -0
  68. package/dist-types/commands/UpdateRecommenderCommand.d.ts +16 -0
  69. package/dist-types/models/PersonalizeServiceException.d.ts +2 -0
  70. package/dist-types/models/models_0.d.ts +456 -0
  71. package/dist-types/pagination/Interfaces.d.ts +3 -0
  72. package/dist-types/pagination/ListBatchInferenceJobsPaginator.d.ts +3 -0
  73. package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +3 -0
  74. package/dist-types/pagination/ListCampaignsPaginator.d.ts +3 -0
  75. package/dist-types/pagination/ListDatasetExportJobsPaginator.d.ts +3 -0
  76. package/dist-types/pagination/ListDatasetGroupsPaginator.d.ts +3 -0
  77. package/dist-types/pagination/ListDatasetImportJobsPaginator.d.ts +3 -0
  78. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  79. package/dist-types/pagination/ListEventTrackersPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListFiltersPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListMetricAttributionMetricsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListMetricAttributionsPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListRecipesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListRecommendersPaginator.d.ts +3 -0
  85. package/dist-types/pagination/ListSchemasPaginator.d.ts +3 -0
  86. package/dist-types/pagination/ListSolutionVersionsPaginator.d.ts +3 -0
  87. package/dist-types/pagination/ListSolutionsPaginator.d.ts +3 -0
  88. package/package.json +29 -29
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { PersonalizeServiceException as __BaseException } from "./PersonalizeServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Describes an algorithm image.</p>
5
6
  */
6
7
  export interface AlgorithmImage {
@@ -14,6 +15,7 @@ export interface AlgorithmImage {
14
15
  dockerURI: string | undefined;
15
16
  }
16
17
  /**
18
+ * @public
17
19
  * <p>Provides the name and default range of a categorical hyperparameter
18
20
  * and whether the hyperparameter is tunable. A tunable hyperparameter can
19
21
  * have its value determined during hyperparameter optimization (HPO).</p>
@@ -33,6 +35,7 @@ export interface DefaultCategoricalHyperParameterRange {
33
35
  isTunable?: boolean;
34
36
  }
35
37
  /**
38
+ * @public
36
39
  * <p>Provides the name and default range of a continuous hyperparameter
37
40
  * and whether the hyperparameter is tunable. A tunable hyperparameter can
38
41
  * have its value determined during hyperparameter optimization (HPO).</p>
@@ -56,6 +59,7 @@ export interface DefaultContinuousHyperParameterRange {
56
59
  isTunable?: boolean;
57
60
  }
58
61
  /**
62
+ * @public
59
63
  * <p>Provides the name and default range of a integer-valued hyperparameter
60
64
  * and whether the hyperparameter is tunable. A tunable hyperparameter can
61
65
  * have its value determined during hyperparameter optimization (HPO).</p>
@@ -79,6 +83,7 @@ export interface DefaultIntegerHyperParameterRange {
79
83
  isTunable?: boolean;
80
84
  }
81
85
  /**
86
+ * @public
82
87
  * <p>Specifies the hyperparameters and their default ranges.
83
88
  * Hyperparameters can be categorical, continuous, or integer-valued.</p>
84
89
  */
@@ -97,6 +102,7 @@ export interface DefaultHyperParameterRanges {
97
102
  categoricalHyperParameterRanges?: DefaultCategoricalHyperParameterRange[];
98
103
  }
99
104
  /**
105
+ * @public
100
106
  * <p>Describes a custom algorithm.</p>
101
107
  */
102
108
  export interface Algorithm {
@@ -144,6 +150,7 @@ export interface Algorithm {
144
150
  lastUpdatedDateTime?: Date;
145
151
  }
146
152
  /**
153
+ * @public
147
154
  * <p>The configuration details of a batch inference job.</p>
148
155
  */
149
156
  export interface BatchInferenceJobConfig {
@@ -156,6 +163,7 @@ export interface BatchInferenceJobConfig {
156
163
  itemExplorationConfig?: Record<string, string>;
157
164
  }
158
165
  /**
166
+ * @public
159
167
  * <p>The configuration details of an Amazon S3 input or output bucket.</p>
160
168
  */
161
169
  export interface S3DataConfig {
@@ -170,6 +178,7 @@ export interface S3DataConfig {
170
178
  kmsKeyArn?: string;
171
179
  }
172
180
  /**
181
+ * @public
173
182
  * <p>The input configuration of a batch inference job.</p>
174
183
  */
175
184
  export interface BatchInferenceJobInput {
@@ -180,6 +189,7 @@ export interface BatchInferenceJobInput {
180
189
  s3DataSource: S3DataConfig | undefined;
181
190
  }
182
191
  /**
192
+ * @public
183
193
  * <p>The output configuration parameters of a batch inference job.</p>
184
194
  */
185
195
  export interface BatchInferenceJobOutput {
@@ -189,6 +199,7 @@ export interface BatchInferenceJobOutput {
189
199
  s3DataDestination: S3DataConfig | undefined;
190
200
  }
191
201
  /**
202
+ * @public
192
203
  * <p>The optional metadata that you apply to resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
193
204
  * For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">Tagging Personalize resources</a>.
194
205
  * </p>
@@ -203,6 +214,9 @@ export interface Tag {
203
214
  */
204
215
  tagValue: string | undefined;
205
216
  }
217
+ /**
218
+ * @public
219
+ */
206
220
  export interface CreateBatchInferenceJobRequest {
207
221
  /**
208
222
  * <p>The name of the batch inference job to create.</p>
@@ -246,6 +260,9 @@ export interface CreateBatchInferenceJobRequest {
246
260
  */
247
261
  tags?: Tag[];
248
262
  }
263
+ /**
264
+ * @public
265
+ */
249
266
  export interface CreateBatchInferenceJobResponse {
250
267
  /**
251
268
  * <p>The ARN of the batch inference job.</p>
@@ -253,6 +270,7 @@ export interface CreateBatchInferenceJobResponse {
253
270
  batchInferenceJobArn?: string;
254
271
  }
255
272
  /**
273
+ * @public
256
274
  * <p>Provide a valid value for the field or parameter.</p>
257
275
  */
258
276
  export declare class InvalidInputException extends __BaseException {
@@ -264,6 +282,7 @@ export declare class InvalidInputException extends __BaseException {
264
282
  constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
265
283
  }
266
284
  /**
285
+ * @public
267
286
  * <p>The limit on the number of requests per second has been exceeded.</p>
268
287
  */
269
288
  export declare class LimitExceededException extends __BaseException {
@@ -275,6 +294,7 @@ export declare class LimitExceededException extends __BaseException {
275
294
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
276
295
  }
277
296
  /**
297
+ * @public
278
298
  * <p>The specified resource already exists.</p>
279
299
  */
280
300
  export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -286,6 +306,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
286
306
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
287
307
  }
288
308
  /**
309
+ * @public
289
310
  * <p>The specified resource is in use.</p>
290
311
  */
291
312
  export declare class ResourceInUseException extends __BaseException {
@@ -297,6 +318,7 @@ export declare class ResourceInUseException extends __BaseException {
297
318
  constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
298
319
  }
299
320
  /**
321
+ * @public
300
322
  * <p>Could not find the specified resource.</p>
301
323
  */
302
324
  export declare class ResourceNotFoundException extends __BaseException {
@@ -308,6 +330,7 @@ export declare class ResourceNotFoundException extends __BaseException {
308
330
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
309
331
  }
310
332
  /**
333
+ * @public
311
334
  * <p>You have exceeded the maximum number of tags you can apply to this resource. </p>
312
335
  */
313
336
  export declare class TooManyTagsException extends __BaseException {
@@ -319,6 +342,7 @@ export declare class TooManyTagsException extends __BaseException {
319
342
  constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
320
343
  }
321
344
  /**
345
+ * @public
322
346
  * <p>The input configuration of a batch segment job.</p>
323
347
  */
324
348
  export interface BatchSegmentJobInput {
@@ -328,6 +352,7 @@ export interface BatchSegmentJobInput {
328
352
  s3DataSource: S3DataConfig | undefined;
329
353
  }
330
354
  /**
355
+ * @public
331
356
  * <p>The output configuration parameters of a batch segment job.</p>
332
357
  */
333
358
  export interface BatchSegmentJobOutput {
@@ -336,6 +361,9 @@ export interface BatchSegmentJobOutput {
336
361
  */
337
362
  s3DataDestination: S3DataConfig | undefined;
338
363
  }
364
+ /**
365
+ * @public
366
+ */
339
367
  export interface CreateBatchSegmentJobRequest {
340
368
  /**
341
369
  * <p>The name of the batch segment job to create.</p>
@@ -373,6 +401,9 @@ export interface CreateBatchSegmentJobRequest {
373
401
  */
374
402
  tags?: Tag[];
375
403
  }
404
+ /**
405
+ * @public
406
+ */
376
407
  export interface CreateBatchSegmentJobResponse {
377
408
  /**
378
409
  * <p>The ARN of the batch segment job.</p>
@@ -380,6 +411,7 @@ export interface CreateBatchSegmentJobResponse {
380
411
  batchSegmentJobArn?: string;
381
412
  }
382
413
  /**
414
+ * @public
383
415
  * <p>The configuration details of a campaign.</p>
384
416
  */
385
417
  export interface CampaignConfig {
@@ -391,6 +423,9 @@ export interface CampaignConfig {
391
423
  */
392
424
  itemExplorationConfig?: Record<string, string>;
393
425
  }
426
+ /**
427
+ * @public
428
+ */
394
429
  export interface CreateCampaignRequest {
395
430
  /**
396
431
  * <p>A name for the new campaign. The campaign name must be unique within your account.</p>
@@ -414,12 +449,18 @@ export interface CreateCampaignRequest {
414
449
  */
415
450
  tags?: Tag[];
416
451
  }
452
+ /**
453
+ * @public
454
+ */
417
455
  export interface CreateCampaignResponse {
418
456
  /**
419
457
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
420
458
  */
421
459
  campaignArn?: string;
422
460
  }
461
+ /**
462
+ * @public
463
+ */
423
464
  export interface CreateDatasetRequest {
424
465
  /**
425
466
  * <p>The name for the dataset.</p>
@@ -456,18 +497,25 @@ export interface CreateDatasetRequest {
456
497
  */
457
498
  tags?: Tag[];
458
499
  }
500
+ /**
501
+ * @public
502
+ */
459
503
  export interface CreateDatasetResponse {
460
504
  /**
461
505
  * <p>The ARN of the dataset.</p>
462
506
  */
463
507
  datasetArn?: string;
464
508
  }
509
+ /**
510
+ * @public
511
+ */
465
512
  export declare enum IngestionMode {
466
513
  ALL = "ALL",
467
514
  BULK = "BULK",
468
515
  PUT = "PUT"
469
516
  }
470
517
  /**
518
+ * @public
471
519
  * <p>The output configuration parameters of a dataset export job.</p>
472
520
  */
473
521
  export interface DatasetExportJobOutput {
@@ -476,6 +524,9 @@ export interface DatasetExportJobOutput {
476
524
  */
477
525
  s3DataDestination: S3DataConfig | undefined;
478
526
  }
527
+ /**
528
+ * @public
529
+ */
479
530
  export interface CreateDatasetExportJobRequest {
480
531
  /**
481
532
  * <p>The name for the dataset export job.</p>
@@ -509,16 +560,25 @@ export interface CreateDatasetExportJobRequest {
509
560
  */
510
561
  tags?: Tag[];
511
562
  }
563
+ /**
564
+ * @public
565
+ */
512
566
  export interface CreateDatasetExportJobResponse {
513
567
  /**
514
568
  * <p>The Amazon Resource Name (ARN) of the dataset export job.</p>
515
569
  */
516
570
  datasetExportJobArn?: string;
517
571
  }
572
+ /**
573
+ * @public
574
+ */
518
575
  export declare enum Domain {
519
576
  ECOMMERCE = "ECOMMERCE",
520
577
  VIDEO_ON_DEMAND = "VIDEO_ON_DEMAND"
521
578
  }
579
+ /**
580
+ * @public
581
+ */
522
582
  export interface CreateDatasetGroupRequest {
523
583
  /**
524
584
  * <p>The name for the new dataset group.</p>
@@ -548,6 +608,9 @@ export interface CreateDatasetGroupRequest {
548
608
  */
549
609
  tags?: Tag[];
550
610
  }
611
+ /**
612
+ * @public
613
+ */
551
614
  export interface CreateDatasetGroupResponse {
552
615
  /**
553
616
  * <p>The Amazon Resource Name (ARN) of the new dataset group.</p>
@@ -559,6 +622,7 @@ export interface CreateDatasetGroupResponse {
559
622
  domain?: Domain | string;
560
623
  }
561
624
  /**
625
+ * @public
562
626
  * <p>Describes the data source that contains the data to upload to a
563
627
  * dataset.</p>
564
628
  */
@@ -572,10 +636,16 @@ export interface DataSource {
572
636
  */
573
637
  dataLocation?: string;
574
638
  }
639
+ /**
640
+ * @public
641
+ */
575
642
  export declare enum ImportMode {
576
643
  FULL = "FULL",
577
644
  INCREMENTAL = "INCREMENTAL"
578
645
  }
646
+ /**
647
+ * @public
648
+ */
579
649
  export interface CreateDatasetImportJobRequest {
580
650
  /**
581
651
  * <p>The name for the dataset import job.</p>
@@ -620,12 +690,18 @@ export interface CreateDatasetImportJobRequest {
620
690
  */
621
691
  publishAttributionMetricsToS3?: boolean;
622
692
  }
693
+ /**
694
+ * @public
695
+ */
623
696
  export interface CreateDatasetImportJobResponse {
624
697
  /**
625
698
  * <p>The ARN of the dataset import job.</p>
626
699
  */
627
700
  datasetImportJobArn?: string;
628
701
  }
702
+ /**
703
+ * @public
704
+ */
629
705
  export interface CreateEventTrackerRequest {
630
706
  /**
631
707
  * <p>The name for the event tracker.</p>
@@ -640,6 +716,9 @@ export interface CreateEventTrackerRequest {
640
716
  */
641
717
  tags?: Tag[];
642
718
  }
719
+ /**
720
+ * @public
721
+ */
643
722
  export interface CreateEventTrackerResponse {
644
723
  /**
645
724
  * <p>The ARN of the event tracker.</p>
@@ -651,6 +730,9 @@ export interface CreateEventTrackerResponse {
651
730
  */
652
731
  trackingId?: string;
653
732
  }
733
+ /**
734
+ * @public
735
+ */
654
736
  export interface CreateFilterRequest {
655
737
  /**
656
738
  * <p>The name of the filter to create.</p>
@@ -671,6 +753,9 @@ export interface CreateFilterRequest {
671
753
  */
672
754
  tags?: Tag[];
673
755
  }
756
+ /**
757
+ * @public
758
+ */
674
759
  export interface CreateFilterResponse {
675
760
  /**
676
761
  * <p>The ARN of the new filter.</p>
@@ -678,6 +763,7 @@ export interface CreateFilterResponse {
678
763
  filterArn?: string;
679
764
  }
680
765
  /**
766
+ * @public
681
767
  * <p>Contains information on a metric that a metric attribution reports on. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
682
768
  */
683
769
  export interface MetricAttribute {
@@ -696,6 +782,7 @@ export interface MetricAttribute {
696
782
  expression: string | undefined;
697
783
  }
698
784
  /**
785
+ * @public
699
786
  * <p>The output configuration details for a metric attribution.</p>
700
787
  */
701
788
  export interface MetricAttributionOutput {
@@ -708,6 +795,9 @@ export interface MetricAttributionOutput {
708
795
  */
709
796
  roleArn: string | undefined;
710
797
  }
798
+ /**
799
+ * @public
800
+ */
711
801
  export interface CreateMetricAttributionRequest {
712
802
  /**
713
803
  * <p>A name for the metric attribution.</p>
@@ -728,6 +818,9 @@ export interface CreateMetricAttributionRequest {
728
818
  */
729
819
  metricsOutputConfig: MetricAttributionOutput | undefined;
730
820
  }
821
+ /**
822
+ * @public
823
+ */
731
824
  export interface CreateMetricAttributionResponse {
732
825
  /**
733
826
  * <p>The Amazon Resource Name (ARN) for the new metric attribution.</p>
@@ -735,6 +828,7 @@ export interface CreateMetricAttributionResponse {
735
828
  metricAttributionArn?: string;
736
829
  }
737
830
  /**
831
+ * @public
738
832
  * <p>The configuration details of the recommender.</p>
739
833
  */
740
834
  export interface RecommenderConfig {
@@ -751,6 +845,9 @@ export interface RecommenderConfig {
751
845
  */
752
846
  minRecommendationRequestsPerSecond?: number;
753
847
  }
848
+ /**
849
+ * @public
850
+ */
754
851
  export interface CreateRecommenderRequest {
755
852
  /**
756
853
  * <p>The name of the recommender.</p>
@@ -775,12 +872,18 @@ export interface CreateRecommenderRequest {
775
872
  */
776
873
  tags?: Tag[];
777
874
  }
875
+ /**
876
+ * @public
877
+ */
778
878
  export interface CreateRecommenderResponse {
779
879
  /**
780
880
  * <p>The Amazon Resource Name (ARN) of the recommender.</p>
781
881
  */
782
882
  recommenderArn?: string;
783
883
  }
884
+ /**
885
+ * @public
886
+ */
784
887
  export interface CreateSchemaRequest {
785
888
  /**
786
889
  * <p>The name for the schema.</p>
@@ -796,6 +899,9 @@ export interface CreateSchemaRequest {
796
899
  */
797
900
  domain?: Domain | string;
798
901
  }
902
+ /**
903
+ * @public
904
+ */
799
905
  export interface CreateSchemaResponse {
800
906
  /**
801
907
  * <p>The Amazon Resource Name (ARN) of the created schema.</p>
@@ -803,6 +909,7 @@ export interface CreateSchemaResponse {
803
909
  schemaArn?: string;
804
910
  }
805
911
  /**
912
+ * @public
806
913
  * <p>When the solution performs AutoML (<code>performAutoML</code> is true in
807
914
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>), Amazon Personalize
808
915
  * determines which recipe, from the specified list, optimizes the given metric.
@@ -819,6 +926,7 @@ export interface AutoMLConfig {
819
926
  recipeList?: string[];
820
927
  }
821
928
  /**
929
+ * @public
822
930
  * <p>Provides the name and range of a categorical hyperparameter.</p>
823
931
  */
824
932
  export interface CategoricalHyperParameterRange {
@@ -832,6 +940,7 @@ export interface CategoricalHyperParameterRange {
832
940
  values?: string[];
833
941
  }
834
942
  /**
943
+ * @public
835
944
  * <p>Provides the name and range of a continuous hyperparameter.</p>
836
945
  */
837
946
  export interface ContinuousHyperParameterRange {
@@ -849,6 +958,7 @@ export interface ContinuousHyperParameterRange {
849
958
  maxValue?: number;
850
959
  }
851
960
  /**
961
+ * @public
852
962
  * <p>Provides the name and range of an integer-valued hyperparameter.</p>
853
963
  */
854
964
  export interface IntegerHyperParameterRange {
@@ -866,6 +976,7 @@ export interface IntegerHyperParameterRange {
866
976
  maxValue?: number;
867
977
  }
868
978
  /**
979
+ * @public
869
980
  * <p>Specifies the hyperparameters and their ranges.
870
981
  * Hyperparameters can be categorical, continuous, or integer-valued.</p>
871
982
  */
@@ -884,6 +995,7 @@ export interface HyperParameterRanges {
884
995
  categoricalHyperParameterRanges?: CategoricalHyperParameterRange[];
885
996
  }
886
997
  /**
998
+ * @public
887
999
  * <p>The metric to optimize during hyperparameter optimization (HPO).</p>
888
1000
  * <note>
889
1001
  * <p>Amazon Personalize doesn't support configuring the <code>hpoObjective</code>
@@ -905,6 +1017,7 @@ export interface HPOObjective {
905
1017
  metricRegex?: string;
906
1018
  }
907
1019
  /**
1020
+ * @public
908
1021
  * <p>Describes the resource configuration for hyperparameter optimization (HPO).</p>
909
1022
  */
910
1023
  export interface HPOResourceConfig {
@@ -928,6 +1041,7 @@ export interface HPOResourceConfig {
928
1041
  maxParallelTrainingJobs?: string;
929
1042
  }
930
1043
  /**
1044
+ * @public
931
1045
  * <p>Describes the properties for hyperparameter optimization (HPO).</p>
932
1046
  */
933
1047
  export interface HPOConfig {
@@ -948,6 +1062,9 @@ export interface HPOConfig {
948
1062
  */
949
1063
  algorithmHyperParameterRanges?: HyperParameterRanges;
950
1064
  }
1065
+ /**
1066
+ * @public
1067
+ */
951
1068
  export declare enum ObjectiveSensitivity {
952
1069
  HIGH = "HIGH",
953
1070
  LOW = "LOW",
@@ -955,6 +1072,7 @@ export declare enum ObjectiveSensitivity {
955
1072
  OFF = "OFF"
956
1073
  }
957
1074
  /**
1075
+ * @public
958
1076
  * <p>Describes the additional objective for the solution, such as maximizing streaming
959
1077
  * 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>
960
1078
  */
@@ -969,6 +1087,7 @@ export interface OptimizationObjective {
969
1087
  objectiveSensitivity?: ObjectiveSensitivity | string;
970
1088
  }
971
1089
  /**
1090
+ * @public
972
1091
  * <p>Describes the configuration properties for the solution.</p>
973
1092
  */
974
1093
  export interface SolutionConfig {
@@ -1000,6 +1119,9 @@ export interface SolutionConfig {
1000
1119
  */
1001
1120
  optimizationObjective?: OptimizationObjective;
1002
1121
  }
1122
+ /**
1123
+ * @public
1124
+ */
1003
1125
  export interface CreateSolutionRequest {
1004
1126
  /**
1005
1127
  * <p>The name for the solution.</p>
@@ -1054,16 +1176,25 @@ export interface CreateSolutionRequest {
1054
1176
  */
1055
1177
  tags?: Tag[];
1056
1178
  }
1179
+ /**
1180
+ * @public
1181
+ */
1057
1182
  export interface CreateSolutionResponse {
1058
1183
  /**
1059
1184
  * <p>The ARN of the solution.</p>
1060
1185
  */
1061
1186
  solutionArn?: string;
1062
1187
  }
1188
+ /**
1189
+ * @public
1190
+ */
1063
1191
  export declare enum TrainingMode {
1064
1192
  FULL = "FULL",
1065
1193
  UPDATE = "UPDATE"
1066
1194
  }
1195
+ /**
1196
+ * @public
1197
+ */
1067
1198
  export interface CreateSolutionVersionRequest {
1068
1199
  /**
1069
1200
  * <p>The name of the solution version.</p>
@@ -1095,78 +1226,117 @@ export interface CreateSolutionVersionRequest {
1095
1226
  */
1096
1227
  tags?: Tag[];
1097
1228
  }
1229
+ /**
1230
+ * @public
1231
+ */
1098
1232
  export interface CreateSolutionVersionResponse {
1099
1233
  /**
1100
1234
  * <p>The ARN of the new solution version.</p>
1101
1235
  */
1102
1236
  solutionVersionArn?: string;
1103
1237
  }
1238
+ /**
1239
+ * @public
1240
+ */
1104
1241
  export interface DeleteCampaignRequest {
1105
1242
  /**
1106
1243
  * <p>The Amazon Resource Name (ARN) of the campaign to delete.</p>
1107
1244
  */
1108
1245
  campaignArn: string | undefined;
1109
1246
  }
1247
+ /**
1248
+ * @public
1249
+ */
1110
1250
  export interface DeleteDatasetRequest {
1111
1251
  /**
1112
1252
  * <p>The Amazon Resource Name (ARN) of the dataset to delete.</p>
1113
1253
  */
1114
1254
  datasetArn: string | undefined;
1115
1255
  }
1256
+ /**
1257
+ * @public
1258
+ */
1116
1259
  export interface DeleteDatasetGroupRequest {
1117
1260
  /**
1118
1261
  * <p>The ARN of the dataset group to delete.</p>
1119
1262
  */
1120
1263
  datasetGroupArn: string | undefined;
1121
1264
  }
1265
+ /**
1266
+ * @public
1267
+ */
1122
1268
  export interface DeleteEventTrackerRequest {
1123
1269
  /**
1124
1270
  * <p>The Amazon Resource Name (ARN) of the event tracker to delete.</p>
1125
1271
  */
1126
1272
  eventTrackerArn: string | undefined;
1127
1273
  }
1274
+ /**
1275
+ * @public
1276
+ */
1128
1277
  export interface DeleteFilterRequest {
1129
1278
  /**
1130
1279
  * <p>The ARN of the filter to delete.</p>
1131
1280
  */
1132
1281
  filterArn: string | undefined;
1133
1282
  }
1283
+ /**
1284
+ * @public
1285
+ */
1134
1286
  export interface DeleteMetricAttributionRequest {
1135
1287
  /**
1136
1288
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
1137
1289
  */
1138
1290
  metricAttributionArn: string | undefined;
1139
1291
  }
1292
+ /**
1293
+ * @public
1294
+ */
1140
1295
  export interface DeleteRecommenderRequest {
1141
1296
  /**
1142
1297
  * <p>The Amazon Resource Name (ARN) of the recommender to delete.</p>
1143
1298
  */
1144
1299
  recommenderArn: string | undefined;
1145
1300
  }
1301
+ /**
1302
+ * @public
1303
+ */
1146
1304
  export interface DeleteSchemaRequest {
1147
1305
  /**
1148
1306
  * <p>The Amazon Resource Name (ARN) of the schema to delete.</p>
1149
1307
  */
1150
1308
  schemaArn: string | undefined;
1151
1309
  }
1310
+ /**
1311
+ * @public
1312
+ */
1152
1313
  export interface DeleteSolutionRequest {
1153
1314
  /**
1154
1315
  * <p>The ARN of the solution to delete.</p>
1155
1316
  */
1156
1317
  solutionArn: string | undefined;
1157
1318
  }
1319
+ /**
1320
+ * @public
1321
+ */
1158
1322
  export interface DescribeAlgorithmRequest {
1159
1323
  /**
1160
1324
  * <p>The Amazon Resource Name (ARN) of the algorithm to describe.</p>
1161
1325
  */
1162
1326
  algorithmArn: string | undefined;
1163
1327
  }
1328
+ /**
1329
+ * @public
1330
+ */
1164
1331
  export interface DescribeAlgorithmResponse {
1165
1332
  /**
1166
1333
  * <p>A listing of the properties of the algorithm.</p>
1167
1334
  */
1168
1335
  algorithm?: Algorithm;
1169
1336
  }
1337
+ /**
1338
+ * @public
1339
+ */
1170
1340
  export interface DescribeBatchInferenceJobRequest {
1171
1341
  /**
1172
1342
  * <p>The ARN of the batch inference job to describe.</p>
@@ -1174,6 +1344,7 @@ export interface DescribeBatchInferenceJobRequest {
1174
1344
  batchInferenceJobArn: string | undefined;
1175
1345
  }
1176
1346
  /**
1347
+ * @public
1177
1348
  * <p>Contains information on a batch inference job.</p>
1178
1349
  */
1179
1350
  export interface BatchInferenceJob {
@@ -1247,12 +1418,18 @@ export interface BatchInferenceJob {
1247
1418
  */
1248
1419
  lastUpdatedDateTime?: Date;
1249
1420
  }
1421
+ /**
1422
+ * @public
1423
+ */
1250
1424
  export interface DescribeBatchInferenceJobResponse {
1251
1425
  /**
1252
1426
  * <p>Information on the specified batch inference job.</p>
1253
1427
  */
1254
1428
  batchInferenceJob?: BatchInferenceJob;
1255
1429
  }
1430
+ /**
1431
+ * @public
1432
+ */
1256
1433
  export interface DescribeBatchSegmentJobRequest {
1257
1434
  /**
1258
1435
  * <p>The ARN of the batch segment job to describe.</p>
@@ -1260,6 +1437,7 @@ export interface DescribeBatchSegmentJobRequest {
1260
1437
  batchSegmentJobArn: string | undefined;
1261
1438
  }
1262
1439
  /**
1440
+ * @public
1263
1441
  * <p>Contains information on a batch segment job.</p>
1264
1442
  */
1265
1443
  export interface BatchSegmentJob {
@@ -1326,12 +1504,18 @@ export interface BatchSegmentJob {
1326
1504
  */
1327
1505
  lastUpdatedDateTime?: Date;
1328
1506
  }
1507
+ /**
1508
+ * @public
1509
+ */
1329
1510
  export interface DescribeBatchSegmentJobResponse {
1330
1511
  /**
1331
1512
  * <p>Information on the specified batch segment job.</p>
1332
1513
  */
1333
1514
  batchSegmentJob?: BatchSegmentJob;
1334
1515
  }
1516
+ /**
1517
+ * @public
1518
+ */
1335
1519
  export interface DescribeCampaignRequest {
1336
1520
  /**
1337
1521
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
@@ -1339,6 +1523,7 @@ export interface DescribeCampaignRequest {
1339
1523
  campaignArn: string | undefined;
1340
1524
  }
1341
1525
  /**
1526
+ * @public
1342
1527
  * <p>Provides a summary of the properties of a campaign update. For a complete listing, call the
1343
1528
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> API.</p>
1344
1529
  */
@@ -1383,6 +1568,7 @@ export interface CampaignUpdateSummary {
1383
1568
  lastUpdatedDateTime?: Date;
1384
1569
  }
1385
1570
  /**
1571
+ * @public
1386
1572
  * <p>An object that describes the deployment of a solution version.
1387
1573
  * For more information on campaigns, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateCampaign.html">CreateCampaign</a>.</p>
1388
1574
  */
@@ -1438,12 +1624,18 @@ export interface Campaign {
1438
1624
  */
1439
1625
  latestCampaignUpdate?: CampaignUpdateSummary;
1440
1626
  }
1627
+ /**
1628
+ * @public
1629
+ */
1441
1630
  export interface DescribeCampaignResponse {
1442
1631
  /**
1443
1632
  * <p>The properties of the campaign.</p>
1444
1633
  */
1445
1634
  campaign?: Campaign;
1446
1635
  }
1636
+ /**
1637
+ * @public
1638
+ */
1447
1639
  export interface DescribeDatasetRequest {
1448
1640
  /**
1449
1641
  * <p>The Amazon Resource Name (ARN) of the dataset to describe.</p>
@@ -1451,6 +1643,7 @@ export interface DescribeDatasetRequest {
1451
1643
  datasetArn: string | undefined;
1452
1644
  }
1453
1645
  /**
1646
+ * @public
1454
1647
  * <p>Provides metadata for a dataset.</p>
1455
1648
  */
1456
1649
  export interface Dataset {
@@ -1509,12 +1702,18 @@ export interface Dataset {
1509
1702
  */
1510
1703
  lastUpdatedDateTime?: Date;
1511
1704
  }
1705
+ /**
1706
+ * @public
1707
+ */
1512
1708
  export interface DescribeDatasetResponse {
1513
1709
  /**
1514
1710
  * <p>A listing of the dataset's properties.</p>
1515
1711
  */
1516
1712
  dataset?: Dataset;
1517
1713
  }
1714
+ /**
1715
+ * @public
1716
+ */
1518
1717
  export interface DescribeDatasetExportJobRequest {
1519
1718
  /**
1520
1719
  * <p>The Amazon Resource Name (ARN) of the dataset export job to
@@ -1523,6 +1722,7 @@ export interface DescribeDatasetExportJobRequest {
1523
1722
  datasetExportJobArn: string | undefined;
1524
1723
  }
1525
1724
  /**
1725
+ * @public
1526
1726
  * <p>Describes a job that exports a dataset to an Amazon S3 bucket. For more
1527
1727
  * information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>.</p>
1528
1728
  * <p>A dataset export job can be in one of the following states:</p>
@@ -1593,6 +1793,9 @@ export interface DatasetExportJob {
1593
1793
  */
1594
1794
  failureReason?: string;
1595
1795
  }
1796
+ /**
1797
+ * @public
1798
+ */
1596
1799
  export interface DescribeDatasetExportJobResponse {
1597
1800
  /**
1598
1801
  * <p>Information about the dataset export job, including the status.</p>
@@ -1614,6 +1817,9 @@ export interface DescribeDatasetExportJobResponse {
1614
1817
  */
1615
1818
  datasetExportJob?: DatasetExportJob;
1616
1819
  }
1820
+ /**
1821
+ * @public
1822
+ */
1617
1823
  export interface DescribeDatasetGroupRequest {
1618
1824
  /**
1619
1825
  * <p>The Amazon Resource Name (ARN) of the dataset group to
@@ -1622,6 +1828,7 @@ export interface DescribeDatasetGroupRequest {
1622
1828
  datasetGroupArn: string | undefined;
1623
1829
  }
1624
1830
  /**
1831
+ * @public
1625
1832
  * <p>A dataset group is a collection of related datasets (Interactions,
1626
1833
  * User, and Item). You create a dataset group by calling <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetGroup.html">CreateDatasetGroup</a>. You then create a dataset and add it to a
1627
1834
  * dataset group by calling <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>. The dataset group is used to create and train a
@@ -1681,12 +1888,18 @@ export interface DatasetGroup {
1681
1888
  */
1682
1889
  domain?: Domain | string;
1683
1890
  }
1891
+ /**
1892
+ * @public
1893
+ */
1684
1894
  export interface DescribeDatasetGroupResponse {
1685
1895
  /**
1686
1896
  * <p>A listing of the dataset group's properties.</p>
1687
1897
  */
1688
1898
  datasetGroup?: DatasetGroup;
1689
1899
  }
1900
+ /**
1901
+ * @public
1902
+ */
1690
1903
  export interface DescribeDatasetImportJobRequest {
1691
1904
  /**
1692
1905
  * <p>The Amazon Resource Name (ARN) of the dataset import job to
@@ -1695,6 +1908,7 @@ export interface DescribeDatasetImportJobRequest {
1695
1908
  datasetImportJobArn: string | undefined;
1696
1909
  }
1697
1910
  /**
1911
+ * @public
1698
1912
  * <p>Describes a job that imports training data from a data source (Amazon S3
1699
1913
  * bucket) to an Amazon Personalize dataset. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>.</p>
1700
1914
  * <p>A dataset import job can be in one of the following states:</p>
@@ -1762,6 +1976,9 @@ export interface DatasetImportJob {
1762
1976
  */
1763
1977
  publishAttributionMetricsToS3?: boolean;
1764
1978
  }
1979
+ /**
1980
+ * @public
1981
+ */
1765
1982
  export interface DescribeDatasetImportJobResponse {
1766
1983
  /**
1767
1984
  * <p>Information about the dataset import job, including the status.</p>
@@ -1783,6 +2000,9 @@ export interface DescribeDatasetImportJobResponse {
1783
2000
  */
1784
2001
  datasetImportJob?: DatasetImportJob;
1785
2002
  }
2003
+ /**
2004
+ * @public
2005
+ */
1786
2006
  export interface DescribeEventTrackerRequest {
1787
2007
  /**
1788
2008
  * <p>The Amazon Resource Name (ARN) of the event tracker to describe.</p>
@@ -1790,6 +2010,7 @@ export interface DescribeEventTrackerRequest {
1790
2010
  eventTrackerArn: string | undefined;
1791
2011
  }
1792
2012
  /**
2013
+ * @public
1793
2014
  * <p>Provides information about an event tracker.</p>
1794
2015
  */
1795
2016
  export interface EventTracker {
@@ -1836,12 +2057,18 @@ export interface EventTracker {
1836
2057
  */
1837
2058
  lastUpdatedDateTime?: Date;
1838
2059
  }
2060
+ /**
2061
+ * @public
2062
+ */
1839
2063
  export interface DescribeEventTrackerResponse {
1840
2064
  /**
1841
2065
  * <p>An object that describes the event tracker.</p>
1842
2066
  */
1843
2067
  eventTracker?: EventTracker;
1844
2068
  }
2069
+ /**
2070
+ * @public
2071
+ */
1845
2072
  export interface DescribeFeatureTransformationRequest {
1846
2073
  /**
1847
2074
  * <p>The Amazon Resource Name (ARN) of the feature transformation to describe.</p>
@@ -1849,6 +2076,7 @@ export interface DescribeFeatureTransformationRequest {
1849
2076
  featureTransformationArn: string | undefined;
1850
2077
  }
1851
2078
  /**
2079
+ * @public
1852
2080
  * <p>Provides feature transformation information. Feature transformation is the process
1853
2081
  * of modifying raw input data into a form more suitable for model training.</p>
1854
2082
  */
@@ -1884,12 +2112,18 @@ export interface FeatureTransformation {
1884
2112
  */
1885
2113
  status?: string;
1886
2114
  }
2115
+ /**
2116
+ * @public
2117
+ */
1887
2118
  export interface DescribeFeatureTransformationResponse {
1888
2119
  /**
1889
2120
  * <p>A listing of the FeatureTransformation properties.</p>
1890
2121
  */
1891
2122
  featureTransformation?: FeatureTransformation;
1892
2123
  }
2124
+ /**
2125
+ * @public
2126
+ */
1893
2127
  export interface DescribeFilterRequest {
1894
2128
  /**
1895
2129
  * <p>The ARN of the filter to describe.</p>
@@ -1897,6 +2131,7 @@ export interface DescribeFilterRequest {
1897
2131
  filterArn: string | undefined;
1898
2132
  }
1899
2133
  /**
2134
+ * @public
1900
2135
  * <p>Contains information on a recommendation filter, including its ARN, status, and filter
1901
2136
  * expression.</p>
1902
2137
  */
@@ -1936,12 +2171,18 @@ export interface Filter {
1936
2171
  */
1937
2172
  status?: string;
1938
2173
  }
2174
+ /**
2175
+ * @public
2176
+ */
1939
2177
  export interface DescribeFilterResponse {
1940
2178
  /**
1941
2179
  * <p>The filter's details.</p>
1942
2180
  */
1943
2181
  filter?: Filter;
1944
2182
  }
2183
+ /**
2184
+ * @public
2185
+ */
1945
2186
  export interface DescribeMetricAttributionRequest {
1946
2187
  /**
1947
2188
  * <p>The metric attribution's Amazon Resource Name (ARN).</p>
@@ -1949,6 +2190,7 @@ export interface DescribeMetricAttributionRequest {
1949
2190
  metricAttributionArn: string | undefined;
1950
2191
  }
1951
2192
  /**
2193
+ * @public
1952
2194
  * <p>Contains information on a metric attribution. A metric attribution creates reports on the data that you import into Amazon Personalize.
1953
2195
  * Depending on how you import the data, you can view reports in Amazon CloudWatch or Amazon S3.
1954
2196
  * For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
@@ -1987,12 +2229,18 @@ export interface MetricAttribution {
1987
2229
  */
1988
2230
  failureReason?: string;
1989
2231
  }
2232
+ /**
2233
+ * @public
2234
+ */
1990
2235
  export interface DescribeMetricAttributionResponse {
1991
2236
  /**
1992
2237
  * <p>The details of the metric attribution.</p>
1993
2238
  */
1994
2239
  metricAttribution?: MetricAttribution;
1995
2240
  }
2241
+ /**
2242
+ * @public
2243
+ */
1996
2244
  export interface DescribeRecipeRequest {
1997
2245
  /**
1998
2246
  * <p>The Amazon Resource Name (ARN) of the recipe to describe.</p>
@@ -2000,6 +2248,7 @@ export interface DescribeRecipeRequest {
2000
2248
  recipeArn: string | undefined;
2001
2249
  }
2002
2250
  /**
2251
+ * @public
2003
2252
  * <p>Provides information about a recipe. Each recipe provides an algorithm
2004
2253
  * that Amazon Personalize uses in model training when you use the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>
2005
2254
  * operation. </p>
@@ -2054,12 +2303,18 @@ export interface Recipe {
2054
2303
  */
2055
2304
  lastUpdatedDateTime?: Date;
2056
2305
  }
2306
+ /**
2307
+ * @public
2308
+ */
2057
2309
  export interface DescribeRecipeResponse {
2058
2310
  /**
2059
2311
  * <p>An object that describes the recipe.</p>
2060
2312
  */
2061
2313
  recipe?: Recipe;
2062
2314
  }
2315
+ /**
2316
+ * @public
2317
+ */
2063
2318
  export interface DescribeRecommenderRequest {
2064
2319
  /**
2065
2320
  * <p>The Amazon Resource Name (ARN) of the recommender to describe.</p>
@@ -2067,6 +2322,7 @@ export interface DescribeRecommenderRequest {
2067
2322
  recommenderArn: string | undefined;
2068
2323
  }
2069
2324
  /**
2325
+ * @public
2070
2326
  * <p>Provides a summary of the properties of a recommender update. For a complete listing, call the
2071
2327
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecommender.html">DescribeRecommender</a> API.</p>
2072
2328
  */
@@ -2105,6 +2361,7 @@ export interface RecommenderUpdateSummary {
2105
2361
  failureReason?: string;
2106
2362
  }
2107
2363
  /**
2364
+ * @public
2108
2365
  * <p>Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group
2109
2366
  * for a specific domain use case (domain recipe), and specify the recommender in a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html">GetRecommendations</a> request.</p>
2110
2367
  */
@@ -2170,12 +2427,18 @@ export interface Recommender {
2170
2427
  */
2171
2428
  modelMetrics?: Record<string, number>;
2172
2429
  }
2430
+ /**
2431
+ * @public
2432
+ */
2173
2433
  export interface DescribeRecommenderResponse {
2174
2434
  /**
2175
2435
  * <p>The properties of the recommender.</p>
2176
2436
  */
2177
2437
  recommender?: Recommender;
2178
2438
  }
2439
+ /**
2440
+ * @public
2441
+ */
2179
2442
  export interface DescribeSchemaRequest {
2180
2443
  /**
2181
2444
  * <p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>
@@ -2183,6 +2446,7 @@ export interface DescribeSchemaRequest {
2183
2446
  schemaArn: string | undefined;
2184
2447
  }
2185
2448
  /**
2449
+ * @public
2186
2450
  * <p>Describes the schema for a dataset. For more information on schemas, see
2187
2451
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSchema.html">CreateSchema</a>.</p>
2188
2452
  */
@@ -2212,12 +2476,18 @@ export interface DatasetSchema {
2212
2476
  */
2213
2477
  domain?: Domain | string;
2214
2478
  }
2479
+ /**
2480
+ * @public
2481
+ */
2215
2482
  export interface DescribeSchemaResponse {
2216
2483
  /**
2217
2484
  * <p>The requested schema.</p>
2218
2485
  */
2219
2486
  schema?: DatasetSchema;
2220
2487
  }
2488
+ /**
2489
+ * @public
2490
+ */
2221
2491
  export interface DescribeSolutionRequest {
2222
2492
  /**
2223
2493
  * <p>The Amazon Resource Name (ARN) of the solution to describe.</p>
@@ -2225,6 +2495,7 @@ export interface DescribeSolutionRequest {
2225
2495
  solutionArn: string | undefined;
2226
2496
  }
2227
2497
  /**
2498
+ * @public
2228
2499
  * <p>When the solution performs AutoML (<code>performAutoML</code> is true in
2229
2500
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>), specifies the recipe that best optimized the
2230
2501
  * specified metric.</p>
@@ -2236,6 +2507,7 @@ export interface AutoMLResult {
2236
2507
  bestRecipeArn?: string;
2237
2508
  }
2238
2509
  /**
2510
+ * @public
2239
2511
  * <p>Provides a summary of the properties of a solution version. For a complete listing, call the
2240
2512
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolutionVersion.html">DescribeSolutionVersion</a> API.</p>
2241
2513
  */
@@ -2268,6 +2540,7 @@ export interface SolutionVersionSummary {
2268
2540
  failureReason?: string;
2269
2541
  }
2270
2542
  /**
2543
+ * @public
2271
2544
  * <p>An object that provides information about a solution. A solution is a trained model
2272
2545
  * that can be deployed as a campaign.</p>
2273
2546
  */
@@ -2339,12 +2612,18 @@ export interface Solution {
2339
2612
  */
2340
2613
  latestSolutionVersion?: SolutionVersionSummary;
2341
2614
  }
2615
+ /**
2616
+ * @public
2617
+ */
2342
2618
  export interface DescribeSolutionResponse {
2343
2619
  /**
2344
2620
  * <p>An object that describes the solution.</p>
2345
2621
  */
2346
2622
  solution?: Solution;
2347
2623
  }
2624
+ /**
2625
+ * @public
2626
+ */
2348
2627
  export interface DescribeSolutionVersionRequest {
2349
2628
  /**
2350
2629
  * <p>The Amazon Resource Name (ARN) of the solution version.</p>
@@ -2352,6 +2631,7 @@ export interface DescribeSolutionVersionRequest {
2352
2631
  solutionVersionArn: string | undefined;
2353
2632
  }
2354
2633
  /**
2634
+ * @public
2355
2635
  * <p>If hyperparameter optimization (HPO) was performed, contains the hyperparameter values of
2356
2636
  * the best performing model.</p>
2357
2637
  */
@@ -2362,6 +2642,7 @@ export interface TunedHPOParams {
2362
2642
  algorithmHyperParameters?: Record<string, string>;
2363
2643
  }
2364
2644
  /**
2645
+ * @public
2365
2646
  * <p>An object that provides information about a specific version of a <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_Solution.html">Solution</a> in a Custom dataset group.</p>
2366
2647
  */
2367
2648
  export interface SolutionVersion {
@@ -2472,18 +2753,27 @@ export interface SolutionVersion {
2472
2753
  */
2473
2754
  lastUpdatedDateTime?: Date;
2474
2755
  }
2756
+ /**
2757
+ * @public
2758
+ */
2475
2759
  export interface DescribeSolutionVersionResponse {
2476
2760
  /**
2477
2761
  * <p>The solution version.</p>
2478
2762
  */
2479
2763
  solutionVersion?: SolutionVersion;
2480
2764
  }
2765
+ /**
2766
+ * @public
2767
+ */
2481
2768
  export interface GetSolutionMetricsRequest {
2482
2769
  /**
2483
2770
  * <p>The Amazon Resource Name (ARN) of the solution version for which to get metrics.</p>
2484
2771
  */
2485
2772
  solutionVersionArn: string | undefined;
2486
2773
  }
2774
+ /**
2775
+ * @public
2776
+ */
2487
2777
  export interface GetSolutionMetricsResponse {
2488
2778
  /**
2489
2779
  * <p>The same solution version ARN as specified in the request.</p>
@@ -2498,6 +2788,7 @@ export interface GetSolutionMetricsResponse {
2498
2788
  metrics?: Record<string, number>;
2499
2789
  }
2500
2790
  /**
2791
+ * @public
2501
2792
  * <p>The token is not valid.</p>
2502
2793
  */
2503
2794
  export declare class InvalidNextTokenException extends __BaseException {
@@ -2508,6 +2799,9 @@ export declare class InvalidNextTokenException extends __BaseException {
2508
2799
  */
2509
2800
  constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
2510
2801
  }
2802
+ /**
2803
+ * @public
2804
+ */
2511
2805
  export interface ListBatchInferenceJobsRequest {
2512
2806
  /**
2513
2807
  * <p>The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs
@@ -2525,6 +2819,7 @@ export interface ListBatchInferenceJobsRequest {
2525
2819
  maxResults?: number;
2526
2820
  }
2527
2821
  /**
2822
+ * @public
2528
2823
  * <p>A truncated version of the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_BatchInferenceJob.html">BatchInferenceJob</a>. The
2529
2824
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchInferenceJobs.html">ListBatchInferenceJobs</a> operation returns a list of batch inference job
2530
2825
  * summaries.</p>
@@ -2573,6 +2868,9 @@ export interface BatchInferenceJobSummary {
2573
2868
  */
2574
2869
  solutionVersionArn?: string;
2575
2870
  }
2871
+ /**
2872
+ * @public
2873
+ */
2576
2874
  export interface ListBatchInferenceJobsResponse {
2577
2875
  /**
2578
2876
  * <p>A list containing information on each job that is returned.</p>
@@ -2584,6 +2882,9 @@ export interface ListBatchInferenceJobsResponse {
2584
2882
  */
2585
2883
  nextToken?: string;
2586
2884
  }
2885
+ /**
2886
+ * @public
2887
+ */
2587
2888
  export interface ListBatchSegmentJobsRequest {
2588
2889
  /**
2589
2890
  * <p>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</p>
@@ -2600,6 +2901,7 @@ export interface ListBatchSegmentJobsRequest {
2600
2901
  maxResults?: number;
2601
2902
  }
2602
2903
  /**
2904
+ * @public
2603
2905
  * <p>A truncated version of the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_BatchSegmentJob.html">BatchSegmentJob</a> datatype.
2604
2906
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_ListBatchSegmentJobs.html">ListBatchSegmentJobs</a> operation returns a list of batch segment job
2605
2907
  * summaries.</p>
@@ -2648,6 +2950,9 @@ export interface BatchSegmentJobSummary {
2648
2950
  */
2649
2951
  solutionVersionArn?: string;
2650
2952
  }
2953
+ /**
2954
+ * @public
2955
+ */
2651
2956
  export interface ListBatchSegmentJobsResponse {
2652
2957
  /**
2653
2958
  * <p>A list containing information on each job that is returned.</p>
@@ -2659,6 +2964,9 @@ export interface ListBatchSegmentJobsResponse {
2659
2964
  */
2660
2965
  nextToken?: string;
2661
2966
  }
2967
+ /**
2968
+ * @public
2969
+ */
2662
2970
  export interface ListCampaignsRequest {
2663
2971
  /**
2664
2972
  * <p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When
@@ -2676,6 +2984,7 @@ export interface ListCampaignsRequest {
2676
2984
  maxResults?: number;
2677
2985
  }
2678
2986
  /**
2987
+ * @public
2679
2988
  * <p>Provides a summary of the properties of a campaign. For a complete listing, call the
2680
2989
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html">DescribeCampaign</a> API.</p>
2681
2990
  */
@@ -2714,6 +3023,9 @@ export interface CampaignSummary {
2714
3023
  */
2715
3024
  failureReason?: string;
2716
3025
  }
3026
+ /**
3027
+ * @public
3028
+ */
2717
3029
  export interface ListCampaignsResponse {
2718
3030
  /**
2719
3031
  * <p>A list of the campaigns.</p>
@@ -2724,6 +3036,9 @@ export interface ListCampaignsResponse {
2724
3036
  */
2725
3037
  nextToken?: string;
2726
3038
  }
3039
+ /**
3040
+ * @public
3041
+ */
2727
3042
  export interface ListDatasetExportJobsRequest {
2728
3043
  /**
2729
3044
  * <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
@@ -2742,6 +3057,7 @@ export interface ListDatasetExportJobsRequest {
2742
3057
  maxResults?: number;
2743
3058
  }
2744
3059
  /**
3060
+ * @public
2745
3061
  * <p>Provides a summary of the properties of a dataset export job. For a complete listing, call the
2746
3062
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetExportJob.html">DescribeDatasetExportJob</a> API.</p>
2747
3063
  */
@@ -2777,6 +3093,9 @@ export interface DatasetExportJobSummary {
2777
3093
  */
2778
3094
  failureReason?: string;
2779
3095
  }
3096
+ /**
3097
+ * @public
3098
+ */
2780
3099
  export interface ListDatasetExportJobsResponse {
2781
3100
  /**
2782
3101
  * <p>The list of dataset export jobs.</p>
@@ -2788,6 +3107,9 @@ export interface ListDatasetExportJobsResponse {
2788
3107
  */
2789
3108
  nextToken?: string;
2790
3109
  }
3110
+ /**
3111
+ * @public
3112
+ */
2791
3113
  export interface ListDatasetGroupsRequest {
2792
3114
  /**
2793
3115
  * <p>A token returned from the previous call to
@@ -2801,6 +3123,7 @@ export interface ListDatasetGroupsRequest {
2801
3123
  maxResults?: number;
2802
3124
  }
2803
3125
  /**
3126
+ * @public
2804
3127
  * <p>Provides a summary of the properties of a dataset group. For a complete listing, call the
2805
3128
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetGroup.html">DescribeDatasetGroup</a> API.</p>
2806
3129
  */
@@ -2843,6 +3166,9 @@ export interface DatasetGroupSummary {
2843
3166
  */
2844
3167
  domain?: Domain | string;
2845
3168
  }
3169
+ /**
3170
+ * @public
3171
+ */
2846
3172
  export interface ListDatasetGroupsResponse {
2847
3173
  /**
2848
3174
  * <p>The list of your dataset groups.</p>
@@ -2854,6 +3180,9 @@ export interface ListDatasetGroupsResponse {
2854
3180
  */
2855
3181
  nextToken?: string;
2856
3182
  }
3183
+ /**
3184
+ * @public
3185
+ */
2857
3186
  export interface ListDatasetImportJobsRequest {
2858
3187
  /**
2859
3188
  * <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
@@ -2872,6 +3201,7 @@ export interface ListDatasetImportJobsRequest {
2872
3201
  maxResults?: number;
2873
3202
  }
2874
3203
  /**
3204
+ * @public
2875
3205
  * <p>Provides a summary of the properties of a dataset import job. For a complete listing, call the
2876
3206
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html">DescribeDatasetImportJob</a> API.</p>
2877
3207
  */
@@ -2914,6 +3244,9 @@ export interface DatasetImportJobSummary {
2914
3244
  */
2915
3245
  importMode?: ImportMode | string;
2916
3246
  }
3247
+ /**
3248
+ * @public
3249
+ */
2917
3250
  export interface ListDatasetImportJobsResponse {
2918
3251
  /**
2919
3252
  * <p>The list of dataset import jobs.</p>
@@ -2925,6 +3258,9 @@ export interface ListDatasetImportJobsResponse {
2925
3258
  */
2926
3259
  nextToken?: string;
2927
3260
  }
3261
+ /**
3262
+ * @public
3263
+ */
2928
3264
  export interface ListDatasetsRequest {
2929
3265
  /**
2930
3266
  * <p>The Amazon Resource Name (ARN) of the dataset group that contains the
@@ -2943,6 +3279,7 @@ export interface ListDatasetsRequest {
2943
3279
  maxResults?: number;
2944
3280
  }
2945
3281
  /**
3282
+ * @public
2946
3283
  * <p>Provides a summary of the properties of a dataset. For a complete listing, call the
2947
3284
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDataset.html">DescribeDataset</a> API.</p>
2948
3285
  */
@@ -2995,6 +3332,9 @@ export interface DatasetSummary {
2995
3332
  */
2996
3333
  lastUpdatedDateTime?: Date;
2997
3334
  }
3335
+ /**
3336
+ * @public
3337
+ */
2998
3338
  export interface ListDatasetsResponse {
2999
3339
  /**
3000
3340
  * <p>An array of <code>Dataset</code> objects. Each object provides
@@ -3006,6 +3346,9 @@ export interface ListDatasetsResponse {
3006
3346
  */
3007
3347
  nextToken?: string;
3008
3348
  }
3349
+ /**
3350
+ * @public
3351
+ */
3009
3352
  export interface ListEventTrackersRequest {
3010
3353
  /**
3011
3354
  * <p>The ARN of a dataset group used to filter the response.</p>
@@ -3022,6 +3365,7 @@ export interface ListEventTrackersRequest {
3022
3365
  maxResults?: number;
3023
3366
  }
3024
3367
  /**
3368
+ * @public
3025
3369
  * <p>Provides a summary of the properties of an event tracker. For a complete listing, call the
3026
3370
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeEventTracker.html">DescribeEventTracker</a> API.</p>
3027
3371
  */
@@ -3056,6 +3400,9 @@ export interface EventTrackerSummary {
3056
3400
  */
3057
3401
  lastUpdatedDateTime?: Date;
3058
3402
  }
3403
+ /**
3404
+ * @public
3405
+ */
3059
3406
  export interface ListEventTrackersResponse {
3060
3407
  /**
3061
3408
  * <p>A list of event trackers.</p>
@@ -3066,6 +3413,9 @@ export interface ListEventTrackersResponse {
3066
3413
  */
3067
3414
  nextToken?: string;
3068
3415
  }
3416
+ /**
3417
+ * @public
3418
+ */
3069
3419
  export interface ListFiltersRequest {
3070
3420
  /**
3071
3421
  * <p>The ARN of the dataset group that contains the filters.</p>
@@ -3082,6 +3432,7 @@ export interface ListFiltersRequest {
3082
3432
  maxResults?: number;
3083
3433
  }
3084
3434
  /**
3435
+ * @public
3085
3436
  * <p>A short summary of a filter's attributes.</p>
3086
3437
  */
3087
3438
  export interface FilterSummary {
@@ -3114,6 +3465,9 @@ export interface FilterSummary {
3114
3465
  */
3115
3466
  status?: string;
3116
3467
  }
3468
+ /**
3469
+ * @public
3470
+ */
3117
3471
  export interface ListFiltersResponse {
3118
3472
  /**
3119
3473
  * <p>A list of returned filters.</p>
@@ -3124,6 +3478,9 @@ export interface ListFiltersResponse {
3124
3478
  */
3125
3479
  nextToken?: string;
3126
3480
  }
3481
+ /**
3482
+ * @public
3483
+ */
3127
3484
  export interface ListMetricAttributionMetricsRequest {
3128
3485
  /**
3129
3486
  * <p>The Amazon Resource Name (ARN) of the metric attribution to retrieve attributes for.</p>
@@ -3138,6 +3495,9 @@ export interface ListMetricAttributionMetricsRequest {
3138
3495
  */
3139
3496
  maxResults?: number;
3140
3497
  }
3498
+ /**
3499
+ * @public
3500
+ */
3141
3501
  export interface ListMetricAttributionMetricsResponse {
3142
3502
  /**
3143
3503
  * <p>The metrics for the specified metric attribution.</p>
@@ -3148,6 +3508,9 @@ export interface ListMetricAttributionMetricsResponse {
3148
3508
  */
3149
3509
  nextToken?: string;
3150
3510
  }
3511
+ /**
3512
+ * @public
3513
+ */
3151
3514
  export interface ListMetricAttributionsRequest {
3152
3515
  /**
3153
3516
  * <p>The metric attributions' dataset group Amazon Resource Name (ARN).</p>
@@ -3163,6 +3526,7 @@ export interface ListMetricAttributionsRequest {
3163
3526
  maxResults?: number;
3164
3527
  }
3165
3528
  /**
3529
+ * @public
3166
3530
  * <p>Provides a summary of the properties of a metric attribution. For a complete listing, call the <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeMetricAttribution.html">DescribeMetricAttribution</a>.</p>
3167
3531
  */
3168
3532
  export interface MetricAttributionSummary {
@@ -3191,6 +3555,9 @@ export interface MetricAttributionSummary {
3191
3555
  */
3192
3556
  failureReason?: string;
3193
3557
  }
3558
+ /**
3559
+ * @public
3560
+ */
3194
3561
  export interface ListMetricAttributionsResponse {
3195
3562
  /**
3196
3563
  * <p>The list of metric attributions.</p>
@@ -3201,9 +3568,15 @@ export interface ListMetricAttributionsResponse {
3201
3568
  */
3202
3569
  nextToken?: string;
3203
3570
  }
3571
+ /**
3572
+ * @public
3573
+ */
3204
3574
  export declare enum RecipeProvider {
3205
3575
  SERVICE = "SERVICE"
3206
3576
  }
3577
+ /**
3578
+ * @public
3579
+ */
3207
3580
  export interface ListRecipesRequest {
3208
3581
  /**
3209
3582
  * <p>The default is <code>SERVICE</code>.</p>
@@ -3227,6 +3600,7 @@ export interface ListRecipesRequest {
3227
3600
  domain?: Domain | string;
3228
3601
  }
3229
3602
  /**
3603
+ * @public
3230
3604
  * <p>Provides a summary of the properties of a recipe. For a complete listing, call the
3231
3605
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeRecipe.html">DescribeRecipe</a> API.</p>
3232
3606
  */
@@ -3256,6 +3630,9 @@ export interface RecipeSummary {
3256
3630
  */
3257
3631
  domain?: Domain | string;
3258
3632
  }
3633
+ /**
3634
+ * @public
3635
+ */
3259
3636
  export interface ListRecipesResponse {
3260
3637
  /**
3261
3638
  * <p>The list of available recipes.</p>
@@ -3266,6 +3643,9 @@ export interface ListRecipesResponse {
3266
3643
  */
3267
3644
  nextToken?: string;
3268
3645
  }
3646
+ /**
3647
+ * @public
3648
+ */
3269
3649
  export interface ListRecommendersRequest {
3270
3650
  /**
3271
3651
  * <p>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When
@@ -3283,6 +3663,7 @@ export interface ListRecommendersRequest {
3283
3663
  maxResults?: number;
3284
3664
  }
3285
3665
  /**
3666
+ * @public
3286
3667
  * <p>Provides a summary of the properties of the recommender.</p>
3287
3668
  */
3288
3669
  export interface RecommenderSummary {
@@ -3330,6 +3711,9 @@ export interface RecommenderSummary {
3330
3711
  */
3331
3712
  lastUpdatedDateTime?: Date;
3332
3713
  }
3714
+ /**
3715
+ * @public
3716
+ */
3333
3717
  export interface ListRecommendersResponse {
3334
3718
  /**
3335
3719
  * <p>A list of the recommenders.</p>
@@ -3340,6 +3724,9 @@ export interface ListRecommendersResponse {
3340
3724
  */
3341
3725
  nextToken?: string;
3342
3726
  }
3727
+ /**
3728
+ * @public
3729
+ */
3343
3730
  export interface ListSchemasRequest {
3344
3731
  /**
3345
3732
  * <p>A token returned from the previous call to <code>ListSchemas</code> for getting
@@ -3352,6 +3739,7 @@ export interface ListSchemasRequest {
3352
3739
  maxResults?: number;
3353
3740
  }
3354
3741
  /**
3742
+ * @public
3355
3743
  * <p>Provides a summary of the properties of a dataset schema. For a complete listing, call the
3356
3744
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSchema.html">DescribeSchema</a> API.</p>
3357
3745
  */
@@ -3377,6 +3765,9 @@ export interface DatasetSchemaSummary {
3377
3765
  */
3378
3766
  domain?: Domain | string;
3379
3767
  }
3768
+ /**
3769
+ * @public
3770
+ */
3380
3771
  export interface ListSchemasResponse {
3381
3772
  /**
3382
3773
  * <p>A list of schemas.</p>
@@ -3387,6 +3778,9 @@ export interface ListSchemasResponse {
3387
3778
  */
3388
3779
  nextToken?: string;
3389
3780
  }
3781
+ /**
3782
+ * @public
3783
+ */
3390
3784
  export interface ListSolutionsRequest {
3391
3785
  /**
3392
3786
  * <p>The Amazon Resource Name (ARN) of the dataset group.</p>
@@ -3403,6 +3797,7 @@ export interface ListSolutionsRequest {
3403
3797
  maxResults?: number;
3404
3798
  }
3405
3799
  /**
3800
+ * @public
3406
3801
  * <p>Provides a summary of the properties of a solution. For a complete listing, call the
3407
3802
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeSolution.html">DescribeSolution</a> API.</p>
3408
3803
  */
@@ -3441,6 +3836,9 @@ export interface SolutionSummary {
3441
3836
  */
3442
3837
  recipeArn?: string;
3443
3838
  }
3839
+ /**
3840
+ * @public
3841
+ */
3444
3842
  export interface ListSolutionsResponse {
3445
3843
  /**
3446
3844
  * <p>A list of the current solutions.</p>
@@ -3451,6 +3849,9 @@ export interface ListSolutionsResponse {
3451
3849
  */
3452
3850
  nextToken?: string;
3453
3851
  }
3852
+ /**
3853
+ * @public
3854
+ */
3454
3855
  export interface ListSolutionVersionsRequest {
3455
3856
  /**
3456
3857
  * <p>The Amazon Resource Name (ARN) of the solution.</p>
@@ -3466,6 +3867,9 @@ export interface ListSolutionVersionsRequest {
3466
3867
  */
3467
3868
  maxResults?: number;
3468
3869
  }
3870
+ /**
3871
+ * @public
3872
+ */
3469
3873
  export interface ListSolutionVersionsResponse {
3470
3874
  /**
3471
3875
  * <p>A list of solution versions describing the version properties.</p>
@@ -3476,48 +3880,72 @@ export interface ListSolutionVersionsResponse {
3476
3880
  */
3477
3881
  nextToken?: string;
3478
3882
  }
3883
+ /**
3884
+ * @public
3885
+ */
3479
3886
  export interface ListTagsForResourceRequest {
3480
3887
  /**
3481
3888
  * <p>The resource's Amazon Resource Name.</p>
3482
3889
  */
3483
3890
  resourceArn: string | undefined;
3484
3891
  }
3892
+ /**
3893
+ * @public
3894
+ */
3485
3895
  export interface ListTagsForResourceResponse {
3486
3896
  /**
3487
3897
  * <p>The resource's tags.</p>
3488
3898
  */
3489
3899
  tags?: Tag[];
3490
3900
  }
3901
+ /**
3902
+ * @public
3903
+ */
3491
3904
  export interface StartRecommenderRequest {
3492
3905
  /**
3493
3906
  * <p>The Amazon Resource Name (ARN) of the recommender to start.</p>
3494
3907
  */
3495
3908
  recommenderArn: string | undefined;
3496
3909
  }
3910
+ /**
3911
+ * @public
3912
+ */
3497
3913
  export interface StartRecommenderResponse {
3498
3914
  /**
3499
3915
  * <p>The Amazon Resource Name (ARN) of the recommender you started.</p>
3500
3916
  */
3501
3917
  recommenderArn?: string;
3502
3918
  }
3919
+ /**
3920
+ * @public
3921
+ */
3503
3922
  export interface StopRecommenderRequest {
3504
3923
  /**
3505
3924
  * <p>The Amazon Resource Name (ARN) of the recommender to stop.</p>
3506
3925
  */
3507
3926
  recommenderArn: string | undefined;
3508
3927
  }
3928
+ /**
3929
+ * @public
3930
+ */
3509
3931
  export interface StopRecommenderResponse {
3510
3932
  /**
3511
3933
  * <p>The Amazon Resource Name (ARN) of the recommender you stopped.</p>
3512
3934
  */
3513
3935
  recommenderArn?: string;
3514
3936
  }
3937
+ /**
3938
+ * @public
3939
+ */
3515
3940
  export interface StopSolutionVersionCreationRequest {
3516
3941
  /**
3517
3942
  * <p>The Amazon Resource Name (ARN) of the solution version you want to stop creating.</p>
3518
3943
  */
3519
3944
  solutionVersionArn: string | undefined;
3520
3945
  }
3946
+ /**
3947
+ * @public
3948
+ */
3521
3949
  export interface TagResourceRequest {
3522
3950
  /**
3523
3951
  * <p>The resource's Amazon Resource Name (ARN).</p>
@@ -3528,9 +3956,13 @@ export interface TagResourceRequest {
3528
3956
  */
3529
3957
  tags: Tag[] | undefined;
3530
3958
  }
3959
+ /**
3960
+ * @public
3961
+ */
3531
3962
  export interface TagResourceResponse {
3532
3963
  }
3533
3964
  /**
3965
+ * @public
3534
3966
  * <p>The request contains more tag keys than can be associated with a resource (50 tag keys per resource). </p>
3535
3967
  */
3536
3968
  export declare class TooManyTagKeysException extends __BaseException {
@@ -3541,6 +3973,9 @@ export declare class TooManyTagKeysException extends __BaseException {
3541
3973
  */
3542
3974
  constructor(opts: __ExceptionOptionType<TooManyTagKeysException, __BaseException>);
3543
3975
  }
3976
+ /**
3977
+ * @public
3978
+ */
3544
3979
  export interface UntagResourceRequest {
3545
3980
  /**
3546
3981
  * <p>The resource's Amazon Resource Name (ARN).</p>
@@ -3551,8 +3986,14 @@ export interface UntagResourceRequest {
3551
3986
  */
3552
3987
  tagKeys: string[] | undefined;
3553
3988
  }
3989
+ /**
3990
+ * @public
3991
+ */
3554
3992
  export interface UntagResourceResponse {
3555
3993
  }
3994
+ /**
3995
+ * @public
3996
+ */
3556
3997
  export interface UpdateCampaignRequest {
3557
3998
  /**
3558
3999
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
@@ -3572,12 +4013,18 @@ export interface UpdateCampaignRequest {
3572
4013
  */
3573
4014
  campaignConfig?: CampaignConfig;
3574
4015
  }
4016
+ /**
4017
+ * @public
4018
+ */
3575
4019
  export interface UpdateCampaignResponse {
3576
4020
  /**
3577
4021
  * <p>The same campaign ARN as given in the request.</p>
3578
4022
  */
3579
4023
  campaignArn?: string;
3580
4024
  }
4025
+ /**
4026
+ * @public
4027
+ */
3581
4028
  export interface UpdateMetricAttributionRequest {
3582
4029
  /**
3583
4030
  * <p>Add new metric attributes to the metric attribution.</p>
@@ -3596,12 +4043,18 @@ export interface UpdateMetricAttributionRequest {
3596
4043
  */
3597
4044
  metricAttributionArn?: string;
3598
4045
  }
4046
+ /**
4047
+ * @public
4048
+ */
3599
4049
  export interface UpdateMetricAttributionResponse {
3600
4050
  /**
3601
4051
  * <p>The Amazon Resource Name (ARN) for the metric attribution that you updated.</p>
3602
4052
  */
3603
4053
  metricAttributionArn?: string;
3604
4054
  }
4055
+ /**
4056
+ * @public
4057
+ */
3605
4058
  export interface UpdateRecommenderRequest {
3606
4059
  /**
3607
4060
  * <p>The Amazon Resource Name (ARN) of the recommender to modify.</p>
@@ -3612,6 +4065,9 @@ export interface UpdateRecommenderRequest {
3612
4065
  */
3613
4066
  recommenderConfig: RecommenderConfig | undefined;
3614
4067
  }
4068
+ /**
4069
+ * @public
4070
+ */
3615
4071
  export interface UpdateRecommenderResponse {
3616
4072
  /**
3617
4073
  * <p>The same recommender Amazon Resource Name (ARN) as given in the request.</p>