@aws-sdk/client-rekognition 3.351.0 → 3.353.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AssociateFacesCommand.d.ts +45 -0
- package/dist-types/commands/CreateUserCommand.d.ts +12 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +13 -0
- package/dist-types/commands/DisassociateFacesCommand.d.ts +36 -0
- package/dist-types/commands/ListUsersCommand.d.ts +26 -0
- package/dist-types/commands/SearchUsersByImageCommand.d.ts +72 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +31 -0
- package/package.json +13 -13
|
@@ -135,6 +135,51 @@ export interface AssociateFacesCommandOutput extends AssociateFacesResponse, __M
|
|
|
135
135
|
* @throws {@link RekognitionServiceException}
|
|
136
136
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
137
137
|
*
|
|
138
|
+
* @example AssociateFaces
|
|
139
|
+
* ```javascript
|
|
140
|
+
* // This operation associates one or more faces with an existing UserID.
|
|
141
|
+
* const input = {
|
|
142
|
+
* "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440002",
|
|
143
|
+
* "CollectionId": "MyCollection",
|
|
144
|
+
* "FaceIds": [
|
|
145
|
+
* "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
146
|
+
* "851cb847-dccc-4fea-9309-9f4805967855",
|
|
147
|
+
* "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
|
|
148
|
+
* ],
|
|
149
|
+
* "UserId": "DemoUser",
|
|
150
|
+
* "UserMatchThreshold": 70
|
|
151
|
+
* };
|
|
152
|
+
* const command = new AssociateFacesCommand(input);
|
|
153
|
+
* const response = await client.send(command);
|
|
154
|
+
* /* response ==
|
|
155
|
+
* {
|
|
156
|
+
* "AssociatedFaces": [
|
|
157
|
+
* {
|
|
158
|
+
* "FaceId": "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
|
|
159
|
+
* }
|
|
160
|
+
* ],
|
|
161
|
+
* "UnsuccessfulFaceAssociations": [
|
|
162
|
+
* {
|
|
163
|
+
* "Confidence": 0.9375374913215637,
|
|
164
|
+
* "FaceId": "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
165
|
+
* "Reasons": [
|
|
166
|
+
* "LOW_MATCH_CONFIDENCE"
|
|
167
|
+
* ]
|
|
168
|
+
* },
|
|
169
|
+
* {
|
|
170
|
+
* "FaceId": "851cb847-dccc-4fea-9309-9f4805967855",
|
|
171
|
+
* "Reasons": [
|
|
172
|
+
* "ASSOCIATED_TO_A_DIFFERENT_USER"
|
|
173
|
+
* ],
|
|
174
|
+
* "UserId": "demoUser2"
|
|
175
|
+
* }
|
|
176
|
+
* ],
|
|
177
|
+
* "UserStatus": "UPDATING"
|
|
178
|
+
* }
|
|
179
|
+
* *\/
|
|
180
|
+
* // example id: associatefaces-1686181269281
|
|
181
|
+
* ```
|
|
182
|
+
*
|
|
138
183
|
*/
|
|
139
184
|
export declare class AssociateFacesCommand extends $Command<AssociateFacesCommandInput, AssociateFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
140
185
|
readonly input: AssociateFacesCommandInput;
|
|
@@ -91,6 +91,18 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
|
|
|
91
91
|
* @throws {@link RekognitionServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
93
93
|
*
|
|
94
|
+
* @example CreateUser
|
|
95
|
+
* ```javascript
|
|
96
|
+
* // Creates a new User within a collection specified by CollectionId.
|
|
97
|
+
* const input = {
|
|
98
|
+
* "CollectionId": "MyCollection",
|
|
99
|
+
* "UserId": "DemoUser"
|
|
100
|
+
* };
|
|
101
|
+
* const command = new CreateUserCommand(input);
|
|
102
|
+
* await client.send(command);
|
|
103
|
+
* // example id: createuser-1686181562299
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
94
106
|
*/
|
|
95
107
|
export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, RekognitionClientResolvedConfig> {
|
|
96
108
|
readonly input: CreateUserCommandInput;
|
|
@@ -83,6 +83,19 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
|
|
|
83
83
|
* @throws {@link RekognitionServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
85
85
|
*
|
|
86
|
+
* @example DeleteUser
|
|
87
|
+
* ```javascript
|
|
88
|
+
* // Deletes the specified UserID within the collection.
|
|
89
|
+
* const input = {
|
|
90
|
+
* "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440001",
|
|
91
|
+
* "CollectionId": "MyCollection",
|
|
92
|
+
* "UserId": "DemoUser"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new DeleteUserCommand(input);
|
|
95
|
+
* await client.send(command);
|
|
96
|
+
* // example id: deleteuser-1686181913475
|
|
97
|
+
* ```
|
|
98
|
+
*
|
|
86
99
|
*/
|
|
87
100
|
export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, RekognitionClientResolvedConfig> {
|
|
88
101
|
readonly input: DeleteUserCommandInput;
|
|
@@ -105,6 +105,42 @@ export interface DisassociateFacesCommandOutput extends DisassociateFacesRespons
|
|
|
105
105
|
* @throws {@link RekognitionServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
107
107
|
*
|
|
108
|
+
* @example DisassociateFaces
|
|
109
|
+
* ```javascript
|
|
110
|
+
* // Removes the association between a Face supplied in an array of FaceIds and the User.
|
|
111
|
+
* const input = {
|
|
112
|
+
* "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440003",
|
|
113
|
+
* "CollectionId": "MyCollection",
|
|
114
|
+
* "FaceIds": [
|
|
115
|
+
* "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
116
|
+
* "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
|
|
117
|
+
* ],
|
|
118
|
+
* "UserId": "DemoUser"
|
|
119
|
+
* };
|
|
120
|
+
* const command = new DisassociateFacesCommand(input);
|
|
121
|
+
* const response = await client.send(command);
|
|
122
|
+
* /* response ==
|
|
123
|
+
* {
|
|
124
|
+
* "DisassociatedFaces": [
|
|
125
|
+
* {
|
|
126
|
+
* "FaceId": "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
|
|
127
|
+
* }
|
|
128
|
+
* ],
|
|
129
|
+
* "UnsuccessfulFaceDisassociations": [
|
|
130
|
+
* {
|
|
131
|
+
* "FaceId": "f5817d37-94f6-4335-bfee-6cf79a3d806e",
|
|
132
|
+
* "Reasons": [
|
|
133
|
+
* "ASSOCIATED_TO_A_DIFFERENT_USER"
|
|
134
|
+
* ],
|
|
135
|
+
* "UserId": "demoUser1"
|
|
136
|
+
* }
|
|
137
|
+
* ],
|
|
138
|
+
* "UserStatus": "UPDATING"
|
|
139
|
+
* }
|
|
140
|
+
* *\/
|
|
141
|
+
* // example id: disassociatefaces-1686182627295
|
|
142
|
+
* ```
|
|
143
|
+
*
|
|
108
144
|
*/
|
|
109
145
|
export declare class DisassociateFacesCommand extends $Command<DisassociateFacesCommandInput, DisassociateFacesCommandOutput, RekognitionClientResolvedConfig> {
|
|
110
146
|
readonly input: DisassociateFacesCommandInput;
|
|
@@ -85,6 +85,32 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
|
|
|
85
85
|
* @throws {@link RekognitionServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
87
87
|
*
|
|
88
|
+
* @example ListUsers
|
|
89
|
+
* ```javascript
|
|
90
|
+
* // Returns metadata of the User such as UserID in the specified collection.
|
|
91
|
+
* const input = {
|
|
92
|
+
* "CollectionId": "MyCollection"
|
|
93
|
+
* };
|
|
94
|
+
* const command = new ListUsersCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* /* response ==
|
|
97
|
+
* {
|
|
98
|
+
* "NextToken": "MGYZLAHX1T5a....",
|
|
99
|
+
* "Users": [
|
|
100
|
+
* {
|
|
101
|
+
* "UserId": "demoUser4",
|
|
102
|
+
* "UserStatus": "CREATED"
|
|
103
|
+
* },
|
|
104
|
+
* {
|
|
105
|
+
* "UserId": "demoUser2",
|
|
106
|
+
* "UserStatus": "CREATED"
|
|
107
|
+
* }
|
|
108
|
+
* ]
|
|
109
|
+
* }
|
|
110
|
+
* *\/
|
|
111
|
+
* // example id: listusers-1686182360075
|
|
112
|
+
* ```
|
|
113
|
+
*
|
|
88
114
|
*/
|
|
89
115
|
export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, RekognitionClientResolvedConfig> {
|
|
90
116
|
readonly input: ListUsersCommandInput;
|
|
@@ -271,6 +271,78 @@ export interface SearchUsersByImageCommandOutput extends SearchUsersByImageRespo
|
|
|
271
271
|
* @throws {@link RekognitionServiceException}
|
|
272
272
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
273
273
|
*
|
|
274
|
+
* @example SearchUsersByImage
|
|
275
|
+
* ```javascript
|
|
276
|
+
* // Searches for UserIDs using a supplied image.
|
|
277
|
+
* const input = {
|
|
278
|
+
* "CollectionId": "MyCollection",
|
|
279
|
+
* "Image": {
|
|
280
|
+
* "S3Object": {
|
|
281
|
+
* "Bucket": "bucket",
|
|
282
|
+
* "Name": "input.jpg"
|
|
283
|
+
* }
|
|
284
|
+
* },
|
|
285
|
+
* "MaxUsers": 2,
|
|
286
|
+
* "QualityFilter": "MEDIUM",
|
|
287
|
+
* "UserMatchThreshold": 70
|
|
288
|
+
* };
|
|
289
|
+
* const command = new SearchUsersByImageCommand(input);
|
|
290
|
+
* const response = await client.send(command);
|
|
291
|
+
* /* response ==
|
|
292
|
+
* {
|
|
293
|
+
* "FaceModelVersion": "6",
|
|
294
|
+
* "SearchedFace": {
|
|
295
|
+
* "FaceDetail": {
|
|
296
|
+
* "BoundingBox": {
|
|
297
|
+
* "Height": 0.07510016113519669,
|
|
298
|
+
* "Left": 0.3598678708076477,
|
|
299
|
+
* "Top": 0.5391526818275452,
|
|
300
|
+
* "Width": 0.03692837432026863
|
|
301
|
+
* }
|
|
302
|
+
* }
|
|
303
|
+
* },
|
|
304
|
+
* "UnsearchedFaces": [
|
|
305
|
+
* {
|
|
306
|
+
* "FaceDetails": {
|
|
307
|
+
* "BoundingBox": {
|
|
308
|
+
* "Height": 0.0682177022099495,
|
|
309
|
+
* "Left": 0.6102562546730042,
|
|
310
|
+
* "Top": 0.5593535900115967,
|
|
311
|
+
* "Width": 0.031677018851041794
|
|
312
|
+
* }
|
|
313
|
+
* },
|
|
314
|
+
* "Reasons": [
|
|
315
|
+
* "FACE_NOT_LARGEST"
|
|
316
|
+
* ]
|
|
317
|
+
* },
|
|
318
|
+
* {
|
|
319
|
+
* "FaceDetails": {
|
|
320
|
+
* "BoundingBox": {
|
|
321
|
+
* "Height": 0.06347997486591339,
|
|
322
|
+
* "Left": 0.516062319278717,
|
|
323
|
+
* "Top": 0.6080358028411865,
|
|
324
|
+
* "Width": 0.03254449740052223
|
|
325
|
+
* }
|
|
326
|
+
* },
|
|
327
|
+
* "Reasons": [
|
|
328
|
+
* "FACE_NOT_LARGEST"
|
|
329
|
+
* ]
|
|
330
|
+
* }
|
|
331
|
+
* ],
|
|
332
|
+
* "UserMatches": [
|
|
333
|
+
* {
|
|
334
|
+
* "Similarity": 99.88186645507812,
|
|
335
|
+
* "User": {
|
|
336
|
+
* "UserId": "demoUser1",
|
|
337
|
+
* "UserStatus": "ACTIVE"
|
|
338
|
+
* }
|
|
339
|
+
* }
|
|
340
|
+
* ]
|
|
341
|
+
* }
|
|
342
|
+
* *\/
|
|
343
|
+
* // example id: searchusersbyimage-1686183178610
|
|
344
|
+
* ```
|
|
345
|
+
*
|
|
274
346
|
*/
|
|
275
347
|
export declare class SearchUsersByImageCommand extends $Command<SearchUsersByImageCommandInput, SearchUsersByImageCommandOutput, RekognitionClientResolvedConfig> {
|
|
276
348
|
readonly input: SearchUsersByImageCommandInput;
|
|
@@ -94,6 +94,37 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
|
|
|
94
94
|
* @throws {@link RekognitionServiceException}
|
|
95
95
|
* <p>Base exception class for all service exceptions from Rekognition service.</p>
|
|
96
96
|
*
|
|
97
|
+
* @example SearchUsers
|
|
98
|
+
* ```javascript
|
|
99
|
+
* // Searches for UserIDs within a collection based on a FaceId or UserId.
|
|
100
|
+
* const input = {
|
|
101
|
+
* "CollectionId": "MyCollection",
|
|
102
|
+
* "MaxUsers": 2,
|
|
103
|
+
* "UserId": "DemoUser",
|
|
104
|
+
* "UserMatchThreshold": 70
|
|
105
|
+
* };
|
|
106
|
+
* const command = new SearchUsersCommand(input);
|
|
107
|
+
* const response = await client.send(command);
|
|
108
|
+
* /* response ==
|
|
109
|
+
* {
|
|
110
|
+
* "FaceModelVersion": "6",
|
|
111
|
+
* "SearchedUser": {
|
|
112
|
+
* "UserId": "DemoUser"
|
|
113
|
+
* },
|
|
114
|
+
* "UserMatches": [
|
|
115
|
+
* {
|
|
116
|
+
* "Similarity": 99.88186645507812,
|
|
117
|
+
* "User": {
|
|
118
|
+
* "UserId": "demoUser1",
|
|
119
|
+
* "UserStatus": "ACTIVE"
|
|
120
|
+
* }
|
|
121
|
+
* }
|
|
122
|
+
* ]
|
|
123
|
+
* }
|
|
124
|
+
* *\/
|
|
125
|
+
* // example id: searchusers-1686182912030
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
97
128
|
*/
|
|
98
129
|
export declare class SearchUsersCommand extends $Command<SearchUsersCommandInput, SearchUsersCommandOutput, RekognitionClientResolvedConfig> {
|
|
99
130
|
readonly input: SearchUsersCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-rekognition",
|
|
3
3
|
"description": "AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.353.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,10 +21,10 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/config-resolver": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.353.0",
|
|
25
|
+
"@aws-sdk/config-resolver": "3.353.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.353.0",
|
|
27
|
+
"@aws-sdk/fetch-http-handler": "3.353.0",
|
|
28
28
|
"@aws-sdk/hash-node": "3.347.0",
|
|
29
29
|
"@aws-sdk/invalid-dependency": "3.347.0",
|
|
30
30
|
"@aws-sdk/middleware-content-length": "3.347.0",
|
|
@@ -32,12 +32,12 @@
|
|
|
32
32
|
"@aws-sdk/middleware-host-header": "3.347.0",
|
|
33
33
|
"@aws-sdk/middleware-logger": "3.347.0",
|
|
34
34
|
"@aws-sdk/middleware-recursion-detection": "3.347.0",
|
|
35
|
-
"@aws-sdk/middleware-retry": "3.
|
|
35
|
+
"@aws-sdk/middleware-retry": "3.353.0",
|
|
36
36
|
"@aws-sdk/middleware-serde": "3.347.0",
|
|
37
|
-
"@aws-sdk/middleware-signing": "3.
|
|
37
|
+
"@aws-sdk/middleware-signing": "3.353.0",
|
|
38
38
|
"@aws-sdk/middleware-stack": "3.347.0",
|
|
39
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
40
|
-
"@aws-sdk/node-config-provider": "3.
|
|
39
|
+
"@aws-sdk/middleware-user-agent": "3.352.0",
|
|
40
|
+
"@aws-sdk/node-config-provider": "3.353.0",
|
|
41
41
|
"@aws-sdk/node-http-handler": "3.350.0",
|
|
42
42
|
"@aws-sdk/smithy-client": "3.347.0",
|
|
43
43
|
"@aws-sdk/types": "3.347.0",
|
|
@@ -45,12 +45,12 @@
|
|
|
45
45
|
"@aws-sdk/util-base64": "3.310.0",
|
|
46
46
|
"@aws-sdk/util-body-length-browser": "3.310.0",
|
|
47
47
|
"@aws-sdk/util-body-length-node": "3.310.0",
|
|
48
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
49
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
50
|
-
"@aws-sdk/util-endpoints": "3.
|
|
48
|
+
"@aws-sdk/util-defaults-mode-browser": "3.353.0",
|
|
49
|
+
"@aws-sdk/util-defaults-mode-node": "3.353.0",
|
|
50
|
+
"@aws-sdk/util-endpoints": "3.352.0",
|
|
51
51
|
"@aws-sdk/util-retry": "3.347.0",
|
|
52
52
|
"@aws-sdk/util-user-agent-browser": "3.347.0",
|
|
53
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
53
|
+
"@aws-sdk/util-user-agent-node": "3.353.0",
|
|
54
54
|
"@aws-sdk/util-utf8": "3.310.0",
|
|
55
55
|
"@aws-sdk/util-waiter": "3.347.0",
|
|
56
56
|
"@smithy/protocol-http": "^1.0.1",
|