@aws-sdk/client-rekognition 3.208.0 → 3.209.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/README.md +4 -13
- package/dist-cjs/endpoint/ruleset.js +6 -6
- package/dist-cjs/models/models_0.js +63 -6
- package/dist-cjs/protocols/Aws_json1_1.js +138 -0
- package/dist-cjs/runtimeConfig.shared.js +2 -1
- package/dist-es/endpoint/ruleset.js +6 -6
- package/dist-es/models/models_0.js +47 -0
- package/dist-es/protocols/Aws_json1_1.js +138 -0
- package/dist-es/runtimeConfig.shared.js +2 -1
- package/dist-types/Rekognition.d.ts +226 -229
- package/dist-types/RekognitionClient.d.ts +4 -17
- package/dist-types/commands/CompareFacesCommand.d.ts +30 -41
- package/dist-types/commands/CreateCollectionCommand.d.ts +5 -3
- package/dist-types/commands/DeleteCollectionCommand.d.ts +3 -3
- package/dist-types/commands/DetectFacesCommand.d.ts +6 -10
- package/dist-types/commands/DetectLabelsCommand.d.ts +83 -38
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +8 -8
- package/dist-types/commands/DetectTextCommand.d.ts +4 -2
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +2 -2
- package/dist-types/commands/IndexFacesCommand.d.ts +22 -28
- package/dist-types/commands/ListCollectionsCommand.d.ts +7 -5
- package/dist-types/commands/ListFacesCommand.d.ts +6 -8
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -4
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +7 -10
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +20 -29
- package/dist-types/commands/SearchFacesCommand.d.ts +7 -11
- package/dist-types/commands/TagResourceCommand.d.ts +5 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -4
- package/dist-types/models/models_0.d.ts +564 -320
- package/dist-types/runtimeConfig.shared.d.ts +2 -3
- package/dist-types/ts3.4/models/models_0.d.ts +96 -10
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -3
- package/package.json +11 -13
|
@@ -39,8 +39,8 @@ export interface AgeRange {
|
|
|
39
39
|
* Amazon Rekognition operations.</p>
|
|
40
40
|
*
|
|
41
41
|
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
42
|
-
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
43
|
-
* Developer Guide. </p>
|
|
42
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
43
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
44
44
|
*/
|
|
45
45
|
export interface S3Object {
|
|
46
46
|
/**
|
|
@@ -67,8 +67,8 @@ export interface GroundTruthManifest {
|
|
|
67
67
|
* Amazon Rekognition operations.</p>
|
|
68
68
|
*
|
|
69
69
|
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
70
|
-
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
71
|
-
* Developer Guide. </p>
|
|
70
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
71
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
72
72
|
*/
|
|
73
73
|
S3Object?: S3Object;
|
|
74
74
|
}
|
|
@@ -161,10 +161,10 @@ export declare enum BodyPart {
|
|
|
161
161
|
RIGHT_HAND = "RIGHT_HAND"
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
165
|
-
* The <code>left</code> (x-coordinate) and <code>top</code>
|
|
166
|
-
*
|
|
167
|
-
* (0,0). </p>
|
|
164
|
+
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
165
|
+
* personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
|
|
166
|
+
* (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
|
|
167
|
+
* that the upper-left corner of the image is the origin (0,0). </p>
|
|
168
168
|
* <p>The <code>top</code> and <code>left</code> values returned are ratios of the overall
|
|
169
169
|
* image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of
|
|
170
170
|
* the bounding box is 350x50 pixels, the API returns a <code>left</code> value of 0.5 (350/700)
|
|
@@ -260,12 +260,23 @@ export interface ProtectiveEquipmentBodyPart {
|
|
|
260
260
|
*/
|
|
261
261
|
EquipmentDetections?: EquipmentDetection[];
|
|
262
262
|
}
|
|
263
|
-
export declare
|
|
263
|
+
export declare enum EmotionName {
|
|
264
|
+
ANGRY = "ANGRY",
|
|
265
|
+
CALM = "CALM",
|
|
266
|
+
CONFUSED = "CONFUSED",
|
|
267
|
+
DISGUSTED = "DISGUSTED",
|
|
268
|
+
FEAR = "FEAR",
|
|
269
|
+
HAPPY = "HAPPY",
|
|
270
|
+
SAD = "SAD",
|
|
271
|
+
SURPRISED = "SURPRISED",
|
|
272
|
+
UNKNOWN = "UNKNOWN"
|
|
273
|
+
}
|
|
264
274
|
/**
|
|
265
|
-
* <p>The emotions that appear to be expressed on the face, and the confidence level in the
|
|
266
|
-
* The API is only making a determination of the physical appearance of a person's
|
|
267
|
-
* of the person’s internal emotional state and should not be
|
|
268
|
-
* a sad face might not be sad
|
|
275
|
+
* <p>The emotions that appear to be expressed on the face, and the confidence level in the
|
|
276
|
+
* determination. The API is only making a determination of the physical appearance of a person's
|
|
277
|
+
* face. It is not a determination of the person’s internal emotional state and should not be
|
|
278
|
+
* used in such a way. For example, a person pretending to have a sad face might not be sad
|
|
279
|
+
* emotionally.</p>
|
|
269
280
|
*/
|
|
270
281
|
export interface Emotion {
|
|
271
282
|
/**
|
|
@@ -318,15 +329,16 @@ export interface Landmark {
|
|
|
318
329
|
*/
|
|
319
330
|
Type?: LandmarkType | string;
|
|
320
331
|
/**
|
|
321
|
-
* <p>The x-coordinate of the landmark expressed as a ratio of the width of the image.
|
|
322
|
-
*
|
|
323
|
-
*
|
|
332
|
+
* <p>The x-coordinate of the landmark expressed as a ratio of the width of the image. The
|
|
333
|
+
* x-coordinate is measured from the left-side of the image. For example, if the image is 700
|
|
334
|
+
* pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
|
|
335
|
+
* </p>
|
|
324
336
|
*/
|
|
325
337
|
X?: number;
|
|
326
338
|
/**
|
|
327
|
-
* <p>The y-coordinate of the landmark expressed as a ratio of the height of the image.
|
|
328
|
-
*
|
|
329
|
-
*
|
|
339
|
+
* <p>The y-coordinate of the landmark expressed as a ratio of the height of the image. The
|
|
340
|
+
* y-coordinate is measured from the top of the image. For example, if the image height is 200
|
|
341
|
+
* pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.</p>
|
|
330
342
|
*/
|
|
331
343
|
Y?: number;
|
|
332
344
|
}
|
|
@@ -402,15 +414,14 @@ export interface ComparedFace {
|
|
|
402
414
|
*/
|
|
403
415
|
Quality?: ImageQuality;
|
|
404
416
|
/**
|
|
405
|
-
* <p> The emotions that appear to be expressed on the face,
|
|
406
|
-
*
|
|
407
|
-
* "
|
|
408
|
-
* </p>
|
|
417
|
+
* <p> The emotions that appear to be expressed on the face, and the confidence level in the
|
|
418
|
+
* determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted",
|
|
419
|
+
* "Surprised", "Calm", "Unknown", and "Fear". </p>
|
|
409
420
|
*/
|
|
410
421
|
Emotions?: Emotion[];
|
|
411
422
|
/**
|
|
412
|
-
* <p> Indicates whether or not the face is smiling, and the confidence level in the
|
|
413
|
-
*
|
|
423
|
+
* <p> Indicates whether or not the face is smiling, and the confidence level in the
|
|
424
|
+
* determination. </p>
|
|
414
425
|
*/
|
|
415
426
|
Smile?: Smile;
|
|
416
427
|
}
|
|
@@ -497,18 +508,19 @@ export declare enum GenderType {
|
|
|
497
508
|
}
|
|
498
509
|
/**
|
|
499
510
|
* <p>The predicted gender of a detected face.
|
|
500
|
-
* </p>
|
|
501
|
-
*
|
|
502
|
-
*
|
|
503
|
-
* <p>Amazon Rekognition makes gender binary (male/female) predictions based on the physical appearance
|
|
504
|
-
* of a face in a particular image. This kind of prediction is not designed to categorize a person’s gender
|
|
505
|
-
* identity, and you shouldn't use Amazon Rekognition to make such a determination. For example, a male actor
|
|
506
|
-
* wearing a long-haired wig and earrings for a role might be predicted as female.</p>
|
|
507
511
|
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
+
* </p>
|
|
513
|
+
* <p>Amazon Rekognition makes gender binary (male/female) predictions based on the physical
|
|
514
|
+
* appearance of a face in a particular image. This kind of prediction is not designed to
|
|
515
|
+
* categorize a person’s gender identity, and you shouldn't use Amazon Rekognition to make such a
|
|
516
|
+
* determination. For example, a male actor wearing a long-haired wig and earrings for a role
|
|
517
|
+
* might be predicted as female.</p>
|
|
518
|
+
* <p>Using Amazon Rekognition to make gender binary predictions is best suited for use cases
|
|
519
|
+
* where aggregate gender distribution statistics need to be analyzed without identifying
|
|
520
|
+
* specific users. For example, the percentage of female users compared to male users on a social
|
|
521
|
+
* media platform. </p>
|
|
522
|
+
* <p>We don't recommend using gender binary predictions to make decisions that impact an
|
|
523
|
+
* individual's rights, privacy, or access to services.</p>
|
|
512
524
|
*/
|
|
513
525
|
export interface Gender {
|
|
514
526
|
/**
|
|
@@ -564,13 +576,16 @@ export interface Sunglasses {
|
|
|
564
576
|
}
|
|
565
577
|
/**
|
|
566
578
|
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
567
|
-
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
568
|
-
* The default attributes are <code>BoundingBox</code>,
|
|
579
|
+
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
580
|
+
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
581
|
+
* <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
|
|
582
|
+
* <code>Quality</code>.</p>
|
|
569
583
|
* <p>
|
|
570
|
-
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
571
|
-
*
|
|
572
|
-
* The following Amazon Rekognition Video operations return only the default
|
|
573
|
-
*
|
|
584
|
+
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
585
|
+
* return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
|
|
586
|
+
* return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
|
|
587
|
+
* attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
|
|
588
|
+
* parameter.</p>
|
|
574
589
|
* <ul>
|
|
575
590
|
* <li>
|
|
576
591
|
* <p>GetCelebrityRecognition</p>
|
|
@@ -584,8 +599,8 @@ export interface Sunglasses {
|
|
|
584
599
|
* </ul>
|
|
585
600
|
* <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
|
|
586
601
|
* can return all facial attributes. To specify which attributes to return, use the
|
|
587
|
-
*
|
|
588
|
-
*
|
|
602
|
+
* <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
|
|
603
|
+
* <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
|
|
589
604
|
*/
|
|
590
605
|
export interface FaceDetail {
|
|
591
606
|
/**
|
|
@@ -613,8 +628,7 @@ export interface FaceDetail {
|
|
|
613
628
|
*/
|
|
614
629
|
Sunglasses?: Sunglasses;
|
|
615
630
|
/**
|
|
616
|
-
* <p>The predicted gender of a detected face.
|
|
617
|
-
* </p>
|
|
631
|
+
* <p>The predicted gender of a detected face. </p>
|
|
618
632
|
*/
|
|
619
633
|
Gender?: Gender;
|
|
620
634
|
/**
|
|
@@ -638,10 +652,11 @@ export interface FaceDetail {
|
|
|
638
652
|
*/
|
|
639
653
|
MouthOpen?: MouthOpen;
|
|
640
654
|
/**
|
|
641
|
-
* <p>The emotions that appear to be expressed on the face, and the confidence level in the
|
|
642
|
-
* The API is only making a determination of the physical appearance of a person's
|
|
643
|
-
* of the person’s internal emotional state and should not be
|
|
644
|
-
* a sad face might not be sad
|
|
655
|
+
* <p>The emotions that appear to be expressed on the face, and the confidence level in the
|
|
656
|
+
* determination. The API is only making a determination of the physical appearance of a person's
|
|
657
|
+
* face. It is not a determination of the person’s internal emotional state and should not be
|
|
658
|
+
* used in such a way. For example, a person pretending to have a sad face might not be sad
|
|
659
|
+
* emotionally.</p>
|
|
645
660
|
*/
|
|
646
661
|
Emotions?: Emotion[];
|
|
647
662
|
/**
|
|
@@ -649,7 +664,8 @@ export interface FaceDetail {
|
|
|
649
664
|
*/
|
|
650
665
|
Landmarks?: Landmark[];
|
|
651
666
|
/**
|
|
652
|
-
* <p>Indicates the pose of the face as determined by its pitch, roll, and yaw. Default
|
|
667
|
+
* <p>Indicates the pose of the face as determined by its pitch, roll, and yaw. Default
|
|
668
|
+
* attribute.</p>
|
|
653
669
|
*/
|
|
654
670
|
Pose?: Pose;
|
|
655
671
|
/**
|
|
@@ -701,7 +717,8 @@ export interface CelebrityDetail {
|
|
|
701
717
|
*/
|
|
702
718
|
export interface CelebrityRecognition {
|
|
703
719
|
/**
|
|
704
|
-
* <p>The time, in milliseconds from the start of the video, that the celebrity was recognized
|
|
720
|
+
* <p>The time, in milliseconds from the start of the video, that the celebrity was recognized.
|
|
721
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the celebrity first appears.</p>
|
|
705
722
|
*/
|
|
706
723
|
Timestamp?: number;
|
|
707
724
|
/**
|
|
@@ -757,9 +774,9 @@ export declare enum QualityFilter {
|
|
|
757
774
|
* property is not supported. You must first upload the image to an Amazon S3 bucket and then
|
|
758
775
|
* call the operation using the S3Object property.</p>
|
|
759
776
|
*
|
|
760
|
-
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
761
|
-
* object. For more information, see How Amazon Rekognition works with IAM in the
|
|
762
|
-
*
|
|
777
|
+
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
778
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
779
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
763
780
|
*/
|
|
764
781
|
export interface Image {
|
|
765
782
|
/**
|
|
@@ -773,21 +790,19 @@ export interface Image {
|
|
|
773
790
|
}
|
|
774
791
|
export interface CompareFacesRequest {
|
|
775
792
|
/**
|
|
776
|
-
* <p>The input image as base64-encoded bytes or an S3 object.
|
|
777
|
-
*
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
781
|
-
* For more information, see Images in the Amazon Rekognition developer guide.</p>
|
|
793
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
794
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
795
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
796
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
797
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
782
798
|
*/
|
|
783
799
|
SourceImage: Image | undefined;
|
|
784
800
|
/**
|
|
785
801
|
* <p>The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
786
|
-
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
|
|
787
|
-
*
|
|
788
|
-
*
|
|
789
|
-
*
|
|
790
|
-
* For more information, see Images in the Amazon Rekognition developer guide.</p>
|
|
802
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
803
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
804
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
805
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
791
806
|
*/
|
|
792
807
|
TargetImage: Image | undefined;
|
|
793
808
|
/**
|
|
@@ -797,18 +812,16 @@ export interface CompareFacesRequest {
|
|
|
797
812
|
SimilarityThreshold?: number;
|
|
798
813
|
/**
|
|
799
814
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
800
|
-
* Filtered faces aren't compared. If you specify <code>AUTO</code>, Amazon Rekognition chooses the
|
|
801
|
-
* If you specify <code>LOW</code>,
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
810
|
-
* </p>
|
|
811
|
-
* <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>
|
|
815
|
+
* Filtered faces aren't compared. If you specify <code>AUTO</code>, Amazon Rekognition chooses the
|
|
816
|
+
* quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>,
|
|
817
|
+
* filtering removes all faces that don’t meet the chosen quality bar.
|
|
818
|
+
* The quality bar is
|
|
819
|
+
* based on a variety of common use cases. Low-quality detections can occur for a number of
|
|
820
|
+
* reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,
|
|
821
|
+
* or a face with a pose that's too extreme to use. If you specify <code>NONE</code>, no
|
|
822
|
+
* filtering is performed. The default value is <code>NONE</code>. </p>
|
|
823
|
+
* <p>To use quality filtering, the collection you are using must be associated with version 3
|
|
824
|
+
* of the face model or higher.</p>
|
|
812
825
|
*/
|
|
813
826
|
QualityFilter?: QualityFilter | string;
|
|
814
827
|
}
|
|
@@ -854,35 +867,34 @@ export interface CompareFacesResponse {
|
|
|
854
867
|
UnmatchedFaces?: ComparedFace[];
|
|
855
868
|
/**
|
|
856
869
|
* <p>The value of <code>SourceImageOrientationCorrection</code> is always null.</p>
|
|
857
|
-
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
858
|
-
* that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
859
|
-
* image correction. The bounding box coordinates are translated to
|
|
860
|
-
* after the orientation information in the Exif metadata is used to
|
|
861
|
-
* Images in .png format don't contain Exif metadata.</p>
|
|
862
|
-
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
* </p>
|
|
870
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
871
|
+
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
872
|
+
* information to perform image correction. The bounding box coordinates are translated to
|
|
873
|
+
* represent object locations after the orientation information in the Exif metadata is used to
|
|
874
|
+
* correct the image orientation. Images in .png format don't contain Exif metadata.</p>
|
|
875
|
+
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images
|
|
876
|
+
* without orientation information in the image Exif metadata. The bounding box coordinates
|
|
877
|
+
* aren't translated and represent the object locations before the image is rotated. </p>
|
|
866
878
|
*/
|
|
867
879
|
SourceImageOrientationCorrection?: OrientationCorrection | string;
|
|
868
880
|
/**
|
|
869
881
|
* <p>The value of <code>TargetImageOrientationCorrection</code> is always null.</p>
|
|
870
|
-
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
871
|
-
* that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
872
|
-
* image correction. The bounding box coordinates are translated to
|
|
873
|
-
* after the orientation information in the Exif metadata is used to
|
|
874
|
-
* Images in .png format don't contain Exif metadata.</p>
|
|
875
|
-
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
* </p>
|
|
882
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
883
|
+
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
884
|
+
* information to perform image correction. The bounding box coordinates are translated to
|
|
885
|
+
* represent object locations after the orientation information in the Exif metadata is used to
|
|
886
|
+
* correct the image orientation. Images in .png format don't contain Exif metadata.</p>
|
|
887
|
+
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images
|
|
888
|
+
* without orientation information in the image Exif metadata. The bounding box coordinates
|
|
889
|
+
* aren't translated and represent the object locations before the image is rotated. </p>
|
|
879
890
|
*/
|
|
880
891
|
TargetImageOrientationCorrection?: OrientationCorrection | string;
|
|
881
892
|
}
|
|
882
893
|
/**
|
|
883
894
|
* <p>The input image size exceeds the allowed limit. If you are calling
|
|
884
|
-
* DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more
|
|
885
|
-
* Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
|
|
895
|
+
* DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more
|
|
896
|
+
* information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
|
|
897
|
+
* </p>
|
|
886
898
|
*/
|
|
887
899
|
export declare class ImageTooLargeException extends __BaseException {
|
|
888
900
|
readonly name: "ImageTooLargeException";
|
|
@@ -1049,9 +1061,10 @@ export declare enum ContentClassifier {
|
|
|
1049
1061
|
FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
|
|
1050
1062
|
}
|
|
1051
1063
|
/**
|
|
1052
|
-
* <p>Provides information about a single type of inappropriate, unwanted, or
|
|
1053
|
-
*
|
|
1054
|
-
* Content moderation in the Amazon Rekognition
|
|
1064
|
+
* <p>Provides information about a single type of inappropriate, unwanted, or
|
|
1065
|
+
* offensive content found in an image or video. Each type of moderated content has a label
|
|
1066
|
+
* within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition
|
|
1067
|
+
* Developer Guide.</p>
|
|
1055
1068
|
*/
|
|
1056
1069
|
export interface ModerationLabel {
|
|
1057
1070
|
/**
|
|
@@ -1077,7 +1090,8 @@ export interface ModerationLabel {
|
|
|
1077
1090
|
*/
|
|
1078
1091
|
export interface ContentModerationDetection {
|
|
1079
1092
|
/**
|
|
1080
|
-
* <p>Time, in milliseconds from the beginning of the video, that the content moderation label was detected
|
|
1093
|
+
* <p>Time, in milliseconds from the beginning of the video, that the content moderation label was detected.
|
|
1094
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the moderated content first appears.</p>
|
|
1081
1095
|
*/
|
|
1082
1096
|
Timestamp?: number;
|
|
1083
1097
|
/**
|
|
@@ -1215,9 +1229,8 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1215
1229
|
/**
|
|
1216
1230
|
* <p></p>
|
|
1217
1231
|
*
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1220
|
-
* Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
|
|
1232
|
+
* <p>The size of the collection exceeds the allowed limit. For more information,
|
|
1233
|
+
* see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
|
|
1221
1234
|
*/
|
|
1222
1235
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1223
1236
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -1239,9 +1252,7 @@ export interface CreateCollectionRequest {
|
|
|
1239
1252
|
*/
|
|
1240
1253
|
CollectionId: string | undefined;
|
|
1241
1254
|
/**
|
|
1242
|
-
* <p>
|
|
1243
|
-
* A set of tags (key-value pairs) that you want to attach to the collection.
|
|
1244
|
-
* </p>
|
|
1255
|
+
* <p> A set of tags (key-value pairs) that you want to attach to the collection. </p>
|
|
1245
1256
|
*/
|
|
1246
1257
|
Tags?: Record<string, string>;
|
|
1247
1258
|
}
|
|
@@ -1256,7 +1267,8 @@ export interface CreateCollectionResponse {
|
|
|
1256
1267
|
*/
|
|
1257
1268
|
CollectionArn?: string;
|
|
1258
1269
|
/**
|
|
1259
|
-
* <p>Version number of the face detection model associated with the collection you are
|
|
1270
|
+
* <p>Version number of the face detection model associated with the collection you are
|
|
1271
|
+
* creating.</p>
|
|
1260
1272
|
*/
|
|
1261
1273
|
FaceModelVersion?: string;
|
|
1262
1274
|
}
|
|
@@ -1405,9 +1417,7 @@ export interface CreateProjectVersionRequest {
|
|
|
1405
1417
|
*/
|
|
1406
1418
|
TestingData?: TestingData;
|
|
1407
1419
|
/**
|
|
1408
|
-
* <p>
|
|
1409
|
-
* A set of tags (key-value pairs) that you want to attach to the model.
|
|
1410
|
-
* </p>
|
|
1420
|
+
* <p> A set of tags (key-value pairs) that you want to attach to the model. </p>
|
|
1411
1421
|
*/
|
|
1412
1422
|
Tags?: Record<string, string>;
|
|
1413
1423
|
/**
|
|
@@ -1542,15 +1552,15 @@ export interface StreamProcessorOutput {
|
|
|
1542
1552
|
S3Destination?: S3Destination;
|
|
1543
1553
|
}
|
|
1544
1554
|
/**
|
|
1545
|
-
* <p>The X and Y coordinates of a point on an image or video frame. The X and Y values are
|
|
1546
|
-
* of the overall image size or video resolution. For example, if an input image is
|
|
1547
|
-
* values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel
|
|
1555
|
+
* <p>The X and Y coordinates of a point on an image or video frame. The X and Y values are
|
|
1556
|
+
* ratios of the overall image size or video resolution. For example, if an input image is
|
|
1557
|
+
* 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel
|
|
1558
|
+
* coordinate on the image.</p>
|
|
1548
1559
|
*
|
|
1549
|
-
* <p>An array of <code>Point</code> objects makes up a <code>Polygon</code>.
|
|
1550
|
-
*
|
|
1551
|
-
* <code>Polygon</code>
|
|
1552
|
-
*
|
|
1553
|
-
* Amazon Rekognition Developer Guide. </p>
|
|
1560
|
+
* <p>An array of <code>Point</code> objects makes up a <code>Polygon</code>. A
|
|
1561
|
+
* <code>Polygon</code> is returned by <a>DetectText</a> and by <a>DetectCustomLabels</a>
|
|
1562
|
+
* <code>Polygon</code> represents a fine-grained polygon around a detected item. For more
|
|
1563
|
+
* information, see Geometry in the Amazon Rekognition Developer Guide. </p>
|
|
1554
1564
|
*/
|
|
1555
1565
|
export interface Point {
|
|
1556
1566
|
/**
|
|
@@ -1645,9 +1655,7 @@ export interface CreateStreamProcessorRequest {
|
|
|
1645
1655
|
*/
|
|
1646
1656
|
RoleArn: string | undefined;
|
|
1647
1657
|
/**
|
|
1648
|
-
* <p>
|
|
1649
|
-
* A set of tags (key-value pairs) that you want to attach to the stream processor.
|
|
1650
|
-
* </p>
|
|
1658
|
+
* <p> A set of tags (key-value pairs) that you want to attach to the stream processor. </p>
|
|
1651
1659
|
*/
|
|
1652
1660
|
Tags?: Record<string, string>;
|
|
1653
1661
|
/**
|
|
@@ -1689,8 +1697,7 @@ export interface CreateStreamProcessorResponse {
|
|
|
1689
1697
|
StreamProcessorArn?: string;
|
|
1690
1698
|
}
|
|
1691
1699
|
/**
|
|
1692
|
-
* <p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on
|
|
1693
|
-
* an image.</p>
|
|
1700
|
+
* <p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on an image.</p>
|
|
1694
1701
|
*/
|
|
1695
1702
|
export interface Geometry {
|
|
1696
1703
|
/**
|
|
@@ -2200,8 +2207,8 @@ export interface Summary {
|
|
|
2200
2207
|
* Amazon Rekognition operations.</p>
|
|
2201
2208
|
*
|
|
2202
2209
|
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
2203
|
-
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
2204
|
-
* Developer Guide. </p>
|
|
2210
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
2211
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
2205
2212
|
*/
|
|
2206
2213
|
S3Object?: S3Object;
|
|
2207
2214
|
}
|
|
@@ -2469,9 +2476,9 @@ export interface DetectCustomLabelsRequest {
|
|
|
2469
2476
|
* property is not supported. You must first upload the image to an Amazon S3 bucket and then
|
|
2470
2477
|
* call the operation using the S3Object property.</p>
|
|
2471
2478
|
*
|
|
2472
|
-
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
2473
|
-
* object. For more information, see How Amazon Rekognition works with IAM in the
|
|
2474
|
-
*
|
|
2479
|
+
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
2480
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
2481
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
2475
2482
|
*/
|
|
2476
2483
|
Image: Image | undefined;
|
|
2477
2484
|
/**
|
|
@@ -2518,11 +2525,11 @@ export declare class ResourceNotReadyException extends __BaseException {
|
|
|
2518
2525
|
}
|
|
2519
2526
|
export interface DetectFacesRequest {
|
|
2520
2527
|
/**
|
|
2521
|
-
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
2522
|
-
* Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
2523
|
-
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2524
|
-
* passed using the <code>Bytes</code> field.
|
|
2525
|
-
*
|
|
2528
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
2529
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
2530
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2531
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
2532
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
2526
2533
|
*/
|
|
2527
2534
|
Image: Image | undefined;
|
|
2528
2535
|
/**
|
|
@@ -2544,15 +2551,14 @@ export interface DetectFacesResponse {
|
|
|
2544
2551
|
FaceDetails?: FaceDetail[];
|
|
2545
2552
|
/**
|
|
2546
2553
|
* <p>The value of <code>OrientationCorrection</code> is always null.</p>
|
|
2547
|
-
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
2548
|
-
* that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
2549
|
-
* image correction. The bounding box coordinates are translated to
|
|
2550
|
-
* after the orientation information in the Exif metadata is used to
|
|
2551
|
-
* Images in .png format don't contain Exif metadata.</p>
|
|
2552
|
-
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and
|
|
2553
|
-
*
|
|
2554
|
-
*
|
|
2555
|
-
* </p>
|
|
2554
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
2555
|
+
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
2556
|
+
* information to perform image correction. The bounding box coordinates are translated to
|
|
2557
|
+
* represent object locations after the orientation information in the Exif metadata is used to
|
|
2558
|
+
* correct the image orientation. Images in .png format don't contain Exif metadata.</p>
|
|
2559
|
+
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images
|
|
2560
|
+
* without orientation information in the image Exif metadata. The bounding box coordinates
|
|
2561
|
+
* aren't translated and represent the object locations before the image is rotated. </p>
|
|
2556
2562
|
*/
|
|
2557
2563
|
OrientationCorrection?: OrientationCorrection | string;
|
|
2558
2564
|
}
|
|
@@ -2577,14 +2583,66 @@ export interface DetectionFilter {
|
|
|
2577
2583
|
*/
|
|
2578
2584
|
MinBoundingBoxWidth?: number;
|
|
2579
2585
|
}
|
|
2586
|
+
export declare enum DetectLabelsFeatureName {
|
|
2587
|
+
GENERAL_LABELS = "GENERAL_LABELS",
|
|
2588
|
+
IMAGE_PROPERTIES = "IMAGE_PROPERTIES"
|
|
2589
|
+
}
|
|
2590
|
+
/**
|
|
2591
|
+
* <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
|
|
2592
|
+
* exclusive, or a combination of both and can be applied to individual l
|
|
2593
|
+
* abels or entire label categories.</p>
|
|
2594
|
+
*/
|
|
2595
|
+
export interface GeneralLabelsSettings {
|
|
2596
|
+
/**
|
|
2597
|
+
* <p>The labels that should be included in the return from DetectLabels.</p>
|
|
2598
|
+
*/
|
|
2599
|
+
LabelInclusionFilters?: string[];
|
|
2600
|
+
/**
|
|
2601
|
+
* <p>The labels that should be excluded from the return from DetectLabels.</p>
|
|
2602
|
+
*/
|
|
2603
|
+
LabelExclusionFilters?: string[];
|
|
2604
|
+
/**
|
|
2605
|
+
* <p>The label categories that should be included in the return from DetectLabels.</p>
|
|
2606
|
+
*/
|
|
2607
|
+
LabelCategoryInclusionFilters?: string[];
|
|
2608
|
+
/**
|
|
2609
|
+
* <p>The label categories that should be excluded from the return from DetectLabels.</p>
|
|
2610
|
+
*/
|
|
2611
|
+
LabelCategoryExclusionFilters?: string[];
|
|
2612
|
+
}
|
|
2613
|
+
/**
|
|
2614
|
+
* <p>Settings for the IMAGE_PROPERTIES feature type.</p>
|
|
2615
|
+
*/
|
|
2616
|
+
export interface DetectLabelsImagePropertiesSettings {
|
|
2617
|
+
/**
|
|
2618
|
+
* <p>The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.</p>
|
|
2619
|
+
*/
|
|
2620
|
+
MaxDominantColors?: number;
|
|
2621
|
+
}
|
|
2622
|
+
/**
|
|
2623
|
+
* <p>Settings for the DetectLabels request. Settings can include
|
|
2624
|
+
* filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive
|
|
2625
|
+
* or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters
|
|
2626
|
+
* allow specification of a maximum number of dominant colors.</p>
|
|
2627
|
+
*/
|
|
2628
|
+
export interface DetectLabelsSettings {
|
|
2629
|
+
/**
|
|
2630
|
+
* <p>Contains the specified filters for GENERAL_LABELS.</p>
|
|
2631
|
+
*/
|
|
2632
|
+
GeneralLabels?: GeneralLabelsSettings;
|
|
2633
|
+
/**
|
|
2634
|
+
* <p>Contains the chosen number of maximum dominant colors in an image.</p>
|
|
2635
|
+
*/
|
|
2636
|
+
ImageProperties?: DetectLabelsImagePropertiesSettings;
|
|
2637
|
+
}
|
|
2580
2638
|
export interface DetectLabelsRequest {
|
|
2581
2639
|
/**
|
|
2582
|
-
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
2583
|
-
* Amazon Rekognition operations, passing image bytes is not supported. Images stored in an
|
|
2584
|
-
*
|
|
2585
|
-
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2586
|
-
* passed using the <code>Bytes</code> field.
|
|
2587
|
-
*
|
|
2640
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
2641
|
+
* call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an
|
|
2642
|
+
* S3 Bucket do not need to be base64-encoded.</p>
|
|
2643
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2644
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
2645
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
2588
2646
|
*/
|
|
2589
2647
|
Image: Image | undefined;
|
|
2590
2648
|
/**
|
|
@@ -2599,10 +2657,150 @@ export interface DetectLabelsRequest {
|
|
|
2599
2657
|
* confidence values greater than or equal to 55 percent.</p>
|
|
2600
2658
|
*/
|
|
2601
2659
|
MinConfidence?: number;
|
|
2660
|
+
/**
|
|
2661
|
+
* <p>A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection
|
|
2662
|
+
* feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality.
|
|
2663
|
+
* If no option is specified GENERAL_LABELS is used by default.</p>
|
|
2664
|
+
*/
|
|
2665
|
+
Features?: (DetectLabelsFeatureName | string)[];
|
|
2666
|
+
/**
|
|
2667
|
+
* <p>A list of the filters to be applied to returned detected labels and image properties. Specified
|
|
2668
|
+
* filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual
|
|
2669
|
+
* labels or label categories. The exact label names or label categories must be supplied. For
|
|
2670
|
+
* a full list of labels and label categories, see LINK HERE.</p>
|
|
2671
|
+
*/
|
|
2672
|
+
Settings?: DetectLabelsSettings;
|
|
2673
|
+
}
|
|
2674
|
+
/**
|
|
2675
|
+
* <p>A description of the dominant colors in an image.</p>
|
|
2676
|
+
*/
|
|
2677
|
+
export interface DominantColor {
|
|
2678
|
+
/**
|
|
2679
|
+
* <p>The Red RGB value for a dominant color.</p>
|
|
2680
|
+
*/
|
|
2681
|
+
Red?: number;
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>The Blue RGB value for a dominant color.</p>
|
|
2684
|
+
*/
|
|
2685
|
+
Blue?: number;
|
|
2686
|
+
/**
|
|
2687
|
+
* <p>The Green RGB value for a dominant color.</p>
|
|
2688
|
+
*/
|
|
2689
|
+
Green?: number;
|
|
2690
|
+
/**
|
|
2691
|
+
* <p>The Hex code equivalent of the RGB values for a dominant color.</p>
|
|
2692
|
+
*/
|
|
2693
|
+
HexCode?: string;
|
|
2694
|
+
/**
|
|
2695
|
+
* <p>The CSS color name of a dominant color.</p>
|
|
2696
|
+
*/
|
|
2697
|
+
CSSColor?: string;
|
|
2698
|
+
/**
|
|
2699
|
+
* <p>One of 12 simplified color names applied to a dominant color.</p>
|
|
2700
|
+
*/
|
|
2701
|
+
SimplifiedColor?: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>The percentage of image pixels that have a given dominant color.</p>
|
|
2704
|
+
*/
|
|
2705
|
+
PixelPercent?: number;
|
|
2602
2706
|
}
|
|
2603
2707
|
/**
|
|
2604
|
-
* <p>
|
|
2605
|
-
|
|
2708
|
+
* <p>The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.</p>
|
|
2709
|
+
*/
|
|
2710
|
+
export interface DetectLabelsImageQuality {
|
|
2711
|
+
/**
|
|
2712
|
+
* <p>The brightness of an image provided for label detection.</p>
|
|
2713
|
+
*/
|
|
2714
|
+
Brightness?: number;
|
|
2715
|
+
/**
|
|
2716
|
+
* <p>The sharpness of an image provided for label detection.</p>
|
|
2717
|
+
*/
|
|
2718
|
+
Sharpness?: number;
|
|
2719
|
+
/**
|
|
2720
|
+
* <p>The contrast of an image provided for label detection.</p>
|
|
2721
|
+
*/
|
|
2722
|
+
Contrast?: number;
|
|
2723
|
+
}
|
|
2724
|
+
/**
|
|
2725
|
+
* <p>The background of the image with regard to image quality and dominant colors.</p>
|
|
2726
|
+
*/
|
|
2727
|
+
export interface DetectLabelsImageBackground {
|
|
2728
|
+
/**
|
|
2729
|
+
* <p>The quality of the image background as defined by brightness and sharpness.</p>
|
|
2730
|
+
*/
|
|
2731
|
+
Quality?: DetectLabelsImageQuality;
|
|
2732
|
+
/**
|
|
2733
|
+
* <p>The dominant colors found in the background of an image, defined with RGB values,
|
|
2734
|
+
* CSS color name, simplified color name, and PixelPercentage (the percentage of
|
|
2735
|
+
* image pixels that have a particular color).</p>
|
|
2736
|
+
*/
|
|
2737
|
+
DominantColors?: DominantColor[];
|
|
2738
|
+
}
|
|
2739
|
+
/**
|
|
2740
|
+
* <p>The foreground of the image with regard to image quality and dominant colors.</p>
|
|
2741
|
+
*/
|
|
2742
|
+
export interface DetectLabelsImageForeground {
|
|
2743
|
+
/**
|
|
2744
|
+
* <p>The quality of the image foreground as defined by brightness and sharpness.</p>
|
|
2745
|
+
*/
|
|
2746
|
+
Quality?: DetectLabelsImageQuality;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>The dominant colors found in the foreground of an image, defined with RGB values,
|
|
2749
|
+
* CSS color name, simplified color name, and PixelPercentage (the percentage of image
|
|
2750
|
+
* pixels that have a particular color).</p>
|
|
2751
|
+
*/
|
|
2752
|
+
DominantColors?: DominantColor[];
|
|
2753
|
+
}
|
|
2754
|
+
/**
|
|
2755
|
+
* <p>Information about the quality and dominant colors of an input image.
|
|
2756
|
+
* Quality and color information is returned for the entire image, foreground, and background.</p>
|
|
2757
|
+
*/
|
|
2758
|
+
export interface DetectLabelsImageProperties {
|
|
2759
|
+
/**
|
|
2760
|
+
* <p>Information about the quality of the image foreground as defined by brightness,
|
|
2761
|
+
* sharpness, and contrast. The higher the value the greater the brightness,
|
|
2762
|
+
* sharpness, and contrast respectively.</p>
|
|
2763
|
+
*/
|
|
2764
|
+
Quality?: DetectLabelsImageQuality;
|
|
2765
|
+
/**
|
|
2766
|
+
* <p>Information about the dominant colors found in an image, described with RGB values,
|
|
2767
|
+
* CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels
|
|
2768
|
+
* that have a particular color).</p>
|
|
2769
|
+
*/
|
|
2770
|
+
DominantColors?: DominantColor[];
|
|
2771
|
+
/**
|
|
2772
|
+
* <p>Information about the properties of an image’s foreground, including the
|
|
2773
|
+
* foreground’s quality and dominant colors, including the quality and dominant colors of the image.</p>
|
|
2774
|
+
*/
|
|
2775
|
+
Foreground?: DetectLabelsImageForeground;
|
|
2776
|
+
/**
|
|
2777
|
+
* <p>Information about the properties of an image’s background, including
|
|
2778
|
+
* the background’s quality and dominant colors, including the quality
|
|
2779
|
+
* and dominant colors of the image.</p>
|
|
2780
|
+
*/
|
|
2781
|
+
Background?: DetectLabelsImageBackground;
|
|
2782
|
+
}
|
|
2783
|
+
/**
|
|
2784
|
+
* <p>A potential alias of for a given label.</p>
|
|
2785
|
+
*/
|
|
2786
|
+
export interface LabelAlias {
|
|
2787
|
+
/**
|
|
2788
|
+
* <p>The name of an alias for a given label.</p>
|
|
2789
|
+
*/
|
|
2790
|
+
Name?: string;
|
|
2791
|
+
}
|
|
2792
|
+
/**
|
|
2793
|
+
* <p>The category that applies to a given label.</p>
|
|
2794
|
+
*/
|
|
2795
|
+
export interface LabelCategory {
|
|
2796
|
+
/**
|
|
2797
|
+
* <p>The name of a category that applies to a given label.</p>
|
|
2798
|
+
*/
|
|
2799
|
+
Name?: string;
|
|
2800
|
+
}
|
|
2801
|
+
/**
|
|
2802
|
+
* <p>An instance of a label returned by Amazon Rekognition Image (<a>DetectLabels</a>) or by
|
|
2803
|
+
* Amazon Rekognition Video (<a>GetLabelDetection</a>).</p>
|
|
2606
2804
|
*/
|
|
2607
2805
|
export interface Instance {
|
|
2608
2806
|
/**
|
|
@@ -2613,6 +2811,10 @@ export interface Instance {
|
|
|
2613
2811
|
* <p>The confidence that Amazon Rekognition has in the accuracy of the bounding box.</p>
|
|
2614
2812
|
*/
|
|
2615
2813
|
Confidence?: number;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>The dominant colors found in an individual instance of a label.</p>
|
|
2816
|
+
*/
|
|
2817
|
+
DominantColors?: DominantColor[];
|
|
2616
2818
|
}
|
|
2617
2819
|
/**
|
|
2618
2820
|
* <p>A parent label for a label. A label can have 0, 1, or more parents. </p>
|
|
@@ -2647,6 +2849,14 @@ export interface Label {
|
|
|
2647
2849
|
* <p>The parent labels for a label. The response includes all ancestor labels.</p>
|
|
2648
2850
|
*/
|
|
2649
2851
|
Parents?: Parent[];
|
|
2852
|
+
/**
|
|
2853
|
+
* <p>A list of potential aliases for a given label.</p>
|
|
2854
|
+
*/
|
|
2855
|
+
Aliases?: LabelAlias[];
|
|
2856
|
+
/**
|
|
2857
|
+
* <p>A list of the categories associated with a given label.</p>
|
|
2858
|
+
*/
|
|
2859
|
+
Categories?: LabelCategory[];
|
|
2650
2860
|
}
|
|
2651
2861
|
export interface DetectLabelsResponse {
|
|
2652
2862
|
/**
|
|
@@ -2655,21 +2865,24 @@ export interface DetectLabelsResponse {
|
|
|
2655
2865
|
Labels?: Label[];
|
|
2656
2866
|
/**
|
|
2657
2867
|
* <p>The value of <code>OrientationCorrection</code> is always null.</p>
|
|
2658
|
-
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
2659
|
-
* that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
2660
|
-
* image correction. The bounding box coordinates are translated to
|
|
2661
|
-
* after the orientation information in the Exif metadata is used to
|
|
2662
|
-
* Images in .png format don't contain Exif metadata.</p>
|
|
2663
|
-
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and
|
|
2664
|
-
*
|
|
2665
|
-
*
|
|
2666
|
-
* </p>
|
|
2868
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
2869
|
+
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
2870
|
+
* information to perform image correction. The bounding box coordinates are translated to
|
|
2871
|
+
* represent object locations after the orientation information in the Exif metadata is used to
|
|
2872
|
+
* correct the image orientation. Images in .png format don't contain Exif metadata.</p>
|
|
2873
|
+
* <p>Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images
|
|
2874
|
+
* without orientation information in the image Exif metadata. The bounding box coordinates
|
|
2875
|
+
* aren't translated and represent the object locations before the image is rotated. </p>
|
|
2667
2876
|
*/
|
|
2668
2877
|
OrientationCorrection?: OrientationCorrection | string;
|
|
2669
2878
|
/**
|
|
2670
2879
|
* <p>Version number of the label detection model that was used to detect labels.</p>
|
|
2671
2880
|
*/
|
|
2672
2881
|
LabelModelVersion?: string;
|
|
2882
|
+
/**
|
|
2883
|
+
* <p>Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.</p>
|
|
2884
|
+
*/
|
|
2885
|
+
ImageProperties?: DetectLabelsImageProperties;
|
|
2673
2886
|
}
|
|
2674
2887
|
/**
|
|
2675
2888
|
* <p>Allows you to set attributes of the image. Currently, you can declare an image as free of
|
|
@@ -2682,18 +2895,18 @@ export interface HumanLoopDataAttributes {
|
|
|
2682
2895
|
ContentClassifiers?: (ContentClassifier | string)[];
|
|
2683
2896
|
}
|
|
2684
2897
|
/**
|
|
2685
|
-
* <p>Sets up the flow definition the image will be sent to if one of the conditions is met.
|
|
2686
|
-
*
|
|
2898
|
+
* <p>Sets up the flow definition the image will be sent to if one of the conditions is met. You
|
|
2899
|
+
* can also set certain attributes of the image before review.</p>
|
|
2687
2900
|
*/
|
|
2688
2901
|
export interface HumanLoopConfig {
|
|
2689
2902
|
/**
|
|
2690
|
-
* <p>The name of the human review used for this image. This should be kept unique within a
|
|
2903
|
+
* <p>The name of the human review used for this image. This should be kept unique within a
|
|
2904
|
+
* region.</p>
|
|
2691
2905
|
*/
|
|
2692
2906
|
HumanLoopName: string | undefined;
|
|
2693
2907
|
/**
|
|
2694
|
-
* <p>The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by
|
|
2695
|
-
* <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html">CreateFlowDefinition</a>
|
|
2696
|
-
* Operation. </p>
|
|
2908
|
+
* <p>The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by
|
|
2909
|
+
* using the Amazon Sagemaker <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html">CreateFlowDefinition</a> Operation. </p>
|
|
2697
2910
|
*/
|
|
2698
2911
|
FlowDefinitionArn: string | undefined;
|
|
2699
2912
|
/**
|
|
@@ -2703,12 +2916,11 @@ export interface HumanLoopConfig {
|
|
|
2703
2916
|
}
|
|
2704
2917
|
export interface DetectModerationLabelsRequest {
|
|
2705
2918
|
/**
|
|
2706
|
-
* <p>The input image as base64-encoded bytes or an S3 object.
|
|
2707
|
-
*
|
|
2708
|
-
*
|
|
2709
|
-
*
|
|
2710
|
-
*
|
|
2711
|
-
* For more information, see Images in the Amazon Rekognition developer guide.</p>
|
|
2919
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
2920
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
2921
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2922
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
2923
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
2712
2924
|
*/
|
|
2713
2925
|
Image: Image | undefined;
|
|
2714
2926
|
/**
|
|
@@ -2719,14 +2931,14 @@ export interface DetectModerationLabelsRequest {
|
|
|
2719
2931
|
*/
|
|
2720
2932
|
MinConfidence?: number;
|
|
2721
2933
|
/**
|
|
2722
|
-
* <p>Sets up the configuration for human evaluation, including the FlowDefinition
|
|
2723
|
-
*
|
|
2934
|
+
* <p>Sets up the configuration for human evaluation, including the FlowDefinition the image
|
|
2935
|
+
* will be sent to.</p>
|
|
2724
2936
|
*/
|
|
2725
2937
|
HumanLoopConfig?: HumanLoopConfig;
|
|
2726
2938
|
}
|
|
2727
2939
|
/**
|
|
2728
|
-
* <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
|
|
2729
|
-
*
|
|
2940
|
+
* <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
|
|
2941
|
+
* input did not trigger human review.</p>
|
|
2730
2942
|
*/
|
|
2731
2943
|
export interface HumanLoopActivationOutput {
|
|
2732
2944
|
/**
|
|
@@ -2745,12 +2957,13 @@ export interface HumanLoopActivationOutput {
|
|
|
2745
2957
|
}
|
|
2746
2958
|
export interface DetectModerationLabelsResponse {
|
|
2747
2959
|
/**
|
|
2748
|
-
* <p>Array of detected Moderation labels and the time, in milliseconds from the
|
|
2749
|
-
*
|
|
2960
|
+
* <p>Array of detected Moderation labels and the time, in milliseconds from the start of the
|
|
2961
|
+
* video, they were detected.</p>
|
|
2750
2962
|
*/
|
|
2751
2963
|
ModerationLabels?: ModerationLabel[];
|
|
2752
2964
|
/**
|
|
2753
|
-
* <p>Version number of the moderation detection model that was used to detect unsafe
|
|
2965
|
+
* <p>Version number of the moderation detection model that was used to detect unsafe
|
|
2966
|
+
* content.</p>
|
|
2754
2967
|
*/
|
|
2755
2968
|
ModerationModelVersion?: string;
|
|
2756
2969
|
/**
|
|
@@ -2904,10 +3117,10 @@ export interface DetectProtectiveEquipmentResponse {
|
|
|
2904
3117
|
Summary?: ProtectiveEquipmentSummary;
|
|
2905
3118
|
}
|
|
2906
3119
|
/**
|
|
2907
|
-
* <p>A set of optional parameters that you can use to set the criteria that the text must meet
|
|
2908
|
-
* <code>WordFilter</code> looks at a word’s height, width, and
|
|
2909
|
-
* lets you set a specific region of the image
|
|
2910
|
-
* </p>
|
|
3120
|
+
* <p>A set of optional parameters that you can use to set the criteria that the text must meet
|
|
3121
|
+
* to be included in your response. <code>WordFilter</code> looks at a word’s height, width, and
|
|
3122
|
+
* minimum confidence. <code>RegionOfInterest</code> lets you set a specific region of the image
|
|
3123
|
+
* to look for text in. </p>
|
|
2911
3124
|
*/
|
|
2912
3125
|
export interface DetectTextFilters {
|
|
2913
3126
|
/**
|
|
@@ -2915,22 +3128,23 @@ export interface DetectTextFilters {
|
|
|
2915
3128
|
*/
|
|
2916
3129
|
WordFilter?: DetectionFilter;
|
|
2917
3130
|
/**
|
|
2918
|
-
* <p> A Filter focusing on a certain area of the image. Uses a <code>BoundingBox</code> object
|
|
2919
|
-
* of the image.</p>
|
|
3131
|
+
* <p> A Filter focusing on a certain area of the image. Uses a <code>BoundingBox</code> object
|
|
3132
|
+
* to set the region of the image.</p>
|
|
2920
3133
|
*/
|
|
2921
3134
|
RegionsOfInterest?: RegionOfInterest[];
|
|
2922
3135
|
}
|
|
2923
3136
|
export interface DetectTextRequest {
|
|
2924
3137
|
/**
|
|
2925
|
-
* <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS
|
|
2926
|
-
* to call Amazon Rekognition operations, you can't pass image bytes. </p>
|
|
2927
|
-
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
2928
|
-
* passed using the <code>Bytes</code> field.
|
|
2929
|
-
*
|
|
3138
|
+
* <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS
|
|
3139
|
+
* CLI to call Amazon Rekognition operations, you can't pass image bytes. </p>
|
|
3140
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
3141
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
3142
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
2930
3143
|
*/
|
|
2931
3144
|
Image: Image | undefined;
|
|
2932
3145
|
/**
|
|
2933
|
-
* <p>Optional parameters that let you set the criteria that the text must meet to be included
|
|
3146
|
+
* <p>Optional parameters that let you set the criteria that the text must meet to be included
|
|
3147
|
+
* in your response.</p>
|
|
2934
3148
|
*/
|
|
2935
3149
|
Filters?: DetectTextFilters;
|
|
2936
3150
|
}
|
|
@@ -2947,7 +3161,8 @@ export declare enum TextTypes {
|
|
|
2947
3161
|
* the word appears. The word <code>Id</code> is also an index for the word within a line of
|
|
2948
3162
|
* words. </p>
|
|
2949
3163
|
*
|
|
2950
|
-
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
3164
|
+
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
3165
|
+
* Guide.</p>
|
|
2951
3166
|
*/
|
|
2952
3167
|
export interface TextDetection {
|
|
2953
3168
|
/**
|
|
@@ -3041,9 +3256,8 @@ export interface Face {
|
|
|
3041
3256
|
*/
|
|
3042
3257
|
Confidence?: number;
|
|
3043
3258
|
/**
|
|
3044
|
-
* <p>
|
|
3045
|
-
*
|
|
3046
|
-
* </p>
|
|
3259
|
+
* <p> The version of the face detect and storage model that was used when indexing the face
|
|
3260
|
+
* vector. </p>
|
|
3047
3261
|
*/
|
|
3048
3262
|
IndexFacesModelVersion?: string;
|
|
3049
3263
|
}
|
|
@@ -3056,7 +3270,8 @@ export declare enum FaceAttributes {
|
|
|
3056
3270
|
*/
|
|
3057
3271
|
export interface FaceDetection {
|
|
3058
3272
|
/**
|
|
3059
|
-
* <p>Time, in milliseconds from the start of the video, that the face was detected
|
|
3273
|
+
* <p>Time, in milliseconds from the start of the video, that the face was detected.
|
|
3274
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the face first appears.</p>
|
|
3060
3275
|
*/
|
|
3061
3276
|
Timestamp?: number;
|
|
3062
3277
|
/**
|
|
@@ -3100,8 +3315,8 @@ export declare enum FaceSearchSortBy {
|
|
|
3100
3315
|
}
|
|
3101
3316
|
export interface GetCelebrityInfoRequest {
|
|
3102
3317
|
/**
|
|
3103
|
-
* <p>The ID for the celebrity. You get the celebrity ID from a call to the <a>RecognizeCelebrities</a> operation,
|
|
3104
|
-
*
|
|
3318
|
+
* <p>The ID for the celebrity. You get the celebrity ID from a call to the <a>RecognizeCelebrities</a> operation, which recognizes celebrities in an image.
|
|
3319
|
+
* </p>
|
|
3105
3320
|
*/
|
|
3106
3321
|
Id: string | undefined;
|
|
3107
3322
|
}
|
|
@@ -3348,13 +3563,14 @@ export interface PersonDetail {
|
|
|
3348
3563
|
}
|
|
3349
3564
|
/**
|
|
3350
3565
|
* <p>Information about a person whose face matches a face(s) in an Amazon Rekognition collection.
|
|
3351
|
-
* Includes information about the faces in the Amazon Rekognition collection (<a>FaceMatch</a>), information about the person (<a>PersonDetail</a>),
|
|
3352
|
-
*
|
|
3353
|
-
*
|
|
3566
|
+
* Includes information about the faces in the Amazon Rekognition collection (<a>FaceMatch</a>), information about the person (<a>PersonDetail</a>), and the time stamp for
|
|
3567
|
+
* when the person was detected in a video. An array of <code>PersonMatch</code> objects is
|
|
3568
|
+
* returned by <a>GetFaceSearch</a>. </p>
|
|
3354
3569
|
*/
|
|
3355
3570
|
export interface PersonMatch {
|
|
3356
3571
|
/**
|
|
3357
|
-
* <p>The time, in milliseconds from the beginning of the video, that the person was matched in
|
|
3572
|
+
* <p>The time, in milliseconds from the beginning of the video, that the person was matched in
|
|
3573
|
+
* the video.</p>
|
|
3358
3574
|
*/
|
|
3359
3575
|
Timestamp?: number;
|
|
3360
3576
|
/**
|
|
@@ -3362,7 +3578,8 @@ export interface PersonMatch {
|
|
|
3362
3578
|
*/
|
|
3363
3579
|
Person?: PersonDetail;
|
|
3364
3580
|
/**
|
|
3365
|
-
* <p>Information about the faces in the input collection that match the face of a person in the
|
|
3581
|
+
* <p>Information about the faces in the input collection that match the face of a person in the
|
|
3582
|
+
* video.</p>
|
|
3366
3583
|
*/
|
|
3367
3584
|
FaceMatches?: FaceMatch[];
|
|
3368
3585
|
}
|
|
@@ -3430,7 +3647,8 @@ export interface GetLabelDetectionRequest {
|
|
|
3430
3647
|
*/
|
|
3431
3648
|
export interface LabelDetection {
|
|
3432
3649
|
/**
|
|
3433
|
-
* <p>Time, in milliseconds from the start of the video, that the label was detected
|
|
3650
|
+
* <p>Time, in milliseconds from the start of the video, that the label was detected.
|
|
3651
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the label first appears.</p>
|
|
3434
3652
|
*/
|
|
3435
3653
|
Timestamp?: number;
|
|
3436
3654
|
/**
|
|
@@ -3505,7 +3723,8 @@ export interface GetPersonTrackingRequest {
|
|
|
3505
3723
|
*/
|
|
3506
3724
|
export interface PersonDetection {
|
|
3507
3725
|
/**
|
|
3508
|
-
* <p>The time, in milliseconds from the start of the video, that the person's path was tracked
|
|
3726
|
+
* <p>The time, in milliseconds from the start of the video, that the person's path was tracked.
|
|
3727
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the person's path first appears.</p>
|
|
3509
3728
|
*/
|
|
3510
3729
|
Timestamp?: number;
|
|
3511
3730
|
/**
|
|
@@ -3742,7 +3961,8 @@ export interface GetTextDetectionRequest {
|
|
|
3742
3961
|
*/
|
|
3743
3962
|
export interface TextDetectionResult {
|
|
3744
3963
|
/**
|
|
3745
|
-
* <p>The time, in milliseconds from the start of the video, that the text was detected
|
|
3964
|
+
* <p>The time, in milliseconds from the start of the video, that the text was detected.
|
|
3965
|
+
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the text first appears.</p>
|
|
3746
3966
|
*/
|
|
3747
3967
|
Timestamp?: number;
|
|
3748
3968
|
/**
|
|
@@ -3804,11 +4024,11 @@ export interface IndexFacesRequest {
|
|
|
3804
4024
|
*/
|
|
3805
4025
|
CollectionId: string | undefined;
|
|
3806
4026
|
/**
|
|
3807
|
-
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
3808
|
-
* Amazon Rekognition operations, passing base64-encoded image bytes isn't supported. </p>
|
|
3809
|
-
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
3810
|
-
* passed using the <code>Bytes</code> field.
|
|
3811
|
-
*
|
|
4027
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
4028
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported. </p>
|
|
4029
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
4030
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
4031
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
3812
4032
|
*/
|
|
3813
4033
|
Image: Image | undefined;
|
|
3814
4034
|
/**
|
|
@@ -3838,24 +4058,22 @@ export interface IndexFacesRequest {
|
|
|
3838
4058
|
* <p>The faces that are returned by <code>IndexFaces</code> are sorted by the largest face
|
|
3839
4059
|
* bounding box size to the smallest size, in descending order.</p>
|
|
3840
4060
|
* <p>
|
|
3841
|
-
* <code>MaxFaces</code> can be used with a collection associated with any version of
|
|
3842
|
-
*
|
|
4061
|
+
* <code>MaxFaces</code> can be used with a collection associated with any version of the
|
|
4062
|
+
* face model.</p>
|
|
3843
4063
|
*/
|
|
3844
4064
|
MaxFaces?: number;
|
|
3845
4065
|
/**
|
|
3846
4066
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
3847
|
-
*
|
|
3848
|
-
* If you specify <code>LOW</code>,
|
|
3849
|
-
*
|
|
3850
|
-
*
|
|
3851
|
-
*
|
|
3852
|
-
*
|
|
3853
|
-
*
|
|
3854
|
-
*
|
|
3855
|
-
*
|
|
3856
|
-
*
|
|
3857
|
-
* </p>
|
|
3858
|
-
* <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>
|
|
4067
|
+
* Filtered faces aren't indexed. If you specify <code>AUTO</code>, Amazon Rekognition chooses the quality
|
|
4068
|
+
* bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>, filtering
|
|
4069
|
+
* removes all faces that don’t meet the chosen quality bar. The default value is
|
|
4070
|
+
* <code>AUTO</code>.
|
|
4071
|
+
* The quality bar is based on a variety of common use cases. Low-quality detections can occur
|
|
4072
|
+
* for a number of reasons. Some examples are an object that's misidentified as a face, a face
|
|
4073
|
+
* that's too blurry, or a face with a pose that's too extreme to use. If you specify
|
|
4074
|
+
* <code>NONE</code>, no filtering is performed. </p>
|
|
4075
|
+
* <p>To use quality filtering, the collection you are using must be associated with version 3
|
|
4076
|
+
* of the face model or higher.</p>
|
|
3859
4077
|
*/
|
|
3860
4078
|
QualityFilter?: QualityFilter | string;
|
|
3861
4079
|
}
|
|
@@ -3877,12 +4095,12 @@ export interface UnindexedFace {
|
|
|
3877
4095
|
* <p>An array of reasons that specify why a face wasn't indexed. </p>
|
|
3878
4096
|
* <ul>
|
|
3879
4097
|
* <li>
|
|
3880
|
-
* <p>EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is
|
|
3881
|
-
* too far away from the camera.</p>
|
|
4098
|
+
* <p>EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is
|
|
4099
|
+
* turned too far away from the camera.</p>
|
|
3882
4100
|
* </li>
|
|
3883
4101
|
* <li>
|
|
3884
|
-
* <p>EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified
|
|
3885
|
-
*
|
|
4102
|
+
* <p>EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified
|
|
4103
|
+
* by the <code>MaxFaces</code> input parameter for <code>IndexFaces</code>.</p>
|
|
3886
4104
|
* </li>
|
|
3887
4105
|
* <li>
|
|
3888
4106
|
* <p>LOW_BRIGHTNESS - The image is too dark.</p>
|
|
@@ -3908,39 +4126,34 @@ export interface UnindexedFace {
|
|
|
3908
4126
|
}
|
|
3909
4127
|
export interface IndexFacesResponse {
|
|
3910
4128
|
/**
|
|
3911
|
-
* <p>An array of faces detected and added to the collection.
|
|
3912
|
-
*
|
|
3913
|
-
* </p>
|
|
4129
|
+
* <p>An array of faces detected and added to the collection. For more information,
|
|
4130
|
+
* see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. </p>
|
|
3914
4131
|
*/
|
|
3915
4132
|
FaceRecords?: FaceRecord[];
|
|
3916
4133
|
/**
|
|
3917
|
-
* <p>If your collection is associated with a face detection model that's later
|
|
3918
|
-
*
|
|
3919
|
-
*
|
|
3920
|
-
*
|
|
3921
|
-
*
|
|
3922
|
-
* version 3.0 or earlier, the following applies:</p>
|
|
4134
|
+
* <p>If your collection is associated with a face detection model that's later than version
|
|
4135
|
+
* 3.0, the value of <code>OrientationCorrection</code> is always null and no orientation
|
|
4136
|
+
* information is returned.</p>
|
|
4137
|
+
* <p>If your collection is associated with a face detection model that's version 3.0 or
|
|
4138
|
+
* earlier, the following applies:</p>
|
|
3923
4139
|
* <ul>
|
|
3924
4140
|
* <li>
|
|
3925
|
-
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
3926
|
-
*
|
|
3927
|
-
*
|
|
3928
|
-
*
|
|
3929
|
-
*
|
|
3930
|
-
*
|
|
4141
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
4142
|
+
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
4143
|
+
* information to perform image correction - the bounding box coordinates are translated to
|
|
4144
|
+
* represent object locations after the orientation information in the Exif metadata is used
|
|
4145
|
+
* to correct the image orientation. Images in .png format don't contain Exif metadata. The
|
|
4146
|
+
* value of <code>OrientationCorrection</code> is null.</p>
|
|
3931
4147
|
* </li>
|
|
3932
4148
|
* <li>
|
|
3933
|
-
* <p>If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition
|
|
3934
|
-
*
|
|
3935
|
-
*
|
|
3936
|
-
*
|
|
4149
|
+
* <p>If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition
|
|
4150
|
+
* returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition
|
|
4151
|
+
* doesn’t perform image correction for images. The bounding box coordinates aren't
|
|
4152
|
+
* translated and represent the object locations before the image is rotated.</p>
|
|
3937
4153
|
* </li>
|
|
3938
4154
|
* </ul>
|
|
3939
|
-
*
|
|
3940
|
-
*
|
|
3941
|
-
*
|
|
3942
|
-
* <p>Bounding box information is returned in the <code>FaceRecords</code> array. You can get the
|
|
3943
|
-
* version of the face detection model by calling <a>DescribeCollection</a>. </p>
|
|
4155
|
+
* <p>Bounding box information is returned in the <code>FaceRecords</code> array. You can get
|
|
4156
|
+
* the version of the face detection model by calling <a>DescribeCollection</a>. </p>
|
|
3944
4157
|
*/
|
|
3945
4158
|
OrientationCorrection?: OrientationCorrection | string;
|
|
3946
4159
|
/**
|
|
@@ -3957,17 +4170,15 @@ export interface IndexFacesResponse {
|
|
|
3957
4170
|
UnindexedFaces?: UnindexedFace[];
|
|
3958
4171
|
}
|
|
3959
4172
|
/**
|
|
3960
|
-
* <p>
|
|
3961
|
-
*
|
|
3962
|
-
*
|
|
3963
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
|
|
3964
|
-
* </p>
|
|
4173
|
+
* <p>Specifies the starting point in a Kinesis stream to start processing. You can use the
|
|
4174
|
+
* producer timestamp or the fragment number. One of either producer timestamp or fragment
|
|
4175
|
+
* number is required. If you use the producer timestamp, you must put the time in
|
|
4176
|
+
* milliseconds. For more information about fragment numbers, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>. </p>
|
|
3965
4177
|
*/
|
|
3966
4178
|
export interface KinesisVideoStreamStartSelector {
|
|
3967
4179
|
/**
|
|
3968
|
-
* <p>
|
|
3969
|
-
*
|
|
3970
|
-
* </p>
|
|
4180
|
+
* <p> The timestamp from the producer corresponding to the fragment, in milliseconds,
|
|
4181
|
+
* expressed in unix time format. </p>
|
|
3971
4182
|
*/
|
|
3972
4183
|
ProducerTimestamp?: number;
|
|
3973
4184
|
/**
|
|
@@ -3998,9 +4209,10 @@ export interface ListCollectionsResponse {
|
|
|
3998
4209
|
*/
|
|
3999
4210
|
NextToken?: string;
|
|
4000
4211
|
/**
|
|
4001
|
-
* <p>Version numbers of the face detection models associated with the collections in the
|
|
4002
|
-
*
|
|
4003
|
-
* by the collection in
|
|
4212
|
+
* <p>Version numbers of the face detection models associated with the collections in the
|
|
4213
|
+
* array <code>CollectionIds</code>. For example, the value of <code>FaceModelVersions[2]</code>
|
|
4214
|
+
* is the version number for the face detection model used by the collection in
|
|
4215
|
+
* <code>CollectionId[2]</code>.</p>
|
|
4004
4216
|
*/
|
|
4005
4217
|
FaceModelVersions?: string[];
|
|
4006
4218
|
}
|
|
@@ -4124,7 +4336,8 @@ export interface ListFacesResponse {
|
|
|
4124
4336
|
*/
|
|
4125
4337
|
NextToken?: string;
|
|
4126
4338
|
/**
|
|
4127
|
-
* <p>Version number of the face detection model associated with the input collection
|
|
4339
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
4340
|
+
* (<code>CollectionId</code>).</p>
|
|
4128
4341
|
*/
|
|
4129
4342
|
FaceModelVersion?: string;
|
|
4130
4343
|
}
|
|
@@ -4228,17 +4441,14 @@ export interface ListStreamProcessorsResponse {
|
|
|
4228
4441
|
}
|
|
4229
4442
|
export interface ListTagsForResourceRequest {
|
|
4230
4443
|
/**
|
|
4231
|
-
* <p>
|
|
4232
|
-
*
|
|
4233
|
-
* </p>
|
|
4444
|
+
* <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that contains
|
|
4445
|
+
* the tags that you want a list of. </p>
|
|
4234
4446
|
*/
|
|
4235
4447
|
ResourceArn: string | undefined;
|
|
4236
4448
|
}
|
|
4237
4449
|
export interface ListTagsForResourceResponse {
|
|
4238
4450
|
/**
|
|
4239
|
-
* <p>
|
|
4240
|
-
* A list of key-value tags assigned to the resource.
|
|
4241
|
-
* </p>
|
|
4451
|
+
* <p> A list of key-value tags assigned to the resource. </p>
|
|
4242
4452
|
*/
|
|
4243
4453
|
Tags?: Record<string, string>;
|
|
4244
4454
|
}
|
|
@@ -4307,8 +4517,8 @@ export interface PutProjectPolicyResponse {
|
|
|
4307
4517
|
}
|
|
4308
4518
|
export interface RecognizeCelebritiesRequest {
|
|
4309
4519
|
/**
|
|
4310
|
-
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
4311
|
-
* Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
4520
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
4521
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
4312
4522
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
4313
4523
|
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
4314
4524
|
* Images in the Amazon Rekognition developer guide.</p>
|
|
@@ -4319,9 +4529,9 @@ export interface RecognizeCelebritiesResponse {
|
|
|
4319
4529
|
/**
|
|
4320
4530
|
* <p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
|
|
4321
4531
|
* celebrities in an image. Each celebrity object includes the following attributes:
|
|
4322
|
-
*
|
|
4323
|
-
*
|
|
4324
|
-
*
|
|
4532
|
+
* <code>Face</code>, <code>Confidence</code>, <code>Emotions</code>, <code>Landmarks</code>,
|
|
4533
|
+
* <code>Pose</code>, <code>Quality</code>, <code>Smile</code>, <code>Id</code>,
|
|
4534
|
+
* <code>KnownGender</code>, <code>MatchConfidence</code>, <code>Name</code>,
|
|
4325
4535
|
* <code>Urls</code>.</p>
|
|
4326
4536
|
*/
|
|
4327
4537
|
CelebrityFaces?: Celebrity[];
|
|
@@ -4331,8 +4541,9 @@ export interface RecognizeCelebritiesResponse {
|
|
|
4331
4541
|
UnrecognizedFaces?: ComparedFace[];
|
|
4332
4542
|
/**
|
|
4333
4543
|
* <note>
|
|
4334
|
-
* <p>Support for estimating image orientation using the the OrientationCorrection field
|
|
4335
|
-
* Any returned values for this field included in an API response
|
|
4544
|
+
* <p>Support for estimating image orientation using the the OrientationCorrection field
|
|
4545
|
+
* has ceased as of August 2021. Any returned values for this field included in an API response
|
|
4546
|
+
* will always be NULL.</p>
|
|
4336
4547
|
* </note>
|
|
4337
4548
|
* <p>The orientation of the input image (counterclockwise direction). If your application
|
|
4338
4549
|
* displays the image, you can use this value to correct the orientation. The bounding box
|
|
@@ -4365,9 +4576,8 @@ export interface SearchFacesRequest {
|
|
|
4365
4576
|
MaxFaces?: number;
|
|
4366
4577
|
/**
|
|
4367
4578
|
* <p>Optional value specifying the minimum confidence in the face match to return. For
|
|
4368
|
-
* example, don't return any matches where confidence in matches is less than 70%.
|
|
4369
|
-
*
|
|
4370
|
-
* </p>
|
|
4579
|
+
* example, don't return any matches where confidence in matches is less than 70%. The default
|
|
4580
|
+
* value is 80%. </p>
|
|
4371
4581
|
*/
|
|
4372
4582
|
FaceMatchThreshold?: number;
|
|
4373
4583
|
}
|
|
@@ -4382,7 +4592,8 @@ export interface SearchFacesResponse {
|
|
|
4382
4592
|
*/
|
|
4383
4593
|
FaceMatches?: FaceMatch[];
|
|
4384
4594
|
/**
|
|
4385
|
-
* <p>Version number of the face detection model associated with the input collection
|
|
4595
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
4596
|
+
* (<code>CollectionId</code>).</p>
|
|
4386
4597
|
*/
|
|
4387
4598
|
FaceModelVersion?: string;
|
|
4388
4599
|
}
|
|
@@ -4392,12 +4603,11 @@ export interface SearchFacesByImageRequest {
|
|
|
4392
4603
|
*/
|
|
4393
4604
|
CollectionId: string | undefined;
|
|
4394
4605
|
/**
|
|
4395
|
-
* <p>The input image as base64-encoded bytes or an S3 object.
|
|
4396
|
-
*
|
|
4397
|
-
*
|
|
4398
|
-
*
|
|
4399
|
-
*
|
|
4400
|
-
* For more information, see Images in the Amazon Rekognition developer guide.</p>
|
|
4606
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
4607
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
4608
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
4609
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
4610
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
4401
4611
|
*/
|
|
4402
4612
|
Image: Image | undefined;
|
|
4403
4613
|
/**
|
|
@@ -4407,24 +4617,22 @@ export interface SearchFacesByImageRequest {
|
|
|
4407
4617
|
MaxFaces?: number;
|
|
4408
4618
|
/**
|
|
4409
4619
|
* <p>(Optional) Specifies the minimum confidence in the face match to return. For example,
|
|
4410
|
-
* don't return any matches where confidence in matches is less than 70%.
|
|
4411
|
-
*
|
|
4620
|
+
* don't return any matches where confidence in matches is less than 70%. The default value is
|
|
4621
|
+
* 80%.</p>
|
|
4412
4622
|
*/
|
|
4413
4623
|
FaceMatchThreshold?: number;
|
|
4414
4624
|
/**
|
|
4415
4625
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
4416
|
-
* Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>,
|
|
4417
|
-
* chooses the quality bar.
|
|
4418
|
-
*
|
|
4419
|
-
*
|
|
4420
|
-
*
|
|
4421
|
-
*
|
|
4422
|
-
*
|
|
4423
|
-
*
|
|
4424
|
-
*
|
|
4425
|
-
*
|
|
4426
|
-
* </p>
|
|
4427
|
-
* <p>To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.</p>
|
|
4626
|
+
* Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>,
|
|
4627
|
+
* Amazon Rekognition chooses the quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or
|
|
4628
|
+
* <code>HIGH</code>, filtering removes all faces that don’t meet the chosen quality bar.
|
|
4629
|
+
* The quality bar is
|
|
4630
|
+
* based on a variety of common use cases. Low-quality detections can occur for a number of
|
|
4631
|
+
* reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,
|
|
4632
|
+
* or a face with a pose that's too extreme to use. If you specify <code>NONE</code>, no
|
|
4633
|
+
* filtering is performed. The default value is <code>NONE</code>. </p>
|
|
4634
|
+
* <p>To use quality filtering, the collection you are using must be associated with version 3
|
|
4635
|
+
* of the face model or higher.</p>
|
|
4428
4636
|
*/
|
|
4429
4637
|
QualityFilter?: QualityFilter | string;
|
|
4430
4638
|
}
|
|
@@ -4445,7 +4653,8 @@ export interface SearchFacesByImageResponse {
|
|
|
4445
4653
|
*/
|
|
4446
4654
|
FaceMatches?: FaceMatch[];
|
|
4447
4655
|
/**
|
|
4448
|
-
* <p>Version number of the face detection model associated with the input collection
|
|
4656
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
4657
|
+
* (<code>CollectionId</code>).</p>
|
|
4449
4658
|
*/
|
|
4450
4659
|
FaceModelVersion?: string;
|
|
4451
4660
|
}
|
|
@@ -4810,12 +5019,13 @@ export interface StartSegmentDetectionResponse {
|
|
|
4810
5019
|
JobId?: string;
|
|
4811
5020
|
}
|
|
4812
5021
|
/**
|
|
4813
|
-
* <p
|
|
5022
|
+
* <p>This is a required parameter for label detection stream processors and should not be used
|
|
5023
|
+
* to start a face search stream processor.</p>
|
|
4814
5024
|
*/
|
|
4815
5025
|
export interface StreamProcessingStartSelector {
|
|
4816
5026
|
/**
|
|
4817
5027
|
* <p>
|
|
4818
|
-
* Specifies the starting point in the stream to start processing. This can be done with a timestamp or a fragment number in a Kinesis stream.
|
|
5028
|
+
* Specifies the starting point in the stream to start processing. This can be done with a producer timestamp or a fragment number in a Kinesis stream.
|
|
4819
5029
|
* </p>
|
|
4820
5030
|
*/
|
|
4821
5031
|
KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
|
|
@@ -4842,8 +5052,8 @@ export interface StartStreamProcessorRequest {
|
|
|
4842
5052
|
/**
|
|
4843
5053
|
* <p>
|
|
4844
5054
|
* Specifies the starting point in the Kinesis stream to start processing.
|
|
4845
|
-
* You can use the producer timestamp or the fragment number.
|
|
4846
|
-
* For more information, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
|
|
5055
|
+
* You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.
|
|
5056
|
+
* For more information about fragment numbers, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
|
|
4847
5057
|
* </p>
|
|
4848
5058
|
* <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
|
|
4849
5059
|
*/
|
|
@@ -4938,15 +5148,12 @@ export interface StopStreamProcessorResponse {
|
|
|
4938
5148
|
}
|
|
4939
5149
|
export interface TagResourceRequest {
|
|
4940
5150
|
/**
|
|
4941
|
-
* <p>
|
|
4942
|
-
*
|
|
4943
|
-
* </p>
|
|
5151
|
+
* <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
|
|
5152
|
+
* assign the tags to. </p>
|
|
4944
5153
|
*/
|
|
4945
5154
|
ResourceArn: string | undefined;
|
|
4946
5155
|
/**
|
|
4947
|
-
* <p>
|
|
4948
|
-
* The key-value tags to assign to the resource.
|
|
4949
|
-
* </p>
|
|
5156
|
+
* <p> The key-value tags to assign to the resource. </p>
|
|
4950
5157
|
*/
|
|
4951
5158
|
Tags: Record<string, string> | undefined;
|
|
4952
5159
|
}
|
|
@@ -4954,15 +5161,12 @@ export interface TagResourceResponse {
|
|
|
4954
5161
|
}
|
|
4955
5162
|
export interface UntagResourceRequest {
|
|
4956
5163
|
/**
|
|
4957
|
-
* <p>
|
|
4958
|
-
*
|
|
4959
|
-
* </p>
|
|
5164
|
+
* <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
|
|
5165
|
+
* remove the tags from. </p>
|
|
4960
5166
|
*/
|
|
4961
5167
|
ResourceArn: string | undefined;
|
|
4962
5168
|
/**
|
|
4963
|
-
* <p>
|
|
4964
|
-
* A list of the tags that you want to remove.
|
|
4965
|
-
* </p>
|
|
5169
|
+
* <p> A list of the tags that you want to remove. </p>
|
|
4966
5170
|
*/
|
|
4967
5171
|
TagKeys: string[] | undefined;
|
|
4968
5172
|
}
|
|
@@ -5468,10 +5672,50 @@ export declare const DetectFacesResponseFilterSensitiveLog: (obj: DetectFacesRes
|
|
|
5468
5672
|
* @internal
|
|
5469
5673
|
*/
|
|
5470
5674
|
export declare const DetectionFilterFilterSensitiveLog: (obj: DetectionFilter) => any;
|
|
5675
|
+
/**
|
|
5676
|
+
* @internal
|
|
5677
|
+
*/
|
|
5678
|
+
export declare const GeneralLabelsSettingsFilterSensitiveLog: (obj: GeneralLabelsSettings) => any;
|
|
5679
|
+
/**
|
|
5680
|
+
* @internal
|
|
5681
|
+
*/
|
|
5682
|
+
export declare const DetectLabelsImagePropertiesSettingsFilterSensitiveLog: (obj: DetectLabelsImagePropertiesSettings) => any;
|
|
5683
|
+
/**
|
|
5684
|
+
* @internal
|
|
5685
|
+
*/
|
|
5686
|
+
export declare const DetectLabelsSettingsFilterSensitiveLog: (obj: DetectLabelsSettings) => any;
|
|
5471
5687
|
/**
|
|
5472
5688
|
* @internal
|
|
5473
5689
|
*/
|
|
5474
5690
|
export declare const DetectLabelsRequestFilterSensitiveLog: (obj: DetectLabelsRequest) => any;
|
|
5691
|
+
/**
|
|
5692
|
+
* @internal
|
|
5693
|
+
*/
|
|
5694
|
+
export declare const DominantColorFilterSensitiveLog: (obj: DominantColor) => any;
|
|
5695
|
+
/**
|
|
5696
|
+
* @internal
|
|
5697
|
+
*/
|
|
5698
|
+
export declare const DetectLabelsImageQualityFilterSensitiveLog: (obj: DetectLabelsImageQuality) => any;
|
|
5699
|
+
/**
|
|
5700
|
+
* @internal
|
|
5701
|
+
*/
|
|
5702
|
+
export declare const DetectLabelsImageBackgroundFilterSensitiveLog: (obj: DetectLabelsImageBackground) => any;
|
|
5703
|
+
/**
|
|
5704
|
+
* @internal
|
|
5705
|
+
*/
|
|
5706
|
+
export declare const DetectLabelsImageForegroundFilterSensitiveLog: (obj: DetectLabelsImageForeground) => any;
|
|
5707
|
+
/**
|
|
5708
|
+
* @internal
|
|
5709
|
+
*/
|
|
5710
|
+
export declare const DetectLabelsImagePropertiesFilterSensitiveLog: (obj: DetectLabelsImageProperties) => any;
|
|
5711
|
+
/**
|
|
5712
|
+
* @internal
|
|
5713
|
+
*/
|
|
5714
|
+
export declare const LabelAliasFilterSensitiveLog: (obj: LabelAlias) => any;
|
|
5715
|
+
/**
|
|
5716
|
+
* @internal
|
|
5717
|
+
*/
|
|
5718
|
+
export declare const LabelCategoryFilterSensitiveLog: (obj: LabelCategory) => any;
|
|
5475
5719
|
/**
|
|
5476
5720
|
* @internal
|
|
5477
5721
|
*/
|