12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981 |
- 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 IoTTwinMaker extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: IoTTwinMaker.Types.ClientConfiguration)
- config: Config & IoTTwinMaker.Types.ClientConfiguration;
- /**
- * Sets values for multiple time series properties.
- */
- batchPutPropertyValues(params: IoTTwinMaker.Types.BatchPutPropertyValuesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.BatchPutPropertyValuesResponse) => void): Request<IoTTwinMaker.Types.BatchPutPropertyValuesResponse, AWSError>;
- /**
- * Sets values for multiple time series properties.
- */
- batchPutPropertyValues(callback?: (err: AWSError, data: IoTTwinMaker.Types.BatchPutPropertyValuesResponse) => void): Request<IoTTwinMaker.Types.BatchPutPropertyValuesResponse, AWSError>;
- /**
- * Cancels the metadata transfer job.
- */
- cancelMetadataTransferJob(params: IoTTwinMaker.Types.CancelMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CancelMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CancelMetadataTransferJobResponse, AWSError>;
- /**
- * Cancels the metadata transfer job.
- */
- cancelMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CancelMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CancelMetadataTransferJobResponse, AWSError>;
- /**
- * Creates a component type.
- */
- createComponentType(params: IoTTwinMaker.Types.CreateComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.CreateComponentTypeResponse, AWSError>;
- /**
- * Creates a component type.
- */
- createComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.CreateComponentTypeResponse, AWSError>;
- /**
- * Creates an entity.
- */
- createEntity(params: IoTTwinMaker.Types.CreateEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateEntityResponse) => void): Request<IoTTwinMaker.Types.CreateEntityResponse, AWSError>;
- /**
- * Creates an entity.
- */
- createEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateEntityResponse) => void): Request<IoTTwinMaker.Types.CreateEntityResponse, AWSError>;
- /**
- * Creates a new metadata transfer job.
- */
- createMetadataTransferJob(params: IoTTwinMaker.Types.CreateMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CreateMetadataTransferJobResponse, AWSError>;
- /**
- * Creates a new metadata transfer job.
- */
- createMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.CreateMetadataTransferJobResponse, AWSError>;
- /**
- * Creates a scene.
- */
- createScene(params: IoTTwinMaker.Types.CreateSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSceneResponse) => void): Request<IoTTwinMaker.Types.CreateSceneResponse, AWSError>;
- /**
- * Creates a scene.
- */
- createScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSceneResponse) => void): Request<IoTTwinMaker.Types.CreateSceneResponse, AWSError>;
- /**
- * This action creates a SyncJob.
- */
- createSyncJob(params: IoTTwinMaker.Types.CreateSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSyncJobResponse) => void): Request<IoTTwinMaker.Types.CreateSyncJobResponse, AWSError>;
- /**
- * This action creates a SyncJob.
- */
- createSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateSyncJobResponse) => void): Request<IoTTwinMaker.Types.CreateSyncJobResponse, AWSError>;
- /**
- * Creates a workplace.
- */
- createWorkspace(params: IoTTwinMaker.Types.CreateWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.CreateWorkspaceResponse, AWSError>;
- /**
- * Creates a workplace.
- */
- createWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.CreateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.CreateWorkspaceResponse, AWSError>;
- /**
- * Deletes a component type.
- */
- deleteComponentType(params: IoTTwinMaker.Types.DeleteComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteComponentTypeResponse) => void): Request<IoTTwinMaker.Types.DeleteComponentTypeResponse, AWSError>;
- /**
- * Deletes a component type.
- */
- deleteComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteComponentTypeResponse) => void): Request<IoTTwinMaker.Types.DeleteComponentTypeResponse, AWSError>;
- /**
- * Deletes an entity.
- */
- deleteEntity(params: IoTTwinMaker.Types.DeleteEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteEntityResponse) => void): Request<IoTTwinMaker.Types.DeleteEntityResponse, AWSError>;
- /**
- * Deletes an entity.
- */
- deleteEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteEntityResponse) => void): Request<IoTTwinMaker.Types.DeleteEntityResponse, AWSError>;
- /**
- * Deletes a scene.
- */
- deleteScene(params: IoTTwinMaker.Types.DeleteSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSceneResponse) => void): Request<IoTTwinMaker.Types.DeleteSceneResponse, AWSError>;
- /**
- * Deletes a scene.
- */
- deleteScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSceneResponse) => void): Request<IoTTwinMaker.Types.DeleteSceneResponse, AWSError>;
- /**
- * Delete the SyncJob.
- */
- deleteSyncJob(params: IoTTwinMaker.Types.DeleteSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSyncJobResponse) => void): Request<IoTTwinMaker.Types.DeleteSyncJobResponse, AWSError>;
- /**
- * Delete the SyncJob.
- */
- deleteSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteSyncJobResponse) => void): Request<IoTTwinMaker.Types.DeleteSyncJobResponse, AWSError>;
- /**
- * Deletes a workspace.
- */
- deleteWorkspace(params: IoTTwinMaker.Types.DeleteWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteWorkspaceResponse) => void): Request<IoTTwinMaker.Types.DeleteWorkspaceResponse, AWSError>;
- /**
- * Deletes a workspace.
- */
- deleteWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.DeleteWorkspaceResponse) => void): Request<IoTTwinMaker.Types.DeleteWorkspaceResponse, AWSError>;
- /**
- * Run queries to access information from your knowledge graph of entities within individual workspaces. The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.
- */
- executeQuery(params: IoTTwinMaker.Types.ExecuteQueryRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ExecuteQueryResponse) => void): Request<IoTTwinMaker.Types.ExecuteQueryResponse, AWSError>;
- /**
- * Run queries to access information from your knowledge graph of entities within individual workspaces. The ExecuteQuery action only works with Amazon Web Services Java SDK2. ExecuteQuery will not work with any Amazon Web Services Java SDK version < 2.x.
- */
- executeQuery(callback?: (err: AWSError, data: IoTTwinMaker.Types.ExecuteQueryResponse) => void): Request<IoTTwinMaker.Types.ExecuteQueryResponse, AWSError>;
- /**
- * Retrieves information about a component type.
- */
- getComponentType(params: IoTTwinMaker.Types.GetComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetComponentTypeResponse) => void): Request<IoTTwinMaker.Types.GetComponentTypeResponse, AWSError>;
- /**
- * Retrieves information about a component type.
- */
- getComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetComponentTypeResponse) => void): Request<IoTTwinMaker.Types.GetComponentTypeResponse, AWSError>;
- /**
- * Retrieves information about an entity.
- */
- getEntity(params: IoTTwinMaker.Types.GetEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetEntityResponse) => void): Request<IoTTwinMaker.Types.GetEntityResponse, AWSError>;
- /**
- * Retrieves information about an entity.
- */
- getEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetEntityResponse) => void): Request<IoTTwinMaker.Types.GetEntityResponse, AWSError>;
- /**
- * Gets a nmetadata transfer job.
- */
- getMetadataTransferJob(params: IoTTwinMaker.Types.GetMetadataTransferJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.GetMetadataTransferJobResponse, AWSError>;
- /**
- * Gets a nmetadata transfer job.
- */
- getMetadataTransferJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetMetadataTransferJobResponse) => void): Request<IoTTwinMaker.Types.GetMetadataTransferJobResponse, AWSError>;
- /**
- * Gets the pricing plan.
- */
- getPricingPlan(params: IoTTwinMaker.Types.GetPricingPlanRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPricingPlanResponse) => void): Request<IoTTwinMaker.Types.GetPricingPlanResponse, AWSError>;
- /**
- * Gets the pricing plan.
- */
- getPricingPlan(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPricingPlanResponse) => void): Request<IoTTwinMaker.Types.GetPricingPlanResponse, AWSError>;
- /**
- * Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
- */
- getPropertyValue(params: IoTTwinMaker.Types.GetPropertyValueRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueResponse, AWSError>;
- /**
- * Gets the property values for a component, component type, entity, or workspace. You must specify a value for either componentName, componentTypeId, entityId, or workspaceId.
- */
- getPropertyValue(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueResponse, AWSError>;
- /**
- * Retrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.
- */
- getPropertyValueHistory(params: IoTTwinMaker.Types.GetPropertyValueHistoryRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueHistoryResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueHistoryResponse, AWSError>;
- /**
- * Retrieves information about the history of a time series property value for a component, component type, entity, or workspace. You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.
- */
- getPropertyValueHistory(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetPropertyValueHistoryResponse) => void): Request<IoTTwinMaker.Types.GetPropertyValueHistoryResponse, AWSError>;
- /**
- * Retrieves information about a scene.
- */
- getScene(params: IoTTwinMaker.Types.GetSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSceneResponse) => void): Request<IoTTwinMaker.Types.GetSceneResponse, AWSError>;
- /**
- * Retrieves information about a scene.
- */
- getScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSceneResponse) => void): Request<IoTTwinMaker.Types.GetSceneResponse, AWSError>;
- /**
- * Gets the SyncJob.
- */
- getSyncJob(params: IoTTwinMaker.Types.GetSyncJobRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSyncJobResponse) => void): Request<IoTTwinMaker.Types.GetSyncJobResponse, AWSError>;
- /**
- * Gets the SyncJob.
- */
- getSyncJob(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetSyncJobResponse) => void): Request<IoTTwinMaker.Types.GetSyncJobResponse, AWSError>;
- /**
- * Retrieves information about a workspace.
- */
- getWorkspace(params: IoTTwinMaker.Types.GetWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.GetWorkspaceResponse) => void): Request<IoTTwinMaker.Types.GetWorkspaceResponse, AWSError>;
- /**
- * Retrieves information about a workspace.
- */
- getWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.GetWorkspaceResponse) => void): Request<IoTTwinMaker.Types.GetWorkspaceResponse, AWSError>;
- /**
- * Lists all component types in a workspace.
- */
- listComponentTypes(params: IoTTwinMaker.Types.ListComponentTypesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentTypesResponse) => void): Request<IoTTwinMaker.Types.ListComponentTypesResponse, AWSError>;
- /**
- * Lists all component types in a workspace.
- */
- listComponentTypes(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentTypesResponse) => void): Request<IoTTwinMaker.Types.ListComponentTypesResponse, AWSError>;
- /**
- * This API lists the components of an entity.
- */
- listComponents(params: IoTTwinMaker.Types.ListComponentsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentsResponse) => void): Request<IoTTwinMaker.Types.ListComponentsResponse, AWSError>;
- /**
- * This API lists the components of an entity.
- */
- listComponents(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListComponentsResponse) => void): Request<IoTTwinMaker.Types.ListComponentsResponse, AWSError>;
- /**
- * Lists all entities in a workspace.
- */
- listEntities(params: IoTTwinMaker.Types.ListEntitiesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListEntitiesResponse) => void): Request<IoTTwinMaker.Types.ListEntitiesResponse, AWSError>;
- /**
- * Lists all entities in a workspace.
- */
- listEntities(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListEntitiesResponse) => void): Request<IoTTwinMaker.Types.ListEntitiesResponse, AWSError>;
- /**
- * Lists the metadata transfer jobs.
- */
- listMetadataTransferJobs(params: IoTTwinMaker.Types.ListMetadataTransferJobsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListMetadataTransferJobsResponse) => void): Request<IoTTwinMaker.Types.ListMetadataTransferJobsResponse, AWSError>;
- /**
- * Lists the metadata transfer jobs.
- */
- listMetadataTransferJobs(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListMetadataTransferJobsResponse) => void): Request<IoTTwinMaker.Types.ListMetadataTransferJobsResponse, AWSError>;
- /**
- * This API lists the properties of a component.
- */
- listProperties(params: IoTTwinMaker.Types.ListPropertiesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListPropertiesResponse) => void): Request<IoTTwinMaker.Types.ListPropertiesResponse, AWSError>;
- /**
- * This API lists the properties of a component.
- */
- listProperties(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListPropertiesResponse) => void): Request<IoTTwinMaker.Types.ListPropertiesResponse, AWSError>;
- /**
- * Lists all scenes in a workspace.
- */
- listScenes(params: IoTTwinMaker.Types.ListScenesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListScenesResponse) => void): Request<IoTTwinMaker.Types.ListScenesResponse, AWSError>;
- /**
- * Lists all scenes in a workspace.
- */
- listScenes(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListScenesResponse) => void): Request<IoTTwinMaker.Types.ListScenesResponse, AWSError>;
- /**
- * List all SyncJobs.
- */
- listSyncJobs(params: IoTTwinMaker.Types.ListSyncJobsRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncJobsResponse) => void): Request<IoTTwinMaker.Types.ListSyncJobsResponse, AWSError>;
- /**
- * List all SyncJobs.
- */
- listSyncJobs(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncJobsResponse) => void): Request<IoTTwinMaker.Types.ListSyncJobsResponse, AWSError>;
- /**
- * Lists the sync resources.
- */
- listSyncResources(params: IoTTwinMaker.Types.ListSyncResourcesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncResourcesResponse) => void): Request<IoTTwinMaker.Types.ListSyncResourcesResponse, AWSError>;
- /**
- * Lists the sync resources.
- */
- listSyncResources(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListSyncResourcesResponse) => void): Request<IoTTwinMaker.Types.ListSyncResourcesResponse, AWSError>;
- /**
- * Lists all tags associated with a resource.
- */
- listTagsForResource(params: IoTTwinMaker.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListTagsForResourceResponse) => void): Request<IoTTwinMaker.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Lists all tags associated with a resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListTagsForResourceResponse) => void): Request<IoTTwinMaker.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Retrieves information about workspaces in the current account.
- */
- listWorkspaces(params: IoTTwinMaker.Types.ListWorkspacesRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.ListWorkspacesResponse) => void): Request<IoTTwinMaker.Types.ListWorkspacesResponse, AWSError>;
- /**
- * Retrieves information about workspaces in the current account.
- */
- listWorkspaces(callback?: (err: AWSError, data: IoTTwinMaker.Types.ListWorkspacesResponse) => void): Request<IoTTwinMaker.Types.ListWorkspacesResponse, AWSError>;
- /**
- * Adds tags to a resource.
- */
- tagResource(params: IoTTwinMaker.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.TagResourceResponse) => void): Request<IoTTwinMaker.Types.TagResourceResponse, AWSError>;
- /**
- * Adds tags to a resource.
- */
- tagResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.TagResourceResponse) => void): Request<IoTTwinMaker.Types.TagResourceResponse, AWSError>;
- /**
- * Removes tags from a resource.
- */
- untagResource(params: IoTTwinMaker.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UntagResourceResponse) => void): Request<IoTTwinMaker.Types.UntagResourceResponse, AWSError>;
- /**
- * Removes tags from a resource.
- */
- untagResource(callback?: (err: AWSError, data: IoTTwinMaker.Types.UntagResourceResponse) => void): Request<IoTTwinMaker.Types.UntagResourceResponse, AWSError>;
- /**
- * Updates information in a component type.
- */
- updateComponentType(params: IoTTwinMaker.Types.UpdateComponentTypeRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.UpdateComponentTypeResponse, AWSError>;
- /**
- * Updates information in a component type.
- */
- updateComponentType(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateComponentTypeResponse) => void): Request<IoTTwinMaker.Types.UpdateComponentTypeResponse, AWSError>;
- /**
- * Updates an entity.
- */
- updateEntity(params: IoTTwinMaker.Types.UpdateEntityRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateEntityResponse) => void): Request<IoTTwinMaker.Types.UpdateEntityResponse, AWSError>;
- /**
- * Updates an entity.
- */
- updateEntity(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateEntityResponse) => void): Request<IoTTwinMaker.Types.UpdateEntityResponse, AWSError>;
- /**
- * Update the pricing plan.
- */
- updatePricingPlan(params: IoTTwinMaker.Types.UpdatePricingPlanRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdatePricingPlanResponse) => void): Request<IoTTwinMaker.Types.UpdatePricingPlanResponse, AWSError>;
- /**
- * Update the pricing plan.
- */
- updatePricingPlan(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdatePricingPlanResponse) => void): Request<IoTTwinMaker.Types.UpdatePricingPlanResponse, AWSError>;
- /**
- * Updates a scene.
- */
- updateScene(params: IoTTwinMaker.Types.UpdateSceneRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateSceneResponse) => void): Request<IoTTwinMaker.Types.UpdateSceneResponse, AWSError>;
- /**
- * Updates a scene.
- */
- updateScene(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateSceneResponse) => void): Request<IoTTwinMaker.Types.UpdateSceneResponse, AWSError>;
- /**
- * Updates a workspace.
- */
- updateWorkspace(params: IoTTwinMaker.Types.UpdateWorkspaceRequest, callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.UpdateWorkspaceResponse, AWSError>;
- /**
- * Updates a workspace.
- */
- updateWorkspace(callback?: (err: AWSError, data: IoTTwinMaker.Types.UpdateWorkspaceResponse) => void): Request<IoTTwinMaker.Types.UpdateWorkspaceResponse, AWSError>;
- }
- declare namespace IoTTwinMaker {
- export interface BatchPutPropertyError {
- /**
- * The error code.
- */
- errorCode: String;
- /**
- * The error message.
- */
- errorMessage: String;
- /**
- * An object that contains information about errors returned by the BatchPutProperty action.
- */
- entry: PropertyValueEntry;
- }
- export interface BatchPutPropertyErrorEntry {
- /**
- * A list of objects that contain information about errors returned by the BatchPutProperty action.
- */
- errors: Errors;
- }
- export interface BatchPutPropertyValuesRequest {
- /**
- * The ID of the workspace that contains the properties to set.
- */
- workspaceId: Id;
- /**
- * An object that maps strings to the property value entries to set. Each string in the mapping must be unique to this object.
- */
- entries: Entries;
- }
- export interface BatchPutPropertyValuesResponse {
- /**
- * Entries that caused errors in the batch put operation.
- */
- errorEntries: ErrorEntries;
- }
- export type Boolean = boolean;
- export interface BundleInformation {
- /**
- * The bundle names.
- */
- bundleNames: PricingBundles;
- /**
- * The pricing tier.
- */
- pricingTier?: PricingTier;
- }
- export type BundleName = string;
- export interface CancelMetadataTransferJobRequest {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId: Id;
- }
- export interface CancelMetadataTransferJobResponse {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId: Id;
- /**
- * The metadata transfer job ARN.
- */
- arn: TwinMakerArn;
- /**
- * Used to update the DateTime property.
- */
- updateDateTime: Timestamp;
- /**
- * The metadata transfer job's status.
- */
- status: MetadataTransferJobStatus;
- /**
- * The metadata transfer job's progress.
- */
- progress?: MetadataTransferJobProgress;
- }
- export interface ColumnDescription {
- /**
- * The name of the column description.
- */
- name?: ColumnName;
- /**
- * The type of the column description.
- */
- type?: ColumnType;
- }
- export type ColumnDescriptions = ColumnDescription[];
- export type ColumnName = string;
- export type ColumnType = "NODE"|"EDGE"|"VALUE"|string;
- export type ComponentPath = string;
- export interface ComponentPropertyGroupRequest {
- /**
- * The group type.
- */
- groupType?: GroupType;
- /**
- * The property names.
- */
- propertyNames?: PropertyNames;
- /**
- * The update type.
- */
- updateType?: PropertyGroupUpdateType;
- }
- export type ComponentPropertyGroupRequests = {[key: string]: ComponentPropertyGroupRequest};
- export interface ComponentPropertyGroupResponse {
- /**
- * The group type.
- */
- groupType: GroupType;
- /**
- * The names of properties
- */
- propertyNames: PropertyNames;
- /**
- * A Boolean value that specifies whether the property group is inherited from a parent entity
- */
- isInherited: Boolean;
- }
- export type ComponentPropertyGroupResponses = {[key: string]: ComponentPropertyGroupResponse};
- export interface ComponentRequest {
- /**
- * The description of the component request.
- */
- description?: Description;
- /**
- * The ID of the component type.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
- */
- properties?: PropertyRequests;
- /**
- * The property groups.
- */
- propertyGroups?: ComponentPropertyGroupRequests;
- }
- export interface ComponentResponse {
- /**
- * The name of the component.
- */
- componentName?: Name;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * The ID of the component type.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * The status of the component type.
- */
- status?: Status;
- /**
- * The name of the property definition set in the request.
- */
- definedIn?: String;
- /**
- * An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
- */
- properties?: PropertyResponses;
- /**
- * The property groups.
- */
- propertyGroups?: ComponentPropertyGroupResponses;
- /**
- * The syncSource of the sync job, if this entity was created by a sync job.
- */
- syncSource?: SyncSource;
- /**
- * This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.
- */
- areAllPropertiesReturned?: Boolean;
- /**
- * This lists objects that contain information about the compositeComponents.
- */
- compositeComponents?: CompositeComponentResponse;
- /**
- * This flag notes whether all compositeComponents are returned in the API response.
- */
- areAllCompositeComponentsReturned?: Boolean;
- }
- export type ComponentSummaries = ComponentSummary[];
- export interface ComponentSummary {
- /**
- * The name of the component.
- */
- componentName: Name;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The name of the property definition set in the request.
- */
- definedIn?: String;
- /**
- * The description of the component request.
- */
- description?: Description;
- /**
- * The property groups.
- */
- propertyGroups?: ComponentPropertyGroupResponses;
- /**
- * The status of the component type.
- */
- status: Status;
- /**
- * The syncSource of the sync job, if this entity was created by a sync job.
- */
- syncSource?: SyncSource;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- }
- export type ComponentTypeId = string;
- export type ComponentTypeName = string;
- export type ComponentTypeSummaries = ComponentTypeSummary[];
- export interface ComponentTypeSummary {
- /**
- * The ARN of the component type.
- */
- arn: TwinMakerArn;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The date and time when the component type was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the component type was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * The current status of the component type.
- */
- status?: Status;
- /**
- * The component type name.
- */
- componentTypeName?: ComponentTypeName;
- }
- export interface ComponentUpdateRequest {
- /**
- * The update type of the component update request.
- */
- updateType?: ComponentUpdateType;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * The ID of the component type.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
- */
- propertyUpdates?: PropertyRequests;
- /**
- * The property group updates.
- */
- propertyGroupUpdates?: ComponentPropertyGroupRequests;
- }
- export type ComponentUpdateType = "CREATE"|"UPDATE"|"DELETE"|string;
- export type ComponentUpdatesMapRequest = {[key: string]: ComponentUpdateRequest};
- export type ComponentsMap = {[key: string]: ComponentResponse};
- export type ComponentsMapRequest = {[key: string]: ComponentRequest};
- export interface CompositeComponentRequest {
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * This is an object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.
- */
- properties?: PropertyRequests;
- /**
- * The property groups.
- */
- propertyGroups?: ComponentPropertyGroupRequests;
- }
- export type CompositeComponentResponse = {[key: string]: ComponentSummary};
- export interface CompositeComponentTypeRequest {
- /**
- * This is the componentTypeId that the compositeComponentType refers to.
- */
- componentTypeId?: ComponentTypeId;
- }
- export interface CompositeComponentTypeResponse {
- /**
- * This is the componentTypeId that this compositeComponentType refers to.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * This boolean indicates whether this compositeComponentType is inherited from its parent.
- */
- isInherited?: Boolean;
- }
- export type CompositeComponentTypesRequest = {[key: string]: CompositeComponentTypeRequest};
- export type CompositeComponentTypesResponse = {[key: string]: CompositeComponentTypeResponse};
- export interface CompositeComponentUpdateRequest {
- /**
- * The update type of the component update request.
- */
- updateType?: ComponentUpdateType;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * An object that maps strings to the properties to set in the component type update. Each string in the mapping must be unique to this object.
- */
- propertyUpdates?: PropertyRequests;
- /**
- * The property group updates.
- */
- propertyGroupUpdates?: ComponentPropertyGroupRequests;
- }
- export type CompositeComponentUpdatesMapRequest = {[key: string]: CompositeComponentUpdateRequest};
- export type CompositeComponentsMapRequest = {[key: string]: CompositeComponentRequest};
- export type Configuration = {[key: string]: Value};
- export interface CreateComponentTypeRequest {
- /**
- * The ID of the workspace that contains the component type.
- */
- workspaceId: Id;
- /**
- * A Boolean value that specifies whether an entity can have more than one component of this type.
- */
- isSingleton?: Boolean;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
- */
- propertyDefinitions?: PropertyDefinitionsRequest;
- /**
- * Specifies the parent component type to extend.
- */
- extendsFrom?: ExtendsFrom;
- /**
- * An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
- */
- functions?: FunctionsRequest;
- /**
- * Metadata that you can use to manage the component type.
- */
- tags?: TagMap;
- /**
- *
- */
- propertyGroups?: PropertyGroupsRequest;
- /**
- * A friendly name for the component type.
- */
- componentTypeName?: ComponentTypeName;
- /**
- * This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
- */
- compositeComponentTypes?: CompositeComponentTypesRequest;
- }
- export interface CreateComponentTypeResponse {
- /**
- * The ARN of the component type.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the entity was created.
- */
- creationDateTime: Timestamp;
- /**
- * The current state of the component type.
- */
- state: State;
- }
- export interface CreateEntityRequest {
- /**
- * The ID of the workspace that contains the entity.
- */
- workspaceId: Id;
- /**
- * The ID of the entity.
- */
- entityId?: EntityId;
- /**
- * The name of the entity.
- */
- entityName: EntityName;
- /**
- * The description of the entity.
- */
- description?: Description;
- /**
- * An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
- */
- components?: ComponentsMapRequest;
- /**
- * This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
- */
- compositeComponents?: CompositeComponentsMapRequest;
- /**
- * The ID of the entity's parent entity.
- */
- parentEntityId?: ParentEntityId;
- /**
- * Metadata that you can use to manage the entity.
- */
- tags?: TagMap;
- }
- export interface CreateEntityResponse {
- /**
- * The ID of the entity.
- */
- entityId: EntityId;
- /**
- * The ARN of the entity.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the entity was created.
- */
- creationDateTime: Timestamp;
- /**
- * The current state of the entity.
- */
- state: State;
- }
- export interface CreateMetadataTransferJobRequest {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId?: Id;
- /**
- * The metadata transfer job description.
- */
- description?: Description;
- /**
- * The metadata transfer job sources.
- */
- sources: SourceConfigurations;
- /**
- * The metadata transfer job destination.
- */
- destination: DestinationConfiguration;
- }
- export interface CreateMetadataTransferJobResponse {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId: Id;
- /**
- * The metadata transfer job ARN.
- */
- arn: TwinMakerArn;
- /**
- * The The metadata transfer job creation DateTime property.
- */
- creationDateTime: Timestamp;
- /**
- * The metadata transfer job response status.
- */
- status: MetadataTransferJobStatus;
- }
- export interface CreateSceneRequest {
- /**
- * The ID of the workspace that contains the scene.
- */
- workspaceId: Id;
- /**
- * The ID of the scene.
- */
- sceneId: Id;
- /**
- * The relative path that specifies the location of the content definition file.
- */
- contentLocation: S3Url;
- /**
- * The description for this scene.
- */
- description?: Description;
- /**
- * A list of capabilities that the scene uses to render itself.
- */
- capabilities?: SceneCapabilities;
- /**
- * Metadata that you can use to manage the scene.
- */
- tags?: TagMap;
- /**
- * The request metadata.
- */
- sceneMetadata?: SceneMetadataMap;
- }
- export interface CreateSceneResponse {
- /**
- * The ARN of the scene.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the scene was created.
- */
- creationDateTime: Timestamp;
- }
- export interface CreateSyncJobRequest {
- /**
- * The workspace ID.
- */
- workspaceId: Id;
- /**
- * The sync source. Currently the only supported syncSoource is SITEWISE .
- */
- syncSource: SyncSource;
- /**
- * The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.
- */
- syncRole: RoleArn;
- /**
- * The SyncJob tags.
- */
- tags?: TagMap;
- }
- export interface CreateSyncJobResponse {
- /**
- * The SyncJob ARN.
- */
- arn: TwinMakerArn;
- /**
- * The date and time for the SyncJob creation.
- */
- creationDateTime: Timestamp;
- /**
- * The SyncJob response state.
- */
- state: SyncJobState;
- }
- export interface CreateWorkspaceRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The description of the workspace.
- */
- description?: Description;
- /**
- * The ARN of the S3 bucket where resources associated with the workspace are stored.
- */
- s3Location?: S3Location;
- /**
- * The ARN of the execution role associated with the workspace.
- */
- role?: RoleArn;
- /**
- * Metadata that you can use to manage the workspace
- */
- tags?: TagMap;
- }
- export interface CreateWorkspaceResponse {
- /**
- * The ARN of the workspace.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the workspace was created.
- */
- creationDateTime: Timestamp;
- }
- export interface DataConnector {
- /**
- * The Lambda function associated with this data connector.
- */
- lambda?: LambdaFunction;
- /**
- * A Boolean value that specifies whether the data connector is native to IoT TwinMaker.
- */
- isNative?: Boolean;
- }
- export interface DataType {
- /**
- * The underlying type of the data type.
- */
- type: Type;
- /**
- * The nested type in the data type.
- */
- nestedType?: DataType;
- /**
- * The allowed values for this data type.
- */
- allowedValues?: DataValueList;
- /**
- * The unit of measure used in this data type.
- */
- unitOfMeasure?: String;
- /**
- * A relationship that associates a component with another component.
- */
- relationship?: Relationship;
- }
- export interface DataValue {
- /**
- * A Boolean value.
- */
- booleanValue?: Boolean;
- /**
- * A double value.
- */
- doubleValue?: Double;
- /**
- * An integer value.
- */
- integerValue?: Integer;
- /**
- * A long value.
- */
- longValue?: Long;
- /**
- * A string value.
- */
- stringValue?: String;
- /**
- * A list of multiple values.
- */
- listValue?: DataValueList;
- /**
- * An object that maps strings to multiple DataValue objects.
- */
- mapValue?: DataValueMap;
- /**
- * A value that relates a component to another component.
- */
- relationshipValue?: RelationshipValue;
- /**
- * An expression that produces the value.
- */
- expression?: Expression;
- }
- export type DataValueList = DataValue[];
- export type DataValueMap = {[key: string]: DataValue};
- export interface DeleteComponentTypeRequest {
- /**
- * The ID of the workspace that contains the component type.
- */
- workspaceId: Id;
- /**
- * The ID of the component type to delete.
- */
- componentTypeId: ComponentTypeId;
- }
- export interface DeleteComponentTypeResponse {
- /**
- * The current state of the component type to be deleted.
- */
- state: State;
- }
- export interface DeleteEntityRequest {
- /**
- * The ID of the workspace that contains the entity to delete.
- */
- workspaceId: Id;
- /**
- * The ID of the entity to delete.
- */
- entityId: EntityId;
- /**
- * A Boolean value that specifies whether the operation deletes child entities.
- */
- isRecursive?: Boolean;
- }
- export interface DeleteEntityResponse {
- /**
- * The current state of the deleted entity.
- */
- state: State;
- }
- export interface DeleteSceneRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The ID of the scene to delete.
- */
- sceneId: Id;
- }
- export interface DeleteSceneResponse {
- }
- export interface DeleteSyncJobRequest {
- /**
- * The workspace ID.
- */
- workspaceId: Id;
- /**
- * The sync source. Currently the only supported syncSource is SITEWISE .
- */
- syncSource: SyncSource;
- }
- export interface DeleteSyncJobResponse {
- /**
- * The SyncJob response state.
- */
- state: SyncJobState;
- }
- export interface DeleteWorkspaceRequest {
- /**
- * The ID of the workspace to delete.
- */
- workspaceId: Id;
- }
- export interface DeleteWorkspaceResponse {
- /**
- * The string that specifies the delete result for the workspace.
- */
- message?: WorkspaceDeleteMessage;
- }
- export type Description = string;
- export interface DestinationConfiguration {
- /**
- * The destination type.
- */
- type: DestinationType;
- /**
- * The metadata transfer job S3 configuration. [need to add S3 entity]
- */
- s3Configuration?: S3DestinationConfiguration;
- /**
- * The metadata transfer job Amazon Web Services IoT TwinMaker configuration.
- */
- iotTwinMakerConfiguration?: IotTwinMakerDestinationConfiguration;
- }
- export type DestinationType = "s3"|"iotsitewise"|"iottwinmaker"|string;
- export type Double = number;
- export type EntityId = string;
- export type EntityName = string;
- export interface EntityPropertyReference {
- /**
- * The name of the component.
- */
- componentName?: Name;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- /**
- * A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.
- */
- externalIdProperty?: ExternalIdProperty;
- /**
- * The ID of the entity.
- */
- entityId?: EntityId;
- /**
- * The name of the property.
- */
- propertyName: Name;
- }
- export type EntitySummaries = EntitySummary[];
- export interface EntitySummary {
- /**
- * The ID of the entity.
- */
- entityId: EntityId;
- /**
- * The name of the entity.
- */
- entityName: EntityName;
- /**
- * The ARN of the entity.
- */
- arn: TwinMakerArn;
- /**
- * The ID of the parent entity.
- */
- parentEntityId?: ParentEntityId;
- /**
- * The current status of the entity.
- */
- status: Status;
- /**
- * The description of the entity.
- */
- description?: Description;
- /**
- * An eventual Boolean value that specifies whether the entity has child entities or not.
- */
- hasChildEntities?: Boolean;
- /**
- * The date and time when the entity was created.
- */
- creationDateTime: Timestamp;
- /**
- * The last date and time when the entity was updated.
- */
- updateDateTime: Timestamp;
- }
- export type Entries = PropertyValueEntry[];
- export type ErrorCode = "VALIDATION_ERROR"|"INTERNAL_FAILURE"|"SYNC_INITIALIZING_ERROR"|"SYNC_CREATING_ERROR"|"SYNC_PROCESSING_ERROR"|"SYNC_DELETING_ERROR"|"PROCESSING_ERROR"|"COMPOSITE_COMPONENT_FAILURE"|string;
- export interface ErrorDetails {
- /**
- * The error code.
- */
- code?: ErrorCode;
- /**
- * The error message.
- */
- message?: ErrorMessage;
- }
- export type ErrorEntries = BatchPutPropertyErrorEntry[];
- export type ErrorMessage = string;
- export type Errors = BatchPutPropertyError[];
- export interface ExecuteQueryRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The query statement.
- */
- queryStatement: QueryStatement;
- /**
- * The maximum number of results to return at one time. The default is 50.
- */
- maxResults?: QueryServiceMaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ExecuteQueryResponse {
- /**
- * A list of ColumnDescription objects.
- */
- columnDescriptions?: ColumnDescriptions;
- /**
- * Represents a single row in the query results.
- */
- rows?: Rows;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export type Expression = string;
- export type ExtendsFrom = ComponentTypeId[];
- export type ExternalIdProperty = {[key: string]: String};
- export interface FilterByAsset {
- /**
- * Filter by asset Id.
- */
- assetId?: Uuid;
- /**
- * The external-Id property of an asset.
- */
- assetExternalId?: SiteWiseExternalId;
- /**
- * Includes sub-assets.[need description hekp for this]
- */
- includeOffspring?: Boolean;
- /**
- * Boolean to include the asset model.
- */
- includeAssetModel?: Boolean;
- }
- export interface FilterByAssetModel {
- /**
- * The asset model Id.
- */
- assetModelId?: Uuid;
- /**
- * The external-Id property of an asset model.
- */
- assetModelExternalId?: SiteWiseExternalId;
- /**
- * Include asset offspring. [need desc.]
- */
- includeOffspring?: Boolean;
- /**
- * Bolean to include assets.
- */
- includeAssets?: Boolean;
- }
- export interface FilterByComponentType {
- /**
- * The component type Id.
- */
- componentTypeId: ComponentTypeId;
- }
- export interface FilterByEntity {
- /**
- * The entity Id.
- */
- entityId: EntityId;
- }
- export interface FunctionRequest {
- /**
- * The required properties of the function.
- */
- requiredProperties?: RequiredProperties;
- /**
- * The scope of the function.
- */
- scope?: Scope;
- /**
- * The data connector.
- */
- implementedBy?: DataConnector;
- }
- export interface FunctionResponse {
- /**
- * The required properties of the function.
- */
- requiredProperties?: RequiredProperties;
- /**
- * The scope of the function.
- */
- scope?: Scope;
- /**
- * The data connector.
- */
- implementedBy?: DataConnector;
- /**
- * Indicates whether this function is inherited.
- */
- isInherited?: Boolean;
- }
- export type FunctionsRequest = {[key: string]: FunctionRequest};
- export type FunctionsResponse = {[key: string]: FunctionResponse};
- export type GeneratedSceneMetadataMap = {[key: string]: SceneMetadataValue};
- export interface GetComponentTypeRequest {
- /**
- * The ID of the workspace that contains the component type.
- */
- workspaceId: Id;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- }
- export interface GetComponentTypeResponse {
- /**
- * The ID of the workspace that contains the component type.
- */
- workspaceId: Id;
- /**
- * A Boolean value that specifies whether an entity can have more than one component of this type.
- */
- isSingleton?: Boolean;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
- */
- propertyDefinitions?: PropertyDefinitionsResponse;
- /**
- * The name of the parent component type that this component type extends.
- */
- extendsFrom?: ExtendsFrom;
- /**
- * An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
- */
- functions?: FunctionsResponse;
- /**
- * The date and time when the component type was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the component was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The ARN of the component type.
- */
- arn: TwinMakerArn;
- /**
- * A Boolean value that specifies whether the component type is abstract.
- */
- isAbstract?: Boolean;
- /**
- * A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
- */
- isSchemaInitialized?: Boolean;
- /**
- * The current status of the component type.
- */
- status?: Status;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- propertyGroups?: PropertyGroupsResponse;
- /**
- * The syncSource of the SyncJob, if this entity was created by a SyncJob.
- */
- syncSource?: SyncSource;
- /**
- * The component type name.
- */
- componentTypeName?: ComponentTypeName;
- /**
- * This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
- */
- compositeComponentTypes?: CompositeComponentTypesResponse;
- }
- export interface GetEntityRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The ID of the entity.
- */
- entityId: EntityId;
- }
- export interface GetEntityResponse {
- /**
- * The ID of the entity.
- */
- entityId: EntityId;
- /**
- * The name of the entity.
- */
- entityName: EntityName;
- /**
- * The ARN of the entity.
- */
- arn: TwinMakerArn;
- /**
- * The current status of the entity.
- */
- status: Status;
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The description of the entity.
- */
- description?: Description;
- /**
- * An object that maps strings to the components in the entity. Each string in the mapping must be unique to this object.
- */
- components?: ComponentsMap;
- /**
- * The ID of the parent entity for this entity.
- */
- parentEntityId: ParentEntityId;
- /**
- * A Boolean value that specifies whether the entity has associated child entities.
- */
- hasChildEntities: Boolean;
- /**
- * The date and time when the entity was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the entity was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The syncSource of the sync job, if this entity was created by a sync job.
- */
- syncSource?: SyncSource;
- /**
- * This flag notes whether all components are returned in the API response. The maximum number of components returned is 30.
- */
- areAllComponentsReturned?: Boolean;
- }
- export interface GetMetadataTransferJobRequest {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId: Id;
- }
- export interface GetMetadataTransferJobResponse {
- /**
- * The metadata transfer job Id.
- */
- metadataTransferJobId: Id;
- /**
- * The metadata transfer job ARN.
- */
- arn: TwinMakerArn;
- /**
- * The metadata transfer job description.
- */
- description?: Description;
- /**
- * The metadata transfer job's sources.
- */
- sources: SourceConfigurations;
- /**
- * The metadata transfer job's destination.
- */
- destination: DestinationConfiguration;
- /**
- * The metadata transfer job's role.
- */
- metadataTransferJobRole: RoleArn;
- /**
- * The metadata transfer job's report URL.
- */
- reportUrl?: String;
- /**
- * The metadata transfer job's creation DateTime property.
- */
- creationDateTime: Timestamp;
- /**
- * The metadata transfer job's update DateTime property.
- */
- updateDateTime: Timestamp;
- /**
- * The metadata transfer job's status.
- */
- status: MetadataTransferJobStatus;
- /**
- * The metadata transfer job's progress.
- */
- progress?: MetadataTransferJobProgress;
- }
- export interface GetPricingPlanRequest {
- }
- export interface GetPricingPlanResponse {
- /**
- * The chosen pricing plan for the current billing cycle.
- */
- currentPricingPlan: PricingPlan;
- /**
- * The pending pricing plan.
- */
- pendingPricingPlan?: PricingPlan;
- }
- export interface GetPropertyValueHistoryRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The ID of the entity.
- */
- entityId?: EntityId;
- /**
- * The name of the component.
- */
- componentName?: Name;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- /**
- * The ID of the component type.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * A list of properties whose value histories the request retrieves.
- */
- selectedProperties: SelectedPropertyList;
- /**
- * A list of objects that filter the property value history request.
- */
- propertyFilters?: PropertyFilters;
- /**
- * The date and time of the earliest property value to return.
- */
- startDateTime?: Timestamp;
- /**
- * The date and time of the latest property value to return.
- */
- endDateTime?: Timestamp;
- /**
- * An object that specifies the interpolation type and the interval over which to interpolate data.
- */
- interpolation?: InterpolationParameters;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- /**
- * The time direction to use in the result order.
- */
- orderByTime?: OrderByTime;
- /**
- * The ISO8601 DateTime of the earliest property value to return. For more information about the ISO8601 DateTime format, see the data type PropertyValue.
- */
- startTime?: Time;
- /**
- * The ISO8601 DateTime of the latest property value to return. For more information about the ISO8601 DateTime format, see the data type PropertyValue.
- */
- endTime?: Time;
- }
- export interface GetPropertyValueHistoryResponse {
- /**
- * An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
- */
- propertyValues: PropertyValueList;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface GetPropertyValueRequest {
- /**
- * The name of the component whose property values the operation returns.
- */
- componentName?: Name;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- /**
- * The ID of the component type whose property values the operation returns.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * The ID of the entity whose property values the operation returns.
- */
- entityId?: EntityId;
- /**
- * The properties whose values the operation returns.
- */
- selectedProperties: SelectedPropertyList;
- /**
- * The ID of the workspace whose values the operation returns.
- */
- workspaceId: Id;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * The property group name.
- */
- propertyGroupName?: Name;
- /**
- * The tabular conditions.
- */
- tabularConditions?: TabularConditions;
- }
- export interface GetPropertyValueResponse {
- /**
- * An object that maps strings to the properties and latest property values in the response. Each string in the mapping must be unique to this object.
- */
- propertyValues?: PropertyLatestValueMap;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * A table of property values.
- */
- tabularPropertyValues?: TabularPropertyValues;
- }
- export interface GetSceneRequest {
- /**
- * The ID of the workspace that contains the scene.
- */
- workspaceId: Id;
- /**
- * The ID of the scene.
- */
- sceneId: Id;
- }
- export interface GetSceneResponse {
- /**
- * The ID of the workspace that contains the scene.
- */
- workspaceId: Id;
- /**
- * The ID of the scene.
- */
- sceneId: Id;
- /**
- * The relative path that specifies the location of the content definition file.
- */
- contentLocation: S3Url;
- /**
- * The ARN of the scene.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the scene was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the scene was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The description of the scene.
- */
- description?: Description;
- /**
- * A list of capabilities that the scene uses to render.
- */
- capabilities?: SceneCapabilities;
- /**
- * The response metadata.
- */
- sceneMetadata?: SceneMetadataMap;
- /**
- * The generated scene metadata.
- */
- generatedSceneMetadata?: GeneratedSceneMetadataMap;
- /**
- * The SceneResponse error.
- */
- error?: SceneError;
- }
- export interface GetSyncJobRequest {
- /**
- * The sync source. Currently the only supported syncSource is SITEWISE .
- */
- syncSource: SyncSource;
- /**
- * The workspace ID.
- */
- workspaceId?: Id;
- }
- export interface GetSyncJobResponse {
- /**
- * The sync job ARN.
- */
- arn: TwinMakerArn;
- /**
- * The ID of the workspace that contains the sync job.
- */
- workspaceId: Id;
- /**
- * The sync soucre. Currently the only supported syncSource is SITEWISE .
- */
- syncSource: SyncSource;
- /**
- * The sync IAM role.
- */
- syncRole: RoleArn;
- /**
- * The SyncJob response status.
- */
- status: SyncJobStatus;
- /**
- * The creation date and time.
- */
- creationDateTime: Timestamp;
- /**
- * The update date and time.
- */
- updateDateTime: Timestamp;
- }
- export interface GetWorkspaceRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: IdOrArn;
- }
- export interface GetWorkspaceResponse {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The ARN of the workspace.
- */
- arn: TwinMakerArn;
- /**
- * The description of the workspace.
- */
- description?: Description;
- /**
- * A list of services that are linked to the workspace.
- */
- linkedServices?: LinkedServices;
- /**
- * The ARN of the S3 bucket where resources associated with the workspace are stored.
- */
- s3Location?: S3Location;
- /**
- * The ARN of the execution role associated with the workspace.
- */
- role?: RoleArn;
- /**
- * The date and time when the workspace was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the workspace was last updated.
- */
- updateDateTime: Timestamp;
- }
- export type GroupType = "TABULAR"|string;
- export type Id = string;
- export type IdOrArn = string;
- export type Integer = number;
- export interface InterpolationParameters {
- /**
- * The interpolation type.
- */
- interpolationType?: InterpolationType;
- /**
- * The interpolation time interval in seconds.
- */
- intervalInSeconds?: IntervalInSeconds;
- }
- export type InterpolationType = "LINEAR"|string;
- export type IntervalInSeconds = number;
- export interface IotSiteWiseSourceConfiguration {
- /**
- * The AWS IoT SiteWise soucre configuration filters.
- */
- filters?: IotSiteWiseSourceConfigurationFilters;
- }
- export interface IotSiteWiseSourceConfigurationFilter {
- /**
- * Filter by asset model.
- */
- filterByAssetModel?: FilterByAssetModel;
- /**
- * Filter by asset.
- */
- filterByAsset?: FilterByAsset;
- }
- export type IotSiteWiseSourceConfigurationFilters = IotSiteWiseSourceConfigurationFilter[];
- export interface IotTwinMakerDestinationConfiguration {
- /**
- * The IoT TwinMaker workspace.
- */
- workspace: TwinMakerArn;
- }
- export interface IotTwinMakerSourceConfiguration {
- /**
- * The IoT TwinMaker workspace.
- */
- workspace: TwinMakerArn;
- /**
- * The metadata transfer job AWS IoT TwinMaker source configuration filters.
- */
- filters?: IotTwinMakerSourceConfigurationFilters;
- }
- export interface IotTwinMakerSourceConfigurationFilter {
- /**
- * Filter by component type.
- */
- filterByComponentType?: FilterByComponentType;
- /**
- * Filter by entity.
- */
- filterByEntity?: FilterByEntity;
- }
- export type IotTwinMakerSourceConfigurationFilters = IotTwinMakerSourceConfigurationFilter[];
- export type LambdaArn = string;
- export interface LambdaFunction {
- /**
- * The ARN of the Lambda function.
- */
- arn: LambdaArn;
- }
- export type LinkedService = string;
- export type LinkedServices = LinkedService[];
- export interface ListComponentTypesFilter {
- /**
- * The component type that the component types in the list extend.
- */
- extendsFrom?: ComponentTypeId;
- /**
- * The namespace to which the component types in the list belong.
- */
- namespace?: String;
- /**
- * A Boolean value that specifies whether the component types in the list are abstract.
- */
- isAbstract?: Boolean;
- }
- export type ListComponentTypesFilters = ListComponentTypesFilter[];
- export interface ListComponentTypesRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * A list of objects that filter the request.
- */
- filters?: ListComponentTypesFilters;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- }
- export interface ListComponentTypesResponse {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * A list of objects that contain information about the component types.
- */
- componentTypeSummaries: ComponentTypeSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * Specifies the maximum number of results to display.
- */
- maxResults?: MaxResults;
- }
- export interface ListComponentsRequest {
- /**
- * The workspace ID.
- */
- workspaceId: Id;
- /**
- * The ID for the entity whose metadata (component/properties) is returned by the operation.
- */
- entityId: EntityId;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- /**
- * The maximum number of results returned at one time. The default is 25.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListComponentsResponse {
- /**
- * A list of objects that contain information about the components.
- */
- componentSummaries: ComponentSummaries;
- /**
- * The string that specifies the next page of component results.
- */
- nextToken?: NextToken;
- }
- export interface ListEntitiesFilter {
- /**
- * The parent of the entities in the list.
- */
- parentEntityId?: ParentEntityId;
- /**
- * The ID of the component type in the entities in the list.
- */
- componentTypeId?: ComponentTypeId;
- /**
- * The external-Id property of a component. The external-Id property is the primary key of an external storage system.
- */
- externalId?: String;
- }
- export type ListEntitiesFilters = ListEntitiesFilter[];
- export interface ListEntitiesRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * A list of objects that filter the request. Only one object is accepted as a valid input.
- */
- filters?: ListEntitiesFilters;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListEntitiesResponse {
- /**
- * A list of objects that contain information about the entities.
- */
- entitySummaries?: EntitySummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListMetadataTransferJobsFilter {
- /**
- * The workspace Id.
- */
- workspaceId?: Id;
- /**
- * The filter state.
- */
- state?: MetadataTransferJobState;
- }
- export type ListMetadataTransferJobsFilters = ListMetadataTransferJobsFilter[];
- export interface ListMetadataTransferJobsRequest {
- /**
- * The metadata transfer job's source type.
- */
- sourceType: SourceType;
- /**
- * The metadata transfer job's destination type.
- */
- destinationType: DestinationType;
- /**
- * An object that filters metadata transfer jobs.
- */
- filters?: ListMetadataTransferJobsFilters;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- /**
- * The maximum number of results to return at one time.
- */
- maxResults?: MaxResults;
- }
- export interface ListMetadataTransferJobsResponse {
- /**
- * The metadata transfer job summaries.
- */
- metadataTransferJobSummaries: MetadataTransferJobSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListPropertiesRequest {
- /**
- * The workspace ID.
- */
- workspaceId: Id;
- /**
- * The name of the component whose properties are returned by the operation.
- */
- componentName?: Name;
- /**
- * This string specifies the path to the composite component, starting from the top-level component.
- */
- componentPath?: ComponentPath;
- /**
- * The ID for the entity whose metadata (component/properties) is returned by the operation.
- */
- entityId: EntityId;
- /**
- * The maximum number of results returned at one time. The default is 25.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListPropertiesResponse {
- /**
- * A list of objects that contain information about the properties.
- */
- propertySummaries: PropertySummaries;
- /**
- * The string that specifies the next page of property results.
- */
- nextToken?: NextToken;
- }
- export interface ListScenesRequest {
- /**
- * The ID of the workspace that contains the scenes.
- */
- workspaceId: Id;
- /**
- * Specifies the maximum number of results to display.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListScenesResponse {
- /**
- * A list of objects that contain information about the scenes.
- */
- sceneSummaries?: SceneSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListSyncJobsRequest {
- /**
- * The ID of the workspace that contains the sync job.
- */
- workspaceId: Id;
- /**
- * The maximum number of results to return at one time. The default is 50. Valid Range: Minimum value of 0. Maximum value of 200.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListSyncJobsResponse {
- /**
- * The listed SyncJob summaries.
- */
- syncJobSummaries?: SyncJobSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListSyncResourcesRequest {
- /**
- * The ID of the workspace that contains the sync job.
- */
- workspaceId: Id;
- /**
- * The sync source. Currently the only supported syncSource is SITEWISE .
- */
- syncSource: SyncSource;
- /**
- * A list of objects that filter the request. The following filter combinations are supported: Filter with state Filter with ResourceType and ResourceId Filter with ResourceType and ExternalId
- */
- filters?: SyncResourceFilters;
- /**
- * The maximum number of results to return at one time. The default is 50. Valid Range: Minimum value of 0. Maximum value of 200.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListSyncResourcesResponse {
- /**
- * The sync resources.
- */
- syncResources?: SyncResourceSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The ARN of the resource.
- */
- resourceARN: TwinMakerArn;
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListTagsForResourceResponse {
- /**
- * Metadata that you can use to manage a resource.
- */
- tags?: TagMap;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListWorkspacesRequest {
- /**
- * The maximum number of results to return at one time. The default is 25. Valid Range: Minimum value of 1. Maximum value of 250.
- */
- maxResults?: MaxResults;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export interface ListWorkspacesResponse {
- /**
- * A list of objects that contain information about the workspaces.
- */
- workspaceSummaries?: WorkspaceSummaries;
- /**
- * The string that specifies the next page of results.
- */
- nextToken?: NextToken;
- }
- export type Long = number;
- export type MaxResults = number;
- export interface MetadataTransferJobProgress {
- /**
- * The total count. [of what]
- */
- totalCount?: Integer;
- /**
- * The succeeded count.
- */
- succeededCount?: Integer;
- /**
- * The skipped count.
- */
- skippedCount?: Integer;
- /**
- * The failed count.
- */
- failedCount?: Integer;
- }
- export type MetadataTransferJobState = "VALIDATING"|"PENDING"|"RUNNING"|"CANCELLING"|"ERROR"|"COMPLETED"|"CANCELLED"|string;
- export interface MetadataTransferJobStatus {
- /**
- * The metadata transfer job state.
- */
- state?: MetadataTransferJobState;
- /**
- * The metadata transfer job error.
- */
- error?: ErrorDetails;
- /**
- * The queued position.
- */
- queuedPosition?: Integer;
- }
- export type MetadataTransferJobSummaries = MetadataTransferJobSummary[];
- export interface MetadataTransferJobSummary {
- /**
- * The metadata transfer job summary Id.
- */
- metadataTransferJobId: Id;
- /**
- * The metadata transfer job summary ARN.
- */
- arn: TwinMakerArn;
- /**
- * The metadata transfer job summary creation DateTime object.
- */
- creationDateTime: Timestamp;
- /**
- * The metadata transfer job summary update DateTime object
- */
- updateDateTime: Timestamp;
- /**
- * The metadata transfer job summary status.
- */
- status: MetadataTransferJobStatus;
- /**
- * The metadata transfer job summary progess.
- */
- progress?: MetadataTransferJobProgress;
- }
- export type Name = string;
- export type NextToken = string;
- export type Order = "ASCENDING"|"DESCENDING"|string;
- export interface OrderBy {
- /**
- * The set order that filters results.
- */
- order?: Order;
- /**
- * The property name.
- */
- propertyName: String;
- }
- export type OrderByList = OrderBy[];
- export type OrderByTime = "ASCENDING"|"DESCENDING"|string;
- export type ParentEntityId = string;
- export interface ParentEntityUpdateRequest {
- /**
- * The type of the update.
- */
- updateType: ParentEntityUpdateType;
- /**
- * The ID of the parent entity.
- */
- parentEntityId?: ParentEntityId;
- }
- export type ParentEntityUpdateType = "UPDATE"|"DELETE"|string;
- export type PricingBundles = BundleName[];
- export type PricingMode = "BASIC"|"STANDARD"|"TIERED_BUNDLE"|string;
- export interface PricingPlan {
- /**
- * The billable entity count.
- */
- billableEntityCount?: Long;
- /**
- * The pricing plan's bundle information.
- */
- bundleInformation?: BundleInformation;
- /**
- * The effective date and time of the pricing plan.
- */
- effectiveDateTime: Timestamp;
- /**
- * The pricing mode.
- */
- pricingMode: PricingMode;
- /**
- * The set date and time for updating a pricing plan.
- */
- updateDateTime: Timestamp;
- /**
- * The update reason for changing a pricing plan.
- */
- updateReason: UpdateReason;
- }
- export type PricingTier = "TIER_1"|"TIER_2"|"TIER_3"|"TIER_4"|string;
- export interface PropertyDefinitionRequest {
- /**
- * An object that contains information about the data type.
- */
- dataType?: DataType;
- /**
- * A Boolean value that specifies whether the property is required.
- */
- isRequiredInEntity?: Boolean;
- /**
- * A Boolean value that specifies whether the property ID comes from an external data store.
- */
- isExternalId?: Boolean;
- /**
- * A Boolean value that specifies whether the property is stored externally.
- */
- isStoredExternally?: Boolean;
- /**
- * A Boolean value that specifies whether the property consists of time series data.
- */
- isTimeSeries?: Boolean;
- /**
- * An object that contains the default value.
- */
- defaultValue?: DataValue;
- /**
- * A mapping that specifies configuration information about the property. Use this field to specify information that you read from and write to an external source.
- */
- configuration?: Configuration;
- /**
- * A friendly name for the property.
- */
- displayName?: PropertyDisplayName;
- }
- export interface PropertyDefinitionResponse {
- /**
- * An object that contains information about the data type.
- */
- dataType: DataType;
- /**
- * A Boolean value that specifies whether the property consists of time series data.
- */
- isTimeSeries: Boolean;
- /**
- * A Boolean value that specifies whether the property is required in an entity.
- */
- isRequiredInEntity: Boolean;
- /**
- * A Boolean value that specifies whether the property ID comes from an external data store.
- */
- isExternalId: Boolean;
- /**
- * A Boolean value that specifies whether the property is stored externally.
- */
- isStoredExternally: Boolean;
- /**
- * A Boolean value that specifies whether the property definition is imported from an external data store.
- */
- isImported: Boolean;
- /**
- * A Boolean value that specifies whether the property definition can be updated.
- */
- isFinal: Boolean;
- /**
- * A Boolean value that specifies whether the property definition is inherited from a parent entity.
- */
- isInherited: Boolean;
- /**
- * An object that contains the default value.
- */
- defaultValue?: DataValue;
- /**
- * A mapping that specifies configuration information about the property.
- */
- configuration?: Configuration;
- /**
- * A friendly name for the property.
- */
- displayName?: PropertyDisplayName;
- }
- export type PropertyDefinitionsRequest = {[key: string]: PropertyDefinitionRequest};
- export type PropertyDefinitionsResponse = {[key: string]: PropertyDefinitionResponse};
- export type PropertyDisplayName = string;
- export interface PropertyFilter {
- /**
- * The property name associated with this property filter.
- */
- propertyName?: String;
- /**
- * The operator associated with this property filter.
- */
- operator?: String;
- /**
- * The value associated with this property filter.
- */
- value?: DataValue;
- }
- export type PropertyFilters = PropertyFilter[];
- export interface PropertyGroupRequest {
- /**
- * The group type.
- */
- groupType?: GroupType;
- /**
- * The names of properties.
- */
- propertyNames?: PropertyNames;
- }
- export interface PropertyGroupResponse {
- /**
- * The group types.
- */
- groupType: GroupType;
- /**
- * The names of properties.
- */
- propertyNames: PropertyNames;
- /**
- * A Boolean value that specifies whether the property group is inherited from a parent entity
- */
- isInherited: Boolean;
- }
- export type PropertyGroupUpdateType = "UPDATE"|"DELETE"|"CREATE"|string;
- export type PropertyGroupsRequest = {[key: string]: PropertyGroupRequest};
- export type PropertyGroupsResponse = {[key: string]: PropertyGroupResponse};
- export interface PropertyLatestValue {
- /**
- * An object that specifies information about a property.
- */
- propertyReference: EntityPropertyReference;
- /**
- * The value of the property.
- */
- propertyValue?: DataValue;
- }
- export type PropertyLatestValueMap = {[key: string]: PropertyLatestValue};
- export type PropertyNames = Name[];
- export interface PropertyRequest {
- /**
- * An object that specifies information about a property.
- */
- definition?: PropertyDefinitionRequest;
- /**
- * The value of the property.
- */
- value?: DataValue;
- /**
- * The update type of the update property request.
- */
- updateType?: PropertyUpdateType;
- }
- export type PropertyRequests = {[key: string]: PropertyRequest};
- export interface PropertyResponse {
- /**
- * An object that specifies information about a property.
- */
- definition?: PropertyDefinitionResponse;
- /**
- * The value of the property.
- */
- value?: DataValue;
- /**
- * This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
- */
- areAllPropertyValuesReturned?: Boolean;
- }
- export type PropertyResponses = {[key: string]: PropertyResponse};
- export type PropertySummaries = PropertySummary[];
- export interface PropertySummary {
- /**
- * This is the schema for the property.
- */
- definition?: PropertyDefinitionResponse;
- /**
- * This is the name of the property.
- */
- propertyName: Name;
- /**
- * This is the value for the property.
- */
- value?: DataValue;
- /**
- * This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.
- */
- areAllPropertyValuesReturned?: Boolean;
- }
- export type PropertyTableValue = {[key: string]: DataValue};
- export type PropertyUpdateType = "UPDATE"|"DELETE"|"CREATE"|string;
- export interface PropertyValue {
- /**
- * The timestamp of a value for a time series property.
- */
- timestamp?: Timestamp;
- /**
- * An object that specifies a value for a time series property.
- */
- value: DataValue;
- /**
- * ISO8601 DateTime of a value for a time series property. The time for when the property value was recorded in ISO 8601 format: YYYY-MM-DDThh:mm:ss[.SSSSSSSSS][Z/±HH:mm]. [YYYY]: year [MM]: month [DD]: day [hh]: hour [mm]: minute [ss]: seconds [.SSSSSSSSS]: additional precision, where precedence is maintained. For example: [.573123] is equal to 573123000 nanoseconds. Z: default timezone UTC ± HH:mm: time zone offset in Hours and Minutes. Required sub-fields: YYYY-MM-DDThh:mm:ss and [Z/±HH:mm]
- */
- time?: Time;
- }
- export interface PropertyValueEntry {
- /**
- * An object that contains information about the entity that has the property.
- */
- entityPropertyReference: EntityPropertyReference;
- /**
- * A list of objects that specify time series property values.
- */
- propertyValues?: PropertyValues;
- }
- export interface PropertyValueHistory {
- /**
- * An object that uniquely identifies an entity property.
- */
- entityPropertyReference: EntityPropertyReference;
- /**
- * A list of objects that contain information about the values in the history of a time series property.
- */
- values?: Values;
- }
- export type PropertyValueList = PropertyValueHistory[];
- export type PropertyValues = PropertyValue[];
- export interface QueryResultValue {
- }
- export type QueryServiceMaxResults = number;
- export type QueryStatement = string;
- export interface Relationship {
- /**
- * The ID of the target component type associated with this relationship.
- */
- targetComponentTypeId?: ComponentTypeId;
- /**
- * The type of the relationship.
- */
- relationshipType?: String;
- }
- export interface RelationshipValue {
- /**
- * The ID of the target entity associated with this relationship value.
- */
- targetEntityId?: EntityId;
- /**
- * The name of the target component associated with the relationship value.
- */
- targetComponentName?: Name;
- }
- export type RequiredProperties = Name[];
- export type RoleArn = string;
- export interface Row {
- /**
- * The data in a row of query results.
- */
- rowData?: RowData;
- }
- export type RowData = QueryResultValue[];
- export type Rows = Row[];
- export interface S3DestinationConfiguration {
- /**
- * The S3 destination configuration location.
- */
- location: S3DestinationLocation;
- }
- export type S3DestinationLocation = string;
- export type S3Location = string;
- export interface S3SourceConfiguration {
- /**
- * The S3 destination source configuration location.
- */
- location: S3SourceLocation;
- }
- export type S3SourceLocation = string;
- export type S3Url = string;
- export type SceneCapabilities = SceneCapability[];
- export type SceneCapability = string;
- export interface SceneError {
- /**
- * The SceneError code.
- */
- code?: SceneErrorCode;
- /**
- * The SceneError message.
- */
- message?: ErrorMessage;
- }
- export type SceneErrorCode = "MATTERPORT_ERROR"|string;
- export type SceneMetadataMap = {[key: string]: SceneMetadataValue};
- export type SceneMetadataValue = string;
- export type SceneSummaries = SceneSummary[];
- export interface SceneSummary {
- /**
- * The ID of the scene.
- */
- sceneId: Id;
- /**
- * The relative path that specifies the location of the content definition file.
- */
- contentLocation: S3Url;
- /**
- * The ARN of the scene.
- */
- arn: TwinMakerArn;
- /**
- * The date and time when the scene was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the scene was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The scene description.
- */
- description?: Description;
- }
- export type Scope = "ENTITY"|"WORKSPACE"|string;
- export type SelectedPropertyList = String[];
- export type SiteWiseExternalId = string;
- export interface SourceConfiguration {
- /**
- * The source configuration type.
- */
- type: SourceType;
- /**
- * The source configuration S3 configuration.
- */
- s3Configuration?: S3SourceConfiguration;
- /**
- * The source configuration IoT SiteWise configuration.
- */
- iotSiteWiseConfiguration?: IotSiteWiseSourceConfiguration;
- /**
- * The source configuration IoT TwinMaker configuration.
- */
- iotTwinMakerConfiguration?: IotTwinMakerSourceConfiguration;
- }
- export type SourceConfigurations = SourceConfiguration[];
- export type SourceType = "s3"|"iotsitewise"|"iottwinmaker"|string;
- export type State = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"ERROR"|string;
- export interface Status {
- /**
- * The current state of the entity, component, component type, or workspace.
- */
- state?: State;
- /**
- * The error message.
- */
- error?: ErrorDetails;
- }
- export type String = string;
- export type SyncJobState = "CREATING"|"INITIALIZING"|"ACTIVE"|"DELETING"|"ERROR"|string;
- export interface SyncJobStatus {
- /**
- * The SyncJob status state.
- */
- state?: SyncJobState;
- /**
- * The SyncJob error.
- */
- error?: ErrorDetails;
- }
- export type SyncJobSummaries = SyncJobSummary[];
- export interface SyncJobSummary {
- /**
- * The SyncJob summary ARN.
- */
- arn?: TwinMakerArn;
- /**
- * The ID of the workspace that contains the sync job.
- */
- workspaceId?: Id;
- /**
- * The sync source.
- */
- syncSource?: SyncSource;
- /**
- * The SyncJob summaries status.
- */
- status?: SyncJobStatus;
- /**
- * The creation date and time.
- */
- creationDateTime?: Timestamp;
- /**
- * The update date and time.
- */
- updateDateTime?: Timestamp;
- }
- export interface SyncResourceFilter {
- /**
- * The sync resource filter's state.
- */
- state?: SyncResourceState;
- /**
- * The sync resource filter resource type
- */
- resourceType?: SyncResourceType;
- /**
- * The sync resource filter resource ID.
- */
- resourceId?: Id;
- /**
- * The external ID.
- */
- externalId?: Id;
- }
- export type SyncResourceFilters = SyncResourceFilter[];
- export type SyncResourceState = "INITIALIZING"|"PROCESSING"|"DELETED"|"IN_SYNC"|"ERROR"|string;
- export interface SyncResourceStatus {
- /**
- * The sync resource status state.
- */
- state?: SyncResourceState;
- /**
- * The status error.
- */
- error?: ErrorDetails;
- }
- export type SyncResourceSummaries = SyncResourceSummary[];
- export interface SyncResourceSummary {
- /**
- * The resource type.
- */
- resourceType?: SyncResourceType;
- /**
- * The external ID.
- */
- externalId?: Id;
- /**
- * The resource ID.
- */
- resourceId?: Id;
- /**
- * The sync resource summary status.
- */
- status?: SyncResourceStatus;
- /**
- * The update date and time.
- */
- updateDateTime?: Timestamp;
- }
- export type SyncResourceType = "ENTITY"|"COMPONENT_TYPE"|string;
- export type SyncSource = string;
- export interface TabularConditions {
- /**
- * Filter criteria that orders the output. It can be sorted in ascending or descending order.
- */
- orderBy?: OrderByList;
- /**
- * You can filter the request using various logical operators and a key-value format. For example: {"key": "serverType", "value": "webServer"}
- */
- propertyFilters?: PropertyFilters;
- }
- export type TabularPropertyValue = PropertyTableValue[];
- export type TabularPropertyValues = TabularPropertyValue[];
- export type TagKey = string;
- export type TagKeyList = TagKey[];
- export type TagMap = {[key: string]: TagValue};
- export interface TagResourceRequest {
- /**
- * The ARN of the resource.
- */
- resourceARN: TwinMakerArn;
- /**
- * Metadata to add to this resource.
- */
- tags: TagMap;
- }
- export interface TagResourceResponse {
- }
- export type TagValue = string;
- export type Time = string;
- export type Timestamp = Date;
- export type TwinMakerArn = string;
- export type Type = "RELATIONSHIP"|"STRING"|"LONG"|"BOOLEAN"|"INTEGER"|"DOUBLE"|"LIST"|"MAP"|string;
- export interface UntagResourceRequest {
- /**
- * The ARN of the resource.
- */
- resourceARN: TwinMakerArn;
- /**
- * A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.
- */
- tagKeys: TagKeyList;
- }
- export interface UntagResourceResponse {
- }
- export interface UpdateComponentTypeRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * A Boolean value that specifies whether an entity can have more than one component of this type.
- */
- isSingleton?: Boolean;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The description of the component type.
- */
- description?: Description;
- /**
- * An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
- */
- propertyDefinitions?: PropertyDefinitionsRequest;
- /**
- * Specifies the component type that this component type extends.
- */
- extendsFrom?: ExtendsFrom;
- /**
- * An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
- */
- functions?: FunctionsRequest;
- /**
- * The property groups.
- */
- propertyGroups?: PropertyGroupsRequest;
- /**
- * The component type name.
- */
- componentTypeName?: ComponentTypeName;
- /**
- * This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
- */
- compositeComponentTypes?: CompositeComponentTypesRequest;
- }
- export interface UpdateComponentTypeResponse {
- /**
- * The ID of the workspace that contains the component type.
- */
- workspaceId: Id;
- /**
- * The ARN of the component type.
- */
- arn: TwinMakerArn;
- /**
- * The ID of the component type.
- */
- componentTypeId: ComponentTypeId;
- /**
- * The current state of the component type.
- */
- state: State;
- }
- export interface UpdateEntityRequest {
- /**
- * The ID of the workspace that contains the entity.
- */
- workspaceId: Id;
- /**
- * The ID of the entity.
- */
- entityId: EntityId;
- /**
- * The name of the entity.
- */
- entityName?: EntityName;
- /**
- * The description of the entity.
- */
- description?: Description;
- /**
- * An object that maps strings to the component updates in the request. Each string in the mapping must be unique to this object.
- */
- componentUpdates?: ComponentUpdatesMapRequest;
- /**
- * This is an object that maps strings to compositeComponent updates in the request. Each key of the map represents the componentPath of the compositeComponent.
- */
- compositeComponentUpdates?: CompositeComponentUpdatesMapRequest;
- /**
- * An object that describes the update request for a parent entity.
- */
- parentEntityUpdate?: ParentEntityUpdateRequest;
- }
- export interface UpdateEntityResponse {
- /**
- * The date and time when the entity was last updated.
- */
- updateDateTime: Timestamp;
- /**
- * The current state of the entity update.
- */
- state: State;
- }
- export interface UpdatePricingPlanRequest {
- /**
- * The pricing mode.
- */
- pricingMode: PricingMode;
- /**
- * The bundle names.
- */
- bundleNames?: PricingBundles;
- }
- export interface UpdatePricingPlanResponse {
- /**
- * Update the current pricing plan.
- */
- currentPricingPlan: PricingPlan;
- /**
- * Update the pending pricing plan.
- */
- pendingPricingPlan?: PricingPlan;
- }
- export type UpdateReason = "DEFAULT"|"PRICING_TIER_UPDATE"|"ENTITY_COUNT_UPDATE"|"PRICING_MODE_UPDATE"|"OVERWRITTEN"|string;
- export interface UpdateSceneRequest {
- /**
- * The ID of the workspace that contains the scene.
- */
- workspaceId: Id;
- /**
- * The ID of the scene.
- */
- sceneId: Id;
- /**
- * The relative path that specifies the location of the content definition file.
- */
- contentLocation?: S3Url;
- /**
- * The description of this scene.
- */
- description?: Description;
- /**
- * A list of capabilities that the scene uses to render.
- */
- capabilities?: SceneCapabilities;
- /**
- * The scene metadata.
- */
- sceneMetadata?: SceneMetadataMap;
- }
- export interface UpdateSceneResponse {
- /**
- * The date and time when the scene was last updated.
- */
- updateDateTime: Timestamp;
- }
- export interface UpdateWorkspaceRequest {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The description of the workspace.
- */
- description?: Description;
- /**
- * The ARN of the execution role associated with the workspace.
- */
- role?: RoleArn;
- /**
- * The ARN of the S3 bucket where resources associated with the workspace are stored.
- */
- s3Location?: S3Location;
- }
- export interface UpdateWorkspaceResponse {
- /**
- * The date and time of the current update.
- */
- updateDateTime: Timestamp;
- }
- export type Uuid = string;
- export type Value = string;
- export type Values = PropertyValue[];
- export type WorkspaceDeleteMessage = string;
- export type WorkspaceSummaries = WorkspaceSummary[];
- export interface WorkspaceSummary {
- /**
- * The ID of the workspace.
- */
- workspaceId: Id;
- /**
- * The ARN of the workspace.
- */
- arn: TwinMakerArn;
- /**
- * The description of the workspace.
- */
- description?: Description;
- /**
- * A list of services that are linked to the workspace.
- */
- linkedServices?: LinkedServices;
- /**
- * The date and time when the workspace was created.
- */
- creationDateTime: Timestamp;
- /**
- * The date and time when the workspace was last updated.
- */
- updateDateTime: Timestamp;
- }
- /**
- * 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-11-29"|"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 IoTTwinMaker client.
- */
- export import Types = IoTTwinMaker;
- }
- export = IoTTwinMaker;
|