:doc:`IoTFleetWise <../../iotfleetwise>` / Client / get_vehicle

***********
get_vehicle
***********



.. py:method:: IoTFleetWise.Client.get_vehicle(**kwargs)

  

  Retrieves information about a vehicle.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotfleetwise-2021-06-17/GetVehicle>`_  


  **Request Syntax**
  ::

    response = client.get_vehicle(
        vehicleName='string'
    )
    
  :type vehicleName: string
  :param vehicleName: **[REQUIRED]** 

    The ID of the vehicle to retrieve information about.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'vehicleName': 'string',
          'arn': 'string',
          'modelManifestArn': 'string',
          'decoderManifestArn': 'string',
          'attributes': {
              'string': 'string'
          },
          'stateTemplates': [
              {
                  'identifier': 'string',
                  'stateTemplateUpdateStrategy': {
                      'periodic': {
                          'stateTemplateUpdateRate': {
                              'unit': 'MILLISECOND'|'SECOND'|'MINUTE'|'HOUR',
                              'value': 123
                          }
                      },
                      'onChange': {}
                  }
              },
          ],
          '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) --* 
    
  
      

      - **stateTemplates** *(list) --* 

        State templates associated with the vehicle.

        
        

        - *(dict) --* 

          The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the Amazon Web Services IoT FleetWise Edge and the Amazon Web Services Cloud.

           

          .. warning::

             

            Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see `Amazon Web Services Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`__ in the *Amazon Web Services IoT FleetWise Developer Guide*.

            

          
          

          - **identifier** *(string) --* 

            The unique ID of the state template.

            
          

          - **stateTemplateUpdateStrategy** *(dict) --* 

            The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an ``onChange`` or ``periodic`` update strategy.

             

            .. warning::

               

              Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see `Amazon Web Services Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`__ in the *Amazon Web Services IoT FleetWise Developer Guide*.

              

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``periodic``, ``onChange``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


          
            

            - **periodic** *(dict) --* 

              Vehicles associated with the state template will stream telemetry data during a specified time period.

              
              

              - **stateTemplateUpdateRate** *(dict) --* 

                The length of time between state template updates.

                
                

                - **unit** *(string) --* 

                  A unit of time.

                  
                

                - **value** *(integer) --* 

                  A number of time units.

                  
            
          
            

            - **onChange** *(dict) --* 

              Vehicles associated with the state template will stream telemetry data when there is a change.

              
          
        
      
    
      

      - **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**
  
  *   :py:class:`IoTFleetWise.Client.exceptions.InternalServerException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTFleetWise.Client.exceptions.AccessDeniedException`

  