panorama.d.ts 64 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class Panorama extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: Panorama.Types.ClientConfiguration)
  13. config: Config & Panorama.Types.ClientConfiguration;
  14. /**
  15. * Creates an application instance and deploys it to a device.
  16. */
  17. createApplicationInstance(params: Panorama.Types.CreateApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.CreateApplicationInstanceResponse) => void): Request<Panorama.Types.CreateApplicationInstanceResponse, AWSError>;
  18. /**
  19. * Creates an application instance and deploys it to a device.
  20. */
  21. createApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.CreateApplicationInstanceResponse) => void): Request<Panorama.Types.CreateApplicationInstanceResponse, AWSError>;
  22. /**
  23. * Creates a job to run on a device. A job can update a device's software or reboot it.
  24. */
  25. createJobForDevices(params: Panorama.Types.CreateJobForDevicesRequest, callback?: (err: AWSError, data: Panorama.Types.CreateJobForDevicesResponse) => void): Request<Panorama.Types.CreateJobForDevicesResponse, AWSError>;
  26. /**
  27. * Creates a job to run on a device. A job can update a device's software or reboot it.
  28. */
  29. createJobForDevices(callback?: (err: AWSError, data: Panorama.Types.CreateJobForDevicesResponse) => void): Request<Panorama.Types.CreateJobForDevicesResponse, AWSError>;
  30. /**
  31. * Creates a camera stream node.
  32. */
  33. createNodeFromTemplateJob(params: Panorama.Types.CreateNodeFromTemplateJobRequest, callback?: (err: AWSError, data: Panorama.Types.CreateNodeFromTemplateJobResponse) => void): Request<Panorama.Types.CreateNodeFromTemplateJobResponse, AWSError>;
  34. /**
  35. * Creates a camera stream node.
  36. */
  37. createNodeFromTemplateJob(callback?: (err: AWSError, data: Panorama.Types.CreateNodeFromTemplateJobResponse) => void): Request<Panorama.Types.CreateNodeFromTemplateJobResponse, AWSError>;
  38. /**
  39. * Creates a package and storage location in an Amazon S3 access point.
  40. */
  41. createPackage(params: Panorama.Types.CreatePackageRequest, callback?: (err: AWSError, data: Panorama.Types.CreatePackageResponse) => void): Request<Panorama.Types.CreatePackageResponse, AWSError>;
  42. /**
  43. * Creates a package and storage location in an Amazon S3 access point.
  44. */
  45. createPackage(callback?: (err: AWSError, data: Panorama.Types.CreatePackageResponse) => void): Request<Panorama.Types.CreatePackageResponse, AWSError>;
  46. /**
  47. * Imports a node package.
  48. */
  49. createPackageImportJob(params: Panorama.Types.CreatePackageImportJobRequest, callback?: (err: AWSError, data: Panorama.Types.CreatePackageImportJobResponse) => void): Request<Panorama.Types.CreatePackageImportJobResponse, AWSError>;
  50. /**
  51. * Imports a node package.
  52. */
  53. createPackageImportJob(callback?: (err: AWSError, data: Panorama.Types.CreatePackageImportJobResponse) => void): Request<Panorama.Types.CreatePackageImportJobResponse, AWSError>;
  54. /**
  55. * Deletes a device.
  56. */
  57. deleteDevice(params: Panorama.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.DeleteDeviceResponse) => void): Request<Panorama.Types.DeleteDeviceResponse, AWSError>;
  58. /**
  59. * Deletes a device.
  60. */
  61. deleteDevice(callback?: (err: AWSError, data: Panorama.Types.DeleteDeviceResponse) => void): Request<Panorama.Types.DeleteDeviceResponse, AWSError>;
  62. /**
  63. * Deletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
  64. */
  65. deletePackage(params: Panorama.Types.DeletePackageRequest, callback?: (err: AWSError, data: Panorama.Types.DeletePackageResponse) => void): Request<Panorama.Types.DeletePackageResponse, AWSError>;
  66. /**
  67. * Deletes a package. To delete a package, you need permission to call s3:DeleteObject in addition to permissions for the AWS Panorama API.
  68. */
  69. deletePackage(callback?: (err: AWSError, data: Panorama.Types.DeletePackageResponse) => void): Request<Panorama.Types.DeletePackageResponse, AWSError>;
  70. /**
  71. * Deregisters a package version.
  72. */
  73. deregisterPackageVersion(params: Panorama.Types.DeregisterPackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.DeregisterPackageVersionResponse) => void): Request<Panorama.Types.DeregisterPackageVersionResponse, AWSError>;
  74. /**
  75. * Deregisters a package version.
  76. */
  77. deregisterPackageVersion(callback?: (err: AWSError, data: Panorama.Types.DeregisterPackageVersionResponse) => void): Request<Panorama.Types.DeregisterPackageVersionResponse, AWSError>;
  78. /**
  79. * Returns information about an application instance on a device.
  80. */
  81. describeApplicationInstance(params: Panorama.Types.DescribeApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceResponse, AWSError>;
  82. /**
  83. * Returns information about an application instance on a device.
  84. */
  85. describeApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceResponse, AWSError>;
  86. /**
  87. * Returns information about an application instance's configuration manifest.
  88. */
  89. describeApplicationInstanceDetails(params: Panorama.Types.DescribeApplicationInstanceDetailsRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceDetailsResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceDetailsResponse, AWSError>;
  90. /**
  91. * Returns information about an application instance's configuration manifest.
  92. */
  93. describeApplicationInstanceDetails(callback?: (err: AWSError, data: Panorama.Types.DescribeApplicationInstanceDetailsResponse) => void): Request<Panorama.Types.DescribeApplicationInstanceDetailsResponse, AWSError>;
  94. /**
  95. * Returns information about a device.
  96. */
  97. describeDevice(params: Panorama.Types.DescribeDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceResponse) => void): Request<Panorama.Types.DescribeDeviceResponse, AWSError>;
  98. /**
  99. * Returns information about a device.
  100. */
  101. describeDevice(callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceResponse) => void): Request<Panorama.Types.DescribeDeviceResponse, AWSError>;
  102. /**
  103. * Returns information about a device job.
  104. */
  105. describeDeviceJob(params: Panorama.Types.DescribeDeviceJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceJobResponse) => void): Request<Panorama.Types.DescribeDeviceJobResponse, AWSError>;
  106. /**
  107. * Returns information about a device job.
  108. */
  109. describeDeviceJob(callback?: (err: AWSError, data: Panorama.Types.DescribeDeviceJobResponse) => void): Request<Panorama.Types.DescribeDeviceJobResponse, AWSError>;
  110. /**
  111. * Returns information about a node.
  112. */
  113. describeNode(params: Panorama.Types.DescribeNodeRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeNodeResponse) => void): Request<Panorama.Types.DescribeNodeResponse, AWSError>;
  114. /**
  115. * Returns information about a node.
  116. */
  117. describeNode(callback?: (err: AWSError, data: Panorama.Types.DescribeNodeResponse) => void): Request<Panorama.Types.DescribeNodeResponse, AWSError>;
  118. /**
  119. * Returns information about a job to create a camera stream node.
  120. */
  121. describeNodeFromTemplateJob(params: Panorama.Types.DescribeNodeFromTemplateJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribeNodeFromTemplateJobResponse) => void): Request<Panorama.Types.DescribeNodeFromTemplateJobResponse, AWSError>;
  122. /**
  123. * Returns information about a job to create a camera stream node.
  124. */
  125. describeNodeFromTemplateJob(callback?: (err: AWSError, data: Panorama.Types.DescribeNodeFromTemplateJobResponse) => void): Request<Panorama.Types.DescribeNodeFromTemplateJobResponse, AWSError>;
  126. /**
  127. * Returns information about a package.
  128. */
  129. describePackage(params: Panorama.Types.DescribePackageRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageResponse) => void): Request<Panorama.Types.DescribePackageResponse, AWSError>;
  130. /**
  131. * Returns information about a package.
  132. */
  133. describePackage(callback?: (err: AWSError, data: Panorama.Types.DescribePackageResponse) => void): Request<Panorama.Types.DescribePackageResponse, AWSError>;
  134. /**
  135. * Returns information about a package import job.
  136. */
  137. describePackageImportJob(params: Panorama.Types.DescribePackageImportJobRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageImportJobResponse) => void): Request<Panorama.Types.DescribePackageImportJobResponse, AWSError>;
  138. /**
  139. * Returns information about a package import job.
  140. */
  141. describePackageImportJob(callback?: (err: AWSError, data: Panorama.Types.DescribePackageImportJobResponse) => void): Request<Panorama.Types.DescribePackageImportJobResponse, AWSError>;
  142. /**
  143. * Returns information about a package version.
  144. */
  145. describePackageVersion(params: Panorama.Types.DescribePackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.DescribePackageVersionResponse) => void): Request<Panorama.Types.DescribePackageVersionResponse, AWSError>;
  146. /**
  147. * Returns information about a package version.
  148. */
  149. describePackageVersion(callback?: (err: AWSError, data: Panorama.Types.DescribePackageVersionResponse) => void): Request<Panorama.Types.DescribePackageVersionResponse, AWSError>;
  150. /**
  151. * Returns a list of application instance dependencies.
  152. */
  153. listApplicationInstanceDependencies(params: Panorama.Types.ListApplicationInstanceDependenciesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceDependenciesResponse) => void): Request<Panorama.Types.ListApplicationInstanceDependenciesResponse, AWSError>;
  154. /**
  155. * Returns a list of application instance dependencies.
  156. */
  157. listApplicationInstanceDependencies(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceDependenciesResponse) => void): Request<Panorama.Types.ListApplicationInstanceDependenciesResponse, AWSError>;
  158. /**
  159. * Returns a list of application node instances.
  160. */
  161. listApplicationInstanceNodeInstances(params: Panorama.Types.ListApplicationInstanceNodeInstancesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstanceNodeInstancesResponse, AWSError>;
  162. /**
  163. * Returns a list of application node instances.
  164. */
  165. listApplicationInstanceNodeInstances(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstanceNodeInstancesResponse, AWSError>;
  166. /**
  167. * Returns a list of application instances.
  168. */
  169. listApplicationInstances(params: Panorama.Types.ListApplicationInstancesRequest, callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstancesResponse, AWSError>;
  170. /**
  171. * Returns a list of application instances.
  172. */
  173. listApplicationInstances(callback?: (err: AWSError, data: Panorama.Types.ListApplicationInstancesResponse) => void): Request<Panorama.Types.ListApplicationInstancesResponse, AWSError>;
  174. /**
  175. * Returns a list of devices.
  176. */
  177. listDevices(params: Panorama.Types.ListDevicesRequest, callback?: (err: AWSError, data: Panorama.Types.ListDevicesResponse) => void): Request<Panorama.Types.ListDevicesResponse, AWSError>;
  178. /**
  179. * Returns a list of devices.
  180. */
  181. listDevices(callback?: (err: AWSError, data: Panorama.Types.ListDevicesResponse) => void): Request<Panorama.Types.ListDevicesResponse, AWSError>;
  182. /**
  183. * Returns a list of jobs.
  184. */
  185. listDevicesJobs(params: Panorama.Types.ListDevicesJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListDevicesJobsResponse) => void): Request<Panorama.Types.ListDevicesJobsResponse, AWSError>;
  186. /**
  187. * Returns a list of jobs.
  188. */
  189. listDevicesJobs(callback?: (err: AWSError, data: Panorama.Types.ListDevicesJobsResponse) => void): Request<Panorama.Types.ListDevicesJobsResponse, AWSError>;
  190. /**
  191. * Returns a list of camera stream node jobs.
  192. */
  193. listNodeFromTemplateJobs(params: Panorama.Types.ListNodeFromTemplateJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListNodeFromTemplateJobsResponse) => void): Request<Panorama.Types.ListNodeFromTemplateJobsResponse, AWSError>;
  194. /**
  195. * Returns a list of camera stream node jobs.
  196. */
  197. listNodeFromTemplateJobs(callback?: (err: AWSError, data: Panorama.Types.ListNodeFromTemplateJobsResponse) => void): Request<Panorama.Types.ListNodeFromTemplateJobsResponse, AWSError>;
  198. /**
  199. * Returns a list of nodes.
  200. */
  201. listNodes(params: Panorama.Types.ListNodesRequest, callback?: (err: AWSError, data: Panorama.Types.ListNodesResponse) => void): Request<Panorama.Types.ListNodesResponse, AWSError>;
  202. /**
  203. * Returns a list of nodes.
  204. */
  205. listNodes(callback?: (err: AWSError, data: Panorama.Types.ListNodesResponse) => void): Request<Panorama.Types.ListNodesResponse, AWSError>;
  206. /**
  207. * Returns a list of package import jobs.
  208. */
  209. listPackageImportJobs(params: Panorama.Types.ListPackageImportJobsRequest, callback?: (err: AWSError, data: Panorama.Types.ListPackageImportJobsResponse) => void): Request<Panorama.Types.ListPackageImportJobsResponse, AWSError>;
  210. /**
  211. * Returns a list of package import jobs.
  212. */
  213. listPackageImportJobs(callback?: (err: AWSError, data: Panorama.Types.ListPackageImportJobsResponse) => void): Request<Panorama.Types.ListPackageImportJobsResponse, AWSError>;
  214. /**
  215. * Returns a list of packages.
  216. */
  217. listPackages(params: Panorama.Types.ListPackagesRequest, callback?: (err: AWSError, data: Panorama.Types.ListPackagesResponse) => void): Request<Panorama.Types.ListPackagesResponse, AWSError>;
  218. /**
  219. * Returns a list of packages.
  220. */
  221. listPackages(callback?: (err: AWSError, data: Panorama.Types.ListPackagesResponse) => void): Request<Panorama.Types.ListPackagesResponse, AWSError>;
  222. /**
  223. * Returns a list of tags for a resource.
  224. */
  225. listTagsForResource(params: Panorama.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Panorama.Types.ListTagsForResourceResponse) => void): Request<Panorama.Types.ListTagsForResourceResponse, AWSError>;
  226. /**
  227. * Returns a list of tags for a resource.
  228. */
  229. listTagsForResource(callback?: (err: AWSError, data: Panorama.Types.ListTagsForResourceResponse) => void): Request<Panorama.Types.ListTagsForResourceResponse, AWSError>;
  230. /**
  231. * Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.
  232. */
  233. provisionDevice(params: Panorama.Types.ProvisionDeviceRequest, callback?: (err: AWSError, data: Panorama.Types.ProvisionDeviceResponse) => void): Request<Panorama.Types.ProvisionDeviceResponse, AWSError>;
  234. /**
  235. * Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_device-name.zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.
  236. */
  237. provisionDevice(callback?: (err: AWSError, data: Panorama.Types.ProvisionDeviceResponse) => void): Request<Panorama.Types.ProvisionDeviceResponse, AWSError>;
  238. /**
  239. * Registers a package version.
  240. */
  241. registerPackageVersion(params: Panorama.Types.RegisterPackageVersionRequest, callback?: (err: AWSError, data: Panorama.Types.RegisterPackageVersionResponse) => void): Request<Panorama.Types.RegisterPackageVersionResponse, AWSError>;
  242. /**
  243. * Registers a package version.
  244. */
  245. registerPackageVersion(callback?: (err: AWSError, data: Panorama.Types.RegisterPackageVersionResponse) => void): Request<Panorama.Types.RegisterPackageVersionResponse, AWSError>;
  246. /**
  247. * Removes an application instance.
  248. */
  249. removeApplicationInstance(params: Panorama.Types.RemoveApplicationInstanceRequest, callback?: (err: AWSError, data: Panorama.Types.RemoveApplicationInstanceResponse) => void): Request<Panorama.Types.RemoveApplicationInstanceResponse, AWSError>;
  250. /**
  251. * Removes an application instance.
  252. */
  253. removeApplicationInstance(callback?: (err: AWSError, data: Panorama.Types.RemoveApplicationInstanceResponse) => void): Request<Panorama.Types.RemoveApplicationInstanceResponse, AWSError>;
  254. /**
  255. * Signal camera nodes to stop or resume.
  256. */
  257. signalApplicationInstanceNodeInstances(params: Panorama.Types.SignalApplicationInstanceNodeInstancesRequest, callback?: (err: AWSError, data: Panorama.Types.SignalApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.SignalApplicationInstanceNodeInstancesResponse, AWSError>;
  258. /**
  259. * Signal camera nodes to stop or resume.
  260. */
  261. signalApplicationInstanceNodeInstances(callback?: (err: AWSError, data: Panorama.Types.SignalApplicationInstanceNodeInstancesResponse) => void): Request<Panorama.Types.SignalApplicationInstanceNodeInstancesResponse, AWSError>;
  262. /**
  263. * Tags a resource.
  264. */
  265. tagResource(params: Panorama.Types.TagResourceRequest, callback?: (err: AWSError, data: Panorama.Types.TagResourceResponse) => void): Request<Panorama.Types.TagResourceResponse, AWSError>;
  266. /**
  267. * Tags a resource.
  268. */
  269. tagResource(callback?: (err: AWSError, data: Panorama.Types.TagResourceResponse) => void): Request<Panorama.Types.TagResourceResponse, AWSError>;
  270. /**
  271. * Removes tags from a resource.
  272. */
  273. untagResource(params: Panorama.Types.UntagResourceRequest, callback?: (err: AWSError, data: Panorama.Types.UntagResourceResponse) => void): Request<Panorama.Types.UntagResourceResponse, AWSError>;
  274. /**
  275. * Removes tags from a resource.
  276. */
  277. untagResource(callback?: (err: AWSError, data: Panorama.Types.UntagResourceResponse) => void): Request<Panorama.Types.UntagResourceResponse, AWSError>;
  278. /**
  279. * Updates a device's metadata.
  280. */
  281. updateDeviceMetadata(params: Panorama.Types.UpdateDeviceMetadataRequest, callback?: (err: AWSError, data: Panorama.Types.UpdateDeviceMetadataResponse) => void): Request<Panorama.Types.UpdateDeviceMetadataResponse, AWSError>;
  282. /**
  283. * Updates a device's metadata.
  284. */
  285. updateDeviceMetadata(callback?: (err: AWSError, data: Panorama.Types.UpdateDeviceMetadataResponse) => void): Request<Panorama.Types.UpdateDeviceMetadataResponse, AWSError>;
  286. }
  287. declare namespace Panorama {
  288. export interface AlternateSoftwareMetadata {
  289. /**
  290. * The appliance software version.
  291. */
  292. Version?: Version;
  293. }
  294. export type AlternateSoftwares = AlternateSoftwareMetadata[];
  295. export interface ApplicationInstance {
  296. /**
  297. * The application instance's ID.
  298. */
  299. ApplicationInstanceId?: ApplicationInstanceId;
  300. /**
  301. * The application instance's ARN.
  302. */
  303. Arn?: ApplicationInstanceArn;
  304. /**
  305. * When the application instance was created.
  306. */
  307. CreatedTime?: TimeStamp;
  308. /**
  309. * The device's ID.
  310. */
  311. DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
  312. /**
  313. * The device's name.
  314. */
  315. DefaultRuntimeContextDeviceName?: DeviceName;
  316. /**
  317. * The application instance's description.
  318. */
  319. Description?: Description;
  320. /**
  321. * The application instance's health status.
  322. */
  323. HealthStatus?: ApplicationInstanceHealthStatus;
  324. /**
  325. * The application instance's name.
  326. */
  327. Name?: ApplicationInstanceName;
  328. /**
  329. * The application's state.
  330. */
  331. RuntimeContextStates?: ReportedRuntimeContextStates;
  332. /**
  333. * The application instance's status.
  334. */
  335. Status?: ApplicationInstanceStatus;
  336. /**
  337. * The application instance's status description.
  338. */
  339. StatusDescription?: ApplicationInstanceStatusDescription;
  340. /**
  341. * The application instance's tags.
  342. */
  343. Tags?: TagMap;
  344. }
  345. export type ApplicationInstanceArn = string;
  346. export type ApplicationInstanceHealthStatus = "RUNNING"|"ERROR"|"NOT_AVAILABLE"|string;
  347. export type ApplicationInstanceId = string;
  348. export type ApplicationInstanceName = string;
  349. export type ApplicationInstanceStatus = "DEPLOYMENT_PENDING"|"DEPLOYMENT_REQUESTED"|"DEPLOYMENT_IN_PROGRESS"|"DEPLOYMENT_ERROR"|"DEPLOYMENT_SUCCEEDED"|"REMOVAL_PENDING"|"REMOVAL_REQUESTED"|"REMOVAL_IN_PROGRESS"|"REMOVAL_FAILED"|"REMOVAL_SUCCEEDED"|"DEPLOYMENT_FAILED"|string;
  350. export type ApplicationInstanceStatusDescription = string;
  351. export type ApplicationInstances = ApplicationInstance[];
  352. export type Boolean = boolean;
  353. export type Bucket = string;
  354. export type BucketName = string;
  355. export type Certificates = Buffer|Uint8Array|Blob|string;
  356. export type ClientToken = string;
  357. export type ConnectionType = "STATIC_IP"|"DHCP"|string;
  358. export interface CreateApplicationInstanceRequest {
  359. /**
  360. * The ID of an application instance to replace with the new instance.
  361. */
  362. ApplicationInstanceIdToReplace?: ApplicationInstanceId;
  363. /**
  364. * A device's ID.
  365. */
  366. DefaultRuntimeContextDevice: DefaultRuntimeContextDevice;
  367. /**
  368. * A description for the application instance.
  369. */
  370. Description?: Description;
  371. /**
  372. * Setting overrides for the application manifest.
  373. */
  374. ManifestOverridesPayload?: ManifestOverridesPayload;
  375. /**
  376. * The application's manifest document.
  377. */
  378. ManifestPayload: ManifestPayload;
  379. /**
  380. * A name for the application instance.
  381. */
  382. Name?: ApplicationInstanceName;
  383. /**
  384. * The ARN of a runtime role for the application instance.
  385. */
  386. RuntimeRoleArn?: RuntimeRoleArn;
  387. /**
  388. * Tags for the application instance.
  389. */
  390. Tags?: TagMap;
  391. }
  392. export interface CreateApplicationInstanceResponse {
  393. /**
  394. * The application instance's ID.
  395. */
  396. ApplicationInstanceId: ApplicationInstanceId;
  397. }
  398. export interface CreateJobForDevicesRequest {
  399. /**
  400. * ID of target device.
  401. */
  402. DeviceIds: DeviceIdList;
  403. /**
  404. * Configuration settings for a software update job.
  405. */
  406. DeviceJobConfig?: DeviceJobConfig;
  407. /**
  408. * The type of job to run.
  409. */
  410. JobType: JobType;
  411. }
  412. export interface CreateJobForDevicesResponse {
  413. /**
  414. * A list of jobs.
  415. */
  416. Jobs: JobList;
  417. }
  418. export interface CreateNodeFromTemplateJobRequest {
  419. /**
  420. * Tags for the job.
  421. */
  422. JobTags?: JobTagsList;
  423. /**
  424. * A description for the node.
  425. */
  426. NodeDescription?: Description;
  427. /**
  428. * A name for the node.
  429. */
  430. NodeName: NodeName;
  431. /**
  432. * An output package name for the node.
  433. */
  434. OutputPackageName: NodePackageName;
  435. /**
  436. * An output package version for the node.
  437. */
  438. OutputPackageVersion: NodePackageVersion;
  439. /**
  440. * Template parameters for the node.
  441. */
  442. TemplateParameters: TemplateParametersMap;
  443. /**
  444. * The type of node.
  445. */
  446. TemplateType: TemplateType;
  447. }
  448. export interface CreateNodeFromTemplateJobResponse {
  449. /**
  450. * The job's ID.
  451. */
  452. JobId: JobId;
  453. }
  454. export interface CreatePackageImportJobRequest {
  455. /**
  456. * A client token for the package import job.
  457. */
  458. ClientToken: ClientToken;
  459. /**
  460. * An input config for the package import job.
  461. */
  462. InputConfig: PackageImportJobInputConfig;
  463. /**
  464. * Tags for the package import job.
  465. */
  466. JobTags?: JobTagsList;
  467. /**
  468. * A job type for the package import job.
  469. */
  470. JobType: PackageImportJobType;
  471. /**
  472. * An output config for the package import job.
  473. */
  474. OutputConfig: PackageImportJobOutputConfig;
  475. }
  476. export interface CreatePackageImportJobResponse {
  477. /**
  478. * The job's ID.
  479. */
  480. JobId: JobId;
  481. }
  482. export interface CreatePackageRequest {
  483. /**
  484. * A name for the package.
  485. */
  486. PackageName: NodePackageName;
  487. /**
  488. * Tags for the package.
  489. */
  490. Tags?: TagMap;
  491. }
  492. export interface CreatePackageResponse {
  493. /**
  494. * The package's ARN.
  495. */
  496. Arn?: NodePackageArn;
  497. /**
  498. * The package's ID.
  499. */
  500. PackageId?: NodePackageId;
  501. /**
  502. * The package's storage location.
  503. */
  504. StorageLocation: StorageLocation;
  505. }
  506. export type CreatedTime = Date;
  507. export type CurrentSoftware = string;
  508. export type DefaultGateway = string;
  509. export type DefaultRuntimeContextDevice = string;
  510. export interface DeleteDeviceRequest {
  511. /**
  512. * The device's ID.
  513. */
  514. DeviceId: DeviceId;
  515. }
  516. export interface DeleteDeviceResponse {
  517. /**
  518. * The device's ID.
  519. */
  520. DeviceId?: DeviceId;
  521. }
  522. export interface DeletePackageRequest {
  523. /**
  524. * Delete the package even if it has artifacts stored in its access point. Deletes the package's artifacts from Amazon S3.
  525. */
  526. ForceDelete?: Boolean;
  527. /**
  528. * The package's ID.
  529. */
  530. PackageId: NodePackageId;
  531. }
  532. export interface DeletePackageResponse {
  533. }
  534. export interface DeregisterPackageVersionRequest {
  535. /**
  536. * An owner account.
  537. */
  538. OwnerAccount?: PackageOwnerAccount;
  539. /**
  540. * A package ID.
  541. */
  542. PackageId: NodePackageId;
  543. /**
  544. * A package version.
  545. */
  546. PackageVersion: NodePackageVersion;
  547. /**
  548. * A patch version.
  549. */
  550. PatchVersion: NodePackagePatchVersion;
  551. /**
  552. * If the version was marked latest, the new version to maker as latest.
  553. */
  554. UpdatedLatestPatchVersion?: NodePackagePatchVersion;
  555. }
  556. export interface DeregisterPackageVersionResponse {
  557. }
  558. export interface DescribeApplicationInstanceDetailsRequest {
  559. /**
  560. * The application instance's ID.
  561. */
  562. ApplicationInstanceId: ApplicationInstanceId;
  563. }
  564. export interface DescribeApplicationInstanceDetailsResponse {
  565. /**
  566. * The application instance's ID.
  567. */
  568. ApplicationInstanceId?: ApplicationInstanceId;
  569. /**
  570. * The ID of the application instance that this instance replaced.
  571. */
  572. ApplicationInstanceIdToReplace?: ApplicationInstanceId;
  573. /**
  574. * When the application instance was created.
  575. */
  576. CreatedTime?: TimeStamp;
  577. /**
  578. * The application instance's default runtime context device.
  579. */
  580. DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
  581. /**
  582. * The application instance's description.
  583. */
  584. Description?: Description;
  585. /**
  586. * Parameter overrides for the configuration manifest.
  587. */
  588. ManifestOverridesPayload?: ManifestOverridesPayload;
  589. /**
  590. * The application instance's configuration manifest.
  591. */
  592. ManifestPayload?: ManifestPayload;
  593. /**
  594. * The application instance's name.
  595. */
  596. Name?: ApplicationInstanceName;
  597. }
  598. export interface DescribeApplicationInstanceRequest {
  599. /**
  600. * The application instance's ID.
  601. */
  602. ApplicationInstanceId: ApplicationInstanceId;
  603. }
  604. export interface DescribeApplicationInstanceResponse {
  605. /**
  606. * The application instance's ID.
  607. */
  608. ApplicationInstanceId?: ApplicationInstanceId;
  609. /**
  610. * The ID of the application instance that this instance replaced.
  611. */
  612. ApplicationInstanceIdToReplace?: ApplicationInstanceId;
  613. /**
  614. * The application instance's ARN.
  615. */
  616. Arn?: ApplicationInstanceArn;
  617. /**
  618. * When the application instance was created.
  619. */
  620. CreatedTime?: TimeStamp;
  621. /**
  622. * The device's ID.
  623. */
  624. DefaultRuntimeContextDevice?: DefaultRuntimeContextDevice;
  625. /**
  626. * The device's bane.
  627. */
  628. DefaultRuntimeContextDeviceName?: DeviceName;
  629. /**
  630. * The application instance's description.
  631. */
  632. Description?: Description;
  633. /**
  634. * The application instance's health status.
  635. */
  636. HealthStatus?: ApplicationInstanceHealthStatus;
  637. /**
  638. * The application instance was updated.
  639. */
  640. LastUpdatedTime?: TimeStamp;
  641. /**
  642. * The application instance's name.
  643. */
  644. Name?: ApplicationInstanceName;
  645. /**
  646. * The application instance's state.
  647. */
  648. RuntimeContextStates?: ReportedRuntimeContextStates;
  649. /**
  650. * The application instance's runtime role ARN.
  651. */
  652. RuntimeRoleArn?: RuntimeRoleArn;
  653. /**
  654. * The application instance's status.
  655. */
  656. Status?: ApplicationInstanceStatus;
  657. /**
  658. * The application instance's status description.
  659. */
  660. StatusDescription?: ApplicationInstanceStatusDescription;
  661. /**
  662. * The application instance's tags.
  663. */
  664. Tags?: TagMap;
  665. }
  666. export interface DescribeDeviceJobRequest {
  667. /**
  668. * The job's ID.
  669. */
  670. JobId: JobId;
  671. }
  672. export interface DescribeDeviceJobResponse {
  673. /**
  674. * When the job was created.
  675. */
  676. CreatedTime?: UpdateCreatedTime;
  677. /**
  678. * The device's ARN.
  679. */
  680. DeviceArn?: DeviceArn;
  681. /**
  682. * The device's ID.
  683. */
  684. DeviceId?: DeviceId;
  685. /**
  686. * The device's name.
  687. */
  688. DeviceName?: DeviceName;
  689. /**
  690. * The device's type.
  691. */
  692. DeviceType?: DeviceType;
  693. /**
  694. * For an OTA job, the target version of the device software.
  695. */
  696. ImageVersion?: ImageVersion;
  697. /**
  698. * The job's ID.
  699. */
  700. JobId?: JobId;
  701. /**
  702. * The job's type.
  703. */
  704. JobType?: JobType;
  705. /**
  706. * The job's status.
  707. */
  708. Status?: UpdateProgress;
  709. }
  710. export interface DescribeDeviceRequest {
  711. /**
  712. * The device's ID.
  713. */
  714. DeviceId: DeviceId;
  715. }
  716. export interface DescribeDeviceResponse {
  717. /**
  718. * Beta software releases available for the device.
  719. */
  720. AlternateSoftwares?: AlternateSoftwares;
  721. /**
  722. * The device's ARN.
  723. */
  724. Arn?: DeviceArn;
  725. /**
  726. * The device's maker.
  727. */
  728. Brand?: DeviceBrand;
  729. /**
  730. * When the device was created.
  731. */
  732. CreatedTime?: CreatedTime;
  733. /**
  734. * The device's networking status.
  735. */
  736. CurrentNetworkingStatus?: NetworkStatus;
  737. /**
  738. * The device's current software version.
  739. */
  740. CurrentSoftware?: CurrentSoftware;
  741. /**
  742. * The device's description.
  743. */
  744. Description?: Description;
  745. /**
  746. * A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
  747. */
  748. DeviceAggregatedStatus?: DeviceAggregatedStatus;
  749. /**
  750. * The device's connection status.
  751. */
  752. DeviceConnectionStatus?: DeviceConnectionStatus;
  753. /**
  754. * The device's ID.
  755. */
  756. DeviceId?: DeviceId;
  757. /**
  758. * The most recent beta software release.
  759. */
  760. LatestAlternateSoftware?: LatestAlternateSoftware;
  761. /**
  762. * A device's latest job. Includes the target image version, and the job status.
  763. */
  764. LatestDeviceJob?: LatestDeviceJob;
  765. /**
  766. * The latest software version available for the device.
  767. */
  768. LatestSoftware?: LatestSoftware;
  769. /**
  770. * The device's lease expiration time.
  771. */
  772. LeaseExpirationTime?: LeaseExpirationTime;
  773. /**
  774. * The device's name.
  775. */
  776. Name?: DeviceName;
  777. /**
  778. * The device's networking configuration.
  779. */
  780. NetworkingConfiguration?: NetworkPayload;
  781. /**
  782. * The device's provisioning status.
  783. */
  784. ProvisioningStatus?: DeviceStatus;
  785. /**
  786. * The device's serial number.
  787. */
  788. SerialNumber?: DeviceSerialNumber;
  789. /**
  790. * The device's tags.
  791. */
  792. Tags?: TagMap;
  793. /**
  794. * The device's type.
  795. */
  796. Type?: DeviceType;
  797. }
  798. export interface DescribeNodeFromTemplateJobRequest {
  799. /**
  800. * The job's ID.
  801. */
  802. JobId: JobId;
  803. }
  804. export interface DescribeNodeFromTemplateJobResponse {
  805. /**
  806. * When the job was created.
  807. */
  808. CreatedTime: CreatedTime;
  809. /**
  810. * The job's ID.
  811. */
  812. JobId: JobId;
  813. /**
  814. * The job's tags.
  815. */
  816. JobTags?: JobTagsList;
  817. /**
  818. * When the job was updated.
  819. */
  820. LastUpdatedTime: LastUpdatedTime;
  821. /**
  822. * The node's description.
  823. */
  824. NodeDescription?: Description;
  825. /**
  826. * The node's name.
  827. */
  828. NodeName: NodeName;
  829. /**
  830. * The job's output package name.
  831. */
  832. OutputPackageName: NodePackageName;
  833. /**
  834. * The job's output package version.
  835. */
  836. OutputPackageVersion: NodePackageVersion;
  837. /**
  838. * The job's status.
  839. */
  840. Status: NodeFromTemplateJobStatus;
  841. /**
  842. * The job's status message.
  843. */
  844. StatusMessage: NodeFromTemplateJobStatusMessage;
  845. /**
  846. * The job's template parameters.
  847. */
  848. TemplateParameters: TemplateParametersMap;
  849. /**
  850. * The job's template type.
  851. */
  852. TemplateType: TemplateType;
  853. }
  854. export interface DescribeNodeRequest {
  855. /**
  856. * The node's ID.
  857. */
  858. NodeId: NodeId;
  859. /**
  860. * The account ID of the node's owner.
  861. */
  862. OwnerAccount?: PackageOwnerAccount;
  863. }
  864. export interface DescribeNodeResponse {
  865. /**
  866. * The node's asset name.
  867. */
  868. AssetName?: NodeAssetName;
  869. /**
  870. * The node's category.
  871. */
  872. Category: NodeCategory;
  873. /**
  874. * When the node was created.
  875. */
  876. CreatedTime: TimeStamp;
  877. /**
  878. * The node's description.
  879. */
  880. Description: Description;
  881. /**
  882. * When the node was updated.
  883. */
  884. LastUpdatedTime: TimeStamp;
  885. /**
  886. * The node's name.
  887. */
  888. Name: NodeName;
  889. /**
  890. * The node's ID.
  891. */
  892. NodeId: NodeId;
  893. /**
  894. * The node's interface.
  895. */
  896. NodeInterface: NodeInterface;
  897. /**
  898. * The account ID of the node's owner.
  899. */
  900. OwnerAccount: PackageOwnerAccount;
  901. /**
  902. * The node's ARN.
  903. */
  904. PackageArn?: NodePackageArn;
  905. /**
  906. * The node's package ID.
  907. */
  908. PackageId: NodePackageId;
  909. /**
  910. * The node's package name.
  911. */
  912. PackageName: NodePackageName;
  913. /**
  914. * The node's package version.
  915. */
  916. PackageVersion: NodePackageVersion;
  917. /**
  918. * The node's patch version.
  919. */
  920. PatchVersion: NodePackagePatchVersion;
  921. }
  922. export interface DescribePackageImportJobRequest {
  923. /**
  924. * The job's ID.
  925. */
  926. JobId: JobId;
  927. }
  928. export interface DescribePackageImportJobResponse {
  929. /**
  930. * The job's client token.
  931. */
  932. ClientToken?: ClientToken;
  933. /**
  934. * When the job was created.
  935. */
  936. CreatedTime: CreatedTime;
  937. /**
  938. * The job's input config.
  939. */
  940. InputConfig: PackageImportJobInputConfig;
  941. /**
  942. * The job's ID.
  943. */
  944. JobId: JobId;
  945. /**
  946. * The job's tags.
  947. */
  948. JobTags?: JobTagsList;
  949. /**
  950. * The job's type.
  951. */
  952. JobType: PackageImportJobType;
  953. /**
  954. * When the job was updated.
  955. */
  956. LastUpdatedTime: LastUpdatedTime;
  957. /**
  958. * The job's output.
  959. */
  960. Output: PackageImportJobOutput;
  961. /**
  962. * The job's output config.
  963. */
  964. OutputConfig: PackageImportJobOutputConfig;
  965. /**
  966. * The job's status.
  967. */
  968. Status: PackageImportJobStatus;
  969. /**
  970. * The job's status message.
  971. */
  972. StatusMessage: PackageImportJobStatusMessage;
  973. }
  974. export interface DescribePackageRequest {
  975. /**
  976. * The package's ID.
  977. */
  978. PackageId: NodePackageId;
  979. }
  980. export interface DescribePackageResponse {
  981. /**
  982. * The package's ARN.
  983. */
  984. Arn: NodePackageArn;
  985. /**
  986. * When the package was created.
  987. */
  988. CreatedTime: TimeStamp;
  989. /**
  990. * The package's ID.
  991. */
  992. PackageId: NodePackageId;
  993. /**
  994. * The package's name.
  995. */
  996. PackageName: NodePackageName;
  997. /**
  998. * ARNs of accounts that have read access to the package.
  999. */
  1000. ReadAccessPrincipalArns?: PrincipalArnsList;
  1001. /**
  1002. * The package's storage location.
  1003. */
  1004. StorageLocation: StorageLocation;
  1005. /**
  1006. * The package's tags.
  1007. */
  1008. Tags: TagMap;
  1009. /**
  1010. * ARNs of accounts that have write access to the package.
  1011. */
  1012. WriteAccessPrincipalArns?: PrincipalArnsList;
  1013. }
  1014. export interface DescribePackageVersionRequest {
  1015. /**
  1016. * The version's owner account.
  1017. */
  1018. OwnerAccount?: PackageOwnerAccount;
  1019. /**
  1020. * The version's ID.
  1021. */
  1022. PackageId: NodePackageId;
  1023. /**
  1024. * The version's version.
  1025. */
  1026. PackageVersion: NodePackageVersion;
  1027. /**
  1028. * The version's patch version.
  1029. */
  1030. PatchVersion?: NodePackagePatchVersion;
  1031. }
  1032. export interface DescribePackageVersionResponse {
  1033. /**
  1034. * Whether the version is the latest available.
  1035. */
  1036. IsLatestPatch: Boolean;
  1037. /**
  1038. * The account ID of the version's owner.
  1039. */
  1040. OwnerAccount?: PackageOwnerAccount;
  1041. /**
  1042. * The ARN of the package.
  1043. */
  1044. PackageArn?: NodePackageArn;
  1045. /**
  1046. * The version's ID.
  1047. */
  1048. PackageId: NodePackageId;
  1049. /**
  1050. * The version's name.
  1051. */
  1052. PackageName: NodePackageName;
  1053. /**
  1054. * The version's version.
  1055. */
  1056. PackageVersion: NodePackageVersion;
  1057. /**
  1058. * The version's patch version.
  1059. */
  1060. PatchVersion: NodePackagePatchVersion;
  1061. /**
  1062. * The version's registered time.
  1063. */
  1064. RegisteredTime?: TimeStamp;
  1065. /**
  1066. * The version's status.
  1067. */
  1068. Status: PackageVersionStatus;
  1069. /**
  1070. * The version's status description.
  1071. */
  1072. StatusDescription?: PackageVersionStatusDescription;
  1073. }
  1074. export type Description = string;
  1075. export type DesiredState = "RUNNING"|"STOPPED"|"REMOVED"|string;
  1076. export interface Device {
  1077. /**
  1078. * The device's maker.
  1079. */
  1080. Brand?: DeviceBrand;
  1081. /**
  1082. * When the device was created.
  1083. */
  1084. CreatedTime?: CreatedTime;
  1085. /**
  1086. * A device's current software.
  1087. */
  1088. CurrentSoftware?: CurrentSoftware;
  1089. /**
  1090. * A description for the device.
  1091. */
  1092. Description?: Description;
  1093. /**
  1094. * A device's aggregated status. Including the device's connection status, provisioning status, and lease status.
  1095. */
  1096. DeviceAggregatedStatus?: DeviceAggregatedStatus;
  1097. /**
  1098. * The device's ID.
  1099. */
  1100. DeviceId?: DeviceId;
  1101. /**
  1102. * When the device was updated.
  1103. */
  1104. LastUpdatedTime?: LastUpdatedTime;
  1105. /**
  1106. * A device's latest job. Includes the target image version, and the update job status.
  1107. */
  1108. LatestDeviceJob?: LatestDeviceJob;
  1109. /**
  1110. * The device's lease expiration time.
  1111. */
  1112. LeaseExpirationTime?: LeaseExpirationTime;
  1113. /**
  1114. * The device's name.
  1115. */
  1116. Name?: DeviceName;
  1117. /**
  1118. * The device's provisioning status.
  1119. */
  1120. ProvisioningStatus?: DeviceStatus;
  1121. /**
  1122. * The device's tags.
  1123. */
  1124. Tags?: TagMap;
  1125. /**
  1126. * The device's type.
  1127. */
  1128. Type?: DeviceType;
  1129. }
  1130. export type DeviceAggregatedStatus = "ERROR"|"AWAITING_PROVISIONING"|"PENDING"|"FAILED"|"DELETING"|"ONLINE"|"OFFLINE"|"LEASE_EXPIRED"|"UPDATE_NEEDED"|"REBOOTING"|string;
  1131. export type DeviceArn = string;
  1132. export type DeviceBrand = "AWS_PANORAMA"|"LENOVO"|string;
  1133. export type DeviceConnectionStatus = "ONLINE"|"OFFLINE"|"AWAITING_CREDENTIALS"|"NOT_AVAILABLE"|"ERROR"|string;
  1134. export type DeviceId = string;
  1135. export type DeviceIdList = DeviceId[];
  1136. export interface DeviceJob {
  1137. /**
  1138. * When the job was created.
  1139. */
  1140. CreatedTime?: CreatedTime;
  1141. /**
  1142. * The ID of the target device.
  1143. */
  1144. DeviceId?: DeviceId;
  1145. /**
  1146. * The name of the target device
  1147. */
  1148. DeviceName?: DeviceName;
  1149. /**
  1150. * The job's ID.
  1151. */
  1152. JobId?: JobId;
  1153. /**
  1154. * The job's type.
  1155. */
  1156. JobType?: JobType;
  1157. }
  1158. export interface DeviceJobConfig {
  1159. /**
  1160. * A configuration for an over-the-air (OTA) upgrade. Required for OTA jobs.
  1161. */
  1162. OTAJobConfig?: OTAJobConfig;
  1163. }
  1164. export type DeviceJobList = DeviceJob[];
  1165. export type DeviceList = Device[];
  1166. export type DeviceName = string;
  1167. export type DeviceReportedStatus = "STOPPING"|"STOPPED"|"STOP_ERROR"|"REMOVAL_FAILED"|"REMOVAL_IN_PROGRESS"|"STARTING"|"RUNNING"|"INSTALL_ERROR"|"LAUNCHED"|"LAUNCH_ERROR"|"INSTALL_IN_PROGRESS"|string;
  1168. export type DeviceSerialNumber = string;
  1169. export type DeviceStatus = "AWAITING_PROVISIONING"|"PENDING"|"SUCCEEDED"|"FAILED"|"ERROR"|"DELETING"|string;
  1170. export type DeviceType = "PANORAMA_APPLIANCE_DEVELOPER_KIT"|"PANORAMA_APPLIANCE"|string;
  1171. export type Dns = string;
  1172. export type DnsList = Dns[];
  1173. export interface EthernetPayload {
  1174. /**
  1175. * How the device gets an IP address.
  1176. */
  1177. ConnectionType: ConnectionType;
  1178. /**
  1179. * Network configuration for a static IP connection.
  1180. */
  1181. StaticIpConnectionInfo?: StaticIpConnectionInfo;
  1182. }
  1183. export interface EthernetStatus {
  1184. /**
  1185. * The device's connection status.
  1186. */
  1187. ConnectionStatus?: NetworkConnectionStatus;
  1188. /**
  1189. * The device's physical address.
  1190. */
  1191. HwAddress?: HwAddress;
  1192. /**
  1193. * The device's IP address.
  1194. */
  1195. IpAddress?: IpAddress;
  1196. }
  1197. export type HwAddress = string;
  1198. export type ImageVersion = string;
  1199. export type InputPortList = NodeInputPort[];
  1200. export type IotThingName = string;
  1201. export type IpAddress = string;
  1202. export type IpAddressOrServerName = string;
  1203. export interface Job {
  1204. /**
  1205. * The target device's ID.
  1206. */
  1207. DeviceId?: DeviceId;
  1208. /**
  1209. * The job's ID.
  1210. */
  1211. JobId?: JobId;
  1212. }
  1213. export type JobId = string;
  1214. export type JobList = Job[];
  1215. export interface JobResourceTags {
  1216. /**
  1217. * The job's type.
  1218. */
  1219. ResourceType: JobResourceType;
  1220. /**
  1221. * The job's tags.
  1222. */
  1223. Tags: TagMap;
  1224. }
  1225. export type JobResourceType = "PACKAGE"|string;
  1226. export type JobTagsList = JobResourceTags[];
  1227. export type JobType = "OTA"|"REBOOT"|string;
  1228. export type LastUpdatedTime = Date;
  1229. export type LatestAlternateSoftware = string;
  1230. export interface LatestDeviceJob {
  1231. /**
  1232. * The target version of the device software.
  1233. */
  1234. ImageVersion?: ImageVersion;
  1235. /**
  1236. * The job's type.
  1237. */
  1238. JobType?: JobType;
  1239. /**
  1240. * Status of the latest device job.
  1241. */
  1242. Status?: UpdateProgress;
  1243. }
  1244. export type LatestSoftware = string;
  1245. export type LeaseExpirationTime = Date;
  1246. export interface ListApplicationInstanceDependenciesRequest {
  1247. /**
  1248. * The application instance's ID.
  1249. */
  1250. ApplicationInstanceId: ApplicationInstanceId;
  1251. /**
  1252. * The maximum number of application instance dependencies to return in one page of results.
  1253. */
  1254. MaxResults?: MaxSize25;
  1255. /**
  1256. * Specify the pagination token from a previous request to retrieve the next page of results.
  1257. */
  1258. NextToken?: NextToken;
  1259. }
  1260. export interface ListApplicationInstanceDependenciesResponse {
  1261. /**
  1262. * A pagination token that's included if more results are available.
  1263. */
  1264. NextToken?: NextToken;
  1265. /**
  1266. * A list of package objects.
  1267. */
  1268. PackageObjects?: PackageObjects;
  1269. }
  1270. export interface ListApplicationInstanceNodeInstancesRequest {
  1271. /**
  1272. * The node instances' application instance ID.
  1273. */
  1274. ApplicationInstanceId: ApplicationInstanceId;
  1275. /**
  1276. * The maximum number of node instances to return in one page of results.
  1277. */
  1278. MaxResults?: MaxSize25;
  1279. /**
  1280. * Specify the pagination token from a previous request to retrieve the next page of results.
  1281. */
  1282. NextToken?: NextToken;
  1283. }
  1284. export interface ListApplicationInstanceNodeInstancesResponse {
  1285. /**
  1286. * A pagination token that's included if more results are available.
  1287. */
  1288. NextToken?: NextToken;
  1289. /**
  1290. * A list of node instances.
  1291. */
  1292. NodeInstances?: NodeInstances;
  1293. }
  1294. export interface ListApplicationInstancesRequest {
  1295. /**
  1296. * The application instances' device ID.
  1297. */
  1298. DeviceId?: DeviceId;
  1299. /**
  1300. * The maximum number of application instances to return in one page of results.
  1301. */
  1302. MaxResults?: MaxSize25;
  1303. /**
  1304. * Specify the pagination token from a previous request to retrieve the next page of results.
  1305. */
  1306. NextToken?: NextToken;
  1307. /**
  1308. * Only include instances with a specific status.
  1309. */
  1310. StatusFilter?: StatusFilter;
  1311. }
  1312. export interface ListApplicationInstancesResponse {
  1313. /**
  1314. * A list of application instances.
  1315. */
  1316. ApplicationInstances?: ApplicationInstances;
  1317. /**
  1318. * A pagination token that's included if more results are available.
  1319. */
  1320. NextToken?: NextToken;
  1321. }
  1322. export interface ListDevicesJobsRequest {
  1323. /**
  1324. * Filter results by the job's target device ID.
  1325. */
  1326. DeviceId?: DeviceId;
  1327. /**
  1328. * The maximum number of device jobs to return in one page of results.
  1329. */
  1330. MaxResults?: MaxSize25;
  1331. /**
  1332. * Specify the pagination token from a previous request to retrieve the next page of results.
  1333. */
  1334. NextToken?: NextToken;
  1335. }
  1336. export interface ListDevicesJobsResponse {
  1337. /**
  1338. * A list of jobs.
  1339. */
  1340. DeviceJobs?: DeviceJobList;
  1341. /**
  1342. * A pagination token that's included if more results are available.
  1343. */
  1344. NextToken?: NextToken;
  1345. }
  1346. export interface ListDevicesRequest {
  1347. /**
  1348. * Filter based on a device's status.
  1349. */
  1350. DeviceAggregatedStatusFilter?: DeviceAggregatedStatus;
  1351. /**
  1352. * The maximum number of devices to return in one page of results.
  1353. */
  1354. MaxResults?: MaxSize25;
  1355. /**
  1356. * Filter based on device's name. Prefixes supported.
  1357. */
  1358. NameFilter?: NameFilter;
  1359. /**
  1360. * Specify the pagination token from a previous request to retrieve the next page of results.
  1361. */
  1362. NextToken?: NextToken;
  1363. /**
  1364. * The target column to be sorted on. Default column sort is CREATED_TIME.
  1365. */
  1366. SortBy?: ListDevicesSortBy;
  1367. /**
  1368. * The sorting order for the returned list. SortOrder is DESCENDING by default based on CREATED_TIME. Otherwise, SortOrder is ASCENDING.
  1369. */
  1370. SortOrder?: SortOrder;
  1371. }
  1372. export interface ListDevicesResponse {
  1373. /**
  1374. * A list of devices.
  1375. */
  1376. Devices: DeviceList;
  1377. /**
  1378. * A pagination token that's included if more results are available.
  1379. */
  1380. NextToken?: NextToken;
  1381. }
  1382. export type ListDevicesSortBy = "DEVICE_ID"|"CREATED_TIME"|"NAME"|"DEVICE_AGGREGATED_STATUS"|string;
  1383. export interface ListNodeFromTemplateJobsRequest {
  1384. /**
  1385. * The maximum number of node from template jobs to return in one page of results.
  1386. */
  1387. MaxResults?: MaxSize25;
  1388. /**
  1389. * Specify the pagination token from a previous request to retrieve the next page of results.
  1390. */
  1391. NextToken?: NextToken;
  1392. }
  1393. export interface ListNodeFromTemplateJobsResponse {
  1394. /**
  1395. * A pagination token that's included if more results are available.
  1396. */
  1397. NextToken?: NextToken;
  1398. /**
  1399. * A list of jobs.
  1400. */
  1401. NodeFromTemplateJobs: NodeFromTemplateJobList;
  1402. }
  1403. export interface ListNodesRequest {
  1404. /**
  1405. * Search for nodes by category.
  1406. */
  1407. Category?: NodeCategory;
  1408. /**
  1409. * The maximum number of nodes to return in one page of results.
  1410. */
  1411. MaxResults?: MaxSize25;
  1412. /**
  1413. * Specify the pagination token from a previous request to retrieve the next page of results.
  1414. */
  1415. NextToken?: Token;
  1416. /**
  1417. * Search for nodes by the account ID of the nodes' owner.
  1418. */
  1419. OwnerAccount?: PackageOwnerAccount;
  1420. /**
  1421. * Search for nodes by name.
  1422. */
  1423. PackageName?: NodePackageName;
  1424. /**
  1425. * Search for nodes by version.
  1426. */
  1427. PackageVersion?: NodePackageVersion;
  1428. /**
  1429. * Search for nodes by patch version.
  1430. */
  1431. PatchVersion?: NodePackagePatchVersion;
  1432. }
  1433. export interface ListNodesResponse {
  1434. /**
  1435. * A pagination token that's included if more results are available.
  1436. */
  1437. NextToken?: Token;
  1438. /**
  1439. * A list of nodes.
  1440. */
  1441. Nodes?: NodesList;
  1442. }
  1443. export interface ListPackageImportJobsRequest {
  1444. /**
  1445. * The maximum number of package import jobs to return in one page of results.
  1446. */
  1447. MaxResults?: MaxSize25;
  1448. /**
  1449. * Specify the pagination token from a previous request to retrieve the next page of results.
  1450. */
  1451. NextToken?: NextToken;
  1452. }
  1453. export interface ListPackageImportJobsResponse {
  1454. /**
  1455. * A pagination token that's included if more results are available.
  1456. */
  1457. NextToken?: NextToken;
  1458. /**
  1459. * A list of package import jobs.
  1460. */
  1461. PackageImportJobs: PackageImportJobList;
  1462. }
  1463. export interface ListPackagesRequest {
  1464. /**
  1465. * The maximum number of packages to return in one page of results.
  1466. */
  1467. MaxResults?: MaxSize25;
  1468. /**
  1469. * Specify the pagination token from a previous request to retrieve the next page of results.
  1470. */
  1471. NextToken?: Token;
  1472. }
  1473. export interface ListPackagesResponse {
  1474. /**
  1475. * A pagination token that's included if more results are available.
  1476. */
  1477. NextToken?: NextToken;
  1478. /**
  1479. * A list of packages.
  1480. */
  1481. Packages?: PackageList;
  1482. }
  1483. export interface ListTagsForResourceRequest {
  1484. /**
  1485. * The resource's ARN.
  1486. */
  1487. ResourceArn: ResourceArn;
  1488. }
  1489. export interface ListTagsForResourceResponse {
  1490. /**
  1491. * A list of tags.
  1492. */
  1493. Tags?: TagMap;
  1494. }
  1495. export interface ManifestOverridesPayload {
  1496. /**
  1497. * The overrides document.
  1498. */
  1499. PayloadData?: ManifestOverridesPayloadData;
  1500. }
  1501. export type ManifestOverridesPayloadData = string;
  1502. export interface ManifestPayload {
  1503. /**
  1504. * The application manifest.
  1505. */
  1506. PayloadData?: ManifestPayloadData;
  1507. }
  1508. export type ManifestPayloadData = string;
  1509. export type MarkLatestPatch = boolean;
  1510. export type Mask = string;
  1511. export type MaxConnections = number;
  1512. export type MaxSize25 = number;
  1513. export type NameFilter = string;
  1514. export type NetworkConnectionStatus = "CONNECTED"|"NOT_CONNECTED"|"CONNECTING"|string;
  1515. export interface NetworkPayload {
  1516. /**
  1517. * Settings for Ethernet port 0.
  1518. */
  1519. Ethernet0?: EthernetPayload;
  1520. /**
  1521. * Settings for Ethernet port 1.
  1522. */
  1523. Ethernet1?: EthernetPayload;
  1524. /**
  1525. * Network time protocol (NTP) server settings.
  1526. */
  1527. Ntp?: NtpPayload;
  1528. }
  1529. export interface NetworkStatus {
  1530. /**
  1531. * The status of Ethernet port 0.
  1532. */
  1533. Ethernet0Status?: EthernetStatus;
  1534. /**
  1535. * The status of Ethernet port 1.
  1536. */
  1537. Ethernet1Status?: EthernetStatus;
  1538. /**
  1539. * When the network status changed.
  1540. */
  1541. LastUpdatedTime?: LastUpdatedTime;
  1542. /**
  1543. * Details about a network time protocol (NTP) server connection.
  1544. */
  1545. NtpStatus?: NtpStatus;
  1546. }
  1547. export type NextToken = string;
  1548. export interface Node {
  1549. /**
  1550. * The node's category.
  1551. */
  1552. Category: NodeCategory;
  1553. /**
  1554. * When the node was created.
  1555. */
  1556. CreatedTime: TimeStamp;
  1557. /**
  1558. * The node's description.
  1559. */
  1560. Description?: Description;
  1561. /**
  1562. * The node's name.
  1563. */
  1564. Name: NodeName;
  1565. /**
  1566. * The node's ID.
  1567. */
  1568. NodeId: NodeId;
  1569. /**
  1570. * The account ID of the node's owner.
  1571. */
  1572. OwnerAccount?: PackageOwnerAccount;
  1573. /**
  1574. * The node's ARN.
  1575. */
  1576. PackageArn?: NodePackageArn;
  1577. /**
  1578. * The node's package ID.
  1579. */
  1580. PackageId: NodePackageId;
  1581. /**
  1582. * The node's package name.
  1583. */
  1584. PackageName: NodePackageName;
  1585. /**
  1586. * The node's package version.
  1587. */
  1588. PackageVersion: NodePackageVersion;
  1589. /**
  1590. * The node's patch version.
  1591. */
  1592. PatchVersion: NodePackagePatchVersion;
  1593. }
  1594. export type NodeAssetName = string;
  1595. export type NodeCategory = "BUSINESS_LOGIC"|"ML_MODEL"|"MEDIA_SOURCE"|"MEDIA_SINK"|string;
  1596. export interface NodeFromTemplateJob {
  1597. /**
  1598. * When the job was created.
  1599. */
  1600. CreatedTime?: CreatedTime;
  1601. /**
  1602. * The job's ID.
  1603. */
  1604. JobId?: JobId;
  1605. /**
  1606. * The node's name.
  1607. */
  1608. NodeName?: NodeName;
  1609. /**
  1610. * The job's status.
  1611. */
  1612. Status?: NodeFromTemplateJobStatus;
  1613. /**
  1614. * The job's status message.
  1615. */
  1616. StatusMessage?: NodeFromTemplateJobStatusMessage;
  1617. /**
  1618. * The job's template type.
  1619. */
  1620. TemplateType?: TemplateType;
  1621. }
  1622. export type NodeFromTemplateJobList = NodeFromTemplateJob[];
  1623. export type NodeFromTemplateJobStatus = "PENDING"|"SUCCEEDED"|"FAILED"|string;
  1624. export type NodeFromTemplateJobStatusMessage = string;
  1625. export type NodeId = string;
  1626. export interface NodeInputPort {
  1627. /**
  1628. * The input port's default value.
  1629. */
  1630. DefaultValue?: PortDefaultValue;
  1631. /**
  1632. * The input port's description.
  1633. */
  1634. Description?: Description;
  1635. /**
  1636. * The input port's max connections.
  1637. */
  1638. MaxConnections?: MaxConnections;
  1639. /**
  1640. * The input port's name.
  1641. */
  1642. Name?: PortName;
  1643. /**
  1644. * The input port's type.
  1645. */
  1646. Type?: PortType;
  1647. }
  1648. export interface NodeInstance {
  1649. /**
  1650. * The instance's current status.
  1651. */
  1652. CurrentStatus: NodeInstanceStatus;
  1653. /**
  1654. * The node's ID.
  1655. */
  1656. NodeId?: NodeId;
  1657. /**
  1658. * The instance's ID.
  1659. */
  1660. NodeInstanceId: NodeInstanceId;
  1661. /**
  1662. * The instance's name.
  1663. */
  1664. NodeName?: NodeName;
  1665. /**
  1666. * The instance's package name.
  1667. */
  1668. PackageName?: NodePackageName;
  1669. /**
  1670. * The instance's package patch version.
  1671. */
  1672. PackagePatchVersion?: NodePackagePatchVersion;
  1673. /**
  1674. * The instance's package version.
  1675. */
  1676. PackageVersion?: NodePackageVersion;
  1677. }
  1678. export type NodeInstanceId = string;
  1679. export type NodeInstanceStatus = "RUNNING"|"ERROR"|"NOT_AVAILABLE"|"PAUSED"|string;
  1680. export type NodeInstances = NodeInstance[];
  1681. export interface NodeInterface {
  1682. /**
  1683. * The node interface's inputs.
  1684. */
  1685. Inputs: InputPortList;
  1686. /**
  1687. * The node interface's outputs.
  1688. */
  1689. Outputs: OutputPortList;
  1690. }
  1691. export type NodeName = string;
  1692. export interface NodeOutputPort {
  1693. /**
  1694. * The output port's description.
  1695. */
  1696. Description?: Description;
  1697. /**
  1698. * The output port's name.
  1699. */
  1700. Name?: PortName;
  1701. /**
  1702. * The output port's type.
  1703. */
  1704. Type?: PortType;
  1705. }
  1706. export type NodePackageArn = string;
  1707. export type NodePackageId = string;
  1708. export type NodePackageName = string;
  1709. export type NodePackagePatchVersion = string;
  1710. export type NodePackageVersion = string;
  1711. export interface NodeSignal {
  1712. /**
  1713. * The camera node's name, from the application manifest.
  1714. */
  1715. NodeInstanceId: NodeInstanceId;
  1716. /**
  1717. * The signal value.
  1718. */
  1719. Signal: NodeSignalValue;
  1720. }
  1721. export type NodeSignalList = NodeSignal[];
  1722. export type NodeSignalValue = "PAUSE"|"RESUME"|string;
  1723. export type NodesList = Node[];
  1724. export interface NtpPayload {
  1725. /**
  1726. * NTP servers to use, in order of preference.
  1727. */
  1728. NtpServers: NtpServerList;
  1729. }
  1730. export type NtpServerList = IpAddressOrServerName[];
  1731. export type NtpServerName = string;
  1732. export interface NtpStatus {
  1733. /**
  1734. * The connection's status.
  1735. */
  1736. ConnectionStatus?: NetworkConnectionStatus;
  1737. /**
  1738. * The IP address of the server.
  1739. */
  1740. IpAddress?: IpAddress;
  1741. /**
  1742. * The domain name of the server.
  1743. */
  1744. NtpServerName?: NtpServerName;
  1745. }
  1746. export interface OTAJobConfig {
  1747. /**
  1748. * Whether to apply the update if it is a major version change.
  1749. */
  1750. AllowMajorVersionUpdate?: Boolean;
  1751. /**
  1752. * The target version of the device software.
  1753. */
  1754. ImageVersion: ImageVersion;
  1755. }
  1756. export type Object = string;
  1757. export type ObjectKey = string;
  1758. export interface OutPutS3Location {
  1759. /**
  1760. * The object's bucket.
  1761. */
  1762. BucketName: BucketName;
  1763. /**
  1764. * The object's key.
  1765. */
  1766. ObjectKey: ObjectKey;
  1767. }
  1768. export type OutputPortList = NodeOutputPort[];
  1769. export interface PackageImportJob {
  1770. /**
  1771. * When the job was created.
  1772. */
  1773. CreatedTime?: CreatedTime;
  1774. /**
  1775. * The job's ID.
  1776. */
  1777. JobId?: JobId;
  1778. /**
  1779. * The job's type.
  1780. */
  1781. JobType?: PackageImportJobType;
  1782. /**
  1783. * When the job was updated.
  1784. */
  1785. LastUpdatedTime?: LastUpdatedTime;
  1786. /**
  1787. * The job's status.
  1788. */
  1789. Status?: PackageImportJobStatus;
  1790. /**
  1791. * The job's status message.
  1792. */
  1793. StatusMessage?: PackageImportJobStatusMessage;
  1794. }
  1795. export interface PackageImportJobInputConfig {
  1796. /**
  1797. * The package version's input configuration.
  1798. */
  1799. PackageVersionInputConfig?: PackageVersionInputConfig;
  1800. }
  1801. export type PackageImportJobList = PackageImportJob[];
  1802. export interface PackageImportJobOutput {
  1803. /**
  1804. * The package's output location.
  1805. */
  1806. OutputS3Location: OutPutS3Location;
  1807. /**
  1808. * The package's ID.
  1809. */
  1810. PackageId: NodePackageId;
  1811. /**
  1812. * The package's version.
  1813. */
  1814. PackageVersion: NodePackageVersion;
  1815. /**
  1816. * The package's patch version.
  1817. */
  1818. PatchVersion: NodePackagePatchVersion;
  1819. }
  1820. export interface PackageImportJobOutputConfig {
  1821. /**
  1822. * The package version's output configuration.
  1823. */
  1824. PackageVersionOutputConfig?: PackageVersionOutputConfig;
  1825. }
  1826. export type PackageImportJobStatus = "PENDING"|"SUCCEEDED"|"FAILED"|string;
  1827. export type PackageImportJobStatusMessage = string;
  1828. export type PackageImportJobType = "NODE_PACKAGE_VERSION"|"MARKETPLACE_NODE_PACKAGE_VERSION"|string;
  1829. export type PackageList = PackageListItem[];
  1830. export interface PackageListItem {
  1831. /**
  1832. * The package's ARN.
  1833. */
  1834. Arn?: NodePackageArn;
  1835. /**
  1836. * When the package was created.
  1837. */
  1838. CreatedTime?: TimeStamp;
  1839. /**
  1840. * The package's ID.
  1841. */
  1842. PackageId?: NodePackageId;
  1843. /**
  1844. * The package's name.
  1845. */
  1846. PackageName?: NodePackageName;
  1847. /**
  1848. * The package's tags.
  1849. */
  1850. Tags?: TagMap;
  1851. }
  1852. export interface PackageObject {
  1853. /**
  1854. * The object's name.
  1855. */
  1856. Name: NodePackageName;
  1857. /**
  1858. * The object's package version.
  1859. */
  1860. PackageVersion: NodePackageVersion;
  1861. /**
  1862. * The object's patch version.
  1863. */
  1864. PatchVersion: NodePackagePatchVersion;
  1865. }
  1866. export type PackageObjects = PackageObject[];
  1867. export type PackageOwnerAccount = string;
  1868. export interface PackageVersionInputConfig {
  1869. /**
  1870. * A location in Amazon S3.
  1871. */
  1872. S3Location: S3Location;
  1873. }
  1874. export interface PackageVersionOutputConfig {
  1875. /**
  1876. * Indicates that the version is recommended for all users.
  1877. */
  1878. MarkLatest?: MarkLatestPatch;
  1879. /**
  1880. * The output's package name.
  1881. */
  1882. PackageName: NodePackageName;
  1883. /**
  1884. * The output's package version.
  1885. */
  1886. PackageVersion: NodePackageVersion;
  1887. }
  1888. export type PackageVersionStatus = "REGISTER_PENDING"|"REGISTER_COMPLETED"|"FAILED"|"DELETING"|string;
  1889. export type PackageVersionStatusDescription = string;
  1890. export type PortDefaultValue = string;
  1891. export type PortName = string;
  1892. export type PortType = "BOOLEAN"|"STRING"|"INT32"|"FLOAT32"|"MEDIA"|string;
  1893. export type PrincipalArn = string;
  1894. export type PrincipalArnsList = PrincipalArn[];
  1895. export interface ProvisionDeviceRequest {
  1896. /**
  1897. * A description for the device.
  1898. */
  1899. Description?: Description;
  1900. /**
  1901. * A name for the device.
  1902. */
  1903. Name: DeviceName;
  1904. /**
  1905. * A networking configuration for the device.
  1906. */
  1907. NetworkingConfiguration?: NetworkPayload;
  1908. /**
  1909. * Tags for the device.
  1910. */
  1911. Tags?: TagMap;
  1912. }
  1913. export interface ProvisionDeviceResponse {
  1914. /**
  1915. * The device's ARN.
  1916. */
  1917. Arn: DeviceArn;
  1918. /**
  1919. * The device's configuration bundle.
  1920. */
  1921. Certificates?: Certificates;
  1922. /**
  1923. * The device's ID.
  1924. */
  1925. DeviceId?: DeviceId;
  1926. /**
  1927. * The device's IoT thing name.
  1928. */
  1929. IotThingName?: IotThingName;
  1930. /**
  1931. * The device's status.
  1932. */
  1933. Status: DeviceStatus;
  1934. }
  1935. export type Region = string;
  1936. export interface RegisterPackageVersionRequest {
  1937. /**
  1938. * Whether to mark the new version as the latest version.
  1939. */
  1940. MarkLatest?: MarkLatestPatch;
  1941. /**
  1942. * An owner account.
  1943. */
  1944. OwnerAccount?: PackageOwnerAccount;
  1945. /**
  1946. * A package ID.
  1947. */
  1948. PackageId: NodePackageId;
  1949. /**
  1950. * A package version.
  1951. */
  1952. PackageVersion: NodePackageVersion;
  1953. /**
  1954. * A patch version.
  1955. */
  1956. PatchVersion: NodePackagePatchVersion;
  1957. }
  1958. export interface RegisterPackageVersionResponse {
  1959. }
  1960. export interface RemoveApplicationInstanceRequest {
  1961. /**
  1962. * An application instance ID.
  1963. */
  1964. ApplicationInstanceId: ApplicationInstanceId;
  1965. }
  1966. export interface RemoveApplicationInstanceResponse {
  1967. }
  1968. export interface ReportedRuntimeContextState {
  1969. /**
  1970. * The application's desired state.
  1971. */
  1972. DesiredState: DesiredState;
  1973. /**
  1974. * The application's reported status.
  1975. */
  1976. DeviceReportedStatus: DeviceReportedStatus;
  1977. /**
  1978. * When the device reported the application's state.
  1979. */
  1980. DeviceReportedTime: TimeStamp;
  1981. /**
  1982. * The device's name.
  1983. */
  1984. RuntimeContextName: RuntimeContextName;
  1985. }
  1986. export type ReportedRuntimeContextStates = ReportedRuntimeContextState[];
  1987. export type ResourceArn = string;
  1988. export type RuntimeContextName = string;
  1989. export type RuntimeRoleArn = string;
  1990. export interface S3Location {
  1991. /**
  1992. * A bucket name.
  1993. */
  1994. BucketName: BucketName;
  1995. /**
  1996. * An object key.
  1997. */
  1998. ObjectKey: ObjectKey;
  1999. /**
  2000. * The bucket's Region.
  2001. */
  2002. Region?: Region;
  2003. }
  2004. export interface SignalApplicationInstanceNodeInstancesRequest {
  2005. /**
  2006. * An application instance ID.
  2007. */
  2008. ApplicationInstanceId: ApplicationInstanceId;
  2009. /**
  2010. * A list of signals.
  2011. */
  2012. NodeSignals: NodeSignalList;
  2013. }
  2014. export interface SignalApplicationInstanceNodeInstancesResponse {
  2015. /**
  2016. * An application instance ID.
  2017. */
  2018. ApplicationInstanceId: ApplicationInstanceId;
  2019. }
  2020. export type SortOrder = "ASCENDING"|"DESCENDING"|string;
  2021. export interface StaticIpConnectionInfo {
  2022. /**
  2023. * The connection's default gateway.
  2024. */
  2025. DefaultGateway: DefaultGateway;
  2026. /**
  2027. * The connection's DNS address.
  2028. */
  2029. Dns: DnsList;
  2030. /**
  2031. * The connection's IP address.
  2032. */
  2033. IpAddress: IpAddress;
  2034. /**
  2035. * The connection's DNS mask.
  2036. */
  2037. Mask: Mask;
  2038. }
  2039. export type StatusFilter = "DEPLOYMENT_SUCCEEDED"|"DEPLOYMENT_ERROR"|"REMOVAL_SUCCEEDED"|"REMOVAL_FAILED"|"PROCESSING_DEPLOYMENT"|"PROCESSING_REMOVAL"|"DEPLOYMENT_FAILED"|string;
  2040. export interface StorageLocation {
  2041. /**
  2042. * The location's binary prefix.
  2043. */
  2044. BinaryPrefixLocation: Object;
  2045. /**
  2046. * The location's bucket.
  2047. */
  2048. Bucket: Bucket;
  2049. /**
  2050. * The location's generated prefix.
  2051. */
  2052. GeneratedPrefixLocation: Object;
  2053. /**
  2054. * The location's manifest prefix.
  2055. */
  2056. ManifestPrefixLocation: Object;
  2057. /**
  2058. * The location's repo prefix.
  2059. */
  2060. RepoPrefixLocation: Object;
  2061. }
  2062. export type TagKey = string;
  2063. export type TagKeyList = TagKey[];
  2064. export type TagMap = {[key: string]: TagValue};
  2065. export interface TagResourceRequest {
  2066. /**
  2067. * The resource's ARN.
  2068. */
  2069. ResourceArn: ResourceArn;
  2070. /**
  2071. * Tags for the resource.
  2072. */
  2073. Tags: TagMap;
  2074. }
  2075. export interface TagResourceResponse {
  2076. }
  2077. export type TagValue = string;
  2078. export type TemplateKey = string;
  2079. export type TemplateParametersMap = {[key: string]: TemplateValue};
  2080. export type TemplateType = "RTSP_CAMERA_STREAM"|string;
  2081. export type TemplateValue = string;
  2082. export type TimeStamp = Date;
  2083. export type Token = string;
  2084. export interface UntagResourceRequest {
  2085. /**
  2086. * The resource's ARN.
  2087. */
  2088. ResourceArn: ResourceArn;
  2089. /**
  2090. * Tag keys to remove.
  2091. */
  2092. TagKeys: TagKeyList;
  2093. }
  2094. export interface UntagResourceResponse {
  2095. }
  2096. export type UpdateCreatedTime = Date;
  2097. export interface UpdateDeviceMetadataRequest {
  2098. /**
  2099. * A description for the device.
  2100. */
  2101. Description?: Description;
  2102. /**
  2103. * The device's ID.
  2104. */
  2105. DeviceId: DeviceId;
  2106. }
  2107. export interface UpdateDeviceMetadataResponse {
  2108. /**
  2109. * The device's ID.
  2110. */
  2111. DeviceId?: DeviceId;
  2112. }
  2113. export type UpdateProgress = "PENDING"|"IN_PROGRESS"|"VERIFYING"|"REBOOTING"|"DOWNLOADING"|"COMPLETED"|"FAILED"|string;
  2114. export type Version = string;
  2115. /**
  2116. * 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.
  2117. */
  2118. export type apiVersion = "2019-07-24"|"latest"|string;
  2119. export interface ClientApiVersions {
  2120. /**
  2121. * 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.
  2122. */
  2123. apiVersion?: apiVersion;
  2124. }
  2125. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2126. /**
  2127. * Contains interfaces for use with the Panorama client.
  2128. */
  2129. export import Types = Panorama;
  2130. }
  2131. export = Panorama;