class Aws::Comprehend::Types::StartPiiEntitiesDetectionJobRequest
@note When making an API call, you may pass StartPiiEntitiesDetectionJobRequest
data as a hash: { input_data_config: { # required s3_uri: "S3Uri", # required input_format: "ONE_DOC_PER_FILE", # accepts ONE_DOC_PER_FILE, ONE_DOC_PER_LINE }, output_data_config: { # required s3_uri: "S3Uri", # required kms_key_id: "KmsKeyId", }, mode: "ONLY_REDACTION", # required, accepts ONLY_REDACTION, ONLY_OFFSETS redaction_config: { pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts 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 mask_mode: "MASK", # accepts MASK, REPLACE_WITH_PII_ENTITY_TYPE mask_character: "MaskCharacter", }, data_access_role_arn: "IamRoleArn", # required job_name: "JobName", language_code: "en", # required, accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW client_request_token: "ClientRequestTokenString", tags: [ { key: "TagKey", # required value: "TagValue", }, ], }
@!attribute [rw] input_data_config
The input properties for a PII entities detection job. @return [Types::InputDataConfig]
@!attribute [rw] output_data_config
Provides configuration parameters for the output of PII entity detection jobs. @return [Types::OutputDataConfig]
@!attribute [rw] mode
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted. @return [String]
@!attribute [rw] redaction_config
Provides configuration parameters for PII entity redaction. This parameter is required if you set the `Mode` parameter to `ONLY_REDACTION`. In that case, you must provide a `RedactionConfig` definition that includes the `PiiEntityTypes` parameter. @return [Types::RedactionConfig]
@!attribute [rw] data_access_role_arn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. @return [String]
@!attribute [rw] job_name
The identifier of the job. @return [String]
@!attribute [rw] language_code
The language of the input documents. @return [String]
@!attribute [rw] client_request_token
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] tags
Tags to be associated with the PII entities detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department. @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJobRequest AWS API Documentation
Constants
- SENSITIVE