@aws-sdk/client-comprehend 3.52.0 → 3.54.1

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 (59) hide show
  1. package/CHANGELOG.md +30 -0
  2. package/dist-cjs/Comprehend.js +60 -0
  3. package/dist-cjs/commands/DescribeTargetedSentimentDetectionJobCommand.js +36 -0
  4. package/dist-cjs/commands/ListTargetedSentimentDetectionJobsCommand.js +36 -0
  5. package/dist-cjs/commands/StartTargetedSentimentDetectionJobCommand.js +36 -0
  6. package/dist-cjs/commands/StopTargetedSentimentDetectionJobCommand.js +36 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/index.js +3 -0
  9. package/dist-cjs/models/ComprehendServiceException.js +11 -0
  10. package/dist-cjs/models/models_0.js +290 -5
  11. package/dist-cjs/pagination/ListTargetedSentimentDetectionJobsPaginator.js +35 -0
  12. package/dist-cjs/pagination/index.js +1 -0
  13. package/dist-cjs/protocols/Aws_json1_1.js +1043 -2586
  14. package/dist-es/Comprehend.js +60 -0
  15. package/dist-es/commands/DescribeTargetedSentimentDetectionJobCommand.js +39 -0
  16. package/dist-es/commands/ListTargetedSentimentDetectionJobsCommand.js +39 -0
  17. package/dist-es/commands/StartTargetedSentimentDetectionJobCommand.js +39 -0
  18. package/dist-es/commands/StopTargetedSentimentDetectionJobCommand.js +39 -0
  19. package/dist-es/commands/index.js +4 -0
  20. package/dist-es/index.js +1 -0
  21. package/dist-es/models/ComprehendServiceException.js +12 -0
  22. package/dist-es/models/models_0.js +250 -1
  23. package/dist-es/pagination/ListTargetedSentimentDetectionJobsPaginator.js +74 -0
  24. package/dist-es/pagination/index.js +1 -0
  25. package/dist-es/protocols/Aws_json1_1.js +1917 -2813
  26. package/dist-types/Comprehend.d.ts +41 -1
  27. package/dist-types/ComprehendClient.d.ts +8 -4
  28. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +36 -0
  29. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +35 -0
  30. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +1 -1
  31. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +37 -0
  32. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +44 -0
  33. package/dist-types/commands/index.d.ts +4 -0
  34. package/dist-types/index.d.ts +1 -0
  35. package/dist-types/models/ComprehendServiceException.d.ts +10 -0
  36. package/dist-types/models/models_0.d.ts +450 -51
  37. package/dist-types/pagination/ListTargetedSentimentDetectionJobsPaginator.d.ts +4 -0
  38. package/dist-types/pagination/index.d.ts +1 -0
  39. package/dist-types/protocols/Aws_json1_1.d.ts +12 -0
  40. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  41. package/dist-types/runtimeConfig.d.ts +1 -1
  42. package/dist-types/runtimeConfig.native.d.ts +1 -1
  43. package/dist-types/ts3.4/Comprehend.d.ts +20 -0
  44. package/dist-types/ts3.4/ComprehendClient.d.ts +8 -4
  45. package/dist-types/ts3.4/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +17 -0
  46. package/dist-types/ts3.4/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +17 -0
  47. package/dist-types/ts3.4/commands/StartTargetedSentimentDetectionJobCommand.d.ts +17 -0
  48. package/dist-types/ts3.4/commands/StopTargetedSentimentDetectionJobCommand.d.ts +17 -0
  49. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  50. package/dist-types/ts3.4/index.d.ts +1 -0
  51. package/dist-types/ts3.4/models/ComprehendServiceException.d.ts +6 -0
  52. package/dist-types/ts3.4/models/models_0.d.ts +222 -49
  53. package/dist-types/ts3.4/pagination/ListTargetedSentimentDetectionJobsPaginator.d.ts +4 -0
  54. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  55. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +12 -0
  56. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  57. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  58. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  59. package/package.json +27 -27
