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 |
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateVehicleFleet
- BatchCreateVehicle
- BatchUpdateVehicle
- CreateCampaign
- CreateDecoderManifest
- CreateFleet
- CreateModelManifest
- CreateSignalCatalog
- CreateVehicle
- DeleteCampaign
- DeleteDecoderManifest
- DeleteFleet
- DeleteModelManifest
- DeleteSignalCatalog
- DeleteVehicle
- DisassociateVehicleFleet
- GetCampaign
- GetDecoderManifest
- GetFleet
- GetLoggingOptions
- GetModelManifest
- GetRegisterAccountStatus
- GetSignalCatalog
- GetVehicle
- GetVehicleStatus (Paginated)
- ImportDecoderManifest
- ImportSignalCatalog
- ListCampaigns (Paginated)
- ListDecoderManifestNetworkInterfaces (Paginated)
- ListDecoderManifestSignals (Paginated)
- ListDecoderManifests (Paginated)
- ListFleets (Paginated)
- ListFleetsForVehicle (Paginated)
- ListModelManifestNodes (Paginated)
- ListModelManifests (Paginated)
- ListSignalCatalogNodes (Paginated)
- ListSignalCatalogs (Paginated)
- ListTagsForResource
- ListVehicles (Paginated)
- ListVehiclesInFleet (Paginated)
- PutLoggingOptions
- RegisterAccount
- TagResource
- UntagResource
- UpdateCampaign
- UpdateDecoderManifest
- UpdateFleet
- UpdateModelManifest
- UpdateSignalCatalog
- UpdateVehicle
- Types
- 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
Derived from API version 2021-06-17
of the AWS service descriptions, licensed under Apache 2.0.
Amazon Web Services IoT FleetWise is a fully managed service that you can use to collect, model, and transfer vehicle data to the Amazon Web Services cloud at scale. With Amazon Web Services IoT FleetWise, you can standardize all of your vehicle data models, independent of the in-vehicle communication architecture, and define data collection rules to transfer only high-value data to the cloud.
For more information, see What is Amazon Web Services IoT FleetWise? in the Amazon Web Services IoT FleetWise Developer Guide.
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
- data AssociateVehicleFleet = AssociateVehicleFleet' Text Text
- newAssociateVehicleFleet :: Text -> Text -> AssociateVehicleFleet
- data AssociateVehicleFleetResponse = AssociateVehicleFleetResponse' Int
- newAssociateVehicleFleetResponse :: Int -> AssociateVehicleFleetResponse
- data BatchCreateVehicle = BatchCreateVehicle' [CreateVehicleRequestItem]
- newBatchCreateVehicle :: BatchCreateVehicle
- data BatchCreateVehicleResponse = BatchCreateVehicleResponse' (Maybe [CreateVehicleError]) (Maybe [CreateVehicleResponseItem]) Int
- newBatchCreateVehicleResponse :: Int -> BatchCreateVehicleResponse
- data BatchUpdateVehicle = BatchUpdateVehicle' [UpdateVehicleRequestItem]
- newBatchUpdateVehicle :: BatchUpdateVehicle
- data BatchUpdateVehicleResponse = BatchUpdateVehicleResponse' (Maybe [UpdateVehicleError]) (Maybe [UpdateVehicleResponseItem]) Int
- newBatchUpdateVehicleResponse :: Int -> BatchUpdateVehicleResponse
- data CreateCampaign = CreateCampaign' (Maybe Compression) (Maybe [Text]) (Maybe Text) (Maybe DiagnosticsMode) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe [SignalInformation]) (Maybe SpoolingMode) (Maybe POSIX) (Maybe [Tag]) Text Text Text CollectionScheme
- newCreateCampaign :: Text -> Text -> Text -> CollectionScheme -> CreateCampaign
- data CreateCampaignResponse = CreateCampaignResponse' (Maybe Text) (Maybe Text) Int
- newCreateCampaignResponse :: Int -> CreateCampaignResponse
- data CreateDecoderManifest = CreateDecoderManifest' (Maybe Text) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty SignalDecoder)) (Maybe [Tag]) Text Text
- newCreateDecoderManifest :: Text -> Text -> CreateDecoderManifest
- data CreateDecoderManifestResponse = CreateDecoderManifestResponse' Int Text Text
- newCreateDecoderManifestResponse :: Int -> Text -> Text -> CreateDecoderManifestResponse
- data CreateFleet = CreateFleet' (Maybe Text) (Maybe [Tag]) Text Text
- newCreateFleet :: Text -> Text -> CreateFleet
- data CreateFleetResponse = CreateFleetResponse' Int Text Text
- newCreateFleetResponse :: Int -> Text -> Text -> CreateFleetResponse
- data CreateModelManifest = CreateModelManifest' (Maybe Text) (Maybe [Tag]) Text [Text] Text
- newCreateModelManifest :: Text -> Text -> CreateModelManifest
- data CreateModelManifestResponse = CreateModelManifestResponse' Int Text Text
- newCreateModelManifestResponse :: Int -> Text -> Text -> CreateModelManifestResponse
- data CreateSignalCatalog = CreateSignalCatalog' (Maybe Text) (Maybe [Node]) (Maybe [Tag]) Text
- newCreateSignalCatalog :: Text -> CreateSignalCatalog
- data CreateSignalCatalogResponse = CreateSignalCatalogResponse' Int Text Text
- newCreateSignalCatalogResponse :: Int -> Text -> Text -> CreateSignalCatalogResponse
- data CreateVehicle = CreateVehicle' (Maybe VehicleAssociationBehavior) (Maybe (HashMap Text Text)) (Maybe [Tag]) Text Text Text
- newCreateVehicle :: Text -> Text -> Text -> CreateVehicle
- data CreateVehicleResponse = CreateVehicleResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateVehicleResponse :: Int -> CreateVehicleResponse
- data DeleteCampaign = DeleteCampaign' Text
- newDeleteCampaign :: Text -> DeleteCampaign
- data DeleteCampaignResponse = DeleteCampaignResponse' (Maybe Text) (Maybe Text) Int
- newDeleteCampaignResponse :: Int -> DeleteCampaignResponse
- data DeleteDecoderManifest = DeleteDecoderManifest' Text
- newDeleteDecoderManifest :: Text -> DeleteDecoderManifest
- data DeleteDecoderManifestResponse = DeleteDecoderManifestResponse' Int Text Text
- newDeleteDecoderManifestResponse :: Int -> Text -> Text -> DeleteDecoderManifestResponse
- data DeleteFleet = DeleteFleet' Text
- newDeleteFleet :: Text -> DeleteFleet
- data DeleteFleetResponse = DeleteFleetResponse' (Maybe Text) (Maybe Text) Int
- newDeleteFleetResponse :: Int -> DeleteFleetResponse
- data DeleteModelManifest = DeleteModelManifest' Text
- newDeleteModelManifest :: Text -> DeleteModelManifest
- data DeleteModelManifestResponse = DeleteModelManifestResponse' Int Text Text
- newDeleteModelManifestResponse :: Int -> Text -> Text -> DeleteModelManifestResponse
- data DeleteSignalCatalog = DeleteSignalCatalog' Text
- newDeleteSignalCatalog :: Text -> DeleteSignalCatalog
- data DeleteSignalCatalogResponse = DeleteSignalCatalogResponse' Int Text Text
- newDeleteSignalCatalogResponse :: Int -> Text -> Text -> DeleteSignalCatalogResponse
- data DeleteVehicle = DeleteVehicle' Text
- newDeleteVehicle :: Text -> DeleteVehicle
- data DeleteVehicleResponse = DeleteVehicleResponse' Int Text Text
- newDeleteVehicleResponse :: Int -> Text -> Text -> DeleteVehicleResponse
- data DisassociateVehicleFleet = DisassociateVehicleFleet' Text Text
- newDisassociateVehicleFleet :: Text -> Text -> DisassociateVehicleFleet
- data DisassociateVehicleFleetResponse = DisassociateVehicleFleetResponse' Int
- newDisassociateVehicleFleetResponse :: Int -> DisassociateVehicleFleetResponse
- data GetCampaign = GetCampaign' Text
- newGetCampaign :: Text -> GetCampaign
- data GetCampaignResponse = GetCampaignResponse' (Maybe Text) (Maybe CollectionScheme) (Maybe Compression) (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe DiagnosticsMode) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe [SignalInformation]) (Maybe SpoolingMode) (Maybe POSIX) (Maybe CampaignStatus) (Maybe Text) Int
- newGetCampaignResponse :: Int -> GetCampaignResponse
- data GetDecoderManifest = GetDecoderManifest' Text
- newGetDecoderManifest :: Text -> GetDecoderManifest
- data GetDecoderManifestResponse = GetDecoderManifestResponse' (Maybe Text) (Maybe Text) (Maybe ManifestStatus) Int Text Text POSIX POSIX
- newGetDecoderManifestResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> GetDecoderManifestResponse
- data GetFleet = GetFleet' Text
- newGetFleet :: Text -> GetFleet
- data GetFleetResponse = GetFleetResponse' (Maybe Text) Int Text Text Text POSIX POSIX
- newGetFleetResponse :: Int -> Text -> Text -> Text -> UTCTime -> UTCTime -> GetFleetResponse
- data GetLoggingOptions = GetLoggingOptions' {
- newGetLoggingOptions :: GetLoggingOptions
- data GetLoggingOptionsResponse = GetLoggingOptionsResponse' Int CloudWatchLogDeliveryOptions
- newGetLoggingOptionsResponse :: Int -> CloudWatchLogDeliveryOptions -> GetLoggingOptionsResponse
- data GetModelManifest = GetModelManifest' Text
- newGetModelManifest :: Text -> GetModelManifest
- data GetModelManifestResponse = GetModelManifestResponse' (Maybe Text) (Maybe Text) (Maybe ManifestStatus) Int Text Text POSIX POSIX
- newGetModelManifestResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> GetModelManifestResponse
- data GetRegisterAccountStatus = GetRegisterAccountStatus' {
- newGetRegisterAccountStatus :: GetRegisterAccountStatus
- data GetRegisterAccountStatusResponse = GetRegisterAccountStatusResponse' Int Text RegistrationStatus TimestreamRegistrationResponse IamRegistrationResponse POSIX POSIX
- newGetRegisterAccountStatusResponse :: Int -> Text -> RegistrationStatus -> TimestreamRegistrationResponse -> IamRegistrationResponse -> UTCTime -> UTCTime -> GetRegisterAccountStatusResponse
- data GetSignalCatalog = GetSignalCatalog' Text
- newGetSignalCatalog :: Text -> GetSignalCatalog
- data GetSignalCatalogResponse = GetSignalCatalogResponse' (Maybe Text) (Maybe NodeCounts) Int Text Text POSIX POSIX
- newGetSignalCatalogResponse :: Int -> Text -> Text -> UTCTime -> UTCTime -> GetSignalCatalogResponse
- data GetVehicle = GetVehicle' Text
- newGetVehicle :: Text -> GetVehicle
- data GetVehicleResponse = GetVehicleResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newGetVehicleResponse :: Int -> GetVehicleResponse
- data GetVehicleStatus = GetVehicleStatus' (Maybe Natural) (Maybe Text) Text
- newGetVehicleStatus :: Text -> GetVehicleStatus
- data GetVehicleStatusResponse = GetVehicleStatusResponse' (Maybe [VehicleStatus]) (Maybe Text) Int
- newGetVehicleStatusResponse :: Int -> GetVehicleStatusResponse
- data ImportDecoderManifest = ImportDecoderManifest' Text [NetworkFileDefinition]
- newImportDecoderManifest :: Text -> ImportDecoderManifest
- data ImportDecoderManifestResponse = ImportDecoderManifestResponse' Int Text Text
- newImportDecoderManifestResponse :: Int -> Text -> Text -> ImportDecoderManifestResponse
- data ImportSignalCatalog = ImportSignalCatalog' (Maybe Text) (Maybe [Tag]) (Maybe FormattedVss) Text
- newImportSignalCatalog :: Text -> ImportSignalCatalog
- data ImportSignalCatalogResponse = ImportSignalCatalogResponse' Int Text Text
- newImportSignalCatalogResponse :: Int -> Text -> Text -> ImportSignalCatalogResponse
- data ListCampaigns = ListCampaigns' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListCampaigns :: ListCampaigns
- data ListCampaignsResponse = ListCampaignsResponse' (Maybe [CampaignSummary]) (Maybe Text) Int
- newListCampaignsResponse :: Int -> ListCampaignsResponse
- data ListDecoderManifestNetworkInterfaces = ListDecoderManifestNetworkInterfaces' (Maybe Natural) (Maybe Text) Text
- newListDecoderManifestNetworkInterfaces :: Text -> ListDecoderManifestNetworkInterfaces
- data ListDecoderManifestNetworkInterfacesResponse = ListDecoderManifestNetworkInterfacesResponse' (Maybe (NonEmpty NetworkInterface)) (Maybe Text) Int
- newListDecoderManifestNetworkInterfacesResponse :: Int -> ListDecoderManifestNetworkInterfacesResponse
- data ListDecoderManifestSignals = ListDecoderManifestSignals' (Maybe Natural) (Maybe Text) Text
- newListDecoderManifestSignals :: Text -> ListDecoderManifestSignals
- data ListDecoderManifestSignalsResponse = ListDecoderManifestSignalsResponse' (Maybe Text) (Maybe (NonEmpty SignalDecoder)) Int
- newListDecoderManifestSignalsResponse :: Int -> ListDecoderManifestSignalsResponse
- data ListDecoderManifests = ListDecoderManifests' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListDecoderManifests :: ListDecoderManifests
- data ListDecoderManifestsResponse = ListDecoderManifestsResponse' (Maybe Text) (Maybe [DecoderManifestSummary]) Int
- newListDecoderManifestsResponse :: Int -> ListDecoderManifestsResponse
- data ListFleets = ListFleets' (Maybe Natural) (Maybe Text)
- newListFleets :: ListFleets
- data ListFleetsResponse = ListFleetsResponse' (Maybe [FleetSummary]) (Maybe Text) Int
- newListFleetsResponse :: Int -> ListFleetsResponse
- data ListFleetsForVehicle = ListFleetsForVehicle' (Maybe Natural) (Maybe Text) Text
- newListFleetsForVehicle :: Text -> ListFleetsForVehicle
- data ListFleetsForVehicleResponse = ListFleetsForVehicleResponse' (Maybe [Text]) (Maybe Text) Int
- newListFleetsForVehicleResponse :: Int -> ListFleetsForVehicleResponse
- data ListModelManifestNodes = ListModelManifestNodes' (Maybe Natural) (Maybe Text) Text
- newListModelManifestNodes :: Text -> ListModelManifestNodes
- data ListModelManifestNodesResponse = ListModelManifestNodesResponse' (Maybe Text) (Maybe [Node]) Int
- newListModelManifestNodesResponse :: Int -> ListModelManifestNodesResponse
- data ListModelManifests = ListModelManifests' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListModelManifests :: ListModelManifests
- data ListModelManifestsResponse = ListModelManifestsResponse' (Maybe Text) (Maybe [ModelManifestSummary]) Int
- newListModelManifestsResponse :: Int -> ListModelManifestsResponse
- data ListSignalCatalogNodes = ListSignalCatalogNodes' (Maybe Natural) (Maybe Text) Text
- newListSignalCatalogNodes :: Text -> ListSignalCatalogNodes
- data ListSignalCatalogNodesResponse = ListSignalCatalogNodesResponse' (Maybe Text) (Maybe [Node]) Int
- newListSignalCatalogNodesResponse :: Int -> ListSignalCatalogNodesResponse
- data ListSignalCatalogs = ListSignalCatalogs' (Maybe Natural) (Maybe Text)
- newListSignalCatalogs :: ListSignalCatalogs
- data ListSignalCatalogsResponse = ListSignalCatalogsResponse' (Maybe Text) (Maybe [SignalCatalogSummary]) Int
- newListSignalCatalogsResponse :: Int -> ListSignalCatalogsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListVehicles = ListVehicles' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListVehicles :: ListVehicles
- data ListVehiclesResponse = ListVehiclesResponse' (Maybe Text) (Maybe [VehicleSummary]) Int
- newListVehiclesResponse :: Int -> ListVehiclesResponse
- data ListVehiclesInFleet = ListVehiclesInFleet' (Maybe Natural) (Maybe Text) Text
- newListVehiclesInFleet :: Text -> ListVehiclesInFleet
- data ListVehiclesInFleetResponse = ListVehiclesInFleetResponse' (Maybe Text) (Maybe [Text]) Int
- newListVehiclesInFleetResponse :: Int -> ListVehiclesInFleetResponse
- data PutLoggingOptions = PutLoggingOptions' CloudWatchLogDeliveryOptions
- newPutLoggingOptions :: CloudWatchLogDeliveryOptions -> PutLoggingOptions
- data PutLoggingOptionsResponse = PutLoggingOptionsResponse' Int
- newPutLoggingOptionsResponse :: Int -> PutLoggingOptionsResponse
- data RegisterAccount = RegisterAccount' (Maybe IamResources) TimestreamResources
- newRegisterAccount :: TimestreamResources -> RegisterAccount
- data RegisterAccountResponse = RegisterAccountResponse' Int RegistrationStatus TimestreamResources IamResources POSIX POSIX
- newRegisterAccountResponse :: Int -> RegistrationStatus -> TimestreamResources -> IamResources -> UTCTime -> UTCTime -> RegisterAccountResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateCampaign = UpdateCampaign' (Maybe [Text]) (Maybe Text) Text UpdateCampaignAction
- newUpdateCampaign :: Text -> UpdateCampaignAction -> UpdateCampaign
- data UpdateCampaignResponse = UpdateCampaignResponse' (Maybe Text) (Maybe Text) (Maybe CampaignStatus) Int
- newUpdateCampaignResponse :: Int -> UpdateCampaignResponse
- data UpdateDecoderManifest = UpdateDecoderManifest' (Maybe Text) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty SignalDecoder)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty SignalDecoder)) (Maybe ManifestStatus) Text
- newUpdateDecoderManifest :: Text -> UpdateDecoderManifest
- data UpdateDecoderManifestResponse = UpdateDecoderManifestResponse' Int Text Text
- newUpdateDecoderManifestResponse :: Int -> Text -> Text -> UpdateDecoderManifestResponse
- data UpdateFleet = UpdateFleet' (Maybe Text) Text
- newUpdateFleet :: Text -> UpdateFleet
- data UpdateFleetResponse = UpdateFleetResponse' (Maybe Text) (Maybe Text) Int
- newUpdateFleetResponse :: Int -> UpdateFleetResponse
- data UpdateModelManifest = UpdateModelManifest' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe ManifestStatus) Text
- newUpdateModelManifest :: Text -> UpdateModelManifest
- data UpdateModelManifestResponse = UpdateModelManifestResponse' Int Text Text
- newUpdateModelManifestResponse :: Int -> Text -> Text -> UpdateModelManifestResponse
- data UpdateSignalCatalog = UpdateSignalCatalog' (Maybe Text) (Maybe [Node]) (Maybe (NonEmpty Text)) (Maybe [Node]) Text
- newUpdateSignalCatalog :: Text -> UpdateSignalCatalog
- data UpdateSignalCatalogResponse = UpdateSignalCatalogResponse' Int Text Text
- newUpdateSignalCatalogResponse :: Int -> Text -> Text -> UpdateSignalCatalogResponse
- data UpdateVehicle = UpdateVehicle' (Maybe UpdateMode) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Text
- newUpdateVehicle :: Text -> UpdateVehicle
- data UpdateVehicleResponse = UpdateVehicleResponse' (Maybe Text) (Maybe Text) Int
- newUpdateVehicleResponse :: Int -> UpdateVehicleResponse
- 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' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Text) Text NodeDataType
- newActuator :: Text -> NodeDataType -> Actuator
- data Attribute = Attribute' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Text) Text NodeDataType
- newAttribute :: Text -> NodeDataType -> Attribute
- data Branch = Branch' (Maybe Text) Text
- newBranch :: Text -> Branch
- data CampaignSummary = CampaignSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CampaignStatus) (Maybe Text) POSIX POSIX
- newCampaignSummary :: UTCTime -> UTCTime -> CampaignSummary
- data CanDbcDefinition = CanDbcDefinition' (Maybe (HashMap Text Text)) Text (NonEmpty Base64)
- newCanDbcDefinition :: Text -> NonEmpty ByteString -> CanDbcDefinition
- data CanInterface = CanInterface' (Maybe Text) (Maybe Text) Text
- newCanInterface :: Text -> CanInterface
- data CanSignal = CanSignal' (Maybe Text) Natural Bool Bool Natural Double Double Natural
- newCanSignal :: Natural -> Bool -> Bool -> Natural -> Double -> Double -> Natural -> CanSignal
- data CloudWatchLogDeliveryOptions = CloudWatchLogDeliveryOptions' (Maybe Text) LogType
- newCloudWatchLogDeliveryOptions :: LogType -> CloudWatchLogDeliveryOptions
- data CollectionScheme = CollectionScheme' (Maybe ConditionBasedCollectionScheme) (Maybe TimeBasedCollectionScheme)
- newCollectionScheme :: CollectionScheme
- data ConditionBasedCollectionScheme = ConditionBasedCollectionScheme' (Maybe Natural) (Maybe Natural) (Maybe TriggerMode) Text
- newConditionBasedCollectionScheme :: Text -> ConditionBasedCollectionScheme
- data CreateVehicleError = CreateVehicleError' (Maybe Text) (Maybe Text) (Maybe Text)
- newCreateVehicleError :: CreateVehicleError
- data CreateVehicleRequestItem = CreateVehicleRequestItem' (Maybe VehicleAssociationBehavior) (Maybe (HashMap Text Text)) (Maybe [Tag]) Text Text Text
- newCreateVehicleRequestItem :: Text -> Text -> Text -> CreateVehicleRequestItem
- data CreateVehicleResponseItem = CreateVehicleResponseItem' (Maybe Text) (Maybe Text) (Maybe Text)
- newCreateVehicleResponseItem :: CreateVehicleResponseItem
- data DecoderManifestSummary = DecoderManifestSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManifestStatus) POSIX POSIX
- newDecoderManifestSummary :: UTCTime -> UTCTime -> DecoderManifestSummary
- data FleetSummary = FleetSummary' (Maybe Text) (Maybe POSIX) Text Text Text POSIX
- newFleetSummary :: Text -> Text -> Text -> UTCTime -> FleetSummary
- data FormattedVss = FormattedVss' (Maybe Text)
- newFormattedVss :: FormattedVss
- data IamRegistrationResponse = IamRegistrationResponse' (Maybe Text) Text RegistrationStatus
- newIamRegistrationResponse :: Text -> RegistrationStatus -> IamRegistrationResponse
- data IamResources = IamResources' Text
- newIamResources :: Text -> IamResources
- data ModelManifestSummary = ModelManifestSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManifestStatus) POSIX POSIX
- newModelManifestSummary :: UTCTime -> UTCTime -> ModelManifestSummary
- data NetworkFileDefinition = NetworkFileDefinition' (Maybe CanDbcDefinition)
- newNetworkFileDefinition :: NetworkFileDefinition
- data NetworkInterface = NetworkInterface' (Maybe CanInterface) (Maybe ObdInterface) Text NetworkInterfaceType
- newNetworkInterface :: Text -> NetworkInterfaceType -> NetworkInterface
- data Node = Node' (Maybe Actuator) (Maybe Attribute) (Maybe Branch) (Maybe Sensor)
- newNode :: Node
- data NodeCounts = NodeCounts' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newNodeCounts :: NodeCounts
- data ObdInterface = ObdInterface' (Maybe Natural) (Maybe Bool) (Maybe Text) (Maybe Natural) (Maybe Bool) Text Natural
- newObdInterface :: Text -> Natural -> ObdInterface
- data ObdSignal = ObdSignal' (Maybe Natural) (Maybe Natural) Natural Natural Natural Double Double Natural Natural
- newObdSignal :: Natural -> Natural -> Natural -> Double -> Double -> Natural -> Natural -> ObdSignal
- data Sensor = Sensor' (Maybe [Text]) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Text) Text NodeDataType
- newSensor :: Text -> NodeDataType -> Sensor
- data SignalCatalogSummary = SignalCatalogSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newSignalCatalogSummary :: SignalCatalogSummary
- data SignalDecoder = SignalDecoder' (Maybe CanSignal) (Maybe ObdSignal) Text SignalDecoderType Text
- newSignalDecoder :: Text -> SignalDecoderType -> Text -> SignalDecoder
- data SignalInformation = SignalInformation' (Maybe Natural) (Maybe Natural) Text
- newSignalInformation :: Text -> SignalInformation
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
- data TimeBasedCollectionScheme = TimeBasedCollectionScheme' Natural
- newTimeBasedCollectionScheme :: Natural -> TimeBasedCollectionScheme
- data TimestreamRegistrationResponse = TimestreamRegistrationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Text Text RegistrationStatus
- newTimestreamRegistrationResponse :: Text -> Text -> RegistrationStatus -> TimestreamRegistrationResponse
- data TimestreamResources = TimestreamResources' Text Text
- newTimestreamResources :: Text -> Text -> TimestreamResources
- data UpdateVehicleError = UpdateVehicleError' (Maybe Int) (Maybe Text) (Maybe Text)
- newUpdateVehicleError :: UpdateVehicleError
- data UpdateVehicleRequestItem = UpdateVehicleRequestItem' (Maybe UpdateMode) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Text
- newUpdateVehicleRequestItem :: Text -> UpdateVehicleRequestItem
- data UpdateVehicleResponseItem = UpdateVehicleResponseItem' (Maybe Text) (Maybe Text)
- newUpdateVehicleResponseItem :: UpdateVehicleResponseItem
- data VehicleStatus = VehicleStatus' (Maybe Text) (Maybe VehicleState) (Maybe Text)
- newVehicleStatus :: VehicleStatus
- data VehicleSummary = VehicleSummary' Text Text Text Text POSIX POSIX
- newVehicleSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> VehicleSummary
Service Configuration
defaultService :: Service Source #
API version 2021-06-17
of the Amazon IoT FleetWise SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by IoTFleetWise
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You don't have sufficient permission to perform this action.
ConflictException
_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
_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
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because the server temporarily failed.
InvalidNodeException
_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
_InvalidSignalsException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed because it contains signals that aren't valid.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A service quota was exceeded.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The resource wasn't found.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request couldn't be completed due to throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateVehicleFleet
data AssociateVehicleFleet Source #
See: newAssociateVehicleFleet
smart constructor.
Instances
newAssociateVehicleFleet Source #
Create a value of AssociateVehicleFleet
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:
AssociateVehicleFleet
, associateVehicleFleet_vehicleName
- The unique ID of the vehicle to associate with the fleet.
$sel:fleetId:AssociateVehicleFleet'
, associateVehicleFleet_fleetId
- The ID of a fleet.
data AssociateVehicleFleetResponse Source #
See: newAssociateVehicleFleetResponse
smart constructor.
Instances
newAssociateVehicleFleetResponse Source #
Create a value of AssociateVehicleFleetResponse
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:httpStatus:AssociateVehicleFleetResponse'
, associateVehicleFleetResponse_httpStatus
- The response's http status code.
BatchCreateVehicle
data BatchCreateVehicle Source #
See: newBatchCreateVehicle
smart constructor.
Instances
newBatchCreateVehicle :: BatchCreateVehicle Source #
Create a value of BatchCreateVehicle
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:
BatchCreateVehicle
, batchCreateVehicle_vehicles
- A list of information about each vehicle to create. For more
information, see the API data type.
data BatchCreateVehicleResponse Source #
See: newBatchCreateVehicleResponse
smart constructor.
Instances
newBatchCreateVehicleResponse Source #
Create a value of BatchCreateVehicleResponse
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:errors:BatchCreateVehicleResponse'
, batchCreateVehicleResponse_errors
- A list of information about creation errors, or an empty list if there
aren't any errors.
BatchCreateVehicle
, batchCreateVehicleResponse_vehicles
- A list of information about a batch of created vehicles. For more
information, see the API data type.
$sel:httpStatus:BatchCreateVehicleResponse'
, batchCreateVehicleResponse_httpStatus
- The response's http status code.
BatchUpdateVehicle
data BatchUpdateVehicle Source #
See: newBatchUpdateVehicle
smart constructor.
Instances
newBatchUpdateVehicle :: BatchUpdateVehicle Source #
Create a value of BatchUpdateVehicle
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:
BatchUpdateVehicle
, batchUpdateVehicle_vehicles
- A list of information about the vehicles to update. For more
information, see the API data type.
data BatchUpdateVehicleResponse Source #
See: newBatchUpdateVehicleResponse
smart constructor.
Instances
newBatchUpdateVehicleResponse Source #
Create a value of BatchUpdateVehicleResponse
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:errors:BatchUpdateVehicleResponse'
, batchUpdateVehicleResponse_errors
- A list of information about errors returned while updating a batch of
vehicles, or, if there aren't any errors, an empty list.
BatchUpdateVehicle
, batchUpdateVehicleResponse_vehicles
- A list of information about the batch of updated vehicles.
This list contains only unique IDs for the vehicles that were updated.
$sel:httpStatus:BatchUpdateVehicleResponse'
, batchUpdateVehicleResponse_httpStatus
- The response's http status code.
CreateCampaign
data CreateCampaign Source #
See: newCreateCampaign
smart constructor.
CreateCampaign' (Maybe Compression) (Maybe [Text]) (Maybe Text) (Maybe DiagnosticsMode) (Maybe POSIX) (Maybe Natural) (Maybe Natural) (Maybe [SignalInformation]) (Maybe SpoolingMode) (Maybe POSIX) (Maybe [Tag]) Text Text Text CollectionScheme |
Instances
:: Text | |
-> Text | |
-> Text | |
-> CollectionScheme | |
-> CreateCampaign |
Create a value of CreateCampaign
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:compression:CreateCampaign'
, createCampaign_compression
- (Optional) Whether to compress signals before transmitting data to
Amazon Web Services IoT FleetWise. If you don't want to compress the
signals, use OFF
. If it's not specified, SNAPPY
is used.
Default: SNAPPY
$sel:dataExtraDimensions:CreateCampaign'
, createCampaign_dataExtraDimensions
- (Optional) A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add
make
and model
to the campaign, and Amazon Web Services IoT
FleetWise will associate the data with those attributes as dimensions in
Amazon Timestream. You can then query the data against make
and
model
.
Default: An empty array
CreateCampaign
, createCampaign_description
- An optional description of the campaign to help identify its purpose.
$sel:diagnosticsMode:CreateCampaign'
, createCampaign_diagnosticsMode
- (Optional) Option for a vehicle to send diagnostic trouble codes to
Amazon Web Services IoT FleetWise. If you want to send diagnostic
trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is
used.
Default: OFF
$sel:expiryTime:CreateCampaign'
, createCampaign_expiryTime
- (Optional) The time the campaign expires, in seconds since epoch
(January 1, 1970 at midnight UTC time). Vehicle data won't be collected
after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
$sel:postTriggerCollectionDuration:CreateCampaign'
, createCampaign_postTriggerCollectionDuration
- (Optional) How long (in milliseconds) to collect raw data after a
triggering event initiates the collection. If it's not specified, 0
is used.
Default: 0
$sel:priority:CreateCampaign'
, createCampaign_priority
- (Optional) A number indicating the priority of one campaign over another
campaign for a certain vehicle or fleet. A campaign with the lowest
value is deployed to vehicles before any other campaigns. If it's not
specified, 0
is used.
Default: 0
$sel:signalsToCollect:CreateCampaign'
, createCampaign_signalsToCollect
- (Optional) A list of information about signals to collect.
$sel:spoolingMode:CreateCampaign'
, createCampaign_spoolingMode
- (Optional) Whether to store collected data after a vehicle lost a
connection with the cloud. After a connection is re-established, the
data is automatically forwarded to Amazon Web Services IoT FleetWise. If
you want to store collected data when a vehicle loses connection with
the cloud, use TO_DISK
. If it's not specified, OFF
is used.
Default: OFF
$sel:startTime:CreateCampaign'
, createCampaign_startTime
- (Optional) The time, in milliseconds, to deliver a campaign after it was
approved. If it's not specified, 0
is used.
Default: 0
CreateCampaign
, createCampaign_tags
- Metadata that can be used to manage the campaign.
CreateCampaign
, createCampaign_name
- The name of the campaign to create.
CreateCampaign
, createCampaign_signalCatalogArn
- (Optional) The Amazon Resource Name (ARN) of the signal catalog to
associate with the campaign.
CreateCampaign
, createCampaign_targetArn
- The ARN of the vehicle or fleet to deploy a campaign to.
$sel:collectionScheme:CreateCampaign'
, createCampaign_collectionScheme
- The data collection scheme associated with the campaign. You can specify
a scheme that collects data based on time or an event.
data CreateCampaignResponse Source #
See: newCreateCampaignResponse
smart constructor.
Instances
newCreateCampaignResponse Source #
Create a value of CreateCampaignResponse
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:
CreateCampaignResponse
, createCampaignResponse_arn
- The ARN of the created campaign.
CreateCampaign
, createCampaignResponse_name
- The name of the created campaign.
$sel:httpStatus:CreateCampaignResponse'
, createCampaignResponse_httpStatus
- The response's http status code.
CreateDecoderManifest
data CreateDecoderManifest Source #
See: newCreateDecoderManifest
smart constructor.
CreateDecoderManifest' (Maybe Text) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty SignalDecoder)) (Maybe [Tag]) Text Text |
Instances
newCreateDecoderManifest Source #
Create a value of CreateDecoderManifest
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:
CreateDecoderManifest
, createDecoderManifest_description
- A brief description of the decoder manifest.
$sel:networkInterfaces:CreateDecoderManifest'
, createDecoderManifest_networkInterfaces
- A list of information about available network interfaces.
$sel:signalDecoders:CreateDecoderManifest'
, createDecoderManifest_signalDecoders
- A list of information about signal decoders.
CreateDecoderManifest
, createDecoderManifest_tags
- Metadata that can be used to manage the decoder manifest.
CreateDecoderManifest
, createDecoderManifest_name
- The unique name of the decoder manifest to create.
CreateDecoderManifest
, createDecoderManifest_modelManifestArn
- The Amazon Resource Name (ARN) of the vehicle model (model manifest).
data CreateDecoderManifestResponse Source #
See: newCreateDecoderManifestResponse
smart constructor.
Instances
newCreateDecoderManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateDecoderManifestResponse |
Create a value of CreateDecoderManifestResponse
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:httpStatus:CreateDecoderManifestResponse'
, createDecoderManifestResponse_httpStatus
- The response's http status code.
CreateDecoderManifest
, createDecoderManifestResponse_name
- The name of the created decoder manifest.
CreateDecoderManifestResponse
, createDecoderManifestResponse_arn
- The ARN of the created decoder manifest.
CreateFleet
data CreateFleet Source #
See: newCreateFleet
smart constructor.
Instances
Create a value of CreateFleet
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:
CreateFleet
, createFleet_description
- A brief description of the fleet to create.
CreateFleet
, createFleet_tags
- Metadata that can be used to manage the fleet.
$sel:fleetId:CreateFleet'
, createFleet_fleetId
- The unique ID of the fleet to create.
CreateFleet
, createFleet_signalCatalogArn
- The Amazon Resource Name (ARN) of a signal catalog.
data CreateFleetResponse Source #
See: newCreateFleetResponse
smart constructor.
Instances
newCreateFleetResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateFleetResponse |
Create a value of CreateFleetResponse
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:httpStatus:CreateFleetResponse'
, createFleetResponse_httpStatus
- The response's http status code.
CreateFleetResponse
, createFleetResponse_id
- The ID of the created fleet.
CreateFleetResponse
, createFleetResponse_arn
- The ARN of the created fleet.
CreateModelManifest
data CreateModelManifest Source #
See: newCreateModelManifest
smart constructor.
Instances
newCreateModelManifest Source #
Create a value of CreateModelManifest
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:
CreateModelManifest
, createModelManifest_description
- A brief description of the vehicle model.
CreateModelManifest
, createModelManifest_tags
- Metadata that can be used to manage the vehicle model.
CreateModelManifest
, createModelManifest_name
- The name of the vehicle model to create.
$sel:nodes:CreateModelManifest'
, createModelManifest_nodes
- A list of nodes, which are a general abstraction of signals.
CreateModelManifest
, createModelManifest_signalCatalogArn
- The Amazon Resource Name (ARN) of a signal catalog.
data CreateModelManifestResponse Source #
See: newCreateModelManifestResponse
smart constructor.
Instances
newCreateModelManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateModelManifestResponse |
Create a value of CreateModelManifestResponse
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:httpStatus:CreateModelManifestResponse'
, createModelManifestResponse_httpStatus
- The response's http status code.
CreateModelManifest
, createModelManifestResponse_name
- The name of the created vehicle model.
CreateModelManifestResponse
, createModelManifestResponse_arn
- The ARN of the created vehicle model.
CreateSignalCatalog
data CreateSignalCatalog Source #
See: newCreateSignalCatalog
smart constructor.
Instances
newCreateSignalCatalog Source #
Create a value of CreateSignalCatalog
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:
CreateSignalCatalog
, createSignalCatalog_description
- A brief description of the signal catalog.
$sel:nodes:CreateSignalCatalog'
, createSignalCatalog_nodes
- A list of information about nodes, which are a general abstraction of
signals. For more information, see the API data type.
CreateSignalCatalog
, createSignalCatalog_tags
- Metadata that can be used to manage the signal catalog.
CreateSignalCatalog
, createSignalCatalog_name
- The name of the signal catalog to create.
data CreateSignalCatalogResponse Source #
See: newCreateSignalCatalogResponse
smart constructor.
Instances
newCreateSignalCatalogResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateSignalCatalogResponse |
Create a value of CreateSignalCatalogResponse
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:httpStatus:CreateSignalCatalogResponse'
, createSignalCatalogResponse_httpStatus
- The response's http status code.
CreateSignalCatalog
, createSignalCatalogResponse_name
- The name of the created signal catalog.
CreateSignalCatalogResponse
, createSignalCatalogResponse_arn
- The ARN of the created signal catalog.
CreateVehicle
data CreateVehicle Source #
See: newCreateVehicle
smart constructor.
CreateVehicle' (Maybe VehicleAssociationBehavior) (Maybe (HashMap Text Text)) (Maybe [Tag]) Text Text Text |
Instances
Create a value of CreateVehicle
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:
CreateVehicle
, createVehicle_associationBehavior
- An option to create a new Amazon Web Services IoT thing when creating a
vehicle, or to validate an existing Amazon Web Services IoT thing as a
vehicle.
Default:
CreateVehicle
, createVehicle_attributes
- Static information about a vehicle in a key-value pair. For example:
"engineType"
: "1.3 L R2"
CreateVehicle
, createVehicle_tags
- Metadata that can be used to manage the vehicle.
CreateVehicle
, createVehicle_vehicleName
- The unique ID of the vehicle to create.
CreateVehicle
, createVehicle_modelManifestArn
- The Amazon Resource Name ARN of a vehicle model.
CreateVehicle
, createVehicle_decoderManifestArn
- The ARN of a decoder manifest.
data CreateVehicleResponse Source #
See: newCreateVehicleResponse
smart constructor.
Instances
newCreateVehicleResponse Source #
Create a value of CreateVehicleResponse
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:
CreateVehicleResponse
, createVehicleResponse_arn
- The ARN of the created vehicle.
CreateVehicleResponse
, createVehicleResponse_thingArn
- The ARN of a created or validated Amazon Web Services IoT thing.
CreateVehicle
, createVehicleResponse_vehicleName
- The unique ID of the created vehicle.
$sel:httpStatus:CreateVehicleResponse'
, createVehicleResponse_httpStatus
- The response's http status code.
DeleteCampaign
data DeleteCampaign Source #
See: newDeleteCampaign
smart constructor.
Instances
Create a value of DeleteCampaign
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:
DeleteCampaign
, deleteCampaign_name
- The name of the campaign to delete.
data DeleteCampaignResponse Source #
See: newDeleteCampaignResponse
smart constructor.
Instances
newDeleteCampaignResponse Source #
Create a value of DeleteCampaignResponse
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:
DeleteCampaignResponse
, deleteCampaignResponse_arn
- The Amazon Resource Name (ARN) of the deleted campaign.
The ARN isn’t returned if a campaign doesn’t exist.
DeleteCampaign
, deleteCampaignResponse_name
- The name of the deleted campaign.
$sel:httpStatus:DeleteCampaignResponse'
, deleteCampaignResponse_httpStatus
- The response's http status code.
DeleteDecoderManifest
data DeleteDecoderManifest Source #
See: newDeleteDecoderManifest
smart constructor.
Instances
newDeleteDecoderManifest Source #
Create a value of DeleteDecoderManifest
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:
DeleteDecoderManifest
, deleteDecoderManifest_name
- The name of the decoder manifest to delete.
data DeleteDecoderManifestResponse Source #
See: newDeleteDecoderManifestResponse
smart constructor.
Instances
newDeleteDecoderManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DeleteDecoderManifestResponse |
Create a value of DeleteDecoderManifestResponse
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:httpStatus:DeleteDecoderManifestResponse'
, deleteDecoderManifestResponse_httpStatus
- The response's http status code.
DeleteDecoderManifest
, deleteDecoderManifestResponse_name
- The name of the deleted decoder manifest.
DeleteDecoderManifestResponse
, deleteDecoderManifestResponse_arn
- The Amazon Resource Name (ARN) of the deleted decoder manifest.
DeleteFleet
data DeleteFleet Source #
See: newDeleteFleet
smart constructor.
Instances
Create a value of DeleteFleet
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:fleetId:DeleteFleet'
, deleteFleet_fleetId
- The ID of the fleet to delete.
data DeleteFleetResponse Source #
See: newDeleteFleetResponse
smart constructor.
Instances
newDeleteFleetResponse Source #
Create a value of DeleteFleetResponse
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:
DeleteFleetResponse
, deleteFleetResponse_arn
- The Amazon Resource Name (ARN) of the deleted fleet.
DeleteFleetResponse
, deleteFleetResponse_id
- The ID of the deleted fleet.
$sel:httpStatus:DeleteFleetResponse'
, deleteFleetResponse_httpStatus
- The response's http status code.
DeleteModelManifest
data DeleteModelManifest Source #
See: newDeleteModelManifest
smart constructor.
Instances
newDeleteModelManifest Source #
Create a value of DeleteModelManifest
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:
DeleteModelManifest
, deleteModelManifest_name
- The name of the model manifest to delete.
data DeleteModelManifestResponse Source #
See: newDeleteModelManifestResponse
smart constructor.
Instances
newDeleteModelManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DeleteModelManifestResponse |
Create a value of DeleteModelManifestResponse
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:httpStatus:DeleteModelManifestResponse'
, deleteModelManifestResponse_httpStatus
- The response's http status code.
DeleteModelManifest
, deleteModelManifestResponse_name
- The name of the deleted model manifest.
DeleteModelManifestResponse
, deleteModelManifestResponse_arn
- The Amazon Resource Name (ARN) of the deleted model manifest.
DeleteSignalCatalog
data DeleteSignalCatalog Source #
See: newDeleteSignalCatalog
smart constructor.
Instances
newDeleteSignalCatalog Source #
Create a value of DeleteSignalCatalog
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:
DeleteSignalCatalog
, deleteSignalCatalog_name
- The name of the signal catalog to delete.
data DeleteSignalCatalogResponse Source #
See: newDeleteSignalCatalogResponse
smart constructor.
Instances
newDeleteSignalCatalogResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DeleteSignalCatalogResponse |
Create a value of DeleteSignalCatalogResponse
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:httpStatus:DeleteSignalCatalogResponse'
, deleteSignalCatalogResponse_httpStatus
- The response's http status code.
DeleteSignalCatalog
, deleteSignalCatalogResponse_name
- The name of the deleted signal catalog.
DeleteSignalCatalogResponse
, deleteSignalCatalogResponse_arn
- The Amazon Resource Name (ARN) of the deleted signal catalog.
DeleteVehicle
data DeleteVehicle Source #
See: newDeleteVehicle
smart constructor.
Instances
Create a value of DeleteVehicle
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:
DeleteVehicle
, deleteVehicle_vehicleName
- The ID of the vehicle to delete.
data DeleteVehicleResponse Source #
See: newDeleteVehicleResponse
smart constructor.
Instances
newDeleteVehicleResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DeleteVehicleResponse |
Create a value of DeleteVehicleResponse
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:httpStatus:DeleteVehicleResponse'
, deleteVehicleResponse_httpStatus
- The response's http status code.
DeleteVehicle
, deleteVehicleResponse_vehicleName
- The ID of the deleted vehicle.
DeleteVehicleResponse
, deleteVehicleResponse_arn
- The Amazon Resource Name (ARN) of the deleted vehicle.
DisassociateVehicleFleet
data DisassociateVehicleFleet Source #
See: newDisassociateVehicleFleet
smart constructor.
Instances
newDisassociateVehicleFleet Source #
:: Text | |
-> Text | |
-> DisassociateVehicleFleet |
Create a value of DisassociateVehicleFleet
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:
DisassociateVehicleFleet
, disassociateVehicleFleet_vehicleName
- The unique ID of the vehicle to disassociate from the fleet.
$sel:fleetId:DisassociateVehicleFleet'
, disassociateVehicleFleet_fleetId
- The unique ID of a fleet.
data DisassociateVehicleFleetResponse Source #
See: newDisassociateVehicleFleetResponse
smart constructor.
Instances
Generic DisassociateVehicleFleetResponse Source # | |
Read DisassociateVehicleFleetResponse Source # | |
Show DisassociateVehicleFleetResponse Source # | |
NFData DisassociateVehicleFleetResponse Source # | |
Defined in Amazonka.IoTFleetWise.DisassociateVehicleFleet rnf :: DisassociateVehicleFleetResponse -> () # | |
Eq DisassociateVehicleFleetResponse Source # | |
type Rep DisassociateVehicleFleetResponse Source # | |
Defined in Amazonka.IoTFleetWise.DisassociateVehicleFleet type Rep DisassociateVehicleFleetResponse = D1 ('MetaData "DisassociateVehicleFleetResponse" "Amazonka.IoTFleetWise.DisassociateVehicleFleet" "amazonka-iotfleetwise-2.0-3noXdw9CznA79cw3EwaHcU" 'False) (C1 ('MetaCons "DisassociateVehicleFleetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newDisassociateVehicleFleetResponse Source #
Create a value of DisassociateVehicleFleetResponse
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:httpStatus:DisassociateVehicleFleetResponse'
, disassociateVehicleFleetResponse_httpStatus
- The response's http status code.
GetCampaign
data GetCampaign Source #
See: newGetCampaign
smart constructor.
Instances
Create a value of GetCampaign
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:
GetCampaign
, getCampaign_name
- The name of the campaign to retrieve information about.
data GetCampaignResponse Source #
See: newGetCampaignResponse
smart constructor.
GetCampaignResponse' (Maybe Text) (Maybe CollectionScheme) (Maybe Compression) (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe DiagnosticsMode) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe [SignalInformation]) (Maybe SpoolingMode) (Maybe POSIX) (Maybe CampaignStatus) (Maybe Text) Int |
Instances
newGetCampaignResponse Source #
Create a value of GetCampaignResponse
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:
GetCampaignResponse
, getCampaignResponse_arn
- The Amazon Resource Name (ARN) of the campaign.
$sel:collectionScheme:GetCampaignResponse'
, getCampaignResponse_collectionScheme
- Information about the data collection scheme associated with the
campaign.
$sel:compression:GetCampaignResponse'
, getCampaignResponse_compression
- Whether to compress signals before transmitting data to Amazon Web
Services IoT FleetWise. If OFF
is specified, the signals aren't
compressed. If it's not specified, SNAPPY
is used.
GetCampaignResponse
, getCampaignResponse_creationTime
- The time the campaign was created in seconds since epoch (January 1,
1970 at midnight UTC time).
$sel:dataExtraDimensions:GetCampaignResponse'
, getCampaignResponse_dataExtraDimensions
- A list of vehicle attributes associated with the campaign.
GetCampaignResponse
, getCampaignResponse_description
- The description of the campaign.
$sel:diagnosticsMode:GetCampaignResponse'
, getCampaignResponse_diagnosticsMode
- Option for a vehicle to send diagnostic trouble codes to Amazon Web
Services IoT FleetWise.
$sel:expiryTime:GetCampaignResponse'
, getCampaignResponse_expiryTime
- The time the campaign expires, in seconds since epoch (January 1, 1970
at midnight UTC time). Vehicle data won't be collected after the
campaign expires.
GetCampaignResponse
, getCampaignResponse_lastModificationTime
- The last time the campaign was modified.
GetCampaign
, getCampaignResponse_name
- The name of the campaign.
$sel:postTriggerCollectionDuration:GetCampaignResponse'
, getCampaignResponse_postTriggerCollectionDuration
- How long (in seconds) to collect raw data after a triggering event
initiates the collection.
$sel:priority:GetCampaignResponse'
, getCampaignResponse_priority
- A number indicating the priority of one campaign over another campaign
for a certain vehicle or fleet. A campaign with the lowest value is
deployed to vehicles before any other campaigns.
GetCampaignResponse
, getCampaignResponse_signalCatalogArn
- The ARN of a signal catalog.
$sel:signalsToCollect:GetCampaignResponse'
, getCampaignResponse_signalsToCollect
- Information about a list of signals to collect data on.
$sel:spoolingMode:GetCampaignResponse'
, getCampaignResponse_spoolingMode
- Whether to store collected data after a vehicle lost a connection with
the cloud. After a connection is re-established, the data is
automatically forwarded to Amazon Web Services IoT FleetWise.
$sel:startTime:GetCampaignResponse'
, getCampaignResponse_startTime
- The time, in milliseconds, to deliver a campaign after it was approved.
GetCampaignResponse
, getCampaignResponse_status
- The state of the campaign. The status can be one of: CREATING
,
WAITING_FOR_APPROVAL
, RUNNING
, and SUSPENDED
.
GetCampaignResponse
, getCampaignResponse_targetArn
- The ARN of the vehicle or the fleet targeted by the campaign.
$sel:httpStatus:GetCampaignResponse'
, getCampaignResponse_httpStatus
- The response's http status code.
GetDecoderManifest
data GetDecoderManifest Source #
See: newGetDecoderManifest
smart constructor.
Instances
newGetDecoderManifest Source #
Create a value of GetDecoderManifest
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:
GetDecoderManifest
, getDecoderManifest_name
- The name of the decoder manifest to retrieve information about.
data GetDecoderManifestResponse Source #
See: newGetDecoderManifestResponse
smart constructor.
GetDecoderManifestResponse' (Maybe Text) (Maybe Text) (Maybe ManifestStatus) Int Text Text POSIX POSIX |
Instances
newGetDecoderManifestResponse Source #
Create a value of GetDecoderManifestResponse
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:
GetDecoderManifestResponse
, getDecoderManifestResponse_description
- A brief description of the decoder manifest.
GetDecoderManifestResponse
, getDecoderManifestResponse_modelManifestArn
- The ARN of a vehicle model (model manifest) associated with the decoder
manifest.
GetDecoderManifestResponse
, getDecoderManifestResponse_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:httpStatus:GetDecoderManifestResponse'
, getDecoderManifestResponse_httpStatus
- The response's http status code.
GetDecoderManifest
, getDecoderManifestResponse_name
- The name of the decoder manifest.
GetDecoderManifestResponse
, getDecoderManifestResponse_arn
- The Amazon Resource Name (ARN) of the decoder manifest.
GetDecoderManifestResponse
, getDecoderManifestResponse_creationTime
- The time the decoder manifest was created in seconds since epoch
(January 1, 1970 at midnight UTC time).
GetDecoderManifestResponse
, getDecoderManifestResponse_lastModificationTime
- The time the decoder manifest was last updated in seconds since epoch
(January 1, 1970 at midnight UTC time).
GetFleet
See: newGetFleet
smart constructor.
Instances
Create a value of GetFleet
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:fleetId:GetFleet'
, getFleet_fleetId
- The ID of the fleet to retrieve information about.
data GetFleetResponse Source #
See: newGetFleetResponse
smart constructor.
Instances
Create a value of GetFleetResponse
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:
GetFleetResponse
, getFleetResponse_description
- A brief description of the fleet.
$sel:httpStatus:GetFleetResponse'
, getFleetResponse_httpStatus
- The response's http status code.
GetFleetResponse
, getFleetResponse_id
- The ID of the fleet.
GetFleetResponse
, getFleetResponse_arn
- The Amazon Resource Name (ARN) of the fleet.
GetFleetResponse
, getFleetResponse_signalCatalogArn
- The ARN of a signal catalog associated with the fleet.
GetFleetResponse
, getFleetResponse_creationTime
- The time the fleet was created in seconds since epoch (January 1, 1970
at midnight UTC time).
GetFleetResponse
, getFleetResponse_lastModificationTime
- The time the fleet was last updated, in seconds since epoch (January 1,
1970 at midnight UTC time).
GetLoggingOptions
data GetLoggingOptions Source #
See: newGetLoggingOptions
smart constructor.
Instances
newGetLoggingOptions :: GetLoggingOptions Source #
Create a value of GetLoggingOptions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetLoggingOptionsResponse Source #
See: newGetLoggingOptionsResponse
smart constructor.
Instances
newGetLoggingOptionsResponse Source #
Create a value of GetLoggingOptionsResponse
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:httpStatus:GetLoggingOptionsResponse'
, getLoggingOptionsResponse_httpStatus
- The response's http status code.
$sel:cloudWatchLogDelivery:GetLoggingOptionsResponse'
, getLoggingOptionsResponse_cloudWatchLogDelivery
- Returns information about log delivery to Amazon CloudWatch Logs.
GetModelManifest
data GetModelManifest Source #
See: newGetModelManifest
smart constructor.
Instances
Create a value of GetModelManifest
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:
GetModelManifest
, getModelManifest_name
- The name of the vehicle model to retrieve information about.
data GetModelManifestResponse Source #
See: newGetModelManifestResponse
smart constructor.
GetModelManifestResponse' (Maybe Text) (Maybe Text) (Maybe ManifestStatus) Int Text Text POSIX POSIX |
Instances
newGetModelManifestResponse Source #
Create a value of GetModelManifestResponse
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:
GetModelManifestResponse
, getModelManifestResponse_description
- A brief description of the vehicle model.
GetModelManifestResponse
, getModelManifestResponse_signalCatalogArn
- The ARN of the signal catalog associated with the vehicle model.
GetModelManifestResponse
, getModelManifestResponse_status
- The state of the vehicle model. If the status is ACTIVE
, the vehicle
model can't be edited. You can edit the vehicle model if the status is
marked DRAFT
.
$sel:httpStatus:GetModelManifestResponse'
, getModelManifestResponse_httpStatus
- The response's http status code.
GetModelManifest
, getModelManifestResponse_name
- The name of the vehicle model.
GetModelManifestResponse
, getModelManifestResponse_arn
- The Amazon Resource Name (ARN) of the vehicle model.
GetModelManifestResponse
, getModelManifestResponse_creationTime
- The time the vehicle model was created, in seconds since epoch (January
1, 1970 at midnight UTC time).
GetModelManifestResponse
, getModelManifestResponse_lastModificationTime
- The last time the vehicle model was modified.
GetRegisterAccountStatus
data GetRegisterAccountStatus Source #
See: newGetRegisterAccountStatus
smart constructor.
Instances
newGetRegisterAccountStatus :: GetRegisterAccountStatus Source #
Create a value of GetRegisterAccountStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetRegisterAccountStatusResponse Source #
See: newGetRegisterAccountStatusResponse
smart constructor.
GetRegisterAccountStatusResponse' Int Text RegistrationStatus TimestreamRegistrationResponse IamRegistrationResponse POSIX POSIX |
Instances
newGetRegisterAccountStatusResponse Source #
Create a value of GetRegisterAccountStatusResponse
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:httpStatus:GetRegisterAccountStatusResponse'
, getRegisterAccountStatusResponse_httpStatus
- The response's http status code.
$sel:customerAccountId:GetRegisterAccountStatusResponse'
, getRegisterAccountStatusResponse_customerAccountId
- The unique ID of the Amazon Web Services account, provided at account
creation.
$sel:accountStatus:GetRegisterAccountStatusResponse'
, getRegisterAccountStatusResponse_accountStatus
- The status of registering your account and resources. The status can be
one of:
REGISTRATION_SUCCESS
- The Amazon Web Services resource is successfully registered.REGISTRATION_PENDING
- Amazon Web Services IoT FleetWise is processing the registration request. This process takes approximately five minutes to complete.REGISTRATION_FAILURE
- Amazon Web Services IoT FleetWise can't register the AWS resource. Try again later.
$sel:timestreamRegistrationResponse:GetRegisterAccountStatusResponse'
, getRegisterAccountStatusResponse_timestreamRegistrationResponse
- Information about the registered Amazon Timestream resources or errors,
if any.
$sel:iamRegistrationResponse:GetRegisterAccountStatusResponse'
, getRegisterAccountStatusResponse_iamRegistrationResponse
- Information about the registered IAM resources or errors, if any.
GetRegisterAccountStatusResponse
, getRegisterAccountStatusResponse_creationTime
- The time the account was registered, in seconds since epoch (January 1,
1970 at midnight UTC time).
GetRegisterAccountStatusResponse
, getRegisterAccountStatusResponse_lastModificationTime
- The time this registration was last updated, in seconds since epoch
(January 1, 1970 at midnight UTC time).
GetSignalCatalog
data GetSignalCatalog Source #
See: newGetSignalCatalog
smart constructor.
Instances
Create a value of GetSignalCatalog
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:
GetSignalCatalog
, getSignalCatalog_name
- The name of the signal catalog to retrieve information about.
data GetSignalCatalogResponse Source #
See: newGetSignalCatalogResponse
smart constructor.
Instances
newGetSignalCatalogResponse Source #
Create a value of GetSignalCatalogResponse
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:
GetSignalCatalogResponse
, getSignalCatalogResponse_description
- A brief description of the signal catalog.
$sel:nodeCounts:GetSignalCatalogResponse'
, getSignalCatalogResponse_nodeCounts
- The total number of network nodes specified in a signal catalog.
$sel:httpStatus:GetSignalCatalogResponse'
, getSignalCatalogResponse_httpStatus
- The response's http status code.
GetSignalCatalog
, getSignalCatalogResponse_name
- The name of the signal catalog.
GetSignalCatalogResponse
, getSignalCatalogResponse_arn
- The Amazon Resource Name (ARN) of the signal catalog.
GetSignalCatalogResponse
, getSignalCatalogResponse_creationTime
- The time the signal catalog was created in seconds since epoch (January
1, 1970 at midnight UTC time).
GetSignalCatalogResponse
, getSignalCatalogResponse_lastModificationTime
- The last time the signal catalog was modified.
GetVehicle
data GetVehicle Source #
See: newGetVehicle
smart constructor.
Instances
:: Text | |
-> GetVehicle |
Create a value of GetVehicle
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:
GetVehicle
, getVehicle_vehicleName
- The ID of the vehicle to retrieve information about.
data GetVehicleResponse Source #
See: newGetVehicleResponse
smart constructor.
GetVehicleResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newGetVehicleResponse Source #
Create a value of GetVehicleResponse
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:
GetVehicleResponse
, getVehicleResponse_arn
- The Amazon Resource Name (ARN) of the vehicle to retrieve information
about.
GetVehicleResponse
, getVehicleResponse_attributes
- Static information about a vehicle in a key-value pair. For example:
"engineType"
: "1.3 L R2"
GetVehicleResponse
, getVehicleResponse_creationTime
- The time the vehicle was created in seconds since epoch (January 1, 1970
at midnight UTC time).
GetVehicleResponse
, getVehicleResponse_decoderManifestArn
- The ARN of a decoder manifest associated with the vehicle.
GetVehicleResponse
, getVehicleResponse_lastModificationTime
- The time the vehicle was last updated in seconds since epoch (January 1,
1970 at midnight UTC time).
GetVehicleResponse
, getVehicleResponse_modelManifestArn
- The ARN of a vehicle model (model manifest) associated with the vehicle.
GetVehicle
, getVehicleResponse_vehicleName
- The ID of the vehicle.
$sel:httpStatus:GetVehicleResponse'
, getVehicleResponse_httpStatus
- The response's http status code.
GetVehicleStatus (Paginated)
data GetVehicleStatus Source #
See: newGetVehicleStatus
smart constructor.
Instances
Create a value of GetVehicleStatus
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:maxResults:GetVehicleStatus'
, getVehicleStatus_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
GetVehicleStatus
, getVehicleStatus_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
GetVehicleStatus
, getVehicleStatus_vehicleName
- The ID of the vehicle to retrieve information about.
data GetVehicleStatusResponse Source #
See: newGetVehicleStatusResponse
smart constructor.
Instances
newGetVehicleStatusResponse Source #
Create a value of GetVehicleStatusResponse
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:campaigns:GetVehicleStatusResponse'
, getVehicleStatusResponse_campaigns
- Lists information about the state of the vehicle with deployed
campaigns.
GetVehicleStatus
, getVehicleStatusResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:GetVehicleStatusResponse'
, getVehicleStatusResponse_httpStatus
- The response's http status code.
ImportDecoderManifest
data ImportDecoderManifest Source #
See: newImportDecoderManifest
smart constructor.
Instances
newImportDecoderManifest Source #
Create a value of ImportDecoderManifest
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:
ImportDecoderManifest
, importDecoderManifest_name
- The name of the decoder manifest to import.
$sel:networkFileDefinitions:ImportDecoderManifest'
, importDecoderManifest_networkFileDefinitions
- The file to load into an Amazon Web Services account.
data ImportDecoderManifestResponse Source #
See: newImportDecoderManifestResponse
smart constructor.
Instances
newImportDecoderManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ImportDecoderManifestResponse |
Create a value of ImportDecoderManifestResponse
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:httpStatus:ImportDecoderManifestResponse'
, importDecoderManifestResponse_httpStatus
- The response's http status code.
ImportDecoderManifest
, importDecoderManifestResponse_name
- The name of the imported decoder manifest.
ImportDecoderManifestResponse
, importDecoderManifestResponse_arn
- The Amazon Resource Name (ARN) of the decoder manifest that was
imported.
ImportSignalCatalog
data ImportSignalCatalog Source #
See: newImportSignalCatalog
smart constructor.
ImportSignalCatalog' (Maybe Text) (Maybe [Tag]) (Maybe FormattedVss) Text |
Instances
newImportSignalCatalog Source #
Create a value of ImportSignalCatalog
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:
ImportSignalCatalog
, importSignalCatalog_description
- A brief description of the signal catalog.
ImportSignalCatalog
, importSignalCatalog_tags
- Metadata that can be used to manage the signal catalog.
$sel:vss:ImportSignalCatalog'
, importSignalCatalog_vss
- The contents of the Vehicle Signal Specification (VSS) configuration.
VSS is a precise language used to describe and model signals in vehicle
networks.
ImportSignalCatalog
, importSignalCatalog_name
- The name of the signal catalog to import.
data ImportSignalCatalogResponse Source #
See: newImportSignalCatalogResponse
smart constructor.
Instances
newImportSignalCatalogResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> ImportSignalCatalogResponse |
Create a value of ImportSignalCatalogResponse
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:httpStatus:ImportSignalCatalogResponse'
, importSignalCatalogResponse_httpStatus
- The response's http status code.
ImportSignalCatalog
, importSignalCatalogResponse_name
- The name of the imported signal catalog.
ImportSignalCatalogResponse
, importSignalCatalogResponse_arn
- The Amazon Resource Name (ARN) of the imported signal catalog.
ListCampaigns (Paginated)
data ListCampaigns Source #
See: newListCampaigns
smart constructor.
Instances
newListCampaigns :: ListCampaigns Source #
Create a value of ListCampaigns
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:maxResults:ListCampaigns'
, listCampaigns_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListCampaigns
, listCampaigns_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListCampaigns
, listCampaigns_status
- Optional parameter to filter the results by the status of each created
campaign in your account. The status can be one of: CREATING
,
WAITING_FOR_APPROVAL
, RUNNING
, or SUSPENDED
.
data ListCampaignsResponse Source #
See: newListCampaignsResponse
smart constructor.
Instances
newListCampaignsResponse Source #
Create a value of ListCampaignsResponse
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:campaignSummaries:ListCampaignsResponse'
, listCampaignsResponse_campaignSummaries
- A summary of information about each campaign.
ListCampaigns
, listCampaignsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:ListCampaignsResponse'
, listCampaignsResponse_httpStatus
- The response's http status code.
ListDecoderManifestNetworkInterfaces (Paginated)
data ListDecoderManifestNetworkInterfaces Source #
See: newListDecoderManifestNetworkInterfaces
smart constructor.
Instances
newListDecoderManifestNetworkInterfaces Source #
Create a value of ListDecoderManifestNetworkInterfaces
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:maxResults:ListDecoderManifestNetworkInterfaces'
, listDecoderManifestNetworkInterfaces_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListDecoderManifestNetworkInterfaces
, listDecoderManifestNetworkInterfaces_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListDecoderManifestNetworkInterfaces
, listDecoderManifestNetworkInterfaces_name
- The name of the decoder manifest to list information about.
data ListDecoderManifestNetworkInterfacesResponse Source #
See: newListDecoderManifestNetworkInterfacesResponse
smart constructor.
Instances
newListDecoderManifestNetworkInterfacesResponse Source #
:: Int |
|
-> ListDecoderManifestNetworkInterfacesResponse |
Create a value of ListDecoderManifestNetworkInterfacesResponse
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:networkInterfaces:ListDecoderManifestNetworkInterfacesResponse'
, listDecoderManifestNetworkInterfacesResponse_networkInterfaces
- A list of information about network interfaces.
ListDecoderManifestNetworkInterfaces
, listDecoderManifestNetworkInterfacesResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:ListDecoderManifestNetworkInterfacesResponse'
, listDecoderManifestNetworkInterfacesResponse_httpStatus
- The response's http status code.
ListDecoderManifestSignals (Paginated)
data ListDecoderManifestSignals Source #
See: newListDecoderManifestSignals
smart constructor.
Instances
newListDecoderManifestSignals Source #
Create a value of ListDecoderManifestSignals
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:maxResults:ListDecoderManifestSignals'
, listDecoderManifestSignals_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListDecoderManifestSignals
, listDecoderManifestSignals_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListDecoderManifestSignals
, listDecoderManifestSignals_name
- The name of the decoder manifest to list information about.
data ListDecoderManifestSignalsResponse Source #
See: newListDecoderManifestSignalsResponse
smart constructor.
Instances
newListDecoderManifestSignalsResponse Source #
Create a value of ListDecoderManifestSignalsResponse
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:
ListDecoderManifestSignals
, listDecoderManifestSignalsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:signalDecoders:ListDecoderManifestSignalsResponse'
, listDecoderManifestSignalsResponse_signalDecoders
- Information about a list of signals to decode.
$sel:httpStatus:ListDecoderManifestSignalsResponse'
, listDecoderManifestSignalsResponse_httpStatus
- The response's http status code.
ListDecoderManifests (Paginated)
data ListDecoderManifests Source #
See: newListDecoderManifests
smart constructor.
Instances
newListDecoderManifests :: ListDecoderManifests Source #
Create a value of ListDecoderManifests
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:maxResults:ListDecoderManifests'
, listDecoderManifests_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListDecoderManifests
, listDecoderManifests_modelManifestArn
- The Amazon Resource Name (ARN) of a vehicle model (model manifest)
associated with the decoder manifest.
ListDecoderManifests
, listDecoderManifests_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
data ListDecoderManifestsResponse Source #
See: newListDecoderManifestsResponse
smart constructor.
Instances
newListDecoderManifestsResponse Source #
Create a value of ListDecoderManifestsResponse
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:
ListDecoderManifests
, listDecoderManifestsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:summaries:ListDecoderManifestsResponse'
, listDecoderManifestsResponse_summaries
- A list of information about each decoder manifest.
$sel:httpStatus:ListDecoderManifestsResponse'
, listDecoderManifestsResponse_httpStatus
- The response's http status code.
ListFleets (Paginated)
data ListFleets Source #
See: newListFleets
smart constructor.
ListFleets' (Maybe Natural) (Maybe Text) |
Instances
newListFleets :: ListFleets Source #
Create a value of ListFleets
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:maxResults:ListFleets'
, listFleets_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListFleets
, listFleets_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
data ListFleetsResponse Source #
See: newListFleetsResponse
smart constructor.
Instances
newListFleetsResponse Source #
Create a value of ListFleetsResponse
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:fleetSummaries:ListFleetsResponse'
, listFleetsResponse_fleetSummaries
- A list of information for each fleet.
ListFleets
, listFleetsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:ListFleetsResponse'
, listFleetsResponse_httpStatus
- The response's http status code.
ListFleetsForVehicle (Paginated)
data ListFleetsForVehicle Source #
See: newListFleetsForVehicle
smart constructor.
Instances
newListFleetsForVehicle Source #
Create a value of ListFleetsForVehicle
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:maxResults:ListFleetsForVehicle'
, listFleetsForVehicle_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListFleetsForVehicle
, listFleetsForVehicle_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListFleetsForVehicle
, listFleetsForVehicle_vehicleName
- The ID of the vehicle to retrieve information about.
data ListFleetsForVehicleResponse Source #
See: newListFleetsForVehicleResponse
smart constructor.
Instances
newListFleetsForVehicleResponse Source #
Create a value of ListFleetsForVehicleResponse
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:fleets:ListFleetsForVehicleResponse'
, listFleetsForVehicleResponse_fleets
- A list of fleet IDs that the vehicle is associated with.
ListFleetsForVehicle
, listFleetsForVehicleResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:httpStatus:ListFleetsForVehicleResponse'
, listFleetsForVehicleResponse_httpStatus
- The response's http status code.
ListModelManifestNodes (Paginated)
data ListModelManifestNodes Source #
See: newListModelManifestNodes
smart constructor.
Instances
newListModelManifestNodes Source #
Create a value of ListModelManifestNodes
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:maxResults:ListModelManifestNodes'
, listModelManifestNodes_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListModelManifestNodes
, listModelManifestNodes_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListModelManifestNodes
, listModelManifestNodes_name
- The name of the vehicle model to list information about.
data ListModelManifestNodesResponse Source #
See: newListModelManifestNodesResponse
smart constructor.
Instances
newListModelManifestNodesResponse Source #
Create a value of ListModelManifestNodesResponse
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:
ListModelManifestNodes
, listModelManifestNodesResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:nodes:ListModelManifestNodesResponse'
, listModelManifestNodesResponse_nodes
- A list of information about nodes.
$sel:httpStatus:ListModelManifestNodesResponse'
, listModelManifestNodesResponse_httpStatus
- The response's http status code.
ListModelManifests (Paginated)
data ListModelManifests Source #
See: newListModelManifests
smart constructor.
Instances
newListModelManifests :: ListModelManifests Source #
Create a value of ListModelManifests
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:maxResults:ListModelManifests'
, listModelManifests_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListModelManifests
, listModelManifests_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListModelManifests
, listModelManifests_signalCatalogArn
- The ARN of a signal catalog. If you specify a signal catalog, only the
vehicle models associated with it are returned.
data ListModelManifestsResponse Source #
See: newListModelManifestsResponse
smart constructor.
Instances
newListModelManifestsResponse Source #
Create a value of ListModelManifestsResponse
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:
ListModelManifests
, listModelManifestsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:summaries:ListModelManifestsResponse'
, listModelManifestsResponse_summaries
- A list of information about vehicle models.
$sel:httpStatus:ListModelManifestsResponse'
, listModelManifestsResponse_httpStatus
- The response's http status code.
ListSignalCatalogNodes (Paginated)
data ListSignalCatalogNodes Source #
See: newListSignalCatalogNodes
smart constructor.
Instances
newListSignalCatalogNodes Source #
Create a value of ListSignalCatalogNodes
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:maxResults:ListSignalCatalogNodes'
, listSignalCatalogNodes_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListSignalCatalogNodes
, listSignalCatalogNodes_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
ListSignalCatalogNodes
, listSignalCatalogNodes_name
- The name of the signal catalog to list information about.
data ListSignalCatalogNodesResponse Source #
See: newListSignalCatalogNodesResponse
smart constructor.
Instances
newListSignalCatalogNodesResponse Source #
Create a value of ListSignalCatalogNodesResponse
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:
ListSignalCatalogNodes
, listSignalCatalogNodesResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:nodes:ListSignalCatalogNodesResponse'
, listSignalCatalogNodesResponse_nodes
- A list of information about nodes.
$sel:httpStatus:ListSignalCatalogNodesResponse'
, listSignalCatalogNodesResponse_httpStatus
- The response's http status code.
ListSignalCatalogs (Paginated)
data ListSignalCatalogs Source #
See: newListSignalCatalogs
smart constructor.
Instances
newListSignalCatalogs :: ListSignalCatalogs Source #
Create a value of ListSignalCatalogs
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:maxResults:ListSignalCatalogs'
, listSignalCatalogs_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListSignalCatalogs
, listSignalCatalogs_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
data ListSignalCatalogsResponse Source #
See: newListSignalCatalogsResponse
smart constructor.
Instances
newListSignalCatalogsResponse Source #
Create a value of ListSignalCatalogsResponse
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:
ListSignalCatalogs
, listSignalCatalogsResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:summaries:ListSignalCatalogsResponse'
, listSignalCatalogsResponse_summaries
- A list of information about each signal catalog.
$sel:httpStatus:ListSignalCatalogsResponse'
, listSignalCatalogsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceARN:ListTagsForResource'
, listTagsForResource_resourceARN
- The ARN of the resource.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- The list of tags assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListVehicles (Paginated)
data ListVehicles Source #
See: newListVehicles
smart constructor.
Instances
newListVehicles :: ListVehicles Source #
Create a value of ListVehicles
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:maxResults:ListVehicles'
, listVehicles_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListVehicles
, listVehicles_modelManifestArn
- The Amazon Resource Name (ARN) of a vehicle model (model manifest). You
can use this optional parameter to list only the vehicles created from a
certain vehicle model.
ListVehicles
, listVehicles_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
data ListVehiclesResponse Source #
See: newListVehiclesResponse
smart constructor.
Instances
newListVehiclesResponse Source #
Create a value of ListVehiclesResponse
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:
ListVehicles
, listVehiclesResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:vehicleSummaries:ListVehiclesResponse'
, listVehiclesResponse_vehicleSummaries
- A list of vehicles and information about them.
$sel:httpStatus:ListVehiclesResponse'
, listVehiclesResponse_httpStatus
- The response's http status code.
ListVehiclesInFleet (Paginated)
data ListVehiclesInFleet Source #
See: newListVehiclesInFleet
smart constructor.
Instances
newListVehiclesInFleet Source #
Create a value of ListVehiclesInFleet
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:maxResults:ListVehiclesInFleet'
, listVehiclesInFleet_maxResults
- The maximum number of items to return, between 1 and 100, inclusive.
ListVehiclesInFleet
, listVehiclesInFleet_nextToken
- A pagination token for the next set of results.
If the results of a search are large, only a portion of the results are
returned, and a nextToken
pagination token is returned in the
response. To retrieve the next set of results, reissue the search
request and include the returned token. When all results have been
returned, the response does not contain a pagination token value.
$sel:fleetId:ListVehiclesInFleet'
, listVehiclesInFleet_fleetId
- The ID of a fleet.
data ListVehiclesInFleetResponse Source #
See: newListVehiclesInFleetResponse
smart constructor.
Instances
newListVehiclesInFleetResponse Source #
Create a value of ListVehiclesInFleetResponse
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:
ListVehiclesInFleet
, listVehiclesInFleetResponse_nextToken
- The token to retrieve the next set of results, or null
if there are no
more results.
$sel:vehicles:ListVehiclesInFleetResponse'
, listVehiclesInFleetResponse_vehicles
- A list of vehicles associated with the fleet.
$sel:httpStatus:ListVehiclesInFleetResponse'
, listVehiclesInFleetResponse_httpStatus
- The response's http status code.
PutLoggingOptions
data PutLoggingOptions Source #
See: newPutLoggingOptions
smart constructor.
Instances
Create a value of PutLoggingOptions
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:cloudWatchLogDelivery:PutLoggingOptions'
, putLoggingOptions_cloudWatchLogDelivery
- Creates or updates the log delivery option to Amazon CloudWatch Logs.
data PutLoggingOptionsResponse Source #
See: newPutLoggingOptionsResponse
smart constructor.
Instances
newPutLoggingOptionsResponse Source #
Create a value of PutLoggingOptionsResponse
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:httpStatus:PutLoggingOptionsResponse'
, putLoggingOptionsResponse_httpStatus
- The response's http status code.
RegisterAccount
data RegisterAccount Source #
See: newRegisterAccount
smart constructor.
Instances
Create a value of RegisterAccount
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:
RegisterAccount
, registerAccount_iamResources
- The IAM resource that allows Amazon Web Services IoT FleetWise to send
data to Amazon Timestream.
RegisterAccount
, registerAccount_timestreamResources
- Undocumented member.
data RegisterAccountResponse Source #
See: newRegisterAccountResponse
smart constructor.
Instances
newRegisterAccountResponse Source #
:: Int | |
-> RegistrationStatus | |
-> TimestreamResources | |
-> IamResources | |
-> UTCTime | |
-> UTCTime | |
-> RegisterAccountResponse |
Create a value of RegisterAccountResponse
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:httpStatus:RegisterAccountResponse'
, registerAccountResponse_httpStatus
- The response's http status code.
$sel:registerAccountStatus:RegisterAccountResponse'
, registerAccountResponse_registerAccountStatus
- The status of registering your Amazon Web Services account, IAM role,
and Timestream resources.
RegisterAccount
, registerAccountResponse_timestreamResources
- Undocumented member.
RegisterAccount
, registerAccountResponse_iamResources
- The registered IAM resource that allows Amazon Web Services IoT
FleetWise to send data to Amazon Timestream.
RegisterAccountResponse
, registerAccountResponse_creationTime
- The time the account was registered, in seconds since epoch (January 1,
1970 at midnight UTC time).
RegisterAccountResponse
, registerAccountResponse_lastModificationTime
- The time this registration was last updated, in seconds since epoch
(January 1, 1970 at midnight UTC time).
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceARN:TagResource'
, tagResource_resourceARN
- The ARN of the resource.
TagResource
, tagResource_tags
- The new or modified tags for the resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceARN:UntagResource'
, untagResource_resourceARN
- The ARN of the resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of the keys of the tags to be removed from the resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateCampaign
data UpdateCampaign Source #
See: newUpdateCampaign
smart constructor.
Instances
Create a value of UpdateCampaign
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:dataExtraDimensions:UpdateCampaign'
, updateCampaign_dataExtraDimensions
- A list of vehicle attributes to associate with a signal.
Default: An empty array
UpdateCampaign
, updateCampaign_description
- The description of the campaign.
UpdateCampaign
, updateCampaign_name
- The name of the campaign to update.
$sel:action:UpdateCampaign'
, updateCampaign_action
- Specifies how to update a campaign. The action can be one of the
following:
APPROVE
- To approve delivering a data collection scheme to vehicles.SUSPEND
- To suspend collecting signal data.RESUME
- To resume collecting signal data.UPDATE
- To update a campaign.
data UpdateCampaignResponse Source #
See: newUpdateCampaignResponse
smart constructor.
Instances
newUpdateCampaignResponse Source #
Create a value of UpdateCampaignResponse
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:
UpdateCampaignResponse
, updateCampaignResponse_arn
- The Amazon Resource Name (ARN) of the campaign.
UpdateCampaign
, updateCampaignResponse_name
- The name of the updated campaign.
UpdateCampaignResponse
, updateCampaignResponse_status
- The state of a campaign. The status can be one of:
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_APPROVAL
state. 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:httpStatus:UpdateCampaignResponse'
, updateCampaignResponse_httpStatus
- The response's http status code.
UpdateDecoderManifest
data UpdateDecoderManifest Source #
See: newUpdateDecoderManifest
smart constructor.
UpdateDecoderManifest' (Maybe Text) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty NetworkInterface)) (Maybe (NonEmpty SignalDecoder)) (Maybe (NonEmpty Text)) (Maybe (NonEmpty SignalDecoder)) (Maybe ManifestStatus) Text |
Instances
newUpdateDecoderManifest Source #
Create a value of UpdateDecoderManifest
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:
UpdateDecoderManifest
, updateDecoderManifest_description
- A brief description of the decoder manifest to update.
$sel:networkInterfacesToAdd:UpdateDecoderManifest'
, updateDecoderManifest_networkInterfacesToAdd
- A list of information about the network interfaces to add to the decoder
manifest.
$sel:networkInterfacesToRemove:UpdateDecoderManifest'
, updateDecoderManifest_networkInterfacesToRemove
- A list of network interfaces to remove from the decoder manifest.
$sel:networkInterfacesToUpdate:UpdateDecoderManifest'
, updateDecoderManifest_networkInterfacesToUpdate
- A list of information about the network interfaces to update in the
decoder manifest.
$sel:signalDecodersToAdd:UpdateDecoderManifest'
, updateDecoderManifest_signalDecodersToAdd
- A list of information about decoding additional signals to add to the
decoder manifest.
$sel:signalDecodersToRemove:UpdateDecoderManifest'
, updateDecoderManifest_signalDecodersToRemove
- A list of signal decoders to remove from the decoder manifest.
$sel:signalDecodersToUpdate:UpdateDecoderManifest'
, updateDecoderManifest_signalDecodersToUpdate
- A list of updated information about decoding signals to update in the
decoder manifest.
UpdateDecoderManifest
, updateDecoderManifest_status
- The state of the decoder manifest. If the status is ACTIVE
, the
decoder manifest can't be edited. If the status is DRAFT
, you can
edit the decoder manifest.
UpdateDecoderManifest
, updateDecoderManifest_name
- The name of the decoder manifest to update.
data UpdateDecoderManifestResponse Source #
See: newUpdateDecoderManifestResponse
smart constructor.
Instances
newUpdateDecoderManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UpdateDecoderManifestResponse |
Create a value of UpdateDecoderManifestResponse
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:httpStatus:UpdateDecoderManifestResponse'
, updateDecoderManifestResponse_httpStatus
- The response's http status code.
UpdateDecoderManifest
, updateDecoderManifestResponse_name
- The name of the updated decoder manifest.
UpdateDecoderManifestResponse
, updateDecoderManifestResponse_arn
- The Amazon Resource Name (ARN) of the updated decoder manifest.
UpdateFleet
data UpdateFleet Source #
See: newUpdateFleet
smart constructor.
Instances
Create a value of UpdateFleet
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:
UpdateFleet
, updateFleet_description
- An updated description of the fleet.
$sel:fleetId:UpdateFleet'
, updateFleet_fleetId
- The ID of the fleet to update.
data UpdateFleetResponse Source #
See: newUpdateFleetResponse
smart constructor.
Instances
newUpdateFleetResponse Source #
Create a value of UpdateFleetResponse
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:
UpdateFleetResponse
, updateFleetResponse_arn
- The Amazon Resource Name (ARN) of the updated fleet.
UpdateFleetResponse
, updateFleetResponse_id
- The ID of the updated fleet.
$sel:httpStatus:UpdateFleetResponse'
, updateFleetResponse_httpStatus
- The response's http status code.
UpdateModelManifest
data UpdateModelManifest Source #
See: newUpdateModelManifest
smart constructor.
UpdateModelManifest' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Text)) (Maybe ManifestStatus) Text |
Instances
newUpdateModelManifest Source #
Create a value of UpdateModelManifest
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:
UpdateModelManifest
, updateModelManifest_description
- A brief description of the vehicle model.
$sel:nodesToAdd:UpdateModelManifest'
, updateModelManifest_nodesToAdd
- A list of fullyQualifiedName
of nodes, which are a general abstraction
of signals, to add to the vehicle model.
$sel:nodesToRemove:UpdateModelManifest'
, updateModelManifest_nodesToRemove
- A list of fullyQualifiedName
of nodes, which are a general abstraction
of signals, to remove from the vehicle model.
UpdateModelManifest
, updateModelManifest_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.
UpdateModelManifest
, updateModelManifest_name
- The name of the vehicle model to update.
data UpdateModelManifestResponse Source #
See: newUpdateModelManifestResponse
smart constructor.
Instances
newUpdateModelManifestResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UpdateModelManifestResponse |
Create a value of UpdateModelManifestResponse
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:httpStatus:UpdateModelManifestResponse'
, updateModelManifestResponse_httpStatus
- The response's http status code.
UpdateModelManifest
, updateModelManifestResponse_name
- The name of the updated vehicle model.
UpdateModelManifestResponse
, updateModelManifestResponse_arn
- The Amazon Resource Name (ARN) of the updated vehicle model.
UpdateSignalCatalog
data UpdateSignalCatalog Source #
See: newUpdateSignalCatalog
smart constructor.
Instances
newUpdateSignalCatalog Source #
Create a value of UpdateSignalCatalog
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:
UpdateSignalCatalog
, updateSignalCatalog_description
- A brief description of the signal catalog to update.
$sel:nodesToAdd:UpdateSignalCatalog'
, updateSignalCatalog_nodesToAdd
- A list of information about nodes to add to the signal catalog.
$sel:nodesToRemove:UpdateSignalCatalog'
, updateSignalCatalog_nodesToRemove
- A list of fullyQualifiedName
of nodes to remove from the signal
catalog.
$sel:nodesToUpdate:UpdateSignalCatalog'
, updateSignalCatalog_nodesToUpdate
- A list of information about nodes to update in the signal catalog.
UpdateSignalCatalog
, updateSignalCatalog_name
- The name of the signal catalog to update.
data UpdateSignalCatalogResponse Source #
See: newUpdateSignalCatalogResponse
smart constructor.
Instances
newUpdateSignalCatalogResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> UpdateSignalCatalogResponse |
Create a value of UpdateSignalCatalogResponse
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:httpStatus:UpdateSignalCatalogResponse'
, updateSignalCatalogResponse_httpStatus
- The response's http status code.
UpdateSignalCatalog
, updateSignalCatalogResponse_name
- The name of the updated signal catalog.
UpdateSignalCatalogResponse
, updateSignalCatalogResponse_arn
- The ARN of the updated signal catalog.
UpdateVehicle
data UpdateVehicle Source #
See: newUpdateVehicle
smart constructor.
Instances
Create a value of UpdateVehicle
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:
UpdateVehicle
, updateVehicle_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.
UpdateVehicle
, updateVehicle_attributes
- Static information about a vehicle in a key-value pair. For example:
"engineType"
: "1.3 L R2"
UpdateVehicle
, updateVehicle_decoderManifestArn
- The ARN of the decoder manifest associated with this vehicle.
UpdateVehicle
, updateVehicle_modelManifestArn
- The ARN of a vehicle model (model manifest) associated with the vehicle.
UpdateVehicle
, updateVehicle_vehicleName
- The unique ID of the vehicle to update.
data UpdateVehicleResponse Source #
See: newUpdateVehicleResponse
smart constructor.
Instances
newUpdateVehicleResponse Source #
Create a value of UpdateVehicleResponse
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:
UpdateVehicleResponse
, updateVehicleResponse_arn
- The ARN of the updated vehicle.
UpdateVehicle
, updateVehicleResponse_vehicleName
- The ID of the updated vehicle.
$sel:httpStatus:UpdateVehicleResponse'
, updateVehicleResponse_httpStatus
- The response's http status code.
Types
CampaignStatus
newtype CampaignStatus Source #
pattern CampaignStatus_CREATING :: CampaignStatus | |
pattern CampaignStatus_RUNNING :: CampaignStatus | |
pattern CampaignStatus_SUSPENDED :: CampaignStatus | |
pattern CampaignStatus_WAITING_FOR_APPROVAL :: CampaignStatus |
Instances
Compression
newtype Compression Source #
pattern Compression_OFF :: Compression | |
pattern Compression_SNAPPY :: Compression |
Instances
DiagnosticsMode
newtype DiagnosticsMode Source #
pattern DiagnosticsMode_OFF :: DiagnosticsMode | |
pattern DiagnosticsMode_SEND_ACTIVE_DTCS :: DiagnosticsMode |
Instances
LogType
pattern LogType_ERROR :: LogType | |
pattern LogType_OFF :: LogType |
Instances
ManifestStatus
newtype ManifestStatus Source #
pattern ManifestStatus_ACTIVE :: ManifestStatus | |
pattern ManifestStatus_DRAFT :: ManifestStatus |
Instances
NetworkInterfaceType
newtype NetworkInterfaceType Source #
pattern NetworkInterfaceType_CAN_INTERFACE :: NetworkInterfaceType | |
pattern NetworkInterfaceType_OBD_INTERFACE :: NetworkInterfaceType |
Instances
NodeDataType
newtype NodeDataType Source #
Instances
RegistrationStatus
newtype RegistrationStatus Source #
Instances
SignalDecoderType
newtype SignalDecoderType Source #
pattern SignalDecoderType_CAN_SIGNAL :: SignalDecoderType | |
pattern SignalDecoderType_OBD_SIGNAL :: SignalDecoderType |
Instances
SpoolingMode
newtype SpoolingMode Source #
pattern SpoolingMode_OFF :: SpoolingMode | |
pattern SpoolingMode_TO_DISK :: SpoolingMode |
Instances
TriggerMode
newtype TriggerMode Source #
pattern TriggerMode_ALWAYS :: TriggerMode | |
pattern TriggerMode_RISING_EDGE :: TriggerMode |
Instances
UpdateCampaignAction
newtype UpdateCampaignAction Source #
pattern UpdateCampaignAction_APPROVE :: UpdateCampaignAction | |
pattern UpdateCampaignAction_RESUME :: UpdateCampaignAction | |
pattern UpdateCampaignAction_SUSPEND :: UpdateCampaignAction | |
pattern UpdateCampaignAction_UPDATE :: UpdateCampaignAction |
Instances
UpdateMode
newtype UpdateMode Source #
pattern UpdateMode_Merge :: UpdateMode | |
pattern UpdateMode_Overwrite :: UpdateMode |
Instances
VehicleAssociationBehavior
newtype VehicleAssociationBehavior Source #
pattern VehicleAssociationBehavior_CreateIotThing :: VehicleAssociationBehavior | |
pattern VehicleAssociationBehavior_ValidateIotThingExists :: VehicleAssociationBehavior |
Instances
VehicleState
newtype VehicleState Source #
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.
Actuator' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Text) Text NodeDataType |
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.
Attribute
A signal that represents static information about the vehicle, such as engine type or manufacturing date.
See: newAttribute
smart constructor.
Attribute' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Text) Text NodeDataType |
Instances
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.
Branch
A group of signals that are defined in a hierarchical structure.
See: newBranch
smart constructor.
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
.
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.
CampaignSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe CampaignStatus) (Maybe Text) POSIX POSIX |
Instances
:: 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_APPROVAL
state. 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.
CanDbcDefinition
data CanDbcDefinition Source #
Configurations used to create a decoder manifest.
See: newCanDbcDefinition
smart constructor.
Instances
:: 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.
CanInterface
data CanInterface Source #
A single controller area network (CAN) device interface.
See: newCanInterface
smart constructor.
Instances
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.
CanSignal
Information about a single controller area network (CAN) signal and the messages it receives and transmits.
See: newCanSignal
smart constructor.
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.
CloudWatchLogDeliveryOptions
data CloudWatchLogDeliveryOptions Source #
The log delivery option to send data to Amazon CloudWatch Logs.
See: newCloudWatchLogDeliveryOptions
smart constructor.
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.
CollectionScheme
data CollectionScheme Source #
Specifies what data to collect and how often or when to collect it.
See: newCollectionScheme
smart constructor.
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.
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.
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
.
CreateVehicleError
data CreateVehicleError Source #
An HTTP error resulting from creating a vehicle.
See: newCreateVehicleError
smart constructor.
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.
CreateVehicleRequestItem
data CreateVehicleRequestItem Source #
Information about the vehicle to create.
See: newCreateVehicleRequestItem
smart constructor.
CreateVehicleRequestItem' (Maybe VehicleAssociationBehavior) (Maybe (HashMap Text Text)) (Maybe [Tag]) Text Text Text |
Instances
newCreateVehicleRequestItem Source #
:: 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.
CreateVehicleResponseItem
data CreateVehicleResponseItem Source #
Information about a created vehicle.
See: newCreateVehicleResponseItem
smart constructor.
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.
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.
DecoderManifestSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManifestStatus) POSIX POSIX |
Instances
newDecoderManifestSummary Source #
:: 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).
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.
Instances
:: 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).
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.
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.
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.
Instances
newIamRegistrationResponse Source #
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
.
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.
Instances
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
.
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.
ModelManifestSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ManifestStatus) POSIX POSIX |
Instances
newModelManifestSummary Source #
:: 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).
NetworkFileDefinition
data NetworkFileDefinition Source #
Specifications for defining a vehicle network.
See: newNetworkFileDefinition
smart constructor.
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.
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.
Instances
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.
Node
A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
See: newNode
smart constructor.
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.
NodeCounts
data NodeCounts Source #
Information about the number of nodes and node types in a vehicle network.
See: newNodeCounts
smart constructor.
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.
ObdInterface
data ObdInterface Source #
A network interface that specifies the On-board diagnostic (OBD) II network protocol.
See: newObdInterface
smart constructor.
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.
ObdSignal
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
See: newObdSignal
smart constructor.
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.
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.
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.
SignalCatalogSummary
data SignalCatalogSummary Source #
Information about a collection of standardized signals, which can be attributes, branches, sensors, or actuators.
See: newSignalCatalogSummary
smart constructor.
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.
SignalDecoder
data SignalDecoder Source #
Information about a signal decoder.
See: newSignalDecoder
smart constructor.
Instances
:: 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.
SignalInformation
data SignalInformation Source #
Information about a signal.
See: newSignalInformation
smart constructor.
Instances
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.
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.
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.
TimestreamRegistrationResponse
data TimestreamRegistrationResponse Source #
Information about the registered Amazon Timestream resources or errors, if any.
See: newTimestreamRegistrationResponse
smart constructor.
Instances
newTimestreamRegistrationResponse Source #
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
.
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.
Instances
newTimestreamResources Source #
:: 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.
UpdateVehicleError
data UpdateVehicleError Source #
An HTTP error resulting from updating the description for a vehicle.
See: newUpdateVehicleError
smart constructor.
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.
UpdateVehicleRequestItem
data UpdateVehicleRequestItem Source #
Information about the vehicle to update.
See: newUpdateVehicleRequestItem
smart constructor.
UpdateVehicleRequestItem' (Maybe UpdateMode) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) Text |
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.
UpdateVehicleResponseItem
data UpdateVehicleResponseItem Source #
Information about the updated vehicle.
See: newUpdateVehicleResponseItem
smart constructor.
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.
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.
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.
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.
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).