@aws-sdk/client-comprehend 3.299.0 → 3.301.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 (85) hide show
  1. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +5 -0
  2. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +6 -0
  3. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +6 -0
  4. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +6 -0
  5. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +6 -0
  6. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +6 -0
  7. package/dist-types/commands/ClassifyDocumentCommand.d.ts +12 -0
  8. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +4 -0
  9. package/dist-types/commands/CreateDatasetCommand.d.ts +43 -0
  10. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +48 -0
  11. package/dist-types/commands/CreateEndpointCommand.d.ts +14 -0
  12. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +56 -0
  13. package/dist-types/commands/CreateFlywheelCommand.d.ts +43 -0
  14. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +3 -0
  15. package/dist-types/commands/DeleteEndpointCommand.d.ts +3 -0
  16. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +3 -0
  17. package/dist-types/commands/DeleteFlywheelCommand.d.ts +3 -0
  18. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  19. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -0
  20. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +3 -0
  21. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +3 -0
  22. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +3 -0
  23. package/dist-types/commands/DescribeEndpointCommand.d.ts +3 -0
  24. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +3 -0
  25. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +3 -0
  26. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeFlywheelCommand.d.ts +3 -0
  28. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +4 -0
  29. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +3 -0
  30. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +3 -0
  32. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +3 -0
  33. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +3 -0
  34. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +3 -0
  35. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +3 -0
  36. package/dist-types/commands/DetectEntitiesCommand.d.ts +13 -0
  37. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +4 -0
  38. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +4 -0
  39. package/dist-types/commands/DetectSentimentCommand.d.ts +4 -0
  40. package/dist-types/commands/DetectSyntaxCommand.d.ts +4 -0
  41. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +4 -0
  42. package/dist-types/commands/ImportModelCommand.d.ts +13 -0
  43. package/dist-types/commands/ListDatasetsCommand.d.ts +11 -0
  44. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +10 -0
  45. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +4 -0
  46. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +10 -0
  47. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +10 -0
  48. package/dist-types/commands/ListEndpointsCommand.d.ts +10 -0
  49. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +10 -0
  50. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +4 -0
  51. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +10 -0
  52. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +10 -0
  53. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +9 -0
  54. package/dist-types/commands/ListFlywheelsCommand.d.ts +9 -0
  55. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +10 -0
  56. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +10 -0
  57. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +10 -0
  58. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  59. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +10 -0
  60. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +10 -0
  61. package/dist-types/commands/PutResourcePolicyCommand.d.ts +5 -0
  62. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +37 -0
  63. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +35 -0
  64. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +38 -0
  65. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +30 -0
  66. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +4 -0
  67. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +36 -0
  68. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +35 -0
  69. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +36 -0
  70. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +36 -0
  71. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +36 -0
  72. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +3 -0
  73. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +3 -0
  74. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +3 -0
  75. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +3 -0
  76. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +3 -0
  77. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +3 -0
  78. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +3 -0
  79. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +3 -0
  80. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +3 -0
  81. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  82. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  83. package/dist-types/commands/UpdateEndpointCommand.d.ts +7 -0
  84. package/dist-types/commands/UpdateFlywheelCommand.d.ts +17 -0
  85. package/package.json +8 -8
@@ -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 = { // BatchDetectDominantLanguageRequest
32
+ * TextList: [ // CustomerInputStringList // 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 = { // BatchDetectEntitiesRequest
33
+ * TextList: [ // CustomerInputStringList // 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 = { // BatchDetectKeyPhrasesRequest
30
+ * TextList: [ // CustomerInputStringList // 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 = { // BatchDetectSentimentRequest
32
+ * TextList: [ // CustomerInputStringList // 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 = { // BatchDetectSyntaxRequest
33
+ * TextList: [ // CustomerInputStringList // 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 = { // BatchDetectTargetedSentimentRequest
32
+ * TextList: [ // CustomerInputStringList // 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 = { // ClassifyDocumentRequest
40
+ * Text: "STRING_VALUE",
41
+ * EndpointArn: "STRING_VALUE", // required
42
+ * Bytes: "BLOB_VALUE",
43
+ * DocumentReaderConfig: { // DocumentReaderConfig
44
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
45
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
46
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
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 = { // ContainsPiiEntitiesRequest
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 = { // CreateDatasetRequest
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * DatasetName: "STRING_VALUE", // required
34
+ * DatasetType: "TRAIN" || "TEST",
35
+ * Description: "STRING_VALUE",
36
+ * InputDataConfig: { // DatasetInputDataConfig
37
+ * AugmentedManifests: [ // DatasetAugmentedManifestsList
38
+ * { // DatasetAugmentedManifestsListItem
39
+ * AttributeNames: [ // AttributeNamesList // 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: { // DatasetDocumentClassifierInputDataConfig
50
+ * S3Uri: "STRING_VALUE", // required
51
+ * LabelDelimiter: "STRING_VALUE",
52
+ * },
53
+ * EntityRecognizerInputDataConfig: { // DatasetEntityRecognizerInputDataConfig
54
+ * Annotations: { // DatasetEntityRecognizerAnnotations
55
+ * S3Uri: "STRING_VALUE", // required
56
+ * },
57
+ * Documents: { // DatasetEntityRecognizerDocuments
58
+ * S3Uri: "STRING_VALUE", // required
59
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
60
+ * },
61
+ * EntityList: { // DatasetEntityRecognizerEntityList
62
+ * S3Uri: "STRING_VALUE", // required
63
+ * },
64
+ * },
65
+ * },
66
+ * ClientRequestToken: "STRING_VALUE",
67
+ * Tags: [ // TagList
68
+ * { // Tag
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 = { // CreateDocumentClassifierRequest
35
+ * DocumentClassifierName: "STRING_VALUE", // required
36
+ * VersionName: "STRING_VALUE",
37
+ * DataAccessRoleArn: "STRING_VALUE", // required
38
+ * Tags: [ // TagList
39
+ * { // Tag
40
+ * Key: "STRING_VALUE", // required
41
+ * Value: "STRING_VALUE",
42
+ * },
43
+ * ],
44
+ * InputDataConfig: { // DocumentClassifierInputDataConfig
45
+ * DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
46
+ * S3Uri: "STRING_VALUE",
47
+ * TestS3Uri: "STRING_VALUE",
48
+ * LabelDelimiter: "STRING_VALUE",
49
+ * AugmentedManifests: [ // DocumentClassifierAugmentedManifestsList
50
+ * { // AugmentedManifestsListItem
51
+ * S3Uri: "STRING_VALUE", // required
52
+ * Split: "TRAIN" || "TEST",
53
+ * AttributeNames: [ // AttributeNamesList // 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: { // DocumentClassifierOutputDataConfig
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: { // VpcConfig
71
+ * SecurityGroupIds: [ // SecurityGroupIds // required
72
+ * "STRING_VALUE",
73
+ * ],
74
+ * Subnets: [ // 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 = { // CreateEndpointRequest
32
+ * EndpointName: "STRING_VALUE", // required
33
+ * ModelArn: "STRING_VALUE",
34
+ * DesiredInferenceUnits: Number("int"), // required
35
+ * ClientRequestToken: "STRING_VALUE",
36
+ * Tags: [ // TagList
37
+ * { // Tag
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 = { // CreateEntityRecognizerRequest
32
+ * RecognizerName: "STRING_VALUE", // required
33
+ * VersionName: "STRING_VALUE",
34
+ * DataAccessRoleArn: "STRING_VALUE", // required
35
+ * Tags: [ // TagList
36
+ * { // Tag
37
+ * Key: "STRING_VALUE", // required
38
+ * Value: "STRING_VALUE",
39
+ * },
40
+ * ],
41
+ * InputDataConfig: { // EntityRecognizerInputDataConfig
42
+ * DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
43
+ * EntityTypes: [ // EntityTypesList // required
44
+ * { // EntityTypesListItem
45
+ * Type: "STRING_VALUE", // required
46
+ * },
47
+ * ],
48
+ * Documents: { // EntityRecognizerDocuments
49
+ * S3Uri: "STRING_VALUE", // required
50
+ * TestS3Uri: "STRING_VALUE",
51
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
52
+ * },
53
+ * Annotations: { // EntityRecognizerAnnotations
54
+ * S3Uri: "STRING_VALUE", // required
55
+ * TestS3Uri: "STRING_VALUE",
56
+ * },
57
+ * EntityList: { // EntityRecognizerEntityList
58
+ * S3Uri: "STRING_VALUE", // required
59
+ * },
60
+ * AugmentedManifests: [ // EntityRecognizerAugmentedManifestsList
61
+ * { // AugmentedManifestsListItem
62
+ * S3Uri: "STRING_VALUE", // required
63
+ * Split: "TRAIN" || "TEST",
64
+ * AttributeNames: [ // AttributeNamesList // 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: { // VpcConfig
77
+ * SecurityGroupIds: [ // SecurityGroupIds // required
78
+ * "STRING_VALUE",
79
+ * ],
80
+ * Subnets: [ // 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
  * ```
@@ -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 = { // CreateFlywheelRequest
40
+ * FlywheelName: "STRING_VALUE", // required
41
+ * ActiveModelArn: "STRING_VALUE",
42
+ * DataAccessRoleArn: "STRING_VALUE", // required
43
+ * TaskConfig: { // TaskConfig
44
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
45
+ * DocumentClassificationConfig: { // DocumentClassificationConfig
46
+ * Mode: "MULTI_CLASS" || "MULTI_LABEL", // required
47
+ * Labels: [ // LabelsList
48
+ * "STRING_VALUE",
49
+ * ],
50
+ * },
51
+ * EntityRecognitionConfig: { // EntityRecognitionConfig
52
+ * EntityTypes: [ // EntityTypesList // required
53
+ * { // EntityTypesListItem
54
+ * Type: "STRING_VALUE", // required
55
+ * },
56
+ * ],
57
+ * },
58
+ * },
59
+ * ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER",
60
+ * DataLakeS3Uri: "STRING_VALUE", // required
61
+ * DataSecurityConfig: { // DataSecurityConfig
62
+ * ModelKmsKeyId: "STRING_VALUE",
63
+ * VolumeKmsKeyId: "STRING_VALUE",
64
+ * DataLakeKmsKeyId: "STRING_VALUE",
65
+ * VpcConfig: { // VpcConfig
66
+ * SecurityGroupIds: [ // SecurityGroupIds // required
67
+ * "STRING_VALUE",
68
+ * ],
69
+ * Subnets: [ // Subnets // required
70
+ * "STRING_VALUE",
71
+ * ],
72
+ * },
73
+ * },
74
+ * ClientRequestToken: "STRING_VALUE",
75
+ * Tags: [ // TagList
76
+ * { // Tag
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 = { // DeleteDocumentClassifierRequest
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 = { // DeleteEndpointRequest
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 = { // DeleteEntityRecognizerRequest
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 = { // DeleteFlywheelRequest
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 = { // DeleteResourcePolicyRequest
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 = { // DescribeDatasetRequest
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 = { // DescribeDocumentClassificationJobRequest
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 = { // DescribeDocumentClassifierRequest
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 = { // DescribeDominantLanguageDetectionJobRequest
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 = { // DescribeEndpointRequest
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 = { // DescribeEntitiesDetectionJobRequest
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 = { // DescribeEntityRecognizerRequest
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 = { // DescribeEventsDetectionJobRequest
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 = { // DescribeFlywheelRequest
31
+ * FlywheelArn: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeFlywheelCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -28,6 +28,10 @@ export interface DescribeFlywheelIterationCommandOutput extends DescribeFlywheel
28
28
  * import { ComprehendClient, DescribeFlywheelIterationCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, DescribeFlywheelIterationCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // DescribeFlywheelIterationRequest
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * FlywheelIterationId: "STRING_VALUE", // required
34
+ * };
31
35
  * const command = new DescribeFlywheelIterationCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -27,6 +27,9 @@ export interface DescribeKeyPhrasesDetectionJobCommandOutput extends DescribeKey
27
27
  * import { ComprehendClient, DescribeKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribeKeyPhrasesDetectionJobRequest
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeKeyPhrasesDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribePiiEntitiesDetectionJobCommandOutput extends DescribePi
27
27
  * import { ComprehendClient, DescribePiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribePiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribePiiEntitiesDetectionJobRequest
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribePiiEntitiesDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
27
27
  * import { ComprehendClient, DescribeResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribeResourcePolicyRequest
31
+ * ResourceArn: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeResourcePolicyCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribeSentimentDetectionJobCommandOutput extends DescribeSent
27
27
  * import { ComprehendClient, DescribeSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribeSentimentDetectionJobRequest
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeSentimentDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribeTargetedSentimentDetectionJobCommandOutput extends Desc
27
27
  * import { ComprehendClient, DescribeTargetedSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeTargetedSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribeTargetedSentimentDetectionJobRequest
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeTargetedSentimentDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DescribeTopicsDetectionJobCommandOutput extends DescribeTopicsD
27
27
  * import { ComprehendClient, DescribeTopicsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DescribeTopicsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DescribeTopicsDetectionJobRequest
31
+ * JobId: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DescribeTopicsDetectionJobCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -27,6 +27,9 @@ export interface DetectDominantLanguageCommandOutput extends DetectDominantLangu
27
27
  * import { ComprehendClient, DetectDominantLanguageCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DetectDominantLanguageCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DetectDominantLanguageRequest
31
+ * Text: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new DetectDominantLanguageCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -41,6 +41,19 @@ export interface DetectEntitiesCommandOutput extends DetectEntitiesResponse, __M
41
41
  * import { ComprehendClient, DetectEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
42
42
  * // const { ComprehendClient, DetectEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
43
43
  * const client = new ComprehendClient(config);
44
+ * const input = { // DetectEntitiesRequest
45
+ * Text: "STRING_VALUE",
46
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
47
+ * EndpointArn: "STRING_VALUE",
48
+ * Bytes: "BLOB_VALUE",
49
+ * DocumentReaderConfig: { // DocumentReaderConfig
50
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
51
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
52
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
53
+ * "TABLES" || "FORMS",
54
+ * ],
55
+ * },
56
+ * };
44
57
  * const command = new DetectEntitiesCommand(input);
45
58
  * const response = await client.send(command);
46
59
  * ```