123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class IoTFleetWise extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: IoTFleetWise.Types.ClientConfiguration)
- config: Config & IoTFleetWise.Types.ClientConfiguration;
- /**
- * Adds, or associates, a vehicle with a fleet.
- */
- associateVehicleFleet(params: IoTFleetWise.Types.AssociateVehicleFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.AssociateVehicleFleetResponse) => void): Request<IoTFleetWise.Types.AssociateVehicleFleetResponse, AWSError>;
- /**
- * Adds, or associates, a vehicle with a fleet.
- */
- associateVehicleFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.AssociateVehicleFleetResponse) => void): Request<IoTFleetWise.Types.AssociateVehicleFleetResponse, AWSError>;
- /**
- * Creates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- batchCreateVehicle(params: IoTFleetWise.Types.BatchCreateVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.BatchCreateVehicleResponse) => void): Request<IoTFleetWise.Types.BatchCreateVehicleResponse, AWSError>;
- /**
- * Creates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Create multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- batchCreateVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.BatchCreateVehicleResponse) => void): Request<IoTFleetWise.Types.BatchCreateVehicleResponse, AWSError>;
- /**
- * Updates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- batchUpdateVehicle(params: IoTFleetWise.Types.BatchUpdateVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.BatchUpdateVehicleResponse) => void): Request<IoTFleetWise.Types.BatchUpdateVehicleResponse, AWSError>;
- /**
- * Updates a group, or batch, of vehicles. You must specify a decoder manifest and a vehicle model (model manifest) for each vehicle. For more information, see Update multiple vehicles (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- batchUpdateVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.BatchUpdateVehicleResponse) => void): Request<IoTFleetWise.Types.BatchUpdateVehicleResponse, AWSError>;
- /**
- * Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles. For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createCampaign(params: IoTFleetWise.Types.CreateCampaignRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateCampaignResponse) => void): Request<IoTFleetWise.Types.CreateCampaignResponse, AWSError>;
- /**
- * Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles. For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createCampaign(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateCampaignResponse) => void): Request<IoTFleetWise.Types.CreateCampaignResponse, AWSError>;
- /**
- * Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true: Every signal decoder has a unique name. Each signal decoder is associated with a network interface. Each network interface has a unique ID. The signal decoders are specified in the model manifest.
- */
- createDecoderManifest(params: IoTFleetWise.Types.CreateDecoderManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateDecoderManifestResponse) => void): Request<IoTFleetWise.Types.CreateDecoderManifestResponse, AWSError>;
- /**
- * Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true: Every signal decoder has a unique name. Each signal decoder is associated with a network interface. Each network interface has a unique ID. The signal decoders are specified in the model manifest.
- */
- createDecoderManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateDecoderManifestResponse) => void): Request<IoTFleetWise.Types.CreateDecoderManifestResponse, AWSError>;
- /**
- * Creates a fleet that represents a group of vehicles. You must create both a signal catalog and vehicles before you can create a fleet. For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createFleet(params: IoTFleetWise.Types.CreateFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateFleetResponse) => void): Request<IoTFleetWise.Types.CreateFleetResponse, AWSError>;
- /**
- * Creates a fleet that represents a group of vehicles. You must create both a signal catalog and vehicles before you can create a fleet. For more information, see Fleets in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateFleetResponse) => void): Request<IoTFleetWise.Types.CreateFleetResponse, AWSError>;
- /**
- * Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createModelManifest(params: IoTFleetWise.Types.CreateModelManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateModelManifestResponse) => void): Request<IoTFleetWise.Types.CreateModelManifestResponse, AWSError>;
- /**
- * Creates a vehicle model (model manifest) that specifies signals (attributes, branches, sensors, and actuators). For more information, see Vehicle models in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createModelManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateModelManifestResponse) => void): Request<IoTFleetWise.Types.CreateModelManifestResponse, AWSError>;
- /**
- * Creates a collection of standardized signals that can be reused to create vehicle models.
- */
- createSignalCatalog(params: IoTFleetWise.Types.CreateSignalCatalogRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateSignalCatalogResponse) => void): Request<IoTFleetWise.Types.CreateSignalCatalogResponse, AWSError>;
- /**
- * Creates a collection of standardized signals that can be reused to create vehicle models.
- */
- createSignalCatalog(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateSignalCatalogResponse) => void): Request<IoTFleetWise.Types.CreateSignalCatalogResponse, AWSError>;
- /**
- * Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model. If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing. For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createVehicle(params: IoTFleetWise.Types.CreateVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.CreateVehicleResponse) => void): Request<IoTFleetWise.Types.CreateVehicleResponse, AWSError>;
- /**
- * Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model. If you have an existing Amazon Web Services IoT thing, you can use Amazon Web Services IoT FleetWise to create a vehicle and collect data from your thing. For more information, see Create a vehicle (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- createVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.CreateVehicleResponse) => void): Request<IoTFleetWise.Types.CreateVehicleResponse, AWSError>;
- /**
- * Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
- */
- deleteCampaign(params: IoTFleetWise.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteCampaignResponse) => void): Request<IoTFleetWise.Types.DeleteCampaignResponse, AWSError>;
- /**
- * Deletes a data collection campaign. Deleting a campaign suspends all data collection and removes it from any vehicles.
- */
- deleteCampaign(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteCampaignResponse) => void): Request<IoTFleetWise.Types.DeleteCampaignResponse, AWSError>;
- /**
- * Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteDecoderManifest(params: IoTFleetWise.Types.DeleteDecoderManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteDecoderManifestResponse) => void): Request<IoTFleetWise.Types.DeleteDecoderManifestResponse, AWSError>;
- /**
- * Deletes a decoder manifest. You can't delete a decoder manifest if it has vehicles associated with it. If the decoder manifest is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteDecoderManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteDecoderManifestResponse) => void): Request<IoTFleetWise.Types.DeleteDecoderManifestResponse, AWSError>;
- /**
- * Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteFleet(params: IoTFleetWise.Types.DeleteFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteFleetResponse) => void): Request<IoTFleetWise.Types.DeleteFleetResponse, AWSError>;
- /**
- * Deletes a fleet. Before you delete a fleet, all vehicles must be dissociated from the fleet. For more information, see Delete a fleet (AWS CLI) in the Amazon Web Services IoT FleetWise Developer Guide. If the fleet is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteFleetResponse) => void): Request<IoTFleetWise.Types.DeleteFleetResponse, AWSError>;
- /**
- * Deletes a vehicle model (model manifest). If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteModelManifest(params: IoTFleetWise.Types.DeleteModelManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteModelManifestResponse) => void): Request<IoTFleetWise.Types.DeleteModelManifestResponse, AWSError>;
- /**
- * Deletes a vehicle model (model manifest). If the vehicle model is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteModelManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteModelManifestResponse) => void): Request<IoTFleetWise.Types.DeleteModelManifestResponse, AWSError>;
- /**
- * Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteSignalCatalog(params: IoTFleetWise.Types.DeleteSignalCatalogRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteSignalCatalogResponse) => void): Request<IoTFleetWise.Types.DeleteSignalCatalogResponse, AWSError>;
- /**
- * Deletes a signal catalog. If the signal catalog is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteSignalCatalog(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteSignalCatalogResponse) => void): Request<IoTFleetWise.Types.DeleteSignalCatalogResponse, AWSError>;
- /**
- * Deletes a vehicle and removes it from any campaigns. If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteVehicle(params: IoTFleetWise.Types.DeleteVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteVehicleResponse) => void): Request<IoTFleetWise.Types.DeleteVehicleResponse, AWSError>;
- /**
- * Deletes a vehicle and removes it from any campaigns. If the vehicle is successfully deleted, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- deleteVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.DeleteVehicleResponse) => void): Request<IoTFleetWise.Types.DeleteVehicleResponse, AWSError>;
- /**
- * Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- disassociateVehicleFleet(params: IoTFleetWise.Types.DisassociateVehicleFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.DisassociateVehicleFleetResponse) => void): Request<IoTFleetWise.Types.DisassociateVehicleFleetResponse, AWSError>;
- /**
- * Removes, or disassociates, a vehicle from a fleet. Disassociating a vehicle from a fleet doesn't delete the vehicle. If the vehicle is successfully dissociated from a fleet, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty body.
- */
- disassociateVehicleFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.DisassociateVehicleFleetResponse) => void): Request<IoTFleetWise.Types.DisassociateVehicleFleetResponse, AWSError>;
- /**
- * Retrieves information about a campaign.
- */
- getCampaign(params: IoTFleetWise.Types.GetCampaignRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetCampaignResponse) => void): Request<IoTFleetWise.Types.GetCampaignResponse, AWSError>;
- /**
- * Retrieves information about a campaign.
- */
- getCampaign(callback?: (err: AWSError, data: IoTFleetWise.Types.GetCampaignResponse) => void): Request<IoTFleetWise.Types.GetCampaignResponse, AWSError>;
- /**
- * Retrieves information about a created decoder manifest.
- */
- getDecoderManifest(params: IoTFleetWise.Types.GetDecoderManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetDecoderManifestResponse) => void): Request<IoTFleetWise.Types.GetDecoderManifestResponse, AWSError>;
- /**
- * Retrieves information about a created decoder manifest.
- */
- getDecoderManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.GetDecoderManifestResponse) => void): Request<IoTFleetWise.Types.GetDecoderManifestResponse, AWSError>;
- /**
- * Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
- */
- getEncryptionConfiguration(params: IoTFleetWise.Types.GetEncryptionConfigurationRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetEncryptionConfigurationResponse) => void): Request<IoTFleetWise.Types.GetEncryptionConfigurationResponse, AWSError>;
- /**
- * Retrieves the encryption configuration for resources and data in Amazon Web Services IoT FleetWise.
- */
- getEncryptionConfiguration(callback?: (err: AWSError, data: IoTFleetWise.Types.GetEncryptionConfigurationResponse) => void): Request<IoTFleetWise.Types.GetEncryptionConfigurationResponse, AWSError>;
- /**
- * Retrieves information about a fleet.
- */
- getFleet(params: IoTFleetWise.Types.GetFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetFleetResponse) => void): Request<IoTFleetWise.Types.GetFleetResponse, AWSError>;
- /**
- * Retrieves information about a fleet.
- */
- getFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.GetFleetResponse) => void): Request<IoTFleetWise.Types.GetFleetResponse, AWSError>;
- /**
- * Retrieves the logging options.
- */
- getLoggingOptions(params: IoTFleetWise.Types.GetLoggingOptionsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetLoggingOptionsResponse) => void): Request<IoTFleetWise.Types.GetLoggingOptionsResponse, AWSError>;
- /**
- * Retrieves the logging options.
- */
- getLoggingOptions(callback?: (err: AWSError, data: IoTFleetWise.Types.GetLoggingOptionsResponse) => void): Request<IoTFleetWise.Types.GetLoggingOptionsResponse, AWSError>;
- /**
- * Retrieves information about a vehicle model (model manifest).
- */
- getModelManifest(params: IoTFleetWise.Types.GetModelManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetModelManifestResponse) => void): Request<IoTFleetWise.Types.GetModelManifestResponse, AWSError>;
- /**
- * Retrieves information about a vehicle model (model manifest).
- */
- getModelManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.GetModelManifestResponse) => void): Request<IoTFleetWise.Types.GetModelManifestResponse, AWSError>;
- /**
- * Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. This API operation doesn't require input parameters.
- */
- getRegisterAccountStatus(params: IoTFleetWise.Types.GetRegisterAccountStatusRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetRegisterAccountStatusResponse) => void): Request<IoTFleetWise.Types.GetRegisterAccountStatusResponse, AWSError>;
- /**
- * Retrieves information about the status of registering your Amazon Web Services account, IAM, and Amazon Timestream resources so that Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. This API operation doesn't require input parameters.
- */
- getRegisterAccountStatus(callback?: (err: AWSError, data: IoTFleetWise.Types.GetRegisterAccountStatusResponse) => void): Request<IoTFleetWise.Types.GetRegisterAccountStatusResponse, AWSError>;
- /**
- * Retrieves information about a signal catalog.
- */
- getSignalCatalog(params: IoTFleetWise.Types.GetSignalCatalogRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetSignalCatalogResponse) => void): Request<IoTFleetWise.Types.GetSignalCatalogResponse, AWSError>;
- /**
- * Retrieves information about a signal catalog.
- */
- getSignalCatalog(callback?: (err: AWSError, data: IoTFleetWise.Types.GetSignalCatalogResponse) => void): Request<IoTFleetWise.Types.GetSignalCatalogResponse, AWSError>;
- /**
- * Retrieves information about a vehicle.
- */
- getVehicle(params: IoTFleetWise.Types.GetVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetVehicleResponse) => void): Request<IoTFleetWise.Types.GetVehicleResponse, AWSError>;
- /**
- * Retrieves information about a vehicle.
- */
- getVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.GetVehicleResponse) => void): Request<IoTFleetWise.Types.GetVehicleResponse, AWSError>;
- /**
- * Retrieves information about the status of a vehicle with any associated campaigns.
- */
- getVehicleStatus(params: IoTFleetWise.Types.GetVehicleStatusRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.GetVehicleStatusResponse) => void): Request<IoTFleetWise.Types.GetVehicleStatusResponse, AWSError>;
- /**
- * Retrieves information about the status of a vehicle with any associated campaigns.
- */
- getVehicleStatus(callback?: (err: AWSError, data: IoTFleetWise.Types.GetVehicleStatusResponse) => void): Request<IoTFleetWise.Types.GetVehicleStatusResponse, AWSError>;
- /**
- * Creates a decoder manifest using your existing CAN DBC file from your local device.
- */
- importDecoderManifest(params: IoTFleetWise.Types.ImportDecoderManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ImportDecoderManifestResponse) => void): Request<IoTFleetWise.Types.ImportDecoderManifestResponse, AWSError>;
- /**
- * Creates a decoder manifest using your existing CAN DBC file from your local device.
- */
- importDecoderManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.ImportDecoderManifestResponse) => void): Request<IoTFleetWise.Types.ImportDecoderManifestResponse, AWSError>;
- /**
- * Creates a signal catalog using your existing VSS formatted content from your local device.
- */
- importSignalCatalog(params: IoTFleetWise.Types.ImportSignalCatalogRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ImportSignalCatalogResponse) => void): Request<IoTFleetWise.Types.ImportSignalCatalogResponse, AWSError>;
- /**
- * Creates a signal catalog using your existing VSS formatted content from your local device.
- */
- importSignalCatalog(callback?: (err: AWSError, data: IoTFleetWise.Types.ImportSignalCatalogResponse) => void): Request<IoTFleetWise.Types.ImportSignalCatalogResponse, AWSError>;
- /**
- * Lists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listCampaigns(params: IoTFleetWise.Types.ListCampaignsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListCampaignsResponse) => void): Request<IoTFleetWise.Types.ListCampaignsResponse, AWSError>;
- /**
- * Lists information about created campaigns. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listCampaigns(callback?: (err: AWSError, data: IoTFleetWise.Types.ListCampaignsResponse) => void): Request<IoTFleetWise.Types.ListCampaignsResponse, AWSError>;
- /**
- * Lists the network interfaces specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifestNetworkInterfaces(params: IoTFleetWise.Types.ListDecoderManifestNetworkInterfacesRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestNetworkInterfacesResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestNetworkInterfacesResponse, AWSError>;
- /**
- * Lists the network interfaces specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifestNetworkInterfaces(callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestNetworkInterfacesResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestNetworkInterfacesResponse, AWSError>;
- /**
- * A list of information about signal decoders specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifestSignals(params: IoTFleetWise.Types.ListDecoderManifestSignalsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestSignalsResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestSignalsResponse, AWSError>;
- /**
- * A list of information about signal decoders specified in a decoder manifest. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifestSignals(callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestSignalsResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestSignalsResponse, AWSError>;
- /**
- * Lists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifests(params: IoTFleetWise.Types.ListDecoderManifestsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestsResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestsResponse, AWSError>;
- /**
- * Lists decoder manifests. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listDecoderManifests(callback?: (err: AWSError, data: IoTFleetWise.Types.ListDecoderManifestsResponse) => void): Request<IoTFleetWise.Types.ListDecoderManifestsResponse, AWSError>;
- /**
- * Retrieves information for each created fleet in an Amazon Web Services account. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listFleets(params: IoTFleetWise.Types.ListFleetsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListFleetsResponse) => void): Request<IoTFleetWise.Types.ListFleetsResponse, AWSError>;
- /**
- * Retrieves information for each created fleet in an Amazon Web Services account. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listFleets(callback?: (err: AWSError, data: IoTFleetWise.Types.ListFleetsResponse) => void): Request<IoTFleetWise.Types.ListFleetsResponse, AWSError>;
- /**
- * Retrieves a list of IDs for all fleets that the vehicle is associated with. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listFleetsForVehicle(params: IoTFleetWise.Types.ListFleetsForVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListFleetsForVehicleResponse) => void): Request<IoTFleetWise.Types.ListFleetsForVehicleResponse, AWSError>;
- /**
- * Retrieves a list of IDs for all fleets that the vehicle is associated with. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listFleetsForVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.ListFleetsForVehicleResponse) => void): Request<IoTFleetWise.Types.ListFleetsForVehicleResponse, AWSError>;
- /**
- * Lists information about nodes specified in a vehicle model (model manifest). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listModelManifestNodes(params: IoTFleetWise.Types.ListModelManifestNodesRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListModelManifestNodesResponse) => void): Request<IoTFleetWise.Types.ListModelManifestNodesResponse, AWSError>;
- /**
- * Lists information about nodes specified in a vehicle model (model manifest). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listModelManifestNodes(callback?: (err: AWSError, data: IoTFleetWise.Types.ListModelManifestNodesResponse) => void): Request<IoTFleetWise.Types.ListModelManifestNodesResponse, AWSError>;
- /**
- * Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listModelManifests(params: IoTFleetWise.Types.ListModelManifestsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListModelManifestsResponse) => void): Request<IoTFleetWise.Types.ListModelManifestsResponse, AWSError>;
- /**
- * Retrieves a list of vehicle models (model manifests). This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listModelManifests(callback?: (err: AWSError, data: IoTFleetWise.Types.ListModelManifestsResponse) => void): Request<IoTFleetWise.Types.ListModelManifestsResponse, AWSError>;
- /**
- * Lists of information about the signals (nodes) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listSignalCatalogNodes(params: IoTFleetWise.Types.ListSignalCatalogNodesRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListSignalCatalogNodesResponse) => void): Request<IoTFleetWise.Types.ListSignalCatalogNodesResponse, AWSError>;
- /**
- * Lists of information about the signals (nodes) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listSignalCatalogNodes(callback?: (err: AWSError, data: IoTFleetWise.Types.ListSignalCatalogNodesResponse) => void): Request<IoTFleetWise.Types.ListSignalCatalogNodesResponse, AWSError>;
- /**
- * Lists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listSignalCatalogs(params: IoTFleetWise.Types.ListSignalCatalogsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListSignalCatalogsResponse) => void): Request<IoTFleetWise.Types.ListSignalCatalogsResponse, AWSError>;
- /**
- * Lists all the created signal catalogs in an Amazon Web Services account. You can use to list information about each signal (node) specified in a signal catalog. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listSignalCatalogs(callback?: (err: AWSError, data: IoTFleetWise.Types.ListSignalCatalogsResponse) => void): Request<IoTFleetWise.Types.ListSignalCatalogsResponse, AWSError>;
- /**
- * Lists the tags (metadata) you have assigned to the resource.
- */
- listTagsForResource(params: IoTFleetWise.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListTagsForResourceResponse) => void): Request<IoTFleetWise.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Lists the tags (metadata) you have assigned to the resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: IoTFleetWise.Types.ListTagsForResourceResponse) => void): Request<IoTFleetWise.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Retrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listVehicles(params: IoTFleetWise.Types.ListVehiclesRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListVehiclesResponse) => void): Request<IoTFleetWise.Types.ListVehiclesResponse, AWSError>;
- /**
- * Retrieves a list of summaries of created vehicles. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listVehicles(callback?: (err: AWSError, data: IoTFleetWise.Types.ListVehiclesResponse) => void): Request<IoTFleetWise.Types.ListVehiclesResponse, AWSError>;
- /**
- * Retrieves a list of summaries of all vehicles associated with a fleet. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listVehiclesInFleet(params: IoTFleetWise.Types.ListVehiclesInFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.ListVehiclesInFleetResponse) => void): Request<IoTFleetWise.Types.ListVehiclesInFleetResponse, AWSError>;
- /**
- * Retrieves a list of summaries of all vehicles associated with a fleet. This API operation uses pagination. Specify the nextToken parameter in the request to return more results.
- */
- listVehiclesInFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.ListVehiclesInFleetResponse) => void): Request<IoTFleetWise.Types.ListVehiclesInFleetResponse, AWSError>;
- /**
- * Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- putEncryptionConfiguration(params: IoTFleetWise.Types.PutEncryptionConfigurationRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.PutEncryptionConfigurationResponse) => void): Request<IoTFleetWise.Types.PutEncryptionConfigurationResponse, AWSError>;
- /**
- * Creates or updates the encryption configuration. Amazon Web Services IoT FleetWise can encrypt your data and resources using an Amazon Web Services managed key. Or, you can use a KMS key that you own and manage. For more information, see Data encryption in the Amazon Web Services IoT FleetWise Developer Guide.
- */
- putEncryptionConfiguration(callback?: (err: AWSError, data: IoTFleetWise.Types.PutEncryptionConfigurationResponse) => void): Request<IoTFleetWise.Types.PutEncryptionConfigurationResponse, AWSError>;
- /**
- * Creates or updates the logging option.
- */
- putLoggingOptions(params: IoTFleetWise.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.PutLoggingOptionsResponse) => void): Request<IoTFleetWise.Types.PutLoggingOptionsResponse, AWSError>;
- /**
- * Creates or updates the logging option.
- */
- putLoggingOptions(callback?: (err: AWSError, data: IoTFleetWise.Types.PutLoggingOptionsResponse) => void): Request<IoTFleetWise.Types.PutLoggingOptionsResponse, AWSError>;
- /**
- * This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation. You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation. If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference. Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
- */
- registerAccount(params: IoTFleetWise.Types.RegisterAccountRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.RegisterAccountResponse) => void): Request<IoTFleetWise.Types.RegisterAccountResponse, AWSError>;
- /**
- * This API operation contains deprecated parameters. Register your account again without the Timestream resources parameter so that Amazon Web Services IoT FleetWise can remove the Timestream metadata stored. You should then pass the data destination into the CreateCampaign API operation. You must delete any existing campaigns that include an empty data destination before you register your account again. For more information, see the DeleteCampaign API operation. If you want to delete the Timestream inline policy from the service-linked role, such as to mitigate an overly permissive policy, you must first delete any existing campaigns. Then delete the service-linked role and register your account again to enable CloudWatch metrics. For more information, see DeleteServiceLinkedRole in the Identity and Access Management API Reference. Registers your Amazon Web Services account, IAM, and Amazon Timestream resources so Amazon Web Services IoT FleetWise can transfer your vehicle data to the Amazon Web Services Cloud. For more information, including step-by-step procedures, see Setting up Amazon Web Services IoT FleetWise. An Amazon Web Services account is not the same thing as a "user." An Amazon Web Services user is an identity that you create using Identity and Access Management (IAM) and takes the form of either an IAM user or an IAM role, both with credentials. A single Amazon Web Services account can, and typically does, contain many users and roles.
- */
- registerAccount(callback?: (err: AWSError, data: IoTFleetWise.Types.RegisterAccountResponse) => void): Request<IoTFleetWise.Types.RegisterAccountResponse, AWSError>;
- /**
- * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
- */
- tagResource(params: IoTFleetWise.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.TagResourceResponse) => void): Request<IoTFleetWise.Types.TagResourceResponse, AWSError>;
- /**
- * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
- */
- tagResource(callback?: (err: AWSError, data: IoTFleetWise.Types.TagResourceResponse) => void): Request<IoTFleetWise.Types.TagResourceResponse, AWSError>;
- /**
- * Removes the given tags (metadata) from the resource.
- */
- untagResource(params: IoTFleetWise.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UntagResourceResponse) => void): Request<IoTFleetWise.Types.UntagResourceResponse, AWSError>;
- /**
- * Removes the given tags (metadata) from the resource.
- */
- untagResource(callback?: (err: AWSError, data: IoTFleetWise.Types.UntagResourceResponse) => void): Request<IoTFleetWise.Types.UntagResourceResponse, AWSError>;
- /**
- * Updates a campaign.
- */
- updateCampaign(params: IoTFleetWise.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateCampaignResponse) => void): Request<IoTFleetWise.Types.UpdateCampaignResponse, AWSError>;
- /**
- * Updates a campaign.
- */
- updateCampaign(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateCampaignResponse) => void): Request<IoTFleetWise.Types.UpdateCampaignResponse, AWSError>;
- /**
- * Updates a decoder manifest. A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.
- */
- updateDecoderManifest(params: IoTFleetWise.Types.UpdateDecoderManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateDecoderManifestResponse) => void): Request<IoTFleetWise.Types.UpdateDecoderManifestResponse, AWSError>;
- /**
- * Updates a decoder manifest. A decoder manifest can only be updated when the status is DRAFT. Only ACTIVE decoder manifests can be associated with vehicles.
- */
- updateDecoderManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateDecoderManifestResponse) => void): Request<IoTFleetWise.Types.UpdateDecoderManifestResponse, AWSError>;
- /**
- * Updates the description of an existing fleet. If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
- */
- updateFleet(params: IoTFleetWise.Types.UpdateFleetRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateFleetResponse) => void): Request<IoTFleetWise.Types.UpdateFleetResponse, AWSError>;
- /**
- * Updates the description of an existing fleet. If the fleet is successfully updated, Amazon Web Services IoT FleetWise sends back an HTTP 200 response with an empty HTTP body.
- */
- updateFleet(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateFleetResponse) => void): Request<IoTFleetWise.Types.UpdateFleetResponse, AWSError>;
- /**
- * Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
- */
- updateModelManifest(params: IoTFleetWise.Types.UpdateModelManifestRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateModelManifestResponse) => void): Request<IoTFleetWise.Types.UpdateModelManifestResponse, AWSError>;
- /**
- * Updates a vehicle model (model manifest). If created vehicles are associated with a vehicle model, it can't be updated.
- */
- updateModelManifest(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateModelManifestResponse) => void): Request<IoTFleetWise.Types.UpdateModelManifestResponse, AWSError>;
- /**
- * Updates a signal catalog.
- */
- updateSignalCatalog(params: IoTFleetWise.Types.UpdateSignalCatalogRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateSignalCatalogResponse) => void): Request<IoTFleetWise.Types.UpdateSignalCatalogResponse, AWSError>;
- /**
- * Updates a signal catalog.
- */
- updateSignalCatalog(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateSignalCatalogResponse) => void): Request<IoTFleetWise.Types.UpdateSignalCatalogResponse, AWSError>;
- /**
- * Updates a vehicle.
- */
- updateVehicle(params: IoTFleetWise.Types.UpdateVehicleRequest, callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateVehicleResponse) => void): Request<IoTFleetWise.Types.UpdateVehicleResponse, AWSError>;
- /**
- * Updates a vehicle.
- */
- updateVehicle(callback?: (err: AWSError, data: IoTFleetWise.Types.UpdateVehicleResponse) => void): Request<IoTFleetWise.Types.UpdateVehicleResponse, AWSError>;
- }
- declare namespace IoTFleetWise {
- export interface Actuator {
- /**
- * The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be Vehicle.Front.Left.Door.Lock.
- */
- fullyQualifiedName: string;
- /**
- * The specified data type of the actuator.
- */
- dataType: NodeDataType;
- /**
- * A brief description of the actuator.
- */
- description?: description;
- /**
- * The scientific unit for the actuator.
- */
- unit?: string;
- /**
- * A list of possible values an actuator can take.
- */
- allowedValues?: listOfStrings;
- /**
- * The specified possible minimum value of an actuator.
- */
- min?: double;
- /**
- * The specified possible maximum value of an actuator.
- */
- max?: double;
- /**
- * A specified value for the actuator.
- */
- assignedValue?: string;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- /**
- * The fully qualified name of the struct node for the actuator if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of an actuator might be Vehicle.Door.LockStruct.
- */
- structFullyQualifiedName?: NodePath;
- }
- export type AmazonResourceName = string;
- export interface AssociateVehicleFleetRequest {
- /**
- * The unique ID of the vehicle to associate with the fleet.
- */
- vehicleName: vehicleName;
- /**
- * The ID of a fleet.
- */
- fleetId: fleetId;
- }
- export interface AssociateVehicleFleetResponse {
- }
- export interface Attribute {
- /**
- * The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.
- */
- fullyQualifiedName: string;
- /**
- * The specified data type of the attribute.
- */
- dataType: NodeDataType;
- /**
- * A brief description of the attribute.
- */
- description?: description;
- /**
- * The scientific unit for the attribute.
- */
- unit?: string;
- /**
- * A list of possible values an attribute can be assigned.
- */
- allowedValues?: listOfStrings;
- /**
- * The specified possible minimum value of the attribute.
- */
- min?: double;
- /**
- * The specified possible maximum value of the attribute.
- */
- max?: double;
- /**
- * A specified value for the attribute.
- */
- assignedValue?: string;
- /**
- * The default value of the attribute.
- */
- defaultValue?: string;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- }
- export interface BatchCreateVehicleRequest {
- /**
- * A list of information about each vehicle to create. For more information, see the API data type.
- */
- vehicles: createVehicleRequestItems;
- }
- export interface BatchCreateVehicleResponse {
- /**
- * A list of information about a batch of created vehicles. For more information, see the API data type.
- */
- vehicles?: createVehicleResponses;
- /**
- * A list of information about creation errors, or an empty list if there aren't any errors.
- */
- errors?: createVehicleErrors;
- }
- export interface BatchUpdateVehicleRequest {
- /**
- * A list of information about the vehicles to update. For more information, see the API data type.
- */
- vehicles: updateVehicleRequestItems;
- }
- export interface BatchUpdateVehicleResponse {
- /**
- * A list of information about the batch of updated vehicles. This list contains only unique IDs for the vehicles that were updated.
- */
- vehicles?: updateVehicleResponseItems;
- /**
- * A list of information about errors returned while updating a batch of vehicles, or, if there aren't any errors, an empty list.
- */
- errors?: updateVehicleErrors;
- }
- export interface Branch {
- /**
- * The fully qualified name of the branch. For example, the fully qualified name of a branch might be Vehicle.Body.Engine.
- */
- fullyQualifiedName: string;
- /**
- * A brief description of the branch.
- */
- description?: description;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- }
- export type CampaignStatus = "CREATING"|"WAITING_FOR_APPROVAL"|"RUNNING"|"SUSPENDED"|string;
- export interface CampaignSummary {
- /**
- * The Amazon Resource Name (ARN) of a campaign.
- */
- arn?: arn;
- /**
- * The name of a campaign.
- */
- name?: campaignName;
- /**
- * The description of the campaign.
- */
- description?: description;
- /**
- * The ARN of the signal catalog associated with the campaign.
- */
- signalCatalogArn?: arn;
- /**
- * The ARN of a vehicle or fleet to which the campaign is deployed.
- */
- targetArn?: arn;
- /**
- * 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 the WAITING_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.
- */
- status?: CampaignStatus;
- /**
- * The time the campaign was created.
- */
- creationTime: timestamp;
- /**
- * The last time the campaign was modified.
- */
- lastModificationTime: timestamp;
- }
- export interface CanDbcDefinition {
- /**
- * Contains information about a network interface.
- */
- networkInterface: InterfaceId;
- /**
- * 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. The DBC file can be a maximum size of 200 MB.
- */
- canDbcFiles: NetworkFilesList;
- /**
- * Pairs every signal specified in your vehicle model with a signal decoder.
- */
- signalsMap?: ModelSignalsMap;
- }
- export interface CanInterface {
- /**
- * The unique name of the interface.
- */
- name: CanInterfaceName;
- /**
- * The name of the communication protocol for the interface.
- */
- protocolName?: ProtocolName;
- /**
- * The version of the communication protocol for the interface.
- */
- protocolVersion?: ProtocolVersion;
- }
- export type CanInterfaceName = string;
- export interface CanSignal {
- /**
- * The ID of the message.
- */
- messageId: nonNegativeInteger;
- /**
- * Whether the byte ordering of a CAN message is big-endian.
- */
- isBigEndian: PrimitiveBoolean;
- /**
- * Whether the message data is specified as a signed value.
- */
- isSigned: PrimitiveBoolean;
- /**
- * Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB). This value might be different from the value in a DBC file. For little endian signals, startBit is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the startBit.
- */
- startBit: nonNegativeInteger;
- /**
- * The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset.
- */
- offset: double;
- /**
- * A multiplier used to decode the CAN message.
- */
- factor: double;
- /**
- * How many bytes of data are in the message.
- */
- length: nonNegativeInteger;
- /**
- * The name of the signal.
- */
- name?: CanSignalName;
- }
- export type CanSignalName = string;
- export interface CloudWatchLogDeliveryOptions {
- /**
- * The type of log to send data to Amazon CloudWatch Logs.
- */
- logType: LogType;
- /**
- * The Amazon CloudWatch Logs group the operation sends data to.
- */
- logGroupName?: CloudWatchLogGroupName;
- }
- export type CloudWatchLogGroupName = string;
- export interface CollectionScheme {
- /**
- * Information about a collection scheme that uses a time period to decide how often to collect data.
- */
- timeBasedCollectionScheme?: TimeBasedCollectionScheme;
- /**
- * Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
- */
- conditionBasedCollectionScheme?: ConditionBasedCollectionScheme;
- }
- export type Compression = "OFF"|"SNAPPY"|string;
- export interface ConditionBasedCollectionScheme {
- /**
- * The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.
- */
- expression: eventExpression;
- /**
- * 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.
- */
- minimumTriggerIntervalMs?: uint32;
- /**
- * 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.
- */
- triggerMode?: TriggerMode;
- /**
- * Specifies the version of the conditional expression language.
- */
- conditionLanguageVersion?: languageVersion;
- }
- export interface CreateCampaignRequest {
- /**
- * The name of the campaign to create.
- */
- name: campaignName;
- /**
- * An optional description of the campaign to help identify its purpose.
- */
- description?: description;
- /**
- * (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
- */
- signalCatalogArn: arn;
- /**
- * The ARN of the vehicle or fleet to deploy a campaign to.
- */
- targetArn: arn;
- /**
- * (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used. Default: 0
- */
- startTime?: timestamp;
- /**
- * (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
- */
- expiryTime?: timestamp;
- /**
- * (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
- */
- postTriggerCollectionDuration?: uint32;
- /**
- * (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
- */
- diagnosticsMode?: DiagnosticsMode;
- /**
- * (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
- */
- spoolingMode?: SpoolingMode;
- /**
- * (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
- */
- compression?: Compression;
- /**
- * (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
- */
- priority?: priority;
- /**
- * (Optional) A list of information about signals to collect.
- */
- signalsToCollect?: SignalInformationList;
- /**
- * The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.
- */
- collectionScheme: CollectionScheme;
- /**
- * (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
- */
- dataExtraDimensions?: DataExtraDimensionNodePathList;
- /**
- * Metadata that can be used to manage the campaign.
- */
- tags?: TagList;
- /**
- * The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- */
- dataDestinationConfigs?: DataDestinationConfigs;
- }
- export interface CreateCampaignResponse {
- /**
- * The name of the created campaign.
- */
- name?: campaignName;
- /**
- * The ARN of the created campaign.
- */
- arn?: arn;
- }
- export interface CreateDecoderManifestRequest {
- /**
- * The unique name of the decoder manifest to create.
- */
- name: resourceName;
- /**
- * A brief description of the decoder manifest.
- */
- description?: description;
- /**
- * The Amazon Resource Name (ARN) of the vehicle model (model manifest).
- */
- modelManifestArn: arn;
- /**
- * A list of information about signal decoders.
- */
- signalDecoders?: SignalDecoders;
- /**
- * A list of information about available network interfaces.
- */
- networkInterfaces?: NetworkInterfaces;
- /**
- * Metadata that can be used to manage the decoder manifest.
- */
- tags?: TagList;
- }
- export interface CreateDecoderManifestResponse {
- /**
- * The name of the created decoder manifest.
- */
- name: resourceName;
- /**
- * The ARN of the created decoder manifest.
- */
- arn: arn;
- }
- export interface CreateFleetRequest {
- /**
- * The unique ID of the fleet to create.
- */
- fleetId: fleetId;
- /**
- * A brief description of the fleet to create.
- */
- description?: description;
- /**
- * The Amazon Resource Name (ARN) of a signal catalog.
- */
- signalCatalogArn: arn;
- /**
- * Metadata that can be used to manage the fleet.
- */
- tags?: TagList;
- }
- export interface CreateFleetResponse {
- /**
- * The ID of the created fleet.
- */
- id: fleetId;
- /**
- * The ARN of the created fleet.
- */
- arn: arn;
- }
- export interface CreateModelManifestRequest {
- /**
- * The name of the vehicle model to create.
- */
- name: resourceName;
- /**
- * A brief description of the vehicle model.
- */
- description?: description;
- /**
- * A list of nodes, which are a general abstraction of signals.
- */
- nodes: listOfStrings;
- /**
- * The Amazon Resource Name (ARN) of a signal catalog.
- */
- signalCatalogArn: arn;
- /**
- * Metadata that can be used to manage the vehicle model.
- */
- tags?: TagList;
- }
- export interface CreateModelManifestResponse {
- /**
- * The name of the created vehicle model.
- */
- name: resourceName;
- /**
- * The ARN of the created vehicle model.
- */
- arn: arn;
- }
- export interface CreateSignalCatalogRequest {
- /**
- * The name of the signal catalog to create.
- */
- name: resourceName;
- /**
- * A brief description of the signal catalog.
- */
- description?: description;
- /**
- * A list of information about nodes, which are a general abstraction of signals. For more information, see the API data type.
- */
- nodes?: Nodes;
- /**
- * Metadata that can be used to manage the signal catalog.
- */
- tags?: TagList;
- }
- export interface CreateSignalCatalogResponse {
- /**
- * The name of the created signal catalog.
- */
- name: resourceName;
- /**
- * The ARN of the created signal catalog.
- */
- arn: arn;
- }
- export interface CreateVehicleError {
- /**
- * The ID of the vehicle with the error.
- */
- vehicleName?: vehicleName;
- /**
- * An HTTP error code.
- */
- code?: string;
- /**
- * A description of the HTTP error.
- */
- message?: string;
- }
- export interface CreateVehicleRequest {
- /**
- * The unique ID of the vehicle to create.
- */
- vehicleName: vehicleName;
- /**
- * The Amazon Resource Name ARN of a vehicle model.
- */
- modelManifestArn: arn;
- /**
- * The ARN of a decoder manifest.
- */
- decoderManifestArn: arn;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2" A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.
- */
- attributes?: attributesMap;
- /**
- * 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:
- */
- associationBehavior?: VehicleAssociationBehavior;
- /**
- * Metadata that can be used to manage the vehicle.
- */
- tags?: TagList;
- }
- export interface CreateVehicleRequestItem {
- /**
- * The unique ID of the vehicle to create.
- */
- vehicleName: vehicleName;
- /**
- * The ARN of the vehicle model (model manifest) to create the vehicle from.
- */
- modelManifestArn: arn;
- /**
- * The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
- */
- decoderManifestArn: arn;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engine Type" : "v6"
- */
- attributes?: attributesMap;
- /**
- * An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
- */
- associationBehavior?: VehicleAssociationBehavior;
- /**
- * Metadata which can be used to manage the vehicle.
- */
- tags?: TagList;
- }
- export interface CreateVehicleResponse {
- /**
- * The unique ID of the created vehicle.
- */
- vehicleName?: vehicleName;
- /**
- * The ARN of the created vehicle.
- */
- arn?: arn;
- /**
- * The ARN of a created or validated Amazon Web Services IoT thing.
- */
- thingArn?: arn;
- }
- export interface CreateVehicleResponseItem {
- /**
- * The unique ID of the vehicle to create.
- */
- vehicleName?: vehicleName;
- /**
- * The ARN of the created vehicle.
- */
- arn?: arn;
- /**
- * The ARN of a created or validated Amazon Web Services IoT thing.
- */
- thingArn?: arn;
- }
- export interface CustomProperty {
- /**
- * The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.
- */
- fullyQualifiedName: string;
- /**
- * The data type for the custom property.
- */
- dataType: NodeDataType;
- /**
- * Indicates whether the property is binary data.
- */
- dataEncoding?: NodeDataEncoding;
- /**
- * A brief description of the custom property.
- */
- description?: description;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- /**
- * The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.
- */
- structFullyQualifiedName?: NodePath;
- }
- export interface CustomStruct {
- /**
- * The fully qualified name of the custom structure. For example, the fully qualified name of a custom structure might be ComplexDataTypes.VehicleDataTypes.SVMCamera.
- */
- fullyQualifiedName: string;
- /**
- * A brief description of the custom structure.
- */
- description?: description;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- }
- export interface DataDestinationConfig {
- /**
- * The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.
- */
- s3Config?: S3Config;
- /**
- * The Amazon Timestream table where the campaign sends data.
- */
- timestreamConfig?: TimestreamConfig;
- }
- export type DataDestinationConfigs = DataDestinationConfig[];
- export type DataExtraDimensionNodePathList = NodePath[];
- export type DataFormat = "JSON"|"PARQUET"|string;
- export interface DecoderManifestSummary {
- /**
- * The name of the decoder manifest.
- */
- name?: string;
- /**
- * The ARN of a vehicle model (model manifest) associated with the decoder manifest.
- */
- arn?: arn;
- /**
- * The ARN of a vehicle model (model manifest) associated with the decoder manifest.
- */
- modelManifestArn?: arn;
- /**
- * A brief description of the decoder manifest.
- */
- description?: description;
- /**
- * 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.
- */
- status?: ManifestStatus;
- /**
- * The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- /**
- * The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
- */
- message?: message;
- }
- export interface DeleteCampaignRequest {
- /**
- * The name of the campaign to delete.
- */
- name: campaignName;
- }
- export interface DeleteCampaignResponse {
- /**
- * The name of the deleted campaign.
- */
- name?: campaignName;
- /**
- * The Amazon Resource Name (ARN) of the deleted campaign. The ARN isn’t returned if a campaign doesn’t exist.
- */
- arn?: arn;
- }
- export interface DeleteDecoderManifestRequest {
- /**
- * The name of the decoder manifest to delete.
- */
- name: resourceName;
- }
- export interface DeleteDecoderManifestResponse {
- /**
- * The name of the deleted decoder manifest.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the deleted decoder manifest.
- */
- arn: arn;
- }
- export interface DeleteFleetRequest {
- /**
- * The ID of the fleet to delete.
- */
- fleetId: fleetId;
- }
- export interface DeleteFleetResponse {
- /**
- * The ID of the deleted fleet.
- */
- id?: fleetId;
- /**
- * The Amazon Resource Name (ARN) of the deleted fleet.
- */
- arn?: arn;
- }
- export interface DeleteModelManifestRequest {
- /**
- * The name of the model manifest to delete.
- */
- name: resourceName;
- }
- export interface DeleteModelManifestResponse {
- /**
- * The name of the deleted model manifest.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the deleted model manifest.
- */
- arn: arn;
- }
- export interface DeleteSignalCatalogRequest {
- /**
- * The name of the signal catalog to delete.
- */
- name: resourceName;
- }
- export interface DeleteSignalCatalogResponse {
- /**
- * The name of the deleted signal catalog.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the deleted signal catalog.
- */
- arn: arn;
- }
- export interface DeleteVehicleRequest {
- /**
- * The ID of the vehicle to delete.
- */
- vehicleName: vehicleName;
- }
- export interface DeleteVehicleResponse {
- /**
- * The ID of the deleted vehicle.
- */
- vehicleName: vehicleName;
- /**
- * The Amazon Resource Name (ARN) of the deleted vehicle.
- */
- arn: arn;
- }
- export type DiagnosticsMode = "OFF"|"SEND_ACTIVE_DTCS"|string;
- export interface DisassociateVehicleFleetRequest {
- /**
- * The unique ID of the vehicle to disassociate from the fleet.
- */
- vehicleName: vehicleName;
- /**
- * The unique ID of a fleet.
- */
- fleetId: fleetId;
- }
- export interface DisassociateVehicleFleetResponse {
- }
- export type EncryptionStatus = "PENDING"|"SUCCESS"|"FAILURE"|string;
- export type EncryptionType = "KMS_BASED_ENCRYPTION"|"FLEETWISE_DEFAULT_ENCRYPTION"|string;
- export interface FleetSummary {
- /**
- * The unique ID of the fleet.
- */
- id: fleetId;
- /**
- * The Amazon Resource Name (ARN) of the fleet.
- */
- arn: arn;
- /**
- * A brief description of the fleet.
- */
- description?: description;
- /**
- * The ARN of the signal catalog associated with the fleet.
- */
- signalCatalogArn: arn;
- /**
- * The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the fleet was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime?: timestamp;
- }
- export interface FormattedVss {
- /**
- * Provides the VSS in JSON format.
- */
- vssJson?: String;
- }
- export type Fqns = FullyQualifiedName[];
- export type FullyQualifiedName = string;
- export interface GetCampaignRequest {
- /**
- * The name of the campaign to retrieve information about.
- */
- name: campaignName;
- }
- export interface GetCampaignResponse {
- /**
- * The name of the campaign.
- */
- name?: campaignName;
- /**
- * The Amazon Resource Name (ARN) of the campaign.
- */
- arn?: arn;
- /**
- * The description of the campaign.
- */
- description?: description;
- /**
- * The ARN of a signal catalog.
- */
- signalCatalogArn?: arn;
- /**
- * The ARN of the vehicle or the fleet targeted by the campaign.
- */
- targetArn?: arn;
- /**
- * The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
- */
- status?: CampaignStatus;
- /**
- * The time, in milliseconds, to deliver a campaign after it was approved.
- */
- startTime?: timestamp;
- /**
- * 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.
- */
- expiryTime?: timestamp;
- /**
- * How long (in seconds) to collect raw data after a triggering event initiates the collection.
- */
- postTriggerCollectionDuration?: uint32;
- /**
- * Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
- */
- diagnosticsMode?: DiagnosticsMode;
- /**
- * 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.
- */
- spoolingMode?: SpoolingMode;
- /**
- * 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.
- */
- compression?: Compression;
- /**
- * 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.
- */
- priority?: priority;
- /**
- * Information about a list of signals to collect data on.
- */
- signalsToCollect?: SignalInformationList;
- /**
- * Information about the data collection scheme associated with the campaign.
- */
- collectionScheme?: CollectionScheme;
- /**
- * A list of vehicle attributes associated with the campaign.
- */
- dataExtraDimensions?: DataExtraDimensionNodePathList;
- /**
- * The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime?: timestamp;
- /**
- * The last time the campaign was modified.
- */
- lastModificationTime?: timestamp;
- /**
- * The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream. Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- */
- dataDestinationConfigs?: DataDestinationConfigs;
- }
- export interface GetDecoderManifestRequest {
- /**
- * The name of the decoder manifest to retrieve information about.
- */
- name: resourceName;
- }
- export interface GetDecoderManifestResponse {
- /**
- * The name of the decoder manifest.
- */
- name: string;
- /**
- * The Amazon Resource Name (ARN) of the decoder manifest.
- */
- arn: arn;
- /**
- * A brief description of the decoder manifest.
- */
- description?: description;
- /**
- * The ARN of a vehicle model (model manifest) associated with the decoder manifest.
- */
- modelManifestArn?: arn;
- /**
- * 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.
- */
- status?: ManifestStatus;
- /**
- * The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- /**
- * The detailed message for the decoder manifest. When a decoder manifest is in an INVALID status, the message contains detailed reason and help information.
- */
- message?: message;
- }
- export interface GetEncryptionConfigurationRequest {
- }
- export interface GetEncryptionConfigurationResponse {
- /**
- * The ID of the KMS key that is used for encryption.
- */
- kmsKeyId?: String;
- /**
- * The encryption status.
- */
- encryptionStatus: EncryptionStatus;
- /**
- * The type of encryption. Set to KMS_BASED_ENCRYPTION to use a KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
- */
- encryptionType: EncryptionType;
- /**
- * The error message that describes why encryption settings couldn't be configured, if applicable.
- */
- errorMessage?: errorMessage;
- /**
- * The time when encryption was configured in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime?: timestamp;
- /**
- * The time when encryption was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime?: timestamp;
- }
- export interface GetFleetRequest {
- /**
- * The ID of the fleet to retrieve information about.
- */
- fleetId: fleetId;
- }
- export interface GetFleetResponse {
- /**
- * The ID of the fleet.
- */
- id: fleetId;
- /**
- * The Amazon Resource Name (ARN) of the fleet.
- */
- arn: arn;
- /**
- * A brief description of the fleet.
- */
- description?: description;
- /**
- * The ARN of a signal catalog associated with the fleet.
- */
- signalCatalogArn: arn;
- /**
- * The time the fleet was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the fleet was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- }
- export interface GetLoggingOptionsRequest {
- }
- export interface GetLoggingOptionsResponse {
- /**
- * Returns information about log delivery to Amazon CloudWatch Logs.
- */
- cloudWatchLogDelivery: CloudWatchLogDeliveryOptions;
- }
- export interface GetModelManifestRequest {
- /**
- * The name of the vehicle model to retrieve information about.
- */
- name: resourceName;
- }
- export interface GetModelManifestResponse {
- /**
- * The name of the vehicle model.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the vehicle model.
- */
- arn: arn;
- /**
- * A brief description of the vehicle model.
- */
- description?: description;
- /**
- * The ARN of the signal catalog associated with the vehicle model.
- */
- signalCatalogArn?: arn;
- /**
- * 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.
- */
- status?: ManifestStatus;
- /**
- * The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The last time the vehicle model was modified.
- */
- lastModificationTime: timestamp;
- }
- export interface GetRegisterAccountStatusRequest {
- }
- export interface GetRegisterAccountStatusResponse {
- /**
- * The unique ID of the Amazon Web Services account, provided at account creation.
- */
- customerAccountId: customerAccountId;
- /**
- * 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.
- */
- accountStatus: RegistrationStatus;
- /**
- * Information about the registered Amazon Timestream resources or errors, if any.
- */
- timestreamRegistrationResponse?: TimestreamRegistrationResponse;
- /**
- * Information about the registered IAM resources or errors, if any.
- */
- iamRegistrationResponse: IamRegistrationResponse;
- /**
- * The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- }
- export interface GetSignalCatalogRequest {
- /**
- * The name of the signal catalog to retrieve information about.
- */
- name: resourceName;
- }
- export interface GetSignalCatalogResponse {
- /**
- * The name of the signal catalog.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the signal catalog.
- */
- arn: arn;
- /**
- * A brief description of the signal catalog.
- */
- description?: description;
- /**
- * The total number of network nodes specified in a signal catalog.
- */
- nodeCounts?: NodeCounts;
- /**
- * The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The last time the signal catalog was modified.
- */
- lastModificationTime: timestamp;
- }
- export interface GetVehicleRequest {
- /**
- * The ID of the vehicle to retrieve information about.
- */
- vehicleName: vehicleName;
- }
- export interface GetVehicleResponse {
- /**
- * The ID of the vehicle.
- */
- vehicleName?: vehicleName;
- /**
- * The Amazon Resource Name (ARN) of the vehicle to retrieve information about.
- */
- arn?: arn;
- /**
- * The ARN of a vehicle model (model manifest) associated with the vehicle.
- */
- modelManifestArn?: arn;
- /**
- * The ARN of a decoder manifest associated with the vehicle.
- */
- decoderManifestArn?: arn;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
- */
- attributes?: attributesMap;
- /**
- * The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime?: timestamp;
- /**
- * The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime?: timestamp;
- }
- export interface GetVehicleStatusRequest {
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- /**
- * The ID of the vehicle to retrieve information about.
- */
- vehicleName: vehicleName;
- }
- export interface GetVehicleStatusResponse {
- /**
- * Lists information about the state of the vehicle with deployed campaigns.
- */
- campaigns?: VehicleStatusList;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export type IAMRoleArn = string;
- export interface IamRegistrationResponse {
- /**
- * The Amazon Resource Name (ARN) of the IAM role to register.
- */
- roleArn: arn;
- /**
- * The status of registering your IAM resource. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
- */
- registrationStatus: RegistrationStatus;
- /**
- * A message associated with a registration error.
- */
- errorMessage?: errorMessage;
- }
- export interface IamResources {
- /**
- * 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.
- */
- roleArn: IAMRoleArn;
- }
- export interface ImportDecoderManifestRequest {
- /**
- * The name of the decoder manifest to import.
- */
- name: resourceName;
- /**
- * The file to load into an Amazon Web Services account.
- */
- networkFileDefinitions: NetworkFileDefinitions;
- }
- export interface ImportDecoderManifestResponse {
- /**
- * The name of the imported decoder manifest.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the decoder manifest that was imported.
- */
- arn: arn;
- }
- export interface ImportSignalCatalogRequest {
- /**
- * The name of the signal catalog to import.
- */
- name: resourceName;
- /**
- * A brief description of the signal catalog.
- */
- description?: description;
- /**
- * The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise language used to describe and model signals in vehicle networks.
- */
- vss?: FormattedVss;
- /**
- * Metadata that can be used to manage the signal catalog.
- */
- tags?: TagList;
- }
- export interface ImportSignalCatalogResponse {
- /**
- * The name of the imported signal catalog.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the imported signal catalog.
- */
- arn: arn;
- }
- export type InterfaceId = string;
- export type InterfaceIds = InterfaceId[];
- export interface ListCampaignsRequest {
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- /**
- * 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.
- */
- status?: status;
- }
- export interface ListCampaignsResponse {
- /**
- * A summary of information about each campaign.
- */
- campaignSummaries?: campaignSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListDecoderManifestNetworkInterfacesRequest {
- /**
- * The name of the decoder manifest to list information about.
- */
- name: resourceName;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListDecoderManifestNetworkInterfacesResponse {
- /**
- * A list of information about network interfaces.
- */
- networkInterfaces?: NetworkInterfaces;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListDecoderManifestSignalsRequest {
- /**
- * The name of the decoder manifest to list information about.
- */
- name: resourceName;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListDecoderManifestSignalsResponse {
- /**
- * Information about a list of signals to decode.
- */
- signalDecoders?: SignalDecoders;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListDecoderManifestsRequest {
- /**
- * The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with the decoder manifest.
- */
- modelManifestArn?: arn;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListDecoderManifestsResponse {
- /**
- * A list of information about each decoder manifest.
- */
- summaries?: decoderManifestSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListFleetsForVehicleRequest {
- /**
- * The ID of the vehicle to retrieve information about.
- */
- vehicleName: vehicleName;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListFleetsForVehicleResponse {
- /**
- * A list of fleet IDs that the vehicle is associated with.
- */
- fleets?: fleets;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListFleetsRequest {
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListFleetsResponse {
- /**
- * A list of information for each fleet.
- */
- fleetSummaries?: fleetSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListModelManifestNodesRequest {
- /**
- * The name of the vehicle model to list information about.
- */
- name: resourceName;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListModelManifestNodesResponse {
- /**
- * A list of information about nodes.
- */
- nodes?: Nodes;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListModelManifestsRequest {
- /**
- * The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models associated with it are returned.
- */
- signalCatalogArn?: arn;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListModelManifestsResponse {
- /**
- * A list of information about vehicle models.
- */
- summaries?: modelManifestSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListSignalCatalogNodesRequest {
- /**
- * The name of the signal catalog to list information about.
- */
- name: resourceName;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- /**
- * The type of node in the signal catalog.
- */
- signalNodeType?: SignalNodeType;
- }
- export interface ListSignalCatalogNodesResponse {
- /**
- * A list of information about nodes.
- */
- nodes?: Nodes;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListSignalCatalogsRequest {
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListSignalCatalogsResponse {
- /**
- * A list of information about each signal catalog.
- */
- summaries?: signalCatalogSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceARN: AmazonResourceName;
- }
- export interface ListTagsForResourceResponse {
- /**
- * The list of tags assigned to the resource.
- */
- Tags?: TagList;
- }
- export interface ListVehiclesInFleetRequest {
- /**
- * The ID of a fleet.
- */
- fleetId: fleetId;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: maxResults;
- }
- export interface ListVehiclesInFleetResponse {
- /**
- * A list of vehicles associated with the fleet.
- */
- vehicles?: vehicles;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export interface ListVehiclesRequest {
- /**
- * 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.
- */
- modelManifestArn?: arn;
- /**
- * 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.
- */
- nextToken?: nextToken;
- /**
- * The maximum number of items to return, between 1 and 100, inclusive.
- */
- maxResults?: listVehiclesMaxResults;
- }
- export interface ListVehiclesResponse {
- /**
- * A list of vehicles and information about them.
- */
- vehicleSummaries?: vehicleSummaries;
- /**
- * The token to retrieve the next set of results, or null if there are no more results.
- */
- nextToken?: nextToken;
- }
- export type LogType = "OFF"|"ERROR"|string;
- export type ManifestStatus = "ACTIVE"|"DRAFT"|"INVALID"|"VALIDATING"|string;
- export interface MessageSignal {
- /**
- * The topic name for the message signal. It corresponds to topics in ROS 2.
- */
- topicName: TopicName;
- /**
- * The structured message for the message signal. It can be defined with either a primitiveMessageDefinition, structuredMessageListDefinition, or structuredMessageDefinition recursively.
- */
- structuredMessage: StructuredMessage;
- }
- export interface ModelManifestSummary {
- /**
- * The name of the vehicle model.
- */
- name?: string;
- /**
- * The Amazon Resource Name (ARN) of the vehicle model.
- */
- arn?: arn;
- /**
- * The ARN of the signal catalog associated with the vehicle model.
- */
- signalCatalogArn?: arn;
- /**
- * A brief description of the vehicle model.
- */
- description?: description;
- /**
- * 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.
- */
- status?: ManifestStatus;
- /**
- * The time the vehicle model was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the vehicle model was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- }
- export type ModelSignalsMap = {[key: string]: string};
- export type NetworkFileBlob = Buffer|Uint8Array|Blob|string;
- export interface NetworkFileDefinition {
- /**
- * Information, including CAN DBC files, about the configurations used to create a decoder manifest.
- */
- canDbc?: CanDbcDefinition;
- }
- export type NetworkFileDefinitions = NetworkFileDefinition[];
- export type NetworkFilesList = NetworkFileBlob[];
- export interface NetworkInterface {
- /**
- * The ID of the network interface.
- */
- interfaceId: InterfaceId;
- /**
- * 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.
- */
- type: NetworkInterfaceType;
- /**
- * Information about a network interface specified by the Controller Area Network (CAN) protocol.
- */
- canInterface?: CanInterface;
- /**
- * Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
- */
- obdInterface?: ObdInterface;
- /**
- * The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.
- */
- vehicleMiddleware?: VehicleMiddleware;
- }
- export type NetworkInterfaceType = "CAN_INTERFACE"|"OBD_INTERFACE"|"VEHICLE_MIDDLEWARE"|string;
- export type NetworkInterfaces = NetworkInterface[];
- export interface Node {
- /**
- * Information about a node specified as a branch. A group of signals that are defined in a hierarchical structure.
- */
- branch?: Branch;
- sensor?: Sensor;
- /**
- * Information about a node specified as an actuator. An actuator is a digital representation of a vehicle device.
- */
- actuator?: Actuator;
- /**
- * Information about a node specified as an attribute. An attribute represents static information about a vehicle.
- */
- attribute?: Attribute;
- /**
- * Represents a complex or higher-order data structure.
- */
- struct?: CustomStruct;
- /**
- * Represents a member of the complex data structure. The datatype of the property can be either primitive or another struct.
- */
- property?: CustomProperty;
- }
- export interface NodeCounts {
- /**
- * The total number of nodes in a vehicle network.
- */
- totalNodes?: number;
- /**
- * The total number of nodes in a vehicle network that represent branches.
- */
- totalBranches?: number;
- /**
- * The total number of nodes in a vehicle network that represent sensors.
- */
- totalSensors?: number;
- /**
- * The total number of nodes in a vehicle network that represent attributes.
- */
- totalAttributes?: number;
- /**
- * The total number of nodes in a vehicle network that represent actuators.
- */
- totalActuators?: number;
- /**
- * The total structure for the node.
- */
- totalStructs?: number;
- /**
- * The total properties for the node.
- */
- totalProperties?: number;
- }
- export type NodeDataEncoding = "BINARY"|"TYPED"|string;
- export type NodeDataType = "INT8"|"UINT8"|"INT16"|"UINT16"|"INT32"|"UINT32"|"INT64"|"UINT64"|"BOOLEAN"|"FLOAT"|"DOUBLE"|"STRING"|"UNIX_TIMESTAMP"|"INT8_ARRAY"|"UINT8_ARRAY"|"INT16_ARRAY"|"UINT16_ARRAY"|"INT32_ARRAY"|"UINT32_ARRAY"|"INT64_ARRAY"|"UINT64_ARRAY"|"BOOLEAN_ARRAY"|"FLOAT_ARRAY"|"DOUBLE_ARRAY"|"STRING_ARRAY"|"UNIX_TIMESTAMP_ARRAY"|"UNKNOWN"|"STRUCT"|"STRUCT_ARRAY"|string;
- export type NodePath = string;
- export type NodePaths = NodePath[];
- export type Nodes = Node[];
- export type ObdBitmaskLength = number;
- export type ObdByteLength = number;
- export interface ObdInterface {
- /**
- * The name of the interface.
- */
- name: ObdInterfaceName;
- /**
- * The ID of the message requesting vehicle data.
- */
- requestMessageId: nonNegativeInteger;
- /**
- * The standard OBD II PID.
- */
- obdStandard?: ObdStandard;
- /**
- * The maximum number message requests per second.
- */
- pidRequestIntervalSeconds?: nonNegativeInteger;
- /**
- * The maximum number message requests per diagnostic trouble code per second.
- */
- dtcRequestIntervalSeconds?: nonNegativeInteger;
- /**
- * Whether to use extended IDs in the message.
- */
- useExtendedIds?: PrimitiveBoolean;
- /**
- * Whether the vehicle has a transmission control module (TCM).
- */
- hasTransmissionEcu?: PrimitiveBoolean;
- }
- export type ObdInterfaceName = string;
- export interface ObdSignal {
- /**
- * The length of the requested data.
- */
- pidResponseLength: positiveInteger;
- /**
- * The mode of operation (diagnostic service) in a message.
- */
- serviceMode: nonNegativeInteger;
- /**
- * The diagnostic code used to request data from a vehicle for this signal.
- */
- pid: nonNegativeInteger;
- /**
- * A multiplier used to decode the message.
- */
- scaling: double;
- /**
- * The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
- */
- offset: double;
- /**
- * Indicates the beginning of the message.
- */
- startByte: nonNegativeInteger;
- /**
- * The length of a message.
- */
- byteLength: ObdByteLength;
- /**
- * The number of positions to shift bits in the message.
- */
- bitRightShift?: nonNegativeInteger;
- /**
- * The number of bits to mask in a message.
- */
- bitMaskLength?: ObdBitmaskLength;
- }
- export type ObdStandard = string;
- export type Prefix = string;
- export type PrimitiveBoolean = boolean;
- export interface PrimitiveMessageDefinition {
- /**
- * Information about a PrimitiveMessage using a ROS 2 compliant primitive type message of the complex data structure.
- */
- ros2PrimitiveMessageDefinition?: ROS2PrimitiveMessageDefinition;
- }
- export type ProtocolName = string;
- export type ProtocolVersion = string;
- export interface PutEncryptionConfigurationRequest {
- /**
- * The ID of the KMS key that is used for encryption.
- */
- kmsKeyId?: PutEncryptionConfigurationRequestKmsKeyIdString;
- /**
- * The type of encryption. Choose KMS_BASED_ENCRYPTION to use a KMS key or FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key.
- */
- encryptionType: EncryptionType;
- }
- export type PutEncryptionConfigurationRequestKmsKeyIdString = string;
- export interface PutEncryptionConfigurationResponse {
- /**
- * The ID of the KMS key that is used for encryption.
- */
- kmsKeyId?: String;
- /**
- * The encryption status.
- */
- encryptionStatus: EncryptionStatus;
- /**
- * The type of encryption. Set to KMS_BASED_ENCRYPTION to use an KMS key that you own and manage. Set to FLEETWISE_DEFAULT_ENCRYPTION to use an Amazon Web Services managed key that is owned by the Amazon Web Services IoT FleetWise service account.
- */
- encryptionType: EncryptionType;
- }
- export interface PutLoggingOptionsRequest {
- /**
- * Creates or updates the log delivery option to Amazon CloudWatch Logs.
- */
- cloudWatchLogDelivery: CloudWatchLogDeliveryOptions;
- }
- export interface PutLoggingOptionsResponse {
- }
- export interface ROS2PrimitiveMessageDefinition {
- /**
- * The primitive type (integer, floating point, boolean, etc.) for the ROS 2 primitive message definition.
- */
- primitiveType: ROS2PrimitiveType;
- /**
- * The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.
- */
- offset?: double;
- /**
- * A multiplier used to decode the message.
- */
- scaling?: double;
- /**
- * An optional attribute specifying the upper bound for STRING and WSTRING.
- */
- upperBound?: ROS2PrimitiveMessageDefinitionUpperBoundLong;
- }
- export type ROS2PrimitiveMessageDefinitionUpperBoundLong = number;
- export type ROS2PrimitiveType = "BOOL"|"BYTE"|"CHAR"|"FLOAT32"|"FLOAT64"|"INT8"|"UINT8"|"INT16"|"UINT16"|"INT32"|"UINT32"|"INT64"|"UINT64"|"STRING"|"WSTRING"|string;
- export interface RegisterAccountRequest {
- timestreamResources?: TimestreamResources;
- /**
- * The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
- */
- iamResources?: IamResources;
- }
- export interface RegisterAccountResponse {
- /**
- * The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
- */
- registerAccountStatus: RegistrationStatus;
- timestreamResources?: TimestreamResources;
- /**
- * The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.
- */
- iamResources: IamResources;
- /**
- * The time the account was registered, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time this registration was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- }
- export type RegistrationStatus = "REGISTRATION_PENDING"|"REGISTRATION_SUCCESS"|"REGISTRATION_FAILURE"|string;
- export type S3BucketArn = string;
- export interface S3Config {
- /**
- * The Amazon Resource Name (ARN) of the Amazon S3 bucket.
- */
- bucketArn: S3BucketArn;
- /**
- * Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format. Parquet - Store data in a columnar storage file format. Parquet is optimal for fast data retrieval and can reduce costs. This option is selected by default. JSON - Store data in a standard text-based JSON file format.
- */
- dataFormat?: DataFormat;
- /**
- * By default, stored data is compressed as a .gzip file. Compressed files have a reduced file size, which can optimize the cost of data storage.
- */
- storageCompressionFormat?: StorageCompressionFormat;
- /**
- * (Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide. By default, Amazon Web Services IoT FleetWise sets the prefix processed-data/year=YY/month=MM/date=DD/hour=HH/ (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix vehicles, the prefix will be vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/.
- */
- prefix?: Prefix;
- }
- export interface Sensor {
- /**
- * The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be Vehicle.Body.Engine.Battery.
- */
- fullyQualifiedName: string;
- /**
- * The specified data type of the sensor.
- */
- dataType: NodeDataType;
- /**
- * A brief description of a sensor.
- */
- description?: description;
- /**
- * The scientific unit of measurement for data collected by the sensor.
- */
- unit?: string;
- /**
- * A list of possible values a sensor can take.
- */
- allowedValues?: listOfStrings;
- /**
- * The specified possible minimum value of the sensor.
- */
- min?: double;
- /**
- * The specified possible maximum value of the sensor.
- */
- max?: double;
- /**
- * The deprecation message for the node or the branch that was moved or deleted.
- */
- deprecationMessage?: message;
- /**
- * A comment in addition to the description.
- */
- comment?: message;
- /**
- * The fully qualified name of the struct node for a sensor if the data type of the actuator is Struct or StructArray. For example, the struct fully qualified name of a sensor might be Vehicle.ADAS.CameraStruct.
- */
- structFullyQualifiedName?: NodePath;
- }
- export interface SignalCatalogSummary {
- /**
- * The name of the signal catalog.
- */
- name?: string;
- /**
- * The Amazon Resource Name (ARN) of the signal catalog.
- */
- arn?: arn;
- /**
- * The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime?: timestamp;
- /**
- * The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime?: timestamp;
- }
- export interface SignalDecoder {
- /**
- * The fully qualified name of a signal decoder as defined in a vehicle model.
- */
- fullyQualifiedName: FullyQualifiedName;
- /**
- * 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.
- */
- type: SignalDecoderType;
- /**
- * The ID of a network interface that specifies what network protocol a vehicle follows.
- */
- interfaceId: InterfaceId;
- /**
- * Information about signal decoder using the Controller Area Network (CAN) protocol.
- */
- canSignal?: CanSignal;
- /**
- * Information about signal decoder using the On-board diagnostic (OBD) II protocol.
- */
- obdSignal?: ObdSignal;
- /**
- * The decoding information for a specific message which supports higher order data types.
- */
- messageSignal?: MessageSignal;
- }
- export type SignalDecoderType = "CAN_SIGNAL"|"OBD_SIGNAL"|"MESSAGE_SIGNAL"|string;
- export type SignalDecoders = SignalDecoder[];
- export interface SignalInformation {
- /**
- * The name of the signal.
- */
- name: wildcardSignalName;
- /**
- * The maximum number of samples to collect.
- */
- maxSampleCount?: maxSampleCount;
- /**
- * 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.
- */
- minimumSamplingIntervalMs?: uint32;
- }
- export type SignalInformationList = SignalInformation[];
- export type SignalNodeType = "SENSOR"|"ACTUATOR"|"ATTRIBUTE"|"BRANCH"|"CUSTOM_STRUCT"|"CUSTOM_PROPERTY"|string;
- export type SpoolingMode = "OFF"|"TO_DISK"|string;
- export type StorageCompressionFormat = "NONE"|"GZIP"|string;
- export type String = string;
- export type StructureMessageName = string;
- export interface StructuredMessage {
- /**
- * Represents a primitive type node of the complex data structure.
- */
- primitiveMessageDefinition?: PrimitiveMessageDefinition;
- /**
- * Represents a list type node of the complex data structure.
- */
- structuredMessageListDefinition?: StructuredMessageListDefinition;
- /**
- * Represents a struct type node of the complex data structure.
- */
- structuredMessageDefinition?: StructuredMessageDefinition;
- }
- export type StructuredMessageDefinition = StructuredMessageFieldNameAndDataTypePair[];
- export interface StructuredMessageFieldNameAndDataTypePair {
- /**
- * The field name of the structured message. It determines how a data value is referenced in the target language.
- */
- fieldName: StructureMessageName;
- /**
- * The data type.
- */
- dataType: StructuredMessage;
- }
- export interface StructuredMessageListDefinition {
- /**
- * The name of the structured message list definition.
- */
- name: StructureMessageName;
- /**
- * The member type of the structured message list definition.
- */
- memberType: StructuredMessage;
- /**
- * The type of list of the structured message list definition.
- */
- listType: StructuredMessageListType;
- /**
- * The capacity of the structured message list definition when the list type is FIXED_CAPACITY or DYNAMIC_BOUNDED_CAPACITY.
- */
- capacity?: nonNegativeInteger;
- }
- export type StructuredMessageListType = "FIXED_CAPACITY"|"DYNAMIC_UNBOUNDED_CAPACITY"|"DYNAMIC_BOUNDED_CAPACITY"|string;
- export interface Tag {
- /**
- * The tag's key.
- */
- Key: TagKey;
- /**
- * The tag's value.
- */
- Value: TagValue;
- }
- export type TagKey = string;
- export type TagKeyList = TagKey[];
- export type TagList = Tag[];
- export interface TagResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceARN: AmazonResourceName;
- /**
- * The new or modified tags for the resource.
- */
- Tags: TagList;
- }
- export interface TagResourceResponse {
- }
- export type TagValue = string;
- export interface TimeBasedCollectionScheme {
- /**
- * 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.
- */
- periodMs: collectionPeriodMs;
- }
- export interface TimestreamConfig {
- /**
- * The Amazon Resource Name (ARN) of the Amazon Timestream table.
- */
- timestreamTableArn: TimestreamTableArn;
- /**
- * The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.
- */
- executionRoleArn: IAMRoleArn;
- }
- export type TimestreamDatabaseName = string;
- export interface TimestreamRegistrationResponse {
- /**
- * The name of the Timestream database.
- */
- timestreamDatabaseName: TimestreamDatabaseName;
- /**
- * The name of the Timestream database table.
- */
- timestreamTableName: TimestreamTableName;
- /**
- * The Amazon Resource Name (ARN) of the Timestream database.
- */
- timestreamDatabaseArn?: arn;
- /**
- * The ARN of the Timestream database table.
- */
- timestreamTableArn?: arn;
- /**
- * The status of registering your Amazon Timestream resources. The status can be one of REGISTRATION_SUCCESS, REGISTRATION_PENDING, REGISTRATION_FAILURE.
- */
- registrationStatus: RegistrationStatus;
- /**
- * A message associated with a registration error.
- */
- errorMessage?: errorMessage;
- }
- export interface TimestreamResources {
- /**
- * The name of the registered Amazon Timestream database.
- */
- timestreamDatabaseName: TimestreamDatabaseName;
- /**
- * The name of the registered Amazon Timestream database table.
- */
- timestreamTableName: TimestreamTableName;
- }
- export type TimestreamTableArn = string;
- export type TimestreamTableName = string;
- export type TopicName = string;
- export type TriggerMode = "ALWAYS"|"RISING_EDGE"|string;
- export interface UntagResourceRequest {
- /**
- * The ARN of the resource.
- */
- ResourceARN: AmazonResourceName;
- /**
- * A list of the keys of the tags to be removed from the resource.
- */
- TagKeys: TagKeyList;
- }
- export interface UntagResourceResponse {
- }
- export type UpdateCampaignAction = "APPROVE"|"SUSPEND"|"RESUME"|"UPDATE"|string;
- export interface UpdateCampaignRequest {
- /**
- * The name of the campaign to update.
- */
- name: campaignName;
- /**
- * The description of the campaign.
- */
- description?: description;
- /**
- * A list of vehicle attributes to associate with a signal. Default: An empty array
- */
- dataExtraDimensions?: DataExtraDimensionNodePathList;
- /**
- * 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. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data. RESUME - To reactivate the SUSPEND campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. UPDATE - To update a campaign.
- */
- action: UpdateCampaignAction;
- }
- export interface UpdateCampaignResponse {
- /**
- * The Amazon Resource Name (ARN) of the campaign.
- */
- arn?: arn;
- /**
- * The name of the updated campaign.
- */
- name?: campaignName;
- /**
- * 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 the WAITING_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.
- */
- status?: CampaignStatus;
- }
- export interface UpdateDecoderManifestRequest {
- /**
- * The name of the decoder manifest to update.
- */
- name: resourceName;
- /**
- * A brief description of the decoder manifest to update.
- */
- description?: description;
- /**
- * A list of information about decoding additional signals to add to the decoder manifest.
- */
- signalDecodersToAdd?: SignalDecoders;
- /**
- * A list of updated information about decoding signals to update in the decoder manifest.
- */
- signalDecodersToUpdate?: SignalDecoders;
- /**
- * A list of signal decoders to remove from the decoder manifest.
- */
- signalDecodersToRemove?: Fqns;
- /**
- * A list of information about the network interfaces to add to the decoder manifest.
- */
- networkInterfacesToAdd?: NetworkInterfaces;
- /**
- * A list of information about the network interfaces to update in the decoder manifest.
- */
- networkInterfacesToUpdate?: NetworkInterfaces;
- /**
- * A list of network interfaces to remove from the decoder manifest.
- */
- networkInterfacesToRemove?: InterfaceIds;
- /**
- * 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.
- */
- status?: ManifestStatus;
- }
- export interface UpdateDecoderManifestResponse {
- /**
- * The name of the updated decoder manifest.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the updated decoder manifest.
- */
- arn: arn;
- }
- export interface UpdateFleetRequest {
- /**
- * The ID of the fleet to update.
- */
- fleetId: fleetId;
- /**
- * An updated description of the fleet.
- */
- description?: description;
- }
- export interface UpdateFleetResponse {
- /**
- * The ID of the updated fleet.
- */
- id?: fleetId;
- /**
- * The Amazon Resource Name (ARN) of the updated fleet.
- */
- arn?: arn;
- }
- export type UpdateMode = "Overwrite"|"Merge"|string;
- export interface UpdateModelManifestRequest {
- /**
- * The name of the vehicle model to update.
- */
- name: resourceName;
- /**
- * A brief description of the vehicle model.
- */
- description?: description;
- /**
- * A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to add to the vehicle model.
- */
- nodesToAdd?: NodePaths;
- /**
- * A list of fullyQualifiedName of nodes, which are a general abstraction of signals, to remove from the vehicle model.
- */
- nodesToRemove?: NodePaths;
- /**
- * 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.
- */
- status?: ManifestStatus;
- }
- export interface UpdateModelManifestResponse {
- /**
- * The name of the updated vehicle model.
- */
- name: resourceName;
- /**
- * The Amazon Resource Name (ARN) of the updated vehicle model.
- */
- arn: arn;
- }
- export interface UpdateSignalCatalogRequest {
- /**
- * The name of the signal catalog to update.
- */
- name: resourceName;
- /**
- * A brief description of the signal catalog to update.
- */
- description?: description;
- /**
- * A list of information about nodes to add to the signal catalog.
- */
- nodesToAdd?: Nodes;
- /**
- * A list of information about nodes to update in the signal catalog.
- */
- nodesToUpdate?: Nodes;
- /**
- * A list of fullyQualifiedName of nodes to remove from the signal catalog.
- */
- nodesToRemove?: NodePaths;
- }
- export interface UpdateSignalCatalogResponse {
- /**
- * The name of the updated signal catalog.
- */
- name: resourceName;
- /**
- * The ARN of the updated signal catalog.
- */
- arn: arn;
- }
- export interface UpdateVehicleError {
- /**
- * The ID of the vehicle with the error.
- */
- vehicleName?: vehicleName;
- /**
- * The relevant HTTP error code (400+).
- */
- code?: number;
- /**
- * A message associated with the error.
- */
- message?: string;
- }
- export interface UpdateVehicleRequest {
- /**
- * The unique ID of the vehicle to update.
- */
- vehicleName: vehicleName;
- /**
- * The ARN of a vehicle model (model manifest) associated with the vehicle.
- */
- modelManifestArn?: arn;
- /**
- * The ARN of the decoder manifest associated with this vehicle.
- */
- decoderManifestArn?: arn;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
- */
- attributes?: attributesMap;
- /**
- * 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.
- */
- attributeUpdateMode?: UpdateMode;
- }
- export interface UpdateVehicleRequestItem {
- /**
- * The unique ID of the vehicle to update.
- */
- vehicleName: vehicleName;
- /**
- * The ARN of the vehicle model (model manifest) associated with the vehicle to update.
- */
- modelManifestArn?: arn;
- /**
- * The ARN of the signal decoder manifest associated with the vehicle to update.
- */
- decoderManifestArn?: arn;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
- */
- attributes?: attributesMap;
- /**
- * 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.
- */
- attributeUpdateMode?: UpdateMode;
- }
- export interface UpdateVehicleResponse {
- /**
- * The ID of the updated vehicle.
- */
- vehicleName?: vehicleName;
- /**
- * The ARN of the updated vehicle.
- */
- arn?: arn;
- }
- export interface UpdateVehicleResponseItem {
- /**
- * The unique ID of the updated vehicle.
- */
- vehicleName?: vehicleName;
- /**
- * The Amazon Resource Name (ARN) of the updated vehicle.
- */
- arn?: arn;
- }
- export type VehicleAssociationBehavior = "CreateIotThing"|"ValidateIotThingExists"|string;
- export interface VehicleMiddleware {
- /**
- * The name of the vehicle middleware.
- */
- name: VehicleMiddlewareName;
- /**
- * The protocol name of the vehicle middleware.
- */
- protocolName: VehicleMiddlewareProtocol;
- }
- export type VehicleMiddlewareName = string;
- export type VehicleMiddlewareProtocol = "ROS_2"|string;
- export type VehicleState = "CREATED"|"READY"|"HEALTHY"|"SUSPENDED"|"DELETING"|string;
- export interface VehicleStatus {
- /**
- * The name of a campaign.
- */
- campaignName?: string;
- /**
- * The unique ID of the vehicle.
- */
- vehicleName?: vehicleName;
- /**
- * 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.
- */
- status?: VehicleState;
- }
- export type VehicleStatusList = VehicleStatus[];
- export interface VehicleSummary {
- /**
- * The unique ID of the vehicle.
- */
- vehicleName: vehicleName;
- /**
- * The Amazon Resource Name (ARN) of the vehicle.
- */
- arn: arn;
- /**
- * The ARN of a vehicle model (model manifest) associated with the vehicle.
- */
- modelManifestArn: arn;
- /**
- * The ARN of a decoder manifest associated with the vehicle.
- */
- decoderManifestArn: arn;
- /**
- * The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- creationTime: timestamp;
- /**
- * The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
- */
- lastModificationTime: timestamp;
- /**
- * Static information about a vehicle in a key-value pair. For example: "engineType" : "1.3 L R2"
- */
- attributes?: attributesMap;
- }
- export type arn = string;
- export type attributeName = string;
- export type attributeValue = string;
- export type attributesMap = {[key: string]: attributeValue};
- export type campaignName = string;
- export type campaignSummaries = CampaignSummary[];
- export type collectionPeriodMs = number;
- export type createVehicleErrors = CreateVehicleError[];
- export type createVehicleRequestItems = CreateVehicleRequestItem[];
- export type createVehicleResponses = CreateVehicleResponseItem[];
- export type customerAccountId = string;
- export type decoderManifestSummaries = DecoderManifestSummary[];
- export type description = string;
- export type double = number;
- export type errorMessage = string;
- export type eventExpression = string;
- export type fleetId = string;
- export type fleetSummaries = FleetSummary[];
- export type fleets = fleetId[];
- export type languageVersion = number;
- export type listOfStrings = string[];
- export type listVehiclesMaxResults = number;
- export type maxResults = number;
- export type maxSampleCount = number;
- export type message = string;
- export type modelManifestSummaries = ModelManifestSummary[];
- export type nextToken = string;
- export type nonNegativeInteger = number;
- export type positiveInteger = number;
- export type priority = number;
- export type resourceName = string;
- export type signalCatalogSummaries = SignalCatalogSummary[];
- export type status = string;
- export type timestamp = Date;
- export type uint32 = number;
- export type updateVehicleErrors = UpdateVehicleError[];
- export type updateVehicleRequestItems = UpdateVehicleRequestItem[];
- export type updateVehicleResponseItems = UpdateVehicleResponseItem[];
- export type vehicleName = string;
- export type vehicleSummaries = VehicleSummary[];
- export type vehicles = vehicleName[];
- export type wildcardSignalName = string;
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2021-06-17"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the IoTFleetWise client.
- */
- export import Types = IoTFleetWise;
- }
- export = IoTFleetWise;
|