例: コマンドを使用して車両のステアリングモードを制御する (AWS CLI)

ステアリングモードオペレーションのコマンドリソースを作成する

create-command CLI を使用してデバイスに送信するコマンドを作成します。この例では、以下を指定します。

aws iot create-command \ 
    --command-id TurnOffSteeringMode \ 
    --role-arn "arn:aws:iam:accountId:role/FwCommandExecutionRole" \
    --display-name "Turn off steering mode" \ 
    --namespace AWS-IoT-FleetWise \
    --mandatory-parameters '[
      {
        "name": "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode",
        "defaultValue": { "S": "true" }
      }
    ]'

次の出力は、 CLI からのレスポンスの例を示しています。ここで、 ap-south-1と 123456789012は AWS リージョン および AWS アカウント ID の例です。

{
    "commandId": "TurnOffSteeringMode",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode"
}

このコマンドを使用するその他の例については、「」を参照してくださいコマンドリソースを作成する。

コマンドに関する情報を取得する

次のコマンドを実行して、コマンドに関する情報を取得します。ここで、 command-idは、上記の create-commandオペレーションの出力のコマンド ID です。

aws iot get-command --command-id TurnOffSteeringMode

このコマンドを実行すると、次のレスポンスが生成されます。コマンドが作成された時刻と最後に更新された時刻、指定したパラメータ、およびコマンドをデバイスで実行できるかどうかが表示されます。

{
    "commandId": "TurnOffSteeringMode",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode",
    "namespace": "AWS-IoT-FleetWise",
    "mandatoryParameters":[
        {
            "name": "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode",
            "defaultValue": {"S": "true" }
        }
    ],
    "createdAt": "2024-03-23T00:50:10.095000-07:00",
    "lastUpdatedAt": "2024-03-23T00:50:10.095000-07:00",
    "deprecated": false
}

このコマンドを使用するその他の例については、「」を参照してくださいコマンドに関する情報を取得する。

コマンド実行を開始する

次のコマンドを実行してコマンドの実行を開始します。ここで、 command-arnは上からの get-commandオペレーションの出力のコマンド ARN です。target-arn は、 コマンドを実行するターゲットデバイスの ARN です。たとえば、 ですmyVehicle。

この例では、コマンドの作成時にパラメータにデフォルト値を指定しているため、CLI start-command-execution はコマンドの実行時にこれらの値を使用できます。CLI の使用時にパラメータに別の値を指定することで、デフォルト値を上書きすることもできます。

aws iot-data start-command-execution \    
    --command-arn arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode \
    --target-arn arn:aws:iot:ap-south-1:123456789012:thing/myVehicle

このコマンドを実行すると、コマンド実行 ID が返されます。この ID を使用して、コマンド実行ステータス、詳細、およびコマンド実行履歴をクエリできます。

{
    "executionId": "07e4b780-7eca-4ffd-b772-b76358da5542"
}

CLI の使用に関するその他の例については、「」を参照してくださいコマンドを送信する (AWS CLI）。

コマンド実行に関する情報を取得する

次のコマンドを実行して、ターゲットデバイスで実行したコマンドに関する情報を取得します。上からstart-command-execution操作の出力としてexecution-id取得した と、ターゲットとするデバイスの ARN target-arnである を指定します。

aws iot get-command-execution \    
    --execution-id <"07e4b780-7eca-4ffd-b772-b76358da5542"> \ 
    --target-arn arn:aws:iot:us-east-1:<account>:thing/myVehicle

このコマンドを実行すると、コマンドの実行、実行ステータス、実行を開始した時刻、完了時刻に関する情報が返されます。たとえば、次のレスポンスは、ターゲットデバイスでコマンドの実行が成功し、ステアリングモードがオフになったことを示しています。

{
    "executionId": "07e4b780-7eca-4ffd-b772-b76358da5542",
    "commandArn": "arn:aws:iot:ap-south-1:123456789012:command/TurnOffSteeringMode",
    "targetArn": "arn:aws:iot:ap-south-1:123456789012:thing/myVehicle",
    "result": "SUCCEEDED",
     "statusReason": {
        "reasonCode": "65536",
        "reasonDescription": "SUCCESS"
    },
    "result": {
        "KeyName": {
            "S": "",
            "B": true,
            "BIN": null
        }
    },
    "createdAt": "2024-03-23T00:50:10.095000-07:00",
    "completedAt": "2024-03-23T00:50:10.095000-07:00",
    "parameters": '{
         "$actuatorPath.Vehicle.Chassis.SteeringWheel.TurnOffSteeringMode":
         { "S": "true" }
    }' 
}

(オプション) コマンドリソースを非推奨にする

次のコマンドを実行してコマンドを非推奨にします。ここで、 command-idは上記の get-commandオペレーションの出力のコマンド ID です。

aws iot update-command \    
   --command-id TurnOffSteeringMode \    
   --deprecated

このコマンドを実行すると、コマンドが廃止されたことを示す出力が返されます。CLI を使用してコマンドを復元することもできます。

{
    "commandId": "TurnOffSteeringMode",
    "deprecated": true,
    "lastUpdatedAt": "2024-05-09T23:16:51.370000-07:00"
}

コマンドを削除する

次のコマンドを実行して、 で指定された コマンドを削除しますcommand-id。

aws iot delete-command --command-id TurnOffSteeringMode

削除リクエストが成功すると、コマンドを非推奨にしたか、いつ非推奨にしたかに応じて、HTTP statusCodeが 202 または 204 になります。詳細と例については、「コマンドリソースを削除する」を参照してください。

get-command CLI を使用して、コマンドがアカウントから削除されたことを確認できます。

(オプション) コマンド実行を削除する

デフォルトでは、すべてのコマンド実行は、作成日から 6 か月以内に削除されます。この情報は、 GetCommandExecution API の timeToLiveパラメータを使用して表示できます。

または、実行ステータスが 、、または のいずれかである場合などSUCCEEDEDFAILED、コマンド実行がターミナルになった場合はREJECTED、コマンド実行を削除できます。次のコマンドを実行して実行を削除します。ここで、 execution-idは上記の get-command-executionオペレーションの出力の実行 ID です。

aws iot delete-command-execution \ 
            --execution-id "07e4b780-7eca-4ffd-b772-b76358da5542"

get-command-execution CLI を使用して、コマンド実行がアカウントから削除されたことを確認できます。