You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Provides information about a PII entities detection job.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Returns:

  • (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.

Returns:

  • (Time) —

    The time that the PII entities detection job completed.

#input_data_config ⇒ Types::InputDataConfig

The input properties for a PII entities detection job.

Returns:

#job_id ⇒ String

The identifier assigned to the PII entities detection job.

Returns:

  • (String) —

    The identifier assigned to the PII entities detection job.

#job_name ⇒ String

The name that you assigned the PII entities detection job.

Returns:

  • (String) —

    The name that you assigned the PII entities detection job.

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

Possible values:

  • SUBMITTED
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • STOP_REQUESTED
  • STOPPED

Returns:

  • (String) —

    The current status of the PII entities detection job.

#language_code ⇒ String

The language code of the input documents

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

    The language code of the input documents.

#message ⇒ String

A description of the status of a job.

Returns:

  • (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.

Possible values:

  • ONLY_REDACTION
  • ONLY_OFFSETS

Returns:

  • (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.

Returns:

  • (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.

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:

#submit_time ⇒ Time

The time that the PII entities detection job was submitted for processing.

Returns:

  • (Time) —

    The time that the PII entities detection job was submitted for processing.