AWS iot-fleetwise documentation change
Summary
Added console-based workflow instructions for command management including IAM role requirements and access control references
Security assessment
The changes add documentation about requiring IAM roles for command payload generation and reference access control documentation. While this relates to security practices, there's no indication of addressing a specific vulnerability. The security documentation addition is about standard security feature usage.
Diff
diff --git a/iot-fleetwise/latest/developerguide/create-manage-remote-command-cli.md b/iot-fleetwise/latest/developerguide/create-manage-remote-command-cli.md index 139a37d39..6dfa0a455 100644 --- a//iot-fleetwise/latest/developerguide/create-manage-remote-command-cli.md +++ b//iot-fleetwise/latest/developerguide/create-manage-remote-command-cli.md @@ -34 +34 @@ This topic shows how you can create and manage a command resource using the AWS -You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCommand.html) AWS IoT Core control plane API operation to create a command resource. The following example uses the AWS CLI. +You can use 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 to create a command. @@ -36 +36,17 @@ You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe -###### Topics +You can use the AWS IoT FleetWise console to create a command. + +###### To create a command + + 1. Open the [AWS IoT FleetWise console](https://console.aws.amazon.com/iotfleetwise). + + 2. On the navigation pane, choose **Commands**. + + 3. Choose **Create command**. + + 4. Specify a unique command ID to help you identify the command that you want to run on the vehicle. + + 5. (Optional) Specify an optional display name and description. + + 6. (Optional) Select the actuator and default parameter value. Parameters specify the actions the target vehicle can perform upon receiving the command. If you don't add parameters, you will need to provide them when running the command. + + 7. Choose an IAM role that grants permissions to generate the payload for commands. See [Controlling access](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/controlling-access.html#generate-command-payload). @@ -38 +54 @@ You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe - * Considerations when creating a command + 8. Choose **Create command**. @@ -40 +55,0 @@ You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe - * Creating a command example @@ -43,0 +59 @@ You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe +The following example shows how to create a command with a parameter. @@ -45 +61 @@ You can use the [`CreateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe -### Considerations when creating a command +#### Considerations when creating a command @@ -60,4 +75,0 @@ When you create a command in AWS IoT FleetWise: -### Creating a command example - -The following example shows how to create a command with a parameter. - @@ -161 +173 @@ The `ListCommands` API operation returns a response that contains the following -You can use the [`UpdateCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCommand.html) AWS IoT Core control plane API operation to update a command resource. You can use the API to either update the display name and description of a command, or to deprecate a command. +You can use the [`UpdateCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCommand.html) AWS IoT Core control plane API operation or AWS IoT FleetWise console to update a command resource. You can update the display name and description of a command. You can also deprecate a command if it's not currently being used. @@ -165 +177,23 @@ You can use the [`UpdateCommand`](https://docs.aws.amazon.com/iot/latest/apirefe -The `UpdateCommand` API can't be used to modify the namespace information or the parameters to be used when executing the command. +You can't modify the namespace information or the parameters to be used when executing the command. + +###### Update a command + +To update a command from the console, go to the [Commands](https://console.aws.amazon.com/iotfleetwise/home#/commands) page of the AWS IoT FleetWise console and perform the following steps. + + 1. Choose the command that you want to update, and then choose **Edit**. + + 2. Edit the command details, and then choose **Save changes**. + + + + +###### Deprecate a command + +To deprecate a command from the console, go to the [Commands](https://console.aws.amazon.com/iotfleetwise/home#/commands) page of the AWS IoT FleetWise console and perform the following steps. + + 1. Choose the command that you want to deprecate, and then choose **Deprecate**. + + 2. Confirm the deprecation, and then choose **Deprecate**. + + + @@ -208 +242 @@ Once a command has been deprecated, existing command executions will continue ru -You can use the [`DeleteCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCommand.html) AWS IoT Core control plane API operation to delete a command resource. +You can use the [`DeleteCommand`](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCommand.html) AWS IoT Core control plane API operation or AWS IoT FleetWise console to delete a command resource. @@ -213,0 +248,9 @@ Deletion actions are permanent and can't be undone. The command will be permanen +To delete a command from the console, go to the [Commands](https://console.aws.amazon.com/iotfleetwise/home#/commands) page of the AWS IoT FleetWise console and perform the following steps. + + 1. Choose the command that you want to delete, and then choose **Delete**. + + 2. Confirm that you want to delete the command, and then choose **Delete**. + + + +