@aws-sdk/client-rekognition 3.431.0 → 3.434.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/README.md +24 -0
- package/dist-cjs/Rekognition.js +6 -0
- package/dist-cjs/commands/GetMediaAnalysisJobCommand.js +51 -0
- package/dist-cjs/commands/ListMediaAnalysisJobsCommand.js +51 -0
- package/dist-cjs/commands/StartMediaAnalysisJobCommand.js +51 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +35 -1
- package/dist-cjs/pagination/ListMediaAnalysisJobsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +270 -3
- package/dist-es/Rekognition.js +6 -0
- package/dist-es/commands/GetMediaAnalysisJobCommand.js +47 -0
- package/dist-es/commands/ListMediaAnalysisJobsCommand.js +47 -0
- package/dist-es/commands/StartMediaAnalysisJobCommand.js +47 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +33 -0
- package/dist-es/pagination/ListMediaAnalysisJobsPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +262 -1
- package/dist-types/Rekognition.d.ts +21 -0
- package/dist-types/RekognitionClient.d.ts +5 -2
- package/dist-types/commands/GetMediaAnalysisJobCommand.d.ts +134 -0
- package/dist-types/commands/ListMediaAnalysisJobsCommand.d.ts +139 -0
- package/dist-types/commands/PutProjectPolicyCommand.d.ts +1 -1
- package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +1 -1
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +1 -1
- package/dist-types/commands/SearchFacesCommand.d.ts +1 -1
- package/dist-types/commands/SearchUsersByImageCommand.d.ts +1 -2
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -1
- package/dist-types/commands/StartMediaAnalysisJobCommand.d.ts +135 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +336 -406
- package/dist-types/models/models_1.d.ts +457 -1
- package/dist-types/pagination/ListMediaAnalysisJobsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
- package/dist-types/ts3.4/Rekognition.d.ts +51 -0
- package/dist-types/ts3.4/RekognitionClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/GetMediaAnalysisJobCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListMediaAnalysisJobsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/PutProjectPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RecognizeCelebritiesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchFacesByImageCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchFacesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMediaAnalysisJobCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +95 -74
- package/dist-types/ts3.4/models/models_1.d.ts +96 -2
- package/dist-types/ts3.4/pagination/ListMediaAnalysisJobsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +32 -32
|
@@ -1,6 +1,412 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { BlackFrame, ConnectedHomeSettingsForUpdate, DatasetChanges, DetectionFilter, FaceAttributes, FaceDetail, KinesisVideoStreamStartSelector, LabelDetectionFeatureName, LabelDetectionSettings, NotificationChannel, ProjectVersionStatus,
|
|
2
|
+
import { BlackFrame, BoundingBox, Celebrity, ComparedFace, ConnectedHomeSettingsForUpdate, DatasetChanges, DetectionFilter, FaceAttributes, FaceDetail, FaceMatch, Image, KinesisVideoStreamStartSelector, LabelDetectionFeatureName, LabelDetectionSettings, MatchedUser, MediaAnalysisInput, MediaAnalysisOperationsConfig, MediaAnalysisOutputConfig, NotificationChannel, OrientationCorrection, ProjectVersionStatus, QualityFilter, RegionOfInterest, SegmentType, StreamProcessorDataSharingPreference, Video } from "./models_0";
|
|
3
3
|
import { RekognitionServiceException as __BaseException } from "./RekognitionServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface PutProjectPolicyRequest {
|
|
8
|
+
/**
|
|
9
|
+
* @public
|
|
10
|
+
* <p>The Amazon Resource Name (ARN) of the project that the project policy is attached to.</p>
|
|
11
|
+
*/
|
|
12
|
+
ProjectArn: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
* <p>A name for the policy.</p>
|
|
16
|
+
*/
|
|
17
|
+
PolicyName: string | undefined;
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
* <p>The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels
|
|
21
|
+
* generates and assigns a new <code>PolicyRevisionId</code> and then deletes the previous version of the
|
|
22
|
+
* policy.</p>
|
|
23
|
+
*/
|
|
24
|
+
PolicyRevisionId?: string;
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>A resource policy to add to the model. The policy is a JSON structure that contains
|
|
28
|
+
* one or more statements that define the policy.
|
|
29
|
+
* The policy must follow the IAM syntax. For
|
|
30
|
+
* more information about the contents of a JSON policy document, see
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON policy reference</a>. </p>
|
|
32
|
+
*/
|
|
33
|
+
PolicyDocument: string | undefined;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
export interface PutProjectPolicyResponse {
|
|
39
|
+
/**
|
|
40
|
+
* @public
|
|
41
|
+
* <p>The ID of the project policy.</p>
|
|
42
|
+
*/
|
|
43
|
+
PolicyRevisionId?: string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export interface RecognizeCelebritiesRequest {
|
|
49
|
+
/**
|
|
50
|
+
* @public
|
|
51
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
52
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
53
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
54
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
55
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
56
|
+
*/
|
|
57
|
+
Image: Image | undefined;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export interface RecognizeCelebritiesResponse {
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
* <p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
|
|
66
|
+
* celebrities in an image. Each celebrity object includes the following attributes:
|
|
67
|
+
* <code>Face</code>, <code>Confidence</code>, <code>Emotions</code>, <code>Landmarks</code>,
|
|
68
|
+
* <code>Pose</code>, <code>Quality</code>, <code>Smile</code>, <code>Id</code>,
|
|
69
|
+
* <code>KnownGender</code>, <code>MatchConfidence</code>, <code>Name</code>,
|
|
70
|
+
* <code>Urls</code>.</p>
|
|
71
|
+
*/
|
|
72
|
+
CelebrityFaces?: Celebrity[];
|
|
73
|
+
/**
|
|
74
|
+
* @public
|
|
75
|
+
* <p>Details about each unrecognized face in the image.</p>
|
|
76
|
+
*/
|
|
77
|
+
UnrecognizedFaces?: ComparedFace[];
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
* <note>
|
|
81
|
+
* <p>Support for estimating image orientation using the the OrientationCorrection field
|
|
82
|
+
* has ceased as of August 2021. Any returned values for this field included in an API response
|
|
83
|
+
* will always be NULL.</p>
|
|
84
|
+
* </note>
|
|
85
|
+
* <p>The orientation of the input image (counterclockwise direction). If your application
|
|
86
|
+
* displays the image, you can use this value to correct the orientation. The bounding box
|
|
87
|
+
* coordinates returned in <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code>
|
|
88
|
+
* represent face locations before the image orientation is corrected. </p>
|
|
89
|
+
* <note>
|
|
90
|
+
* <p>If the input image is in .jpeg format, it might contain exchangeable image (Exif)
|
|
91
|
+
* metadata that includes the image's orientation. If so, and the Exif metadata for the input
|
|
92
|
+
* image populates the orientation field, the value of <code>OrientationCorrection</code> is
|
|
93
|
+
* null. The <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code> bounding box
|
|
94
|
+
* coordinates represent face locations after Exif metadata is used to correct the image
|
|
95
|
+
* orientation. Images in .png format don't contain Exif metadata. </p>
|
|
96
|
+
* </note>
|
|
97
|
+
*/
|
|
98
|
+
OrientationCorrection?: OrientationCorrection;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export interface SearchFacesRequest {
|
|
104
|
+
/**
|
|
105
|
+
* @public
|
|
106
|
+
* <p>ID of the collection the face belongs to.</p>
|
|
107
|
+
*/
|
|
108
|
+
CollectionId: string | undefined;
|
|
109
|
+
/**
|
|
110
|
+
* @public
|
|
111
|
+
* <p>ID of a face to find matches for in the collection.</p>
|
|
112
|
+
*/
|
|
113
|
+
FaceId: string | undefined;
|
|
114
|
+
/**
|
|
115
|
+
* @public
|
|
116
|
+
* <p>Maximum number of faces to return. The operation returns the maximum number of faces
|
|
117
|
+
* with the highest confidence in the match.</p>
|
|
118
|
+
*/
|
|
119
|
+
MaxFaces?: number;
|
|
120
|
+
/**
|
|
121
|
+
* @public
|
|
122
|
+
* <p>Optional value specifying the minimum confidence in the face match to return. For
|
|
123
|
+
* example, don't return any matches where confidence in matches is less than 70%. The default
|
|
124
|
+
* value is 80%. </p>
|
|
125
|
+
*/
|
|
126
|
+
FaceMatchThreshold?: number;
|
|
127
|
+
}
|
|
128
|
+
/**
|
|
129
|
+
* @public
|
|
130
|
+
*/
|
|
131
|
+
export interface SearchFacesResponse {
|
|
132
|
+
/**
|
|
133
|
+
* @public
|
|
134
|
+
* <p>ID of the face that was searched for matches in a collection.</p>
|
|
135
|
+
*/
|
|
136
|
+
SearchedFaceId?: string;
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
* <p>An array of faces that matched the input face, along with the confidence in the
|
|
140
|
+
* match.</p>
|
|
141
|
+
*/
|
|
142
|
+
FaceMatches?: FaceMatch[];
|
|
143
|
+
/**
|
|
144
|
+
* @public
|
|
145
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
146
|
+
* (<code>CollectionId</code>).</p>
|
|
147
|
+
*/
|
|
148
|
+
FaceModelVersion?: string;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export interface SearchFacesByImageRequest {
|
|
154
|
+
/**
|
|
155
|
+
* @public
|
|
156
|
+
* <p>ID of the collection to search.</p>
|
|
157
|
+
*/
|
|
158
|
+
CollectionId: string | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* @public
|
|
161
|
+
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
|
|
162
|
+
* call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
|
|
163
|
+
* <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
|
|
164
|
+
* base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
|
|
165
|
+
* Images in the Amazon Rekognition developer guide.</p>
|
|
166
|
+
*/
|
|
167
|
+
Image: Image | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
* <p>Maximum number of faces to return. The operation returns the maximum number of faces
|
|
171
|
+
* with the highest confidence in the match.</p>
|
|
172
|
+
*/
|
|
173
|
+
MaxFaces?: number;
|
|
174
|
+
/**
|
|
175
|
+
* @public
|
|
176
|
+
* <p>(Optional) Specifies the minimum confidence in the face match to return. For example,
|
|
177
|
+
* don't return any matches where confidence in matches is less than 70%. The default value is
|
|
178
|
+
* 80%.</p>
|
|
179
|
+
*/
|
|
180
|
+
FaceMatchThreshold?: number;
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
184
|
+
* Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>,
|
|
185
|
+
* Amazon Rekognition chooses the quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or
|
|
186
|
+
* <code>HIGH</code>, filtering removes all faces that don’t meet the chosen quality bar.
|
|
187
|
+
* The quality bar is
|
|
188
|
+
* based on a variety of common use cases. Low-quality detections can occur for a number of
|
|
189
|
+
* reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,
|
|
190
|
+
* or a face with a pose that's too extreme to use. If you specify <code>NONE</code>, no
|
|
191
|
+
* filtering is performed. The default value is <code>NONE</code>. </p>
|
|
192
|
+
* <p>To use quality filtering, the collection you are using must be associated with version 3
|
|
193
|
+
* of the face model or higher.</p>
|
|
194
|
+
*/
|
|
195
|
+
QualityFilter?: QualityFilter;
|
|
196
|
+
}
|
|
197
|
+
/**
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
export interface SearchFacesByImageResponse {
|
|
201
|
+
/**
|
|
202
|
+
* @public
|
|
203
|
+
* <p>The bounding box around the face in the input image that Amazon Rekognition used for the
|
|
204
|
+
* search.</p>
|
|
205
|
+
*/
|
|
206
|
+
SearchedFaceBoundingBox?: BoundingBox;
|
|
207
|
+
/**
|
|
208
|
+
* @public
|
|
209
|
+
* <p>The level of confidence that the <code>searchedFaceBoundingBox</code>, contains a
|
|
210
|
+
* face.</p>
|
|
211
|
+
*/
|
|
212
|
+
SearchedFaceConfidence?: number;
|
|
213
|
+
/**
|
|
214
|
+
* @public
|
|
215
|
+
* <p>An array of faces that match the input face, along with the confidence in the
|
|
216
|
+
* match.</p>
|
|
217
|
+
*/
|
|
218
|
+
FaceMatches?: FaceMatch[];
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
222
|
+
* (<code>CollectionId</code>).</p>
|
|
223
|
+
*/
|
|
224
|
+
FaceModelVersion?: string;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
export interface SearchUsersRequest {
|
|
230
|
+
/**
|
|
231
|
+
* @public
|
|
232
|
+
* <p>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a
|
|
233
|
+
* FaceId is provided, UserId isn’t required to be present in the Collection.</p>
|
|
234
|
+
*/
|
|
235
|
+
CollectionId: string | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* @public
|
|
238
|
+
* <p>ID for the existing User.</p>
|
|
239
|
+
*/
|
|
240
|
+
UserId?: string;
|
|
241
|
+
/**
|
|
242
|
+
* @public
|
|
243
|
+
* <p>ID for the existing face.</p>
|
|
244
|
+
*/
|
|
245
|
+
FaceId?: string;
|
|
246
|
+
/**
|
|
247
|
+
* @public
|
|
248
|
+
* <p>Optional value that specifies the minimum confidence in the matched UserID to return.
|
|
249
|
+
* Default value of 80.</p>
|
|
250
|
+
*/
|
|
251
|
+
UserMatchThreshold?: number;
|
|
252
|
+
/**
|
|
253
|
+
* @public
|
|
254
|
+
* <p>Maximum number of identities to return.</p>
|
|
255
|
+
*/
|
|
256
|
+
MaxUsers?: number;
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* @public
|
|
260
|
+
* <p>Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for
|
|
261
|
+
* search.</p>
|
|
262
|
+
*/
|
|
263
|
+
export interface SearchedFace {
|
|
264
|
+
/**
|
|
265
|
+
* @public
|
|
266
|
+
* <p> Unique identifier assigned to the face.</p>
|
|
267
|
+
*/
|
|
268
|
+
FaceId?: string;
|
|
269
|
+
}
|
|
270
|
+
/**
|
|
271
|
+
* @public
|
|
272
|
+
* <p>Contains metadata about a User searched for within a collection.</p>
|
|
273
|
+
*/
|
|
274
|
+
export interface SearchedUser {
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
* <p> A provided ID for the UserID. Unique within the collection. </p>
|
|
278
|
+
*/
|
|
279
|
+
UserId?: string;
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* @public
|
|
283
|
+
* <p>Provides UserID metadata along with the confidence in the match of this UserID with the
|
|
284
|
+
* input face.</p>
|
|
285
|
+
*/
|
|
286
|
+
export interface UserMatch {
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
* <p> Describes the UserID metadata.</p>
|
|
290
|
+
*/
|
|
291
|
+
Similarity?: number;
|
|
292
|
+
/**
|
|
293
|
+
* @public
|
|
294
|
+
* <p> Confidence in the match of this UserID with the input face. </p>
|
|
295
|
+
*/
|
|
296
|
+
User?: MatchedUser;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
export interface SearchUsersResponse {
|
|
302
|
+
/**
|
|
303
|
+
* @public
|
|
304
|
+
* <p>An array of UserMatch objects that matched the input face along with the confidence in the
|
|
305
|
+
* match. Array will be empty if there are no matches.</p>
|
|
306
|
+
*/
|
|
307
|
+
UserMatches?: UserMatch[];
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
310
|
+
* <p>Version number of the face detection model associated with the input CollectionId.</p>
|
|
311
|
+
*/
|
|
312
|
+
FaceModelVersion?: string;
|
|
313
|
+
/**
|
|
314
|
+
* @public
|
|
315
|
+
* <p>Contains the ID of a face that was used to search for matches in a collection.</p>
|
|
316
|
+
*/
|
|
317
|
+
SearchedFace?: SearchedFace;
|
|
318
|
+
/**
|
|
319
|
+
* @public
|
|
320
|
+
* <p>Contains the ID of the UserID that was used to search for matches in a collection.</p>
|
|
321
|
+
*/
|
|
322
|
+
SearchedUser?: SearchedUser;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
export interface SearchUsersByImageRequest {
|
|
328
|
+
/**
|
|
329
|
+
* @public
|
|
330
|
+
* <p>The ID of an existing collection containing the UserID.</p>
|
|
331
|
+
*/
|
|
332
|
+
CollectionId: string | undefined;
|
|
333
|
+
/**
|
|
334
|
+
* @public
|
|
335
|
+
* <p>Provides the input image either as bytes or an S3 object.</p>
|
|
336
|
+
* <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
|
|
337
|
+
* property. For example, you would use the <code>Bytes</code> property to pass an image loaded
|
|
338
|
+
* from a local file system. Image bytes passed by using the <code>Bytes</code> property must be
|
|
339
|
+
* base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to
|
|
340
|
+
* call Amazon Rekognition API operations. </p>
|
|
341
|
+
* <p>For more information, see Analyzing an Image Loaded from a Local File System
|
|
342
|
+
* in the Amazon Rekognition Developer Guide.</p>
|
|
343
|
+
* <p> You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the
|
|
344
|
+
* <code>S3Object</code> property. Images stored in an S3 bucket do not need to be
|
|
345
|
+
* base64-encoded.</p>
|
|
346
|
+
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
347
|
+
* Amazon Rekognition operations.</p>
|
|
348
|
+
* <p>If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the
|
|
349
|
+
* Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and
|
|
350
|
+
* then call the operation using the S3Object property.</p>
|
|
351
|
+
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
352
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
353
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
354
|
+
*/
|
|
355
|
+
Image: Image | undefined;
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
* <p>Specifies the minimum confidence in the UserID match to return. Default value is
|
|
359
|
+
* 80.</p>
|
|
360
|
+
*/
|
|
361
|
+
UserMatchThreshold?: number;
|
|
362
|
+
/**
|
|
363
|
+
* @public
|
|
364
|
+
* <p>Maximum number of UserIDs to return.</p>
|
|
365
|
+
*/
|
|
366
|
+
MaxUsers?: number;
|
|
367
|
+
/**
|
|
368
|
+
* @public
|
|
369
|
+
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
370
|
+
* Filtered faces aren't searched for in the collection. The default value is NONE.</p>
|
|
371
|
+
*/
|
|
372
|
+
QualityFilter?: QualityFilter;
|
|
373
|
+
}
|
|
374
|
+
/**
|
|
375
|
+
* @public
|
|
376
|
+
* <p>Contains data regarding the input face used for a search.</p>
|
|
377
|
+
*/
|
|
378
|
+
export interface SearchedFaceDetails {
|
|
379
|
+
/**
|
|
380
|
+
* @public
|
|
381
|
+
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
382
|
+
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
383
|
+
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
384
|
+
* <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
|
|
385
|
+
* <code>Quality</code>.</p>
|
|
386
|
+
* <p>
|
|
387
|
+
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
388
|
+
* return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
|
|
389
|
+
* return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
|
|
390
|
+
* attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
|
|
391
|
+
* parameter:</p>
|
|
392
|
+
* <ul>
|
|
393
|
+
* <li>
|
|
394
|
+
* <p>GetCelebrityRecognition</p>
|
|
395
|
+
* </li>
|
|
396
|
+
* <li>
|
|
397
|
+
* <p>GetPersonTracking</p>
|
|
398
|
+
* </li>
|
|
399
|
+
* <li>
|
|
400
|
+
* <p>GetFaceSearch</p>
|
|
401
|
+
* </li>
|
|
402
|
+
* </ul>
|
|
403
|
+
* <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
|
|
404
|
+
* can return all facial attributes. To specify which attributes to return, use the
|
|
405
|
+
* <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
|
|
406
|
+
* <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
|
|
407
|
+
*/
|
|
408
|
+
FaceDetail?: FaceDetail;
|
|
409
|
+
}
|
|
4
410
|
/**
|
|
5
411
|
* @public
|
|
6
412
|
* @enum
|
|
@@ -366,6 +772,56 @@ export interface StartLabelDetectionResponse {
|
|
|
366
772
|
*/
|
|
367
773
|
JobId?: string;
|
|
368
774
|
}
|
|
775
|
+
/**
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
export interface StartMediaAnalysisJobRequest {
|
|
779
|
+
/**
|
|
780
|
+
* @public
|
|
781
|
+
* <p>Idempotency token used to prevent the accidental creation of duplicate versions. If
|
|
782
|
+
* you use the same token with multiple <code>StartMediaAnalysisJobRequest</code> requests, the same
|
|
783
|
+
* response is returned. Use <code>ClientRequestToken</code> to prevent the same request from being
|
|
784
|
+
* processed more than once.</p>
|
|
785
|
+
*/
|
|
786
|
+
ClientRequestToken?: string;
|
|
787
|
+
/**
|
|
788
|
+
* @public
|
|
789
|
+
* <p>The name of the job. Does not have to be unique.</p>
|
|
790
|
+
*/
|
|
791
|
+
JobName?: string;
|
|
792
|
+
/**
|
|
793
|
+
* @public
|
|
794
|
+
* <p>Configuration options for the media analysis job to be created.</p>
|
|
795
|
+
*/
|
|
796
|
+
OperationsConfig: MediaAnalysisOperationsConfig | undefined;
|
|
797
|
+
/**
|
|
798
|
+
* @public
|
|
799
|
+
* <p>Input data to be analyzed by the job.</p>
|
|
800
|
+
*/
|
|
801
|
+
Input: MediaAnalysisInput | undefined;
|
|
802
|
+
/**
|
|
803
|
+
* @public
|
|
804
|
+
* <p>The Amazon S3 bucket location to store the results.</p>
|
|
805
|
+
*/
|
|
806
|
+
OutputConfig: MediaAnalysisOutputConfig | undefined;
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
* <p>The identifier of customer managed AWS KMS key (name or ARN). The key
|
|
810
|
+
* is used to encrypt images copied into the service. The key is also used
|
|
811
|
+
* to encrypt results and manifest files written to the output Amazon S3 bucket.</p>
|
|
812
|
+
*/
|
|
813
|
+
KmsKeyId?: string;
|
|
814
|
+
}
|
|
815
|
+
/**
|
|
816
|
+
* @public
|
|
817
|
+
*/
|
|
818
|
+
export interface StartMediaAnalysisJobResponse {
|
|
819
|
+
/**
|
|
820
|
+
* @public
|
|
821
|
+
* <p>Identifier for the created job.</p>
|
|
822
|
+
*/
|
|
823
|
+
JobId: string | undefined;
|
|
824
|
+
}
|
|
369
825
|
/**
|
|
370
826
|
* @public
|
|
371
827
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListMediaAnalysisJobsCommandInput, ListMediaAnalysisJobsCommandOutput } from "../commands/ListMediaAnalysisJobsCommand";
|
|
3
|
+
import { RekognitionPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare function paginateListMediaAnalysisJobs(config: RekognitionPaginationConfiguration, input: ListMediaAnalysisJobsCommandInput, ...additionalArguments: any): Paginator<ListMediaAnalysisJobsCommandOutput>;
|
|
@@ -13,6 +13,7 @@ export * from "./ListCollectionsPaginator";
|
|
|
13
13
|
export * from "./ListDatasetEntriesPaginator";
|
|
14
14
|
export * from "./ListDatasetLabelsPaginator";
|
|
15
15
|
export * from "./ListFacesPaginator";
|
|
16
|
+
export * from "./ListMediaAnalysisJobsPaginator";
|
|
16
17
|
export * from "./ListProjectPoliciesPaginator";
|
|
17
18
|
export * from "./ListStreamProcessorsPaginator";
|
|
18
19
|
export * from "./ListUsersPaginator";
|
|
@@ -38,6 +38,7 @@ import { GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput } from "../
|
|
|
38
38
|
import { GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput } from "../commands/GetFaceLivenessSessionResultsCommand";
|
|
39
39
|
import { GetFaceSearchCommandInput, GetFaceSearchCommandOutput } from "../commands/GetFaceSearchCommand";
|
|
40
40
|
import { GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput } from "../commands/GetLabelDetectionCommand";
|
|
41
|
+
import { GetMediaAnalysisJobCommandInput, GetMediaAnalysisJobCommandOutput } from "../commands/GetMediaAnalysisJobCommand";
|
|
41
42
|
import { GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput } from "../commands/GetPersonTrackingCommand";
|
|
42
43
|
import { GetSegmentDetectionCommandInput, GetSegmentDetectionCommandOutput } from "../commands/GetSegmentDetectionCommand";
|
|
43
44
|
import { GetTextDetectionCommandInput, GetTextDetectionCommandOutput } from "../commands/GetTextDetectionCommand";
|
|
@@ -46,6 +47,7 @@ import { ListCollectionsCommandInput, ListCollectionsCommandOutput } from "../co
|
|
|
46
47
|
import { ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput } from "../commands/ListDatasetEntriesCommand";
|
|
47
48
|
import { ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput } from "../commands/ListDatasetLabelsCommand";
|
|
48
49
|
import { ListFacesCommandInput, ListFacesCommandOutput } from "../commands/ListFacesCommand";
|
|
50
|
+
import { ListMediaAnalysisJobsCommandInput, ListMediaAnalysisJobsCommandOutput } from "../commands/ListMediaAnalysisJobsCommand";
|
|
49
51
|
import { ListProjectPoliciesCommandInput, ListProjectPoliciesCommandOutput } from "../commands/ListProjectPoliciesCommand";
|
|
50
52
|
import { ListStreamProcessorsCommandInput, ListStreamProcessorsCommandOutput } from "../commands/ListStreamProcessorsCommand";
|
|
51
53
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
|
|
@@ -61,6 +63,7 @@ import { StartContentModerationCommandInput, StartContentModerationCommandOutput
|
|
|
61
63
|
import { StartFaceDetectionCommandInput, StartFaceDetectionCommandOutput } from "../commands/StartFaceDetectionCommand";
|
|
62
64
|
import { StartFaceSearchCommandInput, StartFaceSearchCommandOutput } from "../commands/StartFaceSearchCommand";
|
|
63
65
|
import { StartLabelDetectionCommandInput, StartLabelDetectionCommandOutput } from "../commands/StartLabelDetectionCommand";
|
|
66
|
+
import { StartMediaAnalysisJobCommandInput, StartMediaAnalysisJobCommandOutput } from "../commands/StartMediaAnalysisJobCommand";
|
|
64
67
|
import { StartPersonTrackingCommandInput, StartPersonTrackingCommandOutput } from "../commands/StartPersonTrackingCommand";
|
|
65
68
|
import { StartProjectVersionCommandInput, StartProjectVersionCommandOutput } from "../commands/StartProjectVersionCommand";
|
|
66
69
|
import { StartSegmentDetectionCommandInput, StartSegmentDetectionCommandOutput } from "../commands/StartSegmentDetectionCommand";
|
|
@@ -224,6 +227,10 @@ export declare const se_GetFaceSearchCommand: (input: GetFaceSearchCommandInput,
|
|
|
224
227
|
* serializeAws_json1_1GetLabelDetectionCommand
|
|
225
228
|
*/
|
|
226
229
|
export declare const se_GetLabelDetectionCommand: (input: GetLabelDetectionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
230
|
+
/**
|
|
231
|
+
* serializeAws_json1_1GetMediaAnalysisJobCommand
|
|
232
|
+
*/
|
|
233
|
+
export declare const se_GetMediaAnalysisJobCommand: (input: GetMediaAnalysisJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
227
234
|
/**
|
|
228
235
|
* serializeAws_json1_1GetPersonTrackingCommand
|
|
229
236
|
*/
|
|
@@ -256,6 +263,10 @@ export declare const se_ListDatasetLabelsCommand: (input: ListDatasetLabelsComma
|
|
|
256
263
|
* serializeAws_json1_1ListFacesCommand
|
|
257
264
|
*/
|
|
258
265
|
export declare const se_ListFacesCommand: (input: ListFacesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
266
|
+
/**
|
|
267
|
+
* serializeAws_json1_1ListMediaAnalysisJobsCommand
|
|
268
|
+
*/
|
|
269
|
+
export declare const se_ListMediaAnalysisJobsCommand: (input: ListMediaAnalysisJobsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
259
270
|
/**
|
|
260
271
|
* serializeAws_json1_1ListProjectPoliciesCommand
|
|
261
272
|
*/
|
|
@@ -316,6 +327,10 @@ export declare const se_StartFaceSearchCommand: (input: StartFaceSearchCommandIn
|
|
|
316
327
|
* serializeAws_json1_1StartLabelDetectionCommand
|
|
317
328
|
*/
|
|
318
329
|
export declare const se_StartLabelDetectionCommand: (input: StartLabelDetectionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
330
|
+
/**
|
|
331
|
+
* serializeAws_json1_1StartMediaAnalysisJobCommand
|
|
332
|
+
*/
|
|
333
|
+
export declare const se_StartMediaAnalysisJobCommand: (input: StartMediaAnalysisJobCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
319
334
|
/**
|
|
320
335
|
* serializeAws_json1_1StartPersonTrackingCommand
|
|
321
336
|
*/
|
|
@@ -512,6 +527,10 @@ export declare const de_GetFaceSearchCommand: (output: __HttpResponse, context:
|
|
|
512
527
|
* deserializeAws_json1_1GetLabelDetectionCommand
|
|
513
528
|
*/
|
|
514
529
|
export declare const de_GetLabelDetectionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetLabelDetectionCommandOutput>;
|
|
530
|
+
/**
|
|
531
|
+
* deserializeAws_json1_1GetMediaAnalysisJobCommand
|
|
532
|
+
*/
|
|
533
|
+
export declare const de_GetMediaAnalysisJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetMediaAnalysisJobCommandOutput>;
|
|
515
534
|
/**
|
|
516
535
|
* deserializeAws_json1_1GetPersonTrackingCommand
|
|
517
536
|
*/
|
|
@@ -544,6 +563,10 @@ export declare const de_ListDatasetLabelsCommand: (output: __HttpResponse, conte
|
|
|
544
563
|
* deserializeAws_json1_1ListFacesCommand
|
|
545
564
|
*/
|
|
546
565
|
export declare const de_ListFacesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListFacesCommandOutput>;
|
|
566
|
+
/**
|
|
567
|
+
* deserializeAws_json1_1ListMediaAnalysisJobsCommand
|
|
568
|
+
*/
|
|
569
|
+
export declare const de_ListMediaAnalysisJobsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListMediaAnalysisJobsCommandOutput>;
|
|
547
570
|
/**
|
|
548
571
|
* deserializeAws_json1_1ListProjectPoliciesCommand
|
|
549
572
|
*/
|
|
@@ -604,6 +627,10 @@ export declare const de_StartFaceSearchCommand: (output: __HttpResponse, context
|
|
|
604
627
|
* deserializeAws_json1_1StartLabelDetectionCommand
|
|
605
628
|
*/
|
|
606
629
|
export declare const de_StartLabelDetectionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartLabelDetectionCommandOutput>;
|
|
630
|
+
/**
|
|
631
|
+
* deserializeAws_json1_1StartMediaAnalysisJobCommand
|
|
632
|
+
*/
|
|
633
|
+
export declare const de_StartMediaAnalysisJobCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StartMediaAnalysisJobCommandOutput>;
|
|
607
634
|
/**
|
|
608
635
|
* deserializeAws_json1_1StartPersonTrackingCommand
|
|
609
636
|
*/
|
|
@@ -151,6 +151,10 @@ import {
|
|
|
151
151
|
GetLabelDetectionCommandInput,
|
|
152
152
|
GetLabelDetectionCommandOutput,
|
|
153
153
|
} from "./commands/GetLabelDetectionCommand";
|
|
154
|
+
import {
|
|
155
|
+
GetMediaAnalysisJobCommandInput,
|
|
156
|
+
GetMediaAnalysisJobCommandOutput,
|
|
157
|
+
} from "./commands/GetMediaAnalysisJobCommand";
|
|
154
158
|
import {
|
|
155
159
|
GetPersonTrackingCommandInput,
|
|
156
160
|
GetPersonTrackingCommandOutput,
|
|
@@ -183,6 +187,10 @@ import {
|
|
|
183
187
|
ListFacesCommandInput,
|
|
184
188
|
ListFacesCommandOutput,
|
|
185
189
|
} from "./commands/ListFacesCommand";
|
|
190
|
+
import {
|
|
191
|
+
ListMediaAnalysisJobsCommandInput,
|
|
192
|
+
ListMediaAnalysisJobsCommandOutput,
|
|
193
|
+
} from "./commands/ListMediaAnalysisJobsCommand";
|
|
186
194
|
import {
|
|
187
195
|
ListProjectPoliciesCommandInput,
|
|
188
196
|
ListProjectPoliciesCommandOutput,
|
|
@@ -243,6 +251,10 @@ import {
|
|
|
243
251
|
StartLabelDetectionCommandInput,
|
|
244
252
|
StartLabelDetectionCommandOutput,
|
|
245
253
|
} from "./commands/StartLabelDetectionCommand";
|
|
254
|
+
import {
|
|
255
|
+
StartMediaAnalysisJobCommandInput,
|
|
256
|
+
StartMediaAnalysisJobCommandOutput,
|
|
257
|
+
} from "./commands/StartMediaAnalysisJobCommand";
|
|
246
258
|
import {
|
|
247
259
|
StartPersonTrackingCommandInput,
|
|
248
260
|
StartPersonTrackingCommandOutput,
|
|
@@ -783,6 +795,19 @@ export interface Rekognition {
|
|
|
783
795
|
options: __HttpHandlerOptions,
|
|
784
796
|
cb: (err: any, data?: GetLabelDetectionCommandOutput) => void
|
|
785
797
|
): void;
|
|
798
|
+
getMediaAnalysisJob(
|
|
799
|
+
args: GetMediaAnalysisJobCommandInput,
|
|
800
|
+
options?: __HttpHandlerOptions
|
|
801
|
+
): Promise<GetMediaAnalysisJobCommandOutput>;
|
|
802
|
+
getMediaAnalysisJob(
|
|
803
|
+
args: GetMediaAnalysisJobCommandInput,
|
|
804
|
+
cb: (err: any, data?: GetMediaAnalysisJobCommandOutput) => void
|
|
805
|
+
): void;
|
|
806
|
+
getMediaAnalysisJob(
|
|
807
|
+
args: GetMediaAnalysisJobCommandInput,
|
|
808
|
+
options: __HttpHandlerOptions,
|
|
809
|
+
cb: (err: any, data?: GetMediaAnalysisJobCommandOutput) => void
|
|
810
|
+
): void;
|
|
786
811
|
getPersonTracking(
|
|
787
812
|
args: GetPersonTrackingCommandInput,
|
|
788
813
|
options?: __HttpHandlerOptions
|
|
@@ -887,6 +912,19 @@ export interface Rekognition {
|
|
|
887
912
|
options: __HttpHandlerOptions,
|
|
888
913
|
cb: (err: any, data?: ListFacesCommandOutput) => void
|
|
889
914
|
): void;
|
|
915
|
+
listMediaAnalysisJobs(
|
|
916
|
+
args: ListMediaAnalysisJobsCommandInput,
|
|
917
|
+
options?: __HttpHandlerOptions
|
|
918
|
+
): Promise<ListMediaAnalysisJobsCommandOutput>;
|
|
919
|
+
listMediaAnalysisJobs(
|
|
920
|
+
args: ListMediaAnalysisJobsCommandInput,
|
|
921
|
+
cb: (err: any, data?: ListMediaAnalysisJobsCommandOutput) => void
|
|
922
|
+
): void;
|
|
923
|
+
listMediaAnalysisJobs(
|
|
924
|
+
args: ListMediaAnalysisJobsCommandInput,
|
|
925
|
+
options: __HttpHandlerOptions,
|
|
926
|
+
cb: (err: any, data?: ListMediaAnalysisJobsCommandOutput) => void
|
|
927
|
+
): void;
|
|
890
928
|
listProjectPolicies(
|
|
891
929
|
args: ListProjectPoliciesCommandInput,
|
|
892
930
|
options?: __HttpHandlerOptions
|
|
@@ -1082,6 +1120,19 @@ export interface Rekognition {
|
|
|
1082
1120
|
options: __HttpHandlerOptions,
|
|
1083
1121
|
cb: (err: any, data?: StartLabelDetectionCommandOutput) => void
|
|
1084
1122
|
): void;
|
|
1123
|
+
startMediaAnalysisJob(
|
|
1124
|
+
args: StartMediaAnalysisJobCommandInput,
|
|
1125
|
+
options?: __HttpHandlerOptions
|
|
1126
|
+
): Promise<StartMediaAnalysisJobCommandOutput>;
|
|
1127
|
+
startMediaAnalysisJob(
|
|
1128
|
+
args: StartMediaAnalysisJobCommandInput,
|
|
1129
|
+
cb: (err: any, data?: StartMediaAnalysisJobCommandOutput) => void
|
|
1130
|
+
): void;
|
|
1131
|
+
startMediaAnalysisJob(
|
|
1132
|
+
args: StartMediaAnalysisJobCommandInput,
|
|
1133
|
+
options: __HttpHandlerOptions,
|
|
1134
|
+
cb: (err: any, data?: StartMediaAnalysisJobCommandOutput) => void
|
|
1135
|
+
): void;
|
|
1085
1136
|
startPersonTracking(
|
|
1086
1137
|
args: StartPersonTrackingCommandInput,
|
|
1087
1138
|
options?: __HttpHandlerOptions
|