@aws-sdk/client-personalize 3.141.0 → 3.150.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/dist-cjs/models/models_0.js +9 -4
- package/dist-cjs/protocols/Aws_json1_1.js +303 -501
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_json1_1.js +484 -503
- package/dist-types/Personalize.d.ts +87 -77
- package/dist-types/commands/CreateDatasetCommand.d.ts +8 -6
- package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +10 -13
- package/dist-types/commands/CreateDatasetGroupCommand.d.ts +20 -18
- package/dist-types/commands/CreateDatasetImportJobCommand.d.ts +20 -14
- package/dist-types/commands/DeleteDatasetCommand.d.ts +3 -2
- package/dist-types/commands/DeleteDatasetGroupCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDatasetCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +1 -2
- package/dist-types/commands/DescribeDatasetGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDatasetImportJobCommand.d.ts +1 -2
- package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +6 -5
- package/dist-types/commands/ListDatasetGroupsCommand.d.ts +3 -3
- package/dist-types/commands/ListDatasetImportJobsCommand.d.ts +6 -5
- package/dist-types/commands/ListDatasetsCommand.d.ts +3 -3
- package/dist-types/models/models_0.d.ts +144 -72
- package/dist-types/ts3.4/models/models_0.d.ts +10 -0
- package/package.json +11 -6
|
@@ -7,11 +7,12 @@ export interface ListDatasetImportJobsCommandInput extends ListDatasetImportJobs
|
|
|
7
7
|
export interface ListDatasetImportJobsCommandOutput extends ListDatasetImportJobsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
11
|
-
* specified, all the dataset import jobs associated with
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Returns a list of dataset import jobs that use the given dataset. When
|
|
11
|
+
* a dataset is not specified, all the dataset import jobs associated with
|
|
12
|
+
* the account are listed. The response provides the properties for each
|
|
13
|
+
* dataset import job, including the Amazon Resource Name (ARN). For more
|
|
14
|
+
* information on dataset import jobs, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>. For more information on datasets, see
|
|
15
|
+
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
15
16
|
* @example
|
|
16
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
18
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface ListDatasetsCommandInput extends ListDatasetsRequest {
|
|
|
7
7
|
export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
11
|
-
* the properties for each dataset, including the Amazon
|
|
12
|
-
* information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
10
|
+
* <p>Returns the list of datasets contained in the given dataset group. The
|
|
11
|
+
* response provides the properties for each dataset, including the Amazon
|
|
12
|
+
* Resource Name (ARN). For more information on datasets, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html">CreateDataset</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -426,12 +426,13 @@ export interface CreateDatasetRequest {
|
|
|
426
426
|
*/
|
|
427
427
|
name: string | undefined;
|
|
428
428
|
/**
|
|
429
|
-
* <p>The ARN of the schema to associate with the dataset. The schema
|
|
430
|
-
* fields.</p>
|
|
429
|
+
* <p>The ARN of the schema to associate with the dataset. The schema
|
|
430
|
+
* defines the dataset fields.</p>
|
|
431
431
|
*/
|
|
432
432
|
schemaArn: string | undefined;
|
|
433
433
|
/**
|
|
434
|
-
* <p>The Amazon Resource Name (ARN) of the dataset group to add the dataset
|
|
434
|
+
* <p>The Amazon Resource Name (ARN) of the dataset group to add the dataset
|
|
435
|
+
* to.</p>
|
|
435
436
|
*/
|
|
436
437
|
datasetGroupArn: string | undefined;
|
|
437
438
|
/**
|
|
@@ -481,19 +482,22 @@ export interface CreateDatasetExportJobRequest {
|
|
|
481
482
|
*/
|
|
482
483
|
jobName: string | undefined;
|
|
483
484
|
/**
|
|
484
|
-
* <p>The Amazon Resource Name (ARN) of the dataset that contains the data
|
|
485
|
+
* <p>The Amazon Resource Name (ARN) of the dataset that contains the data
|
|
486
|
+
* to export.</p>
|
|
485
487
|
*/
|
|
486
488
|
datasetArn: string | undefined;
|
|
487
489
|
/**
|
|
488
|
-
* <p>The data to export, based on how you imported the data. You can choose
|
|
489
|
-
* only <code>
|
|
490
|
-
*
|
|
490
|
+
* <p>The data to export, based on how you imported the data. You can choose
|
|
491
|
+
* to export only <code>BULK</code> data that you imported using a dataset
|
|
492
|
+
* import job, only <code>PUT</code> data that you imported incrementally
|
|
493
|
+
* (using the console, PutEvents, PutUsers and PutItems operations), or
|
|
494
|
+
* <code>ALL</code> for both types. The default value is <code>PUT</code>.
|
|
491
495
|
* </p>
|
|
492
496
|
*/
|
|
493
497
|
ingestionMode?: IngestionMode | string;
|
|
494
498
|
/**
|
|
495
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role that has
|
|
496
|
-
* output Amazon S3 bucket.</p>
|
|
499
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that has
|
|
500
|
+
* permissions to add data to your output Amazon S3 bucket.</p>
|
|
497
501
|
*/
|
|
498
502
|
roleArn: string | undefined;
|
|
499
503
|
/**
|
|
@@ -521,19 +525,22 @@ export interface CreateDatasetGroupRequest {
|
|
|
521
525
|
*/
|
|
522
526
|
name: string | undefined;
|
|
523
527
|
/**
|
|
524
|
-
* <p>The ARN of the Identity and Access Management (IAM) role that has permissions to access
|
|
525
|
-
* role is only valid when also
|
|
528
|
+
* <p>The ARN of the Identity and Access Management (IAM) role that has permissions to access
|
|
529
|
+
* the Key Management Service (KMS) key. Supplying an IAM role is only valid when also
|
|
530
|
+
* specifying a KMS key.</p>
|
|
526
531
|
*/
|
|
527
532
|
roleArn?: string;
|
|
528
533
|
/**
|
|
529
|
-
* <p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to
|
|
534
|
+
* <p>The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to
|
|
535
|
+
* encrypt the datasets.</p>
|
|
530
536
|
*/
|
|
531
537
|
kmsKeyArn?: string;
|
|
532
538
|
/**
|
|
533
|
-
* <p>The domain of the dataset group. Specify a domain to create a
|
|
534
|
-
*
|
|
535
|
-
*
|
|
536
|
-
*
|
|
539
|
+
* <p>The domain of the dataset group. Specify a domain to create a
|
|
540
|
+
* Domain dataset group. The domain you specify determines the default
|
|
541
|
+
* schemas for datasets and the use cases available for recommenders. If you
|
|
542
|
+
* don't specify a domain, you create a Custom dataset group with solution
|
|
543
|
+
* versions that you deploy with a campaign. </p>
|
|
537
544
|
*/
|
|
538
545
|
domain?: Domain | string;
|
|
539
546
|
/**
|
|
@@ -552,18 +559,23 @@ export interface CreateDatasetGroupResponse {
|
|
|
552
559
|
domain?: Domain | string;
|
|
553
560
|
}
|
|
554
561
|
/**
|
|
555
|
-
* <p>Describes the data source that contains the data to upload to a
|
|
562
|
+
* <p>Describes the data source that contains the data to upload to a
|
|
563
|
+
* dataset.</p>
|
|
556
564
|
*/
|
|
557
565
|
export interface DataSource {
|
|
558
566
|
/**
|
|
559
|
-
* <p>The path to the Amazon S3 bucket where the data that you want to upload to
|
|
560
|
-
* stored. For example: </p>
|
|
567
|
+
* <p>The path to the Amazon S3 bucket where the data that you want to upload to
|
|
568
|
+
* your dataset is stored. For example: </p>
|
|
561
569
|
* <p>
|
|
562
570
|
* <code>s3://bucket-name/folder-name/</code>
|
|
563
571
|
* </p>
|
|
564
572
|
*/
|
|
565
573
|
dataLocation?: string;
|
|
566
574
|
}
|
|
575
|
+
export declare enum ImportMode {
|
|
576
|
+
FULL = "FULL",
|
|
577
|
+
INCREMENTAL = "INCREMENTAL"
|
|
578
|
+
}
|
|
567
579
|
export interface CreateDatasetImportJobRequest {
|
|
568
580
|
/**
|
|
569
581
|
* <p>The name for the dataset import job.</p>
|
|
@@ -578,13 +590,31 @@ export interface CreateDatasetImportJobRequest {
|
|
|
578
590
|
*/
|
|
579
591
|
dataSource: DataSource | undefined;
|
|
580
592
|
/**
|
|
581
|
-
* <p>The ARN of the IAM role that has permissions to read from the Amazon S3
|
|
593
|
+
* <p>The ARN of the IAM role that has permissions to read from the Amazon S3
|
|
594
|
+
* data source.</p>
|
|
582
595
|
*/
|
|
583
596
|
roleArn: string | undefined;
|
|
584
597
|
/**
|
|
585
598
|
* <p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dev/tagging-resources.html">tags</a> to apply to the dataset import job.</p>
|
|
586
599
|
*/
|
|
587
600
|
tags?: Tag[];
|
|
601
|
+
/**
|
|
602
|
+
* <p>Specify how to add the new records to an existing dataset. The default
|
|
603
|
+
* import mode is <code>FULL</code>. If you haven't imported bulk records into the dataset previously, you
|
|
604
|
+
* can only specify <code>FULL</code>.</p>
|
|
605
|
+
* <ul>
|
|
606
|
+
* <li>
|
|
607
|
+
* <p>Specify <code>FULL</code> to overwrite all existing bulk data in
|
|
608
|
+
* your dataset. Data you imported individually is not replaced.</p>
|
|
609
|
+
* </li>
|
|
610
|
+
* <li>
|
|
611
|
+
* <p>Specify <code>INCREMENTAL</code> to append the new records to the
|
|
612
|
+
* existing data in your dataset. Amazon Personalize replaces any record with the
|
|
613
|
+
* same ID with the new one.</p>
|
|
614
|
+
* </li>
|
|
615
|
+
* </ul>
|
|
616
|
+
*/
|
|
617
|
+
importMode?: ImportMode | string;
|
|
588
618
|
}
|
|
589
619
|
export interface CreateDatasetImportJobResponse {
|
|
590
620
|
/**
|
|
@@ -1358,7 +1388,8 @@ export interface Dataset {
|
|
|
1358
1388
|
*/
|
|
1359
1389
|
name?: string;
|
|
1360
1390
|
/**
|
|
1361
|
-
* <p>The Amazon Resource Name (ARN) of the dataset that you want metadata
|
|
1391
|
+
* <p>The Amazon Resource Name (ARN) of the dataset that you want metadata
|
|
1392
|
+
* for.</p>
|
|
1362
1393
|
*/
|
|
1363
1394
|
datasetArn?: string;
|
|
1364
1395
|
/**
|
|
@@ -1389,7 +1420,8 @@ export interface Dataset {
|
|
|
1389
1420
|
* <p>A dataset can be in one of the following states:</p>
|
|
1390
1421
|
* <ul>
|
|
1391
1422
|
* <li>
|
|
1392
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1423
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1424
|
+
* FAILED</p>
|
|
1393
1425
|
* </li>
|
|
1394
1426
|
* <li>
|
|
1395
1427
|
* <p>DELETE PENDING > DELETE IN_PROGRESS</p>
|
|
@@ -1414,16 +1446,19 @@ export interface DescribeDatasetResponse {
|
|
|
1414
1446
|
}
|
|
1415
1447
|
export interface DescribeDatasetExportJobRequest {
|
|
1416
1448
|
/**
|
|
1417
|
-
* <p>The Amazon Resource Name (ARN) of the dataset export job to
|
|
1449
|
+
* <p>The Amazon Resource Name (ARN) of the dataset export job to
|
|
1450
|
+
* describe.</p>
|
|
1418
1451
|
*/
|
|
1419
1452
|
datasetExportJobArn: string | undefined;
|
|
1420
1453
|
}
|
|
1421
1454
|
/**
|
|
1422
|
-
* <p>Describes a job that exports a dataset to an Amazon S3 bucket. For more
|
|
1455
|
+
* <p>Describes a job that exports a dataset to an Amazon S3 bucket. For more
|
|
1456
|
+
* information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetExportJob.html">CreateDatasetExportJob</a>.</p>
|
|
1423
1457
|
* <p>A dataset export job can be in one of the following states:</p>
|
|
1424
1458
|
* <ul>
|
|
1425
1459
|
* <li>
|
|
1426
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1460
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1461
|
+
* FAILED</p>
|
|
1427
1462
|
* </li>
|
|
1428
1463
|
* </ul>
|
|
1429
1464
|
*/
|
|
@@ -1441,15 +1476,16 @@ export interface DatasetExportJob {
|
|
|
1441
1476
|
*/
|
|
1442
1477
|
datasetArn?: string;
|
|
1443
1478
|
/**
|
|
1444
|
-
* <p>The data to export, based on how you imported the data. You can choose
|
|
1445
|
-
* <code>
|
|
1446
|
-
*
|
|
1447
|
-
*
|
|
1479
|
+
* <p>The data to export, based on how you imported the data. You can choose
|
|
1480
|
+
* to export <code>BULK</code> data that you imported using a dataset import
|
|
1481
|
+
* job, <code>PUT</code> data that you imported incrementally (using the
|
|
1482
|
+
* console, PutEvents, PutUsers and PutItems operations), or <code>ALL</code>
|
|
1483
|
+
* for both types. The default value is <code>PUT</code>. </p>
|
|
1448
1484
|
*/
|
|
1449
1485
|
ingestionMode?: IngestionMode | string;
|
|
1450
1486
|
/**
|
|
1451
|
-
* <p>The Amazon Resource Name (ARN) of the IAM service role that has
|
|
1452
|
-
* output Amazon S3 bucket.</p>
|
|
1487
|
+
* <p>The Amazon Resource Name (ARN) of the IAM service role that has
|
|
1488
|
+
* permissions to add data to your output Amazon S3 bucket.</p>
|
|
1453
1489
|
*/
|
|
1454
1490
|
roleArn?: string;
|
|
1455
1491
|
/**
|
|
@@ -1457,24 +1493,28 @@ export interface DatasetExportJob {
|
|
|
1457
1493
|
* <p>A dataset export job can be in one of the following states:</p>
|
|
1458
1494
|
* <ul>
|
|
1459
1495
|
* <li>
|
|
1460
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1496
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1497
|
+
* FAILED</p>
|
|
1461
1498
|
* </li>
|
|
1462
1499
|
* </ul>
|
|
1463
1500
|
*/
|
|
1464
1501
|
status?: string;
|
|
1465
1502
|
/**
|
|
1466
|
-
* <p>The path to the Amazon S3 bucket where the job's output is stored.
|
|
1503
|
+
* <p>The path to the Amazon S3 bucket where the job's output is stored. For
|
|
1504
|
+
* example:</p>
|
|
1467
1505
|
* <p>
|
|
1468
1506
|
* <code>s3://bucket-name/folder-name/</code>
|
|
1469
1507
|
* </p>
|
|
1470
1508
|
*/
|
|
1471
1509
|
jobOutput?: DatasetExportJobOutput;
|
|
1472
1510
|
/**
|
|
1473
|
-
* <p>The creation date and time (in Unix time) of the dataset export
|
|
1511
|
+
* <p>The creation date and time (in Unix time) of the dataset export
|
|
1512
|
+
* job.</p>
|
|
1474
1513
|
*/
|
|
1475
1514
|
creationDateTime?: Date;
|
|
1476
1515
|
/**
|
|
1477
|
-
* <p>The date and time (in Unix time) the status of the dataset export job
|
|
1516
|
+
* <p>The date and time (in Unix time) the status of the dataset export job
|
|
1517
|
+
* was last updated.</p>
|
|
1478
1518
|
*/
|
|
1479
1519
|
lastUpdatedDateTime?: Date;
|
|
1480
1520
|
/**
|
|
@@ -1505,17 +1545,19 @@ export interface DescribeDatasetExportJobResponse {
|
|
|
1505
1545
|
}
|
|
1506
1546
|
export interface DescribeDatasetGroupRequest {
|
|
1507
1547
|
/**
|
|
1508
|
-
* <p>The Amazon Resource Name (ARN) of the dataset group to
|
|
1548
|
+
* <p>The Amazon Resource Name (ARN) of the dataset group to
|
|
1549
|
+
* describe.</p>
|
|
1509
1550
|
*/
|
|
1510
1551
|
datasetGroupArn: string | undefined;
|
|
1511
1552
|
}
|
|
1512
1553
|
/**
|
|
1513
|
-
* <p>A dataset group is a collection of related datasets (Interactions,
|
|
1514
|
-
* 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
|
|
1515
|
-
* dataset
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1518
|
-
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
1554
|
+
* <p>A dataset group is a collection of related datasets (Interactions,
|
|
1555
|
+
* 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
|
|
1556
|
+
* 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
|
|
1557
|
+
* solution by calling <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html">CreateSolution</a>. A dataset group can contain only one of each
|
|
1558
|
+
* type of dataset.</p>
|
|
1559
|
+
* <p>You can specify an Key Management Service (KMS) key to encrypt the datasets in
|
|
1560
|
+
* the group.</p>
|
|
1519
1561
|
*/
|
|
1520
1562
|
export interface DatasetGroup {
|
|
1521
1563
|
/**
|
|
@@ -1531,7 +1573,8 @@ export interface DatasetGroup {
|
|
|
1531
1573
|
* <p>A dataset group can be in one of the following states:</p>
|
|
1532
1574
|
* <ul>
|
|
1533
1575
|
* <li>
|
|
1534
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1576
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1577
|
+
* FAILED</p>
|
|
1535
1578
|
* </li>
|
|
1536
1579
|
* <li>
|
|
1537
1580
|
* <p>DELETE PENDING</p>
|
|
@@ -1540,11 +1583,13 @@ export interface DatasetGroup {
|
|
|
1540
1583
|
*/
|
|
1541
1584
|
status?: string;
|
|
1542
1585
|
/**
|
|
1543
|
-
* <p>The ARN of the IAM role that has permissions to create the dataset
|
|
1586
|
+
* <p>The ARN of the IAM role that has permissions to create the dataset
|
|
1587
|
+
* group.</p>
|
|
1544
1588
|
*/
|
|
1545
1589
|
roleArn?: string;
|
|
1546
1590
|
/**
|
|
1547
|
-
* <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to
|
|
1591
|
+
* <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to
|
|
1592
|
+
* encrypt the datasets.</p>
|
|
1548
1593
|
*/
|
|
1549
1594
|
kmsKeyArn?: string;
|
|
1550
1595
|
/**
|
|
@@ -1552,7 +1597,8 @@ export interface DatasetGroup {
|
|
|
1552
1597
|
*/
|
|
1553
1598
|
creationDateTime?: Date;
|
|
1554
1599
|
/**
|
|
1555
|
-
* <p>The last update date and time (in Unix time) of the dataset
|
|
1600
|
+
* <p>The last update date and time (in Unix time) of the dataset
|
|
1601
|
+
* group.</p>
|
|
1556
1602
|
*/
|
|
1557
1603
|
lastUpdatedDateTime?: Date;
|
|
1558
1604
|
/**
|
|
@@ -1572,17 +1618,19 @@ export interface DescribeDatasetGroupResponse {
|
|
|
1572
1618
|
}
|
|
1573
1619
|
export interface DescribeDatasetImportJobRequest {
|
|
1574
1620
|
/**
|
|
1575
|
-
* <p>The Amazon Resource Name (ARN) of the dataset import job to
|
|
1621
|
+
* <p>The Amazon Resource Name (ARN) of the dataset import job to
|
|
1622
|
+
* describe.</p>
|
|
1576
1623
|
*/
|
|
1577
1624
|
datasetImportJobArn: string | undefined;
|
|
1578
1625
|
}
|
|
1579
1626
|
/**
|
|
1580
|
-
* <p>Describes a job that imports training data from a data source (Amazon S3
|
|
1581
|
-
* Amazon Personalize dataset. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a>.</p>
|
|
1627
|
+
* <p>Describes a job that imports training data from a data source (Amazon S3
|
|
1628
|
+
* 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>
|
|
1582
1629
|
* <p>A dataset import job can be in one of the following states:</p>
|
|
1583
1630
|
* <ul>
|
|
1584
1631
|
* <li>
|
|
1585
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1632
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1633
|
+
* FAILED</p>
|
|
1586
1634
|
* </li>
|
|
1587
1635
|
* </ul>
|
|
1588
1636
|
*/
|
|
@@ -1596,7 +1644,8 @@ export interface DatasetImportJob {
|
|
|
1596
1644
|
*/
|
|
1597
1645
|
datasetImportJobArn?: string;
|
|
1598
1646
|
/**
|
|
1599
|
-
* <p>The Amazon Resource Name (ARN) of the dataset that receives the
|
|
1647
|
+
* <p>The Amazon Resource Name (ARN) of the dataset that receives the
|
|
1648
|
+
* imported data.</p>
|
|
1600
1649
|
*/
|
|
1601
1650
|
datasetArn?: string;
|
|
1602
1651
|
/**
|
|
@@ -1604,8 +1653,8 @@ export interface DatasetImportJob {
|
|
|
1604
1653
|
*/
|
|
1605
1654
|
dataSource?: DataSource;
|
|
1606
1655
|
/**
|
|
1607
|
-
* <p>The ARN of the IAM role that has permissions to read from the Amazon S3
|
|
1608
|
-
* source.</p>
|
|
1656
|
+
* <p>The ARN of the IAM role that has permissions to read from the Amazon S3
|
|
1657
|
+
* data source.</p>
|
|
1609
1658
|
*/
|
|
1610
1659
|
roleArn?: string;
|
|
1611
1660
|
/**
|
|
@@ -1613,13 +1662,15 @@ export interface DatasetImportJob {
|
|
|
1613
1662
|
* <p>A dataset import job can be in one of the following states:</p>
|
|
1614
1663
|
* <ul>
|
|
1615
1664
|
* <li>
|
|
1616
|
-
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1665
|
+
* <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE
|
|
1666
|
+
* FAILED</p>
|
|
1617
1667
|
* </li>
|
|
1618
1668
|
* </ul>
|
|
1619
1669
|
*/
|
|
1620
1670
|
status?: string;
|
|
1621
1671
|
/**
|
|
1622
|
-
* <p>The creation date and time (in Unix time) of the dataset import
|
|
1672
|
+
* <p>The creation date and time (in Unix time) of the dataset import
|
|
1673
|
+
* job.</p>
|
|
1623
1674
|
*/
|
|
1624
1675
|
creationDateTime?: Date;
|
|
1625
1676
|
/**
|
|
@@ -1630,6 +1681,11 @@ export interface DatasetImportJob {
|
|
|
1630
1681
|
* <p>If a dataset import job fails, provides the reason why.</p>
|
|
1631
1682
|
*/
|
|
1632
1683
|
failureReason?: string;
|
|
1684
|
+
/**
|
|
1685
|
+
* <p>The import mode used by the dataset import job to import new
|
|
1686
|
+
* records.</p>
|
|
1687
|
+
*/
|
|
1688
|
+
importMode?: ImportMode | string;
|
|
1633
1689
|
}
|
|
1634
1690
|
export interface DescribeDatasetImportJobResponse {
|
|
1635
1691
|
/**
|
|
@@ -2540,12 +2596,14 @@ export interface ListCampaignsResponse {
|
|
|
2540
2596
|
}
|
|
2541
2597
|
export interface ListDatasetExportJobsRequest {
|
|
2542
2598
|
/**
|
|
2543
|
-
* <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
2599
|
+
* <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
2600
|
+
* export jobs for.</p>
|
|
2544
2601
|
*/
|
|
2545
2602
|
datasetArn?: string;
|
|
2546
2603
|
/**
|
|
2547
|
-
* <p>A token returned from the previous call to
|
|
2548
|
-
*
|
|
2604
|
+
* <p>A token returned from the previous call to
|
|
2605
|
+
* <code>ListDatasetExportJobs</code> for getting the next set of dataset
|
|
2606
|
+
* export jobs (if they exist).</p>
|
|
2549
2607
|
*/
|
|
2550
2608
|
nextToken?: string;
|
|
2551
2609
|
/**
|
|
@@ -2595,14 +2653,16 @@ export interface ListDatasetExportJobsResponse {
|
|
|
2595
2653
|
*/
|
|
2596
2654
|
datasetExportJobs?: DatasetExportJobSummary[];
|
|
2597
2655
|
/**
|
|
2598
|
-
* <p>A token for getting the next set of dataset export jobs (if they
|
|
2656
|
+
* <p>A token for getting the next set of dataset export jobs (if they
|
|
2657
|
+
* exist).</p>
|
|
2599
2658
|
*/
|
|
2600
2659
|
nextToken?: string;
|
|
2601
2660
|
}
|
|
2602
2661
|
export interface ListDatasetGroupsRequest {
|
|
2603
2662
|
/**
|
|
2604
|
-
* <p>A token returned from the previous call to
|
|
2605
|
-
*
|
|
2663
|
+
* <p>A token returned from the previous call to
|
|
2664
|
+
* <code>ListDatasetGroups</code> for getting the next set of dataset
|
|
2665
|
+
* groups (if they exist).</p>
|
|
2606
2666
|
*/
|
|
2607
2667
|
nextToken?: string;
|
|
2608
2668
|
/**
|
|
@@ -2659,18 +2719,21 @@ export interface ListDatasetGroupsResponse {
|
|
|
2659
2719
|
*/
|
|
2660
2720
|
datasetGroups?: DatasetGroupSummary[];
|
|
2661
2721
|
/**
|
|
2662
|
-
* <p>A token for getting the next set of dataset groups (if they
|
|
2722
|
+
* <p>A token for getting the next set of dataset groups (if they
|
|
2723
|
+
* exist).</p>
|
|
2663
2724
|
*/
|
|
2664
2725
|
nextToken?: string;
|
|
2665
2726
|
}
|
|
2666
2727
|
export interface ListDatasetImportJobsRequest {
|
|
2667
2728
|
/**
|
|
2668
|
-
* <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
2729
|
+
* <p>The Amazon Resource Name (ARN) of the dataset to list the dataset
|
|
2730
|
+
* import jobs for.</p>
|
|
2669
2731
|
*/
|
|
2670
2732
|
datasetArn?: string;
|
|
2671
2733
|
/**
|
|
2672
|
-
* <p>A token returned from the previous call to
|
|
2673
|
-
*
|
|
2734
|
+
* <p>A token returned from the previous call to
|
|
2735
|
+
* <code>ListDatasetImportJobs</code> for getting the next set of dataset
|
|
2736
|
+
* import jobs (if they exist).</p>
|
|
2674
2737
|
*/
|
|
2675
2738
|
nextToken?: string;
|
|
2676
2739
|
/**
|
|
@@ -2713,6 +2776,13 @@ export interface DatasetImportJobSummary {
|
|
|
2713
2776
|
* <p>If a dataset import job fails, the reason behind the failure.</p>
|
|
2714
2777
|
*/
|
|
2715
2778
|
failureReason?: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* <p>The import mode the dataset import job used to update the data in the dataset.
|
|
2781
|
+
* For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/updating-existing-bulk-data.html">Updating existing bulk
|
|
2782
|
+
* data</a>.
|
|
2783
|
+
* </p>
|
|
2784
|
+
*/
|
|
2785
|
+
importMode?: ImportMode | string;
|
|
2716
2786
|
}
|
|
2717
2787
|
export interface ListDatasetImportJobsResponse {
|
|
2718
2788
|
/**
|
|
@@ -2720,19 +2790,21 @@ export interface ListDatasetImportJobsResponse {
|
|
|
2720
2790
|
*/
|
|
2721
2791
|
datasetImportJobs?: DatasetImportJobSummary[];
|
|
2722
2792
|
/**
|
|
2723
|
-
* <p>A token for getting the next set of dataset import jobs (if they
|
|
2793
|
+
* <p>A token for getting the next set of dataset import jobs (if they
|
|
2794
|
+
* exist).</p>
|
|
2724
2795
|
*/
|
|
2725
2796
|
nextToken?: string;
|
|
2726
2797
|
}
|
|
2727
2798
|
export interface ListDatasetsRequest {
|
|
2728
2799
|
/**
|
|
2729
|
-
* <p>The Amazon Resource Name (ARN) of the dataset group that contains the
|
|
2730
|
-
* list.</p>
|
|
2800
|
+
* <p>The Amazon Resource Name (ARN) of the dataset group that contains the
|
|
2801
|
+
* datasets to list.</p>
|
|
2731
2802
|
*/
|
|
2732
2803
|
datasetGroupArn?: string;
|
|
2733
2804
|
/**
|
|
2734
|
-
* <p>A token returned from the previous call to
|
|
2735
|
-
*
|
|
2805
|
+
* <p>A token returned from the previous call to
|
|
2806
|
+
* <code>ListDatasetImportJobs</code> for getting the next set of dataset
|
|
2807
|
+
* import jobs (if they exist).</p>
|
|
2736
2808
|
*/
|
|
2737
2809
|
nextToken?: string;
|
|
2738
2810
|
/**
|
|
@@ -2795,8 +2867,8 @@ export interface DatasetSummary {
|
|
|
2795
2867
|
}
|
|
2796
2868
|
export interface ListDatasetsResponse {
|
|
2797
2869
|
/**
|
|
2798
|
-
* <p>An array of <code>Dataset</code> objects. Each object provides
|
|
2799
|
-
* information.</p>
|
|
2870
|
+
* <p>An array of <code>Dataset</code> objects. Each object provides
|
|
2871
|
+
* metadata information.</p>
|
|
2800
2872
|
*/
|
|
2801
2873
|
datasets?: DatasetSummary[];
|
|
2802
2874
|
/**
|
|
@@ -289,6 +289,10 @@ export interface DataSource {
|
|
|
289
289
|
|
|
290
290
|
dataLocation?: string;
|
|
291
291
|
}
|
|
292
|
+
export declare enum ImportMode {
|
|
293
|
+
FULL = "FULL",
|
|
294
|
+
INCREMENTAL = "INCREMENTAL"
|
|
295
|
+
}
|
|
292
296
|
export interface CreateDatasetImportJobRequest {
|
|
293
297
|
|
|
294
298
|
jobName: string | undefined;
|
|
@@ -300,6 +304,8 @@ export interface CreateDatasetImportJobRequest {
|
|
|
300
304
|
roleArn: string | undefined;
|
|
301
305
|
|
|
302
306
|
tags?: Tag[];
|
|
307
|
+
|
|
308
|
+
importMode?: ImportMode | string;
|
|
303
309
|
}
|
|
304
310
|
export interface CreateDatasetImportJobResponse {
|
|
305
311
|
|
|
@@ -771,6 +777,8 @@ export interface DatasetImportJob {
|
|
|
771
777
|
lastUpdatedDateTime?: Date;
|
|
772
778
|
|
|
773
779
|
failureReason?: string;
|
|
780
|
+
|
|
781
|
+
importMode?: ImportMode | string;
|
|
774
782
|
}
|
|
775
783
|
export interface DescribeDatasetImportJobResponse {
|
|
776
784
|
|
|
@@ -1240,6 +1248,8 @@ export interface DatasetImportJobSummary {
|
|
|
1240
1248
|
lastUpdatedDateTime?: Date;
|
|
1241
1249
|
|
|
1242
1250
|
failureReason?: string;
|
|
1251
|
+
|
|
1252
|
+
importMode?: ImportMode | string;
|
|
1243
1253
|
}
|
|
1244
1254
|
export interface ListDatasetImportJobsResponse {
|
|
1245
1255
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-personalize",
|
|
3
3
|
"description": "AWS SDK for JavaScript Personalize Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.150.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -18,9 +18,9 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
20
20
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
21
|
-
"@aws-sdk/client-sts": "3.
|
|
21
|
+
"@aws-sdk/client-sts": "3.150.0",
|
|
22
22
|
"@aws-sdk/config-resolver": "3.130.0",
|
|
23
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/credential-provider-node": "3.150.0",
|
|
24
24
|
"@aws-sdk/fetch-http-handler": "3.131.0",
|
|
25
25
|
"@aws-sdk/hash-node": "3.127.0",
|
|
26
26
|
"@aws-sdk/invalid-dependency": "3.127.0",
|
|
@@ -36,15 +36,15 @@
|
|
|
36
36
|
"@aws-sdk/node-config-provider": "3.127.0",
|
|
37
37
|
"@aws-sdk/node-http-handler": "3.127.0",
|
|
38
38
|
"@aws-sdk/protocol-http": "3.127.0",
|
|
39
|
-
"@aws-sdk/smithy-client": "3.
|
|
39
|
+
"@aws-sdk/smithy-client": "3.142.0",
|
|
40
40
|
"@aws-sdk/types": "3.127.0",
|
|
41
41
|
"@aws-sdk/url-parser": "3.127.0",
|
|
42
42
|
"@aws-sdk/util-base64-browser": "3.109.0",
|
|
43
43
|
"@aws-sdk/util-base64-node": "3.55.0",
|
|
44
44
|
"@aws-sdk/util-body-length-browser": "3.55.0",
|
|
45
45
|
"@aws-sdk/util-body-length-node": "3.55.0",
|
|
46
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
47
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
46
|
+
"@aws-sdk/util-defaults-mode-browser": "3.142.0",
|
|
47
|
+
"@aws-sdk/util-defaults-mode-node": "3.142.0",
|
|
48
48
|
"@aws-sdk/util-user-agent-browser": "3.127.0",
|
|
49
49
|
"@aws-sdk/util-user-agent-node": "3.127.0",
|
|
50
50
|
"@aws-sdk/util-utf8-browser": "3.109.0",
|
|
@@ -61,6 +61,11 @@
|
|
|
61
61
|
"typedoc": "0.19.2",
|
|
62
62
|
"typescript": "~4.6.2"
|
|
63
63
|
},
|
|
64
|
+
"overrides": {
|
|
65
|
+
"typedoc": {
|
|
66
|
+
"typescript": "~4.6.2"
|
|
67
|
+
}
|
|
68
|
+
},
|
|
64
69
|
"engines": {
|
|
65
70
|
"node": ">=12.0.0"
|
|
66
71
|
},
|