@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
@@ -26,6 +26,10 @@ export interface DetectKeyPhrasesCommandOutput extends DetectKeyPhrasesResponse,
26
26
  * import { ComprehendClient, DetectKeyPhrasesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, DetectKeyPhrasesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // DetectKeyPhrasesRequest
30
+ * Text: "STRING_VALUE", // required
31
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
32
+ * };
29
33
  * const command = new DetectKeyPhrasesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -27,6 +27,10 @@ export interface DetectPiiEntitiesCommandOutput extends DetectPiiEntitiesRespons
27
27
  * import { ComprehendClient, DetectPiiEntitiesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DetectPiiEntitiesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DetectPiiEntitiesRequest
31
+ * Text: "STRING_VALUE", // required
32
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
33
+ * };
30
34
  * const command = new DetectPiiEntitiesCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -27,6 +27,10 @@ export interface DetectSentimentCommandOutput extends DetectSentimentResponse, _
27
27
  * import { ComprehendClient, DetectSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DetectSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DetectSentimentRequest
31
+ * Text: "STRING_VALUE", // required
32
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
33
+ * };
30
34
  * const command = new DetectSentimentCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -29,6 +29,10 @@ export interface DetectSyntaxCommandOutput extends DetectSyntaxResponse, __Metad
29
29
  * import { ComprehendClient, DetectSyntaxCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
30
30
  * // const { ComprehendClient, DetectSyntaxCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
31
31
  * const client = new ComprehendClient(config);
32
+ * const input = { // DetectSyntaxRequest
33
+ * Text: "STRING_VALUE", // required
34
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt", // required
35
+ * };
32
36
  * const command = new DetectSyntaxCommand(input);
33
37
  * const response = await client.send(command);
34
38
  * ```
@@ -27,6 +27,10 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
27
27
  * import { ComprehendClient, DetectTargetedSentimentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, DetectTargetedSentimentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // DetectTargetedSentimentRequest
31
+ * Text: "STRING_VALUE", // required
32
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
33
+ * };
30
34
  * const command = new DetectTargetedSentimentCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -31,6 +31,19 @@ export interface ImportModelCommandOutput extends ImportModelResponse, __Metadat
31
31
  * import { ComprehendClient, ImportModelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
32
32
  * // const { ComprehendClient, ImportModelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
33
33
  * const client = new ComprehendClient(config);
34
+ * const input = { // ImportModelRequest
35
+ * SourceModelArn: "STRING_VALUE", // required
36
+ * ModelName: "STRING_VALUE",
37
+ * VersionName: "STRING_VALUE",
38
+ * ModelKmsKeyId: "STRING_VALUE",
39
+ * DataAccessRoleArn: "STRING_VALUE",
40
+ * Tags: [ // TagList
41
+ * { // Tag
42
+ * Key: "STRING_VALUE", // required
43
+ * Value: "STRING_VALUE",
44
+ * },
45
+ * ],
46
+ * };
34
47
  * const command = new ImportModelCommand(input);
35
48
  * const response = await client.send(command);
36
49
  * ```
@@ -27,6 +27,17 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
27
27
  * import { ComprehendClient, ListDatasetsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, ListDatasetsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // ListDatasetsRequest
31
+ * FlywheelArn: "STRING_VALUE",
32
+ * Filter: { // DatasetFilter
33
+ * Status: "CREATING" || "COMPLETED" || "FAILED",
34
+ * DatasetType: "TRAIN" || "TEST",
35
+ * CreationTimeAfter: new Date("TIMESTAMP"),
36
+ * CreationTimeBefore: new Date("TIMESTAMP"),
37
+ * },
38
+ * NextToken: "STRING_VALUE",
39
+ * MaxResults: Number("int"),
40
+ * };
30
41
  * const command = new ListDatasetsCommand(input);
31
42
  * const response = await client.send(command);
32
43
  * ```
@@ -26,6 +26,16 @@ export interface ListDocumentClassificationJobsCommandOutput extends ListDocumen
26
26
  * import { ComprehendClient, ListDocumentClassificationJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListDocumentClassificationJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListDocumentClassificationJobsRequest
30
+ * Filter: { // DocumentClassificationJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListDocumentClassificationJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,10 @@ export interface ListDocumentClassifierSummariesCommandOutput extends ListDocume
26
26
  * import { ComprehendClient, ListDocumentClassifierSummariesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListDocumentClassifierSummariesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListDocumentClassifierSummariesRequest
30
+ * NextToken: "STRING_VALUE",
31
+ * MaxResults: Number("int"),
32
+ * };
29
33
  * const command = new ListDocumentClassifierSummariesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,16 @@ export interface ListDocumentClassifiersCommandOutput extends ListDocumentClassi
26
26
  * import { ComprehendClient, ListDocumentClassifiersCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListDocumentClassifiersCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListDocumentClassifiersRequest
30
+ * Filter: { // DocumentClassifierFilter
31
+ * Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
32
+ * DocumentClassifierName: "STRING_VALUE",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListDocumentClassifiersCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,16 @@ export interface ListDominantLanguageDetectionJobsCommandOutput extends ListDomi
26
26
  * import { ComprehendClient, ListDominantLanguageDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListDominantLanguageDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListDominantLanguageDetectionJobsRequest
30
+ * Filter: { // DominantLanguageDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListDominantLanguageDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -27,6 +27,16 @@ export interface ListEndpointsCommandOutput extends ListEndpointsResponse, __Met
27
27
  * import { ComprehendClient, ListEndpointsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
28
28
  * // const { ComprehendClient, ListEndpointsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
29
29
  * const client = new ComprehendClient(config);
30
+ * const input = { // ListEndpointsRequest
31
+ * Filter: { // EndpointFilter
32
+ * ModelArn: "STRING_VALUE",
33
+ * Status: "CREATING" || "DELETING" || "FAILED" || "IN_SERVICE" || "UPDATING",
34
+ * CreationTimeBefore: new Date("TIMESTAMP"),
35
+ * CreationTimeAfter: new Date("TIMESTAMP"),
36
+ * },
37
+ * NextToken: "STRING_VALUE",
38
+ * MaxResults: Number("int"),
39
+ * };
30
40
  * const command = new ListEndpointsCommand(input);
31
41
  * const response = await client.send(command);
32
42
  * ```
@@ -26,6 +26,16 @@ export interface ListEntitiesDetectionJobsCommandOutput extends ListEntitiesDete
26
26
  * import { ComprehendClient, ListEntitiesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListEntitiesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListEntitiesDetectionJobsRequest
30
+ * Filter: { // EntitiesDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListEntitiesDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,10 @@ export interface ListEntityRecognizerSummariesCommandOutput extends ListEntityRe
26
26
  * import { ComprehendClient, ListEntityRecognizerSummariesCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListEntityRecognizerSummariesCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListEntityRecognizerSummariesRequest
30
+ * NextToken: "STRING_VALUE",
31
+ * MaxResults: Number("int"),
32
+ * };
29
33
  * const command = new ListEntityRecognizerSummariesCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -31,6 +31,16 @@ export interface ListEntityRecognizersCommandOutput extends ListEntityRecognizer
31
31
  * import { ComprehendClient, ListEntityRecognizersCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
32
32
  * // const { ComprehendClient, ListEntityRecognizersCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
33
33
  * const client = new ComprehendClient(config);
34
+ * const input = { // ListEntityRecognizersRequest
35
+ * Filter: { // EntityRecognizerFilter
36
+ * Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
37
+ * RecognizerName: "STRING_VALUE",
38
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
39
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
40
+ * },
41
+ * NextToken: "STRING_VALUE",
42
+ * MaxResults: Number("int"),
43
+ * };
34
44
  * const command = new ListEntityRecognizersCommand(input);
35
45
  * const response = await client.send(command);
36
46
  * ```
@@ -26,6 +26,16 @@ export interface ListEventsDetectionJobsCommandOutput extends ListEventsDetectio
26
26
  * import { ComprehendClient, ListEventsDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListEventsDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListEventsDetectionJobsRequest
30
+ * Filter: { // EventsDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListEventsDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -28,6 +28,15 @@ export interface ListFlywheelIterationHistoryCommandOutput extends ListFlywheelI
28
28
  * import { ComprehendClient, ListFlywheelIterationHistoryCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, ListFlywheelIterationHistoryCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // ListFlywheelIterationHistoryRequest
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * Filter: { // FlywheelIterationFilter
34
+ * CreationTimeAfter: new Date("TIMESTAMP"),
35
+ * CreationTimeBefore: new Date("TIMESTAMP"),
36
+ * },
37
+ * NextToken: "STRING_VALUE",
38
+ * MaxResults: Number("int"),
39
+ * };
31
40
  * const command = new ListFlywheelIterationHistoryCommand(input);
32
41
  * const response = await client.send(command);
33
42
  * ```
@@ -26,6 +26,15 @@ export interface ListFlywheelsCommandOutput extends ListFlywheelsResponse, __Met
26
26
  * import { ComprehendClient, ListFlywheelsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListFlywheelsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListFlywheelsRequest
30
+ * Filter: { // FlywheelFilter
31
+ * Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
32
+ * CreationTimeAfter: new Date("TIMESTAMP"),
33
+ * CreationTimeBefore: new Date("TIMESTAMP"),
34
+ * },
35
+ * NextToken: "STRING_VALUE",
36
+ * MaxResults: Number("int"),
37
+ * };
29
38
  * const command = new ListFlywheelsCommand(input);
30
39
  * const response = await client.send(command);
31
40
  * ```
@@ -26,6 +26,16 @@ export interface ListKeyPhrasesDetectionJobsCommandOutput extends ListKeyPhrases
26
26
  * import { ComprehendClient, ListKeyPhrasesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListKeyPhrasesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListKeyPhrasesDetectionJobsRequest
30
+ * Filter: { // KeyPhrasesDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListKeyPhrasesDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,16 @@ export interface ListPiiEntitiesDetectionJobsCommandOutput extends ListPiiEntiti
26
26
  * import { ComprehendClient, ListPiiEntitiesDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListPiiEntitiesDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListPiiEntitiesDetectionJobsRequest
30
+ * Filter: { // PiiEntitiesDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListPiiEntitiesDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,16 @@ export interface ListSentimentDetectionJobsCommandOutput extends ListSentimentDe
26
26
  * import { ComprehendClient, ListSentimentDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListSentimentDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListSentimentDetectionJobsRequest
30
+ * Filter: { // SentimentDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListSentimentDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { ComprehendClient, ListTagsForResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListTagsForResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListTagsForResourceRequest
30
+ * ResourceArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new ListTagsForResourceCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -26,6 +26,16 @@ export interface ListTargetedSentimentDetectionJobsCommandOutput extends ListTar
26
26
  * import { ComprehendClient, ListTargetedSentimentDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListTargetedSentimentDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListTargetedSentimentDetectionJobsRequest
30
+ * Filter: { // TargetedSentimentDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListTargetedSentimentDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -26,6 +26,16 @@ export interface ListTopicsDetectionJobsCommandOutput extends ListTopicsDetectio
26
26
  * import { ComprehendClient, ListTopicsDetectionJobsCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, ListTopicsDetectionJobsCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // ListTopicsDetectionJobsRequest
30
+ * Filter: { // TopicsDetectionJobFilter
31
+ * JobName: "STRING_VALUE",
32
+ * JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
33
+ * SubmitTimeBefore: new Date("TIMESTAMP"),
34
+ * SubmitTimeAfter: new Date("TIMESTAMP"),
35
+ * },
36
+ * NextToken: "STRING_VALUE",
37
+ * MaxResults: Number("int"),
38
+ * };
29
39
  * const command = new ListTopicsDetectionJobsCommand(input);
30
40
  * const response = await client.send(command);
31
41
  * ```
@@ -28,6 +28,11 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
28
28
  * import { ComprehendClient, PutResourcePolicyCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, PutResourcePolicyCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // PutResourcePolicyRequest
32
+ * ResourceArn: "STRING_VALUE", // required
33
+ * ResourcePolicy: "STRING_VALUE", // required
34
+ * PolicyRevisionId: "STRING_VALUE",
35
+ * };
31
36
  * const command = new PutResourcePolicyCommand(input);
32
37
  * const response = await client.send(command);
33
38
  * ```
@@ -28,6 +28,43 @@ export interface StartDocumentClassificationJobCommandOutput extends StartDocume
28
28
  * import { ComprehendClient, StartDocumentClassificationJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, StartDocumentClassificationJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // StartDocumentClassificationJobRequest
32
+ * JobName: "STRING_VALUE",
33
+ * DocumentClassifierArn: "STRING_VALUE",
34
+ * InputDataConfig: { // InputDataConfig
35
+ * S3Uri: "STRING_VALUE", // required
36
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
37
+ * DocumentReaderConfig: { // DocumentReaderConfig
38
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
39
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
40
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
41
+ * "TABLES" || "FORMS",
42
+ * ],
43
+ * },
44
+ * },
45
+ * OutputDataConfig: { // OutputDataConfig
46
+ * S3Uri: "STRING_VALUE", // required
47
+ * KmsKeyId: "STRING_VALUE",
48
+ * },
49
+ * DataAccessRoleArn: "STRING_VALUE", // required
50
+ * ClientRequestToken: "STRING_VALUE",
51
+ * VolumeKmsKeyId: "STRING_VALUE",
52
+ * VpcConfig: { // VpcConfig
53
+ * SecurityGroupIds: [ // SecurityGroupIds // required
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * Subnets: [ // Subnets // required
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * Tags: [ // TagList
61
+ * { // Tag
62
+ * Key: "STRING_VALUE", // required
63
+ * Value: "STRING_VALUE",
64
+ * },
65
+ * ],
66
+ * FlywheelArn: "STRING_VALUE",
67
+ * };
31
68
  * const command = new StartDocumentClassificationJobCommand(input);
32
69
  * const response = await client.send(command);
33
70
  * ```
@@ -28,6 +28,41 @@ export interface StartDominantLanguageDetectionJobCommandOutput extends StartDom
28
28
  * import { ComprehendClient, StartDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, StartDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // StartDominantLanguageDetectionJobRequest
32
+ * InputDataConfig: { // InputDataConfig
33
+ * S3Uri: "STRING_VALUE", // required
34
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
35
+ * DocumentReaderConfig: { // DocumentReaderConfig
36
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
37
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
38
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
39
+ * "TABLES" || "FORMS",
40
+ * ],
41
+ * },
42
+ * },
43
+ * OutputDataConfig: { // OutputDataConfig
44
+ * S3Uri: "STRING_VALUE", // required
45
+ * KmsKeyId: "STRING_VALUE",
46
+ * },
47
+ * DataAccessRoleArn: "STRING_VALUE", // required
48
+ * JobName: "STRING_VALUE",
49
+ * ClientRequestToken: "STRING_VALUE",
50
+ * VolumeKmsKeyId: "STRING_VALUE",
51
+ * VpcConfig: { // VpcConfig
52
+ * SecurityGroupIds: [ // SecurityGroupIds // required
53
+ * "STRING_VALUE",
54
+ * ],
55
+ * Subnets: [ // Subnets // required
56
+ * "STRING_VALUE",
57
+ * ],
58
+ * },
59
+ * Tags: [ // TagList
60
+ * { // Tag
61
+ * Key: "STRING_VALUE", // required
62
+ * Value: "STRING_VALUE",
63
+ * },
64
+ * ],
65
+ * };
31
66
  * const command = new StartDominantLanguageDetectionJobCommand(input);
32
67
  * const response = await client.send(command);
33
68
  * ```
@@ -30,6 +30,44 @@ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDet
30
30
  * import { ComprehendClient, StartEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
31
31
  * // const { ComprehendClient, StartEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
32
32
  * const client = new ComprehendClient(config);
33
+ * const input = { // StartEntitiesDetectionJobRequest
34
+ * InputDataConfig: { // InputDataConfig
35
+ * S3Uri: "STRING_VALUE", // required
36
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
37
+ * DocumentReaderConfig: { // DocumentReaderConfig
38
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
39
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
40
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
41
+ * "TABLES" || "FORMS",
42
+ * ],
43
+ * },
44
+ * },
45
+ * OutputDataConfig: { // OutputDataConfig
46
+ * S3Uri: "STRING_VALUE", // required
47
+ * KmsKeyId: "STRING_VALUE",
48
+ * },
49
+ * DataAccessRoleArn: "STRING_VALUE", // required
50
+ * JobName: "STRING_VALUE",
51
+ * EntityRecognizerArn: "STRING_VALUE",
52
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
53
+ * ClientRequestToken: "STRING_VALUE",
54
+ * VolumeKmsKeyId: "STRING_VALUE",
55
+ * VpcConfig: { // VpcConfig
56
+ * SecurityGroupIds: [ // SecurityGroupIds // required
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * Subnets: [ // Subnets // required
60
+ * "STRING_VALUE",
61
+ * ],
62
+ * },
63
+ * Tags: [ // TagList
64
+ * { // Tag
65
+ * Key: "STRING_VALUE", // required
66
+ * Value: "STRING_VALUE",
67
+ * },
68
+ * ],
69
+ * FlywheelArn: "STRING_VALUE",
70
+ * };
33
71
  * const command = new StartEntitiesDetectionJobCommand(input);
34
72
  * const response = await client.send(command);
35
73
  * ```
@@ -26,6 +26,36 @@ export interface StartEventsDetectionJobCommandOutput extends StartEventsDetecti
26
26
  * import { ComprehendClient, StartEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
27
27
  * // const { ComprehendClient, StartEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
28
28
  * const client = new ComprehendClient(config);
29
+ * const input = { // StartEventsDetectionJobRequest
30
+ * InputDataConfig: { // InputDataConfig
31
+ * S3Uri: "STRING_VALUE", // required
32
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
33
+ * DocumentReaderConfig: { // DocumentReaderConfig
34
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
35
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
36
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
37
+ * "TABLES" || "FORMS",
38
+ * ],
39
+ * },
40
+ * },
41
+ * OutputDataConfig: { // OutputDataConfig
42
+ * S3Uri: "STRING_VALUE", // required
43
+ * KmsKeyId: "STRING_VALUE",
44
+ * },
45
+ * DataAccessRoleArn: "STRING_VALUE", // required
46
+ * JobName: "STRING_VALUE",
47
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
48
+ * ClientRequestToken: "STRING_VALUE",
49
+ * TargetEventTypes: [ // TargetEventTypes // required
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * Tags: [ // TagList
53
+ * { // Tag
54
+ * Key: "STRING_VALUE", // required
55
+ * Value: "STRING_VALUE",
56
+ * },
57
+ * ],
58
+ * };
29
59
  * const command = new StartEventsDetectionJobCommand(input);
30
60
  * const response = await client.send(command);
31
61
  * ```
@@ -28,6 +28,10 @@ export interface StartFlywheelIterationCommandOutput extends StartFlywheelIterat
28
28
  * import { ComprehendClient, StartFlywheelIterationCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, StartFlywheelIterationCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // StartFlywheelIterationRequest
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * ClientRequestToken: "STRING_VALUE",
34
+ * };
31
35
  * const command = new StartFlywheelIterationCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -28,6 +28,42 @@ export interface StartKeyPhrasesDetectionJobCommandOutput extends StartKeyPhrase
28
28
  * import { ComprehendClient, StartKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
29
29
  * // const { ComprehendClient, StartKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
30
30
  * const client = new ComprehendClient(config);
31
+ * const input = { // StartKeyPhrasesDetectionJobRequest
32
+ * InputDataConfig: { // InputDataConfig
33
+ * S3Uri: "STRING_VALUE", // required
34
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
35
+ * DocumentReaderConfig: { // DocumentReaderConfig
36
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
37
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
38
+ * FeatureTypes: [ // ListOfDocumentReadFeatureTypes
39
+ * "TABLES" || "FORMS",
40
+ * ],
41
+ * },
42
+ * },
43
+ * OutputDataConfig: { // OutputDataConfig
44
+ * S3Uri: "STRING_VALUE", // required
45
+ * KmsKeyId: "STRING_VALUE",
46
+ * },
47
+ * DataAccessRoleArn: "STRING_VALUE", // required
48
+ * JobName: "STRING_VALUE",
49
+ * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
50
+ * ClientRequestToken: "STRING_VALUE",
51
+ * VolumeKmsKeyId: "STRING_VALUE",
52
+ * VpcConfig: { // VpcConfig
53
+ * SecurityGroupIds: [ // SecurityGroupIds // required
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * Subnets: [ // Subnets // required
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * Tags: [ // TagList
61
+ * { // Tag
62
+ * Key: "STRING_VALUE", // required
63
+ * Value: "STRING_VALUE",
64
+ * },
65
+ * ],
66
+ * };
31
67
  * const command = new StartKeyPhrasesDetectionJobCommand(input);
32
68
  * const response = await client.send(command);
33
69
  * ```