feat(client-rekognition): Adding support for ImageProperties feature to detect dominant colors and image brightness, sharpness, and contrast, inclusion and exclusion filters for labels and label categories, new fields to the API response, "aliases" and "categories"

Author: awstools

clients/client-rekognition/README.md

@@ -9,17 +9,13 @@
 
 AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native.
 
-<p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
-<a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
-<a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored Video</a>,
-<a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>.
-It provides descriptions of actions, data types, common parameters,
-and common errors.</p>
-
+<p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
+<a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
+Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
+parameters, and common errors.</p>
 <p>
 <b>Amazon Rekognition Image</b>
 </p>
-
 <ul>
 <li>
 <p>
@@ -107,7 +103,6 @@ and common errors.</p>
 </p>
 </li>
 </ul>
-
 <p>
 <b>Amazon Rekognition Custom Labels</b>
 </p>
@@ -213,11 +208,9 @@ and common errors.</p>
 </p>
 </li>
 </ul>
-
 <p>
 <b>Amazon Rekognition Video Stored Video</b>
 </p>
-
 <ul>
 <li>
 <p>
@@ -300,11 +293,9 @@ and common errors.</p>
 </p>
 </li>
 </ul>
-
 <p>
 <b>Amazon Rekognition Video Streaming Video</b>
 </p>
-
 <ul>
 <li>
 <p>

clients/client-rekognition/src/Rekognition.ts

@@ -479,19 +479,13 @@ type RekognitionClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpH
 export interface RekognitionClientResolvedConfig extends RekognitionClientResolvedConfigType {}
 
 /**
- * <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>,
- *       <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
- *       <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored Video</a>,
- *       <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>.
- *       It provides descriptions of actions, data types, common parameters,
- *       and common errors.</p>
- *
+ * <p>This is the API Reference for <a href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon Rekognition Image</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html">Amazon Rekognition Custom Labels</a>,
+ *         <a href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon Rekognition Stored
+ *         Video</a>, <a href="https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html">Amazon Rekognition Streaming Video</a>. It provides descriptions of actions, data types, common
+ *       parameters, and common errors.</p>
  *          <p>
  *             <b>Amazon Rekognition Image</b>
  *          </p>
- *
- *
- *
  *          <ul>
  *             <li>
  *                <p>
@@ -579,8 +573,6 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
  *                </p>
  *             </li>
  *          </ul>
- *
- *
  *          <p>
  *             <b>Amazon Rekognition Custom Labels</b>
  *          </p>
@@ -686,12 +678,9 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
  *                </p>
  *             </li>
  *          </ul>
- *
- *
  *          <p>
  *             <b>Amazon Rekognition Video Stored Video</b>
  *          </p>
- *
  *          <ul>
  *             <li>
  *                <p>
@@ -774,11 +763,9 @@ export interface RekognitionClientResolvedConfig extends RekognitionClientResolv
  *                </p>
  *             </li>
  *          </ul>
- *
  *          <p>
  *             <b>Amazon Rekognition Video Streaming Video</b>
  *          </p>
- *
  *          <ul>
  *             <li>
  *                <p>

clients/client-rekognition/src/RekognitionClient.ts

@@ -29,26 +29,19 @@ export interface CompareFacesCommandInput extends CompareFacesRequest {}
 export interface CompareFacesCommandOutput extends CompareFacesResponse, __MetadataBearer {}
 
 /**
- * <p>Compares a face in the <i>source</i> input image with
- *       each of the 100 largest faces detected in the <i>target</i> input image.
- *     </p>
- *
- *          <p> If the source image contains multiple faces, the service detects the largest face
- *         and compares it with each face detected in the target image. </p>
- *
- *
+ * <p>Compares a face in the <i>source</i> input image with each of the 100
+ *       largest faces detected in the <i>target</i> input image. </p>
+ *          <p> If the source image contains multiple faces, the service detects the largest face and
+ *       compares it with each face detected in the target image. </p>
  *          <note>
- *             <p>CompareFaces uses machine learning algorithms, which are probabilistic.
- *       A false negative is an incorrect prediction that
- *       a face in the target image has a low similarity confidence score when compared to the face
- *       in the source image. To reduce the probability of false negatives,
- *       we recommend that you compare the target image against multiple source images.
- *       If you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's rights,
- *       privacy, or access to services, we recommend that you pass the result to a human for review and further
- *       validation before taking action.</p>
+ *             <p>CompareFaces uses machine learning algorithms, which are probabilistic. A false negative
+ *         is an incorrect prediction that a face in the target image has a low similarity confidence
+ *         score when compared to the face in the source image. To reduce the probability of false
+ *         negatives, we recommend that you compare the target image against multiple source images. If
+ *         you plan to use <code>CompareFaces</code> to make a decision that impacts an individual's
+ *         rights, privacy, or access to services, we recommend that you pass the result to a human for
+ *         review and further validation before taking action.</p>
  *          </note>
- *
- *
  *          <p>You pass the input and target images either as base64-encoded image bytes or as
  *       references to images in an Amazon S3 bucket. If you use the
  *       AWS
@@ -59,39 +52,35 @@ export interface CompareFacesCommandOutput extends CompareFacesResponse, __Metad
  *       facial landmarks, pose details (pitch, roll, and yaw), quality (brightness and sharpness), and
  *       confidence value (indicating the level of confidence that the bounding box contains a face).
  *       The response also provides a similarity score, which indicates how closely the faces match. </p>
- *
  *          <note>
  *             <p>By default, only faces with a similarity score of greater than or equal to 80% are
  *         returned in the response. You can change this value by specifying the
  *           <code>SimilarityThreshold</code> parameter.</p>
  *          </note>
- *
  *          <p>
- *             <code>CompareFaces</code> also returns an array of faces that don't match the source image.
- *       For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality.
- *     The response also returns information about the face in the source image, including the bounding box
- *       of the face and confidence value.</p>
- *
+ *             <code>CompareFaces</code> also returns an array of faces that don't match the source
+ *       image. For each face, it returns a bounding box, confidence value, landmarks, pose details,
+ *       and quality. The response also returns information about the face in the source image,
+ *       including the bounding box of the face and confidence value.</p>
  *          <p>The <code>QualityFilter</code> input parameter allows you to filter out detected faces
- *       that don’t meet a required quality bar. The quality bar is based on a
- *       variety of common use cases.  Use <code>QualityFilter</code> to set the quality bar
- *       by specifying <code>LOW</code>, <code>MEDIUM</code>, or <code>HIGH</code>.
- *       If you do not want to filter detected faces, specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
- *
- *          <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the
- *         source and target images. Use these values to display the images with the correct image orientation.</p>
- *          <p>If no faces are detected in the source or target images, <code>CompareFaces</code> returns an
- *     <code>InvalidParameterException</code> error. </p>
- *
- *
+ *       that don’t meet a required quality bar. The quality bar is based on a variety of common use
+ *       cases. Use <code>QualityFilter</code> to set the quality bar by specifying <code>LOW</code>,
+ *         <code>MEDIUM</code>, or <code>HIGH</code>. If you do not want to filter detected faces,
+ *       specify <code>NONE</code>. The default value is <code>NONE</code>. </p>
+ *          <p>If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns
+ *       orientation information for the source and target images. Use these values to display the
+ *       images with the correct image orientation.</p>
+ *          <p>If no faces are detected in the source or target images, <code>CompareFaces</code>
+ *       returns an <code>InvalidParameterException</code> error. </p>
  *          <note>
- *             <p> This is a stateless API operation. That is, data returned by this operation doesn't persist.</p>
+ *             <p> This is a stateless API operation. That is, data returned by this operation doesn't
+ *         persist.</p>
  *          </note>
  *
- *
- *          <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.</p>
- *          <p>This operation requires permissions to perform the <code>rekognition:CompareFaces</code>
- *       action.</p>
+ *          <p>For an example, see Comparing Faces in Images in the Amazon Rekognition Developer
+ *       Guide.</p>
+ *          <p>This operation requires permissions to perform the
+ *         <code>rekognition:CompareFaces</code> action.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rekognition/src/commands/CompareFacesCommand.ts

@@ -35,13 +35,15 @@ export interface CreateCollectionCommandOutput extends CreateCollectionResponse,
  *       user can then index faces using the <code>IndexFaces</code> operation and persist results in a
  *       specific collection. Then, a user can search the collection for faces in the user-specific
  *       container. </p>
- *          <p>When you create a collection, it is associated with the latest version of the face model version.</p>
+ *          <p>When you create a collection, it is associated with the latest version of the face model
+ *       version.</p>
  *          <note>
  *             <p>Collection names are case-sensitive.</p>
  *          </note>
- *
  *          <p>This operation requires permissions to perform the
- *       <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you also require permission to perform the <code>rekognition:TagResource</code> operation.</p>
+ *         <code>rekognition:CreateCollection</code> action. If you want to tag your collection, you
+ *       also require permission to perform the <code>rekognition:TagResource</code>
+ *       operation.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-rekognition/src/commands/CreateCollectionCommand.ts

@@ -29,9 +29,9 @@ export interface DeleteCollectionCommandInput extends DeleteCollectionRequest {}
 export interface DeleteCollectionCommandOutput extends DeleteCollectionResponse, __MetadataBearer {}
 
 /**
- * <p>Deletes the specified collection. Note that this operation
- *       removes all faces in the collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a collection</a>.</p>
- *
+ * <p>Deletes the specified collection. Note that this operation removes all faces in the
+ *       collection. For an example, see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html">Deleting a
+ *       collection</a>.</p>
  *          <p>This operation requires permissions to perform the
  *         <code>rekognition:DeleteCollection</code> action.</p>
  * @example

clients/client-rekognition/src/commands/DeleteCollectionCommand.ts

@@ -30,28 +30,24 @@ export interface DetectFacesCommandOutput extends DetectFacesResponse, __Metadat
 
 /**
  * <p>Detects faces within an image that is provided as input.</p>
- *
  *          <p>
  *             <code>DetectFaces</code> detects the 100 largest faces in the image. For each face
  *       detected, the operation returns face details. These details include a bounding box of the
  *       face, a confidence value (that the bounding box contains a face), and a fixed set of
- *       attributes such as facial landmarks (for example, coordinates of eye and mouth),
- *       presence of beard, sunglasses, and so on. </p>
+ *       attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of
+ *       beard, sunglasses, and so on. </p>
  *          <p>The face-detection algorithm is most effective on frontal faces. For non-frontal or
  *       obscured faces, the algorithm might not detect the faces or might detect faces with lower
  *       confidence. </p>
  *          <p>You pass the input image either as base64-encoded image bytes or as a reference to an
- *       image in an Amazon S3 bucket. If you use the AWS CLI
- *        to call Amazon Rekognition operations, passing image bytes is not
- *       supported. The image must be either a PNG or JPEG formatted file. </p>
- *
+ *       image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,
+ *       passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </p>
  *          <note>
  *             <p>This is a stateless API operation. That is, the operation does not persist any
  *         data.</p>
  *          </note>
- *
- *          <p>This operation requires permissions to perform the
- *       <code>rekognition:DetectFaces</code> action. </p>
+ *          <p>This operation requires permissions to perform the <code>rekognition:DetectFaces</code>
+ *       action. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript