@aws-sdk/client-comprehend 3.321.1 → 3.326.0

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

@@ -31,6 +31,84 @@ export interface DescribeDocumentClassifierCommandOutput extends DescribeDocumen
  * };
  * const command = new DescribeDocumentClassifierCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeDocumentClassifierResponse
+ * //   DocumentClassifierProperties: { // DocumentClassifierProperties
+ * //     DocumentClassifierArn: "STRING_VALUE",
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     TrainingStartTime: new Date("TIMESTAMP"),
+ * //     TrainingEndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // DocumentClassifierInputDataConfig
+ * //       DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
+ * //       S3Uri: "STRING_VALUE",
+ * //       TestS3Uri: "STRING_VALUE",
+ * //       LabelDelimiter: "STRING_VALUE",
+ * //       AugmentedManifests: [ // DocumentClassifierAugmentedManifestsList
+ * //         { // AugmentedManifestsListItem
+ * //           S3Uri: "STRING_VALUE", // required
+ * //           Split: "TRAIN" || "TEST",
+ * //           AttributeNames: [ // AttributeNamesList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           AnnotationDataS3Uri: "STRING_VALUE",
+ * //           SourceDocumentsS3Uri: "STRING_VALUE",
+ * //           DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
+ * //         },
+ * //       ],
+ * //       DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
+ * //       Documents: { // DocumentClassifierDocuments
+ * //         S3Uri: "STRING_VALUE", // required
+ * //         TestS3Uri: "STRING_VALUE",
+ * //       },
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // DocumentClassifierOutputDataConfig
+ * //       S3Uri: "STRING_VALUE",
+ * //       KmsKeyId: "STRING_VALUE",
+ * //       FlywheelStatsS3Prefix: "STRING_VALUE",
+ * //     },
+ * //     ClassifierMetadata: { // ClassifierMetadata
+ * //       NumberOfLabels: Number("int"),
+ * //       NumberOfTrainedDocuments: Number("int"),
+ * //       NumberOfTestDocuments: Number("int"),
+ * //       EvaluationMetrics: { // ClassifierEvaluationMetrics
+ * //         Accuracy: Number("double"),
+ * //         Precision: Number("double"),
+ * //         Recall: Number("double"),
+ * //         F1Score: Number("double"),
+ * //         MicroPrecision: Number("double"),
+ * //         MicroRecall: Number("double"),
+ * //         MicroF1Score: Number("double"),
+ * //         HammingLoss: Number("double"),
+ * //       },
+ * //     },
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     VolumeKmsKeyId: "STRING_VALUE",
+ * //     VpcConfig: { // VpcConfig
+ * //       SecurityGroupIds: [ // SecurityGroupIds // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Subnets: [ // Subnets // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     Mode: "MULTI_CLASS" || "MULTI_LABEL",
+ * //     ModelKmsKeyId: "STRING_VALUE",
+ * //     VersionName: "STRING_VALUE",
+ * //     SourceModelArn: "STRING_VALUE",
+ * //     FlywheelArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeDocumentClassifierCommandInput - {@link DescribeDocumentClassifierCommandInput}
@@ -51,6 +129,8 @@ export interface DescribeDocumentClassifierCommandOutput extends DescribeDocumen
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeDocumentClassifierCommand extends $Command<DescribeDocumentClassifierCommandInput, DescribeDocumentClassifierCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,43 @@ export interface DescribeDominantLanguageDetectionJobCommandOutput extends Descr
  * };
  * const command = new DescribeDominantLanguageDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeDominantLanguageDetectionJobResponse
+ * //   DominantLanguageDetectionJobProperties: { // DominantLanguageDetectionJobProperties
+ * //     JobId: "STRING_VALUE",
+ * //     JobArn: "STRING_VALUE",
+ * //     JobName: "STRING_VALUE",
+ * //     JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // InputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // OutputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     VolumeKmsKeyId: "STRING_VALUE",
+ * //     VpcConfig: { // VpcConfig
+ * //       SecurityGroupIds: [ // SecurityGroupIds // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Subnets: [ // Subnets // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeDominantLanguageDetectionJobCommandInput - {@link DescribeDominantLanguageDetectionJobCommandInput}
@@ -52,6 +89,8 @@ export interface DescribeDominantLanguageDetectionJobCommandOutput extends Descr
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeDominantLanguageDetectionJobCommand extends $Command<DescribeDominantLanguageDetectionJobCommandInput, DescribeDominantLanguageDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -33,6 +33,23 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
  * };
  * const command = new DescribeEndpointCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeEndpointResponse
+ * //   EndpointProperties: { // EndpointProperties
+ * //     EndpointArn: "STRING_VALUE",
+ * //     Status: "CREATING" || "DELETING" || "FAILED" || "IN_SERVICE" || "UPDATING",
+ * //     Message: "STRING_VALUE",
+ * //     ModelArn: "STRING_VALUE",
+ * //     DesiredModelArn: "STRING_VALUE",
+ * //     DesiredInferenceUnits: Number("int"),
+ * //     CurrentInferenceUnits: Number("int"),
+ * //     CreationTime: new Date("TIMESTAMP"),
+ * //     LastModifiedTime: new Date("TIMESTAMP"),
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     DesiredDataAccessRoleArn: "STRING_VALUE",
+ * //     FlywheelArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeEndpointCommandInput - {@link DescribeEndpointCommandInput}
@@ -53,6 +70,8 @@ export interface DescribeEndpointCommandOutput extends DescribeEndpointResponse,
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeEndpointCommand extends $Command<DescribeEndpointCommandInput, DescribeEndpointCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,46 @@ export interface DescribeEntitiesDetectionJobCommandOutput extends DescribeEntit
  * };
  * const command = new DescribeEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeEntitiesDetectionJobResponse
+ * //   EntitiesDetectionJobProperties: { // EntitiesDetectionJobProperties
+ * //     JobId: "STRING_VALUE",
+ * //     JobArn: "STRING_VALUE",
+ * //     JobName: "STRING_VALUE",
+ * //     JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     EntityRecognizerArn: "STRING_VALUE",
+ * //     InputDataConfig: { // InputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // OutputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     VolumeKmsKeyId: "STRING_VALUE",
+ * //     VpcConfig: { // VpcConfig
+ * //       SecurityGroupIds: [ // SecurityGroupIds // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Subnets: [ // Subnets // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     FlywheelArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeEntitiesDetectionJobCommandInput - {@link DescribeEntitiesDetectionJobCommandInput}
@@ -52,6 +92,8 @@ export interface DescribeEntitiesDetectionJobCommandOutput extends DescribeEntit
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeEntitiesDetectionJobCommand extends $Command<DescribeEntitiesDetectionJobCommandInput, DescribeEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,88 @@ export interface DescribeEntityRecognizerCommandOutput extends DescribeEntityRec
  * };
  * const command = new DescribeEntityRecognizerCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeEntityRecognizerResponse
+ * //   EntityRecognizerProperties: { // EntityRecognizerProperties
+ * //     EntityRecognizerArn: "STRING_VALUE",
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     Status: "SUBMITTED" || "TRAINING" || "DELETING" || "STOP_REQUESTED" || "STOPPED" || "IN_ERROR" || "TRAINED" || "TRAINED_WITH_WARNING",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     TrainingStartTime: new Date("TIMESTAMP"),
+ * //     TrainingEndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // EntityRecognizerInputDataConfig
+ * //       DataFormat: "COMPREHEND_CSV" || "AUGMENTED_MANIFEST",
+ * //       EntityTypes: [ // EntityTypesList // required
+ * //         { // EntityTypesListItem
+ * //           Type: "STRING_VALUE", // required
+ * //         },
+ * //       ],
+ * //       Documents: { // EntityRecognizerDocuments
+ * //         S3Uri: "STRING_VALUE", // required
+ * //         TestS3Uri: "STRING_VALUE",
+ * //         InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       },
+ * //       Annotations: { // EntityRecognizerAnnotations
+ * //         S3Uri: "STRING_VALUE", // required
+ * //         TestS3Uri: "STRING_VALUE",
+ * //       },
+ * //       EntityList: { // EntityRecognizerEntityList
+ * //         S3Uri: "STRING_VALUE", // required
+ * //       },
+ * //       AugmentedManifests: [ // EntityRecognizerAugmentedManifestsList
+ * //         { // AugmentedManifestsListItem
+ * //           S3Uri: "STRING_VALUE", // required
+ * //           Split: "TRAIN" || "TEST",
+ * //           AttributeNames: [ // AttributeNamesList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           AnnotationDataS3Uri: "STRING_VALUE",
+ * //           SourceDocumentsS3Uri: "STRING_VALUE",
+ * //           DocumentType: "PLAIN_TEXT_DOCUMENT" || "SEMI_STRUCTURED_DOCUMENT",
+ * //         },
+ * //       ],
+ * //     },
+ * //     RecognizerMetadata: { // EntityRecognizerMetadata
+ * //       NumberOfTrainedDocuments: Number("int"),
+ * //       NumberOfTestDocuments: Number("int"),
+ * //       EvaluationMetrics: { // EntityRecognizerEvaluationMetrics
+ * //         Precision: Number("double"),
+ * //         Recall: Number("double"),
+ * //         F1Score: Number("double"),
+ * //       },
+ * //       EntityTypes: [ // EntityRecognizerMetadataEntityTypesList
+ * //         { // EntityRecognizerMetadataEntityTypesListItem
+ * //           Type: "STRING_VALUE",
+ * //           EvaluationMetrics: { // EntityTypesEvaluationMetrics
+ * //             Precision: Number("double"),
+ * //             Recall: Number("double"),
+ * //             F1Score: Number("double"),
+ * //           },
+ * //           NumberOfTrainMentions: Number("int"),
+ * //         },
+ * //       ],
+ * //     },
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     VolumeKmsKeyId: "STRING_VALUE",
+ * //     VpcConfig: { // VpcConfig
+ * //       SecurityGroupIds: [ // SecurityGroupIds // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Subnets: [ // Subnets // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //     ModelKmsKeyId: "STRING_VALUE",
+ * //     VersionName: "STRING_VALUE",
+ * //     SourceModelArn: "STRING_VALUE",
+ * //     FlywheelArn: "STRING_VALUE",
+ * //     OutputDataConfig: { // EntityRecognizerOutputDataConfig
+ * //       FlywheelStatsS3Prefix: "STRING_VALUE",
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeEntityRecognizerCommandInput - {@link DescribeEntityRecognizerCommandInput}
@@ -52,6 +134,8 @@ export interface DescribeEntityRecognizerCommandOutput extends DescribeEntityRec
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeEntityRecognizerCommand extends $Command<DescribeEntityRecognizerCommandInput, DescribeEntityRecognizerCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -31,6 +31,38 @@ export interface DescribeEventsDetectionJobCommandOutput extends DescribeEventsD
  * };
  * const command = new DescribeEventsDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeEventsDetectionJobResponse
+ * //   EventsDetectionJobProperties: { // EventsDetectionJobProperties
+ * //     JobId: "STRING_VALUE",
+ * //     JobArn: "STRING_VALUE",
+ * //     JobName: "STRING_VALUE",
+ * //     JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // InputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // OutputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     TargetEventTypes: [ // TargetEventTypes
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeEventsDetectionJobCommandInput - {@link DescribeEventsDetectionJobCommandInput}
@@ -51,6 +83,8 @@ export interface DescribeEventsDetectionJobCommandOutput extends DescribeEventsD
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeEventsDetectionJobCommand extends $Command<DescribeEventsDetectionJobCommandInput, DescribeEventsDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,50 @@ export interface DescribeFlywheelCommandOutput extends DescribeFlywheelResponse,
  * };
  * const command = new DescribeFlywheelCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeFlywheelResponse
+ * //   FlywheelProperties: { // FlywheelProperties
+ * //     FlywheelArn: "STRING_VALUE",
+ * //     ActiveModelArn: "STRING_VALUE",
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     TaskConfig: { // TaskConfig
+ * //       LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
+ * //       DocumentClassificationConfig: { // DocumentClassificationConfig
+ * //         Mode: "MULTI_CLASS" || "MULTI_LABEL", // required
+ * //         Labels: [ // LabelsList
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //       EntityRecognitionConfig: { // EntityRecognitionConfig
+ * //         EntityTypes: [ // EntityTypesList // required
+ * //           { // EntityTypesListItem
+ * //             Type: "STRING_VALUE", // required
+ * //           },
+ * //         ],
+ * //       },
+ * //     },
+ * //     DataLakeS3Uri: "STRING_VALUE",
+ * //     DataSecurityConfig: { // DataSecurityConfig
+ * //       ModelKmsKeyId: "STRING_VALUE",
+ * //       VolumeKmsKeyId: "STRING_VALUE",
+ * //       DataLakeKmsKeyId: "STRING_VALUE",
+ * //       VpcConfig: { // VpcConfig
+ * //         SecurityGroupIds: [ // SecurityGroupIds // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Subnets: [ // Subnets // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     },
+ * //     Status: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
+ * //     ModelType: "DOCUMENT_CLASSIFIER" || "ENTITY_RECOGNIZER",
+ * //     Message: "STRING_VALUE",
+ * //     CreationTime: new Date("TIMESTAMP"),
+ * //     LastModifiedTime: new Date("TIMESTAMP"),
+ * //     LatestFlywheelIteration: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeFlywheelCommandInput - {@link DescribeFlywheelCommandInput}
@@ -52,6 +96,8 @@ export interface DescribeFlywheelCommandOutput extends DescribeFlywheelResponse,
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeFlywheelCommand extends $Command<DescribeFlywheelCommandInput, DescribeFlywheelCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -34,6 +34,32 @@ export interface DescribeFlywheelIterationCommandOutput extends DescribeFlywheel
  * };
  * const command = new DescribeFlywheelIterationCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeFlywheelIterationResponse
+ * //   FlywheelIterationProperties: { // FlywheelIterationProperties
+ * //     FlywheelArn: "STRING_VALUE",
+ * //     FlywheelIterationId: "STRING_VALUE",
+ * //     CreationTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     Status: "TRAINING" || "EVALUATING" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     EvaluatedModelArn: "STRING_VALUE",
+ * //     EvaluatedModelMetrics: { // FlywheelModelEvaluationMetrics
+ * //       AverageF1Score: Number("double"),
+ * //       AveragePrecision: Number("double"),
+ * //       AverageRecall: Number("double"),
+ * //       AverageAccuracy: Number("double"),
+ * //     },
+ * //     TrainedModelArn: "STRING_VALUE",
+ * //     TrainedModelMetrics: {
+ * //       AverageF1Score: Number("double"),
+ * //       AveragePrecision: Number("double"),
+ * //       AverageRecall: Number("double"),
+ * //       AverageAccuracy: Number("double"),
+ * //     },
+ * //     EvaluationManifestS3Prefix: "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeFlywheelIterationCommandInput - {@link DescribeFlywheelIterationCommandInput}
@@ -54,6 +80,8 @@ export interface DescribeFlywheelIterationCommandOutput extends DescribeFlywheel
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeFlywheelIterationCommand extends $Command<DescribeFlywheelIterationCommandInput, DescribeFlywheelIterationCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,44 @@ export interface DescribeKeyPhrasesDetectionJobCommandOutput extends DescribeKey
  * };
  * const command = new DescribeKeyPhrasesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeKeyPhrasesDetectionJobResponse
+ * //   KeyPhrasesDetectionJobProperties: { // KeyPhrasesDetectionJobProperties
+ * //     JobId: "STRING_VALUE",
+ * //     JobArn: "STRING_VALUE",
+ * //     JobName: "STRING_VALUE",
+ * //     JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // InputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // OutputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     VolumeKmsKeyId: "STRING_VALUE",
+ * //     VpcConfig: { // VpcConfig
+ * //       SecurityGroupIds: [ // SecurityGroupIds // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       Subnets: [ // Subnets // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribeKeyPhrasesDetectionJobCommandInput - {@link DescribeKeyPhrasesDetectionJobCommandInput}
@@ -52,6 +90,8 @@ export interface DescribeKeyPhrasesDetectionJobCommandOutput extends DescribeKey
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeKeyPhrasesDetectionJobCommand extends $Command<DescribeKeyPhrasesDetectionJobCommandInput, DescribeKeyPhrasesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,43 @@ export interface DescribePiiEntitiesDetectionJobCommandOutput extends DescribePi
  * };
  * const command = new DescribePiiEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // DescribePiiEntitiesDetectionJobResponse
+ * //   PiiEntitiesDetectionJobProperties: { // PiiEntitiesDetectionJobProperties
+ * //     JobId: "STRING_VALUE",
+ * //     JobArn: "STRING_VALUE",
+ * //     JobName: "STRING_VALUE",
+ * //     JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //     Message: "STRING_VALUE",
+ * //     SubmitTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"),
+ * //     InputDataConfig: { // InputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE",
+ * //       DocumentReaderConfig: { // DocumentReaderConfig
+ * //         DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required
+ * //         DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION",
+ * //         FeatureTypes: [ // ListOfDocumentReadFeatureTypes
+ * //           "TABLES" || "FORMS",
+ * //         ],
+ * //       },
+ * //     },
+ * //     OutputDataConfig: { // PiiOutputDataConfig
+ * //       S3Uri: "STRING_VALUE", // required
+ * //       KmsKeyId: "STRING_VALUE",
+ * //     },
+ * //     RedactionConfig: { // RedactionConfig
+ * //       PiiEntityTypes: [ // ListOfPiiEntityTypes
+ * //         "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",
+ * //     },
+ * //     LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW",
+ * //     DataAccessRoleArn: "STRING_VALUE",
+ * //     Mode: "ONLY_REDACTION" || "ONLY_OFFSETS",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param DescribePiiEntitiesDetectionJobCommandInput - {@link DescribePiiEntitiesDetectionJobCommandInput}
@@ -52,6 +89,8 @@ export interface DescribePiiEntitiesDetectionJobCommandOutput extends DescribePi
  * @throws {@link TooManyRequestsException} (client fault)
  *  <p>The number of requests exceeds the limit. Resubmit your request later.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribePiiEntitiesDetectionJobCommand extends $Command<DescribePiiEntitiesDetectionJobCommandInput, DescribePiiEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -32,6 +32,13 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
  * };
  * const command = new DescribeResourcePolicyCommand(input);
  * const response = await client.send(command);
+ * // { // DescribeResourcePolicyResponse
+ * //   ResourcePolicy: "STRING_VALUE",
+ * //   CreationTime: new Date("TIMESTAMP"),
+ * //   LastModifiedTime: new Date("TIMESTAMP"),
+ * //   PolicyRevisionId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param DescribeResourcePolicyCommandInput - {@link DescribeResourcePolicyCommandInput}
@@ -49,6 +56,8 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The specified resource ARN was not found. Check the ARN and try your request again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class DescribeResourcePolicyCommand extends $Command<DescribeResourcePolicyCommandInput, DescribeResourcePolicyCommandOutput, ComprehendClientResolvedConfig> {