@aws-sdk/client-personalize 3.42.0 → 3.47.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 (80) hide show
  1. package/CHANGELOG.md +50 -0
  2. package/dist-cjs/Personalize.js +120 -0
  3. package/dist-cjs/commands/CreateBatchSegmentJobCommand.js +36 -0
  4. package/dist-cjs/commands/CreateRecommenderCommand.js +36 -0
  5. package/dist-cjs/commands/DeleteRecommenderCommand.js +36 -0
  6. package/dist-cjs/commands/DescribeBatchSegmentJobCommand.js +36 -0
  7. package/dist-cjs/commands/DescribeRecommenderCommand.js +36 -0
  8. package/dist-cjs/commands/ListBatchSegmentJobsCommand.js +36 -0
  9. package/dist-cjs/commands/ListRecommendersCommand.js +36 -0
  10. package/dist-cjs/commands/UpdateRecommenderCommand.js +36 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/endpoints.js +1 -0
  13. package/dist-cjs/models/models_0.js +139 -31
  14. package/dist-cjs/pagination/ListBatchSegmentJobsPaginator.js +35 -0
  15. package/dist-cjs/pagination/ListRecommendersPaginator.js +35 -0
  16. package/dist-cjs/pagination/index.js +2 -0
  17. package/dist-cjs/protocols/Aws_json1_1.js +891 -28
  18. package/dist-cjs/runtimeConfig.browser.js +7 -2
  19. package/dist-cjs/runtimeConfig.js +9 -3
  20. package/dist-es/Personalize.js +120 -0
  21. package/dist-es/commands/CreateBatchSegmentJobCommand.js +39 -0
  22. package/dist-es/commands/CreateRecommenderCommand.js +39 -0
  23. package/dist-es/commands/DeleteRecommenderCommand.js +39 -0
  24. package/dist-es/commands/DescribeBatchSegmentJobCommand.js +39 -0
  25. package/dist-es/commands/DescribeRecommenderCommand.js +39 -0
  26. package/dist-es/commands/ListBatchSegmentJobsCommand.js +39 -0
  27. package/dist-es/commands/ListRecommendersCommand.js +39 -0
  28. package/dist-es/commands/UpdateRecommenderCommand.js +39 -0
  29. package/dist-es/commands/index.js +8 -0
  30. package/dist-es/endpoints.js +1 -0
  31. package/dist-es/models/models_0.js +97 -24
  32. package/dist-es/pagination/ListBatchSegmentJobsPaginator.js +74 -0
  33. package/dist-es/pagination/ListRecommendersPaginator.js +74 -0
  34. package/dist-es/pagination/index.js +2 -0
  35. package/dist-es/protocols/Aws_json1_1.js +944 -38
  36. package/dist-es/runtimeConfig.browser.js +12 -3
  37. package/dist-es/runtimeConfig.js +13 -6
  38. package/dist-types/Personalize.d.ts +137 -8
  39. package/dist-types/PersonalizeClient.d.ts +15 -3
  40. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +36 -0
  41. package/dist-types/commands/CreateCampaignCommand.d.ts +1 -1
  42. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +8 -5
  43. package/dist-types/commands/CreateRecommenderCommand.d.ts +84 -0
  44. package/dist-types/commands/CreateSchemaCommand.d.ts +2 -1
  45. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +1 -1
  46. package/dist-types/commands/DeleteRecommenderCommand.d.ts +36 -0
  47. package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +37 -0
  48. package/dist-types/commands/DescribeRecommenderCommand.d.ts +47 -0
  49. package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +36 -0
  50. package/dist-types/commands/ListRecommendersCommand.d.ts +38 -0
  51. package/dist-types/commands/UpdateRecommenderCommand.d.ts +35 -0
  52. package/dist-types/commands/index.d.ts +8 -0
  53. package/dist-types/models/models_0.d.ts +630 -35
  54. package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
  55. package/dist-types/pagination/ListRecommendersPaginator.d.ts +4 -0
  56. package/dist-types/pagination/index.d.ts +2 -0
  57. package/dist-types/protocols/Aws_json1_1.d.ts +24 -0
  58. package/dist-types/runtimeConfig.browser.d.ts +3 -2
  59. package/dist-types/runtimeConfig.d.ts +4 -3
  60. package/dist-types/runtimeConfig.native.d.ts +1 -0
  61. package/dist-types/ts3.4/Personalize.d.ts +40 -0
  62. package/dist-types/ts3.4/PersonalizeClient.d.ts +13 -3
  63. package/dist-types/ts3.4/commands/CreateBatchSegmentJobCommand.d.ts +17 -0
  64. package/dist-types/ts3.4/commands/CreateRecommenderCommand.d.ts +17 -0
  65. package/dist-types/ts3.4/commands/DeleteRecommenderCommand.d.ts +17 -0
  66. package/dist-types/ts3.4/commands/DescribeBatchSegmentJobCommand.d.ts +17 -0
  67. package/dist-types/ts3.4/commands/DescribeRecommenderCommand.d.ts +17 -0
  68. package/dist-types/ts3.4/commands/ListBatchSegmentJobsCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/UpdateRecommenderCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  72. package/dist-types/ts3.4/models/models_0.d.ts +320 -22
  73. package/dist-types/ts3.4/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
  74. package/dist-types/ts3.4/pagination/ListRecommendersPaginator.d.ts +4 -0
  75. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  76. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  77. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
  78. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
  79. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  80. package/package.json +38 -45
