@aws-sdk/client-rekognition 3.385.0 → 3.387.0

package/dist-types/commands/GetFaceDetectionCommand.d.ts

@@ -36,6 +36,8 @@ export interface GetFaceDetectionCommandOutput extends GetFaceDetectionResponse,
  *    specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set
  *    of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token
  *     value returned from the previous call to <code>GetFaceDetection</code>.</p>
+ *          <p>Note that for the <code>GetFaceDetection</code> operation, the returned values for
+ *         <code>FaceOccluded</code> and <code>EyeDirection</code> will always be "null".</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetFaceLivenessSessionResultsCommand.d.ts

@@ -27,8 +27,11 @@ export interface GetFaceLivenessSessionResultsCommandOutput extends GetFaceLiven
  *         <code>sessionId</code> as input, which was created using
  *         <code>CreateFaceLivenessSession</code>. Returns the corresponding Face Liveness confidence
  *       score, a reference image that includes a face bounding box, and audit images that also contain
- *       face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. The reference
- *       image can optionally be returned.</p>
+ *       face bounding boxes. The Face Liveness confidence score ranges from 0 to 100. </p>
+ *          <p>The number of audit images returned by <code>GetFaceLivenessSessionResults</code> is
+ *       defined by the <code>AuditImagesLimit</code> paramater when calling
+ *         <code>CreateFaceLivenessSession</code>. Reference images are always returned when
+ *       possible.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/GetTextDetectionCommand.d.ts

@@ -33,7 +33,7 @@ export interface GetTextDetectionCommandOutput extends GetTextDetectionResponse,
  *      of <code>StartLabelDetection</code>.</p>
  *          <p>
  *             <code>GetTextDetection</code> returns an array of detected text (<code>TextDetections</code>) sorted by
- *        the time the text was detected, up to 50 words per frame of video.</p>
+ *        the time the text was detected, up to 100 words per frame of video.</p>
  *          <p>Each element of the array includes the detected text, the precentage confidence in the acuracy
  *        of the detected text, the time the text was detected, bounding box information for where the text
  *        was located, and unique identifiers for words and their lines.</p>

package/dist-types/commands/ListDatasetEntriesCommand.d.ts

@@ -105,6 +105,33 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To list the entries in an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Lists the JSON line entries in an Amazon Rekognition Custom Labels dataset.
+ * const input = {
+ *   "ContainsLabels": [
+ *     "camellia"
+ *   ],
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
+ *   "HasErrors": true,
+ *   "Labeled": true,
+ *   "MaxResults": 100,
+ *   "NextToken": "",
+ *   "SourceRefContains": "camellia4.jpg"
+ * };
+ * const command = new ListDatasetEntriesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DatasetEntries": [
+ *     "{\"source-ref\":\"s3://custom-labels-console-us-east-1-1111111111/assets/flowers_1_train_dataset/camellia4.jpg\",\"camellia\":1,\"camellia-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/camellia\",\"class-name\":\"camellia\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:32:13.456Z\",\"type\":\"groundtruth/image-classification\"},\"cl-metadata\":{\"is_labeled\":true}}"
+ *   ],
+ *   "NextToken": ""
+ * }
+ * *\/
+ * // example id: to-list-the-entries-in-an-amazon-rekognition-custom-labels-dataset-1690823292345
+ * ```
+ *
  */
 export declare class ListDatasetEntriesCommand extends $Command<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListDatasetEntriesCommandInput;

package/dist-types/commands/ListDatasetLabelsCommand.d.ts

@@ -97,6 +97,43 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To list the entries in an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Lists the JSON line entries in an Amazon Rekognition Custom Labels dataset.
+ * const input = {
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106",
+ *   "MaxResults": 100,
+ *   "NextToken": ""
+ * };
+ * const command = new ListDatasetLabelsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DatasetLabelDescriptions": [
+ *     {
+ *       "LabelName": "camellia",
+ *       "LabelStats": {
+ *         "EntryCount": 1
+ *       }
+ *     },
+ *     {
+ *       "LabelName": "with_leaves",
+ *       "LabelStats": {
+ *         "EntryCount": 2
+ *       }
+ *     },
+ *     {
+ *       "LabelName": "mediterranean_spurge",
+ *       "LabelStats": {
+ *         "EntryCount": 1
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-the-entries-in-an-amazon-rekognition-custom-labels-dataset-1690823292345
+ * ```
+ *
  */
 export declare class ListDatasetLabelsCommand extends $Command<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: ListDatasetLabelsCommandInput;

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

@@ -29,9 +29,9 @@ export interface SearchUsersByImageCommandOutput extends SearchUsersByImageRespo
  *       ordered by similarity score with the highest similarity first. It also returns a bounding box
  *       for the face found in the input image. </p>
  *          <p>Information about faces detected in the supplied image, but not used for the search, is
- *       returned in an array of <code>UnsearchedFace</code> objects. If no valid face is detected
- *       in the image, the response will contain an empty <code>UserMatches</code> list and no
- *       <code>SearchedFace</code> object. </p>
+ *       returned in an array of <code>UnsearchedFace</code> objects. If no valid face is detected in
+ *       the image, the response will contain an empty <code>UserMatches</code> list and no
+ *         <code>SearchedFace</code> object. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/StartProjectVersionCommand.d.ts

@@ -90,6 +90,24 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To start an Amazon Rekognition Custom Labels model
+ * ```javascript
+ * // Starts a version of an Amazon Rekognition Custom Labels model.
+ * const input = {
+ *   "MaxInferenceUnits": 1,
+ *   "MinInferenceUnits": 1,
+ *   "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ * };
+ * const command = new StartProjectVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Status": "STARTING"
+ * }
+ * *\/
+ * // example id: to-start-an-amazon-rekognition-custom-labels-model-1690559168398
+ * ```
+ *
  */
 export declare class StartProjectVersionCommand extends $Command<StartProjectVersionCommandInput, StartProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: StartProjectVersionCommandInput;

package/dist-types/commands/StopProjectVersionCommand.d.ts

@@ -75,6 +75,22 @@ export interface StopProjectVersionCommandOutput extends StopProjectVersionRespo
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To stop an Amazon Rekognition Custom Labels model.
+ * ```javascript
+ * // Stops a version of an Amazon Rekognition Custom Labels model.
+ * const input = {
+ *   "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ * };
+ * const command = new StopProjectVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Status": "STOPPING"
+ * }
+ * *\/
+ * // example id: to-stop-an-amazon-rekognition-custom-labels-model-1690561110698
+ * ```
+ *
  */
 export declare class StopProjectVersionCommand extends $Command<StopProjectVersionCommandInput, StopProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: StopProjectVersionCommandInput;

package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts

@@ -100,6 +100,20 @@ export interface UpdateDatasetEntriesCommandOutput extends UpdateDatasetEntriesR
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To-add dataset entries to an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Adds dataset entries to an Amazon Rekognition Custom Labels dataset.
+ * const input = {
+ *   "Changes": {
+ *     "GroundTruth": "{\"source-ref\":\"s3://custom-labels-console-us-east-1-111111111/assets/flowers_1_test_dataset/mediterranean_spurge4.jpg\",\"mediterranean_spurge\":1,\"mediterranean_spurge-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/mediterranean_spurge\",\"class-name\":\"mediterranean_spurge\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"},\"with_leaves\":1,\"with_leaves-metadata\":{\"confidence\":1,\"job-name\":\"labeling-job/with_leaves\",\"class-name\":\"with_leaves\",\"human-annotated\":\"yes\",\"creation-date\":\"2021-07-11T03:33:42.025Z\",\"type\":\"groundtruth/image-classification\"}}"
+ *   },
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106"
+ * };
+ * const command = new UpdateDatasetEntriesCommand(input);
+ * await client.send(command);
+ * // example id: to-add-dataset-entries-to-an-amazon-rekognition-custom-labels-dataset-1690816977073
+ * ```
+ *
  */
 export declare class UpdateDatasetEntriesCommand extends $Command<UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: UpdateDatasetEntriesCommandInput;