NAME

Paws::Comprehend::PiiEntitiesDetectionJobProperties

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Comprehend::PiiEntitiesDetectionJobProperties object:

  $service_obj->Method(Att1 => { DataAccessRoleArn => $value, ..., SubmitTime => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Comprehend::PiiEntitiesDetectionJobProperties object:

  $result = $service_obj->Method(...);
  $result->Att1->DataAccessRoleArn

DESCRIPTION

Provides information about a PII entities detection job.

ATTRIBUTES

DataAccessRoleArn => Str

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

EndTime => Str

The time that the PII entities detection job completed.

InputDataConfig => Paws::Comprehend::InputDataConfig

The input properties for a PII entities detection job.

JobId => Str

The identifier assigned to the PII entities detection job.

JobName => Str

The name that you assigned the PII entities detection job.

JobStatus => Str

The current status of the PII entities detection job. If the status is "FAILED", the "Message" field shows the reason for the failure.

LanguageCode => Str

The language code of the input documents

Message => Str

A description of the status of a job.

Mode => Str

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

OutputDataConfig => Paws::Comprehend::PiiOutputDataConfig

The output data configuration that you supplied when you created the PII entities detection job.

RedactionConfig => Paws::Comprehend::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.

SubmitTime => Str

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

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>