@aws-sdk/client-rekognition 3.295.0 → 3.297.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/dist-types/Rekognition.d.ts +70 -6
- package/dist-types/RekognitionClient.d.ts +24 -4
- package/dist-types/commands/CompareFacesCommand.d.ts +16 -0
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +16 -0
- package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
- package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
- package/dist-types/commands/CreateProjectVersionCommand.d.ts +16 -0
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +16 -0
- package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFacesCommand.d.ts +16 -0
- package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +16 -0
- package/dist-types/commands/DeleteProjectVersionCommand.d.ts +16 -0
- package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +16 -0
- package/dist-types/commands/DescribeCollectionCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
- package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeProjectsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +16 -0
- package/dist-types/commands/DetectCustomLabelsCommand.d.ts +16 -0
- package/dist-types/commands/DetectFacesCommand.d.ts +16 -0
- package/dist-types/commands/DetectLabelsCommand.d.ts +22 -6
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +16 -0
- package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +16 -0
- package/dist-types/commands/DetectTextCommand.d.ts +16 -0
- package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +16 -0
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +16 -0
- package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +16 -0
- package/dist-types/commands/GetContentModerationCommand.d.ts +16 -0
- package/dist-types/commands/GetFaceDetectionCommand.d.ts +16 -0
- package/dist-types/commands/GetFaceSearchCommand.d.ts +16 -0
- package/dist-types/commands/GetLabelDetectionCommand.d.ts +16 -0
- package/dist-types/commands/GetPersonTrackingCommand.d.ts +16 -0
- package/dist-types/commands/GetSegmentDetectionCommand.d.ts +16 -0
- package/dist-types/commands/GetTextDetectionCommand.d.ts +16 -0
- package/dist-types/commands/IndexFacesCommand.d.ts +16 -0
- package/dist-types/commands/ListCollectionsCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetEntriesCommand.d.ts +16 -0
- package/dist-types/commands/ListDatasetLabelsCommand.d.ts +16 -0
- package/dist-types/commands/ListFacesCommand.d.ts +16 -0
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListStreamProcessorsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +16 -0
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +16 -0
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +16 -0
- package/dist-types/commands/SearchFacesCommand.d.ts +16 -0
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +16 -0
- package/dist-types/commands/StartContentModerationCommand.d.ts +16 -0
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +16 -0
- package/dist-types/commands/StartFaceSearchCommand.d.ts +16 -0
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +16 -0
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +16 -0
- package/dist-types/commands/StartProjectVersionCommand.d.ts +16 -0
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +16 -0
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +16 -0
- package/dist-types/commands/StartTextDetectionCommand.d.ts +16 -0
- package/dist-types/commands/StopProjectVersionCommand.d.ts +16 -0
- package/dist-types/commands/StopStreamProcessorCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +16 -0
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +16 -0
- package/dist-types/models/RekognitionServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +610 -0
- package/dist-types/pagination/DescribeProjectVersionsPaginator.d.ts +3 -0
- package/dist-types/pagination/DescribeProjectsPaginator.d.ts +3 -0
- package/dist-types/pagination/GetCelebrityRecognitionPaginator.d.ts +3 -0
- package/dist-types/pagination/GetContentModerationPaginator.d.ts +3 -0
- package/dist-types/pagination/GetFaceDetectionPaginator.d.ts +3 -0
- package/dist-types/pagination/GetFaceSearchPaginator.d.ts +3 -0
- package/dist-types/pagination/GetLabelDetectionPaginator.d.ts +3 -0
- package/dist-types/pagination/GetPersonTrackingPaginator.d.ts +3 -0
- package/dist-types/pagination/GetSegmentDetectionPaginator.d.ts +3 -0
- package/dist-types/pagination/GetTextDetectionPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListFacesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListProjectPoliciesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListStreamProcessorsPaginator.d.ts +3 -0
- package/package.json +30 -30
|
@@ -64,6 +64,7 @@ import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } f
|
|
|
64
64
|
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
65
65
|
import { RekognitionClient } from "./RekognitionClient";
|
|
66
66
|
/**
|
|
67
|
+
* @public
|
|
67
68
|
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
68
69
|
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
69
70
|
* Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
|
|
@@ -391,6 +392,7 @@ import { RekognitionClient } from "./RekognitionClient";
|
|
|
391
392
|
*/
|
|
392
393
|
export declare class Rekognition extends RekognitionClient {
|
|
393
394
|
/**
|
|
395
|
+
* @public
|
|
394
396
|
* <p>Compares a face in the <i>source</i> input image with each of the 100
|
|
395
397
|
* largest faces detected in the <i>target</i> input image. </p>
|
|
396
398
|
* <p> If the source image contains multiple faces, the service detects the largest face and
|
|
@@ -447,6 +449,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
447
449
|
compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
448
450
|
compareFaces(args: CompareFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
449
451
|
/**
|
|
452
|
+
* @public
|
|
450
453
|
* <p>Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and
|
|
451
454
|
* destination projects can be in different AWS accounts but must be in the same AWS Region.
|
|
452
455
|
* You can't copy a model to another AWS service.
|
|
@@ -471,6 +474,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
471
474
|
copyProjectVersion(args: CopyProjectVersionCommandInput, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void): void;
|
|
472
475
|
copyProjectVersion(args: CopyProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void): void;
|
|
473
476
|
/**
|
|
477
|
+
* @public
|
|
474
478
|
* <p>Creates a collection in an AWS Region. You can add faces to the collection using the
|
|
475
479
|
* <a>IndexFaces</a> operation. </p>
|
|
476
480
|
* <p>For example, you might create collections, one for each of your application users. A
|
|
@@ -491,6 +495,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
491
495
|
createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
492
496
|
createCollection(args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
493
497
|
/**
|
|
498
|
+
* @public
|
|
494
499
|
* <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
|
|
495
500
|
* an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
|
|
496
501
|
* <p>To create a training dataset for a project, specify <code>train</code> for the value of
|
|
@@ -515,6 +520,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
515
520
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
516
521
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
517
522
|
/**
|
|
523
|
+
* @public
|
|
518
524
|
* <p>Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions)
|
|
519
525
|
* that you use to create and manage Amazon Rekognition Custom Labels models. </p>
|
|
520
526
|
* <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
|
|
@@ -523,6 +529,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
523
529
|
createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
524
530
|
createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
525
531
|
/**
|
|
532
|
+
* @public
|
|
526
533
|
* <p>Creates a new version of a model and begins training.
|
|
527
534
|
* Models are managed as part of an Amazon Rekognition Custom Labels project.
|
|
528
535
|
* The response from <code>CreateProjectVersion</code>
|
|
@@ -558,6 +565,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
558
565
|
createProjectVersion(args: CreateProjectVersionCommandInput, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
559
566
|
createProjectVersion(args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
560
567
|
/**
|
|
568
|
+
* @public
|
|
561
569
|
* <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>
|
|
562
570
|
* <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
571
|
* <ul>
|
|
@@ -584,6 +592,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
584
592
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
585
593
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
586
594
|
/**
|
|
595
|
+
* @public
|
|
587
596
|
* <p>Deletes the specified collection. Note that this operation removes all faces in the
|
|
588
597
|
* collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
|
|
589
598
|
* collection</a>.</p>
|
|
@@ -594,6 +603,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
594
603
|
deleteCollection(args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
595
604
|
deleteCollection(args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
596
605
|
/**
|
|
606
|
+
* @public
|
|
597
607
|
* <p>Deletes an existing Amazon Rekognition Custom Labels dataset.
|
|
598
608
|
* Deleting a dataset might take while. Use <a>DescribeDataset</a> to check the
|
|
599
609
|
* current status. The dataset is still deleting if the value of <code>Status</code> is
|
|
@@ -609,6 +619,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
609
619
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
610
620
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
611
621
|
/**
|
|
622
|
+
* @public
|
|
612
623
|
* <p>Deletes faces from a collection. You specify a collection ID and an array of face IDs
|
|
613
624
|
* to remove from the collection.</p>
|
|
614
625
|
* <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
|
|
@@ -618,6 +629,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
618
629
|
deleteFaces(args: DeleteFacesCommandInput, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
619
630
|
deleteFaces(args: DeleteFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
620
631
|
/**
|
|
632
|
+
* @public
|
|
621
633
|
* <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
|
|
622
634
|
* with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
|
|
623
635
|
* <p>
|
|
@@ -632,6 +644,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
632
644
|
deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
633
645
|
deleteProject(args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
634
646
|
/**
|
|
647
|
+
* @public
|
|
635
648
|
* <p>Deletes an existing project policy.</p>
|
|
636
649
|
* <p>To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. To attach a project policy to a project, call <a>PutProjectPolicy</a>.</p>
|
|
637
650
|
*/
|
|
@@ -639,6 +652,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
639
652
|
deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void): void;
|
|
640
653
|
deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void): void;
|
|
641
654
|
/**
|
|
655
|
+
* @public
|
|
642
656
|
* <p>Deletes an Amazon Rekognition Custom Labels model. </p>
|
|
643
657
|
* <p>You can't delete a model if it is running or if it is training.
|
|
644
658
|
* To check the status of a model, use the <code>Status</code> field returned
|
|
@@ -652,6 +666,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
652
666
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
653
667
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
654
668
|
/**
|
|
669
|
+
* @public
|
|
655
670
|
* <p>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with
|
|
656
671
|
* <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>
|
|
657
672
|
*/
|
|
@@ -659,6 +674,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
659
674
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
660
675
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
661
676
|
/**
|
|
677
|
+
* @public
|
|
662
678
|
* <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
|
|
663
679
|
* information, such as the number of faces indexed into a collection and the version of the
|
|
664
680
|
* model used by the collection for face detection.</p>
|
|
@@ -669,6 +685,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
669
685
|
describeCollection(args: DescribeCollectionCommandInput, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
670
686
|
describeCollection(args: DescribeCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
671
687
|
/**
|
|
688
|
+
* @public
|
|
672
689
|
* <p>
|
|
673
690
|
* Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and
|
|
674
691
|
* statistics about the images and labels in a dataset.
|
|
@@ -679,6 +696,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
679
696
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
680
697
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
681
698
|
/**
|
|
699
|
+
* @public
|
|
682
700
|
* <p>Gets information about your Amazon Rekognition Custom Labels projects. </p>
|
|
683
701
|
* <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
|
|
684
702
|
*/
|
|
@@ -686,6 +704,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
686
704
|
describeProjects(args: DescribeProjectsCommandInput, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
687
705
|
describeProjects(args: DescribeProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
688
706
|
/**
|
|
707
|
+
* @public
|
|
689
708
|
* <p>Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You
|
|
690
709
|
* can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
|
|
691
710
|
* you don't specify a value, descriptions for all model versions in the project are returned.</p>
|
|
@@ -696,6 +715,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
696
715
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
697
716
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
698
717
|
/**
|
|
718
|
+
* @public
|
|
699
719
|
* <p>Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed,
|
|
700
720
|
* and the current status of the stream processor.</p>
|
|
701
721
|
*/
|
|
@@ -703,6 +723,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
703
723
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
704
724
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
705
725
|
/**
|
|
726
|
+
* @public
|
|
706
727
|
* <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
|
|
707
728
|
* <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
|
|
708
729
|
* parameter. </p>
|
|
@@ -740,6 +761,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
740
761
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
741
762
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
742
763
|
/**
|
|
764
|
+
* @public
|
|
743
765
|
* <p>Detects faces within an image that is provided as input.</p>
|
|
744
766
|
* <p>
|
|
745
767
|
* <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
|
|
@@ -764,6 +786,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
764
786
|
detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
765
787
|
detectFaces(args: DetectFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
766
788
|
/**
|
|
789
|
+
* @public
|
|
767
790
|
* <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
|
|
768
791
|
* input. This includes objects like flower, tree, and table; events like wedding, graduation,
|
|
769
792
|
* and birthday party; and concepts like landscape, evening, and nature. </p>
|
|
@@ -847,25 +870,25 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
847
870
|
* a lighthouse, the sea, and a rock. The response includes all three labels, one for each
|
|
848
871
|
* object, as well as the confidence in the label:</p>
|
|
849
872
|
* <p>
|
|
850
|
-
* <code
|
|
873
|
+
* <code>\{Name: lighthouse, Confidence: 98.4629\}</code>
|
|
851
874
|
* </p>
|
|
852
875
|
* <p>
|
|
853
|
-
* <code
|
|
876
|
+
* <code>\{Name: rock,Confidence: 79.2097\}</code>
|
|
854
877
|
* </p>
|
|
855
878
|
* <p>
|
|
856
|
-
* <code> {Name: sea,Confidence: 75.061}</code>
|
|
879
|
+
* <code> \{Name: sea,Confidence: 75.061\}</code>
|
|
857
880
|
* </p>
|
|
858
881
|
* <p>The list of labels can include multiple labels for the same object. For example, if the
|
|
859
882
|
* input image shows a flower (for example, a tulip), the operation might return the following
|
|
860
883
|
* three labels. </p>
|
|
861
884
|
* <p>
|
|
862
|
-
* <code
|
|
885
|
+
* <code>\{Name: flower,Confidence: 99.0562\}</code>
|
|
863
886
|
* </p>
|
|
864
887
|
* <p>
|
|
865
|
-
* <code
|
|
888
|
+
* <code>\{Name: plant,Confidence: 99.0562\}</code>
|
|
866
889
|
* </p>
|
|
867
890
|
* <p>
|
|
868
|
-
* <code
|
|
891
|
+
* <code>\{Name: tulip,Confidence: 99.0562\}</code>
|
|
869
892
|
* </p>
|
|
870
893
|
* <p>In this example, the detection algorithm more precisely identifies the flower as a
|
|
871
894
|
* tulip.</p>
|
|
@@ -882,6 +905,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
882
905
|
detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
883
906
|
detectLabels(args: DetectLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
884
907
|
/**
|
|
908
|
+
* @public
|
|
885
909
|
* <p>Detects unsafe content in a specified JPEG or PNG format image. Use
|
|
886
910
|
* <code>DetectModerationLabels</code> to moderate images depending on your requirements. For
|
|
887
911
|
* example, you might want to filter images that contain nudity, but not images containing
|
|
@@ -900,6 +924,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
900
924
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
901
925
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
902
926
|
/**
|
|
927
|
+
* @public
|
|
903
928
|
* <p>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the
|
|
904
929
|
* following types of PPE.</p>
|
|
905
930
|
* <ul>
|
|
@@ -942,6 +967,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
942
967
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
943
968
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
944
969
|
/**
|
|
970
|
+
* @public
|
|
945
971
|
* <p>Detects text in the input image and converts it into machine-readable text.</p>
|
|
946
972
|
* <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an
|
|
947
973
|
* Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
|
|
@@ -970,6 +996,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
970
996
|
detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
971
997
|
detectText(args: DetectTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
972
998
|
/**
|
|
999
|
+
* @public
|
|
973
1000
|
* <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
|
|
974
1001
|
* <code>DistributeDatasetEntries</code> moves 20% of the training dataset images to the test dataset.
|
|
975
1002
|
* An entry is a JSON Line that describes an image.
|
|
@@ -986,6 +1013,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
986
1013
|
distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void): void;
|
|
987
1014
|
distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void): void;
|
|
988
1015
|
/**
|
|
1016
|
+
* @public
|
|
989
1017
|
* <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
|
|
990
1018
|
* The additional information is returned as an array of URLs. If there is no additional
|
|
991
1019
|
* information about the celebrity, this list is empty.</p>
|
|
@@ -998,6 +1026,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
998
1026
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
999
1027
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
1000
1028
|
/**
|
|
1029
|
+
* @public
|
|
1001
1030
|
* <p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
|
|
1002
1031
|
* <a>StartCelebrityRecognition</a>.</p>
|
|
1003
1032
|
* <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a
|
|
@@ -1042,6 +1071,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1042
1071
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
1043
1072
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
1044
1073
|
/**
|
|
1074
|
+
* @public
|
|
1045
1075
|
* <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
|
|
1046
1076
|
* <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
|
|
1047
1077
|
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
@@ -1074,6 +1104,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1074
1104
|
getContentModeration(args: GetContentModerationCommandInput, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
1075
1105
|
getContentModeration(args: GetContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
1076
1106
|
/**
|
|
1107
|
+
* @public
|
|
1077
1108
|
* <p>Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>.</p>
|
|
1078
1109
|
* <p>Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a>
|
|
1079
1110
|
* which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
@@ -1092,6 +1123,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1092
1123
|
getFaceDetection(args: GetFaceDetectionCommandInput, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
1093
1124
|
getFaceDetection(args: GetFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
1094
1125
|
/**
|
|
1126
|
+
* @public
|
|
1095
1127
|
* <p>Gets the face search results for Amazon Rekognition Video face search started by
|
|
1096
1128
|
* <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces
|
|
1097
1129
|
* of persons detected in a video. It also includes the time(s) that faces are matched in the video.</p>
|
|
@@ -1126,6 +1158,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1126
1158
|
getFaceSearch(args: GetFaceSearchCommandInput, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
1127
1159
|
getFaceSearch(args: GetFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
1128
1160
|
/**
|
|
1161
|
+
* @public
|
|
1129
1162
|
* <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
|
|
1130
1163
|
* <p>The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When
|
|
1131
1164
|
* the label detection operation finishes, Amazon Rekognition publishes a completion status to the
|
|
@@ -1197,6 +1230,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1197
1230
|
getLabelDetection(args: GetLabelDetectionCommandInput, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
1198
1231
|
getLabelDetection(args: GetLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
1199
1232
|
/**
|
|
1233
|
+
* @public
|
|
1200
1234
|
* <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
|
|
1201
1235
|
* <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
|
|
1202
1236
|
* which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
@@ -1227,6 +1261,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1227
1261
|
getPersonTracking(args: GetPersonTrackingCommandInput, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
1228
1262
|
getPersonTracking(args: GetPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
1229
1263
|
/**
|
|
1264
|
+
* @public
|
|
1230
1265
|
* <p>Gets the segment detection results of a Amazon Rekognition Video analysis started by <a>StartSegmentDetection</a>.</p>
|
|
1231
1266
|
* <p>Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
|
|
1232
1267
|
* calling <a>StartSegmentDetection</a> which returns a job identifier (<code>JobId</code>).
|
|
@@ -1254,6 +1289,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1254
1289
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
1255
1290
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
1256
1291
|
/**
|
|
1292
|
+
* @public
|
|
1257
1293
|
* <p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p>
|
|
1258
1294
|
* <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
|
|
1259
1295
|
* calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>)
|
|
@@ -1278,6 +1314,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1278
1314
|
getTextDetection(args: GetTextDetectionCommandInput, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
1279
1315
|
getTextDetection(args: GetTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
1280
1316
|
/**
|
|
1317
|
+
* @public
|
|
1281
1318
|
* <p>Detects faces in the input image and adds them to the specified collection. </p>
|
|
1282
1319
|
* <p>Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying
|
|
1283
1320
|
* detection algorithm first detects the faces in the input image. For each face, the algorithm
|
|
@@ -1374,6 +1411,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1374
1411
|
indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1375
1412
|
indexFaces(args: IndexFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1376
1413
|
/**
|
|
1414
|
+
* @public
|
|
1377
1415
|
* <p>Returns list of collection IDs in your account. If the result is truncated, the
|
|
1378
1416
|
* response also provides a <code>NextToken</code> that you can use in the subsequent request to
|
|
1379
1417
|
* fetch the next set of collection IDs.</p>
|
|
@@ -1386,6 +1424,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1386
1424
|
listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
1387
1425
|
listCollections(args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
1388
1426
|
/**
|
|
1427
|
+
* @public
|
|
1389
1428
|
* <p>
|
|
1390
1429
|
* Lists the entries (images) within a dataset. An entry is a
|
|
1391
1430
|
* JSON Line that contains the information for a single image, including
|
|
@@ -1405,6 +1444,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1405
1444
|
listDatasetEntries(args: ListDatasetEntriesCommandInput, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void): void;
|
|
1406
1445
|
listDatasetEntries(args: ListDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void): void;
|
|
1407
1446
|
/**
|
|
1447
|
+
* @public
|
|
1408
1448
|
* <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
|
|
1409
1449
|
* <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling images</a>.
|
|
1410
1450
|
* </p>
|
|
@@ -1416,6 +1456,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1416
1456
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1417
1457
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1418
1458
|
/**
|
|
1459
|
+
* @public
|
|
1419
1460
|
* <p>Returns metadata for faces in the specified collection. This metadata
|
|
1420
1461
|
* includes information such as the bounding box coordinates, the confidence (that the bounding
|
|
1421
1462
|
* box contains a face), and face ID. For an example, see Listing Faces in a Collection in the
|
|
@@ -1427,6 +1468,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1427
1468
|
listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
1428
1469
|
listFaces(args: ListFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
1429
1470
|
/**
|
|
1471
|
+
* @public
|
|
1430
1472
|
* <p>Gets a list of the project policies attached to a project.</p>
|
|
1431
1473
|
* <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
|
|
1432
1474
|
*/
|
|
@@ -1434,12 +1476,14 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1434
1476
|
listProjectPolicies(args: ListProjectPoliciesCommandInput, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void): void;
|
|
1435
1477
|
listProjectPolicies(args: ListProjectPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void): void;
|
|
1436
1478
|
/**
|
|
1479
|
+
* @public
|
|
1437
1480
|
* <p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>
|
|
1438
1481
|
*/
|
|
1439
1482
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamProcessorsCommandOutput>;
|
|
1440
1483
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1441
1484
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1442
1485
|
/**
|
|
1486
|
+
* @public
|
|
1443
1487
|
* <p> Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1444
1488
|
* model. </p>
|
|
1445
1489
|
* <p>This operation requires permissions to perform the
|
|
@@ -1449,6 +1493,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1449
1493
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1450
1494
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1451
1495
|
/**
|
|
1496
|
+
* @public
|
|
1452
1497
|
* <p>Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A
|
|
1453
1498
|
* project policy specifies that a trusted AWS account can copy a model version from a
|
|
1454
1499
|
* trusting AWS account to a project in the trusted AWS account. To copy a model version you use
|
|
@@ -1467,6 +1512,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1467
1512
|
putProjectPolicy(args: PutProjectPolicyCommandInput, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1468
1513
|
putProjectPolicy(args: PutProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1469
1514
|
/**
|
|
1515
|
+
* @public
|
|
1470
1516
|
* <p>Returns an array of celebrities recognized in the input image. For more
|
|
1471
1517
|
* information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </p>
|
|
1472
1518
|
* <p>
|
|
@@ -1499,6 +1545,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1499
1545
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
1500
1546
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
1501
1547
|
/**
|
|
1548
|
+
* @public
|
|
1502
1549
|
* <p>For a given input face ID, searches for matching faces in the collection the face
|
|
1503
1550
|
* belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with
|
|
1504
1551
|
* faces in the specified collection. </p>
|
|
@@ -1520,6 +1567,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1520
1567
|
searchFaces(args: SearchFacesCommandInput, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
1521
1568
|
searchFaces(args: SearchFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
1522
1569
|
/**
|
|
1570
|
+
* @public
|
|
1523
1571
|
* <p>For a given input image, first detects the largest face in the image, and then searches
|
|
1524
1572
|
* the specified collection for matching faces. The operation compares the features of the input
|
|
1525
1573
|
* face with faces in the specified collection. </p>
|
|
@@ -1562,6 +1610,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1562
1610
|
searchFacesByImage(args: SearchFacesByImageCommandInput, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1563
1611
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1564
1612
|
/**
|
|
1613
|
+
* @public
|
|
1565
1614
|
* <p>Starts asynchronous recognition of celebrities in a stored video.</p>
|
|
1566
1615
|
* <p>Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1567
1616
|
* and the filename of the video.
|
|
@@ -1578,6 +1627,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1578
1627
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1579
1628
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1580
1629
|
/**
|
|
1630
|
+
* @public
|
|
1581
1631
|
* <p> Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see
|
|
1582
1632
|
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
1583
1633
|
* <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
@@ -1594,6 +1644,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1594
1644
|
startContentModeration(args: StartContentModerationCommandInput, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1595
1645
|
startContentModeration(args: StartContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1596
1646
|
/**
|
|
1647
|
+
* @public
|
|
1597
1648
|
* <p>Starts asynchronous detection of faces in a stored video.</p>
|
|
1598
1649
|
* <p>Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.
|
|
1599
1650
|
* Use <a>Video</a> to specify the bucket name and the filename of the video.
|
|
@@ -1611,6 +1662,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1611
1662
|
startFaceDetection(args: StartFaceDetectionCommandInput, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1612
1663
|
startFaceDetection(args: StartFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1613
1664
|
/**
|
|
1665
|
+
* @public
|
|
1614
1666
|
* <p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>
|
|
1615
1667
|
* <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1616
1668
|
* and the filename of the video. <code>StartFaceSearch</code>
|
|
@@ -1627,6 +1679,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1627
1679
|
startFaceSearch(args: StartFaceSearchCommandInput, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1628
1680
|
startFaceSearch(args: StartFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1629
1681
|
/**
|
|
1682
|
+
* @public
|
|
1630
1683
|
* <p>Starts asynchronous detection of labels in a stored video.</p>
|
|
1631
1684
|
* <p>Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.
|
|
1632
1685
|
* This includes objects like flower, tree, and table; events like
|
|
@@ -1657,6 +1710,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1657
1710
|
startLabelDetection(args: StartLabelDetectionCommandInput, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1658
1711
|
startLabelDetection(args: StartLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1659
1712
|
/**
|
|
1713
|
+
* @public
|
|
1660
1714
|
* <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
|
|
1661
1715
|
* <p>Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1662
1716
|
* and the filename of the video. <code>StartPersonTracking</code>
|
|
@@ -1671,6 +1725,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1671
1725
|
startPersonTracking(args: StartPersonTrackingCommandInput, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1672
1726
|
startPersonTracking(args: StartPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1673
1727
|
/**
|
|
1728
|
+
* @public
|
|
1674
1729
|
* <p>Starts the running of the version of a model. Starting a model takes a while
|
|
1675
1730
|
* to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>
|
|
1676
1731
|
* <p>Once the model is running, you can detect custom labels in new images by calling
|
|
@@ -1687,6 +1742,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1687
1742
|
startProjectVersion(args: StartProjectVersionCommandInput, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1688
1743
|
startProjectVersion(args: StartProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1689
1744
|
/**
|
|
1745
|
+
* @public
|
|
1690
1746
|
* <p>Starts asynchronous detection of segment detection in a stored video.</p>
|
|
1691
1747
|
* <p>Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1692
1748
|
* the filename of the video. <code>StartSegmentDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
@@ -1706,6 +1762,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1706
1762
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1707
1763
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1708
1764
|
/**
|
|
1765
|
+
* @public
|
|
1709
1766
|
* <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
|
|
1710
1767
|
* To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
|
|
1711
1768
|
* <code>CreateStreamProcessor</code>.</p>
|
|
@@ -1715,6 +1772,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1715
1772
|
startStreamProcessor(args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1716
1773
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1717
1774
|
/**
|
|
1775
|
+
* @public
|
|
1718
1776
|
* <p>Starts asynchronous detection of text in a stored video.</p>
|
|
1719
1777
|
* <p>Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1720
1778
|
* the filename of the video. <code>StartTextDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
@@ -1728,6 +1786,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1728
1786
|
startTextDetection(args: StartTextDetectionCommandInput, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1729
1787
|
startTextDetection(args: StartTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1730
1788
|
/**
|
|
1789
|
+
* @public
|
|
1731
1790
|
* <p>Stops a running model. The operation might take a while to complete. To
|
|
1732
1791
|
* check the current status, call <a>DescribeProjectVersions</a>. </p>
|
|
1733
1792
|
*/
|
|
@@ -1735,12 +1794,14 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1735
1794
|
stopProjectVersion(args: StopProjectVersionCommandInput, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1736
1795
|
stopProjectVersion(args: StopProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1737
1796
|
/**
|
|
1797
|
+
* @public
|
|
1738
1798
|
* <p>Stops a running stream processor that was created by <a>CreateStreamProcessor</a>.</p>
|
|
1739
1799
|
*/
|
|
1740
1800
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StopStreamProcessorCommandOutput>;
|
|
1741
1801
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1742
1802
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1743
1803
|
/**
|
|
1804
|
+
* @public
|
|
1744
1805
|
* <p> Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom
|
|
1745
1806
|
* Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1746
1807
|
* Resources</a>. </p>
|
|
@@ -1751,6 +1812,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1751
1812
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1752
1813
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1753
1814
|
/**
|
|
1815
|
+
* @public
|
|
1754
1816
|
* <p> Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1755
1817
|
* model. </p>
|
|
1756
1818
|
* <p>This operation requires permissions to perform the
|
|
@@ -1760,6 +1822,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1760
1822
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1761
1823
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1762
1824
|
/**
|
|
1825
|
+
* @public
|
|
1763
1826
|
* <p>Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the
|
|
1764
1827
|
* information for a single image, including
|
|
1765
1828
|
* the image location, assigned labels, and object location bounding boxes. For more information,
|
|
@@ -1787,6 +1850,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1787
1850
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1788
1851
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1789
1852
|
/**
|
|
1853
|
+
* @public
|
|
1790
1854
|
* <p>
|
|
1791
1855
|
* Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.
|
|
1792
1856
|
* </p>
|
|
@@ -71,15 +71,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
71
71
|
import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } from "./commands/UpdateDatasetEntriesCommand";
|
|
72
72
|
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
73
73
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
74
77
|
export type ServiceInputTypes = CompareFacesCommandInput | CopyProjectVersionCommandInput | CreateCollectionCommandInput | CreateDatasetCommandInput | CreateProjectCommandInput | CreateProjectVersionCommandInput | CreateStreamProcessorCommandInput | DeleteCollectionCommandInput | DeleteDatasetCommandInput | DeleteFacesCommandInput | DeleteProjectCommandInput | DeleteProjectPolicyCommandInput | DeleteProjectVersionCommandInput | DeleteStreamProcessorCommandInput | DescribeCollectionCommandInput | DescribeDatasetCommandInput | DescribeProjectVersionsCommandInput | DescribeProjectsCommandInput | DescribeStreamProcessorCommandInput | DetectCustomLabelsCommandInput | DetectFacesCommandInput | DetectLabelsCommandInput | DetectModerationLabelsCommandInput | DetectProtectiveEquipmentCommandInput | DetectTextCommandInput | DistributeDatasetEntriesCommandInput | GetCelebrityInfoCommandInput | GetCelebrityRecognitionCommandInput | GetContentModerationCommandInput | GetFaceDetectionCommandInput | GetFaceSearchCommandInput | GetLabelDetectionCommandInput | GetPersonTrackingCommandInput | GetSegmentDetectionCommandInput | GetTextDetectionCommandInput | IndexFacesCommandInput | ListCollectionsCommandInput | ListDatasetEntriesCommandInput | ListDatasetLabelsCommandInput | ListFacesCommandInput | ListProjectPoliciesCommandInput | ListStreamProcessorsCommandInput | ListTagsForResourceCommandInput | PutProjectPolicyCommandInput | RecognizeCelebritiesCommandInput | SearchFacesByImageCommandInput | SearchFacesCommandInput | StartCelebrityRecognitionCommandInput | StartContentModerationCommandInput | StartFaceDetectionCommandInput | StartFaceSearchCommandInput | StartLabelDetectionCommandInput | StartPersonTrackingCommandInput | StartProjectVersionCommandInput | StartSegmentDetectionCommandInput | StartStreamProcessorCommandInput | StartTextDetectionCommandInput | StopProjectVersionCommandInput | StopStreamProcessorCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetEntriesCommandInput | UpdateStreamProcessorCommandInput;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
75
81
|
export type ServiceOutputTypes = CompareFacesCommandOutput | CopyProjectVersionCommandOutput | CreateCollectionCommandOutput | CreateDatasetCommandOutput | CreateProjectCommandOutput | CreateProjectVersionCommandOutput | CreateStreamProcessorCommandOutput | DeleteCollectionCommandOutput | DeleteDatasetCommandOutput | DeleteFacesCommandOutput | DeleteProjectCommandOutput | DeleteProjectPolicyCommandOutput | DeleteProjectVersionCommandOutput | DeleteStreamProcessorCommandOutput | DescribeCollectionCommandOutput | DescribeDatasetCommandOutput | DescribeProjectVersionsCommandOutput | DescribeProjectsCommandOutput | DescribeStreamProcessorCommandOutput | DetectCustomLabelsCommandOutput | DetectFacesCommandOutput | DetectLabelsCommandOutput | DetectModerationLabelsCommandOutput | DetectProtectiveEquipmentCommandOutput | DetectTextCommandOutput | DistributeDatasetEntriesCommandOutput | GetCelebrityInfoCommandOutput | GetCelebrityRecognitionCommandOutput | GetContentModerationCommandOutput | GetFaceDetectionCommandOutput | GetFaceSearchCommandOutput | GetLabelDetectionCommandOutput | GetPersonTrackingCommandOutput | GetSegmentDetectionCommandOutput | GetTextDetectionCommandOutput | IndexFacesCommandOutput | ListCollectionsCommandOutput | ListDatasetEntriesCommandOutput | ListDatasetLabelsCommandOutput | ListFacesCommandOutput | ListProjectPoliciesCommandOutput | ListStreamProcessorsCommandOutput | ListTagsForResourceCommandOutput | PutProjectPolicyCommandOutput | RecognizeCelebritiesCommandOutput | SearchFacesByImageCommandOutput | SearchFacesCommandOutput | StartCelebrityRecognitionCommandOutput | StartContentModerationCommandOutput | StartFaceDetectionCommandOutput | StartFaceSearchCommandOutput | StartLabelDetectionCommandOutput | StartPersonTrackingCommandOutput | StartProjectVersionCommandOutput | StartSegmentDetectionCommandOutput | StartStreamProcessorCommandOutput | StartTextDetectionCommandOutput | StopProjectVersionCommandOutput | StopStreamProcessorCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetEntriesCommandOutput | UpdateStreamProcessorCommandOutput;
|
|
82
|
+
/**
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
76
85
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
77
86
|
/**
|
|
78
87
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
79
88
|
*/
|
|
80
89
|
requestHandler?: __HttpHandler;
|
|
81
90
|
/**
|
|
82
|
-
* A constructor for a class implementing the {@link
|
|
91
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
83
92
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
84
93
|
* @internal
|
|
85
94
|
*/
|
|
@@ -169,23 +178,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
169
178
|
*/
|
|
170
179
|
logger?: __Logger;
|
|
171
180
|
/**
|
|
172
|
-
* The {@link
|
|
181
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
173
182
|
*/
|
|
174
183
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
175
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
176
188
|
type RekognitionClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
177
189
|
/**
|
|
178
|
-
*
|
|
190
|
+
* @public
|
|
191
|
+
*
|
|
192
|
+
* The configuration interface of RekognitionClient class constructor that set the region, credentials and other options.
|
|
179
193
|
*/
|
|
180
194
|
export interface RekognitionClientConfig extends RekognitionClientConfigType {
|
|
181
195
|
}
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
182
199
|
type RekognitionClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
183
200
|
/**
|
|
184
|
-
*
|
|
201
|
+
* @public
|
|
202
|
+
*
|
|
203
|
+
* The resolved configuration interface of RekognitionClient class. This is resolved and normalized from the {@link RekognitionClientConfig | constructor configuration interface}.
|
|
185
204
|
*/
|
|
186
205
|
export interface RekognitionClientResolvedConfig extends RekognitionClientResolvedConfigType {
|
|
187
206
|
}
|
|
188
207
|
/**
|
|
208
|
+
* @public
|
|
189
209
|
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
190
210
|
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
191
211
|
* Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
|