2025/04/08 - AWS IoT FleetWise - 2 updated api methods
Changes This release adds the option to update the strategy of state templates already associated to a vehicle, without the need to remove and re-add them.
{'vehicles': {'stateTemplatesToUpdate': [{'identifier': 'string',
'stateTemplateUpdateStrategy': {'onChange': {},
'periodic': {'stateTemplateUpdateRate': {'unit': 'MILLISECOND '
'| '
'SECOND '
'| '
'MINUTE '
'| '
'HOUR',
'value': 'integer'}}}}]}}
Updates a group, or batch, of vehicles.
For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
See also: AWS API Documentation
Request Syntax
client.batch_update_vehicle(
vehicles=[
{
'vehicleName': 'string',
'modelManifestArn': 'string',
'decoderManifestArn': 'string',
'attributes': {
'string': 'string'
},
'attributeUpdateMode': 'Overwrite'|'Merge',
'stateTemplatesToAdd': [
{
'identifier': 'string',
'stateTemplateUpdateStrategy': {
'periodic': {
'stateTemplateUpdateRate': {
'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR',
'value': 123
}
},
'onChange': {}
}
},
],
'stateTemplatesToRemove': [
'string',
],
'stateTemplatesToUpdate': [
{
'identifier': 'string',
'stateTemplateUpdateStrategy': {
'periodic': {
'stateTemplateUpdateRate': {
'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR',
'value': 123
}
},
'onChange': {}
}
},
]
},
]
)
list
[REQUIRED]
A list of information about the vehicles to update. For more information, see the API data type.
(dict) --
Information about the vehicle to update.
vehicleName (string) -- [REQUIRED]
The unique ID of the vehicle to update.
modelManifestArn (string) --
The ARN of the vehicle model (model manifest) associated with the vehicle to update.
decoderManifestArn (string) --
The ARN of the signal decoder manifest associated with the vehicle to update.
attributes (dict) --
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
(string) --
(string) --
attributeUpdateMode (string) --
The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
stateTemplatesToAdd (list) --
Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.
(dict) --
The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.
identifier (string) -- [REQUIRED]
The unique ID of the state template.
stateTemplateUpdateStrategy (dict) -- [REQUIRED]
The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.
periodic (dict) --
Vehicles associated with the state template will stream telemetry data during a specified time period.
stateTemplateUpdateRate (dict) -- [REQUIRED]
The length of time between state template updates.
unit (string) -- [REQUIRED]
A unit of time.
value (integer) -- [REQUIRED]
A number of time units.
onChange (dict) --
Vehicles associated with the state template will stream telemetry data when there is a change.
stateTemplatesToRemove (list) --
Remove existing state template associations from the vehicle.
(string) --
stateTemplatesToUpdate (list) --
Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.
(dict) --
The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.
identifier (string) -- [REQUIRED]
The unique ID of the state template.
stateTemplateUpdateStrategy (dict) -- [REQUIRED]
The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.
periodic (dict) --
Vehicles associated with the state template will stream telemetry data during a specified time period.
stateTemplateUpdateRate (dict) -- [REQUIRED]
The length of time between state template updates.
unit (string) -- [REQUIRED]
A unit of time.
value (integer) -- [REQUIRED]
A number of time units.
onChange (dict) --
Vehicles associated with the state template will stream telemetry data when there is a change.
dict
Response Syntax
{
'vehicles': [
{
'vehicleName': 'string',
'arn': 'string'
},
],
'errors': [
{
'vehicleName': 'string',
'code': 123,
'message': 'string'
},
]
}
Response Structure
(dict) --
vehicles (list) --
A list of information about the batch of updated vehicles.
(dict) --
Information about the updated vehicle.
vehicleName (string) --
The unique ID of the updated vehicle.
arn (string) --
The Amazon Resource Name (ARN) of the updated vehicle.
errors (list) --
A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
(dict) --
An HTTP error resulting from updating the description for a vehicle.
vehicleName (string) --
The ID of the vehicle with the error.
code (integer) --
The relevant HTTP error code (400+).
message (string) --
A message associated with the error.
{'stateTemplatesToUpdate': [{'identifier': 'string',
'stateTemplateUpdateStrategy': {'onChange': {},
'periodic': {'stateTemplateUpdateRate': {'unit': 'MILLISECOND '
'| '
'SECOND '
'| '
'MINUTE '
'| '
'HOUR',
'value': 'integer'}}}}]}
Updates a vehicle.
See also: AWS API Documentation
Request Syntax
client.update_vehicle(
vehicleName='string',
modelManifestArn='string',
decoderManifestArn='string',
attributes={
'string': 'string'
},
attributeUpdateMode='Overwrite'|'Merge',
stateTemplatesToAdd=[
{
'identifier': 'string',
'stateTemplateUpdateStrategy': {
'periodic': {
'stateTemplateUpdateRate': {
'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR',
'value': 123
}
},
'onChange': {}
}
},
],
stateTemplatesToRemove=[
'string',
],
stateTemplatesToUpdate=[
{
'identifier': 'string',
'stateTemplateUpdateStrategy': {
'periodic': {
'stateTemplateUpdateRate': {
'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR',
'value': 123
}
},
'onChange': {}
}
},
]
)
string
[REQUIRED]
The unique ID of the vehicle to update.
string
The ARN of a vehicle model (model manifest) associated with the vehicle.
string
The ARN of the decoder manifest associated with this vehicle.
dict
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
(string) --
(string) --
string
The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
list
Associate state templates with the vehicle.
(dict) --
The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.
identifier (string) -- [REQUIRED]
The unique ID of the state template.
stateTemplateUpdateStrategy (dict) -- [REQUIRED]
The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.
periodic (dict) --
Vehicles associated with the state template will stream telemetry data during a specified time period.
stateTemplateUpdateRate (dict) -- [REQUIRED]
The length of time between state template updates.
unit (string) -- [REQUIRED]
A unit of time.
value (integer) -- [REQUIRED]
A number of time units.
onChange (dict) --
Vehicles associated with the state template will stream telemetry data when there is a change.
list
Remove state templates from the vehicle.
(string) --
list
Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.
(dict) --
The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.
identifier (string) -- [REQUIRED]
The unique ID of the state template.
stateTemplateUpdateStrategy (dict) -- [REQUIRED]
The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an onChange or periodic update strategy.
periodic (dict) --
Vehicles associated with the state template will stream telemetry data during a specified time period.
stateTemplateUpdateRate (dict) -- [REQUIRED]
The length of time between state template updates.
unit (string) -- [REQUIRED]
A unit of time.
value (integer) -- [REQUIRED]
A number of time units.
onChange (dict) --
Vehicles associated with the state template will stream telemetry data when there is a change.
dict
Response Syntax
{
'vehicleName': 'string',
'arn': 'string'
}
Response Structure
(dict) --
vehicleName (string) --
The ID of the updated vehicle.
arn (string) --
The ARN of the updated vehicle.