IoTFleetWise / Client / get_vehicle

get_vehicle#

IoTFleetWise.Client.get_vehicle(**kwargs)#

Retrieves information about a vehicle.

Request Syntax

response = client.get_vehicle(
    vehicleName='string'
)

Parameters:

vehicleName (string) –

[REQUIRED]

The ID of the vehicle to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'vehicleName': 'string',
    'arn': 'string',
    'modelManifestArn': 'string',
    'decoderManifestArn': 'string',
    'attributes': {
        'string': 'string'
    },
    'creationTime': datetime(2015, 1, 1),
    'lastModificationTime': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- vehicleName (string) –
  
  The ID of the vehicle.
- arn (string) –
  
  The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
- modelManifestArn (string) –
  
  The ARN of a vehicle model (model manifest) associated with the vehicle.
- decoderManifestArn (string) –
  
  The ARN of a decoder manifest associated with the vehicle.
- attributes (dict) –
  
  Static information about a vehicle in a key-value pair. For example:
  
  "engineType" : "1.3 L R2"
  - (string) –
    - (string) –
- creationTime (datetime) –
  
  The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- lastModificationTime (datetime) –
  
  The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

Exceptions

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