IoTFleetWise / Client / batch_update_vehicle

batch_update_vehicle#

IoTFleetWise.Client.batch_update_vehicle(**kwargs)#

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 Amazon Web Services IoT FleetWise Developer Guide.

Request Syntax

response = client.batch_update_vehicle(
    vehicles=[
        {
            'vehicleName': 'string',
            'modelManifestArn': 'string',
            'decoderManifestArn': 'string',
            'attributes': {
                'string': 'string'
            },
            'attributeUpdateMode': 'Overwrite'|'Merge'
        },
    ]
)

Parameters:

vehicles (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.

Return type:

dict

Returns:

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.
  
  Note
  This list contains only unique IDs for the vehicles that were updated.
  - (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.

Exceptions

IoTFleetWise.Client.exceptions.InternalServerException
IoTFleetWise.Client.exceptions.LimitExceededException
IoTFleetWise.Client.exceptions.ThrottlingException
IoTFleetWise.Client.exceptions.ValidationException
IoTFleetWise.Client.exceptions.AccessDeniedException