Class: Aws::Comprehend::Types::StartPiiEntitiesDetectionJobRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-comprehend/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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.

Returns:

  • (String)


7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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_arnString

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

  • (String)


7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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_configTypes::InputDataConfig

The input properties for a PII entities detection job.



7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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_nameString

The identifier of the job.

Returns:

  • (String)


7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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_codeString

The language of the input documents. Enter the language code for English (en) or Spanish (es).

Returns:

  • (String)


7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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

#modeString

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

Returns:

  • (String)


7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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_configTypes::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 '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_configTypes::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 '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

#tagsArray<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.

Returns:



7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
# File '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