@aws-sdk/client-rekognition 3.312.0 → 3.316.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-cjs/Rekognition.js +69 -910
- package/dist-cjs/protocols/Aws_json1_1.js +979 -2546
- package/dist-es/Rekognition.js +69 -910
- package/dist-es/protocols/Aws_json1_1.js +980 -2547
- package/dist-types/Rekognition.d.ts +396 -1510
- package/dist-types/ts3.4/Rekognition.d.ts +4 -1
- package/package.json +6 -6
|
@@ -65,1838 +65,724 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
65
65
|
import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } from "./commands/UpdateDatasetEntriesCommand";
|
|
66
66
|
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
67
67
|
import { RekognitionClient } from "./RekognitionClient";
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
72
|
-
* Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
|
|
73
|
-
* parameters, and common errors.</p>
|
|
74
|
-
* <p>
|
|
75
|
-
* <b>Amazon Rekognition Image</b>
|
|
76
|
-
* </p>
|
|
77
|
-
* <ul>
|
|
78
|
-
* <li>
|
|
79
|
-
* <p>
|
|
80
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html">CompareFaces</a>
|
|
81
|
-
* </p>
|
|
82
|
-
* </li>
|
|
83
|
-
* <li>
|
|
84
|
-
* <p>
|
|
85
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html">CreateCollection</a>
|
|
86
|
-
* </p>
|
|
87
|
-
* </li>
|
|
88
|
-
* <li>
|
|
89
|
-
* <p>
|
|
90
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html">DeleteCollection</a>
|
|
91
|
-
* </p>
|
|
92
|
-
* </li>
|
|
93
|
-
* <li>
|
|
94
|
-
* <p>
|
|
95
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html">DeleteFaces</a>
|
|
96
|
-
* </p>
|
|
97
|
-
* </li>
|
|
98
|
-
* <li>
|
|
99
|
-
* <p>
|
|
100
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html">DescribeCollection</a>
|
|
101
|
-
* </p>
|
|
102
|
-
* </li>
|
|
103
|
-
* <li>
|
|
104
|
-
* <p>
|
|
105
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html">DetectFaces</a>
|
|
106
|
-
* </p>
|
|
107
|
-
* </li>
|
|
108
|
-
* <li>
|
|
109
|
-
* <p>
|
|
110
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html">DetectLabels</a>
|
|
111
|
-
* </p>
|
|
112
|
-
* </li>
|
|
113
|
-
* <li>
|
|
114
|
-
* <p>
|
|
115
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html">DetectModerationLabels</a>
|
|
116
|
-
* </p>
|
|
117
|
-
* </li>
|
|
118
|
-
* <li>
|
|
119
|
-
* <p>
|
|
120
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html">DetectProtectiveEquipment</a>
|
|
121
|
-
* </p>
|
|
122
|
-
* </li>
|
|
123
|
-
* <li>
|
|
124
|
-
* <p>
|
|
125
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html">DetectText</a>
|
|
126
|
-
* </p>
|
|
127
|
-
* </li>
|
|
128
|
-
* <li>
|
|
129
|
-
* <p>
|
|
130
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html">GetCelebrityInfo</a>
|
|
131
|
-
* </p>
|
|
132
|
-
* </li>
|
|
133
|
-
* <li>
|
|
134
|
-
* <p>
|
|
135
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
|
|
136
|
-
* </p>
|
|
137
|
-
* </li>
|
|
138
|
-
* <li>
|
|
139
|
-
* <p>
|
|
140
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html">ListCollections</a>
|
|
141
|
-
* </p>
|
|
142
|
-
* </li>
|
|
143
|
-
* <li>
|
|
144
|
-
* <p>
|
|
145
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
|
|
146
|
-
* </p>
|
|
147
|
-
* </li>
|
|
148
|
-
* <li>
|
|
149
|
-
* <p>
|
|
150
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html">RecognizeCelebrities</a>
|
|
151
|
-
* </p>
|
|
152
|
-
* </li>
|
|
153
|
-
* <li>
|
|
154
|
-
* <p>
|
|
155
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html">SearchFaces</a>
|
|
156
|
-
* </p>
|
|
157
|
-
* </li>
|
|
158
|
-
* <li>
|
|
159
|
-
* <p>
|
|
160
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html">SearchFacesByImage</a>
|
|
161
|
-
* </p>
|
|
162
|
-
* </li>
|
|
163
|
-
* </ul>
|
|
164
|
-
* <p>
|
|
165
|
-
* <b>Amazon Rekognition Custom Labels</b>
|
|
166
|
-
* </p>
|
|
167
|
-
* <ul>
|
|
168
|
-
* <li>
|
|
169
|
-
* <p>
|
|
170
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html">CopyProjectVersion</a>
|
|
171
|
-
* </p>
|
|
172
|
-
* </li>
|
|
173
|
-
* <li>
|
|
174
|
-
* <p>
|
|
175
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html">CreateDataset</a>
|
|
176
|
-
* </p>
|
|
177
|
-
* </li>
|
|
178
|
-
* <li>
|
|
179
|
-
* <p>
|
|
180
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html">CreateProject</a>
|
|
181
|
-
* </p>
|
|
182
|
-
* </li>
|
|
183
|
-
* <li>
|
|
184
|
-
* <p>
|
|
185
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html">CreateProjectVersion</a>
|
|
186
|
-
* </p>
|
|
187
|
-
* </li>
|
|
188
|
-
* <li>
|
|
189
|
-
* <p>
|
|
190
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html">DeleteDataset</a>
|
|
191
|
-
* </p>
|
|
192
|
-
* </li>
|
|
193
|
-
* <li>
|
|
194
|
-
* <p>
|
|
195
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html">DeleteProject</a>
|
|
196
|
-
* </p>
|
|
197
|
-
* </li>
|
|
198
|
-
* <li>
|
|
199
|
-
* <p>
|
|
200
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html">DeleteProjectPolicy</a>
|
|
201
|
-
* </p>
|
|
202
|
-
* </li>
|
|
203
|
-
* <li>
|
|
204
|
-
* <p>
|
|
205
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html">DeleteProjectVersion</a>
|
|
206
|
-
* </p>
|
|
207
|
-
* </li>
|
|
208
|
-
* <li>
|
|
209
|
-
* <p>
|
|
210
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html">DescribeDataset</a>
|
|
211
|
-
* </p>
|
|
212
|
-
* </li>
|
|
213
|
-
* <li>
|
|
214
|
-
* <p>
|
|
215
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html">DescribeProjects</a>
|
|
216
|
-
* </p>
|
|
217
|
-
* </li>
|
|
218
|
-
* <li>
|
|
219
|
-
* <p>
|
|
220
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html">DescribeProjectVersions</a>
|
|
221
|
-
* </p>
|
|
222
|
-
* </li>
|
|
223
|
-
* <li>
|
|
224
|
-
* <p>
|
|
225
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html">DetectCustomLabels</a>
|
|
226
|
-
* </p>
|
|
227
|
-
* </li>
|
|
228
|
-
* <li>
|
|
229
|
-
* <p>
|
|
230
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html">DistributeDatasetEntries</a>
|
|
231
|
-
* </p>
|
|
232
|
-
* </li>
|
|
233
|
-
* <li>
|
|
234
|
-
* <p>
|
|
235
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html">ListDatasetEntries</a>
|
|
236
|
-
* </p>
|
|
237
|
-
* </li>
|
|
238
|
-
* <li>
|
|
239
|
-
* <p>
|
|
240
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html">ListDatasetLabels</a>
|
|
241
|
-
* </p>
|
|
242
|
-
* </li>
|
|
243
|
-
* <li>
|
|
244
|
-
* <p>
|
|
245
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html">ListProjectPolicies</a>
|
|
246
|
-
* </p>
|
|
247
|
-
* </li>
|
|
248
|
-
* <li>
|
|
249
|
-
* <p>
|
|
250
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html">PutProjectPolicy</a>
|
|
251
|
-
* </p>
|
|
252
|
-
* </li>
|
|
253
|
-
* <li>
|
|
254
|
-
* <p>
|
|
255
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html">StartProjectVersion</a>
|
|
256
|
-
* </p>
|
|
257
|
-
* </li>
|
|
258
|
-
* <li>
|
|
259
|
-
* <p>
|
|
260
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html">StopProjectVersion</a>
|
|
261
|
-
* </p>
|
|
262
|
-
* </li>
|
|
263
|
-
* <li>
|
|
264
|
-
* <p>
|
|
265
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html">UpdateDatasetEntries</a>
|
|
266
|
-
* </p>
|
|
267
|
-
* </li>
|
|
268
|
-
* </ul>
|
|
269
|
-
* <p>
|
|
270
|
-
* <b>Amazon Rekognition Video Stored Video</b>
|
|
271
|
-
* </p>
|
|
272
|
-
* <ul>
|
|
273
|
-
* <li>
|
|
274
|
-
* <p>
|
|
275
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html">GetCelebrityRecognition</a>
|
|
276
|
-
* </p>
|
|
277
|
-
* </li>
|
|
278
|
-
* <li>
|
|
279
|
-
* <p>
|
|
280
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html">GetContentModeration</a>
|
|
281
|
-
* </p>
|
|
282
|
-
* </li>
|
|
283
|
-
* <li>
|
|
284
|
-
* <p>
|
|
285
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html">GetFaceDetection</a>
|
|
286
|
-
* </p>
|
|
287
|
-
* </li>
|
|
288
|
-
* <li>
|
|
289
|
-
* <p>
|
|
290
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html">GetFaceSearch</a>
|
|
291
|
-
* </p>
|
|
292
|
-
* </li>
|
|
293
|
-
* <li>
|
|
294
|
-
* <p>
|
|
295
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html">GetLabelDetection</a>
|
|
296
|
-
* </p>
|
|
297
|
-
* </li>
|
|
298
|
-
* <li>
|
|
299
|
-
* <p>
|
|
300
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html">GetPersonTracking</a>
|
|
301
|
-
* </p>
|
|
302
|
-
* </li>
|
|
303
|
-
* <li>
|
|
304
|
-
* <p>
|
|
305
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html">GetSegmentDetection</a>
|
|
306
|
-
* </p>
|
|
307
|
-
* </li>
|
|
308
|
-
* <li>
|
|
309
|
-
* <p>
|
|
310
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html">GetTextDetection</a>
|
|
311
|
-
* </p>
|
|
312
|
-
* </li>
|
|
313
|
-
* <li>
|
|
314
|
-
* <p>
|
|
315
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html">StartCelebrityRecognition</a>
|
|
316
|
-
* </p>
|
|
317
|
-
* </li>
|
|
318
|
-
* <li>
|
|
319
|
-
* <p>
|
|
320
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html">StartContentModeration</a>
|
|
321
|
-
* </p>
|
|
322
|
-
* </li>
|
|
323
|
-
* <li>
|
|
324
|
-
* <p>
|
|
325
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html">StartFaceDetection</a>
|
|
326
|
-
* </p>
|
|
327
|
-
* </li>
|
|
328
|
-
* <li>
|
|
329
|
-
* <p>
|
|
330
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html">StartFaceSearch</a>
|
|
331
|
-
* </p>
|
|
332
|
-
* </li>
|
|
333
|
-
* <li>
|
|
334
|
-
* <p>
|
|
335
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html">StartLabelDetection</a>
|
|
336
|
-
* </p>
|
|
337
|
-
* </li>
|
|
338
|
-
* <li>
|
|
339
|
-
* <p>
|
|
340
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html">StartPersonTracking</a>
|
|
341
|
-
* </p>
|
|
342
|
-
* </li>
|
|
343
|
-
* <li>
|
|
344
|
-
* <p>
|
|
345
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html">StartSegmentDetection</a>
|
|
346
|
-
* </p>
|
|
347
|
-
* </li>
|
|
348
|
-
* <li>
|
|
349
|
-
* <p>
|
|
350
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html">StartTextDetection</a>
|
|
351
|
-
* </p>
|
|
352
|
-
* </li>
|
|
353
|
-
* </ul>
|
|
354
|
-
* <p>
|
|
355
|
-
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
356
|
-
* </p>
|
|
357
|
-
* <ul>
|
|
358
|
-
* <li>
|
|
359
|
-
* <p>
|
|
360
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html">CreateStreamProcessor</a>
|
|
361
|
-
* </p>
|
|
362
|
-
* </li>
|
|
363
|
-
* <li>
|
|
364
|
-
* <p>
|
|
365
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html">DeleteStreamProcessor</a>
|
|
366
|
-
* </p>
|
|
367
|
-
* </li>
|
|
368
|
-
* <li>
|
|
369
|
-
* <p>
|
|
370
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html">DescribeStreamProcessor</a>
|
|
371
|
-
* </p>
|
|
372
|
-
* </li>
|
|
373
|
-
* <li>
|
|
374
|
-
* <p>
|
|
375
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html">ListStreamProcessors</a>
|
|
376
|
-
* </p>
|
|
377
|
-
* </li>
|
|
378
|
-
* <li>
|
|
379
|
-
* <p>
|
|
380
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html">StartStreamProcessor</a>
|
|
381
|
-
* </p>
|
|
382
|
-
* </li>
|
|
383
|
-
* <li>
|
|
384
|
-
* <p>
|
|
385
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html">StopStreamProcessor</a>
|
|
386
|
-
* </p>
|
|
387
|
-
* </li>
|
|
388
|
-
* <li>
|
|
389
|
-
* <p>
|
|
390
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html">UpdateStreamProcessor</a>
|
|
391
|
-
* </p>
|
|
392
|
-
* </li>
|
|
393
|
-
* </ul>
|
|
394
|
-
*/
|
|
395
|
-
export declare class Rekognition extends RekognitionClient {
|
|
396
|
-
/**
|
|
397
|
-
* @public
|
|
398
|
-
* <p>Compares a face in the <i>source</i> input image with each of the 100
|
|
399
|
-
* largest faces detected in the <i>target</i> input image. </p>
|
|
400
|
-
* <p> If the source image contains multiple faces, the service detects the largest face and
|
|
401
|
-
* compares it with each face detected in the target image. </p>
|
|
402
|
-
* <note>
|
|
403
|
-
* <p>CompareFaces uses machine learning algorithms, which are probabilistic. A false negative
|
|
404
|
-
* is an incorrect prediction that a face in the target image has a low similarity confidence
|
|
405
|
-
* score when compared to the face in the source image. To reduce the probability of false
|
|
406
|
-
* negatives, we recommend that you compare the target image against multiple source images. If
|
|
407
|
-
* you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's
|
|
408
|
-
* rights, privacy, or access to services, we recommend that you pass the result to a human for
|
|
409
|
-
* review and further validation before taking action.</p>
|
|
410
|
-
* </note>
|
|
411
|
-
* <p>You pass the input and target images either as base64-encoded image bytes or as
|
|
412
|
-
* references to images in an Amazon S3 bucket. If you use the
|
|
413
|
-
* AWS
|
|
414
|
-
* CLI to call Amazon Rekognition operations, passing image bytes isn't
|
|
415
|
-
* supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
416
|
-
* <p>In response, the operation returns an array of face matches ordered by similarity score
|
|
417
|
-
* in descending order. For each face match, the response provides a bounding box of the face,
|
|
418
|
-
* facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and
|
|
419
|
-
* confidence value (indicating the level of confidence that the bounding box contains a face).
|
|
420
|
-
* The response also provides a similarity score, which indicates how closely the faces match. </p>
|
|
421
|
-
* <note>
|
|
422
|
-
* <p>By default, only faces with a similarity score of greater than or equal to 80% are
|
|
423
|
-
* returned in the response. You can change this value by specifying the
|
|
424
|
-
* <code>SimilarityThreshold</code> parameter.</p>
|
|
425
|
-
* </note>
|
|
426
|
-
* <p>
|
|
427
|
-
* <code>CompareFaces</code> also returns an array of faces that don't match the source
|
|
428
|
-
* image. For each face, it returns a bounding box, confidence value, landmarks, pose details,
|
|
429
|
-
* and quality. The response also returns information about the face in the source image,
|
|
430
|
-
* including the bounding box of the face and confidence value.</p>
|
|
431
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
432
|
-
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
433
|
-
* cases. Use <code>QualityFilter</code> to set the quality bar by specifying <code>LOW</code>,
|
|
434
|
-
* <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter detected faces,
|
|
435
|
-
* specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
|
|
436
|
-
* <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns
|
|
437
|
-
* orientation information for the source and target images. Use these values to display the
|
|
438
|
-
* images with the correct image orientation.</p>
|
|
439
|
-
* <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
|
|
440
|
-
* returns an <code>InvalidParameterException</code> error. </p>
|
|
441
|
-
* <note>
|
|
442
|
-
* <p> This is a stateless API operation. That is, data returned by this operation doesn't
|
|
443
|
-
* persist.</p>
|
|
444
|
-
* </note>
|
|
445
|
-
* <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
|
|
446
|
-
* Guide.</p>
|
|
447
|
-
* <p>This operation requires permissions to perform the
|
|
448
|
-
* <code>rekognition:CompareFaces</code> action.</p>
|
|
68
|
+
export interface Rekognition {
|
|
69
|
+
/**
|
|
70
|
+
* @see {@link CompareFacesCommand}
|
|
449
71
|
*/
|
|
450
72
|
compareFaces(args: CompareFacesCommandInput, options?: __HttpHandlerOptions): Promise<CompareFacesCommandOutput>;
|
|
451
73
|
compareFaces(args: CompareFacesCommandInput, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
452
74
|
compareFaces(args: CompareFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CompareFacesCommandOutput) => void): void;
|
|
453
75
|
/**
|
|
454
|
-
* @
|
|
455
|
-
* <p>Copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project. The source and
|
|
456
|
-
* destination projects can be in different AWS accounts but must be in the same AWS Region.
|
|
457
|
-
* You can't copy a model to another AWS service.
|
|
458
|
-
*
|
|
459
|
-
* </p>
|
|
460
|
-
* <p>To copy a model version to a different AWS account, you need to create a resource-based policy known as a
|
|
461
|
-
* <i>project policy</i>. You attach the project policy to the
|
|
462
|
-
* source project by calling <a>PutProjectPolicy</a>. The project policy
|
|
463
|
-
* gives permission to copy the model version from a trusting AWS account to a trusted account.</p>
|
|
464
|
-
* <p>For more information creating and attaching a project policy, see Attaching a project policy (SDK)
|
|
465
|
-
* in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
|
|
466
|
-
* </p>
|
|
467
|
-
* <p>If you are copying a model version to a project in the same AWS account, you don't need to create a project policy.</p>
|
|
468
|
-
* <note>
|
|
469
|
-
* <p>To copy a model, the destination project, source project, and source model version must already exist.</p>
|
|
470
|
-
* </note>
|
|
471
|
-
* <p>Copying a model version takes a while to complete. To get the current status, call <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the
|
|
472
|
-
* <a>ProjectVersionDescription</a> object. The copy operation has finished when
|
|
473
|
-
* the value of <code>Status</code> is <code>COPYING_COMPLETED</code>.</p>
|
|
474
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CopyProjectVersion</code> action.</p>
|
|
76
|
+
* @see {@link CopyProjectVersionCommand}
|
|
475
77
|
*/
|
|
476
78
|
copyProjectVersion(args: CopyProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<CopyProjectVersionCommandOutput>;
|
|
477
79
|
copyProjectVersion(args: CopyProjectVersionCommandInput, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void): void;
|
|
478
80
|
copyProjectVersion(args: CopyProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void): void;
|
|
479
81
|
/**
|
|
480
|
-
* @
|
|
481
|
-
* <p>Creates a collection in an AWS Region. You can add faces to the collection using the
|
|
482
|
-
* <a>IndexFaces</a> operation. </p>
|
|
483
|
-
* <p>For example, you might create collections, one for each of your application users. A
|
|
484
|
-
* user can then index faces using the <code>IndexFaces</code> operation and persist results in a
|
|
485
|
-
* specific collection. Then, a user can search the collection for faces in the user-specific
|
|
486
|
-
* container. </p>
|
|
487
|
-
* <p>When you create a collection, it is associated with the latest version of the face model
|
|
488
|
-
* version.</p>
|
|
489
|
-
* <note>
|
|
490
|
-
* <p>Collection names are case-sensitive.</p>
|
|
491
|
-
* </note>
|
|
492
|
-
* <p>This operation requires permissions to perform the
|
|
493
|
-
* <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you
|
|
494
|
-
* also require permission to perform the <code>rekognition:TagResource</code>
|
|
495
|
-
* operation.</p>
|
|
82
|
+
* @see {@link CreateCollectionCommand}
|
|
496
83
|
*/
|
|
497
84
|
createCollection(args: CreateCollectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateCollectionCommandOutput>;
|
|
498
85
|
createCollection(args: CreateCollectionCommandInput, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
499
86
|
createCollection(args: CreateCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateCollectionCommandOutput) => void): void;
|
|
500
87
|
/**
|
|
501
|
-
* @
|
|
502
|
-
* <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
|
|
503
|
-
* an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
|
|
504
|
-
* <p>To create a training dataset for a project, specify <code>train</code> for the value of
|
|
505
|
-
* <code>DatasetType</code>. To create the test dataset for a project,
|
|
506
|
-
* specify <code>test</code> for the value of <code>DatasetType</code>.
|
|
507
|
-
* </p>
|
|
508
|
-
* <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset.
|
|
509
|
-
* Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> to check the
|
|
510
|
-
* current status. The dataset created successfully if the value of <code>Status</code> is
|
|
511
|
-
* <code>CREATE_COMPLETE</code>. </p>
|
|
512
|
-
* <p>To check if any non-terminal errors occurred, call <a>ListDatasetEntries</a>
|
|
513
|
-
* and check for the presence of <code>errors</code> lists in the JSON Lines.</p>
|
|
514
|
-
* <p>Dataset creation fails if a terminal error occurs (<code>Status</code> = <code>CREATE_FAILED</code>).
|
|
515
|
-
* Currently, you can't access the terminal error information.
|
|
516
|
-
*
|
|
517
|
-
* </p>
|
|
518
|
-
* <p>For more information, see Creating dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.</p>
|
|
519
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateDataset</code> action.
|
|
520
|
-
* If you want to copy an existing dataset, you also require permission to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
|
|
88
|
+
* @see {@link CreateDatasetCommand}
|
|
521
89
|
*/
|
|
522
90
|
createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
|
|
523
91
|
createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
524
92
|
createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
|
|
525
93
|
/**
|
|
526
|
-
* @
|
|
527
|
-
* <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>,
|
|
528
|
-
* which you can use to start streaming Face Liveness video and get the results for a Face
|
|
529
|
-
* Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter
|
|
530
|
-
* to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and
|
|
531
|
-
* audit images. You can use <code>AuditImagesLimit</code> to limit of audit images returned.
|
|
532
|
-
* This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based
|
|
533
|
-
* on the duration of the selfie-video. </p>
|
|
94
|
+
* @see {@link CreateFaceLivenessSessionCommand}
|
|
534
95
|
*/
|
|
535
96
|
createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaceLivenessSessionCommandOutput>;
|
|
536
97
|
createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void): void;
|
|
537
98
|
createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void): void;
|
|
538
99
|
/**
|
|
539
|
-
* @
|
|
540
|
-
* <p>Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions)
|
|
541
|
-
* that you use to create and manage Amazon Rekognition Custom Labels models. </p>
|
|
542
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProject</code> action.</p>
|
|
100
|
+
* @see {@link CreateProjectCommand}
|
|
543
101
|
*/
|
|
544
102
|
createProject(args: CreateProjectCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectCommandOutput>;
|
|
545
103
|
createProject(args: CreateProjectCommandInput, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
546
104
|
createProject(args: CreateProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectCommandOutput) => void): void;
|
|
547
105
|
/**
|
|
548
|
-
* @
|
|
549
|
-
* <p>Creates a new version of a model and begins training.
|
|
550
|
-
* Models are managed as part of an Amazon Rekognition Custom Labels project.
|
|
551
|
-
* The response from <code>CreateProjectVersion</code>
|
|
552
|
-
* is an Amazon Resource Name (ARN) for the version of the model. </p>
|
|
553
|
-
* <p>Training uses the training and test datasets associated with the project.
|
|
554
|
-
* For more information, see Creating training and test dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
|
|
555
|
-
* </p>
|
|
556
|
-
* <note>
|
|
557
|
-
* <p>You can train a model in a project that doesn't have associated datasets by specifying manifest files in the
|
|
558
|
-
* <code>TrainingData</code> and <code>TestingData</code> fields.
|
|
559
|
-
* </p>
|
|
560
|
-
* <p>If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates
|
|
561
|
-
* the datasets for you using the most recent manifest files. You can no longer train
|
|
562
|
-
* a model version for the project by specifying manifest files. </p>
|
|
563
|
-
* <p>Instead of training with a project without associated datasets,
|
|
564
|
-
* we recommend that you use the manifest
|
|
565
|
-
* files to create training and test datasets for the project.</p>
|
|
566
|
-
* </note>
|
|
567
|
-
* <p>Training takes a while to complete. You can get the current status by calling
|
|
568
|
-
* <a>DescribeProjectVersions</a>. Training completed successfully if
|
|
569
|
-
* the value of the <code>Status</code> field is <code>TRAINING_COMPLETED</code>.</p>
|
|
570
|
-
* <p>If training
|
|
571
|
-
* fails, see Debugging a failed model training in the <i>Amazon Rekognition Custom Labels</i> developer guide. </p>
|
|
572
|
-
* <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
|
|
573
|
-
* get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model
|
|
574
|
-
* in the <i>Amazon Rekognition Custom Labels</i> developers guide.
|
|
575
|
-
* </p>
|
|
576
|
-
* <p>After evaluating the model, you start the model
|
|
577
|
-
* by calling <a>StartProjectVersion</a>.</p>
|
|
578
|
-
* <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
|
|
106
|
+
* @see {@link CreateProjectVersionCommand}
|
|
579
107
|
*/
|
|
580
108
|
createProjectVersion(args: CreateProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<CreateProjectVersionCommandOutput>;
|
|
581
109
|
createProjectVersion(args: CreateProjectVersionCommandInput, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
582
110
|
createProjectVersion(args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
583
111
|
/**
|
|
584
|
-
* @
|
|
585
|
-
* <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.</p>
|
|
586
|
-
* <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
|
|
587
|
-
* <ul>
|
|
588
|
-
* <li>
|
|
589
|
-
* <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream
|
|
590
|
-
* (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream for receiving
|
|
591
|
-
* the output. You must use the <code>FaceSearch</code> option in
|
|
592
|
-
* <code>Settings</code>, specifying the collection that contains the faces you
|
|
593
|
-
* want to recognize. After you have finished analyzing a streaming video, use
|
|
594
|
-
* <a>StopStreamProcessor</a> to stop processing.</p>
|
|
595
|
-
* </li>
|
|
596
|
-
* <li>
|
|
597
|
-
* <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream
|
|
598
|
-
* (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
|
|
599
|
-
* Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS
|
|
600
|
-
* key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want
|
|
601
|
-
* to detect by using the <code>ConnectedHome</code> option in settings, and
|
|
602
|
-
* selecting one of the following: <code>PERSON</code>, <code>PET</code>,
|
|
603
|
-
* <code>PACKAGE</code>, <code>ALL</code> You can also specify where in the
|
|
604
|
-
* frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>. When
|
|
605
|
-
* you run the <a>StartStreamProcessor</a> operation on a label
|
|
606
|
-
* detection stream processor, you input start and stop information to determine
|
|
607
|
-
* the length of the processing time.</p>
|
|
608
|
-
* </li>
|
|
609
|
-
* </ul>
|
|
610
|
-
* <p>
|
|
611
|
-
* Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
|
|
612
|
-
* to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
|
|
613
|
-
* the <code>Name</code> field. </p>
|
|
614
|
-
* <p>This operation requires permissions to perform the
|
|
615
|
-
* <code>rekognition:CreateStreamProcessor</code> action. If you want to tag your stream processor, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
|
|
112
|
+
* @see {@link CreateStreamProcessorCommand}
|
|
616
113
|
*/
|
|
617
114
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<CreateStreamProcessorCommandOutput>;
|
|
618
115
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
619
116
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
620
117
|
/**
|
|
621
|
-
* @
|
|
622
|
-
* <p>Deletes the specified collection. Note that this operation removes all faces in the
|
|
623
|
-
* collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
|
|
624
|
-
* collection</a>.</p>
|
|
625
|
-
* <p>This operation requires permissions to perform the
|
|
626
|
-
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
118
|
+
* @see {@link DeleteCollectionCommand}
|
|
627
119
|
*/
|
|
628
120
|
deleteCollection(args: DeleteCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteCollectionCommandOutput>;
|
|
629
121
|
deleteCollection(args: DeleteCollectionCommandInput, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
630
122
|
deleteCollection(args: DeleteCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteCollectionCommandOutput) => void): void;
|
|
631
123
|
/**
|
|
632
|
-
* @
|
|
633
|
-
* <p>Deletes an existing Amazon Rekognition Custom Labels dataset.
|
|
634
|
-
* Deleting a dataset might take while. Use <a>DescribeDataset</a> to check the
|
|
635
|
-
* current status. The dataset is still deleting if the value of <code>Status</code> is
|
|
636
|
-
* <code>DELETE_IN_PROGRESS</code>. If you try to access the dataset after it is deleted, you get
|
|
637
|
-
* a <code>ResourceNotFoundException</code> exception.
|
|
638
|
-
*
|
|
639
|
-
* </p>
|
|
640
|
-
* <p>You can't delete a dataset while it is creating (<code>Status</code> = <code>CREATE_IN_PROGRESS</code>)
|
|
641
|
-
* or if the dataset is updating (<code>Status</code> = <code>UPDATE_IN_PROGRESS</code>).</p>
|
|
642
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DeleteDataset</code> action.</p>
|
|
124
|
+
* @see {@link DeleteDatasetCommand}
|
|
643
125
|
*/
|
|
644
126
|
deleteDataset(args: DeleteDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDatasetCommandOutput>;
|
|
645
127
|
deleteDataset(args: DeleteDatasetCommandInput, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
646
128
|
deleteDataset(args: DeleteDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDatasetCommandOutput) => void): void;
|
|
647
129
|
/**
|
|
648
|
-
* @
|
|
649
|
-
* <p>Deletes faces from a collection. You specify a collection ID and an array of face IDs
|
|
650
|
-
* to remove from the collection.</p>
|
|
651
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DeleteFaces</code>
|
|
652
|
-
* action.</p>
|
|
130
|
+
* @see {@link DeleteFacesCommand}
|
|
653
131
|
*/
|
|
654
132
|
deleteFaces(args: DeleteFacesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFacesCommandOutput>;
|
|
655
133
|
deleteFaces(args: DeleteFacesCommandInput, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
656
134
|
deleteFaces(args: DeleteFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFacesCommandOutput) => void): void;
|
|
657
135
|
/**
|
|
658
|
-
* @
|
|
659
|
-
* <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
|
|
660
|
-
* with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
|
|
661
|
-
* <p>
|
|
662
|
-
* <code>DeleteProject</code> is an asynchronous operation. To check if the project is
|
|
663
|
-
* deleted, call <a>DescribeProjects</a>. The project is deleted when the project
|
|
664
|
-
* no longer appears in the response. Be aware that deleting a given project will also delete
|
|
665
|
-
* any <code>ProjectPolicies</code> associated with that project.</p>
|
|
666
|
-
* <p>This operation requires permissions to perform the
|
|
667
|
-
* <code>rekognition:DeleteProject</code> action. </p>
|
|
136
|
+
* @see {@link DeleteProjectCommand}
|
|
668
137
|
*/
|
|
669
138
|
deleteProject(args: DeleteProjectCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectCommandOutput>;
|
|
670
139
|
deleteProject(args: DeleteProjectCommandInput, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
671
140
|
deleteProject(args: DeleteProjectCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectCommandOutput) => void): void;
|
|
672
141
|
/**
|
|
673
|
-
* @
|
|
674
|
-
* <p>Deletes an existing project policy.</p>
|
|
675
|
-
* <p>To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. To attach a project policy to a project, call <a>PutProjectPolicy</a>.</p>
|
|
676
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DeleteProjectPolicy</code> action.</p>
|
|
142
|
+
* @see {@link DeleteProjectPolicyCommand}
|
|
677
143
|
*/
|
|
678
144
|
deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectPolicyCommandOutput>;
|
|
679
145
|
deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void): void;
|
|
680
146
|
deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void): void;
|
|
681
147
|
/**
|
|
682
|
-
* @
|
|
683
|
-
* <p>Deletes an Amazon Rekognition Custom Labels model. </p>
|
|
684
|
-
* <p>You can't delete a model if it is running or if it is training.
|
|
685
|
-
* To check the status of a model, use the <code>Status</code> field returned
|
|
686
|
-
* from <a>DescribeProjectVersions</a>.
|
|
687
|
-
* To stop a running model call <a>StopProjectVersion</a>. If the model
|
|
688
|
-
* is training, wait until it finishes.</p>
|
|
689
|
-
* <p>This operation requires permissions to perform the
|
|
690
|
-
* <code>rekognition:DeleteProjectVersion</code> action. </p>
|
|
148
|
+
* @see {@link DeleteProjectVersionCommand}
|
|
691
149
|
*/
|
|
692
150
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectVersionCommandOutput>;
|
|
693
151
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
694
152
|
deleteProjectVersion(args: DeleteProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProjectVersionCommandOutput) => void): void;
|
|
695
153
|
/**
|
|
696
|
-
* @
|
|
697
|
-
* <p>Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with
|
|
698
|
-
* <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>.</p>
|
|
154
|
+
* @see {@link DeleteStreamProcessorCommand}
|
|
699
155
|
*/
|
|
700
156
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStreamProcessorCommandOutput>;
|
|
701
157
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
702
158
|
deleteStreamProcessor(args: DeleteStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamProcessorCommandOutput) => void): void;
|
|
703
159
|
/**
|
|
704
|
-
* @
|
|
705
|
-
* <p>Describes the specified collection. You can use <code>DescribeCollection</code> to get
|
|
706
|
-
* information, such as the number of faces indexed into a collection and the version of the
|
|
707
|
-
* model used by the collection for face detection.</p>
|
|
708
|
-
* <p>For more information, see Describing a Collection in the
|
|
709
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
160
|
+
* @see {@link DescribeCollectionCommand}
|
|
710
161
|
*/
|
|
711
162
|
describeCollection(args: DescribeCollectionCommandInput, options?: __HttpHandlerOptions): Promise<DescribeCollectionCommandOutput>;
|
|
712
163
|
describeCollection(args: DescribeCollectionCommandInput, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
713
164
|
describeCollection(args: DescribeCollectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeCollectionCommandOutput) => void): void;
|
|
714
165
|
/**
|
|
715
|
-
* @
|
|
716
|
-
* <p>
|
|
717
|
-
* Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and
|
|
718
|
-
* statistics about the images and labels in a dataset.
|
|
719
|
-
* </p>
|
|
720
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DescribeDataset</code> action.</p>
|
|
166
|
+
* @see {@link DescribeDatasetCommand}
|
|
721
167
|
*/
|
|
722
168
|
describeDataset(args: DescribeDatasetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDatasetCommandOutput>;
|
|
723
169
|
describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
724
170
|
describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
|
|
725
171
|
/**
|
|
726
|
-
* @
|
|
727
|
-
* <p>Gets information about your Amazon Rekognition Custom Labels projects. </p>
|
|
728
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
|
|
172
|
+
* @see {@link DescribeProjectsCommand}
|
|
729
173
|
*/
|
|
730
174
|
describeProjects(args: DescribeProjectsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProjectsCommandOutput>;
|
|
731
175
|
describeProjects(args: DescribeProjectsCommandInput, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
732
176
|
describeProjects(args: DescribeProjectsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectsCommandOutput) => void): void;
|
|
733
177
|
/**
|
|
734
|
-
* @
|
|
735
|
-
* <p>Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You
|
|
736
|
-
* can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
|
|
737
|
-
* you don't specify a value, descriptions for all model versions in the project are returned.</p>
|
|
738
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>
|
|
739
|
-
* action.</p>
|
|
178
|
+
* @see {@link DescribeProjectVersionsCommand}
|
|
740
179
|
*/
|
|
741
180
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeProjectVersionsCommandOutput>;
|
|
742
181
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
743
182
|
describeProjectVersions(args: DescribeProjectVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeProjectVersionsCommandOutput) => void): void;
|
|
744
183
|
/**
|
|
745
|
-
* @
|
|
746
|
-
* <p>Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed,
|
|
747
|
-
* and the current status of the stream processor.</p>
|
|
184
|
+
* @see {@link DescribeStreamProcessorCommand}
|
|
748
185
|
*/
|
|
749
186
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStreamProcessorCommandOutput>;
|
|
750
187
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
751
188
|
describeStreamProcessor(args: DescribeStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStreamProcessorCommandOutput) => void): void;
|
|
752
189
|
/**
|
|
753
|
-
* @
|
|
754
|
-
* <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
|
|
755
|
-
* <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
|
|
756
|
-
* parameter. </p>
|
|
757
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
758
|
-
* an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing
|
|
759
|
-
* image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
760
|
-
* <p> For each object that the model version detects on an image, the API returns a
|
|
761
|
-
* (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).
|
|
762
|
-
* Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
|
|
763
|
-
* of confidence that the image contains the object (<code>Confidence</code>), and
|
|
764
|
-
* object location information, if it exists, for the label on the image (<code>Geometry</code>). </p>
|
|
765
|
-
* <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
|
|
766
|
-
* <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
|
|
767
|
-
* the specified value.
|
|
768
|
-
*
|
|
769
|
-
* The value of <code>MinConfidence</code> maps to the assumed threshold values
|
|
770
|
-
* created during training. For more information, see <i>Assumed threshold</i>
|
|
771
|
-
* in the Amazon Rekognition Custom Labels Developer Guide.
|
|
772
|
-
* Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of
|
|
773
|
-
* <code>MinConfidence</code> normalizes the threshold value to a percentage value (0-100). Confidence
|
|
774
|
-
* responses from <code>DetectCustomLabels</code> are also returned as a percentage.
|
|
775
|
-
* You can use <code>MinConfidence</code> to change the precision and recall or your model.
|
|
776
|
-
* For more information, see
|
|
777
|
-
* <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
|
|
778
|
-
* <p>If you don't specify a value for <code>MinConfidence</code>, <code>DetectCustomLabels</code>
|
|
779
|
-
* returns labels based on the assumed threshold of each label.</p>
|
|
780
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
781
|
-
* data.</p>
|
|
782
|
-
* <p>This operation requires permissions to perform the
|
|
783
|
-
* <code>rekognition:DetectCustomLabels</code> action. </p>
|
|
784
|
-
* <p>For more information, see
|
|
785
|
-
* <i>Analyzing an image</i> in the Amazon Rekognition Custom Labels Developer Guide. </p>
|
|
190
|
+
* @see {@link DetectCustomLabelsCommand}
|
|
786
191
|
*/
|
|
787
192
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectCustomLabelsCommandOutput>;
|
|
788
193
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
789
194
|
detectCustomLabels(args: DetectCustomLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectCustomLabelsCommandOutput) => void): void;
|
|
790
195
|
/**
|
|
791
|
-
* @
|
|
792
|
-
* <p>Detects faces within an image that is provided as input.</p>
|
|
793
|
-
* <p>
|
|
794
|
-
* <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
|
|
795
|
-
* detected, the operation returns face details. These details include a bounding box of the
|
|
796
|
-
* face, a confidence value (that the bounding box contains a face), and a fixed set of
|
|
797
|
-
* attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of
|
|
798
|
-
* beard, sunglasses, and so on. </p>
|
|
799
|
-
* <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
|
|
800
|
-
* obscured faces, the algorithm might not detect the faces or might detect faces with lower
|
|
801
|
-
* confidence. </p>
|
|
802
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
803
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
804
|
-
* passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
805
|
-
* <note>
|
|
806
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any
|
|
807
|
-
* data.</p>
|
|
808
|
-
* </note>
|
|
809
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code>
|
|
810
|
-
* action. </p>
|
|
196
|
+
* @see {@link DetectFacesCommand}
|
|
811
197
|
*/
|
|
812
198
|
detectFaces(args: DetectFacesCommandInput, options?: __HttpHandlerOptions): Promise<DetectFacesCommandOutput>;
|
|
813
199
|
detectFaces(args: DetectFacesCommandInput, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
814
200
|
detectFaces(args: DetectFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectFacesCommandOutput) => void): void;
|
|
815
201
|
/**
|
|
816
|
-
* @
|
|
817
|
-
* <p>Detects instances of real-world entities within an image (JPEG or PNG) provided as
|
|
818
|
-
* input. This includes objects like flower, tree, and table; events like wedding, graduation,
|
|
819
|
-
* and birthday party; and concepts like landscape, evening, and nature. </p>
|
|
820
|
-
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the
|
|
821
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
822
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
|
|
823
|
-
* an Amazon S3 bucket. If you use the
|
|
824
|
-
* AWS
|
|
825
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
826
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
827
|
-
* <p>
|
|
828
|
-
* <b>Optional Parameters</b>
|
|
829
|
-
* </p>
|
|
830
|
-
* <p>You can specify one or both of the <code>GENERAL_LABELS</code> and
|
|
831
|
-
* <code>IMAGE_PROPERTIES</code> feature types when calling the DetectLabels API. Including
|
|
832
|
-
* <code>GENERAL_LABELS</code> will ensure the response includes the labels detected in the
|
|
833
|
-
* input image, while including <code>IMAGE_PROPERTIES </code>will ensure the response includes
|
|
834
|
-
* information about the image quality and color.</p>
|
|
835
|
-
* <p>When using <code>GENERAL_LABELS</code> and/or <code>IMAGE_PROPERTIES</code> you can
|
|
836
|
-
* provide filtering criteria to the Settings parameter. You can filter with sets of individual
|
|
837
|
-
* labels or with label categories. You can specify inclusive filters, exclusive filters, or a
|
|
838
|
-
* combination of inclusive and exclusive filters. For more information on filtering see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html">Detecting
|
|
839
|
-
* Labels in an Image</a>.</p>
|
|
840
|
-
* <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
|
|
841
|
-
* labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to
|
|
842
|
-
* limit the number of labels returned. The default and upper limit is 1000 labels.</p>
|
|
843
|
-
* <p>
|
|
844
|
-
* <b>Response Elements</b>
|
|
845
|
-
* </p>
|
|
846
|
-
* <p> For each object, scene, and concept the API returns one or more labels. The API
|
|
847
|
-
* returns the following types of information about labels:</p>
|
|
848
|
-
* <ul>
|
|
849
|
-
* <li>
|
|
850
|
-
* <p> Name - The name of the detected label. </p>
|
|
851
|
-
* </li>
|
|
852
|
-
* <li>
|
|
853
|
-
* <p> Confidence - The level of confidence in the label assigned to a detected object.
|
|
854
|
-
* </p>
|
|
855
|
-
* </li>
|
|
856
|
-
* <li>
|
|
857
|
-
* <p> Parents - The ancestor labels for a detected label. DetectLabels returns a
|
|
858
|
-
* hierarchical taxonomy of detected labels. For example, a detected car might be assigned
|
|
859
|
-
* the label car. The label car has two parent labels: Vehicle (its parent) and
|
|
860
|
-
* Transportation (its grandparent). The response includes the all ancestors for a label,
|
|
861
|
-
* where every ancestor is a unique label. In the previous example, Car, Vehicle, and
|
|
862
|
-
* Transportation are returned as unique labels in the response. </p>
|
|
863
|
-
* </li>
|
|
864
|
-
* <li>
|
|
865
|
-
* <p> Aliases - Possible Aliases for the label. </p>
|
|
866
|
-
* </li>
|
|
867
|
-
* <li>
|
|
868
|
-
* <p> Categories - The label categories that the detected label belongs to. </p>
|
|
869
|
-
* </li>
|
|
870
|
-
* <li>
|
|
871
|
-
* <p> BoundingBox — Bounding boxes are described for all instances of detected common
|
|
872
|
-
* object labels, returned in an array of Instance objects. An Instance object contains a
|
|
873
|
-
* BoundingBox object, describing the location of the label on the input image. It also
|
|
874
|
-
* includes the confidence for the accuracy of the detected bounding box. </p>
|
|
875
|
-
* </li>
|
|
876
|
-
* </ul>
|
|
877
|
-
* <p> The API returns the following information regarding the image, as part of the
|
|
878
|
-
* ImageProperties structure:</p>
|
|
879
|
-
* <ul>
|
|
880
|
-
* <li>
|
|
881
|
-
* <p>Quality - Information about the Sharpness, Brightness, and Contrast of the input
|
|
882
|
-
* image, scored between 0 to 100. Image quality is returned for the entire image, as well as
|
|
883
|
-
* the background and the foreground. </p>
|
|
884
|
-
* </li>
|
|
885
|
-
* <li>
|
|
886
|
-
* <p>Dominant Color - An array of the dominant colors in the image. </p>
|
|
887
|
-
* </li>
|
|
888
|
-
* <li>
|
|
889
|
-
* <p>Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground. </p>
|
|
890
|
-
* </li>
|
|
891
|
-
* <li>
|
|
892
|
-
* <p>Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.</p>
|
|
893
|
-
* </li>
|
|
894
|
-
* </ul>
|
|
895
|
-
* <p>The list of returned labels will include at least one label for every detected object,
|
|
896
|
-
* along with information about that label. In the following example, suppose the input image has
|
|
897
|
-
* a lighthouse, the sea, and a rock. The response includes all three labels, one for each
|
|
898
|
-
* object, as well as the confidence in the label:</p>
|
|
899
|
-
* <p>
|
|
900
|
-
* <code>\{Name: lighthouse, Confidence: 98.4629\}</code>
|
|
901
|
-
* </p>
|
|
902
|
-
* <p>
|
|
903
|
-
* <code>\{Name: rock,Confidence: 79.2097\}</code>
|
|
904
|
-
* </p>
|
|
905
|
-
* <p>
|
|
906
|
-
* <code> \{Name: sea,Confidence: 75.061\}</code>
|
|
907
|
-
* </p>
|
|
908
|
-
* <p>The list of labels can include multiple labels for the same object. For example, if the
|
|
909
|
-
* input image shows a flower (for example, a tulip), the operation might return the following
|
|
910
|
-
* three labels. </p>
|
|
911
|
-
* <p>
|
|
912
|
-
* <code>\{Name: flower,Confidence: 99.0562\}</code>
|
|
913
|
-
* </p>
|
|
914
|
-
* <p>
|
|
915
|
-
* <code>\{Name: plant,Confidence: 99.0562\}</code>
|
|
916
|
-
* </p>
|
|
917
|
-
* <p>
|
|
918
|
-
* <code>\{Name: tulip,Confidence: 99.0562\}</code>
|
|
919
|
-
* </p>
|
|
920
|
-
* <p>In this example, the detection algorithm more precisely identifies the flower as a
|
|
921
|
-
* tulip.</p>
|
|
922
|
-
* <note>
|
|
923
|
-
* <p>If the object detected is a person, the operation doesn't provide the same facial
|
|
924
|
-
* details that the <a>DetectFaces</a> operation provides.</p>
|
|
925
|
-
* </note>
|
|
926
|
-
* <p>This is a stateless API operation that doesn't return any data.</p>
|
|
927
|
-
* <p>This operation requires permissions to perform the
|
|
928
|
-
* <code>rekognition:DetectLabels</code> action. </p>
|
|
202
|
+
* @see {@link DetectLabelsCommand}
|
|
929
203
|
*/
|
|
930
204
|
detectLabels(args: DetectLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectLabelsCommandOutput>;
|
|
931
205
|
detectLabels(args: DetectLabelsCommandInput, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
932
206
|
detectLabels(args: DetectLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectLabelsCommandOutput) => void): void;
|
|
933
207
|
/**
|
|
934
|
-
* @
|
|
935
|
-
* <p>Detects unsafe content in a specified JPEG or PNG format image. Use
|
|
936
|
-
* <code>DetectModerationLabels</code> to moderate images depending on your requirements. For
|
|
937
|
-
* example, you might want to filter images that contain nudity, but not images containing
|
|
938
|
-
* suggestive content.</p>
|
|
939
|
-
* <p>To filter images, use the labels returned by <code>DetectModerationLabels</code> to
|
|
940
|
-
* determine which types of content are appropriate.</p>
|
|
941
|
-
* <p>For information about moderation labels, see Detecting Unsafe Content in the
|
|
942
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
943
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
944
|
-
* image in an Amazon S3 bucket. If you use the
|
|
945
|
-
* AWS
|
|
946
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
947
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
208
|
+
* @see {@link DetectModerationLabelsCommand}
|
|
948
209
|
*/
|
|
949
210
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, options?: __HttpHandlerOptions): Promise<DetectModerationLabelsCommandOutput>;
|
|
950
211
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
951
212
|
detectModerationLabels(args: DetectModerationLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectModerationLabelsCommandOutput) => void): void;
|
|
952
213
|
/**
|
|
953
|
-
* @
|
|
954
|
-
* <p>Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the
|
|
955
|
-
* following types of PPE.</p>
|
|
956
|
-
* <ul>
|
|
957
|
-
* <li>
|
|
958
|
-
* <p>Face cover</p>
|
|
959
|
-
* </li>
|
|
960
|
-
* <li>
|
|
961
|
-
* <p>Hand cover</p>
|
|
962
|
-
* </li>
|
|
963
|
-
* <li>
|
|
964
|
-
* <p>Head cover</p>
|
|
965
|
-
* </li>
|
|
966
|
-
* </ul>
|
|
967
|
-
* <p>You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket.
|
|
968
|
-
* The image must be either a PNG or JPG formatted file. </p>
|
|
969
|
-
* <p>
|
|
970
|
-
* <code>DetectProtectiveEquipment</code> detects PPE worn by up to 15 persons detected in an image.</p>
|
|
971
|
-
* <p>For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand).
|
|
972
|
-
* For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE
|
|
973
|
-
* covers the body part. The API returns the confidence it has in each detection
|
|
974
|
-
* (person, PPE, body part and body part coverage). It also returns a bounding box (<a>BoundingBox</a>) for each detected
|
|
975
|
-
* person and each detected item of PPE. </p>
|
|
976
|
-
* <p>You can optionally request a summary of detected PPE items with the <code>SummarizationAttributes</code> input parameter.
|
|
977
|
-
* The summary provides the following information. </p>
|
|
978
|
-
* <ul>
|
|
979
|
-
* <li>
|
|
980
|
-
* <p>The persons detected as wearing all of the types of PPE that you specify.</p>
|
|
981
|
-
* </li>
|
|
982
|
-
* <li>
|
|
983
|
-
* <p>The persons detected as not wearing all of the types PPE that you specify.</p>
|
|
984
|
-
* </li>
|
|
985
|
-
* <li>
|
|
986
|
-
* <p>The persons detected where PPE adornment could not be determined. </p>
|
|
987
|
-
* </li>
|
|
988
|
-
* </ul>
|
|
989
|
-
* <p>This is a stateless API operation. That is, the operation does not persist any data.</p>
|
|
990
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DetectProtectiveEquipment</code> action. </p>
|
|
214
|
+
* @see {@link DetectProtectiveEquipmentCommand}
|
|
991
215
|
*/
|
|
992
216
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options?: __HttpHandlerOptions): Promise<DetectProtectiveEquipmentCommandOutput>;
|
|
993
217
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
994
218
|
detectProtectiveEquipment(args: DetectProtectiveEquipmentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectProtectiveEquipmentCommandOutput) => void): void;
|
|
995
219
|
/**
|
|
996
|
-
* @
|
|
997
|
-
* <p>Detects text in the input image and converts it into machine-readable text.</p>
|
|
998
|
-
* <p>Pass the input image as base64-encoded image bytes or as a reference to an image in an
|
|
999
|
-
* Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a
|
|
1000
|
-
* reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not
|
|
1001
|
-
* supported. The image must be either a .png or .jpeg formatted file. </p>
|
|
1002
|
-
* <p>The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each
|
|
1003
|
-
* <code>TextDetection</code> element provides information about a single word or line of text
|
|
1004
|
-
* that was detected in the image. </p>
|
|
1005
|
-
* <p>A word is one or more script characters that are not separated by spaces.
|
|
1006
|
-
* <code>DetectText</code> can detect up to 100 words in an image.</p>
|
|
1007
|
-
* <p>A line is a string of equally spaced words. A line isn't necessarily a complete
|
|
1008
|
-
* sentence. For example, a driver's license number is detected as a line. A line ends when there
|
|
1009
|
-
* is no aligned text after it. Also, a line ends when there is a large gap between words,
|
|
1010
|
-
* relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition
|
|
1011
|
-
* may detect multiple lines in text aligned in the same direction. Periods don't represent the
|
|
1012
|
-
* end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation
|
|
1013
|
-
* returns multiple lines.</p>
|
|
1014
|
-
* <p>To determine whether a <code>TextDetection</code> element is a line of text or a word,
|
|
1015
|
-
* use the <code>TextDetection</code> object <code>Type</code> field. </p>
|
|
1016
|
-
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal
|
|
1017
|
-
* axis.</p>
|
|
1018
|
-
* <p>For more information, see Detecting text in the Amazon Rekognition Developer
|
|
1019
|
-
* Guide.</p>
|
|
220
|
+
* @see {@link DetectTextCommand}
|
|
1020
221
|
*/
|
|
1021
222
|
detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise<DetectTextCommandOutput>;
|
|
1022
223
|
detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
1023
224
|
detectText(args: DetectTextCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
1024
225
|
/**
|
|
1025
|
-
* @
|
|
1026
|
-
* <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
|
|
1027
|
-
* <code>DistributeDatasetEntries</code> moves 20% of the training dataset images to the test dataset.
|
|
1028
|
-
* An entry is a JSON Line that describes an image.
|
|
1029
|
-
* </p>
|
|
1030
|
-
* <p>You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset.
|
|
1031
|
-
* The training dataset must contain the images that you want to split. The test dataset
|
|
1032
|
-
* must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call <a>CreateDataset</a>.</p>
|
|
1033
|
-
* <p>Distributing a dataset takes a while to complete. To check the status call <code>DescribeDataset</code>. The operation
|
|
1034
|
-
* is complete when the <code>Status</code> field for the training dataset and the test dataset is <code>UPDATE_COMPLETE</code>.
|
|
1035
|
-
* If the dataset split fails, the value of <code>Status</code> is <code>UPDATE_FAILED</code>.</p>
|
|
1036
|
-
* <p>This operation requires permissions to perform the <code>rekognition:DistributeDatasetEntries</code> action.</p>
|
|
226
|
+
* @see {@link DistributeDatasetEntriesCommand}
|
|
1037
227
|
*/
|
|
1038
228
|
distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, options?: __HttpHandlerOptions): Promise<DistributeDatasetEntriesCommandOutput>;
|
|
1039
229
|
distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void): void;
|
|
1040
230
|
distributeDatasetEntries(args: DistributeDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DistributeDatasetEntriesCommandOutput) => void): void;
|
|
1041
231
|
/**
|
|
1042
|
-
* @
|
|
1043
|
-
* <p>Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.
|
|
1044
|
-
* The additional information is returned as an array of URLs. If there is no additional
|
|
1045
|
-
* information about the celebrity, this list is empty.</p>
|
|
1046
|
-
* <p>For more information, see Getting information about a celebrity in the
|
|
1047
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
1048
|
-
* <p>This operation requires permissions to perform the
|
|
1049
|
-
* <code>rekognition:GetCelebrityInfo</code> action. </p>
|
|
232
|
+
* @see {@link GetCelebrityInfoCommand}
|
|
1050
233
|
*/
|
|
1051
234
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, options?: __HttpHandlerOptions): Promise<GetCelebrityInfoCommandOutput>;
|
|
1052
235
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
1053
236
|
getCelebrityInfo(args: GetCelebrityInfoCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityInfoCommandOutput) => void): void;
|
|
1054
237
|
/**
|
|
1055
|
-
* @
|
|
1056
|
-
* <p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
|
|
1057
|
-
* <a>StartCelebrityRecognition</a>.</p>
|
|
1058
|
-
* <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a
|
|
1059
|
-
* call to <a>StartCelebrityRecognition</a> which returns a job identifier
|
|
1060
|
-
* (<code>JobId</code>). </p>
|
|
1061
|
-
* <p>When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion
|
|
1062
|
-
* status to the Amazon Simple Notification Service topic registered in the initial call to
|
|
1063
|
-
* <code>StartCelebrityRecognition</code>. To get the results of the celebrity recognition
|
|
1064
|
-
* analysis, first check that the status value published to the Amazon SNS topic is
|
|
1065
|
-
* <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job
|
|
1066
|
-
* identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
|
|
1067
|
-
* <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
|
|
1068
|
-
* <p>
|
|
1069
|
-
* <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they
|
|
1070
|
-
* are detected in an array (<code>Celebrities</code>) of <a>CelebrityRecognition</a>
|
|
1071
|
-
* objects. Each <code>CelebrityRecognition</code>
|
|
1072
|
-
* contains information about the celebrity in a <a>CelebrityDetail</a> object and the
|
|
1073
|
-
* time, <code>Timestamp</code>, the celebrity was detected. This <a>CelebrityDetail</a> object stores information about the detected celebrity's face
|
|
1074
|
-
* attributes, a face bounding box, known gender, the celebrity's name, and a confidence
|
|
1075
|
-
* estimate.</p>
|
|
1076
|
-
* <note>
|
|
1077
|
-
* <p>
|
|
1078
|
-
* <code>GetCelebrityRecognition</code> only returns the default facial
|
|
1079
|
-
* attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>,
|
|
1080
|
-
* <code>Pose</code>, and <code>Quality</code>). The <code>BoundingBox</code> field only
|
|
1081
|
-
* applies to the detected face instance. The other facial attributes listed in the
|
|
1082
|
-
* <code>Face</code> object of the following response syntax are not returned. For more
|
|
1083
|
-
* information, see FaceDetail in the Amazon Rekognition Developer Guide. </p>
|
|
1084
|
-
* </note>
|
|
1085
|
-
* <p>By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video).
|
|
1086
|
-
* You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter.</p>
|
|
1087
|
-
* <p>The <code>CelebrityDetail</code> object includes the celebrity identifer and additional information urls. If you don't store
|
|
1088
|
-
* the additional information urls, you can get them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer.</p>
|
|
1089
|
-
* <p>No information is returned for faces not recognized as celebrities.</p>
|
|
1090
|
-
* <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
|
|
1091
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a
|
|
1092
|
-
* pagination token for getting the next set of results. To get the next page of results, call <code>GetCelebrityDetection</code>
|
|
1093
|
-
* and populate the <code>NextToken</code> request parameter with the token
|
|
1094
|
-
* value returned from the previous call to <code>GetCelebrityRecognition</code>.</p>
|
|
238
|
+
* @see {@link GetCelebrityRecognitionCommand}
|
|
1095
239
|
*/
|
|
1096
240
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<GetCelebrityRecognitionCommandOutput>;
|
|
1097
241
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
1098
242
|
getCelebrityRecognition(args: GetCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCelebrityRecognitionCommandOutput) => void): void;
|
|
1099
243
|
/**
|
|
1100
|
-
* @
|
|
1101
|
-
* <p>Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by
|
|
1102
|
-
* <a>StartContentModeration</a>. For a list of moderation labels in Amazon Rekognition, see
|
|
1103
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
1104
|
-
* <p>Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling
|
|
1105
|
-
* <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>).
|
|
1106
|
-
* When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
|
|
1107
|
-
* topic registered in the initial call to <code>StartContentModeration</code>.
|
|
1108
|
-
* To get the results of the content analysis, first check that the status value published to the Amazon SNS
|
|
1109
|
-
* topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier
|
|
1110
|
-
* (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
|
|
1111
|
-
* <p>For more information, see Working with Stored Videos in the
|
|
1112
|
-
* Amazon Rekognition Devlopers Guide.</p>
|
|
1113
|
-
* <p>
|
|
1114
|
-
* <code>GetContentModeration</code> returns detected inappropriate, unwanted, or offensive content moderation labels,
|
|
1115
|
-
* and the time they are detected, in an array, <code>ModerationLabels</code>, of
|
|
1116
|
-
* <a>ContentModerationDetection</a> objects.
|
|
1117
|
-
* </p>
|
|
1118
|
-
* <p>By default, the moderated labels are returned sorted by time, in milliseconds from the start of the
|
|
1119
|
-
* video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code>
|
|
1120
|
-
* input parameter. </p>
|
|
1121
|
-
* <p>Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit
|
|
1122
|
-
* the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than
|
|
1123
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a
|
|
1124
|
-
* pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code>
|
|
1125
|
-
* and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
|
|
1126
|
-
* returned from the previous call to <code>GetContentModeration</code>.</p>
|
|
1127
|
-
* <p>For more information, see moderating content in the Amazon Rekognition Developer Guide.</p>
|
|
244
|
+
* @see {@link GetContentModerationCommand}
|
|
1128
245
|
*/
|
|
1129
246
|
getContentModeration(args: GetContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<GetContentModerationCommandOutput>;
|
|
1130
247
|
getContentModeration(args: GetContentModerationCommandInput, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
1131
248
|
getContentModeration(args: GetContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
1132
249
|
/**
|
|
1133
|
-
* @
|
|
1134
|
-
* <p>Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>.</p>
|
|
1135
|
-
* <p>Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a>
|
|
1136
|
-
* which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
1137
|
-
* the Amazon Simple Notification Service topic registered in the initial call to <code>StartFaceDetection</code>. To get the results
|
|
1138
|
-
* of the face detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
1139
|
-
* If so, call <a>GetFaceDetection</a> and pass the job identifier
|
|
1140
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
|
|
1141
|
-
* <p>
|
|
1142
|
-
* <code>GetFaceDetection</code> returns an array of detected faces (<code>Faces</code>) sorted by the time the faces were detected. </p>
|
|
1143
|
-
* <p>Use MaxResults parameter to limit the number of labels returned. If there are more results than
|
|
1144
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
|
|
1145
|
-
* of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token
|
|
1146
|
-
* value returned from the previous call to <code>GetFaceDetection</code>.</p>
|
|
250
|
+
* @see {@link GetFaceDetectionCommand}
|
|
1147
251
|
*/
|
|
1148
252
|
getFaceDetection(args: GetFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceDetectionCommandOutput>;
|
|
1149
253
|
getFaceDetection(args: GetFaceDetectionCommandInput, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
1150
254
|
getFaceDetection(args: GetFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
|
|
1151
255
|
/**
|
|
1152
|
-
* @
|
|
1153
|
-
* <p>Retrieves the results of a specific Face Liveness session. It requires the
|
|
1154
|
-
* <code>sessionId</code> as input, which was created using
|
|
1155
|
-
* <code>CreateFaceLivenessSession</code>. Returns the corresponding Face Liveness confidence
|
|
1156
|
-
* score, a reference image that includes a face bounding box, and audit images that also contain
|
|
1157
|
-
* face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference
|
|
1158
|
-
* image can optionally be returned.</p>
|
|
256
|
+
* @see {@link GetFaceLivenessSessionResultsCommand}
|
|
1159
257
|
*/
|
|
1160
258
|
getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceLivenessSessionResultsCommandOutput>;
|
|
1161
259
|
getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void): void;
|
|
1162
260
|
getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void): void;
|
|
1163
261
|
/**
|
|
1164
|
-
* @
|
|
1165
|
-
* <p>Gets the face search results for Amazon Rekognition Video face search started by
|
|
1166
|
-
* <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces
|
|
1167
|
-
* of persons detected in a video. It also includes the time(s) that faces are matched in the video.</p>
|
|
1168
|
-
* <p>Face search in a video is an asynchronous operation. You start face search by calling
|
|
1169
|
-
* to <a>StartFaceSearch</a> which returns a job identifier (<code>JobId</code>).
|
|
1170
|
-
* When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
|
|
1171
|
-
* topic registered in the initial call to <code>StartFaceSearch</code>.
|
|
1172
|
-
* To get the search results, first check that the status value published to the Amazon SNS
|
|
1173
|
-
* topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier
|
|
1174
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>.</p>
|
|
1175
|
-
* <p>For more information, see Searching Faces in a Collection in the
|
|
1176
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
1177
|
-
* <p>The search results are retured in an array, <code>Persons</code>, of
|
|
1178
|
-
* <a>PersonMatch</a> objects. Each<code>PersonMatch</code> element contains
|
|
1179
|
-
* details about the matching faces in the input collection, person information (facial attributes,
|
|
1180
|
-
* bounding boxes, and person identifer)
|
|
1181
|
-
* for the matched person, and the time the person was matched in the video.</p>
|
|
1182
|
-
* <note>
|
|
1183
|
-
* <p>
|
|
1184
|
-
* <code>GetFaceSearch</code> only returns the default
|
|
1185
|
-
* facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
|
|
1186
|
-
* <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
|
|
1187
|
-
* in the <code>Face</code> object of the following response syntax are not returned. For more information,
|
|
1188
|
-
* see FaceDetail in the Amazon Rekognition Developer Guide. </p>
|
|
1189
|
-
* </note>
|
|
1190
|
-
* <p>By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the
|
|
1191
|
-
* start of the video, persons are matched.
|
|
1192
|
-
* You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input
|
|
1193
|
-
* parameter.</p>
|
|
262
|
+
* @see {@link GetFaceSearchCommand}
|
|
1194
263
|
*/
|
|
1195
264
|
getFaceSearch(args: GetFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceSearchCommandOutput>;
|
|
1196
265
|
getFaceSearch(args: GetFaceSearchCommandInput, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
1197
266
|
getFaceSearch(args: GetFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceSearchCommandOutput) => void): void;
|
|
1198
267
|
/**
|
|
1199
|
-
* @
|
|
1200
|
-
* <p>Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. </p>
|
|
1201
|
-
* <p>The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When
|
|
1202
|
-
* the label detection operation finishes, Amazon Rekognition publishes a completion status to the
|
|
1203
|
-
* Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. </p>
|
|
1204
|
-
* <p>To get the results of the label detection operation, first check that the status value
|
|
1205
|
-
* published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<code>JobId</code>) from the
|
|
1206
|
-
* initial call to <code>StartLabelDetection</code>.</p>
|
|
1207
|
-
* <p>
|
|
1208
|
-
* <code>GetLabelDetection</code> returns an array of detected labels
|
|
1209
|
-
* (<code>Labels</code>) sorted by the time the labels were detected. You can also sort by the
|
|
1210
|
-
* label name by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. If
|
|
1211
|
-
* there is no <code>NAME</code> specified, the default sort is by
|
|
1212
|
-
* timestamp.</p>
|
|
1213
|
-
* <p>You can select how results are aggregated by using the <code>AggregateBy</code> input
|
|
1214
|
-
* parameter. The default aggregation method is <code>TIMESTAMPS</code>. You can also aggregate
|
|
1215
|
-
* by <code>SEGMENTS</code>, which aggregates all instances of labels detected in a given
|
|
1216
|
-
* segment. </p>
|
|
1217
|
-
* <p>The returned Labels array may include the following attributes:</p>
|
|
1218
|
-
* <ul>
|
|
1219
|
-
* <li>
|
|
1220
|
-
* <p>Name - The name of the detected label.</p>
|
|
1221
|
-
* </li>
|
|
1222
|
-
* <li>
|
|
1223
|
-
* <p>Confidence - The level of confidence in the label assigned to a detected object. </p>
|
|
1224
|
-
* </li>
|
|
1225
|
-
* <li>
|
|
1226
|
-
* <p>Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical
|
|
1227
|
-
* taxonomy of detected labels. For example, a detected car might be assigned the label car.
|
|
1228
|
-
* The label car has two parent labels: Vehicle (its parent) and Transportation (its
|
|
1229
|
-
* grandparent). The response includes the all ancestors for a label, where every ancestor is
|
|
1230
|
-
* a unique label. In the previous example, Car, Vehicle, and Transportation are returned as
|
|
1231
|
-
* unique labels in the response. </p>
|
|
1232
|
-
* </li>
|
|
1233
|
-
* <li>
|
|
1234
|
-
* <p> Aliases - Possible Aliases for the label. </p>
|
|
1235
|
-
* </li>
|
|
1236
|
-
* <li>
|
|
1237
|
-
* <p>Categories - The label categories that the detected label belongs to.</p>
|
|
1238
|
-
* </li>
|
|
1239
|
-
* <li>
|
|
1240
|
-
* <p>BoundingBox — Bounding boxes are described for all instances of detected common object labels,
|
|
1241
|
-
* returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing
|
|
1242
|
-
* the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.</p>
|
|
1243
|
-
* </li>
|
|
1244
|
-
* <li>
|
|
1245
|
-
* <p>Timestamp - Time, in milliseconds from the start of the video, that the label was detected.
|
|
1246
|
-
* For aggregation by <code>SEGMENTS</code>, the <code>StartTimestampMillis</code>,
|
|
1247
|
-
* <code>EndTimestampMillis</code>, and <code>DurationMillis</code> structures are what
|
|
1248
|
-
* define a segment. Although the “Timestamp” structure is still returned with each label,
|
|
1249
|
-
* its value is set to be the same as <code>StartTimestampMillis</code>.</p>
|
|
1250
|
-
* </li>
|
|
1251
|
-
* </ul>
|
|
1252
|
-
* <p>Timestamp and Bounding box information are returned for detected Instances, only if
|
|
1253
|
-
* aggregation is done by <code>TIMESTAMPS</code>. If aggregating by <code>SEGMENTS</code>,
|
|
1254
|
-
* information about detected instances isn’t returned. </p>
|
|
1255
|
-
* <p>The version of the label model used for the detection is also returned.</p>
|
|
1256
|
-
* <p>
|
|
1257
|
-
* <b>Note <code>DominantColors</code> isn't returned for <code>Instances</code>,
|
|
1258
|
-
* although it is shown as part of the response in the sample seen below.</b>
|
|
1259
|
-
* </p>
|
|
1260
|
-
* <p>Use <code>MaxResults</code> parameter to limit the number of labels returned. If
|
|
1261
|
-
* there are more results than specified in <code>MaxResults</code>, the value of
|
|
1262
|
-
* <code>NextToken</code> in the operation response contains a pagination token for getting the
|
|
1263
|
-
* next set of results. To get the next page of results, call <code>GetlabelDetection</code> and
|
|
1264
|
-
* populate the <code>NextToken</code> request parameter with the token value returned from the
|
|
1265
|
-
* previous call to <code>GetLabelDetection</code>.</p>
|
|
268
|
+
* @see {@link GetLabelDetectionCommand}
|
|
1266
269
|
*/
|
|
1267
270
|
getLabelDetection(args: GetLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetLabelDetectionCommandOutput>;
|
|
1268
271
|
getLabelDetection(args: GetLabelDetectionCommandInput, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
1269
272
|
getLabelDetection(args: GetLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLabelDetectionCommandOutput) => void): void;
|
|
1270
273
|
/**
|
|
1271
|
-
* @
|
|
1272
|
-
* <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
|
|
1273
|
-
* <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
|
|
1274
|
-
* which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
|
|
1275
|
-
* the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>
|
|
1276
|
-
* <p>To get the results of the person path tracking operation, first check
|
|
1277
|
-
* that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
1278
|
-
* If so, call <a>GetPersonTracking</a> and pass the job identifier
|
|
1279
|
-
* (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>
|
|
1280
|
-
* <p>
|
|
1281
|
-
* <code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked persons and the time(s) their
|
|
1282
|
-
* paths were tracked in the video. </p>
|
|
1283
|
-
* <note>
|
|
1284
|
-
* <p>
|
|
1285
|
-
* <code>GetPersonTracking</code> only returns the default
|
|
1286
|
-
* facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
|
|
1287
|
-
* <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
|
|
1288
|
-
* in the <code>Face</code> object of the following response syntax are not returned. </p>
|
|
1289
|
-
* <p>For more information, see FaceDetail in the Amazon Rekognition Developer Guide.</p>
|
|
1290
|
-
* </note>
|
|
1291
|
-
* <p>By default, the array is sorted by the time(s) a person's path is tracked in the video.
|
|
1292
|
-
* You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter.</p>
|
|
1293
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than
|
|
1294
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
|
|
1295
|
-
* of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token
|
|
1296
|
-
* value returned from the previous call to <code>GetPersonTracking</code>.</p>
|
|
274
|
+
* @see {@link GetPersonTrackingCommand}
|
|
1297
275
|
*/
|
|
1298
276
|
getPersonTracking(args: GetPersonTrackingCommandInput, options?: __HttpHandlerOptions): Promise<GetPersonTrackingCommandOutput>;
|
|
1299
277
|
getPersonTracking(args: GetPersonTrackingCommandInput, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
1300
278
|
getPersonTracking(args: GetPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPersonTrackingCommandOutput) => void): void;
|
|
1301
279
|
/**
|
|
1302
|
-
* @
|
|
1303
|
-
* <p>Gets the segment detection results of a Amazon Rekognition Video analysis started by <a>StartSegmentDetection</a>.</p>
|
|
1304
|
-
* <p>Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by
|
|
1305
|
-
* calling <a>StartSegmentDetection</a> which returns a job identifier (<code>JobId</code>).
|
|
1306
|
-
* When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
|
|
1307
|
-
* topic registered in the initial call to <code>StartSegmentDetection</code>. To get the results
|
|
1308
|
-
* of the segment detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
1309
|
-
* if so, call <code>GetSegmentDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call
|
|
1310
|
-
* of <code>StartSegmentDetection</code>.</p>
|
|
1311
|
-
* <p>
|
|
1312
|
-
* <code>GetSegmentDetection</code> returns detected segments in an array (<code>Segments</code>)
|
|
1313
|
-
* of <a>SegmentDetection</a> objects. <code>Segments</code> is sorted by the segment types
|
|
1314
|
-
* specified in the <code>SegmentTypes</code> input parameter of <code>StartSegmentDetection</code>.
|
|
1315
|
-
* Each element of the array includes the detected segment, the precentage confidence in the acuracy
|
|
1316
|
-
* of the detected segment, the type of the segment, and the frame in which the segment was detected.</p>
|
|
1317
|
-
* <p>Use <code>SelectedSegmentTypes</code> to find out the type of segment detection requested in the
|
|
1318
|
-
* call to <code>StartSegmentDetection</code>.</p>
|
|
1319
|
-
* <p>Use the <code>MaxResults</code> parameter to limit the number of segment detections returned. If there are more results than
|
|
1320
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains
|
|
1321
|
-
* a pagination token for getting the next set of results. To get the next page of results, call <code>GetSegmentDetection</code>
|
|
1322
|
-
* and populate the <code>NextToken</code> request parameter with the token value returned from the previous
|
|
1323
|
-
* call to <code>GetSegmentDetection</code>.</p>
|
|
1324
|
-
* <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
|
|
280
|
+
* @see {@link GetSegmentDetectionCommand}
|
|
1325
281
|
*/
|
|
1326
282
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetSegmentDetectionCommandOutput>;
|
|
1327
283
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
1328
284
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
1329
285
|
/**
|
|
1330
|
-
* @
|
|
1331
|
-
* <p>Gets the text detection results of a Amazon Rekognition Video analysis started by <a>StartTextDetection</a>.</p>
|
|
1332
|
-
* <p>Text detection with Amazon Rekognition Video is an asynchronous operation. You start text detection by
|
|
1333
|
-
* calling <a>StartTextDetection</a> which returns a job identifier (<code>JobId</code>)
|
|
1334
|
-
* When the text detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service
|
|
1335
|
-
* topic registered in the initial call to <code>StartTextDetection</code>. To get the results
|
|
1336
|
-
* of the text detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>.
|
|
1337
|
-
* if so, call <code>GetTextDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call
|
|
1338
|
-
* of <code>StartLabelDetection</code>.</p>
|
|
1339
|
-
* <p>
|
|
1340
|
-
* <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by
|
|
1341
|
-
* the time the text was detected, up to 50 words per frame of video.</p>
|
|
1342
|
-
* <p>Each element of the array includes the detected text, the precentage confidence in the acuracy
|
|
1343
|
-
* of the detected text, the time the text was detected, bounding box information for where the text
|
|
1344
|
-
* was located, and unique identifiers for words and their lines.</p>
|
|
1345
|
-
* <p>Use MaxResults parameter to limit the number of text detections returned. If there are more results than
|
|
1346
|
-
* specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains
|
|
1347
|
-
* a pagination token for getting the next set of results. To get the next page of results, call <code>GetTextDetection</code>
|
|
1348
|
-
* and populate the <code>NextToken</code> request parameter with the token value returned from the previous
|
|
1349
|
-
* call to <code>GetTextDetection</code>.</p>
|
|
286
|
+
* @see {@link GetTextDetectionCommand}
|
|
1350
287
|
*/
|
|
1351
288
|
getTextDetection(args: GetTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetTextDetectionCommandOutput>;
|
|
1352
289
|
getTextDetection(args: GetTextDetectionCommandInput, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
1353
290
|
getTextDetection(args: GetTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTextDetectionCommandOutput) => void): void;
|
|
1354
291
|
/**
|
|
1355
|
-
* @
|
|
1356
|
-
* <p>Detects faces in the input image and adds them to the specified collection. </p>
|
|
1357
|
-
* <p>Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying
|
|
1358
|
-
* detection algorithm first detects the faces in the input image. For each face, the algorithm
|
|
1359
|
-
* extracts facial features into a feature vector, and stores it in the backend database.
|
|
1360
|
-
* Amazon Rekognition uses feature vectors when it performs face match and search operations using the
|
|
1361
|
-
* <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations.</p>
|
|
1362
|
-
* <p>For more information, see Adding faces to a collection in the Amazon Rekognition
|
|
1363
|
-
* Developer Guide.</p>
|
|
1364
|
-
* <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
|
|
1365
|
-
* <p>If you're using version 1.0 of the face detection model, <code>IndexFaces</code>
|
|
1366
|
-
* indexes the 15 largest faces in the input image. Later versions of the face detection model
|
|
1367
|
-
* index the 100 largest faces in the input image. </p>
|
|
1368
|
-
* <p>If you're using version 4 or later of the face model, image orientation information is not
|
|
1369
|
-
* returned in the <code>OrientationCorrection</code> field. </p>
|
|
1370
|
-
* <p>To determine which version of the model you're using, call <a>DescribeCollection</a> and supply the collection ID. You can also get the model
|
|
1371
|
-
* version from the value of <code>FaceModelVersion</code> in the response from
|
|
1372
|
-
* <code>IndexFaces</code>
|
|
1373
|
-
* </p>
|
|
1374
|
-
* <p>For more information, see Model Versioning in the Amazon Rekognition Developer
|
|
1375
|
-
* Guide.</p>
|
|
1376
|
-
* <p>If you provide the optional <code>ExternalImageId</code> for the input image you
|
|
1377
|
-
* provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the <a>ListFaces</a> operation, the response returns the external ID. You can use this
|
|
1378
|
-
* external image ID to create a client-side index to associate the faces with each image. You
|
|
1379
|
-
* can then use the index to find all faces in an image.</p>
|
|
1380
|
-
* <p>You can specify the maximum number of faces to index with the <code>MaxFaces</code> input
|
|
1381
|
-
* parameter. This is useful when you want to index the largest faces in an image and don't want
|
|
1382
|
-
* to index smaller faces, such as those belonging to people standing in the background.</p>
|
|
1383
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
1384
|
-
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
1385
|
-
* cases. By default, <code>IndexFaces</code> chooses the quality bar that's used to filter
|
|
1386
|
-
* faces. You can also explicitly choose the quality bar. Use <code>QualityFilter</code>, to set
|
|
1387
|
-
* the quality bar by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If
|
|
1388
|
-
* you do not want to filter detected faces, specify <code>NONE</code>. </p>
|
|
1389
|
-
* <note>
|
|
1390
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
1391
|
-
* model or higher. To get the version of the face model associated with a collection, call
|
|
1392
|
-
* <a>DescribeCollection</a>. </p>
|
|
1393
|
-
* </note>
|
|
1394
|
-
* <p>Information about faces detected in an image, but not indexed, is returned in an array of
|
|
1395
|
-
* <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't indexed
|
|
1396
|
-
* for reasons such as:</p>
|
|
1397
|
-
* <ul>
|
|
1398
|
-
* <li>
|
|
1399
|
-
* <p>The number of faces detected exceeds the value of the <code>MaxFaces</code> request
|
|
1400
|
-
* parameter.</p>
|
|
1401
|
-
* </li>
|
|
1402
|
-
* <li>
|
|
1403
|
-
* <p>The face is too small compared to the image dimensions.</p>
|
|
1404
|
-
* </li>
|
|
1405
|
-
* <li>
|
|
1406
|
-
* <p>The face is too blurry.</p>
|
|
1407
|
-
* </li>
|
|
1408
|
-
* <li>
|
|
1409
|
-
* <p>The image is too dark.</p>
|
|
1410
|
-
* </li>
|
|
1411
|
-
* <li>
|
|
1412
|
-
* <p>The face has an extreme pose.</p>
|
|
1413
|
-
* </li>
|
|
1414
|
-
* <li>
|
|
1415
|
-
* <p>The face doesn’t have enough detail to be suitable for face search.</p>
|
|
1416
|
-
* </li>
|
|
1417
|
-
* </ul>
|
|
1418
|
-
* <p>In response, the <code>IndexFaces</code> operation returns an array of metadata for all
|
|
1419
|
-
* detected faces, <code>FaceRecords</code>. This includes: </p>
|
|
1420
|
-
* <ul>
|
|
1421
|
-
* <li>
|
|
1422
|
-
* <p>The bounding box, <code>BoundingBox</code>, of the detected face. </p>
|
|
1423
|
-
* </li>
|
|
1424
|
-
* <li>
|
|
1425
|
-
* <p>A confidence value, <code>Confidence</code>, which indicates the confidence that the
|
|
1426
|
-
* bounding box contains a face.</p>
|
|
1427
|
-
* </li>
|
|
1428
|
-
* <li>
|
|
1429
|
-
* <p>A face ID, <code>FaceId</code>, assigned by the service for each face that's detected
|
|
1430
|
-
* and stored.</p>
|
|
1431
|
-
* </li>
|
|
1432
|
-
* <li>
|
|
1433
|
-
* <p>An image ID, <code>ImageId</code>, assigned by the service for the input image.</p>
|
|
1434
|
-
* </li>
|
|
1435
|
-
* </ul>
|
|
1436
|
-
* <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
|
|
1437
|
-
* parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
|
|
1438
|
-
* example, location of eye and mouth) and other facial attributes. If you provide the same
|
|
1439
|
-
* image, specify the same collection, and use the same external ID in the
|
|
1440
|
-
* <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
|
|
1441
|
-
* <p></p>
|
|
1442
|
-
* <p>The input image is passed either as base64-encoded image bytes, or as a reference to an
|
|
1443
|
-
* image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
|
|
1444
|
-
* passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </p>
|
|
1445
|
-
* <p>This operation requires permissions to perform the <code>rekognition:IndexFaces</code>
|
|
1446
|
-
* action.</p>
|
|
292
|
+
* @see {@link IndexFacesCommand}
|
|
1447
293
|
*/
|
|
1448
294
|
indexFaces(args: IndexFacesCommandInput, options?: __HttpHandlerOptions): Promise<IndexFacesCommandOutput>;
|
|
1449
295
|
indexFaces(args: IndexFacesCommandInput, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1450
296
|
indexFaces(args: IndexFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: IndexFacesCommandOutput) => void): void;
|
|
1451
297
|
/**
|
|
1452
|
-
* @
|
|
1453
|
-
* <p>Returns list of collection IDs in your account. If the result is truncated, the
|
|
1454
|
-
* response also provides a <code>NextToken</code> that you can use in the subsequent request to
|
|
1455
|
-
* fetch the next set of collection IDs.</p>
|
|
1456
|
-
* <p>For an example, see Listing collections in the Amazon Rekognition Developer
|
|
1457
|
-
* Guide.</p>
|
|
1458
|
-
* <p>This operation requires permissions to perform the
|
|
1459
|
-
* <code>rekognition:ListCollections</code> action.</p>
|
|
298
|
+
* @see {@link ListCollectionsCommand}
|
|
1460
299
|
*/
|
|
1461
300
|
listCollections(args: ListCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCollectionsCommandOutput>;
|
|
1462
301
|
listCollections(args: ListCollectionsCommandInput, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
1463
302
|
listCollections(args: ListCollectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListCollectionsCommandOutput) => void): void;
|
|
1464
303
|
/**
|
|
1465
|
-
* @
|
|
1466
|
-
* <p>
|
|
1467
|
-
* Lists the entries (images) within a dataset. An entry is a
|
|
1468
|
-
* JSON Line that contains the information for a single image, including
|
|
1469
|
-
* the image location, assigned labels, and object location bounding boxes. For
|
|
1470
|
-
* more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html">Creating a manifest file</a>.</p>
|
|
1471
|
-
* <p>JSON Lines in the response include information about non-terminal
|
|
1472
|
-
* errors found in the dataset.
|
|
1473
|
-
* Non terminal errors are reported in <code>errors</code> lists within each JSON Line. The
|
|
1474
|
-
* same information is reported in the training and testing validation result manifests that
|
|
1475
|
-
* Amazon Rekognition Custom Labels creates during model training.
|
|
1476
|
-
* </p>
|
|
1477
|
-
* <p>You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
|
|
1478
|
-
* </p>
|
|
1479
|
-
* <p>This operation requires permissions to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
|
|
304
|
+
* @see {@link ListDatasetEntriesCommand}
|
|
1480
305
|
*/
|
|
1481
306
|
listDatasetEntries(args: ListDatasetEntriesCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetEntriesCommandOutput>;
|
|
1482
307
|
listDatasetEntries(args: ListDatasetEntriesCommandInput, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void): void;
|
|
1483
308
|
listDatasetEntries(args: ListDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetEntriesCommandOutput) => void): void;
|
|
1484
309
|
/**
|
|
1485
|
-
* @
|
|
1486
|
-
* <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
|
|
1487
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling images</a>.
|
|
1488
|
-
* </p>
|
|
1489
|
-
* <p>
|
|
1490
|
-
* Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images
|
|
1491
|
-
* in the <i>Amazon Rekognition Custom Labels Developer Guide</i>. </p>
|
|
310
|
+
* @see {@link ListDatasetLabelsCommand}
|
|
1492
311
|
*/
|
|
1493
312
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetLabelsCommandOutput>;
|
|
1494
313
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1495
314
|
listDatasetLabels(args: ListDatasetLabelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetLabelsCommandOutput) => void): void;
|
|
1496
315
|
/**
|
|
1497
|
-
* @
|
|
1498
|
-
* <p>Returns metadata for faces in the specified collection. This metadata
|
|
1499
|
-
* includes information such as the bounding box coordinates, the confidence (that the bounding
|
|
1500
|
-
* box contains a face), and face ID. For an example, see Listing Faces in a Collection in the
|
|
1501
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
1502
|
-
* <p>This operation requires permissions to perform the <code>rekognition:ListFaces</code>
|
|
1503
|
-
* action.</p>
|
|
316
|
+
* @see {@link ListFacesCommand}
|
|
1504
317
|
*/
|
|
1505
318
|
listFaces(args: ListFacesCommandInput, options?: __HttpHandlerOptions): Promise<ListFacesCommandOutput>;
|
|
1506
319
|
listFaces(args: ListFacesCommandInput, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
1507
320
|
listFaces(args: ListFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFacesCommandOutput) => void): void;
|
|
1508
321
|
/**
|
|
1509
|
-
* @
|
|
1510
|
-
* <p>Gets a list of the project policies attached to a project.</p>
|
|
1511
|
-
* <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
|
|
1512
|
-
* <p>This operation requires permissions to perform the <code>rekognition:ListProjectPolicies</code> action.</p>
|
|
322
|
+
* @see {@link ListProjectPoliciesCommand}
|
|
1513
323
|
*/
|
|
1514
324
|
listProjectPolicies(args: ListProjectPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectPoliciesCommandOutput>;
|
|
1515
325
|
listProjectPolicies(args: ListProjectPoliciesCommandInput, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void): void;
|
|
1516
326
|
listProjectPolicies(args: ListProjectPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void): void;
|
|
1517
327
|
/**
|
|
1518
|
-
* @
|
|
1519
|
-
* <p>Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>. </p>
|
|
328
|
+
* @see {@link ListStreamProcessorsCommand}
|
|
1520
329
|
*/
|
|
1521
330
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamProcessorsCommandOutput>;
|
|
1522
331
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1523
332
|
listStreamProcessors(args: ListStreamProcessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamProcessorsCommandOutput) => void): void;
|
|
1524
333
|
/**
|
|
1525
|
-
* @
|
|
1526
|
-
* <p> Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1527
|
-
* model. </p>
|
|
1528
|
-
* <p>This operation requires permissions to perform the
|
|
1529
|
-
* <code>rekognition:ListTagsForResource</code> action. </p>
|
|
334
|
+
* @see {@link ListTagsForResourceCommand}
|
|
1530
335
|
*/
|
|
1531
336
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
1532
337
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1533
338
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1534
339
|
/**
|
|
1535
|
-
* @
|
|
1536
|
-
* <p>Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A
|
|
1537
|
-
* project policy specifies that a trusted AWS account can copy a model version from a
|
|
1538
|
-
* trusting AWS account to a project in the trusted AWS account. To copy a model version you use
|
|
1539
|
-
* the <a>CopyProjectVersion</a> operation.</p>
|
|
1540
|
-
* <p>For more information about the format of a project policy document, see Attaching a project policy (SDK)
|
|
1541
|
-
* in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
|
|
1542
|
-
* </p>
|
|
1543
|
-
* <p>The response from <code>PutProjectPolicy</code> is a revision ID for the project policy.
|
|
1544
|
-
* You can attach multiple project policies to a project. You can also update an existing
|
|
1545
|
-
* project policy by specifying the policy revision ID of the existing policy.</p>
|
|
1546
|
-
* <p>To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.
|
|
1547
|
-
* To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. </p>
|
|
1548
|
-
* <p>You copy a model version by calling <a>CopyProjectVersion</a>.</p>
|
|
1549
|
-
* <p>This operation requires permissions to perform the <code>rekognition:PutProjectPolicy</code> action.</p>
|
|
340
|
+
* @see {@link PutProjectPolicyCommand}
|
|
1550
341
|
*/
|
|
1551
342
|
putProjectPolicy(args: PutProjectPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutProjectPolicyCommandOutput>;
|
|
1552
343
|
putProjectPolicy(args: PutProjectPolicyCommandInput, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1553
344
|
putProjectPolicy(args: PutProjectPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
|
|
1554
345
|
/**
|
|
1555
|
-
* @
|
|
1556
|
-
* <p>Returns an array of celebrities recognized in the input image. For more
|
|
1557
|
-
* information, see Recognizing celebrities in the Amazon Rekognition Developer Guide. </p>
|
|
1558
|
-
* <p>
|
|
1559
|
-
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
|
|
1560
|
-
* the recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces
|
|
1561
|
-
* in the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
|
|
1562
|
-
* celebrities whose faces aren't among the largest 64 faces in the image.</p>
|
|
1563
|
-
* <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
|
|
1564
|
-
* <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity
|
|
1565
|
-
* name, ID, URL links to additional information, match confidence, and a
|
|
1566
|
-
* <code>ComparedFace</code> object that you can use to locate the celebrity's face on the
|
|
1567
|
-
* image.</p>
|
|
1568
|
-
* <p>Amazon Rekognition doesn't retain information about which images a celebrity has been recognized
|
|
1569
|
-
* in. Your application must store this information and use the <code>Celebrity</code> ID
|
|
1570
|
-
* property as a unique identifier for the celebrity. If you don't store the celebrity name or
|
|
1571
|
-
* additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the
|
|
1572
|
-
* ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a>
|
|
1573
|
-
* operation.</p>
|
|
1574
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
1575
|
-
* image in an Amazon S3 bucket. If you use the
|
|
1576
|
-
* AWS
|
|
1577
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
1578
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
1579
|
-
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition
|
|
1580
|
-
* Developer Guide.</p>
|
|
1581
|
-
* <p>This operation requires permissions to perform the
|
|
1582
|
-
* <code>rekognition:RecognizeCelebrities</code> operation.</p>
|
|
346
|
+
* @see {@link RecognizeCelebritiesCommand}
|
|
1583
347
|
*/
|
|
1584
348
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, options?: __HttpHandlerOptions): Promise<RecognizeCelebritiesCommandOutput>;
|
|
1585
349
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
1586
350
|
recognizeCelebrities(args: RecognizeCelebritiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecognizeCelebritiesCommandOutput) => void): void;
|
|
1587
351
|
/**
|
|
1588
|
-
* @
|
|
1589
|
-
* <p>For a given input face ID, searches for matching faces in the collection the face
|
|
1590
|
-
* belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with
|
|
1591
|
-
* faces in the specified collection. </p>
|
|
1592
|
-
* <note>
|
|
1593
|
-
* <p>You can also search faces without indexing faces by using the
|
|
1594
|
-
* <code>SearchFacesByImage</code> operation.</p>
|
|
1595
|
-
* </note>
|
|
1596
|
-
* <p> The operation response returns an array of faces that match, ordered by similarity
|
|
1597
|
-
* score with the highest similarity first. More specifically, it is an array of metadata for
|
|
1598
|
-
* each face match that is found. Along with the metadata, the response also includes a
|
|
1599
|
-
* <code>confidence</code> value for each face match, indicating the confidence that the
|
|
1600
|
-
* specific face matches the input face. </p>
|
|
1601
|
-
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition
|
|
1602
|
-
* Developer Guide.</p>
|
|
1603
|
-
* <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
|
|
1604
|
-
* action.</p>
|
|
352
|
+
* @see {@link SearchFacesCommand}
|
|
1605
353
|
*/
|
|
1606
354
|
searchFaces(args: SearchFacesCommandInput, options?: __HttpHandlerOptions): Promise<SearchFacesCommandOutput>;
|
|
1607
355
|
searchFaces(args: SearchFacesCommandInput, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
1608
356
|
searchFaces(args: SearchFacesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesCommandOutput) => void): void;
|
|
1609
357
|
/**
|
|
1610
|
-
* @
|
|
1611
|
-
* <p>For a given input image, first detects the largest face in the image, and then searches
|
|
1612
|
-
* the specified collection for matching faces. The operation compares the features of the input
|
|
1613
|
-
* face with faces in the specified collection. </p>
|
|
1614
|
-
* <note>
|
|
1615
|
-
* <p>To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent calls
|
|
1616
|
-
* to the <a>SearchFaces</a> operation. </p>
|
|
1617
|
-
* <p> You can also call the <code>DetectFaces</code> operation and use the bounding boxes
|
|
1618
|
-
* in the response to make face crops, which then you can pass in to the
|
|
1619
|
-
* <code>SearchFacesByImage</code> operation. </p>
|
|
1620
|
-
* </note>
|
|
1621
|
-
* <p>You pass the input image either as base64-encoded image bytes or as a reference to an
|
|
1622
|
-
* image in an Amazon S3 bucket. If you use the
|
|
1623
|
-
* AWS
|
|
1624
|
-
* CLI to call Amazon Rekognition operations, passing image bytes is not
|
|
1625
|
-
* supported. The image must be either a PNG or JPEG formatted file. </p>
|
|
1626
|
-
* <p> The response returns an array of faces that match, ordered by similarity score with
|
|
1627
|
-
* the highest similarity first. More specifically, it is an array of metadata for each face
|
|
1628
|
-
* match found. Along with the metadata, the response also includes a <code>similarity</code>
|
|
1629
|
-
* indicating how similar the face is to the input face. In the response, the operation also
|
|
1630
|
-
* returns the bounding box (and a confidence level that the bounding box contains a face) of the
|
|
1631
|
-
* face that Amazon Rekognition used for the input image. </p>
|
|
1632
|
-
* <p>If no faces are detected in the input image, <code>SearchFacesByImage</code> returns an
|
|
1633
|
-
* <code>InvalidParameterException</code> error. </p>
|
|
1634
|
-
* <p>For an example, Searching for a Face Using an Image in the Amazon Rekognition
|
|
1635
|
-
* Developer Guide.</p>
|
|
1636
|
-
* <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
|
|
1637
|
-
* that don’t meet a required quality bar. The quality bar is based on a variety of common use
|
|
1638
|
-
* cases. Use <code>QualityFilter</code> to set the quality bar for filtering by specifying
|
|
1639
|
-
* <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter
|
|
1640
|
-
* detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>.</p>
|
|
1641
|
-
* <note>
|
|
1642
|
-
* <p>To use quality filtering, you need a collection associated with version 3 of the face
|
|
1643
|
-
* model or higher. To get the version of the face model associated with a collection, call
|
|
1644
|
-
* <a>DescribeCollection</a>. </p>
|
|
1645
|
-
* </note>
|
|
1646
|
-
* <p>This operation requires permissions to perform the
|
|
1647
|
-
* <code>rekognition:SearchFacesByImage</code> action.</p>
|
|
358
|
+
* @see {@link SearchFacesByImageCommand}
|
|
1648
359
|
*/
|
|
1649
360
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options?: __HttpHandlerOptions): Promise<SearchFacesByImageCommandOutput>;
|
|
1650
361
|
searchFacesByImage(args: SearchFacesByImageCommandInput, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1651
362
|
searchFacesByImage(args: SearchFacesByImageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchFacesByImageCommandOutput) => void): void;
|
|
1652
363
|
/**
|
|
1653
|
-
* @
|
|
1654
|
-
* <p>Starts asynchronous recognition of celebrities in a stored video.</p>
|
|
1655
|
-
* <p>Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1656
|
-
* and the filename of the video.
|
|
1657
|
-
* <code>StartCelebrityRecognition</code>
|
|
1658
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
|
|
1659
|
-
* When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status
|
|
1660
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1661
|
-
* To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
|
|
1662
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
|
|
1663
|
-
* (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
|
|
1664
|
-
* <p>For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.</p>
|
|
364
|
+
* @see {@link StartCelebrityRecognitionCommand}
|
|
1665
365
|
*/
|
|
1666
366
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<StartCelebrityRecognitionCommandOutput>;
|
|
1667
367
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1668
368
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
1669
369
|
/**
|
|
1670
|
-
* @
|
|
1671
|
-
* <p> Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video. For a list of moderation labels in Amazon Rekognition, see
|
|
1672
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/moderation.html#moderation-api">Using the image and video moderation APIs</a>.</p>
|
|
1673
|
-
* <p>Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1674
|
-
* and the filename of the video. <code>StartContentModeration</code>
|
|
1675
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis.
|
|
1676
|
-
* When content analysis is finished, Amazon Rekognition Video publishes a completion status
|
|
1677
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
|
|
1678
|
-
* <p>To get the results of the content analysis, first check that the status value published to the Amazon SNS
|
|
1679
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
|
|
1680
|
-
* (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
|
|
1681
|
-
* <p>For more information, see Moderating content in the Amazon Rekognition Developer Guide.</p>
|
|
370
|
+
* @see {@link StartContentModerationCommand}
|
|
1682
371
|
*/
|
|
1683
372
|
startContentModeration(args: StartContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<StartContentModerationCommandOutput>;
|
|
1684
373
|
startContentModeration(args: StartContentModerationCommandInput, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1685
374
|
startContentModeration(args: StartContentModerationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
1686
375
|
/**
|
|
1687
|
-
* @
|
|
1688
|
-
* <p>Starts asynchronous detection of faces in a stored video.</p>
|
|
1689
|
-
* <p>Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket.
|
|
1690
|
-
* Use <a>Video</a> to specify the bucket name and the filename of the video.
|
|
1691
|
-
* <code>StartFaceDetection</code> returns a job identifier (<code>JobId</code>) that you
|
|
1692
|
-
* use to get the results of the operation.
|
|
1693
|
-
* When face detection is finished, Amazon Rekognition Video publishes a completion status
|
|
1694
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1695
|
-
* To get the results of the face detection operation, first check that the status value published to the Amazon SNS
|
|
1696
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
|
|
1697
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
|
|
1698
|
-
* <p>For more information, see Detecting faces in a stored video in the
|
|
1699
|
-
* Amazon Rekognition Developer Guide.</p>
|
|
376
|
+
* @see {@link StartFaceDetectionCommand}
|
|
1700
377
|
*/
|
|
1701
378
|
startFaceDetection(args: StartFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceDetectionCommandOutput>;
|
|
1702
379
|
startFaceDetection(args: StartFaceDetectionCommandInput, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1703
380
|
startFaceDetection(args: StartFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceDetectionCommandOutput) => void): void;
|
|
1704
381
|
/**
|
|
1705
|
-
* @
|
|
1706
|
-
* <p>Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.</p>
|
|
1707
|
-
* <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1708
|
-
* and the filename of the video. <code>StartFaceSearch</code>
|
|
1709
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed.
|
|
1710
|
-
* When searching is finished, Amazon Rekognition Video publishes a completion status
|
|
1711
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.
|
|
1712
|
-
* To get the search results, first check that the status value published to the Amazon SNS
|
|
1713
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier
|
|
1714
|
-
* (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see
|
|
1715
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html">Searching stored videos for faces</a>.
|
|
1716
|
-
* </p>
|
|
382
|
+
* @see {@link StartFaceSearchCommand}
|
|
1717
383
|
*/
|
|
1718
384
|
startFaceSearch(args: StartFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceSearchCommandOutput>;
|
|
1719
385
|
startFaceSearch(args: StartFaceSearchCommandInput, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1720
386
|
startFaceSearch(args: StartFaceSearchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
1721
387
|
/**
|
|
1722
|
-
* @
|
|
1723
|
-
* <p>Starts asynchronous detection of labels in a stored video.</p>
|
|
1724
|
-
* <p>Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities.
|
|
1725
|
-
* This includes objects like flower, tree, and table; events like
|
|
1726
|
-
* wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities
|
|
1727
|
-
* like a person getting out of a car or a person skiing.</p>
|
|
1728
|
-
* <p>The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1729
|
-
* and the filename of the video.
|
|
1730
|
-
* <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the
|
|
1731
|
-
* results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status
|
|
1732
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>.</p>
|
|
1733
|
-
* <p>To get the results of the label detection operation, first check that the status value published to the Amazon SNS
|
|
1734
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier
|
|
1735
|
-
* (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>.</p>
|
|
1736
|
-
* <p>
|
|
1737
|
-
* <i>Optional Parameters</i>
|
|
1738
|
-
* </p>
|
|
1739
|
-
* <p>
|
|
1740
|
-
* <code>StartLabelDetection</code> has the <code>GENERAL_LABELS</code> Feature applied by
|
|
1741
|
-
* default. This feature allows you to provide filtering criteria to the <code>Settings</code>
|
|
1742
|
-
* parameter. You can filter with sets of individual labels or with label categories. You can
|
|
1743
|
-
* specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive
|
|
1744
|
-
* filters. For more information on filtering, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detecting-labels-video.html">Detecting labels in a
|
|
1745
|
-
* video</a>.</p>
|
|
1746
|
-
* <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
|
|
1747
|
-
* labels returned. The default is 50.</p>
|
|
388
|
+
* @see {@link StartLabelDetectionCommand}
|
|
1748
389
|
*/
|
|
1749
390
|
startLabelDetection(args: StartLabelDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartLabelDetectionCommandOutput>;
|
|
1750
391
|
startLabelDetection(args: StartLabelDetectionCommandInput, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1751
392
|
startLabelDetection(args: StartLabelDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartLabelDetectionCommandOutput) => void): void;
|
|
1752
393
|
/**
|
|
1753
|
-
* @
|
|
1754
|
-
* <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
|
|
1755
|
-
* <p>Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
|
|
1756
|
-
* and the filename of the video. <code>StartPersonTracking</code>
|
|
1757
|
-
* returns a job identifier (<code>JobId</code>) which you use to get the results of the operation.
|
|
1758
|
-
* When label detection is finished, Amazon Rekognition publishes a completion status
|
|
1759
|
-
* to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </p>
|
|
1760
|
-
* <p>To get the results of the person detection operation, first check that the status value published to the Amazon SNS
|
|
1761
|
-
* topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier
|
|
1762
|
-
* (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>.</p>
|
|
394
|
+
* @see {@link StartPersonTrackingCommand}
|
|
1763
395
|
*/
|
|
1764
396
|
startPersonTracking(args: StartPersonTrackingCommandInput, options?: __HttpHandlerOptions): Promise<StartPersonTrackingCommandOutput>;
|
|
1765
397
|
startPersonTracking(args: StartPersonTrackingCommandInput, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1766
398
|
startPersonTracking(args: StartPersonTrackingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPersonTrackingCommandOutput) => void): void;
|
|
1767
399
|
/**
|
|
1768
|
-
* @
|
|
1769
|
-
* <p>Starts the running of the version of a model. Starting a model takes a while
|
|
1770
|
-
* to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>
|
|
1771
|
-
* <p>Once the model is running, you can detect custom labels in new images by calling
|
|
1772
|
-
* <a>DetectCustomLabels</a>.</p>
|
|
1773
|
-
* <note>
|
|
1774
|
-
* <p>You are charged for the amount of time that the model is running. To stop a running
|
|
1775
|
-
* model, call <a>StopProjectVersion</a>.</p>
|
|
1776
|
-
* </note>
|
|
1777
|
-
* <p>For more information, see <i>Running a trained Amazon Rekognition Custom Labels model</i> in the Amazon Rekognition Custom Labels Guide.</p>
|
|
1778
|
-
* <p>This operation requires permissions to perform the
|
|
1779
|
-
* <code>rekognition:StartProjectVersion</code> action.</p>
|
|
400
|
+
* @see {@link StartProjectVersionCommand}
|
|
1780
401
|
*/
|
|
1781
402
|
startProjectVersion(args: StartProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<StartProjectVersionCommandOutput>;
|
|
1782
403
|
startProjectVersion(args: StartProjectVersionCommandInput, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1783
404
|
startProjectVersion(args: StartProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartProjectVersionCommandOutput) => void): void;
|
|
1784
405
|
/**
|
|
1785
|
-
* @
|
|
1786
|
-
* <p>Starts asynchronous detection of segment detection in a stored video.</p>
|
|
1787
|
-
* <p>Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1788
|
-
* the filename of the video. <code>StartSegmentDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
1789
|
-
* the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
|
|
1790
|
-
* that you specify in <code>NotificationChannel</code>.</p>
|
|
1791
|
-
* <p>You can use the <code>Filters</code> (<a>StartSegmentDetectionFilters</a>)
|
|
1792
|
-
* input parameter to specify the minimum detection confidence returned in the response.
|
|
1793
|
-
* Within <code>Filters</code>, use <code>ShotFilter</code> (<a>StartShotDetectionFilter</a>)
|
|
1794
|
-
* to filter detected shots. Use <code>TechnicalCueFilter</code> (<a>StartTechnicalCueDetectionFilter</a>)
|
|
1795
|
-
* to filter technical cues. </p>
|
|
1796
|
-
* <p>To get the results of the segment detection operation, first check that the status value published to the Amazon SNS
|
|
1797
|
-
* topic is <code>SUCCEEDED</code>. if so, call <a>GetSegmentDetection</a> and pass the job identifier (<code>JobId</code>)
|
|
1798
|
-
* from the initial call to <code>StartSegmentDetection</code>. </p>
|
|
1799
|
-
* <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
|
|
406
|
+
* @see {@link StartSegmentDetectionCommand}
|
|
1800
407
|
*/
|
|
1801
408
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartSegmentDetectionCommandOutput>;
|
|
1802
409
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1803
410
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
1804
411
|
/**
|
|
1805
|
-
* @
|
|
1806
|
-
* <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
|
|
1807
|
-
* To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
|
|
1808
|
-
* <code>CreateStreamProcessor</code>.</p>
|
|
1809
|
-
* <p>If you are using a label detection stream processor to detect labels, you need to provide a <code>Start selector</code> and a <code>Stop selector</code> to determine the length of the stream processing time.</p>
|
|
412
|
+
* @see {@link StartStreamProcessorCommand}
|
|
1810
413
|
*/
|
|
1811
414
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamProcessorCommandOutput>;
|
|
1812
415
|
startStreamProcessor(args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1813
416
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
1814
417
|
/**
|
|
1815
|
-
* @
|
|
1816
|
-
* <p>Starts asynchronous detection of text in a stored video.</p>
|
|
1817
|
-
* <p>Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and
|
|
1818
|
-
* the filename of the video. <code>StartTextDetection</code> returns a job identifier (<code>JobId</code>) which you use to get
|
|
1819
|
-
* the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic
|
|
1820
|
-
* that you specify in <code>NotificationChannel</code>.</p>
|
|
1821
|
-
* <p>To get the results of the text detection operation, first check that the status value published to the Amazon SNS
|
|
1822
|
-
* topic is <code>SUCCEEDED</code>. if so, call <a>GetTextDetection</a> and pass the job identifier (<code>JobId</code>)
|
|
1823
|
-
* from the initial call to <code>StartTextDetection</code>. </p>
|
|
418
|
+
* @see {@link StartTextDetectionCommand}
|
|
1824
419
|
*/
|
|
1825
420
|
startTextDetection(args: StartTextDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartTextDetectionCommandOutput>;
|
|
1826
421
|
startTextDetection(args: StartTextDetectionCommandInput, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1827
422
|
startTextDetection(args: StartTextDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTextDetectionCommandOutput) => void): void;
|
|
1828
423
|
/**
|
|
1829
|
-
* @
|
|
1830
|
-
* <p>Stops a running model. The operation might take a while to complete. To
|
|
1831
|
-
* check the current status, call <a>DescribeProjectVersions</a>. </p>
|
|
1832
|
-
* <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
|
|
424
|
+
* @see {@link StopProjectVersionCommand}
|
|
1833
425
|
*/
|
|
1834
426
|
stopProjectVersion(args: StopProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<StopProjectVersionCommandOutput>;
|
|
1835
427
|
stopProjectVersion(args: StopProjectVersionCommandInput, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1836
428
|
stopProjectVersion(args: StopProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
|
|
1837
429
|
/**
|
|
1838
|
-
* @
|
|
1839
|
-
* <p>Stops a running stream processor that was created by <a>CreateStreamProcessor</a>.</p>
|
|
430
|
+
* @see {@link StopStreamProcessorCommand}
|
|
1840
431
|
*/
|
|
1841
432
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StopStreamProcessorCommandOutput>;
|
|
1842
433
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1843
434
|
stopStreamProcessor(args: StopStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamProcessorCommandOutput) => void): void;
|
|
1844
435
|
/**
|
|
1845
|
-
* @
|
|
1846
|
-
* <p> Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom
|
|
1847
|
-
* Labels model. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
|
|
1848
|
-
* Resources</a>. </p>
|
|
1849
|
-
* <p>This operation requires permissions to perform the <code>rekognition:TagResource</code>
|
|
1850
|
-
* action. </p>
|
|
436
|
+
* @see {@link TagResourceCommand}
|
|
1851
437
|
*/
|
|
1852
438
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1853
439
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1854
440
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1855
441
|
/**
|
|
1856
|
-
* @
|
|
1857
|
-
* <p> Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels
|
|
1858
|
-
* model. </p>
|
|
1859
|
-
* <p>This operation requires permissions to perform the
|
|
1860
|
-
* <code>rekognition:UntagResource</code> action. </p>
|
|
442
|
+
* @see {@link UntagResourceCommand}
|
|
1861
443
|
*/
|
|
1862
444
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1863
445
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1864
446
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1865
447
|
/**
|
|
1866
|
-
* @
|
|
1867
|
-
* <p>Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the
|
|
1868
|
-
* information for a single image, including
|
|
1869
|
-
* the image location, assigned labels, and object location bounding boxes. For more information,
|
|
1870
|
-
* see Image-Level labels in manifest files and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
|
|
1871
|
-
* </p>
|
|
1872
|
-
* <p>If the <code>source-ref</code> field in the JSON line references an existing image, the existing image in the dataset
|
|
1873
|
-
* is updated.
|
|
1874
|
-
* If <code>source-ref</code> field doesn't reference an existing image, the image is added as a new image to the dataset. </p>
|
|
1875
|
-
* <p>You specify the changes that you want to make in the <code>Changes</code> input parameter.
|
|
1876
|
-
* There isn't a limit to the number JSON Lines that you can change, but the size of <code>Changes</code> must be less
|
|
1877
|
-
* than 5MB.</p>
|
|
1878
|
-
* <p>
|
|
1879
|
-
* <code>UpdateDatasetEntries</code> returns immediatly, but the dataset update might take a while to complete.
|
|
1880
|
-
* Use <a>DescribeDataset</a> to check the
|
|
1881
|
-
* current status. The dataset updated successfully if the value of <code>Status</code> is
|
|
1882
|
-
* <code>UPDATE_COMPLETE</code>. </p>
|
|
1883
|
-
* <p>To check if any non-terminal errors occured, call <a>ListDatasetEntries</a>
|
|
1884
|
-
* and check for the presence of <code>errors</code> lists in the JSON Lines.</p>
|
|
1885
|
-
* <p>Dataset update fails if a terminal error occurs (<code>Status</code> = <code>UPDATE_FAILED</code>).
|
|
1886
|
-
* Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.
|
|
1887
|
-
* </p>
|
|
1888
|
-
* <p>This operation requires permissions to perform the <code>rekognition:UpdateDatasetEntries</code> action.</p>
|
|
448
|
+
* @see {@link UpdateDatasetEntriesCommand}
|
|
1889
449
|
*/
|
|
1890
450
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatasetEntriesCommandOutput>;
|
|
1891
451
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1892
452
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1893
453
|
/**
|
|
1894
|
-
* @
|
|
1895
|
-
* <p>
|
|
1896
|
-
* Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.
|
|
1897
|
-
* </p>
|
|
454
|
+
* @see {@link UpdateStreamProcessorCommand}
|
|
1898
455
|
*/
|
|
1899
456
|
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStreamProcessorCommandOutput>;
|
|
1900
457
|
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void): void;
|
|
1901
458
|
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void): void;
|
|
1902
459
|
}
|
|
460
|
+
/**
|
|
461
|
+
* @public
|
|
462
|
+
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
463
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
|
|
464
|
+
* Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
|
|
465
|
+
* parameters, and common errors.</p>
|
|
466
|
+
* <p>
|
|
467
|
+
* <b>Amazon Rekognition Image</b>
|
|
468
|
+
* </p>
|
|
469
|
+
* <ul>
|
|
470
|
+
* <li>
|
|
471
|
+
* <p>
|
|
472
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html">CompareFaces</a>
|
|
473
|
+
* </p>
|
|
474
|
+
* </li>
|
|
475
|
+
* <li>
|
|
476
|
+
* <p>
|
|
477
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html">CreateCollection</a>
|
|
478
|
+
* </p>
|
|
479
|
+
* </li>
|
|
480
|
+
* <li>
|
|
481
|
+
* <p>
|
|
482
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html">DeleteCollection</a>
|
|
483
|
+
* </p>
|
|
484
|
+
* </li>
|
|
485
|
+
* <li>
|
|
486
|
+
* <p>
|
|
487
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html">DeleteFaces</a>
|
|
488
|
+
* </p>
|
|
489
|
+
* </li>
|
|
490
|
+
* <li>
|
|
491
|
+
* <p>
|
|
492
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html">DescribeCollection</a>
|
|
493
|
+
* </p>
|
|
494
|
+
* </li>
|
|
495
|
+
* <li>
|
|
496
|
+
* <p>
|
|
497
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html">DetectFaces</a>
|
|
498
|
+
* </p>
|
|
499
|
+
* </li>
|
|
500
|
+
* <li>
|
|
501
|
+
* <p>
|
|
502
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html">DetectLabels</a>
|
|
503
|
+
* </p>
|
|
504
|
+
* </li>
|
|
505
|
+
* <li>
|
|
506
|
+
* <p>
|
|
507
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html">DetectModerationLabels</a>
|
|
508
|
+
* </p>
|
|
509
|
+
* </li>
|
|
510
|
+
* <li>
|
|
511
|
+
* <p>
|
|
512
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html">DetectProtectiveEquipment</a>
|
|
513
|
+
* </p>
|
|
514
|
+
* </li>
|
|
515
|
+
* <li>
|
|
516
|
+
* <p>
|
|
517
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html">DetectText</a>
|
|
518
|
+
* </p>
|
|
519
|
+
* </li>
|
|
520
|
+
* <li>
|
|
521
|
+
* <p>
|
|
522
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html">GetCelebrityInfo</a>
|
|
523
|
+
* </p>
|
|
524
|
+
* </li>
|
|
525
|
+
* <li>
|
|
526
|
+
* <p>
|
|
527
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html">IndexFaces</a>
|
|
528
|
+
* </p>
|
|
529
|
+
* </li>
|
|
530
|
+
* <li>
|
|
531
|
+
* <p>
|
|
532
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html">ListCollections</a>
|
|
533
|
+
* </p>
|
|
534
|
+
* </li>
|
|
535
|
+
* <li>
|
|
536
|
+
* <p>
|
|
537
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListFaces</a>
|
|
538
|
+
* </p>
|
|
539
|
+
* </li>
|
|
540
|
+
* <li>
|
|
541
|
+
* <p>
|
|
542
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html">RecognizeCelebrities</a>
|
|
543
|
+
* </p>
|
|
544
|
+
* </li>
|
|
545
|
+
* <li>
|
|
546
|
+
* <p>
|
|
547
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html">SearchFaces</a>
|
|
548
|
+
* </p>
|
|
549
|
+
* </li>
|
|
550
|
+
* <li>
|
|
551
|
+
* <p>
|
|
552
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html">SearchFacesByImage</a>
|
|
553
|
+
* </p>
|
|
554
|
+
* </li>
|
|
555
|
+
* </ul>
|
|
556
|
+
* <p>
|
|
557
|
+
* <b>Amazon Rekognition Custom Labels</b>
|
|
558
|
+
* </p>
|
|
559
|
+
* <ul>
|
|
560
|
+
* <li>
|
|
561
|
+
* <p>
|
|
562
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html">CopyProjectVersion</a>
|
|
563
|
+
* </p>
|
|
564
|
+
* </li>
|
|
565
|
+
* <li>
|
|
566
|
+
* <p>
|
|
567
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html">CreateDataset</a>
|
|
568
|
+
* </p>
|
|
569
|
+
* </li>
|
|
570
|
+
* <li>
|
|
571
|
+
* <p>
|
|
572
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html">CreateProject</a>
|
|
573
|
+
* </p>
|
|
574
|
+
* </li>
|
|
575
|
+
* <li>
|
|
576
|
+
* <p>
|
|
577
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html">CreateProjectVersion</a>
|
|
578
|
+
* </p>
|
|
579
|
+
* </li>
|
|
580
|
+
* <li>
|
|
581
|
+
* <p>
|
|
582
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html">DeleteDataset</a>
|
|
583
|
+
* </p>
|
|
584
|
+
* </li>
|
|
585
|
+
* <li>
|
|
586
|
+
* <p>
|
|
587
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html">DeleteProject</a>
|
|
588
|
+
* </p>
|
|
589
|
+
* </li>
|
|
590
|
+
* <li>
|
|
591
|
+
* <p>
|
|
592
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html">DeleteProjectPolicy</a>
|
|
593
|
+
* </p>
|
|
594
|
+
* </li>
|
|
595
|
+
* <li>
|
|
596
|
+
* <p>
|
|
597
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html">DeleteProjectVersion</a>
|
|
598
|
+
* </p>
|
|
599
|
+
* </li>
|
|
600
|
+
* <li>
|
|
601
|
+
* <p>
|
|
602
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html">DescribeDataset</a>
|
|
603
|
+
* </p>
|
|
604
|
+
* </li>
|
|
605
|
+
* <li>
|
|
606
|
+
* <p>
|
|
607
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html">DescribeProjects</a>
|
|
608
|
+
* </p>
|
|
609
|
+
* </li>
|
|
610
|
+
* <li>
|
|
611
|
+
* <p>
|
|
612
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html">DescribeProjectVersions</a>
|
|
613
|
+
* </p>
|
|
614
|
+
* </li>
|
|
615
|
+
* <li>
|
|
616
|
+
* <p>
|
|
617
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html">DetectCustomLabels</a>
|
|
618
|
+
* </p>
|
|
619
|
+
* </li>
|
|
620
|
+
* <li>
|
|
621
|
+
* <p>
|
|
622
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html">DistributeDatasetEntries</a>
|
|
623
|
+
* </p>
|
|
624
|
+
* </li>
|
|
625
|
+
* <li>
|
|
626
|
+
* <p>
|
|
627
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html">ListDatasetEntries</a>
|
|
628
|
+
* </p>
|
|
629
|
+
* </li>
|
|
630
|
+
* <li>
|
|
631
|
+
* <p>
|
|
632
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html">ListDatasetLabels</a>
|
|
633
|
+
* </p>
|
|
634
|
+
* </li>
|
|
635
|
+
* <li>
|
|
636
|
+
* <p>
|
|
637
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html">ListProjectPolicies</a>
|
|
638
|
+
* </p>
|
|
639
|
+
* </li>
|
|
640
|
+
* <li>
|
|
641
|
+
* <p>
|
|
642
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html">PutProjectPolicy</a>
|
|
643
|
+
* </p>
|
|
644
|
+
* </li>
|
|
645
|
+
* <li>
|
|
646
|
+
* <p>
|
|
647
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html">StartProjectVersion</a>
|
|
648
|
+
* </p>
|
|
649
|
+
* </li>
|
|
650
|
+
* <li>
|
|
651
|
+
* <p>
|
|
652
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html">StopProjectVersion</a>
|
|
653
|
+
* </p>
|
|
654
|
+
* </li>
|
|
655
|
+
* <li>
|
|
656
|
+
* <p>
|
|
657
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html">UpdateDatasetEntries</a>
|
|
658
|
+
* </p>
|
|
659
|
+
* </li>
|
|
660
|
+
* </ul>
|
|
661
|
+
* <p>
|
|
662
|
+
* <b>Amazon Rekognition Video Stored Video</b>
|
|
663
|
+
* </p>
|
|
664
|
+
* <ul>
|
|
665
|
+
* <li>
|
|
666
|
+
* <p>
|
|
667
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html">GetCelebrityRecognition</a>
|
|
668
|
+
* </p>
|
|
669
|
+
* </li>
|
|
670
|
+
* <li>
|
|
671
|
+
* <p>
|
|
672
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html">GetContentModeration</a>
|
|
673
|
+
* </p>
|
|
674
|
+
* </li>
|
|
675
|
+
* <li>
|
|
676
|
+
* <p>
|
|
677
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html">GetFaceDetection</a>
|
|
678
|
+
* </p>
|
|
679
|
+
* </li>
|
|
680
|
+
* <li>
|
|
681
|
+
* <p>
|
|
682
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html">GetFaceSearch</a>
|
|
683
|
+
* </p>
|
|
684
|
+
* </li>
|
|
685
|
+
* <li>
|
|
686
|
+
* <p>
|
|
687
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html">GetLabelDetection</a>
|
|
688
|
+
* </p>
|
|
689
|
+
* </li>
|
|
690
|
+
* <li>
|
|
691
|
+
* <p>
|
|
692
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html">GetPersonTracking</a>
|
|
693
|
+
* </p>
|
|
694
|
+
* </li>
|
|
695
|
+
* <li>
|
|
696
|
+
* <p>
|
|
697
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html">GetSegmentDetection</a>
|
|
698
|
+
* </p>
|
|
699
|
+
* </li>
|
|
700
|
+
* <li>
|
|
701
|
+
* <p>
|
|
702
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html">GetTextDetection</a>
|
|
703
|
+
* </p>
|
|
704
|
+
* </li>
|
|
705
|
+
* <li>
|
|
706
|
+
* <p>
|
|
707
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html">StartCelebrityRecognition</a>
|
|
708
|
+
* </p>
|
|
709
|
+
* </li>
|
|
710
|
+
* <li>
|
|
711
|
+
* <p>
|
|
712
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html">StartContentModeration</a>
|
|
713
|
+
* </p>
|
|
714
|
+
* </li>
|
|
715
|
+
* <li>
|
|
716
|
+
* <p>
|
|
717
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html">StartFaceDetection</a>
|
|
718
|
+
* </p>
|
|
719
|
+
* </li>
|
|
720
|
+
* <li>
|
|
721
|
+
* <p>
|
|
722
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html">StartFaceSearch</a>
|
|
723
|
+
* </p>
|
|
724
|
+
* </li>
|
|
725
|
+
* <li>
|
|
726
|
+
* <p>
|
|
727
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html">StartLabelDetection</a>
|
|
728
|
+
* </p>
|
|
729
|
+
* </li>
|
|
730
|
+
* <li>
|
|
731
|
+
* <p>
|
|
732
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html">StartPersonTracking</a>
|
|
733
|
+
* </p>
|
|
734
|
+
* </li>
|
|
735
|
+
* <li>
|
|
736
|
+
* <p>
|
|
737
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html">StartSegmentDetection</a>
|
|
738
|
+
* </p>
|
|
739
|
+
* </li>
|
|
740
|
+
* <li>
|
|
741
|
+
* <p>
|
|
742
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html">StartTextDetection</a>
|
|
743
|
+
* </p>
|
|
744
|
+
* </li>
|
|
745
|
+
* </ul>
|
|
746
|
+
* <p>
|
|
747
|
+
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
748
|
+
* </p>
|
|
749
|
+
* <ul>
|
|
750
|
+
* <li>
|
|
751
|
+
* <p>
|
|
752
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html">CreateStreamProcessor</a>
|
|
753
|
+
* </p>
|
|
754
|
+
* </li>
|
|
755
|
+
* <li>
|
|
756
|
+
* <p>
|
|
757
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html">DeleteStreamProcessor</a>
|
|
758
|
+
* </p>
|
|
759
|
+
* </li>
|
|
760
|
+
* <li>
|
|
761
|
+
* <p>
|
|
762
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html">DescribeStreamProcessor</a>
|
|
763
|
+
* </p>
|
|
764
|
+
* </li>
|
|
765
|
+
* <li>
|
|
766
|
+
* <p>
|
|
767
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html">ListStreamProcessors</a>
|
|
768
|
+
* </p>
|
|
769
|
+
* </li>
|
|
770
|
+
* <li>
|
|
771
|
+
* <p>
|
|
772
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html">StartStreamProcessor</a>
|
|
773
|
+
* </p>
|
|
774
|
+
* </li>
|
|
775
|
+
* <li>
|
|
776
|
+
* <p>
|
|
777
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html">StopStreamProcessor</a>
|
|
778
|
+
* </p>
|
|
779
|
+
* </li>
|
|
780
|
+
* <li>
|
|
781
|
+
* <p>
|
|
782
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html">UpdateStreamProcessor</a>
|
|
783
|
+
* </p>
|
|
784
|
+
* </li>
|
|
785
|
+
* </ul>
|
|
786
|
+
*/
|
|
787
|
+
export declare class Rekognition extends RekognitionClient implements Rekognition {
|
|
788
|
+
}
|