Class: Aws::Comprehend::Types::StartPiiEntitiesDetectionJobRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::StartPiiEntitiesDetectionJobRequest
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
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
document_reader_config: {
document_read_action: "TEXTRACT_DETECT_DOCUMENT_TEXT", # required, accepts TEXTRACT_DETECT_DOCUMENT_TEXT, TEXTRACT_ANALYZE_DOCUMENT
document_read_mode: "SERVICE_DEFAULT", # accepts SERVICE_DEFAULT, FORCE_DOCUMENT_READ_ACTION
feature_types: ["TABLES"], # accepts TABLES, FORMS
},
},
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, 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
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",
},
],
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_request_token ⇒ String
A unique identifier for the request.
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
-
#input_data_config ⇒ Types::InputDataConfig
The input properties for a PII entities detection job.
-
#job_name ⇒ String
The identifier of the job.
-
#language_code ⇒ String
The language of the input documents.
-
#mode ⇒ String
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
-
#output_data_config ⇒ Types::OutputDataConfig
Provides configuration parameters for the output of PII entity detection jobs.
-
#redaction_config ⇒ Types::RedactionConfig
Provides configuration parameters for PII entity redaction.
-
#tags ⇒ Array<Types::Tag>
Tags to be associated with the PII entities detection job.
Instance Attribute Details
#client_request_token ⇒ String
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.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::InputDataConfig
The input properties for a PII entities detection job.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The identifier of the job.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
The language of the input documents. Currently, English is the only valid language.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#mode ⇒ String
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#output_data_config ⇒ Types::OutputDataConfig
Provides configuration parameters for the output of PII entity detection jobs.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#redaction_config ⇒ Types::RedactionConfig
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.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
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.
6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 6496 class StartPiiEntitiesDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :mode, :redaction_config, :data_access_role_arn, :job_name, :language_code, :client_request_token, :tags) SENSITIVE = [] include Aws::Structure end |