@aws-sdk/client-rekognition 3.350.0 → 3.352.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 +98 -7
- package/dist-cjs/Rekognition.js +14 -0
- package/dist-cjs/commands/AssociateFacesCommand.js +46 -0
- package/dist-cjs/commands/CreateUserCommand.js +46 -0
- package/dist-cjs/commands/DeleteUserCommand.js +46 -0
- package/dist-cjs/commands/DisassociateFacesCommand.js +46 -0
- package/dist-cjs/commands/ListUsersCommand.js +46 -0
- package/dist-cjs/commands/SearchUsersByImageCommand.js +46 -0
- package/dist-cjs/commands/SearchUsersCommand.js +46 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/models/models_0.js +159 -130
- package/dist-cjs/models/models_1.js +18 -1
- package/dist-cjs/pagination/ListUsersPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +565 -4
- package/dist-es/Rekognition.js +14 -0
- package/dist-es/commands/AssociateFacesCommand.js +42 -0
- package/dist-es/commands/CreateUserCommand.js +42 -0
- package/dist-es/commands/DeleteUserCommand.js +42 -0
- package/dist-es/commands/DisassociateFacesCommand.js +42 -0
- package/dist-es/commands/ListUsersCommand.js +42 -0
- package/dist-es/commands/SearchUsersByImageCommand.js +42 -0
- package/dist-es/commands/SearchUsersCommand.js +42 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/models/models_0.js +149 -120
- package/dist-es/models/models_1.js +16 -0
- package/dist-es/pagination/ListUsersPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +548 -1
- package/dist-types/Rekognition.d.ts +84 -0
- package/dist-types/RekognitionClient.d.ts +44 -2
- package/dist-types/commands/AssociateFacesCommand.d.ts +203 -0
- package/dist-types/commands/CreateUserCommand.d.ts +126 -0
- package/dist-types/commands/DeleteFacesCommand.d.ts +9 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +119 -0
- package/dist-types/commands/DescribeCollectionCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateFacesCommand.d.ts +164 -0
- package/dist-types/commands/GetFaceSearchCommand.d.ts +1 -0
- package/dist-types/commands/IndexFacesCommand.d.ts +1 -0
- package/dist-types/commands/ListFacesCommand.d.ts +5 -0
- package/dist-types/commands/ListUsersCommand.d.ts +134 -0
- package/dist-types/commands/SearchFacesByImageCommand.d.ts +1 -0
- package/dist-types/commands/SearchFacesCommand.d.ts +1 -0
- package/dist-types/commands/SearchUsersByImageCommand.d.ts +366 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +148 -0
- package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +2 -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 +1 -1
- package/dist-types/commands/StartLabelDetectionCommand.d.ts +1 -1
- package/dist-types/commands/StartPersonTrackingCommand.d.ts +1 -1
- package/dist-types/commands/StartProjectVersionCommand.d.ts +1 -1
- package/dist-types/commands/StartSegmentDetectionCommand.d.ts +1 -1
- package/dist-types/commands/StartStreamProcessorCommand.d.ts +1 -1
- package/dist-types/commands/StartTextDetectionCommand.d.ts +1 -1
- package/dist-types/commands/StopProjectVersionCommand.d.ts +1 -1
- package/dist-types/commands/StopStreamProcessorCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/index.d.ts +35 -0
- package/dist-types/models/models_0.d.ts +668 -604
- package/dist-types/models/models_1.d.ts +562 -1
- package/dist-types/pagination/ListUsersPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +63 -0
- package/dist-types/ts3.4/Rekognition.d.ts +119 -0
- package/dist-types/ts3.4/RekognitionClient.d.ts +42 -0
- package/dist-types/ts3.4/commands/AssociateFacesCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/CreateUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DeleteUserCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DisassociateFacesCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartContentModerationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartFaceDetectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartFaceSearchCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartLabelDetectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartPersonTrackingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartProjectVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartSegmentDetectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartStreamProcessorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartTextDetectionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopProjectVersionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopStreamProcessorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +236 -206
- package/dist-types/ts3.4/models/models_1.d.ts +150 -0
- package/dist-types/ts3.4/pagination/ListUsersPaginator.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 +84 -0
- package/package.json +8 -6
|
@@ -87,6 +87,266 @@ export interface Asset {
|
|
|
87
87
|
*/
|
|
88
88
|
GroundTruthManifest?: GroundTruthManifest;
|
|
89
89
|
}
|
|
90
|
+
/**
|
|
91
|
+
* @public
|
|
92
|
+
* <p>Provides face metadata for the faces that are associated to a specific UserID.</p>
|
|
93
|
+
*/
|
|
94
|
+
export interface AssociatedFace {
|
|
95
|
+
/**
|
|
96
|
+
* <p>Unique identifier assigned to the face.</p>
|
|
97
|
+
*/
|
|
98
|
+
FaceId?: string;
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
export interface AssociateFacesRequest {
|
|
104
|
+
/**
|
|
105
|
+
* <p>The ID of an existing collection containing the UserID.</p>
|
|
106
|
+
*/
|
|
107
|
+
CollectionId: string | undefined;
|
|
108
|
+
/**
|
|
109
|
+
* <p>The ID for the existing UserID.</p>
|
|
110
|
+
*/
|
|
111
|
+
UserId: string | undefined;
|
|
112
|
+
/**
|
|
113
|
+
* <p>An array of FaceIDs to associate with the UserID.</p>
|
|
114
|
+
*/
|
|
115
|
+
FaceIds: string[] | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>An optional value specifying the minimum confidence in the UserID match to return. The
|
|
118
|
+
* default value is 75.</p>
|
|
119
|
+
*/
|
|
120
|
+
UserMatchThreshold?: number;
|
|
121
|
+
/**
|
|
122
|
+
* <p>Idempotent token used to identify the request to <code>AssociateFaces</code>. If you use
|
|
123
|
+
* the same token with multiple <code>AssociateFaces</code> requests, the same response is returned.
|
|
124
|
+
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
125
|
+
* once.</p>
|
|
126
|
+
*/
|
|
127
|
+
ClientRequestToken?: string;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
* @enum
|
|
132
|
+
*/
|
|
133
|
+
export declare const UnsuccessfulFaceAssociationReason: {
|
|
134
|
+
readonly ASSOCIATED_TO_A_DIFFERENT_USER: "ASSOCIATED_TO_A_DIFFERENT_USER";
|
|
135
|
+
readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
|
|
136
|
+
readonly LOW_MATCH_CONFIDENCE: "LOW_MATCH_CONFIDENCE";
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* @public
|
|
140
|
+
*/
|
|
141
|
+
export type UnsuccessfulFaceAssociationReason = (typeof UnsuccessfulFaceAssociationReason)[keyof typeof UnsuccessfulFaceAssociationReason];
|
|
142
|
+
/**
|
|
143
|
+
* @public
|
|
144
|
+
* <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully associated.</p>
|
|
145
|
+
*/
|
|
146
|
+
export interface UnsuccessfulFaceAssociation {
|
|
147
|
+
/**
|
|
148
|
+
* <p>A unique identifier assigned to the face. </p>
|
|
149
|
+
*/
|
|
150
|
+
FaceId?: string;
|
|
151
|
+
/**
|
|
152
|
+
* <p>A provided ID for the UserID. Unique within the collection. </p>
|
|
153
|
+
*/
|
|
154
|
+
UserId?: string;
|
|
155
|
+
/**
|
|
156
|
+
* <p>Match confidence with the UserID, provides information regarding if a face association was
|
|
157
|
+
* unsuccessful because it didn't meet UserMatchThreshold.</p>
|
|
158
|
+
*/
|
|
159
|
+
Confidence?: number;
|
|
160
|
+
/**
|
|
161
|
+
* <p> The reason why the association was unsuccessful. </p>
|
|
162
|
+
*/
|
|
163
|
+
Reasons?: (UnsuccessfulFaceAssociationReason | string)[];
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
* @enum
|
|
168
|
+
*/
|
|
169
|
+
export declare const UserStatus: {
|
|
170
|
+
readonly ACTIVE: "ACTIVE";
|
|
171
|
+
readonly CREATED: "CREATED";
|
|
172
|
+
readonly CREATING: "CREATING";
|
|
173
|
+
readonly UPDATING: "UPDATING";
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
|
|
179
|
+
/**
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
export interface AssociateFacesResponse {
|
|
183
|
+
/**
|
|
184
|
+
* <p>An array of AssociatedFace objects containing FaceIDs that are successfully associated
|
|
185
|
+
* with the UserID is returned. Returned if the AssociateFaces action is successful.</p>
|
|
186
|
+
*/
|
|
187
|
+
AssociatedFaces?: AssociatedFace[];
|
|
188
|
+
/**
|
|
189
|
+
* <p>An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully
|
|
190
|
+
* associated along with the reasons. Returned if the AssociateFaces action is successful.</p>
|
|
191
|
+
*/
|
|
192
|
+
UnsuccessfulFaceAssociations?: UnsuccessfulFaceAssociation[];
|
|
193
|
+
/**
|
|
194
|
+
* <p>The status of an update made to a UserID. Reflects if the UserID has been updated for
|
|
195
|
+
* every requested change.</p>
|
|
196
|
+
*/
|
|
197
|
+
UserStatus?: UserStatus | string;
|
|
198
|
+
}
|
|
199
|
+
/**
|
|
200
|
+
* @public
|
|
201
|
+
* <p>
|
|
202
|
+
* A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
|
|
203
|
+
* </p>
|
|
204
|
+
*/
|
|
205
|
+
export declare class ConflictException extends __BaseException {
|
|
206
|
+
readonly name: "ConflictException";
|
|
207
|
+
readonly $fault: "client";
|
|
208
|
+
Message?: string;
|
|
209
|
+
Code?: string;
|
|
210
|
+
/**
|
|
211
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
212
|
+
*/
|
|
213
|
+
Logref?: string;
|
|
214
|
+
/**
|
|
215
|
+
* @internal
|
|
216
|
+
*/
|
|
217
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
218
|
+
}
|
|
219
|
+
/**
|
|
220
|
+
* @public
|
|
221
|
+
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
|
|
222
|
+
* parameters is different from the previous call to the operation.</p>
|
|
223
|
+
*/
|
|
224
|
+
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
225
|
+
readonly name: "IdempotentParameterMismatchException";
|
|
226
|
+
readonly $fault: "client";
|
|
227
|
+
Message?: string;
|
|
228
|
+
Code?: string;
|
|
229
|
+
/**
|
|
230
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
231
|
+
*/
|
|
232
|
+
Logref?: string;
|
|
233
|
+
/**
|
|
234
|
+
* @internal
|
|
235
|
+
*/
|
|
236
|
+
constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* @public
|
|
240
|
+
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
241
|
+
*/
|
|
242
|
+
export declare class InternalServerError extends __BaseException {
|
|
243
|
+
readonly name: "InternalServerError";
|
|
244
|
+
readonly $fault: "server";
|
|
245
|
+
Message?: string;
|
|
246
|
+
Code?: string;
|
|
247
|
+
/**
|
|
248
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
249
|
+
*/
|
|
250
|
+
Logref?: string;
|
|
251
|
+
/**
|
|
252
|
+
* @internal
|
|
253
|
+
*/
|
|
254
|
+
constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
|
|
255
|
+
}
|
|
256
|
+
/**
|
|
257
|
+
* @public
|
|
258
|
+
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
259
|
+
* operation again.</p>
|
|
260
|
+
*/
|
|
261
|
+
export declare class InvalidParameterException extends __BaseException {
|
|
262
|
+
readonly name: "InvalidParameterException";
|
|
263
|
+
readonly $fault: "client";
|
|
264
|
+
Message?: string;
|
|
265
|
+
Code?: string;
|
|
266
|
+
/**
|
|
267
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
268
|
+
*/
|
|
269
|
+
Logref?: string;
|
|
270
|
+
/**
|
|
271
|
+
* @internal
|
|
272
|
+
*/
|
|
273
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
278
|
+
* limit, contact Amazon Rekognition.</p>
|
|
279
|
+
*/
|
|
280
|
+
export declare class ProvisionedThroughputExceededException extends __BaseException {
|
|
281
|
+
readonly name: "ProvisionedThroughputExceededException";
|
|
282
|
+
readonly $fault: "client";
|
|
283
|
+
Message?: string;
|
|
284
|
+
Code?: string;
|
|
285
|
+
/**
|
|
286
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
287
|
+
*/
|
|
288
|
+
Logref?: string;
|
|
289
|
+
/**
|
|
290
|
+
* @internal
|
|
291
|
+
*/
|
|
292
|
+
constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
* <p>The resource specified in the request cannot be found.</p>
|
|
297
|
+
*/
|
|
298
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
299
|
+
readonly name: "ResourceNotFoundException";
|
|
300
|
+
readonly $fault: "client";
|
|
301
|
+
Message?: string;
|
|
302
|
+
Code?: string;
|
|
303
|
+
/**
|
|
304
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
305
|
+
*/
|
|
306
|
+
Logref?: string;
|
|
307
|
+
/**
|
|
308
|
+
* @internal
|
|
309
|
+
*/
|
|
310
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* @public
|
|
314
|
+
* <p></p>
|
|
315
|
+
* <p>The size of the collection exceeds the allowed limit. For more information,
|
|
316
|
+
* see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
|
|
317
|
+
*/
|
|
318
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
319
|
+
readonly name: "ServiceQuotaExceededException";
|
|
320
|
+
readonly $fault: "client";
|
|
321
|
+
Message?: string;
|
|
322
|
+
Code?: string;
|
|
323
|
+
/**
|
|
324
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
325
|
+
*/
|
|
326
|
+
Logref?: string;
|
|
327
|
+
/**
|
|
328
|
+
* @internal
|
|
329
|
+
*/
|
|
330
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
331
|
+
}
|
|
332
|
+
/**
|
|
333
|
+
* @public
|
|
334
|
+
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
335
|
+
*/
|
|
336
|
+
export declare class ThrottlingException extends __BaseException {
|
|
337
|
+
readonly name: "ThrottlingException";
|
|
338
|
+
readonly $fault: "server";
|
|
339
|
+
Message?: string;
|
|
340
|
+
Code?: string;
|
|
341
|
+
/**
|
|
342
|
+
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
343
|
+
*/
|
|
344
|
+
Logref?: string;
|
|
345
|
+
/**
|
|
346
|
+
* @internal
|
|
347
|
+
*/
|
|
348
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
349
|
+
}
|
|
90
350
|
/**
|
|
91
351
|
* @public
|
|
92
352
|
* @enum
|
|
@@ -1133,24 +1393,6 @@ export declare class ImageTooLargeException extends __BaseException {
|
|
|
1133
1393
|
*/
|
|
1134
1394
|
constructor(opts: __ExceptionOptionType<ImageTooLargeException, __BaseException>);
|
|
1135
1395
|
}
|
|
1136
|
-
/**
|
|
1137
|
-
* @public
|
|
1138
|
-
* <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
|
|
1139
|
-
*/
|
|
1140
|
-
export declare class InternalServerError extends __BaseException {
|
|
1141
|
-
readonly name: "InternalServerError";
|
|
1142
|
-
readonly $fault: "server";
|
|
1143
|
-
Message?: string;
|
|
1144
|
-
Code?: string;
|
|
1145
|
-
/**
|
|
1146
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1147
|
-
*/
|
|
1148
|
-
Logref?: string;
|
|
1149
|
-
/**
|
|
1150
|
-
* @internal
|
|
1151
|
-
*/
|
|
1152
|
-
constructor(opts: __ExceptionOptionType<InternalServerError, __BaseException>);
|
|
1153
|
-
}
|
|
1154
1396
|
/**
|
|
1155
1397
|
* @public
|
|
1156
1398
|
* <p>The provided image format is not supported. </p>
|
|
@@ -1169,25 +1411,6 @@ export declare class InvalidImageFormatException extends __BaseException {
|
|
|
1169
1411
|
*/
|
|
1170
1412
|
constructor(opts: __ExceptionOptionType<InvalidImageFormatException, __BaseException>);
|
|
1171
1413
|
}
|
|
1172
|
-
/**
|
|
1173
|
-
* @public
|
|
1174
|
-
* <p>Input parameter violated a constraint. Validate your parameter before calling the API
|
|
1175
|
-
* operation again.</p>
|
|
1176
|
-
*/
|
|
1177
|
-
export declare class InvalidParameterException extends __BaseException {
|
|
1178
|
-
readonly name: "InvalidParameterException";
|
|
1179
|
-
readonly $fault: "client";
|
|
1180
|
-
Message?: string;
|
|
1181
|
-
Code?: string;
|
|
1182
|
-
/**
|
|
1183
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1184
|
-
*/
|
|
1185
|
-
Logref?: string;
|
|
1186
|
-
/**
|
|
1187
|
-
* @internal
|
|
1188
|
-
*/
|
|
1189
|
-
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
1190
|
-
}
|
|
1191
1414
|
/**
|
|
1192
1415
|
* @public
|
|
1193
1416
|
* <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
|
|
@@ -1206,43 +1429,6 @@ export declare class InvalidS3ObjectException extends __BaseException {
|
|
|
1206
1429
|
*/
|
|
1207
1430
|
constructor(opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>);
|
|
1208
1431
|
}
|
|
1209
|
-
/**
|
|
1210
|
-
* @public
|
|
1211
|
-
* <p>The number of requests exceeded your throughput limit. If you want to increase this
|
|
1212
|
-
* limit, contact Amazon Rekognition.</p>
|
|
1213
|
-
*/
|
|
1214
|
-
export declare class ProvisionedThroughputExceededException extends __BaseException {
|
|
1215
|
-
readonly name: "ProvisionedThroughputExceededException";
|
|
1216
|
-
readonly $fault: "client";
|
|
1217
|
-
Message?: string;
|
|
1218
|
-
Code?: string;
|
|
1219
|
-
/**
|
|
1220
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1221
|
-
*/
|
|
1222
|
-
Logref?: string;
|
|
1223
|
-
/**
|
|
1224
|
-
* @internal
|
|
1225
|
-
*/
|
|
1226
|
-
constructor(opts: __ExceptionOptionType<ProvisionedThroughputExceededException, __BaseException>);
|
|
1227
|
-
}
|
|
1228
|
-
/**
|
|
1229
|
-
* @public
|
|
1230
|
-
* <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
|
|
1231
|
-
*/
|
|
1232
|
-
export declare class ThrottlingException extends __BaseException {
|
|
1233
|
-
readonly name: "ThrottlingException";
|
|
1234
|
-
readonly $fault: "server";
|
|
1235
|
-
Message?: string;
|
|
1236
|
-
Code?: string;
|
|
1237
|
-
/**
|
|
1238
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1239
|
-
*/
|
|
1240
|
-
Logref?: string;
|
|
1241
|
-
/**
|
|
1242
|
-
* @internal
|
|
1243
|
-
*/
|
|
1244
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
1245
|
-
}
|
|
1246
1432
|
/**
|
|
1247
1433
|
* @public
|
|
1248
1434
|
* <p>
|
|
@@ -1494,44 +1680,6 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
1494
1680
|
*/
|
|
1495
1681
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
1496
1682
|
}
|
|
1497
|
-
/**
|
|
1498
|
-
* @public
|
|
1499
|
-
* <p>The resource specified in the request cannot be found.</p>
|
|
1500
|
-
*/
|
|
1501
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
1502
|
-
readonly name: "ResourceNotFoundException";
|
|
1503
|
-
readonly $fault: "client";
|
|
1504
|
-
Message?: string;
|
|
1505
|
-
Code?: string;
|
|
1506
|
-
/**
|
|
1507
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1508
|
-
*/
|
|
1509
|
-
Logref?: string;
|
|
1510
|
-
/**
|
|
1511
|
-
* @internal
|
|
1512
|
-
*/
|
|
1513
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1514
|
-
}
|
|
1515
|
-
/**
|
|
1516
|
-
* @public
|
|
1517
|
-
* <p></p>
|
|
1518
|
-
* <p>The size of the collection exceeds the allowed limit. For more information,
|
|
1519
|
-
* see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide. </p>
|
|
1520
|
-
*/
|
|
1521
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1522
|
-
readonly name: "ServiceQuotaExceededException";
|
|
1523
|
-
readonly $fault: "client";
|
|
1524
|
-
Message?: string;
|
|
1525
|
-
Code?: string;
|
|
1526
|
-
/**
|
|
1527
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
1528
|
-
*/
|
|
1529
|
-
Logref?: string;
|
|
1530
|
-
/**
|
|
1531
|
-
* @internal
|
|
1532
|
-
*/
|
|
1533
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1534
|
-
}
|
|
1535
1683
|
/**
|
|
1536
1684
|
* @public
|
|
1537
1685
|
*/
|
|
@@ -2104,6 +2252,31 @@ export interface CreateStreamProcessorResponse {
|
|
|
2104
2252
|
*/
|
|
2105
2253
|
StreamProcessorArn?: string;
|
|
2106
2254
|
}
|
|
2255
|
+
/**
|
|
2256
|
+
* @public
|
|
2257
|
+
*/
|
|
2258
|
+
export interface CreateUserRequest {
|
|
2259
|
+
/**
|
|
2260
|
+
* <p>The ID of an existing collection to which the new UserID needs to be created.</p>
|
|
2261
|
+
*/
|
|
2262
|
+
CollectionId: string | undefined;
|
|
2263
|
+
/**
|
|
2264
|
+
* <p>ID for the UserID to be created. This ID needs to be unique within the collection.</p>
|
|
2265
|
+
*/
|
|
2266
|
+
UserId: string | undefined;
|
|
2267
|
+
/**
|
|
2268
|
+
* <p>Idempotent token used to identify the request to <code>CreateUser</code>. If you use the
|
|
2269
|
+
* same token with multiple <code>CreateUser</code> requests, the same response is returned.
|
|
2270
|
+
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
2271
|
+
* once.</p>
|
|
2272
|
+
*/
|
|
2273
|
+
ClientRequestToken?: string;
|
|
2274
|
+
}
|
|
2275
|
+
/**
|
|
2276
|
+
* @public
|
|
2277
|
+
*/
|
|
2278
|
+
export interface CreateUserResponse {
|
|
2279
|
+
}
|
|
2107
2280
|
/**
|
|
2108
2281
|
* @public
|
|
2109
2282
|
* <p>Information about where an object (<a>DetectCustomLabels</a>) or text (<a>DetectText</a>) is located on an image.</p>
|
|
@@ -2407,6 +2580,36 @@ export interface DeleteFacesRequest {
|
|
|
2407
2580
|
*/
|
|
2408
2581
|
FaceIds: string[] | undefined;
|
|
2409
2582
|
}
|
|
2583
|
+
/**
|
|
2584
|
+
* @public
|
|
2585
|
+
* @enum
|
|
2586
|
+
*/
|
|
2587
|
+
export declare const UnsuccessfulFaceDeletionReason: {
|
|
2588
|
+
readonly ASSOCIATED_TO_AN_EXISTING_USER: "ASSOCIATED_TO_AN_EXISTING_USER";
|
|
2589
|
+
readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
|
|
2590
|
+
};
|
|
2591
|
+
/**
|
|
2592
|
+
* @public
|
|
2593
|
+
*/
|
|
2594
|
+
export type UnsuccessfulFaceDeletionReason = (typeof UnsuccessfulFaceDeletionReason)[keyof typeof UnsuccessfulFaceDeletionReason];
|
|
2595
|
+
/**
|
|
2596
|
+
* @public
|
|
2597
|
+
* <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully deleted.</p>
|
|
2598
|
+
*/
|
|
2599
|
+
export interface UnsuccessfulFaceDeletion {
|
|
2600
|
+
/**
|
|
2601
|
+
* <p> A unique identifier assigned to the face.</p>
|
|
2602
|
+
*/
|
|
2603
|
+
FaceId?: string;
|
|
2604
|
+
/**
|
|
2605
|
+
* <p> A provided ID for the UserID. Unique within the collection. </p>
|
|
2606
|
+
*/
|
|
2607
|
+
UserId?: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* <p>The reason why the deletion was unsuccessful. </p>
|
|
2610
|
+
*/
|
|
2611
|
+
Reasons?: (UnsuccessfulFaceDeletionReason | string)[];
|
|
2612
|
+
}
|
|
2410
2613
|
/**
|
|
2411
2614
|
* @public
|
|
2412
2615
|
*/
|
|
@@ -2415,6 +2618,10 @@ export interface DeleteFacesResponse {
|
|
|
2415
2618
|
* <p>An array of strings (face IDs) of the faces that were deleted.</p>
|
|
2416
2619
|
*/
|
|
2417
2620
|
DeletedFaces?: string[];
|
|
2621
|
+
/**
|
|
2622
|
+
* <p>An array of any faces that weren't deleted.</p>
|
|
2623
|
+
*/
|
|
2624
|
+
UnsuccessfulFaceDeletions?: UnsuccessfulFaceDeletion[];
|
|
2418
2625
|
}
|
|
2419
2626
|
/**
|
|
2420
2627
|
* @public
|
|
@@ -2541,6 +2748,31 @@ export interface DeleteStreamProcessorRequest {
|
|
|
2541
2748
|
*/
|
|
2542
2749
|
export interface DeleteStreamProcessorResponse {
|
|
2543
2750
|
}
|
|
2751
|
+
/**
|
|
2752
|
+
* @public
|
|
2753
|
+
*/
|
|
2754
|
+
export interface DeleteUserRequest {
|
|
2755
|
+
/**
|
|
2756
|
+
* <p>The ID of an existing collection from which the UserID needs to be deleted. </p>
|
|
2757
|
+
*/
|
|
2758
|
+
CollectionId: string | undefined;
|
|
2759
|
+
/**
|
|
2760
|
+
* <p>ID for the UserID to be deleted. </p>
|
|
2761
|
+
*/
|
|
2762
|
+
UserId: string | undefined;
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>Idempotent token used to identify the request to <code>DeleteUser</code>. If you use the
|
|
2765
|
+
* same token with multiple <code>DeleteUser </code>requests, the same response is returned.
|
|
2766
|
+
* Use ClientRequestToken to prevent the same request from being processed more than
|
|
2767
|
+
* once.</p>
|
|
2768
|
+
*/
|
|
2769
|
+
ClientRequestToken?: string;
|
|
2770
|
+
}
|
|
2771
|
+
/**
|
|
2772
|
+
* @public
|
|
2773
|
+
*/
|
|
2774
|
+
export interface DeleteUserResponse {
|
|
2775
|
+
}
|
|
2544
2776
|
/**
|
|
2545
2777
|
* @public
|
|
2546
2778
|
*/
|
|
@@ -2574,6 +2806,10 @@ export interface DescribeCollectionResponse {
|
|
|
2574
2806
|
* The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.</p>
|
|
2575
2807
|
*/
|
|
2576
2808
|
CreationTimestamp?: Date;
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>The number of UserIDs assigned to the specified colleciton.</p>
|
|
2811
|
+
*/
|
|
2812
|
+
UserCount?: number;
|
|
2577
2813
|
}
|
|
2578
2814
|
/**
|
|
2579
2815
|
* @public
|
|
@@ -3810,6 +4046,90 @@ export interface DetectTextResponse {
|
|
|
3810
4046
|
*/
|
|
3811
4047
|
TextModelVersion?: string;
|
|
3812
4048
|
}
|
|
4049
|
+
/**
|
|
4050
|
+
* @public
|
|
4051
|
+
* <p>Provides face metadata for the faces that are disassociated from a specific UserID.</p>
|
|
4052
|
+
*/
|
|
4053
|
+
export interface DisassociatedFace {
|
|
4054
|
+
/**
|
|
4055
|
+
* <p>Unique identifier assigned to the face.</p>
|
|
4056
|
+
*/
|
|
4057
|
+
FaceId?: string;
|
|
4058
|
+
}
|
|
4059
|
+
/**
|
|
4060
|
+
* @public
|
|
4061
|
+
*/
|
|
4062
|
+
export interface DisassociateFacesRequest {
|
|
4063
|
+
/**
|
|
4064
|
+
* <p>The ID of an existing collection containing the UserID.</p>
|
|
4065
|
+
*/
|
|
4066
|
+
CollectionId: string | undefined;
|
|
4067
|
+
/**
|
|
4068
|
+
* <p>ID for the existing UserID.</p>
|
|
4069
|
+
*/
|
|
4070
|
+
UserId: string | undefined;
|
|
4071
|
+
/**
|
|
4072
|
+
* <p>Idempotent token used to identify the request to <code>DisassociateFaces</code>. If you
|
|
4073
|
+
* use the same token with multiple <code>DisassociateFaces</code> requests, the same response is
|
|
4074
|
+
* returned. Use ClientRequestToken to prevent the same request from being processed more than
|
|
4075
|
+
* once.</p>
|
|
4076
|
+
*/
|
|
4077
|
+
ClientRequestToken?: string;
|
|
4078
|
+
/**
|
|
4079
|
+
* <p>An array of face IDs to disassociate from the UserID. </p>
|
|
4080
|
+
*/
|
|
4081
|
+
FaceIds: string[] | undefined;
|
|
4082
|
+
}
|
|
4083
|
+
/**
|
|
4084
|
+
* @public
|
|
4085
|
+
* @enum
|
|
4086
|
+
*/
|
|
4087
|
+
export declare const UnsuccessfulFaceDisassociationReason: {
|
|
4088
|
+
readonly ASSOCIATED_TO_A_DIFFERENT_USER: "ASSOCIATED_TO_A_DIFFERENT_USER";
|
|
4089
|
+
readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
|
|
4090
|
+
};
|
|
4091
|
+
/**
|
|
4092
|
+
* @public
|
|
4093
|
+
*/
|
|
4094
|
+
export type UnsuccessfulFaceDisassociationReason = (typeof UnsuccessfulFaceDisassociationReason)[keyof typeof UnsuccessfulFaceDisassociationReason];
|
|
4095
|
+
/**
|
|
4096
|
+
* @public
|
|
4097
|
+
* <p>Contains metadata like FaceId, UserID, and Reasons, for a face that was unsuccessfully disassociated.</p>
|
|
4098
|
+
*/
|
|
4099
|
+
export interface UnsuccessfulFaceDisassociation {
|
|
4100
|
+
/**
|
|
4101
|
+
* <p>A unique identifier assigned to the face. </p>
|
|
4102
|
+
*/
|
|
4103
|
+
FaceId?: string;
|
|
4104
|
+
/**
|
|
4105
|
+
* <p>A provided ID for the UserID. Unique within the collection. </p>
|
|
4106
|
+
*/
|
|
4107
|
+
UserId?: string;
|
|
4108
|
+
/**
|
|
4109
|
+
* <p>The reason why the deletion was unsuccessful. </p>
|
|
4110
|
+
*/
|
|
4111
|
+
Reasons?: (UnsuccessfulFaceDisassociationReason | string)[];
|
|
4112
|
+
}
|
|
4113
|
+
/**
|
|
4114
|
+
* @public
|
|
4115
|
+
*/
|
|
4116
|
+
export interface DisassociateFacesResponse {
|
|
4117
|
+
/**
|
|
4118
|
+
* <p>An array of DissociatedFace objects containing FaceIds that are successfully disassociated
|
|
4119
|
+
* with the UserID is returned. Returned if the DisassociatedFaces action is successful.</p>
|
|
4120
|
+
*/
|
|
4121
|
+
DisassociatedFaces?: DisassociatedFace[];
|
|
4122
|
+
/**
|
|
4123
|
+
* <p>An array of UnsuccessfulDisassociation objects containing FaceIds that are not
|
|
4124
|
+
* successfully associated, along with the reasons for the failure to associate. Returned if the
|
|
4125
|
+
* DisassociateFaces action is successful.</p>
|
|
4126
|
+
*/
|
|
4127
|
+
UnsuccessfulFaceDisassociations?: UnsuccessfulFaceDisassociation[];
|
|
4128
|
+
/**
|
|
4129
|
+
* <p>The status of an update made to a User. Reflects if the User has been updated for every requested change.</p>
|
|
4130
|
+
*/
|
|
4131
|
+
UserStatus?: UserStatus | string;
|
|
4132
|
+
}
|
|
3813
4133
|
/**
|
|
3814
4134
|
* @public
|
|
3815
4135
|
* <p>
|
|
@@ -3872,6 +4192,10 @@ export interface Face {
|
|
|
3872
4192
|
* vector. </p>
|
|
3873
4193
|
*/
|
|
3874
4194
|
IndexFacesModelVersion?: string;
|
|
4195
|
+
/**
|
|
4196
|
+
* <p>Unique identifier assigned to the user.</p>
|
|
4197
|
+
*/
|
|
4198
|
+
UserId?: string;
|
|
3875
4199
|
}
|
|
3876
4200
|
/**
|
|
3877
4201
|
* @public
|
|
@@ -5039,25 +5363,6 @@ export interface GetTextDetectionResponse {
|
|
|
5039
5363
|
*/
|
|
5040
5364
|
JobTag?: string;
|
|
5041
5365
|
}
|
|
5042
|
-
/**
|
|
5043
|
-
* @public
|
|
5044
|
-
* <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input
|
|
5045
|
-
* parameters is different from the previous call to the operation.</p>
|
|
5046
|
-
*/
|
|
5047
|
-
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
5048
|
-
readonly name: "IdempotentParameterMismatchException";
|
|
5049
|
-
readonly $fault: "client";
|
|
5050
|
-
Message?: string;
|
|
5051
|
-
Code?: string;
|
|
5052
|
-
/**
|
|
5053
|
-
* <p>A universally unique identifier (UUID) for the request.</p>
|
|
5054
|
-
*/
|
|
5055
|
-
Logref?: string;
|
|
5056
|
-
/**
|
|
5057
|
-
* @internal
|
|
5058
|
-
*/
|
|
5059
|
-
constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
|
|
5060
|
-
}
|
|
5061
5366
|
/**
|
|
5062
5367
|
* @public
|
|
5063
5368
|
*/
|
|
@@ -5426,6 +5731,14 @@ export interface ListFacesRequest {
|
|
|
5426
5731
|
* <p>Maximum number of faces to return.</p>
|
|
5427
5732
|
*/
|
|
5428
5733
|
MaxResults?: number;
|
|
5734
|
+
/**
|
|
5735
|
+
* <p>An array of user IDs to match when listing faces in a collection.</p>
|
|
5736
|
+
*/
|
|
5737
|
+
UserId?: string;
|
|
5738
|
+
/**
|
|
5739
|
+
* <p>An array of face IDs to match when listing faces in a collection.</p>
|
|
5740
|
+
*/
|
|
5741
|
+
FaceIds?: string[];
|
|
5429
5742
|
}
|
|
5430
5743
|
/**
|
|
5431
5744
|
* @public
|
|
@@ -5576,6 +5889,51 @@ export interface ListTagsForResourceResponse {
|
|
|
5576
5889
|
*/
|
|
5577
5890
|
Tags?: Record<string, string>;
|
|
5578
5891
|
}
|
|
5892
|
+
/**
|
|
5893
|
+
* @public
|
|
5894
|
+
*/
|
|
5895
|
+
export interface ListUsersRequest {
|
|
5896
|
+
/**
|
|
5897
|
+
* <p>The ID of an existing collection.</p>
|
|
5898
|
+
*/
|
|
5899
|
+
CollectionId: string | undefined;
|
|
5900
|
+
/**
|
|
5901
|
+
* <p>Maximum number of UsersID to return. </p>
|
|
5902
|
+
*/
|
|
5903
|
+
MaxResults?: number;
|
|
5904
|
+
/**
|
|
5905
|
+
* <p>Pagingation token to receive the next set of UsersID.</p>
|
|
5906
|
+
*/
|
|
5907
|
+
NextToken?: string;
|
|
5908
|
+
}
|
|
5909
|
+
/**
|
|
5910
|
+
* @public
|
|
5911
|
+
* <p>Metadata of the user stored in a collection.</p>
|
|
5912
|
+
*/
|
|
5913
|
+
export interface User {
|
|
5914
|
+
/**
|
|
5915
|
+
* <p> A provided ID for the User. Unique within the collection.</p>
|
|
5916
|
+
*/
|
|
5917
|
+
UserId?: string;
|
|
5918
|
+
/**
|
|
5919
|
+
* <p> Communicates if the UserID has been updated with latest set of faces to be associated
|
|
5920
|
+
* with the UserID. </p>
|
|
5921
|
+
*/
|
|
5922
|
+
UserStatus?: UserStatus | string;
|
|
5923
|
+
}
|
|
5924
|
+
/**
|
|
5925
|
+
* @public
|
|
5926
|
+
*/
|
|
5927
|
+
export interface ListUsersResponse {
|
|
5928
|
+
/**
|
|
5929
|
+
* <p>List of UsersID associated with the specified collection.</p>
|
|
5930
|
+
*/
|
|
5931
|
+
Users?: User[];
|
|
5932
|
+
/**
|
|
5933
|
+
* <p>A pagination token to be used with the subsequent request if the response is truncated.</p>
|
|
5934
|
+
*/
|
|
5935
|
+
NextToken?: string;
|
|
5936
|
+
}
|
|
5579
5937
|
/**
|
|
5580
5938
|
* @public
|
|
5581
5939
|
* <p>The format of the project policy document that you supplied to
|
|
@@ -5595,6 +5953,20 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
|
|
|
5595
5953
|
*/
|
|
5596
5954
|
constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>);
|
|
5597
5955
|
}
|
|
5956
|
+
/**
|
|
5957
|
+
* @public
|
|
5958
|
+
* <p>Contains metadata for a UserID matched with a given face.</p>
|
|
5959
|
+
*/
|
|
5960
|
+
export interface MatchedUser {
|
|
5961
|
+
/**
|
|
5962
|
+
* <p>A provided ID for the UserID. Unique within the collection.</p>
|
|
5963
|
+
*/
|
|
5964
|
+
UserId?: string;
|
|
5965
|
+
/**
|
|
5966
|
+
* <p>The status of the user matched to a provided FaceID.</p>
|
|
5967
|
+
*/
|
|
5968
|
+
UserStatus?: UserStatus | string;
|
|
5969
|
+
}
|
|
5598
5970
|
/**
|
|
5599
5971
|
* @public
|
|
5600
5972
|
* <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
|
|
@@ -5811,388 +6183,272 @@ export interface SearchFacesByImageResponse {
|
|
|
5811
6183
|
/**
|
|
5812
6184
|
* @public
|
|
5813
6185
|
*/
|
|
5814
|
-
export interface
|
|
6186
|
+
export interface SearchUsersRequest {
|
|
5815
6187
|
/**
|
|
5816
|
-
* <p>The
|
|
5817
|
-
*
|
|
6188
|
+
* <p>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a
|
|
6189
|
+
* FaceId is provided, UserId isn’t required to be present in the Collection.</p>
|
|
5818
6190
|
*/
|
|
5819
|
-
|
|
6191
|
+
CollectionId: string | undefined;
|
|
5820
6192
|
/**
|
|
5821
|
-
* <p>
|
|
5822
|
-
* <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use
|
|
5823
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
6193
|
+
* <p>ID for the existing User.</p>
|
|
5824
6194
|
*/
|
|
5825
|
-
|
|
6195
|
+
UserId?: string;
|
|
5826
6196
|
/**
|
|
5827
|
-
* <p>
|
|
5828
|
-
* celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
6197
|
+
* <p>ID for the existing face.</p>
|
|
5829
6198
|
*/
|
|
5830
|
-
|
|
6199
|
+
FaceId?: string;
|
|
5831
6200
|
/**
|
|
5832
|
-
* <p>
|
|
5833
|
-
*
|
|
6201
|
+
* <p>Optional value that specifies the minimum confidence in the matched UserID to return.
|
|
6202
|
+
* Default value of 80.</p>
|
|
5834
6203
|
*/
|
|
5835
|
-
|
|
5836
|
-
}
|
|
5837
|
-
/**
|
|
5838
|
-
* @public
|
|
5839
|
-
*/
|
|
5840
|
-
export interface StartCelebrityRecognitionResponse {
|
|
5841
|
-
/**
|
|
5842
|
-
* <p>The identifier for the celebrity recognition analysis job. Use <code>JobId</code> to identify the job in
|
|
5843
|
-
* a subsequent call to <code>GetCelebrityRecognition</code>.</p>
|
|
5844
|
-
*/
|
|
5845
|
-
JobId?: string;
|
|
5846
|
-
}
|
|
5847
|
-
/**
|
|
5848
|
-
* @public
|
|
5849
|
-
* <p>The file size or duration of the supplied media is too large. The maximum file size is 10GB.
|
|
5850
|
-
* The maximum duration is 6 hours. </p>
|
|
5851
|
-
*/
|
|
5852
|
-
export declare class VideoTooLargeException extends __BaseException {
|
|
5853
|
-
readonly name: "VideoTooLargeException";
|
|
5854
|
-
readonly $fault: "client";
|
|
5855
|
-
Message?: string;
|
|
5856
|
-
Code?: string;
|
|
6204
|
+
UserMatchThreshold?: number;
|
|
5857
6205
|
/**
|
|
5858
|
-
* <p>
|
|
6206
|
+
* <p>Maximum number of identities to return.</p>
|
|
5859
6207
|
*/
|
|
5860
|
-
|
|
5861
|
-
/**
|
|
5862
|
-
* @internal
|
|
5863
|
-
*/
|
|
5864
|
-
constructor(opts: __ExceptionOptionType<VideoTooLargeException, __BaseException>);
|
|
6208
|
+
MaxUsers?: number;
|
|
5865
6209
|
}
|
|
5866
6210
|
/**
|
|
5867
6211
|
* @public
|
|
6212
|
+
* <p>Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for search.</p>
|
|
5868
6213
|
*/
|
|
5869
|
-
export interface
|
|
5870
|
-
/**
|
|
5871
|
-
* <p>The video in which you want to detect inappropriate, unwanted, or offensive content. The video must be stored
|
|
5872
|
-
* in an Amazon S3 bucket.</p>
|
|
5873
|
-
*/
|
|
5874
|
-
Video: Video | undefined;
|
|
6214
|
+
export interface SearchedFace {
|
|
5875
6215
|
/**
|
|
5876
|
-
* <p>
|
|
5877
|
-
* represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence.
|
|
5878
|
-
* 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level
|
|
5879
|
-
* lower than this specified value. If you don't specify <code>MinConfidence</code>, <code>GetContentModeration</code>
|
|
5880
|
-
* returns labels with confidence values greater than or equal to 50 percent.</p>
|
|
6216
|
+
* <p> Unique identifier assigned to the face.</p>
|
|
5881
6217
|
*/
|
|
5882
|
-
|
|
5883
|
-
/**
|
|
5884
|
-
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
5885
|
-
* <code>StartContentModeration</code> requests, the same <code>JobId</code> is returned. Use
|
|
5886
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
5887
|
-
*/
|
|
5888
|
-
ClientRequestToken?: string;
|
|
5889
|
-
/**
|
|
5890
|
-
* <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
|
|
5891
|
-
* content analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>
|
|
5892
|
-
*/
|
|
5893
|
-
NotificationChannel?: NotificationChannel;
|
|
5894
|
-
/**
|
|
5895
|
-
* <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
|
|
5896
|
-
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
5897
|
-
*/
|
|
5898
|
-
JobTag?: string;
|
|
6218
|
+
FaceId?: string;
|
|
5899
6219
|
}
|
|
5900
6220
|
/**
|
|
5901
6221
|
* @public
|
|
6222
|
+
* <p>Contains metadata about a User searched for within a collection.</p>
|
|
5902
6223
|
*/
|
|
5903
|
-
export interface
|
|
6224
|
+
export interface SearchedUser {
|
|
5904
6225
|
/**
|
|
5905
|
-
* <p>
|
|
5906
|
-
* a subsequent call to <code>GetContentModeration</code>.</p>
|
|
6226
|
+
* <p> A provided ID for the UserID. Unique within the collection. </p>
|
|
5907
6227
|
*/
|
|
5908
|
-
|
|
6228
|
+
UserId?: string;
|
|
5909
6229
|
}
|
|
5910
6230
|
/**
|
|
5911
6231
|
* @public
|
|
6232
|
+
* <p>Provides UserID metadata along with the confidence in the match of this UserID with the
|
|
6233
|
+
* input face.</p>
|
|
5912
6234
|
*/
|
|
5913
|
-
export interface
|
|
5914
|
-
/**
|
|
5915
|
-
* <p>The video in which you want to detect faces. The video must be stored
|
|
5916
|
-
* in an Amazon S3 bucket.</p>
|
|
5917
|
-
*/
|
|
5918
|
-
Video: Video | undefined;
|
|
6235
|
+
export interface UserMatch {
|
|
5919
6236
|
/**
|
|
5920
|
-
* <p>
|
|
5921
|
-
* <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use
|
|
5922
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
5923
|
-
*/
|
|
5924
|
-
ClientRequestToken?: string;
|
|
5925
|
-
/**
|
|
5926
|
-
* <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the
|
|
5927
|
-
* face detection operation. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
6237
|
+
* <p> Describes the UserID metadata.</p>
|
|
5928
6238
|
*/
|
|
5929
|
-
|
|
5930
|
-
/**
|
|
5931
|
-
* <p>The face attributes you want returned.</p>
|
|
5932
|
-
* <p>
|
|
5933
|
-
* <code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. </p>
|
|
5934
|
-
* <p>
|
|
5935
|
-
* <code>ALL</code> - All facial attributes are returned.</p>
|
|
5936
|
-
*/
|
|
5937
|
-
FaceAttributes?: FaceAttributes | string;
|
|
6239
|
+
Similarity?: number;
|
|
5938
6240
|
/**
|
|
5939
|
-
* <p>
|
|
5940
|
-
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
6241
|
+
* <p> Confidence in the match of this UserID with the input face. </p>
|
|
5941
6242
|
*/
|
|
5942
|
-
|
|
6243
|
+
User?: MatchedUser;
|
|
5943
6244
|
}
|
|
5944
6245
|
/**
|
|
5945
6246
|
* @public
|
|
5946
6247
|
*/
|
|
5947
|
-
export interface
|
|
6248
|
+
export interface SearchUsersResponse {
|
|
5948
6249
|
/**
|
|
5949
|
-
* <p>
|
|
5950
|
-
*
|
|
6250
|
+
* <p>An array of UserMatch objects that matched the input face along with the confidence in
|
|
6251
|
+
* the match. Array will be empty if there are no matches.</p>
|
|
5951
6252
|
*/
|
|
5952
|
-
|
|
5953
|
-
}
|
|
5954
|
-
/**
|
|
5955
|
-
* @public
|
|
5956
|
-
*/
|
|
5957
|
-
export interface StartFaceSearchRequest {
|
|
6253
|
+
UserMatches?: UserMatch[];
|
|
5958
6254
|
/**
|
|
5959
|
-
* <p>
|
|
6255
|
+
* <p>Version number of the face detection model associated with the input
|
|
6256
|
+
* CollectionId.</p>
|
|
5960
6257
|
*/
|
|
5961
|
-
|
|
5962
|
-
/**
|
|
5963
|
-
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
5964
|
-
* <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use
|
|
5965
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
5966
|
-
*/
|
|
5967
|
-
ClientRequestToken?: string;
|
|
5968
|
-
/**
|
|
5969
|
-
* <p>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%.
|
|
5970
|
-
* The default value is 80%.</p>
|
|
5971
|
-
*/
|
|
5972
|
-
FaceMatchThreshold?: number;
|
|
5973
|
-
/**
|
|
5974
|
-
* <p>ID of the collection that contains the faces you want to search for.</p>
|
|
5975
|
-
*/
|
|
5976
|
-
CollectionId: string | undefined;
|
|
5977
|
-
/**
|
|
5978
|
-
* <p>The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.</p>
|
|
5979
|
-
*/
|
|
5980
|
-
NotificationChannel?: NotificationChannel;
|
|
6258
|
+
FaceModelVersion?: string;
|
|
5981
6259
|
/**
|
|
5982
|
-
* <p>
|
|
5983
|
-
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
6260
|
+
* <p>Contains the ID of a face that was used to search for matches in a collection.</p>
|
|
5984
6261
|
*/
|
|
5985
|
-
|
|
5986
|
-
}
|
|
5987
|
-
/**
|
|
5988
|
-
* @public
|
|
5989
|
-
*/
|
|
5990
|
-
export interface StartFaceSearchResponse {
|
|
6262
|
+
SearchedFace?: SearchedFace;
|
|
5991
6263
|
/**
|
|
5992
|
-
* <p>
|
|
6264
|
+
* <p>Contains the ID of the UserID that was used to search for matches in a collection.</p>
|
|
5993
6265
|
*/
|
|
5994
|
-
|
|
6266
|
+
SearchedUser?: SearchedUser;
|
|
5995
6267
|
}
|
|
5996
6268
|
/**
|
|
5997
6269
|
* @public
|
|
5998
6270
|
*/
|
|
5999
|
-
export interface
|
|
6271
|
+
export interface SearchUsersByImageRequest {
|
|
6000
6272
|
/**
|
|
6001
|
-
* <p>The
|
|
6002
|
-
* in an Amazon S3 bucket.</p>
|
|
6003
|
-
*/
|
|
6004
|
-
Video: Video | undefined;
|
|
6005
|
-
/**
|
|
6006
|
-
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
6007
|
-
* <code>StartLabelDetection</code> requests, the same <code>JobId</code> is returned. Use
|
|
6008
|
-
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
6273
|
+
* <p>The ID of an existing collection containing the UserID.</p>
|
|
6009
6274
|
*/
|
|
6010
|
-
|
|
6011
|
-
/**
|
|
6012
|
-
* <p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence
|
|
6013
|
-
* represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence.
|
|
6014
|
-
* 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level
|
|
6015
|
-
* lower than this specified value.</p>
|
|
6016
|
-
* <p>If you don't specify <code>MinConfidence</code>, the operation returns labels and
|
|
6017
|
-
* bounding boxes (if detected) with confidence values greater than or equal to 50
|
|
6018
|
-
* percent.</p>
|
|
6019
|
-
*/
|
|
6020
|
-
MinConfidence?: number;
|
|
6275
|
+
CollectionId: string | undefined;
|
|
6021
6276
|
/**
|
|
6022
|
-
* <p>
|
|
6023
|
-
*
|
|
6277
|
+
* <p>Provides the input image either as bytes or an S3 object.</p>
|
|
6278
|
+
* <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
|
|
6279
|
+
* property. For example, you would use the <code>Bytes</code> property to pass an image loaded
|
|
6280
|
+
* from a local file system. Image bytes passed by using the <code>Bytes</code> property must be
|
|
6281
|
+
* base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to
|
|
6282
|
+
* call Amazon Rekognition API operations. </p>
|
|
6283
|
+
* <p>For more information, see Analyzing an Image Loaded from a Local File System
|
|
6284
|
+
* in the Amazon Rekognition Developer Guide.</p>
|
|
6285
|
+
* <p> You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the
|
|
6286
|
+
* <code>S3Object</code> property. Images stored in an S3 bucket do not need to be
|
|
6287
|
+
* base64-encoded.</p>
|
|
6288
|
+
* <p>The region for the S3 bucket containing the S3 object must match the region you use for
|
|
6289
|
+
* Amazon Rekognition operations.</p>
|
|
6290
|
+
* <p>If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the
|
|
6291
|
+
* Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and
|
|
6292
|
+
* then call the operation using the S3Object property.</p>
|
|
6293
|
+
* <p>For Amazon Rekognition to process an S3 object, the user must have permission to
|
|
6294
|
+
* access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
|
|
6295
|
+
* Amazon Rekognition Developer Guide. </p>
|
|
6024
6296
|
*/
|
|
6025
|
-
|
|
6297
|
+
Image: Image | undefined;
|
|
6026
6298
|
/**
|
|
6027
|
-
* <p>
|
|
6028
|
-
*
|
|
6299
|
+
* <p>Specifies the minimum confidence in the UserID match to return. Default value is
|
|
6300
|
+
* 80.</p>
|
|
6029
6301
|
*/
|
|
6030
|
-
|
|
6302
|
+
UserMatchThreshold?: number;
|
|
6031
6303
|
/**
|
|
6032
|
-
* <p>
|
|
6304
|
+
* <p>Maximum number of UserIDs to return.</p>
|
|
6033
6305
|
*/
|
|
6034
|
-
|
|
6306
|
+
MaxUsers?: number;
|
|
6035
6307
|
/**
|
|
6036
|
-
* <p>
|
|
6037
|
-
*
|
|
6308
|
+
* <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
|
|
6309
|
+
* Filtered faces aren't searched for in the collection. The default value is NONE.</p>
|
|
6038
6310
|
*/
|
|
6039
|
-
|
|
6311
|
+
QualityFilter?: QualityFilter | string;
|
|
6040
6312
|
}
|
|
6041
6313
|
/**
|
|
6042
6314
|
* @public
|
|
6315
|
+
* <p>Contains data regarding the input face used for a search.</p>
|
|
6043
6316
|
*/
|
|
6044
|
-
export interface
|
|
6317
|
+
export interface SearchedFaceDetails {
|
|
6045
6318
|
/**
|
|
6046
|
-
* <p>
|
|
6047
|
-
*
|
|
6319
|
+
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
6320
|
+
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
6321
|
+
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
6322
|
+
* <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
|
|
6323
|
+
* <code>Quality</code>.</p>
|
|
6324
|
+
* <p>
|
|
6325
|
+
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
6326
|
+
* return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
|
|
6327
|
+
* return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
|
|
6328
|
+
* attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
|
|
6329
|
+
* parameter:</p>
|
|
6330
|
+
* <ul>
|
|
6331
|
+
* <li>
|
|
6332
|
+
* <p>GetCelebrityRecognition</p>
|
|
6333
|
+
* </li>
|
|
6334
|
+
* <li>
|
|
6335
|
+
* <p>GetPersonTracking</p>
|
|
6336
|
+
* </li>
|
|
6337
|
+
* <li>
|
|
6338
|
+
* <p>GetFaceSearch</p>
|
|
6339
|
+
* </li>
|
|
6340
|
+
* </ul>
|
|
6341
|
+
* <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
|
|
6342
|
+
* can return all facial attributes. To specify which attributes to return, use the
|
|
6343
|
+
* <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
|
|
6344
|
+
* <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
|
|
6048
6345
|
*/
|
|
6049
|
-
|
|
6346
|
+
FaceDetail?: FaceDetail;
|
|
6050
6347
|
}
|
|
6051
6348
|
/**
|
|
6052
6349
|
* @public
|
|
6350
|
+
* @enum
|
|
6053
6351
|
*/
|
|
6054
|
-
export
|
|
6055
|
-
|
|
6056
|
-
|
|
6057
|
-
|
|
6058
|
-
|
|
6059
|
-
|
|
6060
|
-
|
|
6061
|
-
|
|
6062
|
-
|
|
6063
|
-
|
|
6064
|
-
*/
|
|
6065
|
-
ClientRequestToken?: string;
|
|
6066
|
-
/**
|
|
6067
|
-
* <p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection
|
|
6068
|
-
* operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
6069
|
-
*/
|
|
6070
|
-
NotificationChannel?: NotificationChannel;
|
|
6071
|
-
/**
|
|
6072
|
-
* <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
|
|
6073
|
-
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
6074
|
-
*/
|
|
6075
|
-
JobTag?: string;
|
|
6076
|
-
}
|
|
6352
|
+
export declare const UnsearchedFaceReason: {
|
|
6353
|
+
readonly EXCEEDS_MAX_FACES: "EXCEEDS_MAX_FACES";
|
|
6354
|
+
readonly EXTREME_POSE: "EXTREME_POSE";
|
|
6355
|
+
readonly FACE_NOT_LARGEST: "FACE_NOT_LARGEST";
|
|
6356
|
+
readonly LOW_BRIGHTNESS: "LOW_BRIGHTNESS";
|
|
6357
|
+
readonly LOW_CONFIDENCE: "LOW_CONFIDENCE";
|
|
6358
|
+
readonly LOW_FACE_QUALITY: "LOW_FACE_QUALITY";
|
|
6359
|
+
readonly LOW_SHARPNESS: "LOW_SHARPNESS";
|
|
6360
|
+
readonly SMALL_BOUNDING_BOX: "SMALL_BOUNDING_BOX";
|
|
6361
|
+
};
|
|
6077
6362
|
/**
|
|
6078
6363
|
* @public
|
|
6079
6364
|
*/
|
|
6080
|
-
export
|
|
6081
|
-
/**
|
|
6082
|
-
* <p>The identifier for the person detection job. Use <code>JobId</code> to identify the job in
|
|
6083
|
-
* a subsequent call to <code>GetPersonTracking</code>.</p>
|
|
6084
|
-
*/
|
|
6085
|
-
JobId?: string;
|
|
6086
|
-
}
|
|
6365
|
+
export type UnsearchedFaceReason = (typeof UnsearchedFaceReason)[keyof typeof UnsearchedFaceReason];
|
|
6087
6366
|
/**
|
|
6088
6367
|
* @public
|
|
6368
|
+
* <p>Face details inferred from the image but not used for search. The response attribute
|
|
6369
|
+
* contains reasons for why a face wasn't used for Search. </p>
|
|
6089
6370
|
*/
|
|
6090
|
-
export interface
|
|
6371
|
+
export interface UnsearchedFace {
|
|
6091
6372
|
/**
|
|
6092
|
-
* <p>
|
|
6093
|
-
|
|
6094
|
-
|
|
6095
|
-
|
|
6096
|
-
*
|
|
6097
|
-
*
|
|
6098
|
-
*
|
|
6099
|
-
*
|
|
6100
|
-
*
|
|
6101
|
-
*
|
|
6102
|
-
*
|
|
6103
|
-
* <
|
|
6104
|
-
*
|
|
6105
|
-
*
|
|
6106
|
-
|
|
6107
|
-
|
|
6108
|
-
|
|
6109
|
-
*
|
|
6110
|
-
*
|
|
6373
|
+
* <p>Structure containing attributes of the face that the algorithm detected.</p>
|
|
6374
|
+
* <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
|
|
6375
|
+
* facial attributes. The default attributes are <code>BoundingBox</code>,
|
|
6376
|
+
* <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
|
|
6377
|
+
* <code>Quality</code>.</p>
|
|
6378
|
+
* <p>
|
|
6379
|
+
* <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
|
|
6380
|
+
* return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
|
|
6381
|
+
* return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
|
|
6382
|
+
* attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
|
|
6383
|
+
* parameter:</p>
|
|
6384
|
+
* <ul>
|
|
6385
|
+
* <li>
|
|
6386
|
+
* <p>GetCelebrityRecognition</p>
|
|
6387
|
+
* </li>
|
|
6388
|
+
* <li>
|
|
6389
|
+
* <p>GetPersonTracking</p>
|
|
6390
|
+
* </li>
|
|
6391
|
+
* <li>
|
|
6392
|
+
* <p>GetFaceSearch</p>
|
|
6393
|
+
* </li>
|
|
6394
|
+
* </ul>
|
|
6395
|
+
* <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
|
|
6396
|
+
* can return all facial attributes. To specify which attributes to return, use the
|
|
6397
|
+
* <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
|
|
6398
|
+
* <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
|
|
6111
6399
|
*/
|
|
6112
|
-
|
|
6113
|
-
}
|
|
6114
|
-
/**
|
|
6115
|
-
* @public
|
|
6116
|
-
*/
|
|
6117
|
-
export interface StartProjectVersionResponse {
|
|
6400
|
+
FaceDetails?: FaceDetail;
|
|
6118
6401
|
/**
|
|
6119
|
-
* <p>
|
|
6402
|
+
* <p> Reasons why a face wasn't used for Search. </p>
|
|
6120
6403
|
*/
|
|
6121
|
-
|
|
6404
|
+
Reasons?: (UnsearchedFaceReason | string)[];
|
|
6122
6405
|
}
|
|
6123
6406
|
/**
|
|
6124
6407
|
* @public
|
|
6125
|
-
* <p>Filters for the shot detection segments returned by <code>GetSegmentDetection</code>.
|
|
6126
|
-
* For more information, see <a>StartSegmentDetectionFilters</a>.</p>
|
|
6127
6408
|
*/
|
|
6128
|
-
export interface
|
|
6409
|
+
export interface SearchUsersByImageResponse {
|
|
6129
6410
|
/**
|
|
6130
|
-
* <p>
|
|
6131
|
-
*
|
|
6132
|
-
*
|
|
6133
|
-
* lower than this specified value.</p>
|
|
6134
|
-
* <p>If you don't specify <code>MinSegmentConfidence</code>, the <code>GetSegmentDetection</code> returns
|
|
6135
|
-
* segments with confidence values greater than or equal to 50 percent.</p>
|
|
6411
|
+
* <p>An array of UserID objects that matched the input face, along with the confidence in the
|
|
6412
|
+
* match. The returned structure will be empty if there are no matches. Returned if the
|
|
6413
|
+
* SearchUsersByImageResponse action is successful.</p>
|
|
6136
6414
|
*/
|
|
6137
|
-
|
|
6138
|
-
}
|
|
6139
|
-
/**
|
|
6140
|
-
* @public
|
|
6141
|
-
* <p>Filters for the technical segments returned by <a>GetSegmentDetection</a>. For more information,
|
|
6142
|
-
* see <a>StartSegmentDetectionFilters</a>.</p>
|
|
6143
|
-
*/
|
|
6144
|
-
export interface StartTechnicalCueDetectionFilter {
|
|
6415
|
+
UserMatches?: UserMatch[];
|
|
6145
6416
|
/**
|
|
6146
|
-
* <p>
|
|
6147
|
-
*
|
|
6148
|
-
* 100 is the highest confidence. Amazon Rekognition Video doesn't return any segments with a confidence level
|
|
6149
|
-
* lower than this specified value.</p>
|
|
6150
|
-
* <p>If you don't specify <code>MinSegmentConfidence</code>, <code>GetSegmentDetection</code> returns
|
|
6151
|
-
* segments with confidence values greater than or equal to 50 percent.</p>
|
|
6152
|
-
*/
|
|
6153
|
-
MinSegmentConfidence?: number;
|
|
6154
|
-
/**
|
|
6155
|
-
* <p>
|
|
6156
|
-
* A filter that allows you to control the black frame detection by specifying the black levels and pixel coverage of black pixels in a frame.
|
|
6157
|
-
* Videos can come from multiple sources, formats, and time periods, with different standards and varying noise levels for black frames that need to be accounted for.
|
|
6158
|
-
* </p>
|
|
6417
|
+
* <p>Version number of the face detection model associated with the input collection
|
|
6418
|
+
* CollectionId.</p>
|
|
6159
6419
|
*/
|
|
6160
|
-
|
|
6161
|
-
}
|
|
6162
|
-
/**
|
|
6163
|
-
* @public
|
|
6164
|
-
* <p>Filters applied to the technical cue or shot detection segments.
|
|
6165
|
-
* For more information, see <a>StartSegmentDetection</a>.
|
|
6166
|
-
* </p>
|
|
6167
|
-
*/
|
|
6168
|
-
export interface StartSegmentDetectionFilters {
|
|
6420
|
+
FaceModelVersion?: string;
|
|
6169
6421
|
/**
|
|
6170
|
-
* <p>
|
|
6422
|
+
* <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image,
|
|
6423
|
+
* as well as the confidence in the bounding box, that was searched for matches. If no valid
|
|
6424
|
+
* face is detected in the image the response will contain no SearchedFace object.</p>
|
|
6171
6425
|
*/
|
|
6172
|
-
|
|
6426
|
+
SearchedFace?: SearchedFaceDetails;
|
|
6173
6427
|
/**
|
|
6174
|
-
* <p>
|
|
6428
|
+
* <p>List of UnsearchedFace objects. Contains the face details infered from the specified
|
|
6429
|
+
* image but not used for search. Contains reasons that describe why a face wasn't used for
|
|
6430
|
+
* Search. </p>
|
|
6175
6431
|
*/
|
|
6176
|
-
|
|
6432
|
+
UnsearchedFaces?: UnsearchedFace[];
|
|
6177
6433
|
}
|
|
6178
6434
|
/**
|
|
6179
6435
|
* @public
|
|
6180
6436
|
*/
|
|
6181
|
-
export interface
|
|
6437
|
+
export interface StartCelebrityRecognitionRequest {
|
|
6182
6438
|
/**
|
|
6183
|
-
* <p>
|
|
6184
|
-
*
|
|
6439
|
+
* <p>The video in which you want to recognize celebrities. The video must be stored
|
|
6440
|
+
* in an Amazon S3 bucket.</p>
|
|
6185
6441
|
*/
|
|
6186
6442
|
Video: Video | undefined;
|
|
6187
6443
|
/**
|
|
6188
6444
|
* <p>Idempotent token used to identify the start request. If you use the same token with multiple
|
|
6189
|
-
*
|
|
6445
|
+
* <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use
|
|
6190
6446
|
* <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
|
|
6191
6447
|
*/
|
|
6192
6448
|
ClientRequestToken?: string;
|
|
6193
6449
|
/**
|
|
6194
|
-
* <p>The
|
|
6195
|
-
*
|
|
6450
|
+
* <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
|
|
6451
|
+
* celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
|
|
6196
6452
|
*/
|
|
6197
6453
|
NotificationChannel?: NotificationChannel;
|
|
6198
6454
|
/**
|
|
@@ -6200,198 +6456,6 @@ export interface StartSegmentDetectionRequest {
|
|
|
6200
6456
|
* For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
|
|
6201
6457
|
*/
|
|
6202
6458
|
JobTag?: string;
|
|
6203
|
-
/**
|
|
6204
|
-
* <p>Filters for technical cue or shot detection.</p>
|
|
6205
|
-
*/
|
|
6206
|
-
Filters?: StartSegmentDetectionFilters;
|
|
6207
|
-
/**
|
|
6208
|
-
* <p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p>
|
|
6209
|
-
*/
|
|
6210
|
-
SegmentTypes: (SegmentType | string)[] | undefined;
|
|
6211
|
-
}
|
|
6212
|
-
/**
|
|
6213
|
-
* @public
|
|
6214
|
-
*/
|
|
6215
|
-
export interface StartSegmentDetectionResponse {
|
|
6216
|
-
/**
|
|
6217
|
-
* <p>Unique identifier for the segment detection job. The <code>JobId</code> is returned from <code>StartSegmentDetection</code>.
|
|
6218
|
-
* </p>
|
|
6219
|
-
*/
|
|
6220
|
-
JobId?: string;
|
|
6221
|
-
}
|
|
6222
|
-
/**
|
|
6223
|
-
* @public
|
|
6224
|
-
* <p>This is a required parameter for label detection stream processors and should not be used
|
|
6225
|
-
* to start a face search stream processor.</p>
|
|
6226
|
-
*/
|
|
6227
|
-
export interface StreamProcessingStartSelector {
|
|
6228
|
-
/**
|
|
6229
|
-
* <p>
|
|
6230
|
-
* Specifies the starting point in the stream to start processing. This can be done with a producer timestamp or a fragment number in a Kinesis stream.
|
|
6231
|
-
* </p>
|
|
6232
|
-
*/
|
|
6233
|
-
KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
|
|
6234
|
-
}
|
|
6235
|
-
/**
|
|
6236
|
-
* @public
|
|
6237
|
-
* <p>
|
|
6238
|
-
* Specifies when to stop processing the stream. You can specify a maximum amount
|
|
6239
|
-
* of time to process the video.
|
|
6240
|
-
* </p>
|
|
6241
|
-
*/
|
|
6242
|
-
export interface StreamProcessingStopSelector {
|
|
6243
|
-
/**
|
|
6244
|
-
* <p>
|
|
6245
|
-
* Specifies the maximum amount of time in seconds that you want the stream to be processed. The largest amount of time is 2 minutes. The default is 10 seconds.
|
|
6246
|
-
* </p>
|
|
6247
|
-
*/
|
|
6248
|
-
MaxDurationInSeconds?: number;
|
|
6249
|
-
}
|
|
6250
|
-
/**
|
|
6251
|
-
* @public
|
|
6252
|
-
*/
|
|
6253
|
-
export interface StartStreamProcessorRequest {
|
|
6254
|
-
/**
|
|
6255
|
-
* <p>The name of the stream processor to start processing.</p>
|
|
6256
|
-
*/
|
|
6257
|
-
Name: string | undefined;
|
|
6258
|
-
/**
|
|
6259
|
-
* <p>
|
|
6260
|
-
* Specifies the starting point in the Kinesis stream to start processing.
|
|
6261
|
-
* You can use the producer timestamp or the fragment number. If you use the producer timestamp, you must put the time in milliseconds.
|
|
6262
|
-
* For more information about fragment numbers, see <a href="https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html">Fragment</a>.
|
|
6263
|
-
* </p>
|
|
6264
|
-
* <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
|
|
6265
|
-
*/
|
|
6266
|
-
StartSelector?: StreamProcessingStartSelector;
|
|
6267
|
-
/**
|
|
6268
|
-
* <p>
|
|
6269
|
-
* Specifies when to stop processing the stream. You can specify a
|
|
6270
|
-
* maximum amount of time to process the video.
|
|
6271
|
-
* </p>
|
|
6272
|
-
* <p>This is a required parameter for label detection stream processors and should not be used to start a face search stream processor.</p>
|
|
6273
|
-
*/
|
|
6274
|
-
StopSelector?: StreamProcessingStopSelector;
|
|
6275
|
-
}
|
|
6276
|
-
/**
|
|
6277
|
-
* @public
|
|
6278
|
-
*/
|
|
6279
|
-
export interface StartStreamProcessorResponse {
|
|
6280
|
-
/**
|
|
6281
|
-
* <p>
|
|
6282
|
-
* A unique identifier for the stream processing session.
|
|
6283
|
-
* </p>
|
|
6284
|
-
*/
|
|
6285
|
-
SessionId?: string;
|
|
6286
|
-
}
|
|
6287
|
-
/**
|
|
6288
|
-
* @public
|
|
6289
|
-
* <p>Set of optional parameters that let you set the criteria text must meet to be included in your response.
|
|
6290
|
-
* <code>WordFilter</code> looks at a word's height, width and minimum confidence. <code>RegionOfInterest</code>
|
|
6291
|
-
* lets you set a specific region of the screen to look for text in.</p>
|
|
6292
|
-
*/
|
|
6293
|
-
export interface StartTextDetectionFilters {
|
|
6294
|
-
/**
|
|
6295
|
-
* <p>Filters focusing on qualities of the text, such as confidence or size.</p>
|
|
6296
|
-
*/
|
|
6297
|
-
WordFilter?: DetectionFilter;
|
|
6298
|
-
/**
|
|
6299
|
-
* <p>Filter focusing on a certain area of the frame. Uses a <code>BoundingBox</code> object to set the region
|
|
6300
|
-
* of the screen.</p>
|
|
6301
|
-
*/
|
|
6302
|
-
RegionsOfInterest?: RegionOfInterest[];
|
|
6303
|
-
}
|
|
6304
|
-
/**
|
|
6305
|
-
* @public
|
|
6306
|
-
*/
|
|
6307
|
-
export interface StartTextDetectionRequest {
|
|
6308
|
-
/**
|
|
6309
|
-
* <p>Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as <a>StartLabelDetection</a> use <code>Video</code> to
|
|
6310
|
-
* specify a video for analysis. The supported file formats are .mp4, .mov and .avi.</p>
|
|
6311
|
-
*/
|
|
6312
|
-
Video: Video | undefined;
|
|
6313
|
-
/**
|
|
6314
|
-
* <p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartTextDetection</code>
|
|
6315
|
-
* requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job
|
|
6316
|
-
* from being accidentaly started more than once.</p>
|
|
6317
|
-
*/
|
|
6318
|
-
ClientRequestToken?: string;
|
|
6319
|
-
/**
|
|
6320
|
-
* <p>The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see
|
|
6321
|
-
* <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html">Calling Amazon Rekognition Video operations</a>. Note that the Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
|
|
6322
|
-
* For more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics">Giving access to multiple Amazon SNS topics</a>.</p>
|
|
6323
|
-
*/
|
|
6324
|
-
NotificationChannel?: NotificationChannel;
|
|
6325
|
-
/**
|
|
6326
|
-
* <p>An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs
|
|
6327
|
-
* and identify them in the completion notification.</p>
|
|
6328
|
-
*/
|
|
6329
|
-
JobTag?: string;
|
|
6330
|
-
/**
|
|
6331
|
-
* <p>Optional parameters that let you set criteria the text must meet to be included in your response.</p>
|
|
6332
|
-
*/
|
|
6333
|
-
Filters?: StartTextDetectionFilters;
|
|
6334
|
-
}
|
|
6335
|
-
/**
|
|
6336
|
-
* @public
|
|
6337
|
-
*/
|
|
6338
|
-
export interface StartTextDetectionResponse {
|
|
6339
|
-
/**
|
|
6340
|
-
* <p>Identifier for the text detection job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetTextDetection</code>.</p>
|
|
6341
|
-
*/
|
|
6342
|
-
JobId?: string;
|
|
6343
|
-
}
|
|
6344
|
-
/**
|
|
6345
|
-
* @public
|
|
6346
|
-
*/
|
|
6347
|
-
export interface StopProjectVersionRequest {
|
|
6348
|
-
/**
|
|
6349
|
-
* <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
|
|
6350
|
-
* <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
|
|
6351
|
-
*/
|
|
6352
|
-
ProjectVersionArn: string | undefined;
|
|
6353
|
-
}
|
|
6354
|
-
/**
|
|
6355
|
-
* @public
|
|
6356
|
-
*/
|
|
6357
|
-
export interface StopProjectVersionResponse {
|
|
6358
|
-
/**
|
|
6359
|
-
* <p>The current status of the stop operation. </p>
|
|
6360
|
-
*/
|
|
6361
|
-
Status?: ProjectVersionStatus | string;
|
|
6362
|
-
}
|
|
6363
|
-
/**
|
|
6364
|
-
* @public
|
|
6365
|
-
*/
|
|
6366
|
-
export interface StopStreamProcessorRequest {
|
|
6367
|
-
/**
|
|
6368
|
-
* <p>The name of a stream processor created by <a>CreateStreamProcessor</a>.</p>
|
|
6369
|
-
*/
|
|
6370
|
-
Name: string | undefined;
|
|
6371
|
-
}
|
|
6372
|
-
/**
|
|
6373
|
-
* @public
|
|
6374
|
-
*/
|
|
6375
|
-
export interface StopStreamProcessorResponse {
|
|
6376
|
-
}
|
|
6377
|
-
/**
|
|
6378
|
-
* @public
|
|
6379
|
-
*/
|
|
6380
|
-
export interface TagResourceRequest {
|
|
6381
|
-
/**
|
|
6382
|
-
* <p> Amazon Resource Name (ARN) of the model, collection, or stream processor that you want to
|
|
6383
|
-
* assign the tags to. </p>
|
|
6384
|
-
*/
|
|
6385
|
-
ResourceArn: string | undefined;
|
|
6386
|
-
/**
|
|
6387
|
-
* <p> The key-value tags to assign to the resource. </p>
|
|
6388
|
-
*/
|
|
6389
|
-
Tags: Record<string, string> | undefined;
|
|
6390
|
-
}
|
|
6391
|
-
/**
|
|
6392
|
-
* @public
|
|
6393
|
-
*/
|
|
6394
|
-
export interface TagResourceResponse {
|
|
6395
6459
|
}
|
|
6396
6460
|
/**
|
|
6397
6461
|
* @internal
|