@aws-sdk/client-comprehend 3.296.0 → 3.298.0

package/dist-types/ComprehendClient.d.ts

@@ -92,15 +92,24 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
 import { UpdateEndpointCommandInput, UpdateEndpointCommandOutput } from "./commands/UpdateEndpointCommand";
 import { UpdateFlywheelCommandInput, UpdateFlywheelCommandOutput } from "./commands/UpdateFlywheelCommand";
 import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
+/**
+ * @public
+ */
 export type ServiceInputTypes = BatchDetectDominantLanguageCommandInput | BatchDetectEntitiesCommandInput | BatchDetectKeyPhrasesCommandInput | BatchDetectSentimentCommandInput | BatchDetectSyntaxCommandInput | BatchDetectTargetedSentimentCommandInput | ClassifyDocumentCommandInput | ContainsPiiEntitiesCommandInput | CreateDatasetCommandInput | CreateDocumentClassifierCommandInput | CreateEndpointCommandInput | CreateEntityRecognizerCommandInput | CreateFlywheelCommandInput | DeleteDocumentClassifierCommandInput | DeleteEndpointCommandInput | DeleteEntityRecognizerCommandInput | DeleteFlywheelCommandInput | DeleteResourcePolicyCommandInput | DescribeDatasetCommandInput | DescribeDocumentClassificationJobCommandInput | DescribeDocumentClassifierCommandInput | DescribeDominantLanguageDetectionJobCommandInput | DescribeEndpointCommandInput | DescribeEntitiesDetectionJobCommandInput | DescribeEntityRecognizerCommandInput | DescribeEventsDetectionJobCommandInput | DescribeFlywheelCommandInput | DescribeFlywheelIterationCommandInput | DescribeKeyPhrasesDetectionJobCommandInput | DescribePiiEntitiesDetectionJobCommandInput | DescribeResourcePolicyCommandInput | DescribeSentimentDetectionJobCommandInput | DescribeTargetedSentimentDetectionJobCommandInput | DescribeTopicsDetectionJobCommandInput | DetectDominantLanguageCommandInput | DetectEntitiesCommandInput | DetectKeyPhrasesCommandInput | DetectPiiEntitiesCommandInput | DetectSentimentCommandInput | DetectSyntaxCommandInput | DetectTargetedSentimentCommandInput | ImportModelCommandInput | ListDatasetsCommandInput | ListDocumentClassificationJobsCommandInput | ListDocumentClassifierSummariesCommandInput | ListDocumentClassifiersCommandInput | ListDominantLanguageDetectionJobsCommandInput | ListEndpointsCommandInput | ListEntitiesDetectionJobsCommandInput | ListEntityRecognizerSummariesCommandInput | ListEntityRecognizersCommandInput | ListEventsDetectionJobsCommandInput | ListFlywheelIterationHistoryCommandInput | ListFlywheelsCommandInput | ListKeyPhrasesDetectionJobsCommandInput | ListPiiEntitiesDetectionJobsCommandInput | ListSentimentDetectionJobsCommandInput | ListTagsForResourceCommandInput | ListTargetedSentimentDetectionJobsCommandInput | ListTopicsDetectionJobsCommandInput | PutResourcePolicyCommandInput | StartDocumentClassificationJobCommandInput | StartDominantLanguageDetectionJobCommandInput | StartEntitiesDetectionJobCommandInput | StartEventsDetectionJobCommandInput | StartFlywheelIterationCommandInput | StartKeyPhrasesDetectionJobCommandInput | StartPiiEntitiesDetectionJobCommandInput | StartSentimentDetectionJobCommandInput | StartTargetedSentimentDetectionJobCommandInput | StartTopicsDetectionJobCommandInput | StopDominantLanguageDetectionJobCommandInput | StopEntitiesDetectionJobCommandInput | StopEventsDetectionJobCommandInput | StopKeyPhrasesDetectionJobCommandInput | StopPiiEntitiesDetectionJobCommandInput | StopSentimentDetectionJobCommandInput | StopTargetedSentimentDetectionJobCommandInput | StopTrainingDocumentClassifierCommandInput | StopTrainingEntityRecognizerCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateEndpointCommandInput | UpdateFlywheelCommandInput;
+/**
+ * @public
+ */
 export type ServiceOutputTypes = BatchDetectDominantLanguageCommandOutput | BatchDetectEntitiesCommandOutput | BatchDetectKeyPhrasesCommandOutput | BatchDetectSentimentCommandOutput | BatchDetectSyntaxCommandOutput | BatchDetectTargetedSentimentCommandOutput | ClassifyDocumentCommandOutput | ContainsPiiEntitiesCommandOutput | CreateDatasetCommandOutput | CreateDocumentClassifierCommandOutput | CreateEndpointCommandOutput | CreateEntityRecognizerCommandOutput | CreateFlywheelCommandOutput | DeleteDocumentClassifierCommandOutput | DeleteEndpointCommandOutput | DeleteEntityRecognizerCommandOutput | DeleteFlywheelCommandOutput | DeleteResourcePolicyCommandOutput | DescribeDatasetCommandOutput | DescribeDocumentClassificationJobCommandOutput | DescribeDocumentClassifierCommandOutput | DescribeDominantLanguageDetectionJobCommandOutput | DescribeEndpointCommandOutput | DescribeEntitiesDetectionJobCommandOutput | DescribeEntityRecognizerCommandOutput | DescribeEventsDetectionJobCommandOutput | DescribeFlywheelCommandOutput | DescribeFlywheelIterationCommandOutput | DescribeKeyPhrasesDetectionJobCommandOutput | DescribePiiEntitiesDetectionJobCommandOutput | DescribeResourcePolicyCommandOutput | DescribeSentimentDetectionJobCommandOutput | DescribeTargetedSentimentDetectionJobCommandOutput | DescribeTopicsDetectionJobCommandOutput | DetectDominantLanguageCommandOutput | DetectEntitiesCommandOutput | DetectKeyPhrasesCommandOutput | DetectPiiEntitiesCommandOutput | DetectSentimentCommandOutput | DetectSyntaxCommandOutput | DetectTargetedSentimentCommandOutput | ImportModelCommandOutput | ListDatasetsCommandOutput | ListDocumentClassificationJobsCommandOutput | ListDocumentClassifierSummariesCommandOutput | ListDocumentClassifiersCommandOutput | ListDominantLanguageDetectionJobsCommandOutput | ListEndpointsCommandOutput | ListEntitiesDetectionJobsCommandOutput | ListEntityRecognizerSummariesCommandOutput | ListEntityRecognizersCommandOutput | ListEventsDetectionJobsCommandOutput | ListFlywheelIterationHistoryCommandOutput | ListFlywheelsCommandOutput | ListKeyPhrasesDetectionJobsCommandOutput | ListPiiEntitiesDetectionJobsCommandOutput | ListSentimentDetectionJobsCommandOutput | ListTagsForResourceCommandOutput | ListTargetedSentimentDetectionJobsCommandOutput | ListTopicsDetectionJobsCommandOutput | PutResourcePolicyCommandOutput | StartDocumentClassificationJobCommandOutput | StartDominantLanguageDetectionJobCommandOutput | StartEntitiesDetectionJobCommandOutput | StartEventsDetectionJobCommandOutput | StartFlywheelIterationCommandOutput | StartKeyPhrasesDetectionJobCommandOutput | StartPiiEntitiesDetectionJobCommandOutput | StartSentimentDetectionJobCommandOutput | StartTargetedSentimentDetectionJobCommandOutput | StartTopicsDetectionJobCommandOutput | StopDominantLanguageDetectionJobCommandOutput | StopEntitiesDetectionJobCommandOutput | StopEventsDetectionJobCommandOutput | StopKeyPhrasesDetectionJobCommandOutput | StopPiiEntitiesDetectionJobCommandOutput | StopSentimentDetectionJobCommandOutput | StopTargetedSentimentDetectionJobCommandOutput | StopTrainingDocumentClassifierCommandOutput | StopTrainingEntityRecognizerCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateEndpointCommandOutput | UpdateFlywheelCommandOutput;
+/**
+ * @public
+ */
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
     /**
      * The HTTP handler to use. Fetch in browser and Https in Nodejs.
      */
     requestHandler?: __HttpHandler;
     /**
-     * A constructor for a class implementing the {@link __Checksum} interface
+     * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
      * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
      * @internal
      */
@@ -190,23 +199,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
      */
     logger?: __Logger;
     /**
-     * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
+     * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
      */
     defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
 }
+/**
+ * @public
+ */
 type ComprehendClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
 /**
- * The configuration interface of ComprehendClient class constructor that set the region, credentials and other options.
+ * @public
+ *
+ *  The configuration interface of ComprehendClient class constructor that set the region, credentials and other options.
  */
 export interface ComprehendClientConfig extends ComprehendClientConfigType {
 }
+/**
+ * @public
+ */
 type ComprehendClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
 /**
- * The resolved configuration interface of ComprehendClient class. This is resolved and normalized from the {@link ComprehendClientConfig | constructor configuration interface}.
+ * @public
+ *
+ *  The resolved configuration interface of ComprehendClient class. This is resolved and normalized from the {@link ComprehendClientConfig | constructor configuration interface}.
  */
 export interface ComprehendClientResolvedConfig extends ComprehendClientResolvedConfigType {
 }
 /**
+ * @public
  * <p>Amazon Comprehend is an AWS service for gaining insight into the content of documents.
  *       Use these actions to determine the topics contained in your documents, the topics they
  *       discuss, the predominant sentiment expressed in them, the predominant language used, and

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectDominantLanguageRequest, BatchDetectDominantLanguageResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectDominantLanguageCommand}.
  */
 export interface BatchDetectDominantLanguageCommandInput extends BatchDetectDominantLanguageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectDominantLanguageCommand}.
  */
 export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDominantLanguageResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Determines the dominant language of the input text for a batch of documents. For a list
  *       of languages that Amazon Comprehend can detect, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html">Amazon Comprehend Supported Languages</a>.
  *     </p>
@@ -27,6 +32,8 @@ export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDom
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectDominantLanguageCommandInput - {@link BatchDetectDominantLanguageCommandInput}
+ * @returns {@link BatchDetectDominantLanguageCommandOutput}
  * @see {@link BatchDetectDominantLanguageCommandInput} for command's `input` shape.
  * @see {@link BatchDetectDominantLanguageCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -49,11 +56,20 @@ export interface BatchDetectDominantLanguageCommandOutput extends BatchDetectDom
 export declare class BatchDetectDominantLanguageCommand extends $Command<BatchDetectDominantLanguageCommandInput, BatchDetectDominantLanguageCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectDominantLanguageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectDominantLanguageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectDominantLanguageCommandInput, BatchDetectDominantLanguageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectEntitiesRequest, BatchDetectEntitiesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectEntitiesCommand}.
  */
 export interface BatchDetectEntitiesCommandInput extends BatchDetectEntitiesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectEntitiesCommand}.
  */
 export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Inspects the text of a batch of documents for named entities and returns information
  *       about them. For more information about named entities, see
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html">Entities</a> in the Comprehend Developer Guide.
@@ -28,6 +33,8 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectEntitiesCommandInput - {@link BatchDetectEntitiesCommandInput}
+ * @returns {@link BatchDetectEntitiesCommandOutput}
  * @see {@link BatchDetectEntitiesCommandInput} for command's `input` shape.
  * @see {@link BatchDetectEntitiesCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -57,11 +64,20 @@ export interface BatchDetectEntitiesCommandOutput extends BatchDetectEntitiesRes
 export declare class BatchDetectEntitiesCommand extends $Command<BatchDetectEntitiesCommandInput, BatchDetectEntitiesCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectEntitiesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectEntitiesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectEntitiesCommandInput, BatchDetectEntitiesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectKeyPhrasesRequest, BatchDetectKeyPhrasesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectKeyPhrasesCommand}.
  */
 export interface BatchDetectKeyPhrasesCommandInput extends BatchDetectKeyPhrasesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectKeyPhrasesCommand}.
  */
 export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrasesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Detects the key noun phrases found in a batch of documents.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectKeyPhrasesCommandInput - {@link BatchDetectKeyPhrasesCommandInput}
+ * @returns {@link BatchDetectKeyPhrasesCommandOutput}
  * @see {@link BatchDetectKeyPhrasesCommandInput} for command's `input` shape.
  * @see {@link BatchDetectKeyPhrasesCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -54,11 +61,20 @@ export interface BatchDetectKeyPhrasesCommandOutput extends BatchDetectKeyPhrase
 export declare class BatchDetectKeyPhrasesCommand extends $Command<BatchDetectKeyPhrasesCommandInput, BatchDetectKeyPhrasesCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectKeyPhrasesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectKeyPhrasesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectKeyPhrasesCommandInput, BatchDetectKeyPhrasesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectSentimentRequest, BatchDetectSentimentResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectSentimentCommand}.
  */
 export interface BatchDetectSentimentCommandInput extends BatchDetectSentimentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectSentimentCommand}.
  */
 export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Inspects a batch of documents and returns an inference of the prevailing sentiment,
  *         <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>,
  *       in each one.</p>
@@ -27,6 +32,8 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectSentimentCommandInput - {@link BatchDetectSentimentCommandInput}
+ * @returns {@link BatchDetectSentimentCommandOutput}
  * @see {@link BatchDetectSentimentCommandInput} for command's `input` shape.
  * @see {@link BatchDetectSentimentCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -56,11 +63,20 @@ export interface BatchDetectSentimentCommandOutput extends BatchDetectSentimentR
 export declare class BatchDetectSentimentCommand extends $Command<BatchDetectSentimentCommandInput, BatchDetectSentimentCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectSentimentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectSentimentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectSentimentCommandInput, BatchDetectSentimentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectSyntaxRequest, BatchDetectSyntaxResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectSyntaxCommand}.
  */
 export interface BatchDetectSyntaxCommandInput extends BatchDetectSyntaxRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectSyntaxCommand}.
  */
 export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Inspects the text of a batch of documents for the syntax and part of speech of the words
  *       in the document and returns information about them. For more information, see
  *       <a href="https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html">Syntax</a> in the Comprehend Developer Guide.
@@ -28,6 +33,8 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectSyntaxCommandInput - {@link BatchDetectSyntaxCommandInput}
+ * @returns {@link BatchDetectSyntaxCommandOutput}
  * @see {@link BatchDetectSyntaxCommandInput} for command's `input` shape.
  * @see {@link BatchDetectSyntaxCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -57,11 +64,20 @@ export interface BatchDetectSyntaxCommandOutput extends BatchDetectSyntaxRespons
 export declare class BatchDetectSyntaxCommand extends $Command<BatchDetectSyntaxCommandInput, BatchDetectSyntaxCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectSyntaxCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectSyntaxCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectSyntaxCommandInput, BatchDetectSyntaxCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { BatchDetectTargetedSentimentRequest, BatchDetectTargetedSentimentResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link BatchDetectTargetedSentimentCommand}.
  */
 export interface BatchDetectTargetedSentimentCommandInput extends BatchDetectTargetedSentimentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link BatchDetectTargetedSentimentCommand}.
  */
 export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTargetedSentimentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Inspects a batch of documents and returns a sentiment analysis
  *       for each entity identified in the documents.</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>
@@ -27,6 +32,8 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
  * const response = await client.send(command);
  * ```
  *
+ * @param BatchDetectTargetedSentimentCommandInput - {@link BatchDetectTargetedSentimentCommandInput}
+ * @returns {@link BatchDetectTargetedSentimentCommandOutput}
  * @see {@link BatchDetectTargetedSentimentCommandInput} for command's `input` shape.
  * @see {@link BatchDetectTargetedSentimentCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -56,11 +63,20 @@ export interface BatchDetectTargetedSentimentCommandOutput extends BatchDetectTa
 export declare class BatchDetectTargetedSentimentCommand extends $Command<BatchDetectTargetedSentimentCommandInput, BatchDetectTargetedSentimentCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: BatchDetectTargetedSentimentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: BatchDetectTargetedSentimentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchDetectTargetedSentimentCommandInput, BatchDetectTargetedSentimentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { ClassifyDocumentRequest, ClassifyDocumentResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ClassifyDocumentCommand}.
  */
 export interface ClassifyDocumentCommandInput extends ClassifyDocumentRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ClassifyDocumentCommand}.
  */
 export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new document classification request to analyze a single document in real-time,
  *       using a previously created and trained custom model and an endpoint.</p>
  *          <p>You can input plain text or you can upload a single-page input document (text, PDF, Word, or image). </p>
@@ -35,6 +40,8 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
  * const response = await client.send(command);
  * ```
  *
+ * @param ClassifyDocumentCommandInput - {@link ClassifyDocumentCommandInput}
+ * @returns {@link ClassifyDocumentCommandOutput}
  * @see {@link ClassifyDocumentCommandInput} for command's `input` shape.
  * @see {@link ClassifyDocumentCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -57,11 +64,20 @@ export interface ClassifyDocumentCommandOutput extends ClassifyDocumentResponse,
 export declare class ClassifyDocumentCommand extends $Command<ClassifyDocumentCommandInput, ClassifyDocumentCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: ClassifyDocumentCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ClassifyDocumentCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ClassifyDocumentCommandInput, ClassifyDocumentCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { ContainsPiiEntitiesRequest, ContainsPiiEntitiesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ContainsPiiEntitiesCommand}.
  */
 export interface ContainsPiiEntitiesCommandInput extends ContainsPiiEntitiesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ContainsPiiEntitiesCommand}.
  */
 export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Analyzes input text for the presence of personally identifiable information (PII) and
  *       returns the labels of identified PII entity types such as name, address, bank account number,
  *       or phone number.</p>
