@aws-sdk/client-rekognition 3.427.0 → 3.428.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 (44) hide show
  1. package/dist-cjs/models/models_0.js +12 -12
  2. package/dist-cjs/models/models_1.js +11 -1
  3. package/dist-cjs/protocols/Aws_json1_1.js +48 -1
  4. package/dist-es/models/models_0.js +10 -10
  5. package/dist-es/models/models_1.js +10 -0
  6. package/dist-es/protocols/Aws_json1_1.js +48 -1
  7. package/dist-types/commands/CopyProjectVersionCommand.d.ts +12 -5
  8. package/dist-types/commands/CreateDatasetCommand.d.ts +9 -4
  9. package/dist-types/commands/CreateProjectCommand.d.ts +13 -6
  10. package/dist-types/commands/CreateProjectVersionCommand.d.ts +29 -22
  11. package/dist-types/commands/CreateStreamProcessorCommand.d.ts +5 -3
  12. package/dist-types/commands/DeleteDatasetCommand.d.ts +9 -4
  13. package/dist-types/commands/DeleteProjectCommand.d.ts +2 -2
  14. package/dist-types/commands/DeleteProjectPolicyCommand.d.ts +4 -1
  15. package/dist-types/commands/DeleteProjectVersionCommand.d.ts +6 -7
  16. package/dist-types/commands/DescribeDatasetCommand.d.ts +4 -1
  17. package/dist-types/commands/DescribeProjectVersionsCommand.d.ts +12 -4
  18. package/dist-types/commands/DescribeProjectsCommand.d.ts +6 -1
  19. package/dist-types/commands/DetectCustomLabelsCommand.d.ts +9 -4
  20. package/dist-types/commands/DetectModerationLabelsCommand.d.ts +12 -0
  21. package/dist-types/commands/DistributeDatasetEntriesCommand.d.ts +4 -1
  22. package/dist-types/commands/ListDatasetEntriesCommand.d.ts +4 -1
  23. package/dist-types/commands/ListDatasetLabelsCommand.d.ts +4 -1
  24. package/dist-types/commands/ListProjectPoliciesCommand.d.ts +4 -1
  25. package/dist-types/commands/PutProjectPolicyCommand.d.ts +12 -6
  26. package/dist-types/commands/SearchUsersByImageCommand.d.ts +2 -1
  27. package/dist-types/commands/StartCelebrityRecognitionCommand.d.ts +6 -5
  28. package/dist-types/commands/StartContentModerationCommand.d.ts +5 -3
  29. package/dist-types/commands/StartFaceDetectionCommand.d.ts +5 -3
  30. package/dist-types/commands/StartFaceSearchCommand.d.ts +5 -3
  31. package/dist-types/commands/StartLabelDetectionCommand.d.ts +5 -3
  32. package/dist-types/commands/StartPersonTrackingCommand.d.ts +5 -3
  33. package/dist-types/commands/StartProjectVersionCommand.d.ts +11 -7
  34. package/dist-types/commands/StartSegmentDetectionCommand.d.ts +5 -3
  35. package/dist-types/commands/StartTextDetectionCommand.d.ts +5 -3
  36. package/dist-types/commands/StopProjectVersionCommand.d.ts +7 -3
  37. package/dist-types/commands/UpdateDatasetEntriesCommand.d.ts +9 -4
  38. package/dist-types/models/models_0.d.ts +187 -175
  39. package/dist-types/models/models_1.d.ts +124 -7
  40. package/dist-types/ts3.4/commands/SearchUsersByImageCommand.d.ts +2 -4
  41. package/dist-types/ts3.4/commands/StartCelebrityRecognitionCommand.d.ts +4 -2
  42. package/dist-types/ts3.4/models/models_0.d.ts +33 -28
  43. package/dist-types/ts3.4/models/models_1.d.ts +31 -0
  44. package/package.json +32 -32
@@ -23,12 +23,11 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Deletes an Amazon Rekognition Custom Labels model. </p>
27
- * <p>You can't delete a model if it is running or if it is training.
28
- * To check the status of a model, use the <code>Status</code> field returned
29
- * from <a>DescribeProjectVersions</a>.
30
- * To stop a running model call <a>StopProjectVersion</a>. If the model
31
- * is training, wait until it finishes.</p>
26
+ * <p>Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom
27
+ * adapter.</p>
28
+ * <p>You can't delete a project version if it is running or if it is training. To check
29
+ * the status of a project version, use the Status field returned from <a>DescribeProjectVersions</a>. To stop a project version call <a>StopProjectVersion</a>. If the project version is training, wait until it
30
+ * finishes.</p>
32
31
  * <p>This operation requires permissions to perform the
33
32
  * <code>rekognition:DeleteProjectVersion</code> action. </p>
34
33
  * @example
@@ -43,7 +42,7 @@ export interface DeleteProjectVersionCommandOutput extends DeleteProjectVersionR
43
42
  * const command = new DeleteProjectVersionCommand(input);
44
43
  * const response = await client.send(command);
45
44
  * // { // DeleteProjectVersionResponse
46
- * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
45
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED" || "DEPRECATED" || "EXPIRED",
47
46
  * // };
48
47
  *
49
48
  * ```
@@ -23,7 +23,10 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>
27
30
  * Describes an Amazon Rekognition Custom Labels dataset. You can get information such as the current status of a dataset and
28
31
  * statistics about the images and labels in a dataset.
29
32
  * </p>
@@ -23,9 +23,9 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists and describes the versions of a model in an Amazon Rekognition Custom Labels project. You
27
- * can specify up to 10 model versions in <code>ProjectVersionArns</code>. If
28
- * you don't specify a value, descriptions for all model versions in the project are returned.</p>
26
+ * <p>Lists and describes the versions of an Amazon Rekognition project. You can specify up to 10 model or
27
+ * adapter versions in <code>ProjectVersionArns</code>. If you don't specify a value,
28
+ * descriptions for all model/adapter versions in the project are returned.</p>
29
29
  * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjectVersions</code>
30
30
  * action.</p>
31
31
  * @example
@@ -50,7 +50,7 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
50
50
  * // ProjectVersionArn: "STRING_VALUE",
51
51
  * // CreationTimestamp: new Date("TIMESTAMP"),
52
52
  * // MinInferenceUnits: Number("int"),
53
- * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
53
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED" || "DEPRECATED" || "EXPIRED",
54
54
  * // StatusMessage: "STRING_VALUE",
55
55
  * // BillableTrainingTimeInSeconds: Number("long"),
56
56
  * // TrainingEndTimestamp: new Date("TIMESTAMP"),
@@ -142,6 +142,14 @@ export interface DescribeProjectVersionsCommandOutput extends DescribeProjectVer
142
142
  * // KmsKeyId: "STRING_VALUE",
143
143
  * // MaxInferenceUnits: Number("int"),
144
144
  * // SourceProjectVersionArn: "STRING_VALUE",
145
+ * // VersionDescription: "STRING_VALUE",
146
+ * // Feature: "CONTENT_MODERATION" || "CUSTOM_LABELS",
147
+ * // BaseModelVersion: "STRING_VALUE",
148
+ * // FeatureConfig: { // CustomizationFeatureConfig
149
+ * // ContentModeration: { // CustomizationFeatureContentModerationConfig
150
+ * // ConfidenceThreshold: Number("float"),
151
+ * // },
152
+ * // },
145
153
  * // },
146
154
  * // ],
147
155
  * // NextToken: "STRING_VALUE",
@@ -23,7 +23,7 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Gets information about your Amazon Rekognition Custom Labels projects. </p>
26
+ * <p>Gets information about your Rekognition projects.</p>
27
27
  * <p>This operation requires permissions to perform the <code>rekognition:DescribeProjects</code> action.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
@@ -37,6 +37,9 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
37
37
  * ProjectNames: [ // ProjectNames
38
38
  * "STRING_VALUE",
39
39
  * ],
40
+ * Features: [ // CustomizationFeatures
41
+ * "CONTENT_MODERATION" || "CUSTOM_LABELS",
42
+ * ],
40
43
  * };
41
44
  * const command = new DescribeProjectsCommand(input);
42
45
  * const response = await client.send(command);
@@ -56,6 +59,8 @@ export interface DescribeProjectsCommandOutput extends DescribeProjectsResponse,
56
59
  * // StatusMessageCode: "SUCCESS" || "SERVICE_ERROR" || "CLIENT_ERROR",
57
60
  * // },
58
61
  * // ],
62
+ * // Feature: "CONTENT_MODERATION" || "CUSTOM_LABELS",
63
+ * // AutoUpdate: "ENABLED" || "DISABLED",
59
64
  * // },
60
65
  * // ],
61
66
  * // NextToken: "STRING_VALUE",
@@ -23,7 +23,10 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model. </p>
27
30
  * <p>You specify which version of a model version to use by using the <code>ProjectVersionArn</code> input
28
31
  * parameter. </p>
29
32
  * <p>You pass the input image as base64-encoded image bytes or as a reference to an image in
@@ -130,9 +133,11 @@ export interface DetectCustomLabelsCommandOutput extends DetectCustomLabelsRespo
130
133
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
131
134
  *
132
135
  * @throws {@link LimitExceededException} (client fault)
133
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
134
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
135
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
136
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
137
+ * concurrently, subsequent calls to start operations (ex:
138
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
139
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
140
+ * the Amazon Rekognition service limit. </p>
136
141
  *
137
142
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
138
143
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -36,6 +36,8 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
36
36
  * AWS
37
37
  * CLI to call Amazon Rekognition operations, passing image bytes is not
38
38
  * supported. The image must be either a PNG or JPEG formatted file. </p>
39
+ * <p>You can specify an adapter to use when retrieving label predictions by providing a
40
+ * <code>ProjectVersionArn</code> to the <code>ProjectVersion</code> argument.</p>
39
41
  * @example
40
42
  * Use a bare-bones client and the command you need to make an API call.
41
43
  * ```javascript
@@ -61,6 +63,7 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
61
63
  * ],
62
64
  * },
63
65
  * },
66
+ * ProjectVersion: "STRING_VALUE",
64
67
  * };
65
68
  * const command = new DetectModerationLabelsCommand(input);
66
69
  * const response = await client.send(command);
@@ -80,6 +83,7 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
80
83
  * // ],
81
84
  * // HumanLoopActivationConditionsEvaluationResults: "STRING_VALUE",
82
85
  * // },
86
+ * // ProjectVersion: "STRING_VALUE",
83
87
  * // };
84
88
  *
85
89
  * ```
@@ -119,6 +123,14 @@ export interface DetectModerationLabelsCommandOutput extends DetectModerationLab
119
123
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
120
124
  * limit, contact Amazon Rekognition.</p>
121
125
  *
126
+ * @throws {@link ResourceNotFoundException} (client fault)
127
+ * <p>The resource specified in the request cannot be found.</p>
128
+ *
129
+ * @throws {@link ResourceNotReadyException} (client fault)
130
+ * <p>The requested resource isn't ready. For example,
131
+ * this exception occurs when you call <code>DetectCustomLabels</code> with a
132
+ * model version that isn't deployed. </p>
133
+ *
122
134
  * @throws {@link ThrottlingException} (server fault)
123
135
  * <p>Amazon Rekognition is temporarily unable to process the request. Try your call again.</p>
124
136
  *
@@ -23,7 +23,10 @@ export interface DistributeDatasetEntriesCommandOutput extends DistributeDataset
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Distributes the entries (images) in a training dataset across the training dataset and the test dataset for a project.
27
30
  * <code>DistributeDatasetEntries</code> moves 20% of the training dataset images to the test dataset.
28
31
  * An entry is a JSON Line that describes an image.
29
32
  * </p>
@@ -23,7 +23,10 @@ export interface ListDatasetEntriesCommandOutput extends ListDatasetEntriesRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>
27
30
  * Lists the entries (images) within a dataset. An entry is a
28
31
  * JSON Line that contains the information for a single image, including
29
32
  * the image location, assigned labels, and object location bounding boxes. For
@@ -23,7 +23,10 @@ export interface ListDatasetLabelsCommandOutput extends ListDatasetLabelsRespons
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Lists the labels in a dataset. Amazon Rekognition Custom Labels uses labels to describe images. For more information, see
27
30
  * <a href="https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/md-labeling-images.html">Labeling images</a>.
28
31
  * </p>
29
32
  * <p>
@@ -23,7 +23,10 @@ export interface ListProjectPoliciesCommandOutput extends ListProjectPoliciesRes
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Gets a list of the project policies attached to a project.</p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Gets a list of the project policies attached to a project.</p>
27
30
  * <p>To attach a project policy to a project, call <a>PutProjectPolicy</a>. To remove a project policy from a project, call <a>DeleteProjectPolicy</a>.</p>
28
31
  * <p>This operation requires permissions to perform the <code>rekognition:ListProjectPolicies</code> action.</p>
29
32
  * @example
@@ -23,10 +23,14 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Attaches a project policy to a Amazon Rekognition Custom Labels project in a trusting AWS account. A
27
30
  * project policy specifies that a trusted AWS account can copy a model version from a
28
- * trusting AWS account to a project in the trusted AWS account. To copy a model version you use
29
- * the <a>CopyProjectVersion</a> operation.</p>
31
+ * trusting AWS account to a project in the trusted AWS account. To copy a model version
32
+ * you use the <a>CopyProjectVersion</a> operation. Only applies to Custom Labels
33
+ * projects.</p>
30
34
  * <p>For more information about the format of a project policy document, see Attaching a project policy (SDK)
31
35
  * in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
32
36
  * </p>
@@ -77,9 +81,11 @@ export interface PutProjectPolicyCommandOutput extends PutProjectPolicyResponse,
77
81
  * <p>The supplied revision id for the project policy is invalid.</p>
78
82
  *
79
83
  * @throws {@link LimitExceededException} (client fault)
80
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
81
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
82
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
84
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
85
+ * concurrently, subsequent calls to start operations (ex:
86
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
87
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
88
+ * the Amazon Rekognition service limit. </p>
83
89
  *
84
90
  * @throws {@link MalformedPolicyDocumentException} (client fault)
85
91
  * <p>The format of the project policy document that you supplied to
@@ -1,7 +1,8 @@
1
1
  import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
2
  import { Command as $Command } from "@smithy/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
- import { SearchUsersByImageRequest, SearchUsersByImageResponse } from "../models/models_0";
4
+ import { SearchUsersByImageRequest } from "../models/models_0";
5
+ import { SearchUsersByImageResponse } from "../models/models_1";
5
6
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
6
7
  /**
7
8
  * @public
@@ -1,8 +1,7 @@
1
1
  import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
2
  import { Command as $Command } from "@smithy/smithy-client";
3
3
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
- import { StartCelebrityRecognitionRequest } from "../models/models_0";
5
- import { StartCelebrityRecognitionResponse } from "../models/models_1";
4
+ import { StartCelebrityRecognitionRequest, StartCelebrityRecognitionResponse } from "../models/models_1";
6
5
  import { RekognitionClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RekognitionClient";
7
6
  /**
8
7
  * @public
@@ -88,9 +87,11 @@ export interface StartCelebrityRecognitionCommandOutput extends StartCelebrityRe
88
87
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
89
88
  *
90
89
  * @throws {@link LimitExceededException} (client fault)
91
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
92
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
93
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
90
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
91
+ * concurrently, subsequent calls to start operations (ex:
92
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
93
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
94
+ * the Amazon Rekognition service limit. </p>
94
95
  *
95
96
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
96
97
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -88,9 +88,11 @@ export interface StartContentModerationCommandOutput extends StartContentModerat
88
88
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
89
89
  *
90
90
  * @throws {@link LimitExceededException} (client fault)
91
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
92
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
93
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
91
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
92
+ * concurrently, subsequent calls to start operations (ex:
93
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
94
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
95
+ * the Amazon Rekognition service limit. </p>
94
96
  *
95
97
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
96
98
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -89,9 +89,11 @@ export interface StartFaceDetectionCommandOutput extends StartFaceDetectionRespo
89
89
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
90
90
  *
91
91
  * @throws {@link LimitExceededException} (client fault)
92
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
93
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
94
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
92
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
93
+ * concurrently, subsequent calls to start operations (ex:
94
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
95
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
96
+ * the Amazon Rekognition service limit. </p>
95
97
  *
96
98
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
97
99
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -89,9 +89,11 @@ export interface StartFaceSearchCommandOutput extends StartFaceSearchResponse, _
89
89
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
90
90
  *
91
91
  * @throws {@link LimitExceededException} (client fault)
92
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
93
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
94
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
92
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
93
+ * concurrently, subsequent calls to start operations (ex:
94
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
95
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
96
+ * the Amazon Rekognition service limit. </p>
95
97
  *
96
98
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
97
99
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -121,9 +121,11 @@ export interface StartLabelDetectionCommandOutput extends StartLabelDetectionRes
121
121
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
122
122
  *
123
123
  * @throws {@link LimitExceededException} (client fault)
124
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
125
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
126
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
124
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
125
+ * concurrently, subsequent calls to start operations (ex:
126
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
127
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
128
+ * the Amazon Rekognition service limit. </p>
127
129
  *
128
130
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
129
131
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -85,9 +85,11 @@ export interface StartPersonTrackingCommandOutput extends StartPersonTrackingRes
85
85
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
86
86
  *
87
87
  * @throws {@link LimitExceededException} (client fault)
88
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
89
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
90
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
88
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
89
+ * concurrently, subsequent calls to start operations (ex:
90
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
91
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
92
+ * the Amazon Rekognition service limit. </p>
91
93
  *
92
94
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
93
95
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -23,15 +23,17 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Starts the running of the version of a model. Starting a model takes a while
27
- * to complete. To check the current state of the model, use <a>DescribeProjectVersions</a>.</p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Starts the running of the version of a model. Starting a model takes a while to
30
+ * complete. To check the current state of the model, use <a>DescribeProjectVersions</a>. </p>
28
31
  * <p>Once the model is running, you can detect custom labels in new images by calling
29
32
  * <a>DetectCustomLabels</a>.</p>
30
33
  * <note>
31
34
  * <p>You are charged for the amount of time that the model is running. To stop a running
32
35
  * model, call <a>StopProjectVersion</a>.</p>
33
36
  * </note>
34
- * <p>For more information, see <i>Running a trained Amazon Rekognition Custom Labels model</i> in the Amazon Rekognition Custom Labels Guide.</p>
35
37
  * <p>This operation requires permissions to perform the
36
38
  * <code>rekognition:StartProjectVersion</code> action.</p>
37
39
  * @example
@@ -48,7 +50,7 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes
48
50
  * const command = new StartProjectVersionCommand(input);
49
51
  * const response = await client.send(command);
50
52
  * // { // StartProjectVersionResponse
51
- * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
53
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED" || "DEPRECATED" || "EXPIRED",
52
54
  * // };
53
55
  *
54
56
  * ```
@@ -70,9 +72,11 @@ export interface StartProjectVersionCommandOutput extends StartProjectVersionRes
70
72
  * operation again.</p>
71
73
  *
72
74
  * @throws {@link LimitExceededException} (client fault)
73
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
74
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
75
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
75
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
76
+ * concurrently, subsequent calls to start operations (ex:
77
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
78
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
79
+ * the Amazon Rekognition service limit. </p>
76
80
  *
77
81
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
78
82
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -105,9 +105,11 @@ export interface StartSegmentDetectionCommandOutput extends StartSegmentDetectio
105
105
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
106
106
  *
107
107
  * @throws {@link LimitExceededException} (client fault)
108
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
109
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
110
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
108
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
109
+ * concurrently, subsequent calls to start operations (ex:
110
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
111
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
112
+ * the Amazon Rekognition service limit. </p>
111
113
  *
112
114
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
113
115
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -107,9 +107,11 @@ export interface StartTextDetectionCommandOutput extends StartTextDetectionRespo
107
107
  * <p>Amazon Rekognition is unable to access the S3 object specified in the request.</p>
108
108
  *
109
109
  * @throws {@link LimitExceededException} (client fault)
110
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
111
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
112
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
110
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
111
+ * concurrently, subsequent calls to start operations (ex:
112
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
113
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
114
+ * the Amazon Rekognition service limit. </p>
113
115
  *
114
116
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
115
117
  * <p>The number of requests exceeded your throughput limit. If you want to increase this
@@ -23,8 +23,12 @@ export interface StopProjectVersionCommandOutput extends StopProjectVersionRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Stops a running model. The operation might take a while to complete. To
27
- * check the current status, call <a>DescribeProjectVersions</a>. </p>
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Stops a running model. The operation might take a while to complete. To check the
30
+ * current status, call <a>DescribeProjectVersions</a>. Only applies to Custom
31
+ * Labels projects.</p>
28
32
  * <p>This operation requires permissions to perform the <code>rekognition:StopProjectVersion</code> action.</p>
29
33
  * @example
30
34
  * Use a bare-bones client and the command you need to make an API call.
@@ -38,7 +42,7 @@ export interface StopProjectVersionCommandOutput extends StopProjectVersionRespo
38
42
  * const command = new StopProjectVersionCommand(input);
39
43
  * const response = await client.send(command);
40
44
  * // { // StopProjectVersionResponse
41
- * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED",
45
+ * // Status: "TRAINING_IN_PROGRESS" || "TRAINING_COMPLETED" || "TRAINING_FAILED" || "STARTING" || "RUNNING" || "FAILED" || "STOPPING" || "STOPPED" || "DELETING" || "COPYING_IN_PROGRESS" || "COPYING_COMPLETED" || "COPYING_FAILED" || "DEPRECATED" || "EXPIRED",
42
46
  * // };
43
47
  *
44
48
  * ```
@@ -23,7 +23,10 @@ export interface UpdateDatasetEntriesCommandOutput extends UpdateDatasetEntriesR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the
26
+ * <note>
27
+ * <p>This operation applies only to Amazon Rekognition Custom Labels.</p>
28
+ * </note>
29
+ * <p>Adds or updates one or more entries (images) in a dataset. An entry is a JSON Line which contains the
27
30
  * information for a single image, including
28
31
  * the image location, assigned labels, and object location bounding boxes. For more information,
29
32
  * see Image-Level labels in manifest files and Object localization in manifest files in the <i>Amazon Rekognition Custom Labels Developer Guide</i>.
@@ -80,9 +83,11 @@ export interface UpdateDatasetEntriesCommandOutput extends UpdateDatasetEntriesR
80
83
  * operation again.</p>
81
84
  *
82
85
  * @throws {@link LimitExceededException} (client fault)
83
- * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations
84
- * (<code>StartLabelDetection</code>, for example) will raise a <code>LimitExceededException</code> exception (HTTP status code: 400) until
85
- * the number of concurrently running jobs is below the Amazon Rekognition service limit. </p>
86
+ * <p>An Amazon Rekognition service limit was exceeded. For example, if you start too many jobs
87
+ * concurrently, subsequent calls to start operations (ex:
88
+ * <code>StartLabelDetection</code>) will raise a <code>LimitExceededException</code>
89
+ * exception (HTTP status code: 400) until the number of concurrently running jobs is below
90
+ * the Amazon Rekognition service limit. </p>
86
91
  *
87
92
  * @throws {@link ProvisionedThroughputExceededException} (client fault)
88
93
  * <p>The number of requests exceeded your throughput limit. If you want to increase this