import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartEntitiesDetectionJobRequest, StartEntitiesDetectionJobResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link StartEntitiesDetectionJobCommand}. */ export interface StartEntitiesDetectionJobCommandInput extends StartEntitiesDetectionJobRequest { } /** * @public * * The output of {@link StartEntitiesDetectionJobCommand}. */ export interface StartEntitiesDetectionJobCommandOutput extends StartEntitiesDetectionJobResponse, __MetadataBearer { } declare const StartEntitiesDetectionJobCommand_base: { new (input: StartEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

*

This API can be used for either standard entity detection or custom entity recognition. In * order to be used for custom entity recognition, the optional EntityRecognizerArn * must be used in order to provide access to the recognizer being used to detect the custom * entity.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, StartEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, StartEntitiesDetectionJobCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import * // import type { ComprehendClientConfig } from "@aws-sdk/client-comprehend"; * const config = {}; // type is ComprehendClientConfig * const client = new ComprehendClient(config); * const input = { // StartEntitiesDetectionJobRequest * InputDataConfig: { // InputDataConfig * S3Uri: "STRING_VALUE", // required * InputFormat: "ONE_DOC_PER_FILE" || "ONE_DOC_PER_LINE", * DocumentReaderConfig: { // DocumentReaderConfig * DocumentReadAction: "TEXTRACT_DETECT_DOCUMENT_TEXT" || "TEXTRACT_ANALYZE_DOCUMENT", // required * DocumentReadMode: "SERVICE_DEFAULT" || "FORCE_DOCUMENT_READ_ACTION", * FeatureTypes: [ // ListOfDocumentReadFeatureTypes * "TABLES" || "FORMS", * ], * }, * }, * OutputDataConfig: { // OutputDataConfig * S3Uri: "STRING_VALUE", // required * KmsKeyId: "STRING_VALUE", * }, * DataAccessRoleArn: "STRING_VALUE", // required * JobName: "STRING_VALUE", * EntityRecognizerArn: "STRING_VALUE", * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required * ClientRequestToken: "STRING_VALUE", * VolumeKmsKeyId: "STRING_VALUE", * VpcConfig: { // VpcConfig * SecurityGroupIds: [ // SecurityGroupIds // required * "STRING_VALUE", * ], * Subnets: [ // Subnets // required * "STRING_VALUE", * ], * }, * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", * }, * ], * FlywheelArn: "STRING_VALUE", * }; * 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} * @returns {@link StartEntitiesDetectionJobCommandOutput} * @see {@link StartEntitiesDetectionJobCommandInput} for command's `input` shape. * @see {@link StartEntitiesDetectionJobCommandOutput} for command's `response` shape. * @see {@link ComprehendClientResolvedConfig | config} for ComprehendClient's `config` shape. * * @throws {@link InternalServerException} (server fault) *

An internal server error occurred. Retry your request.

* * @throws {@link InvalidRequestException} (client fault) *

The request is invalid.

* * @throws {@link KmsKeyValidationException} (client fault) *

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and * re-enter it.

* * @throws {@link ResourceInUseException} (client fault) *

The specified resource name is already in use. Use a different name and try your request * again.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource ARN was not found. Check the ARN and try your request again.

* * @throws {@link ResourceUnavailableException} (client fault) *

The specified resource is not available. Check the resource and try your request * again.

* * @throws {@link TooManyRequestsException} (client fault) *

The number of requests exceeds the limit. Resubmit your request later.

* * @throws {@link TooManyTagsException} (client fault) *

The request contains more tags than can be associated with a resource (50 tags per * resource). The maximum number of tags includes both existing tags and those included in your * current request.

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class StartEntitiesDetectionJobCommand extends StartEntitiesDetectionJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartEntitiesDetectionJobRequest; output: StartEntitiesDetectionJobResponse; }; sdk: { input: StartEntitiesDetectionJobCommandInput; output: StartEntitiesDetectionJobCommandOutput; }; }; }