@@ -318,12 +318,6 @@ export interface InvalidInputException extends __SmithyException, $MetadataBeare
318
318
  $fault: "client";
319
319
  message?: string;
320
320
  }
321
- export declare namespace InvalidInputException {
322
- /**
323
- * @internal
324
- */
325
- const filterSensitiveLog: (obj: InvalidInputException) => any;
326
- }
327
321
  /**
328
322
  * <p>The limit on the number of requests per second has been exceeded.</p>
329
323
  */
@@ -332,12 +326,6 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
332
326
  $fault: "client";
333
327
  message?: string;
334
328
  }
335
- export declare namespace LimitExceededException {
336
- /**
337
- * @internal
338
- */
339
- const filterSensitiveLog: (obj: LimitExceededException) => any;
340
- }
341
329
  /**
342
330
  * <p>The specified resource already exists.</p>
343
331
  */
@@ -346,12 +334,6 @@ export interface ResourceAlreadyExistsException extends __SmithyException, $Meta
346
334
  $fault: "client";
347
335
  message?: string;
348
336
  }
349
- export declare namespace ResourceAlreadyExistsException {
350
- /**
351
- * @internal
352
- */
353
- const filterSensitiveLog: (obj: ResourceAlreadyExistsException) => any;
354
- }
355
337
  /**
356
338
  * <p>The specified resource is in use.</p>
357
339
  */
@@ -360,12 +342,6 @@ export interface ResourceInUseException extends __SmithyException, $MetadataBear
360
342
  $fault: "client";
361
343
  message?: string;
362
344
  }
363
- export declare namespace ResourceInUseException {
364
- /**
365
- * @internal
366
- */
367
- const filterSensitiveLog: (obj: ResourceInUseException) => any;
368
- }
369
345
  /**
370
346
  * <p>Could not find the specified resource.</p>
371
347
  */
@@ -374,18 +350,93 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
374
350
  $fault: "client";
375
351
  message?: string;
376
352
  }
