Amazonka.IoTFleetWise.Types.VehicleStatus

Documentation

data VehicleStatus

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

See: newVehicleStatus smart constructor.

Constructors

VehicleStatus'

Fields

• campaignName :: Maybe Text

  The name of a campaign.

• status :: Maybe VehicleState

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

  • CREATED - Amazon Web Services 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 - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
• vehicleName :: Maybe Text

  The unique ID of the vehicle.

Instances

FromJSON VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

parseJSON :: Value -> Parser VehicleStatus

parseJSONList :: Value -> Parser [VehicleStatus]

Generic VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Associated Types

type Rep VehicleStatus :: Type -> Type

Methods

from :: VehicleStatus -> Rep VehicleStatus x

to :: Rep VehicleStatus x -> VehicleStatus

Read VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

readsPrec :: Int -> ReadS VehicleStatus

readList :: ReadS [VehicleStatus]

readPrec :: ReadPrec VehicleStatus

readListPrec :: ReadPrec [VehicleStatus]

Show VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

showsPrec :: Int -> VehicleStatus -> ShowS

show :: VehicleStatus -> String

showList :: [VehicleStatus] -> ShowS

NFData VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

rnf :: VehicleStatus -> ()

Eq VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

(==) :: VehicleStatus -> VehicleStatus -> Bool

(/=) :: VehicleStatus -> VehicleStatus -> Bool

Hashable VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

Methods

hashWithSalt :: Int -> VehicleStatus -> Int

hash :: VehicleStatus -> Int

type Rep VehicleStatus

Defined in Amazonka.IoTFleetWise.Types.VehicleStatus

type Rep VehicleStatus = D1 ('MetaData "VehicleStatus" "Amazonka.IoTFleetWise.Types.VehicleStatus" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "VehicleStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "campaignName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VehicleState)) :*: S1 ('MetaSel ('Just "vehicleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newVehicleStatus :: VehicleStatus

Create a value of VehicleStatus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:campaignName:VehicleStatus', vehicleStatus_campaignName - The name of a campaign.

$sel:status:VehicleStatus', vehicleStatus_status - The state of a vehicle, which can be one of the following:

• CREATED - Amazon Web Services 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 - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.

$sel:vehicleName:VehicleStatus', vehicleStatus_vehicleName - The unique ID of the vehicle.

vehicleStatus_campaignName :: Lens' VehicleStatus (Maybe Text)

The name of a campaign.

vehicleStatus_status :: Lens' VehicleStatus (Maybe VehicleState)

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

• CREATED - Amazon Web Services 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 - Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.

vehicleStatus_vehicleName :: Lens' VehicleStatus (Maybe Text)

The unique ID of the vehicle.