@aws-sdk/client-rekognition 3.425.0 → 3.428.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 | string)[];
+}
+/**
+ * @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
  */
@@ -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>
@@ -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;

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,

package/dist-types/ts3.4/models/models_0.d.ts

@@ -586,12 +586,32 @@ export interface CreateFaceLivenessSessionRequest {
 export interface CreateFaceLivenessSessionResponse {
   SessionId: string | undefined;
 }
+export declare const ProjectAutoUpdate: {
+  readonly DISABLED: "DISABLED";
+  readonly ENABLED: "ENABLED";
+};
+export type ProjectAutoUpdate =
+  (typeof ProjectAutoUpdate)[keyof typeof ProjectAutoUpdate];
+export declare const CustomizationFeature: {
+  readonly CONTENT_MODERATION: "CONTENT_MODERATION";
+  readonly CUSTOM_LABELS: "CUSTOM_LABELS";
+};
+export type CustomizationFeature =
+  (typeof CustomizationFeature)[keyof typeof CustomizationFeature];
 export interface CreateProjectRequest {
   ProjectName: string | undefined;
+  Feature?: CustomizationFeature | string;
+  AutoUpdate?: ProjectAutoUpdate | string;
 }
 export interface CreateProjectResponse {
   ProjectArn?: string;
 }
+export interface CustomizationFeatureContentModerationConfig {
+  ConfidenceThreshold?: number;
+}
+export interface CustomizationFeatureConfig {
+  ContentModeration?: CustomizationFeatureContentModerationConfig;
+}
 export interface TestingData {
   Assets?: Asset[];
   AutoCreate?: boolean;
@@ -607,6 +627,8 @@ export interface CreateProjectVersionRequest {
   TestingData?: TestingData;
   Tags?: Record<string, string>;
   KmsKeyId?: string;
+  VersionDescription?: string;
+  FeatureConfig?: CustomizationFeatureConfig;
 }
 export interface CreateProjectVersionResponse {
   ProjectVersionArn?: string;
@@ -798,6 +820,8 @@ export declare const ProjectVersionStatus: {
   readonly COPYING_FAILED: "COPYING_FAILED";
   readonly COPYING_IN_PROGRESS: "COPYING_IN_PROGRESS";
   readonly DELETING: "DELETING";
+  readonly DEPRECATED: "DEPRECATED";
+  readonly EXPIRED: "EXPIRED";
   readonly FAILED: "FAILED";
   readonly RUNNING: "RUNNING";
   readonly STARTING: "STARTING";
@@ -842,12 +866,15 @@ export interface DescribeProjectsRequest {
   NextToken?: string;
   MaxResults?: number;
   ProjectNames?: string[];
+  Features?: (CustomizationFeature | string)[];
 }
 export interface ProjectDescription {
   ProjectArn?: string;
   CreationTimestamp?: Date;
   Status?: ProjectStatus | string;
   Datasets?: DatasetMetadata[];
+  Feature?: CustomizationFeature | string;
+  AutoUpdate?: ProjectAutoUpdate | string;
 }
 export interface DescribeProjectsResponse {
   ProjectDescriptions?: ProjectDescription[];
@@ -908,6 +935,10 @@ export interface ProjectVersionDescription {
   KmsKeyId?: string;
   MaxInferenceUnits?: number;
   SourceProjectVersionArn?: string;
+  VersionDescription?: string;
+  Feature?: CustomizationFeature | string;
+  BaseModelVersion?: string;
+  FeatureConfig?: CustomizationFeatureConfig;
 }
 export interface DescribeProjectVersionsResponse {
   ProjectVersionDescriptions?: ProjectVersionDescription[];
@@ -1068,6 +1099,7 @@ export interface DetectModerationLabelsRequest {
   Image: Image | undefined;
   MinConfidence?: number;
   HumanLoopConfig?: HumanLoopConfig;
+  ProjectVersion?: string;
 }
 export interface HumanLoopActivationOutput {
   HumanLoopArn?: string;
@@ -1078,6 +1110,7 @@ export interface DetectModerationLabelsResponse {
   ModerationLabels?: ModerationLabel[];
   ModerationModelVersion?: string;
   HumanLoopActivationOutput?: HumanLoopActivationOutput;
+  ProjectVersion?: string;
 }
 export declare class HumanLoopQuotaExceededException extends __BaseException {
   readonly name: "HumanLoopQuotaExceededException";
@@ -1724,34 +1757,6 @@ export interface SearchUsersByImageRequest {
 export interface SearchedFaceDetails {
   FaceDetail?: FaceDetail;
 }
-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";
-};
-export type UnsearchedFaceReason =
-  (typeof UnsearchedFaceReason)[keyof typeof UnsearchedFaceReason];
-export interface UnsearchedFace {
-  FaceDetails?: FaceDetail;
-  Reasons?: (UnsearchedFaceReason | string)[];
-}
-export interface SearchUsersByImageResponse {
-  UserMatches?: UserMatch[];
-  FaceModelVersion?: string;
-  SearchedFace?: SearchedFaceDetails;
-  UnsearchedFaces?: UnsearchedFace[];
-}
-export interface StartCelebrityRecognitionRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-}
 export declare const AuditImageFilterSensitiveLog: (obj: AuditImage) => any;
 export declare const GetFaceLivenessSessionResultsResponseFilterSensitiveLog: (
   obj: GetFaceLivenessSessionResultsResponse

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

@@ -5,17 +5,48 @@ import {
   DatasetChanges,
   DetectionFilter,
   FaceAttributes,
+  FaceDetail,
   KinesisVideoStreamStartSelector,
   LabelDetectionFeatureName,
   LabelDetectionSettings,
   NotificationChannel,
   ProjectVersionStatus,
   RegionOfInterest,
+  SearchedFaceDetails,
   SegmentType,
   StreamProcessorDataSharingPreference,
+  UserMatch,
   Video,
 } from "./models_0";
 import { RekognitionServiceException as __BaseException } from "./RekognitionServiceException";
+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";
+};
+export type UnsearchedFaceReason =
+  (typeof UnsearchedFaceReason)[keyof typeof UnsearchedFaceReason];
+export interface UnsearchedFace {
+  FaceDetails?: FaceDetail;
+  Reasons?: (UnsearchedFaceReason | string)[];
+}
+export interface SearchUsersByImageResponse {
+  UserMatches?: UserMatch[];
+  FaceModelVersion?: string;
+  SearchedFace?: SearchedFaceDetails;
+  UnsearchedFaces?: UnsearchedFace[];
+}
+export interface StartCelebrityRecognitionRequest {
+  Video: Video | undefined;
+  ClientRequestToken?: string;
+  NotificationChannel?: NotificationChannel;
+  JobTag?: string;
+}
 export interface StartCelebrityRecognitionResponse {
   JobId?: string;
 }

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.425.0",
+  "version": "3.428.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,41 +21,41 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.425.0",
-    "@aws-sdk/credential-provider-node": "3.425.0",
-    "@aws-sdk/middleware-host-header": "3.425.0",
-    "@aws-sdk/middleware-logger": "3.425.0",
-    "@aws-sdk/middleware-recursion-detection": "3.425.0",
-    "@aws-sdk/middleware-signing": "3.425.0",
-    "@aws-sdk/middleware-user-agent": "3.425.0",
-    "@aws-sdk/region-config-resolver": "3.425.0",
-    "@aws-sdk/types": "3.425.0",
-    "@aws-sdk/util-endpoints": "3.425.0",
-    "@aws-sdk/util-user-agent-browser": "3.425.0",
-    "@aws-sdk/util-user-agent-node": "3.425.0",
-    "@smithy/config-resolver": "^2.0.11",
-    "@smithy/fetch-http-handler": "^2.2.1",
-    "@smithy/hash-node": "^2.0.10",
-    "@smithy/invalid-dependency": "^2.0.10",
-    "@smithy/middleware-content-length": "^2.0.12",
-    "@smithy/middleware-endpoint": "^2.0.10",
-    "@smithy/middleware-retry": "^2.0.13",
-    "@smithy/middleware-serde": "^2.0.10",
-    "@smithy/middleware-stack": "^2.0.4",
-    "@smithy/node-config-provider": "^2.0.13",
-    "@smithy/node-http-handler": "^2.1.6",
-    "@smithy/protocol-http": "^3.0.6",
-    "@smithy/smithy-client": "^2.1.9",
-    "@smithy/types": "^2.3.4",
-    "@smithy/url-parser": "^2.0.10",
+    "@aws-sdk/client-sts": "3.428.0",
+    "@aws-sdk/credential-provider-node": "3.428.0",
+    "@aws-sdk/middleware-host-header": "3.428.0",
+    "@aws-sdk/middleware-logger": "3.428.0",
+    "@aws-sdk/middleware-recursion-detection": "3.428.0",
+    "@aws-sdk/middleware-signing": "3.428.0",
+    "@aws-sdk/middleware-user-agent": "3.428.0",
+    "@aws-sdk/region-config-resolver": "3.428.0",
+    "@aws-sdk/types": "3.428.0",
+    "@aws-sdk/util-endpoints": "3.428.0",
+    "@aws-sdk/util-user-agent-browser": "3.428.0",
+    "@aws-sdk/util-user-agent-node": "3.428.0",
+    "@smithy/config-resolver": "^2.0.14",
+    "@smithy/fetch-http-handler": "^2.2.3",
+    "@smithy/hash-node": "^2.0.11",
+    "@smithy/invalid-dependency": "^2.0.11",
+    "@smithy/middleware-content-length": "^2.0.13",
+    "@smithy/middleware-endpoint": "^2.1.0",
+    "@smithy/middleware-retry": "^2.0.16",
+    "@smithy/middleware-serde": "^2.0.11",
+    "@smithy/middleware-stack": "^2.0.5",
+    "@smithy/node-config-provider": "^2.1.1",
+    "@smithy/node-http-handler": "^2.1.7",
+    "@smithy/protocol-http": "^3.0.7",
+    "@smithy/smithy-client": "^2.1.11",
+    "@smithy/types": "^2.3.5",
+    "@smithy/url-parser": "^2.0.11",
     "@smithy/util-base64": "^2.0.0",
     "@smithy/util-body-length-browser": "^2.0.0",
     "@smithy/util-body-length-node": "^2.1.0",
-    "@smithy/util-defaults-mode-browser": "^2.0.13",
-    "@smithy/util-defaults-mode-node": "^2.0.15",
-    "@smithy/util-retry": "^2.0.3",
+    "@smithy/util-defaults-mode-browser": "^2.0.15",
+    "@smithy/util-defaults-mode-node": "^2.0.19",
+    "@smithy/util-retry": "^2.0.4",
     "@smithy/util-utf8": "^2.0.0",
-    "@smithy/util-waiter": "^2.0.10",
+    "@smithy/util-waiter": "^2.0.11",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2"
   },