Update a signal catalog (AWS CLI) - AWS IoT FleetWise

Update a signal catalog (AWS CLI)

AWS IoT FleetWise is in preview release and is subject to change. We recommend that you use the service only with test data, and not in production environments.

While AWS IoT FleetWise is in preview, you must download the preview AWS SDK and AWS CLI to use the API operations for this service. These API operations aren't available in the public AWS SDK or AWS CLI. For more information, see Preview AWS CLI and AWS SDKs.

You can use the UpdateSignalCatalog API operation to update an existing signal catalog. The following example uses AWS CLI.

To update an existing signal catalog, run the following command.

Replace signal-catalog-configuration with the name of the JSON file that contains the configuration.

aws iotfleetwise update-signal-catalog --cli-input-json file://signal-catalog-configuration.json
  • Replace signal-catalog-name with the name of the signal catalog that you're updating.

  • (Optional) Replace description with a description to help you identify the signal catalog.

For more information about how to configure branches, attributes, sensors, and actuators, see Configure signals.

{ "name": "signal-catalog-name", "description": "description", "nodesToAdd": [ { "branch": { "fullyQualifiedName": "Vehicle", "name": "Vehicle" }, "type": "branch" }, { "branch": { "description": "Powertrain data for battery management.", "fullyQualifiedName": "Vehicle.Powertrain", "name": "Powertrain" }, "type": "branch" } ], "nodesToRemove": [ { "branch": { "description": "Transmission-specific data, stopping at the drive shafts.", "fullyQualifiedName": "Vehicle.Powertrain.Transmission", "name": "Transmission" }, "type": "branch" } ], "nodesToUpdate": [ { "sensor": { "dataType": "float", "description": "Vehicle_Odometer", "fullyQualifiedName": "Vehicle.Powertrain.Transmission.VehicleOdometer", "max": 67108863.984375, "min": 0, "name": "VehicleOdometer", "unit": "km" }, "type": "sensor" }, { "branch": { "description": "All data concerning steering, suspension, wheels, and brakes.", "fullyQualifiedName": "Vehicle.Chassis", "name": "Chassis" }, "type": "branch" }, { "branch": { "description": "Steering wheel signals.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel", "name": "SteeringWheel" }, "type": "branch" }, { "attribute": { "dataType": "float", "description": "The diameter of the steering wheel.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel.Diameter", "max": 50, "min": 1, "name": "string", "unit": "cm" }, "type": "attribute" }, { "actuator": { "dataType": "boolean", "description": "Hands Off Steering State.", "fullyQualifiedName": "Vehicle.Chassis.SteeringWheel.HandsOff.HandsOffSteeringState", "name": "HandsOffSteeringState" }, "type": "sensor" } ] }