@aws-sdk/client-rekognition 3.351.0 → 3.352.0

package/dist-types/commands/AssociateFacesCommand.d.ts

@@ -135,6 +135,51 @@ export interface AssociateFacesCommandOutput extends AssociateFacesResponse, __M
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example AssociateFaces
+ * ```javascript
+ * // This operation associates one or more faces with an existing UserID.
+ * const input = {
+ *   "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440002",
+ *   "CollectionId": "MyCollection",
+ *   "FaceIds": [
+ *     "f5817d37-94f6-4335-bfee-6cf79a3d806e",
+ *     "851cb847-dccc-4fea-9309-9f4805967855",
+ *     "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
+ *   ],
+ *   "UserId": "DemoUser",
+ *   "UserMatchThreshold": 70
+ * };
+ * const command = new AssociateFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "AssociatedFaces": [
+ *     {
+ *       "FaceId": "35ebbb41-7f67-4263-908d-dd0ecba05ab9"
+ *     }
+ *   ],
+ *   "UnsuccessfulFaceAssociations": [
+ *     {
+ *       "Confidence": 0.9375374913215637,
+ *       "FaceId": "f5817d37-94f6-4335-bfee-6cf79a3d806e",
+ *       "Reasons": [
+ *         "LOW_MATCH_CONFIDENCE"
+ *       ]
+ *     },
+ *     {
+ *       "FaceId": "851cb847-dccc-4fea-9309-9f4805967855",
+ *       "Reasons": [
+ *         "ASSOCIATED_TO_A_DIFFERENT_USER"
+ *       ],
+ *       "UserId": "demoUser2"
+ *     }
+ *   ],
+ *   "UserStatus": "UPDATING"
+ * }
+ * *\/
+ * // example id: associatefaces-1686181269281
+ * ```
+ *
  */
 export declare class AssociateFacesCommand extends $Command<AssociateFacesCommandInput, AssociateFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: AssociateFacesCommandInput;

package/dist-types/commands/CreateUserCommand.d.ts

@@ -91,6 +91,18 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example CreateUser
+ * ```javascript
+ * // Creates a new User within a collection specified by CollectionId.
+ * const input = {
+ *   "CollectionId": "MyCollection",
+ *   "UserId": "DemoUser"
+ * };
+ * const command = new CreateUserCommand(input);
+ * await client.send(command);
+ * // example id: createuser-1686181562299
+ * ```
+ *
  */
 export declare class CreateUserCommand extends $Command<CreateUserCommandInput, CreateUserCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CreateUserCommandInput;

package/dist-types/commands/DeleteUserCommand.d.ts

@@ -83,6 +83,19 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example DeleteUser
+ * ```javascript
+ * // Deletes the specified UserID within the collection.
+ * const input = {
+ *   "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440001",
+ *   "CollectionId": "MyCollection",
+ *   "UserId": "DemoUser"
+ * };
+ * const command = new DeleteUserCommand(input);
+ * await client.send(command);
+ * // example id: deleteuser-1686181913475
+ * ```
+ *
  */
 export declare class DeleteUserCommand extends $Command<DeleteUserCommandInput, DeleteUserCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteUserCommandInput;

package/dist-types/commands/DisassociateFacesCommand.d.ts

@@ -105,6 +105,42 @@ export interface DisassociateFacesCommandOutput extends DisassociateFacesRespons
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example DisassociateFaces
+ * ```javascript
+ * // Removes the association between a Face supplied in an array of FaceIds and the User.
+ * const input = {
+ *   "ClientRequestToken": "550e8400-e29b-41d4-a716-446655440003",
+ *   "CollectionId": "MyCollection",
+ *   "FaceIds": [
+ *     "f5817d37-94f6-4335-bfee-6cf79a3d806e",
+ *     "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
+ *   ],
+ *   "UserId": "DemoUser"
+ * };
+ * const command = new DisassociateFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DisassociatedFaces": [
+ *     {
+ *       "FaceId": "c92265d4-5f9c-43af-a58e-12be0ce02bc3"
+ *     }
+ *   ],
+ *   "UnsuccessfulFaceDisassociations": [
+ *     {
+ *       "FaceId": "f5817d37-94f6-4335-bfee-6cf79a3d806e",
+ *       "Reasons": [
+ *         "ASSOCIATED_TO_A_DIFFERENT_USER"
+ *       ],
+ *       "UserId": "demoUser1"
+ *     }
+ *   ],
+ *   "UserStatus": "UPDATING"
+ * }
+ * *\/
+ * // example id: disassociatefaces-1686182627295
+ * ```
+ *
  */
 export declare class DisassociateFacesCommand extends $Command<DisassociateFacesCommandInput, DisassociateFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DisassociateFacesCommandInput;

package/dist-types/commands/ListUsersCommand.d.ts

@@ -85,6 +85,32 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example ListUsers
+ * ```javascript
+ * // Returns metadata of the User such as UserID in the specified collection.
+ * const input = {
+ *   "CollectionId": "MyCollection"
+ * };
+ * const command = new ListUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "MGYZLAHX1T5a....",
+ *   "Users": [
+ *     {
+ *       "UserId": "demoUser4",
+ *       "UserStatus": "CREATED"
+ *     },
+ *     {
+ *       "UserId": "demoUser2",
+ *       "UserStatus": "CREATED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: listusers-1686182360075
+ * ```
+ *
  */
 export declare class ListUsersCommand extends $Command<ListUsersCommandInput, ListUsersCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListUsersCommandInput;

