Class: Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties

Inherits:

Struct

Object
Struct
Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties

show all

Includes:: Structure

Defined in:: 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) of the IAM role that grants 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) of the IAM role that grants Amazon Comprehend read access to your input data.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(Types::InputDataConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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 Amazon Web Services account, Amazon Web Services 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`

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(String)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(Types::PiiOutputDataConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(Types::RedactionConfig)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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.

Returns:

(Time)

# File 'lib/aws-sdk-comprehend/types.rb', line 6256

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

Class: Aws::Comprehend::Types::PiiEntitiesDetectionJobProperties

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

#end_time ⇒ Time

#input_data_config ⇒ Types::InputDataConfig

#job_arn ⇒ String

#job_id ⇒ String

#job_name ⇒ String

#job_status ⇒ String

#language_code ⇒ String

#message ⇒ String

#mode ⇒ String

#output_data_config ⇒ Types::PiiOutputDataConfig

#redaction_config ⇒ Types::RedactionConfig

#submit_time ⇒ Time

#data_access_role_arn ⇒ `String`

#end_time ⇒ `Time`

#input_data_config ⇒ `Types::InputDataConfig`

#job_arn ⇒ `String`

#job_id ⇒ `String`

#job_name ⇒ `String`

#job_status ⇒ `String`

#language_code ⇒ `String`

#message ⇒ `String`

#mode ⇒ `String`

#output_data_config ⇒ `Types::PiiOutputDataConfig`

#redaction_config ⇒ `Types::RedactionConfig`

#submit_time ⇒ `Time`