feat(client-rekognition): Adds support for defining an ordered preference list of different Rekognition Face Liveness challenge types when calling CreateFaceLivenessSession.

Author: awstools

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

@@ -30,8 +30,12 @@ export interface AssociateFacesCommandOutput extends AssociateFacesResponse, __M
 /**
  * <p>Associates one or more faces with an existing UserID. Takes an array of
  *         <code>FaceIds</code>. Each <code>FaceId</code> that are present in the <code>FaceIds</code>
- *       list is associated with the provided UserID. The maximum number of total <code>FaceIds</code>
- *       per UserID is 100. </p>
+ *       list is associated with the provided UserID. The number of FaceIds that can be used as input
+ *       in a single request is limited to 100.</p>
+ *          <p>Note that the total number of faces that can be associated with a single
+ *       <code>UserID</code> is also limited to 100. Once a <code>UserID</code> has 100 faces
+ *       associated with it, no additional faces can be added. If more API calls are made after the
+ *       limit is reached, a <code>ServiceQuotaExceededException</code> will result.</p>
  *          <p>The <code>UserMatchThreshold</code> parameter specifies the minimum user match confidence
  *       required for the face to be associated with a UserID that has at least one <code>FaceID</code>
  *       already associated. This ensures that the <code>FaceIds</code> are associated with the right

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

@@ -52,6 +52,15 @@ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivene
  *       S3KeyPrefix: "STRING_VALUE",
  *     },
  *     AuditImagesLimit: Number("int"),
+ *     ChallengePreferences: [ // ChallengePreferences
+ *       { // ChallengePreference
+ *         Type: "FaceMovementAndLightChallenge" || "FaceMovementChallenge", // required
+ *         Versions: { // Versions
+ *           Minimum: "STRING_VALUE",
+ *           Maximum: "STRING_VALUE",
+ *         },
+ *       },
+ *     ],
  *   },
  *   ClientRequestToken: "STRING_VALUE",
  * };

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

@@ -38,12 +38,10 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
  *          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>
  *          <p> For each object that the model version detects on an image, the API returns a
- *             (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>). Each
- *             <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
- *          of confidence that the image contains the object (<code>Confidence</code>), and object
- *          location information, if it exists, for the label on the image (<code>Geometry</code>).
- *          Note that for the <code>DetectCustomLabelsLabels</code> operation, <code>Polygons</code>
- *          are not returned in the <code>Geometry</code> section of the response.</p>
+ *          (<code>CustomLabel</code>) object in an array (<code>CustomLabels</code>).
+ *          Each <code>CustomLabel</code> object provides the label name (<code>Name</code>), the level
+ *          of confidence that the image contains the object (<code>Confidence</code>), and
+ *          object location information, if it exists,  for the label on the image (<code>Geometry</code>). </p>
  *          <p>To filter labels that are returned, specify a value for <code>MinConfidence</code>.
  *          <code>DetectCustomLabelsLabels</code> only returns labels with a confidence that's higher than
  *          the specified value.

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

@@ -91,6 +91,10 @@ export interface GetFaceLivenessSessionResultsCommandOutput
  * //       },
  * //     },
  * //   ],
+ * //   Challenge: { // Challenge
+ * //     Type: "FaceMovementAndLightChallenge" || "FaceMovementChallenge", // required
+ * //     Version: "STRING_VALUE", // required
+ * //   },
  * // };
  *
  * ```

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

@@ -28,7 +28,14 @@ export interface GetPersonTrackingCommandInput extends GetPersonTrackingRequest
 export interface GetPersonTrackingCommandOutput extends GetPersonTrackingResponse, __MetadataBearer {}
 
 /**
- * <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
+ * <note>
+ *             <p>
+ *                <i>End of support notice:</i> On October 31, 2025, AWS will discontinue
+ *          support for Amazon Rekognition People Pathing. After October 31, 2025, you will no
+ *          longer be able to use the Rekognition People Pathing capability. For more information,
+ *          visit this <a href="https://aws.amazon.com/blogs/machine-learning/transitioning-from-amazon-rekognition-people-pathing-exploring-other-alternatives/">blog post</a>.</p>
+ *          </note>
+ *          <p>Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>.</p>
  *          <p>The person path tracking operation is started by a call to <code>StartPersonTracking</code>
  *      which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to
  *      the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>.</p>

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

@@ -5,7 +5,7 @@ import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 
 import { commonParams } from "../endpoint/EndpointParameters";
-import { ListUsersRequest, ListUsersResponse } from "../models/models_0";
+import { ListUsersRequest, ListUsersResponse } from "../models/models_1";
 import { de_ListUsersCommand, se_ListUsersCommand } from "../protocols/Aws_json1_1";
 import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
 

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

@@ -28,7 +28,14 @@ export interface StartPersonTrackingCommandInput extends StartPersonTrackingRequ
 export interface StartPersonTrackingCommandOutput extends StartPersonTrackingResponse, __MetadataBearer {}
 
 /**
- * <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
+ * <note>
+ *             <p>
+ *                <i>End of support notice:</i> On October 31, 2025, AWS will discontinue
+ *          support for Amazon Rekognition People Pathing. After October 31, 2025, you will no
+ *          longer be able to use the Rekognition People Pathing capability. For more information,
+ *          visit this <a href="https://aws.amazon.com/blogs/machine-learning/transitioning-from-amazon-rekognition-people-pathing-exploring-other-alternatives/">blog post</a>.</p>
+ *          </note>
+ *          <p>Starts the asynchronous tracking of a person's path in a stored video.</p>
  *          <p>Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name
  *        and the filename of the video. <code>StartPersonTracking</code>
  *        returns a job identifier (<code>JobId</code>) which you use to get the results of the operation.

clients/client-rekognition/src/models/models_0.ts

@@ -844,11 +844,11 @@ export const EmotionName = {
 export type EmotionName = (typeof EmotionName)[keyof typeof EmotionName];
 
 /**
- * <p>The emotions that appear to be expressed on the face, and the confidence level in the
- *       determination. The API is only making a determination of the physical appearance of a person's
- *       face. It is not a determination of the person’s internal emotional state and should not be
- *       used in such a way. For example, a person pretending to have a sad face might not be sad
- *       emotionally.</p>
+ * <p>The API returns a prediction of an emotion based on a person's facial expressions, along with
+ *       the confidence level for the predicted emotion. It is not a determination of the person’s internal emotional
+ *       state and should not be used in such a way. For example, a person pretending to have a sad face might not
+ *       be sad emotionally. The API is not intended to be used, and you may not use it, in a manner that violates
+ *       the EU Artificial Intelligence Act or any other applicable law.</p>
  * @public
  */
 export interface Emotion {
@@ -1555,6 +1555,74 @@ export const CelebrityRecognitionSortBy = {
  */
 export type CelebrityRecognitionSortBy = (typeof CelebrityRecognitionSortBy)[keyof typeof CelebrityRecognitionSortBy];
 
+/**
+ * @public
+ * @enum
+ */
+export const ChallengeType = {
+  FACE_MOVEMENT_AND_LIGHT_CHALLENGE: "FaceMovementAndLightChallenge",
+  FACE_MOVEMENT_CHALLENGE: "FaceMovementChallenge",
+} as const;
+
+/**
+ * @public
+ */
+export type ChallengeType = (typeof ChallengeType)[keyof typeof ChallengeType];
+
+/**
+ * <p>Describes the type and version of the challenge being used for the Face Liveness session.</p>
+ * @public
+ */
+export interface Challenge {
+  /**
+   * <p>The type of the challenge being used for the Face Liveness session.</p>
+   * @public
+   */
+  Type: ChallengeType | undefined;
+
+  /**
+   * <p>The version of the challenge being used for the Face Liveness session.</p>
+   * @public
+   */
+  Version: string | undefined;
+}
+
+/**
+ * <p>Object specifying the acceptable range of challenge versions.</p>
+ * @public
+ */
+export interface Versions {
+  /**
+   * <p>The desired minimum version for the challenge.</p>
+   * @public
+   */
+  Minimum?: string | undefined;
+
+  /**
+   * <p>The desired maximum version for the challenge.</p>
+   * @public
+   */
+  Maximum?: string | undefined;
+}
+
+/**
+ * <p>An ordered list of preferred challenge type and versions.</p>
+ * @public
+ */
+export interface ChallengePreference {
+  /**
+   * <p>The types of challenges that have been selected for the Face Liveness session.</p>
+   * @public
+   */
+  Type: ChallengeType | undefined;
+
+  /**
+   * <p>The version of the challenges that have been selected for the Face Liveness session.</p>
+   * @public
+   */
+  Versions?: Versions | undefined;
+}
+
 /**
  * <p>Type that describes the face Amazon Rekognition chose to compare with the faces in the target.
  *       This contains a bounding box for the selected face and confidence level that the bounding box
@@ -2436,6 +2504,12 @@ export interface CreateFaceLivenessSessionRequestSettings {
    * @public
    */
   AuditImagesLimit?: number | undefined;
+
+  /**
+   * <p>Indicates preferred challenge types and versions for the Face Liveness session to be created.</p>
+   * @public
+   */
+  ChallengePreferences?: ChallengePreference[] | undefined;
 }
 
 /**
@@ -6191,6 +6265,12 @@ export interface GetFaceLivenessSessionResultsResponse {
    * @public
    */
   AuditImages?: AuditImage[] | undefined;
+
+  /**
+   * <p>Contains information regarding the challenge type used for the Face Liveness check.</p>
+   * @public
+   */
+  Challenge?: Challenge | undefined;
 }
 
 /**
@@ -8162,97 +8242,6 @@ export interface ListTagsForResourceResponse {
   Tags?: Record<string, string> | undefined;
 }
 
-/**
- * @public
- */
-export interface ListUsersRequest {
-  /**
-   * <p>The ID of an existing collection.</p>
-   * @public
-   */
-  CollectionId: string | undefined;
-
-  /**
-   * <p>Maximum number of UsersID to return. </p>
-   * @public
-   */
-  MaxResults?: number | undefined;
-
-  /**
-   * <p>Pagingation token to receive the next set of UsersID.</p>
-   * @public
-   */
-  NextToken?: string | undefined;
-}
-
-/**
- * <p>Metadata of the user stored in a collection.</p>
- * @public
- */
-export interface User {
-  /**
-   * <p> A provided ID for the User. Unique within the collection.</p>
-   * @public
-   */
-  UserId?: string | undefined;
-
-  /**
-   * <p> Communicates if the UserID has been updated with latest set of faces to be associated
-   *       with the UserID. </p>
-   * @public
-   */
-  UserStatus?: UserStatus | undefined;
-}
-
-/**
- * @public
- */
-export interface ListUsersResponse {
-  /**
-   * <p>List of UsersID associated with the specified collection.</p>
-   * @public
-   */
-  Users?: User[] | undefined;
-
-  /**
-   * <p>A pagination token to be used with the subsequent request if the response is
-   *       truncated.</p>
-   * @public
-   */
-  NextToken?: string | undefined;
-}
-
-/**
- * <p>The format of the project policy document that you supplied to
- *       <code>PutProjectPolicy</code> is incorrect. </p>
- * @public
- */
-export class MalformedPolicyDocumentException extends __BaseException {
-  readonly name: "MalformedPolicyDocumentException" = "MalformedPolicyDocumentException";
-  readonly $fault: "client" = "client";
-  Message?: string | undefined;
-  Code?: string | undefined;
-  /**
-   * <p>A universally unique identifier (UUID) for the request.</p>
-   * @public
-   */
-  Logref?: string | undefined;
-  /**
-   * @internal
-   */
-  constructor(opts: __ExceptionOptionType<MalformedPolicyDocumentException, __BaseException>) {
-    super({
-      name: "MalformedPolicyDocumentException",
-      $fault: "client",
-      ...opts,
-    });
-    Object.setPrototypeOf(this, MalformedPolicyDocumentException.prototype);
-    this.Message = opts.Message;
-    this.Code = opts.Code;
-    this.Logref = opts.Logref;
-  }
-}
-
 /**
  * @internal
  */