DescribeExecution
1つ以上のターゲットデバイスで実行されているリモートタスクのステータスをチェックします。
リクエストの構文
POST /task/taskId
/execution/managedDeviceId
HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- managedDeviceId
-
管理対象デバイスの ID。
長さの制限:最小長は 1 です。最大長は 64 文字です。
必須: はい
- taskId
-
アクションが記述しているタスクの ID。
長さの制限:最小長は 1 です。最大長は 64 文字です。
必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"executionId": "string",
"lastUpdatedAt": number,
"managedDeviceId": "string",
"startedAt": number,
"state": "string",
"taskId": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- executionId
-
実行のID。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
- lastUpdatedAt
-
実行ステータスが最後に更新された日時。
型: Timestamp
- managedDeviceId
-
タスクが実行されている管理対象デバイスの ID。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
- startedAt
-
実行が始まった日時。
型: Timestamp
- state
-
現在の実行の状態。
型: 文字列
有効な値:
QUEUED | IN_PROGRESS | CANCELED | FAILED | SUCCEEDED | REJECTED | TIMED_OUT
- taskId
-
デバイスで実行されているタスクの ID。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
HTTP ステータスコード: 403
- InternalServerException
-
リクエストの処理中に予期しないエラーが発生しました。
HTTP ステータスコード:500
- ResourceNotFoundException
-
リクエストは、存在しないリソースを参照しています。
HTTP ステータスコード: 404
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード: 429
- ValidationException
-
入力が、AWS サービスで指定された制約を満たしていません。
HTTP ステータスコード:400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。