@aws-sdk/client-comprehend 3.299.0 → 3.300.0

package/dist-types/commands/StartPiiEntitiesDetectionJobCommand.d.ts

@@ -26,6 +26,41 @@ export interface StartPiiEntitiesDetectionJobCommandOutput extends StartPiiEntit
  * import { ComprehendClient, StartPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StartPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   InputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ *     DocumentReaderConfig: {
+ *       DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ *       DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ *       FeatureTypes: [
+ *         "TABLES" || "FORMS",
+ *       ],
+ *     },
+ *   },
+ *   OutputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     KmsKeyId: "STRING_VALUE",
+ *   },
+ *   Mode: "ONLY_REDACTION" || "ONLY_OFFSETS", // required
+ *   RedactionConfig: {
+ *     PiiEntityTypes: [
+ *       "BANK_ACCOUNT_NUMBER" || "BANK_ROUTING" || "CREDIT_DEBIT_NUMBER" || "CREDIT_DEBIT_CVV" || "CREDIT_DEBIT_EXPIRY" || "PIN" || "EMAIL" || "ADDRESS" || "NAME" || "PHONE" || "SSN" || "DATE_TIME" || "PASSPORT_NUMBER" || "DRIVER_ID" || "URL" || "AGE" || "USERNAME" || "PASSWORD" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "IP_ADDRESS" || "MAC_ADDRESS" || "ALL" || "LICENSE_PLATE" || "VEHICLE_IDENTIFICATION_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "IN_PERMANENT_ACCOUNT_NUMBER" || "IN_NREGA" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "CA_HEALTH_NUMBER" || "IN_AADHAAR" || "IN_VOTER_NUMBER",
+ *     ],
+ *     MaskMode: "MASK" || "REPLACE_WITH_PII_ENTITY_TYPE",
+ *     MaskCharacter: "STRING_VALUE",
+ *   },
+ *   DataAccessRoleArn: "STRING_VALUE", // required
+ *   JobName: "STRING_VALUE",
+ *   LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ *   Tags: [
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new StartPiiEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StartSentimentDetectionJobCommand.d.ts

@@ -28,6 +28,42 @@ export interface StartSentimentDetectionJobCommandOutput extends StartSentimentD
  * import { ComprehendClient, StartSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StartSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   InputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ *     DocumentReaderConfig: {
+ *       DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ *       DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ *       FeatureTypes: [
+ *         "TABLES" || "FORMS",
+ *       ],
+ *     },
+ *   },
+ *   OutputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     KmsKeyId: "STRING_VALUE",
+ *   },
+ *   DataAccessRoleArn: "STRING_VALUE", // required
+ *   JobName: "STRING_VALUE",
+ *   LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ *   VolumeKmsKeyId: "STRING_VALUE",
+ *   VpcConfig: {
+ *     SecurityGroupIds: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *     Subnets: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   Tags: [
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new StartSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StartTargetedSentimentDetectionJobCommand.d.ts

@@ -28,6 +28,42 @@ export interface StartTargetedSentimentDetectionJobCommandOutput extends StartTa
  * import { ComprehendClient, StartTargetedSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StartTargetedSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   InputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ *     DocumentReaderConfig: {
+ *       DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ *       DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ *       FeatureTypes: [
+ *         "TABLES" || "FORMS",
+ *       ],
+ *     },
+ *   },
+ *   OutputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     KmsKeyId: "STRING_VALUE",
+ *   },
+ *   DataAccessRoleArn: "STRING_VALUE", // required
+ *   JobName: "STRING_VALUE",
+ *   LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
+ *   ClientRequestToken: "STRING_VALUE",
+ *   VolumeKmsKeyId: "STRING_VALUE",
+ *   VpcConfig: {
+ *     SecurityGroupIds: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *     Subnets: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   Tags: [
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new StartTargetedSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StartTopicsDetectionJobCommand.d.ts

@@ -27,6 +27,42 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
  * import { ComprehendClient, StartTopicsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StartTopicsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   InputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ *     DocumentReaderConfig: {
+ *       DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ *       DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ *       FeatureTypes: [
+ *         "TABLES" || "FORMS",
+ *       ],
+ *     },
+ *   },
+ *   OutputDataConfig: {
+ *     S3Uri: "STRING_VALUE", // required
+ *     KmsKeyId: "STRING_VALUE",
+ *   },
+ *   DataAccessRoleArn: "STRING_VALUE", // required
+ *   JobName: "STRING_VALUE",
+ *   NumberOfTopics: Number("int"),
+ *   ClientRequestToken: "STRING_VALUE",
+ *   VolumeKmsKeyId: "STRING_VALUE",
+ *   VpcConfig: {
+ *     SecurityGroupIds: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *     Subnets: [ // required
+ *       "STRING_VALUE",
+ *     ],
+ *   },
+ *   Tags: [
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new StartTopicsDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopDominantLanguageDetectionJobCommand.d.ts

@@ -35,6 +35,9 @@ export interface StopDominantLanguageDetectionJobCommandOutput extends StopDomin
  * import { ComprehendClient, StopDominantLanguageDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopDominantLanguageDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopDominantLanguageDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopEntitiesDetectionJobCommand.d.ts

@@ -35,6 +35,9 @@ export interface StopEntitiesDetectionJobCommandOutput extends StopEntitiesDetec
  * import { ComprehendClient, StopEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopEventsDetectionJobCommand.d.ts

@@ -26,6 +26,9 @@ export interface StopEventsDetectionJobCommandOutput extends StopEventsDetection
  * import { ComprehendClient, StopEventsDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopEventsDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopEventsDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopKeyPhrasesDetectionJobCommand.d.ts

@@ -35,6 +35,9 @@ export interface StopKeyPhrasesDetectionJobCommandOutput extends StopKeyPhrasesD
  * import { ComprehendClient, StopKeyPhrasesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopKeyPhrasesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopKeyPhrasesDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopPiiEntitiesDetectionJobCommand.d.ts

@@ -26,6 +26,9 @@ export interface StopPiiEntitiesDetectionJobCommandOutput extends StopPiiEntitie
  * import { ComprehendClient, StopPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopPiiEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopPiiEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopSentimentDetectionJobCommand.d.ts

@@ -35,6 +35,9 @@ export interface StopSentimentDetectionJobCommandOutput extends StopSentimentDet
  * import { ComprehendClient, StopSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopTargetedSentimentDetectionJobCommand.d.ts

@@ -35,6 +35,9 @@ export interface StopTargetedSentimentDetectionJobCommandOutput extends StopTarg
  * import { ComprehendClient, StopTargetedSentimentDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopTargetedSentimentDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   JobId: "STRING_VALUE", // required
+ * };
  * const command = new StopTargetedSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopTrainingDocumentClassifierCommand.d.ts

@@ -31,6 +31,9 @@ export interface StopTrainingDocumentClassifierCommandOutput extends StopTrainin
  * import { ComprehendClient, StopTrainingDocumentClassifierCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopTrainingDocumentClassifierCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   DocumentClassifierArn: "STRING_VALUE", // required
+ * };
  * const command = new StopTrainingDocumentClassifierCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/StopTrainingEntityRecognizerCommand.d.ts

@@ -31,6 +31,9 @@ export interface StopTrainingEntityRecognizerCommandOutput extends StopTrainingE
  * import { ComprehendClient, StopTrainingEntityRecognizerCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, StopTrainingEntityRecognizerCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   EntityRecognizerArn: "STRING_VALUE", // required
+ * };
  * const command = new StopTrainingEntityRecognizerCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/TagResourceCommand.d.ts

@@ -29,6 +29,15 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * import { ComprehendClient, TagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, TagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   ResourceArn: "STRING_VALUE", // required
+ *   Tags: [ // required
+ *     {
+ *       Key: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
  * const command = new TagResourceCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * import { ComprehendClient, UntagResourceCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, UntagResourceCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   ResourceArn: "STRING_VALUE", // required
+ *   TagKeys: [ // required
+ *     "STRING_VALUE",
+ *   ],
+ * };
  * const command = new UntagResourceCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/UpdateEndpointCommand.d.ts

@@ -27,6 +27,13 @@ export interface UpdateEndpointCommandOutput extends UpdateEndpointResponse, __M
  * import { ComprehendClient, UpdateEndpointCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, UpdateEndpointCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   EndpointArn: "STRING_VALUE", // required
+ *   DesiredModelArn: "STRING_VALUE",
+ *   DesiredInferenceUnits: Number("int"),
+ *   DesiredDataAccessRoleArn: "STRING_VALUE",
+ *   FlywheelArn: "STRING_VALUE",
+ * };
  * const command = new UpdateEndpointCommand(input);
  * const response = await client.send(command);
  * ```

package/dist-types/commands/UpdateFlywheelCommand.d.ts

@@ -26,6 +26,23 @@ export interface UpdateFlywheelCommandOutput extends UpdateFlywheelResponse, __M
  * import { ComprehendClient, UpdateFlywheelCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
  * // const { ComprehendClient, UpdateFlywheelCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
  * const client = new ComprehendClient(config);
+ * const input = {
+ *   FlywheelArn: "STRING_VALUE", // required
+ *   ActiveModelArn: "STRING_VALUE",
+ *   DataAccessRoleArn: "STRING_VALUE",
+ *   DataSecurityConfig: {
+ *     ModelKmsKeyId: "STRING_VALUE",
+ *     VolumeKmsKeyId: "STRING_VALUE",
+ *     VpcConfig: {
+ *       SecurityGroupIds: [ // required
+ *         "STRING_VALUE",
+ *       ],
+ *       Subnets: [ // required
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ * };
  * const command = new UpdateFlywheelCommand(input);
  * const response = await client.send(command);
  * ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-comprehend",
   "description": "AWS SDK for JavaScript Comprehend Client for Node.js, Browser and React Native",
-  "version": "3.299.0",
+  "version": "3.300.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.299.0",
-    "@aws-sdk/config-resolver": "3.299.0",
-    "@aws-sdk/credential-provider-node": "3.299.0",
+    "@aws-sdk/client-sts": "3.300.0",
+    "@aws-sdk/config-resolver": "3.300.0",
+    "@aws-sdk/credential-provider-node": "3.300.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",
@@ -32,12 +32,12 @@
     "@aws-sdk/middleware-host-header": "3.296.0",
     "@aws-sdk/middleware-logger": "3.296.0",
     "@aws-sdk/middleware-recursion-detection": "3.296.0",
-    "@aws-sdk/middleware-retry": "3.296.0",
+    "@aws-sdk/middleware-retry": "3.300.0",
     "@aws-sdk/middleware-serde": "3.296.0",
     "@aws-sdk/middleware-signing": "3.299.0",
     "@aws-sdk/middleware-stack": "3.296.0",
     "@aws-sdk/middleware-user-agent": "3.299.0",
-    "@aws-sdk/node-config-provider": "3.296.0",
+    "@aws-sdk/node-config-provider": "3.300.0",
     "@aws-sdk/node-http-handler": "3.296.0",
     "@aws-sdk/protocol-http": "3.296.0",
     "@aws-sdk/smithy-client": "3.296.0",
@@ -47,11 +47,11 @@
     "@aws-sdk/util-body-length-browser": "3.295.0",
     "@aws-sdk/util-body-length-node": "3.295.0",
     "@aws-sdk/util-defaults-mode-browser": "3.296.0",
-    "@aws-sdk/util-defaults-mode-node": "3.299.0",
+    "@aws-sdk/util-defaults-mode-node": "3.300.0",
     "@aws-sdk/util-endpoints": "3.296.0",
     "@aws-sdk/util-retry": "3.296.0",
     "@aws-sdk/util-user-agent-browser": "3.299.0",
-    "@aws-sdk/util-user-agent-node": "3.299.0",
+    "@aws-sdk/util-user-agent-node": "3.300.0",
     "@aws-sdk/util-utf8": "3.295.0",
     "tslib": "^2.5.0",
     "uuid": "^8.3.2"