@aws-sdk/client-rekognition 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/dist-types/Rekognition.d.ts +70 -6
  2. package/dist-types/RekognitionClient.d.ts +24 -4
  3. package/dist-types/commands/CompareFacesCommand.d.ts +16 -0
  4. package/dist-types/commands/CopyProjectVersionCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateCollectionCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProjectCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateProjectVersionCommand.d.ts +16 -0
  9. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteCollectionCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteDatasetCommand.d.ts +16 -0
  12. package/dist-types/commands/DeleteFacesCommand.d.ts +16 -0
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +16 -0
  14. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +16 -0
  15. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeCollectionCommand.d.ts +16 -0
  18. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  19. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +16 -0
  20. package/dist-types/commands/DescribeProjectsCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +16 -0
  22. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +16 -0
  23. package/dist-types/commands/DetectFacesCommand.d.ts +16 -0
  24. package/dist-types/commands/DetectLabelsCommand.d.ts +22 -6
  25. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +16 -0
  26. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +16 -0
  27. package/dist-types/commands/DetectTextCommand.d.ts +16 -0
  28. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +16 -0
  29. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +16 -0
  30. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +16 -0
  31. package/dist-types/commands/GetContentModerationCommand.d.ts +16 -0
  32. package/dist-types/commands/GetFaceDetectionCommand.d.ts +16 -0
  33. package/dist-types/commands/GetFaceSearchCommand.d.ts +16 -0
  34. package/dist-types/commands/GetLabelDetectionCommand.d.ts +16 -0
  35. package/dist-types/commands/GetPersonTrackingCommand.d.ts +16 -0
  36. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +16 -0
  37. package/dist-types/commands/GetTextDetectionCommand.d.ts +16 -0
  38. package/dist-types/commands/IndexFacesCommand.d.ts +16 -0
  39. package/dist-types/commands/ListCollectionsCommand.d.ts +16 -0
  40. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +16 -0
  41. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +16 -0
  42. package/dist-types/commands/ListFacesCommand.d.ts +16 -0
  43. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
  44. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +16 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  46. package/dist-types/commands/PutProjectPolicyCommand.d.ts +16 -0
  47. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +16 -0
  48. package/dist-types/commands/SearchFacesByImageCommand.d.ts +16 -0
  49. package/dist-types/commands/SearchFacesCommand.d.ts +16 -0
  50. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +16 -0
  51. package/dist-types/commands/StartContentModerationCommand.d.ts +16 -0
  52. package/dist-types/commands/StartFaceDetectionCommand.d.ts +16 -0
  53. package/dist-types/commands/StartFaceSearchCommand.d.ts +16 -0
  54. package/dist-types/commands/StartLabelDetectionCommand.d.ts +16 -0
  55. package/dist-types/commands/StartPersonTrackingCommand.d.ts +16 -0
  56. package/dist-types/commands/StartProjectVersionCommand.d.ts +16 -0
  57. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +16 -0
  58. package/dist-types/commands/StartStreamProcessorCommand.d.ts +16 -0
  59. package/dist-types/commands/StartTextDetectionCommand.d.ts +16 -0
  60. package/dist-types/commands/StopProjectVersionCommand.d.ts +16 -0
  61. package/dist-types/commands/StopStreamProcessorCommand.d.ts +16 -0
  62. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  63. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  64. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +16 -0
  65. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +16 -0
  66. package/dist-types/models/RekognitionServiceException.d.ts +2 -0
  67. package/dist-types/models/models_0.d.ts +610 -0
  68. package/dist-types/pagination/DescribeProjectVersionsPaginator.d.ts +3 -0
  69. package/dist-types/pagination/DescribeProjectsPaginator.d.ts +3 -0
  70. package/dist-types/pagination/GetCelebrityRecognitionPaginator.d.ts +3 -0
  71. package/dist-types/pagination/GetContentModerationPaginator.d.ts +3 -0
  72. package/dist-types/pagination/GetFaceDetectionPaginator.d.ts +3 -0
  73. package/dist-types/pagination/GetFaceSearchPaginator.d.ts +3 -0
  74. package/dist-types/pagination/GetLabelDetectionPaginator.d.ts +3 -0
  75. package/dist-types/pagination/GetPersonTrackingPaginator.d.ts +3 -0
  76. package/dist-types/pagination/GetSegmentDetectionPaginator.d.ts +3 -0
  77. package/dist-types/pagination/GetTextDetectionPaginator.d.ts +3 -0
  78. package/dist-types/pagination/Interfaces.d.ts +3 -0
  79. package/dist-types/pagination/ListCollectionsPaginator.d.ts +3 -0
  80. package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +3 -0
  81. package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +3 -0
  82. package/dist-types/pagination/ListFacesPaginator.d.ts +3 -0
  83. package/dist-types/pagination/ListProjectPoliciesPaginator.d.ts +3 -0
  84. package/dist-types/pagination/ListStreamProcessorsPaginator.d.ts +3 -0
  85. package/package.json +3 -3
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType, LazyJsonString as __LazyJsonString } from "@aws-sdk/smithy-client";
2
2
  import { RekognitionServiceException as __BaseException } from "./RekognitionServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>You are not authorized to perform the action.</p>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -18,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
18
19
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
19
20
  }
20
21
  /**
22
+ * @public
21
23
  * <p>Structure containing the estimated age range, in years, for a face.</p>
22
24
  * <p>Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age
23
25
  * ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the
@@ -34,6 +36,7 @@ export interface AgeRange {
34
36
  High?: number;
35
37
  }
36
38
  /**
39
+ * @public
37
40
  * <p>Provides the S3 bucket name and object name.</p>
38
41
  * <p>The region for the S3 bucket containing the S3 object must match the region you use for
39
42
  * Amazon Rekognition operations.</p>
@@ -56,6 +59,7 @@ export interface S3Object {
56
59
  Version?: string;
57
60
  }
58
61
  /**
62
+ * @public
59
63
  * <p>The S3 bucket that contains an Amazon Sagemaker Ground Truth format manifest file.
60
64
  * </p>
61
65
  */
@@ -71,6 +75,7 @@ export interface GroundTruthManifest {
71
75
  S3Object?: S3Object;
72
76
  }
73
77
  /**
78
+ * @public
74
79
  * <p>Assets are the images that you use to train and evaluate a model version.
75
80
  * Assets can also contain validation information that you use to debug a failed model training.
76
81
  * </p>
@@ -82,11 +87,15 @@ export interface Asset {
82
87
  */
83
88
  GroundTruthManifest?: GroundTruthManifest;
84
89
  }
90
+ /**
91
+ * @public
92
+ */
85
93
  export declare enum Attribute {
86
94
  ALL = "ALL",
87
95
  DEFAULT = "DEFAULT"
88
96
  }
89
97
  /**
98
+ * @public
90
99
  * <p>Metadata information about an audio stream. An array of <code>AudioMetadata</code> objects
91
100
  * for the audio streams found in a stored video is returned by <a>GetSegmentDetection</a>. </p>
92
101
  */
@@ -109,6 +118,7 @@ export interface AudioMetadata {
109
118
  NumberOfChannels?: number;
110
119
  }
111
120
  /**
121
+ * @public
112
122
  * <p>Indicates whether or not the face has a beard, and the confidence level in the
113
123
  * determination.</p>
114
124
  */
@@ -123,6 +133,7 @@ export interface Beard {
123
133
  Confidence?: number;
124
134
  }
125
135
  /**
136
+ * @public
126
137
  * <p>
127
138
  * A filter that allows you to control the black frame detection by specifying the black levels
128
139
  * and pixel coverage of black pixels in a frame. As videos can come from multiple sources, formats,
@@ -152,6 +163,9 @@ export interface BlackFrame {
152
163
  */
153
164
  MinCoveragePercentage?: number;
154
165
  }
166
+ /**
167
+ * @public
168
+ */
155
169
  export declare enum BodyPart {
156
170
  FACE = "FACE",
157
171
  HEAD = "HEAD",
@@ -159,6 +173,7 @@ export declare enum BodyPart {
159
173
  RIGHT_HAND = "RIGHT_HAND"
160
174
  }
161
175
  /**
176
+ * @public
162
177
  * <p>Identifies the bounding box around the label, face, text, object of interest, or
163
178
  * personal protective equipment. The <code>left</code> (x-coordinate) and <code>top</code>
164
179
  * (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note
@@ -197,6 +212,7 @@ export interface BoundingBox {
197
212
  Top?: number;
198
213
  }
199
214
  /**
215
+ * @public
200
216
  * <p>Information about an item of Personal Protective Equipment covering a corresponding body part. For more
201
217
  * information, see <a>DetectProtectiveEquipment</a>.</p>
202
218
  */
@@ -210,12 +226,16 @@ export interface CoversBodyPart {
210
226
  */
211
227
  Value?: boolean;
212
228
  }
229
+ /**
230
+ * @public
231
+ */
213
232
  export declare enum ProtectiveEquipmentType {
214
233
  FACE_COVER = "FACE_COVER",
215
234
  HAND_COVER = "HAND_COVER",
216
235
  HEAD_COVER = "HEAD_COVER"
217
236
  }
218
237
  /**
238
+ * @public
219
239
  * <p>Information about an item of Personal Protective Equipment (PPE) detected by
220
240
  * <a>DetectProtectiveEquipment</a>. For more
221
241
  * information, see <a>DetectProtectiveEquipment</a>.</p>
@@ -239,6 +259,7 @@ export interface EquipmentDetection {
239
259
  CoversBodyPart?: CoversBodyPart;
240
260
  }
241
261
  /**
262
+ * @public
242
263
  * <p>Information about a body part detected by <a>DetectProtectiveEquipment</a> that contains PPE.
243
264
  * An array of <code>ProtectiveEquipmentBodyPart</code> objects is returned for each person detected by
244
265
  * <code>DetectProtectiveEquipment</code>. </p>
@@ -258,6 +279,9 @@ export interface ProtectiveEquipmentBodyPart {
258
279
  */
259
280
  EquipmentDetections?: EquipmentDetection[];
260
281
  }
282
+ /**
283
+ * @public
284
+ */
261
285
  export declare enum EmotionName {
262
286
  ANGRY = "ANGRY",
263
287
  CALM = "CALM",
@@ -270,6 +294,7 @@ export declare enum EmotionName {
270
294
  UNKNOWN = "UNKNOWN"
271
295
  }
272
296
  /**
297
+ * @public
273
298
  * <p>The emotions that appear to be expressed on the face, and the confidence level in the
274
299
  * determination. The API is only making a determination of the physical appearance of a person's
275
300
  * face. It is not a determination of the person’s internal emotional state and should not be
@@ -286,6 +311,9 @@ export interface Emotion {
286
311
  */
287
312
  Confidence?: number;
288
313
  }
