StartTopicsDetectionJob - Amazon Comprehend

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

StartTopicsDetectionJob

启动异步主题检测作业。使用DescribeTopicDetectionJob操作以跟踪作业的状态。

请求语法

{ "ClientRequestToken": "string", "DataAccessRoleArn": "string", "InputDataConfig": { "DocumentReaderConfig": { "DocumentReadAction": "string", "DocumentReadMode": "string", "FeatureTypes": [ "string" ] }, "InputFormat": "string", "S3Uri": "string" }, "JobName": "string", "NumberOfTopics": number, "OutputDataConfig": { "KmsKeyId": "string", "S3Uri": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeKmsKeyId": "string", "VpcConfig": { "SecurityGroupIds": [ "string" ], "Subnets": [ "string" ] } }

请求参数

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

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

ClientRequestToken

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

类型: 字符串

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

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

必需:必需 否

DataAccessRoleArn

AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称 (ARN),该角色可授予Amazon 资源名称 (ARN),Amazon 有关更多信息,请参阅 https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions

类型: 字符串

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

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

必需:必需 是

InputDataConfig

指定作业的输入数据的格式和位置。

类型:InputDataConfig 对象

必需:必需 是

JobName

任务的标识符。

类型: 字符串

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

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

必需:必需 否

NumberOfTopics

要检测的主题数。

类型: 整数

有效范围: 最小值为 1。最大值为 100。

必需:必需 否

OutputDataConfig

指定输出文件的发送位置。输出是一个包含两个文件的压缩存档,topic-terms.csv其中列出了与每个主题相关的术语,以及doc-topics.csv其中列出了与每个主题关联的文档

类型:OutputDataConfig 对象

必需:必需 是

Tags

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

类型: 数组的Tag对象

必需:必需 否

VolumeKmsKeyId

AWS Key Management Service (KMS) 密钥的 Amazon 使用它来加密附加到处理分析作业的 Amazon 计算实例的存储卷上的数据。这些区域有: VolumeKmsKeyId 可以是以下任一格式:

  • KMS 密钥 ID:"1234abcd-12ab-34cd-56ef-1234567890ab"

  • KMS 密钥的 Amazon 资源名称 (ARN)"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

类型: 字符串

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

模式:^\p{ASCII}+$

必需:必需 否

VpcConfig

包含您用于主题检测作业的资源的可选私有Virtual Private Cloud (VPC) 的配置参数。有关更多信息,请参阅 Amazon VPC

类型:VpcConfig 对象

必需:必需 否

响应语法

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

响应元素

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

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

JobArn

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

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

以下是作业 ARN 的示例:

arn:aws:comprehend:us-west-2:111122223333:document-classification-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

为作业生成的标识符。要获取作业的状态,请将此标识符与DescribeTopicDetectionJoboperation.

类型: 字符串

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

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

JobStatus

任务的状态:

  • 已提交-作业已收到,正在排队等待处理。

  • IN_PROGRESS-亚马逊 Compress 正在处理该任务。

  • 已完成-作业已成功完成且输出可用。

  • 失败-作业未完成。要获取详细信息,请使用DescribeTopicDetectionJoboperation.

类型: 字符串

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

错误

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

InternalServerException

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

HTP 状态代码:500

InvalidRequestException

该请求无效。

HTP 状态代码:400

KmsKeyValidationException

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

HTP 状态代码:400

TooManyRequestsException

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

HTP 状态代码:400

TooManyTagsException

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

HTP 状态代码:400

另请参阅

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