@aws-sdk/client-rekognition 3.385.0 → 3.387.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-cjs/endpoint/ruleset.js

@@ -3,5 +3,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ruleSet = void 0;
 const q = "required", r = "fn", s = "argv", t = "ref";
 const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
-const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
+const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
 exports.ruleSet = _data;

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-es/endpoint/ruleset.js

@@ -1,4 +1,4 @@
 const q = "required", r = "fn", s = "argv", t = "ref";
 const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = { [q]: false, "type": "String" }, g = { [q]: true, "default": false, "type": "Boolean" }, h = { [t]: "Endpoint" }, i = { [r]: "booleanEquals", [s]: [{ [t]: "UseFIPS" }, true] }, j = { [r]: "booleanEquals", [s]: [{ [t]: "UseDualStack" }, true] }, k = {}, l = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsFIPS"] }] }, m = { [r]: "booleanEquals", [s]: [true, { [r]: "getAttr", [s]: [{ [t]: e }, "supportsDualStack"] }] }, n = [i], o = [j], p = [{ [t]: "Region" }];
-const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
+const _data = { version: "1.0", parameters: { Region: f, UseDualStack: g, UseFIPS: g, Endpoint: f }, rules: [{ conditions: [{ [r]: a, [s]: [h] }], type: b, rules: [{ conditions: n, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: o, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: h, properties: k, headers: k }, type: d }] }, { conditions: [{ [r]: a, [s]: p }], type: b, rules: [{ conditions: [{ [r]: "aws.partition", [s]: p, assign: e }], type: b, rules: [{ conditions: [i, j], type: b, rules: [{ conditions: [l, m], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: n, type: b, rules: [{ conditions: [l], type: b, rules: [{ endpoint: { url: "https://rekognition-fips.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: o, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: k, headers: k }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { endpoint: { url: "https://rekognition.{Region}.{PartitionResult#dnsSuffix}", properties: k, headers: k }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
 export const ruleSet = _data;

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/AssociateFacesCommand.d.ts

@@ -102,9 +102,8 @@ export interface AssociateFacesCommandOutput extends AssociateFacesResponse, __M
  *  <p>You are not authorized to perform the action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>
- *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
- *     </p>
+ *  <p> A User with the same Id already exists within the collection, or the update or deletion
+ *       of the User caused an inconsistent state. ** </p>
  *
  * @throws {@link IdempotentParameterMismatchException} (client fault)
  *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input

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

@@ -25,9 +25,9 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
  * @public
  * <p>Creates a new Amazon Rekognition Custom Labels dataset. You can create a dataset by using
  *    an Amazon Sagemaker format manifest file or by copying an existing Amazon Rekognition Custom Labels dataset.</p>
- *          <p>To create a training dataset for a project, specify <code>train</code> for the value of
+ *          <p>To create a training dataset for a project, specify <code>TRAIN</code> for the value of
  *       <code>DatasetType</code>. To create the test dataset for a project,
- *       specify <code>test</code> for the value of <code>DatasetType</code>.
+ *       specify <code>TEST</code> for the value of <code>DatasetType</code>.
  *     </p>
  *          <p>The response from <code>CreateDataset</code> is the Amazon Resource Name (ARN) for the dataset.
  *    Creating a dataset takes a while to complete. Use <a>DescribeDataset</a> to check the
@@ -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/CreateFaceLivenessSessionCommand.d.ts

@@ -25,11 +25,14 @@ export interface CreateFaceLivenessSessionCommandOutput extends CreateFaceLivene
  * @public
  * <p>This API operation initiates a Face Liveness session. It returns a <code>SessionId</code>,
  *       which you can use to start streaming Face Liveness video and get the results for a Face
- *       Liveness session. You can use the <code>OutputConfig</code> option in the Settings parameter
- *       to provide an Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images.
- *       You can use <code>AuditImagesLimit</code> to limit the number of audit images returned.  This
- *       number is between 0 and 4. By default, it is set to 0. The limit is best effort and based on
- *       the duration of the selfie-video. </p>
+ *       Liveness session. </p>
+ *          <p>You can use the <code>OutputConfig</code> option in the Settings parameter to provide an
+ *       Amazon S3 bucket location. The Amazon S3 bucket stores reference images and audit images. If no Amazon S3
+ *       bucket is defined, raw bytes are sent instead. </p>
+ *          <p>You can use <code>AuditImagesLimit</code> to limit the number of audit images returned
+ *       when <code>GetFaceLivenessSessionResults</code> is called. This number is between 0 and 4. By
+ *       default, it is set to 0. The limit is best effort and based on the duration of the
+ *       selfie-video. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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/CreateUserCommand.d.ts

@@ -24,13 +24,13 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
 /**
  * @public
  * <p>Creates a new User within a collection specified by <code>CollectionId</code>. Takes
- *       <code>UserId</code> as a parameter, which is a user provided ID which should be unique
- *       within the collection. The provided <code>UserId</code> will alias the system generated
- *       UUID to make the <code>UserId</code> more user friendly. </p>
+ *         <code>UserId</code> as a parameter, which is a user provided ID which should be unique
+ *       within the collection. The provided <code>UserId</code> will alias the system generated UUID
+ *       to make the <code>UserId</code> more user friendly. </p>
  *          <p>Uses a <code>ClientToken</code>, an idempotency token that ensures a call to
- *       <code>CreateUser</code> completes only once. If the value is not supplied, the AWS SDK
- *       generates an idempotency token for the requests. This prevents retries after a network
- *       error results from making multiple <code>CreateUser</code> calls. </p>
+ *         <code>CreateUser</code> completes only once. If the value is not supplied, the AWS SDK
+ *       generates an idempotency token for the requests. This prevents retries after a network error
+ *       results from making multiple <code>CreateUser</code> calls. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -58,9 +58,8 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
  *  <p>You are not authorized to perform the action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>
- *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
- *     </p>
+ *  <p> A User with the same Id already exists within the collection, or the update or deletion
+ *       of the User caused an inconsistent state. ** </p>
  *
  * @throws {@link IdempotentParameterMismatchException} (client fault)
  *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input

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/DeleteUserCommand.d.ts

@@ -55,9 +55,8 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
  *  <p>You are not authorized to perform the action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>
- *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
- *     </p>
+ *  <p> A User with the same Id already exists within the collection, or the update or deletion
+ *       of the User caused an inconsistent state. ** </p>
  *
  * @throws {@link IdempotentParameterMismatchException} (client fault)
  *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input

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/DetectLabelsCommand.d.ts

@@ -46,9 +46,11 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
  *       labels or with label categories. You can specify inclusive filters, exclusive filters, or a
  *       combination of inclusive and exclusive filters. For more information on filtering see <a href="https://docs.aws.amazon.com/rekognition/latest/dg/labels-detect-labels-image.html">Detecting
  *         Labels in an Image</a>.</p>
- *          <p>You can specify <code>MinConfidence</code> to control the confidence threshold for the
- *       labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to
- *       limit the number of labels returned. The default and upper limit is 1000 labels.</p>
+ *          <p>When getting labels, you can specify <code>MinConfidence</code> to control the
+ *       confidence threshold for the labels returned. The default is 55%. You can also add the
+ *         <code>MaxLabels</code> parameter to limit the number of labels returned. The default and
+ *       upper limit is 1000 labels. These arguments are only valid when supplying GENERAL_LABELS as a
+ *       feature type.</p>
  *          <p>
  *             <b>Response Elements</b>
  *          </p>
@@ -95,10 +97,12 @@ export interface DetectLabelsCommandOutput extends DetectLabelsResponse, __Metad
  *                <p>Dominant Color - An array of the dominant colors in the image. </p>
  *             </li>
  *             <li>
- *                <p>Foreground - Information about the sharpness, brightness, and dominant colors of the input image’s foreground. </p>
+ *                <p>Foreground - Information about the sharpness, brightness, and dominant colors of the
+ *           input image’s foreground. </p>
  *             </li>
  *             <li>
- *                <p>Background - Information about the sharpness, brightness, and dominant colors of the input image’s background.</p>
+ *                <p>Background - Information about the sharpness, brightness, and dominant colors of the
+ *           input image’s background.</p>
  *             </li>
  *          </ul>
  *          <p>The list of returned labels will include at least one label for every detected object,

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

@@ -77,9 +77,8 @@ export interface DisassociateFacesCommandOutput extends DisassociateFacesRespons
  *  <p>You are not authorized to perform the action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>
- *       A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
- *     </p>
+ *  <p> A User with the same Id already exists within the collection, or the update or deletion
+ *       of the User caused an inconsistent state. ** </p>
  *
  * @throws {@link IdempotentParameterMismatchException} (client fault)
  *  <p>A <code>ClientRequestToken</code> input parameter was reused with an operation, but at least one of the other input

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;