@aws-sdk/client-rekognition 3.431.0 → 3.434.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/Rekognition.js +6 -0
  3. package/dist-cjs/commands/GetMediaAnalysisJobCommand.js +51 -0
  4. package/dist-cjs/commands/ListMediaAnalysisJobsCommand.js +51 -0
  5. package/dist-cjs/commands/StartMediaAnalysisJobCommand.js +51 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/endpoint/ruleset.js +3 -3
  8. package/dist-cjs/models/models_0.js +35 -1
  9. package/dist-cjs/pagination/ListMediaAnalysisJobsPaginator.js +29 -0
  10. package/dist-cjs/pagination/index.js +1 -0
  11. package/dist-cjs/protocols/Aws_json1_1.js +270 -3
  12. package/dist-es/Rekognition.js +6 -0
  13. package/dist-es/commands/GetMediaAnalysisJobCommand.js +47 -0
  14. package/dist-es/commands/ListMediaAnalysisJobsCommand.js +47 -0
  15. package/dist-es/commands/StartMediaAnalysisJobCommand.js +47 -0
  16. package/dist-es/commands/index.js +3 -0
  17. package/dist-es/endpoint/ruleset.js +3 -3
  18. package/dist-es/models/models_0.js +33 -0
  19. package/dist-es/pagination/ListMediaAnalysisJobsPaginator.js +25 -0
  20. package/dist-es/pagination/index.js +1 -0
  21. package/dist-es/protocols/Aws_json1_1.js +262 -1
  22. package/dist-types/Rekognition.d.ts +21 -0
  23. package/dist-types/RekognitionClient.d.ts +5 -2
  24. package/dist-types/commands/GetMediaAnalysisJobCommand.d.ts +134 -0
  25. package/dist-types/commands/ListMediaAnalysisJobsCommand.d.ts +139 -0
  26. package/dist-types/commands/PutProjectPolicyCommand.d.ts +1 -1
  27. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +1 -1
  28. package/dist-types/commands/SearchFacesByImageCommand.d.ts +1 -1
  29. package/dist-types/commands/SearchFacesCommand.d.ts +1 -1
  30. package/dist-types/commands/SearchUsersByImageCommand.d.ts +1 -2
  31. package/dist-types/commands/SearchUsersCommand.d.ts +1 -1
  32. package/dist-types/commands/StartMediaAnalysisJobCommand.d.ts +135 -0
  33. package/dist-types/commands/index.d.ts +3 -0
  34. package/dist-types/models/models_0.d.ts +336 -406
  35. package/dist-types/models/models_1.d.ts +457 -1
  36. package/dist-types/pagination/ListMediaAnalysisJobsPaginator.d.ts +7 -0
  37. package/dist-types/pagination/index.d.ts +1 -0
  38. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  39. package/dist-types/ts3.4/Rekognition.d.ts +51 -0
  40. package/dist-types/ts3.4/RekognitionClient.d.ts +18 -0
  41. package/dist-types/ts3.4/commands/GetMediaAnalysisJobCommand.d.ts +39 -0
  42. package/dist-types/ts3.4/commands/ListMediaAnalysisJobsCommand.d.ts +42 -0
  43. package/dist-types/ts3.4/commands/PutProjectPolicyCommand.d.ts +1 -1
  44. package/dist-types/ts3.4/commands/RecognizeCelebritiesCommand.d.ts +1 -1
  45. package/dist-types/ts3.4/commands/SearchFacesByImageCommand.d.ts +1 -1
  46. package/dist-types/ts3.4/commands/SearchFacesCommand.d.ts +1 -1
  47. package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +4 -2
  48. package/dist-types/ts3.4/commands/SearchUsersCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/StartMediaAnalysisJobCommand.d.ts +42 -0
  50. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +95 -74
  52. package/dist-types/ts3.4/models/models_1.d.ts +96 -2
  53. package/dist-types/ts3.4/pagination/ListMediaAnalysisJobsPaginator.d.ts +11 -0
  54. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  55. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  56. package/package.json +32 -32
@@ -5653,6 +5653,226 @@ export interface GetLabelDetectionResponse {
5653
5653
  */
5654
5654
  GetRequestMetadata?: GetLabelDetectionRequestMetadata;
5655
5655
  }
5656
+ /**
5657
+ * @public
5658
+ */
5659
+ export interface GetMediaAnalysisJobRequest {
5660
+ /**
5661
+ * @public
5662
+ * <p>Unique identifier for the media analysis job for which you want to retrieve results.</p>
5663
+ */
5664
+ JobId: string | undefined;
5665
+ }
5666
+ /**
5667
+ * @public
5668
+ * @enum
5669
+ */
5670
+ export declare const MediaAnalysisJobFailureCode: {
5671
+ readonly ACCESS_DENIED: "ACCESS_DENIED";
5672
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
5673
+ readonly INVALID_KMS_KEY: "INVALID_KMS_KEY";
5674
+ readonly INVALID_MANIFEST: "INVALID_MANIFEST";
5675
+ readonly INVALID_OUTPUT_CONFIG: "INVALID_OUTPUT_CONFIG";
5676
+ readonly INVALID_S3_OBJECT: "INVALID_S3_OBJECT";
5677
+ readonly RESOURCE_NOT_FOUND: "RESOURCE_NOT_FOUND";
5678
+ readonly RESOURCE_NOT_READY: "RESOURCE_NOT_READY";
5679
+ readonly THROTTLED: "THROTTLED";
5680
+ };
5681
+ /**
5682
+ * @public
5683
+ */
5684
+ export type MediaAnalysisJobFailureCode = (typeof MediaAnalysisJobFailureCode)[keyof typeof MediaAnalysisJobFailureCode];
5685
+ /**
5686
+ * @public
5687
+ * <p>Details about the error that resulted in failure of the job.</p>
5688
+ */
5689
+ export interface MediaAnalysisJobFailureDetails {
5690
+ /**
5691
+ * @public
5692
+ * <p>Error code for the failed job.</p>
5693
+ */
5694
+ Code?: MediaAnalysisJobFailureCode;
5695
+ /**
5696
+ * @public
5697
+ * <p>Human readable error message.</p>
5698
+ */
5699
+ Message?: string;
5700
+ }
5701
+ /**
5702
+ * @public
5703
+ * <p>Contains input information for a media analysis job.</p>
5704
+ */
5705
+ export interface MediaAnalysisInput {
5706
+ /**
5707
+ * @public
5708
+ * <p>Provides the S3 bucket name and object name.</p>
5709
+ * <p>The region for the S3 bucket containing the S3 object must match the region you use for
5710
+ * Amazon Rekognition operations.</p>
5711
+ * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
5712
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
5713
+ * Amazon Rekognition Developer Guide. </p>
5714
+ */
5715
+ S3Object: S3Object | undefined;
5716
+ }
5717
+ /**
5718
+ * @public
5719
+ * <p>Summary that provides statistics on input manifest and errors identified in the input manifest.</p>
5720
+ */
5721
+ export interface MediaAnalysisManifestSummary {
5722
+ /**
5723
+ * @public
5724
+ * <p>Provides the S3 bucket name and object name.</p>
5725
+ * <p>The region for the S3 bucket containing the S3 object must match the region you use for
5726
+ * Amazon Rekognition operations.</p>
5727
+ * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
5728
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
5729
+ * Amazon Rekognition Developer Guide. </p>
5730
+ */
5731
+ S3Object?: S3Object;
5732
+ }
5733
+ /**
5734
+ * @public
5735
+ * <p>Configuration for Moderation Labels Detection.</p>
5736
+ */
5737
+ export interface MediaAnalysisDetectModerationLabelsConfig {
5738
+ /**
5739
+ * @public
5740
+ * <p>Specifies the minimum confidence level for the moderation labels to return. Amazon Rekognition
5741
+ * doesn't return any labels with a confidence level lower than this specified value.
5742
+ * </p>
5743
+ */
5744
+ MinConfidence?: number;
5745
+ /**
5746
+ * @public
5747
+ * <p>Specifies the custom moderation model to be used during the label detection job.
5748
+ * If not provided the pre-trained model is used.</p>
5749
+ */
5750
+ ProjectVersion?: string;
5751
+ }
5752
+ /**
5753
+ * @public
5754
+ * <p>Configuration options for a media analysis job. Configuration is operation-specific.</p>
5755
+ */
5756
+ export interface MediaAnalysisOperationsConfig {
5757
+ /**
5758
+ * @public
5759
+ * <p>Contains configuration options for a DetectModerationLabels job.</p>
5760
+ */
5761
+ DetectModerationLabels?: MediaAnalysisDetectModerationLabelsConfig;
5762
+ }
5763
+ /**
5764
+ * @public
5765
+ * <p>Output configuration provided in the job creation request.</p>
5766
+ */
5767
+ export interface MediaAnalysisOutputConfig {
5768
+ /**
5769
+ * @public
5770
+ * <p>Specifies the Amazon S3 bucket to contain the output of the media analysis job.</p>
5771
+ */
5772
+ S3Bucket: string | undefined;
5773
+ /**
5774
+ * @public
5775
+ * <p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have
5776
+ * designated for storage.</p>
5777
+ */
5778
+ S3KeyPrefix?: string;
5779
+ }
5780
+ /**
5781
+ * @public
5782
+ * <p>Contains the results for a media analysis job created with StartMediaAnalysisJob.</p>
5783
+ */
5784
+ export interface MediaAnalysisResults {
5785
+ /**
5786
+ * @public
5787
+ * <p>Provides the S3 bucket name and object name.</p>
5788
+ * <p>The region for the S3 bucket containing the S3 object must match the region you use for
5789
+ * Amazon Rekognition operations.</p>
5790
+ * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
5791
+ * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
5792
+ * Amazon Rekognition Developer Guide. </p>
5793
+ */
5794
+ S3Object?: S3Object;
5795
+ }
5796
+ /**
5797
+ * @public
5798
+ * @enum
5799
+ */
5800
+ export declare const MediaAnalysisJobStatus: {
5801
+ readonly CREATED: "CREATED";
5802
+ readonly FAILED: "FAILED";
5803
+ readonly IN_PROGRESS: "IN_PROGRESS";
5804
+ readonly QUEUED: "QUEUED";
5805
+ readonly SUCCEEDED: "SUCCEEDED";
5806
+ };
5807
+ /**
5808
+ * @public
5809
+ */
5810
+ export type MediaAnalysisJobStatus = (typeof MediaAnalysisJobStatus)[keyof typeof MediaAnalysisJobStatus];
5811
+ /**
5812
+ * @public
5813
+ */
5814
+ export interface GetMediaAnalysisJobResponse {
5815
+ /**
5816
+ * @public
5817
+ * <p>The identifier for the media analysis job.</p>
5818
+ */
5819
+ JobId: string | undefined;
5820
+ /**
5821
+ * @public
5822
+ * <p>The name of the media analysis job.</p>
5823
+ */
5824
+ JobName?: string;
5825
+ /**
5826
+ * @public
5827
+ * <p>Operation configurations that were provided during job creation.</p>
5828
+ */
5829
+ OperationsConfig: MediaAnalysisOperationsConfig | undefined;
5830
+ /**
5831
+ * @public
5832
+ * <p>The current status of the media analysis job.</p>
5833
+ */
5834
+ Status: MediaAnalysisJobStatus | undefined;
5835
+ /**
5836
+ * @public
5837
+ * <p>Details about the error that resulted in failure of the job.</p>
5838
+ */
5839
+ FailureDetails?: MediaAnalysisJobFailureDetails;
5840
+ /**
5841
+ * @public
5842
+ * <p>The Unix date and time when the job was started.</p>
5843
+ */
5844
+ CreationTimestamp: Date | undefined;
5845
+ /**
5846
+ * @public
5847
+ * <p>The Unix date and time when the job finished.</p>
5848
+ */
5849
+ CompletionTimestamp?: Date;
5850
+ /**
5851
+ * @public
5852
+ * <p>Reference to the input manifest that was provided in the job creation request.</p>
5853
+ */
5854
+ Input: MediaAnalysisInput | undefined;
5855
+ /**
5856
+ * @public
5857
+ * <p>Output configuration that was provided in the creation request.</p>
5858
+ */
5859
+ OutputConfig: MediaAnalysisOutputConfig | undefined;
5860
+ /**
5861
+ * @public
5862
+ * <p>KMS Key that was provided in the creation request.</p>
5863
+ */
5864
+ KmsKeyId?: string;
5865
+ /**
5866
+ * @public
5867
+ * <p>Output manifest that contains prediction results.</p>
5868
+ */
5869
+ Results?: MediaAnalysisResults;
5870
+ /**
5871
+ * @public
5872
+ * <p>The summary manifest provides statistics on input manifest and errors identified in the input manifest.</p>
5873
+ */
5874
+ ManifestSummary?: MediaAnalysisManifestSummary;
5875
+ }
5656
5876
  /**
5657
5877
  * @public
5658
5878
  * @enum
@@ -6298,6 +6518,25 @@ export interface IndexFacesResponse {
6298
6518
  */
