@aws-sdk/client-comprehend 3.321.1 → 3.326.0

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

@@ -38,6 +38,47 @@ export interface ListSentimentDetectionJobsCommandOutput extends ListSentimentDe
  * };
  * const command = new ListSentimentDetectionJobsCommand(input);
  * const response = await client.send(command);
+ * // { // ListSentimentDetectionJobsResponse
+ * //   SentimentDetectionJobPropertiesList: [ // SentimentDetectionJobPropertiesList
+ * //     { // SentimentDetectionJobProperties
+ * //       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",
+ * //         ],
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListSentimentDetectionJobsCommandInput - {@link ListSentimentDetectionJobsCommandInput}
@@ -59,6 +100,8 @@ export interface ListSentimentDetectionJobsCommandOutput extends ListSentimentDe
  * @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 ListSentimentDetectionJobsCommand extends $Command<ListSentimentDetectionJobsCommandInput, ListSentimentDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -31,6 +31,16 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * };
  * const command = new ListTagsForResourceCommand(input);
  * const response = await client.send(command);
+ * // { // ListTagsForResourceResponse
+ * //   ResourceArn: "STRING_VALUE",
+ * //   Tags: [ // TagList
+ * //     { // Tag
+ * //       Key: "STRING_VALUE", // required
+ * //       Value: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -48,6 +58,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
  * @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 ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -38,6 +38,47 @@ export interface ListTargetedSentimentDetectionJobsCommandOutput extends ListTar
  * };
  * const command = new ListTargetedSentimentDetectionJobsCommand(input);
  * const response = await client.send(command);
+ * // { // ListTargetedSentimentDetectionJobsResponse
+ * //   TargetedSentimentDetectionJobPropertiesList: [ // TargetedSentimentDetectionJobPropertiesList
+ * //     { // TargetedSentimentDetectionJobProperties
+ * //       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",
+ * //         ],
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListTargetedSentimentDetectionJobsCommandInput - {@link ListTargetedSentimentDetectionJobsCommandInput}
@@ -59,6 +100,8 @@ export interface ListTargetedSentimentDetectionJobsCommandOutput extends ListTar
  * @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 ListTargetedSentimentDetectionJobsCommand extends $Command<ListTargetedSentimentDetectionJobsCommandInput, ListTargetedSentimentDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -38,6 +38,47 @@ export interface ListTopicsDetectionJobsCommandOutput extends ListTopicsDetectio
  * };
  * const command = new ListTopicsDetectionJobsCommand(input);
  * const response = await client.send(command);
+ * // { // ListTopicsDetectionJobsResponse
+ * //   TopicsDetectionJobPropertiesList: [ // TopicsDetectionJobPropertiesList
+ * //     { // TopicsDetectionJobProperties
+ * //       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",
+ * //       },
+ * //       NumberOfTopics: Number("int"),
+ * //       DataAccessRoleArn: "STRING_VALUE",
+ * //       VolumeKmsKeyId: "STRING_VALUE",
+ * //       VpcConfig: { // VpcConfig
+ * //         SecurityGroupIds: [ // SecurityGroupIds // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //         Subnets: [ // Subnets // required
+ * //           "STRING_VALUE",
+ * //         ],
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param ListTopicsDetectionJobsCommandInput - {@link ListTopicsDetectionJobsCommandInput}
@@ -59,6 +100,8 @@ export interface ListTopicsDetectionJobsCommandOutput extends ListTopicsDetectio
  * @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 ListTopicsDetectionJobsCommand extends $Command<ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -35,6 +35,10 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
  * };
  * const command = new PutResourcePolicyCommand(input);
  * const response = await client.send(command);
+ * // { // PutResourcePolicyResponse
+ * //   PolicyRevisionId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param PutResourcePolicyCommandInput - {@link PutResourcePolicyCommandInput}
@@ -52,6 +56,8 @@ export interface PutResourcePolicyCommandOutput extends PutResourcePolicyRespons
  * @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 PutResourcePolicyCommand extends $Command<PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -67,6 +67,13 @@ export interface StartDocumentClassificationJobCommandOutput extends StartDocume
  * };
  * const command = new StartDocumentClassificationJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartDocumentClassificationJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //   DocumentClassifierArn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param StartDocumentClassificationJobCommandInput - {@link StartDocumentClassificationJobCommandInput}
@@ -104,6 +111,8 @@ export interface StartDocumentClassificationJobCommandOutput extends StartDocume
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartDocumentClassificationJobCommand extends $Command<StartDocumentClassificationJobCommandInput, StartDocumentClassificationJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -65,6 +65,12 @@ export interface StartDominantLanguageDetectionJobCommandOutput extends StartDom
  * };
  * const command = new StartDominantLanguageDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartDominantLanguageDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartDominantLanguageDetectionJobCommandInput - {@link StartDominantLanguageDetectionJobCommandInput}
@@ -95,6 +101,8 @@ export interface StartDominantLanguageDetectionJobCommandOutput extends StartDom
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartDominantLanguageDetectionJobCommand extends $Command<StartDominantLanguageDetectionJobCommandInput, StartDominantLanguageDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -70,6 +70,13 @@ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDet
  * };
  * const command = new StartEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartEntitiesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * //   EntityRecognizerArn: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param StartEntitiesDetectionJobCommandInput - {@link StartEntitiesDetectionJobCommandInput}
@@ -107,6 +114,8 @@ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDet
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartEntitiesDetectionJobCommand extends $Command<StartEntitiesDetectionJobCommandInput, StartEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -58,6 +58,12 @@ export interface StartEventsDetectionJobCommandOutput extends StartEventsDetecti
  * };
  * const command = new StartEventsDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartEventsDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartEventsDetectionJobCommandInput - {@link StartEventsDetectionJobCommandInput}
@@ -88,6 +94,8 @@ export interface StartEventsDetectionJobCommandOutput extends StartEventsDetecti
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartEventsDetectionJobCommand extends $Command<StartEventsDetectionJobCommandInput, StartEventsDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -34,6 +34,11 @@ export interface StartFlywheelIterationCommandOutput extends StartFlywheelIterat
  * };
  * const command = new StartFlywheelIterationCommand(input);
  * const response = await client.send(command);
+ * // { // StartFlywheelIterationResponse
+ * //   FlywheelArn: "STRING_VALUE",
+ * //   FlywheelIterationId: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param StartFlywheelIterationCommandInput - {@link StartFlywheelIterationCommandInput}
@@ -58,6 +63,8 @@ export interface StartFlywheelIterationCommandOutput extends StartFlywheelIterat
  * @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 StartFlywheelIterationCommand extends $Command<StartFlywheelIterationCommandInput, StartFlywheelIterationCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -66,6 +66,12 @@ export interface StartKeyPhrasesDetectionJobCommandOutput extends StartKeyPhrase
  * };
  * const command = new StartKeyPhrasesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartKeyPhrasesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartKeyPhrasesDetectionJobCommandInput - {@link StartKeyPhrasesDetectionJobCommandInput}
@@ -96,6 +102,8 @@ export interface StartKeyPhrasesDetectionJobCommandOutput extends StartKeyPhrase
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartKeyPhrasesDetectionJobCommand extends $Command<StartKeyPhrasesDetectionJobCommandInput, StartKeyPhrasesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -63,6 +63,12 @@ export interface StartPiiEntitiesDetectionJobCommandOutput extends StartPiiEntit
  * };
  * const command = new StartPiiEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartPiiEntitiesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartPiiEntitiesDetectionJobCommandInput - {@link StartPiiEntitiesDetectionJobCommandInput}
@@ -93,6 +99,8 @@ export interface StartPiiEntitiesDetectionJobCommandOutput extends StartPiiEntit
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartPiiEntitiesDetectionJobCommand extends $Command<StartPiiEntitiesDetectionJobCommandInput, StartPiiEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -66,6 +66,12 @@ export interface StartSentimentDetectionJobCommandOutput extends StartSentimentD
  * };
  * const command = new StartSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartSentimentDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartSentimentDetectionJobCommandInput - {@link StartSentimentDetectionJobCommandInput}
@@ -96,6 +102,8 @@ export interface StartSentimentDetectionJobCommandOutput extends StartSentimentD
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartSentimentDetectionJobCommand extends $Command<StartSentimentDetectionJobCommandInput, StartSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -66,6 +66,12 @@ export interface StartTargetedSentimentDetectionJobCommandOutput extends StartTa
  * };
  * const command = new StartTargetedSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartTargetedSentimentDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartTargetedSentimentDetectionJobCommandInput - {@link StartTargetedSentimentDetectionJobCommandInput}
@@ -96,6 +102,8 @@ export interface StartTargetedSentimentDetectionJobCommandOutput extends StartTa
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartTargetedSentimentDetectionJobCommand extends $Command<StartTargetedSentimentDetectionJobCommandInput, StartTargetedSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -65,6 +65,12 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
  * };
  * const command = new StartTopicsDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StartTopicsDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobArn: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StartTopicsDetectionJobCommandInput - {@link StartTopicsDetectionJobCommandInput}
@@ -95,6 +101,8 @@ export interface StartTopicsDetectionJobCommandOutput extends StartTopicsDetecti
  *       resource). The maximum number of tags includes both existing tags and those included in your
  *       current request. </p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StartTopicsDetectionJobCommand extends $Command<StartTopicsDetectionJobCommandInput, StartTopicsDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface StopDominantLanguageDetectionJobCommandOutput extends StopDomin
  * };
  * const command = new StopDominantLanguageDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopDominantLanguageDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopDominantLanguageDetectionJobCommandInput - {@link StopDominantLanguageDetectionJobCommandInput}
@@ -57,6 +62,8 @@ export interface StopDominantLanguageDetectionJobCommandOutput extends StopDomin
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopDominantLanguageDetectionJobCommand extends $Command<StopDominantLanguageDetectionJobCommandInput, StopDominantLanguageDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface StopEntitiesDetectionJobCommandOutput extends StopEntitiesDetec
  * };
  * const command = new StopEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopEntitiesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopEntitiesDetectionJobCommandInput - {@link StopEntitiesDetectionJobCommandInput}
@@ -57,6 +62,8 @@ export interface StopEntitiesDetectionJobCommandOutput extends StopEntitiesDetec
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopEntitiesDetectionJobCommand extends $Command<StopEntitiesDetectionJobCommandInput, StopEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -31,6 +31,11 @@ export interface StopEventsDetectionJobCommandOutput extends StopEventsDetection
  * };
  * const command = new StopEventsDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopEventsDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopEventsDetectionJobCommandInput - {@link StopEventsDetectionJobCommandInput}
@@ -48,6 +53,8 @@ export interface StopEventsDetectionJobCommandOutput extends StopEventsDetection
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopEventsDetectionJobCommand extends $Command<StopEventsDetectionJobCommandInput, StopEventsDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface StopKeyPhrasesDetectionJobCommandOutput extends StopKeyPhrasesD
  * };
  * const command = new StopKeyPhrasesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopKeyPhrasesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopKeyPhrasesDetectionJobCommandInput - {@link StopKeyPhrasesDetectionJobCommandInput}
@@ -57,6 +62,8 @@ export interface StopKeyPhrasesDetectionJobCommandOutput extends StopKeyPhrasesD
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopKeyPhrasesDetectionJobCommand extends $Command<StopKeyPhrasesDetectionJobCommandInput, StopKeyPhrasesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -31,6 +31,11 @@ export interface StopPiiEntitiesDetectionJobCommandOutput extends StopPiiEntitie
  * };
  * const command = new StopPiiEntitiesDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopPiiEntitiesDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopPiiEntitiesDetectionJobCommandInput - {@link StopPiiEntitiesDetectionJobCommandInput}
@@ -48,6 +53,8 @@ export interface StopPiiEntitiesDetectionJobCommandOutput extends StopPiiEntitie
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopPiiEntitiesDetectionJobCommand extends $Command<StopPiiEntitiesDetectionJobCommandInput, StopPiiEntitiesDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface StopSentimentDetectionJobCommandOutput extends StopSentimentDet
  * };
  * const command = new StopSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopSentimentDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopSentimentDetectionJobCommandInput - {@link StopSentimentDetectionJobCommandInput}
@@ -57,6 +62,8 @@ export interface StopSentimentDetectionJobCommandOutput extends StopSentimentDet
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopSentimentDetectionJobCommand extends $Command<StopSentimentDetectionJobCommandInput, StopSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -40,6 +40,11 @@ export interface StopTargetedSentimentDetectionJobCommandOutput extends StopTarg
  * };
  * const command = new StopTargetedSentimentDetectionJobCommand(input);
  * const response = await client.send(command);
+ * // { // StopTargetedSentimentDetectionJobResponse
+ * //   JobId: "STRING_VALUE",
+ * //   JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED",
+ * // };
+ *
  * ```
  *
  * @param StopTargetedSentimentDetectionJobCommandInput - {@link StopTargetedSentimentDetectionJobCommandInput}
@@ -57,6 +62,8 @@ export interface StopTargetedSentimentDetectionJobCommandOutput extends StopTarg
  * @throws {@link JobNotFoundException} (client fault)
  *  <p>The specified job was not found. Check the job ID and try again.</p>
  *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
  *
  */
 export declare class StopTargetedSentimentDetectionJobCommand extends $Command<StopTargetedSentimentDetectionJobCommandInput, StopTargetedSentimentDetectionJobCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -36,6 +36,8 @@ export interface StopTrainingDocumentClassifierCommandOutput extends StopTrainin
  * };
  * const command = new StopTrainingDocumentClassifierCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StopTrainingDocumentClassifierCommandInput - {@link StopTrainingDocumentClassifierCommandInput}
@@ -56,6 +58,8 @@ export interface StopTrainingDocumentClassifierCommandOutput extends StopTrainin
  * @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 StopTrainingDocumentClassifierCommand extends $Command<StopTrainingDocumentClassifierCommandInput, StopTrainingDocumentClassifierCommandOutput, ComprehendClientResolvedConfig> {

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

@@ -36,6 +36,8 @@ export interface StopTrainingEntityRecognizerCommandOutput extends StopTrainingE
  * };
  * const command = new StopTrainingEntityRecognizerCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param StopTrainingEntityRecognizerCommandInput - {@link StopTrainingEntityRecognizerCommandInput}
@@ -56,6 +58,8 @@ export interface StopTrainingEntityRecognizerCommandOutput extends StopTrainingE
  * @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 StopTrainingEntityRecognizerCommand extends $Command<StopTrainingEntityRecognizerCommandInput, StopTrainingEntityRecognizerCommandOutput, ComprehendClientResolvedConfig> {