import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartPiiEntitiesDetectionJobRequest, StartPiiEntitiesDetectionJobResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link StartPiiEntitiesDetectionJobCommand}. */ export interface StartPiiEntitiesDetectionJobCommandInput extends StartPiiEntitiesDetectionJobRequest { } /** * @public * * The output of {@link StartPiiEntitiesDetectionJobCommand}. */ export interface StartPiiEntitiesDetectionJobCommandOutput extends StartPiiEntitiesDetectionJobResponse, __MetadataBearer { } declare const StartPiiEntitiesDetectionJobCommand_base: { new (input: StartPiiEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartPiiEntitiesDetectionJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Starts an asynchronous PII entity detection job for a collection of documents.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { ComprehendClient, StartPiiEntitiesDetectionJobCommand } from "@aws-sdk/client-comprehend"; // ES Modules import * // const { ComprehendClient, StartPiiEntitiesDetectionJobCommand } = 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 = { // StartPiiEntitiesDetectionJobRequest * 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", * }, * Mode: "ONLY_REDACTION" || "ONLY_OFFSETS", // required * RedactionConfig: { // RedactionConfig * PiiEntityTypes: [ // ListOfPiiEntityTypes * "BANK_ACCOUNT_NUMBER" || "BANK_ROUTING" || "CREDIT_DEBIT_NUMBER" || "CREDIT_DEBIT_CVV" || "CREDIT_DEBIT_EXPIRY" || "PIN" || "EMAIL" || "ADDRESS" || "NAME" || "PHONE" || "SSN" || "DATE_TIME" || "PASSPORT_NUMBER" || "DRIVER_ID" || "URL" || "AGE" || "USERNAME" || "PASSWORD" || "AWS_ACCESS_KEY" || "AWS_SECRET_KEY" || "IP_ADDRESS" || "MAC_ADDRESS" || "ALL" || "LICENSE_PLATE" || "VEHICLE_IDENTIFICATION_NUMBER" || "UK_NATIONAL_INSURANCE_NUMBER" || "CA_SOCIAL_INSURANCE_NUMBER" || "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" || "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" || "IN_PERMANENT_ACCOUNT_NUMBER" || "IN_NREGA" || "INTERNATIONAL_BANK_ACCOUNT_NUMBER" || "SWIFT_CODE" || "UK_NATIONAL_HEALTH_SERVICE_NUMBER" || "CA_HEALTH_NUMBER" || "IN_AADHAAR" || "IN_VOTER_NUMBER", * ], * MaskMode: "MASK" || "REPLACE_WITH_PII_ENTITY_TYPE", * MaskCharacter: "STRING_VALUE", * }, * DataAccessRoleArn: "STRING_VALUE", // required * JobName: "STRING_VALUE", * LanguageCode: "en" || "es" || "fr" || "de" || "it" || "pt" || "ar" || "hi" || "ja" || "ko" || "zh" || "zh-TW", // required * ClientRequestToken: "STRING_VALUE", * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", * }, * ], * }; * const command = new StartPiiEntitiesDetectionJobCommand(input); * const response = await client.send(command); * // { // StartPiiEntitiesDetectionJobResponse * // JobId: "STRING_VALUE", * // JobArn: "STRING_VALUE", * // JobStatus: "SUBMITTED" || "IN_PROGRESS" || "COMPLETED" || "FAILED" || "STOP_REQUESTED" || "STOPPED", * // }; * * ``` * * @param StartPiiEntitiesDetectionJobCommandInput - {@link StartPiiEntitiesDetectionJobCommandInput} * @returns {@link StartPiiEntitiesDetectionJobCommandOutput} * @see {@link StartPiiEntitiesDetectionJobCommandInput} for command's `input` shape. * @see {@link StartPiiEntitiesDetectionJobCommandOutput} 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 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 StartPiiEntitiesDetectionJobCommand extends StartPiiEntitiesDetectionJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartPiiEntitiesDetectionJobRequest; output: StartPiiEntitiesDetectionJobResponse; }; sdk: { input: StartPiiEntitiesDetectionJobCommandInput; output: StartPiiEntitiesDetectionJobCommandOutput; }; }; }