314
+ /**
315
+ * @public
316
+ */
289
317
  export declare enum LandmarkType {
290
318
  chinBottom = "chinBottom",
291
319
  eyeLeft = "eyeLeft",
@@ -319,6 +347,7 @@ export declare enum LandmarkType {
319
347
  upperJawlineRight = "upperJawlineRight"
320
348
  }
321
349
  /**
350
+ * @public
322
351
  * <p>Indicates the location of the landmark on the face.</p>
323
352
  */
324
353
  export interface Landmark {
@@ -341,6 +370,7 @@ export interface Landmark {
341
370
  Y?: number;
342
371
  }
343
372
  /**
373
+ * @public
344
374
  * <p>Indicates the pose of the face as determined by its pitch, roll, and yaw.</p>
345
375
  */
346
376
  export interface Pose {
@@ -358,6 +388,7 @@ export interface Pose {
358
388
  Pitch?: number;
359
389
  }
360
390
  /**
391
+ * @public
361
392
  * <p>Identifies face image brightness and sharpness. </p>
362
393
  */
363
394
  export interface ImageQuality {
@@ -373,6 +404,7 @@ export interface ImageQuality {
373
404
  Sharpness?: number;
374
405
  }
375
406
  /**
407
+ * @public
376
408
  * <p>Indicates whether or not the face is smiling, and the confidence level in the
377
409
  * determination.</p>
378
410
  */
@@ -387,6 +419,7 @@ export interface Smile {
387
419
  Confidence?: number;
388
420
  }
389
421
  /**
422
+ * @public
390
423
  * <p>Provides face metadata for target image faces that are analyzed by
391
424
  * <code>CompareFaces</code> and <code>RecognizeCelebrities</code>.</p>
392
425
  */
@@ -423,6 +456,9 @@ export interface ComparedFace {
423
456
  */
424
457
  Smile?: Smile;
425
458
  }
459
+ /**
460
+ * @public
461
+ */
426
462
  export declare enum KnownGenderType {
427
463
  Female = "Female",
428
464
  Male = "Male",
@@ -430,6 +466,7 @@ export declare enum KnownGenderType {
430
466
  Unlisted = "Unlisted"
431
467
  }
432
468
  /**
469
+ * @public
433
470
  * <p>The known gender identity for the celebrity that matches the provided ID. The known
434
471
  * gender identity can be Male, Female, Nonbinary, or Unlisted.</p>
435
472
  */
@@ -440,6 +477,7 @@ export interface KnownGender {
440
477
  Type?: KnownGenderType | string;
441
478
  }
442
479
  /**
480
+ * @public
443
481
  * <p>Provides information about a celebrity recognized by the <a>RecognizeCelebrities</a> operation.</p>
444
482
  */
445
483
  export interface Celebrity {
@@ -473,6 +511,7 @@ export interface Celebrity {
473
511
  KnownGender?: KnownGender;
474
512
  }
475
513
  /**
514
+ * @public
476
515
  * <p>Indicates whether or not the face is wearing eye glasses, and the confidence level in
477
516
  * the determination.</p>
478
517
  */
@@ -487,6 +526,7 @@ export interface Eyeglasses {
487
526
  Confidence?: number;
488
527
  }
489
528
  /**
529
+ * @public
490
530
  * <p>Indicates whether or not the eyes on the face are open, and the confidence level in the
491
531
  * determination.</p>
492
532
  */
@@ -500,11 +540,15 @@ export interface EyeOpen {
500
540
  */
501
541
  Confidence?: number;
502
542
  }
543
+ /**
544
+ * @public
545
+ */
503
546
  export declare enum GenderType {
504
547
  Female = "Female",
505
548
  Male = "Male"
506
549
  }
507
550
  /**
551
+ * @public
508
552
  * <p>The predicted gender of a detected face.
509
553
  *
510
554
  * </p>
@@ -531,6 +575,7 @@ export interface Gender {
531
575
  Confidence?: number;
532
576
  }
533
577
  /**
578
+ * @public
534
579
  * <p>Indicates whether or not the mouth on the face is open, and the confidence level in the
535
580
  * determination.</p>
536
581
  */
@@ -545,6 +590,7 @@ export interface MouthOpen {
545
590
  Confidence?: number;
546
591
  }
547
592
  /**
593
+ * @public
548
594
  * <p>Indicates whether or not the face has a mustache, and the confidence level in the
549
595
  * determination.</p>
550
596
  */
@@ -559,6 +605,7 @@ export interface Mustache {
559
605
  Confidence?: number;
560
606
  }
561
607
  /**
608
+ * @public
562
609
  * <p>Indicates whether or not the face is wearing sunglasses, and the confidence level in
563
610
  * the determination.</p>
564
611
  */
@@ -573,6 +620,7 @@ export interface Sunglasses {
573
620
  Confidence?: number;
574
621
  }
575
622
  /**
623
+ * @public
576
624
  * <p>Structure containing attributes of the face that the algorithm detected.</p>
577
625
  * <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
578
626
  * facial attributes. The default attributes are <code>BoundingBox</code>,
@@ -677,6 +725,7 @@ export interface FaceDetail {
677
725
  Confidence?: number;
678
726
  }
679
727
  /**
728
+ * @public
680
729
  * <p>Information about a recognized celebrity.</p>
681
730
  */
682
731
  export interface CelebrityDetail {
@@ -710,6 +759,7 @@ export interface CelebrityDetail {
710
759
  KnownGender?: KnownGender;
711
760
  }
712
761
  /**
762
+ * @public
713
763
  * <p>Information about a detected celebrity and the time the celebrity was detected in a stored video.
714
764
  * For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.</p>
715
765
  */
@@ -724,11 +774,15 @@ export interface CelebrityRecognition {
724
774
  */
725
775
  Celebrity?: CelebrityDetail;
726
776
  }
777
+ /**
778
+ * @public
779
+ */
727
780
  export declare enum CelebrityRecognitionSortBy {
728
781
  ID = "ID",
729
782
  TIMESTAMP = "TIMESTAMP"
730
783
  }
731
784
  /**
785
+ * @public
732
786
  * <p>Type that describes the face Amazon Rekognition chose to compare with the faces in the target.
733
787
  * This contains a bounding box for the selected face and confidence level that the bounding box
734
788
  * contains a face. Note that Amazon Rekognition selects the largest face in the source image for this
@@ -744,6 +798,9 @@ export interface ComparedSourceImageFace {
744
798
  */
745
799
  Confidence?: number;
746
800
  }
801
+ /**
802
+ * @public
803
+ */
747
804
  export declare enum QualityFilter {
748
805
  AUTO = "AUTO",
749
806
  HIGH = "HIGH",
@@ -752,6 +809,7 @@ export declare enum QualityFilter {
752
809
  NONE = "NONE"
753
810
  }
754
811
  /**
812
+ * @public
755
813
  * <p>Provides the input image either as bytes or an S3 object.</p>
756
814
  * <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
757
815
  * property. For example, you would use the <code>Bytes</code> property to pass an image loaded
@@ -784,6 +842,9 @@ export interface Image {
784
842
  */
785
843
  S3Object?: S3Object;
786
844
  }
845
+ /**
846
+ * @public
847
+ */
787
848
  export interface CompareFacesRequest {
788
849
  /**
789
850
  * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
@@ -822,6 +883,7 @@ export interface CompareFacesRequest {
822
883
  QualityFilter?: QualityFilter | string;
823
884
  }
824
885
  /**
886
+ * @public
825
887
  * <p>Provides information about a face in a target image that matches the source image face
826
888
  * analyzed by <code>CompareFaces</code>. The <code>Face</code> property contains the bounding
827
889
  * box of the face in the target image. The <code>Similarity</code> property is the confidence
@@ -838,12 +900,18 @@ export interface CompareFacesMatch {
838
900
  */
839
901
  Face?: ComparedFace;
840
902
  }
903
+ /**
904
+ * @public
905
+ */
841
906
  export declare enum OrientationCorrection {
842
907
  ROTATE_0 = "ROTATE_0",
843
908
  ROTATE_180 = "ROTATE_180",
844
909
  ROTATE_270 = "ROTATE_270",
845
910
  ROTATE_90 = "ROTATE_90"
846
911
  }
912
+ /**
913
+ * @public
914
+ */
847
915
  export interface CompareFacesResponse {
848
916
  /**
849
917
  * <p>The face in the source image that was used for comparison.</p>
@@ -887,6 +955,7 @@ export interface CompareFacesResponse {
887
955
  TargetImageOrientationCorrection?: OrientationCorrection | string;
888
956
  }
889
957
  /**
958
+ * @public
890
959
  * <p>The input image size exceeds the allowed limit. If you are calling
891
960
  * DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more
892
961
  * information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
@@ -907,6 +976,7 @@ export declare class ImageTooLargeException extends __BaseException {
907
976
  constructor(opts: __ExceptionOptionType<ImageTooLargeException, __BaseException>);
908
977
  }
909
978
  /**
979
+ * @public
910
980
  * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
911
981
  */
912
982
  export declare class InternalServerError extends __BaseException {
@@ -924,6 +994,7 @@ export declare class InternalServerError extends __BaseException {
924
994
  constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
925
995
  }
926
996
  /**
997
+ * @public
927
998
  * <p>The provided image format is not supported. </p>
928
999
  */
929
1000
  export declare class InvalidImageFormatException extends __BaseException {
@@ -941,6 +1012,7 @@ export declare class InvalidImageFormatException extends __BaseException {
941
1012
  constructor(opts: __ExceptionOptionType<InvalidImageFormatException, __BaseException>);
942
1013
  }
943
1014
  /**
1015
+ * @public
944
1016
  * <p>Input parameter violated a constraint. Validate your parameter before calling the API
945
1017
  * operation again.</p>
946
1018
  */
@@ -959,6 +1031,7 @@ export declare class InvalidParameterException extends __BaseException {
959
1031
  constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
960
1032
  }
961
1033
  /**
1034
+ * @public
962
1035
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
963
1036
  */
964
1037
  export declare class InvalidS3ObjectException extends __BaseException {
@@ -976,6 +1049,7 @@ export declare class InvalidS3ObjectException extends __BaseException {
976
1049
  constructor(opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>);
977
1050
  }
978
1051
  /**
1052
+ * @public
979
1053
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
980
1054
  * limit, contact Amazon Rekognition.</p>
981
1055
  */
@@ -994,6 +1068,7 @@ export declare class ProvisionedThroughputExceededException extends __BaseExcept
994
1068
  constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
995
1069
  }
996
1070
  /**
1071
+ * @public
997
1072
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
998
1073
  */
999
1074
  export declare class ThrottlingException extends __BaseException {
@@ -1011,6 +1086,7 @@ export declare class ThrottlingException extends __BaseException {
1011
1086
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1012
1087
  }
1013
1088
  /**
1089
+ * @public
1014
1090
  * <p>
1015
1091
  * Label detection settings to use on a streaming video. Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.
1016
1092
  * Including this setting in the <code>CreateStreamProcessor</code> request enables you to use the stream processor for label detection.
@@ -1034,6 +1110,7 @@ export interface ConnectedHomeSettings {
1034
1110
  MinConfidence?: number;
1035
1111
  }
1036
1112
  /**
1113
+ * @public
1037
1114
  * <p>
1038
1115
  * The label detection settings you want to use in your stream processor. This includes the labels you want the stream processor to detect and the minimum confidence level allowed to label objects.
1039
1116
  * </p>
@@ -1052,11 +1129,15 @@ export interface ConnectedHomeSettingsForUpdate {
1052
1129
  */
1053
1130
  MinConfidence?: number;
1054
1131
  }
1132
+ /**
1133
+ * @public
1134
+ */
1055
1135
  export declare enum ContentClassifier {
1056
1136
  FREE_OF_ADULT_CONTENT = "FreeOfAdultContent",
1057
1137
  FREE_OF_PERSONALLY_IDENTIFIABLE_INFORMATION = "FreeOfPersonallyIdentifiableInformation"
1058
1138
  }
1059
1139
  /**
1140
+ * @public
1060
1141
  * <p>Provides information about a single type of inappropriate, unwanted, or
1061
1142
  * offensive content found in an image or video. Each type of moderated content has a label
1062
1143
  * within a hierarchical taxonomy. For more information, see Content moderation in the Amazon Rekognition
@@ -1082,6 +1163,7 @@ export interface ModerationLabel {
1082
1163
  ParentName?: string;
1083
1164
  }
1084
1165
  /**
1166
+ * @public
1085
1167
  * <p>Information about an inappropriate, unwanted, or offensive content label detection in a stored video.</p>
1086
1168
  */
1087
1169
  export interface ContentModerationDetection {
@@ -1095,11 +1177,15 @@ export interface ContentModerationDetection {
1095
1177
  */
1096
1178
  ModerationLabel?: ModerationLabel;
1097
1179
  }
1180
+ /**
1181
+ * @public
1182
+ */
1098
1183
  export declare enum ContentModerationSortBy {
1099
1184
  NAME = "NAME",
1100
1185
  TIMESTAMP = "TIMESTAMP"
1101
1186
  }
1102
1187
  /**
1188
+ * @public
1103
1189
  * <p>The S3 bucket and folder location where training output is placed.</p>
1104
1190
  */
1105
1191
  export interface OutputConfig {
@@ -1112,6 +1198,9 @@ export interface OutputConfig {
1112
1198
  */
1113
1199
  S3KeyPrefix?: string;
1114
1200
  }
1201
+ /**
1202
+ * @public
1203
+ */
1115
1204
  export interface CopyProjectVersionRequest {
1116
1205
  /**
1117
1206
  * <p>The ARN of the source project in the trusting AWS account.</p>
@@ -1163,6 +1252,9 @@ export interface CopyProjectVersionRequest {
1163
1252
  */
1164
1253
  KmsKeyId?: string;
1165
1254
  }
1255
+ /**
1256
+ * @public
1257
+ */
1166
1258
  export interface CopyProjectVersionResponse {
1167
1259
  /**
1168
1260
  * <p>The ARN of the copied model version in the destination project. </p>
@@ -1170,6 +1262,7 @@ export interface CopyProjectVersionResponse {
1170
1262
  ProjectVersionArn?: string;
1171
1263
  }
1172
1264
  /**
1265
+ * @public
1173
1266
  * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
1174
1267
  * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
1175
1268
  * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
@@ -1189,6 +1282,7 @@ export declare class LimitExceededException extends __BaseException {
1189
1282
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
1190
1283
  }
1191
1284
  /**
1285
+ * @public
1192
1286
  * <p>The specified resource is already being used.</p>
1193
1287
  */
1194
1288
  export declare class ResourceInUseException extends __BaseException {
@@ -1206,6 +1300,7 @@ export declare class ResourceInUseException extends __BaseException {
1206
1300
  constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
1207
1301
  }
1208
1302
  /**
1303
+ * @public
1209
1304
  * <p>The resource specified in the request cannot be found.</p>
1210
1305
  */
1211
1306
  export declare class ResourceNotFoundException extends __BaseException {
@@ -1223,6 +1318,7 @@ export declare class ResourceNotFoundException extends __BaseException {
1223
1318
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
1224
1319
  }
1225
1320
  /**
1321
+ * @public
1226
1322
  * <p></p>
1227
1323
  * <p>The size of the collection exceeds the allowed limit. For more information,
1228
1324
  * see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
@@ -1241,6 +1337,9 @@ export declare class ServiceQuotaExceededException extends __BaseException {
1241
1337
  */
1242
1338
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
1243
1339
  }
1340
+ /**
1341
+ * @public
1342
+ */
1244
1343
  export interface CreateCollectionRequest {
1245
1344
  /**
1246
1345
  * <p>ID for the collection that you are creating.</p>
@@ -1251,6 +1350,9 @@ export interface CreateCollectionRequest {
1251
1350
  */
1252
1351
  Tags?: Record<string, string>;
1253
1352
  }
1353
+ /**
1354
+ * @public
1355
+ */
1254
1356
  export interface CreateCollectionResponse {
1255
1357
  /**
1256
1358
  * <p>HTTP status code indicating the result of the operation.</p>
@@ -1268,6 +1370,7 @@ export interface CreateCollectionResponse {
1268
1370
  FaceModelVersion?: string;
1269
1371
  }
1270
1372
  /**
1373
+ * @public
1271
1374
  * <p>A resource with the specified ID already exists.</p>
1272
1375
  */
1273
1376
  export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -1285,6 +1388,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
1285
1388
  constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
1286
1389
  }
1287
1390
  /**
1391
+ * @public
1288
1392
  * <p>
1289
1393
  * The source that Amazon Rekognition Custom Labels uses to create a dataset. To
1290
1394
  * use an Amazon Sagemaker format manifest file, specify the S3 bucket location in the <code>GroundTruthManifest</code> field.
@@ -1309,10 +1413,16 @@ export interface DatasetSource {
1309
1413
  */
1310
1414
  DatasetArn?: string;
1311
1415
  }
1416
+ /**
1417
+ * @public
1418
+ */
1312
1419
  export declare enum DatasetType {
1313
1420
  TEST = "TEST",
1314
1421
  TRAIN = "TRAIN"
1315
1422
  }
1423
+ /**
1424
+ * @public
1425
+ */
1316
1426
  export interface CreateDatasetRequest {
1317
1427
  /**
1318
1428
  * <p>
@@ -1337,6 +1447,9 @@ export interface CreateDatasetRequest {
1337
1447
  */
1338
1448
  ProjectArn: string | undefined;
1339
1449
  }
1450
+ /**
1451
+ * @public
1452
+ */
1340
1453
  export interface CreateDatasetResponse {
1341
1454
  /**
1342
1455
  * <p>
@@ -1345,12 +1458,18 @@ export interface CreateDatasetResponse {
1345
1458
  */
1346
1459
  DatasetArn?: string;
1347
1460
  }
1461
+ /**
1462
+ * @public
1463
+ */
1348
1464
  export interface CreateProjectRequest {
1349
1465
  /**
1350
1466
  * <p>The name of the project to create.</p>
1351
1467
  */
1352
1468
  ProjectName: string | undefined;
1353
1469
  }
1470
+ /**
1471
+ * @public
1472
+ */
1354
1473
  export interface CreateProjectResponse {
1355
1474
  /**
1356
1475
  * <p>The Amazon Resource Name (ARN) of the new project. You can use the ARN to
@@ -1359,6 +1478,7 @@ export interface CreateProjectResponse {
1359
1478
  ProjectArn?: string;
1360
1479
  }
1361
1480
  /**
1481
+ * @public
1362
1482
  * <p>The dataset used for testing. Optionally, if <code>AutoCreate</code> is set, Amazon Rekognition Custom Labels uses the
1363
1483
  * training dataset to create a test dataset with a temporary split of the training dataset. </p>
1364
1484
  */
@@ -1374,6 +1494,7 @@ export interface TestingData {
1374
1494
  AutoCreate?: boolean;
1375
1495
  }
1376
1496
  /**
1497
+ * @public
1377
1498
  * <p>The dataset used for training.</p>
1378
1499
  */
1379
1500
  export interface TrainingData {
@@ -1382,6 +1503,9 @@ export interface TrainingData {
1382
1503
  */
1383
1504
  Assets?: Asset[];
1384
1505
  }
1506
+ /**
1507
+ * @public
1508
+ */
1385
1509
  export interface CreateProjectVersionRequest {
1386
1510
  /**
1387
1511
  * <p>The ARN of the Amazon Rekognition Custom Labels project that
@@ -1442,6 +1566,9 @@ export interface CreateProjectVersionRequest {
1442
1566
  */
1443
1567
  KmsKeyId?: string;
1444
1568
  }
1569
+ /**
1570
+ * @public
1571
+ */
1445
1572
  export interface CreateProjectVersionResponse {
1446
1573
  /**
1447
1574
  * <p>The ARN of the model version that was created. Use <code>DescribeProjectVersion</code>
@@ -1450,6 +1577,7 @@ export interface CreateProjectVersionResponse {
1450
1577
  ProjectVersionArn?: string;
1451
1578
  }
1452
1579
  /**
1580
+ * @public
1453
1581
  * <p>
1454
1582
  * Allows you to opt in or opt out to share data with Rekognition to improve model performance. You can choose this option at the account level or on a per-stream basis.
1455
1583
  * Note that if you opt out at the account level this setting is ignored on individual streams.
@@ -1465,6 +1593,7 @@ export interface StreamProcessorDataSharingPreference {
1465
1593
  OptIn: boolean | undefined;
1466
1594
  }
1467
1595
  /**
1596
+ * @public
1468
1597
  * <p>Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see
1469
1598
  * CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
1470
1599
  */
@@ -1475,6 +1604,7 @@ export interface KinesisVideoStream {
1475
1604
  Arn?: string;
1476
1605
  }
1477
1606
  /**
1607
+ * @public
1478
1608
  * <p>Information about the source streaming video. </p>
1479
1609
  */
1480
1610
  export interface StreamProcessorInput {
@@ -1484,6 +1614,7 @@ export interface StreamProcessorInput {
1484
1614
  KinesisVideoStream?: KinesisVideoStream;
1485
1615
  }
1486
1616
  /**
1617
+ * @public
1487
1618
  * <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>
1488
1619
  * <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
1489
1620
  * 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,
@@ -1499,6 +1630,7 @@ export interface StreamProcessorNotificationChannel {
1499
1630
  SNSTopicArn: string | undefined;
1500
1631
  }
1501
1632
  /**
1633
+ * @public
1502
1634
  * <p>The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see
1503
1635
  * CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
1504
1636
  */
@@ -1509,6 +1641,7 @@ export interface KinesisDataStream {
1509
1641
  Arn?: string;
1510
1642
  }
1511
1643
  /**
1644
+ * @public
1512
1645
  * <p>
1513
1646
  * The Amazon S3 bucket location to which Amazon Rekognition publishes the detailed inference results of a video analysis operation.
1514
1647
  * These results include the name of the stream processor resource, the session ID of the stream processing session,
@@ -1531,6 +1664,7 @@ export interface S3Destination {
1531
1664
  KeyPrefix?: string;
1532
1665
  }
1533
1666
  /**
1667
+ * @public
1534
1668
  * <p>Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more
1535
1669
  * information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.</p>
1536
1670
  */
@@ -1547,6 +1681,7 @@ export interface StreamProcessorOutput {
1547
1681
  S3Destination?: S3Destination;
1548
1682
  }
1549
1683
  /**
1684
+ * @public
1550
1685
  * <p>The X and Y coordinates of a point on an image or video frame. The X and Y values are
1551
1686
  * ratios of the overall image size or video resolution. For example, if an input image is
1552
1687
  * 700x200 and the values are X=0.5 and Y=0.25, then the point is at the (350,50) pixel
@@ -1567,6 +1702,7 @@ export interface Point {
1567
1702
  Y?: number;
1568
1703
  }
1569
1704
  /**
1705
+ * @public
1570
1706
  * <p>Specifies a location within the frame that Rekognition checks for objects of interest such as text, labels, or faces. It uses a <code>BoundingBox</code>
1571
1707
  * or <code>Polygon</code> to set a region of the screen.</p>
1572
1708
  * <p>A word, face, or label is included in the region if it is more than half in that region. If there is more than
@@ -1586,6 +1722,7 @@ export interface RegionOfInterest {
1586
1722
  Polygon?: Point[];
1587
1723
  }
1588
1724
  /**
1725
+ * @public
1589
1726
  * <p>Input face recognition parameters for an Amazon Rekognition stream processor.
1590
1727
  * Includes the collection to use for face recognition and the face attributes to detect.
1591
1728
  * Defining the settings is required in the request parameter for <a>CreateStreamProcessor</a>.</p>
@@ -1602,6 +1739,7 @@ export interface FaceSearchSettings {
1602
1739
  FaceMatchThreshold?: number;
1603
1740
  }
1604
1741
  /**
1742
+ * @public
1605
1743
  * <p>Input parameters used in a streaming video analyzed by a Amazon Rekognition stream processor.
1606
1744
  * You can use <code>FaceSearch</code> to recognize faces in a streaming video, or you can use <code>ConnectedHome</code> to detect labels. </p>
1607
1745
  */
@@ -1621,6 +1759,9 @@ export interface StreamProcessorSettings {
1621
1759
  */
1622
1760
  ConnectedHome?: ConnectedHomeSettings;
1623
1761
  }
1762
+ /**
1763
+ * @public
1764
+ */
1624
1765
  export interface CreateStreamProcessorRequest {
1625
1766
  /**
1626
1767
  * <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>
@@ -1684,6 +1825,9 @@ export interface CreateStreamProcessorRequest {
1684
1825
  */
1685
1826
  DataSharingPreference?: StreamProcessorDataSharingPreference;
1686
1827
  }
1828
+ /**
1829
+ * @public
1830
+ */
1687
1831
  export interface CreateStreamProcessorResponse {
1688
1832
  /**
1689
1833
  * <p>Amazon Resource Number for the newly created stream processor.</p>
@@ -1691,6 +1835,7 @@ export interface CreateStreamProcessorResponse {
1691
1835
  StreamProcessorArn?: string;
1692
1836
  }
1693
1837
  /**
1838
+ * @public
1694
1839
  * <p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on an image.</p>
1695
1840
  */
1696
1841
  export interface Geometry {
@@ -1705,6 +1850,7 @@ export interface Geometry {
1705
1850
  Polygon?: Point[];
1706
1851
  }
1707
1852
  /**
1853
+ * @public
1708
1854
  * <p>A custom label detected in an image by a call to <a>DetectCustomLabels</a>.</p>
1709
1855
  */
1710
1856
  export interface CustomLabel {
@@ -1725,6 +1871,7 @@ export interface CustomLabel {
1725
1871
  Geometry?: Geometry;
1726
1872
  }
1727
1873
  /**
1874
+ * @public
1728
1875
  * <p>
1729
1876
  * Describes updates or additions to a dataset. A Single update or addition
1730
1877
  * is an entry (JSON Line) that provides information about a single image. To update an existing entry,
@@ -1746,6 +1893,7 @@ export interface DatasetChanges {
1746
1893
  GroundTruth: Uint8Array | undefined;
1747
1894
  }
1748
1895
  /**
1896
+ * @public
1749
1897
  * <p>
1750
1898
  * Provides statistics about a dataset. For more information, see <a>DescribeDataset</a>.
1751
1899
  *
@@ -1777,6 +1925,9 @@ export interface DatasetStats {
1777
1925
  */
1778
1926
  ErrorEntries?: number;
1779
1927
  }
1928
+ /**
1929
+ * @public
1930
+ */
1780
1931
  export declare enum DatasetStatus {
1781
1932
  CREATE_COMPLETE = "CREATE_COMPLETE",
1782
1933
  CREATE_FAILED = "CREATE_FAILED",
@@ -1786,12 +1937,16 @@ export declare enum DatasetStatus {
1786
1937
  UPDATE_FAILED = "UPDATE_FAILED",
1787
1938
  UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
1788
1939
  }
1940
+ /**
1941
+ * @public
1942
+ */
1789
1943
  export declare enum DatasetStatusMessageCode {
1790
1944
  CLIENT_ERROR = "CLIENT_ERROR",
1791
1945
  SERVICE_ERROR = "SERVICE_ERROR",
1792
1946
  SUCCESS = "SUCCESS"
1793
1947
  }
1794
1948
  /**
1949
+ * @public
1795
1950
  * <p>
1796
1951
  * A description for a dataset. For more information, see <a>DescribeDataset</a>.</p>
1797
1952
  * <p>The status fields <code>Status</code>, <code>StatusMessage</code>, and <code>StatusMessageCode</code>
@@ -1839,6 +1994,7 @@ export interface DatasetDescription {
1839
1994
  DatasetStats?: DatasetStats;
1840
1995
  }
1841
1996
  /**
1997
+ * @public
1842
1998
  * <p>
1843
1999
  * Statistics about a label used in a dataset. For more information, see <a>DatasetLabelDescription</a>.
1844
2000
  * </p>
@@ -1858,6 +2014,7 @@ export interface DatasetLabelStats {
1858
2014
  BoundingBoxCount?: number;
1859
2015
  }
1860
2016
  /**
2017
+ * @public
1861
2018
  * <p>
1862
2019
  * Describes a dataset label. For more information, see <a>ListDatasetLabels</a>.
1863
2020
  * </p>
@@ -1877,6 +2034,7 @@ export interface DatasetLabelDescription {
1877
2034
  LabelStats?: DatasetLabelStats;
1878
2035
  }
1879
2036
  /**
2037
+ * @public
1880
2038
  * <p>
1881
2039
  * Summary information for an Amazon Rekognition Custom Labels dataset. For more information, see
1882
2040
  * <a>ProjectDescription</a>.
@@ -1922,18 +2080,27 @@ export interface DatasetMetadata {
1922
2080
  */
1923
2081
  StatusMessageCode?: DatasetStatusMessageCode | string;
1924
2082
  }
2083
+ /**
2084
+ * @public
2085
+ */
1925
2086
  export interface DeleteCollectionRequest {
1926
2087
  /**
1927
2088
  * <p>ID of the collection to delete.</p>
1928
2089
  */
1929
2090
  CollectionId: string | undefined;
1930
2091
  }
2092
+ /**
2093
+ * @public
2094
+ */
1931
2095
  export interface DeleteCollectionResponse {
1932
2096
  /**
1933
2097
  * <p>HTTP status code that indicates the result of the operation.</p>
1934
2098
  */
1935
2099
  StatusCode?: number;
1936
2100
  }
2101
+ /**
2102
+ * @public
2103
+ */
1937
2104
  export interface DeleteDatasetRequest {
1938
2105
  /**
1939
2106
  * <p>
@@ -1942,8 +2109,14 @@ export interface DeleteDatasetRequest {
1942
2109
  */
1943
2110
  DatasetArn: string | undefined;
1944
2111
  }
2112
+ /**
2113
+ * @public
2114
+ */
1945
2115
  export interface DeleteDatasetResponse {
1946
2116
  }
2117
+ /**
2118
+ * @public
2119
+ */
1947
2120
  export interface DeleteFacesRequest {
1948
2121
  /**
1949
2122
  * <p>Collection from which to remove the specific faces.</p>
@@ -1954,29 +2127,44 @@ export interface DeleteFacesRequest {
1954
2127
  */
1955
2128
  FaceIds: string[] | undefined;
1956
2129
  }
2130
+ /**
2131
+ * @public
2132
+ */
1957
2133
  export interface DeleteFacesResponse {
1958
2134
  /**
1959
2135
  * <p>An array of strings (face IDs) of the faces that were deleted.</p>
1960
2136
  */
1961
2137
  DeletedFaces?: string[];
1962
2138
  }
2139
+ /**
2140
+ * @public
2141
+ */
1963
2142
  export interface DeleteProjectRequest {
1964
2143
  /**
1965
2144
  * <p>The Amazon Resource Name (ARN) of the project that you want to delete.</p>
1966
2145
  */
1967
2146
  ProjectArn: string | undefined;
1968
2147
  }
2148
+ /**
2149
+ * @public
2150
+ */
1969
2151
  export declare enum ProjectStatus {
1970
2152
  CREATED = "CREATED",
1971
2153
  CREATING = "CREATING",
1972
2154
  DELETING = "DELETING"
1973
2155
  }
2156
+ /**
2157
+ * @public
2158
+ */
1974
2159
  export interface DeleteProjectResponse {
1975
2160
  /**
1976
2161
  * <p>The current status of the delete project operation.</p>
1977
2162
  */
1978
2163
  Status?: ProjectStatus | string;
1979
2164
  }
2165
+ /**
2166
+ * @public
2167
+ */
1980
2168
  export interface DeleteProjectPolicyRequest {
1981
2169
  /**
1982
2170
  * <p>The Amazon Resource Name (ARN) of the project that the project policy you want to delete is attached to.</p>
@@ -1991,9 +2179,13 @@ export interface DeleteProjectPolicyRequest {
1991
2179
  */
1992
2180
  PolicyRevisionId?: string;
1993
2181
  }
2182
+ /**
2183
+ * @public
2184
+ */
1994
2185
  export interface DeleteProjectPolicyResponse {
1995
2186
  }
1996
2187
  /**
2188
+ * @public
1997
2189
  * <p>The supplied revision id for the project policy is invalid.</p>
1998
2190
  */
1999
2191
  export declare class InvalidPolicyRevisionIdException extends __BaseException {
@@ -2010,12 +2202,18 @@ export declare class InvalidPolicyRevisionIdException extends __BaseException {
2010
2202
  */
2011
2203
  constructor(opts: __ExceptionOptionType<InvalidPolicyRevisionIdException, __BaseException>);
2012
2204
  }
2205
+ /**
2206
+ * @public
2207
+ */
2013
2208
  export interface DeleteProjectVersionRequest {
2014
2209
  /**
2015
2210
  * <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
2016
2211
  */
2017
2212
  ProjectVersionArn: string | undefined;
2018
2213
  }
2214
+ /**
2215
+ * @public
2216
+ */
2019
2217
  export declare enum ProjectVersionStatus {
2020
2218
  COPYING_COMPLETED = "COPYING_COMPLETED",
2021
2219
  COPYING_FAILED = "COPYING_FAILED",
@@ -2030,26 +2228,41 @@ export declare enum ProjectVersionStatus {
2030
2228
  TRAINING_FAILED = "TRAINING_FAILED",
2031
2229
  TRAINING_IN_PROGRESS = "TRAINING_IN_PROGRESS"
2032
2230
  }
2231
+ /**
2232
+ * @public
2233
+ */
2033
2234
  export interface DeleteProjectVersionResponse {
2034
2235
  /**
2035
2236
  * <p>The status of the deletion operation.</p>
2036
2237
  */
2037
2238
  Status?: ProjectVersionStatus | string;
2038
2239
  }
2240
+ /**
2241
+ * @public
2242
+ */
2039
2243
  export interface DeleteStreamProcessorRequest {
2040
2244
  /**
2041
2245
  * <p>The name of the stream processor you want to delete.</p>
2042
2246
  */
2043
2247
  Name: string | undefined;
2044
2248
  }
2249
+ /**
2250
+ * @public
2251
+ */
2045
2252
  export interface DeleteStreamProcessorResponse {
2046
2253
  }
2254
+ /**
2255
+ * @public
2256
+ */
2047
2257
  export interface DescribeCollectionRequest {
2048
2258
  /**
2049
2259
  * <p>The ID of the collection to describe.</p>
2050
2260
  */
2051
2261
  CollectionId: string | undefined;
2052
2262
  }
2263
+ /**
2264
+ * @public
2265
+ */
2053
2266
  export interface DescribeCollectionResponse {
2054
2267
  /**
2055
2268
  * <p>The number of faces that are indexed into the collection. To index faces into a
@@ -2072,6 +2285,9 @@ export interface DescribeCollectionResponse {
2072
2285
  */
2073
2286
  CreationTimestamp?: Date;
2074
2287
  }
2288
+ /**
2289
+ * @public
2290
+ */
2075
2291
  export interface DescribeDatasetRequest {
2076
2292
  /**
2077
2293
  * <p>
@@ -2080,6 +2296,9 @@ export interface DescribeDatasetRequest {
2080
2296
  */
2081
2297
  DatasetArn: string | undefined;
2082
2298
  }
2299
+ /**
2300
+ * @public
2301
+ */
2083
2302
  export interface DescribeDatasetResponse {
2084
2303
  /**
2085
2304
  * <p>
@@ -2088,6 +2307,9 @@ export interface DescribeDatasetResponse {
2088
2307
  */
2089
2308
  DatasetDescription?: DatasetDescription;
2090
2309
  }
2310
+ /**
2311
+ * @public
2312
+ */
2091
2313
  export interface DescribeProjectsRequest {
2092
2314
  /**
2093
2315
  * <p>If the previous response was incomplete (because there is more
@@ -2108,6 +2330,7 @@ export interface DescribeProjectsRequest {
2108
2330
  ProjectNames?: string[];
2109
2331
  }
2110
2332
  /**
2333
+ * @public
2111
2334
  * <p>A description of an Amazon Rekognition Custom Labels project. For more information, see <a>DescribeProjects</a>.</p>
2112
2335
  */
2113
2336
  export interface ProjectDescription {
@@ -2130,6 +2353,9 @@ export interface ProjectDescription {
2130
2353
  */
2131
2354
  Datasets?: DatasetMetadata[];
2132
2355
  }
2356
+ /**
2357
+ * @public
2358
+ */
2133
2359
  export interface DescribeProjectsResponse {
2134
2360
  /**
2135
2361
  * <p>A list of project descriptions. The list is sorted by the date and time the projects are created.</p>
@@ -2143,6 +2369,7 @@ export interface DescribeProjectsResponse {
2143
2369
  NextToken?: string;
2144
2370
  }
2145
2371
  /**
2372
+ * @public
2146
2373
  * <p>Pagination token in the request is not valid.</p>
2147
2374
  */
2148
2375
  export declare class InvalidPaginationTokenException extends __BaseException {
@@ -2159,6 +2386,9 @@ export declare class InvalidPaginationTokenException extends __BaseException {
2159
2386
  */
2160
2387
  constructor(opts: __ExceptionOptionType<InvalidPaginationTokenException, __BaseException>);
2161
2388
  }
2389
+ /**
2390
+ * @public
2391
+ */
2162
2392
  export interface DescribeProjectVersionsRequest {
2163
2393
  /**
2164
2394
  * <p>The Amazon Resource Name (ARN) of the project that contains the models you want to describe.</p>
@@ -2185,6 +2415,7 @@ export interface DescribeProjectVersionsRequest {
2185
2415
  MaxResults?: number;
2186
2416
  }
2187
2417
  /**
2418
+ * @public
2188
2419
  * <p>The S3 bucket that contains the training summary. The training summary includes
2189
2420
  * aggregated evaluation metrics for the entire testing dataset and metrics for each
2190
2421
  * individual label. </p>
@@ -2203,6 +2434,7 @@ export interface Summary {
2203
2434
  S3Object?: S3Object;
2204
2435
  }
2205
2436
  /**
2437
+ * @public
2206
2438
  * <p>The evaluation results for the training of a model.</p>
2207
2439
  */
2208
2440
  export interface EvaluationResult {
@@ -2220,6 +2452,7 @@ export interface EvaluationResult {
2220
2452
  Summary?: Summary;
2221
2453
  }
2222
2454
  /**
2455
+ * @public
2223
2456
  * <p>Contains the Amazon S3 bucket location of the validation data for a model training job. </p>
2224
2457
  * <p>The validation data includes error information for individual JSON Lines in the dataset.
2225
2458
  * For more information, see <i>Debugging a Failed Model Training</i> in the
@@ -2238,6 +2471,7 @@ export interface ValidationData {
2238
2471
  Assets?: Asset[];
2239
2472
  }
2240
2473
  /**
2474
+ * @public
2241
2475
  * <p>Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.</p>
2242
2476
  */
2243
2477
  export interface TestingDataResult {
@@ -2256,6 +2490,7 @@ export interface TestingDataResult {
2256
2490
  Validation?: ValidationData;
2257
2491
  }
2258
2492
  /**
2493
+ * @public
2259
2494
  * <p>Sagemaker Groundtruth format manifest files for the input, output and validation datasets that are used and created during testing.</p>
2260
2495
  */
2261
2496
  export interface TrainingDataResult {
@@ -2273,6 +2508,7 @@ export interface TrainingDataResult {
2273
2508
  Validation?: ValidationData;
2274
2509
  }
2275
2510
  /**
2511
+ * @public
2276
2512
  * <p>A description of a version of an Amazon Rekognition Custom Labels model.</p>
2277
2513
  */
2278
2514
  export interface ProjectVersionDescription {
@@ -2341,6 +2577,9 @@ export interface ProjectVersionDescription {
2341
2577
  */
2342
2578
  SourceProjectVersionArn?: string;
2343
2579
  }
2580
+ /**
2581
+ * @public
2582
+ */
2344
2583
  export interface DescribeProjectVersionsResponse {
2345
2584
  /**
2346
2585
  * <p>A list of model descriptions. The list is sorted by the creation date and time of
@@ -2354,12 +2593,18 @@ export interface DescribeProjectVersionsResponse {
2354
2593
  */
2355
2594
  NextToken?: string;
2356
2595
  }
2596
+ /**
2597
+ * @public
2598
+ */
2357
2599
  export interface DescribeStreamProcessorRequest {
2358
2600
  /**
2359
2601
  * <p>Name of the stream processor for which you want information.</p>
2360
2602
  */
2361
2603
  Name: string | undefined;
2362
2604
  }
2605
+ /**
2606
+ * @public
2607
+ */
2363
2608
  export declare enum StreamProcessorStatus {
2364
2609
  FAILED = "FAILED",
2365
2610
  RUNNING = "RUNNING",
@@ -2368,6 +2613,9 @@ export declare enum StreamProcessorStatus {
2368
2613
  STOPPING = "STOPPING",
2369
2614
  UPDATING = "UPDATING"
2370
2615
  }
2616
+ /**
2617
+ * @public
2618
+ */
2371
2619
  export interface DescribeStreamProcessorResponse {
2372
2620
  /**
2373
2621
  * <p>Name of the stream processor. </p>
@@ -2439,6 +2687,9 @@ export interface DescribeStreamProcessorResponse {
2439
2687
  */
2440
2688
  DataSharingPreference?: StreamProcessorDataSharingPreference;
2441
2689
  }
2690
+ /**
2691
+ * @public
2692
+ */
2442
2693
  export interface DetectCustomLabelsRequest {
2443
2694
  /**
2444
2695
  * <p>The ARN of the model version that you want to use.</p>
@@ -2485,6 +2736,9 @@ export interface DetectCustomLabelsRequest {
2485
2736
  */
2486
2737
  MinConfidence?: number;
2487
2738
  }
2739
+ /**
2740
+ * @public
2741
+ */
2488
2742
  export interface DetectCustomLabelsResponse {
2489
2743
  /**
2490
2744
  * <p>An array of custom labels detected in the input image.</p>
@@ -2492,6 +2746,7 @@ export interface DetectCustomLabelsResponse {
2492
2746
  CustomLabels?: CustomLabel[];
2493
2747
  }
2494
2748
  /**
2749
+ * @public
2495
2750
  * <p>The requested resource isn't ready. For example,
2496
2751
  * this exception occurs when you call <code>DetectCustomLabels</code> with a
2497
2752
  * model version that isn't deployed. </p>
@@ -2510,6 +2765,9 @@ export declare class ResourceNotReadyException extends __BaseException {
2510
2765
  */
2511
2766
  constructor(opts: __ExceptionOptionType<ResourceNotReadyException, __BaseException>);
2512
2767
  }
2768
+ /**
2769
+ * @public
2770
+ */
2513
2771
  export interface DetectFacesRequest {
2514
2772
  /**
2515
2773
  * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
@@ -2531,6 +2789,9 @@ export interface DetectFacesRequest {
2531
2789
  */
2532
2790
  Attributes?: (Attribute | string)[];
2533
2791
  }
2792
+ /**
2793
+ * @public
2794
+ */
2534
2795
  export interface DetectFacesResponse {
2535
2796
  /**
2536
2797
  * <p>Details of each face found in the image. </p>
@@ -2550,6 +2811,7 @@ export interface DetectFacesResponse {
2550
2811
  OrientationCorrection?: OrientationCorrection | string;
2551
2812
  }
2552
2813
  /**
2814
+ * @public
2553
2815
  * <p>A set of parameters that allow you to filter out certain results from your returned results.</p>
2554
2816
  */
2555
2817
  export interface DetectionFilter {
@@ -2570,11 +2832,15 @@ export interface DetectionFilter {
2570
2832
  */
2571
2833
  MinBoundingBoxWidth?: number;
2572
2834
  }
2835
+ /**
2836
+ * @public
2837
+ */
2573
2838
  export declare enum DetectLabelsFeatureName {
2574
2839
  GENERAL_LABELS = "GENERAL_LABELS",
2575
2840
  IMAGE_PROPERTIES = "IMAGE_PROPERTIES"
2576
2841
  }
2577
2842
  /**
2843
+ * @public
2578
2844
  * <p>Contains filters for the object labels returned by DetectLabels. Filters can be inclusive,
2579
2845
  * exclusive, or a combination of both and can be applied to individual l
2580
2846
  * abels or entire label categories.</p>
@@ -2598,6 +2864,7 @@ export interface GeneralLabelsSettings {
2598
2864
  LabelCategoryExclusionFilters?: string[];
2599
2865
  }
2600
2866
  /**
2867
+ * @public
2601
2868
  * <p>Settings for the IMAGE_PROPERTIES feature type.</p>
2602
2869
  */
2603
2870
  export interface DetectLabelsImagePropertiesSettings {
@@ -2607,6 +2874,7 @@ export interface DetectLabelsImagePropertiesSettings {
2607
2874
  MaxDominantColors?: number;
2608
2875
  }
2609
2876
  /**
2877
+ * @public
2610
2878
  * <p>Settings for the DetectLabels request. Settings can include
2611
2879
  * filters for both GENERAL_LABELS and IMAGE_PROPERTIES. GENERAL_LABELS filters can be inclusive
2612
2880
  * or exclusive and applied to individual labels or label categories. IMAGE_PROPERTIES filters
@@ -2622,6 +2890,9 @@ export interface DetectLabelsSettings {
2622
2890
  */
2623
2891
  ImageProperties?: DetectLabelsImagePropertiesSettings;
2624
2892
  }
2893
+ /**
2894
+ * @public
2895
+ */
2625
2896
  export interface DetectLabelsRequest {
2626
2897
  /**
2627
2898
  * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
@@ -2659,6 +2930,7 @@ export interface DetectLabelsRequest {
2659
2930
  Settings?: DetectLabelsSettings;
2660
2931
  }
2661
2932
  /**
2933
+ * @public
2662
2934
  * <p>A description of the dominant colors in an image.</p>
2663
2935
  */
2664
2936
  export interface DominantColor {
@@ -2692,6 +2964,7 @@ export interface DominantColor {
2692
2964
  PixelPercent?: number;
2693
2965
  }
2694
2966
  /**
2967
+ * @public
2695
2968
  * <p>The quality of an image provided for label detection, with regard to brightness, sharpness, and contrast.</p>
2696
2969
  */
2697
2970
  export interface DetectLabelsImageQuality {
@@ -2709,6 +2982,7 @@ export interface DetectLabelsImageQuality {
2709
2982
  Contrast?: number;
2710
2983
  }
2711
2984
  /**
2985
+ * @public
2712
2986
  * <p>The background of the image with regard to image quality and dominant colors.</p>
2713
2987
  */
2714
2988
  export interface DetectLabelsImageBackground {
@@ -2724,6 +2998,7 @@ export interface DetectLabelsImageBackground {
2724
2998
  DominantColors?: DominantColor[];
2725
2999
  }
2726
3000
  /**
3001
+ * @public
2727
3002
  * <p>The foreground of the image with regard to image quality and dominant colors.</p>
2728
3003
  */
2729
3004
  export interface DetectLabelsImageForeground {
@@ -2739,6 +3014,7 @@ export interface DetectLabelsImageForeground {
2739
3014
  DominantColors?: DominantColor[];
2740
3015
  }
2741
3016
  /**
3017
+ * @public
2742
3018
  * <p>Information about the quality and dominant colors of an input image.
2743
3019
  * Quality and color information is returned for the entire image, foreground, and background.</p>
2744
3020
  */
@@ -2768,6 +3044,7 @@ export interface DetectLabelsImageProperties {
2768
3044
  Background?: DetectLabelsImageBackground;
2769
3045
  }
2770
3046
  /**
3047
+ * @public
2771
3048
  * <p>A potential alias of for a given label.</p>
2772
3049
  */
2773
3050
  export interface LabelAlias {
@@ -2777,6 +3054,7 @@ export interface LabelAlias {
2777
3054
  Name?: string;
2778
3055
  }
2779
3056
  /**
3057
+ * @public
2780
3058
  * <p>The category that applies to a given label.</p>
2781
3059
  */
2782
3060
  export interface LabelCategory {
@@ -2786,6 +3064,7 @@ export interface LabelCategory {
2786
3064
  Name?: string;
2787
3065
  }
2788
3066
  /**
3067
+ * @public
2789
3068
  * <p>An instance of a label returned by Amazon Rekognition Image (<a>DetectLabels</a>) or by
2790
3069
  * Amazon Rekognition Video (<a>GetLabelDetection</a>).</p>
2791
3070
  */
@@ -2804,6 +3083,7 @@ export interface Instance {
2804
3083
  DominantColors?: DominantColor[];
2805
3084
  }
2806
3085
  /**
3086
+ * @public
2807
3087
  * <p>A parent label for a label. A label can have 0, 1, or more parents. </p>
2808
3088
  */
2809
3089
  export interface Parent {
@@ -2813,6 +3093,7 @@ export interface Parent {
2813
3093
  Name?: string;
2814
3094
  }
2815
3095
  /**
3096
+ * @public
2816
3097
  * <p>Structure containing details about the detected label, including the name, detected instances, parent labels, and level of
2817
3098
  * confidence.</p>
2818
3099
  * <p>
@@ -2845,6 +3126,9 @@ export interface Label {
2845
3126
  */
2846
3127
  Categories?: LabelCategory[];
2847
3128
  }
3129
+ /**
3130
+ * @public
3131
+ */
2848
3132
  export interface DetectLabelsResponse {
2849
3133
  /**
2850
3134
  * <p>An array of labels for the real-world objects detected. </p>
@@ -2872,6 +3156,7 @@ export interface DetectLabelsResponse {
2872
3156
  ImageProperties?: DetectLabelsImageProperties;
2873
3157
  }
2874
3158
  /**
3159
+ * @public
2875
3160
  * <p>Allows you to set attributes of the image. Currently, you can declare an image as free of
2876
3161
  * personally identifiable information.</p>
2877
3162
  */
@@ -2882,6 +3167,7 @@ export interface HumanLoopDataAttributes {
2882
3167
  ContentClassifiers?: (ContentClassifier | string)[];
2883
3168
  }
2884
3169
  /**
3170
+ * @public
2885
3171
  * <p>Sets up the flow definition the image will be sent to if one of the conditions is met. You
2886
3172
  * can also set certain attributes of the image before review.</p>
2887
3173
  */
@@ -2901,6 +3187,9 @@ export interface HumanLoopConfig {
2901
3187
  */
2902
3188
  DataAttributes?: HumanLoopDataAttributes;
2903
3189
  }
3190
+ /**
3191
+ * @public
3192
+ */
2904
3193
  export interface DetectModerationLabelsRequest {
2905
3194
  /**
2906
3195
  * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
@@ -2924,6 +3213,7 @@ export interface DetectModerationLabelsRequest {
2924
3213
  HumanLoopConfig?: HumanLoopConfig;
2925
3214
  }
2926
3215
  /**
3216
+ * @public
2927
3217
  * <p>Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the
2928
3218
  * input did not trigger human review.</p>
2929
3219
  */
@@ -2942,6 +3232,9 @@ export interface HumanLoopActivationOutput {
2942
3232
  */
2943
3233
  HumanLoopActivationConditionsEvaluationResults?: __LazyJsonString | string;
2944
3234
  }
3235
+ /**
3236
+ * @public
3237
+ */
2945
3238
  export interface DetectModerationLabelsResponse {
2946
3239
  /**
2947
3240
  * <p>Array of detected Moderation labels and the time, in milliseconds from the start of the
@@ -2959,6 +3252,7 @@ export interface DetectModerationLabelsResponse {
2959
3252
  HumanLoopActivationOutput?: HumanLoopActivationOutput;
2960
3253
  }
2961
3254
  /**
3255
+ * @public
2962
3256
  * <p>The number of in-progress human reviews you have has exceeded the number allowed.</p>
2963
3257
  */
2964
3258
  export declare class HumanLoopQuotaExceededException extends __BaseException {
@@ -2988,6 +3282,7 @@ export declare class HumanLoopQuotaExceededException extends __BaseException {
2988
3282
  constructor(opts: __ExceptionOptionType<HumanLoopQuotaExceededException, __BaseException>);
2989
3283
  }
2990
3284
  /**
3285
+ * @public
2991
3286
  * <p>Specifies summary attributes to return from a call to <a>DetectProtectiveEquipment</a>.
2992
3287
  * You can specify which types of PPE to summarize. You can also specify a minimum confidence value for detections.
2993
3288
  * Summary information is returned in the <code>Summary</code> (<a>ProtectiveEquipmentSummary</a>) field of the response from
@@ -3017,6 +3312,9 @@ export interface ProtectiveEquipmentSummarizationAttributes {
3017
3312
  */
3018
3313
  RequiredEquipmentTypes: (ProtectiveEquipmentType | string)[] | undefined;
3019
3314
  }
3315
+ /**
3316
+ * @public
3317
+ */
3020
3318
  export interface DetectProtectiveEquipmentRequest {
3021
3319
  /**
3022
3320
  * <p>The image in which you want to detect PPE on detected persons. The image can be passed as image bytes or you can
@@ -3029,6 +3327,7 @@ export interface DetectProtectiveEquipmentRequest {
3029
3327
  SummarizationAttributes?: ProtectiveEquipmentSummarizationAttributes;
3030
3328
  }
3031
3329
  /**
3330
+ * @public
3032
3331
  * <p>A person detected by a call to <a>DetectProtectiveEquipment</a>. The API returns
3033
3332
  * all persons detected in the input
3034
3333
  * image in an array of <code>ProtectiveEquipmentPerson</code> objects.</p>
@@ -3053,6 +3352,7 @@ export interface ProtectiveEquipmentPerson {
3053
3352
  Id?: number;
3054
3353
  }
3055
3354
  /**
3355
+ * @public
3056
3356
  * <p>Summary information for required items of personal protective equipment (PPE) detected on persons by a call
3057
3357
  * to <a>DetectProtectiveEquipment</a>. You specify the required type of PPE in
3058
3358
  * the <code>SummarizationAttributes</code>
@@ -3088,6 +3388,9 @@ export interface ProtectiveEquipmentSummary {
3088
3388
  */
3089
3389
  PersonsIndeterminate?: number[];
3090
3390
  }
3391
+ /**
3392
+ * @public
3393
+ */
3091
3394
  export interface DetectProtectiveEquipmentResponse {
3092
3395
  /**
3093
3396
  * <p>The version number of the PPE detection model used to detect PPE in the image.</p>
@@ -3104,6 +3407,7 @@ export interface DetectProtectiveEquipmentResponse {
3104
3407
  Summary?: ProtectiveEquipmentSummary;
3105
3408
  }
3106
3409
  /**
3410
+ * @public
3107
3411
  * <p>A set of optional parameters that you can use to set the criteria that the text must meet
3108
3412
  * to be included in your response. <code>WordFilter</code> looks at a word’s height, width, and
3109
3413
  * minimum confidence. <code>RegionOfInterest</code> lets you set a specific region of the image
@@ -3120,6 +3424,9 @@ export interface DetectTextFilters {
3120
3424
  */
3121
3425
  RegionsOfInterest?: RegionOfInterest[];
3122
3426
  }
3427
+ /**
3428
+ * @public
3429
+ */
3123
3430
  export interface DetectTextRequest {
3124
3431
  /**
3125
3432
  * <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS
@@ -3135,11 +3442,15 @@ export interface DetectTextRequest {
3135
3442
  */
3136
3443
  Filters?: DetectTextFilters;
3137
3444
  }
3445
+ /**
3446
+ * @public
3447
+ */
3138
3448
  export declare enum TextTypes {
3139
3449
  LINE = "LINE",
3140
3450
  WORD = "WORD"
3141
3451
  }
3142
3452
  /**
3453
+ * @public
3143
3454
  * <p>Information about a word or line of text detected by <a>DetectText</a>.</p>
3144
3455
  * <p>The <code>DetectedText</code> field contains the text that Amazon Rekognition detected in the
3145
3456
  * image. </p>
@@ -3182,6 +3493,9 @@ export interface TextDetection {
3182
3493
  */
3183
3494
  Geometry?: Geometry;
3184
3495
  }
3496
+ /**
3497
+ * @public
3498
+ */
3185
3499
  export interface DetectTextResponse {
3186
3500
  /**
3187
3501
  * <p>An array of text that was detected in the input image.</p>
@@ -3193,6 +3507,7 @@ export interface DetectTextResponse {
3193
3507
  TextModelVersion?: string;
3194
3508
  }
3195
3509
  /**
3510
+ * @public
3196
3511
  * <p>
3197
3512
  * A training dataset or a test dataset used in a dataset distribution operation.
3198
3513
  * For more information, see <a>DistributeDatasetEntries</a>.
@@ -3205,6 +3520,9 @@ export interface DistributeDataset {
3205
3520
  */
3206
3521
  Arn: string | undefined;
3207
3522
  }
3523
+ /**
3524
+ * @public
3525
+ */
3208
3526
  export interface DistributeDatasetEntriesRequest {
3209
3527
  /**
3210
3528
  * <p>The ARNS for the training dataset and test dataset that you want to use. The datasets must belong to
@@ -3213,9 +3531,13 @@ export interface DistributeDatasetEntriesRequest {
3213
3531
  */
3214
3532
  Datasets: DistributeDataset[] | undefined;
3215
3533
  }
3534
+ /**
3535
+ * @public
3536
+ */
3216
3537
  export interface DistributeDatasetEntriesResponse {
3217
3538
  }
3218
3539
  /**
3540
+ * @public
3219
3541
  * <p>Describes the face properties such as the bounding box, face ID, image ID of the input
3220
3542
  * image, and external image ID that you assigned. </p>
3221
3543
  */
@@ -3247,11 +3569,15 @@ export interface Face {
3247
3569
  */
3248
3570
  IndexFacesModelVersion?: string;
3249
3571
  }
3572
+ /**
3573
+ * @public
3574
+ */
3250
3575
  export declare enum FaceAttributes {
3251
3576
  ALL = "ALL",
3252
3577
  DEFAULT = "DEFAULT"
3253
3578
  }
3254
3579
  /**
3580
+ * @public
3255
3581
  * <p>Information about a face detected in a video analysis request and the time the face was detected in the video. </p>
3256
3582
  */
3257
3583
  export interface FaceDetection {
@@ -3266,6 +3592,7 @@ export interface FaceDetection {
3266
3592
  Face?: FaceDetail;
3267
3593
  }
3268
3594
  /**
3595
+ * @public
3269
3596
  * <p>Provides face metadata. In addition, it also provides the confidence in the match of
3270
3597
  * this face with the input face.</p>
3271
3598
  */
@@ -3281,6 +3608,7 @@ export interface FaceMatch {
3281
3608
  Face?: Face;
3282
3609
  }
3283
3610
  /**
3611
+ * @public
3284
3612
  * <p>Object containing both the face metadata (stored in the backend database), and facial
3285
3613
  * attributes that are detected but aren't stored in the database.</p>
3286
3614
  */
@@ -3295,10 +3623,16 @@ export interface FaceRecord {
3295
3623
  */
3296
3624
  FaceDetail?: FaceDetail;
3297
3625
  }
3626
+ /**
3627
+ * @public
3628
+ */
3298
3629
  export declare enum FaceSearchSortBy {
3299
3630
  INDEX = "INDEX",
3300
3631
  TIMESTAMP = "TIMESTAMP"
3301
3632
  }
3633
+ /**
3634
+ * @public
3635
+ */
3302
3636
  export interface GetCelebrityInfoRequest {
3303
3637
  /**
3304
3638
  * <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.
@@ -3306,6 +3640,9 @@ export interface GetCelebrityInfoRequest {
3306
3640
  */
3307
3641
  Id: string | undefined;
3308
3642
  }
3643
+ /**
3644
+ * @public
3645
+ */
3309
3646
  export interface GetCelebrityInfoResponse {
3310
3647
  /**
3311
3648
  * <p>An array of URLs pointing to additional celebrity information. </p>
@@ -3320,6 +3657,9 @@ export interface GetCelebrityInfoResponse {
3320
3657
  */
3321
3658
  KnownGender?: KnownGender;
3322
3659
  }
3660
+ /**
3661
+ * @public
3662
+ */
3323
3663
  export interface GetCelebrityRecognitionRequest {
3324
3664
  /**
3325
3665
  * <p>Job identifier for the required celebrity recognition analysis. You can get the job identifer from
@@ -3343,16 +3683,23 @@ export interface GetCelebrityRecognitionRequest {
3343
3683
  */
3344
3684
  SortBy?: CelebrityRecognitionSortBy | string;
3345
3685
  }
3686
+ /**
3687
+ * @public
3688
+ */
3346
3689
  export declare enum VideoJobStatus {
3347
3690
  FAILED = "FAILED",
3348
3691
  IN_PROGRESS = "IN_PROGRESS",
3349
3692
  SUCCEEDED = "SUCCEEDED"
3350
3693
  }
3694
+ /**
3695
+ * @public
3696
+ */
3351
3697
  export declare enum VideoColorRange {
3352
3698
  FULL = "FULL",
3353
3699
  LIMITED = "LIMITED"
3354
3700
  }
3355
3701
  /**
3702
+ * @public
3356
3703
  * <p>Information about a video that Amazon Rekognition analyzed. <code>Videometadata</code> is returned in
3357
3704
  * every page of paginated responses from a Amazon Rekognition video operation.</p>
3358
3705
  */
@@ -3388,6 +3735,9 @@ export interface VideoMetadata {
3388
3735
  */
3389
3736
  ColorRange?: VideoColorRange | string;
3390
3737
  }
3738
+ /**
3739
+ * @public
3740
+ */
3391
3741
  export interface GetCelebrityRecognitionResponse {
3392
3742
  /**
3393
3743
  * <p>The current status of the celebrity recognition job.</p>
@@ -3412,6 +3762,9 @@ export interface GetCelebrityRecognitionResponse {
3412
3762
  */
3413
3763
  Celebrities?: CelebrityRecognition[];
3414
3764
  }
3765
+ /**
3766
+ * @public
3767
+ */
3415
3768
  export interface GetContentModerationRequest {
3416
3769
  /**
3417
3770
  * <p>The identifier for the inappropriate, unwanted, or offensive content moderation job. Use <code>JobId</code> to identify the job in
@@ -3439,6 +3792,9 @@ export interface GetContentModerationRequest {
3439
3792
  */
3440
3793
  SortBy?: ContentModerationSortBy | string;
3441
3794
  }
3795
+ /**
3796
+ * @public
3797
+ */
3442
3798
  export interface GetContentModerationResponse {
3443
3799
  /**
3444
3800
  * <p>The current status of the content moderation analysis job.</p>
@@ -3467,6 +3823,9 @@ export interface GetContentModerationResponse {
3467
3823
  */
3468
3824
  ModerationModelVersion?: string;
3469
3825
  }
3826
+ /**
3827
+ * @public
3828
+ */
3470
3829
  export interface GetFaceDetectionRequest {
3471
3830
  /**
3472
3831
  * <p>Unique identifier for the face detection job. The <code>JobId</code> is returned from <code>StartFaceDetection</code>.</p>
@@ -3484,6 +3843,9 @@ export interface GetFaceDetectionRequest {
3484
3843
  */
3485
3844
  NextToken?: string;
3486
3845
  }
3846
+ /**
3847
+ * @public
3848
+ */
3487
3849
  export interface GetFaceDetectionResponse {
3488
3850
  /**
3489
3851
  * <p>The current status of the face detection job.</p>
@@ -3508,6 +3870,9 @@ export interface GetFaceDetectionResponse {
3508
3870
  */
3509
3871
  Faces?: FaceDetection[];
3510
3872
  }
3873
+ /**
3874
+ * @public
3875
+ */
3511
3876
  export interface GetFaceSearchRequest {
3512
3877
  /**
3513
3878
  * <p>The job identifer for the search request. You get the job identifier from an initial call to <code>StartFaceSearch</code>.</p>
@@ -3531,6 +3896,7 @@ export interface GetFaceSearchRequest {
3531
3896
  SortBy?: FaceSearchSortBy | string;
3532
3897
  }
3533
3898
  /**
3899
+ * @public
3534
3900
  * <p>Details about a person detected in a video analysis request.</p>
3535
3901
  */
3536
3902
  export interface PersonDetail {
@@ -3548,6 +3914,7 @@ export interface PersonDetail {
3548
3914
  Face?: FaceDetail;
3549
3915
  }
3550
3916
  /**
3917
+ * @public
3551
3918
  * <p>Information about a person whose face matches a face(s) in an Amazon Rekognition collection.
3552
3919
  * Includes information about the faces in the Amazon Rekognition collection (<a>FaceMatch</a>), information about the person (<a>PersonDetail</a>), and the time stamp for
3553
3920
  * when the person was detected in a video. An array of <code>PersonMatch</code> objects is
@@ -3569,6 +3936,9 @@ export interface PersonMatch {
3569
3936
  */
3570
3937
  FaceMatches?: FaceMatch[];
3571
3938
  }
3939
+ /**
3940
+ * @public
3941
+ */
3572
3942
  export interface GetFaceSearchResponse {
3573
3943
  /**
3574
3944
  * <p>The current status of the face search job.</p>
@@ -3598,14 +3968,23 @@ export interface GetFaceSearchResponse {
3598
3968
  */
3599
3969
  Persons?: PersonMatch[];
3600
3970
  }
3971
+ /**
3972
+ * @public
3973
+ */
3601
3974
  export declare enum LabelDetectionAggregateBy {
3602
3975
  SEGMENTS = "SEGMENTS",
3603
3976
  TIMESTAMPS = "TIMESTAMPS"
3604
3977
  }
3978
+ /**
3979
+ * @public
3980
+ */
3605
3981
  export declare enum LabelDetectionSortBy {
3606
3982
  NAME = "NAME",
3607
3983
  TIMESTAMP = "TIMESTAMP"
3608
3984
  }
3985
+ /**
3986
+ * @public
3987
+ */
3609
3988
  export interface GetLabelDetectionRequest {
3610
3989
  /**
3611
3990
  * <p>Job identifier for the label detection operation for which you want results returned. You get the job identifer from
@@ -3637,6 +4016,7 @@ export interface GetLabelDetectionRequest {
3637
4016
  AggregateBy?: LabelDetectionAggregateBy | string;
3638
4017
  }
3639
4018
  /**
4019
+ * @public
3640
4020
  * <p>Information about a label detected in a video analysis request and the time the label was detected in the video. </p>
3641
4021
  */
3642
4022
  export interface LabelDetection {
@@ -3662,6 +4042,9 @@ export interface LabelDetection {
3662
4042
  */
3663
4043
  DurationMillis?: number;
3664
4044
  }
4045
+ /**
4046
+ * @public
4047
+ */
3665
4048
  export interface GetLabelDetectionResponse {
3666
4049
  /**
3667
4050
  * <p>The current status of the label detection job.</p>
@@ -3691,10 +4074,16 @@ export interface GetLabelDetectionResponse {
3691
4074
  */
3692
4075
  LabelModelVersion?: string;
3693
4076
  }
4077
+ /**
4078
+ * @public
4079
+ */
3694
4080
  export declare enum PersonTrackingSortBy {
3695
4081
  INDEX = "INDEX",
3696
4082
  TIMESTAMP = "TIMESTAMP"
3697
4083
  }
4084
+ /**
4085
+ * @public
4086
+ */
3698
4087
  export interface GetPersonTrackingRequest {
3699
4088
  /**
3700
4089
  * <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>.
@@ -3721,6 +4110,7 @@ export interface GetPersonTrackingRequest {
3721
4110
  SortBy?: PersonTrackingSortBy | string;
3722
4111
  }
3723
4112
  /**
4113
+ * @public
3724
4114
  * <p>Details and path tracking information for a single time a person's path is tracked in a video.
3725
4115
  * Amazon Rekognition operations that track people's paths return an array of <code>PersonDetection</code> objects
3726
4116
  * with elements for each time a person's path is tracked in a video. </p>
@@ -3737,6 +4127,9 @@ export interface PersonDetection {
3737
4127
  */
3738
4128
  Person?: PersonDetail;
3739
4129
  }
4130
+ /**
4131
+ * @public
4132
+ */
3740
4133
  export interface GetPersonTrackingResponse {
3741
4134
  /**
3742
4135
  * <p>The current status of the person tracking job.</p>
@@ -3761,6 +4154,9 @@ export interface GetPersonTrackingResponse {
3761
4154
  */
3762
4155
  Persons?: PersonDetection[];
3763
4156
  }
4157
+ /**
4158
+ * @public
4159
+ */
3764
4160
  export interface GetSegmentDetectionRequest {
3765
4161
  /**
3766
4162
  * <p>Job identifier for the text detection operation for which you want results returned.
@@ -3778,6 +4174,7 @@ export interface GetSegmentDetectionRequest {
3778
4174
  NextToken?: string;
3779
4175
  }
3780
4176
  /**
4177
+ * @public
3781
4178
  * <p>Information about a shot detection segment detected in a video. For more information,
3782
4179
  * see <a>SegmentDetection</a>.</p>
3783
4180
  */
@@ -3791,6 +4188,9 @@ export interface ShotSegment {
3791
4188
  */
3792
4189
  Confidence?: number;
3793
4190
  }
4191
+ /**
4192
+ * @public
4193
+ */
3794
4194
  export declare enum TechnicalCueType {
3795
4195
  BLACK_FRAMES = "BlackFrames",
3796
4196
  COLOR_BARS = "ColorBars",
@@ -3801,6 +4201,7 @@ export declare enum TechnicalCueType {
3801
4201
  STUDIO_LOGO = "StudioLogo"
3802
4202
  }
3803
4203
  /**
4204
+ * @public
3804
4205
  * <p>Information about a technical cue segment. For more information, see <a>SegmentDetection</a>.</p>
3805
4206
  */
3806
4207
  export interface TechnicalCueSegment {
@@ -3813,11 +4214,15 @@ export interface TechnicalCueSegment {
3813
4214
  */
3814
4215
  Confidence?: number;
3815
4216
  }
4217
+ /**
4218
+ * @public
4219
+ */
3816
4220
  export declare enum SegmentType {
3817
4221
  SHOT = "SHOT",
3818
4222
  TECHNICAL_CUE = "TECHNICAL_CUE"
3819
4223
  }
3820
4224
  /**
4225
+ * @public
3821
4226
  * <p>A technical cue or shot detection segment detected in a video. An array
3822
4227
  * of <code>SegmentDetection</code> objects containing all segments detected in a stored video
3823
4228
  * is returned by <a>GetSegmentDetection</a>.
@@ -3887,6 +4292,7 @@ export interface SegmentDetection {
3887
4292
  DurationFrames?: number;
3888
4293
  }
3889
4294
  /**
4295
+ * @public
3890
4296
  * <p>Information about the type of a segment requested in a call to <a>StartSegmentDetection</a>.
3891
4297
  * An array of <code>SegmentTypeInfo</code> objects is returned by the response from <a>GetSegmentDetection</a>.</p>
3892
4298
  */
@@ -3900,6 +4306,9 @@ export interface SegmentTypeInfo {
3900
4306
  */
3901
4307
  ModelVersion?: string;
3902
4308
  }
4309
+ /**
4310
+ * @public
4311
+ */
3903
4312
  export interface GetSegmentDetectionResponse {
3904
4313
  /**
3905
4314
  * <p>Current status of the segment detection job.</p>
@@ -3944,6 +4353,9 @@ export interface GetSegmentDetectionResponse {
3944
4353
  */
3945
4354
  SelectedSegmentTypes?: SegmentTypeInfo[];
3946
4355
  }
4356
+ /**
4357
+ * @public
4358
+ */
3947
4359
  export interface GetTextDetectionRequest {
3948
4360
  /**
3949
4361
  * <p>Job identifier for the text detection operation for which you want results returned.
@@ -3961,6 +4373,7 @@ export interface GetTextDetectionRequest {
3961
4373
  NextToken?: string;
3962
4374
  }
3963
4375
  /**
4376
+ * @public
3964
4377
  * <p>Information about text detected in a video. Incudes the detected text,
3965
4378
  * the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.</p>
3966
4379
  */
@@ -3975,6 +4388,9 @@ export interface TextDetectionResult {
3975
4388
  */
3976
4389
  TextDetection?: TextDetection;
3977
4390
  }
4391
+ /**
4392
+ * @public
4393
+ */
3978
4394
  export interface GetTextDetectionResponse {
3979
4395
  /**
3980
4396
  * <p>Current status of the text detection job.</p>
@@ -4005,6 +4421,7 @@ export interface GetTextDetectionResponse {
4005
4421
  TextModelVersion?: string;
4006
4422
  }
4007
4423
  /**
4424
+ * @public
4008
4425
  * <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
4009
4426
  * parameters is different from the previous call to the operation.</p>
4010
4427
  */
@@ -4022,6 +4439,9 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
4022
4439
  */
4023
4440
  constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
4024
4441
  }
4442
+ /**
4443
+ * @public
4444
+ */
4025
4445
  export interface IndexFacesRequest {
4026
4446
  /**
4027
4447
  * <p>The ID of an existing collection to which you want to add the faces that are detected
@@ -4082,6 +4502,9 @@ export interface IndexFacesRequest {
4082
4502
  */
4083
4503
  QualityFilter?: QualityFilter | string;
4084
4504
  }
4505
+ /**
4506
+ * @public
4507
+ */
4085
4508
  export declare enum Reason {
4086
4509
  EXCEEDS_MAX_FACES = "EXCEEDS_MAX_FACES",
4087
4510
  EXTREME_POSE = "EXTREME_POSE",
@@ -4092,6 +4515,7 @@ export declare enum Reason {
4092
4515
  SMALL_BOUNDING_BOX = "SMALL_BOUNDING_BOX"
4093
4516
  }
4094
4517
  /**
4518
+ * @public
4095
4519
  * <p>A face that <a>IndexFaces</a> detected, but didn't index. Use the
4096
4520
  * <code>Reasons</code> response attribute to determine why a face wasn't indexed.</p>
4097
4521
  */
@@ -4129,6 +4553,9 @@ export interface UnindexedFace {
4129
4553
  */
4130
4554
  FaceDetail?: FaceDetail;
4131
4555
  }
4556
+ /**
4557
+ * @public
4558
+ */
4132
4559
  export interface IndexFacesResponse {
4133
4560
  /**
4134
4561
  * <p>An array of faces detected and added to the collection. For more information,
@@ -4175,6 +4602,7 @@ export interface IndexFacesResponse {
4175
4602
  UnindexedFaces?: UnindexedFace[];
4176
4603
  }
4177
4604
  /**
4605
+ * @public
4178
4606
  * <p>Specifies the starting point in a Kinesis stream to start processing. You can use the
4179
4607
  * producer timestamp or the fragment number. One of either producer timestamp or fragment
4180
4608
  * number is required. If you use the producer timestamp, you must put the time in
@@ -4193,10 +4621,14 @@ export interface KinesisVideoStreamStartSelector {
4193
4621
  */
4194
4622
  FragmentNumber?: string;
4195
4623
  }
4624
+ /**
4625
+ * @public
4626
+ */
4196
4627
  export declare enum LabelDetectionFeatureName {
4197
4628
  GENERAL_LABELS = "GENERAL_LABELS"
4198
4629
  }
4199
4630
  /**
4631
+ * @public
4200
4632
  * <p>Contains the specified filters that should be applied to a list of returned GENERAL_LABELS.</p>
4201
4633
  */
4202
4634
  export interface LabelDetectionSettings {
@@ -4207,6 +4639,9 @@ export interface LabelDetectionSettings {
4207
4639
  */
4208
4640
  GeneralLabels?: GeneralLabelsSettings;
4209
4641
  }
4642
+ /**
4643
+ * @public
4644
+ */
4210
4645
  export interface ListCollectionsRequest {
4211
4646
  /**
4212
4647
  * <p>Pagination token from the previous response.</p>
@@ -4217,6 +4652,9 @@ export interface ListCollectionsRequest {
4217
4652
  */
4218
4653
  MaxResults?: number;
4219
4654
  }
4655
+ /**
4656
+ * @public
4657
+ */
4220
4658
  export interface ListCollectionsResponse {
4221
4659
  /**
4222
4660
  * <p>An array of collection IDs.</p>
@@ -4235,6 +4673,9 @@ export interface ListCollectionsResponse {
4235
4673
  */
4236
4674
  FaceModelVersions?: string[];
4237
4675
  }
4676
+ /**
4677
+ * @public
4678
+ */
4238
4679
  export interface ListDatasetEntriesRequest {
4239
4680
  /**
4240
4681
  * <p>
@@ -4280,6 +4721,9 @@ export interface ListDatasetEntriesRequest {
4280
4721
  */
4281
4722
  MaxResults?: number;
4282
4723
  }
4724
+ /**
4725
+ * @public
4726
+ */
4283
4727
  export interface ListDatasetEntriesResponse {
4284
4728
  /**
4285
4729
  * <p>
@@ -4294,6 +4738,9 @@ export interface ListDatasetEntriesResponse {
4294
4738
  */
4295
4739
  NextToken?: string;
4296
4740
  }
4741
+ /**
4742
+ * @public
4743
+ */
4297
4744
  export interface ListDatasetLabelsRequest {
4298
4745
  /**
4299
4746
  * <p>
@@ -4314,6 +4761,9 @@ export interface ListDatasetLabelsRequest {
4314
4761
  */
4315
4762
  MaxResults?: number;
4316
4763
  }
4764
+ /**
4765
+ * @public
4766
+ */
4317
4767
  export interface ListDatasetLabelsResponse {
4318
4768
  /**
4319
4769
  * <p>
@@ -4328,6 +4778,9 @@ export interface ListDatasetLabelsResponse {
4328
4778
  */
4329
4779
  NextToken?: string;
4330
4780
  }
4781
+ /**
4782
+ * @public
4783
+ */
4331
4784
  export interface ListFacesRequest {
4332
4785
  /**
4333
4786
  * <p>ID of the collection from which to list the faces.</p>
@@ -4344,6 +4797,9 @@ export interface ListFacesRequest {
4344
4797
  */
4345
4798
  MaxResults?: number;
4346
4799
  }
4800
+ /**
4801
+ * @public
4802
+ */
4347
4803
  export interface ListFacesResponse {
4348
4804
  /**
4349
4805
  * <p>An array of <code>Face</code> objects. </p>
@@ -4360,6 +4816,9 @@ export interface ListFacesResponse {
4360
4816
  */
4361
4817
  FaceModelVersion?: string;
4362
4818
  }
4819
+ /**
4820
+ * @public
4821
+ */
4363
4822
  export interface ListProjectPoliciesRequest {
4364
4823
  /**
4365
4824
  * <p>The ARN of the project for which you want to list the project policies.</p>
@@ -4379,6 +4838,7 @@ export interface ListProjectPoliciesRequest {
4379
4838
  MaxResults?: number;
4380
4839
  }
4381
4840
  /**
4841
+ * @public
4382
4842
  * <p>Describes a project policy in the response from <a>ListProjectPolicies</a>. </p>
4383
4843
  * <p> </p>
4384
4844
  */
@@ -4408,6 +4868,9 @@ export interface ProjectPolicy {
4408
4868
  */
4409
4869
  LastUpdatedTimestamp?: Date;
4410
4870
  }
4871
+ /**
4872
+ * @public
4873
+ */
4411
4874
  export interface ListProjectPoliciesResponse {
4412
4875
  /**
4413
4876
  * <p>A list of project policies attached to the project.</p>
@@ -4419,6 +4882,9 @@ export interface ListProjectPoliciesResponse {
4419
4882
  */
4420
4883
  NextToken?: string;
4421
4884
  }
4885
+ /**
4886
+ * @public
4887
+ */
4422
4888
  export interface ListStreamProcessorsRequest {
4423
4889
  /**
4424
4890
  * <p>If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video
@@ -4431,6 +4897,7 @@ export interface ListStreamProcessorsRequest {
4431
4897
  MaxResults?: number;
4432
4898
  }
4433
4899
  /**
4900
+ * @public
4434
4901
  * <p>An object that recognizes faces or labels in a streaming video. An Amazon Rekognition stream processor is created by a call to <a>CreateStreamProcessor</a>. The request
4435
4902
  * parameters for <code>CreateStreamProcessor</code> describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.
4436
4903
  *
@@ -4446,6 +4913,9 @@ export interface StreamProcessor {
4446
4913
  */
4447
4914
  Status?: StreamProcessorStatus | string;
4448
4915
  }
4916
+ /**
4917
+ * @public
4918
+ */
4449
4919
  export interface ListStreamProcessorsResponse {
4450
4920
  /**
4451
4921
  * <p>If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent
@@ -4457,6 +4927,9 @@ export interface ListStreamProcessorsResponse {
4457
4927
  */
4458
4928
  StreamProcessors?: StreamProcessor[];
4459
4929
  }
4930
+ /**
4931
+ * @public
4932
+ */
4460
4933
  export interface ListTagsForResourceRequest {
4461
4934
  /**
4462
4935
  * <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that contains
@@ -4464,6 +4937,9 @@ export interface ListTagsForResourceRequest {
4464
4937
  */
4465
4938
  ResourceArn: string | undefined;
4466
4939
  }
4940
+ /**
4941
+ * @public
4942
+ */
4467
4943
  export interface ListTagsForResourceResponse {
4468
4944
  /**
4469
4945
  * <p> A list of key-value tags assigned to the resource. </p>
@@ -4471,6 +4947,7 @@ export interface ListTagsForResourceResponse {
4471
4947
  Tags?: Record<string, string>;
4472
4948
  }
4473
4949
  /**
4950
+ * @public
4474
4951
  * <p>The format of the project policy document that you supplied to
4475
4952
  * <code>PutProjectPolicy</code> is incorrect. </p>
4476
4953
  */
@@ -4489,6 +4966,7 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
4489
4966
  constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
4490
4967
  }
4491
4968
  /**
4969
+ * @public
4492
4970
  * <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
4493
4971
  * <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html">Calling Amazon Rekognition Video operations</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
4494
4972
  * For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics">Giving access to multiple Amazon SNS topics</a>.</p>
@@ -4503,6 +4981,9 @@ export interface NotificationChannel {
4503
4981
  */
4504
4982
  RoleArn: string | undefined;
4505
4983
  }
4984
+ /**
4985
+ * @public
4986
+ */
4506
4987
  export interface PutProjectPolicyRequest {
4507
4988
  /**
4508
4989
  * <p>The Amazon Resource Name (ARN) of the project that the project policy is attached to.</p>
@@ -4527,12 +5008,18 @@ export interface PutProjectPolicyRequest {
4527
5008
  */
4528
5009
  PolicyDocument: string | undefined;
4529
5010
  }
5011
+ /**
5012
+ * @public
5013
+ */
4530
5014
  export interface PutProjectPolicyResponse {
4531
5015
  /**
4532
5016
  * <p>The ID of the project policy.</p>
4533
5017
  */
4534
5018
  PolicyRevisionId?: string;
4535
5019
  }
5020
+ /**
5021
+ * @public
5022
+ */
4536
5023
  export interface RecognizeCelebritiesRequest {
4537
5024
  /**
4538
5025
  * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
@@ -4543,6 +5030,9 @@ export interface RecognizeCelebritiesRequest {
4543
5030
  */
4544
5031
  Image: Image | undefined;
4545
5032
  }
5033
+ /**
5034
+ * @public
5035
+ */
4546
5036
  export interface RecognizeCelebritiesResponse {
4547
5037
  /**
4548
5038
  * <p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
@@ -4578,6 +5068,9 @@ export interface RecognizeCelebritiesResponse {
4578
5068
  */
4579
5069
  OrientationCorrection?: OrientationCorrection | string;
4580
5070
  }
5071
+ /**
5072
+ * @public
5073
+ */
4581
5074
  export interface SearchFacesRequest {
4582
5075
  /**
4583
5076
  * <p>ID of the collection the face belongs to.</p>
@@ -4599,6 +5092,9 @@ export interface SearchFacesRequest {
4599
5092
  */
4600
5093
  FaceMatchThreshold?: number;
4601
5094
  }
5095
+ /**
5096
+ * @public
5097
+ */
4602
5098
  export interface SearchFacesResponse {
4603
5099
  /**
4604
5100
  * <p>ID of the face that was searched for matches in a collection.</p>
@@ -4615,6 +5111,9 @@ export interface SearchFacesResponse {
4615
5111
  */
4616
5112
  FaceModelVersion?: string;
4617
5113
  }
5114
+ /**
5115
+ * @public
5116
+ */
4618
5117
  export interface SearchFacesByImageRequest {
4619
5118
  /**
4620
5119
  * <p>ID of the collection to search.</p>
@@ -4654,6 +5153,9 @@ export interface SearchFacesByImageRequest {
4654
5153
  */
4655
5154
  QualityFilter?: QualityFilter | string;
4656
5155
  }
5156
+ /**
5157
+ * @public
5158
+ */
4657
5159
  export interface SearchFacesByImageResponse {
4658
5160
  /**
4659
5161
  * <p>The bounding box around the face in the input image that Amazon Rekognition used for the
@@ -4677,6 +5179,7 @@ export interface SearchFacesByImageResponse {
4677
5179
  FaceModelVersion?: string;
4678
5180
  }
4679
5181
  /**
5182
+ * @public
4680
5183
  * <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
4681
5184
  * specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
4682
5185
  */
@@ -4686,6 +5189,9 @@ export interface Video {
4686
5189
  */
4687
5190
  S3Object?: S3Object;
4688
5191
  }
5192
+ /**
5193
+ * @public
5194
+ */
4689
5195
  export interface StartCelebrityRecognitionRequest {
4690
5196
  /**
4691
5197
  * <p>The video in which you want to recognize celebrities. The video must be stored
@@ -4709,6 +5215,9 @@ export interface StartCelebrityRecognitionRequest {
4709
5215
  */
4710
5216
  JobTag?: string;
4711
5217
  }
5218
+ /**
5219
+ * @public
5220
+ */
4712
5221
  export interface StartCelebrityRecognitionResponse {
4713
5222
  /**
4714
5223
  * <p>The identifier for the celebrity recognition analysis job. Use <code>JobId</code> to identify the job in
@@ -4717,6 +5226,7 @@ export interface StartCelebrityRecognitionResponse {
4717
5226
  JobId?: string;
4718
5227
  }
4719
5228
  /**
5229
+ * @public
4720
5230
  * <p>The file size or duration of the supplied media is too large. The maximum file size is 10GB.
4721
5231
  * The maximum duration is 6 hours. </p>
4722
5232
  */
@@ -4734,6 +5244,9 @@ export declare class VideoTooLargeException extends __BaseException {
4734
5244
  */
4735
5245
  constructor(opts: __ExceptionOptionType<VideoTooLargeException, __BaseException>);
4736
5246
  }
5247
+ /**
5248
+ * @public
5249
+ */
4737
5250
  export interface StartContentModerationRequest {
4738
5251
  /**
4739
5252
  * <p>The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored
@@ -4765,6 +5278,9 @@ export interface StartContentModerationRequest {
4765
5278
  */
4766
5279
  JobTag?: string;
4767
5280
  }
5281
+ /**
5282
+ * @public
5283
+ */
4768
5284
  export interface StartContentModerationResponse {
4769
5285
  /**
4770
5286
  * <p>The identifier for the content analysis job. Use <code>JobId</code> to identify the job in
@@ -4772,6 +5288,9 @@ export interface StartContentModerationResponse {
4772
5288
  */
4773
5289
  JobId?: string;
4774
5290
  }
5291
+ /**
5292
+ * @public
5293
+ */
4775
5294
  export interface StartFaceDetectionRequest {
4776
5295
  /**
4777
5296
  * <p>The video in which you want to detect faces. The video must be stored
@@ -4803,6 +5322,9 @@ export interface StartFaceDetectionRequest {
4803
5322
  */
4804
5323
  JobTag?: string;
4805
5324
  }
5325
+ /**
5326
+ * @public
5327
+ */
4806
5328
  export interface StartFaceDetectionResponse {
4807
5329
  /**
4808
5330
  * <p>The identifier for the face detection job. Use <code>JobId</code> to identify the job in
@@ -4810,6 +5332,9 @@ export interface StartFaceDetectionResponse {
4810
5332
  */
4811
5333
  JobId?: string;
4812
5334
  }
5335
+ /**
5336
+ * @public
5337
+ */
4813
5338
  export interface StartFaceSearchRequest {
4814
5339
  /**
4815
5340
  * <p>The video you want to search. The video must be stored in an Amazon S3 bucket. </p>
@@ -4840,12 +5365,18 @@ export interface StartFaceSearchRequest {
4840
5365
  */
4841
5366
  JobTag?: string;
4842
5367
  }
5368
+ /**
5369
+ * @public
5370
+ */
4843
5371
  export interface StartFaceSearchResponse {
4844
5372
  /**
4845
5373
  * <p>The identifier for the search job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetFaceSearch</code>. </p>
4846
5374
  */
4847
5375
  JobId?: string;
4848
5376
  }
5377
+ /**
5378
+ * @public
5379
+ */
4849
5380
  export interface StartLabelDetectionRequest {
4850
5381
  /**
4851
5382
  * <p>The video in which you want to detect labels. The video must be stored
@@ -4888,6 +5419,9 @@ export interface StartLabelDetectionRequest {
4888
5419
  */
4889
5420
  Settings?: LabelDetectionSettings;
4890
5421
  }
5422
+ /**
5423
+ * @public
5424
+ */
4891
5425
  export interface StartLabelDetectionResponse {
4892
5426
  /**
4893
5427
  * <p>The identifier for the label detection job. Use <code>JobId</code> to identify the job in
@@ -4895,6 +5429,9 @@ export interface StartLabelDetectionResponse {
4895
5429
  */
4896
5430
  JobId?: string;
4897
5431
  }
5432
+ /**
5433
+ * @public
5434
+ */
4898
5435
  export interface StartPersonTrackingRequest {
4899
5436
  /**
4900
5437
  * <p>The video in which you want to detect people. The video must be stored
@@ -4918,6 +5455,9 @@ export interface StartPersonTrackingRequest {
4918
5455
  */
4919
5456
  JobTag?: string;
4920
5457
  }
5458
+ /**
5459
+ * @public
5460
+ */
4921
5461
  export interface StartPersonTrackingResponse {
4922
5462
  /**
4923
5463
  * <p>The identifier for the person detection job. Use <code>JobId</code> to identify the job in
@@ -4925,6 +5465,9 @@ export interface StartPersonTrackingResponse {
4925
5465
  */
4926
5466
  JobId?: string;
4927
5467
  }
5468
+ /**
5469
+ * @public
5470
+ */
4928
5471
  export interface StartProjectVersionRequest {
4929
5472
  /**
4930
5473
  * <p>The Amazon Resource Name(ARN) of the model version that you want to start.</p>
@@ -4949,6 +5492,9 @@ export interface StartProjectVersionRequest {
4949
5492
  */
4950
5493
  MaxInferenceUnits?: number;
4951
5494
  }
5495
+ /**
5496
+ * @public
5497
+ */
4952
5498
  export interface StartProjectVersionResponse {
4953
5499
  /**
4954
5500
  * <p>The current running status of the model. </p>
@@ -4956,6 +5502,7 @@ export interface StartProjectVersionResponse {
4956
5502
  Status?: ProjectVersionStatus | string;
4957
5503
  }
4958
5504
  /**
5505
+ * @public
4959
5506
  * <p>Filters for the shot detection segments returned by <code>GetSegmentDetection</code>.
4960
5507
  * For more information, see <a>StartSegmentDetectionFilters</a>.</p>
4961
5508
  */
@@ -4971,6 +5518,7 @@ export interface StartShotDetectionFilter {
4971
5518
  MinSegmentConfidence?: number;
4972
5519
  }
4973
5520
  /**
5521
+ * @public
4974
5522
  * <p>Filters for the technical segments returned by <a>GetSegmentDetection</a>. For more information,
4975
5523
  * see <a>StartSegmentDetectionFilters</a>.</p>
4976
5524
  */
@@ -4993,6 +5541,7 @@ export interface StartTechnicalCueDetectionFilter {
4993
5541
  BlackFrame?: BlackFrame;
4994
5542
  }
4995
5543
  /**
5544
+ * @public
4996
5545
  * <p>Filters applied to the technical cue or shot detection segments.
4997
5546
  * For more information, see <a>StartSegmentDetection</a>.
4998
5547
  * </p>
@@ -5007,6 +5556,9 @@ export interface StartSegmentDetectionFilters {
5007
5556
  */
5008
5557
  ShotFilter?: StartShotDetectionFilter;
5009
5558
  }
5559
+ /**
5560
+ * @public
5561
+ */
5010
5562
  export interface StartSegmentDetectionRequest {
5011
5563
  /**
5012
5564
  * <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
@@ -5038,6 +5590,9 @@ export interface StartSegmentDetectionRequest {
5038
5590
  */
5039
5591
  SegmentTypes: (SegmentType | string)[] | undefined;
5040
5592
  }
5593
+ /**
5594
+ * @public
5595
+ */
5041
5596
  export interface StartSegmentDetectionResponse {
5042
5597
  /**
5043
5598
  * <p>Unique identifier for the segment detection job. The <code>JobId</code> is returned from <code>StartSegmentDetection</code>.
@@ -5046,6 +5601,7 @@ export interface StartSegmentDetectionResponse {
5046
5601
  JobId?: string;
5047
5602
  }
5048
5603
  /**
5604
+ * @public
5049
5605
  * <p>This is a required parameter for label detection stream processors and should not be used
5050
5606
  * to start a face search stream processor.</p>
5051
5607
  */
@@ -5058,6 +5614,7 @@ export interface StreamProcessingStartSelector {
5058
5614
  KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
5059
5615
  }
5060
5616
  /**
5617
+ * @public
5061
5618
  * <p>
5062
5619
  * Specifies when to stop processing the stream. You can specify a maximum amount
5063
5620
  * of time to process the video.
@@ -5071,6 +5628,9 @@ export interface StreamProcessingStopSelector {
5071
5628
  */
5072
5629
  MaxDurationInSeconds?: number;
5073
5630
  }
5631
+ /**
5632
+ * @public
5633
+ */
5074
5634
  export interface StartStreamProcessorRequest {
5075
5635
  /**
5076
5636
  * <p>The name of the stream processor to start processing.</p>
@@ -5094,6 +5654,9 @@ export interface StartStreamProcessorRequest {
5094
5654
  */
5095
5655
  StopSelector?: StreamProcessingStopSelector;
5096
5656
  }
5657
+ /**
5658
+ * @public
5659
+ */
5097
5660
  export interface StartStreamProcessorResponse {
5098
5661
  /**
5099
5662
  * <p>
@@ -5103,6 +5666,7 @@ export interface StartStreamProcessorResponse {
5103
5666
  SessionId?: string;
5104
5667
  }
5105
5668
  /**
5669
+ * @public
5106
5670
  * <p>Set of optional parameters that let you set the criteria text must meet to be included in your response.
5107
5671
  * <code>WordFilter</code> looks at a word's height, width and minimum confidence. <code>RegionOfInterest</code>
5108
5672
  * lets you set a specific region of the screen to look for text in.</p>
@@ -5118,6 +5682,9 @@ export interface StartTextDetectionFilters {
5118
5682
  */
5119
5683
  RegionsOfInterest?: RegionOfInterest[];
5120
5684
  }
5685
+ /**
5686
+ * @public
5687
+ */
5121
5688
  export interface StartTextDetectionRequest {
5122
5689
  /**
5123
5690
  * <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
@@ -5146,12 +5713,18 @@ export interface StartTextDetectionRequest {
5146
5713
  */
5147
5714
  Filters?: StartTextDetectionFilters;
5148
5715
  }
5716
+ /**
5717
+ * @public
5718
+ */
5149
5719
  export interface StartTextDetectionResponse {
5150
5720
  /**
5151
5721
  * <p>Identifier for the text detection job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetTextDetection</code>.</p>
5152
5722
  */
5153
5723
  JobId?: string;
5154
5724
  }
5725
+ /**
5726
+ * @public
5727
+ */
5155
5728
  export interface StopProjectVersionRequest {
5156
5729
  /**
5157
5730
  * <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
@@ -5159,20 +5732,32 @@ export interface StopProjectVersionRequest {
5159
5732
  */
5160
5733
  ProjectVersionArn: string | undefined;
5161
5734
  }
5735
+ /**
5736
+ * @public
5737
+ */
5162
5738
  export interface StopProjectVersionResponse {
5163
5739
  /**
5164
5740
  * <p>The current status of the stop operation. </p>
5165
5741
  */
5166
5742
  Status?: ProjectVersionStatus | string;
5167
5743
  }
5744
+ /**
5745
+ * @public
5746
+ */
5168
5747
  export interface StopStreamProcessorRequest {
5169
5748
  /**
5170
5749
  * <p>The name of a stream processor created by <a>CreateStreamProcessor</a>.</p>
5171
5750
  */
5172
5751
  Name: string | undefined;
5173
5752
  }
5753
+ /**
5754
+ * @public
5755
+ */
5174
5756
  export interface StopStreamProcessorResponse {
5175
5757
  }
5758
+ /**
5759
+ * @public
5760
+ */
5176
5761
  export interface TagResourceRequest {
5177
5762
  /**
5178
5763
  * <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
@@ -5184,8 +5769,14 @@ export interface TagResourceRequest {
5184
5769
  */
5185
5770
  Tags: Record<string, string> | undefined;
5186
5771
  }
5772
+ /**
5773
+ * @public
5774
+ */
5187
5775
  export interface TagResourceResponse {
5188
5776
  }
5777
+ /**
5778
+ * @public
5779
+ */
5189
5780
  export interface UntagResourceRequest {
5190
5781
  /**
5191
5782
  * <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
@@ -5197,8 +5788,14 @@ export interface UntagResourceRequest {
5197
5788
  */
5198
5789
  TagKeys: string[] | undefined;
5199
5790
  }
5791
+ /**
5792
+ * @public
5793
+ */
5200
5794
  export interface UntagResourceResponse {
5201
5795
  }
5796
+ /**
5797
+ * @public
5798
+ */
5202
5799
  export interface UpdateDatasetEntriesRequest {
5203
5800
  /**
5204
5801
  * <p>
@@ -5213,13 +5810,20 @@ export interface UpdateDatasetEntriesRequest {
5213
5810
  */
5214
5811
  Changes: DatasetChanges | undefined;
5215
5812
  }
5813
+ /**
5814
+ * @public
5815
+ */
5216
5816
  export interface UpdateDatasetEntriesResponse {
5217
5817
  }
5818
+ /**
5819
+ * @public
5820
+ */
5218
5821
  export declare enum StreamProcessorParameterToDelete {
5219
5822
  ConnectedHomeMinConfidence = "ConnectedHomeMinConfidence",
5220
5823
  RegionsOfInterest = "RegionsOfInterest"
5221
5824
  }
5222
5825
  /**
5826
+ * @public
5223
5827
  * <p>
5224
5828
  * The stream processor settings that you want to update. <code>ConnectedHome</code> settings can be updated to detect different labels with a different minimum confidence.
5225
5829
  * </p>
@@ -5232,6 +5836,9 @@ export interface StreamProcessorSettingsForUpdate {
5232
5836
  */
5233
5837
  ConnectedHomeForUpdate?: ConnectedHomeSettingsForUpdate;
5234
5838
  }
5839
+ /**
5840
+ * @public
5841
+ */
5235
5842
  export interface UpdateStreamProcessorRequest {
5236
5843
  /**
5237
5844
  * <p>
@@ -5265,6 +5872,9 @@ export interface UpdateStreamProcessorRequest {
5265
5872
  */
5266
5873
  ParametersToDelete?: (StreamProcessorParameterToDelete | string)[];
5267
5874
  }
5875
+ /**
5876
+ * @public
5877
+ */
5268
5878
  export interface UpdateStreamProcessorResponse {
5269
5879
  }
5270
5880
  /**