コマンド実行イベント - AWS IoT Core

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

コマンド実行イベント

AWS IoT コマンド実行のステータスが変更されると、 は MQTT トピックにイベントメッセージを発行します。これらのイベントを使用して、コマンド実行の進行状況をモニタリングし、ステータスの変更に対応するアプリケーションを構築できます。

コマンド実行イベントのトピック

コマンド実行イベントは、次の MQTT トピックに発行されます。

$aws/events/commandExecution/commandId/status

コードの説明は以下のとおりです。

  • commandId は コマンドの識別子です。

  • status は、コマンド実行のステータスです。有効な値は、CREATED、IN_PROGRESS、SUCCEEDED、FAILED、REJECTED、TIMED_OUT です。

すべてのコマンドとすべてのステータスの通知を受信するには、ワイルドカード文字を使用して次のトピックにサブスクライブします。

$aws/events/commandExecution/+/#
コマンド実行イベントメッセージ

コマンドの実行ステータスが変更されると、 は対応する MQTT トピックにイベントメッセージ AWS IoT を発行します。メッセージには、次の例のペイロードが含まれています。

{
    "executionId": "2bd65c51-4cfd-49e4-9310-d5cbfdbc8554",
    "status": "FAILED",
    "statusReason": {
        "reasonCode": "DEVICE_TOO_BUSY",
        "reasonDescription": ""
    },
    "eventType": "COMMAND_EXECUTION",
    "commandArn": "arn:aws:iot:us-east-1:123456789012:command/0b9d9ddf-e873-43a9-8e2c-9fe004a90086",
    "targetArn": "arn:aws:iot:us-east-1:123456789012:thing/5006c3fc-de96-4def-8427-7eee36c6f2bd",
    "timestamp": 1717708862107
}

ペイロードには以下の属性が含まれます。

executionId

コマンド実行の一意の識別子 (文字列）。

status

コマンド実行のステータス。有効な値は、CREATED、IN_PROGRESS、SUCCEEDED、FAILED、REJECTED、TIMED_OUT です。

statusReason

利用可能な場合、ステータスに関する追加情報を含むオブジェクト。reasonCode および reasonDescriptionフィールドが含まれます。

eventType

「COMMAND_EXECUTION」に設定します。

commandArn

コマンドの Amazon リソースネーム (ARN)。

targetArn

コマンド実行のターゲットデバイス (モノまたはクライアント) の ARN。

timestamp

イベントが発生したときの UNIX タイムスタンプ。