IoTFleetWise / Client / batch_create_vehicle

batch_create_vehicle#

IoTFleetWise.Client.batch_create_vehicle(**kwargs)#

Creates 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 Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.batch_create_vehicle(
    vehicles=[
        {
            'vehicleName': 'string',
            'modelManifestArn': 'string',
            'decoderManifestArn': 'string',
            'attributes': {
                'string': 'string'
            },
            'associationBehavior': 'CreateIotThing'|'ValidateIotThingExists',
            'tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

Parameters:

vehicles (list) –

[REQUIRED]

A list of information about each vehicle to create. For more information, see the API data type.

(dict) –

Information about the vehicle to create.
- vehicleName (string) – [REQUIRED]
  
  The unique ID of the vehicle to create.
- modelManifestArn (string) – [REQUIRED]
  
  The ARN of the vehicle model (model manifest) to create the vehicle from.
- decoderManifestArn (string) – [REQUIRED]
  
  The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
- attributes (dict) –
  
  Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"
  - (string) –
    - (string) –
- associationBehavior (string) –
  
  An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
- tags (list) –
  
  Metadata which can be used to manage the vehicle.
  - (dict) –
    
    A set of key/value pairs that are used to manage the resource.
    - Key (string) – [REQUIRED]
      
      The tag’s key.
    - Value (string) – [REQUIRED]
      
      The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'vehicles': [
        {
            'vehicleName': 'string',
            'arn': 'string',
            'thingArn': 'string'
        },
    ],
    'errors': [
        {
            'vehicleName': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

(dict) –
- vehicles (list) –
  
  A list of information about a batch of created vehicles. For more information, see the API data type.
  - (dict) –
    
    Information about a created vehicle.
    - vehicleName (string) –
      
      The unique ID of the vehicle to create.
    - arn (string) –
      
      The ARN of the created vehicle.
    - thingArn (string) –
      
      The ARN of a created or validated Amazon Web Services IoT thing.
- errors (list) –
  
  A list of information about creation errors, or an empty list if there aren’t any errors.
  - (dict) –
    
    An HTTP error resulting from creating a vehicle.
    - vehicleName (string) –
      
      The ID of the vehicle with the error.
    - code (string) –
      
      An HTTP error code.
    - message (string) –
      
      A description of the HTTP error.

Exceptions

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