@@ -1,4 +1,5 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
+ import { ComprehendServiceException as __BaseException } from "./ComprehendServiceException";
2
3
  export declare enum AugmentedManifestsDocumentTypeFormat {
3
4
  PLAIN_TEXT_DOCUMENT = "PLAIN_TEXT_DOCUMENT",
4
5
  SEMI_STRUCTURED_DOCUMENT = "SEMI_STRUCTURED_DOCUMENT"
@@ -181,34 +182,50 @@ export declare namespace BatchDetectDominantLanguageResponse {
181
182
  * <p>The number of documents in the request exceeds the limit of 25. Try your request again
182
183
  * with fewer documents.</p>
183
184
  */
184
- export interface BatchSizeLimitExceededException extends __SmithyException, $MetadataBearer {
185
- name: "BatchSizeLimitExceededException";
186
- $fault: "client";
185
+ export declare class BatchSizeLimitExceededException extends __BaseException {
186
+ readonly name: "BatchSizeLimitExceededException";
187
+ readonly $fault: "client";
187
188
  Message?: string;
189
+ /**
190
+ * @internal
191
+ */
192
+ constructor(opts: __ExceptionOptionType<BatchSizeLimitExceededException, __BaseException>);
188
193
  }
189
194
  /**
190
195
  * <p>An internal server error occurred. Retry your request.</p>
191
196
  */
192
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
193
- name: "InternalServerException";
194
- $fault: "server";
197
+ export declare class InternalServerException extends __BaseException {
198
+ readonly name: "InternalServerException";
199
+ readonly $fault: "server";
195
200
  Message?: string;
201
+ /**
202
+ * @internal
203
+ */
204
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
196
205
  }
197
206
  /**
198
207
  * <p>The request is invalid.</p>
199
208
  */
200
- export interface InvalidRequestException extends __SmithyException, $MetadataBearer {
201
- name: "InvalidRequestException";
202
- $fault: "client";
209
+ export declare class InvalidRequestException extends __BaseException {
210
+ readonly name: "InvalidRequestException";
211
+ readonly $fault: "client";
203
212
  Message?: string;
213
+ /**
214
+ * @internal
215
+ */
216
+ constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
204
217
  }
205
218
  /**
206
219
  * <p>The size of the input text exceeds the limit. Use a smaller document.</p>
207
220
  */
208
- export interface TextSizeLimitExceededException extends __SmithyException, $MetadataBearer {
209
- name: "TextSizeLimitExceededException";
210
- $fault: "client";
221
+ export declare class TextSizeLimitExceededException extends __BaseException {
222
+ readonly name: "TextSizeLimitExceededException";
223
+ readonly $fault: "client";
211
224
  Message?: string;
225
+ /**
226
+ * @internal
227
+ */
228
+ constructor(opts: __ExceptionOptionType<TextSizeLimitExceededException, __BaseException>);
212
229
  }
213
230
  export declare enum LanguageCode {
214
231
  AR = "ar",
@@ -343,10 +360,14 @@ export declare namespace BatchDetectEntitiesResponse {
343
360
  * recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
344
361
  * For a list of supported languages, see <a>supported-languages</a>. </p>
345
362
  */
346
- export interface UnsupportedLanguageException extends __SmithyException, $MetadataBearer {
347
- name: "UnsupportedLanguageException";
348
- $fault: "client";
363
+ export declare class UnsupportedLanguageException extends __BaseException {
364
+ readonly name: "UnsupportedLanguageException";
365
+ readonly $fault: "client";
349
366
  Message?: string;
367
+ /**
368
+ * @internal
369
+ */
370
+ constructor(opts: __ExceptionOptionType<UnsupportedLanguageException, __BaseException>);
350
371
  }
351
372
  export interface BatchDetectKeyPhrasesRequest {
352
373
  /**
@@ -872,10 +893,14 @@ export declare namespace ClassifyDocumentResponse {
872
893
  * <p>The specified resource is not available. Check the resource and try your request
873
894
  * again.</p>
874
895
  */
875
- export interface ResourceUnavailableException extends __SmithyException, $MetadataBearer {
876
- name: "ResourceUnavailableException";
877
- $fault: "client";
896
+ export declare class ResourceUnavailableException extends __BaseException {
897
+ readonly name: "ResourceUnavailableException";
898
+ readonly $fault: "client";
878
899
  Message?: string;
900
+ /**
901
+ * @internal
902
+ */
903
+ constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
879
904
  }
880
905
  export interface ContainsPiiEntitiesRequest {
881
906
  /**
@@ -1263,46 +1288,66 @@ export declare namespace CreateDocumentClassifierResponse {
1263
1288
  * <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and
1264
1289
  * re-enter it.</p>
1265
1290
  */
1266
- export interface KmsKeyValidationException extends __SmithyException, $MetadataBearer {
1267
- name: "KmsKeyValidationException";
1268
- $fault: "client";
1291
+ export declare class KmsKeyValidationException extends __BaseException {
1292
+ readonly name: "KmsKeyValidationException";
1293
+ readonly $fault: "client";
1269
1294
  Message?: string;
1295
+ /**
1296
+ * @internal
1297
+ */
1298
+ constructor(opts: __ExceptionOptionType<KmsKeyValidationException, __BaseException>);
1270
1299
  }
1271
1300
  /**
1272
1301
  * <p>The specified resource name is already in use. Use a different name and try your request
1273
1302
  * again.</p>
1274
1303
  */
1275
- export interface ResourceInUseException extends __SmithyException, $MetadataBearer {
1276
- name: "ResourceInUseException";
1277
- $fault: "client";
1304
+ export declare class ResourceInUseException extends __BaseException {
1305
+ readonly name: "ResourceInUseException";
1306
+ readonly $fault: "client";
1278
1307
  Message?: string;
1308
+ /**
1309
+ * @internal
1310
+ */
1311
+ constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
1279
1312
  }
1280
1313
  /**
1281
1314
  * <p>The maximum number of resources per account has been exceeded. Review the resources, and
1282
1315
  * then try your request again.</p>
1283
1316
  */
1284
- export interface ResourceLimitExceededException extends __SmithyException, $MetadataBearer {
1285
- name: "ResourceLimitExceededException";
1286
- $fault: "client";
1317
+ export declare class ResourceLimitExceededException extends __BaseException {
1318
+ readonly name: "ResourceLimitExceededException";
1319
+ readonly $fault: "client";
1287
1320
  Message?: string;
1321
+ /**
1322
+ * @internal
1323
+ */
1324
+ constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
1288
1325
  }
1289
1326
  /**
1290
1327
  * <p>The number of requests exceeds the limit. Resubmit your request later.</p>
1291
1328
  */
1292
- export interface TooManyRequestsException extends __SmithyException, $MetadataBearer {
1293
- name: "TooManyRequestsException";
1294
- $fault: "client";
1329
+ export declare class TooManyRequestsException extends __BaseException {
1330
+ readonly name: "TooManyRequestsException";
1331
+ readonly $fault: "client";
1295
1332
  Message?: string;
1333
+ /**
1334
+ * @internal
1335
+ */
1336
+ constructor(opts: __ExceptionOptionType<TooManyRequestsException, __BaseException>);
1296
1337
  }
1297
1338
  /**
1298
1339
  * <p>The request contains more tags than can be associated with a resource (50 tags per
1299
1340
  * resource). The maximum number of tags includes both existing tags and those included in your
1300
1341
  * current request. </p>
1301
1342
  */
1302
- export interface TooManyTagsException extends __SmithyException, $MetadataBearer {
1303
- name: "TooManyTagsException";
1304
- $fault: "client";
1343
+ export declare class TooManyTagsException extends __BaseException {
1344
+ readonly name: "TooManyTagsException";
1345
+ readonly $fault: "client";
1305
1346
  Message?: string;
1347
+ /**
1348
+ * @internal
1349
+ */
1350
+ constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
1306
1351
  }
1307
1352
  export interface CreateEndpointRequest {
1308
1353
  /**
@@ -1361,10 +1406,14 @@ export declare namespace CreateEndpointResponse {
1361
1406
  /**
1362
1407
  * <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
1363
1408
  */
1364
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
1365
- name: "ResourceNotFoundException";
1366
- $fault: "client";
1409
+ export declare class ResourceNotFoundException extends __BaseException {
1410
+ readonly name: "ResourceNotFoundException";
1411
+ readonly $fault: "client";
1367
1412
  Message?: string;
1413
+ /**
1414
+ * @internal
1415
+ */
1416
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
1368
1417
  }
1369
1418
  /**
1370
1419
  * <p>Describes the annotations associated with a entity recognizer.</p>
@@ -1863,7 +1912,7 @@ export declare enum JobStatus {
1863
1912
  SUBMITTED = "SUBMITTED"
1864
1913
  }
1865
1914
  /**
1866
- * <p>Provides configuration parameters for the output of topic detection jobs.</p>
1915
+ * <p>Provides configuration parameters for the output of inference jobs.</p>
1867
1916
  * <p></p>
1868
1917
  */
1869
1918
  export interface OutputDataConfig {
@@ -1876,6 +1925,10 @@ export interface OutputDataConfig {
1876
1925
  * directory specific to the job. The <code>S3Uri</code> field contains the location of the
1877
1926
  * output file, called <code>output.tar.gz</code>. It is a compressed archive that contains the
1878
1927
  * ouput of the operation.</p>
1928
+ * <p>
1929
+ * For a PII entity detection job, the output file is plain text, not a compressed archive.
1930
+ * The output file name is the same as the input file, with <code>.out</code> appended at the end.
1931
+ * </p>
1879
1932
  */
1880
1933
  S3Uri: string | undefined;
1881
1934
  /**
@@ -2017,10 +2070,14 @@ export declare namespace DescribeDocumentClassificationJobResponse {
2017
2070
  /**
2018
2071
  * <p>The specified job was not found. Check the job ID and try again.</p>
2019
2072
  */
2020
- export interface JobNotFoundException extends __SmithyException, $MetadataBearer {
2021
- name: "JobNotFoundException";
2022
- $fault: "client";
2073
+ export declare class JobNotFoundException extends __BaseException {
2074
+ readonly name: "JobNotFoundException";
2075
+ readonly $fault: "client";
2023
2076
  Message?: string;
2077
+ /**
2078
+ * @internal
2079
+ */
2080
+ constructor(opts: __ExceptionOptionType<JobNotFoundException, __BaseException>);
2024
2081
  }
2025
2082
  export interface DescribeDocumentClassifierRequest {
2026
2083
  /**
@@ -2593,7 +2650,10 @@ export interface EntityRecognizerEvaluationMetrics {
2593
2650
  /**
2594
2651
  * <p>A measure of how accurate the recognizer results are for the test data. It is derived from
2595
2652
  * the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the
2596
- * harmonic average of the two scores. The highest score is 1, and the worst score is 0. </p>
2653
+ * harmonic average of the two scores. For plain text entity recognizer models, the range is 0 to 100,
2654
+ * where 100 is the best score. For PDF/Word entity recognizer models, the range is 0 to 1,
2655
+ * where 1 is the best score.
2656
+ * </p>
2597
2657
  */
2598
2658
  F1Score?: number;
2599
2659
  }
@@ -2985,6 +3045,10 @@ export interface PiiOutputDataConfig {
2985
3045
  /**
2986
3046
  * <p>When you use the <code>PiiOutputDataConfig</code> object with asynchronous operations,
2987
3047
  * you specify the Amazon S3 location where you want to write the output data. </p>
3048
+ * <p>
3049
+ * For a PII entity detection job, the output file is plain text, not a compressed archive.
3050
+ * The output file name is the same as the input file, with <code>.out</code> appended at the end.
3051
+ * </p>
2988
3052
  */
2989
3053
  S3Uri: string | undefined;
2990
3054
  /**
@@ -3272,6 +3336,121 @@ export declare namespace DescribeSentimentDetectionJobResponse {
3272
3336
  */
3273
3337
  const filterSensitiveLog: (obj: DescribeSentimentDetectionJobResponse) => any;
3274
3338
  }
3339
+ export interface DescribeTargetedSentimentDetectionJobRequest {
3340
+ /**
3341
+ * <p>The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
3342
+ * response.</p>
3343
+ */
3344
+ JobId: string | undefined;
3345
+ }
3346
+ export declare namespace DescribeTargetedSentimentDetectionJobRequest {
3347
+ /**
3348
+ * @internal
3349
+ */
3350
+ const filterSensitiveLog: (obj: DescribeTargetedSentimentDetectionJobRequest) => any;
3351
+ }
3352
+ /**
3353
+ * <p>Provides information about a targeted sentiment detection job.</p>
3354
+ */
3355
+ export interface TargetedSentimentDetectionJobProperties {
3356
+ /**
3357
+ * <p>The identifier assigned to the targeted sentiment detection job.</p>
3358
+ */
3359
+ JobId?: string;
3360
+ /**
3361
+ * <p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully
3362
+ * qualified identifier for the job. It includes the AWS account, Region, and the job ID. The
3363
+ * format of the ARN is as follows:</p>
3364
+ * <p>
3365
+ * <code>arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id></code>
3366
+ * </p>
3367
+ * <p>The following is an example job ARN:</p>
3368
+ * <p>
3369
+ * <code>arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab</code>
3370
+ * </p>
3371
+ */
3372
+ JobArn?: string;
3373
+ /**
3374
+ * <p>The name that you assigned to the targeted sentiment detection job.</p>
3375
+ */
3376
+ JobName?: string;
3377
+ /**
3378
+ * <p>The current status of the targeted sentiment detection job. If the status is <code>FAILED</code>,
3379
+ * the <code>Messages</code> field shows the reason for the failure.</p>
3380
+ */
3381
+ JobStatus?: JobStatus | string;
3382
+ /**
3383
+ * <p>A description of the status of a job.</p>
3384
+ */
3385
+ Message?: string;
3386
+ /**
3387
+ * <p>The time that the targeted sentiment detection job was submitted for processing.</p>
3388
+ */
3389
+ SubmitTime?: Date;
3390
+ /**
3391
+ * <p>The time that the targeted sentiment detection job ended.</p>
3392
+ */
3393
+ EndTime?: Date;
3394
+ /**
3395
+ * <p>The input properties for an inference job.</p>
3396
+ */
3397
+ InputDataConfig?: InputDataConfig;
3398
+ /**
3399
+ * <p>Provides configuration parameters for the output of inference jobs.</p>
3400
+ * <p></p>
3401
+ */
3402
+ OutputDataConfig?: OutputDataConfig;
3403
+ /**
3404
+ * <p>The language code of the input documents.</p>
3405
+ */
3406
+ LanguageCode?: LanguageCode | string;
3407
+ /**
3408
+ * <p>The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input
3409
+ * data.</p>
3410
+ */
3411
+ DataAccessRoleArn?: string;
3412
+ /**
3413
+ * <p>ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
3414
+ * data on the storage volume attached to the ML compute instance(s) that process the
3415
+ * targeted sentiment detection job. The VolumeKmsKeyId can be either of the following formats:</p>
3416
+ * <ul>
3417
+ * <li>
3418
+ * <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
3419
+ * </p>
3420
+ * </li>
3421
+ * <li>
3422
+ * <p>Amazon Resource Name (ARN) of a KMS Key:
3423
+ * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
3424
+ * </p>
3425
+ * </li>
3426
+ * </ul>
3427
+ */
3428
+ VolumeKmsKeyId?: string;
3429
+ /**
3430
+ * <p> Configuration parameters for an optional private Virtual Private Cloud (VPC) containing
3431
+ * the resources you are using for the job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
3432
+ * VPC</a>. </p>
3433
+ */
3434
+ VpcConfig?: VpcConfig;
3435
+ }
3436
+ export declare namespace TargetedSentimentDetectionJobProperties {
3437
+ /**
3438
+ * @internal
3439
+ */
3440
+ const filterSensitiveLog: (obj: TargetedSentimentDetectionJobProperties) => any;
3441
+ }
3442
+ export interface DescribeTargetedSentimentDetectionJobResponse {
3443
+ /**
3444
+ * <p>An object that contains the properties associated with a targeted sentiment detection job.</p>
3445
+ */
3446
+ TargetedSentimentDetectionJobProperties?: TargetedSentimentDetectionJobProperties;
3447
+ }
3448
+ export declare namespace DescribeTargetedSentimentDetectionJobResponse {
3449
+ /**
3450
+ * @internal
3451
+ */
3452
+ const filterSensitiveLog: (obj: DescribeTargetedSentimentDetectionJobResponse) => any;
3453
+ }
3275
3454
  export interface DescribeTopicsDetectionJobRequest {
3276
3455
  /**
3277
3456
  * <p>The identifier assigned by the user to the detection job.</p>
@@ -3699,10 +3878,14 @@ export declare namespace ImportModelResponse {
3699
3878
  * <p>The filter specified for the operation is invalid. Specify a different
3700
3879
  * filter.</p>
3701
3880
  */
3702
- export interface InvalidFilterException extends __SmithyException, $MetadataBearer {
3703
- name: "InvalidFilterException";
3704
- $fault: "client";
3881
+ export declare class InvalidFilterException extends __BaseException {
3882
+ readonly name: "InvalidFilterException";
3883
+ readonly $fault: "client";
3705
3884
  Message?: string;
3885
+ /**
3886
+ * @internal
3887
+ */
3888
+ constructor(opts: __ExceptionOptionType<InvalidFilterException, __BaseException>);
3706
3889
  }
3707
3890
  /**
3708
3891
  * <p>Provides information for filtering a list of document classification jobs. For more
@@ -4560,6 +4743,76 @@ export declare namespace ListTagsForResourceResponse {
4560
4743
  */
4561
4744
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
4562
4745
  }
4746
+ /**
4747
+ * <p>Provides information for filtering a list of dominant language detection jobs. For more
4748
+ * information, see the operation.</p>
4749
+ */
4750
+ export interface TargetedSentimentDetectionJobFilter {
4751
+ /**
4752
+ * <p>Filters on the name of the job.</p>
4753
+ */
4754
+ JobName?: string;
4755
+ /**
4756
+ * <p>Filters the list of jobs based on job status. Returns only jobs with the specified
4757
+ * status.</p>
4758
+ */
4759
+ JobStatus?: JobStatus | string;
4760
+ /**
4761
+ * <p>Filters the list of jobs based on the time that the job was submitted for processing.
4762
+ * Returns only jobs submitted before the specified time. Jobs are returned in ascending order,
4763
+ * oldest to newest.</p>
4764
+ */
4765
+ SubmitTimeBefore?: Date;
4766
+ /**
4767
+ * <p>Filters the list of jobs based on the time that the job was submitted for processing.
4768
+ * Returns only jobs submitted after the specified time. Jobs are returned in descending order,
4769
+ * newest to oldest.</p>
4770
+ */
4771
+ SubmitTimeAfter?: Date;
4772
+ }
4773
+ export declare namespace TargetedSentimentDetectionJobFilter {
4774
+ /**
4775
+ * @internal
4776
+ */
4777
+ const filterSensitiveLog: (obj: TargetedSentimentDetectionJobFilter) => any;
4778
+ }
4779
+ export interface ListTargetedSentimentDetectionJobsRequest {
4780
+ /**
4781
+ * <p>Filters the jobs that are returned. You can filter jobs on their name, status, or the date
4782
+ * and time that they were submitted. You can only set one filter at a time.</p>
4783
+ */
4784
+ Filter?: TargetedSentimentDetectionJobFilter;
4785
+ /**
4786
+ * <p>Identifies the next page of results to return.</p>
4787
+ */
4788
+ NextToken?: string;
4789
+ /**
4790
+ * <p>The maximum number of results to return in each page. The default is 100.</p>
4791
+ */
4792
+ MaxResults?: number;
4793
+ }
4794
+ export declare namespace ListTargetedSentimentDetectionJobsRequest {
4795
+ /**
4796
+ * @internal
4797
+ */
4798
+ const filterSensitiveLog: (obj: ListTargetedSentimentDetectionJobsRequest) => any;
4799
+ }
4800
+ export interface ListTargetedSentimentDetectionJobsResponse {
4801
+ /**
4802
+ * <p>A list containing the properties of each job that is returned.</p>
4803
+ */
4804
+ TargetedSentimentDetectionJobPropertiesList?: TargetedSentimentDetectionJobProperties[];
4805
+ /**
4806
+ * <p>Identifies the next page of results to return.</p>
4807
+ */
4808
+ NextToken?: string;
4809
+ }
4810
+ export declare namespace ListTargetedSentimentDetectionJobsResponse {
4811
+ /**
4812
+ * @internal
4813
+ */
4814
+ const filterSensitiveLog: (obj: ListTargetedSentimentDetectionJobsResponse) => any;
4815
+ }
4563
4816
  /**
4564
4817
  * <p>Provides information for filtering topic detection jobs. For more information, see
4565
4818
  * .</p>
@@ -5390,6 +5643,114 @@ export declare namespace StartSentimentDetectionJobResponse {
5390
5643
  */
5391
5644
  const filterSensitiveLog: (obj: StartSentimentDetectionJobResponse) => any;
5392
5645
  }
5646
+ export interface StartTargetedSentimentDetectionJobRequest {
5647
+ /**
5648
+ * <p>The input properties for an inference job.</p>
5649
+ */
5650
+ InputDataConfig: InputDataConfig | undefined;
5651
+ /**
5652
+ * <p>Specifies where to send the output files. </p>
5653
+ */
5654
+ OutputDataConfig: OutputDataConfig | undefined;
5655
+ /**
5656
+ * <p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
5657
+ * grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">Role-based permissions</a>.</p>
5658
+ */
5659
+ DataAccessRoleArn: string | undefined;
5660
+ /**
5661
+ * <p>The identifier of the job.</p>
5662
+ */
5663
+ JobName?: string;
5664
+ /**
5665
+ * <p>The language of the input documents. You can specify any of the primary languages
5666
+ * supported by Amazon Comprehend. All documents must be in the same language.</p>
5667
+ */
5668
+ LanguageCode: LanguageCode | string | undefined;
5669
+ /**
5670
+ * <p>A unique identifier for the request. If you don't set the client request token, Amazon
5671
+ * Comprehend generates one.</p>
5672
+ */
5673
+ ClientRequestToken?: string;
5674
+ /**
5675
+ * <p>ID for the KMS key that Amazon Comprehend uses to encrypt
5676
+ * data on the storage volume attached to the ML compute instance(s) that process the analysis
5677
+ * job. The VolumeKmsKeyId can be either of the following formats:</p>
5678
+ * <ul>
5679
+ * <li>
5680
+ * <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
5681
+ * </p>
5682
+ * </li>
5683
+ * <li>
5684
+ * <p>Amazon Resource Name (ARN) of a KMS Key:
5685
+ * <code>"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"</code>
5686
+ * </p>
5687
+ * </li>
5688
+ * </ul>
5689
+ */
5690
+ VolumeKmsKeyId?: string;
5691
+ /**
5692
+ * <p> Configuration parameters for an optional private Virtual Private Cloud (VPC) containing
5693
+ * the resources you are using for the job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
5694
+ * VPC</a>. </p>
5695
+ */
5696
+ VpcConfig?: VpcConfig;
5697
+ /**
5698
+ * <p>Tags to be associated with the targeted sentiment detection job. A tag is a key-value pair that
5699
+ * adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the
5700
+ * key might be added to a resource to indicate its use by the sales department.</p>
5701
+ */
5702
+ Tags?: Tag[];
5703
+ }
5704
+ export declare namespace StartTargetedSentimentDetectionJobRequest {
5705
+ /**
5706
+ * @internal
5707
+ */
5708
+ const filterSensitiveLog: (obj: StartTargetedSentimentDetectionJobRequest) => any;
5709
+ }
5710
+ export interface StartTargetedSentimentDetectionJobResponse {
5711
+ /**
5712
+ * <p>The identifier generated for the job. To get the status of a job, use this identifier with
5713
+ * the operation.</p>
5714
+ */
5715
+ JobId?: string;
5716
+ /**
5717
+ * <p>The Amazon Resource Name (ARN) of the targeted sentiment detection job. It is a unique, fully
5718
+ * qualified identifier for the job. It includes the AWS account, Region, and the job ID. The
5719
+ * format of the ARN is as follows:</p>
5720
+ * <p>
5721
+ * <code>arn:<partition>:comprehend:<region>:<account-id>:targeted-sentiment-detection-job/<job-id></code>
5722
+ * </p>
5723
+ * <p>The following is an example job ARN:</p>
5724
+ * <p>
5725
+ * <code>arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab</code>
5726
+ * </p>
5727
+ */
5728
+ JobArn?: string;
5729
+ /**
5730
+ * <p>The status of the job. </p>
5731
+ * <ul>
5732
+ * <li>
5733
+ * <p>SUBMITTED - The job has been received and is queued for processing.</p>
5734
+ * </li>
5735
+ * <li>
5736
+ * <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p>
5737
+ * </li>
5738
+ * <li>
5739
+ * <p>COMPLETED - The job was successfully completed and the output is available.</p>
5740
+ * </li>
5741
+ * <li>
5742
+ * <p>FAILED - The job did not complete. To get details, use the operation.</p>
5743
+ * </li>
5744
+ * </ul>
5745
+ */
5746
+ JobStatus?: JobStatus | string;
5747
+ }
5748
+ export declare namespace StartTargetedSentimentDetectionJobResponse {
5749
+ /**
5750
+ * @internal
5751
+ */
5752
+ const filterSensitiveLog: (obj: StartTargetedSentimentDetectionJobResponse) => any;
5753
+ }
5393
5754
  export interface StartTopicsDetectionJobRequest {
5394
5755
  /**
5395
5756
  * <p>Specifies the format and location of the input data for the job.</p>
@@ -5677,6 +6038,36 @@ export declare namespace StopSentimentDetectionJobResponse {
5677
6038
  */
5678
6039
  const filterSensitiveLog: (obj: StopSentimentDetectionJobResponse) => any;
5679
6040
  }
6041
+ export interface StopTargetedSentimentDetectionJobRequest {
6042
+ /**
6043
+ * <p>The identifier of the targeted sentiment detection job to stop.</p>
6044
+ */
6045
+ JobId: string | undefined;
6046
+ }
6047
+ export declare namespace StopTargetedSentimentDetectionJobRequest {
6048
+ /**
6049
+ * @internal
6050
+ */
6051
+ const filterSensitiveLog: (obj: StopTargetedSentimentDetectionJobRequest) => any;
6052
+ }
6053
+ export interface StopTargetedSentimentDetectionJobResponse {
6054
+ /**
6055
+ * <p>The identifier of the targeted sentiment detection job to stop.</p>
6056
+ */
6057
+ JobId?: string;
6058
+ /**
6059
+ * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
6060
+ * <code>STOPPED</code> if the job was previously stopped with the
6061
+ * <code>StopSentimentDetectionJob</code> operation.</p>
6062
+ */
6063
+ JobStatus?: JobStatus | string;
6064
+ }
6065
+ export declare namespace StopTargetedSentimentDetectionJobResponse {
6066
+ /**
6067
+ * @internal
6068
+ */
6069
+ const filterSensitiveLog: (obj: StopTargetedSentimentDetectionJobResponse) => any;
6070
+ }
5680
6071
  export interface StopTrainingDocumentClassifierRequest {
5681
6072
  /**
5682
6073
  * <p>The Amazon Resource Name (ARN) that identifies the document classifier currently being
@@ -5723,10 +6114,14 @@ export declare namespace StopTrainingEntityRecognizerResponse {
5723
6114
  * <p>Concurrent modification of the tags associated with an Amazon Comprehend resource is not
5724
6115
  * supported. </p>
5725
6116
  */
5726
- export interface ConcurrentModificationException extends __SmithyException, $MetadataBearer {
5727
- name: "ConcurrentModificationException";
5728
- $fault: "client";
6117
+ export declare class ConcurrentModificationException extends __BaseException {
6118
+ readonly name: "ConcurrentModificationException";
6119
+ readonly $fault: "client";
5729
6120
  Message?: string;
6121
+ /**
6122
+ * @internal
6123
+ */
6124
+ constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
5730
6125
  }
5731
6126
  export interface TagResourceRequest {
5732
6127
  /**
@@ -5758,10 +6153,14 @@ export declare namespace TagResourceResponse {
5758
6153
  * <p>The request contains more tag keys than can be associated with a resource (50 tag keys per
5759
6154
  * resource).</p>
5760
6155
  */
5761
- export interface TooManyTagKeysException extends __SmithyException, $MetadataBearer {
5762
- name: "TooManyTagKeysException";
5763
- $fault: "client";
6156
+ export declare class TooManyTagKeysException extends __BaseException {
6157
+ readonly name: "TooManyTagKeysException";
6158
+ readonly $fault: "client";
5764
6159
  Message?: string;
6160
+ /**
6161
+ * @internal
6162
+ */
6163
+ constructor(opts: __ExceptionOptionType<TooManyTagKeysException, __BaseException>);
5765
6164
  }
5766
6165
  export interface UntagResourceRequest {
5767
6166
  /**
@@ -0,0 +1,4 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { ListTargetedSentimentDetectionJobsCommandInput, ListTargetedSentimentDetectionJobsCommandOutput } from "../commands/ListTargetedSentimentDetectionJobsCommand";
3
+ import { ComprehendPaginationConfiguration } from "./Interfaces";
4
+ export declare function paginateListTargetedSentimentDetectionJobs(config: ComprehendPaginationConfiguration, input: ListTargetedSentimentDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListTargetedSentimentDetectionJobsCommandOutput>;
@@ -9,4 +9,5 @@ export * from "./ListEntityRecognizersPaginator";
9
9
  export * from "./ListEventsDetectionJobsPaginator";
10
10
  export * from "./ListKeyPhrasesDetectionJobsPaginator";
11
11
  export * from "./ListSentimentDetectionJobsPaginator";
12
+ export * from "./ListTargetedSentimentDetectionJobsPaginator";
12
13
  export * from "./ListTopicsDetectionJobsPaginator";