comprehend/aws.sdk.kotlin.services.comprehend.model/PiiEntitiesDetectionJobProperties/Builder

Builder

class Builder

Properties

dataAccessRoleArn

var dataAccessRoleArn: String?

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

endTime

var endTime: Instant?

The time that the PII entities detection job completed.

inputDataConfig

var inputDataConfig: InputDataConfig?

The input properties for a PII entities detection job.

jobArn

var jobArn: 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:

jobId

var jobId: String?

The identifier assigned to the PII entities detection job.

jobName

var jobName: String?

The name that you assigned the PII entities detection job.

jobStatus

var jobStatus: JobStatus?

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

languageCode

var languageCode: LanguageCode?

The language code of the input documents.

message

var message: String?

A description of the status of a job.

mode

var mode: PiiEntitiesDetectionMode?

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

outputDataConfig

var outputDataConfig: PiiOutputDataConfig?

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

redactionConfig

var redactionConfig: RedactionConfig?

Provides configuration parameters for PII entity redaction.

submitTime

var submitTime: Instant?

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

Functions

inputDataConfig

fun inputDataConfig(block: InputDataConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.InputDataConfig inside the given block

outputDataConfig

fun outputDataConfig(block: PiiOutputDataConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.PiiOutputDataConfig inside the given block

redactionConfig

fun redactionConfig(block: RedactionConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.comprehend.model.RedactionConfig inside the given block