@aws-sdk/client-rekognition 3.306.0 → 3.310.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 (175) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/Rekognition.js +30 -0
  3. package/dist-cjs/commands/CompareFacesCommand.js +2 -2
  4. package/dist-cjs/commands/CopyProjectVersionCommand.js +2 -2
  5. package/dist-cjs/commands/CreateCollectionCommand.js +2 -2
  6. package/dist-cjs/commands/CreateDatasetCommand.js +2 -2
  7. package/dist-cjs/commands/CreateFaceLivenessSessionCommand.js +45 -0
  8. package/dist-cjs/commands/CreateProjectCommand.js +2 -2
  9. package/dist-cjs/commands/CreateProjectVersionCommand.js +2 -2
  10. package/dist-cjs/commands/CreateStreamProcessorCommand.js +2 -2
  11. package/dist-cjs/commands/DeleteCollectionCommand.js +2 -2
  12. package/dist-cjs/commands/DeleteDatasetCommand.js +2 -2
  13. package/dist-cjs/commands/DeleteFacesCommand.js +2 -2
  14. package/dist-cjs/commands/DeleteProjectCommand.js +2 -2
  15. package/dist-cjs/commands/DeleteProjectPolicyCommand.js +2 -2
  16. package/dist-cjs/commands/DeleteProjectVersionCommand.js +2 -2
  17. package/dist-cjs/commands/DeleteStreamProcessorCommand.js +2 -2
  18. package/dist-cjs/commands/DescribeCollectionCommand.js +2 -2
  19. package/dist-cjs/commands/DescribeDatasetCommand.js +2 -2
  20. package/dist-cjs/commands/DescribeProjectVersionsCommand.js +2 -2
  21. package/dist-cjs/commands/DescribeProjectsCommand.js +2 -2
  22. package/dist-cjs/commands/DescribeStreamProcessorCommand.js +2 -2
  23. package/dist-cjs/commands/DetectCustomLabelsCommand.js +2 -2
  24. package/dist-cjs/commands/DetectFacesCommand.js +2 -2
  25. package/dist-cjs/commands/DetectLabelsCommand.js +2 -2
  26. package/dist-cjs/commands/DetectModerationLabelsCommand.js +2 -2
  27. package/dist-cjs/commands/DetectProtectiveEquipmentCommand.js +2 -2
  28. package/dist-cjs/commands/DetectTextCommand.js +2 -2
  29. package/dist-cjs/commands/DistributeDatasetEntriesCommand.js +2 -2
  30. package/dist-cjs/commands/GetCelebrityInfoCommand.js +2 -2
  31. package/dist-cjs/commands/GetCelebrityRecognitionCommand.js +2 -2
  32. package/dist-cjs/commands/GetContentModerationCommand.js +2 -2
  33. package/dist-cjs/commands/GetFaceDetectionCommand.js +2 -2
  34. package/dist-cjs/commands/GetFaceLivenessSessionResultsCommand.js +46 -0
  35. package/dist-cjs/commands/GetFaceSearchCommand.js +2 -2
  36. package/dist-cjs/commands/GetLabelDetectionCommand.js +2 -2
  37. package/dist-cjs/commands/GetPersonTrackingCommand.js +2 -2
  38. package/dist-cjs/commands/GetSegmentDetectionCommand.js +2 -2
  39. package/dist-cjs/commands/GetTextDetectionCommand.js +2 -2
  40. package/dist-cjs/commands/IndexFacesCommand.js +2 -2
  41. package/dist-cjs/commands/ListCollectionsCommand.js +2 -2
  42. package/dist-cjs/commands/ListDatasetEntriesCommand.js +2 -2
  43. package/dist-cjs/commands/ListDatasetLabelsCommand.js +2 -2
  44. package/dist-cjs/commands/ListFacesCommand.js +2 -2
  45. package/dist-cjs/commands/ListProjectPoliciesCommand.js +2 -2
  46. package/dist-cjs/commands/ListStreamProcessorsCommand.js +2 -2
  47. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -2
  48. package/dist-cjs/commands/PutProjectPolicyCommand.js +2 -2
  49. package/dist-cjs/commands/RecognizeCelebritiesCommand.js +2 -2
  50. package/dist-cjs/commands/SearchFacesByImageCommand.js +2 -2
  51. package/dist-cjs/commands/SearchFacesCommand.js +2 -2
  52. package/dist-cjs/commands/StartCelebrityRecognitionCommand.js +2 -2
  53. package/dist-cjs/commands/StartContentModerationCommand.js +2 -2
  54. package/dist-cjs/commands/StartFaceDetectionCommand.js +2 -2
  55. package/dist-cjs/commands/StartFaceSearchCommand.js +2 -2
  56. package/dist-cjs/commands/StartLabelDetectionCommand.js +2 -2
  57. package/dist-cjs/commands/StartPersonTrackingCommand.js +2 -2
  58. package/dist-cjs/commands/StartProjectVersionCommand.js +2 -2
  59. package/dist-cjs/commands/StartSegmentDetectionCommand.js +2 -2
  60. package/dist-cjs/commands/StartStreamProcessorCommand.js +2 -2
  61. package/dist-cjs/commands/StartTextDetectionCommand.js +2 -2
  62. package/dist-cjs/commands/StopProjectVersionCommand.js +2 -2
  63. package/dist-cjs/commands/StopStreamProcessorCommand.js +2 -2
  64. package/dist-cjs/commands/TagResourceCommand.js +2 -2
  65. package/dist-cjs/commands/UntagResourceCommand.js +2 -2
  66. package/dist-cjs/commands/UpdateDatasetEntriesCommand.js +2 -2
  67. package/dist-cjs/commands/UpdateStreamProcessorCommand.js +2 -2
  68. package/dist-cjs/commands/index.js +2 -0
  69. package/dist-cjs/endpoint/ruleset.js +3 -3
  70. package/dist-cjs/models/index.js +1 -0
  71. package/dist-cjs/models/models_0.js +36 -2
  72. package/dist-cjs/models/models_1.js +2 -0
  73. package/dist-cjs/protocols/Aws_json1_1.js +1883 -1773
  74. package/dist-es/Rekognition.js +30 -0
  75. package/dist-es/commands/CompareFacesCommand.js +3 -3
  76. package/dist-es/commands/CopyProjectVersionCommand.js +3 -3
  77. package/dist-es/commands/CreateCollectionCommand.js +3 -3
  78. package/dist-es/commands/CreateDatasetCommand.js +3 -3
  79. package/dist-es/commands/CreateFaceLivenessSessionCommand.js +41 -0
  80. package/dist-es/commands/CreateProjectCommand.js +3 -3
  81. package/dist-es/commands/CreateProjectVersionCommand.js +3 -3
  82. package/dist-es/commands/CreateStreamProcessorCommand.js +3 -3
  83. package/dist-es/commands/DeleteCollectionCommand.js +3 -3
  84. package/dist-es/commands/DeleteDatasetCommand.js +3 -3
  85. package/dist-es/commands/DeleteFacesCommand.js +3 -3
  86. package/dist-es/commands/DeleteProjectCommand.js +3 -3
  87. package/dist-es/commands/DeleteProjectPolicyCommand.js +3 -3
  88. package/dist-es/commands/DeleteProjectVersionCommand.js +3 -3
  89. package/dist-es/commands/DeleteStreamProcessorCommand.js +3 -3
  90. package/dist-es/commands/DescribeCollectionCommand.js +3 -3
  91. package/dist-es/commands/DescribeDatasetCommand.js +3 -3
  92. package/dist-es/commands/DescribeProjectVersionsCommand.js +3 -3
  93. package/dist-es/commands/DescribeProjectsCommand.js +3 -3
  94. package/dist-es/commands/DescribeStreamProcessorCommand.js +3 -3
  95. package/dist-es/commands/DetectCustomLabelsCommand.js +3 -3
  96. package/dist-es/commands/DetectFacesCommand.js +3 -3
  97. package/dist-es/commands/DetectLabelsCommand.js +3 -3
  98. package/dist-es/commands/DetectModerationLabelsCommand.js +3 -3
  99. package/dist-es/commands/DetectProtectiveEquipmentCommand.js +3 -3
  100. package/dist-es/commands/DetectTextCommand.js +3 -3
  101. package/dist-es/commands/DistributeDatasetEntriesCommand.js +3 -3
  102. package/dist-es/commands/GetCelebrityInfoCommand.js +3 -3
  103. package/dist-es/commands/GetCelebrityRecognitionCommand.js +3 -3
  104. package/dist-es/commands/GetContentModerationCommand.js +3 -3
  105. package/dist-es/commands/GetFaceDetectionCommand.js +3 -3
  106. package/dist-es/commands/GetFaceLivenessSessionResultsCommand.js +42 -0
  107. package/dist-es/commands/GetFaceSearchCommand.js +3 -3
  108. package/dist-es/commands/GetLabelDetectionCommand.js +3 -3
  109. package/dist-es/commands/GetPersonTrackingCommand.js +3 -3
  110. package/dist-es/commands/GetSegmentDetectionCommand.js +3 -3
  111. package/dist-es/commands/GetTextDetectionCommand.js +3 -3
  112. package/dist-es/commands/IndexFacesCommand.js +3 -3
  113. package/dist-es/commands/ListCollectionsCommand.js +3 -3
  114. package/dist-es/commands/ListDatasetEntriesCommand.js +3 -3
  115. package/dist-es/commands/ListDatasetLabelsCommand.js +3 -3
  116. package/dist-es/commands/ListFacesCommand.js +3 -3
  117. package/dist-es/commands/ListProjectPoliciesCommand.js +3 -3
  118. package/dist-es/commands/ListStreamProcessorsCommand.js +3 -3
  119. package/dist-es/commands/ListTagsForResourceCommand.js +3 -3
  120. package/dist-es/commands/PutProjectPolicyCommand.js +3 -3
  121. package/dist-es/commands/RecognizeCelebritiesCommand.js +3 -3
  122. package/dist-es/commands/SearchFacesByImageCommand.js +3 -3
  123. package/dist-es/commands/SearchFacesCommand.js +3 -3
  124. package/dist-es/commands/StartCelebrityRecognitionCommand.js +3 -3
  125. package/dist-es/commands/StartContentModerationCommand.js +3 -3
  126. package/dist-es/commands/StartFaceDetectionCommand.js +3 -3
  127. package/dist-es/commands/StartFaceSearchCommand.js +3 -3
  128. package/dist-es/commands/StartLabelDetectionCommand.js +3 -3
  129. package/dist-es/commands/StartPersonTrackingCommand.js +3 -3
  130. package/dist-es/commands/StartProjectVersionCommand.js +3 -3
  131. package/dist-es/commands/StartSegmentDetectionCommand.js +3 -3
  132. package/dist-es/commands/StartStreamProcessorCommand.js +3 -3
  133. package/dist-es/commands/StartTextDetectionCommand.js +3 -3
  134. package/dist-es/commands/StopProjectVersionCommand.js +3 -3
  135. package/dist-es/commands/StopStreamProcessorCommand.js +3 -3
  136. package/dist-es/commands/TagResourceCommand.js +3 -3
  137. package/dist-es/commands/UntagResourceCommand.js +3 -3
  138. package/dist-es/commands/UpdateDatasetEntriesCommand.js +3 -3
  139. package/dist-es/commands/UpdateStreamProcessorCommand.js +3 -3
  140. package/dist-es/commands/index.js +2 -0
  141. package/dist-es/endpoint/ruleset.js +3 -3
  142. package/dist-es/models/index.js +1 -0
  143. package/dist-es/models/models_0.js +31 -0
  144. package/dist-es/models/models_1.js +1 -0
  145. package/dist-es/protocols/Aws_json1_1.js +1751 -1645
  146. package/dist-types/Rekognition.d.ts +51 -10
  147. package/dist-types/RekognitionClient.d.ts +4 -2
  148. package/dist-types/commands/CopyProjectVersionCommand.d.ts +1 -0
  149. package/dist-types/commands/CreateFaceLivenessSessionCommand.d.ts +94 -0
  150. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +17 -7
  151. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +1 -0
  152. package/dist-types/commands/DetectLabelsCommand.d.ts +2 -3
  153. package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts +88 -0
  154. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +1 -0
  155. package/dist-types/commands/PutProjectPolicyCommand.d.ts +1 -0
  156. package/dist-types/commands/StopProjectVersionCommand.d.ts +1 -0
  157. package/dist-types/commands/UpdateStreamProcessorCommand.d.ts +4 -1
  158. package/dist-types/commands/index.d.ts +2 -0
  159. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  160. package/dist-types/models/index.d.ts +1 -0
  161. package/dist-types/models/models_0.d.ts +241 -106
  162. package/dist-types/models/models_1.d.ts +56 -0
  163. package/dist-types/protocols/Aws_json1_1.d.ts +522 -126
  164. package/dist-types/ts3.4/Rekognition.d.ts +34 -0
  165. package/dist-types/ts3.4/RekognitionClient.d.ts +12 -0
  166. package/dist-types/ts3.4/commands/CreateFaceLivenessSessionCommand.d.ts +41 -0
  167. package/dist-types/ts3.4/commands/GetFaceLivenessSessionResultsCommand.d.ts +41 -0
  168. package/dist-types/ts3.4/commands/UpdateStreamProcessorCommand.d.ts +1 -1
  169. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  170. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  171. package/dist-types/ts3.4/models/index.d.ts +1 -0
  172. package/dist-types/ts3.4/models/models_0.d.ts +59 -17
  173. package/dist-types/ts3.4/models/models_1.d.ts +17 -0
  174. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +150 -126
  175. package/package.json +36 -36
@@ -3,6 +3,7 @@ import { CompareFacesCommandInput, CompareFacesCommandOutput } from "./commands/
3
3
  import { CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput } from "./commands/CopyProjectVersionCommand";
4
4
  import { CreateCollectionCommandInput, CreateCollectionCommandOutput } from "./commands/CreateCollectionCommand";
5
5
  import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
6
+ import { CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput } from "./commands/CreateFaceLivenessSessionCommand";
6
7
  import { CreateProjectCommandInput, CreateProjectCommandOutput } from "./commands/CreateProjectCommand";
7
8
  import { CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput } from "./commands/CreateProjectVersionCommand";
8
9
  import { CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput } from "./commands/CreateStreamProcessorCommand";
@@ -29,6 +30,7 @@ import { GetCelebrityInfoCommandInput, GetCelebrityInfoCommandOutput } from "./c
29
30
  import { GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput } from "./commands/GetCelebrityRecognitionCommand";
30
31
  import { GetContentModerationCommandInput, GetContentModerationCommandOutput } from "./commands/GetContentModerationCommand";
31
32
  import { GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput } from "./commands/GetFaceDetectionCommand";
33
+ import { GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput } from "./commands/GetFaceLivenessSessionResultsCommand";
32
34
  import { GetFaceSearchCommandInput, GetFaceSearchCommandOutput } from "./commands/GetFaceSearchCommand";
