@aws-sdk/client-rekognition 3.36.1 → 3.40.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 (87) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/dist-cjs/Rekognition.js +105 -0
  3. package/dist-cjs/commands/CreateDatasetCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteDatasetCommand.js +36 -0
  5. package/dist-cjs/commands/DescribeDatasetCommand.js +36 -0
  6. package/dist-cjs/commands/DistributeDatasetEntriesCommand.js +36 -0
  7. package/dist-cjs/commands/ListDatasetEntriesCommand.js +36 -0
  8. package/dist-cjs/commands/ListDatasetLabelsCommand.js +36 -0
  9. package/dist-cjs/commands/UpdateDatasetEntriesCommand.js +36 -0
  10. package/dist-cjs/commands/index.js +61 -0
  11. package/dist-cjs/endpoints.js +155 -25
  12. package/dist-cjs/index.js +5 -69
  13. package/dist-cjs/models/models_0.js +170 -16
  14. package/dist-cjs/pagination/ListDatasetEntriesPaginator.js +35 -0
  15. package/dist-cjs/pagination/ListDatasetLabelsPaginator.js +35 -0
  16. package/dist-cjs/pagination/index.js +19 -0
  17. package/dist-cjs/protocols/Aws_json1_1.js +1077 -54
  18. package/dist-cjs/runtimeConfig.browser.js +6 -3
  19. package/dist-cjs/runtimeConfig.js +5 -3
  20. package/dist-cjs/waiters/index.js +5 -0
  21. package/dist-es/Rekognition.js +105 -0
  22. package/dist-es/commands/CreateDatasetCommand.js +39 -0
  23. package/dist-es/commands/DeleteDatasetCommand.js +39 -0
  24. package/dist-es/commands/DescribeDatasetCommand.js +39 -0
  25. package/dist-es/commands/DistributeDatasetEntriesCommand.js +39 -0
  26. package/dist-es/commands/ListDatasetEntriesCommand.js +39 -0
  27. package/dist-es/commands/ListDatasetLabelsCommand.js +39 -0
  28. package/dist-es/commands/UpdateDatasetEntriesCommand.js +39 -0
  29. package/dist-es/commands/index.js +58 -0
  30. package/dist-es/endpoints.js +155 -25
  31. package/dist-es/index.js +5 -69
  32. package/dist-es/models/models_0.js +117 -8
  33. package/dist-es/pagination/ListDatasetEntriesPaginator.js +74 -0
  34. package/dist-es/pagination/ListDatasetLabelsPaginator.js +74 -0
  35. package/dist-es/pagination/index.js +16 -0
  36. package/dist-es/protocols/Aws_json1_1.js +1111 -51
  37. package/dist-es/runtimeConfig.browser.js +3 -2
  38. package/dist-es/runtimeConfig.js +3 -3
  39. package/dist-es/waiters/index.js +2 -0
  40. package/dist-types/Rekognition.d.ts +209 -29
  41. package/dist-types/RekognitionClient.d.ts +17 -2
  42. package/dist-types/commands/CreateDatasetCommand.d.ts +59 -0
  43. package/dist-types/commands/CreateProjectCommand.d.ts +2 -2
  44. package/dist-types/commands/CreateProjectVersionCommand.d.ts +32 -4
  45. package/dist-types/commands/DeleteDatasetCommand.d.ts +44 -0
  46. package/dist-types/commands/DeleteProjectCommand.d.ts +4 -0
  47. package/dist-types/commands/DescribeDatasetCommand.d.ts +39 -0
  48. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +2 -2
  49. package/dist-types/commands/DescribeProjectsCommand.d.ts +1 -1
  50. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +46 -0
  51. package/dist-types/commands/GetCelebrityRecognitionCommand.d.ts +22 -17
  52. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +49 -0
  53. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +40 -0
  54. package/dist-types/commands/RecognizeCelebritiesCommand.d.ts +3 -3
  55. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +62 -0
  56. package/dist-types/commands/index.d.ts +58 -0
  57. package/dist-types/index.d.ts +5 -69
  58. package/dist-types/models/models_0.d.ts +622 -51
  59. package/dist-types/pagination/ListDatasetEntriesPaginator.d.ts +4 -0
  60. package/dist-types/pagination/ListDatasetLabelsPaginator.d.ts +4 -0
  61. package/dist-types/pagination/index.d.ts +16 -0
  62. package/dist-types/protocols/Aws_json1_1.d.ts +21 -0
  63. package/dist-types/runtimeConfig.browser.d.ts +2 -0
  64. package/dist-types/runtimeConfig.d.ts +2 -0
  65. package/dist-types/runtimeConfig.native.d.ts +2 -0
  66. package/dist-types/ts3.4/Rekognition.d.ts +35 -0
  67. package/dist-types/ts3.4/RekognitionClient.d.ts +13 -2
  68. package/dist-types/ts3.4/commands/CreateDatasetCommand.d.ts +17 -0
  69. package/dist-types/ts3.4/commands/DeleteDatasetCommand.d.ts +17 -0
  70. package/dist-types/ts3.4/commands/DescribeDatasetCommand.d.ts +17 -0
  71. package/dist-types/ts3.4/commands/DistributeDatasetEntriesCommand.d.ts +17 -0
  72. package/dist-types/ts3.4/commands/ListDatasetEntriesCommand.d.ts +17 -0
  73. package/dist-types/ts3.4/commands/ListDatasetLabelsCommand.d.ts +17 -0
  74. package/dist-types/ts3.4/commands/UpdateDatasetEntriesCommand.d.ts +17 -0
  75. package/dist-types/ts3.4/commands/index.d.ts +58 -0
  76. package/dist-types/ts3.4/index.d.ts +5 -69
  77. package/dist-types/ts3.4/models/models_0.d.ts +283 -23
  78. package/dist-types/ts3.4/pagination/ListDatasetEntriesPaginator.d.ts +4 -0
  79. package/dist-types/ts3.4/pagination/ListDatasetLabelsPaginator.d.ts +4 -0
  80. package/dist-types/ts3.4/pagination/index.d.ts +16 -0
  81. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +21 -0
  82. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
  83. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
  84. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
  85. package/dist-types/ts3.4/waiters/index.d.ts +2 -0
  86. package/dist-types/waiters/index.d.ts +2 -0
  87. package/package.json +33 -33
@@ -8,14 +8,42 @@ export interface CreateProjectVersionCommandOutput extends CreateProjectVersionR
8
8
  }
9
9
  /**
10
10
  * <p>Creates a new version of a model and begins training.
11
- * Models are managed as part of an Amazon Rekognition Custom Labels project. You can specify
12
- * one training dataset and one testing dataset. The response from <code>CreateProjectVersion</code>
11
+ * Models are managed as part of an Amazon Rekognition Custom Labels project.
12
+ * The response from <code>CreateProjectVersion</code>
13
13
  * is an Amazon Resource Name (ARN) for the version of the model. </p>
14
+ *
15
+ *
16
+ * <p>Training uses the training and test datasets associated with the project.
17
+ * For more information, see Creating training and test dataset in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
18
+ * </p>
19
+ *
20
+ *
21
+ * <note>
22
+ * <p>You can train a modelin a project that doesn't have associated datasets by specifying manifest files in the
23
+ * <code>TrainingData</code> and <code>TestingData</code> fields.
24
+ * </p>
25
+ * <p>If you open the console after training a model with manifest files, Amazon Rekognition Custom Labels creates
26
+ * the datasets for you using the most recent manifest files. You can no longer train
27
+ * a model version for the project by specifying manifest files. </p>
28
+ * <p>Instead of training with a project without associated datasets,
29
+ * we recommend that you use the manifest
30
+ * files to create training and test datasets for the project.</p>
31
+ * </note>
32
+ *
33
+ *
14
34
  * <p>Training takes a while to complete. You can get the current status by calling
15
- * <a>DescribeProjectVersions</a>.</p>
35
+ * <a>DescribeProjectVersions</a>. Training completed successfully if
36
+ * the value of the <code>Status</code> field is <code>TRAINING_COMPLETED</code>.</p>
37
+ *
38
+ * <p>If training
39
+ * fails, see Debugging a failed model training in the <i>Amazon Rekognition Custom Labels</i> developer guide. </p>
40
+ *
41
+ *
16
42
  * <p>Once training has successfully completed, call <a>DescribeProjectVersions</a> to
17
- * get the training results and evaluate the model.
43
+ * get the training results and evaluate the model. For more information, see Improving a trained Amazon Rekognition Custom Labels model
44
+ * in the <i>Amazon Rekognition Custom Labels</i> developers guide.
18
45
  * </p>
46
+ *
19
47
  * <p>After evaluating the model, you start the model
20
48
  * by calling <a>StartProjectVersion</a>.</p>
21
49
  * <p>This operation requires permissions to perform the <code>rekognition:CreateProjectVersion</code> action.</p>
@@ -0,0 +1,44 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { DeleteDatasetRequest, DeleteDatasetResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface DeleteDatasetCommandInput extends DeleteDatasetRequest {
6
+ }
7
+ export interface DeleteDatasetCommandOutput extends DeleteDatasetResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes an existing Amazon Rekognition Custom Labels dataset.
11
+ * Deleting a dataset might take while. Use <a>DescribeDataset</a> to check the
12
+ * current status. The dataset is still deleting if the value of <code>Status</code> is
13
+ * <code>DELETE_IN_PROGRESS</code>. If you try to access the dataset after it is deleted, you get
14
+ * a <code>ResourceNotFoundException</code> exception.
15
+ *
16
+ * </p>
17
+ * <p>You can't delete a dataset while it is creating (<code>Status</code> = <code>CREATE_IN_PROGRESS</code>)
18
+ * or if the dataset is updating (<code>Status</code> = <code>UPDATE_IN_PROGRESS</code>).</p>
19
+ * <p>This operation requires permissions to perform the <code>rekognition:DeleteDataset</code> action.</p>
20
+ * @example
21
+ * Use a bare-bones client and the command you need to make an API call.
22
+ * ```javascript
23
+ * import { RekognitionClient, DeleteDatasetCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
24
+ * // const { RekognitionClient, DeleteDatasetCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
25
+ * const client = new RekognitionClient(config);
26
+ * const command = new DeleteDatasetCommand(input);
27
+ * const response = await client.send(command);
28
+ * ```
29
+ *
30
+ * @see {@link DeleteDatasetCommandInput} for command's `input` shape.
31
+ * @see {@link DeleteDatasetCommandOutput} for command's `response` shape.
32
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
33
+ *
34
+ */
35
+ export declare class DeleteDatasetCommand extends $Command<DeleteDatasetCommandInput, DeleteDatasetCommandOutput, RekognitionClientResolvedConfig> {
36
+ readonly input: DeleteDatasetCommandInput;
37
+ constructor(input: DeleteDatasetCommandInput);
38
+ /**
39
+ * @internal
40
+ */
41
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteDatasetCommandInput, DeleteDatasetCommandOutput>;
42
+ private serialize;
43
+ private deserialize;
44
+ }
@@ -9,6 +9,10 @@ export interface DeleteProjectCommandOutput extends DeleteProjectResponse, __Met
9
9
  /**
10
10
  * <p>Deletes an Amazon Rekognition Custom Labels project. To delete a project you must first delete all models associated
11
11
  * with the project. To delete a model, see <a>DeleteProjectVersion</a>.</p>
12
+ * <p>
13
+ * <code>DeleteProject</code> is an asynchronous operation. To check if the project is deleted,
14
+ * call <a>DescribeProjects</a>. The project is deleted when the project no longer appears in the
15
+ * response.</p>
12
16
  * <p>This operation requires permissions to perform the
13
17
  * <code>rekognition:DeleteProject</code> action. </p>
14
18
  * @example
@@ -0,0 +1,39 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { DescribeDatasetRequest, DescribeDatasetResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface DescribeDatasetCommandInput extends DescribeDatasetRequest {
6
+ }
7
+ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>
11
+ * Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and
12
+ * statistics about the images and labels in a dataset.
13
+ * </p>
14
+ * <p>This operation requires permissions to perform the <code>rekognition:DescribeDataset</code> action.</p>
15
+ * @example
16
+ * Use a bare-bones client and the command you need to make an API call.
17
+ * ```javascript
18
+ * import { RekognitionClient, DescribeDatasetCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
19
+ * // const { RekognitionClient, DescribeDatasetCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
20
+ * const client = new RekognitionClient(config);
21
+ * const command = new DescribeDatasetCommand(input);
22
+ * const response = await client.send(command);
23
+ * ```
24
+ *
25
+ * @see {@link DescribeDatasetCommandInput} for command's `input` shape.
26
+ * @see {@link DescribeDatasetCommandOutput} for command's `response` shape.
27
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
28
+ *
29
+ */
30
+ export declare class DescribeDatasetCommand extends $Command<DescribeDatasetCommandInput, DescribeDatasetCommandOutput, RekognitionClientResolvedConfig> {
31
+ readonly input: DescribeDatasetCommandInput;
32
+ constructor(input: DescribeDatasetCommandInput);
33
+ /**
34
+ * @internal
35
+ */
36
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeDatasetCommandInput, DescribeDatasetCommandOutput>;
37
+ private serialize;
38
+ private deserialize;
39
+ }
@@ -7,9 +7,9 @@ export interface DescribeProjectVersionsCommandInput extends DescribeProjectVers
7
7
  export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVersionsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists and describes the models in an Amazon Rekognition Custom Labels project. You
10
+ * <p>Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You
11
11
  * can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
12
- * you don't specify a value, descriptions for all models are returned.</p>
12
+ * you don't specify a value, descriptions for all model versions in the project are returned.</p>
13
13
  * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>
14
14
  * action.</p>
15
15
  * @example
@@ -7,7 +7,7 @@ export interface DescribeProjectsCommandInput extends DescribeProjectsRequest {
7
7
  export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists and gets information about your Amazon Rekognition Custom Labels projects.</p>
10
+ * <p>Gets information about your Amazon Rekognition Custom Labels projects. </p>
11
11
  * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
@@ -0,0 +1,46 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { DistributeDatasetEntriesRequest, DistributeDatasetEntriesResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface DistributeDatasetEntriesCommandInput extends DistributeDatasetEntriesRequest {
6
+ }
7
+ export interface DistributeDatasetEntriesCommandOutput extends DistributeDatasetEntriesResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
11
+ * <code>DistributeDatasetEntries</code> moves 20% of the training dataset images to the test dataset.
12
+ * An entry is a JSON Line that describes an image.
13
+ * </p>
14
+ * <p>You supply the Amazon Resource Names (ARN) of a project's training dataset and test dataset.
15
+ * The training dataset must contain the images that you want to split. The test dataset
16
+ * must be empty. The datasets must belong to the same project. To create training and test datasets for a project, call <a>CreateDataset</a>.</p>
17
+ * <p>Distributing a dataset takes a while to complete. To check the status call <code>DescribeDataset</code>. The operation
18
+ * is complete when the <code>Status</code> field for the training dataset and the test dataset is <code>UPDATE_COMPLETE</code>.
19
+ * If the dataset split fails, the value of <code>Status</code> is <code>UPDATE_FAILED</code>.</p>
20
+ *
21
+ * <p>This operation requires permissions to perform the <code>rekognition:DistributeDatasetEntries</code> action.</p>
22
+ * @example
23
+ * Use a bare-bones client and the command you need to make an API call.
24
+ * ```javascript
25
+ * import { RekognitionClient, DistributeDatasetEntriesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
26
+ * // const { RekognitionClient, DistributeDatasetEntriesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
27
+ * const client = new RekognitionClient(config);
28
+ * const command = new DistributeDatasetEntriesCommand(input);
29
+ * const response = await client.send(command);
30
+ * ```
31
+ *
32
+ * @see {@link DistributeDatasetEntriesCommandInput} for command's `input` shape.
33
+ * @see {@link DistributeDatasetEntriesCommandOutput} for command's `response` shape.
34
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
35
+ *
36
+ */
37
+ export declare class DistributeDatasetEntriesCommand extends $Command<DistributeDatasetEntriesCommandInput, DistributeDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
38
+ readonly input: DistributeDatasetEntriesCommandInput;
39
+ constructor(input: DistributeDatasetEntriesCommandInput);
40
+ /**
41
+ * @internal
42
+ */
43
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DistributeDatasetEntriesCommandInput, DistributeDatasetEntriesCommandOutput>;
44
+ private serialize;
45
+ private deserialize;
46
+ }
@@ -9,28 +9,33 @@ export interface GetCelebrityRecognitionCommandOutput extends GetCelebrityRecogn
9
9
  /**
10
10
  * <p>Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by
11
11
  * <a>StartCelebrityRecognition</a>.</p>
12
- * <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call
13
- * to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>).
14
- * When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service
15
- * topic registered in the initial call to <code>StartCelebrityRecognition</code>.
16
- * To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS
17
- * topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job identifier
18
- * (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
12
+ * <p>Celebrity recognition in a video is an asynchronous operation. Analysis is started by a
13
+ * call to <a>StartCelebrityRecognition</a> which returns a job identifier
14
+ * (<code>JobId</code>). </p>
15
+ * <p>When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion
16
+ * status to the Amazon Simple Notification Service topic registered in the initial call to
17
+ * <code>StartCelebrityRecognition</code>. To get the results of the celebrity recognition
18
+ * analysis, first check that the status value published to the Amazon SNS topic is
19
+ * <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job
20
+ * identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </p>
19
21
  *
20
22
  * <p>For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.</p>
21
23
  * <p>
22
- * <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they are detected in an array
23
- * (<code>Celebrities</code>) of <a>CelebrityRecognition</a>
24
- * objects. Each <code>CelebrityRecognition</code> contains information about the celebrity in a <a>CelebrityDetail</a>
25
- * object and the time, <code>Timestamp</code>, the celebrity was detected.
26
- * </p>
24
+ * <code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they
25
+ * are detected in an array (<code>Celebrities</code>) of <a>CelebrityRecognition</a>
26
+ * objects. Each <code>CelebrityRecognition</code>
27
+ * contains information about the celebrity in a <a>CelebrityDetail</a> object and the
28
+ * time, <code>Timestamp</code>, the celebrity was detected. This <a>CelebrityDetail</a> object stores information about the detected celebrity's face
29
+ * attributes, a face bounding box, known gender, the celebrity's name, and a confidence
30
+ * estimate.</p>
27
31
  * <note>
28
32
  * <p>
29
- * <code>GetCelebrityRecognition</code> only returns the default
30
- * facial attributes (<code>BoundingBox</code>, <code>Confidence</code>,
31
- * <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed
32
- * in the <code>Face</code> object of the following response syntax are not returned. For more information,
33
- * see FaceDetail in the Amazon Rekognition Developer Guide. </p>
33
+ * <code>GetCelebrityRecognition</code> only returns the default facial
34
+ * attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>,
35
+ * <code>Pose</code>, and <code>Quality</code>). The <code>BoundingBox</code> field only
36
+ * applies to the detected face instance. The other facial attributes listed in the
37
+ * <code>Face</code> object of the following response syntax are not returned. For more
38
+ * information, see FaceDetail in the Amazon Rekognition Developer Guide. </p>
34
39
  * </note>
35
40
  * <p>By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video).
36
41
  * You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter.</p>
@@ -0,0 +1,49 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ListDatasetEntriesRequest, ListDatasetEntriesResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface ListDatasetEntriesCommandInput extends ListDatasetEntriesRequest {
6
+ }
7
+ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>
11
+ * Lists the entries (images) within a dataset. An entry is a
12
+ * JSON Line that contains the information for a single image, including
13
+ * the image location, assigned labels, and object location bounding boxes. For
14
+ * more information, see <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-manifest-files.html">Creating a manifest file</a>.</p>
15
+ * <p>JSON Lines in the response include information about non-terminal
16
+ * errors found in the dataset.
17
+ * Non terminal errors are reported in <code>errors</code> lists within each JSON Line. The
18
+ * same information is reported in the training and testing validation result manifests that
19
+ * Amazon Rekognition Custom Labels creates during model training.
20
+ * </p>
21
+ *
22
+ * <p>You can filter the response in variety of ways, such as choosing which labels to return and returning JSON Lines created after a specific date.
23
+ * </p>
24
+ * <p>This operation requires permissions to perform the <code>rekognition:ListDatasetEntries</code> action.</p>
25
+ * @example
26
+ * Use a bare-bones client and the command you need to make an API call.
27
+ * ```javascript
28
+ * import { RekognitionClient, ListDatasetEntriesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
29
+ * // const { RekognitionClient, ListDatasetEntriesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
30
+ * const client = new RekognitionClient(config);
31
+ * const command = new ListDatasetEntriesCommand(input);
32
+ * const response = await client.send(command);
33
+ * ```
34
+ *
35
+ * @see {@link ListDatasetEntriesCommandInput} for command's `input` shape.
36
+ * @see {@link ListDatasetEntriesCommandOutput} for command's `response` shape.
37
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
38
+ *
39
+ */
40
+ export declare class ListDatasetEntriesCommand extends $Command<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
41
+ readonly input: ListDatasetEntriesCommandInput;
42
+ constructor(input: ListDatasetEntriesCommandInput);
43
+ /**
44
+ * @internal
45
+ */
46
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetEntriesCommandInput, ListDatasetEntriesCommandOutput>;
47
+ private serialize;
48
+ private deserialize;
49
+ }
@@ -0,0 +1,40 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { ListDatasetLabelsRequest, ListDatasetLabelsResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface ListDatasetLabelsCommandInput extends ListDatasetLabelsRequest {
6
+ }
7
+ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
11
+ * <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling images</a>.
12
+ * </p>
13
+ * <p>
14
+ * Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see Labeling images
15
+ * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>. </p>
16
+ * @example
17
+ * Use a bare-bones client and the command you need to make an API call.
18
+ * ```javascript
19
+ * import { RekognitionClient, ListDatasetLabelsCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
20
+ * // const { RekognitionClient, ListDatasetLabelsCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
21
+ * const client = new RekognitionClient(config);
22
+ * const command = new ListDatasetLabelsCommand(input);
23
+ * const response = await client.send(command);
24
+ * ```
25
+ *
26
+ * @see {@link ListDatasetLabelsCommandInput} for command's `input` shape.
27
+ * @see {@link ListDatasetLabelsCommandOutput} for command's `response` shape.
28
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
29
+ *
30
+ */
31
+ export declare class ListDatasetLabelsCommand extends $Command<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput, RekognitionClientResolvedConfig> {
32
+ readonly input: ListDatasetLabelsCommandInput;
33
+ constructor(input: ListDatasetLabelsCommandInput);
34
+ /**
35
+ * @internal
36
+ */
37
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDatasetLabelsCommandInput, ListDatasetLabelsCommandOutput>;
38
+ private serialize;
39
+ private deserialize;
40
+ }
@@ -10,9 +10,9 @@ export interface RecognizeCelebritiesCommandOutput extends RecognizeCelebritiesR
10
10
  * <p>Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities
11
11
  * in the Amazon Rekognition Developer Guide. </p>
12
12
  * <p>
13
- * <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists
14
- * recognized celebrities in the <code>CelebrityFaces</code> array and unrecognized faces in the
15
- * <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
13
+ * <code>RecognizeCelebrities</code> returns the 64 largest faces in the image. It lists the
14
+ * recognized celebrities in the <code>CelebrityFaces</code> array and any unrecognized faces in
15
+ * the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return
16
16
  * celebrities whose faces aren't among the largest 64 faces in the image.</p>
17
17
  *
18
18
  * <p>For each celebrity recognized, <code>RecognizeCelebrities</code> returns a
@@ -0,0 +1,62 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { UpdateDatasetEntriesRequest, UpdateDatasetEntriesResponse } from "../models/models_0";
4
+ import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
5
+ export interface UpdateDatasetEntriesCommandInput extends UpdateDatasetEntriesRequest {
6
+ }
7
+ export interface UpdateDatasetEntriesCommandOutput extends UpdateDatasetEntriesResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the
11
+ * information for a single image, including
12
+ * the image location, assigned labels, and object location bounding boxes. For more information,
13
+ * see Image-Level labels in manifest files and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
14
+ * </p>
15
+ *
16
+ *
17
+ *
18
+ * <p>If the <code>source-ref</code> field in the JSON line references an existing image, the existing image in the dataset
19
+ * is updated.
20
+ * If <code>source-ref</code> field doesn't reference an existing image, the image is added as a new image to the dataset. </p>
21
+ *
22
+ * <p>You specify the changes that you want to make in the <code>Changes</code> input parameter.
23
+ * There isn't a limit to the number JSON Lines that you can change, but the size of <code>Changes</code> must be less
24
+ * than 5MB.</p>
25
+ *
26
+ *
27
+ * <p>
28
+ * <code>UpdateDatasetEntries</code> returns immediatly, but the dataset update might take a while to complete.
29
+ * Use <a>DescribeDataset</a> to check the
30
+ * current status. The dataset updated successfully if the value of <code>Status</code> is
31
+ * <code>UPDATE_COMPLETE</code>. </p>
32
+ * <p>To check if any non-terminal errors occured, call <a>ListDatasetEntries</a>
33
+ * and check for the presence of <code>errors</code> lists in the JSON Lines.</p>
34
+ * <p>Dataset update fails if a terminal error occurs (<code>Status</code> = <code>UPDATE_FAILED</code>).
35
+ * Currently, you can't access the terminal error information from the Amazon Rekognition Custom Labels SDK.
36
+ * </p>
37
+ * <p>This operation requires permissions to perform the <code>rekognition:UpdateDatasetEntries</code> action.</p>
38
+ * @example
39
+ * Use a bare-bones client and the command you need to make an API call.
40
+ * ```javascript
41
+ * import { RekognitionClient, UpdateDatasetEntriesCommand } from "@aws-sdk/client-rekognition"; // ES Modules import
42
+ * // const { RekognitionClient, UpdateDatasetEntriesCommand } = require("@aws-sdk/client-rekognition"); // CommonJS import
43
+ * const client = new RekognitionClient(config);
44
+ * const command = new UpdateDatasetEntriesCommand(input);
45
+ * const response = await client.send(command);
46
+ * ```
47
+ *
48
+ * @see {@link UpdateDatasetEntriesCommandInput} for command's `input` shape.
49
+ * @see {@link UpdateDatasetEntriesCommandOutput} for command's `response` shape.
50
+ * @see {@link RekognitionClientResolvedConfig | config} for command's `input` shape.
51
+ *
52
+ */
53
+ export declare class UpdateDatasetEntriesCommand extends $Command<UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput, RekognitionClientResolvedConfig> {
54
+ readonly input: UpdateDatasetEntriesCommandInput;
55
+ constructor(input: UpdateDatasetEntriesCommandInput);
56
+ /**
57
+ * @internal
58
+ */
59
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: RekognitionClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDatasetEntriesCommandInput, UpdateDatasetEntriesCommandOutput>;
60
+ private serialize;
61
+ private deserialize;
62
+ }
@@ -0,0 +1,58 @@
1
+ export * from "./CompareFacesCommand";
2
+ export * from "./CreateCollectionCommand";
3
+ export * from "./CreateDatasetCommand";
4
+ export * from "./CreateProjectCommand";
5
+ export * from "./CreateProjectVersionCommand";
6
+ export * from "./CreateStreamProcessorCommand";
7
+ export * from "./DeleteCollectionCommand";
8
+ export * from "./DeleteDatasetCommand";
9
+ export * from "./DeleteFacesCommand";
10
+ export * from "./DeleteProjectCommand";
11
+ export * from "./DeleteProjectVersionCommand";
12
+ export * from "./DeleteStreamProcessorCommand";
13
+ export * from "./DescribeCollectionCommand";
14
+ export * from "./DescribeDatasetCommand";
15
+ export * from "./DescribeProjectVersionsCommand";
16
+ export * from "./DescribeProjectsCommand";
17
+ export * from "./DescribeStreamProcessorCommand";
18
+ export * from "./DetectCustomLabelsCommand";
19
+ export * from "./DetectFacesCommand";
20
+ export * from "./DetectLabelsCommand";
21
+ export * from "./DetectModerationLabelsCommand";
22
+ export * from "./DetectProtectiveEquipmentCommand";
23
+ export * from "./DetectTextCommand";
24
+ export * from "./DistributeDatasetEntriesCommand";
25
+ export * from "./GetCelebrityInfoCommand";
26
+ export * from "./GetCelebrityRecognitionCommand";
27
+ export * from "./GetContentModerationCommand";
28
+ export * from "./GetFaceDetectionCommand";
29
+ export * from "./GetFaceSearchCommand";
30
+ export * from "./GetLabelDetectionCommand";
31
+ export * from "./GetPersonTrackingCommand";
32
+ export * from "./GetSegmentDetectionCommand";
33
+ export * from "./GetTextDetectionCommand";
34
+ export * from "./IndexFacesCommand";
35
+ export * from "./ListCollectionsCommand";
36
+ export * from "./ListDatasetEntriesCommand";
37
+ export * from "./ListDatasetLabelsCommand";
38
+ export * from "./ListFacesCommand";
39
+ export * from "./ListStreamProcessorsCommand";
40
+ export * from "./ListTagsForResourceCommand";
41
+ export * from "./RecognizeCelebritiesCommand";
42
+ export * from "./SearchFacesByImageCommand";
43
+ export * from "./SearchFacesCommand";
44
+ export * from "./StartCelebrityRecognitionCommand";
45
+ export * from "./StartContentModerationCommand";
46
+ export * from "./StartFaceDetectionCommand";
47
+ export * from "./StartFaceSearchCommand";
48
+ export * from "./StartLabelDetectionCommand";
49
+ export * from "./StartPersonTrackingCommand";
50
+ export * from "./StartProjectVersionCommand";
51
+ export * from "./StartSegmentDetectionCommand";
52
+ export * from "./StartStreamProcessorCommand";
53
+ export * from "./StartTextDetectionCommand";
54
+ export * from "./StopProjectVersionCommand";
55
+ export * from "./StopStreamProcessorCommand";
56
+ export * from "./TagResourceCommand";
57
+ export * from "./UntagResourceCommand";
58
+ export * from "./UpdateDatasetEntriesCommand";
@@ -1,70 +1,6 @@
1
- export * from "./RekognitionClient";
2
1
  export * from "./Rekognition";
3
- export * from "./commands/CompareFacesCommand";
4
- export * from "./commands/CreateCollectionCommand";
5
- export * from "./commands/CreateProjectCommand";
6
- export * from "./commands/CreateProjectVersionCommand";
7
- export * from "./commands/CreateStreamProcessorCommand";
8
- export * from "./commands/DeleteCollectionCommand";
9
- export * from "./commands/DeleteFacesCommand";
10
- export * from "./commands/DeleteProjectCommand";
11
- export * from "./commands/DeleteProjectVersionCommand";
12
- export * from "./commands/DeleteStreamProcessorCommand";
13
- export * from "./commands/DescribeCollectionCommand";
14
- export * from "./commands/DescribeProjectsCommand";
15
- export * from "./pagination/DescribeProjectsPaginator";
16
- export * from "./commands/DescribeProjectVersionsCommand";
17
- export * from "./pagination/DescribeProjectVersionsPaginator";
18
- export * from "./waiters/waitForProjectVersionRunning";
19
- export * from "./waiters/waitForProjectVersionTrainingCompleted";
20
- export * from "./commands/DescribeStreamProcessorCommand";
21
- export * from "./commands/DetectCustomLabelsCommand";
22
- export * from "./commands/DetectFacesCommand";
23
- export * from "./commands/DetectLabelsCommand";
24
- export * from "./commands/DetectModerationLabelsCommand";
25
- export * from "./commands/DetectProtectiveEquipmentCommand";
26
- export * from "./commands/DetectTextCommand";
27
- export * from "./commands/GetCelebrityInfoCommand";
28
- export * from "./commands/GetCelebrityRecognitionCommand";
29
- export * from "./pagination/GetCelebrityRecognitionPaginator";
30
- export * from "./commands/GetContentModerationCommand";
31
- export * from "./pagination/GetContentModerationPaginator";
32
- export * from "./commands/GetFaceDetectionCommand";
33
- export * from "./pagination/GetFaceDetectionPaginator";
34
- export * from "./commands/GetFaceSearchCommand";
35
- export * from "./pagination/GetFaceSearchPaginator";
36
- export * from "./commands/GetLabelDetectionCommand";
37
- export * from "./pagination/GetLabelDetectionPaginator";
38
- export * from "./commands/GetPersonTrackingCommand";
39
- export * from "./pagination/GetPersonTrackingPaginator";
40
- export * from "./commands/GetSegmentDetectionCommand";
41
- export * from "./pagination/GetSegmentDetectionPaginator";
42
- export * from "./commands/GetTextDetectionCommand";
43
- export * from "./pagination/GetTextDetectionPaginator";
44
- export * from "./commands/IndexFacesCommand";
45
- export * from "./commands/ListCollectionsCommand";
46
- export * from "./pagination/ListCollectionsPaginator";
47
- export * from "./commands/ListFacesCommand";
48
- export * from "./pagination/ListFacesPaginator";
49
- export * from "./commands/ListStreamProcessorsCommand";
50
- export * from "./pagination/ListStreamProcessorsPaginator";
51
- export * from "./commands/ListTagsForResourceCommand";
52
- export * from "./commands/RecognizeCelebritiesCommand";
53
- export * from "./commands/SearchFacesCommand";
54
- export * from "./commands/SearchFacesByImageCommand";
55
- export * from "./commands/StartCelebrityRecognitionCommand";
56
- export * from "./commands/StartContentModerationCommand";
57
- export * from "./commands/StartFaceDetectionCommand";
58
- export * from "./commands/StartFaceSearchCommand";
59
- export * from "./commands/StartLabelDetectionCommand";
60
- export * from "./commands/StartPersonTrackingCommand";
61
- export * from "./commands/StartProjectVersionCommand";
62
- export * from "./commands/StartSegmentDetectionCommand";
63
- export * from "./commands/StartStreamProcessorCommand";
64
- export * from "./commands/StartTextDetectionCommand";
65
- export * from "./commands/StopProjectVersionCommand";
66
- export * from "./commands/StopStreamProcessorCommand";
67
- export * from "./commands/TagResourceCommand";
68
- export * from "./commands/UntagResourceCommand";
69
- export * from "./pagination/Interfaces";
70
- export * from "./models/index";
2
+ export * from "./RekognitionClient";
3
+ export * from "./commands";
4
+ export * from "./models";
5
+ export * from "./pagination";
6
+ export * from "./waiters";