@aws-sdk/client-rekognition 3.226.0 → 3.231.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 (56) hide show
  1. package/dist-cjs/endpoint/ruleset.js +1 -10
  2. package/dist-cjs/models/models_0.js +19 -6
  3. package/dist-cjs/protocols/Aws_json1_1.js +20 -0
  4. package/dist-cjs/runtimeConfig.browser.js +3 -3
  5. package/dist-cjs/runtimeConfig.js +2 -1
  6. package/dist-es/endpoint/ruleset.js +1 -10
  7. package/dist-es/models/models_0.js +12 -0
  8. package/dist-es/protocols/Aws_json1_1.js +20 -0
  9. package/dist-es/runtimeConfig.browser.js +1 -1
  10. package/dist-es/runtimeConfig.js +2 -1
  11. package/dist-types/Rekognition.d.ts +85 -120
  12. package/dist-types/commands/CompareFacesCommand.d.ts +0 -1
  13. package/dist-types/commands/CopyProjectVersionCommand.d.ts +0 -3
  14. package/dist-types/commands/CreateDatasetCommand.d.ts +0 -6
  15. package/dist-types/commands/CreateProjectVersionCommand.d.ts +0 -10
  16. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +4 -5
  17. package/dist-types/commands/DescribeCollectionCommand.d.ts +0 -1
  18. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +0 -19
  19. package/dist-types/commands/DetectLabelsCommand.d.ts +3 -8
  20. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +0 -1
  21. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +0 -3
  22. package/dist-types/commands/DetectTextCommand.d.ts +0 -1
  23. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +0 -1
  24. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +0 -1
  25. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +0 -1
  26. package/dist-types/commands/GetContentModerationCommand.d.ts +0 -3
  27. package/dist-types/commands/GetFaceSearchCommand.d.ts +0 -2
  28. package/dist-types/commands/GetLabelDetectionCommand.d.ts +64 -19
  29. package/dist-types/commands/GetPersonTrackingCommand.d.ts +0 -5
  30. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +0 -1
  31. package/dist-types/commands/IndexFacesCommand.d.ts +0 -3
  32. package/dist-types/commands/ListCollectionsCommand.d.ts +0 -1
  33. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +0 -1
  34. package/dist-types/commands/PutProjectPolicyCommand.d.ts +0 -4
  35. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +0 -1
  36. package/dist-types/commands/SearchFacesByImageCommand.d.ts +0 -1
  37. package/dist-types/commands/SearchFacesCommand.d.ts +0 -1
  38. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +0 -1
  39. package/dist-types/commands/StartContentModerationCommand.d.ts +1 -2
  40. package/dist-types/commands/StartFaceDetectionCommand.d.ts +0 -1
  41. package/dist-types/commands/StartLabelDetectionCommand.d.ts +12 -2
  42. package/dist-types/commands/StartProjectVersionCommand.d.ts +0 -2
  43. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +0 -2
  44. package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +0 -6
  46. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  47. package/dist-types/models/models_0.d.ts +60 -29
  48. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  49. package/dist-types/runtimeConfig.d.ts +1 -1
  50. package/dist-types/runtimeConfig.native.d.ts +1 -1
  51. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  52. package/dist-types/ts3.4/models/models_0.d.ts +19 -0
  53. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +4 -1
  54. package/dist-types/ts3.4/runtimeConfig.d.ts +4 -1
  55. package/dist-types/ts3.4/runtimeConfig.native.d.ts +4 -1
  56. package/package.json +7 -6
