@aws-sdk/client-comprehend 3.300.0 → 3.303.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 (89) hide show
  1. package/dist-cjs/models/models_0.js +250 -283
  2. package/dist-es/models/models_0.js +250 -283
  3. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +2 -2
  4. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +2 -2
  5. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +2 -2
  6. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +2 -2
  7. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +2 -2
  8. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +2 -2
  9. package/dist-types/commands/ClassifyDocumentCommand.d.ts +3 -3
  10. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +1 -1
  11. package/dist-types/commands/CreateDatasetCommand.d.ts +12 -12
  12. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +11 -11
  13. package/dist-types/commands/CreateEndpointCommand.d.ts +3 -3
  14. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +15 -15
  15. package/dist-types/commands/CreateFlywheelCommand.d.ts +13 -13
  16. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +1 -1
  17. package/dist-types/commands/DeleteEndpointCommand.d.ts +1 -1
  18. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteFlywheelCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribeDatasetCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +1 -1
  24. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +1 -1
  25. package/dist-types/commands/DescribeEndpointCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +1 -1
  28. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +1 -1
  29. package/dist-types/commands/DescribeFlywheelCommand.d.ts +1 -1
  30. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +1 -1
  31. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +1 -1
  32. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +1 -1
  33. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +1 -1
  34. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +1 -1
  35. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +1 -1
  36. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +1 -1
  37. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +1 -1
  38. package/dist-types/commands/DetectEntitiesCommand.d.ts +3 -3
  39. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +1 -1
  40. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +1 -1
  41. package/dist-types/commands/DetectSentimentCommand.d.ts +1 -1
  42. package/dist-types/commands/DetectSyntaxCommand.d.ts +1 -1
  43. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +1 -1
  44. package/dist-types/commands/ImportModelCommand.d.ts +3 -3
  45. package/dist-types/commands/ListDatasetsCommand.d.ts +2 -2
  46. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +2 -2
  47. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +1 -1
  48. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +2 -2
  49. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +2 -2
  50. package/dist-types/commands/ListEndpointsCommand.d.ts +2 -2
  51. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +2 -2
  52. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +1 -1
  53. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +2 -2
  54. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +2 -2
  55. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +2 -2
  56. package/dist-types/commands/ListFlywheelsCommand.d.ts +2 -2
  57. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +2 -2
  58. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +2 -2
  59. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +2 -2
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  61. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +2 -2
  62. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +2 -2
  63. package/dist-types/commands/PutResourcePolicyCommand.d.ts +1 -1
  64. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +10 -10
  65. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +10 -10
  66. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +10 -10
  67. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +8 -8
  68. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +1 -1
  69. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +10 -10
  70. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +9 -9
  71. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +10 -10
  72. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +10 -10
  73. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +10 -10
  74. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +1 -1
  75. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +1 -1
  76. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +1 -1
  77. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +1 -1
  78. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +1 -1
  79. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +1 -1
  80. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +1 -1
  81. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +1 -1
  82. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +1 -1
  83. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  84. package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
  85. package/dist-types/commands/UpdateEndpointCommand.d.ts +1 -1
  86. package/dist-types/commands/UpdateFlywheelCommand.d.ts +5 -5
  87. package/dist-types/models/models_0.d.ts +416 -251
  88. package/dist-types/ts3.4/models/models_0.d.ts +303 -250
  89. package/package.json +34 -34
@@ -28,19 +28,19 @@ export interface StartTargetedSentimentDetectionJobCommandOutput extends StartTa
28
28
  * import { ComprehendClient, StartTargetedSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, StartTargetedSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
- * const input = {
32
- * InputDataConfig: {
31
+ * const input = { // StartTargetedSentimentDetectionJobRequest
32
+ * InputDataConfig: { // InputDataConfig
33
33
  * S3Uri: "STRING_VALUE", // required
34
34
  * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
35
- * DocumentReaderConfig: {
35
+ * DocumentReaderConfig: { // DocumentReaderConfig
36
36
  * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
37
37
  * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
38
- * FeatureTypes: [
38
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
39
39
  * "TABLES" || "FORMS",
40
40
  * ],
41
41
  * },
42
42
  * },
43
- * OutputDataConfig: {
43
+ * OutputDataConfig: { // OutputDataConfig
44
44
  * S3Uri: "STRING_VALUE", // required
45
45
  * KmsKeyId: "STRING_VALUE",
46
46
  * },
@@ -49,16 +49,16 @@ export interface StartTargetedSentimentDetectionJobCommandOutput extends StartTa
49
49
  * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
50
50
  * ClientRequestToken: "STRING_VALUE",
51
51
  * VolumeKmsKeyId: "STRING_VALUE",
52
- * VpcConfig: {
53
- * SecurityGroupIds: [ // required
52
+ * VpcConfig: { // VpcConfig
53
+ * SecurityGroupIds: [ // SecurityGroupIds // required
54
54
  * "STRING_VALUE",
55
55
  * ],
56
- * Subnets: [ // required
56
+ * Subnets: [ // Subnets // required
57
57
  * "STRING_VALUE",
58
58
  * ],
59
59
  * },
60
- * Tags: [
61
- * {
60
+ * Tags: [ // TagList
61
+ * { // Tag
62
62
  * Key: "STRING_VALUE", // required
63
63
  * Value: "STRING_VALUE",
64
64
  * },
@@ -27,19 +27,19 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
27
27
  * import { ComprehendClient, StartTopicsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, StartTopicsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
- * const input = {
31
- * InputDataConfig: {
30
+ * const input = { // StartTopicsDetectionJobRequest
31
+ * InputDataConfig: { // InputDataConfig
32
32
  * S3Uri: "STRING_VALUE", // required
33
33
  * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
34
- * DocumentReaderConfig: {
34
+ * DocumentReaderConfig: { // DocumentReaderConfig
35
35
  * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
36
36
  * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
37
- * FeatureTypes: [
37
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
38
38
  * "TABLES" || "FORMS",
39
39
  * ],
40
40
  * },
41
41
  * },
42
- * OutputDataConfig: {
42
+ * OutputDataConfig: { // OutputDataConfig
43
43
  * S3Uri: "STRING_VALUE", // required
44
44
  * KmsKeyId: "STRING_VALUE",
45
45
  * },
@@ -48,16 +48,16 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
48
48
  * NumberOfTopics: Number("int"),
49
49
  * ClientRequestToken: "STRING_VALUE",
50
50
  * VolumeKmsKeyId: "STRING_VALUE",
51
- * VpcConfig: {
52
- * SecurityGroupIds: [ // required
51
+ * VpcConfig: { // VpcConfig
52
+ * SecurityGroupIds: [ // SecurityGroupIds // required
53
53
  * "STRING_VALUE",
54
54
  * ],
55
- * Subnets: [ // required
55
+ * Subnets: [ // Subnets // required
56
56
  * "STRING_VALUE",
57
57
  * ],
58
58
  * },
59
- * Tags: [
60
- * {
59
+ * Tags: [ // TagList
60
+ * { // Tag
61
61
  * Key: "STRING_VALUE", // required
62
62
  * Value: "STRING_VALUE",
63
63
  * },
@@ -35,7 +35,7 @@ export interface StopDominantLanguageDetectionJobCommandOutput extends StopDomin
35
35
  * import { ComprehendClient, StopDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
36
36
  * // const { ComprehendClient, StopDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
37
37
  * const client = new ComprehendClient(config);
38
- * const input = {
38
+ * const input = { // StopDominantLanguageDetectionJobRequest
39
39
  * JobId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new StopDominantLanguageDetectionJobCommand(input);
@@ -35,7 +35,7 @@ export interface StopEntitiesDetectionJobCommandOutput extends StopEntitiesDetec
35
35
  * import { ComprehendClient, StopEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
36
36
  * // const { ComprehendClient, StopEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
37
37
  * const client = new ComprehendClient(config);
38
- * const input = {
38
+ * const input = { // StopEntitiesDetectionJobRequest
39
39
  * JobId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new StopEntitiesDetectionJobCommand(input);
@@ -26,7 +26,7 @@ export interface StopEventsDetectionJobCommandOutput extends StopEventsDetection
26
26
  * import { ComprehendClient, StopEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, StopEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
- * const input = {
29
+ * const input = { // StopEventsDetectionJobRequest
30
30
  * JobId: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new StopEventsDetectionJobCommand(input);
@@ -35,7 +35,7 @@ export interface StopKeyPhrasesDetectionJobCommandOutput extends StopKeyPhrasesD
35
35
  * import { ComprehendClient, StopKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
36
36
  * // const { ComprehendClient, StopKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
37
37
  * const client = new ComprehendClient(config);
38
- * const input = {
38
+ * const input = { // StopKeyPhrasesDetectionJobRequest
39
39
  * JobId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new StopKeyPhrasesDetectionJobCommand(input);
@@ -26,7 +26,7 @@ export interface StopPiiEntitiesDetectionJobCommandOutput extends StopPiiEntitie
26
26
  * import { ComprehendClient, StopPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, StopPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
- * const input = {
29
+ * const input = { // StopPiiEntitiesDetectionJobRequest
30
30
  * JobId: "STRING_VALUE", // required
31
31
  * };
32
32
  * const command = new StopPiiEntitiesDetectionJobCommand(input);
@@ -35,7 +35,7 @@ export interface StopSentimentDetectionJobCommandOutput extends StopSentimentDet
35
35
  * import { ComprehendClient, StopSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
36
36
  * // const { ComprehendClient, StopSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
37
37
  * const client = new ComprehendClient(config);
38
- * const input = {
38
+ * const input = { // StopSentimentDetectionJobRequest
39
39
  * JobId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new StopSentimentDetectionJobCommand(input);
@@ -35,7 +35,7 @@ export interface StopTargetedSentimentDetectionJobCommandOutput extends StopTarg
35
35
  * import { ComprehendClient, StopTargetedSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
36
36
  * // const { ComprehendClient, StopTargetedSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
37
37
  * const client = new ComprehendClient(config);
38
- * const input = {
38
+ * const input = { // StopTargetedSentimentDetectionJobRequest
39
39
  * JobId: "STRING_VALUE", // required
40
40
  * };
41
41
  * const command = new StopTargetedSentimentDetectionJobCommand(input);
@@ -31,7 +31,7 @@ export interface StopTrainingDocumentClassifierCommandOutput extends StopTrainin
31
31
  * import { ComprehendClient, StopTrainingDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
32
32
  * // const { ComprehendClient, StopTrainingDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
33
33
  * const client = new ComprehendClient(config);
34
- * const input = {
34
+ * const input = { // StopTrainingDocumentClassifierRequest
35
35
  * DocumentClassifierArn: "STRING_VALUE", // required
36
36
  * };
37
37
  * const command = new StopTrainingDocumentClassifierCommand(input);
@@ -31,7 +31,7 @@ export interface StopTrainingEntityRecognizerCommandOutput extends StopTrainingE
31
31
  * import { ComprehendClient, StopTrainingEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
32
32
  * // const { ComprehendClient, StopTrainingEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
33
33
  * const client = new ComprehendClient(config);
34
- * const input = {
34
+ * const input = { // StopTrainingEntityRecognizerRequest
35
35
  * EntityRecognizerArn: "STRING_VALUE", // required
36
36
  * };
37
37
  * const command = new StopTrainingEntityRecognizerCommand(input);
@@ -29,10 +29,10 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
29
29
  * import { ComprehendClient, TagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
30
30
  * // const { ComprehendClient, TagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
31
31
  * const client = new ComprehendClient(config);
32
- * const input = {
32
+ * const input = { // TagResourceRequest
33
33
  * ResourceArn: "STRING_VALUE", // required
34
- * Tags: [ // required
35
- * {
34
+ * Tags: [ // TagList // required
35
+ * { // Tag
36
36
  * Key: "STRING_VALUE", // required
37
37
  * Value: "STRING_VALUE",
38
38
  * },
@@ -26,9 +26,9 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
26
  * import { ComprehendClient, UntagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, UntagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
- * const input = {
29
+ * const input = { // UntagResourceRequest
30
30
  * ResourceArn: "STRING_VALUE", // required
31
- * TagKeys: [ // required
31
+ * TagKeys: [ // TagKeyList // required
32
32
  * "STRING_VALUE",
33
33
  * ],
34
34
  * };
@@ -27,7 +27,7 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
27
27
  * import { ComprehendClient, UpdateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, UpdateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
- * const input = {
30
+ * const input = { // UpdateEndpointRequest
31
31
  * EndpointArn: "STRING_VALUE", // required
32
32
  * DesiredModelArn: "STRING_VALUE",
33
33
  * DesiredInferenceUnits: Number("int"),
@@ -26,18 +26,18 @@ export interface UpdateFlywheelCommandOutput extends UpdateFlywheelResponse, __M
26
26
  * import { ComprehendClient, UpdateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, UpdateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
- * const input = {
29
+ * const input = { // UpdateFlywheelRequest
30
30
  * FlywheelArn: "STRING_VALUE", // required
31
31
  * ActiveModelArn: "STRING_VALUE",
32
32
  * DataAccessRoleArn: "STRING_VALUE",
33
- * DataSecurityConfig: {
33
+ * DataSecurityConfig: { // UpdateDataSecurityConfig
34
34
  * ModelKmsKeyId: "STRING_VALUE",
35
35
  * VolumeKmsKeyId: "STRING_VALUE",
36
- * VpcConfig: {
37
- * SecurityGroupIds: [ // required
36
+ * VpcConfig: { // VpcConfig
37
+ * SecurityGroupIds: [ // SecurityGroupIds // required
38
38
  * "STRING_VALUE",
39
39
  * ],
40
- * Subnets: [ // required
40
+ * Subnets: [ // Subnets // required
41
41
  * "STRING_VALUE",
42
42
  * ],
43
43
  * },