Optional
ClientThe Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
The input properties for a PII entities detection job.
Optional
JobThe identifier of the job.
The language of the input documents. Enter the language code for English (en) or Spanish (es).
Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.
Provides configuration parameters for the output of PII entity detection jobs.
Optional
RedactionProvides 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.
Optional
TagsTags 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.
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.