v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457355285.1 KB

Updates a state template.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

post/#X-Amz-Target=IoTAutobahnControlPlane.UpdateStateTemplate

Headers

X-Amz-Target'IoTAutobahnControlPlane.UpdateStateTemplate' required

Request body

identifierstring required

The unique ID of the state template.

descriptionstring

A brief description of the state template.

stateTemplatePropertiesToAddNodePath[]

Add signals from which data is collected as part of the state template.

stateTemplatePropertiesToRemoveNodePath[]

Remove signals from which data is collected as part of the state template.

dataExtraDimensionsNodePath[]
<p>A list of vehicle attributes to associate with the payload published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the <code>extraDimensions</code> field.</p> <p>Default: An empty array</p>
metadataExtraDimensionsNodePath[]

A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic. (See <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/process-visualize-data.html#process-last-known-state-vehicle-data"> Processing last known state vehicle data using MQTT messaging</a>). For example, if you add <code>Vehicle.Attributes.Make</code> and <code>Vehicle.Attributes.Model</code> attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

Response

Success

namestring

The name of the state template.

arnstring

The Amazon Resource Name (ARN) of the state template.

idstring

The unique ID of the state template.