@@ -27,6 +32,8 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
  * const response = await client.send(command);
  * ```
  *
+ * @param ContainsPiiEntitiesCommandInput - {@link ContainsPiiEntitiesCommandInput}
+ * @returns {@link ContainsPiiEntitiesCommandOutput}
  * @see {@link ContainsPiiEntitiesCommandInput} for command's `input` shape.
  * @see {@link ContainsPiiEntitiesCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -52,11 +59,20 @@ export interface ContainsPiiEntitiesCommandOutput extends ContainsPiiEntitiesRes
 export declare class ContainsPiiEntitiesCommand extends $Command<ContainsPiiEntitiesCommandInput, ContainsPiiEntitiesCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: ContainsPiiEntitiesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ContainsPiiEntitiesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ContainsPiiEntitiesCommandInput, ContainsPiiEntitiesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { CreateDatasetRequest, CreateDatasetResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDatasetCommand}.
  */
 export interface CreateDatasetCommandInput extends CreateDatasetRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDatasetCommand}.
  */
 export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a dataset to upload training or test data for a model associated with a flywheel.
  *       For more information about datasets, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html">
  *       Flywheel overview</a> in the <i>Amazon Comprehend Developer Guide</i>.</p>
@@ -27,6 +32,8 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDatasetCommandInput - {@link CreateDatasetCommandInput}
+ * @returns {@link CreateDatasetCommandOutput}
  * @see {@link CreateDatasetCommandInput} for command's `input` shape.
  * @see {@link CreateDatasetCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -61,11 +68,20 @@ export interface CreateDatasetCommandOutput extends CreateDatasetResponse, __Met
 export declare class CreateDatasetCommand extends $Command<CreateDatasetCommandInput, CreateDatasetCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: CreateDatasetCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDatasetCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDatasetCommandInput, CreateDatasetCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { CreateDocumentClassifierRequest, CreateDocumentClassifierResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateDocumentClassifierCommand}.
  */
 export interface CreateDocumentClassifierCommandInput extends CreateDocumentClassifierRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateDocumentClassifierCommand}.
  */
 export interface CreateDocumentClassifierCommandOutput extends CreateDocumentClassifierResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a new document classifier that you can use to categorize documents. To create a
  *       classifier, you provide a set of training documents that labeled with the categories that you
  *       want to use. After the classifier is trained you can use it to categorize a set of labeled
@@ -30,6 +35,8 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateDocumentClassifierCommandInput - {@link CreateDocumentClassifierCommandInput}
+ * @returns {@link CreateDocumentClassifierCommandOutput}
  * @see {@link CreateDocumentClassifierCommandInput} for command's `input` shape.
  * @see {@link CreateDocumentClassifierCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -72,11 +79,20 @@ export interface CreateDocumentClassifierCommandOutput extends CreateDocumentCla
 export declare class CreateDocumentClassifierCommand extends $Command<CreateDocumentClassifierCommandInput, CreateDocumentClassifierCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: CreateDocumentClassifierCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateDocumentClassifierCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateDocumentClassifierCommandInput, CreateDocumentClassifierCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ComprehendClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ComprehendClient";
 import { CreateEndpointRequest, CreateEndpointResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link CreateEndpointCommand}.
  */
 export interface CreateEndpointCommandInput extends CreateEndpointRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link CreateEndpointCommand}.
  */
 export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Creates a model-specific endpoint for synchronous inference for a previously trained
  *       custom model
  *       For information about endpoints, see <a href="https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html">Managing endpoints</a>.</p>
@@ -27,6 +32,8 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param CreateEndpointCommandInput - {@link CreateEndpointCommandInput}
+ * @returns {@link CreateEndpointCommandOutput}
  * @see {@link CreateEndpointCommandInput} for command's `input` shape.
  * @see {@link CreateEndpointCommandOutput} for command's `response` shape.
  * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape.
@@ -65,11 +72,20 @@ export interface CreateEndpointCommandOutput extends CreateEndpointResponse, __M
 export declare class CreateEndpointCommand extends $Command<CreateEndpointCommandInput, CreateEndpointCommandOutput, ComprehendClientResolvedConfig> {
     readonly input: CreateEndpointCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: CreateEndpointCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ComprehendClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateEndpointCommandInput, CreateEndpointCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }