PiiEntitiesDetectionJobProperties - Amazon Comprehend

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

PiiEntitiesDetectionJobProperties

提供有关 PII 实体检测作业的信息。

目录

DataAccessRoleArn

授予您输入数据的读取权限的 Amazon Comprehend 资源名称 (ARN)。

类型: 字符串

长度约束:最小长度为 20。长度上限为 2048。

模式:arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

必需: 否

EndTime

PII 实体检测作业完成的时间。

类型: 时间戳

必需: 否

InputDataConfig

PII 实体检测作业的输入属性。

类型:InputDataConfig 对象

必需: 否

JobArn

PII 实体检测作业的 Amazon 资源名称 (ARN)。它是作业唯一的完全限定标识符。它包括 AWS 账户、区域和任务 ID。ARN 的格式如下所示:

arn:<partition>:comprehend:<region>:<account-id>:pii-entities-detection-job/<job-id>

以下是示例作业 ARN:

arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/1234abcd12ab34cd56ef1234567890ab

类型: 字符串

长度约束:长度上限为 256。

模式:arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*(/version/[a-zA-Z0-9](-*[a-zA-Z0-9])*)?

必需: 否

JobId

分配给 PII 实体检测作业的标识符。

类型: 字符串

长度约束:最小长度为 1。长度上限为 32。

模式:^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

必需: 否

JobName

您为 PII 实体检测作业分配的名称。

类型: 字符串

长度约束:最小长度为 1。长度上限为 256。

模式:^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

必需: 否

JobStatus

PII 实体检测作业的当前状态。如果状态为FAILED,那个Message字段会显示故障原因。

类型: 字符串

有效值: SUBMITTED | IN_PROGRESS | COMPLETED | FAILED | STOP_REQUESTED | STOPPED

必需: 否

LanguageCode

输入文档的语言代码

类型: 字符串

有效值: en

必需: 否

Message

作业状态的描述。

类型: 字符串

必需: 否

Mode

指定输出是提供 PII 实体的位置(偏移),还是提供密文 PII 实体的文件。

类型: 字符串

有效值: ONLY_REDACTION | ONLY_OFFSETS

必需: 否

OutputDataConfig

您在创建 PII 实体检测作业时提供的输出数据配置。

类型:PiiOutputDataConfig 对象

必需: 否

RedactionConfig

提供用于 PII 实体密文的配置参数。

如果您将Mode参数为ONLY_REDACTION. 在这种情况下,您必须提供一个RedactionConfig定义中包含PiiEntityTypes参数。

类型:RedactionConfig 对象

必需: 否

SubmitTime

提交 PII 实体检测作业进行处理的时间。

类型: 时间戳

必需: 否

另请参阅

有关在特定语言的 AWS 软件开发工具包中使用此 API 的更多信息,请参阅以下内容: