Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateVehicle

Updates a vehicle.

Important

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

Request Syntax


{
   "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.

attributes

Static information about a vehicle in a key-value pair. For example:

"engineType" : "1.3 L R2"

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 150.

Key Pattern: [a-zA-Z0-9_.-]+

Required: No

attributeUpdateMode

The method the specified attributes will update the existing attributes on the vehicle. UseOverwite 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.

Type: String

Valid Values: Overwrite | Merge

Required: No

decoderManifestArn

The ARN of the decoder manifest associated with this vehicle.

Type: String

Required: No

modelManifestArn

The ARN of a vehicle model (model manifest) associated with the vehicle.

Type: String

Required: No

stateTemplatesToAdd

Associate state templates with the vehicle.

Type: Array of StateTemplateAssociation objects

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

Required: No

stateTemplatesToRemove

Remove state templates from the vehicle.

Type: Array of strings

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: No

stateTemplatesToUpdate

Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.

Type: Array of StateTemplateAssociation objects

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

Required: No

vehicleName

The unique ID of the vehicle to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: Yes

Response Syntax


{
   "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.

arn

The ARN of the updated vehicle.

Type: String

vehicleName

The ID of the updated vehicle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

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

ConflictException

The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resource: The resource on which there are conflicting operations.
resourceType: The type of resource on which there are conflicting operations..

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

ResourceNotFoundException

The resource wasn't found.

resourceId: The identifier of the resource that wasn't found.
resourceType: The type of resource that wasn't found.

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