33
35
  import { GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput } from "./commands/GetLabelDetectionCommand";
34
36
  import { GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput } from "./commands/GetPersonTrackingCommand";
@@ -469,6 +471,7 @@ export declare class Rekognition extends RekognitionClient {
469
471
  * <p>Copying a model version takes a while to complete. To get the current status, call <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the
470
472
  * <a>ProjectVersionDescription</a> object. The copy operation has finished when
471
473
  * the value of <code>Status</code> is <code>COPYING_COMPLETED</code>.</p>
474
+ * <p>This operation requires permissions to perform the <code>rekognition:CopyProjectVersion</code> action.</p>
472
475
  */
473
476
  copyProjectVersion(args: CopyProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<CopyProjectVersionCommandOutput>;
474
477
  copyProjectVersion(args: CopyProjectVersionCommandInput, cb: (err: any, data?: CopyProjectVersionCommandOutput) => void): void;
@@ -519,6 +522,19 @@ export declare class Rekognition extends RekognitionClient {
519
522
  createDataset(args: CreateDatasetCommandInput, options?: __HttpHandlerOptions): Promise<CreateDatasetCommandOutput>;
520
523
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
521
524
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
525
+ /**
526
+ * @public
527
+ * <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>,
528
+ * which you can use to start streaming Face Liveness video and get the results for a Face
529
+ * Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter
530
+ * to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and
531
+ * audit images. You can use <code>AuditImagesLimit</code> to limit of audit images returned.
532
+ * This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based
533
+ * on the duration of the selfie-video. </p>
534
+ */
535
+ createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaceLivenessSessionCommandOutput>;
536
+ createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void): void;
537
+ createFaceLivenessSession(args: CreateFaceLivenessSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaceLivenessSessionCommandOutput) => void): void;
522
538
  /**
523
539
  * @public
524
540
  * <p>Creates a new Amazon Rekognition Custom Labels project. A project is a group of resources (datasets, model versions)
@@ -570,15 +586,25 @@ export declare class Rekognition extends RekognitionClient {
570
586
  * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
571
587
  * <ul>
572
588
  * <li>
573
- * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
574
- * face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
575
- * stop processing.</p>
589
+ * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream
590
+ * (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream for receiving
591
+ * the output. You must use the <code>FaceSearch</code> option in
592
+ * <code>Settings</code>, specifying the collection that contains the faces you
593
+ * want to recognize. After you have finished analyzing a streaming video, use
594
+ * <a>StopStreamProcessor</a> to stop processing.</p>
576
595
  * </li>
577
596
  * <li>
578
- * <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
579
- * Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.
580
- * You specify what you want to detect in <code>ConnectedHomeSettings</code>, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>.
581
- * When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
597
+ * <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream
598
+ * (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
599
+ * Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS
600
+ * key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want
601
+ * to detect by using the <code>ConnectedHome</code> option in settings, and
602
+ * selecting one of the following: <code>PERSON</code>, <code>PET</code>,
603
+ * <code>PACKAGE</code>, <code>ALL</code> You can also specify where in the
604
+ * frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>. When
605
+ * you run the <a>StartStreamProcessor</a> operation on a label
606
+ * detection stream processor, you input start and stop information to determine
607
+ * the length of the processing time.</p>
582
608
  * </li>
583
609
  * </ul>
584
610
  * <p>
@@ -647,6 +673,7 @@ export declare class Rekognition extends RekognitionClient {
647
673
  * @public
648
674
  * <p>Deletes an existing project policy.</p>
649
675
  * <p>To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. To attach a project policy to a project, call <a>PutProjectPolicy</a>.</p>
676
+ * <p>This operation requires permissions to perform the <code>rekognition:DeleteProjectPolicy</code> action.</p>
650
677
  */
651
678
  deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteProjectPolicyCommandOutput>;
652
679
  deleteProjectPolicy(args: DeleteProjectPolicyCommandInput, cb: (err: any, data?: DeleteProjectPolicyCommandOutput) => void): void;
@@ -817,7 +844,7 @@ export declare class Rekognition extends RekognitionClient {
817
844
  * <b>Response Elements</b>
818
845
  * </p>
819
846
  * <p> For each object, scene, and concept the API returns one or more labels. The API
820
- * returns the following types of information regarding labels:</p>
847
+ * returns the following types of information about labels:</p>
821
848
  * <ul>
822
849
  * <li>
823
850
  * <p> Name - The name of the detected label. </p>
@@ -896,8 +923,7 @@ export declare class Rekognition extends RekognitionClient {
896
923
  * <p>If the object detected is a person, the operation doesn't provide the same facial
897
924
  * details that the <a>DetectFaces</a> operation provides.</p>
898
925
  * </note>
899
- * <p>This is a stateless API operation. That is, the operation does not persist any
900
- * data.</p>
926
+ * <p>This is a stateless API operation that doesn't return any data.</p>
901
927
  * <p>This operation requires permissions to perform the
902
928
  * <code>rekognition:DetectLabels</code> action. </p>
903
929
  */
@@ -1122,6 +1148,18 @@ export declare class Rekognition extends RekognitionClient {
1122
1148
  getFaceDetection(args: GetFaceDetectionCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceDetectionCommandOutput>;
1123
1149
  getFaceDetection(args: GetFaceDetectionCommandInput, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
1124
1150
  getFaceDetection(args: GetFaceDetectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceDetectionCommandOutput) => void): void;
1151
+ /**
1152
+ * @public
1153
+ * <p>Retrieves the results of a specific Face Liveness session. It requires the
1154
+ * <code>sessionId</code> as input, which was created using
1155
+ * <code>CreateFaceLivenessSession</code>. Returns the corresponding Face Liveness confidence
1156
+ * score, a reference image that includes a face bounding box, and audit images that also contain
1157
+ * face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference
1158
+ * image can optionally be returned.</p>
1159
+ */
1160
+ getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, options?: __HttpHandlerOptions): Promise<GetFaceLivenessSessionResultsCommandOutput>;
1161
+ getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void): void;
1162
+ getFaceLivenessSessionResults(args: GetFaceLivenessSessionResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetFaceLivenessSessionResultsCommandOutput) => void): void;
1125
1163
  /**
1126
1164
  * @public
1127
1165
  * <p>Gets the face search results for Amazon Rekognition Video face search started by
@@ -1471,6 +1509,7 @@ export declare class Rekognition extends RekognitionClient {
1471
1509
  * @public
1472
1510
  * <p>Gets a list of the project policies attached to a project.</p>
1473
1511
  * <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
1512
+ * <p>This operation requires permissions to perform the <code>rekognition:ListProjectPolicies</code> action.</p>
1474
1513
  */
1475
1514
  listProjectPolicies(args: ListProjectPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<ListProjectPoliciesCommandOutput>;
1476
1515
  listProjectPolicies(args: ListProjectPoliciesCommandInput, cb: (err: any, data?: ListProjectPoliciesCommandOutput) => void): void;
@@ -1507,6 +1546,7 @@ export declare class Rekognition extends RekognitionClient {
1507
1546
  * <p>To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.
1508
1547
  * To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. </p>
1509
1548
  * <p>You copy a model version by calling <a>CopyProjectVersion</a>.</p>
1549
+ * <p>This operation requires permissions to perform the <code>rekognition:PutProjectPolicy</code> action.</p>
1510
1550
  */
1511
1551
  putProjectPolicy(args: PutProjectPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutProjectPolicyCommandOutput>;
1512
1552
  putProjectPolicy(args: PutProjectPolicyCommandInput, cb: (err: any, data?: PutProjectPolicyCommandOutput) => void): void;
@@ -1789,6 +1829,7 @@ export declare class Rekognition extends RekognitionClient {
1789
1829
  * @public
1790
1830
  * <p>Stops a running model. The operation might take a while to complete. To
1791
1831
  * check the current status, call <a>DescribeProjectVersions</a>. </p>
1832
+ * <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
1792
1833
  */
1793
1834
  stopProjectVersion(args: StopProjectVersionCommandInput, options?: __HttpHandlerOptions): Promise<StopProjectVersionCommandOutput>;
1794
1835
  stopProjectVersion(args: StopProjectVersionCommandInput, cb: (err: any, data?: StopProjectVersionCommandOutput) => void): void;
@@ -11,6 +11,7 @@ import { CompareFacesCommandInput, CompareFacesCommandOutput } from "./commands/
11
11
  import { CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput } from "./commands/CopyProjectVersionCommand";
12
12
  import { CreateCollectionCommandInput, CreateCollectionCommandOutput } from "./commands/CreateCollectionCommand";
13
13
  import { CreateDatasetCommandInput, CreateDatasetCommandOutput } from "./commands/CreateDatasetCommand";
14
+ import { CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput } from "./commands/CreateFaceLivenessSessionCommand";
14
15
  import { CreateProjectCommandInput, CreateProjectCommandOutput } from "./commands/CreateProjectCommand";
15
16
  import { CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput } from "./commands/CreateProjectVersionCommand";
16
17
  import { CreateStreamProcessorCommandInput, CreateStreamProcessorCommandOutput } from "./commands/CreateStreamProcessorCommand";
@@ -37,6 +38,7 @@ import { GetCelebrityInfoCommandInput, GetCelebrityInfoCommandOutput } from "./c
37
38
  import { GetCelebrityRecognitionCommandInput, GetCelebrityRecognitionCommandOutput } from "./commands/GetCelebrityRecognitionCommand";
38
39
  import { GetContentModerationCommandInput, GetContentModerationCommandOutput } from "./commands/GetContentModerationCommand";
39
40
  import { GetFaceDetectionCommandInput, GetFaceDetectionCommandOutput } from "./commands/GetFaceDetectionCommand";
41
+ import { GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput } from "./commands/GetFaceLivenessSessionResultsCommand";
40
42
  import { GetFaceSearchCommandInput, GetFaceSearchCommandOutput } from "./commands/GetFaceSearchCommand";
41
43
  import { GetLabelDetectionCommandInput, GetLabelDetectionCommandOutput } from "./commands/GetLabelDetectionCommand";
42
44
  import { GetPersonTrackingCommandInput, GetPersonTrackingCommandOutput } from "./commands/GetPersonTrackingCommand";
@@ -74,11 +76,11 @@ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, Endpoi
74
76
  /**
75
77
  * @public
76
78
  */
77
- export type ServiceInputTypes = CompareFacesCommandInput | CopyProjectVersionCommandInput | CreateCollectionCommandInput | CreateDatasetCommandInput | CreateProjectCommandInput | CreateProjectVersionCommandInput | CreateStreamProcessorCommandInput | DeleteCollectionCommandInput | DeleteDatasetCommandInput | DeleteFacesCommandInput | DeleteProjectCommandInput | DeleteProjectPolicyCommandInput | DeleteProjectVersionCommandInput | DeleteStreamProcessorCommandInput | DescribeCollectionCommandInput | DescribeDatasetCommandInput | DescribeProjectVersionsCommandInput | DescribeProjectsCommandInput | DescribeStreamProcessorCommandInput | DetectCustomLabelsCommandInput | DetectFacesCommandInput | DetectLabelsCommandInput | DetectModerationLabelsCommandInput | DetectProtectiveEquipmentCommandInput | DetectTextCommandInput | DistributeDatasetEntriesCommandInput | GetCelebrityInfoCommandInput | GetCelebrityRecognitionCommandInput | GetContentModerationCommandInput | GetFaceDetectionCommandInput | GetFaceSearchCommandInput | GetLabelDetectionCommandInput | GetPersonTrackingCommandInput | GetSegmentDetectionCommandInput | GetTextDetectionCommandInput | IndexFacesCommandInput | ListCollectionsCommandInput | ListDatasetEntriesCommandInput | ListDatasetLabelsCommandInput | ListFacesCommandInput | ListProjectPoliciesCommandInput | ListStreamProcessorsCommandInput | ListTagsForResourceCommandInput | PutProjectPolicyCommandInput | RecognizeCelebritiesCommandInput | SearchFacesByImageCommandInput | SearchFacesCommandInput | StartCelebrityRecognitionCommandInput | StartContentModerationCommandInput | StartFaceDetectionCommandInput | StartFaceSearchCommandInput | StartLabelDetectionCommandInput | StartPersonTrackingCommandInput | StartProjectVersionCommandInput | StartSegmentDetectionCommandInput | StartStreamProcessorCommandInput | StartTextDetectionCommandInput | StopProjectVersionCommandInput | StopStreamProcessorCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetEntriesCommandInput | UpdateStreamProcessorCommandInput;
79
+ export type ServiceInputTypes = CompareFacesCommandInput | CopyProjectVersionCommandInput | CreateCollectionCommandInput | CreateDatasetCommandInput | CreateFaceLivenessSessionCommandInput | CreateProjectCommandInput | CreateProjectVersionCommandInput | CreateStreamProcessorCommandInput | DeleteCollectionCommandInput | DeleteDatasetCommandInput | DeleteFacesCommandInput | DeleteProjectCommandInput | DeleteProjectPolicyCommandInput | DeleteProjectVersionCommandInput | DeleteStreamProcessorCommandInput | DescribeCollectionCommandInput | DescribeDatasetCommandInput | DescribeProjectVersionsCommandInput | DescribeProjectsCommandInput | DescribeStreamProcessorCommandInput | DetectCustomLabelsCommandInput | DetectFacesCommandInput | DetectLabelsCommandInput | DetectModerationLabelsCommandInput | DetectProtectiveEquipmentCommandInput | DetectTextCommandInput | DistributeDatasetEntriesCommandInput | GetCelebrityInfoCommandInput | GetCelebrityRecognitionCommandInput | GetContentModerationCommandInput | GetFaceDetectionCommandInput | GetFaceLivenessSessionResultsCommandInput | GetFaceSearchCommandInput | GetLabelDetectionCommandInput | GetPersonTrackingCommandInput | GetSegmentDetectionCommandInput | GetTextDetectionCommandInput | IndexFacesCommandInput | ListCollectionsCommandInput | ListDatasetEntriesCommandInput | ListDatasetLabelsCommandInput | ListFacesCommandInput | ListProjectPoliciesCommandInput | ListStreamProcessorsCommandInput | ListTagsForResourceCommandInput | PutProjectPolicyCommandInput | RecognizeCelebritiesCommandInput | SearchFacesByImageCommandInput | SearchFacesCommandInput | StartCelebrityRecognitionCommandInput | StartContentModerationCommandInput | StartFaceDetectionCommandInput | StartFaceSearchCommandInput | StartLabelDetectionCommandInput | StartPersonTrackingCommandInput | StartProjectVersionCommandInput | StartSegmentDetectionCommandInput | StartStreamProcessorCommandInput | StartTextDetectionCommandInput | StopProjectVersionCommandInput | StopStreamProcessorCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDatasetEntriesCommandInput | UpdateStreamProcessorCommandInput;
78
80
  /**
79
81
  * @public
80
82
  */
81
- export type ServiceOutputTypes = CompareFacesCommandOutput | CopyProjectVersionCommandOutput | CreateCollectionCommandOutput | CreateDatasetCommandOutput | CreateProjectCommandOutput | CreateProjectVersionCommandOutput | CreateStreamProcessorCommandOutput | DeleteCollectionCommandOutput | DeleteDatasetCommandOutput | DeleteFacesCommandOutput | DeleteProjectCommandOutput | DeleteProjectPolicyCommandOutput | DeleteProjectVersionCommandOutput | DeleteStreamProcessorCommandOutput | DescribeCollectionCommandOutput | DescribeDatasetCommandOutput | DescribeProjectVersionsCommandOutput | DescribeProjectsCommandOutput | DescribeStreamProcessorCommandOutput | DetectCustomLabelsCommandOutput | DetectFacesCommandOutput | DetectLabelsCommandOutput | DetectModerationLabelsCommandOutput | DetectProtectiveEquipmentCommandOutput | DetectTextCommandOutput | DistributeDatasetEntriesCommandOutput | GetCelebrityInfoCommandOutput | GetCelebrityRecognitionCommandOutput | GetContentModerationCommandOutput | GetFaceDetectionCommandOutput | GetFaceSearchCommandOutput | GetLabelDetectionCommandOutput | GetPersonTrackingCommandOutput | GetSegmentDetectionCommandOutput | GetTextDetectionCommandOutput | IndexFacesCommandOutput | ListCollectionsCommandOutput | ListDatasetEntriesCommandOutput | ListDatasetLabelsCommandOutput | ListFacesCommandOutput | ListProjectPoliciesCommandOutput | ListStreamProcessorsCommandOutput | ListTagsForResourceCommandOutput | PutProjectPolicyCommandOutput | RecognizeCelebritiesCommandOutput | SearchFacesByImageCommandOutput | SearchFacesCommandOutput | StartCelebrityRecognitionCommandOutput | StartContentModerationCommandOutput | StartFaceDetectionCommandOutput | StartFaceSearchCommandOutput | StartLabelDetectionCommandOutput | StartPersonTrackingCommandOutput | StartProjectVersionCommandOutput | StartSegmentDetectionCommandOutput | StartStreamProcessorCommandOutput | StartTextDetectionCommandOutput | StopProjectVersionCommandOutput | StopStreamProcessorCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetEntriesCommandOutput | UpdateStreamProcessorCommandOutput;
83
+ export type ServiceOutputTypes = CompareFacesCommandOutput | CopyProjectVersionCommandOutput | CreateCollectionCommandOutput | CreateDatasetCommandOutput | CreateFaceLivenessSessionCommandOutput | CreateProjectCommandOutput | CreateProjectVersionCommandOutput | CreateStreamProcessorCommandOutput | DeleteCollectionCommandOutput | DeleteDatasetCommandOutput | DeleteFacesCommandOutput | DeleteProjectCommandOutput | DeleteProjectPolicyCommandOutput | DeleteProjectVersionCommandOutput | DeleteStreamProcessorCommandOutput | DescribeCollectionCommandOutput | DescribeDatasetCommandOutput | DescribeProjectVersionsCommandOutput | DescribeProjectsCommandOutput | DescribeStreamProcessorCommandOutput | DetectCustomLabelsCommandOutput | DetectFacesCommandOutput | DetectLabelsCommandOutput | DetectModerationLabelsCommandOutput | DetectProtectiveEquipmentCommandOutput | DetectTextCommandOutput | DistributeDatasetEntriesCommandOutput | GetCelebrityInfoCommandOutput | GetCelebrityRecognitionCommandOutput | GetContentModerationCommandOutput | GetFaceDetectionCommandOutput | GetFaceLivenessSessionResultsCommandOutput | GetFaceSearchCommandOutput | GetLabelDetectionCommandOutput | GetPersonTrackingCommandOutput | GetSegmentDetectionCommandOutput | GetTextDetectionCommandOutput | IndexFacesCommandOutput | ListCollectionsCommandOutput | ListDatasetEntriesCommandOutput | ListDatasetLabelsCommandOutput | ListFacesCommandOutput | ListProjectPoliciesCommandOutput | ListStreamProcessorsCommandOutput | ListTagsForResourceCommandOutput | PutProjectPolicyCommandOutput | RecognizeCelebritiesCommandOutput | SearchFacesByImageCommandOutput | SearchFacesCommandOutput | StartCelebrityRecognitionCommandOutput | StartContentModerationCommandOutput | StartFaceDetectionCommandOutput | StartFaceSearchCommandOutput | StartLabelDetectionCommandOutput | StartPersonTrackingCommandOutput | StartProjectVersionCommandOutput | StartSegmentDetectionCommandOutput | StartStreamProcessorCommandOutput | StartTextDetectionCommandOutput | StopProjectVersionCommandOutput | StopStreamProcessorCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDatasetEntriesCommandOutput | UpdateStreamProcessorCommandOutput;
82
84
  /**
83
85
  * @public
84
86
  */
@@ -38,6 +38,7 @@ export interface CopyProjectVersionCommandOutput extends CopyProjectVersionRespo
38
38
  * <p>Copying a model version takes a while to complete. To get the current status, call <a>DescribeProjectVersions</a> and check the value of <code>Status</code> in the
39
39
  * <a>ProjectVersionDescription</a> object. The copy operation has finished when
40
40
  * the value of <code>Status</code> is <code>COPYING_COMPLETED</code>.</p>
41
+ * <p>This operation requires permissions to perform the <code>rekognition:CopyProjectVersion</code> action.</p>
41
42
  * @example
42
43
  * Use a bare-bones client and the command you need to make an API call.
43
44
  * ```javascript
@@ -0,0 +1,94 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { CreateFaceLivenessSessionRequest, CreateFaceLivenessSessionResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link CreateFaceLivenessSessionCommand}.
10
+ */
11
+ export interface CreateFaceLivenessSessionCommandInput extends CreateFaceLivenessSessionRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link CreateFaceLivenessSessionCommand}.
17
+ */
18
+ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivenessSessionResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>,
23
+ * which you can use to start streaming Face Liveness video and get the results for a Face
24
+ * Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter
25
+ * to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and
26
+ * audit images. You can use <code>AuditImagesLimit</code> to limit of audit images returned.
27
+ * This number is between 0 and 4. By default, it is set to 0. The limit is best effort and based
28
+ * on the duration of the selfie-video. </p>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { RekognitionClient, CreateFaceLivenessSessionCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
33
+ * // const { RekognitionClient, CreateFaceLivenessSessionCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
34
+ * const client = new RekognitionClient(config);
35
+ * const input = { // CreateFaceLivenessSessionRequest
36
+ * KmsKeyId: "STRING_VALUE",
37
+ * Settings: { // CreateFaceLivenessSessionRequestSettings
38
+ * OutputConfig: { // LivenessOutputConfig
39
+ * S3Bucket: "STRING_VALUE", // required
40
+ * S3KeyPrefix: "STRING_VALUE",
41
+ * },
42
+ * AuditImagesLimit: Number("int"),
43
+ * },
44
+ * ClientRequestToken: "STRING_VALUE",
45
+ * };
46
+ * const command = new CreateFaceLivenessSessionCommand(input);
47
+ * const response = await client.send(command);
48
+ * ```
49
+ *
50
+ * @param CreateFaceLivenessSessionCommandInput - {@link CreateFaceLivenessSessionCommandInput}
51
+ * @returns {@link CreateFaceLivenessSessionCommandOutput}
52
+ * @see {@link CreateFaceLivenessSessionCommandInput} for command's `input` shape.
53
+ * @see {@link CreateFaceLivenessSessionCommandOutput} for command's `response` shape.
54
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
55
+ *
56
+ * @throws {@link AccessDeniedException} (client fault)
57
+ * <p>You are not authorized to perform the action.</p>
58
+ *
59
+ * @throws {@link InternalServerError} (server fault)
60
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
61
+ *
62
+ * @throws {@link InvalidParameterException} (client fault)
63
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
64
+ * operation again.</p>
65
+ *
66
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
67
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
68
+ * limit, contact Amazon Rekognition.</p>
69
+ *
70
+ * @throws {@link ThrottlingException} (server fault)
71
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
72
+ *
73
+ *
74
+ */
75
+ export declare class CreateFaceLivenessSessionCommand extends $Command<CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput, RekognitionClientResolvedConfig> {
76
+ readonly input: CreateFaceLivenessSessionCommandInput;
77
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
78
+ /**
79
+ * @public
80
+ */
81
+ constructor(input: CreateFaceLivenessSessionCommandInput);
82
+ /**
83
+ * @internal
84
+ */
85
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateFaceLivenessSessionCommandInput, CreateFaceLivenessSessionCommandOutput>;
86
+ /**
87
+ * @internal
88
+ */
89
+ private serialize;
90
+ /**
91
+ * @internal
92
+ */
93
+ private deserialize;
94
+ }
@@ -23,15 +23,25 @@ export interface CreateStreamProcessorCommandOutput extends CreateStreamProcesso
23
23
  * <p>Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. There are two different settings for stream processors in Amazon Rekognition: detecting faces and detecting labels.</p>
24
24
  * <ul>
25
25
  * <li>
26
- * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the
27
- * face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to
28
- * stop processing.</p>
26
+ * <p>If you are creating a stream processor for detecting faces, you provide as input a Kinesis video stream
27
+ * (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream for receiving
28
+ * the output. You must use the <code>FaceSearch</code> option in
29
+ * <code>Settings</code>, specifying the collection that contains the faces you
30
+ * want to recognize. After you have finished analyzing a streaming video, use
31
+ * <a>StopStreamProcessor</a> to stop processing.</p>
29
32
  * </li>
30
33
  * <li>
31
- * <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
32
- * Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS key ID to encrypt the data sent to your Amazon S3 bucket.
33
- * You specify what you want to detect in <code>ConnectedHomeSettings</code>, such as people, packages and people, or pets, people, and packages. You can also specify where in the frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>.
34
- * When you run the <a>StartStreamProcessor</a> operation on a label detection stream processor, you input start and stop information to determine the length of the processing time.</p>
34
+ * <p>If you are creating a stream processor to detect labels, you provide as input a Kinesis video stream
35
+ * (<code>Input</code>), Amazon S3 bucket information (<code>Output</code>), and an
36
+ * Amazon SNS topic ARN (<code>NotificationChannel</code>). You can also provide a KMS
37
+ * key ID to encrypt the data sent to your Amazon S3 bucket. You specify what you want
38
+ * to detect by using the <code>ConnectedHome</code> option in settings, and
39
+ * selecting one of the following: <code>PERSON</code>, <code>PET</code>,
40
+ * <code>PACKAGE</code>, <code>ALL</code> You can also specify where in the
41
+ * frame you want Amazon Rekognition to monitor with <code>RegionsOfInterest</code>. When
42
+ * you run the <a>StartStreamProcessor</a> operation on a label
43
+ * detection stream processor, you input start and stop information to determine
44
+ * the length of the processing time.</p>
35
45
  * </li>
36
46
  * </ul>
37
47
  * <p>
@@ -21,6 +21,7 @@ export interface DeleteProjectPolicyCommandOutput extends DeleteProjectPolicyRes
21
21
  * @public
22
22
  * <p>Deletes an existing project policy.</p>
23
23
  * <p>To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. To attach a project policy to a project, call <a>PutProjectPolicy</a>.</p>
24
+ * <p>This operation requires permissions to perform the <code>rekognition:DeleteProjectPolicy</code> action.</p>
24
25
  * @example
25
26
  * Use a bare-bones client and the command you need to make an API call.
26
27
  * ```javascript
@@ -49,7 +49,7 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
49
49
  * <b>Response Elements</b>
50
50
  * </p>
51
51
  * <p> For each object, scene, and concept the API returns one or more labels. The API
52
- * returns the following types of information regarding labels:</p>
52
+ * returns the following types of information about labels:</p>
53
53
  * <ul>
54
54
  * <li>
55
55
  * <p> Name - The name of the detected label. </p>
@@ -128,8 +128,7 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
128
128
  * <p>If the object detected is a person, the operation doesn't provide the same facial
129
129
  * details that the <a>DetectFaces</a> operation provides.</p>
130
130
  * </note>
131
- * <p>This is a stateless API operation. That is, the operation does not persist any
132
- * data.</p>
131
+ * <p>This is a stateless API operation that doesn't return any data.</p>
133
132
  * <p>This operation requires permissions to perform the
134
133
  * <code>rekognition:DetectLabels</code> action. </p>
135
134
  * @example
@@ -0,0 +1,88 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { GetFaceLivenessSessionResultsRequest, GetFaceLivenessSessionResultsResponse } from "../models/models_0";
5
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
+ /**
7
+ * @public
8
+ *
9
+ * The input for {@link GetFaceLivenessSessionResultsCommand}.
10
+ */
11
+ export interface GetFaceLivenessSessionResultsCommandInput extends GetFaceLivenessSessionResultsRequest {
12
+ }
13
+ /**
14
+ * @public
15
+ *
16
+ * The output of {@link GetFaceLivenessSessionResultsCommand}.
17
+ */
18
+ export interface GetFaceLivenessSessionResultsCommandOutput extends GetFaceLivenessSessionResultsResponse, __MetadataBearer {
19
+ }
20
+ /**
21
+ * @public
22
+ * <p>Retrieves the results of a specific Face Liveness session. It requires the
23
+ * <code>sessionId</code> as input, which was created using
24
+ * <code>CreateFaceLivenessSession</code>. Returns the corresponding Face Liveness confidence
25
+ * score, a reference image that includes a face bounding box, and audit images that also contain
26
+ * face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference
27
+ * image can optionally be returned.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { RekognitionClient, GetFaceLivenessSessionResultsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
32
+ * // const { RekognitionClient, GetFaceLivenessSessionResultsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
33
+ * const client = new RekognitionClient(config);
34
+ * const input = { // GetFaceLivenessSessionResultsRequest
35
+ * SessionId: "STRING_VALUE", // required
36
+ * };
37
+ * const command = new GetFaceLivenessSessionResultsCommand(input);
38
+ * const response = await client.send(command);
39
+ * ```
40
+ *
41
+ * @param GetFaceLivenessSessionResultsCommandInput - {@link GetFaceLivenessSessionResultsCommandInput}
42
+ * @returns {@link GetFaceLivenessSessionResultsCommandOutput}
43
+ * @see {@link GetFaceLivenessSessionResultsCommandInput} for command's `input` shape.
44
+ * @see {@link GetFaceLivenessSessionResultsCommandOutput} for command's `response` shape.
45
+ * @see {@link RekognitionClientResolvedConfig | config} for RekognitionClient's `config` shape.
46
+ *
47
+ * @throws {@link AccessDeniedException} (client fault)
48
+ * <p>You are not authorized to perform the action.</p>
49
+ *
50
+ * @throws {@link InternalServerError} (server fault)
51
+ * <p>Amazon Rekognition experienced a service issue. Try your call again.</p>
52
+ *
53
+ * @throws {@link InvalidParameterException} (client fault)
54
+ * <p>Input parameter violated a constraint. Validate your parameter before calling the API
55
+ * operation again.</p>
56
+ *
57
+ * @throws {@link ProvisionedThroughputExceededException} (client fault)
58
+ * <p>The number of requests exceeded your throughput limit. If you want to increase this
59
+ * limit, contact Amazon Rekognition.</p>
60
+ *
61
+ * @throws {@link SessionNotFoundException} (client fault)
62
+ * <p>Occurs when a given sessionId is not found.</p>
63
+ *
64
+ * @throws {@link ThrottlingException} (server fault)
65
+ * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
66
+ *
67
+ *
68
+ */
69
+ export declare class GetFaceLivenessSessionResultsCommand extends $Command<GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput, RekognitionClientResolvedConfig> {
70
+ readonly input: GetFaceLivenessSessionResultsCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ /**
73
+ * @public
74
+ */
75
+ constructor(input: GetFaceLivenessSessionResultsCommandInput);
76
+ /**
77
+ * @internal
78
+ */
79
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFaceLivenessSessionResultsCommandInput, GetFaceLivenessSessionResultsCommandOutput>;
80
+ /**
81
+ * @internal
82
+ */
83
+ private serialize;
84
+ /**
85
+ * @internal
86
+ */
87
+ private deserialize;
88
+ }
@@ -21,6 +21,7 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
21
21
  * @public
22
22
  * <p>Gets a list of the project policies attached to a project.</p>
23
23
  * <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
24
+ * <p>This operation requires permissions to perform the <code>rekognition:ListProjectPolicies</code> action.</p>
24
25
  * @example
25
26
  * Use a bare-bones client and the command you need to make an API call.
26
27
  * ```javascript
@@ -32,6 +32,7 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
32
32
  * <p>To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.
33
33
  * To get a list of project policies attached to a project, call <a>ListProjectPolicies</a>. </p>
34
34
  * <p>You copy a model version by calling <a>CopyProjectVersion</a>.</p>
35
+ * <p>This operation requires permissions to perform the <code>rekognition:PutProjectPolicy</code> action.</p>
35
36
  * @example
36
37
  * Use a bare-bones client and the command you need to make an API call.
37
38
  * ```javascript
@@ -21,6 +21,7 @@ export interface StopProjectVersionCommandOutput extends StopProjectVersionRespo
21
21
  * @public
22
22
  * <p>Stops a running model. The operation might take a while to complete. To
23
23
  * check the current status, call <a>DescribeProjectVersions</a>. </p>
24
+ * <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
24
25
  * @example
25
26
  * Use a bare-bones client and the command you need to make an API call.
26
27
  * ```javascript
@@ -1,7 +1,7 @@
1
1
  import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
2
  import { Command as $Command } from "@aws-sdk/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
- import { UpdateStreamProcessorRequest, UpdateStreamProcessorResponse } from "../models/models_0";
4
+ import { UpdateStreamProcessorRequest, UpdateStreamProcessorResponse } from "../models/models_1";
5
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
6
  /**
7
7
  * @public
@@ -85,6 +85,9 @@ export interface UpdateStreamProcessorCommandOutput extends UpdateStreamProcesso
85
85
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
86
86
  * limit, contact Amazon Rekognition.</p>
87
87
  *
88
+ * @throws {@link ResourceInUseException} (client fault)
89
+ * <p>The specified resource is already being used.</p>
90
+ *
88
91
  * @throws {@link ResourceNotFoundException} (client fault)
89
92
  * <p>The resource specified in the request cannot be found.</p>
90
93
  *
@@ -2,6 +2,7 @@ export * from "./CompareFacesCommand";
2
2
  export * from "./CopyProjectVersionCommand";
3
3
  export * from "./CreateCollectionCommand";
4
4
  export * from "./CreateDatasetCommand";
5
+ export * from "./CreateFaceLivenessSessionCommand";
5
6
  export * from "./CreateProjectCommand";
6
7
  export * from "./CreateProjectVersionCommand";
7
8
  export * from "./CreateStreamProcessorCommand";
@@ -28,6 +29,7 @@ export * from "./GetCelebrityInfoCommand";
28
29
  export * from "./GetCelebrityRecognitionCommand";
29
30
  export * from "./GetContentModerationCommand";
30
31
  export * from "./GetFaceDetectionCommand";
32
+ export * from "./GetFaceLivenessSessionResultsCommand";
31
33
  export * from "./GetFaceSearchCommand";
32
34
  export * from "./GetLabelDetectionCommand";
33
35
  export * from "./GetPersonTrackingCommand";
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export interface EndpointParameters extends __EndpointParameters {
15
- Region: string;
15
+ Region?: string;
16
16
  UseDualStack?: boolean;
17
17
  UseFIPS?: boolean;
18
18
  Endpoint?: string;
@@ -1 +1,2 @@
1
1
  export * from "./models_0";
2
+ export * from "./models_1";