vehicle_status

Creates, updates, deletes, gets or lists a vehicle_status resource.

Overview

Name	vehicle_status
Type	Resource
Id	aws.iotfleetwise.vehicle_status

Fields

The following fields are returned by SELECT queries:

get_vehicle_status

Name	Datatype	Description
campaign_name	string	The name of a campaign. (pattern: <code>[a-zA-Z\d-_:]+</code>)
status	string	The status of a campaign, which can be one of the following: CREATED - The campaign exists but is not yet approved. READY - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet. HEALTHY - The campaign is deployed to the vehicle. SUSPENDED - The campaign is suspended and data collection is paused. DELETING - The campaign is being removed from the vehicle. READY_FOR_CHECKIN - The campaign is approved and waiting for vehicle check-in before deployment. (CREATED, READY, HEALTHY, SUSPENDED, DELETING, READY_FOR_CHECKIN)
vehicle_name	string	The unique ID of the vehicle. (pattern: <code>[a-zA-Z\d-_:]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_vehicle_status	select	region		Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_vehicle_status

Retrieves information about the status of campaigns, decoder manifests, or state templates associated with a vehicle.

SELECT
campaign_name,
status,
vehicle_name
FROM aws.iotfleetwise.vehicle_status
WHERE region = '{{ region }}' -- required
;