StartPiiEntitiesDetectionJob - Amazon Comprehend

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

StartPiiEntitiesDetectionJob

为一组文档启动异步 PII 实体检测作业。

请求语法

{ "ClientRequestToken": "string", "DataAccessRoleArn": "string", "InputDataConfig": { "DocumentReaderConfig": { "DocumentReadAction": "string", "DocumentReadMode": "string", "FeatureTypes": [ "string" ] }, "InputFormat": "string", "S3Uri": "string" }, "JobName": "string", "LanguageCode": "string", "Mode": "string", "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "RedactionConfig": { "MaskCharacter": "string", "MaskMode": "string", "PiiEntityTypes": [ "string" ] }, "Tags": [ { "Key": "string", "Value": "string" } ] }

请求参数

有关所有操作的通用参数的信息,请参阅常见参数.

请求接受采用 JSON 格式的以下数据。

ClientRequestToken

请求的唯一标识符。如果您未设置客户端请求令牌,Amazon Comprehend 会生成一个令牌。

类型: 字符串

长度约束:最小长度为 1。最大长度为 64。

模式:^[a-zA-Z0-9-]+$

必需:否

DataAccessRoleArn

Amazon Canagement (IAM) 角色的 Amazon 资源名称 (ARN),Amazon Coment (IAM) 角色的 Amazon 资源名称 (ARN),Amazon C

类型: 字符串

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

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

必需:是

InputDataConfig

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

类型:InputDataConfig 对象

必需:是

JobName

任务的标识符。

类型: 字符串

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

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

必需:否

LanguageCode

输入文档的语言。目前,英语是必需的。

类型: 字符串

有效值: en

必需:是

Mode

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

类型: 字符串

有效值: ONLY_REDACTION | ONLY_OFFSETS

必需:是

OutputDataConfig

为 PII 实体检测作业的输出提供配置参数。

类型:OutputDataConfig 对象

必需:是

RedactionConfig

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

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

类型:RedactionConfig 对象

必需:否

Tags

要与 PII 实体检测作业关联的标签。标签是键值对,用于向 Amazon Comement 使用的资源添加元数据。例如,可以将以 “Sales” 作为密钥的标签添加到资源中,以指示销售部门使用该标签。

类型: 数组的Tag对象

必需:否

响应语法

{ "JobArn": "string", "JobId": "string", "JobStatus": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回的以下数据。

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

为作业生成的标识符。

类型: 字符串

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

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

JobStatus

任务的状态。

类型: 字符串

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

错误

有关所有操作共有的错误的信息,请参阅常见错误.

InternalServerException

发生内部服务器错误。重试您的请求。

HTTP 状态代码:500

InvalidRequestException

该请求无效。

HTTP 状态代码:400

KmsKeyValidationException

无法验证输入的 KMS 客户管理密钥 (CMK)。验证密钥并重新输入。

HTTP 状态代码:400

TooManyRequestsException

请求数超过了限制。稍后重新提交您的请求。

HTTP 状态代码:400

TooManyTagsException

该请求包含的标签多于可以与资源关联的标签(每个资源 50 个标签)。标签的最大数量包括现有标签和当前请求中包含的标签。

HTTP 状态代码:400

另请参阅

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