@aws-sdk/client-comprehend 3.296.0 → 3.298.0

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

@@ -1,12 +1,18 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { ComprehendServiceException as __BaseException } from "./ComprehendServiceException";
 import { FlywheelProperties, JobStatus, Tag, VpcConfig } from "./models_0";
+/**
+ * @public
+ */
 export interface StopTargetedSentimentDetectionJobRequest {
     /**
      * <p>The identifier of the targeted sentiment detection job to stop.</p>
      */
     JobId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopTargetedSentimentDetectionJobResponse {
     /**
      * <p>The identifier of the targeted sentiment detection job to stop.</p>
@@ -19,6 +25,9 @@ export interface StopTargetedSentimentDetectionJobResponse {
      */
     JobStatus?: JobStatus | string;
 }
+/**
+ * @public
+ */
 export interface StopTrainingDocumentClassifierRequest {
     /**
      * <p>The Amazon Resource Name (ARN) that identifies the document classifier currently being
@@ -26,8 +35,14 @@ export interface StopTrainingDocumentClassifierRequest {
      */
     DocumentClassifierArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopTrainingDocumentClassifierResponse {
 }
+/**
+ * @public
+ */
 export interface StopTrainingEntityRecognizerRequest {
     /**
      * <p>The Amazon Resource Name (ARN) that identifies the entity recognizer currently being
@@ -35,9 +50,13 @@ export interface StopTrainingEntityRecognizerRequest {
      */
     EntityRecognizerArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface StopTrainingEntityRecognizerResponse {
 }
 /**
+ * @public
  * <p>Concurrent modification of the tags associated with an Amazon Comprehend resource is not
  *       supported. </p>
  */
@@ -50,6 +69,9 @@ export declare class ConcurrentModificationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ConcurrentModificationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want
@@ -62,9 +84,13 @@ export interface TagResourceRequest {
      */
     Tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
 /**
+ * @public
  * <p>The request contains more tag keys than can be associated with a resource (50 tag keys per
  *       resource).</p>
  */
@@ -77,6 +103,9 @@ export declare class TooManyTagKeysException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<TooManyTagKeysException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p> The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you
@@ -91,8 +120,14 @@ export interface UntagResourceRequest {
      */
     TagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateEndpointRequest {
     /**
      * <p>The Amazon Resource Number (ARN) of the endpoint being updated.</p>
@@ -117,6 +152,9 @@ export interface UpdateEndpointRequest {
      */
     FlywheelArn?: string;
 }
+/**
+ * @public
+ */
 export interface UpdateEndpointResponse {
     /**
      * <p>The Amazon Resource Number (ARN) of the new model.</p>
@@ -124,6 +162,7 @@ export interface UpdateEndpointResponse {
     DesiredModelArn?: string;
 }
 /**
+ * @public
  * <p>Data security configuration.</p>
  */
 export interface UpdateDataSecurityConfig {
@@ -154,6 +193,9 @@ export interface UpdateDataSecurityConfig {
      */
     VpcConfig?: VpcConfig;
 }
+/**
+ * @public
+ */
 export interface UpdateFlywheelRequest {
     /**
      * <p>The Amazon Resource Number (ARN) of the flywheel to update.</p>
@@ -173,69 +215,12 @@ export interface UpdateFlywheelRequest {
      */
     DataSecurityConfig?: UpdateDataSecurityConfig;
 }
+/**
+ * @public
+ */
 export interface UpdateFlywheelResponse {
     /**
      * <p>The flywheel properties.</p>
      */
     FlywheelProperties?: FlywheelProperties;
 }
-/**
- * @internal
- */
-export declare const StopTargetedSentimentDetectionJobRequestFilterSensitiveLog: (obj: StopTargetedSentimentDetectionJobRequest) => any;
-/**
- * @internal
- */
-export declare const StopTargetedSentimentDetectionJobResponseFilterSensitiveLog: (obj: StopTargetedSentimentDetectionJobResponse) => any;
-/**
- * @internal
- */
-export declare const StopTrainingDocumentClassifierRequestFilterSensitiveLog: (obj: StopTrainingDocumentClassifierRequest) => any;
-/**
- * @internal
- */
-export declare const StopTrainingDocumentClassifierResponseFilterSensitiveLog: (obj: StopTrainingDocumentClassifierResponse) => any;
-/**
- * @internal
- */
-export declare const StopTrainingEntityRecognizerRequestFilterSensitiveLog: (obj: StopTrainingEntityRecognizerRequest) => any;
-/**
- * @internal
- */
-export declare const StopTrainingEntityRecognizerResponseFilterSensitiveLog: (obj: StopTrainingEntityRecognizerResponse) => any;
-/**
- * @internal
- */
-export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
-/**
- * @internal
- */
-export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateEndpointRequestFilterSensitiveLog: (obj: UpdateEndpointRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateEndpointResponseFilterSensitiveLog: (obj: UpdateEndpointResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateDataSecurityConfigFilterSensitiveLog: (obj: UpdateDataSecurityConfig) => any;
-/**
- * @internal
- */
-export declare const UpdateFlywheelRequestFilterSensitiveLog: (obj: UpdateFlywheelRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateFlywheelResponseFilterSensitiveLog: (obj: UpdateFlywheelResponse) => any;

package/dist-types/pagination/Interfaces.d.ts

@@ -1,5 +1,8 @@
 import { PaginationConfiguration } from "@aws-sdk/types";
 import { ComprehendClient } from "../ComprehendClient";
+/**
+ * @public
+ */
 export interface ComprehendPaginationConfiguration extends PaginationConfiguration {
     client: ComprehendClient;
 }

package/dist-types/pagination/ListDatasetsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDatasetsCommandInput, ListDatasetsCommandOutput } from "../commands/ListDatasetsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDatasets(config: ComprehendPaginationConfiguration, input: ListDatasetsCommandInput, ...additionalArguments: any): Paginator<ListDatasetsCommandOutput>;

package/dist-types/pagination/ListDocumentClassificationJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDocumentClassificationJobsCommandInput, ListDocumentClassificationJobsCommandOutput } from "../commands/ListDocumentClassificationJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDocumentClassificationJobs(config: ComprehendPaginationConfiguration, input: ListDocumentClassificationJobsCommandInput, ...additionalArguments: any): Paginator<ListDocumentClassificationJobsCommandOutput>;

package/dist-types/pagination/ListDocumentClassifierSummariesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDocumentClassifierSummariesCommandInput, ListDocumentClassifierSummariesCommandOutput } from "../commands/ListDocumentClassifierSummariesCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDocumentClassifierSummaries(config: ComprehendPaginationConfiguration, input: ListDocumentClassifierSummariesCommandInput, ...additionalArguments: any): Paginator<ListDocumentClassifierSummariesCommandOutput>;

package/dist-types/pagination/ListDocumentClassifiersPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDocumentClassifiersCommandInput, ListDocumentClassifiersCommandOutput } from "../commands/ListDocumentClassifiersCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDocumentClassifiers(config: ComprehendPaginationConfiguration, input: ListDocumentClassifiersCommandInput, ...additionalArguments: any): Paginator<ListDocumentClassifiersCommandOutput>;

package/dist-types/pagination/ListDominantLanguageDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListDominantLanguageDetectionJobsCommandInput, ListDominantLanguageDetectionJobsCommandOutput } from "../commands/ListDominantLanguageDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListDominantLanguageDetectionJobs(config: ComprehendPaginationConfiguration, input: ListDominantLanguageDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListDominantLanguageDetectionJobsCommandOutput>;

package/dist-types/pagination/ListEndpointsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListEndpointsCommandInput, ListEndpointsCommandOutput } from "../commands/ListEndpointsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListEndpoints(config: ComprehendPaginationConfiguration, input: ListEndpointsCommandInput, ...additionalArguments: any): Paginator<ListEndpointsCommandOutput>;

package/dist-types/pagination/ListEntitiesDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListEntitiesDetectionJobsCommandInput, ListEntitiesDetectionJobsCommandOutput } from "../commands/ListEntitiesDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListEntitiesDetectionJobs(config: ComprehendPaginationConfiguration, input: ListEntitiesDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListEntitiesDetectionJobsCommandOutput>;

package/dist-types/pagination/ListEntityRecognizerSummariesPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListEntityRecognizerSummariesCommandInput, ListEntityRecognizerSummariesCommandOutput } from "../commands/ListEntityRecognizerSummariesCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListEntityRecognizerSummaries(config: ComprehendPaginationConfiguration, input: ListEntityRecognizerSummariesCommandInput, ...additionalArguments: any): Paginator<ListEntityRecognizerSummariesCommandOutput>;

package/dist-types/pagination/ListEntityRecognizersPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListEntityRecognizersCommandInput, ListEntityRecognizersCommandOutput } from "../commands/ListEntityRecognizersCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListEntityRecognizers(config: ComprehendPaginationConfiguration, input: ListEntityRecognizersCommandInput, ...additionalArguments: any): Paginator<ListEntityRecognizersCommandOutput>;

package/dist-types/pagination/ListEventsDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListEventsDetectionJobsCommandInput, ListEventsDetectionJobsCommandOutput } from "../commands/ListEventsDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListEventsDetectionJobs(config: ComprehendPaginationConfiguration, input: ListEventsDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListEventsDetectionJobsCommandOutput>;

package/dist-types/pagination/ListFlywheelIterationHistoryPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListFlywheelIterationHistoryCommandInput, ListFlywheelIterationHistoryCommandOutput } from "../commands/ListFlywheelIterationHistoryCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListFlywheelIterationHistory(config: ComprehendPaginationConfiguration, input: ListFlywheelIterationHistoryCommandInput, ...additionalArguments: any): Paginator<ListFlywheelIterationHistoryCommandOutput>;

package/dist-types/pagination/ListFlywheelsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListFlywheelsCommandInput, ListFlywheelsCommandOutput } from "../commands/ListFlywheelsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListFlywheels(config: ComprehendPaginationConfiguration, input: ListFlywheelsCommandInput, ...additionalArguments: any): Paginator<ListFlywheelsCommandOutput>;

package/dist-types/pagination/ListKeyPhrasesDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListKeyPhrasesDetectionJobsCommandInput, ListKeyPhrasesDetectionJobsCommandOutput } from "../commands/ListKeyPhrasesDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListKeyPhrasesDetectionJobs(config: ComprehendPaginationConfiguration, input: ListKeyPhrasesDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListKeyPhrasesDetectionJobsCommandOutput>;

package/dist-types/pagination/ListPiiEntitiesDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListPiiEntitiesDetectionJobsCommandInput, ListPiiEntitiesDetectionJobsCommandOutput } from "../commands/ListPiiEntitiesDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListPiiEntitiesDetectionJobs(config: ComprehendPaginationConfiguration, input: ListPiiEntitiesDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListPiiEntitiesDetectionJobsCommandOutput>;

