@aws-sdk/client-rekognition 3.39.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 (123) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/dist-cjs/Rekognition.js +105 -0
  3. package/dist-cjs/commands/CreateDatasetCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteDatasetCommand.js +36 -0
  5. package/dist-cjs/commands/DescribeDatasetCommand.js +36 -0
  6. package/dist-cjs/commands/DistributeDatasetEntriesCommand.js +36 -0
  7. package/dist-cjs/commands/ListDatasetEntriesCommand.js +36 -0
  8. package/dist-cjs/commands/ListDatasetLabelsCommand.js +36 -0
  9. package/dist-cjs/commands/UpdateDatasetEntriesCommand.js +36 -0
  10. package/dist-cjs/commands/index.js +7 -0
  11. package/dist-cjs/endpoints.js +157 -24
  12. package/dist-cjs/models/models_0.js +170 -16
  13. package/dist-cjs/pagination/ListDatasetEntriesPaginator.js +35 -0
  14. package/dist-cjs/pagination/ListDatasetLabelsPaginator.js +35 -0
  15. package/dist-cjs/pagination/index.js +2 -0
  16. package/dist-cjs/protocols/Aws_json1_1.js +1077 -54
  17. package/dist-cjs/runtimeConfig.browser.js +6 -3
  18. package/dist-cjs/runtimeConfig.js +5 -3
  19. package/dist-es/Rekognition.js +105 -0
  20. package/dist-es/commands/CreateDatasetCommand.js +39 -0
  21. package/dist-es/commands/DeleteDatasetCommand.js +39 -0
  22. package/dist-es/commands/DescribeDatasetCommand.js +39 -0
  23. package/dist-es/commands/DistributeDatasetEntriesCommand.js +39 -0
  24. package/dist-es/commands/ListDatasetEntriesCommand.js +39 -0
  25. package/dist-es/commands/ListDatasetLabelsCommand.js +39 -0
  26. package/dist-es/commands/UpdateDatasetEntriesCommand.js +39 -0
  27. package/dist-es/commands/index.js +7 -0
  28. package/dist-es/endpoints.js +157 -24
  29. package/dist-es/models/models_0.js +117 -8
  30. package/dist-es/pagination/ListDatasetEntriesPaginator.js +74 -0
  31. package/dist-es/pagination/ListDatasetLabelsPaginator.js +74 -0
  32. package/dist-es/pagination/index.js +2 -0
  33. package/dist-es/protocols/Aws_json1_1.js +1111 -51
  34. package/dist-es/runtimeConfig.browser.js +3 -2
  35. package/dist-es/runtimeConfig.js +3 -3
  36. package/dist-types/Rekognition.d.ts +209 -29
  37. package/dist-types/RekognitionClient.d.ts +17 -2
  38. package/dist-types/commands/CompareFacesCommand.d.ts +1 -1
  39. package/dist-types/commands/CreateCollectionCommand.d.ts +1 -1
  40. package/dist-types/commands/CreateDatasetCommand.d.ts +59 -0
  41. package/dist-types/commands/CreateProjectCommand.d.ts +3 -3
  42. package/dist-types/commands/CreateProjectVersionCommand.d.ts +33 -5
  43. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +1 -1
  44. package/dist-types/commands/DeleteCollectionCommand.d.ts +1 -1
  45. package/dist-types/commands/DeleteDatasetCommand.d.ts +44 -0
  46. package/dist-types/commands/DeleteFacesCommand.d.ts +1 -1
  47. package/dist-types/commands/DeleteProjectCommand.d.ts +5 -1
  48. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +1 -1
  49. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +1 -1
  50. package/dist-types/commands/DescribeCollectionCommand.d.ts +1 -1
  51. package/dist-types/commands/DescribeDatasetCommand.d.ts +39 -0
  52. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +3 -3
  53. package/dist-types/commands/DescribeProjectsCommand.d.ts +2 -2
  54. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +1 -1
  55. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +1 -1
  56. package/dist-types/commands/DetectFacesCommand.d.ts +1 -1
  57. package/dist-types/commands/DetectLabelsCommand.d.ts +1 -1
  58. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +1 -1
  59. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +1 -1
  60. package/dist-types/commands/DetectTextCommand.d.ts +1 -1
  61. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +46 -0
  62. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +1 -1
  63. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +23 -18
  64. package/dist-types/commands/GetContentModerationCommand.d.ts +1 -1
  65. package/dist-types/commands/GetFaceDetectionCommand.d.ts +1 -1
  66. package/dist-types/commands/GetFaceSearchCommand.d.ts +1 -1
  67. package/dist-types/commands/GetLabelDetectionCommand.d.ts +1 -1
  68. package/dist-types/commands/GetPersonTrackingCommand.d.ts +1 -1
  69. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +1 -1
  70. package/dist-types/commands/GetTextDetectionCommand.d.ts +1 -1
  71. package/dist-types/commands/IndexFacesCommand.d.ts +1 -1
  72. package/dist-types/commands/ListCollectionsCommand.d.ts +1 -1
  73. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +49 -0
  74. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +40 -0
  75. package/dist-types/commands/ListFacesCommand.d.ts +1 -1
  76. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +1 -1
  77. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  78. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +4 -4
  79. package/dist-types/commands/SearchFacesByImageCommand.d.ts +1 -1
  80. package/dist-types/commands/SearchFacesCommand.d.ts +1 -1
  81. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +1 -1
  82. package/dist-types/commands/StartContentModerationCommand.d.ts +1 -1
  83. package/dist-types/commands/StartFaceDetectionCommand.d.ts +1 -1
  84. package/dist-types/commands/StartFaceSearchCommand.d.ts +1 -1
  85. package/dist-types/commands/StartLabelDetectionCommand.d.ts +1 -1
  86. package/dist-types/commands/StartPersonTrackingCommand.d.ts +1 -1
  87. package/dist-types/commands/StartProjectVersionCommand.d.ts +1 -1
  88. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -1
  89. package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -1
  90. package/dist-types/commands/StartTextDetectionCommand.d.ts +1 -1
  91. package/dist-types/commands/StopProjectVersionCommand.d.ts +1 -1
  92. package/dist-types/commands/StopStreamProcessorCommand.d.ts +1 -1
  93. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  94. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  95. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +62 -0
  96. package/dist-types/commands/index.d.ts +7 -0
  97. package/dist-types/models/models_0.d.ts +622 -51
  98. package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +4 -0
  99. package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +4 -0
  100. package/dist-types/pagination/index.d.ts +2 -0
  101. package/dist-types/protocols/Aws_json1_1.d.ts +21 -0
  102. package/dist-types/runtimeConfig.browser.d.ts +2 -0
  103. package/dist-types/runtimeConfig.d.ts +2 -0
  104. package/dist-types/runtimeConfig.native.d.ts +2 -0
  105. package/dist-types/ts3.4/Rekognition.d.ts +35 -0
  106. package/dist-types/ts3.4/RekognitionClient.d.ts +13 -2
  107. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +17 -0
  108. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +17 -0
  109. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +17 -0
  110. package/dist-types/ts3.4/commands/DistributeDatasetEntriesCommand.d.ts +17 -0
  111. package/dist-types/ts3.4/commands/ListDatasetEntriesCommand.d.ts +17 -0
  112. package/dist-types/ts3.4/commands/ListDatasetLabelsCommand.d.ts +17 -0
  113. package/dist-types/ts3.4/commands/UpdateDatasetEntriesCommand.d.ts +17 -0
  114. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  115. package/dist-types/ts3.4/models/models_0.d.ts +283 -23
  116. package/dist-types/ts3.4/pagination/ListDatasetEntriesPaginator.d.ts +4 -0
  117. package/dist-types/ts3.4/pagination/ListDatasetLabelsPaginator.d.ts +4 -0
  118. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  119. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +21 -0
  120. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
  121. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
  122. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
  123. package/package.json +24 -24
