@aws-sdk/client-rekognition 3.378.0 → 3.382.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/endpoint/EndpointParameters.d.ts +3 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +753 -0
- package/dist-types/models/models_1.d.ts +79 -0
- package/dist-types/runtimeConfig.browser.d.ts +3 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/package.json +7 -7
|
@@ -10,6 +10,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
10
10
|
Message?: string;
|
|
11
11
|
Code?: string;
|
|
12
12
|
/**
|
|
13
|
+
* @public
|
|
13
14
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
14
15
|
*/
|
|
15
16
|
Logref?: string;
|
|
@@ -27,10 +28,12 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
27
28
|
*/
|
|
28
29
|
export interface AgeRange {
|
|
29
30
|
/**
|
|
31
|
+
* @public
|
|
30
32
|
* <p>The lowest estimated age.</p>
|
|
31
33
|
*/
|
|
32
34
|
Low?: number;
|
|
33
35
|
/**
|
|
36
|
+
* @public
|
|
34
37
|
* <p>The highest estimated age.</p>
|
|
35
38
|
*/
|
|
36
39
|
High?: number;
|
|
@@ -46,14 +49,17 @@ export interface AgeRange {
|
|
|
46
49
|
*/
|
|
47
50
|
export interface S3Object {
|
|
48
51
|
/**
|
|
52
|
+
* @public
|
|
49
53
|
* <p>Name of the S3 bucket.</p>
|
|
50
54
|
*/
|
|
51
55
|
Bucket?: string;
|
|
52
56
|
/**
|
|
57
|
+
* @public
|
|
53
58
|
* <p>S3 object key name.</p>
|
|
54
59
|
*/
|
|
55
60
|
Name?: string;
|
|
56
61
|
/**
|
|
62
|
+
* @public
|
|
57
63
|
* <p>If the bucket is versioning enabled, you can specify the object version. </p>
|
|
58
64
|
*/
|
|
59
65
|
Version?: string;
|
|
@@ -65,6 +71,7 @@ export interface S3Object {
|
|
|
65
71
|
*/
|
|
66
72
|
export interface GroundTruthManifest {
|
|
67
73
|
/**
|
|
74
|
+
* @public
|
|
68
75
|
* <p>Provides the S3 bucket name and object name.</p>
|
|
69
76
|
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
70
77
|
* Amazon Rekognition operations.</p>
|
|
@@ -82,6 +89,7 @@ export interface GroundTruthManifest {
|
|
|
82
89
|
*/
|
|
83
90
|
export interface Asset {
|
|
84
91
|
/**
|
|
92
|
+
* @public
|
|
85
93
|
* <p>The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
|
|
86
94
|
* </p>
|
|
87
95
|
*/
|
|
@@ -93,6 +101,7 @@ export interface Asset {
|
|
|
93
101
|
*/
|
|
94
102
|
export interface AssociatedFace {
|
|
95
103
|
/**
|
|
104
|
+
* @public
|
|
96
105
|
* <p>Unique identifier assigned to the face.</p>
|
|
97
106
|
*/
|
|
98
107
|
FaceId?: string;
|
|
@@ -102,23 +111,28 @@ export interface AssociatedFace {
|
|
|
102
111
|
*/
|
|
103
112
|
export interface AssociateFacesRequest {
|
|
104
113
|
/**
|
|
114
|
+
* @public
|
|
105
115
|
* <p>The ID of an existing collection containing the UserID.</p>
|
|
106
116
|
*/
|
|
107
117
|
CollectionId: string | undefined;
|
|
108
118
|
/**
|
|
119
|
+
* @public
|
|
109
120
|
* <p>The ID for the existing UserID.</p>
|
|
110
121
|
*/
|
|
111
122
|
UserId: string | undefined;
|
|
112
123
|
/**
|
|
124
|
+
* @public
|
|
113
125
|
* <p>An array of FaceIDs to associate with the UserID.</p>
|
|
114
126
|
*/
|
|
115
127
|
FaceIds: string[] | undefined;
|
|
116
128
|
/**
|
|
129
|
+
* @public
|
|
117
130
|
* <p>An optional value specifying the minimum confidence in the UserID match to return. The
|
|
118
131
|
* default value is 75.</p>
|
|
119
132
|
*/
|
|
120
133
|
UserMatchThreshold?: number;
|
|
121
134
|
/**
|
|
135
|
+
* @public
|
|
122
136
|
* <p>Idempotent token used to identify the request to <code>AssociateFaces</code>. If you use
|
|
123
137
|
* the same token with multiple <code>AssociateFaces</code> requests, the same response is returned.
|
|
124
138
|
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
@@ -145,19 +159,23 @@ export type UnsuccessfulFaceAssociationReason = (typeof UnsuccessfulFaceAssociat
|
|
|
145
159
|
*/
|
|
146
160
|
export interface UnsuccessfulFaceAssociation {
|
|
147
161
|
/**
|
|
162
|
+
* @public
|
|
148
163
|
* <p>A unique identifier assigned to the face. </p>
|
|
149
164
|
*/
|
|
150
165
|
FaceId?: string;
|
|
151
166
|
/**
|
|
167
|
+
* @public
|
|
152
168
|
* <p>A provided ID for the UserID. Unique within the collection. </p>
|
|
153
169
|
*/
|
|
154
170
|
UserId?: string;
|
|
155
171
|
/**
|
|
172
|
+
* @public
|
|
156
173
|
* <p>Match confidence with the UserID, provides information regarding if a face association was
|
|
157
174
|
* unsuccessful because it didn't meet UserMatchThreshold.</p>
|
|
158
175
|
*/
|
|
159
176
|
Confidence?: number;
|
|
160
177
|
/**
|
|
178
|
+
* @public
|
|
161
179
|
* <p> The reason why the association was unsuccessful. </p>
|
|
162
180
|
*/
|
|
163
181
|
Reasons?: (UnsuccessfulFaceAssociationReason | string)[];
|
|
@@ -181,16 +199,19 @@ export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
|
|
|
181
199
|
*/
|
|
182
200
|
export interface AssociateFacesResponse {
|
|
183
201
|
/**
|
|
202
|
+
* @public
|
|
184
203
|
* <p>An array of AssociatedFace objects containing FaceIDs that are successfully associated
|
|
185
204
|
* with the UserID is returned. Returned if the AssociateFaces action is successful.</p>
|
|
186
205
|
*/
|
|
187
206
|
AssociatedFaces?: AssociatedFace[];
|
|
188
207
|
/**
|
|
208
|
+
* @public
|
|
189
209
|
* <p>An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully
|
|
190
210
|
* associated along with the reasons. Returned if the AssociateFaces action is successful.</p>
|
|
191
211
|
*/
|
|
192
212
|
UnsuccessfulFaceAssociations?: UnsuccessfulFaceAssociation[];
|
|
193
213
|
/**
|
|
214
|
+
* @public
|
|
194
215
|
* <p>The status of an update made to a UserID. Reflects if the UserID has been updated for
|
|
195
216
|
* every requested change.</p>
|
|
196
217
|
*/
|
|
@@ -208,6 +229,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
208
229
|
Message?: string;
|
|
209
230
|
Code?: string;
|
|
210
231
|
/**
|
|
232
|
+
* @public
|
|
211
233
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
212
234
|
*/
|
|
213
235
|
Logref?: string;
|
|
@@ -227,6 +249,7 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
|
|
|
227
249
|
Message?: string;
|
|
228
250
|
Code?: string;
|
|
229
251
|
/**
|
|
252
|
+
* @public
|
|
230
253
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
231
254
|
*/
|
|
232
255
|
Logref?: string;
|
|
@@ -245,6 +268,7 @@ export declare class InternalServerError extends __BaseException {
|
|
|
245
268
|
Message?: string;
|
|
246
269
|
Code?: string;
|
|
247
270
|
/**
|
|
271
|
+
* @public
|
|
248
272
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
249
273
|
*/
|
|
250
274
|
Logref?: string;
|
|
@@ -264,6 +288,7 @@ export declare class InvalidParameterException extends __BaseException {
|
|
|
264
288
|
Message?: string;
|
|
265
289
|
Code?: string;
|
|
266
290
|
/**
|
|
291
|
+
* @public
|
|
267
292
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
268
293
|
*/
|
|
269
294
|
Logref?: string;
|
|
@@ -283,6 +308,7 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
|
|
|
283
308
|
Message?: string;
|
|
284
309
|
Code?: string;
|
|
285
310
|
/**
|
|
311
|
+
* @public
|
|
286
312
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
287
313
|
*/
|
|
288
314
|
Logref?: string;
|
|
@@ -301,6 +327,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
301
327
|
Message?: string;
|
|
302
328
|
Code?: string;
|
|
303
329
|
/**
|
|
330
|
+
* @public
|
|
304
331
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
305
332
|
*/
|
|
306
333
|
Logref?: string;
|
|
@@ -321,6 +348,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
321
348
|
Message?: string;
|
|
322
349
|
Code?: string;
|
|
323
350
|
/**
|
|
351
|
+
* @public
|
|
324
352
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
325
353
|
*/
|
|
326
354
|
Logref?: string;
|
|
@@ -339,6 +367,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
339
367
|
Message?: string;
|
|
340
368
|
Code?: string;
|
|
341
369
|
/**
|
|
370
|
+
* @public
|
|
342
371
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
343
372
|
*/
|
|
344
373
|
Logref?: string;
|
|
@@ -378,18 +407,22 @@ export type Attribute = (typeof Attribute)[keyof typeof Attribute];
|
|
|
378
407
|
*/
|
|
379
408
|
export interface AudioMetadata {
|
|
380
409
|
/**
|
|
410
|
+
* @public
|
|
381
411
|
* <p>The audio codec used to encode or decode the audio stream. </p>
|
|
382
412
|
*/
|
|
383
413
|
Codec?: string;
|
|
384
414
|
/**
|
|
415
|
+
* @public
|
|
385
416
|
* <p>The duration of the audio stream in milliseconds.</p>
|
|
386
417
|
*/
|
|
387
418
|
DurationMillis?: number;
|
|
388
419
|
/**
|
|
420
|
+
* @public
|
|
389
421
|
* <p>The sample rate for the audio stream.</p>
|
|
390
422
|
*/
|
|
391
423
|
SampleRate?: number;
|
|
392
424
|
/**
|
|
425
|
+
* @public
|
|
393
426
|
* <p>The number of audio channels in the segment.</p>
|
|
394
427
|
*/
|
|
395
428
|
NumberOfChannels?: number;
|
|
@@ -417,18 +450,22 @@ export interface AudioMetadata {
|
|
|
417
450
|
*/
|
|
418
451
|
export interface BoundingBox {
|
|
419
452
|
/**
|
|
453
|
+
* @public
|
|
420
454
|
* <p>Width of the bounding box as a ratio of the overall image width.</p>
|
|
421
455
|
*/
|
|
422
456
|
Width?: number;
|
|
423
457
|
/**
|
|
458
|
+
* @public
|
|
424
459
|
* <p>Height of the bounding box as a ratio of the overall image height.</p>
|
|
425
460
|
*/
|
|
426
461
|
Height?: number;
|
|
427
462
|
/**
|
|
463
|
+
* @public
|
|
428
464
|
* <p>Left coordinate of the bounding box as a ratio of overall image width.</p>
|
|
429
465
|
*/
|
|
430
466
|
Left?: number;
|
|
431
467
|
/**
|
|
468
|
+
* @public
|
|
432
469
|
* <p>Top coordinate of the bounding box as a ratio of overall image height.</p>
|
|
433
470
|
*/
|
|
434
471
|
Top?: number;
|
|
@@ -439,10 +476,12 @@ export interface BoundingBox {
|
|
|
439
476
|
*/
|
|
440
477
|
export interface AuditImage {
|
|
441
478
|
/**
|
|
479
|
+
* @public
|
|
442
480
|
* <p>The Base64-encoded bytes representing an image selected from the Face Liveness video and returned for audit purposes.</p>
|
|
443
481
|
*/
|
|
444
482
|
Bytes?: Uint8Array;
|
|
445
483
|
/**
|
|
484
|
+
* @public
|
|
446
485
|
* <p>Provides the S3 bucket name and object name.</p>
|
|
447
486
|
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
448
487
|
* Amazon Rekognition operations.</p>
|
|
@@ -452,6 +491,7 @@ export interface AuditImage {
|
|
|
452
491
|
*/
|
|
453
492
|
S3Object?: S3Object;
|
|
454
493
|
/**
|
|
494
|
+
* @public
|
|
455
495
|
* <p>Identifies the bounding box around the label, face, text, object of interest, or
|
|
456
496
|
* personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
|
|
457
497
|
* (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
|
|
@@ -480,10 +520,12 @@ export interface AuditImage {
|
|
|
480
520
|
*/
|
|
481
521
|
export interface Beard {
|
|
482
522
|
/**
|
|
523
|
+
* @public
|
|
483
524
|
* <p>Boolean value that indicates whether the face has beard or not.</p>
|
|
484
525
|
*/
|
|
485
526
|
Value?: boolean;
|
|
486
527
|
/**
|
|
528
|
+
* @public
|
|
487
529
|
* <p>Level of confidence in the determination.</p>
|
|
488
530
|
*/
|
|
489
531
|
Confidence?: number;
|
|
@@ -499,6 +541,7 @@ export interface Beard {
|
|
|
499
541
|
*/
|
|
500
542
|
export interface BlackFrame {
|
|
501
543
|
/**
|
|
544
|
+
* @public
|
|
502
545
|
* <p>
|
|
503
546
|
* A threshold used to determine the maximum luminance value for a pixel to be considered black. In a full color range video,
|
|
504
547
|
* luminance values range from 0-255. A pixel value of 0 is pure black, and the most strict filter. The maximum black pixel
|
|
@@ -510,6 +553,7 @@ export interface BlackFrame {
|
|
|
510
553
|
*/
|
|
511
554
|
MaxPixelThreshold?: number;
|
|
512
555
|
/**
|
|
556
|
+
* @public
|
|
513
557
|
* <p>
|
|
514
558
|
* The minimum percentage of pixels in a frame that need to have a luminance below the max_black_pixel_value for a frame to be considered
|
|
515
559
|
* a black frame. Luminance is calculated using the BT.709 matrix.
|
|
@@ -540,10 +584,12 @@ export type BodyPart = (typeof BodyPart)[keyof typeof BodyPart];
|
|
|
540
584
|
*/
|
|
541
585
|
export interface CoversBodyPart {
|
|
542
586
|
/**
|
|
587
|
+
* @public
|
|
543
588
|
* <p>The confidence that Amazon Rekognition has in the value of <code>Value</code>.</p>
|
|
544
589
|
*/
|
|
545
590
|
Confidence?: number;
|
|
546
591
|
/**
|
|
592
|
+
* @public
|
|
547
593
|
* <p>True if the PPE covers the corresponding body part, otherwise false.</p>
|
|
548
594
|
*/
|
|
549
595
|
Value?: boolean;
|
|
@@ -569,18 +615,22 @@ export type ProtectiveEquipmentType = (typeof ProtectiveEquipmentType)[keyof typ
|
|
|
569
615
|
*/
|
|
570
616
|
export interface EquipmentDetection {
|
|
571
617
|
/**
|
|
618
|
+
* @public
|
|
572
619
|
* <p>A bounding box surrounding the item of detected PPE.</p>
|
|
573
620
|
*/
|
|
574
621
|
BoundingBox?: BoundingBox;
|
|
575
622
|
/**
|
|
623
|
+
* @public
|
|
576
624
|
* <p>The confidence that Amazon Rekognition has that the bounding box (<code>BoundingBox</code>) contains an item of PPE.</p>
|
|
577
625
|
*/
|
|
578
626
|
Confidence?: number;
|
|
579
627
|
/**
|
|
628
|
+
* @public
|
|
580
629
|
* <p>The type of detected PPE.</p>
|
|
581
630
|
*/
|
|
582
631
|
Type?: ProtectiveEquipmentType | string;
|
|
583
632
|
/**
|
|
633
|
+
* @public
|
|
584
634
|
* <p>Information about the body part covered by the detected PPE.</p>
|
|
585
635
|
*/
|
|
586
636
|
CoversBodyPart?: CoversBodyPart;
|
|
@@ -593,15 +643,18 @@ export interface EquipmentDetection {
|
|
|
593
643
|
*/
|
|
594
644
|
export interface ProtectiveEquipmentBodyPart {
|
|
595
645
|
/**
|
|
646
|
+
* @public
|
|
596
647
|
* <p>The detected body part.</p>
|
|
597
648
|
*/
|
|
598
649
|
Name?: BodyPart | string;
|
|
599
650
|
/**
|
|
651
|
+
* @public
|
|
600
652
|
* <p>The confidence that Amazon Rekognition has in the detection accuracy of the detected body part.
|
|
601
653
|
* </p>
|
|
602
654
|
*/
|
|
603
655
|
Confidence?: number;
|
|
604
656
|
/**
|
|
657
|
+
* @public
|
|
605
658
|
* <p>An array of Personal Protective Equipment items detected around a body part.</p>
|
|
606
659
|
*/
|
|
607
660
|
EquipmentDetections?: EquipmentDetection[];
|
|
@@ -635,10 +688,12 @@ export type EmotionName = (typeof EmotionName)[keyof typeof EmotionName];
|
|
|
635
688
|
*/
|
|
636
689
|
export interface Emotion {
|
|
637
690
|
/**
|
|
691
|
+
* @public
|
|
638
692
|
* <p>Type of emotion detected.</p>
|
|
639
693
|
*/
|
|
640
694
|
Type?: EmotionName | string;
|
|
641
695
|
/**
|
|
696
|
+
* @public
|
|
642
697
|
* <p>Level of confidence in the determination.</p>
|
|
643
698
|
*/
|
|
644
699
|
Confidence?: number;
|
|
@@ -689,10 +744,12 @@ export type LandmarkType = (typeof LandmarkType)[keyof typeof LandmarkType];
|
|
|
689
744
|
*/
|
|
690
745
|
export interface Landmark {
|
|
691
746
|
/**
|
|
747
|
+
* @public
|
|
692
748
|
* <p>Type of landmark.</p>
|
|
693
749
|
*/
|
|
694
750
|
Type?: LandmarkType | string;
|
|
695
751
|
/**
|
|
752
|
+
* @public
|
|
696
753
|
* <p>The x-coordinate of the landmark expressed as a ratio of the width of the image. The
|
|
697
754
|
* x-coordinate is measured from the left-side of the image. For example, if the image is 700
|
|
698
755
|
* pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.
|
|
@@ -700,6 +757,7 @@ export interface Landmark {
|
|
|
700
757
|
*/
|
|
701
758
|
X?: number;
|
|
702
759
|
/**
|
|
760
|
+
* @public
|
|
703
761
|
* <p>The y-coordinate of the landmark expressed as a ratio of the height of the image. The
|
|
704
762
|
* y-coordinate is measured from the top of the image. For example, if the image height is 200
|
|
705
763
|
* pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.</p>
|
|
@@ -712,14 +770,17 @@ export interface Landmark {
|
|
|
712
770
|
*/
|
|
713
771
|
export interface Pose {
|
|
714
772
|
/**
|
|
773
|
+
* @public
|
|
715
774
|
* <p>Value representing the face rotation on the roll axis.</p>
|
|
716
775
|
*/
|
|
717
776
|
Roll?: number;
|
|
718
777
|
/**
|
|
778
|
+
* @public
|
|
719
779
|
* <p>Value representing the face rotation on the yaw axis.</p>
|
|
720
780
|
*/
|
|
721
781
|
Yaw?: number;
|
|
722
782
|
/**
|
|
783
|
+
* @public
|
|
723
784
|
* <p>Value representing the face rotation on the pitch axis.</p>
|
|
724
785
|
*/
|
|
725
786
|
Pitch?: number;
|
|
@@ -730,11 +791,13 @@ export interface Pose {
|
|
|
730
791
|
*/
|
|
731
792
|
export interface ImageQuality {
|
|
732
793
|
/**
|
|
794
|
+
* @public
|
|
733
795
|
* <p>Value representing brightness of the face. The service returns a value between 0 and
|
|
734
796
|
* 100 (inclusive). A higher value indicates a brighter face image.</p>
|
|
735
797
|
*/
|
|
736
798
|
Brightness?: number;
|
|
737
799
|
/**
|
|
800
|
+
* @public
|
|
738
801
|
* <p>Value representing sharpness of the face. The service returns a value between 0 and 100
|
|
739
802
|
* (inclusive). A higher value indicates a sharper face image.</p>
|
|
740
803
|
*/
|
|
@@ -747,10 +810,12 @@ export interface ImageQuality {
|
|
|
747
810
|
*/
|
|
748
811
|
export interface Smile {
|
|
749
812
|
/**
|
|
813
|
+
* @public
|
|
750
814
|
* <p>Boolean value that indicates whether the face is smiling or not.</p>
|
|
751
815
|
*/
|
|
752
816
|
Value?: boolean;
|
|
753
817
|
/**
|
|
818
|
+
* @public
|
|
754
819
|
* <p>Level of confidence in the determination.</p>
|
|
755
820
|
*/
|
|
756
821
|
Confidence?: number;
|
|
@@ -762,32 +827,39 @@ export interface Smile {
|
|
|
762
827
|
*/
|
|
763
828
|
export interface ComparedFace {
|
|
764
829
|
/**
|
|
830
|
+
* @public
|
|
765
831
|
* <p>Bounding box of the face.</p>
|
|
766
832
|
*/
|
|
767
833
|
BoundingBox?: BoundingBox;
|
|
768
834
|
/**
|
|
835
|
+
* @public
|
|
769
836
|
* <p>Level of confidence that what the bounding box contains is a face.</p>
|
|
770
837
|
*/
|
|
771
838
|
Confidence?: number;
|
|
772
839
|
/**
|
|
840
|
+
* @public
|
|
773
841
|
* <p>An array of facial landmarks.</p>
|
|
774
842
|
*/
|
|
775
843
|
Landmarks?: Landmark[];
|
|
776
844
|
/**
|
|
845
|
+
* @public
|
|
777
846
|
* <p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>
|
|
778
847
|
*/
|
|
779
848
|
Pose?: Pose;
|
|
780
849
|
/**
|
|
850
|
+
* @public
|
|
781
851
|
* <p>Identifies face image brightness and sharpness. </p>
|
|
782
852
|
*/
|
|
783
853
|
Quality?: ImageQuality;
|
|
784
854
|
/**
|
|
855
|
+
* @public
|
|
785
856
|
* <p> The emotions that appear to be expressed on the face, and the confidence level in the
|
|
786
857
|
* determination. Valid values include "Happy", "Sad", "Angry", "Confused", "Disgusted",
|
|
787
858
|
* "Surprised", "Calm", "Unknown", and "Fear". </p>
|
|
788
859
|
*/
|
|
789
860
|
Emotions?: Emotion[];
|
|
790
861
|
/**
|
|
862
|
+
* @public
|
|
791
863
|
* <p> Indicates whether or not the face is smiling, and the confidence level in the
|
|
792
864
|
* determination. </p>
|
|
793
865
|
*/
|
|
@@ -814,6 +886,7 @@ export type KnownGenderType = (typeof KnownGenderType)[keyof typeof KnownGenderT
|
|
|
814
886
|
*/
|
|
815
887
|
export interface KnownGender {
|
|
816
888
|
/**
|
|
889
|
+
* @public
|
|
817
890
|
* <p>A string value of the KnownGender info about the Celebrity.</p>
|
|
818
891
|
*/
|
|
819
892
|
Type?: KnownGenderType | string;
|
|
@@ -824,29 +897,35 @@ export interface KnownGender {
|
|
|
824
897
|
*/
|
|
825
898
|
export interface Celebrity {
|
|
826
899
|
/**
|
|
900
|
+
* @public
|
|
827
901
|
* <p>An array of URLs pointing to additional information about the celebrity. If there is no
|
|
828
902
|
* additional information about the celebrity, this list is empty.</p>
|
|
829
903
|
*/
|
|
830
904
|
Urls?: string[];
|
|
831
905
|
/**
|
|
906
|
+
* @public
|
|
832
907
|
* <p>The name of the celebrity.</p>
|
|
833
908
|
*/
|
|
834
909
|
Name?: string;
|
|
835
910
|
/**
|
|
911
|
+
* @public
|
|
836
912
|
* <p>A unique identifier for the celebrity. </p>
|
|
837
913
|
*/
|
|
838
914
|
Id?: string;
|
|
839
915
|
/**
|
|
916
|
+
* @public
|
|
840
917
|
* <p>Provides information about the celebrity's face, such as its location on the
|
|
841
918
|
* image.</p>
|
|
842
919
|
*/
|
|
843
920
|
Face?: ComparedFace;
|
|
844
921
|
/**
|
|
922
|
+
* @public
|
|
845
923
|
* <p>The confidence, in percentage, that Amazon Rekognition has that the recognized face is the
|
|
846
924
|
* celebrity.</p>
|
|
847
925
|
*/
|
|
848
926
|
MatchConfidence?: number;
|
|
849
927
|
/**
|
|
928
|
+
* @public
|
|
850
929
|
* <p>The known gender identity for the celebrity that matches the provided ID. The known
|
|
851
930
|
* gender identity can be Male, Female, Nonbinary, or Unlisted.</p>
|
|
852
931
|
*/
|
|
@@ -858,14 +937,17 @@ export interface Celebrity {
|
|
|
858
937
|
*/
|
|
859
938
|
export interface EyeDirection {
|
|
860
939
|
/**
|
|
940
|
+
* @public
|
|
861
941
|
* <p>Value representing eye direction on the yaw axis.</p>
|
|
862
942
|
*/
|
|
863
943
|
Yaw?: number;
|
|
864
944
|
/**
|
|
945
|
+
* @public
|
|
865
946
|
* <p>Value representing eye direction on the pitch axis.</p>
|
|
866
947
|
*/
|
|
867
948
|
Pitch?: number;
|
|
868
949
|
/**
|
|
950
|
+
* @public
|
|
869
951
|
* <p>The confidence that the service has in its predicted eye direction.</p>
|
|
870
952
|
*/
|
|
871
953
|
Confidence?: number;
|
|
@@ -877,10 +959,12 @@ export interface EyeDirection {
|
|
|
877
959
|
*/
|
|
878
960
|
export interface Eyeglasses {
|
|
879
961
|
/**
|
|
962
|
+
* @public
|
|
880
963
|
* <p>Boolean value that indicates whether the face is wearing eye glasses or not.</p>
|
|
881
964
|
*/
|
|
882
965
|
Value?: boolean;
|
|
883
966
|
/**
|
|
967
|
+
* @public
|
|
884
968
|
* <p>Level of confidence in the determination.</p>
|
|
885
969
|
*/
|
|
886
970
|
Confidence?: number;
|
|
@@ -892,10 +976,12 @@ export interface Eyeglasses {
|
|
|
892
976
|
*/
|
|
893
977
|
export interface EyeOpen {
|
|
894
978
|
/**
|
|
979
|
+
* @public
|
|
895
980
|
* <p>Boolean value that indicates whether the eyes on the face are open.</p>
|
|
896
981
|
*/
|
|
897
982
|
Value?: boolean;
|
|
898
983
|
/**
|
|
984
|
+
* @public
|
|
899
985
|
* <p>Level of confidence in the determination.</p>
|
|
900
986
|
*/
|
|
901
987
|
Confidence?: number;
|
|
@@ -914,6 +1000,7 @@ export interface EyeOpen {
|
|
|
914
1000
|
*/
|
|
915
1001
|
export interface FaceOccluded {
|
|
916
1002
|
/**
|
|
1003
|
+
* @public
|
|
917
1004
|
* <p>True if a detected face’s eyes, nose, and mouth are partially captured or if they are
|
|
918
1005
|
* covered by masks, dark sunglasses, cell phones, hands, or other objects. False if common
|
|
919
1006
|
* occurrences that do not impact face verification are detected, such as eye glasses, lightly
|
|
@@ -921,6 +1008,7 @@ export interface FaceOccluded {
|
|
|
921
1008
|
*/
|
|
922
1009
|
Value?: boolean;
|
|
923
1010
|
/**
|
|
1011
|
+
* @public
|
|
924
1012
|
* <p>The confidence that the service has detected the presence of a face occlusion.</p>
|
|
925
1013
|
*/
|
|
926
1014
|
Confidence?: number;
|
|
@@ -956,10 +1044,12 @@ export type GenderType = (typeof GenderType)[keyof typeof GenderType];
|
|
|
956
1044
|
*/
|
|
957
1045
|
export interface Gender {
|
|
958
1046
|
/**
|
|
1047
|
+
* @public
|
|
959
1048
|
* <p>The predicted gender of the face.</p>
|
|
960
1049
|
*/
|
|
961
1050
|
Value?: GenderType | string;
|
|
962
1051
|
/**
|
|
1052
|
+
* @public
|
|
963
1053
|
* <p>Level of confidence in the prediction.</p>
|
|
964
1054
|
*/
|
|
965
1055
|
Confidence?: number;
|
|
@@ -971,10 +1061,12 @@ export interface Gender {
|
|
|
971
1061
|
*/
|
|
972
1062
|
export interface MouthOpen {
|
|
973
1063
|
/**
|
|
1064
|
+
* @public
|
|
974
1065
|
* <p>Boolean value that indicates whether the mouth on the face is open or not.</p>
|
|
975
1066
|
*/
|
|
976
1067
|
Value?: boolean;
|
|
977
1068
|
/**
|
|
1069
|
+
* @public
|
|
978
1070
|
* <p>Level of confidence in the determination.</p>
|
|
979
1071
|
*/
|
|
980
1072
|
Confidence?: number;
|
|
@@ -986,10 +1078,12 @@ export interface MouthOpen {
|
|
|
986
1078
|
*/
|
|
987
1079
|
export interface Mustache {
|
|
988
1080
|
/**
|
|
1081
|
+
* @public
|
|
989
1082
|
* <p>Boolean value that indicates whether the face has mustache or not.</p>
|
|
990
1083
|
*/
|
|
991
1084
|
Value?: boolean;
|
|
992
1085
|
/**
|
|
1086
|
+
* @public
|
|
993
1087
|
* <p>Level of confidence in the determination.</p>
|
|
994
1088
|
*/
|
|
995
1089
|
Confidence?: number;
|
|
@@ -1001,10 +1095,12 @@ export interface Mustache {
|
|
|
1001
1095
|
*/
|
|
1002
1096
|
export interface Sunglasses {
|
|
1003
1097
|
/**
|
|
1098
|
+
* @public
|
|
1004
1099
|
* <p>Boolean value that indicates whether the face is wearing sunglasses or not.</p>
|
|
1005
1100
|
*/
|
|
1006
1101
|
Value?: boolean;
|
|
1007
1102
|
/**
|
|
1103
|
+
* @public
|
|
1008
1104
|
* <p>Level of confidence in the determination.</p>
|
|
1009
1105
|
*/
|
|
1010
1106
|
Confidence?: number;
|
|
@@ -1040,54 +1136,65 @@ export interface Sunglasses {
|
|
|
1040
1136
|
*/
|
|
1041
1137
|
export interface FaceDetail {
|
|
1042
1138
|
/**
|
|
1139
|
+
* @public
|
|
1043
1140
|
* <p>Bounding box of the face. Default attribute.</p>
|
|
1044
1141
|
*/
|
|
1045
1142
|
BoundingBox?: BoundingBox;
|
|
1046
1143
|
/**
|
|
1144
|
+
* @public
|
|
1047
1145
|
* <p>The estimated age range, in years, for the face. Low represents the lowest estimated
|
|
1048
1146
|
* age and High represents the highest estimated age.</p>
|
|
1049
1147
|
*/
|
|
1050
1148
|
AgeRange?: AgeRange;
|
|
1051
1149
|
/**
|
|
1150
|
+
* @public
|
|
1052
1151
|
* <p>Indicates whether or not the face is smiling, and the confidence level in the
|
|
1053
1152
|
* determination.</p>
|
|
1054
1153
|
*/
|
|
1055
1154
|
Smile?: Smile;
|
|
1056
1155
|
/**
|
|
1156
|
+
* @public
|
|
1057
1157
|
* <p>Indicates whether or not the face is wearing eye glasses, and the confidence level in
|
|
1058
1158
|
* the determination.</p>
|
|
1059
1159
|
*/
|
|
1060
1160
|
Eyeglasses?: Eyeglasses;
|
|
1061
1161
|
/**
|
|
1162
|
+
* @public
|
|
1062
1163
|
* <p>Indicates whether or not the face is wearing sunglasses, and the confidence level in
|
|
1063
1164
|
* the determination.</p>
|
|
1064
1165
|
*/
|
|
1065
1166
|
Sunglasses?: Sunglasses;
|
|
1066
1167
|
/**
|
|
1168
|
+
* @public
|
|
1067
1169
|
* <p>The predicted gender of a detected face. </p>
|
|
1068
1170
|
*/
|
|
1069
1171
|
Gender?: Gender;
|
|
1070
1172
|
/**
|
|
1173
|
+
* @public
|
|
1071
1174
|
* <p>Indicates whether or not the face has a beard, and the confidence level in the
|
|
1072
1175
|
* determination.</p>
|
|
1073
1176
|
*/
|
|
1074
1177
|
Beard?: Beard;
|
|
1075
1178
|
/**
|
|
1179
|
+
* @public
|
|
1076
1180
|
* <p>Indicates whether or not the face has a mustache, and the confidence level in the
|
|
1077
1181
|
* determination.</p>
|
|
1078
1182
|
*/
|
|
1079
1183
|
Mustache?: Mustache;
|
|
1080
1184
|
/**
|
|
1185
|
+
* @public
|
|
1081
1186
|
* <p>Indicates whether or not the eyes on the face are open, and the confidence level in the
|
|
1082
1187
|
* determination.</p>
|
|
1083
1188
|
*/
|
|
1084
1189
|
EyesOpen?: EyeOpen;
|
|
1085
1190
|
/**
|
|
1191
|
+
* @public
|
|
1086
1192
|
* <p>Indicates whether or not the mouth on the face is open, and the confidence level in the
|
|
1087
1193
|
* determination.</p>
|
|
1088
1194
|
*/
|
|
1089
1195
|
MouthOpen?: MouthOpen;
|
|
1090
1196
|
/**
|
|
1197
|
+
* @public
|
|
1091
1198
|
* <p>The emotions that appear to be expressed on the face, and the confidence level in the
|
|
1092
1199
|
* determination. The API is only making a determination of the physical appearance of a person's
|
|
1093
1200
|
* face. It is not a determination of the person’s internal emotional state and should not be
|
|
@@ -1096,24 +1203,29 @@ export interface FaceDetail {
|
|
|
1096
1203
|
*/
|
|
1097
1204
|
Emotions?: Emotion[];
|
|
1098
1205
|
/**
|
|
1206
|
+
* @public
|
|
1099
1207
|
* <p>Indicates the location of landmarks on the face. Default attribute.</p>
|
|
1100
1208
|
*/
|
|
1101
1209
|
Landmarks?: Landmark[];
|
|
1102
1210
|
/**
|
|
1211
|
+
* @public
|
|
1103
1212
|
* <p>Indicates the pose of the face as determined by its pitch, roll, and yaw. Default
|
|
1104
1213
|
* attribute.</p>
|
|
1105
1214
|
*/
|
|
1106
1215
|
Pose?: Pose;
|
|
1107
1216
|
/**
|
|
1217
|
+
* @public
|
|
1108
1218
|
* <p>Identifies image brightness and sharpness. Default attribute.</p>
|
|
1109
1219
|
*/
|
|
1110
1220
|
Quality?: ImageQuality;
|
|
1111
1221
|
/**
|
|
1222
|
+
* @public
|
|
1112
1223
|
* <p>Confidence level that the bounding box contains a face (and not a different object such
|
|
1113
1224
|
* as a tree). Default attribute.</p>
|
|
1114
1225
|
*/
|
|
1115
1226
|
Confidence?: number;
|
|
1116
1227
|
/**
|
|
1228
|
+
* @public
|
|
1117
1229
|
* <p>
|
|
1118
1230
|
* <code>FaceOccluded</code> should return "true" with a high confidence score if a detected
|
|
1119
1231
|
* face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark
|
|
@@ -1124,6 +1236,7 @@ export interface FaceDetail {
|
|
|
1124
1236
|
*/
|
|
1125
1237
|
FaceOccluded?: FaceOccluded;
|
|
1126
1238
|
/**
|
|
1239
|
+
* @public
|
|
1127
1240
|
* <p>Indicates the direction the eyes are gazing in, as defined by pitch and yaw.</p>
|
|
1128
1241
|
*/
|
|
1129
1242
|
EyeDirection?: EyeDirection;
|
|
@@ -1134,30 +1247,37 @@ export interface FaceDetail {
|
|
|
1134
1247
|
*/
|
|
1135
1248
|
export interface CelebrityDetail {
|
|
1136
1249
|
/**
|
|
1250
|
+
* @public
|
|
1137
1251
|
* <p>An array of URLs pointing to additional celebrity information. </p>
|
|
1138
1252
|
*/
|
|
1139
1253
|
Urls?: string[];
|
|
1140
1254
|
/**
|
|
1255
|
+
* @public
|
|
1141
1256
|
* <p>The name of the celebrity.</p>
|
|
1142
1257
|
*/
|
|
1143
1258
|
Name?: string;
|
|
1144
1259
|
/**
|
|
1260
|
+
* @public
|
|
1145
1261
|
* <p>The unique identifier for the celebrity. </p>
|
|
1146
1262
|
*/
|
|
1147
1263
|
Id?: string;
|
|
1148
1264
|
/**
|
|
1265
|
+
* @public
|
|
1149
1266
|
* <p>The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity. </p>
|
|
1150
1267
|
*/
|
|
1151
1268
|
Confidence?: number;
|
|
1152
1269
|
/**
|
|
1270
|
+
* @public
|
|
1153
1271
|
* <p>Bounding box around the body of a celebrity.</p>
|
|
1154
1272
|
*/
|
|
1155
1273
|
BoundingBox?: BoundingBox;
|
|
1156
1274
|
/**
|
|
1275
|
+
* @public
|
|
1157
1276
|
* <p>Face details for the recognized celebrity.</p>
|
|
1158
1277
|
*/
|
|
1159
1278
|
Face?: FaceDetail;
|
|
1160
1279
|
/**
|
|
1280
|
+
* @public
|
|
1161
1281
|
* <p>Retrieves the known gender for the celebrity.</p>
|
|
1162
1282
|
*/
|
|
1163
1283
|
KnownGender?: KnownGender;
|
|
@@ -1169,11 +1289,13 @@ export interface CelebrityDetail {
|
|
|
1169
1289
|
*/
|
|
1170
1290
|
export interface CelebrityRecognition {
|
|
1171
1291
|
/**
|
|
1292
|
+
* @public
|
|
1172
1293
|
* <p>The time, in milliseconds from the start of the video, that the celebrity was recognized.
|
|
1173
1294
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the celebrity first appears.</p>
|
|
1174
1295
|
*/
|
|
1175
1296
|
Timestamp?: number;
|
|
1176
1297
|
/**
|
|
1298
|
+
* @public
|
|
1177
1299
|
* <p>Information about a recognized celebrity.</p>
|
|
1178
1300
|
*/
|
|
1179
1301
|
Celebrity?: CelebrityDetail;
|
|
@@ -1199,10 +1321,12 @@ export type CelebrityRecognitionSortBy = (typeof CelebrityRecognitionSortBy)[key
|
|
|
1199
1321
|
*/
|
|
1200
1322
|
export interface ComparedSourceImageFace {
|
|
1201
1323
|
/**
|
|
1324
|
+
* @public
|
|
1202
1325
|
* <p>Bounding box of the face.</p>
|
|
1203
1326
|
*/
|
|
1204
1327
|
BoundingBox?: BoundingBox;
|
|
1205
1328
|
/**
|
|
1329
|
+
* @public
|
|
1206
1330
|
* <p>Confidence level that the selected bounding box contains a face.</p>
|
|
1207
1331
|
*/
|
|
1208
1332
|
Confidence?: number;
|
|
@@ -1246,11 +1370,13 @@ export type QualityFilter = (typeof QualityFilter)[keyof typeof QualityFilter];
|
|
|
1246
1370
|
*/
|
|
1247
1371
|
export interface Image {
|
|
1248
1372
|
/**
|
|
1373
|
+
* @public
|
|
1249
1374
|
* <p>Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to
|
|
1250
1375
|
* <code>DetectCustomLabels</code> is 4MB. </p>
|
|
1251
1376
|
*/
|
|
1252
1377
|
Bytes?: Uint8Array;
|
|
1253
1378
|
/**
|
|
1379
|
+
* @public
|
|
1254
1380
|
* <p>Identifies an S3 object as the image source.</p>
|
|
1255
1381
|
*/
|
|
1256
1382
|
S3Object?: S3Object;
|
|
@@ -1260,6 +1386,7 @@ export interface Image {
|
|
|
1260
1386
|
*/
|
|
1261
1387
|
export interface CompareFacesRequest {
|
|
1262
1388
|
/**
|
|
1389
|
+
* @public
|
|
1263
1390
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
1264
1391
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
1265
1392
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -1268,6 +1395,7 @@ export interface CompareFacesRequest {
|
|
|
1268
1395
|
*/
|
|
1269
1396
|
SourceImage: Image | undefined;
|
|
1270
1397
|
/**
|
|
1398
|
+
* @public
|
|
1271
1399
|
* <p>The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
1272
1400
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
1273
1401
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -1276,11 +1404,13 @@ export interface CompareFacesRequest {
|
|
|
1276
1404
|
*/
|
|
1277
1405
|
TargetImage: Image | undefined;
|
|
1278
1406
|
/**
|
|
1407
|
+
* @public
|
|
1279
1408
|
* <p>The minimum level of confidence in the face matches that a match must meet to be
|
|
1280
1409
|
* included in the <code>FaceMatches</code> array.</p>
|
|
1281
1410
|
*/
|
|
1282
1411
|
SimilarityThreshold?: number;
|
|
1283
1412
|
/**
|
|
1413
|
+
* @public
|
|
1284
1414
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
1285
1415
|
* Filtered faces aren't compared. If you specify <code>AUTO</code>, Amazon Rekognition chooses the
|
|
1286
1416
|
* quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>,
|
|
@@ -1304,10 +1434,12 @@ export interface CompareFacesRequest {
|
|
|
1304
1434
|
*/
|
|
1305
1435
|
export interface CompareFacesMatch {
|
|
1306
1436
|
/**
|
|
1437
|
+
* @public
|
|
1307
1438
|
* <p>Level of confidence that the faces match.</p>
|
|
1308
1439
|
*/
|
|
1309
1440
|
Similarity?: number;
|
|
1310
1441
|
/**
|
|
1442
|
+
* @public
|
|
1311
1443
|
* <p>Provides face metadata (bounding box and confidence that the bounding box actually
|
|
1312
1444
|
* contains a face).</p>
|
|
1313
1445
|
*/
|
|
@@ -1332,10 +1464,12 @@ export type OrientationCorrection = (typeof OrientationCorrection)[keyof typeof
|
|
|
1332
1464
|
*/
|
|
1333
1465
|
export interface CompareFacesResponse {
|
|
1334
1466
|
/**
|
|
1467
|
+
* @public
|
|
1335
1468
|
* <p>The face in the source image that was used for comparison.</p>
|
|
1336
1469
|
*/
|
|
1337
1470
|
SourceImageFace?: ComparedSourceImageFace;
|
|
1338
1471
|
/**
|
|
1472
|
+
* @public
|
|
1339
1473
|
* <p>An array of faces in the target image that match the source image face. Each
|
|
1340
1474
|
* <code>CompareFacesMatch</code> object provides the bounding box, the confidence level that
|
|
1341
1475
|
* the bounding box contains a face, and the similarity score for the face in the bounding box
|
|
@@ -1343,11 +1477,13 @@ export interface CompareFacesResponse {
|
|
|
1343
1477
|
*/
|
|
1344
1478
|
FaceMatches?: CompareFacesMatch[];
|
|
1345
1479
|
/**
|
|
1480
|
+
* @public
|
|
1346
1481
|
* <p>An array of faces in the target image that did not match the source image
|
|
1347
1482
|
* face.</p>
|
|
1348
1483
|
*/
|
|
1349
1484
|
UnmatchedFaces?: ComparedFace[];
|
|
1350
1485
|
/**
|
|
1486
|
+
* @public
|
|
1351
1487
|
* <p>The value of <code>SourceImageOrientationCorrection</code> is always null.</p>
|
|
1352
1488
|
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
1353
1489
|
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
@@ -1360,6 +1496,7 @@ export interface CompareFacesResponse {
|
|
|
1360
1496
|
*/
|
|
1361
1497
|
SourceImageOrientationCorrection?: OrientationCorrection | string;
|
|
1362
1498
|
/**
|
|
1499
|
+
* @public
|
|
1363
1500
|
* <p>The value of <code>TargetImageOrientationCorrection</code> is always null.</p>
|
|
1364
1501
|
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
1365
1502
|
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
@@ -1385,6 +1522,7 @@ export declare class ImageTooLargeException extends __BaseException {
|
|
|
1385
1522
|
Message?: string;
|
|
1386
1523
|
Code?: string;
|
|
1387
1524
|
/**
|
|
1525
|
+
* @public
|
|
1388
1526
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1389
1527
|
*/
|
|
1390
1528
|
Logref?: string;
|
|
@@ -1403,6 +1541,7 @@ export declare class InvalidImageFormatException extends __BaseException {
|
|
|
1403
1541
|
Message?: string;
|
|
1404
1542
|
Code?: string;
|
|
1405
1543
|
/**
|
|
1544
|
+
* @public
|
|
1406
1545
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1407
1546
|
*/
|
|
1408
1547
|
Logref?: string;
|
|
@@ -1421,6 +1560,7 @@ export declare class InvalidS3ObjectException extends __BaseException {
|
|
|
1421
1560
|
Message?: string;
|
|
1422
1561
|
Code?: string;
|
|
1423
1562
|
/**
|
|
1563
|
+
* @public
|
|
1424
1564
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1425
1565
|
*/
|
|
1426
1566
|
Logref?: string;
|
|
@@ -1441,12 +1581,14 @@ export declare class InvalidS3ObjectException extends __BaseException {
|
|
|
1441
1581
|
*/
|
|
1442
1582
|
export interface ConnectedHomeSettings {
|
|
1443
1583
|
/**
|
|
1584
|
+
* @public
|
|
1444
1585
|
* <p>
|
|
1445
1586
|
* Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".
|
|
1446
1587
|
* </p>
|
|
1447
1588
|
*/
|
|
1448
1589
|
Labels: string[] | undefined;
|
|
1449
1590
|
/**
|
|
1591
|
+
* @public
|
|
1450
1592
|
* <p>
|
|
1451
1593
|
* The minimum confidence required to label an object in the video.
|
|
1452
1594
|
* </p>
|
|
@@ -1461,12 +1603,14 @@ export interface ConnectedHomeSettings {
|
|
|
1461
1603
|
*/
|
|
1462
1604
|
export interface ConnectedHomeSettingsForUpdate {
|
|
1463
1605
|
/**
|
|
1606
|
+
* @public
|
|
1464
1607
|
* <p>
|
|
1465
1608
|
* Specifies what you want to detect in the video, such as people, packages, or pets. The current valid labels you can include in this list are: "PERSON", "PET", "PACKAGE", and "ALL".
|
|
1466
1609
|
* </p>
|
|
1467
1610
|
*/
|
|
1468
1611
|
Labels?: string[];
|
|
1469
1612
|
/**
|
|
1613
|
+
* @public
|
|
1470
1614
|
* <p>
|
|
1471
1615
|
* The minimum confidence required to label an object in the video.
|
|
1472
1616
|
* </p>
|
|
@@ -1506,6 +1650,7 @@ export type ContentModerationAggregateBy = (typeof ContentModerationAggregateBy)
|
|
|
1506
1650
|
*/
|
|
1507
1651
|
export interface ModerationLabel {
|
|
1508
1652
|
/**
|
|
1653
|
+
* @public
|
|
1509
1654
|
* <p>Specifies the confidence that Amazon Rekognition has that the label has been correctly
|
|
1510
1655
|
* identified.</p>
|
|
1511
1656
|
* <p>If you don't specify the <code>MinConfidence</code> parameter in the call to
|
|
@@ -1514,10 +1659,12 @@ export interface ModerationLabel {
|
|
|
1514
1659
|
*/
|
|
1515
1660
|
Confidence?: number;
|
|
1516
1661
|
/**
|
|
1662
|
+
* @public
|
|
1517
1663
|
* <p>The label name for the type of unsafe content detected in the image.</p>
|
|
1518
1664
|
*/
|
|
1519
1665
|
Name?: string;
|
|
1520
1666
|
/**
|
|
1667
|
+
* @public
|
|
1521
1668
|
* <p>The name for the parent label. Labels at the top level of the hierarchy have the parent
|
|
1522
1669
|
* label <code>""</code>.</p>
|
|
1523
1670
|
*/
|
|
@@ -1529,25 +1676,30 @@ export interface ModerationLabel {
|
|
|
1529
1676
|
*/
|
|
1530
1677
|
export interface ContentModerationDetection {
|
|
1531
1678
|
/**
|
|
1679
|
+
* @public
|
|
1532
1680
|
* <p>Time, in milliseconds from the beginning of the video, that the content moderation label was detected.
|
|
1533
1681
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the moderated content first appears.</p>
|
|
1534
1682
|
*/
|
|
1535
1683
|
Timestamp?: number;
|
|
1536
1684
|
/**
|
|
1685
|
+
* @public
|
|
1537
1686
|
* <p>The content moderation label detected by in the stored video.</p>
|
|
1538
1687
|
*/
|
|
1539
1688
|
ModerationLabel?: ModerationLabel;
|
|
1540
1689
|
/**
|
|
1690
|
+
* @public
|
|
1541
1691
|
* <p>The time in milliseconds defining the start of the timeline
|
|
1542
1692
|
* segment containing a continuously detected moderation label.</p>
|
|
1543
1693
|
*/
|
|
1544
1694
|
StartTimestampMillis?: number;
|
|
1545
1695
|
/**
|
|
1696
|
+
* @public
|
|
1546
1697
|
* <p> The time in milliseconds defining the end of the
|
|
1547
1698
|
* timeline segment containing a continuously detected moderation label. </p>
|
|
1548
1699
|
*/
|
|
1549
1700
|
EndTimestampMillis?: number;
|
|
1550
1701
|
/**
|
|
1702
|
+
* @public
|
|
1551
1703
|
* <p> The time duration of a segment in milliseconds,
|
|
1552
1704
|
* I.e. time elapsed from StartTimestampMillis to EndTimestampMillis. </p>
|
|
1553
1705
|
*/
|
|
@@ -1571,10 +1723,12 @@ export type ContentModerationSortBy = (typeof ContentModerationSortBy)[keyof typ
|
|
|
1571
1723
|
*/
|
|
1572
1724
|
export interface OutputConfig {
|
|
1573
1725
|
/**
|
|
1726
|
+
* @public
|
|
1574
1727
|
* <p>The S3 bucket where training output is placed.</p>
|
|
1575
1728
|
*/
|
|
1576
1729
|
S3Bucket?: string;
|
|
1577
1730
|
/**
|
|
1731
|
+
* @public
|
|
1578
1732
|
* <p>The prefix applied to the training output files. </p>
|
|
1579
1733
|
*/
|
|
1580
1734
|
S3KeyPrefix?: string;
|
|
@@ -1584,30 +1738,37 @@ export interface OutputConfig {
|
|
|
1584
1738
|
*/
|
|
1585
1739
|
export interface CopyProjectVersionRequest {
|
|
1586
1740
|
/**
|
|
1741
|
+
* @public
|
|
1587
1742
|
* <p>The ARN of the source project in the trusting AWS account.</p>
|
|
1588
1743
|
*/
|
|
1589
1744
|
SourceProjectArn: string | undefined;
|
|
1590
1745
|
/**
|
|
1746
|
+
* @public
|
|
1591
1747
|
* <p>The ARN of the model version in the source project that you want to copy to a destination project.</p>
|
|
1592
1748
|
*/
|
|
1593
1749
|
SourceProjectVersionArn: string | undefined;
|
|
1594
1750
|
/**
|
|
1751
|
+
* @public
|
|
1595
1752
|
* <p>The ARN of the project in the trusted AWS account that you want to copy the model version to. </p>
|
|
1596
1753
|
*/
|
|
1597
1754
|
DestinationProjectArn: string | undefined;
|
|
1598
1755
|
/**
|
|
1756
|
+
* @public
|
|
1599
1757
|
* <p>A name for the version of the model that's copied to the destination project.</p>
|
|
1600
1758
|
*/
|
|
1601
1759
|
VersionName: string | undefined;
|
|
1602
1760
|
/**
|
|
1761
|
+
* @public
|
|
1603
1762
|
* <p>The S3 bucket and folder location where the training output for the source model version is placed.</p>
|
|
1604
1763
|
*/
|
|
1605
1764
|
OutputConfig: OutputConfig | undefined;
|
|
1606
1765
|
/**
|
|
1766
|
+
* @public
|
|
1607
1767
|
* <p>The key-value tags to assign to the model version. </p>
|
|
1608
1768
|
*/
|
|
1609
1769
|
Tags?: Record<string, string>;
|
|
1610
1770
|
/**
|
|
1771
|
+
* @public
|
|
1611
1772
|
* <p>The identifier for your AWS Key Management Service key (AWS KMS key).
|
|
1612
1773
|
* You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,
|
|
1613
1774
|
* an alias for your KMS key, or an alias ARN.
|
|
@@ -1638,6 +1799,7 @@ export interface CopyProjectVersionRequest {
|
|
|
1638
1799
|
*/
|
|
1639
1800
|
export interface CopyProjectVersionResponse {
|
|
1640
1801
|
/**
|
|
1802
|
+
* @public
|
|
1641
1803
|
* <p>The ARN of the copied model version in the destination project. </p>
|
|
1642
1804
|
*/
|
|
1643
1805
|
ProjectVersionArn?: string;
|
|
@@ -1654,6 +1816,7 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1654
1816
|
Message?: string;
|
|
1655
1817
|
Code?: string;
|
|
1656
1818
|
/**
|
|
1819
|
+
* @public
|
|
1657
1820
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1658
1821
|
*/
|
|
1659
1822
|
Logref?: string;
|
|
@@ -1672,6 +1835,7 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
1672
1835
|
Message?: string;
|
|
1673
1836
|
Code?: string;
|
|
1674
1837
|
/**
|
|
1838
|
+
* @public
|
|
1675
1839
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1676
1840
|
*/
|
|
1677
1841
|
Logref?: string;
|
|
@@ -1685,10 +1849,12 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
1685
1849
|
*/
|
|
1686
1850
|
export interface CreateCollectionRequest {
|
|
1687
1851
|
/**
|
|
1852
|
+
* @public
|
|
1688
1853
|
* <p>ID for the collection that you are creating.</p>
|
|
1689
1854
|
*/
|
|
1690
1855
|
CollectionId: string | undefined;
|
|
1691
1856
|
/**
|
|
1857
|
+
* @public
|
|
1692
1858
|
* <p> A set of tags (key-value pairs) that you want to attach to the collection. </p>
|
|
1693
1859
|
*/
|
|
1694
1860
|
Tags?: Record<string, string>;
|
|
@@ -1698,15 +1864,18 @@ export interface CreateCollectionRequest {
|
|
|
1698
1864
|
*/
|
|
1699
1865
|
export interface CreateCollectionResponse {
|
|
1700
1866
|
/**
|
|
1867
|
+
* @public
|
|
1701
1868
|
* <p>HTTP status code indicating the result of the operation.</p>
|
|
1702
1869
|
*/
|
|
1703
1870
|
StatusCode?: number;
|
|
1704
1871
|
/**
|
|
1872
|
+
* @public
|
|
1705
1873
|
* <p>Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on
|
|
1706
1874
|
* your resources. </p>
|
|
1707
1875
|
*/
|
|
1708
1876
|
CollectionArn?: string;
|
|
1709
1877
|
/**
|
|
1878
|
+
* @public
|
|
1710
1879
|
* <p>Version number of the face detection model associated with the collection you are
|
|
1711
1880
|
* creating.</p>
|
|
1712
1881
|
*/
|
|
@@ -1722,6 +1891,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1722
1891
|
Message?: string;
|
|
1723
1892
|
Code?: string;
|
|
1724
1893
|
/**
|
|
1894
|
+
* @public
|
|
1725
1895
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1726
1896
|
*/
|
|
1727
1897
|
Logref?: string;
|
|
@@ -1745,11 +1915,13 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
|
|
|
1745
1915
|
*/
|
|
1746
1916
|
export interface DatasetSource {
|
|
1747
1917
|
/**
|
|
1918
|
+
* @public
|
|
1748
1919
|
* <p>The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
|
|
1749
1920
|
* </p>
|
|
1750
1921
|
*/
|
|
1751
1922
|
GroundTruthManifest?: GroundTruthManifest;
|
|
1752
1923
|
/**
|
|
1924
|
+
* @public
|
|
1753
1925
|
* <p>
|
|
1754
1926
|
* The ARN of an Amazon Rekognition Custom Labels dataset that you want to copy.
|
|
1755
1927
|
* </p>
|
|
@@ -1773,6 +1945,7 @@ export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
|
|
|
1773
1945
|
*/
|
|
1774
1946
|
export interface CreateDatasetRequest {
|
|
1775
1947
|
/**
|
|
1948
|
+
* @public
|
|
1776
1949
|
* <p>
|
|
1777
1950
|
* The source files for the dataset. You can specify the ARN of an existing dataset or specify the Amazon S3 bucket location
|
|
1778
1951
|
* of an Amazon Sagemaker format manifest file. If you don't specify <code>datasetSource</code>, an empty dataset is created.
|
|
@@ -1782,6 +1955,7 @@ export interface CreateDatasetRequest {
|
|
|
1782
1955
|
*/
|
|
1783
1956
|
DatasetSource?: DatasetSource;
|
|
1784
1957
|
/**
|
|
1958
|
+
* @public
|
|
1785
1959
|
* <p>
|
|
1786
1960
|
* The type of the dataset. Specify <code>train</code> to create a training dataset. Specify <code>test</code>
|
|
1787
1961
|
* to create a test dataset.
|
|
@@ -1789,6 +1963,7 @@ export interface CreateDatasetRequest {
|
|
|
1789
1963
|
*/
|
|
1790
1964
|
DatasetType: DatasetType | string | undefined;
|
|
1791
1965
|
/**
|
|
1966
|
+
* @public
|
|
1792
1967
|
* <p>
|
|
1793
1968
|
* The ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.
|
|
1794
1969
|
* </p>
|
|
@@ -1800,6 +1975,7 @@ export interface CreateDatasetRequest {
|
|
|
1800
1975
|
*/
|
|
1801
1976
|
export interface CreateDatasetResponse {
|
|
1802
1977
|
/**
|
|
1978
|
+
* @public
|
|
1803
1979
|
* <p>
|
|
1804
1980
|
* The ARN of the created Amazon Rekognition Custom Labels dataset.
|
|
1805
1981
|
* </p>
|
|
@@ -1815,10 +1991,12 @@ export interface CreateDatasetResponse {
|
|
|
1815
1991
|
*/
|
|
1816
1992
|
export interface LivenessOutputConfig {
|
|
1817
1993
|
/**
|
|
1994
|
+
* @public
|
|
1818
1995
|
* <p>The path to an AWS Amazon S3 bucket used to store Face Liveness session results.</p>
|
|
1819
1996
|
*/
|
|
1820
1997
|
S3Bucket: string | undefined;
|
|
1821
1998
|
/**
|
|
1999
|
+
* @public
|
|
1822
2000
|
* <p>The prefix prepended to the output files for the Face Liveness session results.</p>
|
|
1823
2001
|
*/
|
|
1824
2002
|
S3KeyPrefix?: string;
|
|
@@ -1830,6 +2008,7 @@ export interface LivenessOutputConfig {
|
|
|
1830
2008
|
*/
|
|
1831
2009
|
export interface CreateFaceLivenessSessionRequestSettings {
|
|
1832
2010
|
/**
|
|
2011
|
+
* @public
|
|
1833
2012
|
* <p>Can specify the location of an Amazon S3 bucket, where reference and audit images will be
|
|
1834
2013
|
* stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the
|
|
1835
2014
|
* same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are
|
|
@@ -1838,6 +2017,7 @@ export interface CreateFaceLivenessSessionRequestSettings {
|
|
|
1838
2017
|
*/
|
|
1839
2018
|
OutputConfig?: LivenessOutputConfig;
|
|
1840
2019
|
/**
|
|
2020
|
+
* @public
|
|
1841
2021
|
* <p>Number of audit images to be returned back. Takes an integer between 0-4. Any integer less
|
|
1842
2022
|
* than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it
|
|
1843
2023
|
* is set to 0. The limit is best effort and is based on the actual duration of the
|
|
@@ -1850,16 +2030,19 @@ export interface CreateFaceLivenessSessionRequestSettings {
|
|
|
1850
2030
|
*/
|
|
1851
2031
|
export interface CreateFaceLivenessSessionRequest {
|
|
1852
2032
|
/**
|
|
2033
|
+
* @public
|
|
1853
2034
|
* <p> The identifier for your AWS Key Management Service key (AWS KMS key).
|
|
1854
2035
|
* Used to encrypt audit images and reference images.</p>
|
|
1855
2036
|
*/
|
|
1856
2037
|
KmsKeyId?: string;
|
|
1857
2038
|
/**
|
|
2039
|
+
* @public
|
|
1858
2040
|
* <p>A session settings object. It contains settings for the operation to be performed. For
|
|
1859
2041
|
* Face Liveness, it accepts <code>OutputConfig</code> and <code>AuditImagesLimit</code>.</p>
|
|
1860
2042
|
*/
|
|
1861
2043
|
Settings?: CreateFaceLivenessSessionRequestSettings;
|
|
1862
2044
|
/**
|
|
2045
|
+
* @public
|
|
1863
2046
|
* <p>Idempotent token is used to recognize the Face Liveness request. If the same token is used
|
|
1864
2047
|
* with multiple <code>CreateFaceLivenessSession</code> requests, the same session is returned.
|
|
1865
2048
|
* This token is employed to avoid unintentionally creating the same session multiple
|
|
@@ -1872,6 +2055,7 @@ export interface CreateFaceLivenessSessionRequest {
|
|
|
1872
2055
|
*/
|
|
1873
2056
|
export interface CreateFaceLivenessSessionResponse {
|
|
1874
2057
|
/**
|
|
2058
|
+
* @public
|
|
1875
2059
|
* <p>A unique 128-bit UUID identifying a Face Liveness session.</p>
|
|
1876
2060
|
*/
|
|
1877
2061
|
SessionId: string | undefined;
|
|
@@ -1881,6 +2065,7 @@ export interface CreateFaceLivenessSessionResponse {
|
|
|
1881
2065
|
*/
|
|
1882
2066
|
export interface CreateProjectRequest {
|
|
1883
2067
|
/**
|
|
2068
|
+
* @public
|
|
1884
2069
|
* <p>The name of the project to create.</p>
|
|
1885
2070
|
*/
|
|
1886
2071
|
ProjectName: string | undefined;
|
|
@@ -1890,6 +2075,7 @@ export interface CreateProjectRequest {
|
|
|
1890
2075
|
*/
|
|
1891
2076
|
export interface CreateProjectResponse {
|
|
1892
2077
|
/**
|
|
2078
|
+
* @public
|
|
1893
2079
|
* <p>The Amazon Resource Name (ARN) of the new project. You can use the ARN to
|
|
1894
2080
|
* configure IAM access to the project. </p>
|
|
1895
2081
|
*/
|
|
@@ -1902,10 +2088,12 @@ export interface CreateProjectResponse {
|
|
|
1902
2088
|
*/
|
|
1903
2089
|
export interface TestingData {
|
|
1904
2090
|
/**
|
|
2091
|
+
* @public
|
|
1905
2092
|
* <p>The assets used for testing.</p>
|
|
1906
2093
|
*/
|
|
1907
2094
|
Assets?: Asset[];
|
|
1908
2095
|
/**
|
|
2096
|
+
* @public
|
|
1909
2097
|
* <p>If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset (80%) to create a test dataset (20%) for the training job.
|
|
1910
2098
|
* After training completes, the test dataset is not stored and the training dataset reverts to its previous size.</p>
|
|
1911
2099
|
*/
|
|
@@ -1917,6 +2105,7 @@ export interface TestingData {
|
|
|
1917
2105
|
*/
|
|
1918
2106
|
export interface TrainingData {
|
|
1919
2107
|
/**
|
|
2108
|
+
* @public
|
|
1920
2109
|
* <p>A Sagemaker GroundTruth manifest file that contains the training images (assets).</p>
|
|
1921
2110
|
*/
|
|
1922
2111
|
Assets?: Asset[];
|
|
@@ -1926,21 +2115,25 @@ export interface TrainingData {
|
|
|
1926
2115
|
*/
|
|
1927
2116
|
export interface CreateProjectVersionRequest {
|
|
1928
2117
|
/**
|
|
2118
|
+
* @public
|
|
1929
2119
|
* <p>The ARN of the Amazon Rekognition Custom Labels project that
|
|
1930
2120
|
* manages the model that you want to train.</p>
|
|
1931
2121
|
*/
|
|
1932
2122
|
ProjectArn: string | undefined;
|
|
1933
2123
|
/**
|
|
2124
|
+
* @public
|
|
1934
2125
|
* <p>A name for the version of the model. This value must be unique.</p>
|
|
1935
2126
|
*/
|
|
1936
2127
|
VersionName: string | undefined;
|
|
1937
2128
|
/**
|
|
2129
|
+
* @public
|
|
1938
2130
|
* <p>The Amazon S3 bucket location to store the results of training.
|
|
1939
2131
|
* The S3 bucket can be in any AWS account as long as the caller has
|
|
1940
2132
|
* <code>s3:PutObject</code> permissions on the S3 bucket.</p>
|
|
1941
2133
|
*/
|
|
1942
2134
|
OutputConfig: OutputConfig | undefined;
|
|
1943
2135
|
/**
|
|
2136
|
+
* @public
|
|
1944
2137
|
* <p>Specifies an external manifest that the services uses to train the model.
|
|
1945
2138
|
* If you specify <code>TrainingData</code> you must also specify <code>TestingData</code>.
|
|
1946
2139
|
* The project must not have any associated datasets.
|
|
@@ -1948,16 +2141,19 @@ export interface CreateProjectVersionRequest {
|
|
|
1948
2141
|
*/
|
|
1949
2142
|
TrainingData?: TrainingData;
|
|
1950
2143
|
/**
|
|
2144
|
+
* @public
|
|
1951
2145
|
* <p>Specifies an external manifest that the service uses to test the model.
|
|
1952
2146
|
* If you specify <code>TestingData</code> you must also specify <code>TrainingData</code>.
|
|
1953
2147
|
* The project must not have any associated datasets.</p>
|
|
1954
2148
|
*/
|
|
1955
2149
|
TestingData?: TestingData;
|
|
1956
2150
|
/**
|
|
2151
|
+
* @public
|
|
1957
2152
|
* <p> A set of tags (key-value pairs) that you want to attach to the model. </p>
|
|
1958
2153
|
*/
|
|
1959
2154
|
Tags?: Record<string, string>;
|
|
1960
2155
|
/**
|
|
2156
|
+
* @public
|
|
1961
2157
|
* <p>The identifier for your AWS Key Management Service key (AWS KMS key).
|
|
1962
2158
|
* You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key,
|
|
1963
2159
|
* an alias for your KMS key, or an alias ARN.
|
|
@@ -1989,6 +2185,7 @@ export interface CreateProjectVersionRequest {
|
|
|
1989
2185
|
*/
|
|
1990
2186
|
export interface CreateProjectVersionResponse {
|
|
1991
2187
|
/**
|
|
2188
|
+
* @public
|
|
1992
2189
|
* <p>The ARN of the model version that was created. Use <code>DescribeProjectVersion</code>
|
|
1993
2190
|
* to get the current status of the training operation.</p>
|
|
1994
2191
|
*/
|
|
@@ -2004,6 +2201,7 @@ export interface CreateProjectVersionResponse {
|
|
|
2004
2201
|
*/
|
|
2005
2202
|
export interface StreamProcessorDataSharingPreference {
|
|
2006
2203
|
/**
|
|
2204
|
+
* @public
|
|
2007
2205
|
* <p>
|
|
2008
2206
|
* If this option is set to true, you choose to share data with Rekognition to improve model performance.
|
|
2009
2207
|
* </p>
|
|
@@ -2017,6 +2215,7 @@ export interface StreamProcessorDataSharingPreference {
|
|
|
2017
2215
|
*/
|
|
2018
2216
|
export interface KinesisVideoStream {
|
|
2019
2217
|
/**
|
|
2218
|
+
* @public
|
|
2020
2219
|
* <p>ARN of the Kinesis video stream stream that streams the source video.</p>
|
|
2021
2220
|
*/
|
|
2022
2221
|
Arn?: string;
|
|
@@ -2027,6 +2226,7 @@ export interface KinesisVideoStream {
|
|
|
2027
2226
|
*/
|
|
2028
2227
|
export interface StreamProcessorInput {
|
|
2029
2228
|
/**
|
|
2229
|
+
* @public
|
|
2030
2230
|
* <p>The Kinesis video stream input stream for the source streaming video.</p>
|
|
2031
2231
|
*/
|
|
2032
2232
|
KinesisVideoStream?: KinesisVideoStream;
|
|
@@ -2041,6 +2241,7 @@ export interface StreamProcessorInput {
|
|
|
2041
2241
|
*/
|
|
2042
2242
|
export interface StreamProcessorNotificationChannel {
|
|
2043
2243
|
/**
|
|
2244
|
+
* @public
|
|
2044
2245
|
* <p>
|
|
2045
2246
|
* The Amazon Resource Number (ARN) of the Amazon Amazon Simple Notification Service topic to which Amazon Rekognition posts the completion status.
|
|
2046
2247
|
* </p>
|
|
@@ -2054,6 +2255,7 @@ export interface StreamProcessorNotificationChannel {
|
|
|
2054
2255
|
*/
|
|
2055
2256
|
export interface KinesisDataStream {
|
|
2056
2257
|
/**
|
|
2258
|
+
* @public
|
|
2057
2259
|
* <p>ARN of the output Amazon Kinesis Data Streams stream.</p>
|
|
2058
2260
|
*/
|
|
2059
2261
|
Arn?: string;
|
|
@@ -2068,12 +2270,14 @@ export interface KinesisDataStream {
|
|
|
2068
2270
|
*/
|
|
2069
2271
|
export interface S3Destination {
|
|
2070
2272
|
/**
|
|
2273
|
+
* @public
|
|
2071
2274
|
* <p>
|
|
2072
2275
|
* The name of the Amazon S3 bucket you want to associate with the streaming video project. You must be the owner of the Amazon S3 bucket.
|
|
2073
2276
|
* </p>
|
|
2074
2277
|
*/
|
|
2075
2278
|
Bucket?: string;
|
|
2076
2279
|
/**
|
|
2280
|
+
* @public
|
|
2077
2281
|
* <p>
|
|
2078
2282
|
* The prefix value of the location within the bucket that you want the information to be published to.
|
|
2079
2283
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Using prefixes</a>.
|
|
@@ -2088,10 +2292,12 @@ export interface S3Destination {
|
|
|
2088
2292
|
*/
|
|
2089
2293
|
export interface StreamProcessorOutput {
|
|
2090
2294
|
/**
|
|
2295
|
+
* @public
|
|
2091
2296
|
* <p>The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.</p>
|
|
2092
2297
|
*/
|
|
2093
2298
|
KinesisDataStream?: KinesisDataStream;
|
|
2094
2299
|
/**
|
|
2300
|
+
* @public
|
|
2095
2301
|
* <p>
|
|
2096
2302
|
* The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
|
|
2097
2303
|
* </p>
|
|
@@ -2111,10 +2317,12 @@ export interface StreamProcessorOutput {
|
|
|
2111
2317
|
*/
|
|
2112
2318
|
export interface Point {
|
|
2113
2319
|
/**
|
|
2320
|
+
* @public
|
|
2114
2321
|
* <p>The value of the X coordinate for a point on a <code>Polygon</code>.</p>
|
|
2115
2322
|
*/
|
|
2116
2323
|
X?: number;
|
|
2117
2324
|
/**
|
|
2325
|
+
* @public
|
|
2118
2326
|
* <p>The value of the Y coordinate for a point on a <code>Polygon</code>.</p>
|
|
2119
2327
|
*/
|
|
2120
2328
|
Y?: number;
|
|
@@ -2129,10 +2337,12 @@ export interface Point {
|
|
|
2129
2337
|
*/
|
|
2130
2338
|
export interface RegionOfInterest {
|
|
2131
2339
|
/**
|
|
2340
|
+
* @public
|
|
2132
2341
|
* <p>The box representing a region of interest on screen.</p>
|
|
2133
2342
|
*/
|
|
2134
2343
|
BoundingBox?: BoundingBox;
|
|
2135
2344
|
/**
|
|
2345
|
+
* @public
|
|
2136
2346
|
* <p>
|
|
2137
2347
|
* Specifies a shape made up of up to 10 <code>Point</code> objects to define a region of interest.
|
|
2138
2348
|
* </p>
|
|
@@ -2147,10 +2357,12 @@ export interface RegionOfInterest {
|
|
|
2147
2357
|
*/
|
|
2148
2358
|
export interface FaceSearchSettings {
|
|
2149
2359
|
/**
|
|
2360
|
+
* @public
|
|
2150
2361
|
* <p>The ID of a collection that contains faces that you want to search for.</p>
|
|
2151
2362
|
*/
|
|
2152
2363
|
CollectionId?: string;
|
|
2153
2364
|
/**
|
|
2365
|
+
* @public
|
|
2154
2366
|
* <p>Minimum face match confidence score that must be met to return a result for a recognized face. The default is 80.
|
|
2155
2367
|
* 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.</p>
|
|
2156
2368
|
*/
|
|
@@ -2163,10 +2375,12 @@ export interface FaceSearchSettings {
|
|
|
2163
2375
|
*/
|
|
2164
2376
|
export interface StreamProcessorSettings {
|
|
2165
2377
|
/**
|
|
2378
|
+
* @public
|
|
2166
2379
|
* <p>Face search settings to use on a streaming video. </p>
|
|
2167
2380
|
*/
|
|
2168
2381
|
FaceSearch?: FaceSearchSettings;
|
|
2169
2382
|
/**
|
|
2383
|
+
* @public
|
|
2170
2384
|
* <p>
|
|
2171
2385
|
* Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.
|
|
2172
2386
|
* Including this setting in the <code>CreateStreamProcessor</code> request enables you to use the stream processor for label detection.
|
|
@@ -2182,15 +2396,18 @@ export interface StreamProcessorSettings {
|
|
|
2182
2396
|
*/
|
|
2183
2397
|
export interface CreateStreamProcessorRequest {
|
|
2184
2398
|
/**
|
|
2399
|
+
* @public
|
|
2185
2400
|
* <p>Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is <code>StreamProcessorInput</code>. This is required for both face search and label detection stream processors.</p>
|
|
2186
2401
|
*/
|
|
2187
2402
|
Input: StreamProcessorInput | undefined;
|
|
2188
2403
|
/**
|
|
2404
|
+
* @public
|
|
2189
2405
|
* <p>Kinesis data stream stream or Amazon S3 bucket location to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is <code>StreamProcessorOutput</code>.
|
|
2190
2406
|
* This must be a <a>S3Destination</a> of an Amazon S3 bucket that you own for a label detection stream processor or a Kinesis data stream ARN for a face search stream processor.</p>
|
|
2191
2407
|
*/
|
|
2192
2408
|
Output: StreamProcessorOutput | undefined;
|
|
2193
2409
|
/**
|
|
2410
|
+
* @public
|
|
2194
2411
|
* <p>An identifier you assign to the stream processor. You can use <code>Name</code> to
|
|
2195
2412
|
* manage the stream processor. For example, you can get the current status of the stream processor by calling <a>DescribeStreamProcessor</a>.
|
|
2196
2413
|
* <code>Name</code> is idempotent. This is required for both face search and label detection stream processors.
|
|
@@ -2198,20 +2415,24 @@ export interface CreateStreamProcessorRequest {
|
|
|
2198
2415
|
*/
|
|
2199
2416
|
Name: string | undefined;
|
|
2200
2417
|
/**
|
|
2418
|
+
* @public
|
|
2201
2419
|
* <p>Input parameters used in a streaming video analyzed by a stream processor. You can use <code>FaceSearch</code> to recognize faces in a streaming video, or you can use <code>ConnectedHome</code> to detect labels.</p>
|
|
2202
2420
|
*/
|
|
2203
2421
|
Settings: StreamProcessorSettings | undefined;
|
|
2204
2422
|
/**
|
|
2423
|
+
* @public
|
|
2205
2424
|
* <p>The Amazon Resource Number (ARN) of the IAM role that allows access to the stream processor.
|
|
2206
2425
|
* The IAM role provides Rekognition read permissions for a Kinesis stream.
|
|
2207
2426
|
* It also provides write permissions to an Amazon S3 bucket and Amazon Simple Notification Service topic for a label detection stream processor. This is required for both face search and label detection stream processors.</p>
|
|
2208
2427
|
*/
|
|
2209
2428
|
RoleArn: string | undefined;
|
|
2210
2429
|
/**
|
|
2430
|
+
* @public
|
|
2211
2431
|
* <p> A set of tags (key-value pairs) that you want to attach to the stream processor. </p>
|
|
2212
2432
|
*/
|
|
2213
2433
|
Tags?: Record<string, string>;
|
|
2214
2434
|
/**
|
|
2435
|
+
* @public
|
|
2215
2436
|
* <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.</p>
|
|
2216
2437
|
* <p>Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition
|
|
2217
2438
|
* detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,
|
|
@@ -2220,6 +2441,7 @@ export interface CreateStreamProcessorRequest {
|
|
|
2220
2441
|
*/
|
|
2221
2442
|
NotificationChannel?: StreamProcessorNotificationChannel;
|
|
2222
2443
|
/**
|
|
2444
|
+
* @public
|
|
2223
2445
|
* <p>
|
|
2224
2446
|
* The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
|
|
2225
2447
|
* You can supply the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for your KMS key, or an alias ARN.
|
|
@@ -2230,12 +2452,14 @@ export interface CreateStreamProcessorRequest {
|
|
|
2230
2452
|
*/
|
|
2231
2453
|
KmsKeyId?: string;
|
|
2232
2454
|
/**
|
|
2455
|
+
* @public
|
|
2233
2456
|
* <p>
|
|
2234
2457
|
* Specifies locations in the frames where Amazon Rekognition checks for objects or people. You can specify up to 10 regions of interest, and each region has either a polygon or a bounding box. This is an optional parameter for label detection stream processors and should not be used to create a face search stream processor.
|
|
2235
2458
|
* </p>
|
|
2236
2459
|
*/
|
|
2237
2460
|
RegionsOfInterest?: RegionOfInterest[];
|
|
2238
2461
|
/**
|
|
2462
|
+
* @public
|
|
2239
2463
|
* <p>
|
|
2240
2464
|
* Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
|
|
2241
2465
|
* Note that if you opt out at the account level this setting is ignored on individual streams.
|
|
@@ -2248,6 +2472,7 @@ export interface CreateStreamProcessorRequest {
|
|
|
2248
2472
|
*/
|
|
2249
2473
|
export interface CreateStreamProcessorResponse {
|
|
2250
2474
|
/**
|
|
2475
|
+
* @public
|
|
2251
2476
|
* <p>Amazon Resource Number for the newly created stream processor.</p>
|
|
2252
2477
|
*/
|
|
2253
2478
|
StreamProcessorArn?: string;
|
|
@@ -2257,14 +2482,17 @@ export interface CreateStreamProcessorResponse {
|
|
|
2257
2482
|
*/
|
|
2258
2483
|
export interface CreateUserRequest {
|
|
2259
2484
|
/**
|
|
2485
|
+
* @public
|
|
2260
2486
|
* <p>The ID of an existing collection to which the new UserID needs to be created.</p>
|
|
2261
2487
|
*/
|
|
2262
2488
|
CollectionId: string | undefined;
|
|
2263
2489
|
/**
|
|
2490
|
+
* @public
|
|
2264
2491
|
* <p>ID for the UserID to be created. This ID needs to be unique within the collection.</p>
|
|
2265
2492
|
*/
|
|
2266
2493
|
UserId: string | undefined;
|
|
2267
2494
|
/**
|
|
2495
|
+
* @public
|
|
2268
2496
|
* <p>Idempotent token used to identify the request to <code>CreateUser</code>. If you use the
|
|
2269
2497
|
* same token with multiple <code>CreateUser</code> requests, the same response is returned.
|
|
2270
2498
|
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
@@ -2283,11 +2511,13 @@ export interface CreateUserResponse {
|
|
|
2283
2511
|
*/
|
|
2284
2512
|
export interface Geometry {
|
|
2285
2513
|
/**
|
|
2514
|
+
* @public
|
|
2286
2515
|
* <p>An axis-aligned coarse representation of the detected item's location on the
|
|
2287
2516
|
* image.</p>
|
|
2288
2517
|
*/
|
|
2289
2518
|
BoundingBox?: BoundingBox;
|
|
2290
2519
|
/**
|
|
2520
|
+
* @public
|
|
2291
2521
|
* <p>Within the bounding box, a fine-grained polygon around the detected item.</p>
|
|
2292
2522
|
*/
|
|
2293
2523
|
Polygon?: Point[];
|
|
@@ -2298,15 +2528,18 @@ export interface Geometry {
|
|
|
2298
2528
|
*/
|
|
2299
2529
|
export interface CustomLabel {
|
|
2300
2530
|
/**
|
|
2531
|
+
* @public
|
|
2301
2532
|
* <p>The name of the custom label.</p>
|
|
2302
2533
|
*/
|
|
2303
2534
|
Name?: string;
|
|
2304
2535
|
/**
|
|
2536
|
+
* @public
|
|
2305
2537
|
* <p>The confidence that the model has in the detection of the custom label. The
|
|
2306
2538
|
* range is 0-100. A higher value indicates a higher confidence.</p>
|
|
2307
2539
|
*/
|
|
2308
2540
|
Confidence?: number;
|
|
2309
2541
|
/**
|
|
2542
|
+
* @public
|
|
2310
2543
|
* <p>The location of the detected object on the image that corresponds to the custom label.
|
|
2311
2544
|
* Includes an axis aligned coarse bounding box surrounding the object and a finer grain polygon
|
|
2312
2545
|
* for more accurate spatial information.</p>
|
|
@@ -2323,6 +2556,7 @@ export interface CustomLabel {
|
|
|
2323
2556
|
*/
|
|
2324
2557
|
export interface DatasetChanges {
|
|
2325
2558
|
/**
|
|
2559
|
+
* @public
|
|
2326
2560
|
* <p>A Base64-encoded binary data object
|
|
2327
2561
|
* containing one or JSON lines that either update the dataset or are additions to the dataset. You change a dataset by calling <a>UpdateDatasetEntries</a>.
|
|
2328
2562
|
* If you are using an AWS SDK to call <code>UpdateDatasetEntries</code>, you don't need to encode <code>Changes</code> as the SDK encodes the data for you.
|
|
@@ -2344,24 +2578,28 @@ export interface DatasetChanges {
|
|
|
2344
2578
|
*/
|
|
2345
2579
|
export interface DatasetStats {
|
|
2346
2580
|
/**
|
|
2581
|
+
* @public
|
|
2347
2582
|
* <p>
|
|
2348
2583
|
* The total number of images in the dataset that have labels.
|
|
2349
2584
|
* </p>
|
|
2350
2585
|
*/
|
|
2351
2586
|
LabeledEntries?: number;
|
|
2352
2587
|
/**
|
|
2588
|
+
* @public
|
|
2353
2589
|
* <p>
|
|
2354
2590
|
* The total number of images in the dataset.
|
|
2355
2591
|
* </p>
|
|
2356
2592
|
*/
|
|
2357
2593
|
TotalEntries?: number;
|
|
2358
2594
|
/**
|
|
2595
|
+
* @public
|
|
2359
2596
|
* <p>
|
|
2360
2597
|
* The total number of labels declared in the dataset.
|
|
2361
2598
|
* </p>
|
|
2362
2599
|
*/
|
|
2363
2600
|
TotalLabels?: number;
|
|
2364
2601
|
/**
|
|
2602
|
+
* @public
|
|
2365
2603
|
* <p>
|
|
2366
2604
|
* The total number of entries that contain at least one error.
|
|
2367
2605
|
* </p>
|
|
@@ -2408,30 +2646,35 @@ export type DatasetStatusMessageCode = (typeof DatasetStatusMessageCode)[keyof t
|
|
|
2408
2646
|
*/
|
|
2409
2647
|
export interface DatasetDescription {
|
|
2410
2648
|
/**
|
|
2649
|
+
* @public
|
|
2411
2650
|
* <p>
|
|
2412
2651
|
* The Unix timestamp for the time and date that the dataset was created.
|
|
2413
2652
|
* </p>
|
|
2414
2653
|
*/
|
|
2415
2654
|
CreationTimestamp?: Date;
|
|
2416
2655
|
/**
|
|
2656
|
+
* @public
|
|
2417
2657
|
* <p>
|
|
2418
2658
|
* The Unix timestamp for the date and time that the dataset was last updated.
|
|
2419
2659
|
* </p>
|
|
2420
2660
|
*/
|
|
2421
2661
|
LastUpdatedTimestamp?: Date;
|
|
2422
2662
|
/**
|
|
2663
|
+
* @public
|
|
2423
2664
|
* <p>
|
|
2424
2665
|
* The status of the dataset.
|
|
2425
2666
|
* </p>
|
|
2426
2667
|
*/
|
|
2427
2668
|
Status?: DatasetStatus | string;
|
|
2428
2669
|
/**
|
|
2670
|
+
* @public
|
|
2429
2671
|
* <p>
|
|
2430
2672
|
* The status message for the dataset.
|
|
2431
2673
|
* </p>
|
|
2432
2674
|
*/
|
|
2433
2675
|
StatusMessage?: string;
|
|
2434
2676
|
/**
|
|
2677
|
+
* @public
|
|
2435
2678
|
* <p>
|
|
2436
2679
|
* The status message code for the dataset operation. If a service error occurs, try the
|
|
2437
2680
|
* API call again later. If a client error occurs, check the input parameters to the dataset
|
|
@@ -2440,6 +2683,7 @@ export interface DatasetDescription {
|
|
|
2440
2683
|
*/
|
|
2441
2684
|
StatusMessageCode?: DatasetStatusMessageCode | string;
|
|
2442
2685
|
/**
|
|
2686
|
+
* @public
|
|
2443
2687
|
* <p>
|
|
2444
2688
|
* The status message code for the dataset.
|
|
2445
2689
|
* </p>
|
|
@@ -2454,12 +2698,14 @@ export interface DatasetDescription {
|
|
|
2454
2698
|
*/
|
|
2455
2699
|
export interface DatasetLabelStats {
|
|
2456
2700
|
/**
|
|
2701
|
+
* @public
|
|
2457
2702
|
* <p>
|
|
2458
2703
|
* The total number of images that use the label.
|
|
2459
2704
|
* </p>
|
|
2460
2705
|
*/
|
|
2461
2706
|
EntryCount?: number;
|
|
2462
2707
|
/**
|
|
2708
|
+
* @public
|
|
2463
2709
|
* <p>
|
|
2464
2710
|
* The total number of images that have the label assigned to a bounding box.
|
|
2465
2711
|
* </p>
|
|
@@ -2474,12 +2720,14 @@ export interface DatasetLabelStats {
|
|
|
2474
2720
|
*/
|
|
2475
2721
|
export interface DatasetLabelDescription {
|
|
2476
2722
|
/**
|
|
2723
|
+
* @public
|
|
2477
2724
|
* <p>
|
|
2478
2725
|
* The name of the label.
|
|
2479
2726
|
* </p>
|
|
2480
2727
|
*/
|
|
2481
2728
|
LabelName?: string;
|
|
2482
2729
|
/**
|
|
2730
|
+
* @public
|
|
2483
2731
|
* <p>
|
|
2484
2732
|
* Statistics about the label.
|
|
2485
2733
|
* </p>
|
|
@@ -2495,36 +2743,42 @@ export interface DatasetLabelDescription {
|
|
|
2495
2743
|
*/
|
|
2496
2744
|
export interface DatasetMetadata {
|
|
2497
2745
|
/**
|
|
2746
|
+
* @public
|
|
2498
2747
|
* <p>
|
|
2499
2748
|
* The Unix timestamp for the date and time that the dataset was created.
|
|
2500
2749
|
* </p>
|
|
2501
2750
|
*/
|
|
2502
2751
|
CreationTimestamp?: Date;
|
|
2503
2752
|
/**
|
|
2753
|
+
* @public
|
|
2504
2754
|
* <p>
|
|
2505
2755
|
* The type of the dataset.
|
|
2506
2756
|
* </p>
|
|
2507
2757
|
*/
|
|
2508
2758
|
DatasetType?: DatasetType | string;
|
|
2509
2759
|
/**
|
|
2760
|
+
* @public
|
|
2510
2761
|
* <p>
|
|
2511
2762
|
* The Amazon Resource Name (ARN) for the dataset.
|
|
2512
2763
|
* </p>
|
|
2513
2764
|
*/
|
|
2514
2765
|
DatasetArn?: string;
|
|
2515
2766
|
/**
|
|
2767
|
+
* @public
|
|
2516
2768
|
* <p>
|
|
2517
2769
|
* The status for the dataset.
|
|
2518
2770
|
* </p>
|
|
2519
2771
|
*/
|
|
2520
2772
|
Status?: DatasetStatus | string;
|
|
2521
2773
|
/**
|
|
2774
|
+
* @public
|
|
2522
2775
|
* <p>
|
|
2523
2776
|
* The status message for the dataset.
|
|
2524
2777
|
* </p>
|
|
2525
2778
|
*/
|
|
2526
2779
|
StatusMessage?: string;
|
|
2527
2780
|
/**
|
|
2781
|
+
* @public
|
|
2528
2782
|
* <p>
|
|
2529
2783
|
* The status message code for the dataset operation. If a service error occurs, try the
|
|
2530
2784
|
* API call again later. If a client error occurs, check the input parameters to the dataset
|
|
@@ -2538,6 +2792,7 @@ export interface DatasetMetadata {
|
|
|
2538
2792
|
*/
|
|
2539
2793
|
export interface DeleteCollectionRequest {
|
|
2540
2794
|
/**
|
|
2795
|
+
* @public
|
|
2541
2796
|
* <p>ID of the collection to delete.</p>
|
|
2542
2797
|
*/
|
|
2543
2798
|
CollectionId: string | undefined;
|
|
@@ -2547,6 +2802,7 @@ export interface DeleteCollectionRequest {
|
|
|
2547
2802
|
*/
|
|
2548
2803
|
export interface DeleteCollectionResponse {
|
|
2549
2804
|
/**
|
|
2805
|
+
* @public
|
|
2550
2806
|
* <p>HTTP status code that indicates the result of the operation.</p>
|
|
2551
2807
|
*/
|
|
2552
2808
|
StatusCode?: number;
|
|
@@ -2556,6 +2812,7 @@ export interface DeleteCollectionResponse {
|
|
|
2556
2812
|
*/
|
|
2557
2813
|
export interface DeleteDatasetRequest {
|
|
2558
2814
|
/**
|
|
2815
|
+
* @public
|
|
2559
2816
|
* <p>
|
|
2560
2817
|
* The ARN of the Amazon Rekognition Custom Labels dataset that you want to delete.
|
|
2561
2818
|
* </p>
|
|
@@ -2572,10 +2829,12 @@ export interface DeleteDatasetResponse {
|
|
|
2572
2829
|
*/
|
|
2573
2830
|
export interface DeleteFacesRequest {
|
|
2574
2831
|
/**
|
|
2832
|
+
* @public
|
|
2575
2833
|
* <p>Collection from which to remove the specific faces.</p>
|
|
2576
2834
|
*/
|
|
2577
2835
|
CollectionId: string | undefined;
|
|
2578
2836
|
/**
|
|
2837
|
+
* @public
|
|
2579
2838
|
* <p>An array of face IDs to delete.</p>
|
|
2580
2839
|
*/
|
|
2581
2840
|
FaceIds: string[] | undefined;
|
|
@@ -2598,14 +2857,17 @@ export type UnsuccessfulFaceDeletionReason = (typeof UnsuccessfulFaceDeletionRea
|
|
|
2598
2857
|
*/
|
|
2599
2858
|
export interface UnsuccessfulFaceDeletion {
|
|
2600
2859
|
/**
|
|
2860
|
+
* @public
|
|
2601
2861
|
* <p> A unique identifier assigned to the face.</p>
|
|
2602
2862
|
*/
|
|
2603
2863
|
FaceId?: string;
|
|
2604
2864
|
/**
|
|
2865
|
+
* @public
|
|
2605
2866
|
* <p> A provided ID for the UserID. Unique within the collection. </p>
|
|
2606
2867
|
*/
|
|
2607
2868
|
UserId?: string;
|
|
2608
2869
|
/**
|
|
2870
|
+
* @public
|
|
2609
2871
|
* <p>The reason why the deletion was unsuccessful. </p>
|
|
2610
2872
|
*/
|
|
2611
2873
|
Reasons?: (UnsuccessfulFaceDeletionReason | string)[];
|
|
@@ -2615,10 +2877,12 @@ export interface UnsuccessfulFaceDeletion {
|
|
|
2615
2877
|
*/
|
|
2616
2878
|
export interface DeleteFacesResponse {
|
|
2617
2879
|
/**
|
|
2880
|
+
* @public
|
|
2618
2881
|
* <p>An array of strings (face IDs) of the faces that were deleted.</p>
|
|
2619
2882
|
*/
|
|
2620
2883
|
DeletedFaces?: string[];
|
|
2621
2884
|
/**
|
|
2885
|
+
* @public
|
|
2622
2886
|
* <p>An array of any faces that weren't deleted.</p>
|
|
2623
2887
|
*/
|
|
2624
2888
|
UnsuccessfulFaceDeletions?: UnsuccessfulFaceDeletion[];
|
|
@@ -2628,6 +2892,7 @@ export interface DeleteFacesResponse {
|
|
|
2628
2892
|
*/
|
|
2629
2893
|
export interface DeleteProjectRequest {
|
|
2630
2894
|
/**
|
|
2895
|
+
* @public
|
|
2631
2896
|
* <p>The Amazon Resource Name (ARN) of the project that you want to delete.</p>
|
|
2632
2897
|
*/
|
|
2633
2898
|
ProjectArn: string | undefined;
|
|
@@ -2650,6 +2915,7 @@ export type ProjectStatus = (typeof ProjectStatus)[keyof typeof ProjectStatus];
|
|
|
2650
2915
|
*/
|
|
2651
2916
|
export interface DeleteProjectResponse {
|
|
2652
2917
|
/**
|
|
2918
|
+
* @public
|
|
2653
2919
|
* <p>The current status of the delete project operation.</p>
|
|
2654
2920
|
*/
|
|
2655
2921
|
Status?: ProjectStatus | string;
|
|
@@ -2659,14 +2925,17 @@ export interface DeleteProjectResponse {
|
|
|
2659
2925
|
*/
|
|
2660
2926
|
export interface DeleteProjectPolicyRequest {
|
|
2661
2927
|
/**
|
|
2928
|
+
* @public
|
|
2662
2929
|
* <p>The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.</p>
|
|
2663
2930
|
*/
|
|
2664
2931
|
ProjectArn: string | undefined;
|
|
2665
2932
|
/**
|
|
2933
|
+
* @public
|
|
2666
2934
|
* <p>The name of the policy that you want to delete.</p>
|
|
2667
2935
|
*/
|
|
2668
2936
|
PolicyName: string | undefined;
|
|
2669
2937
|
/**
|
|
2938
|
+
* @public
|
|
2670
2939
|
* <p>The ID of the project policy revision that you want to delete.</p>
|
|
2671
2940
|
*/
|
|
2672
2941
|
PolicyRevisionId?: string;
|
|
@@ -2686,6 +2955,7 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
|
|
|
2686
2955
|
Message?: string;
|
|
2687
2956
|
Code?: string;
|
|
2688
2957
|
/**
|
|
2958
|
+
* @public
|
|
2689
2959
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
2690
2960
|
*/
|
|
2691
2961
|
Logref?: string;
|
|
@@ -2699,6 +2969,7 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
|
|
|
2699
2969
|
*/
|
|
2700
2970
|
export interface DeleteProjectVersionRequest {
|
|
2701
2971
|
/**
|
|
2972
|
+
* @public
|
|
2702
2973
|
* <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
|
|
2703
2974
|
*/
|
|
2704
2975
|
ProjectVersionArn: string | undefined;
|
|
@@ -2730,6 +3001,7 @@ export type ProjectVersionStatus = (typeof ProjectVersionStatus)[keyof typeof Pr
|
|
|
2730
3001
|
*/
|
|
2731
3002
|
export interface DeleteProjectVersionResponse {
|
|
2732
3003
|
/**
|
|
3004
|
+
* @public
|
|
2733
3005
|
* <p>The status of the deletion operation.</p>
|
|
2734
3006
|
*/
|
|
2735
3007
|
Status?: ProjectVersionStatus | string;
|
|
@@ -2739,6 +3011,7 @@ export interface DeleteProjectVersionResponse {
|
|
|
2739
3011
|
*/
|
|
2740
3012
|
export interface DeleteStreamProcessorRequest {
|
|
2741
3013
|
/**
|
|
3014
|
+
* @public
|
|
2742
3015
|
* <p>The name of the stream processor you want to delete.</p>
|
|
2743
3016
|
*/
|
|
2744
3017
|
Name: string | undefined;
|
|
@@ -2753,14 +3026,17 @@ export interface DeleteStreamProcessorResponse {
|
|
|
2753
3026
|
*/
|
|
2754
3027
|
export interface DeleteUserRequest {
|
|
2755
3028
|
/**
|
|
3029
|
+
* @public
|
|
2756
3030
|
* <p>The ID of an existing collection from which the UserID needs to be deleted. </p>
|
|
2757
3031
|
*/
|
|
2758
3032
|
CollectionId: string | undefined;
|
|
2759
3033
|
/**
|
|
3034
|
+
* @public
|
|
2760
3035
|
* <p>ID for the UserID to be deleted. </p>
|
|
2761
3036
|
*/
|
|
2762
3037
|
UserId: string | undefined;
|
|
2763
3038
|
/**
|
|
3039
|
+
* @public
|
|
2764
3040
|
* <p>Idempotent token used to identify the request to <code>DeleteUser</code>. If you use the
|
|
2765
3041
|
* same token with multiple <code>DeleteUser </code>requests, the same response is returned.
|
|
2766
3042
|
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
@@ -2778,6 +3054,7 @@ export interface DeleteUserResponse {
|
|
|
2778
3054
|
*/
|
|
2779
3055
|
export interface DescribeCollectionRequest {
|
|
2780
3056
|
/**
|
|
3057
|
+
* @public
|
|
2781
3058
|
* <p>The ID of the collection to describe.</p>
|
|
2782
3059
|
*/
|
|
2783
3060
|
CollectionId: string | undefined;
|
|
@@ -2787,26 +3064,31 @@ export interface DescribeCollectionRequest {
|
|
|
2787
3064
|
*/
|
|
2788
3065
|
export interface DescribeCollectionResponse {
|
|
2789
3066
|
/**
|
|
3067
|
+
* @public
|
|
2790
3068
|
* <p>The number of faces that are indexed into the collection. To index faces into a
|
|
2791
3069
|
* collection, use <a>IndexFaces</a>.</p>
|
|
2792
3070
|
*/
|
|
2793
3071
|
FaceCount?: number;
|
|
2794
3072
|
/**
|
|
3073
|
+
* @public
|
|
2795
3074
|
* <p>The version of the face model that's used by the collection for face detection.</p>
|
|
2796
3075
|
* <p>For more information, see Model versioning in the
|
|
2797
3076
|
* Amazon Rekognition Developer Guide.</p>
|
|
2798
3077
|
*/
|
|
2799
3078
|
FaceModelVersion?: string;
|
|
2800
3079
|
/**
|
|
3080
|
+
* @public
|
|
2801
3081
|
* <p>The Amazon Resource Name (ARN) of the collection.</p>
|
|
2802
3082
|
*/
|
|
2803
3083
|
CollectionARN?: string;
|
|
2804
3084
|
/**
|
|
3085
|
+
* @public
|
|
2805
3086
|
* <p>The number of milliseconds since the Unix epoch time until the creation of the collection.
|
|
2806
3087
|
* The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.</p>
|
|
2807
3088
|
*/
|
|
2808
3089
|
CreationTimestamp?: Date;
|
|
2809
3090
|
/**
|
|
3091
|
+
* @public
|
|
2810
3092
|
* <p>The number of UserIDs assigned to the specified colleciton.</p>
|
|
2811
3093
|
*/
|
|
2812
3094
|
UserCount?: number;
|
|
@@ -2816,6 +3098,7 @@ export interface DescribeCollectionResponse {
|
|
|
2816
3098
|
*/
|
|
2817
3099
|
export interface DescribeDatasetRequest {
|
|
2818
3100
|
/**
|
|
3101
|
+
* @public
|
|
2819
3102
|
* <p>
|
|
2820
3103
|
* The Amazon Resource Name (ARN) of the dataset that you want to describe.
|
|
2821
3104
|
* </p>
|
|
@@ -2827,6 +3110,7 @@ export interface DescribeDatasetRequest {
|
|
|
2827
3110
|
*/
|
|
2828
3111
|
export interface DescribeDatasetResponse {
|
|
2829
3112
|
/**
|
|
3113
|
+
* @public
|
|
2830
3114
|
* <p>
|
|
2831
3115
|
* The description for the dataset.
|
|
2832
3116
|
* </p>
|
|
@@ -2838,18 +3122,21 @@ export interface DescribeDatasetResponse {
|
|
|
2838
3122
|
*/
|
|
2839
3123
|
export interface DescribeProjectsRequest {
|
|
2840
3124
|
/**
|
|
3125
|
+
* @public
|
|
2841
3126
|
* <p>If the previous response was incomplete (because there is more
|
|
2842
3127
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
|
|
2843
3128
|
* token to retrieve the next set of results. </p>
|
|
2844
3129
|
*/
|
|
2845
3130
|
NextToken?: string;
|
|
2846
3131
|
/**
|
|
3132
|
+
* @public
|
|
2847
3133
|
* <p>The maximum number of results to return per paginated call. The largest value you can specify is 100.
|
|
2848
3134
|
* If you specify a value greater than 100, a ValidationException
|
|
2849
3135
|
* error occurs. The default value is 100. </p>
|
|
2850
3136
|
*/
|
|
2851
3137
|
MaxResults?: number;
|
|
2852
3138
|
/**
|
|
3139
|
+
* @public
|
|
2853
3140
|
* <p>A list of the projects that you want Amazon Rekognition Custom Labels to describe. If you don't specify a value,
|
|
2854
3141
|
* the response includes descriptions for all the projects in your AWS account.</p>
|
|
2855
3142
|
*/
|
|
@@ -2861,18 +3148,22 @@ export interface DescribeProjectsRequest {
|
|
|
2861
3148
|
*/
|
|
2862
3149
|
export interface ProjectDescription {
|
|
2863
3150
|
/**
|
|
3151
|
+
* @public
|
|
2864
3152
|
* <p>The Amazon Resource Name (ARN) of the project.</p>
|
|
2865
3153
|
*/
|
|
2866
3154
|
ProjectArn?: string;
|
|
2867
3155
|
/**
|
|
3156
|
+
* @public
|
|
2868
3157
|
* <p>The Unix timestamp for the date and time that the project was created.</p>
|
|
2869
3158
|
*/
|
|
2870
3159
|
CreationTimestamp?: Date;
|
|
2871
3160
|
/**
|
|
3161
|
+
* @public
|
|
2872
3162
|
* <p>The current status of the project.</p>
|
|
2873
3163
|
*/
|
|
2874
3164
|
Status?: ProjectStatus | string;
|
|
2875
3165
|
/**
|
|
3166
|
+
* @public
|
|
2876
3167
|
* <p>
|
|
2877
3168
|
* Information about the training and test datasets in the project.
|
|
2878
3169
|
* </p>
|
|
@@ -2884,10 +3175,12 @@ export interface ProjectDescription {
|
|
|
2884
3175
|
*/
|
|
2885
3176
|
export interface DescribeProjectsResponse {
|
|
2886
3177
|
/**
|
|
3178
|
+
* @public
|
|
2887
3179
|
* <p>A list of project descriptions. The list is sorted by the date and time the projects are created.</p>
|
|
2888
3180
|
*/
|
|
2889
3181
|
ProjectDescriptions?: ProjectDescription[];
|
|
2890
3182
|
/**
|
|
3183
|
+
* @public
|
|
2891
3184
|
* <p>If the previous response was incomplete (because there is more
|
|
2892
3185
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response.
|
|
2893
3186
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
@@ -2904,6 +3197,7 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
2904
3197
|
Message?: string;
|
|
2905
3198
|
Code?: string;
|
|
2906
3199
|
/**
|
|
3200
|
+
* @public
|
|
2907
3201
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
2908
3202
|
*/
|
|
2909
3203
|
Logref?: string;
|
|
@@ -2917,10 +3211,12 @@ export declare class InvalidPaginationTokenException extends __BaseException {
|
|
|
2917
3211
|
*/
|
|
2918
3212
|
export interface DescribeProjectVersionsRequest {
|
|
2919
3213
|
/**
|
|
3214
|
+
* @public
|
|
2920
3215
|
* <p>The Amazon Resource Name (ARN) of the project that contains the models you want to describe.</p>
|
|
2921
3216
|
*/
|
|
2922
3217
|
ProjectArn: string | undefined;
|
|
2923
3218
|
/**
|
|
3219
|
+
* @public
|
|
2924
3220
|
* <p>A list of model version names that you want to describe. You can add up to 10 model version names
|
|
2925
3221
|
* to the list. If you don't specify a value, all model descriptions are returned. A version name is part of a
|
|
2926
3222
|
* model (ProjectVersion) ARN. For example, <code>my-model.2020-01-21T09.10.15</code> is the version name in the following ARN.
|
|
@@ -2928,12 +3224,14 @@ export interface DescribeProjectVersionsRequest {
|
|
|
2928
3224
|
*/
|
|
2929
3225
|
VersionNames?: string[];
|
|
2930
3226
|
/**
|
|
3227
|
+
* @public
|
|
2931
3228
|
* <p>If the previous response was incomplete (because there is more
|
|
2932
3229
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response.
|
|
2933
3230
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
2934
3231
|
*/
|
|
2935
3232
|
NextToken?: string;
|
|
2936
3233
|
/**
|
|
3234
|
+
* @public
|
|
2937
3235
|
* <p>The maximum number of results to return per paginated call.
|
|
2938
3236
|
* The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException
|
|
2939
3237
|
* error occurs. The default value is 100. </p>
|
|
@@ -2950,6 +3248,7 @@ export interface DescribeProjectVersionsRequest {
|
|
|
2950
3248
|
*/
|
|
2951
3249
|
export interface Summary {
|
|
2952
3250
|
/**
|
|
3251
|
+
* @public
|
|
2953
3252
|
* <p>Provides the S3 bucket name and object name.</p>
|
|
2954
3253
|
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
2955
3254
|
* Amazon Rekognition operations.</p>
|
|
@@ -2965,6 +3264,7 @@ export interface Summary {
|
|
|
2965
3264
|
*/
|
|
2966
3265
|
export interface EvaluationResult {
|
|
2967
3266
|
/**
|
|
3267
|
+
* @public
|
|
2968
3268
|
* <p>The F1 score for the evaluation of all labels. The F1 score metric evaluates the overall precision
|
|
2969
3269
|
* and recall performance of the model as a single value. A higher value indicates better precision
|
|
2970
3270
|
* and recall performance. A lower score indicates that precision, recall, or both are performing poorly.
|
|
@@ -2973,6 +3273,7 @@ export interface EvaluationResult {
|
|
|
2973
3273
|
*/
|
|
2974
3274
|
F1Score?: number;
|
|
2975
3275
|
/**
|
|
3276
|
+
* @public
|
|
2976
3277
|
* <p>The S3 bucket that contains the training summary.</p>
|
|
2977
3278
|
*/
|
|
2978
3279
|
Summary?: Summary;
|
|
@@ -2992,6 +3293,7 @@ export interface EvaluationResult {
|
|
|
2992
3293
|
*/
|
|
2993
3294
|
export interface ValidationData {
|
|
2994
3295
|
/**
|
|
3296
|
+
* @public
|
|
2995
3297
|
* <p>The assets that comprise the validation data. </p>
|
|
2996
3298
|
*/
|
|
2997
3299
|
Assets?: Asset[];
|
|
@@ -3002,15 +3304,18 @@ export interface ValidationData {
|
|
|
3002
3304
|
*/
|
|
3003
3305
|
export interface TestingDataResult {
|
|
3004
3306
|
/**
|
|
3307
|
+
* @public
|
|
3005
3308
|
* <p>The testing dataset that was supplied for training.</p>
|
|
3006
3309
|
*/
|
|
3007
3310
|
Input?: TestingData;
|
|
3008
3311
|
/**
|
|
3312
|
+
* @public
|
|
3009
3313
|
* <p>The subset of the dataset that was actually tested. Some images (assets) might not be tested due to
|
|
3010
3314
|
* file formatting and other issues. </p>
|
|
3011
3315
|
*/
|
|
3012
3316
|
Output?: TestingData;
|
|
3013
3317
|
/**
|
|
3318
|
+
* @public
|
|
3014
3319
|
* <p>The location of the data validation manifest. The data validation manifest is created for the test dataset during model training.</p>
|
|
3015
3320
|
*/
|
|
3016
3321
|
Validation?: ValidationData;
|
|
@@ -3021,14 +3326,17 @@ export interface TestingDataResult {
|
|
|
3021
3326
|
*/
|
|
3022
3327
|
export interface TrainingDataResult {
|
|
3023
3328
|
/**
|
|
3329
|
+
* @public
|
|
3024
3330
|
* <p>The training assets that you supplied for training.</p>
|
|
3025
3331
|
*/
|
|
3026
3332
|
Input?: TrainingData;
|
|
3027
3333
|
/**
|
|
3334
|
+
* @public
|
|
3028
3335
|
* <p>The images (assets) that were actually trained by Amazon Rekognition Custom Labels. </p>
|
|
3029
3336
|
*/
|
|
3030
3337
|
Output?: TrainingData;
|
|
3031
3338
|
/**
|
|
3339
|
+
* @public
|
|
3032
3340
|
* <p>The location of the data validation manifest. The data validation manifest is created for the training dataset during model training.</p>
|
|
3033
3341
|
*/
|
|
3034
3342
|
Validation?: ValidationData;
|
|
@@ -3039,66 +3347,81 @@ export interface TrainingDataResult {
|
|
|
3039
3347
|
*/
|
|
3040
3348
|
export interface ProjectVersionDescription {
|
|
3041
3349
|
/**
|
|
3350
|
+
* @public
|
|
3042
3351
|
* <p>The Amazon Resource Name (ARN) of the model version. </p>
|
|
3043
3352
|
*/
|
|
3044
3353
|
ProjectVersionArn?: string;
|
|
3045
3354
|
/**
|
|
3355
|
+
* @public
|
|
3046
3356
|
* <p>The Unix datetime for the date and time that training started.</p>
|
|
3047
3357
|
*/
|
|
3048
3358
|
CreationTimestamp?: Date;
|
|
3049
3359
|
/**
|
|
3360
|
+
* @public
|
|
3050
3361
|
* <p>The minimum number of inference units used by the model. For more information,
|
|
3051
3362
|
* see <a>StartProjectVersion</a>.</p>
|
|
3052
3363
|
*/
|
|
3053
3364
|
MinInferenceUnits?: number;
|
|
3054
3365
|
/**
|
|
3366
|
+
* @public
|
|
3055
3367
|
* <p>The current status of the model version.</p>
|
|
3056
3368
|
*/
|
|
3057
3369
|
Status?: ProjectVersionStatus | string;
|
|
3058
3370
|
/**
|
|
3371
|
+
* @public
|
|
3059
3372
|
* <p>A descriptive message for an error or warning that occurred.</p>
|
|
3060
3373
|
*/
|
|
3061
3374
|
StatusMessage?: string;
|
|
3062
3375
|
/**
|
|
3376
|
+
* @public
|
|
3063
3377
|
* <p>The duration, in seconds, that you were billed for a successful training of the model version.
|
|
3064
3378
|
* This value is only returned if the model version has been successfully trained.</p>
|
|
3065
3379
|
*/
|
|
3066
3380
|
BillableTrainingTimeInSeconds?: number;
|
|
3067
3381
|
/**
|
|
3382
|
+
* @public
|
|
3068
3383
|
* <p>The Unix date and time that training of the model ended.</p>
|
|
3069
3384
|
*/
|
|
3070
3385
|
TrainingEndTimestamp?: Date;
|
|
3071
3386
|
/**
|
|
3387
|
+
* @public
|
|
3072
3388
|
* <p>The location where training results are saved.</p>
|
|
3073
3389
|
*/
|
|
3074
3390
|
OutputConfig?: OutputConfig;
|
|
3075
3391
|
/**
|
|
3392
|
+
* @public
|
|
3076
3393
|
* <p>Contains information about the training results.</p>
|
|
3077
3394
|
*/
|
|
3078
3395
|
TrainingDataResult?: TrainingDataResult;
|
|
3079
3396
|
/**
|
|
3397
|
+
* @public
|
|
3080
3398
|
* <p>Contains information about the testing results.</p>
|
|
3081
3399
|
*/
|
|
3082
3400
|
TestingDataResult?: TestingDataResult;
|
|
3083
3401
|
/**
|
|
3402
|
+
* @public
|
|
3084
3403
|
* <p>The training results. <code>EvaluationResult</code> is only returned if training is successful.</p>
|
|
3085
3404
|
*/
|
|
3086
3405
|
EvaluationResult?: EvaluationResult;
|
|
3087
3406
|
/**
|
|
3407
|
+
* @public
|
|
3088
3408
|
* <p>The location of the summary manifest. The summary manifest provides aggregate data validation results for the training
|
|
3089
3409
|
* and test datasets.</p>
|
|
3090
3410
|
*/
|
|
3091
3411
|
ManifestSummary?: GroundTruthManifest;
|
|
3092
3412
|
/**
|
|
3413
|
+
* @public
|
|
3093
3414
|
* <p>The identifer for the AWS Key Management Service key (AWS KMS key) that was used to encrypt the model during training. </p>
|
|
3094
3415
|
*/
|
|
3095
3416
|
KmsKeyId?: string;
|
|
3096
3417
|
/**
|
|
3418
|
+
* @public
|
|
3097
3419
|
* <p>The maximum number of inference units Amazon Rekognition Custom Labels uses to auto-scale the model.
|
|
3098
3420
|
* For more information, see <a>StartProjectVersion</a>.</p>
|
|
3099
3421
|
*/
|
|
3100
3422
|
MaxInferenceUnits?: number;
|
|
3101
3423
|
/**
|
|
3424
|
+
* @public
|
|
3102
3425
|
* <p>If the model version was copied from a different project, <code>SourceProjectVersionArn</code> contains the ARN of the source model version. </p>
|
|
3103
3426
|
*/
|
|
3104
3427
|
SourceProjectVersionArn?: string;
|
|
@@ -3108,11 +3431,13 @@ export interface ProjectVersionDescription {
|
|
|
3108
3431
|
*/
|
|
3109
3432
|
export interface DescribeProjectVersionsResponse {
|
|
3110
3433
|
/**
|
|
3434
|
+
* @public
|
|
3111
3435
|
* <p>A list of model descriptions. The list is sorted by the creation date and time of
|
|
3112
3436
|
* the model versions, latest to earliest.</p>
|
|
3113
3437
|
*/
|
|
3114
3438
|
ProjectVersionDescriptions?: ProjectVersionDescription[];
|
|
3115
3439
|
/**
|
|
3440
|
+
* @public
|
|
3116
3441
|
* <p>If the previous response was incomplete (because there is more
|
|
3117
3442
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response.
|
|
3118
3443
|
* You can use this pagination token to retrieve the next set of results. </p>
|
|
@@ -3124,6 +3449,7 @@ export interface DescribeProjectVersionsResponse {
|
|
|
3124
3449
|
*/
|
|
3125
3450
|
export interface DescribeStreamProcessorRequest {
|
|
3126
3451
|
/**
|
|
3452
|
+
* @public
|
|
3127
3453
|
* <p>Name of the stream processor for which you want information.</p>
|
|
3128
3454
|
*/
|
|
3129
3455
|
Name: string | undefined;
|
|
@@ -3149,48 +3475,59 @@ export type StreamProcessorStatus = (typeof StreamProcessorStatus)[keyof typeof
|
|
|
3149
3475
|
*/
|
|
3150
3476
|
export interface DescribeStreamProcessorResponse {
|
|
3151
3477
|
/**
|
|
3478
|
+
* @public
|
|
3152
3479
|
* <p>Name of the stream processor. </p>
|
|
3153
3480
|
*/
|
|
3154
3481
|
Name?: string;
|
|
3155
3482
|
/**
|
|
3483
|
+
* @public
|
|
3156
3484
|
* <p>ARN of the stream processor.</p>
|
|
3157
3485
|
*/
|
|
3158
3486
|
StreamProcessorArn?: string;
|
|
3159
3487
|
/**
|
|
3488
|
+
* @public
|
|
3160
3489
|
* <p>Current status of the stream processor.</p>
|
|
3161
3490
|
*/
|
|
3162
3491
|
Status?: StreamProcessorStatus | string;
|
|
3163
3492
|
/**
|
|
3493
|
+
* @public
|
|
3164
3494
|
* <p>Detailed status message about the stream processor.</p>
|
|
3165
3495
|
*/
|
|
3166
3496
|
StatusMessage?: string;
|
|
3167
3497
|
/**
|
|
3498
|
+
* @public
|
|
3168
3499
|
* <p>Date and time the stream processor was created</p>
|
|
3169
3500
|
*/
|
|
3170
3501
|
CreationTimestamp?: Date;
|
|
3171
3502
|
/**
|
|
3503
|
+
* @public
|
|
3172
3504
|
* <p>The time, in Unix format, the stream processor was last updated. For example, when the stream
|
|
3173
3505
|
* processor moves from a running state to a failed state, or when the user starts or stops the stream processor.</p>
|
|
3174
3506
|
*/
|
|
3175
3507
|
LastUpdateTimestamp?: Date;
|
|
3176
3508
|
/**
|
|
3509
|
+
* @public
|
|
3177
3510
|
* <p>Kinesis video stream that provides the source streaming video.</p>
|
|
3178
3511
|
*/
|
|
3179
3512
|
Input?: StreamProcessorInput;
|
|
3180
3513
|
/**
|
|
3514
|
+
* @public
|
|
3181
3515
|
* <p>Kinesis data stream to which Amazon Rekognition Video puts the analysis results.</p>
|
|
3182
3516
|
*/
|
|
3183
3517
|
Output?: StreamProcessorOutput;
|
|
3184
3518
|
/**
|
|
3519
|
+
* @public
|
|
3185
3520
|
* <p>ARN of the IAM role that allows access to the stream processor.</p>
|
|
3186
3521
|
*/
|
|
3187
3522
|
RoleArn?: string;
|
|
3188
3523
|
/**
|
|
3524
|
+
* @public
|
|
3189
3525
|
* <p>Input parameters used in a streaming video analyzed by a stream processor. You can use <code>FaceSearch</code> to recognize faces
|
|
3190
3526
|
* in a streaming video, or you can use <code>ConnectedHome</code> to detect labels.</p>
|
|
3191
3527
|
*/
|
|
3192
3528
|
Settings?: StreamProcessorSettings;
|
|
3193
3529
|
/**
|
|
3530
|
+
* @public
|
|
3194
3531
|
* <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the object detection results and completion status of a video analysis operation.</p>
|
|
3195
3532
|
* <p>Amazon Rekognition publishes a notification the first time an object of interest or a person is detected in the video stream. For example, if Amazon Rekognition
|
|
3196
3533
|
* detects a person at second 2, a pet at second 4, and a person again at second 5, Amazon Rekognition sends 2 object class detected notifications,
|
|
@@ -3199,18 +3536,21 @@ export interface DescribeStreamProcessorResponse {
|
|
|
3199
3536
|
*/
|
|
3200
3537
|
NotificationChannel?: StreamProcessorNotificationChannel;
|
|
3201
3538
|
/**
|
|
3539
|
+
* @public
|
|
3202
3540
|
* <p>
|
|
3203
3541
|
* The identifier for your AWS Key Management Service key (AWS KMS key). This is an optional parameter for label detection stream processors.
|
|
3204
3542
|
* </p>
|
|
3205
3543
|
*/
|
|
3206
3544
|
KmsKeyId?: string;
|
|
3207
3545
|
/**
|
|
3546
|
+
* @public
|
|
3208
3547
|
* <p>
|
|
3209
3548
|
* Specifies locations in the frames where Amazon Rekognition checks for objects or people. This is an optional parameter for label detection stream processors.
|
|
3210
3549
|
* </p>
|
|
3211
3550
|
*/
|
|
3212
3551
|
RegionsOfInterest?: RegionOfInterest[];
|
|
3213
3552
|
/**
|
|
3553
|
+
* @public
|
|
3214
3554
|
* <p>
|
|
3215
3555
|
* Shows whether you are sharing data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
|
|
3216
3556
|
* Note that if you opt out at the account level this setting is ignored on individual streams.
|
|
@@ -3223,10 +3563,12 @@ export interface DescribeStreamProcessorResponse {
|
|
|
3223
3563
|
*/
|
|
3224
3564
|
export interface DetectCustomLabelsRequest {
|
|
3225
3565
|
/**
|
|
3566
|
+
* @public
|
|
3226
3567
|
* <p>The ARN of the model version that you want to use.</p>
|
|
3227
3568
|
*/
|
|
3228
3569
|
ProjectVersionArn: string | undefined;
|
|
3229
3570
|
/**
|
|
3571
|
+
* @public
|
|
3230
3572
|
* <p>Provides the input image either as bytes or an S3 object.</p>
|
|
3231
3573
|
* <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
|
|
3232
3574
|
* property. For example, you would use the <code>Bytes</code> property to pass an image loaded
|
|
@@ -3249,12 +3591,14 @@ export interface DetectCustomLabelsRequest {
|
|
|
3249
3591
|
*/
|
|
3250
3592
|
Image: Image | undefined;
|
|
3251
3593
|
/**
|
|
3594
|
+
* @public
|
|
3252
3595
|
* <p>Maximum number of results you want the service to return in the response.
|
|
3253
3596
|
* The service returns the specified number of highest confidence labels ranked from highest confidence
|
|
3254
3597
|
* to lowest.</p>
|
|
3255
3598
|
*/
|
|
3256
3599
|
MaxResults?: number;
|
|
3257
3600
|
/**
|
|
3601
|
+
* @public
|
|
3258
3602
|
* <p>Specifies the minimum confidence level for the labels to return.
|
|
3259
3603
|
* <code>DetectCustomLabels</code> doesn't return any labels with a confidence value that's lower than
|
|
3260
3604
|
* this specified value. If you specify a
|
|
@@ -3270,6 +3614,7 @@ export interface DetectCustomLabelsRequest {
|
|
|
3270
3614
|
*/
|
|
3271
3615
|
export interface DetectCustomLabelsResponse {
|
|
3272
3616
|
/**
|
|
3617
|
+
* @public
|
|
3273
3618
|
* <p>An array of custom labels detected in the input image.</p>
|
|
3274
3619
|
*/
|
|
3275
3620
|
CustomLabels?: CustomLabel[];
|
|
@@ -3286,6 +3631,7 @@ export declare class ResourceNotReadyException extends __BaseException {
|
|
|
3286
3631
|
Message?: string;
|
|
3287
3632
|
Code?: string;
|
|
3288
3633
|
/**
|
|
3634
|
+
* @public
|
|
3289
3635
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
3290
3636
|
*/
|
|
3291
3637
|
Logref?: string;
|
|
@@ -3299,6 +3645,7 @@ export declare class ResourceNotReadyException extends __BaseException {
|
|
|
3299
3645
|
*/
|
|
3300
3646
|
export interface DetectFacesRequest {
|
|
3301
3647
|
/**
|
|
3648
|
+
* @public
|
|
3302
3649
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
3303
3650
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
3304
3651
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -3307,6 +3654,7 @@ export interface DetectFacesRequest {
|
|
|
3307
3654
|
*/
|
|
3308
3655
|
Image: Image | undefined;
|
|
3309
3656
|
/**
|
|
3657
|
+
* @public
|
|
3310
3658
|
* <p>An array of facial attributes you want to be returned. A <code>DEFAULT</code> subset of
|
|
3311
3659
|
* facial attributes - <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>,
|
|
3312
3660
|
* <code>Quality</code>, and <code>Landmarks</code> - will always be returned. You can request
|
|
@@ -3324,10 +3672,12 @@ export interface DetectFacesRequest {
|
|
|
3324
3672
|
*/
|
|
3325
3673
|
export interface DetectFacesResponse {
|
|
3326
3674
|
/**
|
|
3675
|
+
* @public
|
|
3327
3676
|
* <p>Details of each face found in the image. </p>
|
|
3328
3677
|
*/
|
|
3329
3678
|
FaceDetails?: FaceDetail[];
|
|
3330
3679
|
/**
|
|
3680
|
+
* @public
|
|
3331
3681
|
* <p>The value of <code>OrientationCorrection</code> is always null.</p>
|
|
3332
3682
|
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
3333
3683
|
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
@@ -3346,17 +3696,20 @@ export interface DetectFacesResponse {
|
|
|
3346
3696
|
*/
|
|
3347
3697
|
export interface DetectionFilter {
|
|
3348
3698
|
/**
|
|
3699
|
+
* @public
|
|
3349
3700
|
* <p>Sets the confidence of word detection. Words with detection confidence below this will be
|
|
3350
3701
|
* excluded from the result. Values should be between 0 and 100. The default MinConfidence is
|
|
3351
3702
|
* 80.</p>
|
|
3352
3703
|
*/
|
|
3353
3704
|
MinConfidence?: number;
|
|
3354
3705
|
/**
|
|
3706
|
+
* @public
|
|
3355
3707
|
* <p>Sets the minimum height of the word bounding box. Words with bounding box heights lesser than
|
|
3356
3708
|
* this value will be excluded from the result. Value is relative to the video frame height.</p>
|
|
3357
3709
|
*/
|
|
3358
3710
|
MinBoundingBoxHeight?: number;
|
|
3359
3711
|
/**
|
|
3712
|
+
* @public
|
|
3360
3713
|
* <p>Sets the minimum width of the word bounding box. Words with bounding boxes widths lesser than
|
|
3361
3714
|
* this value will be excluded from the result. Value is relative to the video frame width.</p>
|
|
3362
3715
|
*/
|
|
@@ -3382,18 +3735,22 @@ export type DetectLabelsFeatureName = (typeof DetectLabelsFeatureName)[keyof typ
|
|
|
3382
3735
|
*/
|
|
3383
3736
|
export interface GeneralLabelsSettings {
|
|
3384
3737
|
/**
|
|
3738
|
+
* @public
|
|
3385
3739
|
* <p>The labels that should be included in the return from DetectLabels.</p>
|
|
3386
3740
|
*/
|
|
3387
3741
|
LabelInclusionFilters?: string[];
|
|
3388
3742
|
/**
|
|
3743
|
+
* @public
|
|
3389
3744
|
* <p>The labels that should be excluded from the return from DetectLabels.</p>
|
|
3390
3745
|
*/
|
|
3391
3746
|
LabelExclusionFilters?: string[];
|
|
3392
3747
|
/**
|
|
3748
|
+
* @public
|
|
3393
3749
|
* <p>The label categories that should be included in the return from DetectLabels.</p>
|
|
3394
3750
|
*/
|
|
3395
3751
|
LabelCategoryInclusionFilters?: string[];
|
|
3396
3752
|
/**
|
|
3753
|
+
* @public
|
|
3397
3754
|
* <p>The label categories that should be excluded from the return from DetectLabels.</p>
|
|
3398
3755
|
*/
|
|
3399
3756
|
LabelCategoryExclusionFilters?: string[];
|
|
@@ -3404,6 +3761,7 @@ export interface GeneralLabelsSettings {
|
|
|
3404
3761
|
*/
|
|
3405
3762
|
export interface DetectLabelsImagePropertiesSettings {
|
|
3406
3763
|
/**
|
|
3764
|
+
* @public
|
|
3407
3765
|
* <p>The maximum number of dominant colors to return when detecting labels in an image. The default value is 10.</p>
|
|
3408
3766
|
*/
|
|
3409
3767
|
MaxDominantColors?: number;
|
|
@@ -3417,10 +3775,12 @@ export interface DetectLabelsImagePropertiesSettings {
|
|
|
3417
3775
|
*/
|
|
3418
3776
|
export interface DetectLabelsSettings {
|
|
3419
3777
|
/**
|
|
3778
|
+
* @public
|
|
3420
3779
|
* <p>Contains the specified filters for GENERAL_LABELS.</p>
|
|
3421
3780
|
*/
|
|
3422
3781
|
GeneralLabels?: GeneralLabelsSettings;
|
|
3423
3782
|
/**
|
|
3783
|
+
* @public
|
|
3424
3784
|
* <p>Contains the chosen number of maximum dominant colors in an image.</p>
|
|
3425
3785
|
*/
|
|
3426
3786
|
ImageProperties?: DetectLabelsImagePropertiesSettings;
|
|
@@ -3430,6 +3790,7 @@ export interface DetectLabelsSettings {
|
|
|
3430
3790
|
*/
|
|
3431
3791
|
export interface DetectLabelsRequest {
|
|
3432
3792
|
/**
|
|
3793
|
+
* @public
|
|
3433
3794
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
3434
3795
|
* call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an
|
|
3435
3796
|
* S3 Bucket do not need to be base64-encoded.</p>
|
|
@@ -3439,11 +3800,13 @@ export interface DetectLabelsRequest {
|
|
|
3439
3800
|
*/
|
|
3440
3801
|
Image: Image | undefined;
|
|
3441
3802
|
/**
|
|
3803
|
+
* @public
|
|
3442
3804
|
* <p>Maximum number of labels you want the service to return in the response. The service
|
|
3443
3805
|
* returns the specified number of highest confidence labels. </p>
|
|
3444
3806
|
*/
|
|
3445
3807
|
MaxLabels?: number;
|
|
3446
3808
|
/**
|
|
3809
|
+
* @public
|
|
3447
3810
|
* <p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't
|
|
3448
3811
|
* return any labels with confidence lower than this specified value.</p>
|
|
3449
3812
|
* <p>If <code>MinConfidence</code> is not specified, the operation returns labels with a
|
|
@@ -3451,12 +3814,14 @@ export interface DetectLabelsRequest {
|
|
|
3451
3814
|
*/
|
|
3452
3815
|
MinConfidence?: number;
|
|
3453
3816
|
/**
|
|
3817
|
+
* @public
|
|
3454
3818
|
* <p>A list of the types of analysis to perform. Specifying GENERAL_LABELS uses the label detection
|
|
3455
3819
|
* feature, while specifying IMAGE_PROPERTIES returns information regarding image color and quality.
|
|
3456
3820
|
* If no option is specified GENERAL_LABELS is used by default.</p>
|
|
3457
3821
|
*/
|
|
3458
3822
|
Features?: (DetectLabelsFeatureName | string)[];
|
|
3459
3823
|
/**
|
|
3824
|
+
* @public
|
|
3460
3825
|
* <p>A list of the filters to be applied to returned detected labels and image properties. Specified
|
|
3461
3826
|
* filters can be inclusive, exclusive, or a combination of both. Filters can be used for individual
|
|
3462
3827
|
* labels or label categories. The exact label names or label categories must be supplied. For
|
|
@@ -3470,30 +3835,37 @@ export interface DetectLabelsRequest {
|
|
|
3470
3835
|
*/
|
|
3471
3836
|
export interface DominantColor {
|
|
3472
3837
|
/**
|
|
3838
|
+
* @public
|
|
3473
3839
|
* <p>The Red RGB value for a dominant color.</p>
|
|
3474
3840
|
*/
|
|
3475
3841
|
Red?: number;
|
|
3476
3842
|
/**
|
|
3843
|
+
* @public
|
|
3477
3844
|
* <p>The Blue RGB value for a dominant color.</p>
|
|
3478
3845
|
*/
|
|
3479
3846
|
Blue?: number;
|
|
3480
3847
|
/**
|
|
3848
|
+
* @public
|
|
3481
3849
|
* <p>The Green RGB value for a dominant color.</p>
|
|
3482
3850
|
*/
|
|
3483
3851
|
Green?: number;
|
|
3484
3852
|
/**
|
|
3853
|
+
* @public
|
|
3485
3854
|
* <p>The Hex code equivalent of the RGB values for a dominant color.</p>
|
|
3486
3855
|
*/
|
|
3487
3856
|
HexCode?: string;
|
|
3488
3857
|
/**
|
|
3858
|
+
* @public
|
|
3489
3859
|
* <p>The CSS color name of a dominant color.</p>
|
|
3490
3860
|
*/
|
|
3491
3861
|
CSSColor?: string;
|
|
3492
3862
|
/**
|
|
3863
|
+
* @public
|
|
3493
3864
|
* <p>One of 12 simplified color names applied to a dominant color.</p>
|
|
3494
3865
|
*/
|
|
3495
3866
|
SimplifiedColor?: string;
|
|
3496
3867
|
/**
|
|
3868
|
+
* @public
|
|
3497
3869
|
* <p>The percentage of image pixels that have a given dominant color.</p>
|
|
3498
3870
|
*/
|
|
3499
3871
|
PixelPercent?: number;
|
|
@@ -3504,14 +3876,17 @@ export interface DominantColor {
|
|
|
3504
3876
|
*/
|
|
3505
3877
|
export interface DetectLabelsImageQuality {
|
|
3506
3878
|
/**
|
|
3879
|
+
* @public
|
|
3507
3880
|
* <p>The brightness of an image provided for label detection.</p>
|
|
3508
3881
|
*/
|
|
3509
3882
|
Brightness?: number;
|
|
3510
3883
|
/**
|
|
3884
|
+
* @public
|
|
3511
3885
|
* <p>The sharpness of an image provided for label detection.</p>
|
|
3512
3886
|
*/
|
|
3513
3887
|
Sharpness?: number;
|
|
3514
3888
|
/**
|
|
3889
|
+
* @public
|
|
3515
3890
|
* <p>The contrast of an image provided for label detection.</p>
|
|
3516
3891
|
*/
|
|
3517
3892
|
Contrast?: number;
|
|
@@ -3522,10 +3897,12 @@ export interface DetectLabelsImageQuality {
|
|
|
3522
3897
|
*/
|
|
3523
3898
|
export interface DetectLabelsImageBackground {
|
|
3524
3899
|
/**
|
|
3900
|
+
* @public
|
|
3525
3901
|
* <p>The quality of the image background as defined by brightness and sharpness.</p>
|
|
3526
3902
|
*/
|
|
3527
3903
|
Quality?: DetectLabelsImageQuality;
|
|
3528
3904
|
/**
|
|
3905
|
+
* @public
|
|
3529
3906
|
* <p>The dominant colors found in the background of an image, defined with RGB values,
|
|
3530
3907
|
* CSS color name, simplified color name, and PixelPercentage (the percentage of
|
|
3531
3908
|
* image pixels that have a particular color).</p>
|
|
@@ -3538,10 +3915,12 @@ export interface DetectLabelsImageBackground {
|
|
|
3538
3915
|
*/
|
|
3539
3916
|
export interface DetectLabelsImageForeground {
|
|
3540
3917
|
/**
|
|
3918
|
+
* @public
|
|
3541
3919
|
* <p>The quality of the image foreground as defined by brightness and sharpness.</p>
|
|
3542
3920
|
*/
|
|
3543
3921
|
Quality?: DetectLabelsImageQuality;
|
|
3544
3922
|
/**
|
|
3923
|
+
* @public
|
|
3545
3924
|
* <p>The dominant colors found in the foreground of an image, defined with RGB values,
|
|
3546
3925
|
* CSS color name, simplified color name, and PixelPercentage (the percentage of image
|
|
3547
3926
|
* pixels that have a particular color).</p>
|
|
@@ -3555,23 +3934,27 @@ export interface DetectLabelsImageForeground {
|
|
|
3555
3934
|
*/
|
|
3556
3935
|
export interface DetectLabelsImageProperties {
|
|
3557
3936
|
/**
|
|
3937
|
+
* @public
|
|
3558
3938
|
* <p>Information about the quality of the image foreground as defined by brightness,
|
|
3559
3939
|
* sharpness, and contrast. The higher the value the greater the brightness,
|
|
3560
3940
|
* sharpness, and contrast respectively.</p>
|
|
3561
3941
|
*/
|
|
3562
3942
|
Quality?: DetectLabelsImageQuality;
|
|
3563
3943
|
/**
|
|
3944
|
+
* @public
|
|
3564
3945
|
* <p>Information about the dominant colors found in an image, described with RGB values,
|
|
3565
3946
|
* CSS color name, simplified color name, and PixelPercentage (the percentage of image pixels
|
|
3566
3947
|
* that have a particular color).</p>
|
|
3567
3948
|
*/
|
|
3568
3949
|
DominantColors?: DominantColor[];
|
|
3569
3950
|
/**
|
|
3951
|
+
* @public
|
|
3570
3952
|
* <p>Information about the properties of an image’s foreground, including the
|
|
3571
3953
|
* foreground’s quality and dominant colors, including the quality and dominant colors of the image.</p>
|
|
3572
3954
|
*/
|
|
3573
3955
|
Foreground?: DetectLabelsImageForeground;
|
|
3574
3956
|
/**
|
|
3957
|
+
* @public
|
|
3575
3958
|
* <p>Information about the properties of an image’s background, including
|
|
3576
3959
|
* the background’s quality and dominant colors, including the quality
|
|
3577
3960
|
* and dominant colors of the image.</p>
|
|
@@ -3584,6 +3967,7 @@ export interface DetectLabelsImageProperties {
|
|
|
3584
3967
|
*/
|
|
3585
3968
|
export interface LabelAlias {
|
|
3586
3969
|
/**
|
|
3970
|
+
* @public
|
|
3587
3971
|
* <p>The name of an alias for a given label.</p>
|
|
3588
3972
|
*/
|
|
3589
3973
|
Name?: string;
|
|
@@ -3594,6 +3978,7 @@ export interface LabelAlias {
|
|
|
3594
3978
|
*/
|
|
3595
3979
|
export interface LabelCategory {
|
|
3596
3980
|
/**
|
|
3981
|
+
* @public
|
|
3597
3982
|
* <p>The name of a category that applies to a given label.</p>
|
|
3598
3983
|
*/
|
|
3599
3984
|
Name?: string;
|
|
@@ -3605,14 +3990,17 @@ export interface LabelCategory {
|
|
|
3605
3990
|
*/
|
|
3606
3991
|
export interface Instance {
|
|
3607
3992
|
/**
|
|
3993
|
+
* @public
|
|
3608
3994
|
* <p>The position of the label instance on the image.</p>
|
|
3609
3995
|
*/
|
|
3610
3996
|
BoundingBox?: BoundingBox;
|
|
3611
3997
|
/**
|
|
3998
|
+
* @public
|
|
3612
3999
|
* <p>The confidence that Amazon Rekognition has in the accuracy of the bounding box.</p>
|
|
3613
4000
|
*/
|
|
3614
4001
|
Confidence?: number;
|
|
3615
4002
|
/**
|
|
4003
|
+
* @public
|
|
3616
4004
|
* <p>The dominant colors found in an individual instance of a label.</p>
|
|
3617
4005
|
*/
|
|
3618
4006
|
DominantColors?: DominantColor[];
|
|
@@ -3623,6 +4011,7 @@ export interface Instance {
|
|
|
3623
4011
|
*/
|
|
3624
4012
|
export interface Parent {
|
|
3625
4013
|
/**
|
|
4014
|
+
* @public
|
|
3626
4015
|
* <p>The name of the parent label.</p>
|
|
3627
4016
|
*/
|
|
3628
4017
|
Name?: string;
|
|
@@ -3636,27 +4025,33 @@ export interface Parent {
|
|
|
3636
4025
|
*/
|
|
3637
4026
|
export interface Label {
|
|
3638
4027
|
/**
|
|
4028
|
+
* @public
|
|
3639
4029
|
* <p>The name (label) of the object or scene.</p>
|
|
3640
4030
|
*/
|
|
3641
4031
|
Name?: string;
|
|
3642
4032
|
/**
|
|
4033
|
+
* @public
|
|
3643
4034
|
* <p>Level of confidence.</p>
|
|
3644
4035
|
*/
|
|
3645
4036
|
Confidence?: number;
|
|
3646
4037
|
/**
|
|
4038
|
+
* @public
|
|
3647
4039
|
* <p>If <code>Label</code> represents an object, <code>Instances</code> contains the bounding boxes for each instance of the detected object.
|
|
3648
4040
|
* Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.</p>
|
|
3649
4041
|
*/
|
|
3650
4042
|
Instances?: Instance[];
|
|
3651
4043
|
/**
|
|
4044
|
+
* @public
|
|
3652
4045
|
* <p>The parent labels for a label. The response includes all ancestor labels.</p>
|
|
3653
4046
|
*/
|
|
3654
4047
|
Parents?: Parent[];
|
|
3655
4048
|
/**
|
|
4049
|
+
* @public
|
|
3656
4050
|
* <p>A list of potential aliases for a given label.</p>
|
|
3657
4051
|
*/
|
|
3658
4052
|
Aliases?: LabelAlias[];
|
|
3659
4053
|
/**
|
|
4054
|
+
* @public
|
|
3660
4055
|
* <p>A list of the categories associated with a given label.</p>
|
|
3661
4056
|
*/
|
|
3662
4057
|
Categories?: LabelCategory[];
|
|
@@ -3666,10 +4061,12 @@ export interface Label {
|
|
|
3666
4061
|
*/
|
|
3667
4062
|
export interface DetectLabelsResponse {
|
|
3668
4063
|
/**
|
|
4064
|
+
* @public
|
|
3669
4065
|
* <p>An array of labels for the real-world objects detected. </p>
|
|
3670
4066
|
*/
|
|
3671
4067
|
Labels?: Label[];
|
|
3672
4068
|
/**
|
|
4069
|
+
* @public
|
|
3673
4070
|
* <p>The value of <code>OrientationCorrection</code> is always null.</p>
|
|
3674
4071
|
* <p>If the input image is in .jpeg format, it might contain exchangeable image file format
|
|
3675
4072
|
* (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation
|
|
@@ -3682,10 +4079,12 @@ export interface DetectLabelsResponse {
|
|
|
3682
4079
|
*/
|
|
3683
4080
|
OrientationCorrection?: OrientationCorrection | string;
|
|
3684
4081
|
/**
|
|
4082
|
+
* @public
|
|
3685
4083
|
* <p>Version number of the label detection model that was used to detect labels.</p>
|
|
3686
4084
|
*/
|
|
3687
4085
|
LabelModelVersion?: string;
|
|
3688
4086
|
/**
|
|
4087
|
+
* @public
|
|
3689
4088
|
* <p>Information about the properties of the input image, such as brightness, sharpness, contrast, and dominant colors.</p>
|
|
3690
4089
|
*/
|
|
3691
4090
|
ImageProperties?: DetectLabelsImageProperties;
|
|
@@ -3697,6 +4096,7 @@ export interface DetectLabelsResponse {
|
|
|
3697
4096
|
*/
|
|
3698
4097
|
export interface HumanLoopDataAttributes {
|
|
3699
4098
|
/**
|
|
4099
|
+
* @public
|
|
3700
4100
|
* <p>Sets whether the input image is free of personally identifiable information.</p>
|
|
3701
4101
|
*/
|
|
3702
4102
|
ContentClassifiers?: (ContentClassifier | string)[];
|
|
@@ -3708,16 +4108,19 @@ export interface HumanLoopDataAttributes {
|
|
|
3708
4108
|
*/
|
|
3709
4109
|
export interface HumanLoopConfig {
|
|
3710
4110
|
/**
|
|
4111
|
+
* @public
|
|
3711
4112
|
* <p>The name of the human review used for this image. This should be kept unique within a
|
|
3712
4113
|
* region.</p>
|
|
3713
4114
|
*/
|
|
3714
4115
|
HumanLoopName: string | undefined;
|
|
3715
4116
|
/**
|
|
4117
|
+
* @public
|
|
3716
4118
|
* <p>The Amazon Resource Name (ARN) of the flow definition. You can create a flow definition by
|
|
3717
4119
|
* using the Amazon Sagemaker <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/API_CreateFlowDefinition.html">CreateFlowDefinition</a> Operation. </p>
|
|
3718
4120
|
*/
|
|
3719
4121
|
FlowDefinitionArn: string | undefined;
|
|
3720
4122
|
/**
|
|
4123
|
+
* @public
|
|
3721
4124
|
* <p>Sets attributes of the input data.</p>
|
|
3722
4125
|
*/
|
|
3723
4126
|
DataAttributes?: HumanLoopDataAttributes;
|
|
@@ -3727,6 +4130,7 @@ export interface HumanLoopConfig {
|
|
|
3727
4130
|
*/
|
|
3728
4131
|
export interface DetectModerationLabelsRequest {
|
|
3729
4132
|
/**
|
|
4133
|
+
* @public
|
|
3730
4134
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
3731
4135
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
3732
4136
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -3735,6 +4139,7 @@ export interface DetectModerationLabelsRequest {
|
|
|
3735
4139
|
*/
|
|
3736
4140
|
Image: Image | undefined;
|
|
3737
4141
|
/**
|
|
4142
|
+
* @public
|
|
3738
4143
|
* <p>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't
|
|
3739
4144
|
* return any labels with a confidence level lower than this specified value.</p>
|
|
3740
4145
|
* <p>If you don't specify <code>MinConfidence</code>, the operation returns labels with
|
|
@@ -3742,6 +4147,7 @@ export interface DetectModerationLabelsRequest {
|
|
|
3742
4147
|
*/
|
|
3743
4148
|
MinConfidence?: number;
|
|
3744
4149
|
/**
|
|
4150
|
+
* @public
|
|
3745
4151
|
* <p>Sets up the configuration for human evaluation, including the FlowDefinition the image
|
|
3746
4152
|
* will be sent to.</p>
|
|
3747
4153
|
*/
|
|
@@ -3754,14 +4160,17 @@ export interface DetectModerationLabelsRequest {
|
|
|
3754
4160
|
*/
|
|
3755
4161
|
export interface HumanLoopActivationOutput {
|
|
3756
4162
|
/**
|
|
4163
|
+
* @public
|
|
3757
4164
|
* <p>The Amazon Resource Name (ARN) of the HumanLoop created.</p>
|
|
3758
4165
|
*/
|
|
3759
4166
|
HumanLoopArn?: string;
|
|
3760
4167
|
/**
|
|
4168
|
+
* @public
|
|
3761
4169
|
* <p>Shows if and why human review was needed.</p>
|
|
3762
4170
|
*/
|
|
3763
4171
|
HumanLoopActivationReasons?: string[];
|
|
3764
4172
|
/**
|
|
4173
|
+
* @public
|
|
3765
4174
|
* <p>Shows the result of condition evaluations, including those conditions which activated a
|
|
3766
4175
|
* human review.</p>
|
|
3767
4176
|
*/
|
|
@@ -3772,16 +4181,19 @@ export interface HumanLoopActivationOutput {
|
|
|
3772
4181
|
*/
|
|
3773
4182
|
export interface DetectModerationLabelsResponse {
|
|
3774
4183
|
/**
|
|
4184
|
+
* @public
|
|
3775
4185
|
* <p>Array of detected Moderation labels and the time, in milliseconds from the start of the
|
|
3776
4186
|
* video, they were detected.</p>
|
|
3777
4187
|
*/
|
|
3778
4188
|
ModerationLabels?: ModerationLabel[];
|
|
3779
4189
|
/**
|
|
4190
|
+
* @public
|
|
3780
4191
|
* <p>Version number of the moderation detection model that was used to detect unsafe
|
|
3781
4192
|
* content.</p>
|
|
3782
4193
|
*/
|
|
3783
4194
|
ModerationModelVersion?: string;
|
|
3784
4195
|
/**
|
|
4196
|
+
* @public
|
|
3785
4197
|
* <p>Shows the results of the human in the loop evaluation.</p>
|
|
3786
4198
|
*/
|
|
3787
4199
|
HumanLoopActivationOutput?: HumanLoopActivationOutput;
|
|
@@ -3794,20 +4206,24 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
|
|
|
3794
4206
|
readonly name: "HumanLoopQuotaExceededException";
|
|
3795
4207
|
readonly $fault: "client";
|
|
3796
4208
|
/**
|
|
4209
|
+
* @public
|
|
3797
4210
|
* <p>The resource type.</p>
|
|
3798
4211
|
*/
|
|
3799
4212
|
ResourceType?: string;
|
|
3800
4213
|
/**
|
|
4214
|
+
* @public
|
|
3801
4215
|
* <p>The quota code.</p>
|
|
3802
4216
|
*/
|
|
3803
4217
|
QuotaCode?: string;
|
|
3804
4218
|
/**
|
|
4219
|
+
* @public
|
|
3805
4220
|
* <p>The service code.</p>
|
|
3806
4221
|
*/
|
|
3807
4222
|
ServiceCode?: string;
|
|
3808
4223
|
Message?: string;
|
|
3809
4224
|
Code?: string;
|
|
3810
4225
|
/**
|
|
4226
|
+
* @public
|
|
3811
4227
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
3812
4228
|
*/
|
|
3813
4229
|
Logref?: string;
|
|
@@ -3828,6 +4244,7 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
|
|
|
3828
4244
|
*/
|
|
3829
4245
|
export interface ProtectiveEquipmentSummarizationAttributes {
|
|
3830
4246
|
/**
|
|
4247
|
+
* @public
|
|
3831
4248
|
* <p>The minimum confidence level for which you want summary information.
|
|
3832
4249
|
* The confidence level applies to person detection, body part detection, equipment detection, and body part coverage.
|
|
3833
4250
|
* Amazon Rekognition doesn't return summary information with a confidence than this specified value. There isn't a
|
|
@@ -3840,6 +4257,7 @@ export interface ProtectiveEquipmentSummarizationAttributes {
|
|
|
3840
4257
|
*/
|
|
3841
4258
|
MinConfidence: number | undefined;
|
|
3842
4259
|
/**
|
|
4260
|
+
* @public
|
|
3843
4261
|
* <p>An array of personal protective equipment types for which you want summary information.
|
|
3844
4262
|
* If a person is detected wearing a required requipment type, the person's ID is added to the
|
|
3845
4263
|
* <code>PersonsWithRequiredEquipment</code> array field returned in <a>ProtectiveEquipmentSummary</a>
|
|
@@ -3852,11 +4270,13 @@ export interface ProtectiveEquipmentSummarizationAttributes {
|
|
|
3852
4270
|
*/
|
|
3853
4271
|
export interface DetectProtectiveEquipmentRequest {
|
|
3854
4272
|
/**
|
|
4273
|
+
* @public
|
|
3855
4274
|
* <p>The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can
|
|
3856
4275
|
* reference an image stored in an Amazon S3 bucket. </p>
|
|
3857
4276
|
*/
|
|
3858
4277
|
Image: Image | undefined;
|
|
3859
4278
|
/**
|
|
4279
|
+
* @public
|
|
3860
4280
|
* <p>An array of PPE types that you want to summarize.</p>
|
|
3861
4281
|
*/
|
|
3862
4282
|
SummarizationAttributes?: ProtectiveEquipmentSummarizationAttributes;
|
|
@@ -3869,18 +4289,22 @@ export interface DetectProtectiveEquipmentRequest {
|
|
|
3869
4289
|
*/
|
|
3870
4290
|
export interface ProtectiveEquipmentPerson {
|
|
3871
4291
|
/**
|
|
4292
|
+
* @public
|
|
3872
4293
|
* <p>An array of body parts detected on a person's body (including body parts without PPE). </p>
|
|
3873
4294
|
*/
|
|
3874
4295
|
BodyParts?: ProtectiveEquipmentBodyPart[];
|
|
3875
4296
|
/**
|
|
4297
|
+
* @public
|
|
3876
4298
|
* <p>A bounding box around the detected person.</p>
|
|
3877
4299
|
*/
|
|
3878
4300
|
BoundingBox?: BoundingBox;
|
|
3879
4301
|
/**
|
|
4302
|
+
* @public
|
|
3880
4303
|
* <p>The confidence that Amazon Rekognition has that the bounding box contains a person.</p>
|
|
3881
4304
|
*/
|
|
3882
4305
|
Confidence?: number;
|
|
3883
4306
|
/**
|
|
4307
|
+
* @public
|
|
3884
4308
|
* <p>The identifier for the detected person. The identifier is only unique for a single call to
|
|
3885
4309
|
* <code>DetectProtectiveEquipment</code>.</p>
|
|
3886
4310
|
*/
|
|
@@ -3907,17 +4331,20 @@ export interface ProtectiveEquipmentPerson {
|
|
|
3907
4331
|
*/
|
|
3908
4332
|
export interface ProtectiveEquipmentSummary {
|
|
3909
4333
|
/**
|
|
4334
|
+
* @public
|
|
3910
4335
|
* <p>An array of IDs for persons who are wearing detected personal protective equipment.
|
|
3911
4336
|
* </p>
|
|
3912
4337
|
*/
|
|
3913
4338
|
PersonsWithRequiredEquipment?: number[];
|
|
3914
4339
|
/**
|
|
4340
|
+
* @public
|
|
3915
4341
|
* <p>An array of IDs for persons who are not wearing all of the types of PPE specified in the <code>RequiredEquipmentTypes</code> field of
|
|
3916
4342
|
* the detected personal protective equipment.
|
|
3917
4343
|
* </p>
|
|
3918
4344
|
*/
|
|
3919
4345
|
PersonsWithoutRequiredEquipment?: number[];
|
|
3920
4346
|
/**
|
|
4347
|
+
* @public
|
|
3921
4348
|
* <p>An array of IDs for persons where it was not possible to determine if they are wearing personal protective equipment.
|
|
3922
4349
|
* </p>
|
|
3923
4350
|
*/
|
|
@@ -3928,14 +4355,17 @@ export interface ProtectiveEquipmentSummary {
|
|
|
3928
4355
|
*/
|
|
3929
4356
|
export interface DetectProtectiveEquipmentResponse {
|
|
3930
4357
|
/**
|
|
4358
|
+
* @public
|
|
3931
4359
|
* <p>The version number of the PPE detection model used to detect PPE in the image.</p>
|
|
3932
4360
|
*/
|
|
3933
4361
|
ProtectiveEquipmentModelVersion?: string;
|
|
3934
4362
|
/**
|
|
4363
|
+
* @public
|
|
3935
4364
|
* <p>An array of persons detected in the image (including persons not wearing PPE).</p>
|
|
3936
4365
|
*/
|
|
3937
4366
|
Persons?: ProtectiveEquipmentPerson[];
|
|
3938
4367
|
/**
|
|
4368
|
+
* @public
|
|
3939
4369
|
* <p>Summary information for the types of PPE specified in the <code>SummarizationAttributes</code> input
|
|
3940
4370
|
* parameter.</p>
|
|
3941
4371
|
*/
|
|
@@ -3950,10 +4380,12 @@ export interface DetectProtectiveEquipmentResponse {
|
|
|
3950
4380
|
*/
|
|
3951
4381
|
export interface DetectTextFilters {
|
|
3952
4382
|
/**
|
|
4383
|
+
* @public
|
|
3953
4384
|
* <p>A set of parameters that allow you to filter out certain results from your returned results.</p>
|
|
3954
4385
|
*/
|
|
3955
4386
|
WordFilter?: DetectionFilter;
|
|
3956
4387
|
/**
|
|
4388
|
+
* @public
|
|
3957
4389
|
* <p> A Filter focusing on a certain area of the image. Uses a <code>BoundingBox</code> object
|
|
3958
4390
|
* to set the region of the image.</p>
|
|
3959
4391
|
*/
|
|
@@ -3964,6 +4396,7 @@ export interface DetectTextFilters {
|
|
|
3964
4396
|
*/
|
|
3965
4397
|
export interface DetectTextRequest {
|
|
3966
4398
|
/**
|
|
4399
|
+
* @public
|
|
3967
4400
|
* <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS
|
|
3968
4401
|
* CLI to call Amazon Rekognition operations, you can't pass image bytes. </p>
|
|
3969
4402
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -3972,6 +4405,7 @@ export interface DetectTextRequest {
|
|
|
3972
4405
|
*/
|
|
3973
4406
|
Image: Image | undefined;
|
|
3974
4407
|
/**
|
|
4408
|
+
* @public
|
|
3975
4409
|
* <p>Optional parameters that let you set the criteria that the text must meet to be included
|
|
3976
4410
|
* in your response.</p>
|
|
3977
4411
|
*/
|
|
@@ -4003,30 +4437,36 @@ export type TextTypes = (typeof TextTypes)[keyof typeof TextTypes];
|
|
|
4003
4437
|
*/
|
|
4004
4438
|
export interface TextDetection {
|
|
4005
4439
|
/**
|
|
4440
|
+
* @public
|
|
4006
4441
|
* <p>The word or line of text recognized by Amazon Rekognition. </p>
|
|
4007
4442
|
*/
|
|
4008
4443
|
DetectedText?: string;
|
|
4009
4444
|
/**
|
|
4445
|
+
* @public
|
|
4010
4446
|
* <p>The type of text that was detected.</p>
|
|
4011
4447
|
*/
|
|
4012
4448
|
Type?: TextTypes | string;
|
|
4013
4449
|
/**
|
|
4450
|
+
* @public
|
|
4014
4451
|
* <p>The identifier for the detected text. The identifier is only unique for a single call
|
|
4015
4452
|
* to <code>DetectText</code>. </p>
|
|
4016
4453
|
*/
|
|
4017
4454
|
Id?: number;
|
|
4018
4455
|
/**
|
|
4456
|
+
* @public
|
|
4019
4457
|
* <p>The Parent identifier for the detected text identified by the value of <code>ID</code>.
|
|
4020
4458
|
* If the type of detected text is <code>LINE</code>, the value of <code>ParentId</code> is
|
|
4021
4459
|
* <code>Null</code>. </p>
|
|
4022
4460
|
*/
|
|
4023
4461
|
ParentId?: number;
|
|
4024
4462
|
/**
|
|
4463
|
+
* @public
|
|
4025
4464
|
* <p>The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy
|
|
4026
4465
|
* of the geometry points around the detected text.</p>
|
|
4027
4466
|
*/
|
|
4028
4467
|
Confidence?: number;
|
|
4029
4468
|
/**
|
|
4469
|
+
* @public
|
|
4030
4470
|
* <p>The location of the detected text on the image. Includes an axis aligned coarse
|
|
4031
4471
|
* bounding box surrounding the text and a finer grain polygon for more accurate spatial
|
|
4032
4472
|
* information.</p>
|
|
@@ -4038,10 +4478,12 @@ export interface TextDetection {
|
|
|
4038
4478
|
*/
|
|
4039
4479
|
export interface DetectTextResponse {
|
|
4040
4480
|
/**
|
|
4481
|
+
* @public
|
|
4041
4482
|
* <p>An array of text that was detected in the input image.</p>
|
|
4042
4483
|
*/
|
|
4043
4484
|
TextDetections?: TextDetection[];
|
|
4044
4485
|
/**
|
|
4486
|
+
* @public
|
|
4045
4487
|
* <p>The model version used to detect text.</p>
|
|
4046
4488
|
*/
|
|
4047
4489
|
TextModelVersion?: string;
|
|
@@ -4052,6 +4494,7 @@ export interface DetectTextResponse {
|
|
|
4052
4494
|
*/
|
|
4053
4495
|
export interface DisassociatedFace {
|
|
4054
4496
|
/**
|
|
4497
|
+
* @public
|
|
4055
4498
|
* <p>Unique identifier assigned to the face.</p>
|
|
4056
4499
|
*/
|
|
4057
4500
|
FaceId?: string;
|
|
@@ -4061,14 +4504,17 @@ export interface DisassociatedFace {
|
|
|
4061
4504
|
*/
|
|
4062
4505
|
export interface DisassociateFacesRequest {
|
|
4063
4506
|
/**
|
|
4507
|
+
* @public
|
|
4064
4508
|
* <p>The ID of an existing collection containing the UserID.</p>
|
|
4065
4509
|
*/
|
|
4066
4510
|
CollectionId: string | undefined;
|
|
4067
4511
|
/**
|
|
4512
|
+
* @public
|
|
4068
4513
|
* <p>ID for the existing UserID.</p>
|
|
4069
4514
|
*/
|
|
4070
4515
|
UserId: string | undefined;
|
|
4071
4516
|
/**
|
|
4517
|
+
* @public
|
|
4072
4518
|
* <p>Idempotent token used to identify the request to <code>DisassociateFaces</code>. If you
|
|
4073
4519
|
* use the same token with multiple <code>DisassociateFaces</code> requests, the same response is
|
|
4074
4520
|
* returned. Use ClientRequestToken to prevent the same request from being processed more than
|
|
@@ -4076,6 +4522,7 @@ export interface DisassociateFacesRequest {
|
|
|
4076
4522
|
*/
|
|
4077
4523
|
ClientRequestToken?: string;
|
|
4078
4524
|
/**
|
|
4525
|
+
* @public
|
|
4079
4526
|
* <p>An array of face IDs to disassociate from the UserID. </p>
|
|
4080
4527
|
*/
|
|
4081
4528
|
FaceIds: string[] | undefined;
|
|
@@ -4098,14 +4545,17 @@ export type UnsuccessfulFaceDisassociationReason = (typeof UnsuccessfulFaceDisas
|
|
|
4098
4545
|
*/
|
|
4099
4546
|
export interface UnsuccessfulFaceDisassociation {
|
|
4100
4547
|
/**
|
|
4548
|
+
* @public
|
|
4101
4549
|
* <p>A unique identifier assigned to the face. </p>
|
|
4102
4550
|
*/
|
|
4103
4551
|
FaceId?: string;
|
|
4104
4552
|
/**
|
|
4553
|
+
* @public
|
|
4105
4554
|
* <p>A provided ID for the UserID. Unique within the collection. </p>
|
|
4106
4555
|
*/
|
|
4107
4556
|
UserId?: string;
|
|
4108
4557
|
/**
|
|
4558
|
+
* @public
|
|
4109
4559
|
* <p>The reason why the deletion was unsuccessful. </p>
|
|
4110
4560
|
*/
|
|
4111
4561
|
Reasons?: (UnsuccessfulFaceDisassociationReason | string)[];
|
|
@@ -4115,17 +4565,20 @@ export interface UnsuccessfulFaceDisassociation {
|
|
|
4115
4565
|
*/
|
|
4116
4566
|
export interface DisassociateFacesResponse {
|
|
4117
4567
|
/**
|
|
4568
|
+
* @public
|
|
4118
4569
|
* <p>An array of DissociatedFace objects containing FaceIds that are successfully disassociated
|
|
4119
4570
|
* with the UserID is returned. Returned if the DisassociatedFaces action is successful.</p>
|
|
4120
4571
|
*/
|
|
4121
4572
|
DisassociatedFaces?: DisassociatedFace[];
|
|
4122
4573
|
/**
|
|
4574
|
+
* @public
|
|
4123
4575
|
* <p>An array of UnsuccessfulDisassociation objects containing FaceIds that are not
|
|
4124
4576
|
* successfully associated, along with the reasons for the failure to associate. Returned if the
|
|
4125
4577
|
* DisassociateFaces action is successful.</p>
|
|
4126
4578
|
*/
|
|
4127
4579
|
UnsuccessfulFaceDisassociations?: UnsuccessfulFaceDisassociation[];
|
|
4128
4580
|
/**
|
|
4581
|
+
* @public
|
|
4129
4582
|
* <p>The status of an update made to a User. Reflects if the User has been updated for every requested change.</p>
|
|
4130
4583
|
*/
|
|
4131
4584
|
UserStatus?: UserStatus | string;
|
|
@@ -4139,6 +4592,7 @@ export interface DisassociateFacesResponse {
|
|
|
4139
4592
|
*/
|
|
4140
4593
|
export interface DistributeDataset {
|
|
4141
4594
|
/**
|
|
4595
|
+
* @public
|
|
4142
4596
|
* <p>The Amazon Resource Name (ARN) of the dataset that you want to use.
|
|
4143
4597
|
* </p>
|
|
4144
4598
|
*/
|
|
@@ -4149,6 +4603,7 @@ export interface DistributeDataset {
|
|
|
4149
4603
|
*/
|
|
4150
4604
|
export interface DistributeDatasetEntriesRequest {
|
|
4151
4605
|
/**
|
|
4606
|
+
* @public
|
|
4152
4607
|
* <p>The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to
|
|
4153
4608
|
* the same project. The test dataset must be empty.
|
|
4154
4609
|
* </p>
|
|
@@ -4167,32 +4622,39 @@ export interface DistributeDatasetEntriesResponse {
|
|
|
4167
4622
|
*/
|
|
4168
4623
|
export interface Face {
|
|
4169
4624
|
/**
|
|
4625
|
+
* @public
|
|
4170
4626
|
* <p>Unique identifier that Amazon Rekognition assigns to the face.</p>
|
|
4171
4627
|
*/
|
|
4172
4628
|
FaceId?: string;
|
|
4173
4629
|
/**
|
|
4630
|
+
* @public
|
|
4174
4631
|
* <p>Bounding box of the face.</p>
|
|
4175
4632
|
*/
|
|
4176
4633
|
BoundingBox?: BoundingBox;
|
|
4177
4634
|
/**
|
|
4635
|
+
* @public
|
|
4178
4636
|
* <p>Unique identifier that Amazon Rekognition assigns to the input image.</p>
|
|
4179
4637
|
*/
|
|
4180
4638
|
ImageId?: string;
|
|
4181
4639
|
/**
|
|
4640
|
+
* @public
|
|
4182
4641
|
* <p>Identifier that you assign to all the faces in the input image.</p>
|
|
4183
4642
|
*/
|
|
4184
4643
|
ExternalImageId?: string;
|
|
4185
4644
|
/**
|
|
4645
|
+
* @public
|
|
4186
4646
|
* <p>Confidence level that the bounding box contains a face (and not a different object such
|
|
4187
4647
|
* as a tree).</p>
|
|
4188
4648
|
*/
|
|
4189
4649
|
Confidence?: number;
|
|
4190
4650
|
/**
|
|
4651
|
+
* @public
|
|
4191
4652
|
* <p> The version of the face detect and storage model that was used when indexing the face
|
|
4192
4653
|
* vector. </p>
|
|
4193
4654
|
*/
|
|
4194
4655
|
IndexFacesModelVersion?: string;
|
|
4195
4656
|
/**
|
|
4657
|
+
* @public
|
|
4196
4658
|
* <p>Unique identifier assigned to the user.</p>
|
|
4197
4659
|
*/
|
|
4198
4660
|
UserId?: string;
|
|
@@ -4215,11 +4677,13 @@ export type FaceAttributes = (typeof FaceAttributes)[keyof typeof FaceAttributes
|
|
|
4215
4677
|
*/
|
|
4216
4678
|
export interface FaceDetection {
|
|
4217
4679
|
/**
|
|
4680
|
+
* @public
|
|
4218
4681
|
* <p>Time, in milliseconds from the start of the video, that the face was detected.
|
|
4219
4682
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the face first appears.</p>
|
|
4220
4683
|
*/
|
|
4221
4684
|
Timestamp?: number;
|
|
4222
4685
|
/**
|
|
4686
|
+
* @public
|
|
4223
4687
|
* <p>The face properties for the detected face.</p>
|
|
4224
4688
|
*/
|
|
4225
4689
|
Face?: FaceDetail;
|
|
@@ -4231,10 +4695,12 @@ export interface FaceDetection {
|
|
|
4231
4695
|
*/
|
|
4232
4696
|
export interface FaceMatch {
|
|
4233
4697
|
/**
|
|
4698
|
+
* @public
|
|
4234
4699
|
* <p>Confidence in the match of this face with the input face.</p>
|
|
4235
4700
|
*/
|
|
4236
4701
|
Similarity?: number;
|
|
4237
4702
|
/**
|
|
4703
|
+
* @public
|
|
4238
4704
|
* <p>Describes the face properties such as the bounding box, face ID, image ID of the source
|
|
4239
4705
|
* image, and external image ID that you assigned.</p>
|
|
4240
4706
|
*/
|
|
@@ -4247,11 +4713,13 @@ export interface FaceMatch {
|
|
|
4247
4713
|
*/
|
|
4248
4714
|
export interface FaceRecord {
|
|
4249
4715
|
/**
|
|
4716
|
+
* @public
|
|
4250
4717
|
* <p>Describes the face properties such as the bounding box, face ID, image ID of the input
|
|
4251
4718
|
* image, and external image ID that you assigned. </p>
|
|
4252
4719
|
*/
|
|
4253
4720
|
Face?: Face;
|
|
4254
4721
|
/**
|
|
4722
|
+
* @public
|
|
4255
4723
|
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
4256
4724
|
*/
|
|
4257
4725
|
FaceDetail?: FaceDetail;
|
|
@@ -4273,6 +4741,7 @@ export type FaceSearchSortBy = (typeof FaceSearchSortBy)[keyof typeof FaceSearch
|
|
|
4273
4741
|
*/
|
|
4274
4742
|
export interface GetCelebrityInfoRequest {
|
|
4275
4743
|
/**
|
|
4744
|
+
* @public
|
|
4276
4745
|
* <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.
|
|
4277
4746
|
* </p>
|
|
4278
4747
|
*/
|
|
@@ -4283,14 +4752,17 @@ export interface GetCelebrityInfoRequest {
|
|
|
4283
4752
|
*/
|
|
4284
4753
|
export interface GetCelebrityInfoResponse {
|
|
4285
4754
|
/**
|
|
4755
|
+
* @public
|
|
4286
4756
|
* <p>An array of URLs pointing to additional celebrity information. </p>
|
|
4287
4757
|
*/
|
|
4288
4758
|
Urls?: string[];
|
|
4289
4759
|
/**
|
|
4760
|
+
* @public
|
|
4290
4761
|
* <p>The name of the celebrity.</p>
|
|
4291
4762
|
*/
|
|
4292
4763
|
Name?: string;
|
|
4293
4764
|
/**
|
|
4765
|
+
* @public
|
|
4294
4766
|
* <p>Retrieves the known gender for the celebrity.</p>
|
|
4295
4767
|
*/
|
|
4296
4768
|
KnownGender?: KnownGender;
|
|
@@ -4300,22 +4772,26 @@ export interface GetCelebrityInfoResponse {
|
|
|
4300
4772
|
*/
|
|
4301
4773
|
export interface GetCelebrityRecognitionRequest {
|
|
4302
4774
|
/**
|
|
4775
|
+
* @public
|
|
4303
4776
|
* <p>Job identifier for the required celebrity recognition analysis. You can get the job identifer from
|
|
4304
4777
|
* a call to <code>StartCelebrityRecognition</code>.</p>
|
|
4305
4778
|
*/
|
|
4306
4779
|
JobId: string | undefined;
|
|
4307
4780
|
/**
|
|
4781
|
+
* @public
|
|
4308
4782
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4309
4783
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4310
4784
|
* The default value is 1000.</p>
|
|
4311
4785
|
*/
|
|
4312
4786
|
MaxResults?: number;
|
|
4313
4787
|
/**
|
|
4788
|
+
* @public
|
|
4314
4789
|
* <p>If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination
|
|
4315
4790
|
* token in the response. You can use this pagination token to retrieve the next set of celebrities. </p>
|
|
4316
4791
|
*/
|
|
4317
4792
|
NextToken?: string;
|
|
4318
4793
|
/**
|
|
4794
|
+
* @public
|
|
4319
4795
|
* <p>Sort to use for celebrities returned in <code>Celebrities</code> field. Specify <code>ID</code> to sort by the celebrity identifier,
|
|
4320
4796
|
* specify <code>TIMESTAMP</code> to sort by the time the celebrity was recognized.</p>
|
|
4321
4797
|
*/
|
|
@@ -4341,6 +4817,7 @@ export type VideoJobStatus = (typeof VideoJobStatus)[keyof typeof VideoJobStatus
|
|
|
4341
4817
|
*/
|
|
4342
4818
|
export interface Video {
|
|
4343
4819
|
/**
|
|
4820
|
+
* @public
|
|
4344
4821
|
* <p>The Amazon S3 bucket name and file name for the video.</p>
|
|
4345
4822
|
*/
|
|
4346
4823
|
S3Object?: S3Object;
|
|
@@ -4364,30 +4841,37 @@ export type VideoColorRange = (typeof VideoColorRange)[keyof typeof VideoColorRa
|
|
|
4364
4841
|
*/
|
|
4365
4842
|
export interface VideoMetadata {
|
|
4366
4843
|
/**
|
|
4844
|
+
* @public
|
|
4367
4845
|
* <p>Type of compression used in the analyzed video. </p>
|
|
4368
4846
|
*/
|
|
4369
4847
|
Codec?: string;
|
|
4370
4848
|
/**
|
|
4849
|
+
* @public
|
|
4371
4850
|
* <p>Length of the video in milliseconds.</p>
|
|
4372
4851
|
*/
|
|
4373
4852
|
DurationMillis?: number;
|
|
4374
4853
|
/**
|
|
4854
|
+
* @public
|
|
4375
4855
|
* <p>Format of the analyzed video. Possible values are MP4, MOV and AVI. </p>
|
|
4376
4856
|
*/
|
|
4377
4857
|
Format?: string;
|
|
4378
4858
|
/**
|
|
4859
|
+
* @public
|
|
4379
4860
|
* <p>Number of frames per second in the video.</p>
|
|
4380
4861
|
*/
|
|
4381
4862
|
FrameRate?: number;
|
|
4382
4863
|
/**
|
|
4864
|
+
* @public
|
|
4383
4865
|
* <p>Vertical pixel dimension of the video.</p>
|
|
4384
4866
|
*/
|
|
4385
4867
|
FrameHeight?: number;
|
|
4386
4868
|
/**
|
|
4869
|
+
* @public
|
|
4387
4870
|
* <p>Horizontal pixel dimension of the video.</p>
|
|
4388
4871
|
*/
|
|
4389
4872
|
FrameWidth?: number;
|
|
4390
4873
|
/**
|
|
4874
|
+
* @public
|
|
4391
4875
|
* <p>
|
|
4392
4876
|
* A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).
|
|
4393
4877
|
* </p>
|
|
@@ -4399,39 +4883,47 @@ export interface VideoMetadata {
|
|
|
4399
4883
|
*/
|
|
4400
4884
|
export interface GetCelebrityRecognitionResponse {
|
|
4401
4885
|
/**
|
|
4886
|
+
* @public
|
|
4402
4887
|
* <p>The current status of the celebrity recognition job.</p>
|
|
4403
4888
|
*/
|
|
4404
4889
|
JobStatus?: VideoJobStatus | string;
|
|
4405
4890
|
/**
|
|
4891
|
+
* @public
|
|
4406
4892
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
4407
4893
|
*/
|
|
4408
4894
|
StatusMessage?: string;
|
|
4409
4895
|
/**
|
|
4896
|
+
* @public
|
|
4410
4897
|
* <p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in
|
|
4411
4898
|
* every page of paginated responses from a Amazon Rekognition Video operation.</p>
|
|
4412
4899
|
*/
|
|
4413
4900
|
VideoMetadata?: VideoMetadata;
|
|
4414
4901
|
/**
|
|
4902
|
+
* @public
|
|
4415
4903
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request
|
|
4416
4904
|
* to retrieve the next set of celebrities.</p>
|
|
4417
4905
|
*/
|
|
4418
4906
|
NextToken?: string;
|
|
4419
4907
|
/**
|
|
4908
|
+
* @public
|
|
4420
4909
|
* <p>Array of celebrities recognized in the video.</p>
|
|
4421
4910
|
*/
|
|
4422
4911
|
Celebrities?: CelebrityRecognition[];
|
|
4423
4912
|
/**
|
|
4913
|
+
* @public
|
|
4424
4914
|
* <p>Job identifier for the celebrity recognition operation for which you
|
|
4425
4915
|
* want to obtain results. The job identifer is returned by an initial call
|
|
4426
4916
|
* to StartCelebrityRecognition.</p>
|
|
4427
4917
|
*/
|
|
4428
4918
|
JobId?: string;
|
|
4429
4919
|
/**
|
|
4920
|
+
* @public
|
|
4430
4921
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
4431
4922
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
4432
4923
|
*/
|
|
4433
4924
|
Video?: Video;
|
|
4434
4925
|
/**
|
|
4926
|
+
* @public
|
|
4435
4927
|
* <p>A job identifier specified in the call to StartCelebrityRecognition and
|
|
4436
4928
|
* returned in the job completion notification sent to your
|
|
4437
4929
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -4443,23 +4935,27 @@ export interface GetCelebrityRecognitionResponse {
|
|
|
4443
4935
|
*/
|
|
4444
4936
|
export interface GetContentModerationRequest {
|
|
4445
4937
|
/**
|
|
4938
|
+
* @public
|
|
4446
4939
|
* <p>The identifier for the inappropriate, unwanted, or offensive content moderation job. Use <code>JobId</code> to identify the job in
|
|
4447
4940
|
* a subsequent call to <code>GetContentModeration</code>.</p>
|
|
4448
4941
|
*/
|
|
4449
4942
|
JobId: string | undefined;
|
|
4450
4943
|
/**
|
|
4944
|
+
* @public
|
|
4451
4945
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4452
4946
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4453
4947
|
* The default value is 1000.</p>
|
|
4454
4948
|
*/
|
|
4455
4949
|
MaxResults?: number;
|
|
4456
4950
|
/**
|
|
4951
|
+
* @public
|
|
4457
4952
|
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition
|
|
4458
4953
|
* returns a pagination token in the response. You can use this pagination token
|
|
4459
4954
|
* to retrieve the next set of content moderation labels.</p>
|
|
4460
4955
|
*/
|
|
4461
4956
|
NextToken?: string;
|
|
4462
4957
|
/**
|
|
4958
|
+
* @public
|
|
4463
4959
|
* <p>Sort to use for elements in the <code>ModerationLabelDetections</code> array.
|
|
4464
4960
|
* Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected.
|
|
4465
4961
|
* Use <code>NAME</code> to alphabetically group elements for a label together.
|
|
@@ -4468,6 +4964,7 @@ export interface GetContentModerationRequest {
|
|
|
4468
4964
|
*/
|
|
4469
4965
|
SortBy?: ContentModerationSortBy | string;
|
|
4470
4966
|
/**
|
|
4967
|
+
* @public
|
|
4471
4968
|
* <p>Defines how to aggregate results of the StartContentModeration request.
|
|
4472
4969
|
* Default aggregation option is TIMESTAMPS.
|
|
4473
4970
|
* SEGMENTS mode aggregates moderation labels over time.</p>
|
|
@@ -4481,10 +4978,12 @@ export interface GetContentModerationRequest {
|
|
|
4481
4978
|
*/
|
|
4482
4979
|
export interface GetContentModerationRequestMetadata {
|
|
4483
4980
|
/**
|
|
4981
|
+
* @public
|
|
4484
4982
|
* <p>The sorting method chosen for a GetContentModeration request.</p>
|
|
4485
4983
|
*/
|
|
4486
4984
|
SortBy?: ContentModerationSortBy | string;
|
|
4487
4985
|
/**
|
|
4986
|
+
* @public
|
|
4488
4987
|
* <p>The aggregation method chosen for a GetContentModeration request.</p>
|
|
4489
4988
|
*/
|
|
4490
4989
|
AggregateBy?: ContentModerationAggregateBy | string;
|
|
@@ -4494,49 +4993,59 @@ export interface GetContentModerationRequestMetadata {
|
|
|
4494
4993
|
*/
|
|
4495
4994
|
export interface GetContentModerationResponse {
|
|
4496
4995
|
/**
|
|
4996
|
+
* @public
|
|
4497
4997
|
* <p>The current status of the content moderation analysis job.</p>
|
|
4498
4998
|
*/
|
|
4499
4999
|
JobStatus?: VideoJobStatus | string;
|
|
4500
5000
|
/**
|
|
5001
|
+
* @public
|
|
4501
5002
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
4502
5003
|
*/
|
|
4503
5004
|
StatusMessage?: string;
|
|
4504
5005
|
/**
|
|
5006
|
+
* @public
|
|
4505
5007
|
* <p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code>
|
|
4506
5008
|
* is returned in every page of paginated responses from <code>GetContentModeration</code>. </p>
|
|
4507
5009
|
*/
|
|
4508
5010
|
VideoMetadata?: VideoMetadata;
|
|
4509
5011
|
/**
|
|
5012
|
+
* @public
|
|
4510
5013
|
* <p>The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.</p>
|
|
4511
5014
|
*/
|
|
4512
5015
|
ModerationLabels?: ContentModerationDetection[];
|
|
4513
5016
|
/**
|
|
5017
|
+
* @public
|
|
4514
5018
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
|
|
4515
5019
|
* request to retrieve the next set of content moderation labels. </p>
|
|
4516
5020
|
*/
|
|
4517
5021
|
NextToken?: string;
|
|
4518
5022
|
/**
|
|
5023
|
+
* @public
|
|
4519
5024
|
* <p>Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.</p>
|
|
4520
5025
|
*/
|
|
4521
5026
|
ModerationModelVersion?: string;
|
|
4522
5027
|
/**
|
|
5028
|
+
* @public
|
|
4523
5029
|
* <p>Job identifier for the content moderation operation for which you
|
|
4524
5030
|
* want to obtain results. The job identifer is returned by an initial call
|
|
4525
5031
|
* to StartContentModeration.</p>
|
|
4526
5032
|
*/
|
|
4527
5033
|
JobId?: string;
|
|
4528
5034
|
/**
|
|
5035
|
+
* @public
|
|
4529
5036
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
4530
5037
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
4531
5038
|
*/
|
|
4532
5039
|
Video?: Video;
|
|
4533
5040
|
/**
|
|
5041
|
+
* @public
|
|
4534
5042
|
* <p>A job identifier specified in the call to StartContentModeration and
|
|
4535
5043
|
* returned in the job completion notification sent to your
|
|
4536
5044
|
* Amazon Simple Notification Service topic.</p>
|
|
4537
5045
|
*/
|
|
4538
5046
|
JobTag?: string;
|
|
4539
5047
|
/**
|
|
5048
|
+
* @public
|
|
4540
5049
|
* <p>Information about the paramters used when getting a response. Includes
|
|
4541
5050
|
* information on aggregation and sorting methods.</p>
|
|
4542
5051
|
*/
|
|
@@ -4547,16 +5056,19 @@ export interface GetContentModerationResponse {
|
|
|
4547
5056
|
*/
|
|
4548
5057
|
export interface GetFaceDetectionRequest {
|
|
4549
5058
|
/**
|
|
5059
|
+
* @public
|
|
4550
5060
|
* <p>Unique identifier for the face detection job. The <code>JobId</code> is returned from <code>StartFaceDetection</code>.</p>
|
|
4551
5061
|
*/
|
|
4552
5062
|
JobId: string | undefined;
|
|
4553
5063
|
/**
|
|
5064
|
+
* @public
|
|
4554
5065
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4555
5066
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4556
5067
|
* The default value is 1000.</p>
|
|
4557
5068
|
*/
|
|
4558
5069
|
MaxResults?: number;
|
|
4559
5070
|
/**
|
|
5071
|
+
* @public
|
|
4560
5072
|
* <p>If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination
|
|
4561
5073
|
* token in the response. You can use this pagination token to retrieve the next set of faces.</p>
|
|
4562
5074
|
*/
|
|
@@ -4567,39 +5079,47 @@ export interface GetFaceDetectionRequest {
|
|
|
4567
5079
|
*/
|
|
4568
5080
|
export interface GetFaceDetectionResponse {
|
|
4569
5081
|
/**
|
|
5082
|
+
* @public
|
|
4570
5083
|
* <p>The current status of the face detection job.</p>
|
|
4571
5084
|
*/
|
|
4572
5085
|
JobStatus?: VideoJobStatus | string;
|
|
4573
5086
|
/**
|
|
5087
|
+
* @public
|
|
4574
5088
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
4575
5089
|
*/
|
|
4576
5090
|
StatusMessage?: string;
|
|
4577
5091
|
/**
|
|
5092
|
+
* @public
|
|
4578
5093
|
* <p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in
|
|
4579
5094
|
* every page of paginated responses from a Amazon Rekognition video operation.</p>
|
|
4580
5095
|
*/
|
|
4581
5096
|
VideoMetadata?: VideoMetadata;
|
|
4582
5097
|
/**
|
|
5098
|
+
* @public
|
|
4583
5099
|
* <p>If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces. </p>
|
|
4584
5100
|
*/
|
|
4585
5101
|
NextToken?: string;
|
|
4586
5102
|
/**
|
|
5103
|
+
* @public
|
|
4587
5104
|
* <p>An array of faces detected in the video. Each element contains a detected face's details and the time,
|
|
4588
5105
|
* in milliseconds from the start of the video, the face was detected. </p>
|
|
4589
5106
|
*/
|
|
4590
5107
|
Faces?: FaceDetection[];
|
|
4591
5108
|
/**
|
|
5109
|
+
* @public
|
|
4592
5110
|
* <p>Job identifier for the face detection operation for which you
|
|
4593
5111
|
* want to obtain results. The job identifer is returned by an initial call
|
|
4594
5112
|
* to StartFaceDetection.</p>
|
|
4595
5113
|
*/
|
|
4596
5114
|
JobId?: string;
|
|
4597
5115
|
/**
|
|
5116
|
+
* @public
|
|
4598
5117
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
4599
5118
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
4600
5119
|
*/
|
|
4601
5120
|
Video?: Video;
|
|
4602
5121
|
/**
|
|
5122
|
+
* @public
|
|
4603
5123
|
* <p>A job identifier specified in the call to StartFaceDetection and
|
|
4604
5124
|
* returned in the job completion notification sent to your
|
|
4605
5125
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -4611,6 +5131,7 @@ export interface GetFaceDetectionResponse {
|
|
|
4611
5131
|
*/
|
|
4612
5132
|
export interface GetFaceLivenessSessionResultsRequest {
|
|
4613
5133
|
/**
|
|
5134
|
+
* @public
|
|
4614
5135
|
* <p>A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an
|
|
4615
5136
|
* idempotency token for all operations associated with the session.</p>
|
|
4616
5137
|
*/
|
|
@@ -4636,20 +5157,24 @@ export type LivenessSessionStatus = (typeof LivenessSessionStatus)[keyof typeof
|
|
|
4636
5157
|
*/
|
|
4637
5158
|
export interface GetFaceLivenessSessionResultsResponse {
|
|
4638
5159
|
/**
|
|
5160
|
+
* @public
|
|
4639
5161
|
* <p>The sessionId for which this request was called.</p>
|
|
4640
5162
|
*/
|
|
4641
5163
|
SessionId: string | undefined;
|
|
4642
5164
|
/**
|
|
5165
|
+
* @public
|
|
4643
5166
|
* <p>Represents a status corresponding to the state of the session. Possible statuses are:
|
|
4644
5167
|
* CREATED, IN_PROGRESS, SUCCEEDED, FAILED, EXPIRED.</p>
|
|
4645
5168
|
*/
|
|
4646
5169
|
Status: LivenessSessionStatus | string | undefined;
|
|
4647
5170
|
/**
|
|
5171
|
+
* @public
|
|
4648
5172
|
* <p>Probabalistic confidence score for if the person in the given video was live, represented as a
|
|
4649
5173
|
* float value between 0 to 100.</p>
|
|
4650
5174
|
*/
|
|
4651
5175
|
Confidence?: number;
|
|
4652
5176
|
/**
|
|
5177
|
+
* @public
|
|
4653
5178
|
* <p>A high-quality image from the Face Liveness video that can be used for face comparison or
|
|
4654
5179
|
* search. It includes a bounding box of the face and the Base64-encoded bytes that return an
|
|
4655
5180
|
* image. If the CreateFaceLivenessSession request included an OutputConfig argument, the image
|
|
@@ -4658,6 +5183,7 @@ export interface GetFaceLivenessSessionResultsResponse {
|
|
|
4658
5183
|
*/
|
|
4659
5184
|
ReferenceImage?: AuditImage;
|
|
4660
5185
|
/**
|
|
5186
|
+
* @public
|
|
4661
5187
|
* <p>A set of images from the Face Liveness video that can be used for audit purposes. It
|
|
4662
5188
|
* includes a bounding box of the face and the Base64-encoded bytes that return an image. If the
|
|
4663
5189
|
* CreateFaceLivenessSession request included an OutputConfig argument, the image will be
|
|
@@ -4675,6 +5201,7 @@ export declare class SessionNotFoundException extends __BaseException {
|
|
|
4675
5201
|
Message?: string;
|
|
4676
5202
|
Code?: string;
|
|
4677
5203
|
/**
|
|
5204
|
+
* @public
|
|
4678
5205
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
4679
5206
|
*/
|
|
4680
5207
|
Logref?: string;
|
|
@@ -4688,21 +5215,25 @@ export declare class SessionNotFoundException extends __BaseException {
|
|
|
4688
5215
|
*/
|
|
4689
5216
|
export interface GetFaceSearchRequest {
|
|
4690
5217
|
/**
|
|
5218
|
+
* @public
|
|
4691
5219
|
* <p>The job identifer for the search request. You get the job identifier from an initial call to <code>StartFaceSearch</code>.</p>
|
|
4692
5220
|
*/
|
|
4693
5221
|
JobId: string | undefined;
|
|
4694
5222
|
/**
|
|
5223
|
+
* @public
|
|
4695
5224
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4696
5225
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4697
5226
|
* The default value is 1000.</p>
|
|
4698
5227
|
*/
|
|
4699
5228
|
MaxResults?: number;
|
|
4700
5229
|
/**
|
|
5230
|
+
* @public
|
|
4701
5231
|
* <p>If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination
|
|
4702
5232
|
* token in the response. You can use this pagination token to retrieve the next set of search results. </p>
|
|
4703
5233
|
*/
|
|
4704
5234
|
NextToken?: string;
|
|
4705
5235
|
/**
|
|
5236
|
+
* @public
|
|
4706
5237
|
* <p>Sort to use for grouping faces in the response. Use <code>TIMESTAMP</code> to group faces by the time
|
|
4707
5238
|
* that they are recognized. Use <code>INDEX</code> to sort by recognized faces. </p>
|
|
4708
5239
|
*/
|
|
@@ -4714,14 +5245,17 @@ export interface GetFaceSearchRequest {
|
|
|
4714
5245
|
*/
|
|
4715
5246
|
export interface PersonDetail {
|
|
4716
5247
|
/**
|
|
5248
|
+
* @public
|
|
4717
5249
|
* <p>Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.</p>
|
|
4718
5250
|
*/
|
|
4719
5251
|
Index?: number;
|
|
4720
5252
|
/**
|
|
5253
|
+
* @public
|
|
4721
5254
|
* <p>Bounding box around the detected person.</p>
|
|
4722
5255
|
*/
|
|
4723
5256
|
BoundingBox?: BoundingBox;
|
|
4724
5257
|
/**
|
|
5258
|
+
* @public
|
|
4725
5259
|
* <p>Face details for the detected person.</p>
|
|
4726
5260
|
*/
|
|
4727
5261
|
Face?: FaceDetail;
|
|
@@ -4735,15 +5269,18 @@ export interface PersonDetail {
|
|
|
4735
5269
|
*/
|
|
4736
5270
|
export interface PersonMatch {
|
|
4737
5271
|
/**
|
|
5272
|
+
* @public
|
|
4738
5273
|
* <p>The time, in milliseconds from the beginning of the video, that the person was matched in
|
|
4739
5274
|
* the video.</p>
|
|
4740
5275
|
*/
|
|
4741
5276
|
Timestamp?: number;
|
|
4742
5277
|
/**
|
|
5278
|
+
* @public
|
|
4743
5279
|
* <p>Information about the matched person.</p>
|
|
4744
5280
|
*/
|
|
4745
5281
|
Person?: PersonDetail;
|
|
4746
5282
|
/**
|
|
5283
|
+
* @public
|
|
4747
5284
|
* <p>Information about the faces in the input collection that match the face of a person in the
|
|
4748
5285
|
* video.</p>
|
|
4749
5286
|
*/
|
|
@@ -4754,23 +5291,28 @@ export interface PersonMatch {
|
|
|
4754
5291
|
*/
|
|
4755
5292
|
export interface GetFaceSearchResponse {
|
|
4756
5293
|
/**
|
|
5294
|
+
* @public
|
|
4757
5295
|
* <p>The current status of the face search job.</p>
|
|
4758
5296
|
*/
|
|
4759
5297
|
JobStatus?: VideoJobStatus | string;
|
|
4760
5298
|
/**
|
|
5299
|
+
* @public
|
|
4761
5300
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
4762
5301
|
*/
|
|
4763
5302
|
StatusMessage?: string;
|
|
4764
5303
|
/**
|
|
5304
|
+
* @public
|
|
4765
5305
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results. </p>
|
|
4766
5306
|
*/
|
|
4767
5307
|
NextToken?: string;
|
|
4768
5308
|
/**
|
|
5309
|
+
* @public
|
|
4769
5310
|
* <p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code> is returned in every page of paginated responses
|
|
4770
5311
|
* from a Amazon Rekognition Video operation. </p>
|
|
4771
5312
|
*/
|
|
4772
5313
|
VideoMetadata?: VideoMetadata;
|
|
4773
5314
|
/**
|
|
5315
|
+
* @public
|
|
4774
5316
|
* <p>An array of persons, <a>PersonMatch</a>,
|
|
4775
5317
|
* in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information
|
|
4776
5318
|
* for when persons are matched in the video.
|
|
@@ -4781,17 +5323,20 @@ export interface GetFaceSearchResponse {
|
|
|
4781
5323
|
*/
|
|
4782
5324
|
Persons?: PersonMatch[];
|
|
4783
5325
|
/**
|
|
5326
|
+
* @public
|
|
4784
5327
|
* <p>Job identifier for the face search operation for which you
|
|
4785
5328
|
* want to obtain results. The job identifer is returned by an initial call
|
|
4786
5329
|
* to StartFaceSearch.</p>
|
|
4787
5330
|
*/
|
|
4788
5331
|
JobId?: string;
|
|
4789
5332
|
/**
|
|
5333
|
+
* @public
|
|
4790
5334
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
4791
5335
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
4792
5336
|
*/
|
|
4793
5337
|
Video?: Video;
|
|
4794
5338
|
/**
|
|
5339
|
+
* @public
|
|
4795
5340
|
* <p>A job identifier specified in the call to StartFaceSearch and
|
|
4796
5341
|
* returned in the job completion notification sent to your
|
|
4797
5342
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -4827,22 +5372,26 @@ export type LabelDetectionSortBy = (typeof LabelDetectionSortBy)[keyof typeof La
|
|
|
4827
5372
|
*/
|
|
4828
5373
|
export interface GetLabelDetectionRequest {
|
|
4829
5374
|
/**
|
|
5375
|
+
* @public
|
|
4830
5376
|
* <p>Job identifier for the label detection operation for which you want results returned. You get the job identifer from
|
|
4831
5377
|
* an initial call to <code>StartlabelDetection</code>.</p>
|
|
4832
5378
|
*/
|
|
4833
5379
|
JobId: string | undefined;
|
|
4834
5380
|
/**
|
|
5381
|
+
* @public
|
|
4835
5382
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4836
5383
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4837
5384
|
* The default value is 1000.</p>
|
|
4838
5385
|
*/
|
|
4839
5386
|
MaxResults?: number;
|
|
4840
5387
|
/**
|
|
5388
|
+
* @public
|
|
4841
5389
|
* <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination
|
|
4842
5390
|
* token in the response. You can use this pagination token to retrieve the next set of labels. </p>
|
|
4843
5391
|
*/
|
|
4844
5392
|
NextToken?: string;
|
|
4845
5393
|
/**
|
|
5394
|
+
* @public
|
|
4846
5395
|
* <p>Sort to use for elements in the <code>Labels</code> array.
|
|
4847
5396
|
* Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected.
|
|
4848
5397
|
* Use <code>NAME</code> to alphabetically group elements for a label together.
|
|
@@ -4851,6 +5400,7 @@ export interface GetLabelDetectionRequest {
|
|
|
4851
5400
|
*/
|
|
4852
5401
|
SortBy?: LabelDetectionSortBy | string;
|
|
4853
5402
|
/**
|
|
5403
|
+
* @public
|
|
4854
5404
|
* <p>Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.</p>
|
|
4855
5405
|
*/
|
|
4856
5406
|
AggregateBy?: LabelDetectionAggregateBy | string;
|
|
@@ -4862,10 +5412,12 @@ export interface GetLabelDetectionRequest {
|
|
|
4862
5412
|
*/
|
|
4863
5413
|
export interface GetLabelDetectionRequestMetadata {
|
|
4864
5414
|
/**
|
|
5415
|
+
* @public
|
|
4865
5416
|
* <p>The sorting method chosen for a GetLabelDetection request.</p>
|
|
4866
5417
|
*/
|
|
4867
5418
|
SortBy?: LabelDetectionSortBy | string;
|
|
4868
5419
|
/**
|
|
5420
|
+
* @public
|
|
4869
5421
|
* <p>The aggregation method chosen for a GetLabelDetection request.</p>
|
|
4870
5422
|
*/
|
|
4871
5423
|
AggregateBy?: LabelDetectionAggregateBy | string;
|
|
@@ -4876,23 +5428,28 @@ export interface GetLabelDetectionRequestMetadata {
|
|
|
4876
5428
|
*/
|
|
4877
5429
|
export interface LabelDetection {
|
|
4878
5430
|
/**
|
|
5431
|
+
* @public
|
|
4879
5432
|
* <p>Time, in milliseconds from the start of the video, that the label was detected.
|
|
4880
5433
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the label first appears.</p>
|
|
4881
5434
|
*/
|
|
4882
5435
|
Timestamp?: number;
|
|
4883
5436
|
/**
|
|
5437
|
+
* @public
|
|
4884
5438
|
* <p>Details about the detected label.</p>
|
|
4885
5439
|
*/
|
|
4886
5440
|
Label?: Label;
|
|
4887
5441
|
/**
|
|
5442
|
+
* @public
|
|
4888
5443
|
* <p>The time in milliseconds defining the start of the timeline segment containing a continuously detected label.</p>
|
|
4889
5444
|
*/
|
|
4890
5445
|
StartTimestampMillis?: number;
|
|
4891
5446
|
/**
|
|
5447
|
+
* @public
|
|
4892
5448
|
* <p>The time in milliseconds defining the end of the timeline segment containing a continuously detected label.</p>
|
|
4893
5449
|
*/
|
|
4894
5450
|
EndTimestampMillis?: number;
|
|
4895
5451
|
/**
|
|
5452
|
+
* @public
|
|
4896
5453
|
* <p>The time duration of a segment in milliseconds, I.e. time elapsed from StartTimestampMillis to EndTimestampMillis.</p>
|
|
4897
5454
|
*/
|
|
4898
5455
|
DurationMillis?: number;
|
|
@@ -4902,50 +5459,60 @@ export interface LabelDetection {
|
|
|
4902
5459
|
*/
|
|
4903
5460
|
export interface GetLabelDetectionResponse {
|
|
4904
5461
|
/**
|
|
5462
|
+
* @public
|
|
4905
5463
|
* <p>The current status of the label detection job.</p>
|
|
4906
5464
|
*/
|
|
4907
5465
|
JobStatus?: VideoJobStatus | string;
|
|
4908
5466
|
/**
|
|
5467
|
+
* @public
|
|
4909
5468
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
4910
5469
|
*/
|
|
4911
5470
|
StatusMessage?: string;
|
|
4912
5471
|
/**
|
|
5472
|
+
* @public
|
|
4913
5473
|
* <p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in
|
|
4914
5474
|
* every page of paginated responses from a Amazon Rekognition video operation.</p>
|
|
4915
5475
|
*/
|
|
4916
5476
|
VideoMetadata?: VideoMetadata;
|
|
4917
5477
|
/**
|
|
5478
|
+
* @public
|
|
4918
5479
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request
|
|
4919
5480
|
* to retrieve the next set of labels.</p>
|
|
4920
5481
|
*/
|
|
4921
5482
|
NextToken?: string;
|
|
4922
5483
|
/**
|
|
5484
|
+
* @public
|
|
4923
5485
|
* <p>An array of labels detected in the video. Each element contains the detected label and the time,
|
|
4924
5486
|
* in milliseconds from the start of the video, that the label was detected. </p>
|
|
4925
5487
|
*/
|
|
4926
5488
|
Labels?: LabelDetection[];
|
|
4927
5489
|
/**
|
|
5490
|
+
* @public
|
|
4928
5491
|
* <p>Version number of the label detection model that was used to detect labels.</p>
|
|
4929
5492
|
*/
|
|
4930
5493
|
LabelModelVersion?: string;
|
|
4931
5494
|
/**
|
|
5495
|
+
* @public
|
|
4932
5496
|
* <p>Job identifier for the label detection operation for which you
|
|
4933
5497
|
* want to obtain results. The job identifer is returned by an initial call
|
|
4934
5498
|
* to StartLabelDetection.</p>
|
|
4935
5499
|
*/
|
|
4936
5500
|
JobId?: string;
|
|
4937
5501
|
/**
|
|
5502
|
+
* @public
|
|
4938
5503
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
4939
5504
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
4940
5505
|
*/
|
|
4941
5506
|
Video?: Video;
|
|
4942
5507
|
/**
|
|
5508
|
+
* @public
|
|
4943
5509
|
* <p>A job identifier specified in the call to StartLabelDetection and
|
|
4944
5510
|
* returned in the job completion notification sent to your
|
|
4945
5511
|
* Amazon Simple Notification Service topic.</p>
|
|
4946
5512
|
*/
|
|
4947
5513
|
JobTag?: string;
|
|
4948
5514
|
/**
|
|
5515
|
+
* @public
|
|
4949
5516
|
* <p>Information about the paramters used when getting a response. Includes
|
|
4950
5517
|
* information on aggregation and sorting methods.</p>
|
|
4951
5518
|
*/
|
|
@@ -4968,22 +5535,26 @@ export type PersonTrackingSortBy = (typeof PersonTrackingSortBy)[keyof typeof Pe
|
|
|
4968
5535
|
*/
|
|
4969
5536
|
export interface GetPersonTrackingRequest {
|
|
4970
5537
|
/**
|
|
5538
|
+
* @public
|
|
4971
5539
|
* <p>The identifier for a job that tracks persons in a video. You get the <code>JobId</code> from a call to <code>StartPersonTracking</code>.
|
|
4972
5540
|
* </p>
|
|
4973
5541
|
*/
|
|
4974
5542
|
JobId: string | undefined;
|
|
4975
5543
|
/**
|
|
5544
|
+
* @public
|
|
4976
5545
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.
|
|
4977
5546
|
* If you specify a value greater than 1000, a maximum of 1000 results is returned.
|
|
4978
5547
|
* The default value is 1000.</p>
|
|
4979
5548
|
*/
|
|
4980
5549
|
MaxResults?: number;
|
|
4981
5550
|
/**
|
|
5551
|
+
* @public
|
|
4982
5552
|
* <p>If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination
|
|
4983
5553
|
* token in the response. You can use this pagination token to retrieve the next set of persons. </p>
|
|
4984
5554
|
*/
|
|
4985
5555
|
NextToken?: string;
|
|
4986
5556
|
/**
|
|
5557
|
+
* @public
|
|
4987
5558
|
* <p>Sort to use for elements in the <code>Persons</code> array. Use <code>TIMESTAMP</code> to sort array elements
|
|
4988
5559
|
* by the time persons are detected. Use <code>INDEX</code> to sort by the tracked persons.
|
|
4989
5560
|
* If you sort by <code>INDEX</code>, the array elements for each person are sorted by detection confidence.
|
|
@@ -5000,11 +5571,13 @@ export interface GetPersonTrackingRequest {
|
|
|
5000
5571
|
*/
|
|
5001
5572
|
export interface PersonDetection {
|
|
5002
5573
|
/**
|
|
5574
|
+
* @public
|
|
5003
5575
|
* <p>The time, in milliseconds from the start of the video, that the person's path was tracked.
|
|
5004
5576
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the person's path first appears.</p>
|
|
5005
5577
|
*/
|
|
5006
5578
|
Timestamp?: number;
|
|
5007
5579
|
/**
|
|
5580
|
+
* @public
|
|
5008
5581
|
* <p>Details about a person whose path was tracked in a video.</p>
|
|
5009
5582
|
*/
|
|
5010
5583
|
Person?: PersonDetail;
|
|
@@ -5014,39 +5587,47 @@ export interface PersonDetection {
|
|
|
5014
5587
|
*/
|
|
5015
5588
|
export interface GetPersonTrackingResponse {
|
|
5016
5589
|
/**
|
|
5590
|
+
* @public
|
|
5017
5591
|
* <p>The current status of the person tracking job.</p>
|
|
5018
5592
|
*/
|
|
5019
5593
|
JobStatus?: VideoJobStatus | string;
|
|
5020
5594
|
/**
|
|
5595
|
+
* @public
|
|
5021
5596
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
5022
5597
|
*/
|
|
5023
5598
|
StatusMessage?: string;
|
|
5024
5599
|
/**
|
|
5600
|
+
* @public
|
|
5025
5601
|
* <p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in
|
|
5026
5602
|
* every page of paginated responses from a Amazon Rekognition Video operation.</p>
|
|
5027
5603
|
*/
|
|
5028
5604
|
VideoMetadata?: VideoMetadata;
|
|
5029
5605
|
/**
|
|
5606
|
+
* @public
|
|
5030
5607
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons. </p>
|
|
5031
5608
|
*/
|
|
5032
5609
|
NextToken?: string;
|
|
5033
5610
|
/**
|
|
5611
|
+
* @public
|
|
5034
5612
|
* <p>An array of the persons detected in the video and the time(s) their path was tracked throughout the video.
|
|
5035
5613
|
* An array element will exist for each time a person's path is tracked. </p>
|
|
5036
5614
|
*/
|
|
5037
5615
|
Persons?: PersonDetection[];
|
|
5038
5616
|
/**
|
|
5617
|
+
* @public
|
|
5039
5618
|
* <p>Job identifier for the person tracking operation for which you
|
|
5040
5619
|
* want to obtain results. The job identifer is returned by an initial call
|
|
5041
5620
|
* to StartPersonTracking.</p>
|
|
5042
5621
|
*/
|
|
5043
5622
|
JobId?: string;
|
|
5044
5623
|
/**
|
|
5624
|
+
* @public
|
|
5045
5625
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
5046
5626
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
5047
5627
|
*/
|
|
5048
5628
|
Video?: Video;
|
|
5049
5629
|
/**
|
|
5630
|
+
* @public
|
|
5050
5631
|
* <p>A job identifier specified in the call to StartCelebrityRecognition and
|
|
5051
5632
|
* returned in the job completion notification sent to your
|
|
5052
5633
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -5058,15 +5639,18 @@ export interface GetPersonTrackingResponse {
|
|
|
5058
5639
|
*/
|
|
5059
5640
|
export interface GetSegmentDetectionRequest {
|
|
5060
5641
|
/**
|
|
5642
|
+
* @public
|
|
5061
5643
|
* <p>Job identifier for the text detection operation for which you want results returned.
|
|
5062
5644
|
* You get the job identifer from an initial call to <code>StartSegmentDetection</code>.</p>
|
|
5063
5645
|
*/
|
|
5064
5646
|
JobId: string | undefined;
|
|
5065
5647
|
/**
|
|
5648
|
+
* @public
|
|
5066
5649
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>
|
|
5067
5650
|
*/
|
|
5068
5651
|
MaxResults?: number;
|
|
5069
5652
|
/**
|
|
5653
|
+
* @public
|
|
5070
5654
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
|
|
5071
5655
|
* request to retrieve the next set of text.</p>
|
|
5072
5656
|
*/
|
|
@@ -5079,10 +5663,12 @@ export interface GetSegmentDetectionRequest {
|
|
|
5079
5663
|
*/
|
|
5080
5664
|
export interface ShotSegment {
|
|
5081
5665
|
/**
|
|
5666
|
+
* @public
|
|
5082
5667
|
* <p>An Identifier for a shot detection segment detected in a video. </p>
|
|
5083
5668
|
*/
|
|
5084
5669
|
Index?: number;
|
|
5085
5670
|
/**
|
|
5671
|
+
* @public
|
|
5086
5672
|
* <p>The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.</p>
|
|
5087
5673
|
*/
|
|
5088
5674
|
Confidence?: number;
|
|
@@ -5110,10 +5696,12 @@ export type TechnicalCueType = (typeof TechnicalCueType)[keyof typeof TechnicalC
|
|
|
5110
5696
|
*/
|
|
5111
5697
|
export interface TechnicalCueSegment {
|
|
5112
5698
|
/**
|
|
5699
|
+
* @public
|
|
5113
5700
|
* <p>The type of the technical cue.</p>
|
|
5114
5701
|
*/
|
|
5115
5702
|
Type?: TechnicalCueType | string;
|
|
5116
5703
|
/**
|
|
5704
|
+
* @public
|
|
5117
5705
|
* <p>The confidence that Amazon Rekognition Video has in the accuracy of the detected segment.</p>
|
|
5118
5706
|
*/
|
|
5119
5707
|
Confidence?: number;
|
|
@@ -5139,61 +5727,73 @@ export type SegmentType = (typeof SegmentType)[keyof typeof SegmentType];
|
|
|
5139
5727
|
*/
|
|
5140
5728
|
export interface SegmentDetection {
|
|
5141
5729
|
/**
|
|
5730
|
+
* @public
|
|
5142
5731
|
* <p>The type of the segment. Valid values are <code>TECHNICAL_CUE</code> and <code>SHOT</code>.</p>
|
|
5143
5732
|
*/
|
|
5144
5733
|
Type?: SegmentType | string;
|
|
5145
5734
|
/**
|
|
5735
|
+
* @public
|
|
5146
5736
|
* <p>The start time of the detected segment in milliseconds from the start of the video. This value
|
|
5147
5737
|
* is rounded down. For example, if the actual timestamp is 100.6667 milliseconds, Amazon Rekognition Video returns a value of
|
|
5148
5738
|
* 100 millis.</p>
|
|
5149
5739
|
*/
|
|
5150
5740
|
StartTimestampMillis?: number;
|
|
5151
5741
|
/**
|
|
5742
|
+
* @public
|
|
5152
5743
|
* <p>The end time of the detected segment, in milliseconds, from the start of the video.
|
|
5153
5744
|
* This value is rounded down.</p>
|
|
5154
5745
|
*/
|
|
5155
5746
|
EndTimestampMillis?: number;
|
|
5156
5747
|
/**
|
|
5748
|
+
* @public
|
|
5157
5749
|
* <p>The duration of the detected segment in milliseconds. </p>
|
|
5158
5750
|
*/
|
|
5159
5751
|
DurationMillis?: number;
|
|
5160
5752
|
/**
|
|
5753
|
+
* @public
|
|
5161
5754
|
* <p>The frame-accurate SMPTE timecode, from the start of a video, for the start of a detected segment.
|
|
5162
5755
|
* <code>StartTimecode</code> is in <i>HH:MM:SS:fr</i> format
|
|
5163
5756
|
* (and <i>;fr</i> for drop frame-rates). </p>
|
|
5164
5757
|
*/
|
|
5165
5758
|
StartTimecodeSMPTE?: string;
|
|
5166
5759
|
/**
|
|
5760
|
+
* @public
|
|
5167
5761
|
* <p>The frame-accurate SMPTE timecode, from the start of a video, for the end of a detected segment.
|
|
5168
5762
|
* <code>EndTimecode</code> is in <i>HH:MM:SS:fr</i> format
|
|
5169
5763
|
* (and <i>;fr</i> for drop frame-rates).</p>
|
|
5170
5764
|
*/
|
|
5171
5765
|
EndTimecodeSMPTE?: string;
|
|
5172
5766
|
/**
|
|
5767
|
+
* @public
|
|
5173
5768
|
* <p>The duration of the timecode for the detected segment in SMPTE format.</p>
|
|
5174
5769
|
*/
|
|
5175
5770
|
DurationSMPTE?: string;
|
|
5176
5771
|
/**
|
|
5772
|
+
* @public
|
|
5177
5773
|
* <p>If the segment is a technical cue, contains information about the technical cue.</p>
|
|
5178
5774
|
*/
|
|
5179
5775
|
TechnicalCueSegment?: TechnicalCueSegment;
|
|
5180
5776
|
/**
|
|
5777
|
+
* @public
|
|
5181
5778
|
* <p>If the segment is a shot detection, contains information about the shot detection.</p>
|
|
5182
5779
|
*/
|
|
5183
5780
|
ShotSegment?: ShotSegment;
|
|
5184
5781
|
/**
|
|
5782
|
+
* @public
|
|
5185
5783
|
* <p>
|
|
5186
5784
|
* The frame number of the start of a video segment, using a frame index that starts with 0.
|
|
5187
5785
|
* </p>
|
|
5188
5786
|
*/
|
|
5189
5787
|
StartFrameNumber?: number;
|
|
5190
5788
|
/**
|
|
5789
|
+
* @public
|
|
5191
5790
|
* <p>
|
|
5192
5791
|
* The frame number at the end of a video segment, using a frame index that starts with 0.
|
|
5193
5792
|
* </p>
|
|
5194
5793
|
*/
|
|
5195
5794
|
EndFrameNumber?: number;
|
|
5196
5795
|
/**
|
|
5796
|
+
* @public
|
|
5197
5797
|
* <p>
|
|
5198
5798
|
* The duration of a video segment, expressed in frames.
|
|
5199
5799
|
* </p>
|
|
@@ -5207,10 +5807,12 @@ export interface SegmentDetection {
|
|
|
5207
5807
|
*/
|
|
5208
5808
|
export interface SegmentTypeInfo {
|
|
5209
5809
|
/**
|
|
5810
|
+
* @public
|
|
5210
5811
|
* <p>The type of a segment (technical cue or shot detection).</p>
|
|
5211
5812
|
*/
|
|
5212
5813
|
Type?: SegmentType | string;
|
|
5213
5814
|
/**
|
|
5815
|
+
* @public
|
|
5214
5816
|
* <p>The version of the model used to detect segments.</p>
|
|
5215
5817
|
*/
|
|
5216
5818
|
ModelVersion?: string;
|
|
@@ -5220,14 +5822,17 @@ export interface SegmentTypeInfo {
|
|
|
5220
5822
|
*/
|
|
5221
5823
|
export interface GetSegmentDetectionResponse {
|
|
5222
5824
|
/**
|
|
5825
|
+
* @public
|
|
5223
5826
|
* <p>Current status of the segment detection job.</p>
|
|
5224
5827
|
*/
|
|
5225
5828
|
JobStatus?: VideoJobStatus | string;
|
|
5226
5829
|
/**
|
|
5830
|
+
* @public
|
|
5227
5831
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
5228
5832
|
*/
|
|
5229
5833
|
StatusMessage?: string;
|
|
5230
5834
|
/**
|
|
5835
|
+
* @public
|
|
5231
5836
|
* <p>Currently, Amazon Rekognition Video returns a single object in the
|
|
5232
5837
|
* <code>VideoMetadata</code> array. The object
|
|
5233
5838
|
* contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze.
|
|
@@ -5236,6 +5841,7 @@ export interface GetSegmentDetectionResponse {
|
|
|
5236
5841
|
*/
|
|
5237
5842
|
VideoMetadata?: VideoMetadata[];
|
|
5238
5843
|
/**
|
|
5844
|
+
* @public
|
|
5239
5845
|
* <p>An array of
|
|
5240
5846
|
* objects. There can be multiple audio streams.
|
|
5241
5847
|
* Each <code>AudioMetadata</code> object contains metadata for a single audio stream.
|
|
@@ -5246,33 +5852,39 @@ export interface GetSegmentDetectionResponse {
|
|
|
5246
5852
|
*/
|
|
5247
5853
|
AudioMetadata?: AudioMetadata[];
|
|
5248
5854
|
/**
|
|
5855
|
+
* @public
|
|
5249
5856
|
* <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns
|
|
5250
5857
|
* a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>
|
|
5251
5858
|
*/
|
|
5252
5859
|
NextToken?: string;
|
|
5253
5860
|
/**
|
|
5861
|
+
* @public
|
|
5254
5862
|
* <p>An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT)
|
|
5255
5863
|
* specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>. Within
|
|
5256
5864
|
* each segment type the array is sorted by timestamp values.</p>
|
|
5257
5865
|
*/
|
|
5258
5866
|
Segments?: SegmentDetection[];
|
|
5259
5867
|
/**
|
|
5868
|
+
* @public
|
|
5260
5869
|
* <p>An array containing the segment types requested in the call to <code>StartSegmentDetection</code>.
|
|
5261
5870
|
* </p>
|
|
5262
5871
|
*/
|
|
5263
5872
|
SelectedSegmentTypes?: SegmentTypeInfo[];
|
|
5264
5873
|
/**
|
|
5874
|
+
* @public
|
|
5265
5875
|
* <p>Job identifier for the segment detection operation for which you
|
|
5266
5876
|
* want to obtain results. The job identifer is returned by an initial call
|
|
5267
5877
|
* to StartSegmentDetection.</p>
|
|
5268
5878
|
*/
|
|
5269
5879
|
JobId?: string;
|
|
5270
5880
|
/**
|
|
5881
|
+
* @public
|
|
5271
5882
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
5272
5883
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
5273
5884
|
*/
|
|
5274
5885
|
Video?: Video;
|
|
5275
5886
|
/**
|
|
5887
|
+
* @public
|
|
5276
5888
|
* <p>A job identifier specified in the call to StartSegmentDetection and
|
|
5277
5889
|
* returned in the job completion notification sent to your
|
|
5278
5890
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -5284,15 +5896,18 @@ export interface GetSegmentDetectionResponse {
|
|
|
5284
5896
|
*/
|
|
5285
5897
|
export interface GetTextDetectionRequest {
|
|
5286
5898
|
/**
|
|
5899
|
+
* @public
|
|
5287
5900
|
* <p>Job identifier for the text detection operation for which you want results returned.
|
|
5288
5901
|
* You get the job identifer from an initial call to <code>StartTextDetection</code>.</p>
|
|
5289
5902
|
*/
|
|
5290
5903
|
JobId: string | undefined;
|
|
5291
5904
|
/**
|
|
5905
|
+
* @public
|
|
5292
5906
|
* <p>Maximum number of results to return per paginated call. The largest value you can specify is 1000.</p>
|
|
5293
5907
|
*/
|
|
5294
5908
|
MaxResults?: number;
|
|
5295
5909
|
/**
|
|
5910
|
+
* @public
|
|
5296
5911
|
* <p>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns
|
|
5297
5912
|
* a pagination token in the response. You can use this pagination token to retrieve the next set of text.</p>
|
|
5298
5913
|
*/
|
|
@@ -5305,11 +5920,13 @@ export interface GetTextDetectionRequest {
|
|
|
5305
5920
|
*/
|
|
5306
5921
|
export interface TextDetectionResult {
|
|
5307
5922
|
/**
|
|
5923
|
+
* @public
|
|
5308
5924
|
* <p>The time, in milliseconds from the start of the video, that the text was detected.
|
|
5309
5925
|
* Note that <code>Timestamp</code> is not guaranteed to be accurate to the individual frame where the text first appears.</p>
|
|
5310
5926
|
*/
|
|
5311
5927
|
Timestamp?: number;
|
|
5312
5928
|
/**
|
|
5929
|
+
* @public
|
|
5313
5930
|
* <p>Details about text detected in a video.</p>
|
|
5314
5931
|
*/
|
|
5315
5932
|
TextDetection?: TextDetection;
|
|
@@ -5319,44 +5936,53 @@ export interface TextDetectionResult {
|
|
|
5319
5936
|
*/
|
|
5320
5937
|
export interface GetTextDetectionResponse {
|
|
5321
5938
|
/**
|
|
5939
|
+
* @public
|
|
5322
5940
|
* <p>Current status of the text detection job.</p>
|
|
5323
5941
|
*/
|
|
5324
5942
|
JobStatus?: VideoJobStatus | string;
|
|
5325
5943
|
/**
|
|
5944
|
+
* @public
|
|
5326
5945
|
* <p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>
|
|
5327
5946
|
*/
|
|
5328
5947
|
StatusMessage?: string;
|
|
5329
5948
|
/**
|
|
5949
|
+
* @public
|
|
5330
5950
|
* <p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code> is returned in
|
|
5331
5951
|
* every page of paginated responses from a Amazon Rekognition video operation.</p>
|
|
5332
5952
|
*/
|
|
5333
5953
|
VideoMetadata?: VideoMetadata;
|
|
5334
5954
|
/**
|
|
5955
|
+
* @public
|
|
5335
5956
|
* <p>An array of text detected in the video. Each element contains the detected text, the time in milliseconds
|
|
5336
5957
|
* from the start of the video that the text was detected, and where it was detected on the screen.</p>
|
|
5337
5958
|
*/
|
|
5338
5959
|
TextDetections?: TextDetectionResult[];
|
|
5339
5960
|
/**
|
|
5961
|
+
* @public
|
|
5340
5962
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
|
|
5341
5963
|
* request to retrieve the next set of text.</p>
|
|
5342
5964
|
*/
|
|
5343
5965
|
NextToken?: string;
|
|
5344
5966
|
/**
|
|
5967
|
+
* @public
|
|
5345
5968
|
* <p>Version number of the text detection model that was used to detect text.</p>
|
|
5346
5969
|
*/
|
|
5347
5970
|
TextModelVersion?: string;
|
|
5348
5971
|
/**
|
|
5972
|
+
* @public
|
|
5349
5973
|
* <p>Job identifier for the text detection operation for which you
|
|
5350
5974
|
* want to obtain results. The job identifer is returned by an initial call
|
|
5351
5975
|
* to StartTextDetection.</p>
|
|
5352
5976
|
*/
|
|
5353
5977
|
JobId?: string;
|
|
5354
5978
|
/**
|
|
5979
|
+
* @public
|
|
5355
5980
|
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
5356
5981
|
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
5357
5982
|
*/
|
|
5358
5983
|
Video?: Video;
|
|
5359
5984
|
/**
|
|
5985
|
+
* @public
|
|
5360
5986
|
* <p>A job identifier specified in the call to StartTextDetection and
|
|
5361
5987
|
* returned in the job completion notification sent to your
|
|
5362
5988
|
* Amazon Simple Notification Service topic.</p>
|
|
@@ -5368,11 +5994,13 @@ export interface GetTextDetectionResponse {
|
|
|
5368
5994
|
*/
|
|
5369
5995
|
export interface IndexFacesRequest {
|
|
5370
5996
|
/**
|
|
5997
|
+
* @public
|
|
5371
5998
|
* <p>The ID of an existing collection to which you want to add the faces that are detected
|
|
5372
5999
|
* in the input images.</p>
|
|
5373
6000
|
*/
|
|
5374
6001
|
CollectionId: string | undefined;
|
|
5375
6002
|
/**
|
|
6003
|
+
* @public
|
|
5376
6004
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
5377
6005
|
* call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported. </p>
|
|
5378
6006
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -5381,10 +6009,12 @@ export interface IndexFacesRequest {
|
|
|
5381
6009
|
*/
|
|
5382
6010
|
Image: Image | undefined;
|
|
5383
6011
|
/**
|
|
6012
|
+
* @public
|
|
5384
6013
|
* <p>The ID you want to assign to all the faces detected in the image.</p>
|
|
5385
6014
|
*/
|
|
5386
6015
|
ExternalImageId?: string;
|
|
5387
6016
|
/**
|
|
6017
|
+
* @public
|
|
5388
6018
|
* <p>An array of facial attributes you want to be returned. A <code>DEFAULT</code> subset of
|
|
5389
6019
|
* facial attributes - <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>,
|
|
5390
6020
|
* <code>Quality</code>, and <code>Landmarks</code> - will always be returned. You can request
|
|
@@ -5397,6 +6027,7 @@ export interface IndexFacesRequest {
|
|
|
5397
6027
|
*/
|
|
5398
6028
|
DetectionAttributes?: (Attribute | string)[];
|
|
5399
6029
|
/**
|
|
6030
|
+
* @public
|
|
5400
6031
|
* <p>The maximum number of faces to index. The value of <code>MaxFaces</code> must be greater
|
|
5401
6032
|
* than or equal to 1. <code>IndexFaces</code> returns no more than 100 detected faces in an
|
|
5402
6033
|
* image, even if you specify a larger value for <code>MaxFaces</code>.</p>
|
|
@@ -5413,6 +6044,7 @@ export interface IndexFacesRequest {
|
|
|
5413
6044
|
*/
|
|
5414
6045
|
MaxFaces?: number;
|
|
5415
6046
|
/**
|
|
6047
|
+
* @public
|
|
5416
6048
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
5417
6049
|
* Filtered faces aren't indexed. If you specify <code>AUTO</code>, Amazon Rekognition chooses the quality
|
|
5418
6050
|
* bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>, filtering
|
|
@@ -5451,6 +6083,7 @@ export type Reason = (typeof Reason)[keyof typeof Reason];
|
|
|
5451
6083
|
*/
|
|
5452
6084
|
export interface UnindexedFace {
|
|
5453
6085
|
/**
|
|
6086
|
+
* @public
|
|
5454
6087
|
* <p>An array of reasons that specify why a face wasn't indexed. </p>
|
|
5455
6088
|
* <ul>
|
|
5456
6089
|
* <li>
|
|
@@ -5477,6 +6110,7 @@ export interface UnindexedFace {
|
|
|
5477
6110
|
*/
|
|
5478
6111
|
Reasons?: (Reason | string)[];
|
|
5479
6112
|
/**
|
|
6113
|
+
* @public
|
|
5480
6114
|
* <p>The
|
|
5481
6115
|
* structure that contains attributes of a face that
|
|
5482
6116
|
* <code>IndexFaces</code>detected, but didn't index. </p>
|
|
@@ -5488,11 +6122,13 @@ export interface UnindexedFace {
|
|
|
5488
6122
|
*/
|
|
5489
6123
|
export interface IndexFacesResponse {
|
|
5490
6124
|
/**
|
|
6125
|
+
* @public
|
|
5491
6126
|
* <p>An array of faces detected and added to the collection. For more information,
|
|
5492
6127
|
* see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. </p>
|
|
5493
6128
|
*/
|
|
5494
6129
|
FaceRecords?: FaceRecord[];
|
|
5495
6130
|
/**
|
|
6131
|
+
* @public
|
|
5496
6132
|
* <p>If your collection is associated with a face detection model that's later than version
|
|
5497
6133
|
* 3.0, the value of <code>OrientationCorrection</code> is always null and no orientation
|
|
5498
6134
|
* information is returned.</p>
|
|
@@ -5519,11 +6155,13 @@ export interface IndexFacesResponse {
|
|
|
5519
6155
|
*/
|
|
5520
6156
|
OrientationCorrection?: OrientationCorrection | string;
|
|
5521
6157
|
/**
|
|
6158
|
+
* @public
|
|
5522
6159
|
* <p>The version number of the face detection model that's associated with the input
|
|
5523
6160
|
* collection (<code>CollectionId</code>).</p>
|
|
5524
6161
|
*/
|
|
5525
6162
|
FaceModelVersion?: string;
|
|
5526
6163
|
/**
|
|
6164
|
+
* @public
|
|
5527
6165
|
* <p>An array of faces that were detected in the image but weren't indexed. They weren't
|
|
5528
6166
|
* indexed because the quality filter identified them as low quality, or the
|
|
5529
6167
|
* <code>MaxFaces</code> request parameter filtered them out. To use the quality filter, you
|
|
@@ -5540,11 +6178,13 @@ export interface IndexFacesResponse {
|
|
|
5540
6178
|
*/
|
|
5541
6179
|
export interface KinesisVideoStreamStartSelector {
|
|
5542
6180
|
/**
|
|
6181
|
+
* @public
|
|
5543
6182
|
* <p> The timestamp from the producer corresponding to the fragment, in milliseconds,
|
|
5544
6183
|
* expressed in unix time format. </p>
|
|
5545
6184
|
*/
|
|
5546
6185
|
ProducerTimestamp?: number;
|
|
5547
6186
|
/**
|
|
6187
|
+
* @public
|
|
5548
6188
|
* <p>
|
|
5549
6189
|
* The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
|
|
5550
6190
|
* </p>
|
|
@@ -5568,6 +6208,7 @@ export type LabelDetectionFeatureName = (typeof LabelDetectionFeatureName)[keyof
|
|
|
5568
6208
|
*/
|
|
5569
6209
|
export interface LabelDetectionSettings {
|
|
5570
6210
|
/**
|
|
6211
|
+
* @public
|
|
5571
6212
|
* <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
|
|
5572
6213
|
* exclusive, or a combination of both and can be applied to individual labels or entire label categories.
|
|
5573
6214
|
* To see a list of label categories, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels.html">Detecting Labels</a>.</p>
|
|
@@ -5579,10 +6220,12 @@ export interface LabelDetectionSettings {
|
|
|
5579
6220
|
*/
|
|
5580
6221
|
export interface ListCollectionsRequest {
|
|
5581
6222
|
/**
|
|
6223
|
+
* @public
|
|
5582
6224
|
* <p>Pagination token from the previous response.</p>
|
|
5583
6225
|
*/
|
|
5584
6226
|
NextToken?: string;
|
|
5585
6227
|
/**
|
|
6228
|
+
* @public
|
|
5586
6229
|
* <p>Maximum number of collection IDs to return. </p>
|
|
5587
6230
|
*/
|
|
5588
6231
|
MaxResults?: number;
|
|
@@ -5592,15 +6235,18 @@ export interface ListCollectionsRequest {
|
|
|
5592
6235
|
*/
|
|
5593
6236
|
export interface ListCollectionsResponse {
|
|
5594
6237
|
/**
|
|
6238
|
+
* @public
|
|
5595
6239
|
* <p>An array of collection IDs.</p>
|
|
5596
6240
|
*/
|
|
5597
6241
|
CollectionIds?: string[];
|
|
5598
6242
|
/**
|
|
6243
|
+
* @public
|
|
5599
6244
|
* <p>If the result is truncated, the response provides a <code>NextToken</code> that you can
|
|
5600
6245
|
* use in the subsequent request to fetch the next set of collection IDs.</p>
|
|
5601
6246
|
*/
|
|
5602
6247
|
NextToken?: string;
|
|
5603
6248
|
/**
|
|
6249
|
+
* @public
|
|
5604
6250
|
* <p>Version numbers of the face detection models associated with the collections in the
|
|
5605
6251
|
* array <code>CollectionIds</code>. For example, the value of <code>FaceModelVersions[2]</code>
|
|
5606
6252
|
* is the version number for the face detection model used by the collection in
|
|
@@ -5613,17 +6259,20 @@ export interface ListCollectionsResponse {
|
|
|
5613
6259
|
*/
|
|
5614
6260
|
export interface ListDatasetEntriesRequest {
|
|
5615
6261
|
/**
|
|
6262
|
+
* @public
|
|
5616
6263
|
* <p>
|
|
5617
6264
|
* The Amazon Resource Name (ARN) for the dataset that you want to use.
|
|
5618
6265
|
* </p>
|
|
5619
6266
|
*/
|
|
5620
6267
|
DatasetArn: string | undefined;
|
|
5621
6268
|
/**
|
|
6269
|
+
* @public
|
|
5622
6270
|
* <p>Specifies a label filter for the response. The response includes an entry only if one or more of the labels in <code>ContainsLabels</code> exist in the entry.
|
|
5623
6271
|
* </p>
|
|
5624
6272
|
*/
|
|
5625
6273
|
ContainsLabels?: string[];
|
|
5626
6274
|
/**
|
|
6275
|
+
* @public
|
|
5627
6276
|
* <p>
|
|
5628
6277
|
* Specify <code>true</code> to get only the JSON Lines where the image is labeled.
|
|
5629
6278
|
* Specify <code>false</code> to get only the JSON Lines where the image isn't labeled. If you
|
|
@@ -5633,23 +6282,27 @@ export interface ListDatasetEntriesRequest {
|
|
|
5633
6282
|
*/
|
|
5634
6283
|
Labeled?: boolean;
|
|
5635
6284
|
/**
|
|
6285
|
+
* @public
|
|
5636
6286
|
* <p>If specified, <code>ListDatasetEntries</code> only returns JSON Lines where the value of <code>SourceRefContains</code> is
|
|
5637
6287
|
* part of the <code>source-ref</code> field. The <code>source-ref</code> field contains the Amazon S3 location of the image.
|
|
5638
6288
|
* You can use <code>SouceRefContains</code> for tasks such as getting the JSON Line for a single image, or gettting JSON Lines for all images within a specific folder.</p>
|
|
5639
6289
|
*/
|
|
5640
6290
|
SourceRefContains?: string;
|
|
5641
6291
|
/**
|
|
6292
|
+
* @public
|
|
5642
6293
|
* <p>Specifies an error filter for the response. Specify <code>True</code> to only include entries that have errors.
|
|
5643
6294
|
* </p>
|
|
5644
6295
|
*/
|
|
5645
6296
|
HasErrors?: boolean;
|
|
5646
6297
|
/**
|
|
6298
|
+
* @public
|
|
5647
6299
|
* <p>If the previous response was incomplete (because there is more
|
|
5648
6300
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
|
|
5649
6301
|
* token to retrieve the next set of results. </p>
|
|
5650
6302
|
*/
|
|
5651
6303
|
NextToken?: string;
|
|
5652
6304
|
/**
|
|
6305
|
+
* @public
|
|
5653
6306
|
* <p>The maximum number of results to return per paginated call. The largest value you can specify is 100.
|
|
5654
6307
|
* If you specify a value greater than 100, a ValidationException
|
|
5655
6308
|
* error occurs. The default value is 100. </p>
|
|
@@ -5661,12 +6314,14 @@ export interface ListDatasetEntriesRequest {
|
|
|
5661
6314
|
*/
|
|
5662
6315
|
export interface ListDatasetEntriesResponse {
|
|
5663
6316
|
/**
|
|
6317
|
+
* @public
|
|
5664
6318
|
* <p>
|
|
5665
6319
|
* A list of entries (images) in the dataset.
|
|
5666
6320
|
* </p>
|
|
5667
6321
|
*/
|
|
5668
6322
|
DatasetEntries?: string[];
|
|
5669
6323
|
/**
|
|
6324
|
+
* @public
|
|
5670
6325
|
* <p>If the previous response was incomplete (because there is more
|
|
5671
6326
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
|
|
5672
6327
|
* token to retrieve the next set of results. </p>
|
|
@@ -5678,18 +6333,21 @@ export interface ListDatasetEntriesResponse {
|
|
|
5678
6333
|
*/
|
|
5679
6334
|
export interface ListDatasetLabelsRequest {
|
|
5680
6335
|
/**
|
|
6336
|
+
* @public
|
|
5681
6337
|
* <p>
|
|
5682
6338
|
* The Amazon Resource Name (ARN) of the dataset that you want to use.
|
|
5683
6339
|
* </p>
|
|
5684
6340
|
*/
|
|
5685
6341
|
DatasetArn: string | undefined;
|
|
5686
6342
|
/**
|
|
6343
|
+
* @public
|
|
5687
6344
|
* <p>If the previous response was incomplete (because there is more
|
|
5688
6345
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
|
|
5689
6346
|
* token to retrieve the next set of results. </p>
|
|
5690
6347
|
*/
|
|
5691
6348
|
NextToken?: string;
|
|
5692
6349
|
/**
|
|
6350
|
+
* @public
|
|
5693
6351
|
* <p>The maximum number of results to return per paginated call. The largest value you can specify is 100.
|
|
5694
6352
|
* If you specify a value greater than 100, a ValidationException
|
|
5695
6353
|
* error occurs. The default value is 100. </p>
|
|
@@ -5701,12 +6359,14 @@ export interface ListDatasetLabelsRequest {
|
|
|
5701
6359
|
*/
|
|
5702
6360
|
export interface ListDatasetLabelsResponse {
|
|
5703
6361
|
/**
|
|
6362
|
+
* @public
|
|
5704
6363
|
* <p>
|
|
5705
6364
|
* A list of the labels in the dataset.
|
|
5706
6365
|
* </p>
|
|
5707
6366
|
*/
|
|
5708
6367
|
DatasetLabelDescriptions?: DatasetLabelDescription[];
|
|
5709
6368
|
/**
|
|
6369
|
+
* @public
|
|
5710
6370
|
* <p>If the previous response was incomplete (because there is more
|
|
5711
6371
|
* results to retrieve), Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination
|
|
5712
6372
|
* token to retrieve the next set of results. </p>
|
|
@@ -5718,24 +6378,29 @@ export interface ListDatasetLabelsResponse {
|
|
|
5718
6378
|
*/
|
|
5719
6379
|
export interface ListFacesRequest {
|
|
5720
6380
|
/**
|
|
6381
|
+
* @public
|
|
5721
6382
|
* <p>ID of the collection from which to list the faces.</p>
|
|
5722
6383
|
*/
|
|
5723
6384
|
CollectionId: string | undefined;
|
|
5724
6385
|
/**
|
|
6386
|
+
* @public
|
|
5725
6387
|
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
5726
6388
|
* Amazon Rekognition returns a pagination token in the response. You can use this pagination token to
|
|
5727
6389
|
* retrieve the next set of faces.</p>
|
|
5728
6390
|
*/
|
|
5729
6391
|
NextToken?: string;
|
|
5730
6392
|
/**
|
|
6393
|
+
* @public
|
|
5731
6394
|
* <p>Maximum number of faces to return.</p>
|
|
5732
6395
|
*/
|
|
5733
6396
|
MaxResults?: number;
|
|
5734
6397
|
/**
|
|
6398
|
+
* @public
|
|
5735
6399
|
* <p>An array of user IDs to match when listing faces in a collection.</p>
|
|
5736
6400
|
*/
|
|
5737
6401
|
UserId?: string;
|
|
5738
6402
|
/**
|
|
6403
|
+
* @public
|
|
5739
6404
|
* <p>An array of face IDs to match when listing faces in a collection.</p>
|
|
5740
6405
|
*/
|
|
5741
6406
|
FaceIds?: string[];
|
|
@@ -5745,15 +6410,18 @@ export interface ListFacesRequest {
|
|
|
5745
6410
|
*/
|
|
5746
6411
|
export interface ListFacesResponse {
|
|
5747
6412
|
/**
|
|
6413
|
+
* @public
|
|
5748
6414
|
* <p>An array of <code>Face</code> objects. </p>
|
|
5749
6415
|
*/
|
|
5750
6416
|
Faces?: Face[];
|
|
5751
6417
|
/**
|
|
6418
|
+
* @public
|
|
5752
6419
|
* <p>If the response is truncated, Amazon Rekognition returns this token that you can use in the
|
|
5753
6420
|
* subsequent request to retrieve the next set of faces.</p>
|
|
5754
6421
|
*/
|
|
5755
6422
|
NextToken?: string;
|
|
5756
6423
|
/**
|
|
6424
|
+
* @public
|
|
5757
6425
|
* <p>Version number of the face detection model associated with the input collection
|
|
5758
6426
|
* (<code>CollectionId</code>).</p>
|
|
5759
6427
|
*/
|
|
@@ -5764,16 +6432,19 @@ export interface ListFacesResponse {
|
|
|
5764
6432
|
*/
|
|
5765
6433
|
export interface ListProjectPoliciesRequest {
|
|
5766
6434
|
/**
|
|
6435
|
+
* @public
|
|
5767
6436
|
* <p>The ARN of the project for which you want to list the project policies.</p>
|
|
5768
6437
|
*/
|
|
5769
6438
|
ProjectArn: string | undefined;
|
|
5770
6439
|
/**
|
|
6440
|
+
* @public
|
|
5771
6441
|
* <p>If the previous response was incomplete (because there is more results to retrieve),
|
|
5772
6442
|
* Amazon Rekognition Custom Labels returns a pagination token in the response. You can use this pagination token
|
|
5773
6443
|
* to retrieve the next set of results. </p>
|
|
5774
6444
|
*/
|
|
5775
6445
|
NextToken?: string;
|
|
5776
6446
|
/**
|
|
6447
|
+
* @public
|
|
5777
6448
|
* <p>The maximum number of results to return per paginated call. The largest value you can
|
|
5778
6449
|
* specify is 5. If you specify a value greater than 5, a ValidationException error
|
|
5779
6450
|
* occurs. The default value is 5. </p>
|
|
@@ -5787,26 +6458,32 @@ export interface ListProjectPoliciesRequest {
|
|
|
5787
6458
|
*/
|
|
5788
6459
|
export interface ProjectPolicy {
|
|
5789
6460
|
/**
|
|
6461
|
+
* @public
|
|
5790
6462
|
* <p>The Amazon Resource Name (ARN) of the project to which the project policy is attached.</p>
|
|
5791
6463
|
*/
|
|
5792
6464
|
ProjectArn?: string;
|
|
5793
6465
|
/**
|
|
6466
|
+
* @public
|
|
5794
6467
|
* <p>The name of the project policy.</p>
|
|
5795
6468
|
*/
|
|
5796
6469
|
PolicyName?: string;
|
|
5797
6470
|
/**
|
|
6471
|
+
* @public
|
|
5798
6472
|
* <p>The revision ID of the project policy.</p>
|
|
5799
6473
|
*/
|
|
5800
6474
|
PolicyRevisionId?: string;
|
|
5801
6475
|
/**
|
|
6476
|
+
* @public
|
|
5802
6477
|
* <p>The JSON document for the project policy.</p>
|
|
5803
6478
|
*/
|
|
5804
6479
|
PolicyDocument?: string;
|
|
5805
6480
|
/**
|
|
6481
|
+
* @public
|
|
5806
6482
|
* <p>The Unix datetime for the creation of the project policy.</p>
|
|
5807
6483
|
*/
|
|
5808
6484
|
CreationTimestamp?: Date;
|
|
5809
6485
|
/**
|
|
6486
|
+
* @public
|
|
5810
6487
|
* <p>The Unix datetime for when the project policy was last updated. </p>
|
|
5811
6488
|
*/
|
|
5812
6489
|
LastUpdatedTimestamp?: Date;
|
|
@@ -5816,10 +6493,12 @@ export interface ProjectPolicy {
|
|
|
5816
6493
|
*/
|
|
5817
6494
|
export interface ListProjectPoliciesResponse {
|
|
5818
6495
|
/**
|
|
6496
|
+
* @public
|
|
5819
6497
|
* <p>A list of project policies attached to the project.</p>
|
|
5820
6498
|
*/
|
|
5821
6499
|
ProjectPolicies?: ProjectPolicy[];
|
|
5822
6500
|
/**
|
|
6501
|
+
* @public
|
|
5823
6502
|
* <p>If the response is truncated, Amazon Rekognition returns this token that you can use in the
|
|
5824
6503
|
* subsequent request to retrieve the next set of project policies.</p>
|
|
5825
6504
|
*/
|
|
@@ -5830,11 +6509,13 @@ export interface ListProjectPoliciesResponse {
|
|
|
5830
6509
|
*/
|
|
5831
6510
|
export interface ListStreamProcessorsRequest {
|
|
5832
6511
|
/**
|
|
6512
|
+
* @public
|
|
5833
6513
|
* <p>If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video
|
|
5834
6514
|
* returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors. </p>
|
|
5835
6515
|
*/
|
|
5836
6516
|
NextToken?: string;
|
|
5837
6517
|
/**
|
|
6518
|
+
* @public
|
|
5838
6519
|
* <p>Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000. </p>
|
|
5839
6520
|
*/
|
|
5840
6521
|
MaxResults?: number;
|
|
@@ -5848,10 +6529,12 @@ export interface ListStreamProcessorsRequest {
|
|
|
5848
6529
|
*/
|
|
5849
6530
|
export interface StreamProcessor {
|
|
5850
6531
|
/**
|
|
6532
|
+
* @public
|
|
5851
6533
|
* <p>Name of the Amazon Rekognition stream processor. </p>
|
|
5852
6534
|
*/
|
|
5853
6535
|
Name?: string;
|
|
5854
6536
|
/**
|
|
6537
|
+
* @public
|
|
5855
6538
|
* <p>Current status of the Amazon Rekognition stream processor.</p>
|
|
5856
6539
|
*/
|
|
5857
6540
|
Status?: StreamProcessorStatus | string;
|
|
@@ -5861,11 +6544,13 @@ export interface StreamProcessor {
|
|
|
5861
6544
|
*/
|
|
5862
6545
|
export interface ListStreamProcessorsResponse {
|
|
5863
6546
|
/**
|
|
6547
|
+
* @public
|
|
5864
6548
|
* <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
|
|
5865
6549
|
* request to retrieve the next set of stream processors. </p>
|
|
5866
6550
|
*/
|
|
5867
6551
|
NextToken?: string;
|
|
5868
6552
|
/**
|
|
6553
|
+
* @public
|
|
5869
6554
|
* <p>List of stream processors that you have created.</p>
|
|
5870
6555
|
*/
|
|
5871
6556
|
StreamProcessors?: StreamProcessor[];
|
|
@@ -5875,6 +6560,7 @@ export interface ListStreamProcessorsResponse {
|
|
|
5875
6560
|
*/
|
|
5876
6561
|
export interface ListTagsForResourceRequest {
|
|
5877
6562
|
/**
|
|
6563
|
+
* @public
|
|
5878
6564
|
* <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that contains
|
|
5879
6565
|
* the tags that you want a list of. </p>
|
|
5880
6566
|
*/
|
|
@@ -5885,6 +6571,7 @@ export interface ListTagsForResourceRequest {
|
|
|
5885
6571
|
*/
|
|
5886
6572
|
export interface ListTagsForResourceResponse {
|
|
5887
6573
|
/**
|
|
6574
|
+
* @public
|
|
5888
6575
|
* <p> A list of key-value tags assigned to the resource. </p>
|
|
5889
6576
|
*/
|
|
5890
6577
|
Tags?: Record<string, string>;
|
|
@@ -5894,14 +6581,17 @@ export interface ListTagsForResourceResponse {
|
|
|
5894
6581
|
*/
|
|
5895
6582
|
export interface ListUsersRequest {
|
|
5896
6583
|
/**
|
|
6584
|
+
* @public
|
|
5897
6585
|
* <p>The ID of an existing collection.</p>
|
|
5898
6586
|
*/
|
|
5899
6587
|
CollectionId: string | undefined;
|
|
5900
6588
|
/**
|
|
6589
|
+
* @public
|
|
5901
6590
|
* <p>Maximum number of UsersID to return. </p>
|
|
5902
6591
|
*/
|
|
5903
6592
|
MaxResults?: number;
|
|
5904
6593
|
/**
|
|
6594
|
+
* @public
|
|
5905
6595
|
* <p>Pagingation token to receive the next set of UsersID.</p>
|
|
5906
6596
|
*/
|
|
5907
6597
|
NextToken?: string;
|
|
@@ -5912,10 +6602,12 @@ export interface ListUsersRequest {
|
|
|
5912
6602
|
*/
|
|
5913
6603
|
export interface User {
|
|
5914
6604
|
/**
|
|
6605
|
+
* @public
|
|
5915
6606
|
* <p> A provided ID for the User. Unique within the collection.</p>
|
|
5916
6607
|
*/
|
|
5917
6608
|
UserId?: string;
|
|
5918
6609
|
/**
|
|
6610
|
+
* @public
|
|
5919
6611
|
* <p> Communicates if the UserID has been updated with latest set of faces to be associated
|
|
5920
6612
|
* with the UserID. </p>
|
|
5921
6613
|
*/
|
|
@@ -5926,10 +6618,12 @@ export interface User {
|
|
|
5926
6618
|
*/
|
|
5927
6619
|
export interface ListUsersResponse {
|
|
5928
6620
|
/**
|
|
6621
|
+
* @public
|
|
5929
6622
|
* <p>List of UsersID associated with the specified collection.</p>
|
|
5930
6623
|
*/
|
|
5931
6624
|
Users?: User[];
|
|
5932
6625
|
/**
|
|
6626
|
+
* @public
|
|
5933
6627
|
* <p>A pagination token to be used with the subsequent request if the response is truncated.</p>
|
|
5934
6628
|
*/
|
|
5935
6629
|
NextToken?: string;
|
|
@@ -5945,6 +6639,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
5945
6639
|
Message?: string;
|
|
5946
6640
|
Code?: string;
|
|
5947
6641
|
/**
|
|
6642
|
+
* @public
|
|
5948
6643
|
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
5949
6644
|
*/
|
|
5950
6645
|
Logref?: string;
|
|
@@ -5959,10 +6654,12 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
5959
6654
|
*/
|
|
5960
6655
|
export interface MatchedUser {
|
|
5961
6656
|
/**
|
|
6657
|
+
* @public
|
|
5962
6658
|
* <p>A provided ID for the UserID. Unique within the collection.</p>
|
|
5963
6659
|
*/
|
|
5964
6660
|
UserId?: string;
|
|
5965
6661
|
/**
|
|
6662
|
+
* @public
|
|
5966
6663
|
* <p>The status of the user matched to a provided FaceID.</p>
|
|
5967
6664
|
*/
|
|
5968
6665
|
UserStatus?: UserStatus | string;
|
|
@@ -5975,10 +6672,12 @@ export interface MatchedUser {
|
|
|
5975
6672
|
*/
|
|
5976
6673
|
export interface NotificationChannel {
|
|
5977
6674
|
/**
|
|
6675
|
+
* @public
|
|
5978
6676
|
* <p>The Amazon SNS topic to which Amazon Rekognition posts the completion status.</p>
|
|
5979
6677
|
*/
|
|
5980
6678
|
SNSTopicArn: string | undefined;
|
|
5981
6679
|
/**
|
|
6680
|
+
* @public
|
|
5982
6681
|
* <p>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </p>
|
|
5983
6682
|
*/
|
|
5984
6683
|
RoleArn: string | undefined;
|
|
@@ -5988,20 +6687,24 @@ export interface NotificationChannel {
|
|
|
5988
6687
|
*/
|
|
5989
6688
|
export interface PutProjectPolicyRequest {
|
|
5990
6689
|
/**
|
|
6690
|
+
* @public
|
|
5991
6691
|
* <p>The Amazon Resource Name (ARN) of the project that the project policy is attached to.</p>
|
|
5992
6692
|
*/
|
|
5993
6693
|
ProjectArn: string | undefined;
|
|
5994
6694
|
/**
|
|
6695
|
+
* @public
|
|
5995
6696
|
* <p>A name for the policy.</p>
|
|
5996
6697
|
*/
|
|
5997
6698
|
PolicyName: string | undefined;
|
|
5998
6699
|
/**
|
|
6700
|
+
* @public
|
|
5999
6701
|
* <p>The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels
|
|
6000
6702
|
* generates and assigns a new <code>PolicyRevisionId</code> and then deletes the previous version of the
|
|
6001
6703
|
* policy.</p>
|
|
6002
6704
|
*/
|
|
6003
6705
|
PolicyRevisionId?: string;
|
|
6004
6706
|
/**
|
|
6707
|
+
* @public
|
|
6005
6708
|
* <p>A resource policy to add to the model. The policy is a JSON structure that contains
|
|
6006
6709
|
* one or more statements that define the policy.
|
|
6007
6710
|
* The policy must follow the IAM syntax. For
|
|
@@ -6015,6 +6718,7 @@ export interface PutProjectPolicyRequest {
|
|
|
6015
6718
|
*/
|
|
6016
6719
|
export interface PutProjectPolicyResponse {
|
|
6017
6720
|
/**
|
|
6721
|
+
* @public
|
|
6018
6722
|
* <p>The ID of the project policy.</p>
|
|
6019
6723
|
*/
|
|
6020
6724
|
PolicyRevisionId?: string;
|
|
@@ -6024,6 +6728,7 @@ export interface PutProjectPolicyResponse {
|
|
|
6024
6728
|
*/
|
|
6025
6729
|
export interface RecognizeCelebritiesRequest {
|
|
6026
6730
|
/**
|
|
6731
|
+
* @public
|
|
6027
6732
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
6028
6733
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
6029
6734
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -6037,6 +6742,7 @@ export interface RecognizeCelebritiesRequest {
|
|
|
6037
6742
|
*/
|
|
6038
6743
|
export interface RecognizeCelebritiesResponse {
|
|
6039
6744
|
/**
|
|
6745
|
+
* @public
|
|
6040
6746
|
* <p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
|
|
6041
6747
|
* celebrities in an image. Each celebrity object includes the following attributes:
|
|
6042
6748
|
* <code>Face</code>, <code>Confidence</code>, <code>Emotions</code>, <code>Landmarks</code>,
|
|
@@ -6046,10 +6752,12 @@ export interface RecognizeCelebritiesResponse {
|
|
|
6046
6752
|
*/
|
|
6047
6753
|
CelebrityFaces?: Celebrity[];
|
|
6048
6754
|
/**
|
|
6755
|
+
* @public
|
|
6049
6756
|
* <p>Details about each unrecognized face in the image.</p>
|
|
6050
6757
|
*/
|
|
6051
6758
|
UnrecognizedFaces?: ComparedFace[];
|
|
6052
6759
|
/**
|
|
6760
|
+
* @public
|
|
6053
6761
|
* <note>
|
|
6054
6762
|
* <p>Support for estimating image orientation using the the OrientationCorrection field
|
|
6055
6763
|
* has ceased as of August 2021. Any returned values for this field included in an API response
|
|
@@ -6075,19 +6783,23 @@ export interface RecognizeCelebritiesResponse {
|
|
|
6075
6783
|
*/
|
|
6076
6784
|
export interface SearchFacesRequest {
|
|
6077
6785
|
/**
|
|
6786
|
+
* @public
|
|
6078
6787
|
* <p>ID of the collection the face belongs to.</p>
|
|
6079
6788
|
*/
|
|
6080
6789
|
CollectionId: string | undefined;
|
|
6081
6790
|
/**
|
|
6791
|
+
* @public
|
|
6082
6792
|
* <p>ID of a face to find matches for in the collection.</p>
|
|
6083
6793
|
*/
|
|
6084
6794
|
FaceId: string | undefined;
|
|
6085
6795
|
/**
|
|
6796
|
+
* @public
|
|
6086
6797
|
* <p>Maximum number of faces to return. The operation returns the maximum number of faces
|
|
6087
6798
|
* with the highest confidence in the match.</p>
|
|
6088
6799
|
*/
|
|
6089
6800
|
MaxFaces?: number;
|
|
6090
6801
|
/**
|
|
6802
|
+
* @public
|
|
6091
6803
|
* <p>Optional value specifying the minimum confidence in the face match to return. For
|
|
6092
6804
|
* example, don't return any matches where confidence in matches is less than 70%. The default
|
|
6093
6805
|
* value is 80%. </p>
|
|
@@ -6099,15 +6811,18 @@ export interface SearchFacesRequest {
|
|
|
6099
6811
|
*/
|
|
6100
6812
|
export interface SearchFacesResponse {
|
|
6101
6813
|
/**
|
|
6814
|
+
* @public
|
|
6102
6815
|
* <p>ID of the face that was searched for matches in a collection.</p>
|
|
6103
6816
|
*/
|
|
6104
6817
|
SearchedFaceId?: string;
|
|
6105
6818
|
/**
|
|
6819
|
+
* @public
|
|
6106
6820
|
* <p>An array of faces that matched the input face, along with the confidence in the
|
|
6107
6821
|
* match.</p>
|
|
6108
6822
|
*/
|
|
6109
6823
|
FaceMatches?: FaceMatch[];
|
|
6110
6824
|
/**
|
|
6825
|
+
* @public
|
|
6111
6826
|
* <p>Version number of the face detection model associated with the input collection
|
|
6112
6827
|
* (<code>CollectionId</code>).</p>
|
|
6113
6828
|
*/
|
|
@@ -6118,10 +6833,12 @@ export interface SearchFacesResponse {
|
|
|
6118
6833
|
*/
|
|
6119
6834
|
export interface SearchFacesByImageRequest {
|
|
6120
6835
|
/**
|
|
6836
|
+
* @public
|
|
6121
6837
|
* <p>ID of the collection to search.</p>
|
|
6122
6838
|
*/
|
|
6123
6839
|
CollectionId: string | undefined;
|
|
6124
6840
|
/**
|
|
6841
|
+
* @public
|
|
6125
6842
|
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
6126
6843
|
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
6127
6844
|
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
@@ -6130,17 +6847,20 @@ export interface SearchFacesByImageRequest {
|
|
|
6130
6847
|
*/
|
|
6131
6848
|
Image: Image | undefined;
|
|
6132
6849
|
/**
|
|
6850
|
+
* @public
|
|
6133
6851
|
* <p>Maximum number of faces to return. The operation returns the maximum number of faces
|
|
6134
6852
|
* with the highest confidence in the match.</p>
|
|
6135
6853
|
*/
|
|
6136
6854
|
MaxFaces?: number;
|
|
6137
6855
|
/**
|
|
6856
|
+
* @public
|
|
6138
6857
|
* <p>(Optional) Specifies the minimum confidence in the face match to return. For example,
|
|
6139
6858
|
* don't return any matches where confidence in matches is less than 70%. The default value is
|
|
6140
6859
|
* 80%.</p>
|
|
6141
6860
|
*/
|
|
6142
6861
|
FaceMatchThreshold?: number;
|
|
6143
6862
|
/**
|
|
6863
|
+
* @public
|
|
6144
6864
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
6145
6865
|
* Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>,
|
|
6146
6866
|
* Amazon Rekognition chooses the quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or
|
|
@@ -6160,21 +6880,25 @@ export interface SearchFacesByImageRequest {
|
|
|
6160
6880
|
*/
|
|
6161
6881
|
export interface SearchFacesByImageResponse {
|
|
6162
6882
|
/**
|
|
6883
|
+
* @public
|
|
6163
6884
|
* <p>The bounding box around the face in the input image that Amazon Rekognition used for the
|
|
6164
6885
|
* search.</p>
|
|
6165
6886
|
*/
|
|
6166
6887
|
SearchedFaceBoundingBox?: BoundingBox;
|
|
6167
6888
|
/**
|
|
6889
|
+
* @public
|
|
6168
6890
|
* <p>The level of confidence that the <code>searchedFaceBoundingBox</code>, contains a
|
|
6169
6891
|
* face.</p>
|
|
6170
6892
|
*/
|
|
6171
6893
|
SearchedFaceConfidence?: number;
|
|
6172
6894
|
/**
|
|
6895
|
+
* @public
|
|
6173
6896
|
* <p>An array of faces that match the input face, along with the confidence in the
|
|
6174
6897
|
* match.</p>
|
|
6175
6898
|
*/
|
|
6176
6899
|
FaceMatches?: FaceMatch[];
|
|
6177
6900
|
/**
|
|
6901
|
+
* @public
|
|
6178
6902
|
* <p>Version number of the face detection model associated with the input collection
|
|
6179
6903
|
* (<code>CollectionId</code>).</p>
|
|
6180
6904
|
*/
|
|
@@ -6185,24 +6909,29 @@ export interface SearchFacesByImageResponse {
|
|
|
6185
6909
|
*/
|
|
6186
6910
|
export interface SearchUsersRequest {
|
|
6187
6911
|
/**
|
|
6912
|
+
* @public
|
|
6188
6913
|
* <p>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a
|
|
6189
6914
|
* FaceId is provided, UserId isn’t required to be present in the Collection.</p>
|
|
6190
6915
|
*/
|
|
6191
6916
|
CollectionId: string | undefined;
|
|
6192
6917
|
/**
|
|
6918
|
+
* @public
|
|
6193
6919
|
* <p>ID for the existing User.</p>
|
|
6194
6920
|
*/
|
|
6195
6921
|
UserId?: string;
|
|
6196
6922
|
/**
|
|
6923
|
+
* @public
|
|
6197
6924
|
* <p>ID for the existing face.</p>
|
|
6198
6925
|
*/
|
|
6199
6926
|
FaceId?: string;
|
|
6200
6927
|
/**
|
|
6928
|
+
* @public
|
|
6201
6929
|
* <p>Optional value that specifies the minimum confidence in the matched UserID to return.
|
|
6202
6930
|
* Default value of 80.</p>
|
|
6203
6931
|
*/
|
|
6204
6932
|
UserMatchThreshold?: number;
|
|
6205
6933
|
/**
|
|
6934
|
+
* @public
|
|
6206
6935
|
* <p>Maximum number of identities to return.</p>
|
|
6207
6936
|
*/
|
|
6208
6937
|
MaxUsers?: number;
|
|
@@ -6213,6 +6942,7 @@ export interface SearchUsersRequest {
|
|
|
6213
6942
|
*/
|
|
6214
6943
|
export interface SearchedFace {
|
|
6215
6944
|
/**
|
|
6945
|
+
* @public
|
|
6216
6946
|
* <p> Unique identifier assigned to the face.</p>
|
|
6217
6947
|
*/
|
|
6218
6948
|
FaceId?: string;
|
|
@@ -6223,6 +6953,7 @@ export interface SearchedFace {
|
|
|
6223
6953
|
*/
|
|
6224
6954
|
export interface SearchedUser {
|
|
6225
6955
|
/**
|
|
6956
|
+
* @public
|
|
6226
6957
|
* <p> A provided ID for the UserID. Unique within the collection. </p>
|
|
6227
6958
|
*/
|
|
6228
6959
|
UserId?: string;
|
|
@@ -6234,10 +6965,12 @@ export interface SearchedUser {
|
|
|
6234
6965
|
*/
|
|
6235
6966
|
export interface UserMatch {
|
|
6236
6967
|
/**
|
|
6968
|
+
* @public
|
|
6237
6969
|
* <p> Describes the UserID metadata.</p>
|
|
6238
6970
|
*/
|
|
6239
6971
|
Similarity?: number;
|
|
6240
6972
|
/**
|
|
6973
|
+
* @public
|
|
6241
6974
|
* <p> Confidence in the match of this UserID with the input face. </p>
|
|
6242
6975
|
*/
|
|
6243
6976
|
User?: MatchedUser;
|
|
@@ -6247,20 +6980,24 @@ export interface UserMatch {
|
|
|
6247
6980
|
*/
|
|
6248
6981
|
export interface SearchUsersResponse {
|
|
6249
6982
|
/**
|
|
6983
|
+
* @public
|
|
6250
6984
|
* <p>An array of UserMatch objects that matched the input face along with the confidence in
|
|
6251
6985
|
* the match. Array will be empty if there are no matches.</p>
|
|
6252
6986
|
*/
|
|
6253
6987
|
UserMatches?: UserMatch[];
|
|
6254
6988
|
/**
|
|
6989
|
+
* @public
|
|
6255
6990
|
* <p>Version number of the face detection model associated with the input
|
|
6256
6991
|
* CollectionId.</p>
|
|
6257
6992
|
*/
|
|
6258
6993
|
FaceModelVersion?: string;
|
|
6259
6994
|
/**
|
|
6995
|
+
* @public
|
|
6260
6996
|
* <p>Contains the ID of a face that was used to search for matches in a collection.</p>
|
|
6261
6997
|
*/
|
|
6262
6998
|
SearchedFace?: SearchedFace;
|
|
6263
6999
|
/**
|
|
7000
|
+
* @public
|
|
6264
7001
|
* <p>Contains the ID of the UserID that was used to search for matches in a collection.</p>
|
|
6265
7002
|
*/
|
|
6266
7003
|
SearchedUser?: SearchedUser;
|
|
@@ -6270,10 +7007,12 @@ export interface SearchUsersResponse {
|
|
|
6270
7007
|
*/
|
|
6271
7008
|
export interface SearchUsersByImageRequest {
|
|
6272
7009
|
/**
|
|
7010
|
+
* @public
|
|
6273
7011
|
* <p>The ID of an existing collection containing the UserID.</p>
|
|
6274
7012
|
*/
|
|
6275
7013
|
CollectionId: string | undefined;
|
|
6276
7014
|
/**
|
|
7015
|
+
* @public
|
|
6277
7016
|
* <p>Provides the input image either as bytes or an S3 object.</p>
|
|
6278
7017
|
* <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
|
|
6279
7018
|
* property. For example, you would use the <code>Bytes</code> property to pass an image loaded
|
|
@@ -6296,15 +7035,18 @@ export interface SearchUsersByImageRequest {
|
|
|
6296
7035
|
*/
|
|
6297
7036
|
Image: Image | undefined;
|
|
6298
7037
|
/**
|
|
7038
|
+
* @public
|
|
6299
7039
|
* <p>Specifies the minimum confidence in the UserID match to return. Default value is
|
|
6300
7040
|
* 80.</p>
|
|
6301
7041
|
*/
|
|
6302
7042
|
UserMatchThreshold?: number;
|
|
6303
7043
|
/**
|
|
7044
|
+
* @public
|
|
6304
7045
|
* <p>Maximum number of UserIDs to return.</p>
|
|
6305
7046
|
*/
|
|
6306
7047
|
MaxUsers?: number;
|
|
6307
7048
|
/**
|
|
7049
|
+
* @public
|
|
6308
7050
|
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
6309
7051
|
* Filtered faces aren't searched for in the collection. The default value is NONE.</p>
|
|
6310
7052
|
*/
|
|
@@ -6316,6 +7058,7 @@ export interface SearchUsersByImageRequest {
|
|
|
6316
7058
|
*/
|
|
6317
7059
|
export interface SearchedFaceDetails {
|
|
6318
7060
|
/**
|
|
7061
|
+
* @public
|
|
6319
7062
|
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
6320
7063
|
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
6321
7064
|
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
@@ -6370,6 +7113,7 @@ export type UnsearchedFaceReason = (typeof UnsearchedFaceReason)[keyof typeof Un
|
|
|
6370
7113
|
*/
|
|
6371
7114
|
export interface UnsearchedFace {
|
|
6372
7115
|
/**
|
|
7116
|
+
* @public
|
|
6373
7117
|
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
6374
7118
|
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
6375
7119
|
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
@@ -6399,6 +7143,7 @@ export interface UnsearchedFace {
|
|
|
6399
7143
|
*/
|
|
6400
7144
|
FaceDetails?: FaceDetail;
|
|
6401
7145
|
/**
|
|
7146
|
+
* @public
|
|
6402
7147
|
* <p> Reasons why a face wasn't used for Search. </p>
|
|
6403
7148
|
*/
|
|
6404
7149
|
Reasons?: (UnsearchedFaceReason | string)[];
|
|
@@ -6408,23 +7153,27 @@ export interface UnsearchedFace {
|
|
|
6408
7153
|
*/
|
|
6409
7154
|
export interface SearchUsersByImageResponse {
|
|
6410
7155
|
/**
|
|
7156
|
+
* @public
|
|
6411
7157
|
* <p>An array of UserID objects that matched the input face, along with the confidence in the
|
|
6412
7158
|
* match. The returned structure will be empty if there are no matches. Returned if the
|
|
6413
7159
|
* SearchUsersByImageResponse action is successful.</p>
|
|
6414
7160
|
*/
|
|
6415
7161
|
UserMatches?: UserMatch[];
|
|
6416
7162
|
/**
|
|
7163
|
+
* @public
|
|
6417
7164
|
* <p>Version number of the face detection model associated with the input collection
|
|
6418
7165
|
* CollectionId.</p>
|
|
6419
7166
|
*/
|
|
6420
7167
|
FaceModelVersion?: string;
|
|
6421
7168
|
/**
|
|
7169
|
+
* @public
|
|
6422
7170
|
* <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image,
|
|
6423
7171
|
* as well as the confidence in the bounding box, that was searched for matches. If no valid
|
|
6424
7172
|
* face is detected in the image the response will contain no SearchedFace object.</p>
|
|
6425
7173
|
*/
|
|
6426
7174
|
SearchedFace?: SearchedFaceDetails;
|
|
6427
7175
|
/**
|
|
7176
|
+
* @public
|
|
6428
7177
|
* <p>List of UnsearchedFace objects. Contains the face details infered from the specified
|
|
6429
7178
|
* image but not used for search. Contains reasons that describe why a face wasn't used for
|
|
6430
7179
|
* Search. </p>
|
|
@@ -6436,22 +7185,26 @@ export interface SearchUsersByImageResponse {
|
|
|
6436
7185
|
*/
|
|
6437
7186
|
export interface StartCelebrityRecognitionRequest {
|
|
6438
7187
|
/**
|
|
7188
|
+
* @public
|
|
6439
7189
|
* <p>The video in which you want to recognize celebrities. The video must be stored
|
|
6440
7190
|
* in an Amazon S3 bucket.</p>
|
|
6441
7191
|
*/
|
|
6442
7192
|
Video: Video | undefined;
|
|
6443
7193
|
/**
|
|
7194
|
+
* @public
|
|
6444
7195
|
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
6445
7196
|
* <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use
|
|
6446
7197
|
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
6447
7198
|
*/
|
|
6448
7199
|
ClientRequestToken?: string;
|
|
6449
7200
|
/**
|
|
7201
|
+
* @public
|
|
6450
7202
|
* <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
|
|
6451
7203
|
* celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
6452
7204
|
*/
|
|
6453
7205
|
NotificationChannel?: NotificationChannel;
|
|
6454
7206
|
/**
|
|
7207
|
+
* @public
|
|
6455
7208
|
* <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
|
|
6456
7209
|
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
6457
7210
|
*/
|