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
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 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 associate 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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 IAM role that grants Amazon Comprehend read access to your input data.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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. Enter the language code for English (en) or Spanish (es).
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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 associate 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.
7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 |
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 7437 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 |