377
- export declare namespace ResourceNotFoundException {
353
+ /**
354
+ * <p>The input configuration of a batch segment job.</p>
355
+ */
356
+ export interface BatchSegmentJobInput {
357
+ /**
358
+ * <p>The configuration details of an Amazon S3 input or output bucket.</p>
359
+ */
360
+ s3DataSource: S3DataConfig | undefined;
361
+ }
362
+ export declare namespace BatchSegmentJobInput {
363
+ /**
364
+ * @internal
365
+ */
366
+ const filterSensitiveLog: (obj: BatchSegmentJobInput) => any;
367
+ }
368
+ /**
369
+ * <p>The output configuration parameters of a batch segment job.</p>
370
+ */
371
+ export interface BatchSegmentJobOutput {
372
+ /**
373
+ * <p>The configuration details of an Amazon S3 input or output bucket.</p>
374
+ */
375
+ s3DataDestination: S3DataConfig | undefined;
376
+ }
377
+ export declare namespace BatchSegmentJobOutput {
378
+ /**
379
+ * @internal
380
+ */
381
+ const filterSensitiveLog: (obj: BatchSegmentJobOutput) => any;
382
+ }
383
+ export interface CreateBatchSegmentJobRequest {
384
+ /**
385
+ * <p>The name of the batch segment job to create.</p>
386
+ */
387
+ jobName: string | undefined;
388
+ /**
389
+ * <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate
390
+ * batch segments.</p>
391
+ */
392
+ solutionVersionArn: string | undefined;
393
+ /**
394
+ * <p>The ARN of the filter to apply to the batch segment job. For more information on using
395
+ * filters, see <a>filter-batch</a>.</p>
396
+ */
397
+ filterArn?: string;
398
+ /**
399
+ * <p>The number of predicted users generated by the batch segment job for each line of input data.</p>
400
+ */
401
+ numResults?: number;
402
+ /**
403
+ * <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
404
+ */
405
+ jobInput: BatchSegmentJobInput | undefined;
406
+ /**
407
+ * <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
408
+ */
409
+ jobOutput: BatchSegmentJobOutput | undefined;
410
+ /**
411
+ * <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output
412
+ * Amazon S3 buckets respectively.</p>
413
+ */
414
+ roleArn: string | undefined;
415
+ }
416
+ export declare namespace CreateBatchSegmentJobRequest {
417
+ /**
418
+ * @internal
419
+ */
420
+ const filterSensitiveLog: (obj: CreateBatchSegmentJobRequest) => any;
421
+ }
422
+ export interface CreateBatchSegmentJobResponse {
423
+ /**
424
+ * <p>The ARN of the batch segment job.</p>
425
+ */
426
+ batchSegmentJobArn?: string;
427
+ }
428
+ export declare namespace CreateBatchSegmentJobResponse {
378
429
  /**
379
430
  * @internal
380
431
  */
381
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
432
+ const filterSensitiveLog: (obj: CreateBatchSegmentJobResponse) => any;
382
433
  }
383
434
  /**
384
435
  * <p>The configuration details of a campaign.</p>
385
436
  */
386
437
  export interface CampaignConfig {
387
438
  /**
388
- * <p>A string to string map specifying the exploration configuration hyperparameters, including <code>explorationWeight</code> and
439
+ * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
389
440
  * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
390
441
  * recommending items. Provide <code>itemExplorationConfig</code> data only if your solution uses the
391
442
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a> recipe.</p>
@@ -550,6 +601,10 @@ export declare namespace CreateDatasetExportJobResponse {
550
601
  */
551
602
  const filterSensitiveLog: (obj: CreateDatasetExportJobResponse) => any;
552
603
  }
604
+ export declare enum Domain {
605
+ ECOMMERCE = "ECOMMERCE",
606
+ VIDEO_ON_DEMAND = "VIDEO_ON_DEMAND"
607
+ }
553
608
  export interface CreateDatasetGroupRequest {
554
609
  /**
555
610
  * <p>The name for the new dataset group.</p>
@@ -564,6 +619,13 @@ export interface CreateDatasetGroupRequest {
564
619
  * <p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.</p>
565
620
  */
566
621
  kmsKeyArn?: string;
622
+ /**
623
+ * <p>The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify
624
+ * determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain,
625
+ * you create a Custom dataset group with solution versions that you deploy with a campaign.
626
+ * </p>
627
+ */
628
+ domain?: Domain | string;
567
629
  }
568
630
  export declare namespace CreateDatasetGroupRequest {
569
631
  /**
@@ -576,6 +638,10 @@ export interface CreateDatasetGroupResponse {
576
638
  * <p>The Amazon Resource Name (ARN) of the new dataset group.</p>
577
639
  */
578
640
  datasetGroupArn?: string;
641
+ /**
642
+ * <p>The domain for the new Domain dataset group.</p>
643
+ */
644
+ domain?: Domain | string;
579
645
  }
580
646
  export declare namespace CreateDatasetGroupResponse {
581
647
  /**
@@ -705,6 +771,64 @@ export declare namespace CreateFilterResponse {
705
771
  */
706
772
  const filterSensitiveLog: (obj: CreateFilterResponse) => any;
707
773
  }
774
+ /**
775
+ * <p>The configuration details of the recommender.</p>
776
+ */
777
+ export interface RecommenderConfig {
778
+ /**
779
+ * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
780
+ * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
781
+ * recommending items. Provide <code>itemExplorationConfig</code> data only if your recommenders generate personalized recommendations for a user
782
+ * (not popular items or similar items).</p>
783
+ */
784
+ itemExplorationConfig?: {
785
+ [key: string]: string;
786
+ };
787
+ }
788
+ export declare namespace RecommenderConfig {
789
+ /**
790
+ * @internal
791
+ */
792
+ const filterSensitiveLog: (obj: RecommenderConfig) => any;
793
+ }
794
+ export interface CreateRecommenderRequest {
795
+ /**
796
+ * <p>The name of the recommender.</p>
797
+ */
798
+ name: string | undefined;
799
+ /**
800
+ * <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
801
+ */
802
+ datasetGroupArn: string | undefined;
803
+ /**
804
+ * <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group
805
+ * 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>.
806
+ * </p>
807
+ */
808
+ recipeArn: string | undefined;
809
+ /**
810
+ * <p>The configuration details of the recommender.</p>
811
+ */
812
+ recommenderConfig?: RecommenderConfig;
813
+ }
814
+ export declare namespace CreateRecommenderRequest {
815
+ /**
816
+ * @internal
817
+ */
818
+ const filterSensitiveLog: (obj: CreateRecommenderRequest) => any;
819
+ }
820
+ export interface CreateRecommenderResponse {
821
+ /**
822
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
823
+ */
824
+ recommenderArn?: string;
825
+ }
826
+ export declare namespace CreateRecommenderResponse {
827
+ /**
828
+ * @internal
829
+ */
830
+ const filterSensitiveLog: (obj: CreateRecommenderResponse) => any;
831
+ }
708
832
  export interface CreateSchemaRequest {
709
833
  /**
710
834
  * <p>The name for the schema.</p>
@@ -714,6 +838,11 @@ export interface CreateSchemaRequest {
714
838
  * <p>A schema in Avro JSON format.</p>
715
839
  */
716
840
  schema: string | undefined;
841
+ /**
842
+ * <p>The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify
843
+ * the domain you chose when you created the Domain dataset group.</p>
844
+ */
845
+ domain?: Domain | string;
717
846
  }
718
847
  export declare namespace CreateSchemaRequest {
719
848
  /**
@@ -1168,6 +1297,18 @@ export declare namespace DeleteFilterRequest {
1168
1297
  */
1169
1298
  const filterSensitiveLog: (obj: DeleteFilterRequest) => any;
1170
1299
  }
1300
+ export interface DeleteRecommenderRequest {
1301
+ /**
1302
+ * <p>The Amazon Resource Name (ARN) of the recommender to delete.</p>
1303
+ */
1304
+ recommenderArn: string | undefined;
1305
+ }
1306
+ export declare namespace DeleteRecommenderRequest {
1307
+ /**
1308
+ * @internal
1309
+ */
1310
+ const filterSensitiveLog: (obj: DeleteRecommenderRequest) => any;
1311
+ }
1171
1312
  export interface DeleteSchemaRequest {
1172
1313
  /**
1173
1314
  * <p>The Amazon Resource Name (ARN) of the schema to delete.</p>
@@ -1320,6 +1461,103 @@ export declare namespace DescribeBatchInferenceJobResponse {
1320
1461
  */
1321
1462
  const filterSensitiveLog: (obj: DescribeBatchInferenceJobResponse) => any;
1322
1463
  }
1464
+ export interface DescribeBatchSegmentJobRequest {
1465
+ /**
1466
+ * <p>The ARN of the batch segment job to describe.</p>
1467
+ */
1468
+ batchSegmentJobArn: string | undefined;
1469
+ }
1470
+ export declare namespace DescribeBatchSegmentJobRequest {
1471
+ /**
1472
+ * @internal
1473
+ */
1474
+ const filterSensitiveLog: (obj: DescribeBatchSegmentJobRequest) => any;
1475
+ }
1476
+ /**
1477
+ * <p>Contains information on a batch segment job.</p>
1478
+ */
1479
+ export interface BatchSegmentJob {
1480
+ /**
1481
+ * <p>The name of the batch segment job.</p>
1482
+ */
1483
+ jobName?: string;
1484
+ /**
1485
+ * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
1486
+ */
1487
+ batchSegmentJobArn?: string;
1488
+ /**
1489
+ * <p>The ARN of the filter used on the batch segment job.</p>
1490
+ */
1491
+ filterArn?: string;
1492
+ /**
1493
+ * <p>If the batch segment job failed, the reason for the failure.</p>
1494
+ */
1495
+ failureReason?: string;
1496
+ /**
1497
+ * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
1498
+ */
1499
+ solutionVersionArn?: string;
1500
+ /**
1501
+ * <p>The number of predicted users generated by the batch segment job for each line of input data.</p>
1502
+ */
1503
+ numResults?: number;
1504
+ /**
1505
+ * <p>The Amazon S3 path that leads to the input data used to generate the batch segment job.</p>
1506
+ */
1507
+ jobInput?: BatchSegmentJobInput;
1508
+ /**
1509
+ * <p>The Amazon S3 bucket that contains the output data generated by the batch segment job.</p>
1510
+ */
1511
+ jobOutput?: BatchSegmentJobOutput;
1512
+ /**
1513
+ * <p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.</p>
1514
+ */
1515
+ roleArn?: string;
1516
+ /**
1517
+ * <p>The status of the batch segment job. The status is one of the following values:</p>
1518
+ * <ul>
1519
+ * <li>
1520
+ * <p>PENDING</p>
1521
+ * </li>
1522
+ * <li>
1523
+ * <p>IN PROGRESS</p>
1524
+ * </li>
1525
+ * <li>
1526
+ * <p>ACTIVE</p>
1527
+ * </li>
1528
+ * <li>
1529
+ * <p>CREATE FAILED</p>
1530
+ * </li>
1531
+ * </ul>
1532
+ */
1533
+ status?: string;
1534
+ /**
1535
+ * <p>The time at which the batch segment job was created.</p>
1536
+ */
1537
+ creationDateTime?: Date;
1538
+ /**
1539
+ * <p>The time at which the batch segment job last updated.</p>
1540
+ */
1541
+ lastUpdatedDateTime?: Date;
1542
+ }
1543
+ export declare namespace BatchSegmentJob {
1544
+ /**
1545
+ * @internal
1546
+ */
1547
+ const filterSensitiveLog: (obj: BatchSegmentJob) => any;
1548
+ }
1549
+ export interface DescribeBatchSegmentJobResponse {
1550
+ /**
1551
+ * <p>Information on the specified batch segment job.</p>
1552
+ */
1553
+ batchSegmentJob?: BatchSegmentJob;
1554
+ }
1555
+ export declare namespace DescribeBatchSegmentJobResponse {
1556
+ /**
1557
+ * @internal
1558
+ */
1559
+ const filterSensitiveLog: (obj: DescribeBatchSegmentJobResponse) => any;
1560
+ }
1323
1561
  export interface DescribeCampaignRequest {
1324
1562
  /**
1325
1563
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
@@ -1383,7 +1621,7 @@ export declare namespace CampaignUpdateSummary {
1383
1621
  const filterSensitiveLog: (obj: CampaignUpdateSummary) => any;
1384
1622
  }
1385
1623
  /**
1386
- * <p>Describes a deployed solution version, otherwise known as a campaign.
1624
+ * <p>An object that describes the deployment of a solution version.
1387
1625
  * For more information on campaigns, see <a>CreateCampaign</a>.</p>
1388
1626
  */
1389
1627
  export interface Campaign {
@@ -1714,6 +1952,10 @@ export interface DatasetGroup {
1714
1952
  * <p>If creating a dataset group fails, provides the reason why.</p>
1715
1953
  */
1716
1954
  failureReason?: string;
1955
+ /**
1956
+ * <p>The domain of a Domain dataset group.</p>
1957
+ */
1958
+ domain?: Domain | string;
1717
1959
  }
1718
1960
  export declare namespace DatasetGroup {
1719
1961
  /**
@@ -2133,6 +2375,133 @@ export declare namespace DescribeRecipeResponse {
2133
2375
  */
2134
2376
  const filterSensitiveLog: (obj: DescribeRecipeResponse) => any;
2135
2377
  }
2378
+ export interface DescribeRecommenderRequest {
2379
+ /**
2380
+ * <p>The Amazon Resource Name (ARN) of the recommender to describe.</p>
2381
+ */
2382
+ recommenderArn: string | undefined;
2383
+ }
2384
+ export declare namespace DescribeRecommenderRequest {
2385
+ /**
2386
+ * @internal
2387
+ */
2388
+ const filterSensitiveLog: (obj: DescribeRecommenderRequest) => any;
2389
+ }
2390
+ /**
2391
+ * <p>Provides a summary of the properties of a recommender update. For a complete listing, call the
2392
+ * <a>DescribeRecommender</a> API.</p>
2393
+ */
2394
+ export interface RecommenderUpdateSummary {
2395
+ /**
2396
+ * <p>The configuration details of the recommender update.</p>
2397
+ */
2398
+ recommenderConfig?: RecommenderConfig;
2399
+ /**
2400
+ * <p>The date and time (in Unix format) that the recommender update was created.</p>
2401
+ */
2402
+ creationDateTime?: Date;
2403
+ /**
2404
+ * <p>The date and time (in Unix time) that the recommender update was last updated.</p>
2405
+ */
2406
+ lastUpdatedDateTime?: Date;
2407
+ /**
2408
+ * <p>The status of the recommender update.</p>
2409
+ * <p>A recommender can be in one of the following states:</p>
2410
+ * <ul>
2411
+ * <li>
2412
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
2413
+ * </li>
2414
+ * <li>
2415
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
2416
+ * </li>
2417
+ * </ul>
2418
+ */
2419
+ status?: string;
2420
+ /**
2421
+ * <p>If a recommender update fails, the reason behind the failure.</p>
2422
+ */
2423
+ failureReason?: string;
2424
+ }
2425
+ export declare namespace RecommenderUpdateSummary {
2426
+ /**
2427
+ * @internal
2428
+ */
2429
+ const filterSensitiveLog: (obj: RecommenderUpdateSummary) => any;
2430
+ }
2431
+ /**
2432
+ * <p>Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group
2433
+ * 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>
2434
+ */
2435
+ export interface Recommender {
2436
+ /**
2437
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
2438
+ */
2439
+ recommenderArn?: string;
2440
+ /**
2441
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
2442
+ */
2443
+ datasetGroupArn?: string;
2444
+ /**
2445
+ * <p>The name of the recommender.</p>
2446
+ */
2447
+ name?: string;
2448
+ /**
2449
+ * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
2450
+ * </p>
2451
+ */
2452
+ recipeArn?: string;
2453
+ /**
2454
+ * <p>The configuration details of the recommender.</p>
2455
+ */
2456
+ recommenderConfig?: RecommenderConfig;
2457
+ /**
2458
+ * <p>The date and time (in Unix format) that the recommender was created.</p>
2459
+ */
2460
+ creationDateTime?: Date;
2461
+ /**
2462
+ * <p>The date and time (in Unix format) that the recommender was last updated.</p>
2463
+ */
2464
+ lastUpdatedDateTime?: Date;
2465
+ /**
2466
+ * <p>The status of the recommender.</p>
2467
+ * <p>A recommender can be in one of the following states:</p>
2468
+ * <ul>
2469
+ * <li>
2470
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
2471
+ * </li>
2472
+ * <li>
2473
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
2474
+ * </li>
2475
+ * </ul>
2476
+ */
2477
+ status?: string;
2478
+ /**
2479
+ * <p>If a recommender fails, the reason behind the failure.</p>
2480
+ */
2481
+ failureReason?: string;
2482
+ /**
2483
+ * <p>Provides a summary of the latest updates to the recommender. </p>
2484
+ */
2485
+ latestRecommenderUpdate?: RecommenderUpdateSummary;
2486
+ }
2487
+ export declare namespace Recommender {
2488
+ /**
2489
+ * @internal
2490
+ */
2491
+ const filterSensitiveLog: (obj: Recommender) => any;
2492
+ }
2493
+ export interface DescribeRecommenderResponse {
2494
+ /**
2495
+ * <p>The properties of the recommender.</p>
2496
+ */
2497
+ recommender?: Recommender;
2498
+ }
2499
+ export declare namespace DescribeRecommenderResponse {
2500
+ /**
2501
+ * @internal
2502
+ */
2503
+ const filterSensitiveLog: (obj: DescribeRecommenderResponse) => any;
2504
+ }
2136
2505
  export interface DescribeSchemaRequest {
2137
2506
  /**
2138
2507
  * <p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>
@@ -2170,6 +2539,10 @@ export interface DatasetSchema {
2170
2539
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
2171
2540
  */
2172
2541
  lastUpdatedDateTime?: Date;
2542
+ /**
2543
+ * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
2544
+ */
2545
+ domain?: Domain | string;
2173
2546
  }
2174
2547
  export declare namespace DatasetSchema {
2175
2548
  /**
@@ -2377,7 +2750,7 @@ export declare namespace TunedHPOParams {
2377
2750
  const filterSensitiveLog: (obj: TunedHPOParams) => any;
2378
2751
  }
2379
2752
  /**
2380
- * <p>An object that provides information about a specific version of a <a>Solution</a>.</p>
2753
+ * <p>An object that provides information about a specific version of a <a>Solution</a> in a Custom dataset group.</p>
2381
2754
  */
2382
2755
  export interface SolutionVersion {
2383
2756
  /**
@@ -2539,12 +2912,6 @@ export interface InvalidNextTokenException extends __SmithyException, $MetadataB
2539
2912
  $fault: "client";
2540
2913
  message?: string;
2541
2914
  }
2542
- export declare namespace InvalidNextTokenException {
2543
- /**
2544
- * @internal
2545
- */
2546
- const filterSensitiveLog: (obj: InvalidNextTokenException) => any;
2547
- }
2548
2915
  export interface ListBatchInferenceJobsRequest {
2549
2916
  /**
2550
2917
  * <p>The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs
@@ -2638,6 +3005,98 @@ export declare namespace ListBatchInferenceJobsResponse {
2638
3005
  */
2639
3006
  const filterSensitiveLog: (obj: ListBatchInferenceJobsResponse) => any;
2640
3007
  }
3008
+ export interface ListBatchSegmentJobsRequest {
3009
+ /**
3010
+ * <p>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</p>
3011
+ */
3012
+ solutionVersionArn?: string;
3013
+ /**
3014
+ * <p>The token to request the next page of results.</p>
3015
+ */
3016
+ nextToken?: string;
3017
+ /**
3018
+ * <p>The maximum number of batch segment job results to return in each page. The default
3019
+ * value is 100.</p>
3020
+ */
3021
+ maxResults?: number;
3022
+ }
3023
+ export declare namespace ListBatchSegmentJobsRequest {
3024
+ /**
3025
+ * @internal
3026
+ */
3027
+ const filterSensitiveLog: (obj: ListBatchSegmentJobsRequest) => any;
3028
+ }
3029
+ /**
3030
+ * <p>A truncated version of the <a>BatchSegmentJob</a> datatype. The <a>ListBatchSegmentJobs</a> operation returns a list of batch segment job
3031
+ * summaries.</p>
3032
+ */
3033
+ export interface BatchSegmentJobSummary {
3034
+ /**
3035
+ * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
3036
+ */
3037
+ batchSegmentJobArn?: string;
3038
+ /**
3039
+ * <p>The name of the batch segment job.</p>
3040
+ */
3041
+ jobName?: string;
3042
+ /**
3043
+ * <p>The status of the batch segment job. The status is one of the following values:</p>
3044
+ * <ul>
3045
+ * <li>
3046
+ * <p>PENDING</p>
3047
+ * </li>
3048
+ * <li>
3049
+ * <p>IN PROGRESS</p>
3050
+ * </li>
3051
+ * <li>
3052
+ * <p>ACTIVE</p>
3053
+ * </li>
3054
+ * <li>
3055
+ * <p>CREATE FAILED</p>
3056
+ * </li>
3057
+ * </ul>
3058
+ */
3059
+ status?: string;
3060
+ /**
3061
+ * <p>The time at which the batch segment job was created.</p>
3062
+ */
3063
+ creationDateTime?: Date;
3064
+ /**
3065
+ * <p>The time at which the batch segment job was last updated.</p>
3066
+ */
3067
+ lastUpdatedDateTime?: Date;
3068
+ /**
3069
+ * <p>If the batch segment job failed, the reason for the failure.</p>
3070
+ */
3071
+ failureReason?: string;
3072
+ /**
3073
+ * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
3074
+ */
3075
+ solutionVersionArn?: string;
3076
+ }
3077
+ export declare namespace BatchSegmentJobSummary {
3078
+ /**
3079
+ * @internal
3080
+ */
3081
+ const filterSensitiveLog: (obj: BatchSegmentJobSummary) => any;
3082
+ }
3083
+ export interface ListBatchSegmentJobsResponse {
3084
+ /**
3085
+ * <p>A list containing information on each job that is returned.</p>
3086
+ */
3087
+ batchSegmentJobs?: BatchSegmentJobSummary[];
3088
+ /**
3089
+ * <p>The token to use to retrieve the next page of results. The value is <code>null</code> when
3090
+ * there are no more results to return.</p>
3091
+ */
3092
+ nextToken?: string;
3093
+ }
3094
+ export declare namespace ListBatchSegmentJobsResponse {
3095
+ /**
3096
+ * @internal
3097
+ */
3098
+ const filterSensitiveLog: (obj: ListBatchSegmentJobsResponse) => any;
3099
+ }
2641
3100
  export interface ListCampaignsRequest {
2642
3101
  /**
2643
3102
  * <p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When
@@ -2855,6 +3314,10 @@ export interface DatasetGroupSummary {
2855
3314
  * <p>If creating a dataset group fails, the reason behind the failure.</p>
2856
3315
  */
2857
3316
  failureReason?: string;
3317
+ /**
3318
+ * <p>The domain of a Domain dataset group.</p>
3319
+ */
3320
+ domain?: Domain | string;
2858
3321
  }
2859
3322
  export declare namespace DatasetGroupSummary {
2860
3323
  /**
@@ -3226,6 +3689,13 @@ export interface ListRecipesRequest {
3226
3689
  * <p>The maximum number of recipes to return.</p>
3227
3690
  */
3228
3691
  maxResults?: number;
3692
+ /**
3693
+ * <p>
3694
+ * Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases)
3695
+ * for this domain are included in the response. If you don't specify a domain, only non-domain recipes are returned.
3696
+ * </p>
3697
+ */
3698
+ domain?: Domain | string;
3229
3699
  }
3230
3700
  export declare namespace ListRecipesRequest {
3231
3701
  /**
@@ -3258,6 +3728,10 @@ export interface RecipeSummary {
3258
3728
  * <p>The date and time (in Unix time) that the recipe was last updated.</p>
3259
3729
  */
3260
3730
  lastUpdatedDateTime?: Date;
3731
+ /**
3732
+ * <p>The domain of the recipe (if the recipe is a Domain dataset group use case).</p>
3733
+ */
3734
+ domain?: Domain | string;
3261
3735
  }
3262
3736
  export declare namespace RecipeSummary {
3263
3737
  /**
@@ -3281,6 +3755,95 @@ export declare namespace ListRecipesResponse {
3281
3755
  */
3282
3756
  const filterSensitiveLog: (obj: ListRecipesResponse) => any;
3283
3757
  }
3758
+ export interface ListRecommendersRequest {
3759
+ /**
3760
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When
3761
+ * a Domain dataset group is not specified, all the recommenders associated with the account are listed.</p>
3762
+ */
3763
+ datasetGroupArn?: string;
3764
+ /**
3765
+ * <p>A token returned from the previous call to <code>ListRecommenders</code> for getting
3766
+ * the next set of recommenders (if they exist).</p>
3767
+ */
3768
+ nextToken?: string;
3769
+ /**
3770
+ * <p>The maximum number of recommenders to return.</p>
3771
+ */
3772
+ maxResults?: number;
3773
+ }
3774
+ export declare namespace ListRecommendersRequest {
3775
+ /**
3776
+ * @internal
3777
+ */
3778
+ const filterSensitiveLog: (obj: ListRecommendersRequest) => any;
3779
+ }
3780
+ /**
3781
+ * <p>Provides a summary of the properties of the recommender.</p>
3782
+ */
3783
+ export interface RecommenderSummary {
3784
+ /**
3785
+ * <p>The name of the recommender.</p>
3786
+ */
3787
+ name?: string;
3788
+ /**
3789
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
3790
+ */
3791
+ recommenderArn?: string;
3792
+ /**
3793
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
3794
+ */
3795
+ datasetGroupArn?: string;
3796
+ /**
3797
+ * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.</p>
3798
+ */
3799
+ recipeArn?: string;
3800
+ /**
3801
+ * <p>The configuration details of the recommender.</p>
3802
+ */
3803
+ recommenderConfig?: RecommenderConfig;
3804
+ /**
3805
+ * <p>The status of the recommender. A recommender can be in one of the following states:</p>
3806
+ * <ul>
3807
+ * <li>
3808
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
3809
+ * </li>
3810
+ * <li>
3811
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
3812
+ * </li>
3813
+ * </ul>
3814
+ */
3815
+ status?: string;
3816
+ /**
3817
+ * <p>The date and time (in Unix format) that the recommender was created.</p>
3818
+ */
3819
+ creationDateTime?: Date;
3820
+ /**
3821
+ * <p>The date and time (in Unix format) that the recommender was last updated.</p>
3822
+ */
3823
+ lastUpdatedDateTime?: Date;
3824
+ }
3825
+ export declare namespace RecommenderSummary {
3826
+ /**
3827
+ * @internal
3828
+ */
3829
+ const filterSensitiveLog: (obj: RecommenderSummary) => any;
3830
+ }
3831
+ export interface ListRecommendersResponse {
3832
+ /**
3833
+ * <p>A list of the recommenders.</p>
3834
+ */
3835
+ recommenders?: RecommenderSummary[];
3836
+ /**
3837
+ * <p>A token for getting the next set of recommenders (if they exist).</p>
3838
+ */
3839
+ nextToken?: string;
3840
+ }
3841
+ export declare namespace ListRecommendersResponse {
3842
+ /**
3843
+ * @internal
3844
+ */
3845
+ const filterSensitiveLog: (obj: ListRecommendersResponse) => any;
3846
+ }
3284
3847
  export interface ListSchemasRequest {
3285
3848
  /**
3286
3849
  * <p>A token returned from the previous call to <code>ListSchemas</code> for getting
@@ -3319,6 +3882,10 @@ export interface DatasetSchemaSummary {
3319
3882
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
3320
3883
  */
3321
3884
  lastUpdatedDateTime?: Date;
3885
+ /**
3886
+ * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
3887
+ */
3888
+ domain?: Domain | string;
3322
3889
  }
3323
3890
  export declare namespace DatasetSchemaSummary {
3324
3891
  /**
@@ -3506,3 +4073,31 @@ export declare namespace UpdateCampaignResponse {
3506
4073
  */
3507
4074
  const filterSensitiveLog: (obj: UpdateCampaignResponse) => any;
3508
4075
  }
4076
+ export interface UpdateRecommenderRequest {
4077
+ /**
4078
+ * <p>The Amazon Resource Name (ARN) of the recommender to modify.</p>
4079
+ */
4080
+ recommenderArn: string | undefined;
4081
+ /**
4082
+ * <p>The configuration details of the recommender.</p>
4083
+ */
4084
+ recommenderConfig: RecommenderConfig | undefined;
4085
+ }
4086
+ export declare namespace UpdateRecommenderRequest {
4087
+ /**
4088
+ * @internal
4089
+ */
4090
+ const filterSensitiveLog: (obj: UpdateRecommenderRequest) => any;
4091
+ }
4092
+ export interface UpdateRecommenderResponse {
4093
+ /**
4094
+ * <p>The same recommender Amazon Resource Name (ARN) as given in the request.</p>
4095
+ */
4096
+ recommenderArn?: string;
4097
+ }
4098
+ export declare namespace UpdateRecommenderResponse {
4099
+ /**
4100
+ * @internal
4101
+ */
4102
+ const filterSensitiveLog: (obj: UpdateRecommenderResponse) => any;
4103
+ }