import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeEntitiesDetectionJobRequest, DescribeEntitiesDetectionJobResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeEntitiesDetectionJobCommand}. */ export interface DescribeEntitiesDetectionJobCommandInput extends DescribeEntitiesDetectionJobRequest { } /** * @public * * The output of {@link DescribeEntitiesDetectionJobCommand}. */ export interface DescribeEntitiesDetectionJobCommandOutput extends DescribeEntitiesDetectionJobResponse, __MetadataBearer { } declare const DescribeEntitiesDetectionJobCommand_base: { new (input: DescribeEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets the properties associated with an entities detection job. Use this operation to get * the status of a detection job.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, DescribeEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, DescribeEntitiesDetectionJobCommand } = 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 = { // DescribeEntitiesDetectionJobRequest * JobId: "STRING_VALUE", // required * }; * const command = new DescribeEntitiesDetectionJobCommand(input); * const response = await client.send(command); * // { // DescribeEntitiesDetectionJobResponse * // EntitiesDetectionJobProperties: { // EntitiesDetectionJobProperties * // 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"), * // EntityRecognizerArn: "STRING_VALUE", * // 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", * // ], * // }, * // FlywheelArn: "STRING_VALUE", * // }, * // }; * * ``` * * @param DescribeEntitiesDetectionJobCommandInput - {@link DescribeEntitiesDetectionJobCommandInput} * @returns {@link DescribeEntitiesDetectionJobCommandOutput} * @see {@link DescribeEntitiesDetectionJobCommandInput} for command's `input` shape. * @see {@link DescribeEntitiesDetectionJobCommandOutput} 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 JobNotFoundException} (client fault) *

The specified job was not found. Check the job ID and try again.

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

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

* * @throws {@link ComprehendServiceException} *

Base exception class for all service exceptions from Comprehend service.

* * * @public */ export declare class DescribeEntitiesDetectionJobCommand extends DescribeEntitiesDetectionJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeEntitiesDetectionJobRequest; output: DescribeEntitiesDetectionJobResponse; }; sdk: { input: DescribeEntitiesDetectionJobCommandInput; output: DescribeEntitiesDetectionJobCommandOutput; }; }; }