6299
6519
  UnindexedFaces?: UnindexedFace[];
6300
6520
  }
6521
+ /**
6522
+ * @public
6523
+ * <p>Indicates that a provided manifest file is empty or larger than the allowed limit.</p>
6524
+ */
6525
+ export declare class InvalidManifestException extends __BaseException {
6526
+ readonly name: "InvalidManifestException";
6527
+ readonly $fault: "client";
6528
+ Message?: string;
6529
+ Code?: string;
6530
+ /**
6531
+ * @public
6532
+ * <p>A universally unique identifier (UUID) for the request.</p>
6533
+ */
6534
+ Logref?: string;
6535
+ /**
6536
+ * @internal
6537
+ */
6538
+ constructor(opts: __ExceptionOptionType<InvalidManifestException, __BaseException>);
6539
+ }
6301
6540
  /**
6302
6541
  * @public
6303
6542
  * <p>Specifies the starting point in a Kinesis stream to start processing. You can use the
@@ -6556,6 +6795,103 @@ export interface ListFacesResponse {
6556
6795
  */
6557
6796
  FaceModelVersion?: string;
6558
6797
  }
6798
+ /**
6799
+ * @public
6800
+ */
6801
+ export interface ListMediaAnalysisJobsRequest {
6802
+ /**
6803
+ * @public
6804
+ * <p>Pagination token, if the previous response was incomplete.</p>
6805
+ */
6806
+ NextToken?: string;
6807
+ /**
6808
+ * @public
6809
+ * <p>The maximum number of results to return per paginated call. The largest value user can specify is 100.
6810
+ * If user specifies a value greater than 100, an <code>InvalidParameterException</code> error occurs. The default value is 100.</p>
6811
+ */
6812
+ MaxResults?: number;
6813
+ }
6814
+ /**
6815
+ * @public
6816
+ * <p>Description for a media analysis job.</p>
6817
+ */
6818
+ export interface MediaAnalysisJobDescription {
6819
+ /**
6820
+ * @public
6821
+ * <p>The identifier for a media analysis job.</p>
6822
+ */
6823
+ JobId: string | undefined;
6824
+ /**
6825
+ * @public
6826
+ * <p>The name of a media analysis job.</p>
6827
+ */
6828
+ JobName?: string;
6829
+ /**
6830
+ * @public
6831
+ * <p>Operation configurations that were provided during job creation.</p>
6832
+ */
6833
+ OperationsConfig: MediaAnalysisOperationsConfig | undefined;
6834
+ /**
6835
+ * @public
6836
+ * <p>The status of the media analysis job being retrieved.</p>
6837
+ */
6838
+ Status: MediaAnalysisJobStatus | undefined;
6839
+ /**
6840
+ * @public
6841
+ * <p>Details about the error that resulted in failure of the job.</p>
6842
+ */
6843
+ FailureDetails?: MediaAnalysisJobFailureDetails;
6844
+ /**
6845
+ * @public
6846
+ * <p>The Unix date and time when the job was started.</p>
6847
+ */
6848
+ CreationTimestamp: Date | undefined;
6849
+ /**
6850
+ * @public
6851
+ * <p>The Unix date and time when the job finished.</p>
6852
+ */
6853
+ CompletionTimestamp?: Date;
6854
+ /**
6855
+ * @public
6856
+ * <p>Reference to the input manifest that was provided in the job creation request.</p>
6857
+ */
6858
+ Input: MediaAnalysisInput | undefined;
6859
+ /**
6860
+ * @public
6861
+ * <p>Output configuration that was provided in the creation request.</p>
6862
+ */
6863
+ OutputConfig: MediaAnalysisOutputConfig | undefined;
6864
+ /**
6865
+ * @public
6866
+ * <p>KMS Key that was provided in the creation request.</p>
6867
+ */
6868
+ KmsKeyId?: string;
6869
+ /**
6870
+ * @public
6871
+ * <p>Output manifest that contains prediction results.</p>
6872
+ */
6873
+ Results?: MediaAnalysisResults;
6874
+ /**
6875
+ * @public
6876
+ * <p>Provides statistics on input manifest and errors identified in the input manifest.</p>
6877
+ */
6878
+ ManifestSummary?: MediaAnalysisManifestSummary;
6879
+ }
6880
+ /**
6881
+ * @public
6882
+ */
6883
+ export interface ListMediaAnalysisJobsResponse {
6884
+ /**
6885
+ * @public
6886
+ * <p>Pagination token, if the previous response was incomplete.</p>
6887
+ */
6888
+ NextToken?: string;
6889
+ /**
6890
+ * @public
6891
+ * <p>Contains a list of all media analysis jobs.</p>
6892
+ */
6893
+ MediaAnalysisJobs: MediaAnalysisJobDescription[] | undefined;
6894
+ }
6559
6895
  /**
6560
6896
  * @public
6561
6897
  */
@@ -6812,412 +7148,6 @@ export interface NotificationChannel {
6812
7148
  */
6813
7149
  RoleArn: string | undefined;
6814
7150
  }
6815
- /**
6816
- * @public
6817
- */
6818
- export interface PutProjectPolicyRequest {
6819
- /**
6820
- * @public
6821
- * <p>The Amazon Resource Name (ARN) of the project that the project policy is attached to.</p>
6822
- */
6823
- ProjectArn: string | undefined;
6824
- /**
6825
- * @public
6826
- * <p>A name for the policy.</p>
6827
- */
6828
- PolicyName: string | undefined;
6829
- /**
6830
- * @public
6831
- * <p>The revision ID for the Project Policy. Each time you modify a policy, Amazon Rekognition Custom Labels
6832
- * generates and assigns a new <code>PolicyRevisionId</code> and then deletes the previous version of the
6833
- * policy.</p>
6834
- */
6835
- PolicyRevisionId?: string;
6836
- /**
6837
- * @public
6838
- * <p>A resource policy to add to the model. The policy is a JSON structure that contains
6839
- * one or more statements that define the policy.
6840
- * The policy must follow the IAM syntax. For
6841
- * more information about the contents of a JSON policy document, see
6842
- * <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html">IAM JSON policy reference</a>. </p>
6843
- */
6844
- PolicyDocument: string | undefined;
6845
- }
6846
- /**
6847
- * @public
6848
- */
6849
- export interface PutProjectPolicyResponse {
6850
- /**
6851
- * @public
6852
- * <p>The ID of the project policy.</p>
6853
- */
6854
- PolicyRevisionId?: string;
6855
- }
6856
- /**
6857
- * @public
6858
- */
6859
- export interface RecognizeCelebritiesRequest {
6860
- /**
6861
- * @public
6862
- * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
6863
- * call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
6864
- * <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
6865
- * base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
6866
- * Images in the Amazon Rekognition developer guide.</p>
6867
- */
6868
- Image: Image | undefined;
6869
- }
6870
- /**
6871
- * @public
6872
- */
6873
- export interface RecognizeCelebritiesResponse {
6874
- /**
6875
- * @public
6876
- * <p>Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64
6877
- * celebrities in an image. Each celebrity object includes the following attributes:
6878
- * <code>Face</code>, <code>Confidence</code>, <code>Emotions</code>, <code>Landmarks</code>,
6879
- * <code>Pose</code>, <code>Quality</code>, <code>Smile</code>, <code>Id</code>,
6880
- * <code>KnownGender</code>, <code>MatchConfidence</code>, <code>Name</code>,
6881
- * <code>Urls</code>.</p>
6882
- */
6883
- CelebrityFaces?: Celebrity[];
6884
- /**
6885
- * @public
6886
- * <p>Details about each unrecognized face in the image.</p>
6887
- */
6888
- UnrecognizedFaces?: ComparedFace[];
6889
- /**
6890
- * @public
6891
- * <note>
6892
- * <p>Support for estimating image orientation using the the OrientationCorrection field
6893
- * has ceased as of August 2021. Any returned values for this field included in an API response
6894
- * will always be NULL.</p>
6895
- * </note>
6896
- * <p>The orientation of the input image (counterclockwise direction). If your application
6897
- * displays the image, you can use this value to correct the orientation. The bounding box
6898
- * coordinates returned in <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code>
6899
- * represent face locations before the image orientation is corrected. </p>
6900
- * <note>
6901
- * <p>If the input image is in .jpeg format, it might contain exchangeable image (Exif)
6902
- * metadata that includes the image's orientation. If so, and the Exif metadata for the input
6903
- * image populates the orientation field, the value of <code>OrientationCorrection</code> is
6904
- * null. The <code>CelebrityFaces</code> and <code>UnrecognizedFaces</code> bounding box
6905
- * coordinates represent face locations after Exif metadata is used to correct the image
6906
- * orientation. Images in .png format don't contain Exif metadata. </p>
6907
- * </note>
6908
- */
6909
- OrientationCorrection?: OrientationCorrection;
6910
- }
6911
- /**
6912
- * @public
6913
- */
6914
- export interface SearchFacesRequest {
6915
- /**
6916
- * @public
6917
- * <p>ID of the collection the face belongs to.</p>
6918
- */
6919
- CollectionId: string | undefined;
6920
- /**
6921
- * @public
6922
- * <p>ID of a face to find matches for in the collection.</p>
6923
- */
6924
- FaceId: string | undefined;
6925
- /**
6926
- * @public
6927
- * <p>Maximum number of faces to return. The operation returns the maximum number of faces
6928
- * with the highest confidence in the match.</p>
6929
- */
6930
- MaxFaces?: number;
6931
- /**
6932
- * @public
6933
- * <p>Optional value specifying the minimum confidence in the face match to return. For
6934
- * example, don't return any matches where confidence in matches is less than 70%. The default
6935
- * value is 80%. </p>
6936
- */
6937
- FaceMatchThreshold?: number;
6938
- }
6939
- /**
6940
- * @public
6941
- */
6942
- export interface SearchFacesResponse {
6943
- /**
6944
- * @public
6945
- * <p>ID of the face that was searched for matches in a collection.</p>
6946
- */
6947
- SearchedFaceId?: string;
6948
- /**
6949
- * @public
6950
- * <p>An array of faces that matched the input face, along with the confidence in the
6951
- * match.</p>
6952
- */
6953
- FaceMatches?: FaceMatch[];
6954
- /**
6955
- * @public
6956
- * <p>Version number of the face detection model associated with the input collection
6957
- * (<code>CollectionId</code>).</p>
6958
- */
6959
- FaceModelVersion?: string;
6960
- }
6961
- /**
6962
- * @public
6963
- */
6964
- export interface SearchFacesByImageRequest {
6965
- /**
6966
- * @public
6967
- * <p>ID of the collection to search.</p>
6968
- */
6969
- CollectionId: string | undefined;
6970
- /**
6971
- * @public
6972
- * <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to
6973
- * call Amazon Rekognition operations, passing base64-encoded image bytes is not supported. </p>
6974
- * <p>If you are using an AWS SDK to call Amazon Rekognition, you might not need to
6975
- * base64-encode image bytes passed using the <code>Bytes</code> field. For more information, see
6976
- * Images in the Amazon Rekognition developer guide.</p>
6977
- */
6978
- Image: Image | undefined;
6979
- /**
6980
- * @public
6981
- * <p>Maximum number of faces to return. The operation returns the maximum number of faces
6982
- * with the highest confidence in the match.</p>
6983
- */
6984
- MaxFaces?: number;
6985
- /**
6986
- * @public
6987
- * <p>(Optional) Specifies the minimum confidence in the face match to return. For example,
6988
- * don't return any matches where confidence in matches is less than 70%. The default value is
6989
- * 80%.</p>
6990
- */
6991
- FaceMatchThreshold?: number;
6992
- /**
6993
- * @public
6994
- * <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
6995
- * Filtered faces aren't searched for in the collection. If you specify <code>AUTO</code>,
6996
- * Amazon Rekognition chooses the quality bar. If you specify <code>LOW</code>, <code>MEDIUM</code>, or
6997
- * <code>HIGH</code>, filtering removes all faces that don’t meet the chosen quality bar.
6998
- * The quality bar is
6999
- * based on a variety of common use cases. Low-quality detections can occur for a number of
7000
- * reasons. Some examples are an object that's misidentified as a face, a face that's too blurry,
7001
- * or a face with a pose that's too extreme to use. If you specify <code>NONE</code>, no
7002
- * filtering is performed. The default value is <code>NONE</code>. </p>
7003
- * <p>To use quality filtering, the collection you are using must be associated with version 3
7004
- * of the face model or higher.</p>
7005
- */
7006
- QualityFilter?: QualityFilter;
7007
- }
7008
- /**
7009
- * @public
7010
- */
7011
- export interface SearchFacesByImageResponse {
7012
- /**
7013
- * @public
7014
- * <p>The bounding box around the face in the input image that Amazon Rekognition used for the
7015
- * search.</p>
7016
- */
7017
- SearchedFaceBoundingBox?: BoundingBox;
7018
- /**
7019
- * @public
7020
- * <p>The level of confidence that the <code>searchedFaceBoundingBox</code>, contains a
7021
- * face.</p>
7022
- */
7023
- SearchedFaceConfidence?: number;
7024
- /**
7025
- * @public
7026
- * <p>An array of faces that match the input face, along with the confidence in the
7027
- * match.</p>
7028
- */
7029
- FaceMatches?: FaceMatch[];
7030
- /**
7031
- * @public
7032
- * <p>Version number of the face detection model associated with the input collection
7033
- * (<code>CollectionId</code>).</p>
7034
- */
7035
- FaceModelVersion?: string;
7036
- }
7037
- /**
7038
- * @public
7039
- */
7040
- export interface SearchUsersRequest {
7041
- /**
7042
- * @public
7043
- * <p>The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a
7044
- * FaceId is provided, UserId isn’t required to be present in the Collection.</p>
7045
- */
7046
- CollectionId: string | undefined;
7047
- /**
7048
- * @public
7049
- * <p>ID for the existing User.</p>
7050
- */
7051
- UserId?: string;
7052
- /**
7053
- * @public
7054
- * <p>ID for the existing face.</p>
7055
- */
7056
- FaceId?: string;
7057
- /**
7058
- * @public
7059
- * <p>Optional value that specifies the minimum confidence in the matched UserID to return.
7060
- * Default value of 80.</p>
7061
- */
7062
- UserMatchThreshold?: number;
7063
- /**
7064
- * @public
7065
- * <p>Maximum number of identities to return.</p>
7066
- */
7067
- MaxUsers?: number;
7068
- }
7069
- /**
7070
- * @public
7071
- * <p>Provides face metadata such as FaceId, BoundingBox, Confidence of the input face used for
7072
- * search.</p>
7073
- */
7074
- export interface SearchedFace {
7075
- /**
7076
- * @public
7077
- * <p> Unique identifier assigned to the face.</p>
7078
- */
7079
- FaceId?: string;
7080
- }
7081
- /**
7082
- * @public
7083
- * <p>Contains metadata about a User searched for within a collection.</p>
7084
- */
7085
- export interface SearchedUser {
7086
- /**
7087
- * @public
7088
- * <p> A provided ID for the UserID. Unique within the collection. </p>
7089
- */
7090
- UserId?: string;
7091
- }
7092
- /**
7093
- * @public
7094
- * <p>Provides UserID metadata along with the confidence in the match of this UserID with the
7095
- * input face.</p>
7096
- */
7097
- export interface UserMatch {
7098
- /**
7099
- * @public
7100
- * <p> Describes the UserID metadata.</p>
7101
- */
7102
- Similarity?: number;
7103
- /**
7104
- * @public
7105
- * <p> Confidence in the match of this UserID with the input face. </p>
7106
- */
7107
- User?: MatchedUser;
7108
- }
7109
- /**
7110
- * @public
7111
- */
7112
- export interface SearchUsersResponse {
7113
- /**
7114
- * @public
7115
- * <p>An array of UserMatch objects that matched the input face along with the confidence in the
7116
- * match. Array will be empty if there are no matches.</p>
7117
- */
7118
- UserMatches?: UserMatch[];
7119
- /**
7120
- * @public
7121
- * <p>Version number of the face detection model associated with the input CollectionId.</p>
7122
- */
7123
- FaceModelVersion?: string;
7124
- /**
7125
- * @public
7126
- * <p>Contains the ID of a face that was used to search for matches in a collection.</p>
7127
- */
7128
- SearchedFace?: SearchedFace;
7129
- /**
7130
- * @public
7131
- * <p>Contains the ID of the UserID that was used to search for matches in a collection.</p>
7132
- */
7133
- SearchedUser?: SearchedUser;
7134
- }
7135
- /**
7136
- * @public
7137
- */
7138
- export interface SearchUsersByImageRequest {
7139
- /**
7140
- * @public
7141
- * <p>The ID of an existing collection containing the UserID.</p>
7142
- */
7143
- CollectionId: string | undefined;
7144
- /**
7145
- * @public
7146
- * <p>Provides the input image either as bytes or an S3 object.</p>
7147
- * <p>You pass image bytes to an Amazon Rekognition API operation by using the <code>Bytes</code>
7148
- * property. For example, you would use the <code>Bytes</code> property to pass an image loaded
7149
- * from a local file system. Image bytes passed by using the <code>Bytes</code> property must be
7150
- * base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to
7151
- * call Amazon Rekognition API operations. </p>
7152
- * <p>For more information, see Analyzing an Image Loaded from a Local File System
7153
- * in the Amazon Rekognition Developer Guide.</p>
7154
- * <p> You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the
7155
- * <code>S3Object</code> property. Images stored in an S3 bucket do not need to be
7156
- * base64-encoded.</p>
7157
- * <p>The region for the S3 bucket containing the S3 object must match the region you use for
7158
- * Amazon Rekognition operations.</p>
7159
- * <p>If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the
7160
- * Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and
7161
- * then call the operation using the S3Object property.</p>
7162
- * <p>For Amazon Rekognition to process an S3 object, the user must have permission to
7163
- * access the S3 object. For more information, see How Amazon Rekognition works with IAM in the
7164
- * Amazon Rekognition Developer Guide. </p>
7165
- */
7166
- Image: Image | undefined;
7167
- /**
7168
- * @public
7169
- * <p>Specifies the minimum confidence in the UserID match to return. Default value is
7170
- * 80.</p>
7171
- */
7172
- UserMatchThreshold?: number;
7173
- /**
7174
- * @public
7175
- * <p>Maximum number of UserIDs to return.</p>
7176
- */
7177
- MaxUsers?: number;
7178
- /**
7179
- * @public
7180
- * <p>A filter that specifies a quality bar for how much filtering is done to identify faces.
7181
- * Filtered faces aren't searched for in the collection. The default value is NONE.</p>
7182
- */
7183
- QualityFilter?: QualityFilter;
7184
- }
7185
- /**
7186
- * @public
7187
- * <p>Contains data regarding the input face used for a search.</p>
7188
- */
7189
- export interface SearchedFaceDetails {
7190
- /**
7191
- * @public
7192
- * <p>Structure containing attributes of the face that the algorithm detected.</p>
7193
- * <p>A <code>FaceDetail</code> object contains either the default facial attributes or all
7194
- * facial attributes. The default attributes are <code>BoundingBox</code>,
7195
- * <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and
7196
- * <code>Quality</code>.</p>
7197
- * <p>
7198
- * <a>GetFaceDetection</a> is the only Amazon Rekognition Video stored video operation that can
7199
- * return a <code>FaceDetail</code> object with all attributes. To specify which attributes to
7200
- * return, use the <code>FaceAttributes</code> input parameter for <a>StartFaceDetection</a>. The following Amazon Rekognition Video operations return only the default
7201
- * attributes. The corresponding Start operations don't have a <code>FaceAttributes</code> input
7202
- * parameter:</p>
7203
- * <ul>
7204
- * <li>
7205
- * <p>GetCelebrityRecognition</p>
7206
- * </li>
7207
- * <li>
7208
- * <p>GetPersonTracking</p>
7209
- * </li>
7210
- * <li>
7211
- * <p>GetFaceSearch</p>
7212
- * </li>
7213
- * </ul>
7214
- * <p>The Amazon Rekognition Image <a>DetectFaces</a> and <a>IndexFaces</a> operations
7215
- * can return all facial attributes. To specify which attributes to return, use the
7216
- * <code>Attributes</code> input parameter for <code>DetectFaces</code>. For
7217
- * <code>IndexFaces</code>, use the <code>DetectAttributes</code> input parameter.</p>
7218
- */
7219
- FaceDetail?: FaceDetail;
7220
- }
7221
7151
  /**
7222
7152
  * @internal
7223
7153
  */