VehicleStatus - AWS IoT FleetWise
ContentsSee Also

VehicleStatus

Information about the state of a vehicle and how it relates to the status of a campaign.

Contents

campaignName

The name of a campaign.

Type: String

Required: No

status

The state of a vehicle, which can be one of the following:

  • CREATED - AWS IoT FleetWise sucessfully created the vehicle.

  • READY - The vehicle is ready to receive a campaign deployment.

  • HEALTHY - A campaign deployment was delivered to the vehicle.

  • SUSPENDED - A campaign associated with the vehicle was suspended and data collection was paused.

  • DELETING - AWS IoT FleetWise is removing a campaign from the vehicle.

Type: String

Valid Values: CREATED | READY | HEALTHY | SUSPENDED | DELETING

Required: No

vehicleName

The unique ID of the vehicle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z\d\-_:]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: