ジョブデバイス MQTT API オペレーション

特定のモノについて、ターミナル状態にないすべてのジョブのリストを取得します。

この API を呼び出すには、$aws/things/thingName/jobs/get にメッセージを発行します。

リクエストペイロード:

{ "clientToken": "string" }

メッセージブローカーは、特定のサブスクリプションがなくても $aws/things/thingName/jobs/get/accepted および $aws/things/thingName/jobs/get/rejected を発行します。ただし、クライアントがメッセージを受信するには、それらをリッスンしている必要があります。詳細については、[the note about Jobs API messages](Jobs API メッセージに関する注記) を参照してください。

レスポンスペイロード:

{
"inProgressJobs" : [ JobExecutionSummary ... ], 
"queuedJobs" : [ JobExecutionSummary ... ],
"timestamp" : 1489096425069,
"clientToken" : "client-001"
}

ここで、inProgressJobs と queuedJobs は、IN_PROGRESS または QUEUED のステータスを持つ JobExecutionSummary オブジェクトのリストを返します。

モノの次の保留中のジョブ実行を取得し、開始します (ステータスが IN_PROGRESS または QUEUED)。

この API を呼び出すには、$aws/things/thingName/jobs/start-next にメッセージを発行します。

リクエストペイロード:

{ 
"statusDetails": {
    "string": "job-execution-state"
    ...
},
"stepTimeoutInMinutes": long,
"clientToken": "string"
}

メッセージブローカーは、特定のサブスクリプションがなくても $aws/things/thingName/jobs/start-next/accepted および $aws/things/thingName/jobs/start-next/rejected を発行します。ただし、クライアントがメッセージを受信するには、それらをリッスンしている必要があります。詳細については、[the note about Jobs API messages](Jobs API メッセージに関する注記) を参照してください。

レスポンスペイロード:

{
"execution" : JobExecutionData,
"timestamp" : timestamp,
"clientToken" : "string"
}

ここで、execution は JobExecution オブジェクトです。例:

{
"execution" : {
    "jobId" : "022",
    "thingName" : "MyThing",
    "jobDocument" : "< contents of job document >",
    "status" : "IN_PROGRESS",
    "queuedAt" : 1489096123309,
    "lastUpdatedAt" : 1489096123309,
    "versionNumber" : 1,
    "executionNumber" : 1234567890
},
"clientToken" : "client-1",
"timestamp" : 1489088524284,
}

ジョブの実行に関する詳細情報を取得します。

jobId を $next に設定して、モノ (ステータスが IN_PROGRESS または QUEUED のもの) に対して保留中の次のジョブ実行を返すことができます。

この API を呼び出すには、$aws/things/thingName/jobs/jobId/get にメッセージを発行します。

リクエストペイロード:

{ 
"jobId" : "022",
"thingName" : "MyThing",
"executionNumber": long,
"includeJobDocument": boolean,
"clientToken": "string" 
}

メッセージブローカーは、特定のサブスクリプションがなくても $aws/things/thingName/jobs/jobId/get/accepted および $aws/things/thingName/jobs/jobId/get/rejected を発行します。ただし、クライアントがメッセージを受信するには、それらをリッスンしている必要があります。詳細については、[the note about Jobs API messages](Jobs API メッセージに関する注記) を参照してください。

レスポンスペイロード:

{
"execution" : JobExecutionData,
"timestamp": "timestamp",
"clientToken": "string"
}

ここで、execution は JobExecution オブジェクトです。

ジョブ実行のステータスを更新します。オプションで、ステップタイマーを作成するには、stepTimeoutInMinutes プロパティの値を設定します。UpdateJobExecution を再び実行してこのプロパティの値を更新しない場合、ステップタイマーが時間切れになると、ジョブの実行がタイムアウトになります。

この API を呼び出すには、$aws/things/thingName/jobs/jobId/update にメッセージを発行します。

リクエストペイロード:

{
"status": "job-execution-state",
"statusDetails": { 
    "string": "string"
    ...
},
"expectedVersion": "number",
"executionNumber": long,
"includeJobExecutionState": boolean,
"includeJobDocument": boolean,
"stepTimeoutInMinutes": long,
"clientToken": "string"
}

メッセージブローカーは、特定のサブスクリプションがなくても $aws/things/thingName/jobs/jobId/update/accepted および $aws/things/thingName/jobs/jobId/update/rejected を発行します。ただし、クライアントがメッセージを受信するには、それらをリッスンしている必要があります。詳細については、[the note about Jobs API messages](Jobs API メッセージに関する注記) を参照してください。

レスポンスペイロード:

{
"executionState": JobExecutionState,
"jobDocument": "string",
"timestamp": timestamp,
"clientToken": "string"
}

あるジョブの実行中のジョブのリストに､ジョブの実行が追加または削除されるたびに送信されます。

トピックを使用します。

$aws/things/thingName/jobs/notify

メッセージペイロード:

{
"jobs" : {
    "JobExecutionState": [ JobExecutionSummary ... ]
         },
    "timestamp": timestamp
}
                     

DescribeJobExecution に対して jobId $next で定義されている、モノに対する保留されているジョブ実行のリストで、次の順番のジョブに変更があったときに送信されます。このメッセージは、次のジョブの実行の詳細が変更されたときには送信されません。これは､jobId $next とともに DescribeJobExecution で返される次のジョブが変更されたときだけです。ステータスが QUEUED のジョブ実行 J1 と J2 を考えてみましょう。保留中のジョブの実行リストの次に J1 が表示されます。J1 の状態が変更されないまま J2 のステータスが IN_PROGRESS に変更された場合、この通知が送信され、J2 の詳細が含まれます。

トピックを使用します。

$aws/things/thingName/jobs/notify-next

メッセージペイロード:

{
"execution" : JobExecution,
"timestamp": timestamp,
}