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

Builder

Properties

clientRequestToken

var clientRequestToken: String?

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

dataAccessRoleArn

var dataAccessRoleArn: String?

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

inputDataConfig

var inputDataConfig: InputDataConfig?

The input properties for a PII entities detection job.

var jobName: String?

The identifier of the job.

var languageCode: LanguageCode?

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

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: OutputDataConfig?

Provides conﬁguration parameters for the output of PII entity detection jobs.

redactionConfig

var redactionConfig: RedactionConfig?

Provides configuration parameters for PII entity redaction.

var tags: List<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.

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: OutputDataConfig.Builder.() -> Unit)

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

redactionConfig

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

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