@aws-sdk/client-rekognition 3.325.0 → 3.326.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/CompareFacesCommand.d.ts +88 -0
- package/dist-types/commands/CopyProjectVersionCommand.d.ts +6 -0
- package/dist-types/commands/CreateCollectionCommand.d.ts +8 -0
- package/dist-types/commands/CreateDatasetCommand.d.ts +6 -0
- package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +6 -0
- package/dist-types/commands/CreateProjectCommand.d.ts +6 -0
- package/dist-types/commands/CreateProjectVersionCommand.d.ts +6 -0
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +6 -0
- package/dist-types/commands/DeleteCollectionCommand.d.ts +6 -0
- package/dist-types/commands/DeleteDatasetCommand.d.ts +4 -0
- package/dist-types/commands/DeleteFacesCommand.d.ts +8 -0
- package/dist-types/commands/DeleteProjectCommand.d.ts +6 -0
- package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +4 -0
- package/dist-types/commands/DeleteProjectVersionCommand.d.ts +6 -0
- package/dist-types/commands/DeleteStreamProcessorCommand.d.ts +4 -0
- package/dist-types/commands/DescribeCollectionCommand.d.ts +9 -0
- package/dist-types/commands/DescribeDatasetCommand.d.ts +18 -0
- package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +105 -0
- package/dist-types/commands/DescribeProjectsCommand.d.ts +23 -0
- package/dist-types/commands/DescribeStreamProcessorCommand.d.ts +61 -0
- package/dist-types/commands/DetectCustomLabelsCommand.d.ts +25 -0
- package/dist-types/commands/DetectFacesCommand.d.ts +75 -0
- package/dist-types/commands/DetectLabelsCommand.d.ts +84 -0
- package/dist-types/commands/DetectModerationLabelsCommand.d.ts +20 -0
- package/dist-types/commands/DetectProtectiveEquipmentCommand.d.ts +51 -0
- package/dist-types/commands/DetectTextCommand.d.ts +29 -0
- package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +4 -0
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +12 -0
- package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +115 -0
- package/dist-types/commands/GetContentModerationCommand.d.ts +44 -0
- package/dist-types/commands/GetFaceDetectionCommand.d.ts +98 -0
- package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +38 -0
- package/dist-types/commands/GetFaceSearchCommand.d.ts +120 -0
- package/dist-types/commands/GetLabelDetectionCommand.d.ts +80 -0
- package/dist-types/commands/GetPersonTrackingCommand.d.ts +107 -0
- package/dist-types/commands/GetSegmentDetectionCommand.d.ts +64 -0
- package/dist-types/commands/GetTextDetectionCommand.d.ts +53 -0
- package/dist-types/commands/IndexFacesCommand.d.ts +165 -0
- package/dist-types/commands/ListCollectionsCommand.d.ts +12 -0
- package/dist-types/commands/ListDatasetEntriesCommand.d.ts +9 -0
- package/dist-types/commands/ListDatasetLabelsCommand.d.ts +15 -0
- package/dist-types/commands/ListFacesCommand.d.ts +22 -0
- package/dist-types/commands/ListProjectPoliciesCommand.d.ts +16 -0
- package/dist-types/commands/ListStreamProcessorsCommand.d.ts +12 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +6 -0
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +91 -0
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +31 -0
- package/dist-types/commands/SearchFacesCommand.d.ts +25 -0
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +6 -0
- package/dist-types/commands/StartContentModerationCommand.d.ts +6 -0
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +6 -0
- package/dist-types/commands/StartFaceSearchCommand.d.ts +6 -0
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +6 -0
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +6 -0
- package/dist-types/commands/StartProjectVersionCommand.d.ts +6 -0
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +6 -0
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +6 -0
- package/dist-types/commands/StartTextDetectionCommand.d.ts +6 -0
- package/dist-types/commands/StopProjectVersionCommand.d.ts +6 -0
- package/dist-types/commands/StopStreamProcessorCommand.d.ts +4 -0
- package/dist-types/commands/TagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
- package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +4 -0
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +4 -0
- package/package.json +3 -3
|
@@ -51,6 +51,57 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
|
|
|
51
51
|
* };
|
|
52
52
|
* const command = new GetTextDetectionCommand(input);
|
|
53
53
|
* const response = await client.send(command);
|
|
54
|
+
* // { // GetTextDetectionResponse
|
|
55
|
+
* // JobStatus: "IN_PROGRESS" || "SUCCEEDED" || "FAILED",
|
|
56
|
+
* // StatusMessage: "STRING_VALUE",
|
|
57
|
+
* // VideoMetadata: { // VideoMetadata
|
|
58
|
+
* // Codec: "STRING_VALUE",
|
|
59
|
+
* // DurationMillis: Number("long"),
|
|
60
|
+
* // Format: "STRING_VALUE",
|
|
61
|
+
* // FrameRate: Number("float"),
|
|
62
|
+
* // FrameHeight: Number("long"),
|
|
63
|
+
* // FrameWidth: Number("long"),
|
|
64
|
+
* // ColorRange: "FULL" || "LIMITED",
|
|
65
|
+
* // },
|
|
66
|
+
* // TextDetections: [ // TextDetectionResults
|
|
67
|
+
* // { // TextDetectionResult
|
|
68
|
+
* // Timestamp: Number("long"),
|
|
69
|
+
* // TextDetection: { // TextDetection
|
|
70
|
+
* // DetectedText: "STRING_VALUE",
|
|
71
|
+
* // Type: "LINE" || "WORD",
|
|
72
|
+
* // Id: Number("int"),
|
|
73
|
+
* // ParentId: Number("int"),
|
|
74
|
+
* // Confidence: Number("float"),
|
|
75
|
+
* // Geometry: { // Geometry
|
|
76
|
+
* // BoundingBox: { // BoundingBox
|
|
77
|
+
* // Width: Number("float"),
|
|
78
|
+
* // Height: Number("float"),
|
|
79
|
+
* // Left: Number("float"),
|
|
80
|
+
* // Top: Number("float"),
|
|
81
|
+
* // },
|
|
82
|
+
* // Polygon: [ // Polygon
|
|
83
|
+
* // { // Point
|
|
84
|
+
* // X: Number("float"),
|
|
85
|
+
* // Y: Number("float"),
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // NextToken: "STRING_VALUE",
|
|
93
|
+
* // TextModelVersion: "STRING_VALUE",
|
|
94
|
+
* // JobId: "STRING_VALUE",
|
|
95
|
+
* // Video: { // Video
|
|
96
|
+
* // S3Object: { // S3Object
|
|
97
|
+
* // Bucket: "STRING_VALUE",
|
|
98
|
+
* // Name: "STRING_VALUE",
|
|
99
|
+
* // Version: "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // },
|
|
102
|
+
* // JobTag: "STRING_VALUE",
|
|
103
|
+
* // };
|
|
104
|
+
*
|
|
54
105
|
* ```
|
|
55
106
|
*
|
|
56
107
|
* @param GetTextDetectionCommandInput - {@link GetTextDetectionCommandInput}
|
|
@@ -82,6 +133,8 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
|
|
|
82
133
|
* @throws {@link ThrottlingException} (server fault)
|
|
83
134
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
84
135
|
*
|
|
136
|
+
* @throws {@link RekognitionServiceException}
|
|
137
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
85
138
|
*
|
|
86
139
|
*/
|
|
87
140
|
export declare class GetTextDetectionCommand extends $Command<GetTextDetectionCommandInput, GetTextDetectionCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -135,6 +135,169 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
135
135
|
* };
|
|
136
136
|
* const command = new IndexFacesCommand(input);
|
|
137
137
|
* const response = await client.send(command);
|
|
138
|
+
* // { // IndexFacesResponse
|
|
139
|
+
* // FaceRecords: [ // FaceRecordList
|
|
140
|
+
* // { // FaceRecord
|
|
141
|
+
* // Face: { // Face
|
|
142
|
+
* // FaceId: "STRING_VALUE",
|
|
143
|
+
* // BoundingBox: { // BoundingBox
|
|
144
|
+
* // Width: Number("float"),
|
|
145
|
+
* // Height: Number("float"),
|
|
146
|
+
* // Left: Number("float"),
|
|
147
|
+
* // Top: Number("float"),
|
|
148
|
+
* // },
|
|
149
|
+
* // ImageId: "STRING_VALUE",
|
|
150
|
+
* // ExternalImageId: "STRING_VALUE",
|
|
151
|
+
* // Confidence: Number("float"),
|
|
152
|
+
* // IndexFacesModelVersion: "STRING_VALUE",
|
|
153
|
+
* // },
|
|
154
|
+
* // FaceDetail: { // FaceDetail
|
|
155
|
+
* // BoundingBox: {
|
|
156
|
+
* // Width: Number("float"),
|
|
157
|
+
* // Height: Number("float"),
|
|
158
|
+
* // Left: Number("float"),
|
|
159
|
+
* // Top: Number("float"),
|
|
160
|
+
* // },
|
|
161
|
+
* // AgeRange: { // AgeRange
|
|
162
|
+
* // Low: Number("int"),
|
|
163
|
+
* // High: Number("int"),
|
|
164
|
+
* // },
|
|
165
|
+
* // Smile: { // Smile
|
|
166
|
+
* // Value: true || false,
|
|
167
|
+
* // Confidence: Number("float"),
|
|
168
|
+
* // },
|
|
169
|
+
* // Eyeglasses: { // Eyeglasses
|
|
170
|
+
* // Value: true || false,
|
|
171
|
+
* // Confidence: Number("float"),
|
|
172
|
+
* // },
|
|
173
|
+
* // Sunglasses: { // Sunglasses
|
|
174
|
+
* // Value: true || false,
|
|
175
|
+
* // Confidence: Number("float"),
|
|
176
|
+
* // },
|
|
177
|
+
* // Gender: { // Gender
|
|
178
|
+
* // Value: "Male" || "Female",
|
|
179
|
+
* // Confidence: Number("float"),
|
|
180
|
+
* // },
|
|
181
|
+
* // Beard: { // Beard
|
|
182
|
+
* // Value: true || false,
|
|
183
|
+
* // Confidence: Number("float"),
|
|
184
|
+
* // },
|
|
185
|
+
* // Mustache: { // Mustache
|
|
186
|
+
* // Value: true || false,
|
|
187
|
+
* // Confidence: Number("float"),
|
|
188
|
+
* // },
|
|
189
|
+
* // EyesOpen: { // EyeOpen
|
|
190
|
+
* // Value: true || false,
|
|
191
|
+
* // Confidence: Number("float"),
|
|
192
|
+
* // },
|
|
193
|
+
* // MouthOpen: { // MouthOpen
|
|
194
|
+
* // Value: true || false,
|
|
195
|
+
* // Confidence: Number("float"),
|
|
196
|
+
* // },
|
|
197
|
+
* // Emotions: [ // Emotions
|
|
198
|
+
* // { // Emotion
|
|
199
|
+
* // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
|
|
200
|
+
* // Confidence: Number("float"),
|
|
201
|
+
* // },
|
|
202
|
+
* // ],
|
|
203
|
+
* // Landmarks: [ // Landmarks
|
|
204
|
+
* // { // Landmark
|
|
205
|
+
* // 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",
|
|
206
|
+
* // X: Number("float"),
|
|
207
|
+
* // Y: Number("float"),
|
|
208
|
+
* // },
|
|
209
|
+
* // ],
|
|
210
|
+
* // Pose: { // Pose
|
|
211
|
+
* // Roll: Number("float"),
|
|
212
|
+
* // Yaw: Number("float"),
|
|
213
|
+
* // Pitch: Number("float"),
|
|
214
|
+
* // },
|
|
215
|
+
* // Quality: { // ImageQuality
|
|
216
|
+
* // Brightness: Number("float"),
|
|
217
|
+
* // Sharpness: Number("float"),
|
|
218
|
+
* // },
|
|
219
|
+
* // Confidence: Number("float"),
|
|
220
|
+
* // },
|
|
221
|
+
* // },
|
|
222
|
+
* // ],
|
|
223
|
+
* // OrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270",
|
|
224
|
+
* // FaceModelVersion: "STRING_VALUE",
|
|
225
|
+
* // UnindexedFaces: [ // UnindexedFaces
|
|
226
|
+
* // { // UnindexedFace
|
|
227
|
+
* // Reasons: [ // Reasons
|
|
228
|
+
* // "EXCEEDS_MAX_FACES" || "EXTREME_POSE" || "LOW_BRIGHTNESS" || "LOW_SHARPNESS" || "LOW_CONFIDENCE" || "SMALL_BOUNDING_BOX" || "LOW_FACE_QUALITY",
|
|
229
|
+
* // ],
|
|
230
|
+
* // FaceDetail: {
|
|
231
|
+
* // BoundingBox: {
|
|
232
|
+
* // Width: Number("float"),
|
|
233
|
+
* // Height: Number("float"),
|
|
234
|
+
* // Left: Number("float"),
|
|
235
|
+
* // Top: Number("float"),
|
|
236
|
+
* // },
|
|
237
|
+
* // AgeRange: {
|
|
238
|
+
* // Low: Number("int"),
|
|
239
|
+
* // High: Number("int"),
|
|
240
|
+
* // },
|
|
241
|
+
* // Smile: {
|
|
242
|
+
* // Value: true || false,
|
|
243
|
+
* // Confidence: Number("float"),
|
|
244
|
+
* // },
|
|
245
|
+
* // Eyeglasses: {
|
|
246
|
+
* // Value: true || false,
|
|
247
|
+
* // Confidence: Number("float"),
|
|
248
|
+
* // },
|
|
249
|
+
* // Sunglasses: {
|
|
250
|
+
* // Value: true || false,
|
|
251
|
+
* // Confidence: Number("float"),
|
|
252
|
+
* // },
|
|
253
|
+
* // Gender: {
|
|
254
|
+
* // Value: "Male" || "Female",
|
|
255
|
+
* // Confidence: Number("float"),
|
|
256
|
+
* // },
|
|
257
|
+
* // Beard: {
|
|
258
|
+
* // Value: true || false,
|
|
259
|
+
* // Confidence: Number("float"),
|
|
260
|
+
* // },
|
|
261
|
+
* // Mustache: {
|
|
262
|
+
* // Value: true || false,
|
|
263
|
+
* // Confidence: Number("float"),
|
|
264
|
+
* // },
|
|
265
|
+
* // EyesOpen: {
|
|
266
|
+
* // Value: true || false,
|
|
267
|
+
* // Confidence: Number("float"),
|
|
268
|
+
* // },
|
|
269
|
+
* // MouthOpen: {
|
|
270
|
+
* // Value: true || false,
|
|
271
|
+
* // Confidence: Number("float"),
|
|
272
|
+
* // },
|
|
273
|
+
* // Emotions: [
|
|
274
|
+
* // {
|
|
275
|
+
* // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
|
|
276
|
+
* // Confidence: Number("float"),
|
|
277
|
+
* // },
|
|
278
|
+
* // ],
|
|
279
|
+
* // Landmarks: [
|
|
280
|
+
* // {
|
|
281
|
+
* // 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",
|
|
282
|
+
* // X: Number("float"),
|
|
283
|
+
* // Y: Number("float"),
|
|
284
|
+
* // },
|
|
285
|
+
* // ],
|
|
286
|
+
* // Pose: {
|
|
287
|
+
* // Roll: Number("float"),
|
|
288
|
+
* // Yaw: Number("float"),
|
|
289
|
+
* // Pitch: Number("float"),
|
|
290
|
+
* // },
|
|
291
|
+
* // Quality: {
|
|
292
|
+
* // Brightness: Number("float"),
|
|
293
|
+
* // Sharpness: Number("float"),
|
|
294
|
+
* // },
|
|
295
|
+
* // Confidence: Number("float"),
|
|
296
|
+
* // },
|
|
297
|
+
* // },
|
|
298
|
+
* // ],
|
|
299
|
+
* // };
|
|
300
|
+
*
|
|
138
301
|
* ```
|
|
139
302
|
*
|
|
140
303
|
* @param IndexFacesCommandInput - {@link IndexFacesCommandInput}
|
|
@@ -180,6 +343,8 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
|
|
|
180
343
|
* @throws {@link ThrottlingException} (server fault)
|
|
181
344
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
182
345
|
*
|
|
346
|
+
* @throws {@link RekognitionServiceException}
|
|
347
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
183
348
|
*
|
|
184
349
|
* @example To add a face to a collection
|
|
185
350
|
* ```javascript
|
|
@@ -38,6 +38,16 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new ListCollectionsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListCollectionsResponse
|
|
42
|
+
* // CollectionIds: [ // CollectionIdList
|
|
43
|
+
* // "STRING_VALUE",
|
|
44
|
+
* // ],
|
|
45
|
+
* // NextToken: "STRING_VALUE",
|
|
46
|
+
* // FaceModelVersions: [ // FaceModelVersionList
|
|
47
|
+
* // "STRING_VALUE",
|
|
48
|
+
* // ],
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
41
51
|
* ```
|
|
42
52
|
*
|
|
43
53
|
* @param ListCollectionsCommandInput - {@link ListCollectionsCommandInput}
|
|
@@ -69,6 +79,8 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
|
|
|
69
79
|
* @throws {@link ThrottlingException} (server fault)
|
|
70
80
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
71
81
|
*
|
|
82
|
+
* @throws {@link RekognitionServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
72
84
|
*
|
|
73
85
|
* @example To list the collections
|
|
74
86
|
* ```javascript
|
|
@@ -52,6 +52,13 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
|
|
|
52
52
|
* };
|
|
53
53
|
* const command = new ListDatasetEntriesCommand(input);
|
|
54
54
|
* const response = await client.send(command);
|
|
55
|
+
* // { // ListDatasetEntriesResponse
|
|
56
|
+
* // DatasetEntries: [ // DatasetEntries
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // NextToken: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
55
62
|
* ```
|
|
56
63
|
*
|
|
57
64
|
* @param ListDatasetEntriesCommandInput - {@link ListDatasetEntriesCommandInput}
|
|
@@ -91,6 +98,8 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
|
|
|
91
98
|
* @throws {@link ThrottlingException} (server fault)
|
|
92
99
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
93
100
|
*
|
|
101
|
+
* @throws {@link RekognitionServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
94
103
|
*
|
|
95
104
|
*/
|
|
96
105
|
export declare class ListDatasetEntriesCommand extends $Command<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -38,6 +38,19 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new ListDatasetLabelsCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListDatasetLabelsResponse
|
|
42
|
+
* // DatasetLabelDescriptions: [ // DatasetLabelDescriptions
|
|
43
|
+
* // { // DatasetLabelDescription
|
|
44
|
+
* // LabelName: "STRING_VALUE",
|
|
45
|
+
* // LabelStats: { // DatasetLabelStats
|
|
46
|
+
* // EntryCount: Number("int"),
|
|
47
|
+
* // BoundingBoxCount: Number("int"),
|
|
48
|
+
* // },
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // NextToken: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
41
54
|
* ```
|
|
42
55
|
*
|
|
43
56
|
* @param ListDatasetLabelsCommandInput - {@link ListDatasetLabelsCommandInput}
|
|
@@ -77,6 +90,8 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
|
|
|
77
90
|
* @throws {@link ThrottlingException} (server fault)
|
|
78
91
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
79
92
|
*
|
|
93
|
+
* @throws {@link RekognitionServiceException}
|
|
94
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
80
95
|
*
|
|
81
96
|
*/
|
|
82
97
|
export declare class ListDatasetLabelsCommand extends $Command<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -38,6 +38,26 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
|
|
|
38
38
|
* };
|
|
39
39
|
* const command = new ListFacesCommand(input);
|
|
40
40
|
* const response = await client.send(command);
|
|
41
|
+
* // { // ListFacesResponse
|
|
42
|
+
* // Faces: [ // FaceList
|
|
43
|
+
* // { // Face
|
|
44
|
+
* // FaceId: "STRING_VALUE",
|
|
45
|
+
* // BoundingBox: { // BoundingBox
|
|
46
|
+
* // Width: Number("float"),
|
|
47
|
+
* // Height: Number("float"),
|
|
48
|
+
* // Left: Number("float"),
|
|
49
|
+
* // Top: Number("float"),
|
|
50
|
+
* // },
|
|
51
|
+
* // ImageId: "STRING_VALUE",
|
|
52
|
+
* // ExternalImageId: "STRING_VALUE",
|
|
53
|
+
* // Confidence: Number("float"),
|
|
54
|
+
* // IndexFacesModelVersion: "STRING_VALUE",
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // NextToken: "STRING_VALUE",
|
|
58
|
+
* // FaceModelVersion: "STRING_VALUE",
|
|
59
|
+
* // };
|
|
60
|
+
*
|
|
41
61
|
* ```
|
|
42
62
|
*
|
|
43
63
|
* @param ListFacesCommandInput - {@link ListFacesCommandInput}
|
|
@@ -69,6 +89,8 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
|
|
|
69
89
|
* @throws {@link ThrottlingException} (server fault)
|
|
70
90
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
71
91
|
*
|
|
92
|
+
* @throws {@link RekognitionServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
72
94
|
*
|
|
73
95
|
* @example To list the faces in a collection
|
|
74
96
|
* ```javascript
|
|
@@ -35,6 +35,20 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new ListProjectPoliciesCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // ListProjectPoliciesResponse
|
|
39
|
+
* // ProjectPolicies: [ // ProjectPolicies
|
|
40
|
+
* // { // ProjectPolicy
|
|
41
|
+
* // ProjectArn: "STRING_VALUE",
|
|
42
|
+
* // PolicyName: "STRING_VALUE",
|
|
43
|
+
* // PolicyRevisionId: "STRING_VALUE",
|
|
44
|
+
* // PolicyDocument: "STRING_VALUE",
|
|
45
|
+
* // CreationTimestamp: new Date("TIMESTAMP"),
|
|
46
|
+
* // LastUpdatedTimestamp: new Date("TIMESTAMP"),
|
|
47
|
+
* // },
|
|
48
|
+
* // ],
|
|
49
|
+
* // NextToken: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
38
52
|
* ```
|
|
39
53
|
*
|
|
40
54
|
* @param ListProjectPoliciesCommandInput - {@link ListProjectPoliciesCommandInput}
|
|
@@ -66,6 +80,8 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
|
|
|
66
80
|
* @throws {@link ThrottlingException} (server fault)
|
|
67
81
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
68
82
|
*
|
|
83
|
+
* @throws {@link RekognitionServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
69
85
|
*
|
|
70
86
|
* @example ListProjectPolicies
|
|
71
87
|
* ```javascript
|
|
@@ -32,6 +32,16 @@ export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsR
|
|
|
32
32
|
* };
|
|
33
33
|
* const command = new ListStreamProcessorsCommand(input);
|
|
34
34
|
* const response = await client.send(command);
|
|
35
|
+
* // { // ListStreamProcessorsResponse
|
|
36
|
+
* // NextToken: "STRING_VALUE",
|
|
37
|
+
* // StreamProcessors: [ // StreamProcessorList
|
|
38
|
+
* // { // StreamProcessor
|
|
39
|
+
* // Name: "STRING_VALUE",
|
|
40
|
+
* // Status: "STOPPED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "UPDATING",
|
|
41
|
+
* // },
|
|
42
|
+
* // ],
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
35
45
|
* ```
|
|
36
46
|
*
|
|
37
47
|
* @param ListStreamProcessorsCommandInput - {@link ListStreamProcessorsCommandInput}
|
|
@@ -60,6 +70,8 @@ export interface ListStreamProcessorsCommandOutput extends ListStreamProcessorsR
|
|
|
60
70
|
* @throws {@link ThrottlingException} (server fault)
|
|
61
71
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
62
72
|
*
|
|
73
|
+
* @throws {@link RekognitionServiceException}
|
|
74
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
63
75
|
*
|
|
64
76
|
*/
|
|
65
77
|
export declare class ListStreamProcessorsCommand extends $Command<ListStreamProcessorsCommandInput, ListStreamProcessorsCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -34,6 +34,12 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new ListTagsForResourceCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // ListTagsForResourceResponse
|
|
38
|
+
* // Tags: { // TagMap
|
|
39
|
+
* // "<keys>": "STRING_VALUE",
|
|
40
|
+
* // },
|
|
41
|
+
* // };
|
|
42
|
+
*
|
|
37
43
|
* ```
|
|
38
44
|
*
|
|
39
45
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -62,6 +68,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
62
68
|
* @throws {@link ThrottlingException} (server fault)
|
|
63
69
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
64
70
|
*
|
|
71
|
+
* @throws {@link RekognitionServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
65
73
|
*
|
|
66
74
|
*/
|
|
67
75
|
export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -47,6 +47,10 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
|
|
|
47
47
|
* };
|
|
48
48
|
* const command = new PutProjectPolicyCommand(input);
|
|
49
49
|
* const response = await client.send(command);
|
|
50
|
+
* // { // PutProjectPolicyResponse
|
|
51
|
+
* // PolicyRevisionId: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
50
54
|
* ```
|
|
51
55
|
*
|
|
52
56
|
* @param PutProjectPolicyCommandInput - {@link PutProjectPolicyCommandInput}
|
|
@@ -95,6 +99,8 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
|
|
|
95
99
|
* @throws {@link ThrottlingException} (server fault)
|
|
96
100
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
97
101
|
*
|
|
102
|
+
* @throws {@link RekognitionServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
98
104
|
*
|
|
99
105
|
* @example PutProjectPolicy
|
|
100
106
|
* ```javascript
|
|
@@ -64,6 +64,95 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
|
|
|
64
64
|
* };
|
|
65
65
|
* const command = new RecognizeCelebritiesCommand(input);
|
|
66
66
|
* const response = await client.send(command);
|
|
67
|
+
* // { // RecognizeCelebritiesResponse
|
|
68
|
+
* // CelebrityFaces: [ // CelebrityList
|
|
69
|
+
* // { // Celebrity
|
|
70
|
+
* // Urls: [ // Urls
|
|
71
|
+
* // "STRING_VALUE",
|
|
72
|
+
* // ],
|
|
73
|
+
* // Name: "STRING_VALUE",
|
|
74
|
+
* // Id: "STRING_VALUE",
|
|
75
|
+
* // Face: { // ComparedFace
|
|
76
|
+
* // BoundingBox: { // BoundingBox
|
|
77
|
+
* // Width: Number("float"),
|
|
78
|
+
* // Height: Number("float"),
|
|
79
|
+
* // Left: Number("float"),
|
|
80
|
+
* // Top: Number("float"),
|
|
81
|
+
* // },
|
|
82
|
+
* // Confidence: Number("float"),
|
|
83
|
+
* // Landmarks: [ // Landmarks
|
|
84
|
+
* // { // Landmark
|
|
85
|
+
* // 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",
|
|
86
|
+
* // X: Number("float"),
|
|
87
|
+
* // Y: Number("float"),
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // Pose: { // Pose
|
|
91
|
+
* // Roll: Number("float"),
|
|
92
|
+
* // Yaw: Number("float"),
|
|
93
|
+
* // Pitch: Number("float"),
|
|
94
|
+
* // },
|
|
95
|
+
* // Quality: { // ImageQuality
|
|
96
|
+
* // Brightness: Number("float"),
|
|
97
|
+
* // Sharpness: Number("float"),
|
|
98
|
+
* // },
|
|
99
|
+
* // Emotions: [ // Emotions
|
|
100
|
+
* // { // Emotion
|
|
101
|
+
* // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
|
|
102
|
+
* // Confidence: Number("float"),
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // Smile: { // Smile
|
|
106
|
+
* // Value: true || false,
|
|
107
|
+
* // Confidence: Number("float"),
|
|
108
|
+
* // },
|
|
109
|
+
* // },
|
|
110
|
+
* // MatchConfidence: Number("float"),
|
|
111
|
+
* // KnownGender: { // KnownGender
|
|
112
|
+
* // Type: "Male" || "Female" || "Nonbinary" || "Unlisted",
|
|
113
|
+
* // },
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // UnrecognizedFaces: [ // ComparedFaceList
|
|
117
|
+
* // {
|
|
118
|
+
* // BoundingBox: {
|
|
119
|
+
* // Width: Number("float"),
|
|
120
|
+
* // Height: Number("float"),
|
|
121
|
+
* // Left: Number("float"),
|
|
122
|
+
* // Top: Number("float"),
|
|
123
|
+
* // },
|
|
124
|
+
* // Confidence: Number("float"),
|
|
125
|
+
* // Landmarks: [
|
|
126
|
+
* // {
|
|
127
|
+
* // 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",
|
|
128
|
+
* // X: Number("float"),
|
|
129
|
+
* // Y: Number("float"),
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // Pose: {
|
|
133
|
+
* // Roll: Number("float"),
|
|
134
|
+
* // Yaw: Number("float"),
|
|
135
|
+
* // Pitch: Number("float"),
|
|
136
|
+
* // },
|
|
137
|
+
* // Quality: {
|
|
138
|
+
* // Brightness: Number("float"),
|
|
139
|
+
* // Sharpness: Number("float"),
|
|
140
|
+
* // },
|
|
141
|
+
* // Emotions: [
|
|
142
|
+
* // {
|
|
143
|
+
* // Type: "HAPPY" || "SAD" || "ANGRY" || "CONFUSED" || "DISGUSTED" || "SURPRISED" || "CALM" || "UNKNOWN" || "FEAR",
|
|
144
|
+
* // Confidence: Number("float"),
|
|
145
|
+
* // },
|
|
146
|
+
* // ],
|
|
147
|
+
* // Smile: {
|
|
148
|
+
* // Value: true || false,
|
|
149
|
+
* // Confidence: Number("float"),
|
|
150
|
+
* // },
|
|
151
|
+
* // },
|
|
152
|
+
* // ],
|
|
153
|
+
* // OrientationCorrection: "ROTATE_0" || "ROTATE_90" || "ROTATE_180" || "ROTATE_270",
|
|
154
|
+
* // };
|
|
155
|
+
*
|
|
67
156
|
* ```
|
|
68
157
|
*
|
|
69
158
|
* @param RecognizeCelebritiesCommandInput - {@link RecognizeCelebritiesCommandInput}
|
|
@@ -101,6 +190,8 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
|
|
|
101
190
|
* @throws {@link ThrottlingException} (server fault)
|
|
102
191
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
103
192
|
*
|
|
193
|
+
* @throws {@link RekognitionServiceException}
|
|
194
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
104
195
|
*
|
|
105
196
|
*/
|
|
106
197
|
export declare class RecognizeCelebritiesCommand extends $Command<RecognizeCelebritiesCommandInput, RecognizeCelebritiesCommandOutput, RekognitionClientResolvedConfig> {
|
|
@@ -78,6 +78,35 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
|
|
|
78
78
|
* };
|
|
79
79
|
* const command = new SearchFacesByImageCommand(input);
|
|
80
80
|
* const response = await client.send(command);
|
|
81
|
+
* // { // SearchFacesByImageResponse
|
|
82
|
+
* // SearchedFaceBoundingBox: { // BoundingBox
|
|
83
|
+
* // Width: Number("float"),
|
|
84
|
+
* // Height: Number("float"),
|
|
85
|
+
* // Left: Number("float"),
|
|
86
|
+
* // Top: Number("float"),
|
|
87
|
+
* // },
|
|
88
|
+
* // SearchedFaceConfidence: Number("float"),
|
|
89
|
+
* // FaceMatches: [ // FaceMatchList
|
|
90
|
+
* // { // FaceMatch
|
|
91
|
+
* // Similarity: Number("float"),
|
|
92
|
+
* // Face: { // Face
|
|
93
|
+
* // FaceId: "STRING_VALUE",
|
|
94
|
+
* // BoundingBox: {
|
|
95
|
+
* // Width: Number("float"),
|
|
96
|
+
* // Height: Number("float"),
|
|
97
|
+
* // Left: Number("float"),
|
|
98
|
+
* // Top: Number("float"),
|
|
99
|
+
* // },
|
|
100
|
+
* // ImageId: "STRING_VALUE",
|
|
101
|
+
* // ExternalImageId: "STRING_VALUE",
|
|
102
|
+
* // Confidence: Number("float"),
|
|
103
|
+
* // IndexFacesModelVersion: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // FaceModelVersion: "STRING_VALUE",
|
|
108
|
+
* // };
|
|
109
|
+
*
|
|
81
110
|
* ```
|
|
82
111
|
*
|
|
83
112
|
* @param SearchFacesByImageCommandInput - {@link SearchFacesByImageCommandInput}
|
|
@@ -118,6 +147,8 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
|
|
|
118
147
|
* @throws {@link ThrottlingException} (server fault)
|
|
119
148
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
120
149
|
*
|
|
150
|
+
* @throws {@link RekognitionServiceException}
|
|
151
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
121
152
|
*
|
|
122
153
|
* @example To search for faces matching a supplied image
|
|
123
154
|
* ```javascript
|
|
@@ -49,6 +49,29 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
|
|
|
49
49
|
* };
|
|
50
50
|
* const command = new SearchFacesCommand(input);
|
|
51
51
|
* const response = await client.send(command);
|
|
52
|
+
* // { // SearchFacesResponse
|
|
53
|
+
* // SearchedFaceId: "STRING_VALUE",
|
|
54
|
+
* // FaceMatches: [ // FaceMatchList
|
|
55
|
+
* // { // FaceMatch
|
|
56
|
+
* // Similarity: Number("float"),
|
|
57
|
+
* // Face: { // Face
|
|
58
|
+
* // FaceId: "STRING_VALUE",
|
|
59
|
+
* // BoundingBox: { // BoundingBox
|
|
60
|
+
* // Width: Number("float"),
|
|
61
|
+
* // Height: Number("float"),
|
|
62
|
+
* // Left: Number("float"),
|
|
63
|
+
* // Top: Number("float"),
|
|
64
|
+
* // },
|
|
65
|
+
* // ImageId: "STRING_VALUE",
|
|
66
|
+
* // ExternalImageId: "STRING_VALUE",
|
|
67
|
+
* // Confidence: Number("float"),
|
|
68
|
+
* // IndexFacesModelVersion: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // FaceModelVersion: "STRING_VALUE",
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
52
75
|
* ```
|
|
53
76
|
*
|
|
54
77
|
* @param SearchFacesCommandInput - {@link SearchFacesCommandInput}
|
|
@@ -77,6 +100,8 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
|
|
|
77
100
|
* @throws {@link ThrottlingException} (server fault)
|
|
78
101
|
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
79
102
|
*
|
|
103
|
+
* @throws {@link RekognitionServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
80
105
|
*
|
|
81
106
|
* @example To delete a face
|
|
82
107
|
* ```javascript
|