@@ -845,6 +845,10 @@ export interface CelebrityDetail {
845
845
  * <p>Face details for the recognized celebrity.</p>
846
846
  */
847
847
  Face?: FaceDetail;
848
+ /**
849
+ * <p>Retrieves the known gender for the celebrity.</p>
850
+ */
851
+ KnownGender?: KnownGender;
848
852
  }
849
853
  export declare namespace CelebrityDetail {
850
854
  /**
@@ -1349,30 +1353,84 @@ export declare namespace ServiceQuotaExceededException {
1349
1353
  */
1350
1354
  const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
1351
1355
  }
1352
- export interface CreateProjectRequest {
1356
+ /**
1357
+ * <p>
1358
+ * The source that Amazon Rekognition Custom Labels uses to create a dataset. To
1359
+ * use an Amazon Sagemaker format manifest file, specify the S3 bucket location in the <code>GroundTruthManifest</code> field.
1360
+ * The S3 bucket must be in your AWS account.
1361
+ * To create a copy of an existing dataset, specify the Amazon Resource Name (ARN) of
1362
+ * an existing dataset in <code>DatasetArn</code>.</p>
1363
+ * <p>You need to specify a value for <code>DatasetArn</code> or <code>GroundTruthManifest</code>, but not both.
1364
+ * if you supply both values, or if you don't specify any values, an InvalidParameterException exception occurs.
1365
+ * </p>
1366
+ * <p>For more information, see <a>CreateDataset</a>.</p>
1367
+ */
1368
+ export interface DatasetSource {
1353
1369
  /**
1354
- * <p>The name of the project to create.</p>
1370
+ * <p>The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
1371
+ * </p>
1355
1372
  */
1356
- ProjectName: string | undefined;
1373
+ GroundTruthManifest?: GroundTruthManifest;
1374
+ /**
1375
+ * <p>
1376
+ * The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.
1377
+ * </p>
1378
+ */
1379
+ DatasetArn?: string;
1357
1380
  }
1358
- export declare namespace CreateProjectRequest {
1381
+ export declare namespace DatasetSource {
1359
1382
  /**
1360
1383
  * @internal
1361
1384
  */
1362
- const filterSensitiveLog: (obj: CreateProjectRequest) => any;
1385
+ const filterSensitiveLog: (obj: DatasetSource) => any;
1363
1386
  }
1364
- export interface CreateProjectResponse {
1387
+ export declare enum DatasetType {
1388
+ TEST = "TEST",
1389
+ TRAIN = "TRAIN"
1390
+ }
1391
+ export interface CreateDatasetRequest {
1365
1392
  /**
1366
- * <p>The Amazon Resource Name (ARN) of the new project. You can use the ARN to
1367
- * configure IAM access to the project. </p>
1393
+ * <p>
1394
+ * The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location
1395
+ * of an Amazon Sagemaker format manifest file. If you don't specify <code>datasetSource</code>, an empty dataset is created.
1396
+ * To add labeled images to the dataset, You can use the console or call <a>UpdateDatasetEntries</a>.
1397
+ *
1398
+ * </p>
1368
1399
  */
1369
- ProjectArn?: string;
1400
+ DatasetSource?: DatasetSource;
1401
+ /**
1402
+ * <p>
1403
+ * The type of the dataset. Specify <code>train</code> to create a training dataset. Specify <code>test</code>
1404
+ * to create a test dataset.
1405
+ * </p>
1406
+ */
1407
+ DatasetType: DatasetType | string | undefined;
1408
+ /**
1409
+ * <p>
1410
+ * The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.
1411
+ * </p>
1412
+ */
1413
+ ProjectArn: string | undefined;
1370
1414
  }
1371
- export declare namespace CreateProjectResponse {
1415
+ export declare namespace CreateDatasetRequest {
1372
1416
  /**
1373
1417
  * @internal
1374
1418
  */
1375
- const filterSensitiveLog: (obj: CreateProjectResponse) => any;
1419
+ const filterSensitiveLog: (obj: CreateDatasetRequest) => any;
1420
+ }
1421
+ export interface CreateDatasetResponse {
1422
+ /**
1423
+ * <p>
1424
+ * The ARN of the created Amazon Rekognition Custom Labels dataset.
1425
+ * </p>
1426
+ */
1427
+ DatasetArn?: string;
1428
+ }
1429
+ export declare namespace CreateDatasetResponse {
1430
+ /**
1431
+ * @internal
1432
+ */
1433
+ const filterSensitiveLog: (obj: CreateDatasetResponse) => any;
1376
1434
  }
1377
1435
  /**
1378
1436
  * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
@@ -1395,6 +1453,50 @@ export declare namespace LimitExceededException {
1395
1453
  */
1396
1454
  const filterSensitiveLog: (obj: LimitExceededException) => any;
1397
1455
  }
1456
+ /**
1457
+ * <p>The resource specified in the request cannot be found.</p>
1458
+ */
1459
+ export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
1460
+ name: "ResourceNotFoundException";
1461
+ $fault: "client";
1462
+ Message?: string;
1463
+ Code?: string;
1464
+ /**
1465
+ * <p>A universally unique identifier (UUID) for the request.</p>
1466
+ */
1467
+ Logref?: string;
1468
+ }
1469
+ export declare namespace ResourceNotFoundException {
1470
+ /**
1471
+ * @internal
1472
+ */
1473
+ const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
1474
+ }
1475
+ export interface CreateProjectRequest {
1476
+ /**
1477
+ * <p>The name of the project to create.</p>
1478
+ */
1479
+ ProjectName: string | undefined;
1480
+ }
1481
+ export declare namespace CreateProjectRequest {
1482
+ /**
1483
+ * @internal
1484
+ */
1485
+ const filterSensitiveLog: (obj: CreateProjectRequest) => any;
1486
+ }
1487
+ export interface CreateProjectResponse {
1488
+ /**
1489
+ * <p>The Amazon Resource Name (ARN) of the new project. You can use the ARN to
1490
+ * configure IAM access to the project. </p>
1491
+ */
1492
+ ProjectArn?: string;
1493
+ }
1494
+ export declare namespace CreateProjectResponse {
1495
+ /**
1496
+ * @internal
1497
+ */
1498
+ const filterSensitiveLog: (obj: CreateProjectResponse) => any;
1499
+ }
1398
1500
  /**
1399
1501
  * <p>The specified resource is already being used.</p>
1400
1502
  */
@@ -1434,8 +1536,8 @@ export declare namespace OutputConfig {
1434
1536
  const filterSensitiveLog: (obj: OutputConfig) => any;
1435
1537
  }
1436
1538
  /**
1437
- * <p>The dataset used for testing. Optionally, if <code>AutoCreate</code> is set, Amazon Rekognition Custom Labels creates a
1438
- * testing dataset using an 80/20 split of the training dataset.</p>
1539
+ * <p>The dataset used for testing. Optionally, if <code>AutoCreate</code> is set, Amazon Rekognition Custom Labels uses the
1540
+ * training dataset to create a test dataset with a temporary split of the training dataset. </p>
1439
1541
  */
1440
1542
  export interface TestingData {
1441
1543
  /**
@@ -1443,7 +1545,8 @@ export interface TestingData {
1443
1545
  */
1444
1546
  Assets?: Asset[];
1445
1547
  /**
1446
- * <p>If specified, Amazon Rekognition Custom Labels creates a testing dataset with an 80/20 split of the training dataset.</p>
1548
+ * <p>If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job.
1549
+ * After training completes, the test dataset is not stored and the training dataset reverts to its previous size.</p>
1447
1550
  */
1448
1551
  AutoCreate?: boolean;
1449
1552
  }
@@ -1485,13 +1588,18 @@ export interface CreateProjectVersionRequest {
1485
1588
  */
1486
1589
  OutputConfig: OutputConfig | undefined;
1487
1590
  /**
1488
- * <p>The dataset to use for training. </p>
1591
+ * <p>Specifies an external manifest that the services uses to train the model.
1592
+ * If you specify <code>TrainingData</code> you must also specify <code>TestingData</code>.
1593
+ * The project must not have any associated datasets.
1594
+ * </p>
1489
1595
  */
1490
- TrainingData: TrainingData | undefined;
1596
+ TrainingData?: TrainingData;
1491
1597
  /**
1492
- * <p>The dataset to use for testing.</p>
1598
+ * <p>Specifies an external manifest that the service uses to test the model.
1599
+ * If you specify <code>TestingData</code> you must also specify <code>TrainingData</code>.
1600
+ * The project must not have any associated datasets.</p>
1493
1601
  */
1494
- TestingData: TestingData | undefined;
1602
+ TestingData?: TestingData;
1495
1603
  /**
1496
1604
  * <p>
1497
1605
  * A set of tags (key-value pairs) that you want to attach to the model.
@@ -1501,13 +1609,13 @@ export interface CreateProjectVersionRequest {
1501
1609
  [key: string]: string;
1502
1610
  };
1503
1611
  /**
1504
- * <p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK).
1505
- * You can supply the Amazon Resource Name (ARN) of your CMK, the ID of your CMK,
1506
- * an alias for your CMK, or an alias ARN.
1612
+ * <p>The identifier for your AWS Key Management Service key (AWS KMS key).
1613
+ * You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,
1614
+ * an alias for your KMS key, or an alias ARN.
1507
1615
  * The key is used to encrypt training and test images copied into the service for model training.
1508
1616
  * Your source images are unaffected. The key is also used to encrypt training results
1509
1617
  * and manifest files written to the output Amazon S3 bucket (<code>OutputConfig</code>).</p>
1510
- * <p>If you choose to use your own CMK, you need the following permissions on the CMK.</p>
1618
+ * <p>If you choose to use your own KMS key, you need the following permissions on the KMS key.</p>
1511
1619
  * <ul>
1512
1620
  * <li>
1513
1621
  * <p>kms:CreateGrant</p>
@@ -1546,25 +1654,6 @@ export declare namespace CreateProjectVersionResponse {
1546
1654
  */
1547
1655
  const filterSensitiveLog: (obj: CreateProjectVersionResponse) => any;
1548
1656
  }
1549
- /**
1550
- * <p>The resource specified in the request cannot be found.</p>
1551
- */
1552
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
1553
- name: "ResourceNotFoundException";
1554
- $fault: "client";
1555
- Message?: string;
1556
- Code?: string;
1557
- /**
1558
- * <p>A universally unique identifier (UUID) for the request.</p>
1559
- */
1560
- Logref?: string;
1561
- }
1562
- export declare namespace ResourceNotFoundException {
1563
- /**
1564
- * @internal
1565
- */
1566
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
1567
- }
1568
1657
  /**
1569
1658
  * <p>Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see
1570
1659
  * CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
@@ -1638,8 +1727,8 @@ export interface FaceSearchSettings {
1638
1727
  */
1639
1728
  CollectionId?: string;
1640
1729
  /**
1641
- * <p>Minimum face match confidence score that must be met to return a result for a recognized face. Default is 80.
1642
- * 0 is the lowest confidence. 100 is the highest confidence.</p>
1730
+ * <p>Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80.
1731
+ * 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.</p>
1643
1732
  */
1644
1733
  FaceMatchThreshold?: number;
1645
1734
  }
