Skip to content

VehicleStatus

Source code in docs_src/capo_iotfleetwise/types/vehicle_status.py 
13
14
15
16
17
18
19
class VehicleStatus(TypedDict, closed=True):
    campaign_name: NotRequired["capo_iotfleetwise.types.campaign_name.campaignName"]
    """<p>The name of a campaign.</p>"""
    vehicle_name: NotRequired["capo_iotfleetwise.types.vehicle_name.vehicleName"]
    """<p>The unique ID of the vehicle.</p>"""
    status: NotRequired["capo_iotfleetwise.types.vehicle_state.VehicleState"]
    """<p>The status of a campaign, which can be one of the following:</p> <ul> <li> <p> <code>CREATED</code> - The campaign exists but is not yet approved.</p> </li> <li> <p> <code>READY</code> - The campaign is approved but has not been deployed to the vehicle. Data has not arrived at the vehicle yet.</p> </li> <li> <p> <code>HEALTHY</code> - The campaign is deployed to the vehicle.</p> </li> <li> <p> <code>SUSPENDED</code> - The campaign is suspended and data collection is paused.</p> </li> <li> <p> <code>DELETING</code> - The campaign is being removed from the vehicle.</p> </li> <li> <p> <code>READY_FOR_CHECKIN</code> - The campaign is approved and waiting for vehicle check-in before deployment.</p> </li> </ul>"""

campaign_name instance-attribute 

campaign_name: NotRequired[campaignName]

The name of a campaign.

status instance-attribute 

status: NotRequired[VehicleState]

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.

vehicle_name instance-attribute 

vehicle_name: NotRequired[vehicleName]

The unique ID of the vehicle.