@aws-sdk/client-rekognition 3.386.0 → 3.388.0

package/dist-cjs/RekognitionClient.js

@@ -15,8 +15,8 @@ Object.defineProperty(exports, "__Client", { enumerable: true, get: function ()
 const EndpointParameters_1 = require("./endpoint/EndpointParameters");
 const runtimeConfig_1 = require("./runtimeConfig");
 class RekognitionClient extends smithy_client_1.Client {
-    constructor(configuration) {
-        const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration);
+    constructor(...[configuration]) {
+        const _config_0 = (0, runtimeConfig_1.getRuntimeConfig)(configuration || {});
         const _config_1 = (0, EndpointParameters_1.resolveClientEndpointParameters)(_config_0);
         const _config_2 = (0, config_resolver_1.resolveRegionConfig)(_config_1);
         const _config_3 = (0, middleware_endpoint_1.resolveEndpointConfig)(_config_2);

package/dist-es/RekognitionClient.js

@@ -12,8 +12,8 @@ import { resolveClientEndpointParameters, } from "./endpoint/EndpointParameters"
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 export { __Client };
 export class RekognitionClient extends __Client {
-    constructor(configuration) {
-        const _config_0 = __getRuntimeConfig(configuration);
+    constructor(...[configuration]) {
+        const _config_0 = __getRuntimeConfig(configuration || {});
         const _config_1 = resolveClientEndpointParameters(_config_0);
         const _config_2 = resolveRegionConfig(_config_1);
         const _config_3 = resolveEndpointConfig(_config_2);

package/dist-types/RekognitionClient.d.ts

@@ -7,7 +7,7 @@ import { EndpointInputConfig, EndpointResolvedConfig } from "@smithy/middleware-
 import { RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry";
 import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
 import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
-import { BodyLengthCalculator as __BodyLengthCalculator, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
+import { BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
 import { AssociateFacesCommandInput, AssociateFacesCommandOutput } from "./commands/AssociateFacesCommand";
 import { CompareFacesCommandInput, CompareFacesCommandOutput } from "./commands/CompareFacesCommand";
 import { CopyProjectVersionCommandInput, CopyProjectVersionCommandOutput } from "./commands/CopyProjectVersionCommand";
@@ -582,7 +582,7 @@ export declare class RekognitionClient extends __Client<__HttpHandlerOptions, Se
      * The resolved configuration of RekognitionClient class. This is resolved and normalized from the {@link RekognitionClientConfig | constructor configuration interface}.
      */
     readonly config: RekognitionClientResolvedConfig;
-    constructor(configuration: RekognitionClientConfig);
+    constructor(...[configuration]: __CheckOptionalClientConfig<RekognitionClientConfig>);
     /**
      * Destroy underlying resources, like sockets. It's usually not necessary to do this.
      * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed.

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

@@ -110,6 +110,31 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To create an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Creates an Amazon Rekognition Custom Labels dataset with a manifest file stored in an Amazon S3 bucket.
+ * const input = {
+ *   "DatasetSource": {
+ *     "GroundTruthManifest": {
+ *       "S3Object": {
+ *         "Bucket": "my-bucket",
+ *         "Name": "datasets/flowers_training/manifests/output/output.manifest"
+ *       }
+ *     }
+ *   },
+ *   "DatasetType": "TRAIN",
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815"
+ * };
+ * const command = new CreateDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535"
+ * }
+ * *\/
+ * // example id: to-create-an-amazon-rekognition-custom-labels-dataset-1690476237145
+ * ```
+ *
  */
 export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CreateDatasetCommandInput;

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

@@ -77,6 +77,22 @@ export interface CreateProjectCommandOutput extends CreateProjectResponse, __Met
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To create an Amazon Rekognition Custom Labels project
+ * ```javascript
+ * // Creates an Amazon Rekognition Custom Labels project.
+ * const input = {
+ *   "ProjectName": "my-project"
+ * };
+ * const command = new CreateProjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
+ * }
+ * *\/
+ * // example id: to-create-an-amazon-rekognition-custom-labels-project-1690405898597
+ * ```
+ *
  */
 export declare class CreateProjectCommand extends $Command<CreateProjectCommandInput, CreateProjectCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CreateProjectCommandInput;

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

@@ -148,6 +148,27 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To train an Amazon Rekognition Custom Labels model
+ * ```javascript
+ * // Trains a version of an Amazon Rekognition Custom Labels model.
+ * const input = {
+ *   "OutputConfig": {
+ *     "S3Bucket": "output_bucket",
+ *     "S3KeyPrefix": "output_folder"
+ *   },
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
+ *   "VersionName": "1"
+ * };
+ * const command = new CreateProjectVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958"
+ * }
+ * *\/
+ * // example id: to-train-an-amazon-rekognition-custom-labels-model-1690555832843
+ * ```
+ *
  */
 export declare class CreateProjectVersionCommand extends $Command<CreateProjectVersionCommandInput, CreateProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: CreateProjectVersionCommandInput;

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

@@ -85,6 +85,17 @@ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __Met
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To delete an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Deletes an Amazon Rekognition Custom Labels dataset.
+ * const input = {
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1690556733321"
+ * };
+ * const command = new DeleteDatasetCommand(input);
+ * await client.send(command);
+ * // example id: to-delete-an-amazon-rekognition-custom-labels-dataset-1690826556349
+ * ```
+ *
  */
 export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteDatasetCommandInput;

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

@@ -81,6 +81,22 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To delete an Amazon Rekognition Custom Labels project
+ * ```javascript
+ * // Deletes an Amazon Rekognition Custom Labels projects.
+ * const input = {
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690405809285"
+ * };
+ * const command = new DeleteProjectCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Status": "DELETING"
+ * }
+ * *\/
+ * // example id: to-delete-an-amazon-rekognition-custom-labels-project-1690409093478
+ * ```
+ *
  */
 export declare class DeleteProjectCommand extends $Command<DeleteProjectCommandInput, DeleteProjectCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteProjectCommandInput;

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

@@ -80,6 +80,22 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To delete an Amazon Rekognition Custom Labels model
+ * ```javascript
+ * // Deletes 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 DeleteProjectVersionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Status": "DELETING"
+ * }
+ * *\/
+ * // example id: to-delete-an-amazon-rekognition-custom-labels-model-1690827562055
+ * ```
+ *
  */
 export declare class DeleteProjectVersionCommand extends $Command<DeleteProjectVersionCommandInput, DeleteProjectVersionCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DeleteProjectVersionCommandInput;

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

@@ -86,6 +86,34 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To describe an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Describes an Amazon Rekognition Custom Labels dataset.
+ * const input = {
+ *   "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1690476084535"
+ * };
+ * const command = new DescribeDatasetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DatasetDescription": {
+ *     "CreationTimestamp": "2023-07-27T09:41:24.738000-07:00",
+ *     "DatasetStats": {
+ *       "ErrorEntries": 0,
+ *       "LabeledEntries": 15,
+ *       "TotalEntries": 15,
+ *       "TotalLabels": 9
+ *     },
+ *     "LastUpdatedTimestamp": "2023-07-28T09:46:45.406000-07:00",
+ *     "Status": "UPDATE_FAILED",
+ *     "StatusMessage": "The manifest file contains images from multiple S3 buckets.",
+ *     "StatusMessageCode": "CLIENT_ERROR"
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-an-amazon-rekognition-custom-labels-dataset-1690827075604
+ * ```
+ *
  */
 export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DescribeDatasetCommandInput;

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

@@ -181,6 +181,111 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To describe an Amazon Rekognition Custom Labels model
+ * ```javascript
+ * // Describes a version of an Amazon Rekognition Custom Labels model.
+ * const input = {
+ *   "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1690474772815",
+ *   "VersionNames": [
+ *     "1"
+ *   ]
+ * };
+ * const command = new DescribeProjectVersionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "NextToken": "",
+ *   "ProjectVersionDescriptions": [
+ *     {
+ *       "BillableTrainingTimeInSeconds": 1899,
+ *       "CreationTimestamp": "2023-07-28T08:05:51.958000-07:00",
+ *       "EvaluationResult": {
+ *         "F1Score": 1,
+ *         "Summary": {
+ *           "S3Object": {
+ *             "Bucket": "custom-labels-console-us-east-1-111111111",
+ *             "Name": "my-model-output/EvaluationResultSummary-my-project-1.json"
+ *           }
+ *         }
+ *       },
+ *       "ManifestSummary": {
+ *         "S3Object": {
+ *           "Bucket": "custom-labels-console-us-east-1-111111111",
+ *           "Name": "my-model-output/ManifestSummary-my-project-1.json"
+ *         }
+ *       },
+ *       "OutputConfig": {
+ *         "S3Bucket": "custom-labels-console-us-east-1-111111111",
+ *         "S3KeyPrefix": "my-model-output"
+ *       },
+ *       "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/1/1690556751958",
+ *       "Status": "TRAINING_COMPLETED",
+ *       "StatusMessage": "The model is ready to run.",
+ *       "TestingDataResult": {
+ *         "Input": {
+ *           "AutoCreate": false
+ *         },
+ *         "Output": {
+ *           "Assets": [
+ *             {
+ *               "GroundTruthManifest": {
+ *                 "S3Object": {
+ *                   "Bucket": "custom-labels-console-us-east-1-111111111",
+ *                   "Name": "my-model-output/TestingGroundTruth-my-project-1.json"
+ *                 }
+ *               }
+ *             }
+ *           ],
+ *           "AutoCreate": false
+ *         },
+ *         "Validation": {
+ *           "Assets": [
+ *             {
+ *               "GroundTruthManifest": {
+ *                 "S3Object": {
+ *                   "Bucket": "custom-labels-console-us-east-1-111111111",
+ *                   "Name": "my-model-output/TestingManifestWithValidation-my-project-1.json"
+ *                 }
+ *               }
+ *             }
+ *           ]
+ *         }
+ *       },
+ *       "TrainingDataResult": {
+ *         "Input": {},
+ *         "Output": {
+ *           "Assets": [
+ *             {
+ *               "GroundTruthManifest": {
+ *                 "S3Object": {
+ *                   "Bucket": "custom-labels-console-us-east-1-111111111",
+ *                   "Name": "my-model-output/TrainingGroundTruth-my-project-1.json"
+ *                 }
+ *               }
+ *             }
+ *           ]
+ *         },
+ *         "Validation": {
+ *           "Assets": [
+ *             {
+ *               "GroundTruthManifest": {
+ *                 "S3Object": {
+ *                   "Bucket": "custom-labels-console-us-east-1-111111111",
+ *                   "Name": "my-model-output/TrainingManifestWithValidation-my-project-1.json"
+ *                 }
+ *               }
+ *             }
+ *           ]
+ *         }
+ *       },
+ *       "TrainingEndTimestamp": "2023-07-28T08:33:10.827000-07:00"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describes-an-amazon-rekognition-custom-labels-model-1690558265950
+ * ```
+ *
  */
 export declare class DescribeProjectVersionsCommand extends $Command<DescribeProjectVersionsCommandInput, DescribeProjectVersionsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DescribeProjectVersionsCommandInput;

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

@@ -92,6 +92,48 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To describe an Amazon Rekognition Custom Labels project.
+ * ```javascript
+ * // Describes an Amazon Rekognition Custom Labels projects.
+ * const input = {
+ *   "ProjectNames": [
+ *     "my-project"
+ *   ]
+ * };
+ * const command = new DescribeProjectsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ProjectDescriptions": [
+ *     {
+ *       "CreationTimestamp": "2022-06-13T15:16:00.634000-07:00",
+ *       "Datasets": [
+ *         {
+ *           "CreationTimestamp": "2022-06-13T15:17:34.620000-07:00",
+ *           "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/test/1655158654491",
+ *           "DatasetType": "TEST",
+ *           "Status": "CREATE_COMPLETE",
+ *           "StatusMessage": "The dataset was successfully created from the manifest file.",
+ *           "StatusMessageCode": "SUCCESS"
+ *         },
+ *         {
+ *           "CreationTimestamp": "2022-06-13T15:17:50.118000-07:00",
+ *           "DatasetArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/dataset/train/1655158669954",
+ *           "DatasetType": "TRAIN",
+ *           "Status": "CREATE_COMPLETE",
+ *           "StatusMessage": "The dataset was successfully created from the manifest file.",
+ *           "StatusMessageCode": "SUCCESS"
+ *         }
+ *       ],
+ *       "ProjectArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/1655158560634",
+ *       "Status": "CREATED"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-an-amazon-rekognition-custom-labels-project-1690400952376
+ * ```
+ *
  */
 export declare class DescribeProjectsCommand extends $Command<DescribeProjectsCommandInput, DescribeProjectsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DescribeProjectsCommandInput;

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

@@ -152,6 +152,39 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To detect custom labels in an image with an Amazon Rekognition Custom Labels model
+ * ```javascript
+ * // Detects custom labels in an image with an Amazon Rekognition Custom Labels model
+ * const input = {
+ *   "Image": {
+ *     "S3Object": {
+ *       "Bucket": "custom-labels-console-us-east-1-1111111111",
+ *       "Name": "assets/flowers_1_test_dataset/camellia4.jpg"
+ *     }
+ *   },
+ *   "MaxResults": 100,
+ *   "MinConfidence": 50,
+ *   "ProjectVersionArn": "arn:aws:rekognition:us-east-1:111122223333:project/my-project/version/my-project.2023-07-31T11.49.37/1690829378219"
+ * };
+ * const command = new DetectCustomLabelsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomLabels": [
+ *     {
+ *       "Confidence": 67.56399536132812,
+ *       "Name": "with_leaves"
+ *     },
+ *     {
+ *       "Confidence": 50.65699768066406,
+ *       "Name": "without_leaves"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-detect-custom-labels-in-images-with-an-amazon-rekognition-custom-labels-model-1690832037913
+ * ```
+ *
  */
 export declare class DetectCustomLabelsCommand extends $Command<DetectCustomLabelsCommandInput, DetectCustomLabelsCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DetectCustomLabelsCommandInput;

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

@@ -87,6 +87,24 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
  * @throws {@link RekognitionServiceException}
  * <p>Base exception class for all service exceptions from Rekognition service.</p>
  *
+ * @example To distribute an Amazon Rekognition Custom Labels dataset
+ * ```javascript
+ * // Distributes an Amazon Rekognition Custom Labels training dataset to a test dataset.
+ * const input = {
+ *   "Datasets": [
+ *     {
+ *       "Arn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/train/1690564858106"
+ *     },
+ *     {
+ *       "Arn": "arn:aws:rekognition:us-east-1:111122223333:project/my-proj-2/dataset/test/1690564858106"
+ *     }
+ *   ]
+ * };
+ * const command = new DistributeDatasetEntriesCommand(input);
+ * await client.send(command);
+ * // example id: to-distribute-to-an-amazon-rekognition-custom-labels-dataset-1690816977073
+ * ```
+ *
  */
 export declare class DistributeDatasetEntriesCommand extends $Command<DistributeDatasetEntriesCommandInput, DistributeDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
     readonly input: DistributeDatasetEntriesCommandInput;

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/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;

package/dist-types/ts3.4/RekognitionClient.d.ts

@@ -32,6 +32,7 @@ import {
 } from "@smithy/smithy-client";
 import {
   BodyLengthCalculator as __BodyLengthCalculator,
+  CheckOptionalClientConfig as __CheckOptionalClientConfig,
   ChecksumConstructor as __ChecksumConstructor,
   Decoder as __Decoder,
   Encoder as __Encoder,
@@ -539,6 +540,8 @@ export declare class RekognitionClient extends __Client<
   RekognitionClientResolvedConfig
 > {
   readonly config: RekognitionClientResolvedConfig;
-  constructor(configuration: RekognitionClientConfig);
+  constructor(
+    ...[configuration]: __CheckOptionalClientConfig<RekognitionClientConfig>
+  );
   destroy(): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-rekognition",
   "description": "AWS SDK for JavaScript Rekognition Client for Node.js, Browser and React Native",
-  "version": "3.386.0",
+  "version": "3.388.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,40 +21,40 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.386.0",
-    "@aws-sdk/credential-provider-node": "3.386.0",
-    "@aws-sdk/middleware-host-header": "3.379.1",
-    "@aws-sdk/middleware-logger": "3.378.0",
-    "@aws-sdk/middleware-recursion-detection": "3.378.0",
-    "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.386.0",
-    "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.386.0",
-    "@aws-sdk/util-user-agent-browser": "3.378.0",
-    "@aws-sdk/util-user-agent-node": "3.378.0",
-    "@smithy/config-resolver": "^2.0.1",
-    "@smithy/fetch-http-handler": "^2.0.1",
-    "@smithy/hash-node": "^2.0.1",
-    "@smithy/invalid-dependency": "^2.0.1",
-    "@smithy/middleware-content-length": "^2.0.1",
-    "@smithy/middleware-endpoint": "^2.0.1",
-    "@smithy/middleware-retry": "^2.0.1",
-    "@smithy/middleware-serde": "^2.0.1",
+    "@aws-sdk/client-sts": "3.388.0",
+    "@aws-sdk/credential-provider-node": "3.388.0",
+    "@aws-sdk/middleware-host-header": "3.387.0",
+    "@aws-sdk/middleware-logger": "3.387.0",
+    "@aws-sdk/middleware-recursion-detection": "3.387.0",
+    "@aws-sdk/middleware-signing": "3.387.0",
+    "@aws-sdk/middleware-user-agent": "3.387.0",
+    "@aws-sdk/types": "3.387.0",
+    "@aws-sdk/util-endpoints": "3.387.0",
+    "@aws-sdk/util-user-agent-browser": "3.387.0",
+    "@aws-sdk/util-user-agent-node": "3.387.0",
+    "@smithy/config-resolver": "^2.0.2",
+    "@smithy/fetch-http-handler": "^2.0.2",
+    "@smithy/hash-node": "^2.0.2",
+    "@smithy/invalid-dependency": "^2.0.2",
+    "@smithy/middleware-content-length": "^2.0.2",
+    "@smithy/middleware-endpoint": "^2.0.2",
+    "@smithy/middleware-retry": "^2.0.2",
+    "@smithy/middleware-serde": "^2.0.2",
     "@smithy/middleware-stack": "^2.0.0",
-    "@smithy/node-config-provider": "^2.0.1",
-    "@smithy/node-http-handler": "^2.0.1",
-    "@smithy/protocol-http": "^2.0.1",
-    "@smithy/smithy-client": "^2.0.1",
-    "@smithy/types": "^2.0.2",
-    "@smithy/url-parser": "^2.0.1",
+    "@smithy/node-config-provider": "^2.0.2",
+    "@smithy/node-http-handler": "^2.0.2",
+    "@smithy/protocol-http": "^2.0.2",
+    "@smithy/smithy-client": "^2.0.2",
+    "@smithy/types": "^2.1.0",
+    "@smithy/url-parser": "^2.0.2",
     "@smithy/util-base64": "^2.0.0",
     "@smithy/util-body-length-browser": "^2.0.0",
     "@smithy/util-body-length-node": "^2.0.0",
-    "@smithy/util-defaults-mode-browser": "^2.0.1",
-    "@smithy/util-defaults-mode-node": "^2.0.1",
+    "@smithy/util-defaults-mode-browser": "^2.0.2",
+    "@smithy/util-defaults-mode-node": "^2.0.2",
     "@smithy/util-retry": "^2.0.0",
     "@smithy/util-utf8": "^2.0.0",
-    "@smithy/util-waiter": "^2.0.1",
+    "@smithy/util-waiter": "^2.0.2",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2"
   },