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

CreateJob

创建任务。

请求语法:

PUT /jobs/jobId Content-type: application/json { "targets": [ "string" ], "documentSource": "string", "document": "string", "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "targetSelection": "string", "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer" }, "documentParameters": { "string": "string" } }

URI 请求参数:

名称

类型

请求?

描述

jobId

JobId

任务的标识符,必须是您的 AWS 账户的唯一标识符。我们建议使用 UUID。此处可以使用字母数字字符、“-”和“_”。

请求正文参数:

名称

类型

请求?

描述

targets

JobTargets

任务应发送到的事物和事物组的列表。

documentSource

JobDocumentSource

指向任务文档的 S3 链接。

文档

JobDocument

任务文档。

description

JobDescription

任务的简短文本描述。

presignedUrlConfig

PresignedUrlConfig

预签名 S3 URL 的配置信息。

targetSelection

TargetSelection

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig

允许您创建任务的分段部署。

documentParameters

JobDocumentParameters

任务文档的参数。

响应语法:

Content-type: application/json { "jobArn": "string", "jobId": "string", "description": "string" }

响应正文参数:

名称

类型

请求?

描述

jobArn

JobArn

任务 ARN。

jobId

JobId

您分配给此任务的唯一标识符。

description

JobDescription

任务描述。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ResourceAlreadyExistsException

该资源已存在。

HTTP 响应代码:409

LimitExceededException

附加的实体数超过了限制。

HTTP 响应代码:410

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CLI

摘要:

aws iot create-job \ --job-id <value> \ --targets <value> \ [--document-source <value>] \ [--document <value>] \ [--description <value>] \ [--presigned-url-config <value>] \ [--target-selection <value>] \ [--job-executions-rollout-config <value>] \ [--document-parameters <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string", "targets": [ "string" ], "documentSource": "string", "document": "string", "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": "long" }, "targetSelection": "string", "jobExecutionsRolloutConfig": { "maximumPerMinute": "integer" }, "documentParameters": { "string": "string" } }

cli-input-json 字段:

名称

类型

描述

jobId

字符串

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

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

任务的标识符,必须是您的 AWS 账户的唯一标识符。我们建议使用 UUID。此处可以使用字母数字字符、“-”和“_”。

targets

列表

成员:TargetArn

任务应发送到的事物和事物组的列表。

TargetArn

字符串

documentSource

字符串

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

指向任务文档的 S3 链接。

文档

字符串

最大长度:32768

任务文档。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

任务的简短文本描述。

presignedUrlConfig

PresignedUrlConfig

预签名 S3 URL 的配置信息。

roleArn

字符串

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

IAM 角色的 ARN,该角色授予权限以从存储任务数据/更新的 S3 存储桶下载文件。该角色还必须授予 IoT 下载文件的权限。

expiresInSec

long

java 类:java.lang.Long

范围 – 最大值:3600,最小值:60

预签名 URL 的有效时间长度 (以秒为单位)。有效值为 60 – 3600,默认值为 3600 秒。预签名 URL 在 Jobs 接收任务文档的 MQTT 请求时生成。

targetSelection

字符串

枚举:CONTINUOUS | SNAPSHOT

java 类:com.amazonaws.iot.laser.TargetSelection

指定任务将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成任务之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,任务也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行任务,即使是组中原有的全部事物已经完成了任务。

jobExecutionsRolloutConfig

JobExecutionsRolloutConfig

允许您创建任务的分段部署。

maximumPerMinute

integer

java 类:java.lang.Integer

范围 – 最大值:1000,最小值:1

待处理任务每分钟通知事物的最大数量。此参数允许您创建分段部署。

documentParameters

map

键:ParameterKey

值:ParameterValue

任务文档的参数。

ParameterKey

字符串

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

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

ParameterValue

字符串

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

模式:[^\\p{C}]+

输出:

{ "jobArn": "string", "jobId": "string", "description": "string" }

cli 输出字段:

名称

类型

描述

jobArn

字符串

任务 ARN。

jobId

字符串

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

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

您分配给此任务的唯一标识符。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

任务描述。

本页内容: