@aws-sdk/client-comprehend 3.445.0 → 3.448.0

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

@@ -24,7 +24,7 @@ export interface DetectTargetedSentimentCommandOutput extends DetectTargetedSent
 /**
  * @public
  * <p>Inspects the input text and returns a sentiment analysis for each entity identified in the text.</p>
- *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
+ *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -0,0 +1,108 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
+import { DetectToxicContentRequest, DetectToxicContentResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link DetectToxicContentCommand}.
+ */
+export interface DetectToxicContentCommandInput extends DetectToxicContentRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link DetectToxicContentCommand}.
+ */
+export interface DetectToxicContentCommandOutput extends DetectToxicContentResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Performs toxicity analysis on the list of text strings that you provide as input.
+ *       The analysis uses the order of strings in the list to determine context when predicting toxicity.
+ *       The API response contains a results list that matches the size of the input list.
+ *       For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>
+ *          </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ComprehendClient, DetectToxicContentCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
+ * // const { ComprehendClient, DetectToxicContentCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
+ * const client = new ComprehendClient(config);
+ * const input = { // DetectToxicContentRequest
+ *   TextSegments: [ // ListOfTextSegments // required
+ *     { // TextSegment
+ *       Text: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required
+ * };
+ * const command = new DetectToxicContentCommand(input);
+ * const response = await client.send(command);
+ * // { // DetectToxicContentResponse
+ * //   ResultList: [ // ListOfToxicLabels
+ * //     { // ToxicLabels
+ * //       Labels: [ // ListOfToxicContent
+ * //         { // ToxicContent
+ * //           Name: "GRAPHIC" || "HARASSMENT_OR_ABUSE" || "HATE_SPEECH" || "INSULT" || "PROFANITY" || "SEXUAL" || "VIOLENCE_OR_THREAT",
+ * //           Score: Number("float"),
+ * //         },
+ * //       ],
+ * //       Toxicity: Number("float"),
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param DetectToxicContentCommandInput - {@link DetectToxicContentCommandInput}
+ * @returns {@link DetectToxicContentCommandOutput}
+ * @see {@link DetectToxicContentCommandInput} for command's `input` shape.
+ * @see {@link DetectToxicContentCommandOutput} for command's `response` shape.
+ * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal server error occurred. Retry your request.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>The request is invalid.</p>
+ *
+ * @throws {@link TextSizeLimitExceededException} (client fault)
+ *  <p>The size of the input text exceeds the limit. Use a smaller document.</p>
+ *
+ * @throws {@link UnsupportedLanguageException} (client fault)
+ *  <p>Amazon Comprehend can't process the language of the input text. For custom entity
+ *       recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted.
+ *       For a list of supported languages,
+ *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/supported-languages.html">Supported languages</a> in the Comprehend Developer Guide.
+ *     </p>
+ *
+ * @throws {@link ComprehendServiceException}
+ * <p>Base exception class for all service exceptions from Comprehend service.</p>
+ *
+ */
+export declare class DetectToxicContentCommand extends $Command<DetectToxicContentCommandInput, DetectToxicContentCommandOutput, ComprehendClientResolvedConfig> {
+    readonly input: DetectToxicContentCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: DetectToxicContentCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DetectToxicContentCommandInput, DetectToxicContentCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
-import { StopEntitiesDetectionJobRequest, StopEntitiesDetectionJobResponse } from "../models/models_0";
+import { StopEntitiesDetectionJobRequest, StopEntitiesDetectionJobResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
-import { StopEventsDetectionJobRequest, StopEventsDetectionJobResponse } from "../models/models_0";
+import { StopEventsDetectionJobRequest, StopEventsDetectionJobResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
 import { Command as $Command } from "@smithy/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
-import { StopKeyPhrasesDetectionJobRequest, StopKeyPhrasesDetectionJobResponse } from "../models/models_0";
+import { StopKeyPhrasesDetectionJobRequest, StopKeyPhrasesDetectionJobResponse } from "../models/models_1";
 /**
  * @public
  */

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

@@ -39,6 +39,7 @@ export * from "./DetectPiiEntitiesCommand";
 export * from "./DetectSentimentCommand";
 export * from "./DetectSyntaxCommand";
 export * from "./DetectTargetedSentimentCommand";
+export * from "./DetectToxicContentCommand";
 export * from "./ImportModelCommand";
 export * from "./ListDatasetsCommand";
 export * from "./ListDocumentClassificationJobsCommand";

package/dist-types/models/models_0.d.ts

@@ -883,7 +883,7 @@ export interface BatchDetectTargetedSentimentRequest {
 /**
  * @public
  * <p>Contains the sentiment and sentiment score for one mention of an entity.</p>
- *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
+ *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  */
 export interface MentionSentiment {
     /**
@@ -929,7 +929,7 @@ export type TargetedSentimentEntityType = (typeof TargetedSentimentEntityType)[k
  * @public
  * <p>Information about one mention of an entity. The mention information includes the location of the mention
  *       in the text and the sentiment of the mention.</p>
- *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
+ *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  */
 export interface TargetedSentimentMention {
     /**
@@ -971,7 +971,7 @@ export interface TargetedSentimentMention {
 /**
  * @public
  * <p>Information about one of the entities found by targeted sentiment analysis.</p>
- *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a>.</p>
+ *          <p>For more information about targeted sentiment, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html">Targeted sentiment</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
  */
 export interface TargetedSentimentEntity {
     /**
@@ -1396,14 +1396,18 @@ export interface ClassifyDocumentRequest {
     Text?: string;
     /**
      * @public
-     * <p>The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
+     * <p>The Amazon Resource Number (ARN) of the endpoint. </p>
+     *          <p>For prompt classification, Amazon Comprehend provides the endpoint ARN: <code>zzz</code>.</p>
+     *          <p>For custom classification, you create an endpoint for your custom model. For more information,
+     *       see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/using-endpoints.html">Using Amazon Comprehend endpoints</a>.</p>
      */
     EndpointArn: string | undefined;
     /**
      * @public
-     * <p>Use the <code>Bytes</code> parameter to input a text, PDF, Word or image file.
-     *       You can also use the <code>Bytes</code> parameter to input an Amazon Textract <code>DetectDocumentText</code>
-     *       or <code>AnalyzeDocument</code> output file.</p>
+     * <p>Use the <code>Bytes</code> parameter to input a text, PDF, Word or image file.</p>
+     *          <p>When you classify a document using a custom model, you can also use the <code>Bytes</code> parameter to input an Amazon Textract <code>DetectDocumentText</code>
+     *         or <code>AnalyzeDocument</code> output file.</p>
+     *          <p>To classify a document using the prompt classifier, use the <code>Text</code> parameter for input.</p>
      *          <p>Provide the input document as a sequence of base64-encoded bytes.
      *       If your code uses an Amazon Web Services SDK to classify documents, the SDK may encode
      *       the document file bytes for you. </p>
@@ -1604,7 +1608,7 @@ export type PageBasedWarningCode = (typeof PageBasedWarningCode)[keyof typeof Pa
  * <p>The system identified one of the following warnings while processing the input document:</p>
  *          <ul>
  *             <li>
- *                <p>The document to classify is plain text, but the classifier is a native model.</p>
+ *                <p>The document to classify is plain text, but the classifier is a native document model.</p>
  *             </li>
  *             <li>
  *                <p>The document to classify is semi-structured, but the classifier is a plain-text model.</p>
@@ -1638,6 +1642,8 @@ export interface ClassifyDocumentResponse {
      *       models. Individual classes are mutually exclusive and each document is expected to have only a
      *       single class assigned to it. For example, an animal can be a dog or a cat, but not both at the
      *       same time. </p>
+     *          <p>For prompt classification, the response includes a single class (<code>UNDESIRED_PROMPT</code>), along with a confidence score.
+     *       A higher confidence score indicates that the input prompt is undesired in nature.</p>
      */
     Classes?: DocumentClass[];
     /**
@@ -2155,7 +2161,7 @@ export declare const DocumentClassifierDataFormat: {
 export type DocumentClassifierDataFormat = (typeof DocumentClassifierDataFormat)[keyof typeof DocumentClassifierDataFormat];
 /**
  * @public
- * <p>The location of the training documents. This parameter is required in a request to create a native classifier model.</p>
+ * <p>The location of the training documents. This parameter is required in a request to create a semi-structured document classification model.</p>
  */
 export interface DocumentClassifierDocuments {
     /**
@@ -2227,9 +2233,8 @@ export interface DocumentClassifierInputDataConfig {
     S3Uri?: string;
     /**
      * @public
-     * <p>This specifies the Amazon S3 location where the test annotations for an entity recognizer
-     *       are located. The URI must be in the same Amazon Web Services Region as the API endpoint that you are
-     *       calling. </p>
+     * <p>This specifies the Amazon S3 location that contains the test annotations for the document classifier.
+     *       The URI must be in the same Amazon Web Services Region as the API endpoint that you are calling. </p>
      */
     TestS3Uri?: string;
     /**
@@ -2254,13 +2259,13 @@ export interface DocumentClassifierInputDataConfig {
     /**
      * @public
      * <p>The type of input documents for training the model. Provide plain-text documents to create a plain-text model, and
-     *     provide semi-structured documents to create a native model.</p>
+     *     provide semi-structured documents to create a native document model.</p>
      */
     DocumentType?: DocumentClassifierDocumentTypeFormat;
     /**
      * @public
      * <p>The S3 location of the training documents.
-     *       This parameter is required in a request to create a native classifier model.</p>
+     *       This parameter is required in a request to create a native document model.</p>
      */
     Documents?: DocumentClassifierDocuments;
     /**
@@ -2307,7 +2312,7 @@ export type DocumentClassifierMode = (typeof DocumentClassifierMode)[keyof typeo
 /**
  * @public
  * <p>Provide the location for output data from a custom classifier job. This field is mandatory
- *     if you are training a native classifier model.</p>
+ *       if you are training a native document model.</p>
  */
 export interface DocumentClassifierOutputDataConfig {
     /**
@@ -2419,7 +2424,7 @@ export interface CreateDocumentClassifierRequest {
     /**
      * @public
      * <p>Specifies the location for the output files from a custom classifier job.
-     *     This parameter is required for a request that creates a native classifier model.</p>
+     *       This parameter is required for a request that creates a native document model.</p>
      */
     OutputDataConfig?: DocumentClassifierOutputDataConfig;
     /**
@@ -2933,7 +2938,7 @@ export declare const ModelType: {
 export type ModelType = (typeof ModelType)[keyof typeof ModelType];
 /**
  * @public
- * <p>Configuration required for a custom classification model.</p>
+ * <p>Configuration required for a document classification model.</p>
  */
 export interface DocumentClassificationConfig {
     /**
@@ -2960,7 +2965,7 @@ export interface EntityRecognitionConfig {
 }
 /**
  * @public
- * <p>Configuration about the custom classifier associated with the flywheel.</p>
+ * <p>Configuration about the model associated with a flywheel.</p>
  */
 export interface TaskConfig {
     /**
@@ -2970,7 +2975,7 @@ export interface TaskConfig {
     LanguageCode: LanguageCode | undefined;
     /**
      * @public
-     * <p>Configuration required for a classification model.</p>
+     * <p>Configuration required for a document classification model.</p>
      */
     DocumentClassificationConfig?: DocumentClassificationConfig;
     /**
@@ -2990,7 +2995,8 @@ export interface CreateFlywheelRequest {
     FlywheelName: string | undefined;
     /**
      * @public
-     * <p>To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.</p>
+     * <p>To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
+     *       Do not set <code>TaskConfig</code> or <code>ModelType</code> if you specify an <code>ActiveModelArn</code>.</p>
      */
     ActiveModelArn?: string;
     /**
@@ -3001,12 +3007,13 @@ export interface CreateFlywheelRequest {
     DataAccessRoleArn: string | undefined;
     /**
      * @public
-     * <p>Configuration about the custom classifier associated with the flywheel.</p>
+     * <p>Configuration about the model associated with the flywheel.
+     *       You need to set <code>TaskConfig</code> if you are creating a flywheel for a new model.</p>
      */
     TaskConfig?: TaskConfig;
     /**
      * @public
-     * <p>The model type.</p>
+     * <p>The model type. You need to set <code>ModelType</code> if you are creating a flywheel for a new model.</p>
      */
     ModelType?: ModelType;
     /**
@@ -3311,7 +3318,9 @@ export interface OutputDataConfig {
     /**
      * @public
      * <p>ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the
-     *       output results from an analysis job. The KmsKeyId can be one of the following formats:</p>
+     *       output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric
+     *        key for uploading data to S3.</p>
+     *          <p>The KmsKeyId can be one of the following formats:</p>
      *          <ul>
      *             <li>
      *                <p>KMS Key ID: <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code>
@@ -3429,7 +3438,7 @@ export interface DocumentClassificationJobProperties {
     /**
      * @public
      * <p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the
-     *       resources you are using for your document classification job. For more information, see <a href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
+     *       resources you are using for your document classification job. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
      *         VPC</a>. </p>
      */
     VpcConfig?: VpcConfig;
@@ -3591,7 +3600,7 @@ export interface DocumentClassifierProperties {
     /**
      * @public
      * <p> Configuration parameters for a private Virtual Private Cloud (VPC) containing the
-     *       resources you are using for your custom classifier. For more information, see <a href="https://docs.aws.amazon.com/vppc/latest/userguide/what-is-amazon-vpc.html">Amazon
+     *       resources you are using for your custom classifier. For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/what-is-amazon-vpc.html">Amazon
      *         VPC</a>. </p>
      */
     VpcConfig?: VpcConfig;
@@ -4415,7 +4424,7 @@ export interface FlywheelProperties {
     DataAccessRoleArn?: string;
     /**
      * @public
-     * <p>Configuration about the custom classifier associated with the flywheel.</p>
+     * <p>Configuration about the model associated with a flywheel.</p>
      */
     TaskConfig?: TaskConfig;
     /**
@@ -5594,6 +5603,98 @@ export interface DetectTargetedSentimentResponse {
      */
     Entities?: TargetedSentimentEntity[];
 }
+/**
+ * @public
+ * <p>One of the of text strings. Each string has a size limit of 1KB.</p>
+ */
+export interface TextSegment {
+    /**
+     * @public
+     * <p>The text content.</p>
+     */
+    Text: string | undefined;
+}
+/**
+ * @public
+ */
+export interface DetectToxicContentRequest {
+    /**
+     * @public
+     * <p>A list of up to 10 text strings. The maximum size for the list is 10 KB.</p>
+     */
+    TextSegments: TextSegment[] | undefined;
+    /**
+     * @public
+     * <p>The language of the input text. Currently, English is the only supported language.</p>
+     */
+    LanguageCode: LanguageCode | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const ToxicContentType: {
+    readonly GRAPHIC: "GRAPHIC";
+    readonly HARASSMENT_OR_ABUSE: "HARASSMENT_OR_ABUSE";
+    readonly HATE_SPEECH: "HATE_SPEECH";
+    readonly INSULT: "INSULT";
+    readonly PROFANITY: "PROFANITY";
+    readonly SEXUAL: "SEXUAL";
+    readonly VIOLENCE_OR_THREAT: "VIOLENCE_OR_THREAT";
+};
+/**
+ * @public
+ */
+export type ToxicContentType = (typeof ToxicContentType)[keyof typeof ToxicContentType];
+/**
+ * @public
+ * <p>Toxic content analysis result for one string. For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>
+ *          </p>
+ */
+export interface ToxicContent {
+    /**
+     * @public
+     * <p>The name of the toxic content type.</p>
+     */
+    Name?: ToxicContentType;
+    /**
+     * @public
+     * <p>
+     *       Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.</p>
+     */
+    Score?: number;
+}
+/**
+ * @public
+ * <p>Toxicity analysis result for one string. For more information about toxicity detection, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/toxicity-detection.html">Toxicity detection</a> in the <i>Amazon Comprehend Developer Guide</i>
+ *          </p>
+ */
+export interface ToxicLabels {
+    /**
+     * @public
+     * <p>Array of toxic content types identified in the string.</p>
+     */
+    Labels?: ToxicContent[];
+    /**
+     * @public
+     * <p>Overall toxicity score for the string.</p>
+     */
+    Toxicity?: number;
+}
+/**
+ * @public
+ */
+export interface DetectToxicContentResponse {
+    /**
+     * @public
+     * <p>Results of the content moderation analysis.
+     *       Each entry in the results list contains a list of toxic content types identified in
+     *       the text, along with a confidence score for each content type.
+     *       The results list also includes a toxicity score for each entry in the results list.
+     *     </p>
+     */
+    ResultList?: ToxicLabels[];
+}
 /**
  * @public
  */
@@ -7742,7 +7843,7 @@ export interface StartTargetedSentimentDetectionJobRequest {
     /**
      * @public
      * <p>The Amazon Resource Name (ARN) of the IAM role that
-     *       grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions">Role-based permissions</a>.</p>
+     *       grants Amazon Comprehend read access to your input data. For more information, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/security_iam_id-based-policy-examples.html#auth-role-permissions">Role-based permissions</a>.</p>
      */
     DataAccessRoleArn: string | undefined;
     /**
@@ -7983,85 +8084,6 @@ export interface StopDominantLanguageDetectionJobResponse {
      */
     JobStatus?: JobStatus;
 }
-/**
- * @public
- */
-export interface StopEntitiesDetectionJobRequest {
-    /**
-     * @public
-     * <p>The identifier of the entities detection job to stop.</p>
-     */
-    JobId: string | undefined;
-}
-/**
- * @public
- */
-export interface StopEntitiesDetectionJobResponse {
-    /**
-     * @public
-     * <p>The identifier of the entities detection job to stop.</p>
-     */
-    JobId?: string;
-    /**
-     * @public
-     * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
-     *         <code>STOPPED</code> if the job was previously stopped with the
-     *         <code>StopEntitiesDetectionJob</code> operation.</p>
-     */
-    JobStatus?: JobStatus;
-}
-/**
- * @public
- */
-export interface StopEventsDetectionJobRequest {
-    /**
-     * @public
-     * <p>The identifier of the events detection job to stop.</p>
-     */
-    JobId: string | undefined;
-}
-/**
- * @public
- */
-export interface StopEventsDetectionJobResponse {
-    /**
-     * @public
-     * <p>The identifier of the events detection job to stop.</p>
-     */
-    JobId?: string;
-    /**
-     * @public
-     * <p>The status of the events detection job.</p>
-     */
-    JobStatus?: JobStatus;
-}
-/**
- * @public
- */
-export interface StopKeyPhrasesDetectionJobRequest {
-    /**
-     * @public
-     * <p>The identifier of the key phrases detection job to stop.</p>
-     */
-    JobId: string | undefined;
-}
-/**
- * @public
- */
-export interface StopKeyPhrasesDetectionJobResponse {
-    /**
-     * @public
-     * <p>The identifier of the key phrases detection job to stop.</p>
-     */
-    JobId?: string;
-    /**
-     * @public
-     * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
-     *         <code>STOPPED</code> if the job was previously stopped with the
-     *         <code>StopKeyPhrasesDetectionJob</code> operation.</p>
-     */
-    JobStatus?: JobStatus;
-}
 /**
  * @internal
  */
@@ -8190,6 +8212,14 @@ export declare const DetectTargetedSentimentRequestFilterSensitiveLog: (obj: Det
  * @internal
  */
 export declare const DetectTargetedSentimentResponseFilterSensitiveLog: (obj: DetectTargetedSentimentResponse) => any;
+/**
+ * @internal
+ */
+export declare const TextSegmentFilterSensitiveLog: (obj: TextSegment) => any;
+/**
+ * @internal
+ */
+export declare const DetectToxicContentRequestFilterSensitiveLog: (obj: DetectToxicContentRequest) => any;
 /**
  * @internal
  */

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,85 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ComprehendServiceException as __BaseException } from "./ComprehendServiceException";
 import { FlywheelProperties, JobStatus, Tag, VpcConfig } from "./models_0";
+/**
+ * @public
+ */
+export interface StopEntitiesDetectionJobRequest {
+    /**
+     * @public
+     * <p>The identifier of the entities detection job to stop.</p>
+     */
+    JobId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StopEntitiesDetectionJobResponse {
+    /**
+     * @public
+     * <p>The identifier of the entities detection job to stop.</p>
+     */
+    JobId?: string;
+    /**
+     * @public
+     * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
+     *         <code>STOPPED</code> if the job was previously stopped with the
+     *         <code>StopEntitiesDetectionJob</code> operation.</p>
+     */
+    JobStatus?: JobStatus;
+}
+/**
+ * @public
+ */
+export interface StopEventsDetectionJobRequest {
+    /**
+     * @public
+     * <p>The identifier of the events detection job to stop.</p>
+     */
+    JobId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StopEventsDetectionJobResponse {
+    /**
+     * @public
+     * <p>The identifier of the events detection job to stop.</p>
+     */
+    JobId?: string;
+    /**
+     * @public
+     * <p>The status of the events detection job.</p>
+     */
+    JobStatus?: JobStatus;
+}
+/**
+ * @public
+ */
+export interface StopKeyPhrasesDetectionJobRequest {
+    /**
+     * @public
+     * <p>The identifier of the key phrases detection job to stop.</p>
+     */
+    JobId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface StopKeyPhrasesDetectionJobResponse {
+    /**
+     * @public
+     * <p>The identifier of the key phrases detection job to stop.</p>
+     */
+    JobId?: string;
+    /**
+     * @public
+     * <p>Either <code>STOP_REQUESTED</code> if the job is currently running, or
+     *         <code>STOPPED</code> if the job was previously stopped with the
+     *         <code>StopKeyPhrasesDetectionJob</code> operation.</p>
+     */
+    JobStatus?: JobStatus;
+}
 /**
  * @public
  */