package/dist-types/pagination/ListSentimentDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListSentimentDetectionJobsCommandInput, ListSentimentDetectionJobsCommandOutput } from "../commands/ListSentimentDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListSentimentDetectionJobs(config: ComprehendPaginationConfiguration, input: ListSentimentDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListSentimentDetectionJobsCommandOutput>;

package/dist-types/pagination/ListTargetedSentimentDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTargetedSentimentDetectionJobsCommandInput, ListTargetedSentimentDetectionJobsCommandOutput } from "../commands/ListTargetedSentimentDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTargetedSentimentDetectionJobs(config: ComprehendPaginationConfiguration, input: ListTargetedSentimentDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListTargetedSentimentDetectionJobsCommandOutput>;

package/dist-types/pagination/ListTopicsDetectionJobsPaginator.d.ts

@@ -1,4 +1,7 @@
 import { Paginator } from "@aws-sdk/types";
 import { ListTopicsDetectionJobsCommandInput, ListTopicsDetectionJobsCommandOutput } from "../commands/ListTopicsDetectionJobsCommand";
 import { ComprehendPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
 export declare function paginateListTopicsDetectionJobs(config: ComprehendPaginationConfiguration, input: ListTopicsDetectionJobsCommandInput, ...additionalArguments: any): Paginator<ListTopicsDetectionJobsCommandOutput>;