翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# ジョブデバイス MQTT API
デバイスは、ポート 443 の HTTP 署名バージョン 4 を使用して AWS IoT ジョブと通信できます。これは、 AWS SDKs と CLI で使用される方法です。これらのツールの詳細については、「[AWS CLI コマンドリファレンス: iot-jobs-data](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/index.html)」または「[AWS SDK とツール](https://aws.amazon.com/tools/#sdk)」を参照してください。
ジョブを実行するデバイスでは、次のコマンドを使用できます。MQTT プロトコルでの API オペレーションの使用方法については、「[ジョブデバイス MQTT API オペレーション](jobs-mqtt-api.md)」を参照してください。
## GetPendingJobExecutions
特定のモノについて、ターミナル状態にないすべてのジョブのリストを取得します。
------
#### [ HTTPS request ]
```
GET /things/thingName/jobs
```
レスポンス:
```
{
"inProgressJobs" : [ JobExecutionSummary ... ],
"queuedJobs" : [ JobExecutionSummary ... ]
}
```
詳細については、「[https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_GetPendingJobExecutions.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_GetPendingJobExecutions.html)」を参照してください。
------
#### [ CLI syntax ]
```
aws iot-jobs-data get-pending-job-executions \
--thing-name \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
`cli-input-json` 形式:
```
{
"thingName": "string"
}
```
詳細については、「[https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/get-pending-job-executions.html](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/get-pending-job-executions.html)」を参照してください。
------
## StartNextPendingJobExecution
モノ (ステータスが `IN_PROGRESS` または `QUEUED` のもの) に対する次の保留中のジョブ実行を取得し、開始します。
+ ステータスが `IN_PROGRESS` のジョブの実行が最初に返されます。
+ ジョブの実行は、作成された順に返されます。
+ 次の保留中のジョブの実行が `QUEUED` の場合、そのステータスは `IN_PROGRESS` に変更され、ジョブの実行のステータスの詳細は指定どおりに設定されます。
+ 次の保留中のジョブの実行がすでに `IN_PROGRESS` である場合、そのステータスの詳細は変更されません。
+ 保留中のジョブの実行がない場合、レスポンスに `execution` フィールドは含まれません。
+ オプションで、`stepTimeoutInMinutes` プロパティの値を設定してステップタイマーを作成できます。`UpdateJobExecution` を実行してこのプロパティの値を更新しない場合、ステップタイマーが時間切れになると、ジョブの実行がタイムアウトになります。
------
#### [ HTTPS request ]
以下に構文例を示します。
```
PUT /things/thingName/jobs/$next
{
"statusDetails": {
"string": "string"
...
},
"stepTimeoutInMinutes": long
}
```
詳細については、「[https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_StartNextPendingJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_StartNextPendingJobExecution.html)」を参照してください。
------
#### [ CLI syntax ]
**概要:**
```
aws iot-jobs-data start-next-pending-job-execution \
--thing-name \
{--step-timeout-in-minutes ] \
[--status-details ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
`cli-input-json` 形式:
```
{
"thingName": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": long
}
```
詳細については、「[https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/start-next-pending-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-jobs-data/start-next-pending-job-execution.html)」を参照してください。
------
## DescribeJobExecution
ジョブの実行に関する詳細情報を取得します。
`jobId` を `$next` に設定して、モノに対して保留中の次のジョブ実行を返すことができます。ジョブの実行ステータスは、`QUEUED` または `IN_PROGRESS` である必要があります。
------
#### [ HTTPS request ]
リクエスト:
```
GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument
```
レスポンス:
```
{
"execution" : JobExecution,
}
```
詳細については、「[https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_DescribeJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_DescribeJobExecution.html)」を参照してください。
------
#### [ CLI syntax ]
**概要:**
```
aws iot-jobs-data describe-job-execution \
--job-id \
--thing-name \
[--include-job-document | --no-include-job-document] \
[--execution-number ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
`cli-input-json` 形式:
```
{
"jobId": "string",
"thingName": "string",
"includeJobDocument": boolean,
"executionNumber": long
}
```
詳細については、「[https://docs.aws.amazon.com/cli/latest/reference/iot-data/describe-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-data/describe-job-execution.html)」を参照してください。
------
## UpdateJobExecution
ジョブ実行のステータスを更新します。オプションで、`stepTimeoutInMinutes` プロパティの値を設定してステップタイマーを作成できます。`UpdateJobExecution` を再び実行してこのプロパティの値を更新しない場合、ステップタイマーが時間切れになると、ジョブの実行がタイムアウトになります。
------
#### [ HTTPS request ]
リクエスト:
```
POST /things/thingName/jobs/jobId
{
"status": "job-execution-state",
"statusDetails": {
"string": "string"
...
},
"expectedVersion": "number",
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"executionNumber": long
}
```
詳細については、「[https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_UpdateJobExecution.html](https://docs.aws.amazon.com/iot/latest/apireference/API_iot-jobs-data_UpdateJobExecution.html)」を参照してください。
------
#### [ CLI syntax ]
**概要:**
```
aws iot-jobs-data update-job-execution \
--job-id \
--thing-name \
--status \
[--status-details ] \
[--expected-version ] \
[--include-job-execution-state | --no-include-job-execution-state] \
[--include-job-document | --no-include-job-document] \
[--execution-number ] \
[--cli-input-json ] \
[--step-timeout-in-minutes ] \
[--generate-cli-skeleton]
```
`cli-input-json` 形式:
```
{
"jobId": "string",
"thingName": "string",
"status": "string",
"statusDetails": {
"string": "string"
},
"stepTimeoutInMinutes": number,
"expectedVersion": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"executionNumber": long
}
```
詳細については、「[https://docs.aws.amazon.com/cli/latest/reference/iot-data/update-job-execution.html](https://docs.aws.amazon.com/cli/latest/reference/iot-data/update-job-execution.html)」を参照してください。
------