@aws-sdk/client-personalize 3.42.0 → 3.43.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 (68) hide show
  1. package/CHANGELOG.md +11 -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/models/models_0.js +147 -3
  13. package/dist-cjs/pagination/ListBatchSegmentJobsPaginator.js +35 -0
  14. package/dist-cjs/pagination/ListRecommendersPaginator.js +35 -0
  15. package/dist-cjs/pagination/index.js +2 -0
  16. package/dist-cjs/protocols/Aws_json1_1.js +891 -28
  17. package/dist-es/Personalize.js +120 -0
  18. package/dist-es/commands/CreateBatchSegmentJobCommand.js +39 -0
  19. package/dist-es/commands/CreateRecommenderCommand.js +39 -0
  20. package/dist-es/commands/DeleteRecommenderCommand.js +39 -0
  21. package/dist-es/commands/DescribeBatchSegmentJobCommand.js +39 -0
  22. package/dist-es/commands/DescribeRecommenderCommand.js +39 -0
  23. package/dist-es/commands/ListBatchSegmentJobsCommand.js +39 -0
  24. package/dist-es/commands/ListRecommendersCommand.js +39 -0
  25. package/dist-es/commands/UpdateRecommenderCommand.js +39 -0
  26. package/dist-es/commands/index.js +8 -0
  27. package/dist-es/models/models_0.js +97 -0
  28. package/dist-es/pagination/ListBatchSegmentJobsPaginator.js +74 -0
  29. package/dist-es/pagination/ListRecommendersPaginator.js +74 -0
  30. package/dist-es/pagination/index.js +2 -0
  31. package/dist-es/protocols/Aws_json1_1.js +944 -38
  32. package/dist-types/Personalize.d.ts +137 -8
  33. package/dist-types/PersonalizeClient.d.ts +10 -2
  34. package/dist-types/commands/CreateBatchSegmentJobCommand.d.ts +36 -0
  35. package/dist-types/commands/CreateCampaignCommand.d.ts +1 -1
  36. package/dist-types/commands/CreateDatasetGroupCommand.d.ts +8 -5
  37. package/dist-types/commands/CreateRecommenderCommand.d.ts +84 -0
  38. package/dist-types/commands/CreateSchemaCommand.d.ts +2 -1
  39. package/dist-types/commands/CreateSolutionVersionCommand.d.ts +1 -1
  40. package/dist-types/commands/DeleteRecommenderCommand.d.ts +36 -0
  41. package/dist-types/commands/DescribeBatchSegmentJobCommand.d.ts +37 -0
  42. package/dist-types/commands/DescribeRecommenderCommand.d.ts +47 -0
  43. package/dist-types/commands/ListBatchSegmentJobsCommand.d.ts +36 -0
  44. package/dist-types/commands/ListRecommendersCommand.d.ts +38 -0
  45. package/dist-types/commands/UpdateRecommenderCommand.d.ts +35 -0
  46. package/dist-types/commands/index.d.ts +8 -0
  47. package/dist-types/models/models_0.d.ts +634 -3
  48. package/dist-types/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
  49. package/dist-types/pagination/ListRecommendersPaginator.d.ts +4 -0
  50. package/dist-types/pagination/index.d.ts +2 -0
  51. package/dist-types/protocols/Aws_json1_1.d.ts +24 -0
  52. package/dist-types/ts3.4/Personalize.d.ts +40 -0
  53. package/dist-types/ts3.4/PersonalizeClient.d.ts +10 -2
  54. package/dist-types/ts3.4/commands/CreateBatchSegmentJobCommand.d.ts +17 -0
  55. package/dist-types/ts3.4/commands/CreateRecommenderCommand.d.ts +17 -0
  56. package/dist-types/ts3.4/commands/DeleteRecommenderCommand.d.ts +17 -0
  57. package/dist-types/ts3.4/commands/DescribeBatchSegmentJobCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/DescribeRecommenderCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/ListBatchSegmentJobsCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/ListRecommendersCommand.d.ts +17 -0
  61. package/dist-types/ts3.4/commands/UpdateRecommenderCommand.d.ts +17 -0
  62. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  63. package/dist-types/ts3.4/models/models_0.d.ts +322 -0
  64. package/dist-types/ts3.4/pagination/ListBatchSegmentJobsPaginator.d.ts +4 -0
  65. package/dist-types/ts3.4/pagination/ListRecommendersPaginator.d.ts +4 -0
  66. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  67. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  68. package/package.json +2 -2
@@ -380,12 +380,93 @@ export declare namespace ResourceNotFoundException {
380
380
  */
381
381
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
382
382
  }
383
+ /**
384
+ * <p>The input configuration of a batch segment job.</p>
385
+ */
386
+ export interface BatchSegmentJobInput {
387
+ /**
388
+ * <p>The configuration details of an Amazon S3 input or output bucket.</p>
389
+ */
390
+ s3DataSource: S3DataConfig | undefined;
391
+ }
392
+ export declare namespace BatchSegmentJobInput {
393
+ /**
394
+ * @internal
395
+ */
396
+ const filterSensitiveLog: (obj: BatchSegmentJobInput) => any;
397
+ }
398
+ /**
399
+ * <p>The output configuration parameters of a batch segment job.</p>
400
+ */
401
+ export interface BatchSegmentJobOutput {
402
+ /**
403
+ * <p>The configuration details of an Amazon S3 input or output bucket.</p>
404
+ */
405
+ s3DataDestination: S3DataConfig | undefined;
406
+ }
407
+ export declare namespace BatchSegmentJobOutput {
408
+ /**
409
+ * @internal
410
+ */
411
+ const filterSensitiveLog: (obj: BatchSegmentJobOutput) => any;
412
+ }
413
+ export interface CreateBatchSegmentJobRequest {
414
+ /**
415
+ * <p>The name of the batch segment job to create.</p>
416
+ */
417
+ jobName: string | undefined;
418
+ /**
419
+ * <p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate
420
+ * batch segments.</p>
421
+ */
422
+ solutionVersionArn: string | undefined;
423
+ /**
424
+ * <p>The ARN of the filter to apply to the batch segment job. For more information on using
425
+ * filters, see <a>filter-batch</a>.</p>
426
+ */
427
+ filterArn?: string;
428
+ /**
429
+ * <p>The number of predicted users generated by the batch segment job for each line of input data.</p>
430
+ */
431
+ numResults?: number;
432
+ /**
433
+ * <p>The Amazon S3 path for the input data used to generate the batch segment job.</p>
434
+ */
435
+ jobInput: BatchSegmentJobInput | undefined;
436
+ /**
437
+ * <p>The Amazon S3 path for the bucket where the job's output will be stored.</p>
438
+ */
439
+ jobOutput: BatchSegmentJobOutput | undefined;
440
+ /**
441
+ * <p>The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output
442
+ * Amazon S3 buckets respectively.</p>
443
+ */
444
+ roleArn: string | undefined;
445
+ }
446
+ export declare namespace CreateBatchSegmentJobRequest {
447
+ /**
448
+ * @internal
449
+ */
450
+ const filterSensitiveLog: (obj: CreateBatchSegmentJobRequest) => any;
451
+ }
452
+ export interface CreateBatchSegmentJobResponse {
453
+ /**
454
+ * <p>The ARN of the batch segment job.</p>
455
+ */
456
+ batchSegmentJobArn?: string;
457
+ }
458
+ export declare namespace CreateBatchSegmentJobResponse {
459
+ /**
460
+ * @internal
461
+ */
462
+ const filterSensitiveLog: (obj: CreateBatchSegmentJobResponse) => any;
463
+ }
383
464
  /**
384
465
  * <p>The configuration details of a campaign.</p>
385
466
  */
386
467
  export interface CampaignConfig {
387
468
  /**
388
- * <p>A string to string map specifying the exploration configuration hyperparameters, including <code>explorationWeight</code> and
469
+ * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
389
470
  * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
390
471
  * recommending items. Provide <code>itemExplorationConfig</code> data only if your solution uses the
391
472
  * <a href="https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html">User-Personalization</a> recipe.</p>
@@ -550,6 +631,10 @@ export declare namespace CreateDatasetExportJobResponse {
550
631
  */
551
632
  const filterSensitiveLog: (obj: CreateDatasetExportJobResponse) => any;
552
633
  }
634
+ export declare enum Domain {
635
+ ECOMMERCE = "ECOMMERCE",
636
+ VIDEO_ON_DEMAND = "VIDEO_ON_DEMAND"
637
+ }
553
638
  export interface CreateDatasetGroupRequest {
554
639
  /**
555
640
  * <p>The name for the new dataset group.</p>
@@ -564,6 +649,13 @@ export interface CreateDatasetGroupRequest {
564
649
  * <p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.</p>
565
650
  */
566
651
  kmsKeyArn?: string;
652
+ /**
653
+ * <p>The domain of the dataset group. Specify a domain to create a Domain dataset group. The domain you specify
654
+ * determines the default schemas for datasets and the use cases available for recommenders. If you don't specify a domain,
655
+ * you create a Custom dataset group with solution versions that you deploy with a campaign.
656
+ * </p>
657
+ */
658
+ domain?: Domain | string;
567
659
  }
568
660
  export declare namespace CreateDatasetGroupRequest {
569
661
  /**
@@ -576,6 +668,10 @@ export interface CreateDatasetGroupResponse {
576
668
  * <p>The Amazon Resource Name (ARN) of the new dataset group.</p>
577
669
  */
578
670
  datasetGroupArn?: string;
671
+ /**
672
+ * <p>The domain for the new Domain dataset group.</p>
673
+ */
674
+ domain?: Domain | string;
579
675
  }
580
676
  export declare namespace CreateDatasetGroupResponse {
581
677
  /**
@@ -705,6 +801,64 @@ export declare namespace CreateFilterResponse {
705
801
  */
706
802
  const filterSensitiveLog: (obj: CreateFilterResponse) => any;
707
803
  }
804
+ /**
805
+ * <p>The configuration details of the recommender.</p>
806
+ */
807
+ export interface RecommenderConfig {
808
+ /**
809
+ * <p>Specifies the exploration configuration hyperparameters, including <code>explorationWeight</code> and
810
+ * <code>explorationItemAgeCutOff</code>, you want to use to configure the amount of item exploration Amazon Personalize uses when
811
+ * recommending items. Provide <code>itemExplorationConfig</code> data only if your recommenders generate personalized recommendations for a user
812
+ * (not popular items or similar items).</p>
813
+ */
814
+ itemExplorationConfig?: {
815
+ [key: string]: string;
816
+ };
817
+ }
818
+ export declare namespace RecommenderConfig {
819
+ /**
820
+ * @internal
821
+ */
822
+ const filterSensitiveLog: (obj: RecommenderConfig) => any;
823
+ }
824
+ export interface CreateRecommenderRequest {
825
+ /**
826
+ * <p>The name of the recommender.</p>
827
+ */
828
+ name: string | undefined;
829
+ /**
830
+ * <p>The Amazon Resource Name (ARN) of the destination domain dataset group for the recommender.</p>
831
+ */
832
+ datasetGroupArn: string | undefined;
833
+ /**
834
+ * <p>The Amazon Resource Name (ARN) of the recipe that the recommender will use. For a recommender, a recipe is a Domain dataset group
835
+ * 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>.
836
+ * </p>
837
+ */
838
+ recipeArn: string | undefined;
839
+ /**
840
+ * <p>The configuration details of the recommender.</p>
841
+ */
842
+ recommenderConfig?: RecommenderConfig;
843
+ }
844
+ export declare namespace CreateRecommenderRequest {
845
+ /**
846
+ * @internal
847
+ */
848
+ const filterSensitiveLog: (obj: CreateRecommenderRequest) => any;
849
+ }
850
+ export interface CreateRecommenderResponse {
851
+ /**
852
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
853
+ */
854
+ recommenderArn?: string;
855
+ }
856
+ export declare namespace CreateRecommenderResponse {
857
+ /**
858
+ * @internal
859
+ */
860
+ const filterSensitiveLog: (obj: CreateRecommenderResponse) => any;
861
+ }
708
862
  export interface CreateSchemaRequest {
709
863
  /**
710
864
  * <p>The name for the schema.</p>
@@ -714,6 +868,11 @@ export interface CreateSchemaRequest {
714
868
  * <p>A schema in Avro JSON format.</p>
715
869
  */
716
870
  schema: string | undefined;
871
+ /**
872
+ * <p>The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify
873
+ * the domain you chose when you created the Domain dataset group.</p>
874
+ */
875
+ domain?: Domain | string;
717
876
  }
718
877
  export declare namespace CreateSchemaRequest {
719
878
  /**
@@ -1168,6 +1327,18 @@ export declare namespace DeleteFilterRequest {
1168
1327
  */
1169
1328
  const filterSensitiveLog: (obj: DeleteFilterRequest) => any;
1170
1329
  }
1330
+ export interface DeleteRecommenderRequest {
1331
+ /**
1332
+ * <p>The Amazon Resource Name (ARN) of the recommender to delete.</p>
1333
+ */
1334
+ recommenderArn: string | undefined;
1335
+ }
1336
+ export declare namespace DeleteRecommenderRequest {
1337
+ /**
1338
+ * @internal
1339
+ */
1340
+ const filterSensitiveLog: (obj: DeleteRecommenderRequest) => any;
1341
+ }
1171
1342
  export interface DeleteSchemaRequest {
1172
1343
  /**
1173
1344
  * <p>The Amazon Resource Name (ARN) of the schema to delete.</p>
@@ -1320,6 +1491,103 @@ export declare namespace DescribeBatchInferenceJobResponse {
1320
1491
  */
1321
1492
  const filterSensitiveLog: (obj: DescribeBatchInferenceJobResponse) => any;
1322
1493
  }
1494
+ export interface DescribeBatchSegmentJobRequest {
1495
+ /**
1496
+ * <p>The ARN of the batch segment job to describe.</p>
1497
+ */
1498
+ batchSegmentJobArn: string | undefined;
1499
+ }
1500
+ export declare namespace DescribeBatchSegmentJobRequest {
1501
+ /**
1502
+ * @internal
1503
+ */
1504
+ const filterSensitiveLog: (obj: DescribeBatchSegmentJobRequest) => any;
1505
+ }
1506
+ /**
1507
+ * <p>Contains information on a batch segment job.</p>
1508
+ */
1509
+ export interface BatchSegmentJob {
1510
+ /**
1511
+ * <p>The name of the batch segment job.</p>
1512
+ */
1513
+ jobName?: string;
1514
+ /**
1515
+ * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
1516
+ */
1517
+ batchSegmentJobArn?: string;
1518
+ /**
1519
+ * <p>The ARN of the filter used on the batch segment job.</p>
1520
+ */
1521
+ filterArn?: string;
1522
+ /**
1523
+ * <p>If the batch segment job failed, the reason for the failure.</p>
1524
+ */
1525
+ failureReason?: string;
1526
+ /**
1527
+ * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
1528
+ */
1529
+ solutionVersionArn?: string;
1530
+ /**
1531
+ * <p>The number of predicted users generated by the batch segment job for each line of input data.</p>
1532
+ */
1533
+ numResults?: number;
1534
+ /**
1535
+ * <p>The Amazon S3 path that leads to the input data used to generate the batch segment job.</p>
1536
+ */
1537
+ jobInput?: BatchSegmentJobInput;
1538
+ /**
1539
+ * <p>The Amazon S3 bucket that contains the output data generated by the batch segment job.</p>
1540
+ */
1541
+ jobOutput?: BatchSegmentJobOutput;
1542
+ /**
1543
+ * <p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.</p>
1544
+ */
1545
+ roleArn?: string;
1546
+ /**
1547
+ * <p>The status of the batch segment job. The status is one of the following values:</p>
1548
+ * <ul>
1549
+ * <li>
1550
+ * <p>PENDING</p>
1551
+ * </li>
1552
+ * <li>
1553
+ * <p>IN PROGRESS</p>
1554
+ * </li>
1555
+ * <li>
1556
+ * <p>ACTIVE</p>
1557
+ * </li>
1558
+ * <li>
1559
+ * <p>CREATE FAILED</p>
1560
+ * </li>
1561
+ * </ul>
1562
+ */
1563
+ status?: string;
1564
+ /**
1565
+ * <p>The time at which the batch segment job was created.</p>
1566
+ */
1567
+ creationDateTime?: Date;
1568
+ /**
1569
+ * <p>The time at which the batch segment job last updated.</p>
1570
+ */
1571
+ lastUpdatedDateTime?: Date;
1572
+ }
1573
+ export declare namespace BatchSegmentJob {
1574
+ /**
1575
+ * @internal
1576
+ */
1577
+ const filterSensitiveLog: (obj: BatchSegmentJob) => any;
1578
+ }
1579
+ export interface DescribeBatchSegmentJobResponse {
1580
+ /**
1581
+ * <p>Information on the specified batch segment job.</p>
1582
+ */
1583
+ batchSegmentJob?: BatchSegmentJob;
1584
+ }
1585
+ export declare namespace DescribeBatchSegmentJobResponse {
1586
+ /**
1587
+ * @internal
1588
+ */
1589
+ const filterSensitiveLog: (obj: DescribeBatchSegmentJobResponse) => any;
1590
+ }
1323
1591
  export interface DescribeCampaignRequest {
1324
1592
  /**
1325
1593
  * <p>The Amazon Resource Name (ARN) of the campaign.</p>
@@ -1383,7 +1651,7 @@ export declare namespace CampaignUpdateSummary {
1383
1651
  const filterSensitiveLog: (obj: CampaignUpdateSummary) => any;
1384
1652
  }
1385
1653
  /**
1386
- * <p>Describes a deployed solution version, otherwise known as a campaign.
1654
+ * <p>An object that describes the deployment of a solution version.
1387
1655
  * For more information on campaigns, see <a>CreateCampaign</a>.</p>
1388
1656
  */
1389
1657
  export interface Campaign {
@@ -1714,6 +1982,10 @@ export interface DatasetGroup {
1714
1982
  * <p>If creating a dataset group fails, provides the reason why.</p>
1715
1983
  */
1716
1984
  failureReason?: string;
1985
+ /**
1986
+ * <p>The domain of a Domain dataset group.</p>
1987
+ */
1988
+ domain?: Domain | string;
1717
1989
  }
1718
1990
  export declare namespace DatasetGroup {
1719
1991
  /**
@@ -2133,6 +2405,133 @@ export declare namespace DescribeRecipeResponse {
2133
2405
  */
2134
2406
  const filterSensitiveLog: (obj: DescribeRecipeResponse) => any;
2135
2407
  }
2408
+ export interface DescribeRecommenderRequest {
2409
+ /**
2410
+ * <p>The Amazon Resource Name (ARN) of the recommender to describe.</p>
2411
+ */
2412
+ recommenderArn: string | undefined;
2413
+ }
2414
+ export declare namespace DescribeRecommenderRequest {
2415
+ /**
2416
+ * @internal
2417
+ */
2418
+ const filterSensitiveLog: (obj: DescribeRecommenderRequest) => any;
2419
+ }
2420
+ /**
2421
+ * <p>Provides a summary of the properties of a recommender update. For a complete listing, call the
2422
+ * <a>DescribeRecommender</a> API.</p>
2423
+ */
2424
+ export interface RecommenderUpdateSummary {
2425
+ /**
2426
+ * <p>The configuration details of the recommender update.</p>
2427
+ */
2428
+ recommenderConfig?: RecommenderConfig;
2429
+ /**
2430
+ * <p>The date and time (in Unix format) that the recommender update was created.</p>
2431
+ */
2432
+ creationDateTime?: Date;
2433
+ /**
2434
+ * <p>The date and time (in Unix time) that the recommender update was last updated.</p>
2435
+ */
2436
+ lastUpdatedDateTime?: Date;
2437
+ /**
2438
+ * <p>The status of the recommender update.</p>
2439
+ * <p>A recommender can be in one of the following states:</p>
2440
+ * <ul>
2441
+ * <li>
2442
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
2443
+ * </li>
2444
+ * <li>
2445
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
2446
+ * </li>
2447
+ * </ul>
2448
+ */
2449
+ status?: string;
2450
+ /**
2451
+ * <p>If a recommender update fails, the reason behind the failure.</p>
2452
+ */
2453
+ failureReason?: string;
2454
+ }
2455
+ export declare namespace RecommenderUpdateSummary {
2456
+ /**
2457
+ * @internal
2458
+ */
2459
+ const filterSensitiveLog: (obj: RecommenderUpdateSummary) => any;
2460
+ }
2461
+ /**
2462
+ * <p>Describes a recommendation generator for a Domain dataset group. You create a recommender in a Domain dataset group
2463
+ * 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>
2464
+ */
2465
+ export interface Recommender {
2466
+ /**
2467
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
2468
+ */
2469
+ recommenderArn?: string;
2470
+ /**
2471
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
2472
+ */
2473
+ datasetGroupArn?: string;
2474
+ /**
2475
+ * <p>The name of the recommender.</p>
2476
+ */
2477
+ name?: string;
2478
+ /**
2479
+ * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.
2480
+ * </p>
2481
+ */
2482
+ recipeArn?: string;
2483
+ /**
2484
+ * <p>The configuration details of the recommender.</p>
2485
+ */
2486
+ recommenderConfig?: RecommenderConfig;
2487
+ /**
2488
+ * <p>The date and time (in Unix format) that the recommender was created.</p>
2489
+ */
2490
+ creationDateTime?: Date;
2491
+ /**
2492
+ * <p>The date and time (in Unix format) that the recommender was last updated.</p>
2493
+ */
2494
+ lastUpdatedDateTime?: Date;
2495
+ /**
2496
+ * <p>The status of the recommender.</p>
2497
+ * <p>A recommender can be in one of the following states:</p>
2498
+ * <ul>
2499
+ * <li>
2500
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
2501
+ * </li>
2502
+ * <li>
2503
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
2504
+ * </li>
2505
+ * </ul>
2506
+ */
2507
+ status?: string;
2508
+ /**
2509
+ * <p>If a recommender fails, the reason behind the failure.</p>
2510
+ */
2511
+ failureReason?: string;
2512
+ /**
2513
+ * <p>Provides a summary of the latest updates to the recommender. </p>
2514
+ */
2515
+ latestRecommenderUpdate?: RecommenderUpdateSummary;
2516
+ }
2517
+ export declare namespace Recommender {
2518
+ /**
2519
+ * @internal
2520
+ */
2521
+ const filterSensitiveLog: (obj: Recommender) => any;
2522
+ }
2523
+ export interface DescribeRecommenderResponse {
2524
+ /**
2525
+ * <p>The properties of the recommender.</p>
2526
+ */
2527
+ recommender?: Recommender;
2528
+ }
2529
+ export declare namespace DescribeRecommenderResponse {
2530
+ /**
2531
+ * @internal
2532
+ */
2533
+ const filterSensitiveLog: (obj: DescribeRecommenderResponse) => any;
2534
+ }
2136
2535
  export interface DescribeSchemaRequest {
2137
2536
  /**
2138
2537
  * <p>The Amazon Resource Name (ARN) of the schema to retrieve.</p>
@@ -2170,6 +2569,10 @@ export interface DatasetSchema {
2170
2569
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
2171
2570
  */
2172
2571
  lastUpdatedDateTime?: Date;
2572
+ /**
2573
+ * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
2574
+ */
2575
+ domain?: Domain | string;
2173
2576
  }
2174
2577
  export declare namespace DatasetSchema {
2175
2578
  /**
@@ -2377,7 +2780,7 @@ export declare namespace TunedHPOParams {
2377
2780
  const filterSensitiveLog: (obj: TunedHPOParams) => any;
2378
2781
  }
2379
2782
  /**
2380
- * <p>An object that provides information about a specific version of a <a>Solution</a>.</p>
2783
+ * <p>An object that provides information about a specific version of a <a>Solution</a> in a Custom dataset group.</p>
2381
2784
  */
2382
2785
  export interface SolutionVersion {
2383
2786
  /**
@@ -2638,6 +3041,98 @@ export declare namespace ListBatchInferenceJobsResponse {
2638
3041
  */
2639
3042
  const filterSensitiveLog: (obj: ListBatchInferenceJobsResponse) => any;
2640
3043
  }
3044
+ export interface ListBatchSegmentJobsRequest {
3045
+ /**
3046
+ * <p>The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.</p>
3047
+ */
3048
+ solutionVersionArn?: string;
3049
+ /**
3050
+ * <p>The token to request the next page of results.</p>
3051
+ */
3052
+ nextToken?: string;
3053
+ /**
3054
+ * <p>The maximum number of batch segment job results to return in each page. The default
3055
+ * value is 100.</p>
3056
+ */
3057
+ maxResults?: number;
3058
+ }
3059
+ export declare namespace ListBatchSegmentJobsRequest {
3060
+ /**
3061
+ * @internal
3062
+ */
3063
+ const filterSensitiveLog: (obj: ListBatchSegmentJobsRequest) => any;
3064
+ }
3065
+ /**
3066
+ * <p>A truncated version of the <a>BatchSegmentJob</a> datatype. The <a>ListBatchSegmentJobs</a> operation returns a list of batch segment job
3067
+ * summaries.</p>
3068
+ */
3069
+ export interface BatchSegmentJobSummary {
3070
+ /**
3071
+ * <p>The Amazon Resource Name (ARN) of the batch segment job.</p>
3072
+ */
3073
+ batchSegmentJobArn?: string;
3074
+ /**
3075
+ * <p>The name of the batch segment job.</p>
3076
+ */
3077
+ jobName?: string;
3078
+ /**
3079
+ * <p>The status of the batch segment job. The status is one of the following values:</p>
3080
+ * <ul>
3081
+ * <li>
3082
+ * <p>PENDING</p>
3083
+ * </li>
3084
+ * <li>
3085
+ * <p>IN PROGRESS</p>
3086
+ * </li>
3087
+ * <li>
3088
+ * <p>ACTIVE</p>
3089
+ * </li>
3090
+ * <li>
3091
+ * <p>CREATE FAILED</p>
3092
+ * </li>
3093
+ * </ul>
3094
+ */
3095
+ status?: string;
3096
+ /**
3097
+ * <p>The time at which the batch segment job was created.</p>
3098
+ */
3099
+ creationDateTime?: Date;
3100
+ /**
3101
+ * <p>The time at which the batch segment job was last updated.</p>
3102
+ */
3103
+ lastUpdatedDateTime?: Date;
3104
+ /**
3105
+ * <p>If the batch segment job failed, the reason for the failure.</p>
3106
+ */
3107
+ failureReason?: string;
3108
+ /**
3109
+ * <p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</p>
3110
+ */
3111
+ solutionVersionArn?: string;
3112
+ }
3113
+ export declare namespace BatchSegmentJobSummary {
3114
+ /**
3115
+ * @internal
3116
+ */
3117
+ const filterSensitiveLog: (obj: BatchSegmentJobSummary) => any;
3118
+ }
3119
+ export interface ListBatchSegmentJobsResponse {
3120
+ /**
3121
+ * <p>A list containing information on each job that is returned.</p>
3122
+ */
3123
+ batchSegmentJobs?: BatchSegmentJobSummary[];
3124
+ /**
3125
+ * <p>The token to use to retrieve the next page of results. The value is <code>null</code> when
3126
+ * there are no more results to return.</p>
3127
+ */
3128
+ nextToken?: string;
3129
+ }
3130
+ export declare namespace ListBatchSegmentJobsResponse {
3131
+ /**
3132
+ * @internal
3133
+ */
3134
+ const filterSensitiveLog: (obj: ListBatchSegmentJobsResponse) => any;
3135
+ }
2641
3136
  export interface ListCampaignsRequest {
2642
3137
  /**
2643
3138
  * <p>The Amazon Resource Name (ARN) of the solution to list the campaigns for. When
@@ -2855,6 +3350,10 @@ export interface DatasetGroupSummary {
2855
3350
  * <p>If creating a dataset group fails, the reason behind the failure.</p>
2856
3351
  */
2857
3352
  failureReason?: string;
3353
+ /**
3354
+ * <p>The domain of a Domain dataset group.</p>
3355
+ */
3356
+ domain?: Domain | string;
2858
3357
  }
2859
3358
  export declare namespace DatasetGroupSummary {
2860
3359
  /**
@@ -3226,6 +3725,13 @@ export interface ListRecipesRequest {
3226
3725
  * <p>The maximum number of recipes to return.</p>
3227
3726
  */
3228
3727
  maxResults?: number;
3728
+ /**
3729
+ * <p>
3730
+ * Filters returned recipes by domain for a Domain dataset group. Only recipes (Domain dataset group use cases)
3731
+ * for this domain are included in the response. If you don't specify a domain, only non-domain recipes are returned.
3732
+ * </p>
3733
+ */
3734
+ domain?: Domain | string;
3229
3735
  }
3230
3736
  export declare namespace ListRecipesRequest {
3231
3737
  /**
@@ -3258,6 +3764,10 @@ export interface RecipeSummary {
3258
3764
  * <p>The date and time (in Unix time) that the recipe was last updated.</p>
3259
3765
  */
3260
3766
  lastUpdatedDateTime?: Date;
3767
+ /**
3768
+ * <p>The domain of the recipe (if the recipe is a Domain dataset group use case).</p>
3769
+ */
3770
+ domain?: Domain | string;
3261
3771
  }
3262
3772
  export declare namespace RecipeSummary {
3263
3773
  /**
@@ -3281,6 +3791,95 @@ export declare namespace ListRecipesResponse {
3281
3791
  */
3282
3792
  const filterSensitiveLog: (obj: ListRecipesResponse) => any;
3283
3793
  }
3794
+ export interface ListRecommendersRequest {
3795
+ /**
3796
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group to list the recommenders for. When
3797
+ * a Domain dataset group is not specified, all the recommenders associated with the account are listed.</p>
3798
+ */
3799
+ datasetGroupArn?: string;
3800
+ /**
3801
+ * <p>A token returned from the previous call to <code>ListRecommenders</code> for getting
3802
+ * the next set of recommenders (if they exist).</p>
3803
+ */
3804
+ nextToken?: string;
3805
+ /**
3806
+ * <p>The maximum number of recommenders to return.</p>
3807
+ */
3808
+ maxResults?: number;
3809
+ }
3810
+ export declare namespace ListRecommendersRequest {
3811
+ /**
3812
+ * @internal
3813
+ */
3814
+ const filterSensitiveLog: (obj: ListRecommendersRequest) => any;
3815
+ }
3816
+ /**
3817
+ * <p>Provides a summary of the properties of the recommender.</p>
3818
+ */
3819
+ export interface RecommenderSummary {
3820
+ /**
3821
+ * <p>The name of the recommender.</p>
3822
+ */
3823
+ name?: string;
3824
+ /**
3825
+ * <p>The Amazon Resource Name (ARN) of the recommender.</p>
3826
+ */
3827
+ recommenderArn?: string;
3828
+ /**
3829
+ * <p>The Amazon Resource Name (ARN) of the Domain dataset group that contains the recommender.</p>
3830
+ */
3831
+ datasetGroupArn?: string;
3832
+ /**
3833
+ * <p>The Amazon Resource Name (ARN) of the recipe (Domain dataset group use case) that the recommender was created for.</p>
3834
+ */
3835
+ recipeArn?: string;
3836
+ /**
3837
+ * <p>The configuration details of the recommender.</p>
3838
+ */
3839
+ recommenderConfig?: RecommenderConfig;
3840
+ /**
3841
+ * <p>The status of the recommender. A recommender can be in one of the following states:</p>
3842
+ * <ul>
3843
+ * <li>
3844
+ * <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p>
3845
+ * </li>
3846
+ * <li>
3847
+ * <p>DELETE PENDING > DELETE IN_PROGRESS</p>
3848
+ * </li>
3849
+ * </ul>
3850
+ */
3851
+ status?: string;
3852
+ /**
3853
+ * <p>The date and time (in Unix format) that the recommender was created.</p>
3854
+ */
3855
+ creationDateTime?: Date;
3856
+ /**
3857
+ * <p>The date and time (in Unix format) that the recommender was last updated.</p>
3858
+ */
3859
+ lastUpdatedDateTime?: Date;
3860
+ }
3861
+ export declare namespace RecommenderSummary {
3862
+ /**
3863
+ * @internal
3864
+ */
3865
+ const filterSensitiveLog: (obj: RecommenderSummary) => any;
3866
+ }
3867
+ export interface ListRecommendersResponse {
3868
+ /**
3869
+ * <p>A list of the recommenders.</p>
3870
+ */
3871
+ recommenders?: RecommenderSummary[];
3872
+ /**
3873
+ * <p>A token for getting the next set of recommenders (if they exist).</p>
3874
+ */
3875
+ nextToken?: string;
3876
+ }
3877
+ export declare namespace ListRecommendersResponse {
3878
+ /**
3879
+ * @internal
3880
+ */
3881
+ const filterSensitiveLog: (obj: ListRecommendersResponse) => any;
3882
+ }
3284
3883
  export interface ListSchemasRequest {
3285
3884
  /**
3286
3885
  * <p>A token returned from the previous call to <code>ListSchemas</code> for getting
@@ -3319,6 +3918,10 @@ export interface DatasetSchemaSummary {
3319
3918
  * <p>The date and time (in Unix time) that the schema was last updated.</p>
3320
3919
  */
3321
3920
  lastUpdatedDateTime?: Date;
3921
+ /**
3922
+ * <p>The domain of a schema that you created for a dataset in a Domain dataset group.</p>
3923
+ */
3924
+ domain?: Domain | string;
3322
3925
  }
3323
3926
  export declare namespace DatasetSchemaSummary {
3324
3927
  /**
@@ -3506,3 +4109,31 @@ export declare namespace UpdateCampaignResponse {
3506
4109
  */
3507
4110
  const filterSensitiveLog: (obj: UpdateCampaignResponse) => any;
3508
4111
  }
4112
+ export interface UpdateRecommenderRequest {
4113
+ /**
4114
+ * <p>The Amazon Resource Name (ARN) of the recommender to modify.</p>
4115
+ */
4116
+ recommenderArn: string | undefined;
4117
+ /**
4118
+ * <p>The configuration details of the recommender.</p>
4119
+ */
4120
+ recommenderConfig: RecommenderConfig | undefined;
4121
+ }
4122
+ export declare namespace UpdateRecommenderRequest {
4123
+ /**
4124
+ * @internal
4125
+ */
4126
+ const filterSensitiveLog: (obj: UpdateRecommenderRequest) => any;
4127
+ }
4128
+ export interface UpdateRecommenderResponse {
4129
+ /**
4130
+ * <p>The same recommender Amazon Resource Name (ARN) as given in the request.</p>
4131
+ */
4132
+ recommenderArn?: string;
4133
+ }
4134
+ export declare namespace UpdateRecommenderResponse {
4135
+ /**
4136
+ * @internal
4137
+ */
4138
+ const filterSensitiveLog: (obj: UpdateRecommenderResponse) => any;
4139
+ }