@@ -438,7 +438,6 @@ export declare class Rekognition extends RekognitionClient {
438
438
  * <p> This is a stateless API operation. That is, data returned by this operation doesn't
439
439
  * persist.</p>
440
440
  * </note>
441
- *
442
441
  * <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
443
442
  * Guide.</p>
444
443
  * <p>This operation requires permissions to perform the
@@ -457,8 +456,6 @@ export declare class Rekognition extends RekognitionClient {
457
456
  * <i>project policy</i>. You attach the project policy to the
458
457
  * source project by calling <a>PutProjectPolicy</a>. The project policy
459
458
  * gives permission to copy the model version from a trusting AWS account to a trusted account.</p>
460
- *
461
- *
462
459
  * <p>For more information creating and attaching a project policy, see Attaching a project policy (SDK)
463
460
  * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
464
461
  * </p>
@@ -466,7 +463,6 @@ export declare class Rekognition extends RekognitionClient {
466
463
  * <note>
467
464
  * <p>To copy a model, the destination project, source project, and source model version must already exist.</p>
468
465
  * </note>
469
- *
470
466
  * <p>Copying a model version takes a while to complete. To get the current status, call <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the
471
467
  * <a>ProjectVersionDescription</a> object. The copy operation has finished when
472
468
  * the value of <code>Status</code> is <code>COPYING_COMPLETED</code>.</p>
@@ -497,13 +493,10 @@ export declare class Rekognition extends RekognitionClient {
497
493
  /**
498
494
  * <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
499
495
  * an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
500
- *
501
496
  * <p>To create a training dataset for a project, specify <code>train</code> for the value of
502
497
  * <code>DatasetType</code>. To create the test dataset for a project,
503
498
  * specify <code>test</code> for the value of <code>DatasetType</code>.
504
499
  * </p>
505
- *
506
- *
507
500
  * <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset.
508
501
  * Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> to check the
509
502
  * current status. The dataset created successfully if the value of <code>Status</code> is
@@ -514,10 +507,7 @@ export declare class Rekognition extends RekognitionClient {
514
507
  * Currently, you can't access the terminal error information.
515
508
  *
516
509
  * </p>
517
- *
518
- *
519
510
  * <p>For more information, see Creating dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.</p>
520
- *
521
511
  * <p>This operation requires permissions to perform the <code>rekognition:CreateDataset</code> action.
522
512
  * If you want to copy an existing dataset, you also require permission to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
523
513
  */
@@ -537,13 +527,9 @@ export declare class Rekognition extends RekognitionClient {
537
527
  * Models are managed as part of an Amazon Rekognition Custom Labels project.
538
528
  * The response from <code>CreateProjectVersion</code>
539
529
  * is an Amazon Resource Name (ARN) for the version of the model. </p>
540
- *
541
- *
542
530
  * <p>Training uses the training and test datasets associated with the project.
543
531
  * For more information, see Creating training and test dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
544
532
  * </p>
545
- *
546
- *
547
533
  * <note>
548
534
  * <p>You can train a model in a project that doesn't have associated datasets by specifying manifest files in the
549
535
  * <code>TrainingData</code> and <code>TestingData</code> fields.
@@ -555,21 +541,15 @@ export declare class Rekognition extends RekognitionClient {
555
541
  * we recommend that you use the manifest
556
542
  * files to create training and test datasets for the project.</p>
557
543
  * </note>
558
- *
559
- *
560
544
  * <p>Training takes a while to complete. You can get the current status by calling
561
545
  * <a>DescribeProjectVersions</a>. Training completed successfully if
562
546
  * the value of the <code>Status</code> field is <code>TRAINING_COMPLETED</code>.</p>
563
- *
564
547
  * <p>If training
565
548
  * fails, see Debugging a failed model training in the <i>Amazon Rekognition Custom Labels</i> developer guide. </p>
566
- *
567
- *
568
549
  * <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
569
550
  * get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model
570
551
  * in the <i>Amazon Rekognition Custom Labels</i> developers guide.
571
552
  * </p>
572
- *
573
553
  * <p>After evaluating the model, you start the model
574
554
  * by calling <a>StartProjectVersion</a>.</p>
575
555
  * <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
@@ -579,8 +559,8 @@ export declare class Rekognition extends RekognitionClient {
579
559
  createProjectVersion(args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
580
560
  /**
581
561
  * <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.</p>
582
- * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
583
- * <ul>
562
+ * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
563
+ * <ul>
584
564
  * <li>
585
565
  * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
586
566
  * face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
@@ -593,12 +573,11 @@ export declare class Rekognition extends RekognitionClient {
593
573
  * When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
594
574
  * </li>
595
575
  * </ul>
596
- *
597
- * <p>
576
+ * <p>
598
577
  * Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
599
578
  * to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
600
579
  * the <code>Name</code> field. </p>
601
- * <p>This operation requires permissions to perform the
580
+ * <p>This operation requires permissions to perform the
602
581
  * <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
603
582
  */
604
583
  createStreamProcessor(args: CreateStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<CreateStreamProcessorCommandOutput>;
@@ -683,7 +662,6 @@ export declare class Rekognition extends RekognitionClient {
683
662
  * <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
684
663
  * information, such as the number of faces indexed into a collection and the version of the
685
664
  * model used by the collection for face detection.</p>
686
- *
687
665
  * <p>For more information, see Describing a Collection in the
688
666
  * Amazon Rekognition Developer Guide.</p>
689
667
  */
@@ -736,16 +714,6 @@ export declare class Rekognition extends RekognitionClient {
736
714
  * Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
737
715
  * of confidence that the image contains the object (<code>Confidence</code>), and
738
716
  * object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
739
- *
740
- *
741
- *
742
- *
743
- *
744
- *
745
- *
746
- *
747
- *
748
- *
749
717
  * <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
750
718
  * <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
751
719
  * the specified value.
@@ -759,21 +727,12 @@ export declare class Rekognition extends RekognitionClient {
759
727
  * You can use <code>MinConfidence</code> to change the precision and recall or your model.
760
728
  * For more information, see
761
729
  * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
762
- *
763
730
  * <p>If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code>
764
731
  * returns labels based on the assumed threshold of each label.</p>
765
- *
766
- *
767
- *
768
- *
769
- *
770
732
  * <p>This is a stateless API operation. That is, the operation does not persist any
771
733
  * data.</p>
772
734
  * <p>This operation requires permissions to perform the
773
735
  * <code>rekognition:DetectCustomLabels</code> action. </p>
774
- *
775
- *
776
- *
777
736
  * <p>For more information, see
778
737
  * <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
779
738
  */
@@ -808,10 +767,8 @@ export declare class Rekognition extends RekognitionClient {
808
767
  * <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
809
768
  * input. This includes objects like flower, tree, and table; events like wedding, graduation,
810
769
  * and birthday party; and concepts like landscape, evening, and nature. </p>
811
- *
812
770
  * <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
813
771
  * Amazon Rekognition Developer Guide.</p>
814
- *
815
772
  * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
816
773
  * an Amazon S3 bucket. If you use the
817
774
  * AWS
@@ -858,8 +815,7 @@ export declare class Rekognition extends RekognitionClient {
858
815
  * <p> Aliases - Possible Aliases for the label. </p>
859
816
  * </li>
860
817
  * <li>
861
- * <p> Categories - The label categories that the detected label belongs to. A given label
862
- * can belong to more than one category. </p>
818
+ * <p> Categories - The label categories that the detected label belongs to. </p>
863
819
  * </li>
864
820
  * <li>
865
821
  * <p> BoundingBox — Bounding boxes are described for all instances of detected common
@@ -880,12 +836,10 @@ export declare class Rekognition extends RekognitionClient {
880
836
  * <p>Dominant Color - An array of the dominant colors in the image. </p>
881
837
  * </li>
882
838
  * <li>
883
- * <p>Foreground - Information about the Sharpness and Brightness of the input image’s
884
- * foreground. </p>
839
+ * <p>Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground. </p>
885
840
  * </li>
886
841
  * <li>
887
- * <p>Background - Information about the Sharpness and Brightness of the input image’s
888
- * background.</p>
842
+ * <p>Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.</p>
889
843
  * </li>
890
844
  * </ul>
891
845
  * <p>The list of returned labels will include at least one label for every detected object,
@@ -934,7 +888,6 @@ export declare class Rekognition extends RekognitionClient {
934
888
  * suggestive content.</p>
935
889
  * <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to
936
890
  * determine which types of content are appropriate.</p>
937
- *
938
891
  * <p>For information about moderation labels, see Detecting Unsafe Content in the
939
892
  * Amazon Rekognition Developer Guide.</p>
940
893
  * <p>You pass the input image either as base64-encoded image bytes or as a reference to an
@@ -960,10 +913,8 @@ export declare class Rekognition extends RekognitionClient {
960
913
  * <p>Head cover</p>
961
914
  * </li>
962
915
  * </ul>
963
- *
964
916
  * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
965
917
  * The image must be either a PNG or JPG formatted file. </p>
966
- *
967
918
  * <p>
968
919
  * <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>
969
920
  * <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).
@@ -985,7 +936,6 @@ export declare class Rekognition extends RekognitionClient {
985
936
  * </li>
986
937
  * </ul>
987
938
  * <p>This is a stateless API operation. That is, the operation does not persist any data.</p>
988
- *
989
939
  * <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>
990
940
  */
991
941
  detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options?: __HttpHandlerOptions): Promise<DetectProtectiveEquipmentCommandOutput>;
@@ -1013,7 +963,6 @@ export declare class Rekognition extends RekognitionClient {
1013
963
  * use the <code>TextDetection</code> object <code>Type</code> field. </p>
1014
964
  * <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
1015
965
  * axis.</p>
1016
- *
1017
966
  * <p>For more information, see Detecting text in the Amazon Rekognition Developer
1018
967
  * Guide.</p>
1019
968
  */
@@ -1031,7 +980,6 @@ export declare class Rekognition extends RekognitionClient {
1031
980
  * <p>Distributing a dataset takes a while to complete. To check the status call <code>DescribeDataset</code>. The operation
1032
981
  * is complete when the <code>Status</code> field for the training dataset and the test dataset is <code>UPDATE_COMPLETE</code>.
1033
982
  * If the dataset split fails, the value of <code>Status</code> is <code>UPDATE_FAILED</code>.</p>
1034
- *
1035
983
  * <p>This operation requires permissions to perform the <code>rekognition:DistributeDatasetEntries</code> action.</p>
1036
984
  */
1037
985
  distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, options?: __HttpHandlerOptions): Promise<DistributeDatasetEntriesCommandOutput>;
@@ -1041,7 +989,6 @@ export declare class Rekognition extends RekognitionClient {
1041
989
  * <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
1042
990
  * The additional information is returned as an array of URLs. If there is no additional
1043
991
  * information about the celebrity, this list is empty.</p>
1044
- *
1045
992
  * <p>For more information, see Getting information about a celebrity in the
1046
993
  * Amazon Rekognition Developer Guide.</p>
1047
994
  * <p>This operation requires permissions to perform the
@@ -1062,7 +1009,6 @@ export declare class Rekognition extends RekognitionClient {
1062
1009
  * analysis, first check that the status value published to the Amazon SNS topic is
1063
1010
  * <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job
1064
1011
  * identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
1065
- *
1066
1012
  * <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
1067
1013
  * <p>
1068
1014
  * <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they
@@ -1099,7 +1045,6 @@ export declare class Rekognition extends RekognitionClient {
1099
1045
  * <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
1100
1046
  * <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
1101
1047
  * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
1102
- *
1103
1048
  * <p>Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling
1104
1049
  * <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).
1105
1050
  * When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
@@ -1107,7 +1052,6 @@ export declare class Rekognition extends RekognitionClient {
1107
1052
  * To get the results of the content analysis, first check that the status value published to the Amazon SNS
1108
1053
  * topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier
1109
1054
  * (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
1110
- *
1111
1055
  * <p>For more information, see Working with Stored Videos in the
1112
1056
  * Amazon Rekognition Devlopers Guide.</p>
1113
1057
  * <p>
@@ -1124,7 +1068,6 @@ export declare class Rekognition extends RekognitionClient {
1124
1068
  * pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>
1125
1069
  * and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
1126
1070
  * returned from the previous call to <code>GetContentModeration</code>.</p>
1127
- *
1128
1071
  * <p>For more information, see moderating content in the Amazon Rekognition Developer Guide.</p>
1129
1072
  */
1130
1073
  getContentModeration(args: GetContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<GetContentModerationCommandOutput>;
@@ -1159,7 +1102,6 @@ export declare class Rekognition extends RekognitionClient {
1159
1102
  * To get the search results, first check that the status value published to the Amazon SNS
1160
1103
  * topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier
1161
1104
  * (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>.</p>
1162
- *
1163
1105
  * <p>For more information, see Searching Faces in a Collection in the
1164
1106
  * Amazon Rekognition Developer Guide.</p>
1165
1107
  * <p>The search results are retured in an array, <code>Persons</code>, of
@@ -1175,7 +1117,6 @@ export declare class Rekognition extends RekognitionClient {
1175
1117
  * in the <code>Face</code> object of the following response syntax are not returned. For more information,
1176
1118
  * see FaceDetail in the Amazon Rekognition Developer Guide. </p>
1177
1119
  * </note>
1178
- *
1179
1120
  * <p>By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the
1180
1121
  * start of the video, persons are matched.
1181
1122
  * You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input
@@ -1186,33 +1127,77 @@ export declare class Rekognition extends RekognitionClient {
1186
1127
  getFaceSearch(args: GetFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
1187
1128
  /**
1188
1129
  * <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
1189
- *
1190
- * <p>The label detection operation is started by a call to <a>StartLabelDetection</a>
1191
- * which returns a job identifier (<code>JobId</code>). When the label detection operation finishes, Amazon Rekognition publishes a completion status to
1192
- * the Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. To get the results
1193
- * of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
1194
- * If so, call <a>GetLabelDetection</a> and pass the job identifier
1195
- * (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
1130
+ * <p>The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When
1131
+ * the label detection operation finishes, Amazon Rekognition publishes a completion status to the
1132
+ * Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. </p>
1133
+ * <p>To get the results of the label detection operation, first check that the status value
1134
+ * published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<code>JobId</code>) from the
1135
+ * initial call to <code>StartLabelDetection</code>.</p>
1196
1136
  * <p>
1197
- * <code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) sorted by the time
1198
- * the labels were detected. You can also sort by the label name by specifying <code>NAME</code> for the
1199
- * <code>SortBy</code> input parameter.</p>
1200
- * <p>The labels returned include the label name, the percentage confidence in the accuracy of the detected label,
1201
- * and the time the label was detected in the video.</p>
1202
- * <p>The returned labels also include bounding box information for common objects, a
1203
- * hierarchical taxonomy of detected labels, and the version of the label model used for detection.</p>
1204
- *
1205
- * <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
1206
- * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
1207
- * of results. To get the next page of results, call <code>GetlabelDetection</code> and populate the <code>NextToken</code> request parameter with the token
1208
- * value returned from the previous call to <code>GetLabelDetection</code>.</p>
1137
+ * <code>GetLabelDetection</code> returns an array of detected labels
1138
+ * (<code>Labels</code>) sorted by the time the labels were detected. You can also sort by the
1139
+ * label name by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. If
1140
+ * there is no <code>NAME</code> specified, the default sort is by
1141
+ * timestamp.</p>
1142
+ * <p>You can select how results are aggregated by using the <code>AggregateBy</code> input
1143
+ * parameter. The default aggregation method is <code>TIMESTAMPS</code>. You can also aggregate
1144
+ * by <code>SEGMENTS</code>, which aggregates all instances of labels detected in a given
1145
+ * segment. </p>
1146
+ * <p>The returned Labels array may include the following attributes:</p>
1147
+ * <ul>
1148
+ * <li>
1149
+ * <p>Name - The name of the detected label.</p>
1150
+ * </li>
1151
+ * <li>
1152
+ * <p>Confidence - The level of confidence in the label assigned to a detected object. </p>
1153
+ * </li>
1154
+ * <li>
1155
+ * <p>Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical
1156
+ * taxonomy of detected labels. For example, a detected car might be assigned the label car.
1157
+ * The label car has two parent labels: Vehicle (its parent) and Transportation (its
1158
+ * grandparent). The response includes the all ancestors for a label, where every ancestor is
1159
+ * a unique label. In the previous example, Car, Vehicle, and Transportation are returned as
1160
+ * unique labels in the response. </p>
1161
+ * </li>
1162
+ * <li>
1163
+ * <p> Aliases - Possible Aliases for the label. </p>
1164
+ * </li>
1165
+ * <li>
1166
+ * <p>Categories - The label categories that the detected label belongs to.</p>
1167
+ * </li>
1168
+ * <li>
1169
+ * <p>BoundingBox — Bounding boxes are described for all instances of detected common object labels,
1170
+ * returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing
1171
+ * the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.</p>
1172
+ * </li>
1173
+ * <li>
1174
+ * <p>Timestamp - Time, in milliseconds from the start of the video, that the label was detected.
1175
+ * For aggregation by <code>SEGMENTS</code>, the <code>StartTimestampMillis</code>,
1176
+ * <code>EndTimestampMillis</code>, and <code>DurationMillis</code> structures are what
1177
+ * define a segment. Although the “Timestamp” structure is still returned with each label,
1178
+ * its value is set to be the same as <code>StartTimestampMillis</code>.</p>
1179
+ * </li>
1180
+ * </ul>
1181
+ * <p>Timestamp and Bounding box information are returned for detected Instances, only if
1182
+ * aggregation is done by <code>TIMESTAMPS</code>. If aggregating by <code>SEGMENTS</code>,
1183
+ * information about detected instances isn’t returned. </p>
1184
+ * <p>The version of the label model used for the detection is also returned.</p>
1185
+ * <p>
1186
+ * <b>Note <code>DominantColors</code> isn't returned for <code>Instances</code>,
1187
+ * although it is shown as part of the response in the sample seen below.</b>
1188
+ * </p>
1189
+ * <p>Use <code>MaxResults</code> parameter to limit the number of labels returned. If
1190
+ * there are more results than specified in <code>MaxResults</code>, the value of
1191
+ * <code>NextToken</code> in the operation response contains a pagination token for getting the
1192
+ * next set of results. To get the next page of results, call <code>GetlabelDetection</code> and
1193
+ * populate the <code>NextToken</code> request parameter with the token value returned from the
1194
+ * previous call to <code>GetLabelDetection</code>.</p>
1209
1195
  */
1210
1196
  getLabelDetection(args: GetLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetLabelDetectionCommandOutput>;
1211
1197
  getLabelDetection(args: GetLabelDetectionCommandInput, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
1212
1198
  getLabelDetection(args: GetLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
1213
1199
  /**
1214
1200
  * <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
1215
- *
1216
1201
  * <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
1217
1202
  * which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
1218
1203
  * the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>
@@ -1229,14 +1214,10 @@ export declare class Rekognition extends RekognitionClient {
1229
1214
  * facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
1230
1215
  * <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
1231
1216
  * in the <code>Face</code> object of the following response syntax are not returned. </p>
1232
- *
1233
1217
  * <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p>
1234
1218
  * </note>
1235
- *
1236
- *
1237
1219
  * <p>By default, the array is sorted by the time(s) a person's path is tracked in the video.
1238
1220
  * You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p>
1239
- *
1240
1221
  * <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than
1241
1222
  * specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
1242
1223
  * of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token
@@ -1267,7 +1248,6 @@ export declare class Rekognition extends RekognitionClient {
1267
1248
  * a pagination token for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code>
1268
1249
  * and populate the <code>NextToken</code> request parameter with the token value returned from the previous
1269
1250
  * call to <code>GetSegmentDetection</code>.</p>
1270
- *
1271
1251
  * <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
1272
1252
  */
1273
1253
  getSegmentDetection(args: GetSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetSegmentDetectionCommandOutput>;
@@ -1304,7 +1284,6 @@ export declare class Rekognition extends RekognitionClient {
1304
1284
  * extracts facial features into a feature vector, and stores it in the backend database.
1305
1285
  * Amazon Rekognition uses feature vectors when it performs face match and search operations using the
1306
1286
  * <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations.</p>
1307
- *
1308
1287
  * <p>For more information, see Adding faces to a collection in the Amazon Rekognition
1309
1288
  * Developer Guide.</p>
1310
1289
  * <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
@@ -1317,7 +1296,6 @@ export declare class Rekognition extends RekognitionClient {
1317
1296
  * version from the value of <code>FaceModelVersion</code> in the response from
1318
1297
  * <code>IndexFaces</code>
1319
1298
  * </p>
1320
- *
1321
1299
  * <p>For more information, see Model Versioning in the Amazon Rekognition Developer
1322
1300
  * Guide.</p>
1323
1301
  * <p>If you provide the optional <code>ExternalImageId</code> for the input image you
@@ -1386,7 +1364,6 @@ export declare class Rekognition extends RekognitionClient {
1386
1364
  * image, specify the same collection, and use the same external ID in the
1387
1365
  * <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
1388
1366
  * <p></p>
1389
- *
1390
1367
  * <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
1391
1368
  * image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
1392
1369
  * passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
@@ -1400,7 +1377,6 @@ export declare class Rekognition extends RekognitionClient {
1400
1377
  * <p>Returns list of collection IDs in your account. If the result is truncated, the
1401
1378
  * response also provides a <code>NextToken</code> that you can use in the subsequent request to
1402
1379
  * fetch the next set of collection IDs.</p>
1403
- *
1404
1380
  * <p>For an example, see Listing collections in the Amazon Rekognition Developer
1405
1381
  * Guide.</p>
1406
1382
  * <p>This operation requires permissions to perform the
@@ -1421,7 +1397,6 @@ export declare class Rekognition extends RekognitionClient {
1421
1397
  * same information is reported in the training and testing validation result manifests that
1422
1398
  * Amazon Rekognition Custom Labels creates during model training.
1423
1399
  * </p>
1424
- *
1425
1400
  * <p>You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
1426
1401
  * </p>
1427
1402
  * <p>This operation requires permissions to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
@@ -1478,18 +1453,14 @@ export declare class Rekognition extends RekognitionClient {
1478
1453
  * project policy specifies that a trusted AWS account can copy a model version from a
1479
1454
  * trusting AWS account to a project in the trusted AWS account. To copy a model version you use
1480
1455
  * the <a>CopyProjectVersion</a> operation.</p>
1481
- *
1482
- *
1483
1456
  * <p>For more information about the format of a project policy document, see Attaching a project policy (SDK)
1484
1457
  * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
1485
1458
  * </p>
1486
- *
1487
1459
  * <p>The response from <code>PutProjectPolicy</code> is a revision ID for the project policy.
1488
1460
  * You can attach multiple project policies to a project. You can also update an existing
1489
1461
  * project policy by specifying the policy revision ID of the existing policy.</p>
1490
1462
  * <p>To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.
1491
1463
  * To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. </p>
1492
- *
1493
1464
  * <p>You copy a model version by calling <a>CopyProjectVersion</a>.</p>
1494
1465
  */
1495
1466
  putProjectPolicy(args: PutProjectPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutProjectPolicyCommandOutput>;
@@ -1519,7 +1490,6 @@ export declare class Rekognition extends RekognitionClient {
1519
1490
  * AWS
1520
1491
  * CLI to call Amazon Rekognition operations, passing image bytes is not
1521
1492
  * supported. The image must be either a PNG or JPEG formatted file. </p>
1522
- *
1523
1493
  * <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition
1524
1494
  * Developer Guide.</p>
1525
1495
  * <p>This operation requires permissions to perform the
@@ -1541,7 +1511,6 @@ export declare class Rekognition extends RekognitionClient {
1541
1511
  * each face match that is found. Along with the metadata, the response also includes a
1542
1512
  * <code>confidence</code> value for each face match, indicating the confidence that the
1543
1513
  * specific face matches the input face. </p>
1544
- *
1545
1514
  * <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition
1546
1515
  * Developer Guide.</p>
1547
1516
  * <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
@@ -1574,7 +1543,6 @@ export declare class Rekognition extends RekognitionClient {
1574
1543
  * face that Amazon Rekognition used for the input image. </p>
1575
1544
  * <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
1576
1545
  * <code>InvalidParameterException</code> error. </p>
1577
- *
1578
1546
  * <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition
1579
1547
  * Developer Guide.</p>
1580
1548
  * <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
@@ -1604,7 +1572,6 @@ export declare class Rekognition extends RekognitionClient {
1604
1572
  * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
1605
1573
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
1606
1574
  * (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
1607
- *
1608
1575
  * <p>For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.</p>
1609
1576
  */
1610
1577
  startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<StartCelebrityRecognitionCommandOutput>;
@@ -1618,10 +1585,9 @@ export declare class Rekognition extends RekognitionClient {
1618
1585
  * returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
1619
1586
  * When content analysis is finished, Amazon Rekognition Video publishes a completion status
1620
1587
  * to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
1621
- * <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
1588
+ * <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
1622
1589
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
1623
1590
  * (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
1624
- *
1625
1591
  * <p>For more information, see Moderating content in the Amazon Rekognition Developer Guide.</p>
1626
1592
  */
1627
1593
  startContentModeration(args: StartContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<StartContentModerationCommandOutput>;
@@ -1638,7 +1604,6 @@ export declare class Rekognition extends RekognitionClient {
1638
1604
  * To get the results of the face detection operation, first check that the status value published to the Amazon SNS
1639
1605
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
1640
1606
  * (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
1641
- *
1642
1607
  * <p>For more information, see Detecting faces in a stored video in the
1643
1608
  * Amazon Rekognition Developer Guide.</p>
1644
1609
  */
@@ -1667,7 +1632,6 @@ export declare class Rekognition extends RekognitionClient {
1667
1632
  * This includes objects like flower, tree, and table; events like
1668
1633
  * wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities
1669
1634
  * like a person getting out of a car or a person skiing.</p>
1670
- *
1671
1635
  * <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
1672
1636
  * and the filename of the video.
1673
1637
  * <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the
@@ -1676,7 +1640,18 @@ export declare class Rekognition extends RekognitionClient {
1676
1640
  * <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS
1677
1641
  * topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier
1678
1642
  * (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
1679
- * <p></p>
1643
+ * <p>
1644
+ * <i>Optional Parameters</i>
1645
+ * </p>
1646
+ * <p>
1647
+ * <code>StartLabelDetection</code> has the <code>GENERAL_LABELS</code> Feature applied by
1648
+ * default. This feature allows you to provide filtering criteria to the <code>Settings</code>
1649
+ * parameter. You can filter with sets of individual labels or with label categories. You can
1650
+ * specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive
1651
+ * filters. For more information on filtering, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html">Detecting labels in a
1652
+ * video</a>.</p>
1653
+ * <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
1654
+ * labels returned. The default is 50.</p>
1680
1655
  */
1681
1656
  startLabelDetection(args: StartLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartLabelDetectionCommandOutput>;
1682
1657
  startLabelDetection(args: StartLabelDetectionCommandInput, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
@@ -1704,9 +1679,7 @@ export declare class Rekognition extends RekognitionClient {
1704
1679
  * <p>You are charged for the amount of time that the model is running. To stop a running
1705
1680
  * model, call <a>StopProjectVersion</a>.</p>
1706
1681
  * </note>
1707
- *
1708
1682
  * <p>For more information, see <i>Running a trained Amazon Rekognition Custom Labels model</i> in the Amazon Rekognition Custom Labels Guide.</p>
1709
- *
1710
1683
  * <p>This operation requires permissions to perform the
1711
1684
  * <code>rekognition:StartProjectVersion</code> action.</p>
1712
1685
  */
@@ -1727,8 +1700,6 @@ export declare class Rekognition extends RekognitionClient {
1727
1700
  * <p>To get the results of the segment detection operation, first check that the status value published to the Amazon SNS
1728
1701
  * topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<code>JobId</code>)
1729
1702
  * from the initial call to <code>StartSegmentDetection</code>. </p>
1730
- *
1731
- *
1732
1703
  * <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
1733
1704
  */
1734
1705
  startSegmentDetection(args: StartSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartSegmentDetectionCommandOutput>;
@@ -1738,7 +1709,7 @@ export declare class Rekognition extends RekognitionClient {
1738
1709
  * <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
1739
1710
  * To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
1740
1711
  * <code>CreateStreamProcessor</code>.</p>
1741
- * <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
1712
+ * <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
1742
1713
  */
1743
1714
  startStreamProcessor(args: StartStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamProcessorCommandOutput>;
1744
1715
  startStreamProcessor(args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
@@ -1794,18 +1765,12 @@ export declare class Rekognition extends RekognitionClient {
1794
1765
  * the image location, assigned labels, and object location bounding boxes. For more information,
1795
1766
  * see Image-Level labels in manifest files and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
1796
1767
  * </p>
1797
- *
1798
- *
1799
- *
1800
1768
  * <p>If the <code>source-ref</code> field in the JSON line references an existing image, the existing image in the dataset
1801
1769
  * is updated.
1802
1770
  * If <code>source-ref</code> field doesn't reference an existing image, the image is added as a new image to the dataset. </p>
1803
- *
1804
1771
  * <p>You specify the changes that you want to make in the <code>Changes</code> input parameter.
1805
1772
  * There isn't a limit to the number JSON Lines that you can change, but the size of <code>Changes</code> must be less
1806
1773
  * than 5MB.</p>
1807
- *
1808
- *
1809
1774
  * <p>
1810
1775
  * <code>UpdateDatasetEntries</code> returns immediatly, but the dataset update might take a while to complete.
1811
1776
  * Use <a>DescribeDataset</a> to check the
@@ -55,7 +55,6 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
55
55
  * <p> This is a stateless API operation. That is, data returned by this operation doesn't
56
56
  * persist.</p>
57
57
  * </note>
58
- *
59
58
  * <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
60
59
  * Guide.</p>
61
60
  * <p>This operation requires permissions to perform the
@@ -17,8 +17,6 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
17
17
  * <i>project policy</i>. You attach the project policy to the
18
18
  * source project by calling <a>PutProjectPolicy</a>. The project policy
19
19
  * gives permission to copy the model version from a trusting AWS account to a trusted account.</p>
20
- *
21
- *
22
20
  * <p>For more information creating and attaching a project policy, see Attaching a project policy (SDK)
23
21
  * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
24
22
  * </p>
@@ -26,7 +24,6 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
26
24
  * <note>
27
25
  * <p>To copy a model, the destination project, source project, and source model version must already exist.</p>
28
26
  * </note>
29
- *
30
27
  * <p>Copying a model version takes a while to complete. To get the current status, call <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the
31
28
  * <a>ProjectVersionDescription</a> object. The copy operation has finished when
32
29
  * the value of <code>Status</code> is <code>COPYING_COMPLETED</code>.</p>