@@ -1789,6 +1878,242 @@ export declare namespace CustomLabel {
1789
1878
  */
1790
1879
  const filterSensitiveLog: (obj: CustomLabel) => any;
1791
1880
  }
1881
+ /**
1882
+ * <p>
1883
+ * Describes updates or additions to a dataset. A Single update or addition
1884
+ * is an entry (JSON Line) that provides information about a single image. To update an existing entry,
1885
+ * you match the <code>source-ref</code> field of the update entry with the <code>source-ref</code> filed of the entry that you want to update.
1886
+ * If the <code>source-ref</code> field doesn't match an existing entry, the entry is added to dataset as a new entry. </p>
1887
+ */
1888
+ export interface DatasetChanges {
1889
+ /**
1890
+ * <p>A Base64-encoded binary data object
1891
+ * containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling <a>UpdateDatasetEntries</a>.
1892
+ * If you are using an AWS SDK to call <code>UpdateDatasetEntries</code>, you don't need to encode <code>Changes</code> as the SDK encodes the data for you.
1893
+ *
1894
+ * </p>
1895
+ *
1896
+ *
1897
+ * <p>For example JSON lines,
1898
+ * see Image-Level labels in manifest files and
1899
+ * and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
1900
+ * </p>
1901
+ */
1902
+ GroundTruth: Uint8Array | undefined;
1903
+ }
1904
+ export declare namespace DatasetChanges {
1905
+ /**
1906
+ * @internal
1907
+ */
1908
+ const filterSensitiveLog: (obj: DatasetChanges) => any;
1909
+ }
1910
+ /**
1911
+ * <p>
1912
+ * Provides statistics about a dataset. For more information, see <a>DescribeDataset</a>.
1913
+ *
1914
+ * </p>
1915
+ */
1916
+ export interface DatasetStats {
1917
+ /**
1918
+ * <p>
1919
+ * The total number of images in the dataset that have labels.
1920
+ * </p>
1921
+ */
1922
+ LabeledEntries?: number;
1923
+ /**
1924
+ * <p>
1925
+ * The total number of images in the dataset.
1926
+ * </p>
1927
+ */
1928
+ TotalEntries?: number;
1929
+ /**
1930
+ * <p>
1931
+ * The total number of labels declared in the dataset.
1932
+ * </p>
1933
+ */
1934
+ TotalLabels?: number;
1935
+ /**
1936
+ * <p>
1937
+ * The total number of entries that contain at least one error.
1938
+ * </p>
1939
+ */
1940
+ ErrorEntries?: number;
1941
+ }
1942
+ export declare namespace DatasetStats {
1943
+ /**
1944
+ * @internal
1945
+ */
1946
+ const filterSensitiveLog: (obj: DatasetStats) => any;
1947
+ }
1948
+ export declare enum DatasetStatus {
1949
+ CREATE_COMPLETE = "CREATE_COMPLETE",
1950
+ CREATE_FAILED = "CREATE_FAILED",
1951
+ CREATE_IN_PROGRESS = "CREATE_IN_PROGRESS",
1952
+ DELETE_IN_PROGRESS = "DELETE_IN_PROGRESS",
1953
+ UPDATE_COMPLETE = "UPDATE_COMPLETE",
1954
+ UPDATE_FAILED = "UPDATE_FAILED",
1955
+ UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
1956
+ }
1957
+ export declare enum DatasetStatusMessageCode {
1958
+ CLIENT_ERROR = "CLIENT_ERROR",
1959
+ SERVICE_ERROR = "SERVICE_ERROR",
1960
+ SUCCESS = "SUCCESS"
1961
+ }
1962
+ /**
1963
+ * <p>
1964
+ * A description for a dataset. For more information, see <a>DescribeDataset</a>.</p>
1965
+ * <p>The status fields <code>Status</code>, <code>StatusMessage</code>, and <code>StatusMessageCode</code>
1966
+ * reflect the last operation on the dataset.
1967
+ * </p>
1968
+ */
1969
+ export interface DatasetDescription {
1970
+ /**
1971
+ * <p>
1972
+ * The Unix timestamp for the time and date that the dataset was created.
1973
+ * </p>
1974
+ */
1975
+ CreationTimestamp?: Date;
1976
+ /**
1977
+ * <p>
1978
+ * The Unix timestamp for the date and time that the dataset was last updated.
1979
+ * </p>
1980
+ */
1981
+ LastUpdatedTimestamp?: Date;
1982
+ /**
1983
+ * <p>
1984
+ * The status of the dataset.
1985
+ * </p>
1986
+ */
1987
+ Status?: DatasetStatus | string;
1988
+ /**
1989
+ * <p>
1990
+ * The status message for the dataset.
1991
+ * </p>
1992
+ */
1993
+ StatusMessage?: string;
1994
+ /**
1995
+ * <p>
1996
+ * The status message code for the dataset operation. If a service error occurs, try the
1997
+ * API call again later. If a client error occurs, check the input parameters to the dataset
1998
+ * API call that failed.
1999
+ * </p>
2000
+ */
2001
+ StatusMessageCode?: DatasetStatusMessageCode | string;
2002
+ /**
2003
+ * <p>
2004
+ * The status message code for the dataset.
2005
+ * </p>
2006
+ */
2007
+ DatasetStats?: DatasetStats;
2008
+ }
2009
+ export declare namespace DatasetDescription {
2010
+ /**
2011
+ * @internal
2012
+ */
2013
+ const filterSensitiveLog: (obj: DatasetDescription) => any;
2014
+ }
2015
+ /**
2016
+ * <p>
2017
+ * Statistics about a label used in a dataset. For more information, see <a>DatasetLabelDescription</a>.
2018
+ * </p>
2019
+ */
2020
+ export interface DatasetLabelStats {
2021
+ /**
2022
+ * <p>
2023
+ * The total number of images that use the label.
2024
+ * </p>
2025
+ */
2026
+ EntryCount?: number;
2027
+ /**
2028
+ * <p>
2029
+ * The total number of images that have the label assigned to a bounding box.
2030
+ * </p>
2031
+ */
2032
+ BoundingBoxCount?: number;
2033
+ }
2034
+ export declare namespace DatasetLabelStats {
2035
+ /**
2036
+ * @internal
2037
+ */
2038
+ const filterSensitiveLog: (obj: DatasetLabelStats) => any;
2039
+ }
2040
+ /**
2041
+ * <p>
2042
+ * Describes a dataset label. For more information, see <a>ListDatasetLabels</a>.
2043
+ * </p>
2044
+ */
2045
+ export interface DatasetLabelDescription {
2046
+ /**
2047
+ * <p>
2048
+ * The name of the label.
2049
+ * </p>
2050
+ */
2051
+ LabelName?: string;
2052
+ /**
2053
+ * <p>
2054
+ * Statistics about the label.
2055
+ * </p>
2056
+ */
2057
+ LabelStats?: DatasetLabelStats;
2058
+ }
2059
+ export declare namespace DatasetLabelDescription {
2060
+ /**
2061
+ * @internal
2062
+ */
2063
+ const filterSensitiveLog: (obj: DatasetLabelDescription) => any;
2064
+ }
2065
+ /**
2066
+ * <p>
2067
+ * Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see
2068
+ * <a>ProjectDescription</a>.
2069
+ * </p>
2070
+ */
2071
+ export interface DatasetMetadata {
2072
+ /**
2073
+ * <p>
2074
+ * The Unix timestamp for the date and time that the dataset was created.
2075
+ * </p>
2076
+ */
2077
+ CreationTimestamp?: Date;
2078
+ /**
2079
+ * <p>
2080
+ * The type of the dataset.
2081
+ * </p>
2082
+ */
2083
+ DatasetType?: DatasetType | string;
2084
+ /**
2085
+ * <p>
2086
+ * The Amazon Resource Name (ARN) for the dataset.
2087
+ * </p>
2088
+ */
2089
+ DatasetArn?: string;
2090
+ /**
2091
+ * <p>
2092
+ * The status for the dataset.
2093
+ * </p>
2094
+ */
2095
+ Status?: DatasetStatus | string;
2096
+ /**
2097
+ * <p>
2098
+ * The status message for the dataset.
2099
+ * </p>
2100
+ */
2101
+ StatusMessage?: string;
2102
+ /**
2103
+ * <p>
2104
+ * The status message code for the dataset operation. If a service error occurs, try the
2105
+ * API call again later. If a client error occurs, check the input parameters to the dataset
2106
+ * API call that failed.
2107
+ * </p>
2108
+ */
2109
+ StatusMessageCode?: DatasetStatusMessageCode | string;
2110
+ }
2111
+ export declare namespace DatasetMetadata {
2112
+ /**
2113
+ * @internal
2114
+ */
2115
+ const filterSensitiveLog: (obj: DatasetMetadata) => any;
2116
+ }
1792
2117
  export interface DeleteCollectionRequest {
1793
2118
  /**
1794
2119
  * <p>ID of the collection to delete.</p>
@@ -1813,6 +2138,28 @@ export declare namespace DeleteCollectionResponse {
1813
2138
  */
1814
2139
  const filterSensitiveLog: (obj: DeleteCollectionResponse) => any;
1815
2140
  }
2141
+ export interface DeleteDatasetRequest {
2142
+ /**
2143
+ * <p>
2144
+ * The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.
2145
+ * </p>
2146
+ */
2147
+ DatasetArn: string | undefined;
2148
+ }
2149
+ export declare namespace DeleteDatasetRequest {
2150
+ /**
2151
+ * @internal
2152
+ */
2153
+ const filterSensitiveLog: (obj: DeleteDatasetRequest) => any;
2154
+ }
2155
+ export interface DeleteDatasetResponse {
2156
+ }
2157
+ export declare namespace DeleteDatasetResponse {
2158
+ /**
2159
+ * @internal
2160
+ */
2161
+ const filterSensitiveLog: (obj: DeleteDatasetResponse) => any;
2162
+ }
1816
2163
  export interface DeleteFacesRequest {
1817
2164
  /**
1818
2165
  * <p>Collection from which to remove the specific faces.</p>
@@ -1966,6 +2313,34 @@ export declare namespace DescribeCollectionResponse {
1966
2313
  */
1967
2314
  const filterSensitiveLog: (obj: DescribeCollectionResponse) => any;
1968
2315
  }
2316
+ export interface DescribeDatasetRequest {
2317
+ /**
2318
+ * <p>
2319
+ * The Amazon Resource Name (ARN) of the dataset that you want to describe.
2320
+ * </p>
2321
+ */
2322
+ DatasetArn: string | undefined;
2323
+ }
2324
+ export declare namespace DescribeDatasetRequest {
2325
+ /**
2326
+ * @internal
2327
+ */
2328
+ const filterSensitiveLog: (obj: DescribeDatasetRequest) => any;
2329
+ }
2330
+ export interface DescribeDatasetResponse {
2331
+ /**
2332
+ * <p>
2333
+ * The description for the dataset.
2334
+ * </p>
2335
+ */
2336
+ DatasetDescription?: DatasetDescription;
2337
+ }
2338
+ export declare namespace DescribeDatasetResponse {
2339
+ /**
2340
+ * @internal
2341
+ */
2342
+ const filterSensitiveLog: (obj: DescribeDatasetResponse) => any;
2343
+ }
1969
2344
  export interface DescribeProjectsRequest {
1970
2345
  /**
1971
2346
  * <p>If the previous response was incomplete (because there is more
@@ -1979,6 +2354,11 @@ export interface DescribeProjectsRequest {
1979
2354
  * error occurs. The default value is 100. </p>
1980
2355
  */
1981
2356
  MaxResults?: number;
2357
+ /**
2358
+ * <p>A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value,
2359
+ * the response includes descriptions for all the projects in your AWS account.</p>
2360
+ */
2361
+ ProjectNames?: string[];
1982
2362
  }
1983
2363
  export declare namespace DescribeProjectsRequest {
1984
2364
  /**
@@ -1987,7 +2367,7 @@ export declare namespace DescribeProjectsRequest {
1987
2367
  const filterSensitiveLog: (obj: DescribeProjectsRequest) => any;
1988
2368
  }
1989
2369
  /**
1990
- * <p>A description of a Amazon Rekognition Custom Labels project.</p>
2370
+ * <p>A description of an Amazon Rekognition Custom Labels project. For more information, see <a>DescribeProjects</a>.</p>
1991
2371
  */
1992
2372
  export interface ProjectDescription {
1993
2373
  /**
@@ -2002,6 +2382,12 @@ export interface ProjectDescription {
2002
2382
  * <p>The current status of the project.</p>
2003
2383
  */
2004
2384
  Status?: ProjectStatus | string;
2385
+ /**
2386
+ * <p>
2387
+ * Information about the training and test datasets in the project.
2388
+ * </p>
2389
+ */
2390
+ Datasets?: DatasetMetadata[];
2005
2391
  }
2006
2392
  export declare namespace ProjectDescription {
2007
2393
  /**
@@ -2127,11 +2513,10 @@ export declare namespace EvaluationResult {
2127
2513
  }
2128
2514
  /**
2129
2515
  * <p>Contains the Amazon S3 bucket location of the validation data for a model training job. </p>
2516
+ * <p>The validation data includes error information for individual JSON Lines in the dataset.
2517
+ * For more information, see <i>Debugging a Failed Model Training</i> in the
2518
+ * Amazon Rekognition Custom Labels Developer Guide. </p>
2130
2519
  *
2131
- * <p>The validation data includes error information for individual
2132
- * JSON lines in the dataset.
2133
- * For more information, see Debugging a Failed Model Training in the
2134
- * Amazon Rekognition Custom Labels Developer Guide. </p>
2135
2520
  * <p>You get the <code>ValidationData</code> object for the training dataset (<a>TrainingDataResult</a>)
2136
2521
  * and the test dataset (<a>TestingDataResult</a>) by calling <a>DescribeProjectVersions</a>. </p>
2137
2522
  * <p>The assets array contains a single <a>Asset</a> object.
@@ -2199,7 +2584,7 @@ export declare namespace TrainingDataResult {
2199
2584
  const filterSensitiveLog: (obj: TrainingDataResult) => any;
2200
2585
  }
2201
2586
  /**
2202
- * <p>The description of a version of a model.</p>
2587
+ * <p>A description of a version of an Amazon Rekognition Custom Labels model.</p>
2203
2588
  */
2204
2589
  export interface ProjectVersionDescription {
2205
2590
  /**
@@ -2224,7 +2609,7 @@ export interface ProjectVersionDescription {
2224
2609
  */
2225
2610
  StatusMessage?: string;
2226
2611
  /**
2227
- * <p>The duration, in seconds, that the model version has been billed for training.
2612
+ * <p>The duration, in seconds, that you were billed for a successful training of the model version.
2228
2613
  * This value is only returned if the model version has been successfully trained.</p>
2229
2614
  */
2230
2615
  BillableTrainingTimeInSeconds?: number;
@@ -2254,7 +2639,7 @@ export interface ProjectVersionDescription {
2254
2639
  */
2255
2640
  ManifestSummary?: GroundTruthManifest;
2256
2641
  /**
2257
- * <p>The identifer for the AWS Key Management Service (AWS KMS) customer master key that was used to encrypt the model during training. </p>
2642
+ * <p>The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training. </p>
2258
2643
  */
2259
2644
  KmsKeyId?: string;
2260
2645
  }
@@ -3068,6 +3453,47 @@ export declare namespace DetectTextResponse {
3068
3453
  */
3069
3454
  const filterSensitiveLog: (obj: DetectTextResponse) => any;
3070
3455
  }
3456
+ /**
3457
+ * <p>
3458
+ * A training dataset or a test dataset used in a dataset distribution operation.
3459
+ * For more information, see <a>DistributeDatasetEntries</a>.
3460
+ * </p>
3461
+ */
3462
+ export interface DistributeDataset {
3463
+ /**
3464
+ * <p>The Amazon Resource Name (ARN) of the dataset that you want to use.
3465
+ * </p>
3466
+ */
3467
+ Arn: string | undefined;
3468
+ }
3469
+ export declare namespace DistributeDataset {
3470
+ /**
3471
+ * @internal
3472
+ */
3473
+ const filterSensitiveLog: (obj: DistributeDataset) => any;
3474
+ }
3475
+ export interface DistributeDatasetEntriesRequest {
3476
+ /**
3477
+ * <p>The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to
3478
+ * the same project. The test dataset must be empty.
3479
+ * </p>
3480
+ */
3481
+ Datasets: DistributeDataset[] | undefined;
3482
+ }
3483
+ export declare namespace DistributeDatasetEntriesRequest {
3484
+ /**
3485
+ * @internal
3486
+ */
3487
+ const filterSensitiveLog: (obj: DistributeDatasetEntriesRequest) => any;
3488
+ }
3489
+ export interface DistributeDatasetEntriesResponse {
3490
+ }
3491
+ export declare namespace DistributeDatasetEntriesResponse {
3492
+ /**
3493
+ * @internal
3494
+ */
3495
+ const filterSensitiveLog: (obj: DistributeDatasetEntriesResponse) => any;
3496
+ }
3071
3497
  /**
3072
3498
  * <p>Describes the face properties such as the bounding box, face ID, image ID of the input
3073
3499
  * image, and external image ID that you assigned. </p>
@@ -4255,6 +4681,123 @@ export declare namespace ListCollectionsResponse {
4255
4681
  */
4256
4682
  const filterSensitiveLog: (obj: ListCollectionsResponse) => any;
4257
4683
  }
4684
+ export interface ListDatasetEntriesRequest {
4685
+ /**
4686
+ * <p>
4687
+ * The Amazon Resource Name (ARN) for the dataset that you want to use.
4688
+ * </p>
4689
+ */
4690
+ DatasetArn: string | undefined;
4691
+ /**
4692
+ * <p>Specifies a label filter for the response. The response includes an entry only if one or more of the labels in <code>ContainsLabels</code> exist in the entry.
4693
+ * </p>
4694
+ */
4695
+ ContainsLabels?: string[];
4696
+ /**
4697
+ * <p>
4698
+ * Specify <code>true</code> to get only the JSON Lines where the image is labeled.
4699
+ * Specify <code>false</code> to get only the JSON Lines where the image isn't labeled. If you
4700
+ * don't specify <code>Labeled</code>, <code>ListDatasetEntries</code> returns JSON Lines for labeled and unlabeled
4701
+ * images.
4702
+ * </p>
4703
+ */
4704
+ Labeled?: boolean;
4705
+ /**
4706
+ * <p>If specified, <code>ListDatasetEntries</code> only returns JSON Lines where the value of <code>SourceRefContains</code> is
4707
+ * part of the <code>source-ref</code> field. The <code>source-ref</code> field contains the Amazon S3 location of the image.
4708
+ * You can use <code>SouceRefContains</code> for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.</p>
4709
+ */
4710
+ SourceRefContains?: string;
4711
+ /**
4712
+ * <p>Specifies an error filter for the response. Specify <code>True</code> to only include entries that have errors.
4713
+ * </p>
4714
+ */
4715
+ HasErrors?: boolean;
4716
+ /**
4717
+ * <p>If the previous response was incomplete (because there is more
4718
+ * results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
4719
+ * token to retrieve the next set of results. </p>
4720
+ */
4721
+ NextToken?: string;
4722
+ /**
4723
+ * <p>The maximum number of results to return per paginated call. The largest value you can specify is 100.
4724
+ * If you specify a value greater than 100, a ValidationException
4725
+ * error occurs. The default value is 100. </p>
4726
+ */
4727
+ MaxResults?: number;
4728
+ }
4729
+ export declare namespace ListDatasetEntriesRequest {
4730
+ /**
4731
+ * @internal
4732
+ */
4733
+ const filterSensitiveLog: (obj: ListDatasetEntriesRequest) => any;
4734
+ }
4735
+ export interface ListDatasetEntriesResponse {
4736
+ /**
4737
+ * <p>
4738
+ * A list of entries (images) in the dataset.
4739
+ * </p>
4740
+ */
4741
+ DatasetEntries?: string[];
4742
+ /**
4743
+ * <p>If the previous response was incomplete (because there is more
4744
+ * results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
4745
+ * token to retrieve the next set of results. </p>
4746
+ */
4747
+ NextToken?: string;
4748
+ }
4749
+ export declare namespace ListDatasetEntriesResponse {
4750
+ /**
4751
+ * @internal
4752
+ */
4753
+ const filterSensitiveLog: (obj: ListDatasetEntriesResponse) => any;
4754
+ }
4755
+ export interface ListDatasetLabelsRequest {
4756
+ /**
4757
+ * <p>
4758
+ * The Amazon Resource Name (ARN) of the dataset that you want to use.
4759
+ * </p>
4760
+ */
4761
+ DatasetArn: string | undefined;
4762
+ /**
4763
+ * <p>If the previous response was incomplete (because there is more
4764
+ * results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
4765
+ * token to retrieve the next set of results. </p>
4766
+ */
4767
+ NextToken?: string;
4768
+ /**
4769
+ * <p>The maximum number of results to return per paginated call. The largest value you can specify is 100.
4770
+ * If you specify a value greater than 100, a ValidationException
4771
+ * error occurs. The default value is 100. </p>
4772
+ */
4773
+ MaxResults?: number;
4774
+ }
4775
+ export declare namespace ListDatasetLabelsRequest {
4776
+ /**
4777
+ * @internal
4778
+ */
4779
+ const filterSensitiveLog: (obj: ListDatasetLabelsRequest) => any;
4780
+ }
4781
+ export interface ListDatasetLabelsResponse {
4782
+ /**
4783
+ * <p>
4784
+ * A list of the labels in the dataset.
4785
+ * </p>
4786
+ */
4787
+ DatasetLabelDescriptions?: DatasetLabelDescription[];
4788
+ /**
4789
+ * <p>If the previous response was incomplete (because there is more
4790
+ * results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
4791
+ * token to retrieve the next set of results. </p>
4792
+ */
4793
+ NextToken?: string;
4794
+ }
4795
+ export declare namespace ListDatasetLabelsResponse {
4796
+ /**
4797
+ * @internal
4798
+ */
4799
+ const filterSensitiveLog: (obj: ListDatasetLabelsResponse) => any;
4800
+ }
4258
4801
  export interface ListFacesRequest {
4259
4802
  /**
4260
4803
  * <p>ID of the collection from which to list the faces.</p>
@@ -5247,3 +5790,31 @@ export declare namespace UntagResourceResponse {
5247
5790
  */
5248
5791
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
5249
5792
  }
5793
+ export interface UpdateDatasetEntriesRequest {
5794
+ /**
5795
+ * <p>
5796
+ * The Amazon Resource Name (ARN) of the dataset that you want to update.
5797
+ * </p>
5798
+ */
5799
+ DatasetArn: string | undefined;
5800
+ /**
5801
+ * <p>
5802
+ * The changes that you want to make to the dataset.
5803
+ * </p>
5804
+ */
5805
+ Changes: DatasetChanges | undefined;
5806
+ }
5807
+ export declare namespace UpdateDatasetEntriesRequest {
5808
+ /**
5809
+ * @internal
5810
+ */
5811
+ const filterSensitiveLog: (obj: UpdateDatasetEntriesRequest) => any;
5812
+ }
5813
+ export interface UpdateDatasetEntriesResponse {
5814
+ }
5815
+ export declare namespace UpdateDatasetEntriesResponse {
5816
+ /**
5817
+ * @internal
5818
+ */
5819
+ const filterSensitiveLog: (obj: UpdateDatasetEntriesResponse) => any;
5820
+ }