package/dist-types/commands/SearchUsersByImageCommand.d.ts

@@ -271,6 +271,78 @@ export interface SearchUsersByImageCommandOutput extends SearchUsersByImageRespo
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example SearchUsersByImage
+ * ```javascript
+ * // Searches for UserIDs using a supplied image.
+ * const input = {
+ *   "CollectionId": "MyCollection",
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "bucket",
+ *       "Name": "input.jpg"
+ *     }
+ *   },
+ *   "MaxUsers": 2,
+ *   "QualityFilter": "MEDIUM",
+ *   "UserMatchThreshold": 70
+ * };
+ * const command = new SearchUsersByImageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceModelVersion": "6",
+ *   "SearchedFace": {
+ *     "FaceDetail": {
+ *       "BoundingBox": {
+ *         "Height": 0.07510016113519669,
+ *         "Left": 0.3598678708076477,
+ *         "Top": 0.5391526818275452,
+ *         "Width": 0.03692837432026863
+ *       }
+ *     }
+ *   },
+ *   "UnsearchedFaces": [
+ *     {
+ *       "FaceDetails": {
+ *         "BoundingBox": {
+ *           "Height": 0.0682177022099495,
+ *           "Left": 0.6102562546730042,
+ *           "Top": 0.5593535900115967,
+ *           "Width": 0.031677018851041794
+ *         }
+ *       },
+ *       "Reasons": [
+ *         "FACE_NOT_LARGEST"
+ *       ]
+ *     },
+ *     {
+ *       "FaceDetails": {
+ *         "BoundingBox": {
+ *           "Height": 0.06347997486591339,
+ *           "Left": 0.516062319278717,
+ *           "Top": 0.6080358028411865,
+ *           "Width": 0.03254449740052223
+ *         }
+ *       },
+ *       "Reasons": [
+ *         "FACE_NOT_LARGEST"
+ *       ]
+ *     }
+ *   ],
+ *   "UserMatches": [
+ *     {
+ *       "Similarity": 99.88186645507812,
+ *       "User": {
+ *         "UserId": "demoUser1",
+ *         "UserStatus": "ACTIVE"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: searchusersbyimage-1686183178610
+ * ```
+ *
  */
 export declare class SearchUsersByImageCommand extends $Command<SearchUsersByImageCommandInput, SearchUsersByImageCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: SearchUsersByImageCommandInput;

package/dist-types/commands/SearchUsersCommand.d.ts

@@ -94,6 +94,37 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example SearchUsers
+ * ```javascript
+ * // Searches for UserIDs within a collection based on a FaceId or UserId.
+ * const input = {
+ *   "CollectionId": "MyCollection",
+ *   "MaxUsers": 2,
+ *   "UserId": "DemoUser",
+ *   "UserMatchThreshold": 70
+ * };
+ * const command = new SearchUsersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceModelVersion": "6",
+ *   "SearchedUser": {
+ *     "UserId": "DemoUser"
+ *   },
+ *   "UserMatches": [
+ *     {
+ *       "Similarity": 99.88186645507812,
+ *       "User": {
+ *         "UserId": "demoUser1",
+ *         "UserStatus": "ACTIVE"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: searchusers-1686182912030
+ * ```
+ *
  */
 export declare class SearchUsersCommand extends $Command<SearchUsersCommandInput, SearchUsersCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: SearchUsersCommandInput;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rekognition",
   "description": "AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native",
-  "version": "3.351.0",
+  "version": "3.352.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.350.0",
+    "@aws-sdk/client-sts": "3.352.0",
     "@aws-sdk/config-resolver": "3.347.0",
-    "@aws-sdk/credential-provider-node": "3.350.0",
+    "@aws-sdk/credential-provider-node": "3.352.0",
     "@aws-sdk/fetch-http-handler": "3.347.0",
     "@aws-sdk/hash-node": "3.347.0",
     "@aws-sdk/invalid-dependency": "3.347.0",
@@ -36,7 +36,7 @@
     "@aws-sdk/middleware-serde": "3.347.0",
     "@aws-sdk/middleware-signing": "3.347.0",
     "@aws-sdk/middleware-stack": "3.347.0",
-    "@aws-sdk/middleware-user-agent": "3.347.0",
+    "@aws-sdk/middleware-user-agent": "3.352.0",
     "@aws-sdk/node-config-provider": "3.347.0",
     "@aws-sdk/node-http-handler": "3.350.0",
     "@aws-sdk/smithy-client": "3.347.0",
@@ -47,7 +47,7 @@
     "@aws-sdk/util-body-length-node": "3.310.0",
     "@aws-sdk/util-defaults-mode-browser": "3.347.0",
     "@aws-sdk/util-defaults-mode-node": "3.347.0",
-    "@aws-sdk/util-endpoints": "3.347.0",
+    "@aws-sdk/util-endpoints": "3.352.0",
     "@aws-sdk/util-retry": "3.347.0",
     "@aws-sdk/util-user-agent-browser": "3.347.0",
     "@aws-sdk/util-user-agent-node": "3.347.0",