BatchUpdateVehicle - AWS IoT FleetWise

BatchUpdateVehicle

Updates a group, or batch, of vehicles.

Note

You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle.

For more information, see Update multiple vehicles (AWS CLI) in the AWS IoT FleetWise Developer Guide.

Request Syntax

{ "vehicles": [ { "attributes": { "string" : "string" }, "attributeUpdateMode": "string", "decoderManifestArn": "string", "modelManifestArn": "string", "stateTemplatesToAdd": [ { "identifier": "string", "stateTemplateUpdateStrategy": { ... } } ], "stateTemplatesToRemove": [ "string" ], "stateTemplatesToUpdate": [ { "identifier": "string", "stateTemplateUpdateStrategy": { ... } } ], "vehicleName": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

vehicles

A list of information about the vehicles to update. For more information, see the UpdateVehicleRequestItem API data type.

Type: Array of UpdateVehicleRequestItem objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax

{ "errors": [ { "code": number, "message": "string", "vehicleName": "string" } ], "vehicles": [ { "arn": "string", "vehicleName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

errors

A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.

Type: Array of UpdateVehicleError objects

vehicles

A list of information about the batch of updated vehicles.

Note

This list contains only unique IDs for the vehicles that were updated.

Type: Array of UpdateVehicleResponseItem objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 400

InternalServerException

The request couldn't be completed because the server temporarily failed.

retryAfterSeconds

The number of seconds to wait before retrying the command.

HTTP Status Code: 500

LimitExceededException

A service quota was exceeded.

resourceId

The identifier of the resource that was exceeded.

resourceType

The type of resource that was exceeded.

HTTP Status Code: 400

ThrottlingException

The request couldn't be completed due to throttling.

quotaCode

The quota identifier of the applied throttling rules for this request.

retryAfterSeconds

The number of seconds to wait before retrying the command.

serviceCode

The code for the service that couldn't be completed due to throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList

The list of fields that fail to satisfy the constraints specified by an AWS service.

reason

The reason the input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: