@aws-sdk/client-rekognition 3.348.0 → 3.351.0

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

@@ -28,6 +28,125 @@ export interface GroundTruthManifest {
 export interface Asset {
   GroundTruthManifest?: GroundTruthManifest;
 }
+export interface AssociatedFace {
+  FaceId?: string;
+}
+export interface AssociateFacesRequest {
+  CollectionId: string | undefined;
+  UserId: string | undefined;
+  FaceIds: string[] | undefined;
+  UserMatchThreshold?: number;
+  ClientRequestToken?: string;
+}
+export declare const UnsuccessfulFaceAssociationReason: {
+  readonly ASSOCIATED_TO_A_DIFFERENT_USER: "ASSOCIATED_TO_A_DIFFERENT_USER";
+  readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
+  readonly LOW_MATCH_CONFIDENCE: "LOW_MATCH_CONFIDENCE";
+};
+export type UnsuccessfulFaceAssociationReason =
+  (typeof UnsuccessfulFaceAssociationReason)[keyof typeof UnsuccessfulFaceAssociationReason];
+export interface UnsuccessfulFaceAssociation {
+  FaceId?: string;
+  UserId?: string;
+  Confidence?: number;
+  Reasons?: (UnsuccessfulFaceAssociationReason | string)[];
+}
+export declare const UserStatus: {
+  readonly ACTIVE: "ACTIVE";
+  readonly CREATED: "CREATED";
+  readonly CREATING: "CREATING";
+  readonly UPDATING: "UPDATING";
+};
+export type UserStatus = (typeof UserStatus)[keyof typeof UserStatus];
+export interface AssociateFacesResponse {
+  AssociatedFaces?: AssociatedFace[];
+  UnsuccessfulFaceAssociations?: UnsuccessfulFaceAssociation[];
+  UserStatus?: UserStatus | string;
+}
+export declare class ConflictException extends __BaseException {
+  readonly name: "ConflictException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
+}
+export declare class IdempotentParameterMismatchException extends __BaseException {
+  readonly name: "IdempotentParameterMismatchException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<
+      IdempotentParameterMismatchException,
+      __BaseException
+    >
+  );
+}
+export declare class InternalServerError extends __BaseException {
+  readonly name: "InternalServerError";
+  readonly $fault: "server";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<InternalServerError, __BaseException>
+  );
+}
+export declare class InvalidParameterException extends __BaseException {
+  readonly name: "InvalidParameterException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<InvalidParameterException, __BaseException>
+  );
+}
+export declare class ProvisionedThroughputExceededException extends __BaseException {
+  readonly name: "ProvisionedThroughputExceededException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<
+      ProvisionedThroughputExceededException,
+      __BaseException
+    >
+  );
+}
+export declare class ResourceNotFoundException extends __BaseException {
+  readonly name: "ResourceNotFoundException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
+  );
+}
+export declare class ServiceQuotaExceededException extends __BaseException {
+  readonly name: "ServiceQuotaExceededException";
+  readonly $fault: "client";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
+  );
+}
+export declare class ThrottlingException extends __BaseException {
+  readonly name: "ThrottlingException";
+  readonly $fault: "server";
+  Message?: string;
+  Code?: string;
+  Logref?: string;
+  constructor(
+    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
+  );
+}
 export declare const Attribute: {
   readonly AGE_RANGE: "AGE_RANGE";
   readonly ALL: "ALL";
@@ -321,16 +440,6 @@ export declare class ImageTooLargeException extends __BaseException {
     opts: __ExceptionOptionType<ImageTooLargeException, __BaseException>
   );
 }
-export declare class InternalServerError extends __BaseException {
-  readonly name: "InternalServerError";
-  readonly $fault: "server";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<InternalServerError, __BaseException>
-  );
-}
 export declare class InvalidImageFormatException extends __BaseException {
   readonly name: "InvalidImageFormatException";
   readonly $fault: "client";
@@ -341,16 +450,6 @@ export declare class InvalidImageFormatException extends __BaseException {
     opts: __ExceptionOptionType<InvalidImageFormatException, __BaseException>
   );
 }
-export declare class InvalidParameterException extends __BaseException {
-  readonly name: "InvalidParameterException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<InvalidParameterException, __BaseException>
-  );
-}
 export declare class InvalidS3ObjectException extends __BaseException {
   readonly name: "InvalidS3ObjectException";
   readonly $fault: "client";
@@ -361,29 +460,6 @@ export declare class InvalidS3ObjectException extends __BaseException {
     opts: __ExceptionOptionType<InvalidS3ObjectException, __BaseException>
   );
 }
-export declare class ProvisionedThroughputExceededException extends __BaseException {
-  readonly name: "ProvisionedThroughputExceededException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<
-      ProvisionedThroughputExceededException,
-      __BaseException
-    >
-  );
-}
-export declare class ThrottlingException extends __BaseException {
-  readonly name: "ThrottlingException";
-  readonly $fault: "server";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<ThrottlingException, __BaseException>
-  );
-}
 export interface ConnectedHomeSettings {
   Labels: string[] | undefined;
   MinConfidence?: number;
@@ -458,26 +534,6 @@ export declare class ResourceInUseException extends __BaseException {
     opts: __ExceptionOptionType<ResourceInUseException, __BaseException>
   );
 }
-export declare class ResourceNotFoundException extends __BaseException {
-  readonly name: "ResourceNotFoundException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>
-  );
-}
-export declare class ServiceQuotaExceededException extends __BaseException {
-  readonly name: "ServiceQuotaExceededException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>
-  );
-}
 export interface CreateCollectionRequest {
   CollectionId: string | undefined;
   Tags?: Record<string, string>;
@@ -609,6 +665,12 @@ export interface CreateStreamProcessorRequest {
 export interface CreateStreamProcessorResponse {
   StreamProcessorArn?: string;
 }
+export interface CreateUserRequest {
+  CollectionId: string | undefined;
+  UserId: string | undefined;
+  ClientRequestToken?: string;
+}
+export interface CreateUserResponse {}
 export interface Geometry {
   BoundingBox?: BoundingBox;
   Polygon?: Point[];
@@ -682,8 +744,20 @@ export interface DeleteFacesRequest {
   CollectionId: string | undefined;
   FaceIds: string[] | undefined;
 }
+export declare const UnsuccessfulFaceDeletionReason: {
+  readonly ASSOCIATED_TO_AN_EXISTING_USER: "ASSOCIATED_TO_AN_EXISTING_USER";
+  readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
+};
+export type UnsuccessfulFaceDeletionReason =
+  (typeof UnsuccessfulFaceDeletionReason)[keyof typeof UnsuccessfulFaceDeletionReason];
+export interface UnsuccessfulFaceDeletion {
+  FaceId?: string;
+  UserId?: string;
+  Reasons?: (UnsuccessfulFaceDeletionReason | string)[];
+}
 export interface DeleteFacesResponse {
   DeletedFaces?: string[];
+  UnsuccessfulFaceDeletions?: UnsuccessfulFaceDeletion[];
 }
 export interface DeleteProjectRequest {
   ProjectArn: string | undefined;
@@ -742,6 +816,12 @@ export interface DeleteStreamProcessorRequest {
   Name: string | undefined;
 }
 export interface DeleteStreamProcessorResponse {}
+export interface DeleteUserRequest {
+  CollectionId: string | undefined;
+  UserId: string | undefined;
+  ClientRequestToken?: string;
+}
+export interface DeleteUserResponse {}
 export interface DescribeCollectionRequest {
   CollectionId: string | undefined;
 }
@@ -750,6 +830,7 @@ export interface DescribeCollectionResponse {
   FaceModelVersion?: string;
   CollectionARN?: string;
   CreationTimestamp?: Date;
+  UserCount?: number;
 }
 export interface DescribeDatasetRequest {
   DatasetArn: string | undefined;
@@ -1063,6 +1144,31 @@ export interface DetectTextResponse {
   TextDetections?: TextDetection[];
   TextModelVersion?: string;
 }
+export interface DisassociatedFace {
+  FaceId?: string;
+}
+export interface DisassociateFacesRequest {
+  CollectionId: string | undefined;
+  UserId: string | undefined;
+  ClientRequestToken?: string;
+  FaceIds: string[] | undefined;
+}
+export declare const UnsuccessfulFaceDisassociationReason: {
+  readonly ASSOCIATED_TO_A_DIFFERENT_USER: "ASSOCIATED_TO_A_DIFFERENT_USER";
+  readonly FACE_NOT_FOUND: "FACE_NOT_FOUND";
+};
+export type UnsuccessfulFaceDisassociationReason =
+  (typeof UnsuccessfulFaceDisassociationReason)[keyof typeof UnsuccessfulFaceDisassociationReason];
+export interface UnsuccessfulFaceDisassociation {
+  FaceId?: string;
+  UserId?: string;
+  Reasons?: (UnsuccessfulFaceDisassociationReason | string)[];
+}
+export interface DisassociateFacesResponse {
+  DisassociatedFaces?: DisassociatedFace[];
+  UnsuccessfulFaceDisassociations?: UnsuccessfulFaceDisassociation[];
+  UserStatus?: UserStatus | string;
+}
 export interface DistributeDataset {
   Arn: string | undefined;
 }
@@ -1077,6 +1183,7 @@ export interface Face {
   ExternalImageId?: string;
   Confidence?: number;
   IndexFacesModelVersion?: string;
+  UserId?: string;
 }
 export declare const FaceAttributes: {
   readonly ALL: "ALL";
@@ -1391,19 +1498,6 @@ export interface GetTextDetectionResponse {
   Video?: Video;
   JobTag?: string;
 }
-export declare class IdempotentParameterMismatchException extends __BaseException {
-  readonly name: "IdempotentParameterMismatchException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<
-      IdempotentParameterMismatchException,
-      __BaseException
-    >
-  );
-}
 export interface IndexFacesRequest {
   CollectionId: string | undefined;
   Image: Image | undefined;
@@ -1479,6 +1573,8 @@ export interface ListFacesRequest {
   CollectionId: string | undefined;
   NextToken?: string;
   MaxResults?: number;
+  UserId?: string;
+  FaceIds?: string[];
 }
 export interface ListFacesResponse {
   Faces?: Face[];
@@ -1520,6 +1616,19 @@ export interface ListTagsForResourceRequest {
 export interface ListTagsForResourceResponse {
   Tags?: Record<string, string>;
 }
+export interface ListUsersRequest {
+  CollectionId: string | undefined;
+  MaxResults?: number;
+  NextToken?: string;
+}
+export interface User {
+  UserId?: string;
+  UserStatus?: UserStatus | string;
+}
+export interface ListUsersResponse {
+  Users?: User[];
+  NextToken?: string;
+}
 export declare class MalformedPolicyDocumentException extends __BaseException {
   readonly name: "MalformedPolicyDocumentException";
   readonly $fault: "client";
@@ -1533,6 +1642,10 @@ export declare class MalformedPolicyDocumentException extends __BaseException {
     >
   );
 }
+export interface MatchedUser {
+  UserId?: string;
+  UserStatus?: UserStatus | string;
+}
 export interface NotificationChannel {
   SNSTopicArn: string | undefined;
   RoleArn: string | undefined;
@@ -1578,150 +1691,67 @@ export interface SearchFacesByImageResponse {
   FaceMatches?: FaceMatch[];
   FaceModelVersion?: string;
 }
-export interface StartCelebrityRecognitionRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-}
-export interface StartCelebrityRecognitionResponse {
-  JobId?: string;
-}
-export declare class VideoTooLargeException extends __BaseException {
-  readonly name: "VideoTooLargeException";
-  readonly $fault: "client";
-  Message?: string;
-  Code?: string;
-  Logref?: string;
-  constructor(
-    opts: __ExceptionOptionType<VideoTooLargeException, __BaseException>
-  );
-}
-export interface StartContentModerationRequest {
-  Video: Video | undefined;
-  MinConfidence?: number;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-}
-export interface StartContentModerationResponse {
-  JobId?: string;
-}
-export interface StartFaceDetectionRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  FaceAttributes?: FaceAttributes | string;
-  JobTag?: string;
-}
-export interface StartFaceDetectionResponse {
-  JobId?: string;
-}
-export interface StartFaceSearchRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  FaceMatchThreshold?: number;
+export interface SearchUsersRequest {
   CollectionId: string | undefined;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-}
-export interface StartFaceSearchResponse {
-  JobId?: string;
-}
-export interface StartLabelDetectionRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  MinConfidence?: number;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-  Features?: (LabelDetectionFeatureName | string)[];
-  Settings?: LabelDetectionSettings;
-}
-export interface StartLabelDetectionResponse {
-  JobId?: string;
-}
-export interface StartPersonTrackingRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-}
-export interface StartPersonTrackingResponse {
-  JobId?: string;
-}
-export interface StartProjectVersionRequest {
-  ProjectVersionArn: string | undefined;
-  MinInferenceUnits: number | undefined;
-  MaxInferenceUnits?: number;
-}
-export interface StartProjectVersionResponse {
-  Status?: ProjectVersionStatus | string;
-}
-export interface StartShotDetectionFilter {
-  MinSegmentConfidence?: number;
-}
-export interface StartTechnicalCueDetectionFilter {
-  MinSegmentConfidence?: number;
-  BlackFrame?: BlackFrame;
-}
-export interface StartSegmentDetectionFilters {
-  TechnicalCueFilter?: StartTechnicalCueDetectionFilter;
-  ShotFilter?: StartShotDetectionFilter;
+  UserId?: string;
+  FaceId?: string;
+  UserMatchThreshold?: number;
+  MaxUsers?: number;
 }
-export interface StartSegmentDetectionRequest {
-  Video: Video | undefined;
-  ClientRequestToken?: string;
-  NotificationChannel?: NotificationChannel;
-  JobTag?: string;
-  Filters?: StartSegmentDetectionFilters;
-  SegmentTypes: (SegmentType | string)[] | undefined;
+export interface SearchedFace {
+  FaceId?: string;
 }
-export interface StartSegmentDetectionResponse {
-  JobId?: string;
+export interface SearchedUser {
+  UserId?: string;
 }
-export interface StreamProcessingStartSelector {
-  KVSStreamStartSelector?: KinesisVideoStreamStartSelector;
+export interface UserMatch {
+  Similarity?: number;
+  User?: MatchedUser;
 }
-export interface StreamProcessingStopSelector {
-  MaxDurationInSeconds?: number;
+export interface SearchUsersResponse {
+  UserMatches?: UserMatch[];
+  FaceModelVersion?: string;
+  SearchedFace?: SearchedFace;
+  SearchedUser?: SearchedUser;
 }
-export interface StartStreamProcessorRequest {
-  Name: string | undefined;
-  StartSelector?: StreamProcessingStartSelector;
-  StopSelector?: StreamProcessingStopSelector;
+export interface SearchUsersByImageRequest {
+  CollectionId: string | undefined;
+  Image: Image | undefined;
+  UserMatchThreshold?: number;
+  MaxUsers?: number;
+  QualityFilter?: QualityFilter | string;
 }
-export interface StartStreamProcessorResponse {
-  SessionId?: string;
+export interface SearchedFaceDetails {
+  FaceDetail?: FaceDetail;
 }
-export interface StartTextDetectionFilters {
-  WordFilter?: DetectionFilter;
-  RegionsOfInterest?: RegionOfInterest[];
+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 StartTextDetectionRequest {
+export interface StartCelebrityRecognitionRequest {
   Video: Video | undefined;
   ClientRequestToken?: string;
   NotificationChannel?: NotificationChannel;
   JobTag?: string;
-  Filters?: StartTextDetectionFilters;
-}
-export interface StartTextDetectionResponse {
-  JobId?: string;
-}
-export interface StopProjectVersionRequest {
-  ProjectVersionArn: string | undefined;
-}
-export interface StopProjectVersionResponse {
-  Status?: ProjectVersionStatus | string;
-}
-export interface StopStreamProcessorRequest {
-  Name: string | undefined;
-}
-export interface StopStreamProcessorResponse {}
-export interface TagResourceRequest {
-  ResourceArn: string | undefined;
-  Tags: Record<string, string> | undefined;
 }
-export interface TagResourceResponse {}
 export declare const AuditImageFilterSensitiveLog: (obj: AuditImage) => any;
 export declare const GetFaceLivenessSessionResultsResponseFilterSensitiveLog: (
   obj: GetFaceLivenessSessionResultsResponse