Class: Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties
- Inherits:
-
Struct
- Object
- Struct
- Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties
- Defined in:
- gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb
Overview
Provides information about a PII entities detection job.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
-
#end_time ⇒ Time
The time that the PII entities detection job completed.
-
#input_data_config ⇒ Types::InputDataConfig
The input properties for a PII entities detection job.
-
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the PII entities detection job.
-
#job_id ⇒ String
The identifier assigned to the PII entities detection job.
-
#job_name ⇒ String
The name that you assigned the PII entities detection job.
-
#job_status ⇒ String
The current status of the PII entities detection job.
-
#language_code ⇒ String
The language code of the input documents.
-
#message ⇒ String
A description of the status of a job.
-
#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::PiiOutputDataConfig
The output data configuration that you supplied when you created the PII entities detection job.
-
#redaction_config ⇒ Types::RedactionConfig
Provides configuration parameters for PII entity redaction.
-
#submit_time ⇒ Time
The time that the PII entities detection job was submitted for processing.
Instance Attribute Details
#data_access_role_arn ⇒ String
The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#end_time ⇒ Time
The time that the PII entities detection job completed.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#input_data_config ⇒ Types::InputDataConfig
The input properties for a PII entities detection job.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#job_arn ⇒ String
The Amazon Resource Name (ARN) of the PII entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#job_id ⇒ String
The identifier assigned to the PII entities detection job.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name that you assigned the PII entities detection job.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#job_status ⇒ String
The current status of the PII entities detection job. If the status
is FAILED
, the Message
field shows the reason for the failure.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ String
The language code of the input documents
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#message ⇒ String
A description of the status of a job.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) 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.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#output_data_config ⇒ Types::PiiOutputDataConfig
The output data configuration that you supplied when you created the PII entities detection job.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) 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.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |
#submit_time ⇒ Time
The time that the PII entities detection job was submitted for processing.
5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 5094 class PiiEntitiesDetectionJobProperties < Struct.new( :job_id, :job_arn, :job_name, :job_status, :message, :submit_time, :end_time, :input_data_config, :output_data_config, :redaction_config, :language_code, :data_access_role_arn, :mode) SENSITIVE = [] include Aws::Structure end |