AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

StartThingRegistrationTask

StartThingRegistrationTask

创建批量事物预配置任务。

https

请求语法:

POST /thing-registration-tasks Content-type: application/json { "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string" }

请求正文参数:

名称

类型

请求?

描述

templateBody

TemplateBody

预配置模板。

inputFileBucket

RegistryS3BucketName

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

inputFileKey

RegistryS3KeyName

S3 存储桶中输入文件的名称。此文件包含以换行符分隔的 JSON 文件。每一行包含用于预配置一个设备 (事物) 的参数值。

roleArn

RoleArn

授予输入文件权限的 IAM 角色 ARN。

响应语法:

Content-type: application/json { "taskId": "string" }

响应正文参数:

名称

类型

请求?

描述

taskId

TaskId

批量事物预配置任务 ID。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

InternalFailureException

出现意外错误。

HTTP 响应代码:500

cli

摘要:

aws iot start-thing-registration-task \ --template-body <value> \ --input-file-bucket <value> \ --input-file-key <value> \ --role-arn <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "templateBody": "string", "inputFileBucket": "string", "inputFileKey": "string", "roleArn": "string" }

cli-input-json 字段:

名称

类型

描述

templateBody

字符串

预配置模板。

inputFileBucket

字符串

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

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

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

inputFileKey

字符串

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

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

S3 存储桶中输入文件的名称。此文件包含以换行符分隔的 JSON 文件。每一行包含用于预配置一个设备 (事物) 的参数值。

roleArn

字符串

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

授予输入文件权限的 IAM 角色 ARN。

输出:

{ "taskId": "string" }

cli 输出字段:

名称

类型

描述

taskId

字符串

最大长度:40

批量事物预配置任务 ID。

错误:

InvalidRequestException

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

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

InternalFailureException

出现意外错误。