Reserved topics in AWS IoT FleetWise - AWS IoT FleetWise

Reserved topics in AWS IoT FleetWise

Important

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

AWS IoT FleetWise reserves the use of the following topics. If the reserved topic allows, you can subscribe or publish to it. However, you can't create new topics that begin with a dollar sign ($). If you use unsupported publish or subscribe operations with reserved topics, it can result in the connection ending.

Topic Client operation allowed Description

$aws/iotfleetwise/vehicles/vehicleName/checkins

Publish

The Edge Agent software publishes vehicle status information to this topic.

Vehicle status information is exchanged in protocol buffers (Protobuf) format. For more information, see the Edge Agent for AWS IoT FleetWise software Developer Guide.

$aws/iotfleetwise/vehicles/vehicleName/signals

Publish

The Edge Agent software publishes signals to this topic.

Signal information is exchanged in protocol buffers (Protobuf) format. For more information, see the Edge Agent for AWS IoT FleetWise software Developer Guide.

$aws/iotfleetwise/vehicles/vehicleName/collection_schemes

Subscribe

AWS IoT FleetWise publishes data collection schemes to this topic. Vehicles consume these data collection schemes.

$aws/iotfleetwise/vehicles/vehicleName/decoder_manifests

Subscribe

AWS IoT FleetWise publishes decoder manifests to this topic. Vehicles consume these decoder manifests.

$aws/iotfleetwise/vehicles/vehicleName/command/request

Subscribe

AWS IoT FleetWise publishes requests to execute commands to this topic. Vehicles then consume these command requests.

$aws/iotfleetwise/vehicles/vehicleName/command/response

Publish

The Edge Agent software publishes command responses from the vehicle to this topic.

Command responses are exchanged in protocol buffers (Protobuf) format. For more information, see the Edge Agent for AWS IoT FleetWise software Developer Guide.

$aws/iotfleetwise/vehicles/vehicleName/command/notification

Subscribe

AWS IoT FleetWise publishes command status updates to this topic. The notifications are sent in a JSON format.

$aws/iotfleetwise/vehicles/$vehicle_name/last_known_states/config

Subscribe

AWS IoT FleetWise publishes state template configurations to this topic. Vehicles consume these state template configurations.

$aws/iotfleetwise/vehicles/$vehicle_name/last_known_states/data

Publish

The Edge Agent software publishes data collected from the signals to this topic.

$aws/iotfleetwise/vehicles/$vehicle_name/last_known_state/$state_template_name/data

Subscribe

AWS IoT FleetWise publishes data collected from the signals configured in the specified $state_template_name to this topic. The updates can be partial. For example, if a state template association contains multiple signals with the on-change update strategy, then only the signals that have changed are contained in a given message.

Signal information is exchanged in protocol buffers (Protobuf) format. For more information, see the Edge Agent for AWS IoT FleetWise software Developer Guide.