@aws-sdk/client-comprehend 3.296.0 → 3.297.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 (108) hide show
  1. package/dist-types/Comprehend.d.ts +85 -0
  2. package/dist-types/ComprehendClient.d.ts +24 -4
  3. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +16 -0
  4. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +16 -0
  5. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +16 -0
  6. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +16 -0
  7. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +16 -0
  8. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +16 -0
  9. package/dist-types/commands/ClassifyDocumentCommand.d.ts +16 -0
  10. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +16 -0
  11. package/dist-types/commands/CreateDatasetCommand.d.ts +16 -0
  12. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +16 -0
  13. package/dist-types/commands/CreateEndpointCommand.d.ts +16 -0
  14. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +16 -0
  15. package/dist-types/commands/CreateFlywheelCommand.d.ts +16 -0
  16. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +16 -0
  17. package/dist-types/commands/DeleteEndpointCommand.d.ts +16 -0
  18. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +16 -0
  19. package/dist-types/commands/DeleteFlywheelCommand.d.ts +16 -0
  20. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeDatasetCommand.d.ts +16 -0
  22. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +16 -0
  23. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +16 -0
  25. package/dist-types/commands/DescribeEndpointCommand.d.ts +16 -0
  26. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +16 -0
  27. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +16 -0
  28. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +16 -0
  29. package/dist-types/commands/DescribeFlywheelCommand.d.ts +16 -0
  30. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +16 -0
  31. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +16 -0
  32. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +16 -0
  33. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +16 -0
  34. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +16 -0
  35. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +16 -0
  37. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +16 -0
  38. package/dist-types/commands/DetectEntitiesCommand.d.ts +16 -0
  39. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +16 -0
  40. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +16 -0
  41. package/dist-types/commands/DetectSentimentCommand.d.ts +16 -0
  42. package/dist-types/commands/DetectSyntaxCommand.d.ts +16 -0
  43. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +16 -0
  44. package/dist-types/commands/ImportModelCommand.d.ts +16 -0
  45. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -0
  46. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +16 -0
  47. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +16 -0
  48. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +16 -0
  49. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +16 -0
  50. package/dist-types/commands/ListEndpointsCommand.d.ts +16 -0
  51. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +16 -0
  52. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +16 -0
  53. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +16 -0
  54. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +16 -0
  55. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +16 -0
  56. package/dist-types/commands/ListFlywheelsCommand.d.ts +16 -0
  57. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +16 -0
  58. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +16 -0
  59. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +16 -0
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  61. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +16 -0
  62. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +16 -0
  63. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  64. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +16 -0
  65. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +16 -0
  66. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +16 -0
  67. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +16 -0
  68. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +16 -0
  69. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +16 -0
  70. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +16 -0
  71. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +16 -0
  72. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +16 -0
  73. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +16 -0
  74. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +16 -0
  75. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +16 -0
  76. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +16 -0
  77. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +16 -0
  78. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +16 -0
  79. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +16 -0
  80. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +16 -0
  81. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +16 -0
  82. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +16 -0
  83. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  84. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  85. package/dist-types/commands/UpdateEndpointCommand.d.ts +16 -0
  86. package/dist-types/commands/UpdateFlywheelCommand.d.ts +16 -0
  87. package/dist-types/models/ComprehendServiceException.d.ts +2 -0
  88. package/dist-types/models/models_0.d.ts +680 -6
  89. package/dist-types/models/models_1.d.ts +45 -0
  90. package/dist-types/pagination/Interfaces.d.ts +3 -0
  91. package/dist-types/pagination/ListDatasetsPaginator.d.ts +3 -0
  92. package/dist-types/pagination/ListDocumentClassificationJobsPaginator.d.ts +3 -0
  93. package/dist-types/pagination/ListDocumentClassifierSummariesPaginator.d.ts +3 -0
  94. package/dist-types/pagination/ListDocumentClassifiersPaginator.d.ts +3 -0
  95. package/dist-types/pagination/ListDominantLanguageDetectionJobsPaginator.d.ts +3 -0
  96. package/dist-types/pagination/ListEndpointsPaginator.d.ts +3 -0
  97. package/dist-types/pagination/ListEntitiesDetectionJobsPaginator.d.ts +3 -0
  98. package/dist-types/pagination/ListEntityRecognizerSummariesPaginator.d.ts +3 -0
  99. package/dist-types/pagination/ListEntityRecognizersPaginator.d.ts +3 -0
  100. package/dist-types/pagination/ListEventsDetectionJobsPaginator.d.ts +3 -0
  101. package/dist-types/pagination/ListFlywheelIterationHistoryPaginator.d.ts +3 -0
  102. package/dist-types/pagination/ListFlywheelsPaginator.d.ts +3 -0
  103. package/dist-types/pagination/ListKeyPhrasesDetectionJobsPaginator.d.ts +3 -0
  104. package/dist-types/pagination/ListPiiEntitiesDetectionJobsPaginator.d.ts +3 -0
  105. package/dist-types/pagination/ListSentimentDetectionJobsPaginator.d.ts +3 -0
  106. package/dist-types/pagination/ListTargetedSentimentDetectionJobsPaginator.d.ts +3 -0
  107. package/dist-types/pagination/ListTopicsDetectionJobsPaginator.d.ts +3 -0
  108. package/package.json +3 -3
@@ -85,6 +85,7 @@ import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./comma
85
85
  import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput } from "./commands/UpdateFlywheelCommand";
86
86
  import { ComprehendClient } from "./ComprehendClient";
87
87
  /**
88
+ * @public
88
89
  * <p>Amazon Comprehend is an AWS service for gaining insight into the content of documents.
89
90
  * Use these actions to determine the topics contained in your documents, the topics they
90
91
  * discuss, the predominant sentiment expressed in them, the predominant language used, and
@@ -92,6 +93,7 @@ import { ComprehendClient } from "./ComprehendClient";
92
93
  */
93
94
  export declare class Comprehend extends ComprehendClient {
94
95
  /**
96
+ * @public
95
97
  * <p>Determines the dominant language of the input text for a batch of documents. For a list
96
98
  * of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>.
97
99
  * </p>
@@ -100,6 +102,7 @@ export declare class Comprehend extends ComprehendClient {
100
102
  batchDetectDominantLanguage(args: BatchDetectDominantLanguageCommandInput, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void): void;
101
103
  batchDetectDominantLanguage(args: BatchDetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectDominantLanguageCommandOutput) => void): void;
102
104
  /**
105
+ * @public
103
106
  * <p>Inspects the text of a batch of documents for named entities and returns information
104
107
  * about them. For more information about named entities, see
105
108
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.
@@ -109,12 +112,14 @@ export declare class Comprehend extends ComprehendClient {
109
112
  batchDetectEntities(args: BatchDetectEntitiesCommandInput, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void): void;
110
113
  batchDetectEntities(args: BatchDetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectEntitiesCommandOutput) => void): void;
111
114
  /**
115
+ * @public
112
116
  * <p>Detects the key noun phrases found in a batch of documents.</p>
113
117
  */
114
118
  batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions): Promise<BatchDetectKeyPhrasesCommandOutput>;
115
119
  batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void): void;
116
120
  batchDetectKeyPhrases(args: BatchDetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectKeyPhrasesCommandOutput) => void): void;
117
121
  /**
122
+ * @public
118
123
  * <p>Inspects a batch of documents and returns an inference of the prevailing sentiment,
119
124
  * <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>,
120
125
  * in each one.</p>
@@ -123,6 +128,7 @@ export declare class Comprehend extends ComprehendClient {
123
128
  batchDetectSentiment(args: BatchDetectSentimentCommandInput, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void): void;
124
129
  batchDetectSentiment(args: BatchDetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSentimentCommandOutput) => void): void;
125
130
  /**
131
+ * @public
126
132
  * <p>Inspects the text of a batch of documents for the syntax and part of speech of the words
127
133
  * in the document and returns information about them. For more information, see
128
134
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide.
@@ -132,6 +138,7 @@ export declare class Comprehend extends ComprehendClient {
132
138
  batchDetectSyntax(args: BatchDetectSyntaxCommandInput, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void): void;
133
139
  batchDetectSyntax(args: BatchDetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectSyntaxCommandOutput) => void): void;
134
140
  /**
141
+ * @public
135
142
  * <p>Inspects a batch of documents and returns a sentiment analysis
136
143
  * for each entity identified in the documents.</p>
137
144
  * <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
@@ -140,6 +147,7 @@ export declare class Comprehend extends ComprehendClient {
140
147
  batchDetectTargetedSentiment(args: BatchDetectTargetedSentimentCommandInput, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void): void;
141
148
  batchDetectTargetedSentiment(args: BatchDetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDetectTargetedSentimentCommandOutput) => void): void;
142
149
  /**
150
+ * @public
143
151
  * <p>Creates a new document classification request to analyze a single document in real-time,
144
152
  * using a previously created and trained custom model and an endpoint.</p>
145
153
  * <p>You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
@@ -156,6 +164,7 @@ export declare class Comprehend extends ComprehendClient {
156
164
  classifyDocument(args: ClassifyDocumentCommandInput, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void): void;
157
165
  classifyDocument(args: ClassifyDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClassifyDocumentCommandOutput) => void): void;
158
166
  /**
167
+ * @public
159
168
  * <p>Analyzes input text for the presence of personally identifiable information (PII) and
160
169
  * returns the labels of identified PII entity types such as name, address, bank account number,
161
170
  * or phone number.</p>
@@ -164,6 +173,7 @@ export declare class Comprehend extends ComprehendClient {
164
173
  containsPiiEntities(args: ContainsPiiEntitiesCommandInput, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void): void;
165
174
  containsPiiEntities(args: ContainsPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContainsPiiEntitiesCommandOutput) => void): void;
166
175
  /**
176
+ * @public
167
177
  * <p>Creates a dataset to upload training or test data for a model associated with a flywheel.
168
178
  * For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
169
179
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -172,6 +182,7 @@ export declare class Comprehend extends ComprehendClient {
172
182
  createDataset(args: CreateDatasetCommandInput, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
173
183
  createDataset(args: CreateDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDatasetCommandOutput) => void): void;
174
184
  /**
185
+ * @public
175
186
  * <p>Creates a new document classifier that you can use to categorize documents. To create a
176
187
  * classifier, you provide a set of training documents that labeled with the categories that you
177
188
  * want to use. After the classifier is trained you can use it to categorize a set of labeled
@@ -183,6 +194,7 @@ export declare class Comprehend extends ComprehendClient {
183
194
  createDocumentClassifier(args: CreateDocumentClassifierCommandInput, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void): void;
184
195
  createDocumentClassifier(args: CreateDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDocumentClassifierCommandOutput) => void): void;
185
196
  /**
197
+ * @public
186
198
  * <p>Creates a model-specific endpoint for synchronous inference for a previously trained
187
199
  * custom model
188
200
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
@@ -191,6 +203,7 @@ export declare class Comprehend extends ComprehendClient {
191
203
  createEndpoint(args: CreateEndpointCommandInput, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
192
204
  createEndpoint(args: CreateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEndpointCommandOutput) => void): void;
193
205
  /**
206
+ * @public
194
207
  * <p>Creates an entity recognizer using submitted files. After your
195
208
  * <code>CreateEntityRecognizer</code> request is submitted, you can check job status using the
196
209
  * <code>DescribeEntityRecognizer</code> API. </p>
@@ -199,6 +212,7 @@ export declare class Comprehend extends ComprehendClient {
199
212
  createEntityRecognizer(args: CreateEntityRecognizerCommandInput, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
200
213
  createEntityRecognizer(args: CreateEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
201
214
  /**
215
+ * @public
202
216
  * <p>A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification
203
217
  * or custom entity recognition. You can create a flywheel to start with an existing trained model, or
204
218
  * Comprehend can create and train a new model.</p>
@@ -215,6 +229,7 @@ export declare class Comprehend extends ComprehendClient {
215
229
  createFlywheel(args: CreateFlywheelCommandInput, cb: (err: any, data?: CreateFlywheelCommandOutput) => void): void;
216
230
  createFlywheel(args: CreateFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFlywheelCommandOutput) => void): void;
217
231
  /**
232
+ * @public
218
233
  * <p>Deletes a previously created document classifier</p>
219
234
  * <p>Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
220
235
  * If an active inference job is using the model, a <code>ResourceInUseException</code> will be
@@ -227,6 +242,7 @@ export declare class Comprehend extends ComprehendClient {
227
242
  deleteDocumentClassifier(args: DeleteDocumentClassifierCommandInput, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void): void;
228
243
  deleteDocumentClassifier(args: DeleteDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDocumentClassifierCommandOutput) => void): void;
229
244
  /**
245
+ * @public
230
246
  * <p>Deletes a model-specific endpoint for a previously-trained custom model. All endpoints
231
247
  * must be deleted in order for the model to be deleted.
232
248
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
@@ -235,6 +251,7 @@ export declare class Comprehend extends ComprehendClient {
235
251
  deleteEndpoint(args: DeleteEndpointCommandInput, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
236
252
  deleteEndpoint(args: DeleteEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEndpointCommandOutput) => void): void;
237
253
  /**
254
+ * @public
238
255
  * <p>Deletes an entity recognizer.</p>
239
256
  * <p>Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted.
240
257
  * If an active inference job is using the model, a <code>ResourceInUseException</code> will be
@@ -247,6 +264,7 @@ export declare class Comprehend extends ComprehendClient {
247
264
  deleteEntityRecognizer(args: DeleteEntityRecognizerCommandInput, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void): void;
248
265
  deleteEntityRecognizer(args: DeleteEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEntityRecognizerCommandOutput) => void): void;
249
266
  /**
267
+ * @public
250
268
  * <p>Deletes a flywheel. When you delete the flywheel, Amazon Comprehend
251
269
  * does not delete the data lake or the model associated with the flywheel.</p>
252
270
  * <p>For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
@@ -256,12 +274,14 @@ export declare class Comprehend extends ComprehendClient {
256
274
  deleteFlywheel(args: DeleteFlywheelCommandInput, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void): void;
257
275
  deleteFlywheel(args: DeleteFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFlywheelCommandOutput) => void): void;
258
276
  /**
277
+ * @public
259
278
  * <p>Deletes a resource-based policy that is attached to a custom model.</p>
260
279
  */
261
280
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourcePolicyCommandOutput>;
262
281
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
263
282
  deleteResourcePolicy(args: DeleteResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourcePolicyCommandOutput) => void): void;
264
283
  /**
284
+ * @public
265
285
  * <p>Returns information about the dataset that you specify.
266
286
  * For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
267
287
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -270,6 +290,7 @@ export declare class Comprehend extends ComprehendClient {
270
290
  describeDataset(args: DescribeDatasetCommandInput, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
271
291
  describeDataset(args: DescribeDatasetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDatasetCommandOutput) => void): void;
272
292
  /**
293
+ * @public
273
294
  * <p>Gets the properties associated with a document classification job. Use this operation to
274
295
  * get the status of a classification job.</p>
275
296
  */
@@ -277,12 +298,14 @@ export declare class Comprehend extends ComprehendClient {
277
298
  describeDocumentClassificationJob(args: DescribeDocumentClassificationJobCommandInput, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void): void;
278
299
  describeDocumentClassificationJob(args: DescribeDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassificationJobCommandOutput) => void): void;
279
300
  /**
301
+ * @public
280
302
  * <p>Gets the properties associated with a document classifier.</p>
281
303
  */
282
304
  describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDocumentClassifierCommandOutput>;
283
305
  describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void): void;
284
306
  describeDocumentClassifier(args: DescribeDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentClassifierCommandOutput) => void): void;
285
307
  /**
308
+ * @public
286
309
  * <p>Gets the properties associated with a dominant language detection job. Use this operation
287
310
  * to get the status of a detection job.</p>
288
311
  */
@@ -290,6 +313,7 @@ export declare class Comprehend extends ComprehendClient {
290
313
  describeDominantLanguageDetectionJob(args: DescribeDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void): void;
291
314
  describeDominantLanguageDetectionJob(args: DescribeDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDominantLanguageDetectionJobCommandOutput) => void): void;
292
315
  /**
316
+ * @public
293
317
  * <p>Gets the properties associated with a specific endpoint. Use this operation to get the
294
318
  * status of an endpoint.
295
319
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
@@ -298,6 +322,7 @@ export declare class Comprehend extends ComprehendClient {
298
322
  describeEndpoint(args: DescribeEndpointCommandInput, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
299
323
  describeEndpoint(args: DescribeEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEndpointCommandOutput) => void): void;
300
324
  /**
325
+ * @public
301
326
  * <p>Gets the properties associated with an entities detection job. Use this operation to get
302
327
  * the status of a detection job.</p>
303
328
  */
@@ -305,6 +330,7 @@ export declare class Comprehend extends ComprehendClient {
305
330
  describeEntitiesDetectionJob(args: DescribeEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void): void;
306
331
  describeEntitiesDetectionJob(args: DescribeEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntitiesDetectionJobCommandOutput) => void): void;
307
332
  /**
333
+ * @public
308
334
  * <p>Provides details about an entity recognizer including status, S3 buckets containing
309
335
  * training data, recognizer metadata, metrics, and so on.</p>
310
336
  */
@@ -312,12 +338,14 @@ export declare class Comprehend extends ComprehendClient {
312
338
  describeEntityRecognizer(args: DescribeEntityRecognizerCommandInput, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void): void;
313
339
  describeEntityRecognizer(args: DescribeEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEntityRecognizerCommandOutput) => void): void;
314
340
  /**
341
+ * @public
315
342
  * <p>Gets the status and details of an events detection job.</p>
316
343
  */
317
344
  describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEventsDetectionJobCommandOutput>;
318
345
  describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void): void;
319
346
  describeEventsDetectionJob(args: DescribeEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEventsDetectionJobCommandOutput) => void): void;
320
347
  /**
348
+ * @public
321
349
  * <p>Provides configuration information about the flywheel. For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
322
350
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
323
351
  */
@@ -325,6 +353,7 @@ export declare class Comprehend extends ComprehendClient {
325
353
  describeFlywheel(args: DescribeFlywheelCommandInput, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void): void;
326
354
  describeFlywheel(args: DescribeFlywheelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelCommandOutput) => void): void;
327
355
  /**
356
+ * @public
328
357
  * <p>Retrieve the configuration properties of a flywheel iteration.
329
358
  * For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
330
359
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -333,6 +362,7 @@ export declare class Comprehend extends ComprehendClient {
333
362
  describeFlywheelIteration(args: DescribeFlywheelIterationCommandInput, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void): void;
334
363
  describeFlywheelIteration(args: DescribeFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFlywheelIterationCommandOutput) => void): void;
335
364
  /**
365
+ * @public
336
366
  * <p>Gets the properties associated with a key phrases detection job. Use this operation to get
337
367
  * the status of a detection job.</p>
338
368
  */
@@ -340,6 +370,7 @@ export declare class Comprehend extends ComprehendClient {
340
370
  describeKeyPhrasesDetectionJob(args: DescribeKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void): void;
341
371
  describeKeyPhrasesDetectionJob(args: DescribeKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeKeyPhrasesDetectionJobCommandOutput) => void): void;
342
372
  /**
373
+ * @public
343
374
  * <p>Gets the properties associated with a PII entities detection job. For example, you can use
344
375
  * this operation to get the job status.</p>
345
376
  */
@@ -347,6 +378,7 @@ export declare class Comprehend extends ComprehendClient {
347
378
  describePiiEntitiesDetectionJob(args: DescribePiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void): void;
348
379
  describePiiEntitiesDetectionJob(args: DescribePiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePiiEntitiesDetectionJobCommandOutput) => void): void;
349
380
  /**
381
+ * @public
350
382
  * <p>Gets the details of a resource-based policy that is attached to a custom model, including
351
383
  * the JSON body of the policy.</p>
352
384
  */
@@ -354,6 +386,7 @@ export declare class Comprehend extends ComprehendClient {
354
386
  describeResourcePolicy(args: DescribeResourcePolicyCommandInput, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void): void;
355
387
  describeResourcePolicy(args: DescribeResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeResourcePolicyCommandOutput) => void): void;
356
388
  /**
389
+ * @public
357
390
  * <p>Gets the properties associated with a sentiment detection job. Use this operation to get
358
391
  * the status of a detection job.</p>
359
392
  */
@@ -361,6 +394,7 @@ export declare class Comprehend extends ComprehendClient {
361
394
  describeSentimentDetectionJob(args: DescribeSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void): void;
362
395
  describeSentimentDetectionJob(args: DescribeSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSentimentDetectionJobCommandOutput) => void): void;
363
396
  /**
397
+ * @public
364
398
  * <p>Gets the properties associated with a targeted sentiment detection job. Use this operation
365
399
  * to get the status of the job.</p>
366
400
  */
@@ -368,6 +402,7 @@ export declare class Comprehend extends ComprehendClient {
368
402
  describeTargetedSentimentDetectionJob(args: DescribeTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void): void;
369
403
  describeTargetedSentimentDetectionJob(args: DescribeTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTargetedSentimentDetectionJobCommandOutput) => void): void;
370
404
  /**
405
+ * @public
371
406
  * <p>Gets the properties associated with a topic detection job. Use this operation to get
372
407
  * the status of a detection job.</p>
373
408
  */
@@ -375,6 +410,7 @@ export declare class Comprehend extends ComprehendClient {
375
410
  describeTopicsDetectionJob(args: DescribeTopicsDetectionJobCommandInput, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void): void;
376
411
  describeTopicsDetectionJob(args: DescribeTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTopicsDetectionJobCommandOutput) => void): void;
377
412
  /**
413
+ * @public
378
414
  * <p>Determines the dominant language of the input text. For a list of languages that Amazon
379
415
  * Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>. </p>
380
416
  */
@@ -382,6 +418,7 @@ export declare class Comprehend extends ComprehendClient {
382
418
  detectDominantLanguage(args: DetectDominantLanguageCommandInput, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
383
419
  detectDominantLanguage(args: DetectDominantLanguageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectDominantLanguageCommandOutput) => void): void;
384
420
  /**
421
+ * @public
385
422
  * <p>Detects named entities in input text when you use the pre-trained model.
386
423
  * Detects custom entities if you have a custom entity recognition model. </p>
387
424
  * <p>
@@ -403,12 +440,14 @@ export declare class Comprehend extends ComprehendClient {
403
440
  detectEntities(args: DetectEntitiesCommandInput, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void;
404
441
  detectEntities(args: DetectEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectEntitiesCommandOutput) => void): void;
405
442
  /**
443
+ * @public
406
444
  * <p>Detects the key noun phrases found in the text. </p>
407
445
  */
408
446
  detectKeyPhrases(args: DetectKeyPhrasesCommandInput, options?: __HttpHandlerOptions): Promise<DetectKeyPhrasesCommandOutput>;
409
447
  detectKeyPhrases(args: DetectKeyPhrasesCommandInput, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void): void;
410
448
  detectKeyPhrases(args: DetectKeyPhrasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectKeyPhrasesCommandOutput) => void): void;
411
449
  /**
450
+ * @public
412
451
  * <p>Inspects the input text for entities that contain personally identifiable information
413
452
  * (PII) and returns information about them.</p>
414
453
  */
@@ -416,6 +455,7 @@ export declare class Comprehend extends ComprehendClient {
416
455
  detectPiiEntities(args: DetectPiiEntitiesCommandInput, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void): void;
417
456
  detectPiiEntities(args: DetectPiiEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectPiiEntitiesCommandOutput) => void): void;
418
457
  /**
458
+ * @public
419
459
  * <p>Inspects text and returns an inference of the prevailing sentiment
420
460
  * (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>
421
461
  */
@@ -423,6 +463,7 @@ export declare class Comprehend extends ComprehendClient {
423
463
  detectSentiment(args: DetectSentimentCommandInput, cb: (err: any, data?: DetectSentimentCommandOutput) => void): void;
424
464
  detectSentiment(args: DetectSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSentimentCommandOutput) => void): void;
425
465
  /**
466
+ * @public
426
467
  * <p>Inspects text for syntax and the part of speech of words in the document. For more
427
468
  * information, see
428
469
  * <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide.
@@ -432,6 +473,7 @@ export declare class Comprehend extends ComprehendClient {
432
473
  detectSyntax(args: DetectSyntaxCommandInput, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void;
433
474
  detectSyntax(args: DetectSyntaxCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectSyntaxCommandOutput) => void): void;
434
475
  /**
476
+ * @public
435
477
  * <p>Inspects the input text and returns a sentiment analysis for each entity identified in the text.</p>
436
478
  * <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
437
479
  */
@@ -439,6 +481,7 @@ export declare class Comprehend extends ComprehendClient {
439
481
  detectTargetedSentiment(args: DetectTargetedSentimentCommandInput, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void): void;
440
482
  detectTargetedSentiment(args: DetectTargetedSentimentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectTargetedSentimentCommandOutput) => void): void;
441
483
  /**
484
+ * @public
442
485
  * <p>Creates a new custom model that replicates a source custom model that you import. The
443
486
  * source model can be in your AWS account or another one.</p>
444
487
  * <p>If the source model is in another AWS account, then it must have a resource-based policy
@@ -450,6 +493,7 @@ export declare class Comprehend extends ComprehendClient {
450
493
  importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
451
494
  importModel(args: ImportModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
452
495
  /**
496
+ * @public
453
497
  * <p>List the datasets that you have configured in this region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
454
498
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
455
499
  */
@@ -457,30 +501,35 @@ export declare class Comprehend extends ComprehendClient {
457
501
  listDatasets(args: ListDatasetsCommandInput, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
458
502
  listDatasets(args: ListDatasetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDatasetsCommandOutput) => void): void;
459
503
  /**
504
+ * @public
460
505
  * <p>Gets a list of the documentation classification jobs that you have submitted.</p>
461
506
  */
462
507
  listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassificationJobsCommandOutput>;
463
508
  listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void): void;
464
509
  listDocumentClassificationJobs(args: ListDocumentClassificationJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassificationJobsCommandOutput) => void): void;
465
510
  /**
511
+ * @public
466
512
  * <p>Gets a list of the document classifiers that you have created.</p>
467
513
  */
468
514
  listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassifiersCommandOutput>;
469
515
  listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void): void;
470
516
  listDocumentClassifiers(args: ListDocumentClassifiersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifiersCommandOutput) => void): void;
471
517
  /**
518
+ * @public
472
519
  * <p>Gets a list of summaries of the document classifiers that you have created</p>
473
520
  */
474
521
  listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, options?: __HttpHandlerOptions): Promise<ListDocumentClassifierSummariesCommandOutput>;
475
522
  listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void): void;
476
523
  listDocumentClassifierSummaries(args: ListDocumentClassifierSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDocumentClassifierSummariesCommandOutput) => void): void;
477
524
  /**
525
+ * @public
478
526
  * <p>Gets a list of the dominant language detection jobs that you have submitted.</p>
479
527
  */
480
528
  listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDominantLanguageDetectionJobsCommandOutput>;
481
529
  listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void): void;
482
530
  listDominantLanguageDetectionJobs(args: ListDominantLanguageDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDominantLanguageDetectionJobsCommandOutput) => void): void;
483
531
  /**
532
+ * @public
484
533
  * <p>Gets a list of all existing endpoints that you've created.
485
534
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
486
535
  */
@@ -488,12 +537,14 @@ export declare class Comprehend extends ComprehendClient {
488
537
  listEndpoints(args: ListEndpointsCommandInput, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
489
538
  listEndpoints(args: ListEndpointsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEndpointsCommandOutput) => void): void;
490
539
  /**
540
+ * @public
491
541
  * <p>Gets a list of the entity detection jobs that you have submitted.</p>
492
542
  */
493
543
  listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListEntitiesDetectionJobsCommandOutput>;
494
544
  listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void): void;
495
545
  listEntitiesDetectionJobs(args: ListEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntitiesDetectionJobsCommandOutput) => void): void;
496
546
  /**
547
+ * @public
497
548
  * <p>Gets a list of the properties of all entity recognizers that you created, including
498
549
  * recognizers currently in training. Allows you to filter the list of recognizers based on
499
550
  * criteria such as status and submission time. This call returns up to 500 entity recognizers in
@@ -505,18 +556,21 @@ export declare class Comprehend extends ComprehendClient {
505
556
  listEntityRecognizers(args: ListEntityRecognizersCommandInput, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void): void;
506
557
  listEntityRecognizers(args: ListEntityRecognizersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizersCommandOutput) => void): void;
507
558
  /**
559
+ * @public
508
560
  * <p>Gets a list of summaries for the entity recognizers that you have created.</p>
509
561
  */
510
562
  listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, options?: __HttpHandlerOptions): Promise<ListEntityRecognizerSummariesCommandOutput>;
511
563
  listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void): void;
512
564
  listEntityRecognizerSummaries(args: ListEntityRecognizerSummariesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityRecognizerSummariesCommandOutput) => void): void;
513
565
  /**
566
+ * @public
514
567
  * <p>Gets a list of the events detection jobs that you have submitted.</p>
515
568
  */
516
569
  listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListEventsDetectionJobsCommandOutput>;
517
570
  listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void): void;
518
571
  listEventsDetectionJobs(args: ListEventsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEventsDetectionJobsCommandOutput) => void): void;
519
572
  /**
573
+ * @public
520
574
  * <p>Information about the history of a flywheel iteration.
521
575
  * For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
522
576
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -525,48 +579,56 @@ export declare class Comprehend extends ComprehendClient {
525
579
  listFlywheelIterationHistory(args: ListFlywheelIterationHistoryCommandInput, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void): void;
526
580
  listFlywheelIterationHistory(args: ListFlywheelIterationHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelIterationHistoryCommandOutput) => void): void;
527
581
  /**
582
+ * @public
528
583
  * <p>Gets a list of the flywheels that you have created.</p>
529
584
  */
530
585
  listFlywheels(args: ListFlywheelsCommandInput, options?: __HttpHandlerOptions): Promise<ListFlywheelsCommandOutput>;
531
586
  listFlywheels(args: ListFlywheelsCommandInput, cb: (err: any, data?: ListFlywheelsCommandOutput) => void): void;
532
587
  listFlywheels(args: ListFlywheelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFlywheelsCommandOutput) => void): void;
533
588
  /**
589
+ * @public
534
590
  * <p>Get a list of key phrase detection jobs that you have submitted.</p>
535
591
  */
536
592
  listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListKeyPhrasesDetectionJobsCommandOutput>;
537
593
  listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void): void;
538
594
  listKeyPhrasesDetectionJobs(args: ListKeyPhrasesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKeyPhrasesDetectionJobsCommandOutput) => void): void;
539
595
  /**
596
+ * @public
540
597
  * <p>Gets a list of the PII entity detection jobs that you have submitted.</p>
541
598
  */
542
599
  listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListPiiEntitiesDetectionJobsCommandOutput>;
543
600
  listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void): void;
544
601
  listPiiEntitiesDetectionJobs(args: ListPiiEntitiesDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPiiEntitiesDetectionJobsCommandOutput) => void): void;
545
602
  /**
603
+ * @public
546
604
  * <p>Gets a list of sentiment detection jobs that you have submitted.</p>
547
605
  */
548
606
  listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListSentimentDetectionJobsCommandOutput>;
549
607
  listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void): void;
550
608
  listSentimentDetectionJobs(args: ListSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSentimentDetectionJobsCommandOutput) => void): void;
551
609
  /**
610
+ * @public
552
611
  * <p>Lists all tags associated with a given Amazon Comprehend resource. </p>
553
612
  */
554
613
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
555
614
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
556
615
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
557
616
  /**
617
+ * @public
558
618
  * <p>Gets a list of targeted sentiment detection jobs that you have submitted.</p>
559
619
  */
560
620
  listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTargetedSentimentDetectionJobsCommandOutput>;
561
621
  listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void): void;
562
622
  listTargetedSentimentDetectionJobs(args: ListTargetedSentimentDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTargetedSentimentDetectionJobsCommandOutput) => void): void;
563
623
  /**
624
+ * @public
564
625
  * <p>Gets a list of the topic detection jobs that you have submitted.</p>
565
626
  */
566
627
  listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListTopicsDetectionJobsCommandOutput>;
567
628
  listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void): void;
568
629
  listTopicsDetectionJobs(args: ListTopicsDetectionJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTopicsDetectionJobsCommandOutput) => void): void;
569
630
  /**
631
+ * @public
570
632
  * <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
571
633
  * an entity in another AWS account to import the custom model, which replicates it in Amazon
572
634
  * Comprehend in their account.</p>
@@ -575,6 +637,7 @@ export declare class Comprehend extends ComprehendClient {
575
637
  putResourcePolicy(args: PutResourcePolicyCommandInput, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
576
638
  putResourcePolicy(args: PutResourcePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourcePolicyCommandOutput) => void): void;
577
639
  /**
640
+ * @public
578
641
  * <p>Starts an asynchronous document classification job. Use the
579
642
  * <code>DescribeDocumentClassificationJob</code>
580
643
  * operation to track the progress of the job.</p>
@@ -583,6 +646,7 @@ export declare class Comprehend extends ComprehendClient {
583
646
  startDocumentClassificationJob(args: StartDocumentClassificationJobCommandInput, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void): void;
584
647
  startDocumentClassificationJob(args: StartDocumentClassificationJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDocumentClassificationJobCommandOutput) => void): void;
585
648
  /**
649
+ * @public
586
650
  * <p>Starts an asynchronous dominant language detection job for a collection of documents. Use
587
651
  * the operation to track the status
588
652
  * of a job.</p>
@@ -591,6 +655,7 @@ export declare class Comprehend extends ComprehendClient {
591
655
  startDominantLanguageDetectionJob(args: StartDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void): void;
592
656
  startDominantLanguageDetectionJob(args: StartDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDominantLanguageDetectionJobCommandOutput) => void): void;
593
657
  /**
658
+ * @public
594
659
  * <p>Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.</p>
595
660
  * <p>This API can be used for either standard entity detection or custom entity recognition. In
596
661
  * order to be used for custom entity recognition, the optional <code>EntityRecognizerArn</code>
@@ -601,12 +666,14 @@ export declare class Comprehend extends ComprehendClient {
601
666
  startEntitiesDetectionJob(args: StartEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void): void;
602
667
  startEntitiesDetectionJob(args: StartEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEntitiesDetectionJobCommandOutput) => void): void;
603
668
  /**
669
+ * @public
604
670
  * <p>Starts an asynchronous event detection job for a collection of documents.</p>
605
671
  */
606
672
  startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartEventsDetectionJobCommandOutput>;
607
673
  startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void): void;
608
674
  startEventsDetectionJob(args: StartEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartEventsDetectionJobCommandOutput) => void): void;
609
675
  /**
676
+ * @public
610
677
  * <p>Start the flywheel iteration.This operation uses any new datasets to train a new model version.
611
678
  * For more information about flywheels, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
612
679
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -615,6 +682,7 @@ export declare class Comprehend extends ComprehendClient {
615
682
  startFlywheelIteration(args: StartFlywheelIterationCommandInput, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void): void;
616
683
  startFlywheelIteration(args: StartFlywheelIterationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFlywheelIterationCommandOutput) => void): void;
617
684
  /**
685
+ * @public
618
686
  * <p>Starts an asynchronous key phrase detection job for a collection of documents. Use the
619
687
  * operation to track the status of a
620
688
  * job.</p>
@@ -623,12 +691,14 @@ export declare class Comprehend extends ComprehendClient {
623
691
  startKeyPhrasesDetectionJob(args: StartKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void): void;
624
692
  startKeyPhrasesDetectionJob(args: StartKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartKeyPhrasesDetectionJobCommandOutput) => void): void;
625
693
  /**
694
+ * @public
626
695
  * <p>Starts an asynchronous PII entity detection job for a collection of documents.</p>
627
696
  */
628
697
  startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StartPiiEntitiesDetectionJobCommandOutput>;
629
698
  startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void): void;
630
699
  startPiiEntitiesDetectionJob(args: StartPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartPiiEntitiesDetectionJobCommandOutput) => void): void;
631
700
  /**
701
+ * @public
632
702
  * <p>Starts an asynchronous sentiment detection job for a collection of documents. Use the
633
703
  * operation to track the status of a
634
704
  * job.</p>
@@ -637,6 +707,7 @@ export declare class Comprehend extends ComprehendClient {
637
707
  startSentimentDetectionJob(args: StartSentimentDetectionJobCommandInput, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void): void;
638
708
  startSentimentDetectionJob(args: StartSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSentimentDetectionJobCommandOutput) => void): void;
639
709
  /**
710
+ * @public
640
711
  * <p>Starts an asynchronous targeted sentiment detection job for a collection of documents. Use the
641
712
  * <code>DescribeTargetedSentimentDetectionJob</code> operation to track the status of a
642
713
  * job.</p>
@@ -645,6 +716,7 @@ export declare class Comprehend extends ComprehendClient {
645
716
  startTargetedSentimentDetectionJob(args: StartTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void): void;
646
717
  startTargetedSentimentDetectionJob(args: StartTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTargetedSentimentDetectionJobCommandOutput) => void): void;
647
718
  /**
719
+ * @public
648
720
  * <p>Starts an asynchronous topic detection job. Use the
649
721
  * <code>DescribeTopicDetectionJob</code> operation to track the status of a job.</p>
650
722
  */
@@ -652,6 +724,7 @@ export declare class Comprehend extends ComprehendClient {
652
724
  startTopicsDetectionJob(args: StartTopicsDetectionJobCommandInput, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void): void;
653
725
  startTopicsDetectionJob(args: StartTopicsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartTopicsDetectionJobCommandOutput) => void): void;
654
726
  /**
727
+ * @public
655
728
  * <p>Stops a dominant language detection job in progress.</p>
656
729
  * <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
657
730
  * into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
@@ -667,6 +740,7 @@ export declare class Comprehend extends ComprehendClient {
667
740
  stopDominantLanguageDetectionJob(args: StopDominantLanguageDetectionJobCommandInput, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void): void;
668
741
  stopDominantLanguageDetectionJob(args: StopDominantLanguageDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDominantLanguageDetectionJobCommandOutput) => void): void;
669
742
  /**
743
+ * @public
670
744
  * <p>Stops an entities detection job in progress.</p>
671
745
  * <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
672
746
  * into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
@@ -682,12 +756,14 @@ export declare class Comprehend extends ComprehendClient {
682
756
  stopEntitiesDetectionJob(args: StopEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void): void;
683
757
  stopEntitiesDetectionJob(args: StopEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEntitiesDetectionJobCommandOutput) => void): void;
684
758
  /**
759
+ * @public
685
760
  * <p>Stops an events detection job in progress.</p>
686
761
  */
687
762
  stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopEventsDetectionJobCommandOutput>;
688
763
  stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void): void;
689
764
  stopEventsDetectionJob(args: StopEventsDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopEventsDetectionJobCommandOutput) => void): void;
690
765
  /**
766
+ * @public
691
767
  * <p>Stops a key phrases detection job in progress.</p>
692
768
  * <p>If the job state is <code>IN_PROGRESS</code> the job is marked for termination and put
693
769
  * into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
@@ -703,12 +779,14 @@ export declare class Comprehend extends ComprehendClient {
703
779
  stopKeyPhrasesDetectionJob(args: StopKeyPhrasesDetectionJobCommandInput, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void): void;
704
780
  stopKeyPhrasesDetectionJob(args: StopKeyPhrasesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopKeyPhrasesDetectionJobCommandOutput) => void): void;
705
781
  /**
782
+ * @public
706
783
  * <p>Stops a PII entities detection job in progress.</p>
707
784
  */
708
785
  stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, options?: __HttpHandlerOptions): Promise<StopPiiEntitiesDetectionJobCommandOutput>;
709
786
  stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void): void;
710
787
  stopPiiEntitiesDetectionJob(args: StopPiiEntitiesDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopPiiEntitiesDetectionJobCommandOutput) => void): void;
711
788
  /**
789
+ * @public
712
790
  * <p>Stops a sentiment detection job in progress.</p>
713
791
  * <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put
714
792
  * into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
@@ -724,6 +802,7 @@ export declare class Comprehend extends ComprehendClient {
724
802
  stopSentimentDetectionJob(args: StopSentimentDetectionJobCommandInput, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void): void;
725
803
  stopSentimentDetectionJob(args: StopSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSentimentDetectionJobCommandOutput) => void): void;
726
804
  /**
805
+ * @public
727
806
  * <p>Stops a targeted sentiment detection job in progress.</p>
728
807
  * <p>If the job state is <code>IN_PROGRESS</code>, the job is marked for termination and put
729
808
  * into the <code>STOP_REQUESTED</code> state. If the job completes before it can be stopped, it
@@ -739,6 +818,7 @@ export declare class Comprehend extends ComprehendClient {
739
818
  stopTargetedSentimentDetectionJob(args: StopTargetedSentimentDetectionJobCommandInput, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void): void;
740
819
  stopTargetedSentimentDetectionJob(args: StopTargetedSentimentDetectionJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTargetedSentimentDetectionJobCommandOutput) => void): void;
741
820
  /**
821
+ * @public
742
822
  * <p>Stops a document classifier training job while in progress.</p>
743
823
  * <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and
744
824
  * put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be
@@ -750,6 +830,7 @@ export declare class Comprehend extends ComprehendClient {
750
830
  stopTrainingDocumentClassifier(args: StopTrainingDocumentClassifierCommandInput, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void): void;
751
831
  stopTrainingDocumentClassifier(args: StopTrainingDocumentClassifierCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingDocumentClassifierCommandOutput) => void): void;
752
832
  /**
833
+ * @public
753
834
  * <p>Stops an entity recognizer training job while in progress.</p>
754
835
  * <p>If the training job state is <code>TRAINING</code>, the job is marked for termination and
755
836
  * put into the <code>STOP_REQUESTED</code> state. If the training job completes before it can be
@@ -761,6 +842,7 @@ export declare class Comprehend extends ComprehendClient {
761
842
  stopTrainingEntityRecognizer(args: StopTrainingEntityRecognizerCommandInput, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void): void;
762
843
  stopTrainingEntityRecognizer(args: StopTrainingEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopTrainingEntityRecognizerCommandOutput) => void): void;
763
844
  /**
845
+ * @public
764
846
  * <p>Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair
765
847
  * that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with
766
848
  * "Sales" as the key might be added to a resource to indicate its use by the sales department.
@@ -770,12 +852,14 @@ export declare class Comprehend extends ComprehendClient {
770
852
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
771
853
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
772
854
  /**
855
+ * @public
773
856
  * <p>Removes a specific tag associated with an Amazon Comprehend resource. </p>
774
857
  */
775
858
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
776
859
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
777
860
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
778
861
  /**
862
+ * @public
779
863
  * <p>Updates information about the specified endpoint.
780
864
  * For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
781
865
  */
@@ -783,6 +867,7 @@ export declare class Comprehend extends ComprehendClient {
783
867
  updateEndpoint(args: UpdateEndpointCommandInput, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
784
868
  updateEndpoint(args: UpdateEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateEndpointCommandOutput) => void): void;
785
869
  /**
870
+ * @public
786
871
  * <p>Update the configuration information for an existing flywheel.</p>
787
872
  */
788
873
  updateFlywheel(args: UpdateFlywheelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFlywheelCommandOutput>;