CreateTask - AWS Snowball

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

CreateTask

指示一台或多台设备启动任务,例如解锁或重启。

请求语法

POST /task HTTP/1.1 Content-type: application/json { "clientToken": "string", "command": { ... }, "description": "string", "tags": { "string" : "string" }, "targets": [ "string" ] }

URI 请求参数

该请求不使用任何 URI 参数。

请求体

请求接受采用 JSON 格式的以下数据。

clientToken

令牌,可确保使用指定的详细信息仅调用操作一次。

类型:字符串

长度限制:长度下限为 1。长度上限为 64。

模式:[!-~]+

必需:否

command

要执行的任务。每次只对一台设备执行一个任务。

类型:Command 对象

注意:此对象是 Union 类型。只能指定或返回此对象的一个成员。

必需:是

description

任务及其目标的描述。

类型:字符串

长度限制:长度下限为 1。长度上限为 128。

模式:[A-Za-z0-9 _.,!#]*

必需:否

tags

分配给资源的可选元数据。您可以使用标签按不同的方式(如用途、拥有者或环境)对资源进行分类。

类型:字符串到字符串映射

必需:否

targets

托管设备 ID 列表。

类型:字符串数组

数组成员:最少 1 个物品。最多 10 个物品。

必需:是

响应语法

HTTP/1.1 200 Content-type: application/json { "taskArn": "string", "taskId": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

taskArn

您创建的任务的 Amazon 资源名称 (ARN)。

类型:字符串

taskId

您创建的任务的 ID。

类型:字符串

错误

有关所有操作返回的常见错误的信息,请参阅 常见错误

AccessDeniedException

您没有足够的访问权限,无法执行该操作。

HTTP 状态代码:403

InternalServerException

处理请求时出现意外错误。

HTTP 状态代码:500

ResourceNotFoundException

该请求引用的资源不存在。

HTTP 状态代码:404

ServiceQuotaExceededException

该请求会导致超出服务限额。

HTTP 状态代码:402

ThrottlingException

由于请求限制而导致请求被拒绝。

HTTP 状态代码:429

ValidationException

输入未能满足 AWS 服务指定的约束。

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: