@aws-sdk/client-comprehend 3.298.0 → 3.300.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 (95) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/models/models_0.js +1 -0
  3. package/dist-cjs/protocols/Aws_json1_1.js +1 -0
  4. package/dist-es/models/models_0.js +1 -0
  5. package/dist-es/protocols/Aws_json1_1.js +1 -0
  6. package/dist-types/Comprehend.d.ts +8 -8
  7. package/dist-types/ComprehendClient.d.ts +1 -1
  8. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +5 -0
  9. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +6 -0
  10. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +6 -0
  11. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +6 -0
  12. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +6 -0
  13. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +6 -0
  14. package/dist-types/commands/ClassifyDocumentCommand.d.ts +12 -0
  15. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +4 -0
  16. package/dist-types/commands/CreateDatasetCommand.d.ts +43 -0
  17. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +48 -0
  18. package/dist-types/commands/CreateEndpointCommand.d.ts +14 -0
  19. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +56 -0
  20. package/dist-types/commands/CreateFlywheelCommand.d.ts +44 -1
  21. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +3 -0
  22. package/dist-types/commands/DeleteEndpointCommand.d.ts +3 -0
  23. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +3 -0
  24. package/dist-types/commands/DeleteFlywheelCommand.d.ts +3 -0
  25. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  26. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +3 -0
  28. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +3 -0
  29. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +3 -0
  30. package/dist-types/commands/DescribeEndpointCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +3 -0
  32. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +3 -0
  33. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +3 -0
  34. package/dist-types/commands/DescribeFlywheelCommand.d.ts +3 -0
  35. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +4 -0
  36. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +3 -0
  37. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +3 -0
  38. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +3 -0
  39. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +3 -0
  40. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +3 -0
  41. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +3 -0
  42. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +3 -0
  43. package/dist-types/commands/DetectEntitiesCommand.d.ts +13 -0
  44. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +4 -0
  45. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +4 -0
  46. package/dist-types/commands/DetectSentimentCommand.d.ts +4 -0
  47. package/dist-types/commands/DetectSyntaxCommand.d.ts +4 -0
  48. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +4 -0
  49. package/dist-types/commands/ImportModelCommand.d.ts +17 -4
  50. package/dist-types/commands/ListDatasetsCommand.d.ts +12 -1
  51. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +10 -0
  52. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +4 -0
  53. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +10 -0
  54. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +10 -0
  55. package/dist-types/commands/ListEndpointsCommand.d.ts +10 -0
  56. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +10 -0
  57. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +4 -0
  58. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +10 -0
  59. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +10 -0
  60. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +9 -0
  61. package/dist-types/commands/ListFlywheelsCommand.d.ts +9 -0
  62. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +10 -0
  63. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +10 -0
  64. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +10 -0
  65. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  66. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +10 -0
  67. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +10 -0
  68. package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -1
  69. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +37 -0
  70. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +35 -0
  71. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +38 -0
  72. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +30 -0
  73. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +4 -0
  74. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +36 -0
  75. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +35 -0
  76. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +36 -0
  77. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +36 -0
  78. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +36 -0
  79. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +3 -0
  80. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +3 -0
  81. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +3 -0
  82. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +3 -0
  83. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +3 -0
  84. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +3 -0
  85. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +3 -0
  86. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +3 -0
  87. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +3 -0
  88. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  89. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  90. package/dist-types/commands/UpdateEndpointCommand.d.ts +7 -0
  91. package/dist-types/commands/UpdateFlywheelCommand.d.ts +17 -0
  92. package/dist-types/models/models_0.d.ts +106 -108
  93. package/dist-types/models/models_1.d.ts +2 -2
  94. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  95. package/package.json +12 -12
package/README.md CHANGED
@@ -9,7 +9,7 @@
9
9
 
10
10
  AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native.
11
11
 
12
- <p>Amazon Comprehend is an AWS service for gaining insight into the content of documents.
12
+ <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
13
13
  Use these actions to determine the topics contained in your documents, the topics they
14
14
  discuss, the predominant sentiment expressed in them, the predominant language used, and
15
15
  more.</p>
@@ -433,6 +433,7 @@ var ModelStatus;
433
433
  ModelStatus["STOP_REQUESTED"] = "STOP_REQUESTED";
434
434
  ModelStatus["SUBMITTED"] = "SUBMITTED";
435
435
  ModelStatus["TRAINED"] = "TRAINED";
436
+ ModelStatus["TRAINED_WITH_WARNING"] = "TRAINED_WITH_WARNING";
436
437
  ModelStatus["TRAINING"] = "TRAINING";
437
438
  })(ModelStatus = exports.ModelStatus || (exports.ModelStatus = {}));
438
439
  var EndpointStatus;
@@ -6541,6 +6541,7 @@ const deserializeAws_json1_1EntitiesDetectionJobProperties = (output, context) =
6541
6541
  DataAccessRoleArn: (0, smithy_client_1.expectString)(output.DataAccessRoleArn),
6542
6542
  EndTime: output.EndTime != null ? (0, smithy_client_1.expectNonNull)((0, smithy_client_1.parseEpochTimestamp)((0, smithy_client_1.expectNumber)(output.EndTime))) : undefined,
6543
6543
  EntityRecognizerArn: (0, smithy_client_1.expectString)(output.EntityRecognizerArn),
6544
+ FlywheelArn: (0, smithy_client_1.expectString)(output.FlywheelArn),
6544
6545
  InputDataConfig: output.InputDataConfig != null
6545
6546
  ? deserializeAws_json1_1InputDataConfig(output.InputDataConfig, context)
6546
6547
  : undefined,
@@ -416,6 +416,7 @@ export var ModelStatus;
416
416
  ModelStatus["STOP_REQUESTED"] = "STOP_REQUESTED";
417
417
  ModelStatus["SUBMITTED"] = "SUBMITTED";
418
418
  ModelStatus["TRAINED"] = "TRAINED";
419
+ ModelStatus["TRAINED_WITH_WARNING"] = "TRAINED_WITH_WARNING";
419
420
  ModelStatus["TRAINING"] = "TRAINING";
420
421
  })(ModelStatus || (ModelStatus = {}));
421
422
  export var EndpointStatus;
@@ -6367,6 +6367,7 @@ const deserializeAws_json1_1EntitiesDetectionJobProperties = (output, context) =
6367
6367
  DataAccessRoleArn: __expectString(output.DataAccessRoleArn),
6368
6368
  EndTime: output.EndTime != null ? __expectNonNull(__parseEpochTimestamp(__expectNumber(output.EndTime))) : undefined,
6369
6369
  EntityRecognizerArn: __expectString(output.EntityRecognizerArn),
6370
+ FlywheelArn: __expectString(output.FlywheelArn),
6370
6371
  InputDataConfig: output.InputDataConfig != null
6371
6372
  ? deserializeAws_json1_1InputDataConfig(output.InputDataConfig, context)
6372
6373
  : undefined,
@@ -86,7 +86,7 @@ import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput } from "./comma
86
86
  import { ComprehendClient } from "./ComprehendClient";
87
87
  /**
88
88
  * @public
89
- * <p>Amazon Comprehend is an AWS service for gaining insight into the content of documents.
89
+ * <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
90
90
  * Use these actions to determine the topics contained in your documents, the topics they
91
91
  * discuss, the predominant sentiment expressed in them, the predominant language used, and
92
92
  * more.</p>
@@ -213,7 +213,7 @@ export declare class Comprehend extends ComprehendClient {
213
213
  createEntityRecognizer(args: CreateEntityRecognizerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateEntityRecognizerCommandOutput) => void): void;
214
214
  /**
215
215
  * @public
216
- * <p>A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification
216
+ * <p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification
217
217
  * or custom entity recognition. You can create a flywheel to start with an existing trained model, or
218
218
  * Comprehend can create and train a new model.</p>
219
219
  * <p>When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training
@@ -483,18 +483,18 @@ export declare class Comprehend extends ComprehendClient {
483
483
  /**
484
484
  * @public
485
485
  * <p>Creates a new custom model that replicates a source custom model that you import. The
486
- * source model can be in your AWS account or another one.</p>
487
- * <p>If the source model is in another AWS account, then it must have a resource-based policy
486
+ * source model can be in your Amazon Web Services account or another one.</p>
487
+ * <p>If the source model is in another Amazon Web Services account, then it must have a resource-based policy
488
488
  * that authorizes you to import it.</p>
489
- * <p>The source model must be in the same AWS region that you're using when you import. You
490
- * can't import a model that's in a different region.</p>
489
+ * <p>The source model must be in the same Amazon Web Services Region that you're using when you import. You
490
+ * can't import a model that's in a different Region.</p>
491
491
  */
492
492
  importModel(args: ImportModelCommandInput, options?: __HttpHandlerOptions): Promise<ImportModelCommandOutput>;
493
493
  importModel(args: ImportModelCommandInput, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
494
494
  importModel(args: ImportModelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportModelCommandOutput) => void): void;
495
495
  /**
496
496
  * @public
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">
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">
498
498
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
499
499
  */
500
500
  listDatasets(args: ListDatasetsCommandInput, options?: __HttpHandlerOptions): Promise<ListDatasetsCommandOutput>;
@@ -630,7 +630,7 @@ export declare class Comprehend extends ComprehendClient {
630
630
  /**
631
631
  * @public
632
632
  * <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
633
- * an entity in another AWS account to import the custom model, which replicates it in Amazon
633
+ * an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon
634
634
  * Comprehend in their account.</p>
635
635
  */
636
636
  putResourcePolicy(args: PutResourcePolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutResourcePolicyCommandOutput>;
@@ -227,7 +227,7 @@ export interface ComprehendClientResolvedConfig extends ComprehendClientResolved
227
227
  }
228
228
  /**
229
229
  * @public
230
- * <p>Amazon Comprehend is an AWS service for gaining insight into the content of documents.
230
+ * <p>Amazon Comprehend is an Amazon Web Services service for gaining insight into the content of documents.
231
231
  * Use these actions to determine the topics contained in your documents, the topics they
232
232
  * discuss, the predominant sentiment expressed in them, the predominant language used, and
233
233
  * more.</p>
@@ -28,6 +28,11 @@ export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDom
28
28
  * import { ComprehendClient, BatchDetectDominantLanguageCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, BatchDetectDominantLanguageCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * TextList: [ // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * };
31
36
  * const command = new BatchDetectDominantLanguageCommand(input);
32
37
  * const response = await client.send(command);
33
38
  * ```
@@ -29,6 +29,12 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
29
29
  * import { ComprehendClient, BatchDetectEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
30
30
  * // const { ComprehendClient, BatchDetectEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
31
31
  * const client = new ComprehendClient(config);
32
+ * const input = {
33
+ * TextList: [ // required
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
37
+ * };
32
38
  * const command = new BatchDetectEntitiesCommand(input);
33
39
  * const response = await client.send(command);
34
40
  * ```
@@ -26,6 +26,12 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
26
26
  * import { ComprehendClient, BatchDetectKeyPhrasesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, BatchDetectKeyPhrasesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = {
30
+ * TextList: [ // required
31
+ * "STRING_VALUE",
32
+ * ],
33
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
34
+ * };
29
35
  * const command = new BatchDetectKeyPhrasesCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -28,6 +28,12 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
28
28
  * import { ComprehendClient, BatchDetectSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, BatchDetectSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * TextList: [ // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
36
+ * };
31
37
  * const command = new BatchDetectSentimentCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -29,6 +29,12 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
29
29
  * import { ComprehendClient, BatchDetectSyntaxCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
30
30
  * // const { ComprehendClient, BatchDetectSyntaxCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
31
31
  * const client = new ComprehendClient(config);
32
+ * const input = {
33
+ * TextList: [ // required
34
+ * "STRING_VALUE",
35
+ * ],
36
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt", // required
37
+ * };
32
38
  * const command = new BatchDetectSyntaxCommand(input);
33
39
  * const response = await client.send(command);
34
40
  * ```
@@ -28,6 +28,12 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
28
28
  * import { ComprehendClient, BatchDetectTargetedSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, BatchDetectTargetedSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * TextList: [ // required
33
+ * "STRING_VALUE",
34
+ * ],
35
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
36
+ * };
31
37
  * const command = new BatchDetectTargetedSentimentCommand(input);
32
38
  * const response = await client.send(command);
33
39
  * ```
@@ -36,6 +36,18 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
36
36
  * import { ComprehendClient, ClassifyDocumentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
37
37
  * // const { ComprehendClient, ClassifyDocumentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
38
38
  * const client = new ComprehendClient(config);
39
+ * const input = {
40
+ * Text: "STRING_VALUE",
41
+ * EndpointArn: "STRING_VALUE", // required
42
+ * Bytes: "BLOB_VALUE",
43
+ * DocumentReaderConfig: {
44
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
45
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
46
+ * FeatureTypes: [
47
+ * "TABLES" || "FORMS",
48
+ * ],
49
+ * },
50
+ * };
39
51
  * const command = new ClassifyDocumentCommand(input);
40
52
  * const response = await client.send(command);
41
53
  * ```
@@ -28,6 +28,10 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
28
28
  * import { ComprehendClient, ContainsPiiEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, ContainsPiiEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * Text: "STRING_VALUE", // required
33
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
34
+ * };
31
35
  * const command = new ContainsPiiEntitiesCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -28,6 +28,49 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
28
28
  * import { ComprehendClient, CreateDatasetCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, CreateDatasetCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * DatasetName: "STRING_VALUE", // required
34
+ * DatasetType: "TRAIN" || "TEST",
35
+ * Description: "STRING_VALUE",
36
+ * InputDataConfig: {
37
+ * AugmentedManifests: [
38
+ * {
39
+ * AttributeNames: [ // required
40
+ * "STRING_VALUE",
41
+ * ],
42
+ * S3Uri: "STRING_VALUE", // required
43
+ * AnnotationDataS3Uri: "STRING_VALUE",
44
+ * SourceDocumentsS3Uri: "STRING_VALUE",
45
+ * DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
46
+ * },
47
+ * ],
48
+ * DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
49
+ * DocumentClassifierInputDataConfig: {
50
+ * S3Uri: "STRING_VALUE", // required
51
+ * LabelDelimiter: "STRING_VALUE",
52
+ * },
53
+ * EntityRecognizerInputDataConfig: {
54
+ * Annotations: {
55
+ * S3Uri: "STRING_VALUE", // required
56
+ * },
57
+ * Documents: {
58
+ * S3Uri: "STRING_VALUE", // required
59
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
60
+ * },
61
+ * EntityList: {
62
+ * S3Uri: "STRING_VALUE", // required
63
+ * },
64
+ * },
65
+ * },
66
+ * ClientRequestToken: "STRING_VALUE",
67
+ * Tags: [
68
+ * {
69
+ * Key: "STRING_VALUE", // required
70
+ * Value: "STRING_VALUE",
71
+ * },
72
+ * ],
73
+ * };
31
74
  * const command = new CreateDatasetCommand(input);
32
75
  * const response = await client.send(command);
33
76
  * ```
@@ -31,6 +31,54 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
31
31
  * import { ComprehendClient, CreateDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
32
32
  * // const { ComprehendClient, CreateDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
33
33
  * const client = new ComprehendClient(config);
34
+ * const input = {
35
+ * DocumentClassifierName: "STRING_VALUE", // required
36
+ * VersionName: "STRING_VALUE",
37
+ * DataAccessRoleArn: "STRING_VALUE", // required
38
+ * Tags: [
39
+ * {
40
+ * Key: "STRING_VALUE", // required
41
+ * Value: "STRING_VALUE",
42
+ * },
43
+ * ],
44
+ * InputDataConfig: {
45
+ * DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
46
+ * S3Uri: "STRING_VALUE",
47
+ * TestS3Uri: "STRING_VALUE",
48
+ * LabelDelimiter: "STRING_VALUE",
49
+ * AugmentedManifests: [
50
+ * {
51
+ * S3Uri: "STRING_VALUE", // required
52
+ * Split: "TRAIN" || "TEST",
53
+ * AttributeNames: [ // required
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * AnnotationDataS3Uri: "STRING_VALUE",
57
+ * SourceDocumentsS3Uri: "STRING_VALUE",
58
+ * DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
59
+ * },
60
+ * ],
61
+ * },
62
+ * OutputDataConfig: {
63
+ * S3Uri: "STRING_VALUE",
64
+ * KmsKeyId: "STRING_VALUE",
65
+ * FlywheelStatsS3Prefix: "STRING_VALUE",
66
+ * },
67
+ * ClientRequestToken: "STRING_VALUE",
68
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
69
+ * VolumeKmsKeyId: "STRING_VALUE",
70
+ * VpcConfig: {
71
+ * SecurityGroupIds: [ // required
72
+ * "STRING_VALUE",
73
+ * ],
74
+ * Subnets: [ // required
75
+ * "STRING_VALUE",
76
+ * ],
77
+ * },
78
+ * Mode: "MULTI_CLASS" || "MULTI_LABEL",
79
+ * ModelKmsKeyId: "STRING_VALUE",
80
+ * ModelPolicy: "STRING_VALUE",
81
+ * };
34
82
  * const command = new CreateDocumentClassifierCommand(input);
35
83
  * const response = await client.send(command);
36
84
  * ```
@@ -28,6 +28,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
28
28
  * import { ComprehendClient, CreateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, CreateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * EndpointName: "STRING_VALUE", // required
33
+ * ModelArn: "STRING_VALUE",
34
+ * DesiredInferenceUnits: Number("int"), // required
35
+ * ClientRequestToken: "STRING_VALUE",
36
+ * Tags: [
37
+ * {
38
+ * Key: "STRING_VALUE", // required
39
+ * Value: "STRING_VALUE",
40
+ * },
41
+ * ],
42
+ * DataAccessRoleArn: "STRING_VALUE",
43
+ * FlywheelArn: "STRING_VALUE",
44
+ * };
31
45
  * const command = new CreateEndpointCommand(input);
32
46
  * const response = await client.send(command);
33
47
  * ```
@@ -28,6 +28,62 @@ export interface CreateEntityRecognizerCommandOutput extends CreateEntityRecogni
28
28
  * import { ComprehendClient, CreateEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, CreateEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * RecognizerName: "STRING_VALUE", // required
33
+ * VersionName: "STRING_VALUE",
34
+ * DataAccessRoleArn: "STRING_VALUE", // required
35
+ * Tags: [
36
+ * {
37
+ * Key: "STRING_VALUE", // required
38
+ * Value: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * InputDataConfig: {
42
+ * DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
43
+ * EntityTypes: [ // required
44
+ * {
45
+ * Type: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * Documents: {
49
+ * S3Uri: "STRING_VALUE", // required
50
+ * TestS3Uri: "STRING_VALUE",
51
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
52
+ * },
53
+ * Annotations: {
54
+ * S3Uri: "STRING_VALUE", // required
55
+ * TestS3Uri: "STRING_VALUE",
56
+ * },
57
+ * EntityList: {
58
+ * S3Uri: "STRING_VALUE", // required
59
+ * },
60
+ * AugmentedManifests: [
61
+ * {
62
+ * S3Uri: "STRING_VALUE", // required
63
+ * Split: "TRAIN" || "TEST",
64
+ * AttributeNames: [ // required
65
+ * "STRING_VALUE",
66
+ * ],
67
+ * AnnotationDataS3Uri: "STRING_VALUE",
68
+ * SourceDocumentsS3Uri: "STRING_VALUE",
69
+ * DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
70
+ * },
71
+ * ],
72
+ * },
73
+ * ClientRequestToken: "STRING_VALUE",
74
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
75
+ * VolumeKmsKeyId: "STRING_VALUE",
76
+ * VpcConfig: {
77
+ * SecurityGroupIds: [ // required
78
+ * "STRING_VALUE",
79
+ * ],
80
+ * Subnets: [ // required
81
+ * "STRING_VALUE",
82
+ * ],
83
+ * },
84
+ * ModelKmsKeyId: "STRING_VALUE",
85
+ * ModelPolicy: "STRING_VALUE",
86
+ * };
31
87
  * const command = new CreateEntityRecognizerCommand(input);
32
88
  * const response = await client.send(command);
33
89
  * ```
@@ -19,7 +19,7 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>A flywheel is an AWS resource that orchestrates the ongoing training of a model for custom classification
22
+ * <p>A flywheel is an Amazon Web Services resource that orchestrates the ongoing training of a model for custom classification
23
23
  * or custom entity recognition. You can create a flywheel to start with an existing trained model, or
24
24
  * Comprehend can create and train a new model.</p>
25
25
  * <p>When you create the flywheel, Comprehend creates a data lake in your account. The data lake holds the training
@@ -36,6 +36,49 @@ export interface CreateFlywheelCommandOutput extends CreateFlywheelResponse, __M
36
36
  * import { ComprehendClient, CreateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
37
37
  * // const { ComprehendClient, CreateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
38
38
  * const client = new ComprehendClient(config);
39
+ * const input = {
40
+ * FlywheelName: "STRING_VALUE", // required
41
+ * ActiveModelArn: "STRING_VALUE",
42
+ * DataAccessRoleArn: "STRING_VALUE", // required
43
+ * TaskConfig: {
44
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
45
+ * DocumentClassificationConfig: {
46
+ * Mode: "MULTI_CLASS" || "MULTI_LABEL", // required
47
+ * Labels: [
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * },
51
+ * EntityRecognitionConfig: {
52
+ * EntityTypes: [ // required
53
+ * {
54
+ * Type: "STRING_VALUE", // required
55
+ * },
56
+ * ],
57
+ * },
58
+ * },
59
+ * ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER",
60
+ * DataLakeS3Uri: "STRING_VALUE", // required
61
+ * DataSecurityConfig: {
62
+ * ModelKmsKeyId: "STRING_VALUE",
63
+ * VolumeKmsKeyId: "STRING_VALUE",
64
+ * DataLakeKmsKeyId: "STRING_VALUE",
65
+ * VpcConfig: {
66
+ * SecurityGroupIds: [ // required
67
+ * "STRING_VALUE",
68
+ * ],
69
+ * Subnets: [ // required
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * },
74
+ * ClientRequestToken: "STRING_VALUE",
75
+ * Tags: [
76
+ * {
77
+ * Key: "STRING_VALUE", // required
78
+ * Value: "STRING_VALUE",
79
+ * },
80
+ * ],
81
+ * };
39
82
  * const command = new CreateFlywheelCommand(input);
40
83
  * const response = await client.send(command);
41
84
  * ```
@@ -32,6 +32,9 @@ export interface DeleteDocumentClassifierCommandOutput extends DeleteDocumentCla
32
32
  * import { ComprehendClient, DeleteDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
33
33
  * // const { ComprehendClient, DeleteDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
34
34
  * const client = new ComprehendClient(config);
35
+ * const input = {
36
+ * DocumentClassifierArn: "STRING_VALUE", // required
37
+ * };
35
38
  * const command = new DeleteDocumentClassifierCommand(input);
36
39
  * const response = await client.send(command);
37
40
  * ```
@@ -28,6 +28,9 @@ export interface DeleteEndpointCommandOutput extends DeleteEndpointResponse, __M
28
28
  * import { ComprehendClient, DeleteEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, DeleteEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * EndpointArn: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new DeleteEndpointCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -32,6 +32,9 @@ export interface DeleteEntityRecognizerCommandOutput extends DeleteEntityRecogni
32
32
  * import { ComprehendClient, DeleteEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
33
33
  * // const { ComprehendClient, DeleteEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
34
34
  * const client = new ComprehendClient(config);
35
+ * const input = {
36
+ * EntityRecognizerArn: "STRING_VALUE", // required
37
+ * };
35
38
  * const command = new DeleteEntityRecognizerCommand(input);
36
39
  * const response = await client.send(command);
37
40
  * ```
@@ -29,6 +29,9 @@ export interface DeleteFlywheelCommandOutput extends DeleteFlywheelResponse, __M
29
29
  * import { ComprehendClient, DeleteFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
30
30
  * // const { ComprehendClient, DeleteFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
31
31
  * const client = new ComprehendClient(config);
32
+ * const input = {
33
+ * FlywheelArn: "STRING_VALUE", // required
34
+ * };
32
35
  * const command = new DeleteFlywheelCommand(input);
33
36
  * const response = await client.send(command);
34
37
  * ```
@@ -26,6 +26,10 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
26
26
  * import { ComprehendClient, DeleteResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, DeleteResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = {
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * PolicyRevisionId: "STRING_VALUE",
32
+ * };
29
33
  * const command = new DeleteResourcePolicyCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -28,6 +28,9 @@ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, _
28
28
  * import { ComprehendClient, DescribeDatasetCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, DescribeDatasetCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * DatasetArn: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new DescribeDatasetCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -27,6 +27,9 @@ export interface DescribeDocumentClassificationJobCommandOutput extends Describe
27
27
  * import { ComprehendClient, DescribeDocumentClassificationJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeDocumentClassificationJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = {
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeDocumentClassificationJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface DescribeDocumentClassifierCommandOutput extends DescribeDocumen
26
26
  * import { ComprehendClient, DescribeDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, DescribeDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = {
30
+ * DocumentClassifierArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeDocumentClassifierCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,9 @@ export interface DescribeDominantLanguageDetectionJobCommandOutput extends Descr
27
27
  * import { ComprehendClient, DescribeDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = {
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeDominantLanguageDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -28,6 +28,9 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
28
28
  * import { ComprehendClient, DescribeEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, DescribeEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = {
32
+ * EndpointArn: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new DescribeEndpointCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -27,6 +27,9 @@ export interface DescribeEntitiesDetectionJobCommandOutput extends DescribeEntit
27
27
  * import { ComprehendClient, DescribeEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = {
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeEntitiesDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribeEntityRecognizerCommandOutput extends DescribeEntityRec
27
27
  * import { ComprehendClient, DescribeEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = {
31
+ * EntityRecognizerArn: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeEntityRecognizerCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -26,6 +26,9 @@ export interface DescribeEventsDetectionJobCommandOutput extends DescribeEventsD
26
26
  * import { ComprehendClient, DescribeEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, DescribeEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = {
30
+ * JobId: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new DescribeEventsDetectionJobCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -27,6 +27,9 @@ export interface DescribeFlywheelCommandOutput extends DescribeFlywheelResponse,
27
27
  * import { ComprehendClient, DescribeFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = {
31
+ * FlywheelArn: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeFlywheelCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```