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

CancelJob

取消任务。

请求语法:

PUT /jobs/jobId/cancel Content-type: application/json { "comment": "string" }

URI 请求参数:

名称

类型

请求?

描述

jobId

JobId

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

请求正文参数:

名称

类型

请求?

说明

comment

评论

一个可选的备注字符串,用于描述为什么取消任务。

响应语法:

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

响应正文参数:

名称

类型

请求?

描述

jobArn

JobArn

任务 ARN。

jobId

JobId

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

description

JobDescription

任务的简短文本描述。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

ThrottlingException

速率超过限制。

HTTP 响应代码:429

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

CLI

摘要:

aws iot cancel-job \ --job-id <value> \ [--comment <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string", "comment": "string" }

cli-input-json 字段:

名称

类型

描述

jobId

字符串

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

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

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

comment

字符串

最大长度:2028

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

一个可选的备注字符串,用于描述为什么取消任务。

输出:

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

cli 输出字段:

名称

类型

描述

jobArn

字符串

任务 ARN。

jobId

字符串

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

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

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

description

字符串

最大长度:2028

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

任务的简短文本描述。

本页内容: