| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoTFleetWise.Types
Contents
- Service Configuration
- Errors
- CampaignStatus
- Compression
- DiagnosticsMode
- LogType
- ManifestStatus
- NetworkInterfaceType
- NodeDataType
- RegistrationStatus
- SignalDecoderType
- SpoolingMode
- TriggerMode
- UpdateCampaignAction
- UpdateMode
- VehicleAssociationBehavior
- VehicleState
- Actuator
- Attribute
- Branch
- CampaignSummary
- CanDbcDefinition
- CanInterface
- CanSignal
- CloudWatchLogDeliveryOptions
- CollectionScheme
- ConditionBasedCollectionScheme
- CreateVehicleError
- CreateVehicleRequestItem
- CreateVehicleResponseItem
- DecoderManifestSummary
- FleetSummary
- FormattedVss
- IamRegistrationResponse
- IamResources
- ModelManifestSummary
- NetworkFileDefinition
- NetworkInterface
- Node
- NodeCounts
- ObdInterface
- ObdSignal
- Sensor
- SignalCatalogSummary
- SignalDecoder
- SignalInformation
- Tag
- TimeBasedCollectionScheme
- TimestreamRegistrationResponse
- TimestreamResources
- UpdateVehicleError
- UpdateVehicleRequestItem
- UpdateVehicleResponseItem
- VehicleStatus
- VehicleSummary
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _DecoderManifestValidationException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _InvalidNodeException :: AsError a => Fold a ServiceError
- _InvalidSignalsException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newtype CampaignStatus where
- CampaignStatus' { }
- pattern CampaignStatus_CREATING :: CampaignStatus
- pattern CampaignStatus_RUNNING :: CampaignStatus
- pattern CampaignStatus_SUSPENDED :: CampaignStatus
- pattern CampaignStatus_WAITING_FOR_APPROVAL :: CampaignStatus
- newtype Compression where
- Compression' { }
- pattern Compression_OFF :: Compression
- pattern Compression_SNAPPY :: Compression
- newtype DiagnosticsMode where
- DiagnosticsMode' { }
- pattern DiagnosticsMode_OFF :: DiagnosticsMode
- pattern DiagnosticsMode_SEND_ACTIVE_DTCS :: DiagnosticsMode
- newtype LogType where
- LogType' {
- fromLogType :: Text
- pattern LogType_ERROR :: LogType
- pattern LogType_OFF :: LogType
- LogType' {
- newtype ManifestStatus where
- ManifestStatus' { }
- pattern ManifestStatus_ACTIVE :: ManifestStatus
- pattern ManifestStatus_DRAFT :: ManifestStatus
- newtype NetworkInterfaceType where
- newtype NodeDataType where
- NodeDataType' { }
- pattern NodeDataType_BOOLEAN :: NodeDataType
- pattern NodeDataType_BOOLEAN_ARRAY :: NodeDataType
- pattern NodeDataType_DOUBLE :: NodeDataType
- pattern NodeDataType_DOUBLE_ARRAY :: NodeDataType
- pattern NodeDataType_FLOAT :: NodeDataType
- pattern NodeDataType_FLOAT_ARRAY :: NodeDataType
- pattern NodeDataType_INT16 :: NodeDataType
- pattern NodeDataType_INT16_ARRAY :: NodeDataType
- pattern NodeDataType_INT32 :: NodeDataType
- pattern NodeDataType_INT32_ARRAY :: NodeDataType
- pattern NodeDataType_INT64 :: NodeDataType
- pattern NodeDataType_INT64_ARRAY :: NodeDataType
- pattern NodeDataType_INT8 :: NodeDataType
- pattern NodeDataType_INT8_ARRAY :: NodeDataType
- pattern NodeDataType_STRING :: NodeDataType
- pattern NodeDataType_STRING_ARRAY :: NodeDataType
- pattern NodeDataType_UINT16 :: NodeDataType
- pattern NodeDataType_UINT16_ARRAY :: NodeDataType
- pattern NodeDataType_UINT32 :: NodeDataType
- pattern NodeDataType_UINT32_ARRAY :: NodeDataType
- pattern NodeDataType_UINT64 :: NodeDataType
- pattern NodeDataType_UINT64_ARRAY :: NodeDataType
- pattern NodeDataType_UINT8 :: NodeDataType
- pattern NodeDataType_UINT8_ARRAY :: NodeDataType
- pattern NodeDataType_UNIX_TIMESTAMP :: NodeDataType
- pattern NodeDataType_UNIX_TIMESTAMP_ARRAY :: NodeDataType
- pattern NodeDataType_UNKNOWN :: NodeDataType
- newtype RegistrationStatus where
- newtype SignalDecoderType where
- newtype SpoolingMode where
- SpoolingMode' { }
- pattern SpoolingMode_OFF :: SpoolingMode
- pattern SpoolingMode_TO_DISK :: SpoolingMode
- newtype TriggerMode where
- TriggerMode' { }
- pattern TriggerMode_ALWAYS :: TriggerMode
- pattern TriggerMode_RISING_EDGE :: TriggerMode
- newtype UpdateCampaignAction where
- newtype UpdateMode where
- UpdateMode' { }
- pattern UpdateMode_Merge :: UpdateMode
- pattern UpdateMode_Overwrite :: UpdateMode
- newtype VehicleAssociationBehavior where
- newtype VehicleState where
- VehicleState' { }
- pattern VehicleState_CREATED :: VehicleState
- pattern VehicleState_DELETING :: VehicleState
- pattern VehicleState_HEALTHY :: VehicleState
- pattern VehicleState_READY :: VehicleState
- pattern VehicleState_SUSPENDED :: VehicleState
- data Actuator = Actuator' {
- allowedValues :: Maybe [Text]
- assignedValue :: Maybe Text
- description :: Maybe Text
- max :: Maybe Double
- min :: Maybe Double
- unit :: Maybe Text
- fullyQualifiedName :: Text
- dataType :: NodeDataType
- newActuator :: Text -> NodeDataType -> Actuator
- actuator_allowedValues :: Lens' Actuator (Maybe [Text])
- actuator_assignedValue :: Lens' Actuator (Maybe Text)
- actuator_description :: Lens' Actuator (Maybe Text)
- actuator_max :: Lens' Actuator (Maybe Double)
- actuator_min :: Lens' Actuator (Maybe Double)
- actuator_unit :: Lens' Actuator (Maybe Text)
- actuator_fullyQualifiedName :: Lens' Actuator Text
- actuator_dataType :: Lens' Actuator NodeDataType
- data Attribute = Attribute' {
- allowedValues :: Maybe [Text]
- assignedValue :: Maybe Text
- defaultValue :: Maybe Text
- description :: Maybe Text
- max :: Maybe Double
- min :: Maybe Double
- unit :: Maybe Text
- fullyQualifiedName :: Text
- dataType :: NodeDataType
- newAttribute :: Text -> NodeDataType -> Attribute
- attribute_allowedValues :: Lens' Attribute (Maybe [Text])
- attribute_assignedValue :: Lens' Attribute (Maybe Text)
- attribute_defaultValue :: Lens' Attribute (Maybe Text)
- attribute_description :: Lens' Attribute (Maybe Text)
- attribute_max :: Lens' Attribute (Maybe Double)
- attribute_min :: Lens' Attribute (Maybe Double)
- attribute_unit :: Lens' Attribute (Maybe Text)
- attribute_fullyQualifiedName :: Lens' Attribute Text
- attribute_dataType :: Lens' Attribute NodeDataType
- data Branch = Branch' {}
- newBranch :: Text -> Branch
- branch_description :: Lens' Branch (Maybe Text)
- branch_fullyQualifiedName :: Lens' Branch Text
- data CampaignSummary = CampaignSummary' {}
- newCampaignSummary :: UTCTime -> UTCTime -> CampaignSummary
- campaignSummary_arn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_description :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_name :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus)
- campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text)
- campaignSummary_creationTime :: Lens' CampaignSummary UTCTime
- campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime
- data CanDbcDefinition = CanDbcDefinition' {}
- newCanDbcDefinition :: Text -> NonEmpty ByteString -> CanDbcDefinition
- canDbcDefinition_signalsMap :: Lens' CanDbcDefinition (Maybe (HashMap Text Text))
- canDbcDefinition_networkInterface :: Lens' CanDbcDefinition Text
- canDbcDefinition_canDbcFiles :: Lens' CanDbcDefinition (NonEmpty ByteString)
- data CanInterface = CanInterface' {
- protocolName :: Maybe Text
- protocolVersion :: Maybe Text
- name :: Text
- newCanInterface :: Text -> CanInterface
- canInterface_protocolName :: Lens' CanInterface (Maybe Text)
- canInterface_protocolVersion :: Lens' CanInterface (Maybe Text)
- canInterface_name :: Lens' CanInterface Text
- data CanSignal = CanSignal' {}
- newCanSignal :: Natural -> Bool -> Bool -> Natural -> Double -> Double -> Natural -> CanSignal
- canSignal_name :: Lens' CanSignal (Maybe Text)
- canSignal_messageId :: Lens' CanSignal Natural
- canSignal_isBigEndian :: Lens' CanSignal Bool
- canSignal_isSigned :: Lens' CanSignal Bool
- canSignal_startBit :: Lens' CanSignal Natural
- canSignal_offset :: Lens' CanSignal Double
- canSignal_factor :: Lens' CanSignal Double
- canSignal_length :: Lens' CanSignal Natural
- data CloudWatchLogDeliveryOptions = CloudWatchLogDeliveryOptions' {
- logGroupName :: Maybe Text
- logType :: LogType
- newCloudWatchLogDeliveryOptions :: LogType -> CloudWatchLogDeliveryOptions
- cloudWatchLogDeliveryOptions_logGroupName :: Lens' CloudWatchLogDeliveryOptions (Maybe Text)
- cloudWatchLogDeliveryOptions_logType :: Lens' CloudWatchLogDeliveryOptions LogType
- data CollectionScheme = CollectionScheme' {}
- newCollectionScheme :: CollectionScheme
- collectionScheme_conditionBasedCollectionScheme :: Lens' CollectionScheme (Maybe ConditionBasedCollectionScheme)
- collectionScheme_timeBasedCollectionScheme :: Lens' CollectionScheme (Maybe TimeBasedCollectionScheme)
- data ConditionBasedCollectionScheme = ConditionBasedCollectionScheme' {}
- newConditionBasedCollectionScheme :: Text -> ConditionBasedCollectionScheme
- conditionBasedCollectionScheme_conditionLanguageVersion :: Lens' ConditionBasedCollectionScheme (Maybe Natural)
- conditionBasedCollectionScheme_minimumTriggerIntervalMs :: Lens' ConditionBasedCollectionScheme (Maybe Natural)
- conditionBasedCollectionScheme_triggerMode :: Lens' ConditionBasedCollectionScheme (Maybe TriggerMode)
- conditionBasedCollectionScheme_expression :: Lens' ConditionBasedCollectionScheme Text
- data CreateVehicleError = CreateVehicleError' {}
- newCreateVehicleError :: CreateVehicleError
- createVehicleError_code :: Lens' CreateVehicleError (Maybe Text)
- createVehicleError_message :: Lens' CreateVehicleError (Maybe Text)
- createVehicleError_vehicleName :: Lens' CreateVehicleError (Maybe Text)
- data CreateVehicleRequestItem = CreateVehicleRequestItem' {}
- newCreateVehicleRequestItem :: Text -> Text -> Text -> CreateVehicleRequestItem
- createVehicleRequestItem_associationBehavior :: Lens' CreateVehicleRequestItem (Maybe VehicleAssociationBehavior)
- createVehicleRequestItem_attributes :: Lens' CreateVehicleRequestItem (Maybe (HashMap Text Text))
- createVehicleRequestItem_tags :: Lens' CreateVehicleRequestItem (Maybe [Tag])
- createVehicleRequestItem_vehicleName :: Lens' CreateVehicleRequestItem Text
- createVehicleRequestItem_modelManifestArn :: Lens' CreateVehicleRequestItem Text
- createVehicleRequestItem_decoderManifestArn :: Lens' CreateVehicleRequestItem Text
- data CreateVehicleResponseItem = CreateVehicleResponseItem' {}
- newCreateVehicleResponseItem :: CreateVehicleResponseItem
- createVehicleResponseItem_arn :: Lens' CreateVehicleResponseItem (Maybe Text)
- createVehicleResponseItem_thingArn :: Lens' CreateVehicleResponseItem (Maybe Text)
- createVehicleResponseItem_vehicleName :: Lens' CreateVehicleResponseItem (Maybe Text)
- data DecoderManifestSummary = DecoderManifestSummary' {}
- newDecoderManifestSummary :: UTCTime -> UTCTime -> DecoderManifestSummary
- decoderManifestSummary_arn :: Lens' DecoderManifestSummary (Maybe Text)
- decoderManifestSummary_description :: Lens' DecoderManifestSummary (Maybe Text)
- decoderManifestSummary_modelManifestArn :: Lens' DecoderManifestSummary (Maybe Text)
- decoderManifestSummary_name :: Lens' DecoderManifestSummary (Maybe Text)
- decoderManifestSummary_status :: Lens' DecoderManifestSummary (Maybe ManifestStatus)
- decoderManifestSummary_creationTime :: Lens' DecoderManifestSummary UTCTime
- decoderManifestSummary_lastModificationTime :: Lens' DecoderManifestSummary UTCTime
- data FleetSummary = FleetSummary' {
- description :: Maybe Text
- lastModificationTime :: Maybe POSIX
- id :: Text
- arn :: Text
- signalCatalogArn :: Text
- creationTime :: POSIX
- newFleetSummary :: Text -> Text -> Text -> UTCTime -> FleetSummary
- fleetSummary_description :: Lens' FleetSummary (Maybe Text)
- fleetSummary_lastModificationTime :: Lens' FleetSummary (Maybe UTCTime)
- fleetSummary_id :: Lens' FleetSummary Text
- fleetSummary_arn :: Lens' FleetSummary Text
- fleetSummary_signalCatalogArn :: Lens' FleetSummary Text
- fleetSummary_creationTime :: Lens' FleetSummary UTCTime
- data FormattedVss = FormattedVss' {}
- newFormattedVss :: FormattedVss
- formattedVss_vssJson :: Lens' FormattedVss (Maybe Text)
- data IamRegistrationResponse = IamRegistrationResponse' {}
- newIamRegistrationResponse :: Text -> RegistrationStatus -> IamRegistrationResponse
- iamRegistrationResponse_errorMessage :: Lens' IamRegistrationResponse (Maybe Text)
- iamRegistrationResponse_roleArn :: Lens' IamRegistrationResponse Text
- iamRegistrationResponse_registrationStatus :: Lens' IamRegistrationResponse RegistrationStatus
- data IamResources = IamResources' {}
- newIamResources :: Text -> IamResources
- iamResources_roleArn :: Lens' IamResources Text
- data ModelManifestSummary = ModelManifestSummary' {}
- newModelManifestSummary :: UTCTime -> UTCTime -> ModelManifestSummary
- modelManifestSummary_arn :: Lens' ModelManifestSummary (Maybe Text)
- modelManifestSummary_description :: Lens' ModelManifestSummary (Maybe Text)
- modelManifestSummary_name :: Lens' ModelManifestSummary (Maybe Text)
- modelManifestSummary_signalCatalogArn :: Lens' ModelManifestSummary (Maybe Text)
- modelManifestSummary_status :: Lens' ModelManifestSummary (Maybe ManifestStatus)
- modelManifestSummary_creationTime :: Lens' ModelManifestSummary UTCTime
- modelManifestSummary_lastModificationTime :: Lens' ModelManifestSummary UTCTime
- data NetworkFileDefinition = NetworkFileDefinition' {}
- newNetworkFileDefinition :: NetworkFileDefinition
- networkFileDefinition_canDbc :: Lens' NetworkFileDefinition (Maybe CanDbcDefinition)
- data NetworkInterface = NetworkInterface' {}
- newNetworkInterface :: Text -> NetworkInterfaceType -> NetworkInterface
- networkInterface_canInterface :: Lens' NetworkInterface (Maybe CanInterface)
- networkInterface_obdInterface :: Lens' NetworkInterface (Maybe ObdInterface)
- networkInterface_interfaceId :: Lens' NetworkInterface Text
- networkInterface_type :: Lens' NetworkInterface NetworkInterfaceType
- data Node = Node' {}
- newNode :: Node
- node_actuator :: Lens' Node (Maybe Actuator)
- node_attribute :: Lens' Node (Maybe Attribute)
- node_branch :: Lens' Node (Maybe Branch)
- node_sensor :: Lens' Node (Maybe Sensor)
- data NodeCounts = NodeCounts' {}
- newNodeCounts :: NodeCounts
- nodeCounts_totalActuators :: Lens' NodeCounts (Maybe Int)
- nodeCounts_totalAttributes :: Lens' NodeCounts (Maybe Int)
- nodeCounts_totalBranches :: Lens' NodeCounts (Maybe Int)
- nodeCounts_totalNodes :: Lens' NodeCounts (Maybe Int)
- nodeCounts_totalSensors :: Lens' NodeCounts (Maybe Int)
- data ObdInterface = ObdInterface' {}
- newObdInterface :: Text -> Natural -> ObdInterface
- obdInterface_dtcRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural)
- obdInterface_hasTransmissionEcu :: Lens' ObdInterface (Maybe Bool)
- obdInterface_obdStandard :: Lens' ObdInterface (Maybe Text)
- obdInterface_pidRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural)
- obdInterface_useExtendedIds :: Lens' ObdInterface (Maybe Bool)
- obdInterface_name :: Lens' ObdInterface Text
- obdInterface_requestMessageId :: Lens' ObdInterface Natural
- data ObdSignal = ObdSignal' {}
- newObdSignal :: Natural -> Natural -> Natural -> Double -> Double -> Natural -> Natural -> ObdSignal
- obdSignal_bitMaskLength :: Lens' ObdSignal (Maybe Natural)
- obdSignal_bitRightShift :: Lens' ObdSignal (Maybe Natural)
- obdSignal_pidResponseLength :: Lens' ObdSignal Natural
- obdSignal_serviceMode :: Lens' ObdSignal Natural
- obdSignal_pid :: Lens' ObdSignal Natural
- obdSignal_scaling :: Lens' ObdSignal Double
- obdSignal_offset :: Lens' ObdSignal Double
- obdSignal_startByte :: Lens' ObdSignal Natural
- obdSignal_byteLength :: Lens' ObdSignal Natural
- data Sensor = Sensor' {
- allowedValues :: Maybe [Text]
- description :: Maybe Text
- max :: Maybe Double
- min :: Maybe Double
- unit :: Maybe Text
- fullyQualifiedName :: Text
- dataType :: NodeDataType
- newSensor :: Text -> NodeDataType -> Sensor
- sensor_allowedValues :: Lens' Sensor (Maybe [Text])
- sensor_description :: Lens' Sensor (Maybe Text)
- sensor_max :: Lens' Sensor (Maybe Double)
- sensor_min :: Lens' Sensor (Maybe Double)
- sensor_unit :: Lens' Sensor (Maybe Text)
- sensor_fullyQualifiedName :: Lens' Sensor Text
- sensor_dataType :: Lens' Sensor NodeDataType
- data SignalCatalogSummary = SignalCatalogSummary' {}
- newSignalCatalogSummary :: SignalCatalogSummary
- signalCatalogSummary_arn :: Lens' SignalCatalogSummary (Maybe Text)
- signalCatalogSummary_creationTime :: Lens' SignalCatalogSummary (Maybe UTCTime)
- signalCatalogSummary_lastModificationTime :: Lens' SignalCatalogSummary (Maybe UTCTime)
- signalCatalogSummary_name :: Lens' SignalCatalogSummary (Maybe Text)
- data SignalDecoder = SignalDecoder' {}
- newSignalDecoder :: Text -> SignalDecoderType -> Text -> SignalDecoder
- signalDecoder_canSignal :: Lens' SignalDecoder (Maybe CanSignal)
- signalDecoder_obdSignal :: Lens' SignalDecoder (Maybe ObdSignal)
- signalDecoder_fullyQualifiedName :: Lens' SignalDecoder Text
- signalDecoder_type :: Lens' SignalDecoder SignalDecoderType
- signalDecoder_interfaceId :: Lens' SignalDecoder Text
- data SignalInformation = SignalInformation' {}
- newSignalInformation :: Text -> SignalInformation
- signalInformation_maxSampleCount :: Lens' SignalInformation (Maybe Natural)
- signalInformation_minimumSamplingIntervalMs :: Lens' SignalInformation (Maybe Natural)
- signalInformation_name :: Lens' SignalInformation Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TimeBasedCollectionScheme = TimeBasedCollectionScheme' {}
- newTimeBasedCollectionScheme :: Natural -> TimeBasedCollectionScheme
- timeBasedCollectionScheme_periodMs :: Lens' TimeBasedCollectionScheme Natural
- data TimestreamRegistrationResponse = TimestreamRegistrationResponse' {}
- newTimestreamRegistrationResponse :: Text -> Text -> RegistrationStatus -> TimestreamRegistrationResponse
- timestreamRegistrationResponse_errorMessage :: Lens' TimestreamRegistrationResponse (Maybe Text)
- timestreamRegistrationResponse_timestreamDatabaseArn :: Lens' TimestreamRegistrationResponse (Maybe Text)
- timestreamRegistrationResponse_timestreamTableArn :: Lens' TimestreamRegistrationResponse (Maybe Text)
- timestreamRegistrationResponse_timestreamDatabaseName :: Lens' TimestreamRegistrationResponse Text
- timestreamRegistrationResponse_timestreamTableName :: Lens' TimestreamRegistrationResponse Text
- timestreamRegistrationResponse_registrationStatus :: Lens' TimestreamRegistrationResponse RegistrationStatus
- data TimestreamResources = TimestreamResources' {}
- newTimestreamResources :: Text -> Text -> TimestreamResources
- timestreamResources_timestreamDatabaseName :: Lens' TimestreamResources Text
- timestreamResources_timestreamTableName :: Lens' TimestreamResources Text
- data UpdateVehicleError = UpdateVehicleError' {}
- newUpdateVehicleError :: UpdateVehicleError
- updateVehicleError_code :: Lens' UpdateVehicleError (Maybe Int)
- updateVehicleError_message :: Lens' UpdateVehicleError (Maybe Text)
- updateVehicleError_vehicleName :: Lens' UpdateVehicleError (Maybe Text)
- data UpdateVehicleRequestItem = UpdateVehicleRequestItem' {}
- newUpdateVehicleRequestItem :: Text -> UpdateVehicleRequestItem
- updateVehicleRequestItem_attributeUpdateMode :: Lens' UpdateVehicleRequestItem (Maybe UpdateMode)
- updateVehicleRequestItem_attributes :: Lens' UpdateVehicleRequestItem (Maybe (HashMap Text Text))
- updateVehicleRequestItem_decoderManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text)
- updateVehicleRequestItem_modelManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text)
- updateVehicleRequestItem_vehicleName :: Lens' UpdateVehicleRequestItem Text
- data UpdateVehicleResponseItem = UpdateVehicleResponseItem' {}
- newUpdateVehicleResponseItem :: UpdateVehicleResponseItem
- updateVehicleResponseItem_arn :: Lens' UpdateVehicleResponseItem (Maybe Text)
- updateVehicleResponseItem_vehicleName :: Lens' UpdateVehicleResponseItem (Maybe Text)
- data VehicleStatus = VehicleStatus' {}
- newVehicleStatus :: VehicleStatus
- vehicleStatus_campaignName :: Lens' VehicleStatus (Maybe Text)
- vehicleStatus_status :: Lens' VehicleStatus (Maybe VehicleState)
- vehicleStatus_vehicleName :: Lens' VehicleStatus (Maybe Text)
- data VehicleSummary = VehicleSummary' {}
- newVehicleSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> VehicleSummary
- vehicleSummary_vehicleName :: Lens' VehicleSummary Text
- vehicleSummary_arn :: Lens' VehicleSummary Text
- vehicleSummary_modelManifestArn :: Lens' VehicleSummary Text
- vehicleSummary_decoderManifestArn :: Lens' VehicleSummary Text
- vehicleSummary_creationTime :: Lens' VehicleSummary UTCTime
- vehicleSummary_lastModificationTime :: Lens' VehicleSummary UTCTime
Service Configuration
defaultService :: Service Source #
API version 2021-06-17 of the Amazon IoT FleetWise SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permission to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
_DecoderManifestValidationException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because it contains signal decoders with one or more validation errors.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because the server temporarily failed.
_InvalidNodeException :: AsError a => Fold a ServiceError Source #
The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.
_InvalidSignalsException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because it contains signals that aren't valid.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A service quota was exceeded.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource wasn't found.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed due to throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
CampaignStatus
newtype CampaignStatus Source #
Constructors
| CampaignStatus' | |
Fields | |
Bundled Patterns
| pattern CampaignStatus_CREATING :: CampaignStatus | |
| pattern CampaignStatus_RUNNING :: CampaignStatus | |
| pattern CampaignStatus_SUSPENDED :: CampaignStatus | |
| pattern CampaignStatus_WAITING_FOR_APPROVAL :: CampaignStatus |
Instances
Compression
newtype Compression Source #
Constructors
| Compression' | |
Fields | |
Bundled Patterns
| pattern Compression_OFF :: Compression | |
| pattern Compression_SNAPPY :: Compression |
Instances
DiagnosticsMode
newtype DiagnosticsMode Source #
Constructors
| DiagnosticsMode' | |
Fields | |
Bundled Patterns
| pattern DiagnosticsMode_OFF :: DiagnosticsMode | |
| pattern DiagnosticsMode_SEND_ACTIVE_DTCS :: DiagnosticsMode |
Instances
LogType
Constructors
| LogType' | |
Fields
| |
Bundled Patterns
| pattern LogType_ERROR :: LogType | |
| pattern LogType_OFF :: LogType |
Instances
ManifestStatus
newtype ManifestStatus Source #
Constructors
| ManifestStatus' | |
Fields | |
Bundled Patterns
| pattern ManifestStatus_ACTIVE :: ManifestStatus | |
| pattern ManifestStatus_DRAFT :: ManifestStatus |
Instances
NetworkInterfaceType
newtype NetworkInterfaceType Source #
Constructors
| NetworkInterfaceType' | |
Fields | |
Bundled Patterns
| pattern NetworkInterfaceType_CAN_INTERFACE :: NetworkInterfaceType | |
| pattern NetworkInterfaceType_OBD_INTERFACE :: NetworkInterfaceType |
Instances
NodeDataType
newtype NodeDataType Source #
Constructors
| NodeDataType' | |
Fields | |
Bundled Patterns
Instances
RegistrationStatus
newtype RegistrationStatus Source #
Constructors
| RegistrationStatus' | |
Fields | |
Bundled Patterns
Instances
SignalDecoderType
newtype SignalDecoderType Source #
Constructors
| SignalDecoderType' | |
Fields | |
Bundled Patterns
| pattern SignalDecoderType_CAN_SIGNAL :: SignalDecoderType | |
| pattern SignalDecoderType_OBD_SIGNAL :: SignalDecoderType |
Instances
SpoolingMode
newtype SpoolingMode Source #
Constructors
| SpoolingMode' | |
Fields | |
Bundled Patterns
| pattern SpoolingMode_OFF :: SpoolingMode | |
| pattern SpoolingMode_TO_DISK :: SpoolingMode |
Instances
TriggerMode
newtype TriggerMode Source #
Constructors
| TriggerMode' | |
Fields | |
Bundled Patterns
| pattern TriggerMode_ALWAYS :: TriggerMode | |
| pattern TriggerMode_RISING_EDGE :: TriggerMode |
Instances
UpdateCampaignAction
newtype UpdateCampaignAction Source #
Constructors
| UpdateCampaignAction' | |
Fields | |
Bundled Patterns
| pattern UpdateCampaignAction_APPROVE :: UpdateCampaignAction | |
| pattern UpdateCampaignAction_RESUME :: UpdateCampaignAction | |
| pattern UpdateCampaignAction_SUSPEND :: UpdateCampaignAction | |
| pattern UpdateCampaignAction_UPDATE :: UpdateCampaignAction |
Instances
UpdateMode
newtype UpdateMode Source #
Constructors
| UpdateMode' | |
Fields | |
Bundled Patterns
| pattern UpdateMode_Merge :: UpdateMode | |
| pattern UpdateMode_Overwrite :: UpdateMode |
Instances
VehicleAssociationBehavior
newtype VehicleAssociationBehavior Source #
Constructors
| VehicleAssociationBehavior' | |
Fields | |
Bundled Patterns
| pattern VehicleAssociationBehavior_CreateIotThing :: VehicleAssociationBehavior | |
| pattern VehicleAssociationBehavior_ValidateIotThingExists :: VehicleAssociationBehavior |
Instances
VehicleState
newtype VehicleState Source #
Constructors
| VehicleState' | |
Fields | |
Bundled Patterns
| pattern VehicleState_CREATED :: VehicleState | |
| pattern VehicleState_DELETING :: VehicleState | |
| pattern VehicleState_HEALTHY :: VehicleState | |
| pattern VehicleState_READY :: VehicleState | |
| pattern VehicleState_SUSPENDED :: VehicleState |
Instances
Actuator
A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
See: newActuator smart constructor.
Constructors
| Actuator' | |
Fields
| |
Instances
Create a value of Actuator 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:allowedValues:Actuator', actuator_allowedValues - A list of possible values an actuator can take.
$sel:assignedValue:Actuator', actuator_assignedValue - A specified value for the actuator.
$sel:description:Actuator', actuator_description - A brief description of the actuator.
$sel:max:Actuator', actuator_max - The specified possible maximum value of an actuator.
$sel:min:Actuator', actuator_min - The specified possible minimum value of an actuator.
$sel:unit:Actuator', actuator_unit - The scientific unit for the actuator.
$sel:fullyQualifiedName:Actuator', actuator_fullyQualifiedName - The fully qualified name of the actuator. For example, the fully
qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
$sel:dataType:Actuator', actuator_dataType - The specified data type of the actuator.
actuator_allowedValues :: Lens' Actuator (Maybe [Text]) Source #
A list of possible values an actuator can take.
actuator_max :: Lens' Actuator (Maybe Double) Source #
The specified possible maximum value of an actuator.
actuator_min :: Lens' Actuator (Maybe Double) Source #
The specified possible minimum value of an actuator.
actuator_fullyQualifiedName :: Lens' Actuator Text Source #
The fully qualified name of the actuator. For example, the fully
qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
actuator_dataType :: Lens' Actuator NodeDataType Source #
The specified data type of the actuator.
Attribute
A signal that represents static information about the vehicle, such as engine type or manufacturing date.
See: newAttribute smart constructor.
Constructors
| Attribute' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NodeDataType | |
| -> Attribute |
Create a value of Attribute 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:allowedValues:Attribute', attribute_allowedValues - A list of possible values an attribute can be assigned.
$sel:assignedValue:Attribute', attribute_assignedValue - A specified value for the attribute.
$sel:defaultValue:Attribute', attribute_defaultValue - The default value of the attribute.
$sel:description:Attribute', attribute_description - A brief description of the attribute.
$sel:max:Attribute', attribute_max - The specified possible maximum value of the attribute.
$sel:min:Attribute', attribute_min - The specified possible minimum value of the attribute.
$sel:unit:Attribute', attribute_unit - The scientific unit for the attribute.
$sel:fullyQualifiedName:Attribute', attribute_fullyQualifiedName - The fully qualified name of the attribute. For example, the fully
qualified name of an attribute might be Vehicle.Body.Engine.Type.
$sel:dataType:Attribute', attribute_dataType - The specified data type of the attribute.
attribute_allowedValues :: Lens' Attribute (Maybe [Text]) Source #
A list of possible values an attribute can be assigned.
attribute_assignedValue :: Lens' Attribute (Maybe Text) Source #
A specified value for the attribute.
attribute_max :: Lens' Attribute (Maybe Double) Source #
The specified possible maximum value of the attribute.
attribute_min :: Lens' Attribute (Maybe Double) Source #
The specified possible minimum value of the attribute.
attribute_fullyQualifiedName :: Lens' Attribute Text Source #
The fully qualified name of the attribute. For example, the fully
qualified name of an attribute might be Vehicle.Body.Engine.Type.
attribute_dataType :: Lens' Attribute NodeDataType Source #
The specified data type of the attribute.
Branch
A group of signals that are defined in a hierarchical structure.
See: newBranch smart constructor.
Constructors
| Branch' | |
Fields
| |
Instances
| FromJSON Branch Source # | |
| ToJSON Branch Source # | |
Defined in Amazonka.IoTFleetWise.Types.Branch | |
| Generic Branch Source # | |
| Read Branch Source # | |
| Show Branch Source # | |
| NFData Branch Source # | |
Defined in Amazonka.IoTFleetWise.Types.Branch | |
| Eq Branch Source # | |
| Hashable Branch Source # | |
Defined in Amazonka.IoTFleetWise.Types.Branch | |
| type Rep Branch Source # | |
Defined in Amazonka.IoTFleetWise.Types.Branch type Rep Branch = D1 ('MetaData "Branch" "Amazonka.IoTFleetWise.Types.Branch" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "Branch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fullyQualifiedName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Branch 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:description:Branch', branch_description - A brief description of the branch.
$sel:fullyQualifiedName:Branch', branch_fullyQualifiedName - The fully qualified name of the branch. For example, the fully qualified
name of a branch might be Vehicle.Body.Engine.
branch_fullyQualifiedName :: Lens' Branch Text Source #
The fully qualified name of the branch. For example, the fully qualified
name of a branch might be Vehicle.Body.Engine.
CampaignSummary
data CampaignSummary Source #
Information about a campaign.
You can use the API operation to return this information about multiple created campaigns.
See: newCampaignSummary smart constructor.
Constructors
| CampaignSummary' | |
Fields
| |
Instances
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> CampaignSummary |
Create a value of CampaignSummary 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:arn:CampaignSummary', campaignSummary_arn - The Amazon Resource Name (ARN) of a campaign.
$sel:description:CampaignSummary', campaignSummary_description - The description of the campaign.
$sel:name:CampaignSummary', campaignSummary_name - The name of a campaign.
$sel:signalCatalogArn:CampaignSummary', campaignSummary_signalCatalogArn - The ARN of the signal catalog associated with the campaign.
$sel:status:CampaignSummary', campaignSummary_status - The state of a campaign. The status can be one of the following:
CREATING- Amazon Web Services IoT FleetWise is processing your request to create the campaign.WAITING_FOR_APPROVAL- After a campaign is created, it enters theWAITING_FOR_APPROVALstate. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.RUNNING- The campaign is active.SUSPENDED- The campaign is suspended. To resume the campaign, use the API operation.
$sel:targetArn:CampaignSummary', campaignSummary_targetArn - The ARN of a vehicle or fleet to which the campaign is deployed.
$sel:creationTime:CampaignSummary', campaignSummary_creationTime - The time the campaign was created.
$sel:lastModificationTime:CampaignSummary', campaignSummary_lastModificationTime - The last time the campaign was modified.
campaignSummary_arn :: Lens' CampaignSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of a campaign.
campaignSummary_description :: Lens' CampaignSummary (Maybe Text) Source #
The description of the campaign.
campaignSummary_name :: Lens' CampaignSummary (Maybe Text) Source #
The name of a campaign.
campaignSummary_signalCatalogArn :: Lens' CampaignSummary (Maybe Text) Source #
The ARN of the signal catalog associated with the campaign.
campaignSummary_status :: Lens' CampaignSummary (Maybe CampaignStatus) Source #
The state of a campaign. The status can be one of the following:
CREATING- Amazon Web Services IoT FleetWise is processing your request to create the campaign.WAITING_FOR_APPROVAL- After a campaign is created, it enters theWAITING_FOR_APPROVALstate. To allow Amazon Web Services IoT FleetWise to deploy the campaign to the target vehicle or fleet, use the API operation to approve the campaign.RUNNING- The campaign is active.SUSPENDED- The campaign is suspended. To resume the campaign, use the API operation.
campaignSummary_targetArn :: Lens' CampaignSummary (Maybe Text) Source #
The ARN of a vehicle or fleet to which the campaign is deployed.
campaignSummary_creationTime :: Lens' CampaignSummary UTCTime Source #
The time the campaign was created.
campaignSummary_lastModificationTime :: Lens' CampaignSummary UTCTime Source #
The last time the campaign was modified.
CanDbcDefinition
data CanDbcDefinition Source #
Configurations used to create a decoder manifest.
See: newCanDbcDefinition smart constructor.
Constructors
| CanDbcDefinition' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NonEmpty ByteString | |
| -> CanDbcDefinition |
Create a value of CanDbcDefinition 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:signalsMap:CanDbcDefinition', canDbcDefinition_signalsMap - Pairs every signal specified in your vehicle model with a signal
decoder.
$sel:networkInterface:CanDbcDefinition', canDbcDefinition_networkInterface - Contains information about a network interface.
$sel:canDbcFiles:CanDbcDefinition', canDbcDefinition_canDbcFiles - A list of DBC files. You can upload only one DBC file for each network
interface and specify up to five (inclusive) files in the list.
canDbcDefinition_signalsMap :: Lens' CanDbcDefinition (Maybe (HashMap Text Text)) Source #
Pairs every signal specified in your vehicle model with a signal decoder.
canDbcDefinition_networkInterface :: Lens' CanDbcDefinition Text Source #
Contains information about a network interface.
canDbcDefinition_canDbcFiles :: Lens' CanDbcDefinition (NonEmpty ByteString) Source #
A list of DBC files. You can upload only one DBC file for each network interface and specify up to five (inclusive) files in the list.
CanInterface
data CanInterface Source #
A single controller area network (CAN) device interface.
See: newCanInterface smart constructor.
Constructors
| CanInterface' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CanInterface |
Create a value of CanInterface 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:protocolName:CanInterface', canInterface_protocolName - The name of the communication protocol for the interface.
$sel:protocolVersion:CanInterface', canInterface_protocolVersion - The version of the communication protocol for the interface.
$sel:name:CanInterface', canInterface_name - The unique name of the interface.
canInterface_protocolName :: Lens' CanInterface (Maybe Text) Source #
The name of the communication protocol for the interface.
canInterface_protocolVersion :: Lens' CanInterface (Maybe Text) Source #
The version of the communication protocol for the interface.
canInterface_name :: Lens' CanInterface Text Source #
The unique name of the interface.
CanSignal
Information about a single controller area network (CAN) signal and the messages it receives and transmits.
See: newCanSignal smart constructor.
Constructors
| CanSignal' | |
Fields
| |
Instances
Create a value of CanSignal 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:name:CanSignal', canSignal_name - The name of the signal.
$sel:messageId:CanSignal', canSignal_messageId - The ID of the message.
$sel:isBigEndian:CanSignal', canSignal_isBigEndian - Whether the byte ordering of a CAN message is big-endian.
$sel:isSigned:CanSignal', canSignal_isSigned - Whether the message data is specified as a signed value.
$sel:startBit:CanSignal', canSignal_startBit - Indicates the beginning of the CAN message.
$sel:offset:CanSignal', canSignal_offset - Indicates where data appears in the CAN message.
$sel:factor:CanSignal', canSignal_factor - A multiplier used to decode the CAN message.
$sel:length:CanSignal', canSignal_length - How many bytes of data are in the message.
canSignal_isBigEndian :: Lens' CanSignal Bool Source #
Whether the byte ordering of a CAN message is big-endian.
canSignal_isSigned :: Lens' CanSignal Bool Source #
Whether the message data is specified as a signed value.
CloudWatchLogDeliveryOptions
data CloudWatchLogDeliveryOptions Source #
The log delivery option to send data to Amazon CloudWatch Logs.
See: newCloudWatchLogDeliveryOptions smart constructor.
Constructors
| CloudWatchLogDeliveryOptions' | |
Fields
| |
Instances
newCloudWatchLogDeliveryOptions Source #
Create a value of CloudWatchLogDeliveryOptions 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:logGroupName:CloudWatchLogDeliveryOptions', cloudWatchLogDeliveryOptions_logGroupName - The Amazon CloudWatch Logs group the operation sends data to.
$sel:logType:CloudWatchLogDeliveryOptions', cloudWatchLogDeliveryOptions_logType - The type of log to send data to Amazon CloudWatch Logs.
cloudWatchLogDeliveryOptions_logGroupName :: Lens' CloudWatchLogDeliveryOptions (Maybe Text) Source #
The Amazon CloudWatch Logs group the operation sends data to.
cloudWatchLogDeliveryOptions_logType :: Lens' CloudWatchLogDeliveryOptions LogType Source #
The type of log to send data to Amazon CloudWatch Logs.
CollectionScheme
data CollectionScheme Source #
Specifies what data to collect and how often or when to collect it.
See: newCollectionScheme smart constructor.
Constructors
| CollectionScheme' | |
Fields
| |
Instances
newCollectionScheme :: CollectionScheme Source #
Create a value of CollectionScheme 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:conditionBasedCollectionScheme:CollectionScheme', collectionScheme_conditionBasedCollectionScheme - Information about a collection scheme that uses a simple logical
expression to recognize what data to collect.
$sel:timeBasedCollectionScheme:CollectionScheme', collectionScheme_timeBasedCollectionScheme - Information about a collection scheme that uses a time period to decide
how often to collect data.
collectionScheme_conditionBasedCollectionScheme :: Lens' CollectionScheme (Maybe ConditionBasedCollectionScheme) Source #
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
collectionScheme_timeBasedCollectionScheme :: Lens' CollectionScheme (Maybe TimeBasedCollectionScheme) Source #
Information about a collection scheme that uses a time period to decide how often to collect data.
ConditionBasedCollectionScheme
data ConditionBasedCollectionScheme Source #
Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
See: newConditionBasedCollectionScheme smart constructor.
Constructors
| ConditionBasedCollectionScheme' | |
Fields
| |
Instances
newConditionBasedCollectionScheme Source #
Create a value of ConditionBasedCollectionScheme 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:conditionLanguageVersion:ConditionBasedCollectionScheme', conditionBasedCollectionScheme_conditionLanguageVersion - Specifies the version of the conditional expression language.
$sel:minimumTriggerIntervalMs:ConditionBasedCollectionScheme', conditionBasedCollectionScheme_minimumTriggerIntervalMs - The minimum duration of time between two triggering events to collect
data, in milliseconds.
If a signal changes often, you might want to collect data at a slower rate.
$sel:triggerMode:ConditionBasedCollectionScheme', conditionBasedCollectionScheme_triggerMode - Whether to collect data for all triggering events (ALWAYS). Specify
(RISING_EDGE), or specify only when the condition first evaluates to
false. For example, triggering on "AirbagDeployed"; Users aren't
interested on triggering when the airbag is already exploded; they only
care about the change from not deployed => deployed.
$sel:expression:ConditionBasedCollectionScheme', conditionBasedCollectionScheme_expression - The logical expression used to recognize what data to collect. For
example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
conditionBasedCollectionScheme_conditionLanguageVersion :: Lens' ConditionBasedCollectionScheme (Maybe Natural) Source #
Specifies the version of the conditional expression language.
conditionBasedCollectionScheme_minimumTriggerIntervalMs :: Lens' ConditionBasedCollectionScheme (Maybe Natural) Source #
The minimum duration of time between two triggering events to collect data, in milliseconds.
If a signal changes often, you might want to collect data at a slower rate.
conditionBasedCollectionScheme_triggerMode :: Lens' ConditionBasedCollectionScheme (Maybe TriggerMode) Source #
Whether to collect data for all triggering events (ALWAYS). Specify
(RISING_EDGE), or specify only when the condition first evaluates to
false. For example, triggering on "AirbagDeployed"; Users aren't
interested on triggering when the airbag is already exploded; they only
care about the change from not deployed => deployed.
conditionBasedCollectionScheme_expression :: Lens' ConditionBasedCollectionScheme Text Source #
The logical expression used to recognize what data to collect. For
example, $variable.Vehicle.OutsideAirTemperature >= 105.0.
CreateVehicleError
data CreateVehicleError Source #
An HTTP error resulting from creating a vehicle.
See: newCreateVehicleError smart constructor.
Constructors
| CreateVehicleError' | |
Instances
newCreateVehicleError :: CreateVehicleError Source #
Create a value of CreateVehicleError 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:code:CreateVehicleError', createVehicleError_code - An HTTP error code.
$sel:message:CreateVehicleError', createVehicleError_message - A description of the HTTP error.
$sel:vehicleName:CreateVehicleError', createVehicleError_vehicleName - The ID of the vehicle with the error.
createVehicleError_code :: Lens' CreateVehicleError (Maybe Text) Source #
An HTTP error code.
createVehicleError_message :: Lens' CreateVehicleError (Maybe Text) Source #
A description of the HTTP error.
createVehicleError_vehicleName :: Lens' CreateVehicleError (Maybe Text) Source #
The ID of the vehicle with the error.
CreateVehicleRequestItem
data CreateVehicleRequestItem Source #
Information about the vehicle to create.
See: newCreateVehicleRequestItem smart constructor.
Constructors
| CreateVehicleRequestItem' | |
Fields
| |
Instances
newCreateVehicleRequestItem Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateVehicleRequestItem |
Create a value of CreateVehicleRequestItem 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:associationBehavior:CreateVehicleRequestItem', createVehicleRequestItem_associationBehavior - An option to create a new Amazon Web Services IoT thing when creating a
vehicle, or to validate an existing thing as a vehicle.
$sel:attributes:CreateVehicleRequestItem', createVehicleRequestItem_attributes - Static information about a vehicle in a key-value pair. For example:
"engine Type" : "v6"
$sel:tags:CreateVehicleRequestItem', createVehicleRequestItem_tags - Metadata which can be used to manage the vehicle.
$sel:vehicleName:CreateVehicleRequestItem', createVehicleRequestItem_vehicleName - The unique ID of the vehicle to create.
$sel:modelManifestArn:CreateVehicleRequestItem', createVehicleRequestItem_modelManifestArn - The ARN of the vehicle model (model manifest) to create the vehicle
from.
$sel:decoderManifestArn:CreateVehicleRequestItem', createVehicleRequestItem_decoderManifestArn - The Amazon Resource Name (ARN) of a decoder manifest associated with the
vehicle to create.
createVehicleRequestItem_associationBehavior :: Lens' CreateVehicleRequestItem (Maybe VehicleAssociationBehavior) Source #
An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
createVehicleRequestItem_attributes :: Lens' CreateVehicleRequestItem (Maybe (HashMap Text Text)) Source #
Static information about a vehicle in a key-value pair. For example:
"engine Type" : "v6"
createVehicleRequestItem_tags :: Lens' CreateVehicleRequestItem (Maybe [Tag]) Source #
Metadata which can be used to manage the vehicle.
createVehicleRequestItem_vehicleName :: Lens' CreateVehicleRequestItem Text Source #
The unique ID of the vehicle to create.
createVehicleRequestItem_modelManifestArn :: Lens' CreateVehicleRequestItem Text Source #
The ARN of the vehicle model (model manifest) to create the vehicle from.
createVehicleRequestItem_decoderManifestArn :: Lens' CreateVehicleRequestItem Text Source #
The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
CreateVehicleResponseItem
data CreateVehicleResponseItem Source #
Information about a created vehicle.
See: newCreateVehicleResponseItem smart constructor.
Constructors
| CreateVehicleResponseItem' | |
Instances
newCreateVehicleResponseItem :: CreateVehicleResponseItem Source #
Create a value of CreateVehicleResponseItem 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:arn:CreateVehicleResponseItem', createVehicleResponseItem_arn - The ARN of the created vehicle.
$sel:thingArn:CreateVehicleResponseItem', createVehicleResponseItem_thingArn - The ARN of a created or validated Amazon Web Services IoT thing.
$sel:vehicleName:CreateVehicleResponseItem', createVehicleResponseItem_vehicleName - The unique ID of the vehicle to create.
createVehicleResponseItem_arn :: Lens' CreateVehicleResponseItem (Maybe Text) Source #
The ARN of the created vehicle.
createVehicleResponseItem_thingArn :: Lens' CreateVehicleResponseItem (Maybe Text) Source #
The ARN of a created or validated Amazon Web Services IoT thing.
createVehicleResponseItem_vehicleName :: Lens' CreateVehicleResponseItem (Maybe Text) Source #
The unique ID of the vehicle to create.
DecoderManifestSummary
data DecoderManifestSummary Source #
Information about a created decoder manifest. You can use the API operation to return this information about multiple decoder manifests.
See: newDecoderManifestSummary smart constructor.
Constructors
| DecoderManifestSummary' | |
Fields
| |
Instances
newDecoderManifestSummary Source #
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> DecoderManifestSummary |
Create a value of DecoderManifestSummary 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:arn:DecoderManifestSummary', decoderManifestSummary_arn - The ARN of a vehicle model (model manifest) associated with the decoder
manifest.
$sel:description:DecoderManifestSummary', decoderManifestSummary_description - A brief description of the decoder manifest.
$sel:modelManifestArn:DecoderManifestSummary', decoderManifestSummary_modelManifestArn - The ARN of a vehicle model (model manifest) associated with the decoder
manifest.
$sel:name:DecoderManifestSummary', decoderManifestSummary_name - The name of the decoder manifest.
$sel:status:DecoderManifestSummary', decoderManifestSummary_status - The state of the decoder manifest. If the status is ACTIVE, the
decoder manifest can't be edited. If the status is marked DRAFT, you
can edit the decoder manifest.
$sel:creationTime:DecoderManifestSummary', decoderManifestSummary_creationTime - The time the decoder manifest was created in seconds since epoch
(January 1, 1970 at midnight UTC time).
$sel:lastModificationTime:DecoderManifestSummary', decoderManifestSummary_lastModificationTime - The time the decoder manifest was last updated in seconds since epoch
(January 1, 1970 at midnight UTC time).
decoderManifestSummary_arn :: Lens' DecoderManifestSummary (Maybe Text) Source #
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
decoderManifestSummary_description :: Lens' DecoderManifestSummary (Maybe Text) Source #
A brief description of the decoder manifest.
decoderManifestSummary_modelManifestArn :: Lens' DecoderManifestSummary (Maybe Text) Source #
The ARN of a vehicle model (model manifest) associated with the decoder manifest.
decoderManifestSummary_name :: Lens' DecoderManifestSummary (Maybe Text) Source #
The name of the decoder manifest.
decoderManifestSummary_status :: Lens' DecoderManifestSummary (Maybe ManifestStatus) Source #
The state of the decoder manifest. If the status is ACTIVE, the
decoder manifest can't be edited. If the status is marked DRAFT, you
can edit the decoder manifest.
decoderManifestSummary_creationTime :: Lens' DecoderManifestSummary UTCTime Source #
The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
decoderManifestSummary_lastModificationTime :: Lens' DecoderManifestSummary UTCTime Source #
The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
FleetSummary
data FleetSummary Source #
Information about a fleet.
You can use the API operation to return this information about multiple fleets.
See: newFleetSummary smart constructor.
Constructors
| FleetSummary' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UTCTime | |
| -> FleetSummary |
Create a value of FleetSummary 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:description:FleetSummary', fleetSummary_description - A brief description of the fleet.
$sel:lastModificationTime:FleetSummary', fleetSummary_lastModificationTime - The time the fleet was last updated in seconds since epoch (January 1,
1970 at midnight UTC time).
$sel:id:FleetSummary', fleetSummary_id - The unique ID of the fleet.
$sel:arn:FleetSummary', fleetSummary_arn - The Amazon Resource Name (ARN) of the fleet.
$sel:signalCatalogArn:FleetSummary', fleetSummary_signalCatalogArn - The ARN of the signal catalog associated with the fleet.
$sel:creationTime:FleetSummary', fleetSummary_creationTime - The time the fleet was created, in seconds since epoch (January 1, 1970
at midnight UTC time).
fleetSummary_description :: Lens' FleetSummary (Maybe Text) Source #
A brief description of the fleet.
fleetSummary_lastModificationTime :: Lens' FleetSummary (Maybe UTCTime) Source #
The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
fleetSummary_id :: Lens' FleetSummary Text Source #
The unique ID of the fleet.
fleetSummary_arn :: Lens' FleetSummary Text Source #
The Amazon Resource Name (ARN) of the fleet.
fleetSummary_signalCatalogArn :: Lens' FleetSummary Text Source #
The ARN of the signal catalog associated with the fleet.
fleetSummary_creationTime :: Lens' FleetSummary UTCTime Source #
The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
FormattedVss
data FormattedVss Source #
Vehicle Signal Specification (VSS) is a precise language used to describe and model signals in vehicle networks. The JSON file collects signal specificiations in a VSS format.
See: newFormattedVss smart constructor.
Constructors
| FormattedVss' | |
Instances
newFormattedVss :: FormattedVss Source #
Create a value of FormattedVss 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:vssJson:FormattedVss', formattedVss_vssJson - Provides the VSS in JSON format.
formattedVss_vssJson :: Lens' FormattedVss (Maybe Text) Source #
Provides the VSS in JSON format.
IamRegistrationResponse
data IamRegistrationResponse Source #
Information about registering an Identity and Access Management (IAM) resource so Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to Amazon Timestream.
See: newIamRegistrationResponse smart constructor.
Constructors
| IamRegistrationResponse' | |
Fields
| |
Instances
newIamRegistrationResponse Source #
Arguments
| :: Text | |
| -> RegistrationStatus | |
| -> IamRegistrationResponse |
Create a value of IamRegistrationResponse 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:errorMessage:IamRegistrationResponse', iamRegistrationResponse_errorMessage - A message associated with a registration error.
$sel:roleArn:IamRegistrationResponse', iamRegistrationResponse_roleArn - The Amazon Resource Name (ARN) of the IAM role to register.
$sel:registrationStatus:IamRegistrationResponse', iamRegistrationResponse_registrationStatus - The status of registering your IAM resource. The status can be one of
REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
iamRegistrationResponse_errorMessage :: Lens' IamRegistrationResponse (Maybe Text) Source #
A message associated with a registration error.
iamRegistrationResponse_roleArn :: Lens' IamRegistrationResponse Text Source #
The Amazon Resource Name (ARN) of the IAM role to register.
iamRegistrationResponse_registrationStatus :: Lens' IamRegistrationResponse RegistrationStatus Source #
The status of registering your IAM resource. The status can be one of
REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
IamResources
data IamResources Source #
The IAM resource that enables Amazon Web Services IoT FleetWise edge agent software to send data to Amazon Timestream.
For more information, see IAM roles in the Identity and Access Management User Guide.
See: newIamResources smart constructor.
Constructors
| IamResources' | |
Instances
Arguments
| :: Text | |
| -> IamResources |
Create a value of IamResources 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:roleArn:IamResources', iamResources_roleArn - The Amazon Resource Name (ARN) of the IAM resource that allows Amazon
Web Services IoT FleetWise to send data to Amazon Timestream. For
example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.
iamResources_roleArn :: Lens' IamResources Text Source #
The Amazon Resource Name (ARN) of the IAM resource that allows Amazon
Web Services IoT FleetWise to send data to Amazon Timestream. For
example, arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN.
ModelManifestSummary
data ModelManifestSummary Source #
Information about a vehicle model (model manifest). You can use the API operation to return this information about multiple vehicle models.
See: newModelManifestSummary smart constructor.
Constructors
| ModelManifestSummary' | |
Fields
| |
Instances
newModelManifestSummary Source #
Arguments
| :: UTCTime | |
| -> UTCTime | |
| -> ModelManifestSummary |
Create a value of ModelManifestSummary 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:arn:ModelManifestSummary', modelManifestSummary_arn - The Amazon Resource Name (ARN) of the vehicle model.
$sel:description:ModelManifestSummary', modelManifestSummary_description - A brief description of the vehicle model.
$sel:name:ModelManifestSummary', modelManifestSummary_name - The name of the vehicle model.
$sel:signalCatalogArn:ModelManifestSummary', modelManifestSummary_signalCatalogArn - The ARN of the signal catalog associated with the vehicle model.
$sel:status:ModelManifestSummary', modelManifestSummary_status - The state of the vehicle model. If the status is ACTIVE, the vehicle
model can't be edited. If the status is DRAFT, you can edit the
vehicle model.
$sel:creationTime:ModelManifestSummary', modelManifestSummary_creationTime - The time the vehicle model was created, in seconds since epoch (January
1, 1970 at midnight UTC time).
$sel:lastModificationTime:ModelManifestSummary', modelManifestSummary_lastModificationTime - The time the vehicle model was last updated, in seconds since epoch
(January 1, 1970 at midnight UTC time).
modelManifestSummary_arn :: Lens' ModelManifestSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the vehicle model.
modelManifestSummary_description :: Lens' ModelManifestSummary (Maybe Text) Source #
A brief description of the vehicle model.
modelManifestSummary_name :: Lens' ModelManifestSummary (Maybe Text) Source #
The name of the vehicle model.
modelManifestSummary_signalCatalogArn :: Lens' ModelManifestSummary (Maybe Text) Source #
The ARN of the signal catalog associated with the vehicle model.
modelManifestSummary_status :: Lens' ModelManifestSummary (Maybe ManifestStatus) Source #
The state of the vehicle model. If the status is ACTIVE, the vehicle
model can't be edited. If the status is DRAFT, you can edit the
vehicle model.
modelManifestSummary_creationTime :: Lens' ModelManifestSummary UTCTime Source #
The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
modelManifestSummary_lastModificationTime :: Lens' ModelManifestSummary UTCTime Source #
The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
NetworkFileDefinition
data NetworkFileDefinition Source #
Specifications for defining a vehicle network.
See: newNetworkFileDefinition smart constructor.
Constructors
| NetworkFileDefinition' | |
Fields
| |
Instances
newNetworkFileDefinition :: NetworkFileDefinition Source #
Create a value of NetworkFileDefinition 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:canDbc:NetworkFileDefinition', networkFileDefinition_canDbc - Information, including CAN DBC files, about the configurations used to
create a decoder manifest.
networkFileDefinition_canDbc :: Lens' NetworkFileDefinition (Maybe CanDbcDefinition) Source #
Information, including CAN DBC files, about the configurations used to create a decoder manifest.
NetworkInterface
data NetworkInterface Source #
Represents a node and its specifications in an in-vehicle communication network. All signal decoders must be associated with a network node.
To return this information about all the network interfaces specified in a decoder manifest, use the API operation.
See: newNetworkInterface smart constructor.
Constructors
| NetworkInterface' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> NetworkInterfaceType | |
| -> NetworkInterface |
Create a value of NetworkInterface 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:canInterface:NetworkInterface', networkInterface_canInterface - Information about a network interface specified by the Controller Area
Network (CAN) protocol.
$sel:obdInterface:NetworkInterface', networkInterface_obdInterface - Information about a network interface specified by the On-board
diagnostic (OBD) II protocol.
$sel:interfaceId:NetworkInterface', networkInterface_interfaceId - The ID of the network interface.
$sel:type':NetworkInterface', networkInterface_type - The network protocol for the vehicle. For example, CAN_SIGNAL
specifies a protocol that defines how data is communicated between
electronic control units (ECUs). OBD_SIGNAL specifies a protocol that
defines how self-diagnostic data is communicated between ECUs.
networkInterface_canInterface :: Lens' NetworkInterface (Maybe CanInterface) Source #
Information about a network interface specified by the Controller Area Network (CAN) protocol.
networkInterface_obdInterface :: Lens' NetworkInterface (Maybe ObdInterface) Source #
Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
networkInterface_interfaceId :: Lens' NetworkInterface Text Source #
The ID of the network interface.
networkInterface_type :: Lens' NetworkInterface NetworkInterfaceType Source #
The network protocol for the vehicle. For example, CAN_SIGNAL
specifies a protocol that defines how data is communicated between
electronic control units (ECUs). OBD_SIGNAL specifies a protocol that
defines how self-diagnostic data is communicated between ECUs.
Node
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
See: newNode smart constructor.
Constructors
| Node' | |
Fields
| |
Instances
Create a value of Node 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:actuator:Node', node_actuator - Information about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
$sel:attribute:Node', node_attribute - Information about a node specified as an attribute.
An attribute represents static information about a vehicle.
$sel:branch:Node', node_branch - Information about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
$sel:sensor:Node', node_sensor - Undocumented member.
node_actuator :: Lens' Node (Maybe Actuator) Source #
Information about a node specified as an actuator.
An actuator is a digital representation of a vehicle device.
node_attribute :: Lens' Node (Maybe Attribute) Source #
Information about a node specified as an attribute.
An attribute represents static information about a vehicle.
node_branch :: Lens' Node (Maybe Branch) Source #
Information about a node specified as a branch.
A group of signals that are defined in a hierarchical structure.
NodeCounts
data NodeCounts Source #
Information about the number of nodes and node types in a vehicle network.
See: newNodeCounts smart constructor.
Constructors
| NodeCounts' | |
Fields
| |
Instances
newNodeCounts :: NodeCounts Source #
Create a value of NodeCounts 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:totalActuators:NodeCounts', nodeCounts_totalActuators - The total number of nodes in a vehicle network that represent actuators.
$sel:totalAttributes:NodeCounts', nodeCounts_totalAttributes - The total number of nodes in a vehicle network that represent
attributes.
$sel:totalBranches:NodeCounts', nodeCounts_totalBranches - The total number of nodes in a vehicle network that represent branches.
$sel:totalNodes:NodeCounts', nodeCounts_totalNodes - The total number of nodes in a vehicle network.
$sel:totalSensors:NodeCounts', nodeCounts_totalSensors - The total number of nodes in a vehicle network that represent sensors.
nodeCounts_totalActuators :: Lens' NodeCounts (Maybe Int) Source #
The total number of nodes in a vehicle network that represent actuators.
nodeCounts_totalAttributes :: Lens' NodeCounts (Maybe Int) Source #
The total number of nodes in a vehicle network that represent attributes.
nodeCounts_totalBranches :: Lens' NodeCounts (Maybe Int) Source #
The total number of nodes in a vehicle network that represent branches.
nodeCounts_totalNodes :: Lens' NodeCounts (Maybe Int) Source #
The total number of nodes in a vehicle network.
nodeCounts_totalSensors :: Lens' NodeCounts (Maybe Int) Source #
The total number of nodes in a vehicle network that represent sensors.
ObdInterface
data ObdInterface Source #
A network interface that specifies the On-board diagnostic (OBD) II network protocol.
See: newObdInterface smart constructor.
Constructors
| ObdInterface' | |
Fields
| |
Instances
Create a value of ObdInterface 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:dtcRequestIntervalSeconds:ObdInterface', obdInterface_dtcRequestIntervalSeconds - The maximum number message requests per diagnostic trouble code per
second.
$sel:hasTransmissionEcu:ObdInterface', obdInterface_hasTransmissionEcu - Whether the vehicle has a transmission control module (TCM).
$sel:obdStandard:ObdInterface', obdInterface_obdStandard - The standard OBD II PID.
$sel:pidRequestIntervalSeconds:ObdInterface', obdInterface_pidRequestIntervalSeconds - The maximum number message requests per second.
$sel:useExtendedIds:ObdInterface', obdInterface_useExtendedIds - Whether to use extended IDs in the message.
$sel:name:ObdInterface', obdInterface_name - The name of the interface.
$sel:requestMessageId:ObdInterface', obdInterface_requestMessageId - The ID of the message requesting vehicle data.
obdInterface_dtcRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural) Source #
The maximum number message requests per diagnostic trouble code per second.
obdInterface_hasTransmissionEcu :: Lens' ObdInterface (Maybe Bool) Source #
Whether the vehicle has a transmission control module (TCM).
obdInterface_obdStandard :: Lens' ObdInterface (Maybe Text) Source #
The standard OBD II PID.
obdInterface_pidRequestIntervalSeconds :: Lens' ObdInterface (Maybe Natural) Source #
The maximum number message requests per second.
obdInterface_useExtendedIds :: Lens' ObdInterface (Maybe Bool) Source #
Whether to use extended IDs in the message.
obdInterface_name :: Lens' ObdInterface Text Source #
The name of the interface.
obdInterface_requestMessageId :: Lens' ObdInterface Natural Source #
The ID of the message requesting vehicle data.
ObdSignal
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
See: newObdSignal smart constructor.
Constructors
| ObdSignal' | |
Fields
| |
Instances
Create a value of ObdSignal 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:bitMaskLength:ObdSignal', obdSignal_bitMaskLength - The number of bits to mask in a message.
$sel:bitRightShift:ObdSignal', obdSignal_bitRightShift - The number of positions to shift bits in the message.
$sel:pidResponseLength:ObdSignal', obdSignal_pidResponseLength - The length of the requested data.
$sel:serviceMode:ObdSignal', obdSignal_serviceMode - The mode of operation (diagnostic service) in a message.
$sel:pid:ObdSignal', obdSignal_pid - The diagnostic code used to request data from a vehicle for this signal.
$sel:scaling:ObdSignal', obdSignal_scaling - A multiplier used to decode the message.
$sel:offset:ObdSignal', obdSignal_offset - Indicates where data appears in the message.
$sel:startByte:ObdSignal', obdSignal_startByte - Indicates the beginning of the message.
$sel:byteLength:ObdSignal', obdSignal_byteLength - The length of a message.
obdSignal_bitMaskLength :: Lens' ObdSignal (Maybe Natural) Source #
The number of bits to mask in a message.
obdSignal_bitRightShift :: Lens' ObdSignal (Maybe Natural) Source #
The number of positions to shift bits in the message.
obdSignal_serviceMode :: Lens' ObdSignal Natural Source #
The mode of operation (diagnostic service) in a message.
obdSignal_pid :: Lens' ObdSignal Natural Source #
The diagnostic code used to request data from a vehicle for this signal.
Sensor
An input component that reports the environmental condition of a vehicle.
You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
See: newSensor smart constructor.
Constructors
| Sensor' | |
Fields
| |
Instances
Create a value of Sensor 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:allowedValues:Sensor', sensor_allowedValues - A list of possible values a sensor can take.
$sel:description:Sensor', sensor_description - A brief description of a sensor.
$sel:max:Sensor', sensor_max - The specified possible maximum value of the sensor.
$sel:min:Sensor', sensor_min - The specified possible minimum value of the sensor.
$sel:unit:Sensor', sensor_unit - The scientific unit of measurement for data collected by the sensor.
$sel:fullyQualifiedName:Sensor', sensor_fullyQualifiedName - The fully qualified name of the sensor. For example, the fully qualified
name of a sensor might be Vehicle.Body.Engine.Battery.
$sel:dataType:Sensor', sensor_dataType - The specified data type of the sensor.
sensor_allowedValues :: Lens' Sensor (Maybe [Text]) Source #
A list of possible values a sensor can take.
sensor_max :: Lens' Sensor (Maybe Double) Source #
The specified possible maximum value of the sensor.
sensor_min :: Lens' Sensor (Maybe Double) Source #
The specified possible minimum value of the sensor.
sensor_unit :: Lens' Sensor (Maybe Text) Source #
The scientific unit of measurement for data collected by the sensor.
sensor_fullyQualifiedName :: Lens' Sensor Text Source #
The fully qualified name of the sensor. For example, the fully qualified
name of a sensor might be Vehicle.Body.Engine.Battery.
sensor_dataType :: Lens' Sensor NodeDataType Source #
The specified data type of the sensor.
SignalCatalogSummary
data SignalCatalogSummary Source #
Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
See: newSignalCatalogSummary smart constructor.
Constructors
| SignalCatalogSummary' | |
Fields
| |
Instances
newSignalCatalogSummary :: SignalCatalogSummary Source #
Create a value of SignalCatalogSummary 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:arn:SignalCatalogSummary', signalCatalogSummary_arn - The Amazon Resource Name (ARN) of the signal catalog.
$sel:creationTime:SignalCatalogSummary', signalCatalogSummary_creationTime - The time the signal catalog was created in seconds since epoch (January
1, 1970 at midnight UTC time).
$sel:lastModificationTime:SignalCatalogSummary', signalCatalogSummary_lastModificationTime - The time the signal catalog was last updated in seconds since epoch
(January 1, 1970 at midnight UTC time).
$sel:name:SignalCatalogSummary', signalCatalogSummary_name - The name of the signal catalog.
signalCatalogSummary_arn :: Lens' SignalCatalogSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the signal catalog.
signalCatalogSummary_creationTime :: Lens' SignalCatalogSummary (Maybe UTCTime) Source #
The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
signalCatalogSummary_lastModificationTime :: Lens' SignalCatalogSummary (Maybe UTCTime) Source #
The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
signalCatalogSummary_name :: Lens' SignalCatalogSummary (Maybe Text) Source #
The name of the signal catalog.
SignalDecoder
data SignalDecoder Source #
Information about a signal decoder.
See: newSignalDecoder smart constructor.
Constructors
| SignalDecoder' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SignalDecoderType | |
| -> Text | |
| -> SignalDecoder |
Create a value of SignalDecoder 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:canSignal:SignalDecoder', signalDecoder_canSignal - Information about signal decoder using the Controller Area Network (CAN)
protocol.
$sel:obdSignal:SignalDecoder', signalDecoder_obdSignal - Information about signal decoder using the On-board diagnostic (OBD) II
protocol.
$sel:fullyQualifiedName:SignalDecoder', signalDecoder_fullyQualifiedName - The fully qualified name of a signal decoder as defined in a vehicle
model.
$sel:type':SignalDecoder', signalDecoder_type - The network protocol for the vehicle. For example, CAN_SIGNAL
specifies a protocol that defines how data is communicated between
electronic control units (ECUs). OBD_SIGNAL specifies a protocol that
defines how self-diagnostic data is communicated between ECUs.
$sel:interfaceId:SignalDecoder', signalDecoder_interfaceId - The ID of a network interface that specifies what network protocol a
vehicle follows.
signalDecoder_canSignal :: Lens' SignalDecoder (Maybe CanSignal) Source #
Information about signal decoder using the Controller Area Network (CAN) protocol.
signalDecoder_obdSignal :: Lens' SignalDecoder (Maybe ObdSignal) Source #
Information about signal decoder using the On-board diagnostic (OBD) II protocol.
signalDecoder_fullyQualifiedName :: Lens' SignalDecoder Text Source #
The fully qualified name of a signal decoder as defined in a vehicle model.
signalDecoder_type :: Lens' SignalDecoder SignalDecoderType Source #
The network protocol for the vehicle. For example, CAN_SIGNAL
specifies a protocol that defines how data is communicated between
electronic control units (ECUs). OBD_SIGNAL specifies a protocol that
defines how self-diagnostic data is communicated between ECUs.
signalDecoder_interfaceId :: Lens' SignalDecoder Text Source #
The ID of a network interface that specifies what network protocol a vehicle follows.
SignalInformation
data SignalInformation Source #
Information about a signal.
See: newSignalInformation smart constructor.
Constructors
| SignalInformation' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> SignalInformation |
Create a value of SignalInformation 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:maxSampleCount:SignalInformation', signalInformation_maxSampleCount - The maximum number of samples to collect.
$sel:minimumSamplingIntervalMs:SignalInformation', signalInformation_minimumSamplingIntervalMs - The minimum duration of time (in milliseconds) between two triggering
events to collect data.
If a signal changes often, you might want to collect data at a slower rate.
$sel:name:SignalInformation', signalInformation_name - The name of the signal.
signalInformation_maxSampleCount :: Lens' SignalInformation (Maybe Natural) Source #
The maximum number of samples to collect.
signalInformation_minimumSamplingIntervalMs :: Lens' SignalInformation (Maybe Natural) Source #
The minimum duration of time (in milliseconds) between two triggering events to collect data.
If a signal changes often, you might want to collect data at a slower rate.
signalInformation_name :: Lens' SignalInformation Text Source #
The name of the signal.
Tag
A set of key/value pairs that are used to manage the resource.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.IoTFleetWise.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.IoTFleetWise.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.IoTFleetWise.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.IoTFleetWise.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.IoTFleetWise.Types.Tag" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:key:Tag', tag_key - The tag's key.
$sel:value:Tag', tag_value - The tag's value.
TimeBasedCollectionScheme
data TimeBasedCollectionScheme Source #
Information about a collection scheme that uses a time period to decide how often to collect data.
See: newTimeBasedCollectionScheme smart constructor.
Constructors
| TimeBasedCollectionScheme' | |
Instances
newTimeBasedCollectionScheme Source #
Create a value of TimeBasedCollectionScheme 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:periodMs:TimeBasedCollectionScheme', timeBasedCollectionScheme_periodMs - The time period (in milliseconds) to decide how often to collect data.
For example, if the time period is 60000, the Edge Agent software
collects data once every minute.
timeBasedCollectionScheme_periodMs :: Lens' TimeBasedCollectionScheme Natural Source #
The time period (in milliseconds) to decide how often to collect data.
For example, if the time period is 60000, the Edge Agent software
collects data once every minute.
TimestreamRegistrationResponse
data TimestreamRegistrationResponse Source #
Information about the registered Amazon Timestream resources or errors, if any.
See: newTimestreamRegistrationResponse smart constructor.
Constructors
| TimestreamRegistrationResponse' | |
Fields
| |
Instances
newTimestreamRegistrationResponse Source #
Arguments
| :: Text | |
| -> Text | |
| -> RegistrationStatus | |
| -> TimestreamRegistrationResponse |
Create a value of TimestreamRegistrationResponse 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:errorMessage:TimestreamRegistrationResponse', timestreamRegistrationResponse_errorMessage - A message associated with a registration error.
$sel:timestreamDatabaseArn:TimestreamRegistrationResponse', timestreamRegistrationResponse_timestreamDatabaseArn - The Amazon Resource Name (ARN) of the Timestream database.
$sel:timestreamTableArn:TimestreamRegistrationResponse', timestreamRegistrationResponse_timestreamTableArn - The ARN of the Timestream database table.
$sel:timestreamDatabaseName:TimestreamRegistrationResponse', timestreamRegistrationResponse_timestreamDatabaseName - The name of the Timestream database.
$sel:timestreamTableName:TimestreamRegistrationResponse', timestreamRegistrationResponse_timestreamTableName - The name of the Timestream database table.
$sel:registrationStatus:TimestreamRegistrationResponse', timestreamRegistrationResponse_registrationStatus - The status of registering your Amazon Timestream resources. The status
can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING,
REGISTRATION_FAILURE.
timestreamRegistrationResponse_errorMessage :: Lens' TimestreamRegistrationResponse (Maybe Text) Source #
A message associated with a registration error.
timestreamRegistrationResponse_timestreamDatabaseArn :: Lens' TimestreamRegistrationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Timestream database.
timestreamRegistrationResponse_timestreamTableArn :: Lens' TimestreamRegistrationResponse (Maybe Text) Source #
The ARN of the Timestream database table.
timestreamRegistrationResponse_timestreamDatabaseName :: Lens' TimestreamRegistrationResponse Text Source #
The name of the Timestream database.
timestreamRegistrationResponse_timestreamTableName :: Lens' TimestreamRegistrationResponse Text Source #
The name of the Timestream database table.
timestreamRegistrationResponse_registrationStatus :: Lens' TimestreamRegistrationResponse RegistrationStatus Source #
The status of registering your Amazon Timestream resources. The status
can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING,
REGISTRATION_FAILURE.
TimestreamResources
data TimestreamResources Source #
The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer your vehicle data to.
See: newTimestreamResources smart constructor.
Constructors
| TimestreamResources' | |
Fields
| |
Instances
newTimestreamResources Source #
Arguments
| :: Text | |
| -> Text | |
| -> TimestreamResources |
Create a value of TimestreamResources 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:timestreamDatabaseName:TimestreamResources', timestreamResources_timestreamDatabaseName - The name of the registered Amazon Timestream database.
$sel:timestreamTableName:TimestreamResources', timestreamResources_timestreamTableName - The name of the registered Amazon Timestream database table.
timestreamResources_timestreamDatabaseName :: Lens' TimestreamResources Text Source #
The name of the registered Amazon Timestream database.
timestreamResources_timestreamTableName :: Lens' TimestreamResources Text Source #
The name of the registered Amazon Timestream database table.
UpdateVehicleError
data UpdateVehicleError Source #
An HTTP error resulting from updating the description for a vehicle.
See: newUpdateVehicleError smart constructor.
Constructors
| UpdateVehicleError' | |
Instances
newUpdateVehicleError :: UpdateVehicleError Source #
Create a value of UpdateVehicleError 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:code:UpdateVehicleError', updateVehicleError_code - The relevant HTTP error code (400+).
$sel:message:UpdateVehicleError', updateVehicleError_message - A message associated with the error.
$sel:vehicleName:UpdateVehicleError', updateVehicleError_vehicleName - The ID of the vehicle with the error.
updateVehicleError_code :: Lens' UpdateVehicleError (Maybe Int) Source #
The relevant HTTP error code (400+).
updateVehicleError_message :: Lens' UpdateVehicleError (Maybe Text) Source #
A message associated with the error.
updateVehicleError_vehicleName :: Lens' UpdateVehicleError (Maybe Text) Source #
The ID of the vehicle with the error.
UpdateVehicleRequestItem
data UpdateVehicleRequestItem Source #
Information about the vehicle to update.
See: newUpdateVehicleRequestItem smart constructor.
Constructors
| UpdateVehicleRequestItem' | |
Fields
| |
Instances
newUpdateVehicleRequestItem Source #
Create a value of UpdateVehicleRequestItem 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:attributeUpdateMode:UpdateVehicleRequestItem', updateVehicleRequestItem_attributeUpdateMode - The method the specified attributes will update the existing attributes
on the vehicle. UseOverwite to replace the vehicle attributes with the
specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
$sel:attributes:UpdateVehicleRequestItem', updateVehicleRequestItem_attributes - Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
$sel:decoderManifestArn:UpdateVehicleRequestItem', updateVehicleRequestItem_decoderManifestArn - The ARN of the signal decoder manifest associated with the vehicle to
update.
$sel:modelManifestArn:UpdateVehicleRequestItem', updateVehicleRequestItem_modelManifestArn - The ARN of the vehicle model (model manifest) associated with the
vehicle to update.
$sel:vehicleName:UpdateVehicleRequestItem', updateVehicleRequestItem_vehicleName - The unique ID of the vehicle to update.
updateVehicleRequestItem_attributeUpdateMode :: Lens' UpdateVehicleRequestItem (Maybe UpdateMode) Source #
The method the specified attributes will update the existing attributes
on the vehicle. UseOverwite to replace the vehicle attributes with the
specified attributes. Or use Merge to combine all attributes.
This is required if attributes are present in the input.
updateVehicleRequestItem_attributes :: Lens' UpdateVehicleRequestItem (Maybe (HashMap Text Text)) Source #
Static information about a vehicle in a key-value pair. For example:
"engineType" : "1.3 L R2"
updateVehicleRequestItem_decoderManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text) Source #
The ARN of the signal decoder manifest associated with the vehicle to update.
updateVehicleRequestItem_modelManifestArn :: Lens' UpdateVehicleRequestItem (Maybe Text) Source #
The ARN of the vehicle model (model manifest) associated with the vehicle to update.
updateVehicleRequestItem_vehicleName :: Lens' UpdateVehicleRequestItem Text Source #
The unique ID of the vehicle to update.
UpdateVehicleResponseItem
data UpdateVehicleResponseItem Source #
Information about the updated vehicle.
See: newUpdateVehicleResponseItem smart constructor.
Constructors
| UpdateVehicleResponseItem' | |
Instances
newUpdateVehicleResponseItem :: UpdateVehicleResponseItem Source #
Create a value of UpdateVehicleResponseItem 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:arn:UpdateVehicleResponseItem', updateVehicleResponseItem_arn - The Amazon Resource Name (ARN) of the updated vehicle.
$sel:vehicleName:UpdateVehicleResponseItem', updateVehicleResponseItem_vehicleName - The unique ID of the updated vehicle.
updateVehicleResponseItem_arn :: Lens' UpdateVehicleResponseItem (Maybe Text) Source #
The Amazon Resource Name (ARN) of the updated vehicle.
updateVehicleResponseItem_vehicleName :: Lens' UpdateVehicleResponseItem (Maybe Text) Source #
The unique ID of the updated vehicle.
VehicleStatus
data VehicleStatus Source #
Information about the state of a vehicle and how it relates to the status of a campaign.
See: newVehicleStatus smart constructor.
Constructors
| VehicleStatus' | |
Fields
| |
Instances
newVehicleStatus :: VehicleStatus Source #
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) Source #
The name of a campaign.
vehicleStatus_status :: Lens' VehicleStatus (Maybe VehicleState) Source #
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) Source #
The unique ID of the vehicle.
VehicleSummary
data VehicleSummary Source #
Information about a vehicle.
To return this information about vehicles in your account, you can use the API operation.
See: newVehicleSummary smart constructor.
Constructors
| VehicleSummary' | |
Fields
| |
Instances
Create a value of VehicleSummary 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:vehicleName:VehicleSummary', vehicleSummary_vehicleName - The unique ID of the vehicle.
$sel:arn:VehicleSummary', vehicleSummary_arn - The Amazon Resource Name (ARN) of the vehicle.
$sel:modelManifestArn:VehicleSummary', vehicleSummary_modelManifestArn - The ARN of a vehicle model (model manifest) associated with the vehicle.
$sel:decoderManifestArn:VehicleSummary', vehicleSummary_decoderManifestArn - The ARN of a decoder manifest associated with the vehicle.
$sel:creationTime:VehicleSummary', vehicleSummary_creationTime - The time the vehicle was created in seconds since epoch (January 1, 1970
at midnight UTC time).
$sel:lastModificationTime:VehicleSummary', vehicleSummary_lastModificationTime - The time the vehicle was last updated in seconds since epoch (January 1,
1970 at midnight UTC time).
vehicleSummary_vehicleName :: Lens' VehicleSummary Text Source #
The unique ID of the vehicle.
vehicleSummary_arn :: Lens' VehicleSummary Text Source #
The Amazon Resource Name (ARN) of the vehicle.
vehicleSummary_modelManifestArn :: Lens' VehicleSummary Text Source #
The ARN of a vehicle model (model manifest) associated with the vehicle.
vehicleSummary_decoderManifestArn :: Lens' VehicleSummary Text Source #
The ARN of a decoder manifest associated with the vehicle.
vehicleSummary_creationTime :: Lens' VehicleSummary UTCTime Source #
The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
vehicleSummary_lastModificationTime :: Lens' VehicleSummary UTCTime Source #
The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).