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

UpdateJobExecution

更新任务执行的状态。

请求语法:

POST /things/thingName/jobs/jobId Content-type: application/json { "status": "string", "statusDetails": { "string": "string" }, "expectedVersion": "long", "includeJobExecutionState": "boolean", "includeJobDocument": "boolean", "executionNumber": "long" }

URI 请求参数:

名称

类型

请求?

描述

jobId

JobId

创建此任务时向其分配的唯一标识符。

thingName

ThingName

与设备关联的事物的名称。

请求正文参数:

名称

类型

请求?

描述

status

JobExecutionStatus

任务执行的新状态 (IN_PROGRESS、FAILED、SUCCESS 或 REJECTED)。这必须在每次更新时指定。

statusDetails

DetailsMap

可选。描述任务执行状态的名称/值对的集合。如果未指定,则 statusDetails 保持不变。

expectedVersion

ExpectedVersion

可选。任务执行的预期当前版本。每次更新任务执行时,其版本将递增。如果存储在 Jobs 中的任务执行版本不匹配,则更新将被拒绝并出现 VersionMismatch 错误,并且将返回包含当前任务执行状态数据的 ErrorResponse。(这样就不再需要执行单独的 DescribeJobExecution 请求来获取任务执行状态数据。)

includeJobExecutionState

IncludeExecutionState

可选。包括此项并设置为 true 时,响应将包含 JobExecutionState 数据。默认为 false。

includeJobDocument

IncludeJobDocument

可选。设置为 true 时,响应将包含任务文档。默认为 false。

executionNumber

ExecutionNumber

可选。标识特定设备上的特定任务执行的数字。

响应语法:

Content-type: application/json { "executionState": { "status": "string", "statusDetails": { "string": "string" }, "versionNumber": "long" }, "jobDocument": "string" }

响应正文参数:

名称

类型

请求?

描述

executionState

JobExecutionState

JobExecutionState 对象。

jobDocument

JobDocument

任务文档的内容。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CertificateValidationException

证书无效。

HTTP 响应代码:400

InvalidStateTransitionException

更新尝试将任务执行更改为某个状态,但该状态由于任务执行的当前状态而无效 (例如,尝试将处于 SUCCESS 状态的请求更改为 IN_PROGRESS 状态)。在这种情况下,错误消息的正文还包含 executionState 字段。

HTTP 响应代码:409

CLI

摘要:

aws iot-jobs-data update-job-execution \ --job-id <value> \ --thing-name <value> \ --status <value> \ [--status-details <value>] \ [--expected-version <value>] \ [--include-job-execution-state | --no-include-job-execution-state] \ [--include-job-document | --no-include-job-document] \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string", "thingName": "string", "status": "string", "statusDetails": { "string": "string" }, "expectedVersion": "long", "includeJobExecutionState": "boolean", "includeJobDocument": "boolean", "executionNumber": "long" }

cli-input-json 字段:

名称

类型

描述

jobId

字符串

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

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

创建此任务时向其分配的唯一标识符。

thingName

字符串

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

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

与设备关联的事物的名称。

status

字符串

枚举:QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | REJECTED | REMOVED | CANCELED

java 类:com.amazonaws.iot.laser.common.JobExecutionStatus

任务执行的新状态 (IN_PROGRESS、FAILED、SUCCESS 或 REJECTED)。这必须在每次更新时指定。

statusDetails

map

键:DetailsKey

值:DetailsValue

可选。描述任务执行状态的名称/值对的集合。如果未指定,则 statusDetails 保持不变。

DetailsKey

字符串

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

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

DetailsValue

字符串

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

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

expectedVersion

long

java 类:java.lang.Long

可选。任务执行的预期当前版本。每次更新任务执行时,其版本将递增。如果存储在 Jobs 中的任务执行版本不匹配,则更新将被拒绝并出现 VersionMismatch 错误,并且将返回包含当前任务执行状态数据的 ErrorResponse。(这样就不再需要执行单独的 DescribeJobExecution 请求来获取任务执行状态数据。)

includeJobExecutionState

布尔值

java 类:java.lang.Boolean

可选。包括此项并设置为 true 时,响应将包含 JobExecutionState 数据。默认为 false。

includeJobDocument

布尔值

java 类:java.lang.Boolean

可选。设置为 true 时,响应将包含任务文档。默认为 false。

executionNumber

long

java 类:java.lang.Long

可选。标识特定设备上的特定任务执行的数字。

输出:

{ "executionState": { "status": "string", "statusDetails": { "string": "string" }, "versionNumber": "long" }, "jobDocument": "string" }

cli 输出字段:

名称

类型

描述

executionState

JobExecutionState

JobExecutionState 对象。

status

字符串

枚举:QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | REJECTED | REMOVED | CANCELED

java 类:com.amazonaws.iot.laser.common.JobExecutionStatus

任务执行的状态。可以为以下值之一:“QUEUED"、“IN_PROGRESS”、“FAILED”、“SUCCESS”、“CANCELED”、“REJECTED”或“REMOVED”。

statusDetails

map

键:DetailsKey

值:DetailsValue

描述任务执行状态的名称/值对的集合。

DetailsKey

字符串

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

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

DetailsValue

字符串

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

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

versionNumber

long

任务执行的版本。每次设备更新任务执行版本时,版本将递增。

jobDocument

字符串

最大长度:32768

任务文档的内容。

本页内容: