feat(client-rekognition): This release adds support for improved accuracy with user vector in Amazon Rekognition Face Search. Adds new APIs: AssociateFaces, CreateUser, DeleteUser, DisassociateFaces, ListUsers, SearchUsers, SearchUsersByImage. Also adds new face metadata that can be stored: user vector.

Author: awstools

clients/client-rekognition/README.md

@@ -16,6 +16,11 @@ parameters, and common errors.</p>
 <ul>
 <li>
 <p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.html">AssociateFaces</a>
+</p>
+</li>
+<li>
+<p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html">CompareFaces</a>
 </p>
 </li>
@@ -26,6 +31,11 @@ parameters, and common errors.</p>
 </li>
 <li>
 <p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.html">CreateUser</a>
+</p>
+</li>
+<li>
+<p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html">DeleteCollection</a>
 </p>
 </li>
@@ -36,6 +46,11 @@ parameters, and common errors.</p>
 </li>
 <li>
 <p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.html">DeleteUser</a>
+</p>
+</li>
+<li>
+<p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html">DescribeCollection</a>
 </p>
 </li>
@@ -66,6 +81,11 @@ parameters, and common errors.</p>
 </li>
 <li>
 <p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html">DisassociateFaces</a>
+</p>
+</li>
+<li>
+<p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html">GetCelebrityInfo</a>
 </p>
 </li>
@@ -86,6 +106,11 @@ parameters, and common errors.</p>
 </li>
 <li>
 <p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html">ListUsers</a>
+</p>
+</li>
+<li>
+<p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html">RecognizeCelebrities</a>
 </p>
 </li>
@@ -99,6 +124,16 @@ parameters, and common errors.</p>
 <a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html">SearchFacesByImage</a>
 </p>
 </li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html">SearchUsers</a>
+</p>
+</li>
+<li>
+<p>
+<a href="https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html">SearchUsersByImage</a>
+</p>
+</li>
 </ul>
 <p>
 <b>Amazon Rekognition Custom Labels</b>
@@ -346,16 +381,16 @@ using your favorite package manager:
 
 The AWS SDK is modulized by clients and commands.
 To send a request, you only need to import the `RekognitionClient` and
-the commands you need, for example `CompareFacesCommand`:
+the commands you need, for example `AssociateFacesCommand`:
 
 ```js
 // ES5 example
-const { RekognitionClient, CompareFacesCommand } = require("@aws-sdk/client-rekognition");
+const { RekognitionClient, AssociateFacesCommand } = require("@aws-sdk/client-rekognition");
 ```
 
 ```ts
 // ES6+ example
-import { RekognitionClient, CompareFacesCommand } from "@aws-sdk/client-rekognition";
+import { RekognitionClient, AssociateFacesCommand } from "@aws-sdk/client-rekognition";
 ```
 
 ### Usage
@@ -374,7 +409,7 @@ const client = new RekognitionClient({ region: "REGION" });
 const params = {
   /** input parameters */
 };
-const command = new CompareFacesCommand(params);
+const command = new AssociateFacesCommand(params);
 ```
 
 #### Async/await
@@ -453,15 +488,15 @@ const client = new AWS.Rekognition({ region: "REGION" });
 
 // async/await.
 try {
-  const data = await client.compareFaces(params);
+  const data = await client.associateFaces(params);
   // process data.
 } catch (error) {
   // error handling.
 }
 
 // Promises.
 client
-  .compareFaces(params)
+  .associateFaces(params)
   .then((data) => {
     // process data.
   })
@@ -470,7 +505,7 @@ client
   });
 
 // callbacks.
-client.compareFaces(params, (err, data) => {
+client.associateFaces(params, (err, data) => {
   // process err and data.
 });
 ```
@@ -526,6 +561,14 @@ see LICENSE for more information.
 
 ## Client Commands (Operations List)
 
+<details>
+<summary>
+AssociateFaces
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/associatefacescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/associatefacescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/associatefacescommandoutput.html)
+
+</details>
 <details>
 <summary>
 CompareFaces
@@ -589,6 +632,14 @@ CreateStreamProcessor
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/createstreamprocessorcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/createstreamprocessorcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/createstreamprocessorcommandoutput.html)
 
+</details>
+<details>
+<summary>
+CreateUser
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/createusercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/createusercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/createusercommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -645,6 +696,14 @@ DeleteStreamProcessor
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/deletestreamprocessorcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/deletestreamprocessorcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/deletestreamprocessorcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DeleteUser
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/deleteusercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/deleteusercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/deleteusercommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -733,6 +792,14 @@ DetectText
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/detecttextcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/detecttextcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/detecttextcommandoutput.html)
 
+</details>
+<details>
+<summary>
+DisassociateFaces
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/disassociatefacescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/disassociatefacescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/disassociatefacescommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -885,6 +952,14 @@ ListTagsForResource
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/listtagsforresourcecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/listtagsforresourcecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/listtagsforresourcecommandoutput.html)
 
+</details>
+<details>
+<summary>
+ListUsers
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/listuserscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/listuserscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/listuserscommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -917,6 +992,22 @@ SearchFacesByImage
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/searchfacesbyimagecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchfacesbyimagecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchfacesbyimagecommandoutput.html)
 
+</details>
+<details>
+<summary>
+SearchUsers
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/searchuserscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchuserscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchuserscommandoutput.html)
+
+</details>
+<details>
+<summary>
+SearchUsersByImage
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/classes/searchusersbyimagecommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchusersbyimagecommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-rekognition/interfaces/searchusersbyimagecommandoutput.html)
+
 </details>
 <details>
 <summary>

clients/client-rekognition/package.json

@@ -55,12 +55,14 @@
     "@aws-sdk/util-waiter": "*",
     "@smithy/protocol-http": "^1.0.1",
     "@smithy/types": "^1.0.0",
-    "tslib": "^2.5.0"
+    "tslib": "^2.5.0",
+    "uuid": "^8.3.2"
   },
   "devDependencies": {
     "@aws-sdk/service-client-documentation-generator": "*",
     "@tsconfig/node14": "1.0.3",
     "@types/node": "^14.14.31",
+    "@types/uuid": "^8.3.0",
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",