DescribeTask
デバイス上の指定のタスクのメタデータをチェックします。
リクエストの構文
POST /task/taskId HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- taskId
-
説明するタスクの ID。
長さの制限：最小長は 1 です。最大長は 64 文字です。
必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"completedAt": number,
"createdAt": number,
"description": "string",
"lastUpdatedAt": number,
"state": "string",
"tags": {
"string" : "string"
},
"targets": [ "string" ],
"taskArn": "string",
"taskId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- completedAt
-
タスクが完了した日時。
型: Timestamp
- createdAt
-
CreateTaskオペレーションが呼び出された日時。型: Timestamp
- description
-
タスクおよび管理対象デバイスの説明。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン:
[A-Za-z0-9 _.,!#]* - lastUpdatedAt
-
タスクの状態が最後に更新された日時。
型: Timestamp
- state
-
タスクの現在の状態。
型: 文字列
有効な値:
IN_PROGRESS | CANCELED | COMPLETED -
リソースに割り当てるオプションのメタデータ。タグを使用し、目的、所有者、環境などのさまざまな方法でリソースを分類できます。
型: 文字列間のマッピング
- targets
-
タスクが送信された管理対象デバイス。
型: 文字列の配列
配列メンバー：最小数は 1 項目です。最大数は 10 項目です。
- taskArn
-
タスクの Amazon リソースネーム (ARN)。
型: 文字列
- taskId
-
タスクの ID。
型: 文字列
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- AccessDeniedException
-
このアクションを実行する十分なアクセス権限がありません。
HTTP ステータスコード: 403
- InternalServerException
-
リクエストの処理中に予期しないエラーが発生しました。
HTTP ステータスコード：500
- ResourceNotFoundException
-
リクエストは、存在しないリソースを参照しています。
HTTP ステータスコード: 404
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード: 429
- ValidationException
-
入力が、AWS サービスで指定された制約を満たしていません。
HTTP ステータスコード：400
以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
