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

StartPiiEntitiesDetectionJobRequest

class StartPiiEntitiesDetectionJobRequest

Types

object Companion

Properties

clientRequestToken

val clientRequestToken: String?

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

dataAccessRoleArn

val dataAccessRoleArn: String?

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

inputDataConfig

val inputDataConfig: InputDataConfig?

The input properties for a PII entities detection job.

val jobName: String?

The identifier of the job.

val languageCode: LanguageCode?

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

val mode: PiiEntitiesDetectionMode?

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

outputDataConfig

val outputDataConfig: OutputDataConfig?

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

redactionConfig

val redactionConfig: RedactionConfig?

Provides configuration parameters for PII entity redaction.

val 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

inline fun copy(block: StartPiiEntitiesDetectionJobRequest.Builder.() -> Unit = {}): StartPiiEntitiesDetectionJobRequest

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toString(): String