@aws-sdk/client-rekognition 3.287.0 → 3.289.0

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

@@ -79,6 +79,56 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
  * @see {@link CompareFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To compare two images
+ * ```javascript
+ * // This operation compares the largest face detected in the source image with each face detected in the target image.
+ * const input = {
+ *   "SimilarityThreshold": 90,
+ *   "SourceImage": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "mysourceimage"
+ *     }
+ *   },
+ *   "TargetImage": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "mytargetimage"
+ *     }
+ *   }
+ * };
+ * const command = new CompareFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceMatches": [
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.33481481671333313,
+ *           "Left": 0.31888890266418457,
+ *           "Top": 0.4933333396911621,
+ *           "Width": 0.25
+ *         },
+ *         "Confidence": 99.9991226196289
+ *       },
+ *       "Similarity": 100
+ *     }
+ *   ],
+ *   "SourceImageFace": {
+ *     "BoundingBox": {
+ *       "Height": 0.33481481671333313,
+ *       "Left": 0.31888890266418457,
+ *       "Top": 0.4933333396911621,
+ *       "Width": 0.25
+ *     },
+ *     "Confidence": 99.9991226196289
+ *   }
+ * }
+ * *\/
+ * // example id: to-compare-two-images-1482181985581
+ * ```
+ *
  */
 export declare class CompareFacesCommand extends $Command<CompareFacesCommandInput, CompareFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CompareFacesCommandInput;

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

@@ -47,6 +47,33 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
  * @see {@link CopyProjectVersionCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example CopyProjectVersion
+ * ```javascript
+ * // This operation copies a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
+ * const input = {
+ *   "DestinationProjectArn": "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/1656705098765",
+ *   "KmsKeyId": "arn:1234abcd-12ab-34cd-56ef-1234567890ab",
+ *   "OutputConfig": {
+ *     "S3Bucket": "bucket-name",
+ *     "S3KeyPrefix": "path_to_folder"
+ *   },
+ *   "SourceProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/16565123456",
+ *   "SourceProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/version/model_1/1656611123456",
+ *   "Tags": {
+ *     "key1": "val1"
+ *   },
+ *   "VersionName": "DestinationVersionName_cross_account"
+ * };
+ * const command = new CopyProjectVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProjectVersionArn": "arn:aws:rekognition:us-east-1:555555555555:project/DestinationProject/version/DestinationVersionName_cross_account/16567050987651"
+ * }
+ * *\/
+ * // example id: copyprojectversion-1658203943815
+ * ```
+ *
  */
 export declare class CopyProjectVersionCommand extends $Command<CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CopyProjectVersionCommandInput;

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

@@ -43,6 +43,23 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
  * @see {@link CreateCollectionCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To create a collection
+ * ```javascript
+ * // This operation creates a Rekognition collection for storing image data.
+ * const input = {
+ *   "CollectionId": "myphotos"
+ * };
+ * const command = new CreateCollectionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/myphotos",
+ *   "StatusCode": 200
+ * }
+ * *\/
+ * // example id: to-create-a-collection-1481833313674
+ * ```
+ *
  */
 export declare class CreateCollectionCommand extends $Command<CreateCollectionCommandInput, CreateCollectionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CreateCollectionCommandInput;

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

@@ -33,6 +33,22 @@ export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse,
  * @see {@link DeleteCollectionCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To delete a collection
+ * ```javascript
+ * // This operation deletes a Rekognition collection.
+ * const input = {
+ *   "CollectionId": "myphotos"
+ * };
+ * const command = new DeleteCollectionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "StatusCode": 200
+ * }
+ * *\/
+ * // example id: to-delete-a-collection-1481838179973
+ * ```
+ *
  */
 export declare class DeleteCollectionCommand extends $Command<DeleteCollectionCommandInput, DeleteCollectionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteCollectionCommandInput;

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

@@ -32,6 +32,27 @@ export interface DeleteFacesCommandOutput extends DeleteFacesResponse, __Metadat
  * @see {@link DeleteFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To delete a face
+ * ```javascript
+ * // This operation deletes one or more faces from a Rekognition collection.
+ * const input = {
+ *   "CollectionId": "myphotos",
+ *   "FaceIds": [
+ *     "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
+ *   ]
+ * };
+ * const command = new DeleteFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DeletedFaces": [
+ *     "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-a-face-1482182799377
+ * ```
+ *
  */
 export declare class DeleteFacesCommand extends $Command<DeleteFacesCommandInput, DeleteFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteFacesCommandInput;

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

@@ -30,6 +30,19 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
  * @see {@link DeleteProjectPolicyCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example DeleteProjectPolicy
+ * ```javascript
+ * // This operation deletes a revision of an existing project policy from an Amazon Rekognition Custom Labels project.
+ * const input = {
+ *   "PolicyName": "testPolicy1",
+ *   "PolicyRevisionId": "3b274c25e9203a56a99e00e3ff205fbc",
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/SourceProject/1656557123456"
+ * };
+ * const command = new DeleteProjectPolicyCommand(input);
+ * await client.send(command);
+ * // example id: deleteprojectpolicy-1658204413810
+ * ```
+ *
  */
 export declare class DeleteProjectPolicyCommand extends $Command<DeleteProjectPolicyCommandInput, DeleteProjectPolicyCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteProjectPolicyCommandInput;

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

@@ -47,6 +47,74 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
  * @see {@link DetectFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To detect faces in an image
+ * ```javascript
+ * // This operation detects faces in an image stored in an AWS S3 bucket.
+ * const input = {
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "myphoto"
+ *     }
+ *   }
+ * };
+ * const command = new DetectFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceDetails": [
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.18000000715255737,
+ *         "Left": 0.5555555820465088,
+ *         "Top": 0.33666667342185974,
+ *         "Width": 0.23999999463558197
+ *       },
+ *       "Confidence": 100,
+ *       "Landmarks": [
+ *         {
+ *           "Type": "eyeLeft",
+ *           "X": 0.6394737362861633,
+ *           "Y": 0.40819624066352844
+ *         },
+ *         {
+ *           "Type": "eyeRight",
+ *           "X": 0.7266660928726196,
+ *           "Y": 0.41039225459098816
+ *         },
+ *         {
+ *           "Type": "eyeRight",
+ *           "X": 0.6912462115287781,
+ *           "Y": 0.44240960478782654
+ *         },
+ *         {
+ *           "Type": "mouthDown",
+ *           "X": 0.6306198239326477,
+ *           "Y": 0.46700039505958557
+ *         },
+ *         {
+ *           "Type": "mouthUp",
+ *           "X": 0.7215608954429626,
+ *           "Y": 0.47114261984825134
+ *         }
+ *       ],
+ *       "Pose": {
+ *         "Pitch": 4.050806522369385,
+ *         "Roll": 0.9950747489929199,
+ *         "Yaw": 13.693790435791016
+ *       },
+ *       "Quality": {
+ *         "Brightness": 37.60169982910156,
+ *         "Sharpness": 80
+ *       }
+ *     }
+ *   ],
+ *   "OrientationCorrection": "ROTATE_0"
+ * }
+ * *\/
+ * // example id: to-detect-faces-in-an-image-1481841782793
+ * ```
+ *
  */
 export declare class DetectFacesCommand extends $Command<DetectFacesCommandInput, DetectFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DetectFacesCommandInput;

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

@@ -141,6 +141,38 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
  * @see {@link DetectLabelsCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To detect labels
+ * ```javascript
+ * // This operation detects labels in the supplied image
+ * const input = {
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "myphoto"
+ *     }
+ *   },
+ *   "MaxLabels": 123,
+ *   "MinConfidence": 70
+ * };
+ * const command = new DetectLabelsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Labels": [
+ *     {
+ *       "Confidence": 99.25072479248047,
+ *       "Name": "People"
+ *     },
+ *     {
+ *       "Confidence": 99.25074005126953,
+ *       "Name": "Person"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-detect-labels-1481834255770
+ * ```
+ *
  */
 export declare class DetectLabelsCommand extends $Command<DetectLabelsCommandInput, DetectLabelsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DetectLabelsCommandInput;

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

@@ -119,6 +119,148 @@ export interface IndexFacesCommandOutput extends IndexFacesResponse, __MetadataB
  * @see {@link IndexFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To add a face to a collection
+ * ```javascript
+ * // This operation detects faces in an image and adds them to the specified Rekognition collection.
+ * const input = {
+ *   "CollectionId": "myphotos",
+ *   "DetectionAttributes": [],
+ *   "ExternalImageId": "myphotoid",
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "myphoto"
+ *     }
+ *   }
+ * };
+ * const command = new IndexFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceRecords": [
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.33481481671333313,
+ *           "Left": 0.31888890266418457,
+ *           "Top": 0.4933333396911621,
+ *           "Width": 0.25
+ *         },
+ *         "Confidence": 99.9991226196289,
+ *         "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
+ *         "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
+ *       },
+ *       "FaceDetail": {
+ *         "BoundingBox": {
+ *           "Height": 0.33481481671333313,
+ *           "Left": 0.31888890266418457,
+ *           "Top": 0.4933333396911621,
+ *           "Width": 0.25
+ *         },
+ *         "Confidence": 99.9991226196289,
+ *         "Landmarks": [
+ *           {
+ *             "Type": "eyeLeft",
+ *             "X": 0.3976764678955078,
+ *             "Y": 0.6248345971107483
+ *           },
+ *           {
+ *             "Type": "eyeRight",
+ *             "X": 0.4810936450958252,
+ *             "Y": 0.6317117214202881
+ *           },
+ *           {
+ *             "Type": "noseLeft",
+ *             "X": 0.41986238956451416,
+ *             "Y": 0.7111940383911133
+ *           },
+ *           {
+ *             "Type": "mouthDown",
+ *             "X": 0.40525302290916443,
+ *             "Y": 0.7497701048851013
+ *           },
+ *           {
+ *             "Type": "mouthUp",
+ *             "X": 0.4753248989582062,
+ *             "Y": 0.7558549642562866
+ *           }
+ *         ],
+ *         "Pose": {
+ *           "Pitch": -9.713645935058594,
+ *           "Roll": 4.707281112670898,
+ *           "Yaw": -24.438663482666016
+ *         },
+ *         "Quality": {
+ *           "Brightness": 29.23358917236328,
+ *           "Sharpness": 80
+ *         }
+ *       }
+ *     },
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.32592591643333435,
+ *           "Left": 0.5144444704055786,
+ *           "Top": 0.15111111104488373,
+ *           "Width": 0.24444444477558136
+ *         },
+ *         "Confidence": 99.99950408935547,
+ *         "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
+ *         "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
+ *       },
+ *       "FaceDetail": {
+ *         "BoundingBox": {
+ *           "Height": 0.32592591643333435,
+ *           "Left": 0.5144444704055786,
+ *           "Top": 0.15111111104488373,
+ *           "Width": 0.24444444477558136
+ *         },
+ *         "Confidence": 99.99950408935547,
+ *         "Landmarks": [
+ *           {
+ *             "Type": "eyeLeft",
+ *             "X": 0.6006892323493958,
+ *             "Y": 0.290842205286026
+ *           },
+ *           {
+ *             "Type": "eyeRight",
+ *             "X": 0.6808141469955444,
+ *             "Y": 0.29609042406082153
+ *           },
+ *           {
+ *             "Type": "noseLeft",
+ *             "X": 0.6395332217216492,
+ *             "Y": 0.3522595763206482
+ *           },
+ *           {
+ *             "Type": "mouthDown",
+ *             "X": 0.5892083048820496,
+ *             "Y": 0.38689887523651123
+ *           },
+ *           {
+ *             "Type": "mouthUp",
+ *             "X": 0.674560010433197,
+ *             "Y": 0.394125759601593
+ *           }
+ *         ],
+ *         "Pose": {
+ *           "Pitch": -4.683138370513916,
+ *           "Roll": 2.1029529571533203,
+ *           "Yaw": 6.716655254364014
+ *         },
+ *         "Quality": {
+ *           "Brightness": 34.951698303222656,
+ *           "Sharpness": 160
+ *         }
+ *       }
+ *     }
+ *   ],
+ *   "OrientationCorrection": "ROTATE_0"
+ * }
+ * *\/
+ * // example id: to-add-a-face-to-a-collection-1482179542923
+ * ```
+ *
  */
 export declare class IndexFacesCommand extends $Command<IndexFacesCommandInput, IndexFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: IndexFacesCommandInput;

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

@@ -35,6 +35,22 @@ export interface ListCollectionsCommandOutput extends ListCollectionsResponse, _
  * @see {@link ListCollectionsCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To list the collections
+ * ```javascript
+ * // This operation returns a list of Rekognition collections.
+ * const input = {};
+ * const command = new ListCollectionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CollectionIds": [
+ *     "myphotos"
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-collections-1482179199088
+ * ```
+ *
  */
 export declare class ListCollectionsCommand extends $Command<ListCollectionsCommandInput, ListCollectionsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListCollectionsCommandInput;

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

@@ -34,6 +34,145 @@ export interface ListFacesCommandOutput extends ListFacesResponse, __MetadataBea
  * @see {@link ListFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To list the faces in a collection
+ * ```javascript
+ * // This operation lists the faces in a Rekognition collection.
+ * const input = {
+ *   "CollectionId": "myphotos",
+ *   "MaxResults": 20
+ * };
+ * const command = new ListFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Faces": [
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.18000000715255737,
+ *         "Left": 0.5555559992790222,
+ *         "Top": 0.336667001247406,
+ *         "Width": 0.23999999463558197
+ *       },
+ *       "Confidence": 100,
+ *       "FaceId": "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7",
+ *       "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.16555599868297577,
+ *         "Left": 0.30963000655174255,
+ *         "Top": 0.7066670060157776,
+ *         "Width": 0.22074100375175476
+ *       },
+ *       "Confidence": 100,
+ *       "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c",
+ *       "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.3234420120716095,
+ *         "Left": 0.3233329951763153,
+ *         "Top": 0.5,
+ *         "Width": 0.24222199618816376
+ *       },
+ *       "Confidence": 99.99829864501953,
+ *       "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85",
+ *       "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.03555560111999512,
+ *         "Left": 0.37388700246810913,
+ *         "Top": 0.2477779984474182,
+ *         "Width": 0.04747769981622696
+ *       },
+ *       "Confidence": 99.99210357666016,
+ *       "FaceId": "3b01bef0-c883-5654-ba42-d5ad28b720b3",
+ *       "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.05333330109715462,
+ *         "Left": 0.2937690019607544,
+ *         "Top": 0.35666701197624207,
+ *         "Width": 0.07121659815311432
+ *       },
+ *       "Confidence": 99.99919891357422,
+ *       "FaceId": "4839a608-49d0-566c-8301-509d71b534d1",
+ *       "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.3249259889125824,
+ *         "Left": 0.5155559778213501,
+ *         "Top": 0.1513350009918213,
+ *         "Width": 0.24333299696445465
+ *       },
+ *       "Confidence": 99.99949645996094,
+ *       "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14",
+ *       "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.03777780011296272,
+ *         "Left": 0.7002969980239868,
+ *         "Top": 0.18777799606323242,
+ *         "Width": 0.05044509842991829
+ *       },
+ *       "Confidence": 99.92639923095703,
+ *       "FaceId": "7f5f88ed-d684-5a88-b0df-01e4a521552b",
+ *       "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.05555560067296028,
+ *         "Left": 0.13946600258350372,
+ *         "Top": 0.46333301067352295,
+ *         "Width": 0.07270029932260513
+ *       },
+ *       "Confidence": 99.99469757080078,
+ *       "FaceId": "895b4e2c-81de-5902-a4bd-d1792bda00b2",
+ *       "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.3259260058403015,
+ *         "Left": 0.5144439935684204,
+ *         "Top": 0.15111100673675537,
+ *         "Width": 0.24444399774074554
+ *       },
+ *       "Confidence": 99.99949645996094,
+ *       "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
+ *       "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.18888899683952332,
+ *         "Left": 0.3783380091190338,
+ *         "Top": 0.2355560064315796,
+ *         "Width": 0.25222599506378174
+ *       },
+ *       "Confidence": 99.9999008178711,
+ *       "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5",
+ *       "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07"
+ *     },
+ *     {
+ *       "BoundingBox": {
+ *         "Height": 0.33481499552726746,
+ *         "Left": 0.31888899207115173,
+ *         "Top": 0.49333301186561584,
+ *         "Width": 0.25
+ *       },
+ *       "Confidence": 99.99909973144531,
+ *       "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b",
+ *       "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-faces-in-a-collection-1482181416530
+ * ```
+ *
  */
 export declare class ListFacesCommand extends $Command<ListFacesCommandInput, ListFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListFacesCommandInput;

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

@@ -30,6 +30,34 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
  * @see {@link ListProjectPoliciesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example ListProjectPolicies
+ * ```javascript
+ * // This operation lists the project policies that are attached to an Amazon Rekognition Custom Labels project.
+ * const input = {
+ *   "MaxResults": 5,
+ *   "NextToken": "",
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
+ * };
+ * const command = new ListProjectPoliciesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "",
+ *   "ProjectPolicies": [
+ *     {
+ *       "CreationTimestamp": "2022-07-01T11:51:27.086000-07:00",
+ *       "LastUpdatedTimestamp": "2022-07-01T11:51:27.086000-07:00",
+ *       "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Statemented1\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::111122223333:root\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"*\"}]}",
+ *       "PolicyName": "testPolicy",
+ *       "PolicyRevisionId": "3b274c25e9203a56a99e00e3ff205fbc",
+ *       "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: listprojectpolicies-1658202290173
+ * ```
+ *
  */
 export declare class ListProjectPoliciesCommand extends $Command<ListProjectPoliciesCommandInput, ListProjectPoliciesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListProjectPoliciesCommandInput;

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

@@ -41,6 +41,25 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
  * @see {@link PutProjectPolicyCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example PutProjectPolicy
+ * ```javascript
+ * // This operation attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account.
+ * const input = {
+ *   "PolicyDocument": "'{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"ALLOW\",\"Principal\":{\"AWS\":\"principal\"},\"Action\":\"rekognition:CopyProjectVersion\",\"Resource\":\"arn:aws:rekognition:us-east-1:123456789012:project/my-sdk-project/version/DestinationVersionName/1627045542080\"}]}'",
+ *   "PolicyName": "SamplePolicy",
+ *   "PolicyRevisionId": "0123456789abcdef",
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-sdk-project/1656557051929"
+ * };
+ * const command = new PutProjectPolicyCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "PolicyRevisionId": "0123456789abcdef"
+ * }
+ * *\/
+ * // example id: putprojectpolicy-1658201727623
+ * ```
+ *
  */
 export declare class PutProjectPolicyCommand extends $Command<PutProjectPolicyCommandInput, PutProjectPolicyCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: PutProjectPolicyCommandInput;

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

@@ -65,6 +65,52 @@ export interface SearchFacesByImageCommandOutput extends SearchFacesByImageRespo
  * @see {@link SearchFacesByImageCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To search for faces matching a supplied image
+ * ```javascript
+ * // This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.
+ * const input = {
+ *   "CollectionId": "myphotos",
+ *   "FaceMatchThreshold": 95,
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "mybucket",
+ *       "Name": "myphoto"
+ *     }
+ *   },
+ *   "MaxFaces": 5
+ * };
+ * const command = new SearchFacesByImageCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceMatches": [
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.3234420120716095,
+ *           "Left": 0.3233329951763153,
+ *           "Top": 0.5,
+ *           "Width": 0.24222199618816376
+ *         },
+ *         "Confidence": 99.99829864501953,
+ *         "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85",
+ *         "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5"
+ *       },
+ *       "Similarity": 99.97036743164062
+ *     }
+ *   ],
+ *   "SearchedFaceBoundingBox": {
+ *     "Height": 0.33481481671333313,
+ *     "Left": 0.31888890266418457,
+ *     "Top": 0.4933333396911621,
+ *     "Width": 0.25
+ *   },
+ *   "SearchedFaceConfidence": 99.9991226196289
+ * }
+ * *\/
+ * // example id: to-search-for-faces-matching-a-supplied-image-1482175994491
+ * ```
+ *
  */
 export declare class SearchFacesByImageCommand extends $Command<SearchFacesByImageCommandInput, SearchFacesByImageCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: SearchFacesByImageCommandInput;

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

@@ -44,6 +44,69 @@ export interface SearchFacesCommandOutput extends SearchFacesResponse, __Metadat
  * @see {@link SearchFacesCommandOutput} for command's `response` shape.
  * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
  *
+ * @example To delete a face
+ * ```javascript
+ * // This operation searches for matching faces in the collection the supplied face belongs to.
+ * const input = {
+ *   "CollectionId": "myphotos",
+ *   "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14",
+ *   "FaceMatchThreshold": 90,
+ *   "MaxFaces": 10
+ * };
+ * const command = new SearchFacesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "FaceMatches": [
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.3259260058403015,
+ *           "Left": 0.5144439935684204,
+ *           "Top": 0.15111100673675537,
+ *           "Width": 0.24444399774074554
+ *         },
+ *         "Confidence": 99.99949645996094,
+ *         "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2",
+ *         "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1"
+ *       },
+ *       "Similarity": 99.97222137451172
+ *     },
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.16555599868297577,
+ *           "Left": 0.30963000655174255,
+ *           "Top": 0.7066670060157776,
+ *           "Width": 0.22074100375175476
+ *         },
+ *         "Confidence": 100,
+ *         "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c",
+ *         "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e"
+ *       },
+ *       "Similarity": 97.04154968261719
+ *     },
+ *     {
+ *       "Face": {
+ *         "BoundingBox": {
+ *           "Height": 0.18888899683952332,
+ *           "Left": 0.3783380091190338,
+ *           "Top": 0.2355560064315796,
+ *           "Width": 0.25222599506378174
+ *         },
+ *         "Confidence": 99.9999008178711,
+ *         "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5",
+ *         "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07"
+ *       },
+ *       "Similarity": 95.94520568847656
+ *     }
+ *   ],
+ *   "SearchedFaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14"
+ * }
+ * *\/
+ * // example id: to-delete-a-face-1482182799377
+ * ```
+ *
  */
 export declare class SearchFacesCommand extends $Command<SearchFacesCommandInput, SearchFacesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: SearchFacesCommandInput;

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.287.0",
+  "version": "3.289.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,39 +20,39 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.287.0",
-    "@aws-sdk/config-resolver": "3.287.0",
-    "@aws-sdk/credential-provider-node": "3.287.0",
-    "@aws-sdk/fetch-http-handler": "3.282.0",
-    "@aws-sdk/hash-node": "3.272.0",
-    "@aws-sdk/invalid-dependency": "3.272.0",
-    "@aws-sdk/middleware-content-length": "3.282.0",
-    "@aws-sdk/middleware-endpoint": "3.282.0",
-    "@aws-sdk/middleware-host-header": "3.282.0",
-    "@aws-sdk/middleware-logger": "3.287.0",
-    "@aws-sdk/middleware-recursion-detection": "3.282.0",
-    "@aws-sdk/middleware-retry": "3.287.0",
-    "@aws-sdk/middleware-serde": "3.272.0",
-    "@aws-sdk/middleware-signing": "3.282.0",
-    "@aws-sdk/middleware-stack": "3.272.0",
-    "@aws-sdk/middleware-user-agent": "3.282.0",
-    "@aws-sdk/node-config-provider": "3.287.0",
-    "@aws-sdk/node-http-handler": "3.282.0",
-    "@aws-sdk/protocol-http": "3.282.0",
-    "@aws-sdk/smithy-client": "3.279.0",
-    "@aws-sdk/types": "3.272.0",
-    "@aws-sdk/url-parser": "3.272.0",
+    "@aws-sdk/client-sts": "3.289.0",
+    "@aws-sdk/config-resolver": "3.289.0",
+    "@aws-sdk/credential-provider-node": "3.289.0",
+    "@aws-sdk/fetch-http-handler": "3.289.0",
+    "@aws-sdk/hash-node": "3.289.0",
+    "@aws-sdk/invalid-dependency": "3.289.0",
+    "@aws-sdk/middleware-content-length": "3.289.0",
+    "@aws-sdk/middleware-endpoint": "3.289.0",
+    "@aws-sdk/middleware-host-header": "3.289.0",
+    "@aws-sdk/middleware-logger": "3.289.0",
+    "@aws-sdk/middleware-recursion-detection": "3.289.0",
+    "@aws-sdk/middleware-retry": "3.289.0",
+    "@aws-sdk/middleware-serde": "3.289.0",
+    "@aws-sdk/middleware-signing": "3.289.0",
+    "@aws-sdk/middleware-stack": "3.289.0",
+    "@aws-sdk/middleware-user-agent": "3.289.0",
+    "@aws-sdk/node-config-provider": "3.289.0",
+    "@aws-sdk/node-http-handler": "3.289.0",
+    "@aws-sdk/protocol-http": "3.289.0",
+    "@aws-sdk/smithy-client": "3.289.0",
+    "@aws-sdk/types": "3.289.0",
+    "@aws-sdk/url-parser": "3.289.0",
     "@aws-sdk/util-base64": "3.208.0",
     "@aws-sdk/util-body-length-browser": "3.188.0",
     "@aws-sdk/util-body-length-node": "3.208.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.279.0",
-    "@aws-sdk/util-defaults-mode-node": "3.287.0",
-    "@aws-sdk/util-endpoints": "3.272.0",
-    "@aws-sdk/util-retry": "3.272.0",
-    "@aws-sdk/util-user-agent-browser": "3.282.0",
-    "@aws-sdk/util-user-agent-node": "3.287.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.289.0",
+    "@aws-sdk/util-defaults-mode-node": "3.289.0",
+    "@aws-sdk/util-endpoints": "3.289.0",
+    "@aws-sdk/util-retry": "3.289.0",
+    "@aws-sdk/util-user-agent-browser": "3.289.0",
+    "@aws-sdk/util-user-agent-node": "3.289.0",
     "@aws-sdk/util-utf8": "3.254.0",
-    "@aws-sdk/util-waiter": "3.272.0",
+    "@aws-sdk/util-waiter": "3.289.0",
     "tslib": "^2.3.1"
   },
   "devDependencies": {