@aws-sdk/client-rekognition 3.427.0 → 3.429.0

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,128 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { BlackFrame, ConnectedHomeSettingsForUpdate, DatasetChanges, DetectionFilter, FaceAttributes, KinesisVideoStreamStartSelector, LabelDetectionFeatureName, LabelDetectionSettings, NotificationChannel, ProjectVersionStatus, RegionOfInterest, SegmentType, StreamProcessorDataSharingPreference, Video } from "./models_0";
+import { BlackFrame, ConnectedHomeSettingsForUpdate, DatasetChanges, DetectionFilter, FaceAttributes, FaceDetail, KinesisVideoStreamStartSelector, LabelDetectionFeatureName, LabelDetectionSettings, NotificationChannel, ProjectVersionStatus, RegionOfInterest, SearchedFaceDetails, SegmentType, StreamProcessorDataSharingPreference, UserMatch, Video } from "./models_0";
 import { RekognitionServiceException as __BaseException } from "./RekognitionServiceException";
+/**
+ * @public
+ * @enum
+ */
+export declare const UnsearchedFaceReason: {
+    readonly EXCEEDS_MAX_FACES: "EXCEEDS_MAX_FACES";
+    readonly EXTREME_POSE: "EXTREME_POSE";
+    readonly FACE_NOT_LARGEST: "FACE_NOT_LARGEST";
+    readonly LOW_BRIGHTNESS: "LOW_BRIGHTNESS";
+    readonly LOW_CONFIDENCE: "LOW_CONFIDENCE";
+    readonly LOW_FACE_QUALITY: "LOW_FACE_QUALITY";
+    readonly LOW_SHARPNESS: "LOW_SHARPNESS";
+    readonly SMALL_BOUNDING_BOX: "SMALL_BOUNDING_BOX";
+};
+/**
+ * @public
+ */
+export type UnsearchedFaceReason = (typeof UnsearchedFaceReason)[keyof typeof UnsearchedFaceReason];
+/**
+ * @public
+ * <p>Face details inferred from the image but not used for search. The response attribute
+ *       contains reasons for why a face wasn't used for Search. </p>
+ */
+export interface UnsearchedFace {
+    /**
+     * @public
+     * <p>Structure containing attributes of the face that the algorithm detected.</p>
+     *          <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
+     *       facial attributes. The default attributes are <code>BoundingBox</code>,
+     *         <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
+     *       <code>Quality</code>.</p>
+     *          <p>
+     *             <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
+     *       return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
+     *       return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
+     *       attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
+     *       parameter:</p>
+     *          <ul>
+     *             <li>
+     *                <p>GetCelebrityRecognition</p>
+     *             </li>
+     *             <li>
+     *                <p>GetPersonTracking</p>
+     *             </li>
+     *             <li>
+     *                <p>GetFaceSearch</p>
+     *             </li>
+     *          </ul>
+     *          <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
+     *       can return all facial attributes. To specify which attributes to return, use the
+     *         <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
+     *         <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
+     */
+    FaceDetails?: FaceDetail;
+    /**
+     * @public
+     * <p> Reasons why a face wasn't used for Search. </p>
+     */
+    Reasons?: UnsearchedFaceReason[];
+}
+/**
+ * @public
+ */
+export interface SearchUsersByImageResponse {
+    /**
+     * @public
+     * <p>An array of UserID objects that matched the input face, along with the confidence in the
+     *       match. The returned structure will be empty if there are no matches. Returned if the
+     *       SearchUsersByImageResponse action is successful.</p>
+     */
+    UserMatches?: UserMatch[];
+    /**
+     * @public
+     * <p>Version number of the face detection model associated with the input collection
+     *       CollectionId.</p>
+     */
+    FaceModelVersion?: string;
+    /**
+     * @public
+     * <p>A list of FaceDetail objects containing the BoundingBox for the largest face in image, as
+     *       well as the confidence in the bounding box, that was searched for matches. If no valid face is
+     *       detected in the image the response will contain no SearchedFace object.</p>
+     */
+    SearchedFace?: SearchedFaceDetails;
+    /**
+     * @public
+     * <p>List of UnsearchedFace objects. Contains the face details infered from the specified image
+     *       but not used for search. Contains reasons that describe why a face wasn't used for Search.
+     *     </p>
+     */
+    UnsearchedFaces?: UnsearchedFace[];
+}
+/**
+ * @public
+ */
+export interface StartCelebrityRecognitionRequest {
+    /**
+     * @public
+     * <p>The video in which you want to recognize celebrities. The video must be stored
+     *       in an Amazon S3 bucket.</p>
+     */
+    Video: Video | undefined;
+    /**
+     * @public
+     * <p>Idempotent token used to identify the start request. If you use the same token with multiple
+     *     <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use
+     *       <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>
+     */
+    ClientRequestToken?: string;
+    /**
+     * @public
+     * <p>The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the
+     *       celebrity recognition analysis to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>
+     */
+    NotificationChannel?: NotificationChannel;
+    /**
+     * @public
+     * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
+     *       For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>
+     */
+    JobTag?: string;
+}
 /**
  * @public
  */
@@ -113,7 +235,7 @@ export interface StartFaceDetectionRequest {
      *          <p>
      *             <code>ALL</code> - All facial attributes are returned.</p>
      */
-    FaceAttributes?: FaceAttributes | string;
+    FaceAttributes?: FaceAttributes;
     /**
      * @public
      * <p>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
@@ -225,7 +347,7 @@ export interface StartLabelDetectionRequest {
      * @public
      * <p>The features to return after video analysis. You can specify that GENERAL_LABELS are returned.</p>
      */
-    Features?: (LabelDetectionFeatureName | string)[];
+    Features?: LabelDetectionFeatureName[];
     /**
      * @public
      * <p>The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation.
@@ -298,11 +420,6 @@ export interface StartProjectVersionRequest {
      * @public
      * <p>The minimum number of inference units to use. A single
      *       inference unit represents 1 hour of processing. </p>
-     *          <p>For information about the number
-     *             of transactions per second (TPS) that an inference unit can support, see
-     *             <i>Running a trained Amazon Rekognition Custom Labels model</i> in the
-     *             Amazon Rekognition Custom Labels Guide.
-     *          </p>
      *          <p>Use a higher number to increase the TPS throughput of your model. You are charged for the number
      *       of inference units that you use.
      *     </p>
@@ -323,7 +440,7 @@ export interface StartProjectVersionResponse {
      * @public
      * <p>The current running status of the model. </p>
      */
-    Status?: ProjectVersionStatus | string;
+    Status?: ProjectVersionStatus;
 }
 /**
  * @public
@@ -423,7 +540,7 @@ export interface StartSegmentDetectionRequest {
      * @public
      * <p>An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.</p>
      */
-    SegmentTypes: (SegmentType | string)[] | undefined;
+    SegmentTypes: SegmentType[] | undefined;
 }
 /**
  * @public
@@ -578,7 +695,7 @@ export interface StartTextDetectionResponse {
 export interface StopProjectVersionRequest {
     /**
      * @public
-     * <p>The Amazon Resource Name (ARN) of the model version that you want to delete.</p>
+     * <p>The Amazon Resource Name (ARN) of the model version that you want to stop.</p>
      *          <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
      */
     ProjectVersionArn: string | undefined;
@@ -591,7 +708,7 @@ export interface StopProjectVersionResponse {
      * @public
      * <p>The current status of the stop operation. </p>
      */
-    Status?: ProjectVersionStatus | string;
+    Status?: ProjectVersionStatus;
 }
 /**
  * @public
@@ -740,7 +857,7 @@ export interface UpdateStreamProcessorRequest {
      *             A list of parameters you want to delete from the stream processor.
      *         </p>
      */
-    ParametersToDelete?: (StreamProcessorParameterToDelete | string)[];
+    ParametersToDelete?: StreamProcessorParameterToDelete[];
 }
 /**
  * @public

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

@@ -6,10 +6,8 @@ import {
   MetadataBearer as __MetadataBearer,
   MiddlewareStack,
 } from "@smithy/types";
-import {
-  SearchUsersByImageRequest,
-  SearchUsersByImageResponse,
-} from "../models/models_0";
+import { SearchUsersByImageRequest } from "../models/models_0";
+import { SearchUsersByImageResponse } from "../models/models_1";
 import {
   RekognitionClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts

@@ -6,8 +6,10 @@ import {
   MetadataBearer as __MetadataBearer,
   MiddlewareStack,
 } from "@smithy/types";
-import { StartCelebrityRecognitionRequest } from "../models/models_0";
-import { StartCelebrityRecognitionResponse } from "../models/models_1";
+import {
+  StartCelebrityRecognitionRequest,
+  StartCelebrityRecognitionResponse,
+} from "../models/models_1";
 import {
   RekognitionClientResolvedConfig,
   ServiceInputTypes,