Create an AWS IoT FleetWise state template - AWS IoT FleetWise

Create an AWS IoT FleetWise state template

Important

Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in AWS IoT FleetWise.

You can use the AWS IoT FleetWise API to create a state template. State templates provide a mechanism to track the state of your vehicles. The Edge Agent for AWS IoT FleetWise software that runs on the vehicle collects and sends signal updates to the cloud.

Create a state template (AWS CLI)

Note

For information about quotas for number of templates and signals, see the AWS IoT FleetWise endpoints and quotas documentation.

You can use the CreateStateTemplate API operation to create a state template. The following example uses the AWS CLI.

To create a state template, run the following command.

Replace create-state-template with the name of the .json file that contains the state template configuration.

aws iotfleetwise create-state-template \ --cli-input-json file://create-state-template.json
Example state template configuration

stateTemplateProperties should contain the fully qualified names of the signals.

dataExtraDimensions and metadataExtraDimensions should contain the fully qualified names of the vehicle attributes. The dimensions specified replace any existing dimension values in the state template.

{ "name": "state-template-name", "signalCatalogArn": "arn:aws:iotfleetwise:region:account:signal-catalog/catalog-name", "stateTemplateProperties": [ "Vehicle.Signal.One", "Vehicle.Signal.Two" ], "dataExtraDimensions": [ "Vehicle.Attribute.One", "Vehicle.Attribute.Two" ], "metadataExtraDimensions": [ "Vehicle.Attribute.Three", "Vehicle.Attribute.Four" ] }

Associate an AWS IoT FleetWise state template with a vehicle (AWS CLI)

Associate the created state template with a vehicle to allow the collection of state updates from the vehicle to the cloud. To do this, use: