@aws-sdk/client-rekognition 3.78.0 → 3.79.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/CHANGELOG.md +11 -0
- package/README.md +198 -1
- package/dist-cjs/Rekognition.js +15 -0
- package/dist-cjs/commands/UpdateStreamProcessorCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +89 -17
- package/dist-cjs/protocols/Aws_json1_1.js +291 -3
- package/dist-es/Rekognition.js +15 -0
- package/dist-es/commands/UpdateStreamProcessorCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +58 -8
- package/dist-es/protocols/Aws_json1_1.js +277 -9
- package/dist-types/Rekognition.d.ts +247 -24
- package/dist-types/RekognitionClient.d.ts +205 -3
- package/dist-types/commands/CreateStreamProcessorCommand.d.ts +17 -6
- package/dist-types/commands/DeleteCollectionCommand.d.ts +1 -1
- package/dist-types/commands/DetectLabelsCommand.d.ts +1 -1
- package/dist-types/commands/DetectTextCommand.d.ts +1 -1
- package/dist-types/commands/GetCelebrityInfoCommand.d.ts +1 -1
- package/dist-types/commands/GetContentModerationCommand.d.ts +1 -1
- package/dist-types/commands/GetSegmentDetectionCommand.d.ts +1 -1
- package/dist-types/commands/IndexFacesCommand.d.ts +2 -2
- package/dist-types/commands/ListCollectionsCommand.d.ts +1 -1
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +2 -2
- package/dist-types/commands/SearchFacesCommand.d.ts +1 -1
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +1 -1
- package/dist-types/commands/StartContentModerationCommand.d.ts +1 -1
- package/dist-types/commands/StartFaceDetectionCommand.d.ts +1 -1
- package/dist-types/commands/StartFaceSearchCommand.d.ts +2 -1
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -1
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -0
- package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +37 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +450 -84
- package/dist-types/protocols/Aws_json1_1.d.ts +3 -0
- package/dist-types/ts3.4/Rekognition.d.ts +5 -0
- package/dist-types/ts3.4/RekognitionClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/UpdateStreamProcessorCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +165 -21
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +3 -0
- package/package.json +8 -8
|
@@ -57,9 +57,211 @@ import { StopStreamProcessorCommandInput, StopStreamProcessorCommandOutput } fro
|
|
|
57
57
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
58
58
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
59
59
|
import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } from "./commands/UpdateDatasetEntriesCommand";
|
|
60
|
+
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
60
61
|
import { RekognitionClient } from "./RekognitionClient";
|
|
61
62
|
/**
|
|
62
|
-
* <p>This is the Amazon Rekognition
|
|
63
|
+
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
|
|
64
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
65
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored Video</a>,
|
|
66
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>.
|
|
67
|
+
* It provides descriptions of actions, data types, common parameters,
|
|
68
|
+
* and common errors.</p>
|
|
69
|
+
*
|
|
70
|
+
* <p>
|
|
71
|
+
* <b>Amazon Rekognition Image</b>
|
|
72
|
+
* </p>
|
|
73
|
+
*
|
|
74
|
+
* <ul>
|
|
75
|
+
* <li>
|
|
76
|
+
* <p></p>
|
|
77
|
+
* </li>
|
|
78
|
+
* <li>
|
|
79
|
+
* <p></p>
|
|
80
|
+
* </li>
|
|
81
|
+
* <li>
|
|
82
|
+
* <p></p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p></p>
|
|
86
|
+
* </li>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p></p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p></p>
|
|
92
|
+
* </li>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p></p>
|
|
95
|
+
* </li>
|
|
96
|
+
* <li>
|
|
97
|
+
* <p></p>
|
|
98
|
+
* </li>
|
|
99
|
+
* <li>
|
|
100
|
+
* <p></p>
|
|
101
|
+
* </li>
|
|
102
|
+
* <li>
|
|
103
|
+
* <p></p>
|
|
104
|
+
* </li>
|
|
105
|
+
* <li>
|
|
106
|
+
* <p></p>
|
|
107
|
+
* </li>
|
|
108
|
+
* <li>
|
|
109
|
+
* <p></p>
|
|
110
|
+
* </li>
|
|
111
|
+
* <li>
|
|
112
|
+
* <p></p>
|
|
113
|
+
* </li>
|
|
114
|
+
* <li>
|
|
115
|
+
* <p></p>
|
|
116
|
+
* </li>
|
|
117
|
+
* <li>
|
|
118
|
+
* <p></p>
|
|
119
|
+
* </li>
|
|
120
|
+
* <li>
|
|
121
|
+
* <p></p>
|
|
122
|
+
* </li>
|
|
123
|
+
* <li>
|
|
124
|
+
* <p></p>
|
|
125
|
+
* </li>
|
|
126
|
+
* </ul>
|
|
127
|
+
*
|
|
128
|
+
*
|
|
129
|
+
*
|
|
130
|
+
*
|
|
131
|
+
*
|
|
132
|
+
* <p>
|
|
133
|
+
* <b>Amazon Rekognition Custom Labels</b>
|
|
134
|
+
* </p>
|
|
135
|
+
* <ul>
|
|
136
|
+
* <li>
|
|
137
|
+
* <p></p>
|
|
138
|
+
* </li>
|
|
139
|
+
* <li>
|
|
140
|
+
* <p></p>
|
|
141
|
+
* </li>
|
|
142
|
+
* <li>
|
|
143
|
+
* <p></p>
|
|
144
|
+
* </li>
|
|
145
|
+
* <li>
|
|
146
|
+
* <p></p>
|
|
147
|
+
* </li>
|
|
148
|
+
* <li>
|
|
149
|
+
* <p></p>
|
|
150
|
+
* </li>
|
|
151
|
+
* <li>
|
|
152
|
+
* <p></p>
|
|
153
|
+
* </li>
|
|
154
|
+
* <li>
|
|
155
|
+
* <p></p>
|
|
156
|
+
* </li>
|
|
157
|
+
* <li>
|
|
158
|
+
* <p></p>
|
|
159
|
+
* </li>
|
|
160
|
+
* <li>
|
|
161
|
+
* <p></p>
|
|
162
|
+
* </li>
|
|
163
|
+
* <li>
|
|
164
|
+
* <p></p>
|
|
165
|
+
* </li>
|
|
166
|
+
* <li>
|
|
167
|
+
* <p></p>
|
|
168
|
+
* </li>
|
|
169
|
+
* <li>
|
|
170
|
+
* <p></p>
|
|
171
|
+
* </li>
|
|
172
|
+
* <li>
|
|
173
|
+
* <p></p>
|
|
174
|
+
* </li>
|
|
175
|
+
* <li>
|
|
176
|
+
* <p></p>
|
|
177
|
+
* </li>
|
|
178
|
+
* <li>
|
|
179
|
+
* <p></p>
|
|
180
|
+
* </li>
|
|
181
|
+
* <li>
|
|
182
|
+
* <p></p>
|
|
183
|
+
* </li>
|
|
184
|
+
* </ul>
|
|
185
|
+
*
|
|
186
|
+
* <p>
|
|
187
|
+
* <b>Amazon Rekognition Video Stored Video</b>
|
|
188
|
+
* </p>
|
|
189
|
+
*
|
|
190
|
+
* <ul>
|
|
191
|
+
* <li>
|
|
192
|
+
* <p></p>
|
|
193
|
+
* </li>
|
|
194
|
+
* <li>
|
|
195
|
+
* <p></p>
|
|
196
|
+
* </li>
|
|
197
|
+
* <li>
|
|
198
|
+
* <p></p>
|
|
199
|
+
* </li>
|
|
200
|
+
* <li>
|
|
201
|
+
* <p></p>
|
|
202
|
+
* </li>
|
|
203
|
+
* <li>
|
|
204
|
+
* <p></p>
|
|
205
|
+
* </li>
|
|
206
|
+
* <li>
|
|
207
|
+
* <p></p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p></p>
|
|
211
|
+
* </li>
|
|
212
|
+
* <li>
|
|
213
|
+
* <p></p>
|
|
214
|
+
* </li>
|
|
215
|
+
* <li>
|
|
216
|
+
* <p></p>
|
|
217
|
+
* </li>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p></p>
|
|
220
|
+
* </li>
|
|
221
|
+
* <li>
|
|
222
|
+
* <p></p>
|
|
223
|
+
* </li>
|
|
224
|
+
* <li>
|
|
225
|
+
* <p></p>
|
|
226
|
+
* </li>
|
|
227
|
+
* <li>
|
|
228
|
+
* <p></p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p></p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p></p>
|
|
235
|
+
* </li>
|
|
236
|
+
* <li>
|
|
237
|
+
* <p></p>
|
|
238
|
+
* </li>
|
|
239
|
+
* </ul>
|
|
240
|
+
*
|
|
241
|
+
* <p>
|
|
242
|
+
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
243
|
+
* </p>
|
|
244
|
+
*
|
|
245
|
+
* <ul>
|
|
246
|
+
* <li>
|
|
247
|
+
* <p></p>
|
|
248
|
+
* </li>
|
|
249
|
+
* <li>
|
|
250
|
+
* <p></p>
|
|
251
|
+
* </li>
|
|
252
|
+
* <li>
|
|
253
|
+
* <p></p>
|
|
254
|
+
* </li>
|
|
255
|
+
* <li>
|
|
256
|
+
* <p></p>
|
|
257
|
+
* </li>
|
|
258
|
+
* <li>
|
|
259
|
+
* <p></p>
|
|
260
|
+
* </li>
|
|
261
|
+
* <li>
|
|
262
|
+
* <p></p>
|
|
263
|
+
* </li>
|
|
264
|
+
* </ul>
|
|
63
265
|
*/
|
|
64
266
|
export declare class Rekognition extends RekognitionClient {
|
|
65
267
|
/**
|
|
@@ -232,15 +434,26 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
232
434
|
createProjectVersion(args: CreateProjectVersionCommandInput, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
233
435
|
createProjectVersion(args: CreateProjectVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProjectVersionCommandOutput) => void): void;
|
|
234
436
|
/**
|
|
235
|
-
* <p>Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.</p>
|
|
236
|
-
* <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams.
|
|
237
|
-
* <
|
|
238
|
-
*
|
|
437
|
+
* <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>
|
|
438
|
+
* <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>
|
|
439
|
+
* <ul>
|
|
440
|
+
* <li>
|
|
441
|
+
* <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
|
|
442
|
+
* face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
|
|
443
|
+
* stop processing.</p>
|
|
444
|
+
* </li>
|
|
445
|
+
* <li>
|
|
446
|
+
* <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
|
|
447
|
+
* Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.
|
|
448
|
+
* You specify what you want to detect in <code>ConnectedHomeSettings</code>, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>.
|
|
449
|
+
* When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
|
|
450
|
+
* </li>
|
|
451
|
+
* </ul>
|
|
452
|
+
*
|
|
453
|
+
* <p>
|
|
239
454
|
* Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code>
|
|
240
455
|
* to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with
|
|
241
456
|
* the <code>Name</code> field. </p>
|
|
242
|
-
* <p>After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
|
|
243
|
-
* stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>.</p>
|
|
244
457
|
* <p>This operation requires permissions to perform the
|
|
245
458
|
* <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>
|
|
246
459
|
*/
|
|
@@ -249,7 +462,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
249
462
|
createStreamProcessor(args: CreateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamProcessorCommandOutput) => void): void;
|
|
250
463
|
/**
|
|
251
464
|
* <p>Deletes the specified collection. Note that this operation
|
|
252
|
-
* removes all faces in the collection. For an example, see <a
|
|
465
|
+
* removes all faces in the collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a collection</a>.</p>
|
|
253
466
|
*
|
|
254
467
|
* <p>This operation requires permissions to perform the
|
|
255
468
|
* <code>rekognition:DeleteCollection</code> action.</p>
|
|
@@ -449,7 +662,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
449
662
|
* wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
|
|
450
663
|
* </p>
|
|
451
664
|
*
|
|
452
|
-
* <p>For an example, see Analyzing
|
|
665
|
+
* <p>For an example, see Analyzing images stored in an Amazon S3 bucket in the Amazon Rekognition Developer Guide.</p>
|
|
453
666
|
* <note>
|
|
454
667
|
* <p>
|
|
455
668
|
* <code>DetectLabels</code> does not support the detection of activities. However, activity detection
|
|
@@ -607,7 +820,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
607
820
|
* use the <code>TextDetection</code> object <code>Type</code> field. </p>
|
|
608
821
|
* <p>To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.</p>
|
|
609
822
|
*
|
|
610
|
-
* <p>For more information, see
|
|
823
|
+
* <p>For more information, see Detecting text in the Amazon Rekognition Developer Guide.</p>
|
|
611
824
|
*/
|
|
612
825
|
detectText(args: DetectTextCommandInput, options?: __HttpHandlerOptions): Promise<DetectTextCommandOutput>;
|
|
613
826
|
detectText(args: DetectTextCommandInput, cb: (err: any, data?: DetectTextCommandOutput) => void): void;
|
|
@@ -634,7 +847,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
634
847
|
* The additional information is returned as an array of URLs. If there is no additional
|
|
635
848
|
* information about the celebrity, this list is empty.</p>
|
|
636
849
|
*
|
|
637
|
-
* <p>For more information, see
|
|
850
|
+
* <p>For more information, see Getting information about a celebrity in
|
|
638
851
|
* the Amazon Rekognition Developer Guide.</p>
|
|
639
852
|
* <p>This operation requires permissions to perform the
|
|
640
853
|
* <code>rekognition:GetCelebrityInfo</code> action. </p>
|
|
@@ -717,7 +930,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
717
930
|
* and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code>
|
|
718
931
|
* returned from the previous call to <code>GetContentModeration</code>.</p>
|
|
719
932
|
*
|
|
720
|
-
* <p>For more information, see
|
|
933
|
+
* <p>For more information, see moderating content in the Amazon Rekognition Developer Guide.</p>
|
|
721
934
|
*/
|
|
722
935
|
getContentModeration(args: GetContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<GetContentModerationCommandOutput>;
|
|
723
936
|
getContentModeration(args: GetContentModerationCommandInput, cb: (err: any, data?: GetContentModerationCommandOutput) => void): void;
|
|
@@ -860,7 +1073,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
860
1073
|
* and populate the <code>NextToken</code> request parameter with the token value returned from the previous
|
|
861
1074
|
* call to <code>GetSegmentDetection</code>.</p>
|
|
862
1075
|
*
|
|
863
|
-
* <p>For more information, see Detecting
|
|
1076
|
+
* <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
|
|
864
1077
|
*/
|
|
865
1078
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetSegmentDetectionCommandOutput>;
|
|
866
1079
|
getSegmentDetection(args: GetSegmentDetectionCommandInput, cb: (err: any, data?: GetSegmentDetectionCommandOutput) => void): void;
|
|
@@ -898,7 +1111,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
898
1111
|
* <a>SearchFaces</a> and <a>SearchFacesByImage</a>
|
|
899
1112
|
* operations.</p>
|
|
900
1113
|
*
|
|
901
|
-
* <p>For more information, see Adding
|
|
1114
|
+
* <p>For more information, see Adding faces to a collection in the Amazon Rekognition
|
|
902
1115
|
* Developer Guide.</p>
|
|
903
1116
|
* <p>To get the number of faces in a collection, call <a>DescribeCollection</a>. </p>
|
|
904
1117
|
*
|
|
@@ -978,7 +1191,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
978
1191
|
* <p>If you request all facial attributes (by using the <code>detectionAttributes</code>
|
|
979
1192
|
* parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for
|
|
980
1193
|
* example, location of eye and mouth) and other facial attributes. If you provide
|
|
981
|
-
* the same image, specify the same collection, use the same external ID
|
|
1194
|
+
* the same image, specify the same collection, and use the same external ID in the
|
|
982
1195
|
* <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata.</p>
|
|
983
1196
|
*
|
|
984
1197
|
*
|
|
@@ -999,7 +1212,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
999
1212
|
* If the result is truncated, the response also provides a <code>NextToken</code>
|
|
1000
1213
|
* that you can use in the subsequent request to fetch the next set of collection IDs.</p>
|
|
1001
1214
|
*
|
|
1002
|
-
* <p>For an example, see Listing
|
|
1215
|
+
* <p>For an example, see Listing collections in the Amazon Rekognition Developer Guide.</p>
|
|
1003
1216
|
* <p>This operation requires permissions to perform the <code>rekognition:ListCollections</code> action.</p>
|
|
1004
1217
|
*/
|
|
1005
1218
|
listCollections(args: ListCollectionsCommandInput, options?: __HttpHandlerOptions): Promise<ListCollectionsCommandOutput>;
|
|
@@ -1066,7 +1279,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1066
1279
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1067
1280
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1068
1281
|
/**
|
|
1069
|
-
* <p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing
|
|
1282
|
+
* <p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities
|
|
1070
1283
|
* in the Amazon Rekognition Developer Guide. </p>
|
|
1071
1284
|
* <p>
|
|
1072
1285
|
* <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists the
|
|
@@ -1094,7 +1307,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1094
1307
|
*
|
|
1095
1308
|
*
|
|
1096
1309
|
*
|
|
1097
|
-
* <p>For an example, see Recognizing
|
|
1310
|
+
* <p>For an example, see Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.</p>
|
|
1098
1311
|
* <p>This operation requires permissions to perform the
|
|
1099
1312
|
* <code>rekognition:RecognizeCelebrities</code> operation.</p>
|
|
1100
1313
|
*/
|
|
@@ -1119,7 +1332,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1119
1332
|
* that the specific face matches the input face.
|
|
1120
1333
|
* </p>
|
|
1121
1334
|
*
|
|
1122
|
-
* <p>For an example, see Searching for a
|
|
1335
|
+
* <p>For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.</p>
|
|
1123
1336
|
*
|
|
1124
1337
|
* <p>This operation requires permissions to perform the <code>rekognition:SearchFaces</code>
|
|
1125
1338
|
* action.</p>
|
|
@@ -1191,7 +1404,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1191
1404
|
* topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier
|
|
1192
1405
|
* (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </p>
|
|
1193
1406
|
*
|
|
1194
|
-
* <p>For more information, see Recognizing
|
|
1407
|
+
* <p>For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.</p>
|
|
1195
1408
|
*/
|
|
1196
1409
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, options?: __HttpHandlerOptions): Promise<StartCelebrityRecognitionCommandOutput>;
|
|
1197
1410
|
startCelebrityRecognition(args: StartCelebrityRecognitionCommandInput, cb: (err: any, data?: StartCelebrityRecognitionCommandOutput) => void): void;
|
|
@@ -1208,7 +1421,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1208
1421
|
* topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier
|
|
1209
1422
|
* (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </p>
|
|
1210
1423
|
*
|
|
1211
|
-
* <p>For more information, see
|
|
1424
|
+
* <p>For more information, see Moderating content in the Amazon Rekognition Developer Guide.</p>
|
|
1212
1425
|
*/
|
|
1213
1426
|
startContentModeration(args: StartContentModerationCommandInput, options?: __HttpHandlerOptions): Promise<StartContentModerationCommandOutput>;
|
|
1214
1427
|
startContentModeration(args: StartContentModerationCommandInput, cb: (err: any, data?: StartContentModerationCommandOutput) => void): void;
|
|
@@ -1225,7 +1438,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1225
1438
|
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier
|
|
1226
1439
|
* (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>.</p>
|
|
1227
1440
|
*
|
|
1228
|
-
* <p>For more information, see Detecting
|
|
1441
|
+
* <p>For more information, see Detecting faces in a stored video in the
|
|
1229
1442
|
* Amazon Rekognition Developer Guide.</p>
|
|
1230
1443
|
*/
|
|
1231
1444
|
startFaceDetection(args: StartFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceDetectionCommandOutput>;
|
|
@@ -1241,7 +1454,8 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1241
1454
|
* To get the search results, first check that the status value published to the Amazon SNS
|
|
1242
1455
|
* topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier
|
|
1243
1456
|
* (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see
|
|
1244
|
-
* <a
|
|
1457
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html">Searching stored videos for faces</a>.
|
|
1458
|
+
* </p>
|
|
1245
1459
|
*/
|
|
1246
1460
|
startFaceSearch(args: StartFaceSearchCommandInput, options?: __HttpHandlerOptions): Promise<StartFaceSearchCommandOutput>;
|
|
1247
1461
|
startFaceSearch(args: StartFaceSearchCommandInput, cb: (err: any, data?: StartFaceSearchCommandOutput) => void): void;
|
|
@@ -1311,7 +1525,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1311
1525
|
* from the initial call to <code>StartSegmentDetection</code>. </p>
|
|
1312
1526
|
*
|
|
1313
1527
|
*
|
|
1314
|
-
* <p>For more information, see Detecting
|
|
1528
|
+
* <p>For more information, see Detecting video segments in stored video in the Amazon Rekognition Developer Guide.</p>
|
|
1315
1529
|
*/
|
|
1316
1530
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, options?: __HttpHandlerOptions): Promise<StartSegmentDetectionCommandOutput>;
|
|
1317
1531
|
startSegmentDetection(args: StartSegmentDetectionCommandInput, cb: (err: any, data?: StartSegmentDetectionCommandOutput) => void): void;
|
|
@@ -1320,6 +1534,7 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1320
1534
|
* <p>Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>.
|
|
1321
1535
|
* To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to
|
|
1322
1536
|
* <code>CreateStreamProcessor</code>.</p>
|
|
1537
|
+
* <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>
|
|
1323
1538
|
*/
|
|
1324
1539
|
startStreamProcessor(args: StartStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<StartStreamProcessorCommandOutput>;
|
|
1325
1540
|
startStreamProcessor(args: StartStreamProcessorCommandInput, cb: (err: any, data?: StartStreamProcessorCommandOutput) => void): void;
|
|
@@ -1403,4 +1618,12 @@ export declare class Rekognition extends RekognitionClient {
|
|
|
1403
1618
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDatasetEntriesCommandOutput>;
|
|
1404
1619
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1405
1620
|
updateDatasetEntries(args: UpdateDatasetEntriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDatasetEntriesCommandOutput) => void): void;
|
|
1621
|
+
/**
|
|
1622
|
+
* <p>
|
|
1623
|
+
* Allows you to update a stream processor. You can change some settings and regions of interest and delete certain parameters.
|
|
1624
|
+
* </p>
|
|
1625
|
+
*/
|
|
1626
|
+
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStreamProcessorCommandOutput>;
|
|
1627
|
+
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void): void;
|
|
1628
|
+
updateStreamProcessor(args: UpdateStreamProcessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamProcessorCommandOutput) => void): void;
|
|
1406
1629
|
}
|
|
@@ -64,8 +64,9 @@ import { StopStreamProcessorCommandInput, StopStreamProcessorCommandOutput } fro
|
|
|
64
64
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
65
65
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
66
66
|
import { UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput } from "./commands/UpdateDatasetEntriesCommand";
|
|
67
|
-
|
|
68
|
-
export declare type
|
|
67
|
+
import { UpdateStreamProcessorCommandInput, UpdateStreamProcessorCommandOutput } from "./commands/UpdateStreamProcessorCommand";
|
|
68
|
+
export declare type ServiceInputTypes = CompareFacesCommandInput | CreateCollectionCommandInput | CreateDatasetCommandInput | CreateProjectCommandInput | CreateProjectVersionCommandInput | CreateStreamProcessorCommandInput | DeleteCollectionCommandInput | DeleteDatasetCommandInput | DeleteFacesCommandInput | DeleteProjectCommandInput | DeleteProjectVersionCommandInput | DeleteStreamProcessorCommandInput | DescribeCollectionCommandInput | DescribeDatasetCommandInput | DescribeProjectVersionsCommandInput | DescribeProjectsCommandInput | DescribeStreamProcessorCommandInput | DetectCustomLabelsCommandInput | DetectFacesCommandInput | DetectLabelsCommandInput | DetectModerationLabelsCommandInput | DetectProtectiveEquipmentCommandInput | DetectTextCommandInput | DistributeDatasetEntriesCommandInput | GetCelebrityInfoCommandInput | GetCelebrityRecognitionCommandInput | GetContentModerationCommandInput | GetFaceDetectionCommandInput | GetFaceSearchCommandInput | GetLabelDetectionCommandInput | GetPersonTrackingCommandInput | GetSegmentDetectionCommandInput | GetTextDetectionCommandInput | IndexFacesCommandInput | ListCollectionsCommandInput | ListDatasetEntriesCommandInput | ListDatasetLabelsCommandInput | ListFacesCommandInput | ListStreamProcessorsCommandInput | ListTagsForResourceCommandInput | RecognizeCelebritiesCommandInput | SearchFacesByImageCommandInput | SearchFacesCommandInput | StartCelebrityRecognitionCommandInput | StartContentModerationCommandInput | StartFaceDetectionCommandInput | StartFaceSearchCommandInput | StartLabelDetectionCommandInput | StartPersonTrackingCommandInput | StartProjectVersionCommandInput | StartSegmentDetectionCommandInput | StartStreamProcessorCommandInput | StartTextDetectionCommandInput | StopProjectVersionCommandInput | StopStreamProcessorCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetEntriesCommandInput | UpdateStreamProcessorCommandInput;
|
|
69
|
+
export declare type ServiceOutputTypes = CompareFacesCommandOutput | CreateCollectionCommandOutput | CreateDatasetCommandOutput | CreateProjectCommandOutput | CreateProjectVersionCommandOutput | CreateStreamProcessorCommandOutput | DeleteCollectionCommandOutput | DeleteDatasetCommandOutput | DeleteFacesCommandOutput | DeleteProjectCommandOutput | DeleteProjectVersionCommandOutput | DeleteStreamProcessorCommandOutput | DescribeCollectionCommandOutput | DescribeDatasetCommandOutput | DescribeProjectVersionsCommandOutput | DescribeProjectsCommandOutput | DescribeStreamProcessorCommandOutput | DetectCustomLabelsCommandOutput | DetectFacesCommandOutput | DetectLabelsCommandOutput | DetectModerationLabelsCommandOutput | DetectProtectiveEquipmentCommandOutput | DetectTextCommandOutput | DistributeDatasetEntriesCommandOutput | GetCelebrityInfoCommandOutput | GetCelebrityRecognitionCommandOutput | GetContentModerationCommandOutput | GetFaceDetectionCommandOutput | GetFaceSearchCommandOutput | GetLabelDetectionCommandOutput | GetPersonTrackingCommandOutput | GetSegmentDetectionCommandOutput | GetTextDetectionCommandOutput | IndexFacesCommandOutput | ListCollectionsCommandOutput | ListDatasetEntriesCommandOutput | ListDatasetLabelsCommandOutput | ListFacesCommandOutput | ListStreamProcessorsCommandOutput | ListTagsForResourceCommandOutput | RecognizeCelebritiesCommandOutput | SearchFacesByImageCommandOutput | SearchFacesCommandOutput | StartCelebrityRecognitionCommandOutput | StartContentModerationCommandOutput | StartFaceDetectionCommandOutput | StartFaceSearchCommandOutput | StartLabelDetectionCommandOutput | StartPersonTrackingCommandOutput | StartProjectVersionCommandOutput | StartSegmentDetectionCommandOutput | StartStreamProcessorCommandOutput | StartTextDetectionCommandOutput | StopProjectVersionCommandOutput | StopStreamProcessorCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetEntriesCommandOutput | UpdateStreamProcessorCommandOutput;
|
|
69
70
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
70
71
|
/**
|
|
71
72
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
@@ -184,7 +185,208 @@ declare type RekognitionClientResolvedConfigType = __SmithyResolvedConfiguration
|
|
|
184
185
|
export interface RekognitionClientResolvedConfig extends RekognitionClientResolvedConfigType {
|
|
185
186
|
}
|
|
186
187
|
/**
|
|
187
|
-
* <p>This is the Amazon Rekognition
|
|
188
|
+
* <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
|
|
189
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
|
|
190
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored Video</a>,
|
|
191
|
+
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>.
|
|
192
|
+
* It provides descriptions of actions, data types, common parameters,
|
|
193
|
+
* and common errors.</p>
|
|
194
|
+
*
|
|
195
|
+
* <p>
|
|
196
|
+
* <b>Amazon Rekognition Image</b>
|
|
197
|
+
* </p>
|
|
198
|
+
*
|
|
199
|
+
* <ul>
|
|
200
|
+
* <li>
|
|
201
|
+
* <p></p>
|
|
202
|
+
* </li>
|
|
203
|
+
* <li>
|
|
204
|
+
* <p></p>
|
|
205
|
+
* </li>
|
|
206
|
+
* <li>
|
|
207
|
+
* <p></p>
|
|
208
|
+
* </li>
|
|
209
|
+
* <li>
|
|
210
|
+
* <p></p>
|
|
211
|
+
* </li>
|
|
212
|
+
* <li>
|
|
213
|
+
* <p></p>
|
|
214
|
+
* </li>
|
|
215
|
+
* <li>
|
|
216
|
+
* <p></p>
|
|
217
|
+
* </li>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p></p>
|
|
220
|
+
* </li>
|
|
221
|
+
* <li>
|
|
222
|
+
* <p></p>
|
|
223
|
+
* </li>
|
|
224
|
+
* <li>
|
|
225
|
+
* <p></p>
|
|
226
|
+
* </li>
|
|
227
|
+
* <li>
|
|
228
|
+
* <p></p>
|
|
229
|
+
* </li>
|
|
230
|
+
* <li>
|
|
231
|
+
* <p></p>
|
|
232
|
+
* </li>
|
|
233
|
+
* <li>
|
|
234
|
+
* <p></p>
|
|
235
|
+
* </li>
|
|
236
|
+
* <li>
|
|
237
|
+
* <p></p>
|
|
238
|
+
* </li>
|
|
239
|
+
* <li>
|
|
240
|
+
* <p></p>
|
|
241
|
+
* </li>
|
|
242
|
+
* <li>
|
|
243
|
+
* <p></p>
|
|
244
|
+
* </li>
|
|
245
|
+
* <li>
|
|
246
|
+
* <p></p>
|
|
247
|
+
* </li>
|
|
248
|
+
* <li>
|
|
249
|
+
* <p></p>
|
|
250
|
+
* </li>
|
|
251
|
+
* </ul>
|
|
252
|
+
*
|
|
253
|
+
*
|
|
254
|
+
*
|
|
255
|
+
*
|
|
256
|
+
*
|
|
257
|
+
* <p>
|
|
258
|
+
* <b>Amazon Rekognition Custom Labels</b>
|
|
259
|
+
* </p>
|
|
260
|
+
* <ul>
|
|
261
|
+
* <li>
|
|
262
|
+
* <p></p>
|
|
263
|
+
* </li>
|
|
264
|
+
* <li>
|
|
265
|
+
* <p></p>
|
|
266
|
+
* </li>
|
|
267
|
+
* <li>
|
|
268
|
+
* <p></p>
|
|
269
|
+
* </li>
|
|
270
|
+
* <li>
|
|
271
|
+
* <p></p>
|
|
272
|
+
* </li>
|
|
273
|
+
* <li>
|
|
274
|
+
* <p></p>
|
|
275
|
+
* </li>
|
|
276
|
+
* <li>
|
|
277
|
+
* <p></p>
|
|
278
|
+
* </li>
|
|
279
|
+
* <li>
|
|
280
|
+
* <p></p>
|
|
281
|
+
* </li>
|
|
282
|
+
* <li>
|
|
283
|
+
* <p></p>
|
|
284
|
+
* </li>
|
|
285
|
+
* <li>
|
|
286
|
+
* <p></p>
|
|
287
|
+
* </li>
|
|
288
|
+
* <li>
|
|
289
|
+
* <p></p>
|
|
290
|
+
* </li>
|
|
291
|
+
* <li>
|
|
292
|
+
* <p></p>
|
|
293
|
+
* </li>
|
|
294
|
+
* <li>
|
|
295
|
+
* <p></p>
|
|
296
|
+
* </li>
|
|
297
|
+
* <li>
|
|
298
|
+
* <p></p>
|
|
299
|
+
* </li>
|
|
300
|
+
* <li>
|
|
301
|
+
* <p></p>
|
|
302
|
+
* </li>
|
|
303
|
+
* <li>
|
|
304
|
+
* <p></p>
|
|
305
|
+
* </li>
|
|
306
|
+
* <li>
|
|
307
|
+
* <p></p>
|
|
308
|
+
* </li>
|
|
309
|
+
* </ul>
|
|
310
|
+
*
|
|
311
|
+
* <p>
|
|
312
|
+
* <b>Amazon Rekognition Video Stored Video</b>
|
|
313
|
+
* </p>
|
|
314
|
+
*
|
|
315
|
+
* <ul>
|
|
316
|
+
* <li>
|
|
317
|
+
* <p></p>
|
|
318
|
+
* </li>
|
|
319
|
+
* <li>
|
|
320
|
+
* <p></p>
|
|
321
|
+
* </li>
|
|
322
|
+
* <li>
|
|
323
|
+
* <p></p>
|
|
324
|
+
* </li>
|
|
325
|
+
* <li>
|
|
326
|
+
* <p></p>
|
|
327
|
+
* </li>
|
|
328
|
+
* <li>
|
|
329
|
+
* <p></p>
|
|
330
|
+
* </li>
|
|
331
|
+
* <li>
|
|
332
|
+
* <p></p>
|
|
333
|
+
* </li>
|
|
334
|
+
* <li>
|
|
335
|
+
* <p></p>
|
|
336
|
+
* </li>
|
|
337
|
+
* <li>
|
|
338
|
+
* <p></p>
|
|
339
|
+
* </li>
|
|
340
|
+
* <li>
|
|
341
|
+
* <p></p>
|
|
342
|
+
* </li>
|
|
343
|
+
* <li>
|
|
344
|
+
* <p></p>
|
|
345
|
+
* </li>
|
|
346
|
+
* <li>
|
|
347
|
+
* <p></p>
|
|
348
|
+
* </li>
|
|
349
|
+
* <li>
|
|
350
|
+
* <p></p>
|
|
351
|
+
* </li>
|
|
352
|
+
* <li>
|
|
353
|
+
* <p></p>
|
|
354
|
+
* </li>
|
|
355
|
+
* <li>
|
|
356
|
+
* <p></p>
|
|
357
|
+
* </li>
|
|
358
|
+
* <li>
|
|
359
|
+
* <p></p>
|
|
360
|
+
* </li>
|
|
361
|
+
* <li>
|
|
362
|
+
* <p></p>
|
|
363
|
+
* </li>
|
|
364
|
+
* </ul>
|
|
365
|
+
*
|
|
366
|
+
* <p>
|
|
367
|
+
* <b>Amazon Rekognition Video Streaming Video</b>
|
|
368
|
+
* </p>
|
|
369
|
+
*
|
|
370
|
+
* <ul>
|
|
371
|
+
* <li>
|
|
372
|
+
* <p></p>
|
|
373
|
+
* </li>
|
|
374
|
+
* <li>
|
|
375
|
+
* <p></p>
|
|
376
|
+
* </li>
|
|
377
|
+
* <li>
|
|
378
|
+
* <p></p>
|
|
379
|
+
* </li>
|
|
380
|
+
* <li>
|
|
381
|
+
* <p></p>
|
|
382
|
+
* </li>
|
|
383
|
+
* <li>
|
|
384
|
+
* <p></p>
|
|
385
|
+
* </li>
|
|
386
|
+
* <li>
|
|
387
|
+
* <p></p>
|
|
388
|
+
* </li>
|
|
389
|
+
* </ul>
|
|
188
390
|
*/
|
|
189
391
|
export declare class RekognitionClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, RekognitionClientResolvedConfig> {
|
|
190
392
|
/**
|