@aws-sdk/client-rekognition 3.325.0 → 3.327.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 (75) hide show
  1. package/dist-cjs/models/models_0.js +11 -0
  2. package/dist-cjs/protocols/Aws_json1_1.js +7 -0
  3. package/dist-es/models/models_0.js +11 -0
  4. package/dist-es/protocols/Aws_json1_1.js +7 -0
  5. package/dist-types/commands/CompareFacesCommand.d.ts +88 -0
  6. package/dist-types/commands/CopyProjectVersionCommand.d.ts +6 -0
  7. package/dist-types/commands/CreateCollectionCommand.d.ts +8 -0
  8. package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
  9. package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +6 -0
  10. package/dist-types/commands/CreateProjectCommand.d.ts +6 -0
  11. package/dist-types/commands/CreateProjectVersionCommand.d.ts +6 -0
  12. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +6 -0
  13. package/dist-types/commands/DeleteCollectionCommand.d.ts +6 -0
  14. package/dist-types/commands/DeleteDatasetCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteFacesCommand.d.ts +8 -0
  16. package/dist-types/commands/DeleteProjectCommand.d.ts +6 -0
  17. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +6 -0
  19. package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +4 -0
  20. package/dist-types/commands/DescribeCollectionCommand.d.ts +9 -0
  21. package/dist-types/commands/DescribeDatasetCommand.d.ts +18 -0
  22. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +105 -0
  23. package/dist-types/commands/DescribeProjectsCommand.d.ts +23 -0
  24. package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +61 -0
  25. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +25 -0
  26. package/dist-types/commands/DetectFacesCommand.d.ts +82 -3
  27. package/dist-types/commands/DetectLabelsCommand.d.ts +84 -0
  28. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +20 -0
  29. package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +51 -0
  30. package/dist-types/commands/DetectTextCommand.d.ts +29 -0
  31. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +4 -0
  32. package/dist-types/commands/GetCelebrityInfoCommand.d.ts +12 -0
  33. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +119 -0
  34. package/dist-types/commands/GetContentModerationCommand.d.ts +44 -0
  35. package/dist-types/commands/GetFaceDetectionCommand.d.ts +102 -0
  36. package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +38 -0
  37. package/dist-types/commands/GetFaceSearchCommand.d.ts +124 -0
  38. package/dist-types/commands/GetLabelDetectionCommand.d.ts +80 -0
  39. package/dist-types/commands/GetPersonTrackingCommand.d.ts +111 -0
  40. package/dist-types/commands/GetSegmentDetectionCommand.d.ts +64 -0
  41. package/dist-types/commands/GetTextDetectionCommand.d.ts +53 -0
  42. package/dist-types/commands/IndexFacesCommand.d.ts +181 -6
  43. package/dist-types/commands/ListCollectionsCommand.d.ts +12 -0
  44. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +9 -0
  45. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +15 -0
  46. package/dist-types/commands/ListFacesCommand.d.ts +22 -0
  47. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
  48. package/dist-types/commands/ListStreamProcessorsCommand.d.ts +12 -0
  49. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  50. package/dist-types/commands/PutProjectPolicyCommand.d.ts +6 -0
  51. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +91 -0
  52. package/dist-types/commands/SearchFacesByImageCommand.d.ts +31 -0
  53. package/dist-types/commands/SearchFacesCommand.d.ts +25 -0
  54. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +6 -0
  55. package/dist-types/commands/StartContentModerationCommand.d.ts +6 -0
  56. package/dist-types/commands/StartFaceDetectionCommand.d.ts +6 -0
  57. package/dist-types/commands/StartFaceSearchCommand.d.ts +6 -0
  58. package/dist-types/commands/StartLabelDetectionCommand.d.ts +6 -0
  59. package/dist-types/commands/StartPersonTrackingCommand.d.ts +6 -0
  60. package/dist-types/commands/StartProjectVersionCommand.d.ts +6 -0
  61. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +6 -0
  62. package/dist-types/commands/StartStreamProcessorCommand.d.ts +6 -0
  63. package/dist-types/commands/StartTextDetectionCommand.d.ts +6 -0
  64. package/dist-types/commands/StopProjectVersionCommand.d.ts +6 -0
  65. package/dist-types/commands/StopStreamProcessorCommand.d.ts +4 -0
  66. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  67. package/dist-types/commands/UntagResourceCommand.d.ts +6 -1
  68. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +4 -0
  69. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +4 -0
  70. package/dist-types/models/models_0.d.ts +66 -22
  71. package/dist-types/models/models_1.d.ts +5 -0
  72. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -4
  73. package/dist-types/ts3.4/models/models_0.d.ts +16 -1
  74. package/dist-types/ts3.4/models/models_1.d.ts +1 -0
  75. package/package.json +7 -7
package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts CHANGED
@@ -72,6 +72,123 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
72
72
  * };
73
73
  * const command = new GetCelebrityRecognitionCommand(input);
74
74
  * const response = await client.send(command);
75
+ * // { // GetCelebrityRecognitionResponse
76
+ * // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
77
+ * // StatusMessage: "STRING_VALUE",
78
+ * // VideoMetadata: { // VideoMetadata
79
+ * // Codec: "STRING_VALUE",
80
+ * // DurationMillis: Number("long"),
81
+ * // Format: "STRING_VALUE",
82
+ * // FrameRate: Number("float"),
83
+ * // FrameHeight: Number("long"),
84
+ * // FrameWidth: Number("long"),
85
+ * // ColorRange: "FULL" || "LIMITED",
86
+ * // },
87
+ * // NextToken: "STRING_VALUE",
88
+ * // Celebrities: [ // CelebrityRecognitions
89
+ * // { // CelebrityRecognition
90
+ * // Timestamp: Number("long"),
91
+ * // Celebrity: { // CelebrityDetail
92
+ * // Urls: [ // Urls
93
+ * // "STRING_VALUE",
94
+ * // ],
95
+ * // Name: "STRING_VALUE",
96
+ * // Id: "STRING_VALUE",
97
+ * // Confidence: Number("float"),
98
+ * // BoundingBox: { // BoundingBox
99
+ * // Width: Number("float"),
100
+ * // Height: Number("float"),
101
+ * // Left: Number("float"),
102
+ * // Top: Number("float"),
103
+ * // },
104
+ * // Face: { // FaceDetail
105
+ * // BoundingBox: {
106
+ * // Width: Number("float"),
107
+ * // Height: Number("float"),
108
+ * // Left: Number("float"),
109
+ * // Top: Number("float"),
110
+ * // },
111
+ * // AgeRange: { // AgeRange
112
+ * // Low: Number("int"),
113
+ * // High: Number("int"),
114
+ * // },
115
+ * // Smile: { // Smile
116
+ * // Value: true || false,
117
+ * // Confidence: Number("float"),
118
+ * // },
119
+ * // Eyeglasses: { // Eyeglasses
120
+ * // Value: true || false,
121
+ * // Confidence: Number("float"),
122
+ * // },
123
+ * // Sunglasses: { // Sunglasses
124
+ * // Value: true || false,
125
+ * // Confidence: Number("float"),
126
+ * // },
127
+ * // Gender: { // Gender
128
+ * // Value: "Male" || "Female",
129
+ * // Confidence: Number("float"),
130
+ * // },
131
+ * // Beard: { // Beard
132
+ * // Value: true || false,
133
+ * // Confidence: Number("float"),
134
+ * // },
135
+ * // Mustache: { // Mustache
136
+ * // Value: true || false,
137
+ * // Confidence: Number("float"),
138
+ * // },
139
+ * // EyesOpen: { // EyeOpen
140
+ * // Value: true || false,
141
+ * // Confidence: Number("float"),
142
+ * // },
143
+ * // MouthOpen: { // MouthOpen
144
+ * // Value: true || false,
145
+ * // Confidence: Number("float"),
146
+ * // },
147
+ * // Emotions: [ // Emotions
148
+ * // { // Emotion
149
+ * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
150
+ * // Confidence: Number("float"),
151
+ * // },
152
+ * // ],
153
+ * // Landmarks: [ // Landmarks
154
+ * // { // Landmark
155
+ * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
156
+ * // X: Number("float"),
157
+ * // Y: Number("float"),
158
+ * // },
159
+ * // ],
160
+ * // Pose: { // Pose
161
+ * // Roll: Number("float"),
162
+ * // Yaw: Number("float"),
163
+ * // Pitch: Number("float"),
164
+ * // },
165
+ * // Quality: { // ImageQuality
166
+ * // Brightness: Number("float"),
167
+ * // Sharpness: Number("float"),
168
+ * // },
169
+ * // Confidence: Number("float"),
170
+ * // FaceOccluded: { // FaceOccluded
171
+ * // Value: true || false,
172
+ * // Confidence: Number("float"),
173
+ * // },
174
+ * // },
175
+ * // KnownGender: { // KnownGender
176
+ * // Type: "Male" || "Female" || "Nonbinary" || "Unlisted",
177
+ * // },
178
+ * // },
179
+ * // },
180
+ * // ],
181
+ * // JobId: "STRING_VALUE",
182
+ * // Video: { // Video
183
+ * // S3Object: { // S3Object
184
+ * // Bucket: "STRING_VALUE",
185
+ * // Name: "STRING_VALUE",
186
+ * // Version: "STRING_VALUE",
187
+ * // },
188
+ * // },
189
+ * // JobTag: "STRING_VALUE",
190
+ * // };
191
+ *
75
192
  * ```
76
193
  *
77
194
  * @param GetCelebrityRecognitionCommandInput - {@link GetCelebrityRecognitionCommandInput}
@@ -103,6 +220,8 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
103
220
  * @throws {@link ThrottlingException} (server fault)
104
221
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
105
222
  *
223
+ * @throws {@link RekognitionServiceException}
224
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
106
225
  *
107
226
  */
108
227
  export declare class GetCelebrityRecognitionCommand extends $Command<GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput, RekognitionClientResolvedConfig> {
package/dist-types/commands/GetContentModerationCommand.d.ts CHANGED
@@ -61,6 +61,48 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
61
61
  * };
62
62
  * const command = new GetContentModerationCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // GetContentModerationResponse
65
+ * // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
66
+ * // StatusMessage: "STRING_VALUE",
67
+ * // VideoMetadata: { // VideoMetadata
68
+ * // Codec: "STRING_VALUE",
69
+ * // DurationMillis: Number("long"),
70
+ * // Format: "STRING_VALUE",
71
+ * // FrameRate: Number("float"),
72
+ * // FrameHeight: Number("long"),
73
+ * // FrameWidth: Number("long"),
74
+ * // ColorRange: "FULL" || "LIMITED",
75
+ * // },
76
+ * // ModerationLabels: [ // ContentModerationDetections
77
+ * // { // ContentModerationDetection
78
+ * // Timestamp: Number("long"),
79
+ * // ModerationLabel: { // ModerationLabel
80
+ * // Confidence: Number("float"),
81
+ * // Name: "STRING_VALUE",
82
+ * // ParentName: "STRING_VALUE",
83
+ * // },
84
+ * // StartTimestampMillis: Number("long"),
85
+ * // EndTimestampMillis: Number("long"),
86
+ * // DurationMillis: Number("long"),
87
+ * // },
88
+ * // ],
89
+ * // NextToken: "STRING_VALUE",
90
+ * // ModerationModelVersion: "STRING_VALUE",
91
+ * // JobId: "STRING_VALUE",
92
+ * // Video: { // Video
93
+ * // S3Object: { // S3Object
94
+ * // Bucket: "STRING_VALUE",
95
+ * // Name: "STRING_VALUE",
96
+ * // Version: "STRING_VALUE",
97
+ * // },
98
+ * // },
99
+ * // JobTag: "STRING_VALUE",
100
+ * // GetRequestMetadata: { // GetContentModerationRequestMetadata
101
+ * // SortBy: "NAME" || "TIMESTAMP",
102
+ * // AggregateBy: "TIMESTAMPS" || "SEGMENTS",
103
+ * // },
104
+ * // };
105
+ *
64
106
  * ```
65
107
  *
66
108
  * @param GetContentModerationCommandInput - {@link GetContentModerationCommandInput}
@@ -92,6 +134,8 @@ export interface GetContentModerationCommandOutput extends GetContentModerationR
92
134
  * @throws {@link ThrottlingException} (server fault)
93
135
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
94
136
  *
137
+ * @throws {@link RekognitionServiceException}
138
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
95
139
  *
96
140
  */
97
141
  export declare class GetContentModerationCommand extends $Command<GetContentModerationCommandInput, GetContentModerationCommandOutput, RekognitionClientResolvedConfig> {
package/dist-types/commands/GetFaceDetectionCommand.d.ts CHANGED
@@ -45,6 +45,106 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
45
45
  * };
46
46
  * const command = new GetFaceDetectionCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // GetFaceDetectionResponse
49
+ * // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
50
+ * // StatusMessage: "STRING_VALUE",
51
+ * // VideoMetadata: { // VideoMetadata
52
+ * // Codec: "STRING_VALUE",
53
+ * // DurationMillis: Number("long"),
54
+ * // Format: "STRING_VALUE",
55
+ * // FrameRate: Number("float"),
56
+ * // FrameHeight: Number("long"),
57
+ * // FrameWidth: Number("long"),
58
+ * // ColorRange: "FULL" || "LIMITED",
59
+ * // },
60
+ * // NextToken: "STRING_VALUE",
61
+ * // Faces: [ // FaceDetections
62
+ * // { // FaceDetection
63
+ * // Timestamp: Number("long"),
64
+ * // Face: { // FaceDetail
65
+ * // BoundingBox: { // BoundingBox
66
+ * // Width: Number("float"),
67
+ * // Height: Number("float"),
68
+ * // Left: Number("float"),
69
+ * // Top: Number("float"),
70
+ * // },
71
+ * // AgeRange: { // AgeRange
72
+ * // Low: Number("int"),
73
+ * // High: Number("int"),
74
+ * // },
75
+ * // Smile: { // Smile
76
+ * // Value: true || false,
77
+ * // Confidence: Number("float"),
78
+ * // },
79
+ * // Eyeglasses: { // Eyeglasses
80
+ * // Value: true || false,
81
+ * // Confidence: Number("float"),
82
+ * // },
83
+ * // Sunglasses: { // Sunglasses
84
+ * // Value: true || false,
85
+ * // Confidence: Number("float"),
86
+ * // },
87
+ * // Gender: { // Gender
88
+ * // Value: "Male" || "Female",
89
+ * // Confidence: Number("float"),
90
+ * // },
91
+ * // Beard: { // Beard
92
+ * // Value: true || false,
93
+ * // Confidence: Number("float"),
94
+ * // },
95
+ * // Mustache: { // Mustache
96
+ * // Value: true || false,
97
+ * // Confidence: Number("float"),
98
+ * // },
99
+ * // EyesOpen: { // EyeOpen
100
+ * // Value: true || false,
101
+ * // Confidence: Number("float"),
102
+ * // },
103
+ * // MouthOpen: { // MouthOpen
104
+ * // Value: true || false,
105
+ * // Confidence: Number("float"),
106
+ * // },
107
+ * // Emotions: [ // Emotions
108
+ * // { // Emotion
109
+ * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
110
+ * // Confidence: Number("float"),
111
+ * // },
112
+ * // ],
113
+ * // Landmarks: [ // Landmarks
114
+ * // { // Landmark
115
+ * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
116
+ * // X: Number("float"),
117
+ * // Y: Number("float"),
118
+ * // },
119
+ * // ],
120
+ * // Pose: { // Pose
121
+ * // Roll: Number("float"),
122
+ * // Yaw: Number("float"),
123
+ * // Pitch: Number("float"),
124
+ * // },
125
+ * // Quality: { // ImageQuality
126
+ * // Brightness: Number("float"),
127
+ * // Sharpness: Number("float"),
128
+ * // },
129
+ * // Confidence: Number("float"),
130
+ * // FaceOccluded: { // FaceOccluded
131
+ * // Value: true || false,
132
+ * // Confidence: Number("float"),
133
+ * // },
134
+ * // },
135
+ * // },
136
+ * // ],
137
+ * // JobId: "STRING_VALUE",
138
+ * // Video: { // Video
139
+ * // S3Object: { // S3Object
140
+ * // Bucket: "STRING_VALUE",
141
+ * // Name: "STRING_VALUE",
142
+ * // Version: "STRING_VALUE",
143
+ * // },
144
+ * // },
145
+ * // JobTag: "STRING_VALUE",
146
+ * // };
147
+ *
48
148
  * ```
49
149
  *
50
150
  * @param GetFaceDetectionCommandInput - {@link GetFaceDetectionCommandInput}
@@ -76,6 +176,8 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
76
176
  * @throws {@link ThrottlingException} (server fault)
77
177
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
78
178
  *
179
+ * @throws {@link RekognitionServiceException}
180
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
79
181
  *
80
182
  */
81
183
  export declare class GetFaceDetectionCommand extends $Command<GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput, RekognitionClientResolvedConfig> {
package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts CHANGED
@@ -36,6 +36,42 @@ export interface GetFaceLivenessSessionResultsCommandOutput extends GetFaceLiven
36
36
  * };
37
37
  * const command = new GetFaceLivenessSessionResultsCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // GetFaceLivenessSessionResultsResponse
40
+ * // SessionId: "STRING_VALUE", // required
41
+ * // Status: "CREATED" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED" || "EXPIRED", // required
42
+ * // Confidence: Number("float"),
43
+ * // ReferenceImage: { // AuditImage
44
+ * // Bytes: "BLOB_VALUE",
45
+ * // S3Object: { // S3Object
46
+ * // Bucket: "STRING_VALUE",
47
+ * // Name: "STRING_VALUE",
48
+ * // Version: "STRING_VALUE",
49
+ * // },
50
+ * // BoundingBox: { // BoundingBox
51
+ * // Width: Number("float"),
52
+ * // Height: Number("float"),
53
+ * // Left: Number("float"),
54
+ * // Top: Number("float"),
55
+ * // },
56
+ * // },
57
+ * // AuditImages: [ // AuditImages
58
+ * // {
59
+ * // Bytes: "BLOB_VALUE",
60
+ * // S3Object: {
61
+ * // Bucket: "STRING_VALUE",
62
+ * // Name: "STRING_VALUE",
63
+ * // Version: "STRING_VALUE",
64
+ * // },
65
+ * // BoundingBox: {
66
+ * // Width: Number("float"),
67
+ * // Height: Number("float"),
68
+ * // Left: Number("float"),
69
+ * // Top: Number("float"),
70
+ * // },
71
+ * // },
72
+ * // ],
73
+ * // };
74
+ *
39
75
  * ```
40
76
  *
41
77
  * @param GetFaceLivenessSessionResultsCommandInput - {@link GetFaceLivenessSessionResultsCommandInput}
@@ -64,6 +100,8 @@ export interface GetFaceLivenessSessionResultsCommandOutput extends GetFaceLiven
64
100
  * @throws {@link ThrottlingException} (server fault)
65
101
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
66
102
  *
103
+ * @throws {@link RekognitionServiceException}
104
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
67
105
  *
68
106
  */
69
107
  export declare class GetFaceLivenessSessionResultsCommand extends $Command<GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput, RekognitionClientResolvedConfig> {
package/dist-types/commands/GetFaceSearchCommand.d.ts CHANGED
@@ -62,6 +62,128 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
62
62
  * };
63
63
  * const command = new GetFaceSearchCommand(input);
64
64
  * const response = await client.send(command);
65
+ * // { // GetFaceSearchResponse
66
+ * // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
67
+ * // StatusMessage: "STRING_VALUE",
68
+ * // NextToken: "STRING_VALUE",
69
+ * // VideoMetadata: { // VideoMetadata
70
+ * // Codec: "STRING_VALUE",
71
+ * // DurationMillis: Number("long"),
72
+ * // Format: "STRING_VALUE",
73
+ * // FrameRate: Number("float"),
74
+ * // FrameHeight: Number("long"),
75
+ * // FrameWidth: Number("long"),
76
+ * // ColorRange: "FULL" || "LIMITED",
77
+ * // },
78
+ * // Persons: [ // PersonMatches
79
+ * // { // PersonMatch
80
+ * // Timestamp: Number("long"),
81
+ * // Person: { // PersonDetail
82
+ * // Index: Number("long"),
83
+ * // BoundingBox: { // BoundingBox
84
+ * // Width: Number("float"),
85
+ * // Height: Number("float"),
86
+ * // Left: Number("float"),
87
+ * // Top: Number("float"),
88
+ * // },
89
+ * // Face: { // FaceDetail
90
+ * // BoundingBox: {
91
+ * // Width: Number("float"),
92
+ * // Height: Number("float"),
93
+ * // Left: Number("float"),
94
+ * // Top: Number("float"),
95
+ * // },
96
+ * // AgeRange: { // AgeRange
97
+ * // Low: Number("int"),
98
+ * // High: Number("int"),
99
+ * // },
100
+ * // Smile: { // Smile
101
+ * // Value: true || false,
102
+ * // Confidence: Number("float"),
103
+ * // },
104
+ * // Eyeglasses: { // Eyeglasses
105
+ * // Value: true || false,
106
+ * // Confidence: Number("float"),
107
+ * // },
108
+ * // Sunglasses: { // Sunglasses
109
+ * // Value: true || false,
110
+ * // Confidence: Number("float"),
111
+ * // },
112
+ * // Gender: { // Gender
113
+ * // Value: "Male" || "Female",
114
+ * // Confidence: Number("float"),
115
+ * // },
116
+ * // Beard: { // Beard
117
+ * // Value: true || false,
118
+ * // Confidence: Number("float"),
119
+ * // },
120
+ * // Mustache: { // Mustache
121
+ * // Value: true || false,
122
+ * // Confidence: Number("float"),
123
+ * // },
124
+ * // EyesOpen: { // EyeOpen
125
+ * // Value: true || false,
126
+ * // Confidence: Number("float"),
127
+ * // },
128
+ * // MouthOpen: { // MouthOpen
129
+ * // Value: true || false,
130
+ * // Confidence: Number("float"),
131
+ * // },
132
+ * // Emotions: [ // Emotions
133
+ * // { // Emotion
134
+ * // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
135
+ * // Confidence: Number("float"),
136
+ * // },
137
+ * // ],
138
+ * // Landmarks: [ // Landmarks
139
+ * // { // Landmark
140
+ * // Type: "eyeLeft" || "eyeRight" || "nose" || "mouthLeft" || "mouthRight" || "leftEyeBrowLeft" || "leftEyeBrowRight" || "leftEyeBrowUp" || "rightEyeBrowLeft" || "rightEyeBrowRight" || "rightEyeBrowUp" || "leftEyeLeft" || "leftEyeRight" || "leftEyeUp" || "leftEyeDown" || "rightEyeLeft" || "rightEyeRight" || "rightEyeUp" || "rightEyeDown" || "noseLeft" || "noseRight" || "mouthUp" || "mouthDown" || "leftPupil" || "rightPupil" || "upperJawlineLeft" || "midJawlineLeft" || "chinBottom" || "midJawlineRight" || "upperJawlineRight",
141
+ * // X: Number("float"),
142
+ * // Y: Number("float"),
143
+ * // },
144
+ * // ],
145
+ * // Pose: { // Pose
146
+ * // Roll: Number("float"),
147
+ * // Yaw: Number("float"),
148
+ * // Pitch: Number("float"),
149
+ * // },
150
+ * // Quality: { // ImageQuality
151
+ * // Brightness: Number("float"),
152
+ * // Sharpness: Number("float"),
153
+ * // },
154
+ * // Confidence: Number("float"),
155
+ * // FaceOccluded: { // FaceOccluded
156
+ * // Value: true || false,
157
+ * // Confidence: Number("float"),
158
+ * // },
159
+ * // },
160
+ * // },
161
+ * // FaceMatches: [ // FaceMatchList
162
+ * // { // FaceMatch
163
+ * // Similarity: Number("float"),
164
+ * // Face: { // Face
165
+ * // FaceId: "STRING_VALUE",
166
+ * // BoundingBox: "<BoundingBox>",
167
+ * // ImageId: "STRING_VALUE",
168
+ * // ExternalImageId: "STRING_VALUE",
169
+ * // Confidence: Number("float"),
170
+ * // IndexFacesModelVersion: "STRING_VALUE",
171
+ * // },
172
+ * // },
173
+ * // ],
174
+ * // },
175
+ * // ],
176
+ * // JobId: "STRING_VALUE",
177
+ * // Video: { // Video
178
+ * // S3Object: { // S3Object
179
+ * // Bucket: "STRING_VALUE",
180
+ * // Name: "STRING_VALUE",
181
+ * // Version: "STRING_VALUE",
182
+ * // },
183
+ * // },
184
+ * // JobTag: "STRING_VALUE",
185
+ * // };
186
+ *
65
187
  * ```
66
188
  *
67
189
  * @param GetFaceSearchCommandInput - {@link GetFaceSearchCommandInput}
@@ -93,6 +215,8 @@ export interface GetFaceSearchCommandOutput extends GetFaceSearchResponse, __Met
93
215
  * @throws {@link ThrottlingException} (server fault)
94
216
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
95
217
  *
218
+ * @throws {@link RekognitionServiceException}
219
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
96
220
  *
97
221
  */
98
222
  export declare class GetFaceSearchCommand extends $Command<GetFaceSearchCommandInput, GetFaceSearchCommandOutput, RekognitionClientResolvedConfig> {
package/dist-types/commands/GetLabelDetectionCommand.d.ts CHANGED
@@ -100,6 +100,84 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
100
100
  * };
101
101
  * const command = new GetLabelDetectionCommand(input);
102
102
  * const response = await client.send(command);
103
+ * // { // GetLabelDetectionResponse
104
+ * // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
105
+ * // StatusMessage: "STRING_VALUE",
106
+ * // VideoMetadata: { // VideoMetadata
107
+ * // Codec: "STRING_VALUE",
108
+ * // DurationMillis: Number("long"),
109
+ * // Format: "STRING_VALUE",
110
+ * // FrameRate: Number("float"),
111
+ * // FrameHeight: Number("long"),
112
+ * // FrameWidth: Number("long"),
113
+ * // ColorRange: "FULL" || "LIMITED",
114
+ * // },
115
+ * // NextToken: "STRING_VALUE",
116
+ * // Labels: [ // LabelDetections
117
+ * // { // LabelDetection
118
+ * // Timestamp: Number("long"),
119
+ * // Label: { // Label
120
+ * // Name: "STRING_VALUE",
121
+ * // Confidence: Number("float"),
122
+ * // Instances: [ // Instances
123
+ * // { // Instance
124
+ * // BoundingBox: { // BoundingBox
125
+ * // Width: Number("float"),
126
+ * // Height: Number("float"),
127
+ * // Left: Number("float"),
128
+ * // Top: Number("float"),
129
+ * // },
130
+ * // Confidence: Number("float"),
131
+ * // DominantColors: [ // DominantColors
132
+ * // { // DominantColor
133
+ * // Red: Number("int"),
134
+ * // Blue: Number("int"),
135
+ * // Green: Number("int"),
136
+ * // HexCode: "STRING_VALUE",
137
+ * // CSSColor: "STRING_VALUE",
138
+ * // SimplifiedColor: "STRING_VALUE",
139
+ * // PixelPercent: Number("float"),
140
+ * // },
141
+ * // ],
142
+ * // },
143
+ * // ],
144
+ * // Parents: [ // Parents
145
+ * // { // Parent
146
+ * // Name: "STRING_VALUE",
147
+ * // },
148
+ * // ],
149
+ * // Aliases: [ // LabelAliases
150
+ * // { // LabelAlias
151
+ * // Name: "STRING_VALUE",
152
+ * // },
153
+ * // ],
154
+ * // Categories: [ // LabelCategories
155
+ * // { // LabelCategory
156
+ * // Name: "STRING_VALUE",
157
+ * // },
158
+ * // ],
159
+ * // },
160
+ * // StartTimestampMillis: Number("long"),
161
+ * // EndTimestampMillis: Number("long"),
162
+ * // DurationMillis: Number("long"),
163
+ * // },
164
+ * // ],
165
+ * // LabelModelVersion: "STRING_VALUE",
166
+ * // JobId: "STRING_VALUE",
167
+ * // Video: { // Video
168
+ * // S3Object: { // S3Object
169
+ * // Bucket: "STRING_VALUE",
170
+ * // Name: "STRING_VALUE",
171
+ * // Version: "STRING_VALUE",
172
+ * // },
173
+ * // },
174
+ * // JobTag: "STRING_VALUE",
175
+ * // GetRequestMetadata: { // GetLabelDetectionRequestMetadata
176
+ * // SortBy: "NAME" || "TIMESTAMP",
177
+ * // AggregateBy: "TIMESTAMPS" || "SEGMENTS",
178
+ * // },
179
+ * // };
180
+ *
103
181
  * ```
104
182
  *
105
183
  * @param GetLabelDetectionCommandInput - {@link GetLabelDetectionCommandInput}
@@ -131,6 +209,8 @@ export interface GetLabelDetectionCommandOutput extends GetLabelDetectionRespons
131
209
  * @throws {@link ThrottlingException} (server fault)
132
210
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
133
211
  *
212
+ * @throws {@link RekognitionServiceException}
213
+ * <p>Base exception class for all service exceptions from Rekognition service.</p>
134
214
  *
135
215
  */
136
216
  export declare class GetLabelDetectionCommand extends $Command<GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput, RekognitionClientResolvedConfig> {