AWS iot-fleetwise documentation change
Summary
Updated documentation for fetching vehicle state snapshots with console instructions and API references
Security assessment
Added guidance about IAM role permissions for command operations, which relates to access control security practices. No specific vulnerability addressed.
Diff
diff --git a/iot-fleetwise/latest/developerguide/on-demand-operations.md b/iot-fleetwise/latest/developerguide/on-demand-operations.md index 521149f01..b0cf89e59 100644 --- a//iot-fleetwise/latest/developerguide/on-demand-operations.md +++ b//iot-fleetwise/latest/developerguide/on-demand-operations.md @@ -5 +5 @@ -# Fetch a vehicle state snapshot using state templates (AWS CLI) +# Fetch a vehicle state snapshot using state templates @@ -11 +11 @@ Access to certain AWS IoT FleetWise features is currently gated. For more inform -To fetch a state snapshot, first create a command resource. You can then send the following command to the vehicle for which you want to fetch the state snapshot. For more information about using the `CreateCommand` API and its parameters, see [Using the CreateCommand API](./start-stop-data-ingestion.html#start-stop-ingestion-create-command). +You can fetch a vehicle's last known state using the[`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCommand.html) AWS IoT Core control plane API operation or the AWS IoT FleetWise console. @@ -25,0 +26,21 @@ A validation exception can occur in any of the following scenarios: +You can use the AWS IoT FleetWise console to fetch a vehicle's last known state. AWS IoT FleetWise will create a command for you to fetch data. + +###### To fetch a vehicle's state + + 1. Open the [AWS IoT FleetWise console](https://console.aws.amazon.com/iotfleetwise). + + 2. On the navigation pane, choose **Vehicles**. + + 3. Choose a vehicle from the list to open its details page. + + 4. On the **State templates** tab, choose **Fetch data**. + + 5. Select the IAM role that grants AWS IoT FleetWise permissions to send a command and fetch data. See [Controlling access](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/controlling-access.html#generate-command-payload). + + 6. Choose **Fetch state**. + + + + +To fetch a state snapshot, first create a command resource. You can then send the following command to the vehicle for which you want to fetch the state snapshot. For more information about using the `CreateCommand` API and its parameters, see [Using the CreateCommand API](./start-stop-data-ingestion.html#start-stop-ingestion-create-command). + @@ -54 +75 @@ Response: -After the command is created, send the command to the vehicle. If you didn't specify values for the mandatory parameters when you created the command resource, you must specify them now. For more information, see [Send a command](./send-monitor-remote-command-cli.html#send-remote-command-cli). +After the command is created, send the command to the vehicle. If you didn't specify values for the mandatory parameters when you created the command resource, you must specify them now. For more information, see [Send a command (AWS CLI)](./send-monitor-remote-command-cli.html#send-remote-command-cli).