AWS IoT
开发人员指南
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

DescribeThingRegistrationTask

描述批量事物预配置任务。

请求语法:

GET /thing-registration-tasks/taskId

URI 请求参数:

名称

类型

请求?

描述

taskId

TaskId

任务 ID。

响应语法:

Content-type: application/json { "taskId": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string", "status": "string", "message": "string", "successCount": "integer", "failureCount": "integer", "percentageProgress": "integer" }

响应正文参数:

名称

类型

请求?

描述

taskId

TaskId

任务 ID。

creationDate

CreationDate

任务创建日期。

lastModifiedDate

LastModifiedDate

上次修改任务的日期。

templateBody

TemplateBody

任务的模板。

inputFileBucket

RegistryS3BucketName

包含输入文件的 S3 存储桶。

inputFileKey

RegistryS3KeyName

输入文件密钥。

roleArn

RoleArn

授予对输入文件存储桶的访问权限的角色 ARN。

status

Status

批量事物预配置任务的状态。

message

ErrorMessage

消息。

successCount

Count

成功预配置的事物数量。

failureCount

Count

预配置失败的事物数量。

percentageProgress

百分比

以百分比表示的批量预配置任务的进度。

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

CLI

摘要:

aws iot describe-thing-registration-task \ --task-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "taskId": "string" }

cli-input-json 字段:

名称

类型

描述

taskId

字符串

最大长度:40

任务 ID。

输出:

{ "taskId": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string", "status": "string", "message": "string", "successCount": "integer", "failureCount": "integer", "percentageProgress": "integer" }

cli 输出字段:

名称

类型

描述

taskId

字符串

最大长度:40

任务 ID。

creationDate

timestamp

任务创建日期。

lastModifiedDate

timestamp

上次修改任务的日期。

templateBody

字符串

任务的模板。

inputFileBucket

字符串

最大长度:256,最小长度:3

模式:[a-zA-Z0-9._-]+

包含输入文件的 S3 存储桶。

inputFileKey

字符串

最大长度:1024,最小长度:1

模式:[a-zA-Z0-9!_.*'()-/]+

输入文件密钥。

roleArn

字符串

最大长度:2048,最小长度:20

授予对输入文件存储桶的访问权限的角色 ARN。

status

字符串

枚举:InProgress | Completed | Failed | Cancelled | Cancelling

java 类:com.amazonaws.iot.common.types.enums.Status

批量事物预配置任务的状态。

message

字符串

最大长度:2048

消息。

successCount

integer

成功预配置的事物数量。

failureCount

integer

预配置失败的事物数量。

percentageProgress

integer

范围 - 最大值:100,最小值:0

以百分比表示的批量预配置任务的进度。

本页内容: