@aws-sdk/client-comprehend 3.298.0 → 3.300.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (95) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/models/models_0.js +1 -0
  3. package/dist-cjs/protocols/Aws_json1_1.js +1 -0
  4. package/dist-es/models/models_0.js +1 -0
  5. package/dist-es/protocols/Aws_json1_1.js +1 -0
  6. package/dist-types/Comprehend.d.ts +8 -8
  7. package/dist-types/ComprehendClient.d.ts +1 -1
  8. package/dist-types/commands/BatchDetectDominantLanguageCommand.d.ts +5 -0
  9. package/dist-types/commands/BatchDetectEntitiesCommand.d.ts +6 -0
  10. package/dist-types/commands/BatchDetectKeyPhrasesCommand.d.ts +6 -0
  11. package/dist-types/commands/BatchDetectSentimentCommand.d.ts +6 -0
  12. package/dist-types/commands/BatchDetectSyntaxCommand.d.ts +6 -0
  13. package/dist-types/commands/BatchDetectTargetedSentimentCommand.d.ts +6 -0
  14. package/dist-types/commands/ClassifyDocumentCommand.d.ts +12 -0
  15. package/dist-types/commands/ContainsPiiEntitiesCommand.d.ts +4 -0
  16. package/dist-types/commands/CreateDatasetCommand.d.ts +43 -0
  17. package/dist-types/commands/CreateDocumentClassifierCommand.d.ts +48 -0
  18. package/dist-types/commands/CreateEndpointCommand.d.ts +14 -0
  19. package/dist-types/commands/CreateEntityRecognizerCommand.d.ts +56 -0
  20. package/dist-types/commands/CreateFlywheelCommand.d.ts +44 -1
  21. package/dist-types/commands/DeleteDocumentClassifierCommand.d.ts +3 -0
  22. package/dist-types/commands/DeleteEndpointCommand.d.ts +3 -0
  23. package/dist-types/commands/DeleteEntityRecognizerCommand.d.ts +3 -0
  24. package/dist-types/commands/DeleteFlywheelCommand.d.ts +3 -0
  25. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +4 -0
  26. package/dist-types/commands/DescribeDatasetCommand.d.ts +3 -0
  27. package/dist-types/commands/DescribeDocumentClassificationJobCommand.d.ts +3 -0
  28. package/dist-types/commands/DescribeDocumentClassifierCommand.d.ts +3 -0
  29. package/dist-types/commands/DescribeDominantLanguageDetectionJobCommand.d.ts +3 -0
  30. package/dist-types/commands/DescribeEndpointCommand.d.ts +3 -0
  31. package/dist-types/commands/DescribeEntitiesDetectionJobCommand.d.ts +3 -0
  32. package/dist-types/commands/DescribeEntityRecognizerCommand.d.ts +3 -0
  33. package/dist-types/commands/DescribeEventsDetectionJobCommand.d.ts +3 -0
  34. package/dist-types/commands/DescribeFlywheelCommand.d.ts +3 -0
  35. package/dist-types/commands/DescribeFlywheelIterationCommand.d.ts +4 -0
  36. package/dist-types/commands/DescribeKeyPhrasesDetectionJobCommand.d.ts +3 -0
  37. package/dist-types/commands/DescribePiiEntitiesDetectionJobCommand.d.ts +3 -0
  38. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +3 -0
  39. package/dist-types/commands/DescribeSentimentDetectionJobCommand.d.ts +3 -0
  40. package/dist-types/commands/DescribeTargetedSentimentDetectionJobCommand.d.ts +3 -0
  41. package/dist-types/commands/DescribeTopicsDetectionJobCommand.d.ts +3 -0
  42. package/dist-types/commands/DetectDominantLanguageCommand.d.ts +3 -0
  43. package/dist-types/commands/DetectEntitiesCommand.d.ts +13 -0
  44. package/dist-types/commands/DetectKeyPhrasesCommand.d.ts +4 -0
  45. package/dist-types/commands/DetectPiiEntitiesCommand.d.ts +4 -0
  46. package/dist-types/commands/DetectSentimentCommand.d.ts +4 -0
  47. package/dist-types/commands/DetectSyntaxCommand.d.ts +4 -0
  48. package/dist-types/commands/DetectTargetedSentimentCommand.d.ts +4 -0
  49. package/dist-types/commands/ImportModelCommand.d.ts +17 -4
  50. package/dist-types/commands/ListDatasetsCommand.d.ts +12 -1
  51. package/dist-types/commands/ListDocumentClassificationJobsCommand.d.ts +10 -0
  52. package/dist-types/commands/ListDocumentClassifierSummariesCommand.d.ts +4 -0
  53. package/dist-types/commands/ListDocumentClassifiersCommand.d.ts +10 -0
  54. package/dist-types/commands/ListDominantLanguageDetectionJobsCommand.d.ts +10 -0
  55. package/dist-types/commands/ListEndpointsCommand.d.ts +10 -0
  56. package/dist-types/commands/ListEntitiesDetectionJobsCommand.d.ts +10 -0
  57. package/dist-types/commands/ListEntityRecognizerSummariesCommand.d.ts +4 -0
  58. package/dist-types/commands/ListEntityRecognizersCommand.d.ts +10 -0
  59. package/dist-types/commands/ListEventsDetectionJobsCommand.d.ts +10 -0
  60. package/dist-types/commands/ListFlywheelIterationHistoryCommand.d.ts +9 -0
  61. package/dist-types/commands/ListFlywheelsCommand.d.ts +9 -0
  62. package/dist-types/commands/ListKeyPhrasesDetectionJobsCommand.d.ts +10 -0
  63. package/dist-types/commands/ListPiiEntitiesDetectionJobsCommand.d.ts +10 -0
  64. package/dist-types/commands/ListSentimentDetectionJobsCommand.d.ts +10 -0
  65. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  66. package/dist-types/commands/ListTargetedSentimentDetectionJobsCommand.d.ts +10 -0
  67. package/dist-types/commands/ListTopicsDetectionJobsCommand.d.ts +10 -0
  68. package/dist-types/commands/PutResourcePolicyCommand.d.ts +6 -1
  69. package/dist-types/commands/StartDocumentClassificationJobCommand.d.ts +37 -0
  70. package/dist-types/commands/StartDominantLanguageDetectionJobCommand.d.ts +35 -0
  71. package/dist-types/commands/StartEntitiesDetectionJobCommand.d.ts +38 -0
  72. package/dist-types/commands/StartEventsDetectionJobCommand.d.ts +30 -0
  73. package/dist-types/commands/StartFlywheelIterationCommand.d.ts +4 -0
  74. package/dist-types/commands/StartKeyPhrasesDetectionJobCommand.d.ts +36 -0
  75. package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts +35 -0
  76. package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts +36 -0
  77. package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts +36 -0
  78. package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts +36 -0
  79. package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts +3 -0
  80. package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts +3 -0
  81. package/dist-types/commands/StopEventsDetectionJobCommand.d.ts +3 -0
  82. package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts +3 -0
  83. package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts +3 -0
  84. package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts +3 -0
  85. package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts +3 -0
  86. package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts +3 -0
  87. package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts +3 -0
  88. package/dist-types/commands/TagResourceCommand.d.ts +9 -0
  89. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  90. package/dist-types/commands/UpdateEndpointCommand.d.ts +7 -0
  91. package/dist-types/commands/UpdateFlywheelCommand.d.ts +17 -0
  92. package/dist-types/models/models_0.d.ts +106 -108
  93. package/dist-types/models/models_1.d.ts +2 -2
  94. package/dist-types/ts3.4/models/models_0.d.ts +2 -0
  95. package/package.json +12 -12
@@ -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 = {
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 = {
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 = {
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 = {
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 = {
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 = {
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 = {
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 = {
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 = {
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: {
50
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
51
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
52
+ * FeatureTypes: [
53
+ * "TABLES" || "FORMS",
54
+ * ],
55
+ * },
56
+ * };
44
57
  * const command = new DetectEntitiesCommand(input);
45
58
  * const response = await client.send(command);
46
59
  * ```
@@ -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 = {
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 = {
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 = {
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 = {
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 = {
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
  * ```
@@ -20,17 +20,30 @@ export interface ImportModelCommandOutput extends ImportModelResponse, __Metadat
20
20
  /**
21
21
  * @public
22
22
  * <p>Creates a new custom model that replicates a source custom model that you import. The
23
- * source model can be in your AWS account or another one.</p>
24
- * <p>If the source model is in another AWS account, then it must have a resource-based policy
23
+ * source model can be in your Amazon Web Services account or another one.</p>
24
+ * <p>If the source model is in another Amazon Web Services account, then it must have a resource-based policy
25
25
  * that authorizes you to import it.</p>
26
- * <p>The source model must be in the same AWS region that you're using when you import. You
27
- * can't import a model that's in a different region.</p>
26
+ * <p>The source model must be in the same Amazon Web Services Region that you're using when you import. You
27
+ * can't import a model that's in a different Region.</p>
28
28
  * @example
29
29
  * Use a bare-bones client and the command you need to make an API call.
30
30
  * ```javascript
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 = {
35
+ * SourceModelArn: "STRING_VALUE", // required
36
+ * ModelName: "STRING_VALUE",
37
+ * VersionName: "STRING_VALUE",
38
+ * ModelKmsKeyId: "STRING_VALUE",
39
+ * DataAccessRoleArn: "STRING_VALUE",
40
+ * Tags: [
41
+ * {
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
  * ```
@@ -19,7 +19,7 @@ export interface ListDatasetsCommandOutput extends ListDatasetsResponse, __Metad
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>List the datasets that you have configured in this region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
22
+ * <p>List the datasets that you have configured in this Region. For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
23
23
  * Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
24
24
  * @example
25
25
  * Use a bare-bones client and the command you need to make an API call.
@@ -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 = {
31
+ * FlywheelArn: "STRING_VALUE",
32
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
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 = {
30
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
31
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
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 = {
35
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
32
+ * FlywheelArn: "STRING_VALUE", // required
33
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
30
+ * Filter: {
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 = {
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 = {
30
+ * Filter: {
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 = {
30
+ * Filter: {
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
  * ```
@@ -20,7 +20,7 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
20
20
  /**
21
21
  * @public
22
22
  * <p>Attaches a resource-based policy to a custom model. You can use this policy to authorize
23
- * an entity in another AWS account to import the custom model, which replicates it in Amazon
23
+ * an entity in another Amazon Web Services account to import the custom model, which replicates it in Amazon
24
24
  * Comprehend in their account.</p>
25
25
  * @example
26
26
  * Use a bare-bones client and the command you need to make an API call.
@@ -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 = {
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 = {
32
+ * JobName: "STRING_VALUE",
33
+ * DocumentClassifierArn: "STRING_VALUE",
34
+ * InputDataConfig: {
35
+ * S3Uri: "STRING_VALUE", // required
36
+ * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
37
+ * DocumentReaderConfig: {
38
+ * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
39
+ * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
40
+ * FeatureTypes: [
41
+ * "TABLES" || "FORMS",
42
+ * ],
43
+ * },
44
+ * },
45
+ * 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: {
53
+ * SecurityGroupIds: [ // required
54
+ * "STRING_VALUE",
55
+ * ],
56
+ * Subnets: [ // required
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * },
60
+ * Tags: [
61
+ * {
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
  * ```