@aws-sdk/client-iotsitewise 3.1097.0 → 3.1098.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (294) hide show
  1. package/README.md +315 -0
  2. package/dist-cjs/index.js +2189 -237
  3. package/dist-es/IoTSiteWise.js +118 -0
  4. package/dist-es/commands/BatchAssociateDataSegmentsToDatasetCommand.js +4 -0
  5. package/dist-es/commands/BatchDeleteDatasetDataSegmentsCommand.js +4 -0
  6. package/dist-es/commands/BatchDisassociateDataSegmentsFromDatasetCommand.js +4 -0
  7. package/dist-es/commands/CancelEnrichmentJobCommand.js +4 -0
  8. package/dist-es/commands/CancelPipelineExecutionCommand.js +4 -0
  9. package/dist-es/commands/CancelQueryCommand.js +4 -0
  10. package/dist-es/commands/CreateApplicationCommand.js +4 -0
  11. package/dist-es/commands/CreateDatasetExportJobCommand.js +4 -0
  12. package/dist-es/commands/CreateEnrichmentJobCommand.js +4 -0
  13. package/dist-es/commands/CreatePipelineCommand.js +4 -0
  14. package/dist-es/commands/CreateTaskCommand.js +4 -0
  15. package/dist-es/commands/CreateWorkspaceCommand.js +4 -0
  16. package/dist-es/commands/DeleteApplicationCommand.js +4 -0
  17. package/dist-es/commands/DeletePipelineCommand.js +4 -0
  18. package/dist-es/commands/DeleteTaskCommand.js +4 -0
  19. package/dist-es/commands/DeleteWorkspaceCommand.js +4 -0
  20. package/dist-es/commands/DescribeApplicationCommand.js +4 -0
  21. package/dist-es/commands/DescribeDatasetExportJobCommand.js +4 -0
  22. package/dist-es/commands/DescribeEnrichmentJobCommand.js +4 -0
  23. package/dist-es/commands/DescribePipelineCommand.js +4 -0
  24. package/dist-es/commands/DescribePipelineExecutionCommand.js +4 -0
  25. package/dist-es/commands/DescribeQueryCommand.js +4 -0
  26. package/dist-es/commands/DescribeSearchCommand.js +4 -0
  27. package/dist-es/commands/DescribeTaskCommand.js +4 -0
  28. package/dist-es/commands/DescribeWorkspaceCommand.js +4 -0
  29. package/dist-es/commands/GetCaptureDataCommand.js +4 -0
  30. package/dist-es/commands/GetQueryResultsCommand.js +4 -0
  31. package/dist-es/commands/GetSearchResultsCommand.js +4 -0
  32. package/dist-es/commands/ListApplicationsCommand.js +4 -0
  33. package/dist-es/commands/ListDatasetDataSegmentRelationshipsCommand.js +4 -0
  34. package/dist-es/commands/ListDatasetDataSegmentsCommand.js +4 -0
  35. package/dist-es/commands/ListDatasetExportJobsCommand.js +4 -0
  36. package/dist-es/commands/ListEnrichmentJobsCommand.js +4 -0
  37. package/dist-es/commands/ListPipelineExecutionsCommand.js +4 -0
  38. package/dist-es/commands/ListPipelinesCommand.js +4 -0
  39. package/dist-es/commands/ListQueriesCommand.js +4 -0
  40. package/dist-es/commands/ListSearchesCommand.js +4 -0
  41. package/dist-es/commands/ListTasksCommand.js +4 -0
  42. package/dist-es/commands/ListWorkspacesCommand.js +4 -0
  43. package/dist-es/commands/StartPipelineExecutionCommand.js +4 -0
  44. package/dist-es/commands/StartQueryCommand.js +4 -0
  45. package/dist-es/commands/StartSearchCommand.js +4 -0
  46. package/dist-es/commands/UpdatePipelineCommand.js +4 -0
  47. package/dist-es/commands/UpdateTaskCommand.js +4 -0
  48. package/dist-es/commands/UpdateWorkspaceCommand.js +4 -0
  49. package/dist-es/commands/index.js +45 -0
  50. package/dist-es/models/enums.js +157 -3
  51. package/dist-es/pagination/DescribePipelineExecutionPaginator.js +4 -0
  52. package/dist-es/pagination/GetQueryResultsPaginator.js +4 -0
  53. package/dist-es/pagination/GetSearchResultsPaginator.js +4 -0
  54. package/dist-es/pagination/ListApplicationsPaginator.js +4 -0
  55. package/dist-es/pagination/ListDatasetDataSegmentRelationshipsPaginator.js +4 -0
  56. package/dist-es/pagination/ListDatasetDataSegmentsPaginator.js +4 -0
  57. package/dist-es/pagination/ListDatasetExportJobsPaginator.js +4 -0
  58. package/dist-es/pagination/ListEnrichmentJobsPaginator.js +4 -0
  59. package/dist-es/pagination/ListPipelineExecutionsPaginator.js +4 -0
  60. package/dist-es/pagination/ListPipelinesPaginator.js +4 -0
  61. package/dist-es/pagination/ListQueriesPaginator.js +4 -0
  62. package/dist-es/pagination/ListSearchesPaginator.js +4 -0
  63. package/dist-es/pagination/ListTasksPaginator.js +4 -0
  64. package/dist-es/pagination/ListWorkspacesPaginator.js +4 -0
  65. package/dist-es/pagination/index.js +14 -0
  66. package/dist-es/schemas/schemas_0.js +1544 -233
  67. package/dist-types/IoTSiteWise.d.ts +415 -0
  68. package/dist-types/IoTSiteWiseClient.d.ts +47 -2
  69. package/dist-types/commands/BatchAssociateDataSegmentsToDatasetCommand.d.ts +133 -0
  70. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +7 -1
  71. package/dist-types/commands/BatchDeleteDatasetDataSegmentsCommand.d.ts +123 -0
  72. package/dist-types/commands/BatchDisassociateDataSegmentsFromDatasetCommand.d.ts +125 -0
  73. package/dist-types/commands/CancelEnrichmentJobCommand.d.ts +124 -0
  74. package/dist-types/commands/CancelPipelineExecutionCommand.d.ts +103 -0
  75. package/dist-types/commands/CancelQueryCommand.d.ts +96 -0
  76. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +7 -1
  77. package/dist-types/commands/CreateApplicationCommand.d.ts +111 -0
  78. package/dist-types/commands/CreateAssetModelCommand.d.ts +2 -2
  79. package/dist-types/commands/CreateAssetModelCompositeModelCommand.d.ts +2 -1
  80. package/dist-types/commands/CreateBulkImportJobCommand.d.ts +28 -5
  81. package/dist-types/commands/CreateDashboardCommand.d.ts +7 -1
  82. package/dist-types/commands/CreateDatasetCommand.d.ts +20 -3
  83. package/dist-types/commands/CreateDatasetExportJobCommand.d.ts +141 -0
  84. package/dist-types/commands/CreateEnrichmentJobCommand.d.ts +147 -0
  85. package/dist-types/commands/CreatePipelineCommand.d.ts +136 -0
  86. package/dist-types/commands/CreatePortalCommand.d.ts +7 -1
  87. package/dist-types/commands/CreateProjectCommand.d.ts +7 -1
  88. package/dist-types/commands/CreateTaskCommand.d.ts +133 -0
  89. package/dist-types/commands/CreateWorkspaceCommand.d.ts +119 -0
  90. package/dist-types/commands/DeleteApplicationCommand.d.ts +93 -0
  91. package/dist-types/commands/DeleteAssetCommand.d.ts +1 -0
  92. package/dist-types/commands/DeleteAssetModelCommand.d.ts +1 -0
  93. package/dist-types/commands/DeleteAssetModelCompositeModelCommand.d.ts +1 -0
  94. package/dist-types/commands/DeleteDatasetCommand.d.ts +2 -1
  95. package/dist-types/commands/DeletePipelineCommand.d.ts +104 -0
  96. package/dist-types/commands/DeleteTaskCommand.d.ts +103 -0
  97. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +3 -1
  98. package/dist-types/commands/DeleteWorkspaceCommand.d.ts +103 -0
  99. package/dist-types/commands/DescribeApplicationCommand.d.ts +100 -0
  100. package/dist-types/commands/DescribeAssetCommand.d.ts +2 -2
  101. package/dist-types/commands/DescribeAssetCompositeModelCommand.d.ts +1 -1
  102. package/dist-types/commands/DescribeAssetModelCommand.d.ts +2 -2
  103. package/dist-types/commands/DescribeAssetModelCompositeModelCommand.d.ts +1 -1
  104. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +2 -2
  105. package/dist-types/commands/DescribeBulkImportJobCommand.d.ts +23 -3
  106. package/dist-types/commands/DescribeDatasetCommand.d.ts +27 -2
  107. package/dist-types/commands/DescribeDatasetExportJobCommand.d.ts +138 -0
  108. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +3 -0
  109. package/dist-types/commands/DescribeEnrichmentJobCommand.d.ts +151 -0
  110. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +4 -2
  111. package/dist-types/commands/DescribePipelineCommand.d.ts +120 -0
  112. package/dist-types/commands/DescribePipelineExecutionCommand.d.ts +156 -0
  113. package/dist-types/commands/DescribeQueryCommand.d.ts +100 -0
  114. package/dist-types/commands/DescribeSearchCommand.d.ts +102 -0
  115. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
  116. package/dist-types/commands/DescribeTaskCommand.d.ts +120 -0
  117. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +4 -2
  118. package/dist-types/commands/DescribeWorkspaceCommand.d.ts +105 -0
  119. package/dist-types/commands/DisassociateAssetsCommand.d.ts +1 -1
  120. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +1 -1
  121. package/dist-types/commands/ExecuteActionCommand.d.ts +1 -1
  122. package/dist-types/commands/ExecuteQueryCommand.d.ts +1 -2
  123. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
  124. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +1 -1
  125. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
  126. package/dist-types/commands/GetCaptureDataCommand.d.ts +116 -0
  127. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +1 -1
  128. package/dist-types/commands/GetQueryResultsCommand.d.ts +104 -0
  129. package/dist-types/commands/GetSearchResultsCommand.d.ts +118 -0
  130. package/dist-types/commands/InvokeAssistantCommand.d.ts +1 -1
  131. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  132. package/dist-types/commands/ListActionsCommand.d.ts +1 -1
  133. package/dist-types/commands/ListApplicationsCommand.d.ts +101 -0
  134. package/dist-types/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  135. package/dist-types/commands/ListAssetModelPropertiesCommand.d.ts +2 -2
  136. package/dist-types/commands/ListAssetModelsCommand.d.ts +4 -1
  137. package/dist-types/commands/ListAssetPropertiesCommand.d.ts +1 -1
  138. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  139. package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
  140. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  141. package/dist-types/commands/ListBulkImportJobsCommand.d.ts +2 -1
  142. package/dist-types/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  143. package/dist-types/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  144. package/dist-types/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  145. package/dist-types/commands/ListComputationModelsCommand.d.ts +1 -1
  146. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  147. package/dist-types/commands/ListDatasetDataSegmentRelationshipsCommand.d.ts +107 -0
  148. package/dist-types/commands/ListDatasetDataSegmentsCommand.d.ts +111 -0
  149. package/dist-types/commands/ListDatasetExportJobsCommand.d.ts +102 -0
  150. package/dist-types/commands/ListDatasetsCommand.d.ts +16 -2
  151. package/dist-types/commands/ListEnrichmentJobsCommand.d.ts +151 -0
  152. package/dist-types/commands/ListExecutionsCommand.d.ts +1 -1
  153. package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
  154. package/dist-types/commands/ListPipelineExecutionsCommand.d.ts +126 -0
  155. package/dist-types/commands/ListPipelinesCommand.d.ts +109 -0
  156. package/dist-types/commands/ListQueriesCommand.d.ts +101 -0
  157. package/dist-types/commands/ListSearchesCommand.d.ts +119 -0
  158. package/dist-types/commands/ListTasksCommand.d.ts +109 -0
  159. package/dist-types/commands/ListTimeSeriesCommand.d.ts +3 -1
  160. package/dist-types/commands/ListWorkspacesCommand.d.ts +103 -0
  161. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +3 -0
  162. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -0
  163. package/dist-types/commands/StartPipelineExecutionCommand.d.ts +118 -0
  164. package/dist-types/commands/StartQueryCommand.d.ts +97 -0
  165. package/dist-types/commands/StartSearchCommand.d.ts +131 -0
  166. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +7 -1
  167. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -0
  168. package/dist-types/commands/UpdateAssetModelCommand.d.ts +3 -2
  169. package/dist-types/commands/UpdateAssetModelCompositeModelCommand.d.ts +2 -1
  170. package/dist-types/commands/UpdateDashboardCommand.d.ts +7 -1
  171. package/dist-types/commands/UpdateDatasetCommand.d.ts +21 -2
  172. package/dist-types/commands/UpdatePipelineCommand.d.ts +127 -0
  173. package/dist-types/commands/UpdatePortalCommand.d.ts +7 -1
  174. package/dist-types/commands/UpdateProjectCommand.d.ts +7 -1
  175. package/dist-types/commands/UpdateTaskCommand.d.ts +120 -0
  176. package/dist-types/commands/UpdateWorkspaceCommand.d.ts +109 -0
  177. package/dist-types/commands/index.d.ts +45 -0
  178. package/dist-types/models/enums.d.ts +350 -4
  179. package/dist-types/models/models_0.d.ts +2607 -2755
  180. package/dist-types/models/models_1.d.ts +4139 -33
  181. package/dist-types/pagination/DescribePipelineExecutionPaginator.d.ts +7 -0
  182. package/dist-types/pagination/GetQueryResultsPaginator.d.ts +7 -0
  183. package/dist-types/pagination/GetSearchResultsPaginator.d.ts +7 -0
  184. package/dist-types/pagination/ListApplicationsPaginator.d.ts +7 -0
  185. package/dist-types/pagination/ListDatasetDataSegmentRelationshipsPaginator.d.ts +7 -0
  186. package/dist-types/pagination/ListDatasetDataSegmentsPaginator.d.ts +7 -0
  187. package/dist-types/pagination/ListDatasetExportJobsPaginator.d.ts +7 -0
  188. package/dist-types/pagination/ListEnrichmentJobsPaginator.d.ts +7 -0
  189. package/dist-types/pagination/ListPipelineExecutionsPaginator.d.ts +7 -0
  190. package/dist-types/pagination/ListPipelinesPaginator.d.ts +7 -0
  191. package/dist-types/pagination/ListQueriesPaginator.d.ts +7 -0
  192. package/dist-types/pagination/ListSearchesPaginator.d.ts +7 -0
  193. package/dist-types/pagination/ListTasksPaginator.d.ts +7 -0
  194. package/dist-types/pagination/ListWorkspacesPaginator.d.ts +7 -0
  195. package/dist-types/pagination/index.d.ts +14 -0
  196. package/dist-types/schemas/schemas_0.d.ts +190 -0
  197. package/dist-types/ts3.4/IoTSiteWise.d.ts +841 -0
  198. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +248 -2
  199. package/dist-types/ts3.4/commands/BatchAssociateDataSegmentsToDatasetCommand.d.ts +42 -0
  200. package/dist-types/ts3.4/commands/BatchDeleteDatasetDataSegmentsCommand.d.ts +42 -0
  201. package/dist-types/ts3.4/commands/BatchDisassociateDataSegmentsFromDatasetCommand.d.ts +42 -0
  202. package/dist-types/ts3.4/commands/CancelEnrichmentJobCommand.d.ts +39 -0
  203. package/dist-types/ts3.4/commands/CancelPipelineExecutionCommand.d.ts +42 -0
  204. package/dist-types/ts3.4/commands/CancelQueryCommand.d.ts +38 -0
  205. package/dist-types/ts3.4/commands/CreateApplicationCommand.d.ts +39 -0
  206. package/dist-types/ts3.4/commands/CreateDatasetExportJobCommand.d.ts +39 -0
  207. package/dist-types/ts3.4/commands/CreateEnrichmentJobCommand.d.ts +39 -0
  208. package/dist-types/ts3.4/commands/CreatePipelineCommand.d.ts +38 -0
  209. package/dist-types/ts3.4/commands/CreateTaskCommand.d.ts +38 -0
  210. package/dist-types/ts3.4/commands/CreateWorkspaceCommand.d.ts +38 -0
  211. package/dist-types/ts3.4/commands/DeleteApplicationCommand.d.ts +39 -0
  212. package/dist-types/ts3.4/commands/DeletePipelineCommand.d.ts +38 -0
  213. package/dist-types/ts3.4/commands/DeleteTaskCommand.d.ts +38 -0
  214. package/dist-types/ts3.4/commands/DeleteWorkspaceCommand.d.ts +38 -0
  215. package/dist-types/ts3.4/commands/DescribeApplicationCommand.d.ts +39 -0
  216. package/dist-types/ts3.4/commands/DescribeDatasetExportJobCommand.d.ts +42 -0
  217. package/dist-types/ts3.4/commands/DescribeEnrichmentJobCommand.d.ts +39 -0
  218. package/dist-types/ts3.4/commands/DescribeLoggingOptionsCommand.d.ts +1 -1
  219. package/dist-types/ts3.4/commands/DescribePipelineCommand.d.ts +38 -0
  220. package/dist-types/ts3.4/commands/DescribePipelineExecutionCommand.d.ts +42 -0
  221. package/dist-types/ts3.4/commands/DescribeQueryCommand.d.ts +38 -0
  222. package/dist-types/ts3.4/commands/DescribeSearchCommand.d.ts +39 -0
  223. package/dist-types/ts3.4/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
  224. package/dist-types/ts3.4/commands/DescribeTaskCommand.d.ts +38 -0
  225. package/dist-types/ts3.4/commands/DescribeTimeSeriesCommand.d.ts +1 -1
  226. package/dist-types/ts3.4/commands/DescribeWorkspaceCommand.d.ts +39 -0
  227. package/dist-types/ts3.4/commands/DisassociateAssetsCommand.d.ts +1 -1
  228. package/dist-types/ts3.4/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +1 -1
  229. package/dist-types/ts3.4/commands/ExecuteActionCommand.d.ts +1 -1
  230. package/dist-types/ts3.4/commands/ExecuteQueryCommand.d.ts +1 -2
  231. package/dist-types/ts3.4/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
  232. package/dist-types/ts3.4/commands/GetAssetPropertyValueCommand.d.ts +1 -1
  233. package/dist-types/ts3.4/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
  234. package/dist-types/ts3.4/commands/GetCaptureDataCommand.d.ts +38 -0
  235. package/dist-types/ts3.4/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +1 -1
  236. package/dist-types/ts3.4/commands/GetQueryResultsCommand.d.ts +38 -0
  237. package/dist-types/ts3.4/commands/GetSearchResultsCommand.d.ts +38 -0
  238. package/dist-types/ts3.4/commands/InvokeAssistantCommand.d.ts +1 -1
  239. package/dist-types/ts3.4/commands/ListAccessPoliciesCommand.d.ts +1 -1
  240. package/dist-types/ts3.4/commands/ListActionsCommand.d.ts +1 -1
  241. package/dist-types/ts3.4/commands/ListApplicationsCommand.d.ts +38 -0
  242. package/dist-types/ts3.4/commands/ListAssetModelCompositeModelsCommand.d.ts +1 -1
  243. package/dist-types/ts3.4/commands/ListAssetModelPropertiesCommand.d.ts +1 -1
  244. package/dist-types/ts3.4/commands/ListAssetModelsCommand.d.ts +1 -1
  245. package/dist-types/ts3.4/commands/ListAssetPropertiesCommand.d.ts +1 -1
  246. package/dist-types/ts3.4/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  247. package/dist-types/ts3.4/commands/ListAssetsCommand.d.ts +1 -1
  248. package/dist-types/ts3.4/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  249. package/dist-types/ts3.4/commands/ListBulkImportJobsCommand.d.ts +1 -1
  250. package/dist-types/ts3.4/commands/ListCompositionRelationshipsCommand.d.ts +1 -1
  251. package/dist-types/ts3.4/commands/ListComputationModelDataBindingUsagesCommand.d.ts +1 -1
  252. package/dist-types/ts3.4/commands/ListComputationModelResolveToResourcesCommand.d.ts +1 -1
  253. package/dist-types/ts3.4/commands/ListComputationModelsCommand.d.ts +1 -1
  254. package/dist-types/ts3.4/commands/ListDashboardsCommand.d.ts +1 -1
  255. package/dist-types/ts3.4/commands/ListDatasetDataSegmentRelationshipsCommand.d.ts +42 -0
  256. package/dist-types/ts3.4/commands/ListDatasetDataSegmentsCommand.d.ts +42 -0
  257. package/dist-types/ts3.4/commands/ListDatasetExportJobsCommand.d.ts +39 -0
  258. package/dist-types/ts3.4/commands/ListDatasetsCommand.d.ts +1 -1
  259. package/dist-types/ts3.4/commands/ListEnrichmentJobsCommand.d.ts +39 -0
  260. package/dist-types/ts3.4/commands/ListExecutionsCommand.d.ts +1 -1
  261. package/dist-types/ts3.4/commands/ListGatewaysCommand.d.ts +1 -1
  262. package/dist-types/ts3.4/commands/ListPipelineExecutionsCommand.d.ts +39 -0
  263. package/dist-types/ts3.4/commands/ListPipelinesCommand.d.ts +38 -0
  264. package/dist-types/ts3.4/commands/ListQueriesCommand.d.ts +38 -0
  265. package/dist-types/ts3.4/commands/ListSearchesCommand.d.ts +38 -0
  266. package/dist-types/ts3.4/commands/ListTasksCommand.d.ts +38 -0
  267. package/dist-types/ts3.4/commands/ListWorkspacesCommand.d.ts +38 -0
  268. package/dist-types/ts3.4/commands/StartPipelineExecutionCommand.d.ts +39 -0
  269. package/dist-types/ts3.4/commands/StartQueryCommand.d.ts +38 -0
  270. package/dist-types/ts3.4/commands/StartSearchCommand.d.ts +38 -0
  271. package/dist-types/ts3.4/commands/UpdatePipelineCommand.d.ts +38 -0
  272. package/dist-types/ts3.4/commands/UpdateTaskCommand.d.ts +38 -0
  273. package/dist-types/ts3.4/commands/UpdateWorkspaceCommand.d.ts +38 -0
  274. package/dist-types/ts3.4/commands/index.d.ts +45 -0
  275. package/dist-types/ts3.4/models/enums.d.ts +188 -4
  276. package/dist-types/ts3.4/models/models_0.d.ts +550 -614
  277. package/dist-types/ts3.4/models/models_1.d.ts +1048 -4
  278. package/dist-types/ts3.4/pagination/DescribePipelineExecutionPaginator.d.ts +11 -0
  279. package/dist-types/ts3.4/pagination/GetQueryResultsPaginator.d.ts +11 -0
  280. package/dist-types/ts3.4/pagination/GetSearchResultsPaginator.d.ts +11 -0
  281. package/dist-types/ts3.4/pagination/ListApplicationsPaginator.d.ts +11 -0
  282. package/dist-types/ts3.4/pagination/ListDatasetDataSegmentRelationshipsPaginator.d.ts +11 -0
  283. package/dist-types/ts3.4/pagination/ListDatasetDataSegmentsPaginator.d.ts +11 -0
  284. package/dist-types/ts3.4/pagination/ListDatasetExportJobsPaginator.d.ts +11 -0
  285. package/dist-types/ts3.4/pagination/ListEnrichmentJobsPaginator.d.ts +11 -0
  286. package/dist-types/ts3.4/pagination/ListPipelineExecutionsPaginator.d.ts +11 -0
  287. package/dist-types/ts3.4/pagination/ListPipelinesPaginator.d.ts +11 -0
  288. package/dist-types/ts3.4/pagination/ListQueriesPaginator.d.ts +8 -0
  289. package/dist-types/ts3.4/pagination/ListSearchesPaginator.d.ts +11 -0
  290. package/dist-types/ts3.4/pagination/ListTasksPaginator.d.ts +8 -0
  291. package/dist-types/ts3.4/pagination/ListWorkspacesPaginator.d.ts +11 -0
  292. package/dist-types/ts3.4/pagination/index.d.ts +14 -0
  293. package/dist-types/ts3.4/schemas/schemas_0.d.ts +190 -0
  294. package/package.json +6 -6
@@ -1,5 +1,3232 @@
1
- import type { AssetModelVersionType, CapabilitySyncStatus, DisassociatedDataStorageState, EncryptionType, ListTimeSeriesType, Permission, PortalType, PropertyDataType, PropertyNotificationState, StorageType, WarmTierState } from "./enums";
2
- import type { ActionDefinition, Alarms, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelStatus, AssetPropertyBindingValue, AssetStatus, ColumnInfo, ComputationModelConfiguration, ComputationModelStatus, ConfigurationStatus, DatasetSource, DatasetStatus, Identity, ImageFile, LoggingOptions, MultiLayerStorage, PortalStatus, PortalTypeEntry, PropertyMapping, Resource, RetentionPeriod, WarmTierRetentionPeriod } from "./models_0";
1
+ import type { AggregateType, AssetModelType, AssetModelVersionType, CapabilitySyncStatus, ComputationModelType, DatasetExportJobFilter, DatasetExportJobStatus, DatasetSourceType, DatasetTypeEnum, DisassociatedDataStorageState, EncryptionType, EnrichmentJobStatus, EnrichmentStatus, IdentityType, JobStatus, JobType, ListAssetModelPropertiesFilter, ListAssetPropertiesFilter, ListAssetsFilter, ListBulkImportJobsFilter, ListTimeSeriesType, Permission, PipelineExecutionState, PortalType, PropertyDataType, PropertyNotificationState, Quality, QueryStatus, ResolveToResourceType, ResourceType, ScalarType, SearchStatus, SearchType, StorageType, TargetResourceType, TimeOrdering, TraversalDirection, TraversalType, VideoDataType, WarmTierState } from "./enums";
2
+ import type { AccessDeniedException, ConflictingOperationException, InternalFailureException, InvalidRequestException, LimitExceededException, ResourceNotFoundException, ThrottlingException } from "./errors";
3
+ import type { AccessPolicySummary, ActionDefinition, ActionPayload, ActionSummary, AggregatedValue, Alarms, ApplicationSummary, AssetBindingValueFilter, AssetModelBindingValueFilter, AssetModelCompositeModel, AssetModelCompositeModelPathSegment, AssetModelCompositeModelSummary, AssetModelHierarchy, AssetModelProperty, AssetModelPropertyBindingValue, AssetModelPropertyBindingValueFilter, AssetModelPropertySummary, AssetModelStatus, AssetModelSummary, AssetPropertyBindingValue, AssetPropertyBindingValueFilter, AssetPropertySummary, AssetPropertyValue, AssetRelationshipSummary, AssetStatus, AssetSummary, AssociatedAssetsSummary, ComputationModelConfiguration, ComputationModelStatus, ComputeNode, ConfigurationStatus, DatasetConfig, DatasetEnrichment, DatasetSource, DatasetStatus, ExecutionEnvironmentVariables, ExecutionStatus, FormatSettings, GatewayCapabilitySummary, GatewayPlatform, Identity, ImageFile, LoggingOptions, PipelineExecutionStatus, PortalStatus, PortalTypeEntry, PropertyMapping, ResolveTo, Resource, ResourceStatus, TargetResource, TaskConfiguration, TimeInNanos, Variant, WorkspaceEncryptionConfiguration, WorkspaceStatus } from "./models_0";
4
+ /**
5
+ * <p>Output of the DescribeSearch operation.</p>
6
+ * @public
7
+ */
8
+ export interface DescribeSearchResponse {
9
+ /**
10
+ * <p>The unique identifier of the search.</p>
11
+ * @public
12
+ */
13
+ searchId: string | undefined;
14
+ /**
15
+ * <p>The name of the workspace the search runs against.</p>
16
+ * @public
17
+ */
18
+ workspaceName: string | undefined;
19
+ /**
20
+ * <p>The current status of the search.</p>
21
+ * @public
22
+ */
23
+ status: SearchStatus | undefined;
24
+ /**
25
+ * <p>The natural-language query that was submitted for the search.</p>
26
+ * @public
27
+ */
28
+ queryStatement: string | undefined;
29
+ /**
30
+ * <p>The search strategy used for the search.</p>
31
+ * @public
32
+ */
33
+ searchType: SearchType | undefined;
34
+ /**
35
+ * <p>A human-readable explanation of the current status. Populated when the search has <code>FAILED</code>.</p>
36
+ * @public
37
+ */
38
+ statusReason?: string | undefined;
39
+ /**
40
+ * <p>The time at which the search was started.</p>
41
+ * @public
42
+ */
43
+ startedAt?: Date | undefined;
44
+ /**
45
+ * <p>The group identifier associated with the search, if one was supplied on the request.</p>
46
+ * @public
47
+ */
48
+ groupId?: string | undefined;
49
+ }
50
+ /**
51
+ * @public
52
+ */
53
+ export interface DescribeStorageConfigurationRequest {
54
+ }
55
+ /**
56
+ * <p>Contains information about a customer managed Amazon S3 bucket.</p>
57
+ * @public
58
+ */
59
+ export interface CustomerManagedS3Storage {
60
+ /**
61
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Amazon S3 object. For more information about how to find the ARN for an
62
+ * Amazon S3 object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html">Amazon S3 resources</a> in the
63
+ * <i>Amazon Simple Storage Service User Guide</i>.</p>
64
+ * @public
65
+ */
66
+ s3ResourceArn: string | undefined;
67
+ /**
68
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3.</p>
69
+ * @public
70
+ */
71
+ roleArn: string | undefined;
72
+ }
73
+ /**
74
+ * <p>Contains information about the storage destination.</p>
75
+ * @public
76
+ */
77
+ export interface MultiLayerStorage {
78
+ /**
79
+ * <p>Contains information about a customer managed Amazon S3 bucket.</p>
80
+ * @public
81
+ */
82
+ customerManagedS3Storage: CustomerManagedS3Storage | undefined;
83
+ }
84
+ /**
85
+ * <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
86
+ * @public
87
+ */
88
+ export interface RetentionPeriod {
89
+ /**
90
+ * <p>The number of days that your data is kept.</p>
91
+ * <note>
92
+ * <p>If you specified a value for this parameter, the <code>unlimited</code> parameter must
93
+ * be <code>false</code>.</p>
94
+ * </note>
95
+ * @public
96
+ */
97
+ numberOfDays?: number | undefined;
98
+ /**
99
+ * <p>If true, your data is kept indefinitely.</p>
100
+ * <note>
101
+ * <p>If configured to <code>true</code>, you must not specify a value for the
102
+ * <code>numberOfDays</code> parameter.</p>
103
+ * </note>
104
+ * @public
105
+ */
106
+ unlimited?: boolean | undefined;
107
+ }
108
+ /**
109
+ * <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
110
+ * @public
111
+ */
112
+ export interface WarmTierRetentionPeriod {
113
+ /**
114
+ * <p>The number of days the data is stored in the warm tier.</p>
115
+ * @public
116
+ */
117
+ numberOfDays?: number | undefined;
118
+ /**
119
+ * <p>If set to true, the data is stored indefinitely in the warm tier.</p>
120
+ * @public
121
+ */
122
+ unlimited?: boolean | undefined;
123
+ }
124
+ /**
125
+ * @public
126
+ */
127
+ export interface DescribeStorageConfigurationResponse {
128
+ /**
129
+ * <p>The storage tier that you specified for your data.
130
+ * The <code>storageType</code> parameter can be one of the following values:</p>
131
+ * <ul>
132
+ * <li>
133
+ * <p>
134
+ * <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
135
+ * The hot tier is a service-managed database.</p>
136
+ * </li>
137
+ * <li>
138
+ * <p>
139
+ * <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the hot tier.
140
+ * The cold tier is a customer-managed Amazon S3 bucket.</p>
141
+ * </li>
142
+ * </ul>
143
+ * @public
144
+ */
145
+ storageType: StorageType | undefined;
146
+ /**
147
+ * <p>Contains information about the storage destination.</p>
148
+ * @public
149
+ */
150
+ multiLayerStorage?: MultiLayerStorage | undefined;
151
+ /**
152
+ * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
153
+ * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
154
+ * <ul>
155
+ * <li>
156
+ * <p>
157
+ * <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
158
+ * <important>
159
+ * <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
160
+ * </important>
161
+ * </li>
162
+ * <li>
163
+ * <p>
164
+ * <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
165
+ * </li>
166
+ * </ul>
167
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
168
+ * in the <i>IoT SiteWise User Guide</i>.</p>
169
+ * @public
170
+ */
171
+ disassociatedDataStorage?: DisassociatedDataStorageState | undefined;
172
+ /**
173
+ * <p>The number of days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
174
+ * @public
175
+ */
176
+ retentionPeriod?: RetentionPeriod | undefined;
177
+ /**
178
+ * <p>Contains current status information for the configuration.</p>
179
+ * @public
180
+ */
181
+ configurationStatus: ConfigurationStatus | undefined;
182
+ /**
183
+ * <p>The date the storage configuration was last updated, in Unix epoch time.</p>
184
+ * @public
185
+ */
186
+ lastUpdateDate?: Date | undefined;
187
+ /**
188
+ * <p>A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.</p>
189
+ * @public
190
+ */
191
+ warmTier?: WarmTierState | undefined;
192
+ /**
193
+ * <p>Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.</p>
194
+ * @public
195
+ */
196
+ warmTierRetentionPeriod?: WarmTierRetentionPeriod | undefined;
197
+ /**
198
+ * <p>Describes the configuration for ingesting NULL and NaN data. By default the feature is
199
+ * allowed. The feature is disallowed if the value is <code>true</code>.</p>
200
+ * @public
201
+ */
202
+ disallowIngestNullNaN?: boolean | undefined;
203
+ }
204
+ /**
205
+ * <p>Request structure for DescribeTask operation.</p>
206
+ * @public
207
+ */
208
+ export interface DescribeTaskRequest {
209
+ /**
210
+ * <p>The name of the workspace.</p>
211
+ * @public
212
+ */
213
+ workspaceName: string | undefined;
214
+ /**
215
+ * <p>The name of the task.</p>
216
+ * @public
217
+ */
218
+ taskName: string | undefined;
219
+ /**
220
+ * <p>The version number of the task to retrieve. If not specified, returns the latest version.</p>
221
+ * @public
222
+ */
223
+ taskVersion?: string | undefined;
224
+ }
225
+ /**
226
+ * <p>Response structure for DescribeTask operation.</p>
227
+ * @public
228
+ */
229
+ export interface DescribeTaskResponse {
230
+ /**
231
+ * <p>The name of the workspace.</p>
232
+ * @public
233
+ */
234
+ workspaceName: string | undefined;
235
+ /**
236
+ * <p>The name of the task.</p>
237
+ * @public
238
+ */
239
+ taskName: string | undefined;
240
+ /**
241
+ * <p>The description of the task.</p>
242
+ * @public
243
+ */
244
+ description?: string | undefined;
245
+ /**
246
+ * <p>The ARN of the task.</p>
247
+ * @public
248
+ */
249
+ taskArn: string | undefined;
250
+ /**
251
+ * <p>The version of the task.</p>
252
+ * @public
253
+ */
254
+ version: string | undefined;
255
+ /**
256
+ * <p>The task execution configuration. Contains a <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_ContainerTaskConfiguration.html">containerTaskConfiguration</a> for custom container workloads.</p>
257
+ * @public
258
+ */
259
+ taskConfiguration: TaskConfiguration | undefined;
260
+ /**
261
+ * <p>The current lifecycle status of the task.</p>
262
+ * @public
263
+ */
264
+ status: ResourceStatus | undefined;
265
+ /**
266
+ * <p>The time the task was created, in Unix epoch time.</p>
267
+ * @public
268
+ */
269
+ createdAt: Date | undefined;
270
+ /**
271
+ * <p>The time the task was last updated, in Unix epoch time.</p>
272
+ * @public
273
+ */
274
+ updatedAt: Date | undefined;
275
+ }
276
+ /**
277
+ * @public
278
+ */
279
+ export interface DescribeTimeSeriesRequest {
280
+ /**
281
+ * <p>The alias that identifies the time series.</p>
282
+ * @public
283
+ */
284
+ alias?: string | undefined;
285
+ /**
286
+ * <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
287
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
288
+ * @public
289
+ */
290
+ assetId?: string | undefined;
291
+ /**
292
+ * <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
293
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
294
+ * @public
295
+ */
296
+ propertyId?: string | undefined;
297
+ /**
298
+ * <p>The name of the workspace.</p>
299
+ * @public
300
+ */
301
+ workspaceName?: string | undefined;
302
+ }
303
+ /**
304
+ * @public
305
+ */
306
+ export interface DescribeTimeSeriesResponse {
307
+ /**
308
+ * <p>The ID of the asset in which the asset property was created.</p>
309
+ * @public
310
+ */
311
+ assetId?: string | undefined;
312
+ /**
313
+ * <p>The ID of the asset property, in UUID format.</p>
314
+ * @public
315
+ */
316
+ propertyId?: string | undefined;
317
+ /**
318
+ * <p>The alias that identifies the time series.</p>
319
+ * @public
320
+ */
321
+ alias?: string | undefined;
322
+ /**
323
+ * <p>The ID of the time series.</p>
324
+ * @public
325
+ */
326
+ timeSeriesId: string | undefined;
327
+ /**
328
+ * <p>The data type of the time series.</p>
329
+ * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
330
+ * @public
331
+ */
332
+ dataType: PropertyDataType | undefined;
333
+ /**
334
+ * <p>The data type of the structure for this time series. This parameter is required for time series
335
+ * that have the <code>STRUCT</code> data type.</p>
336
+ * <p>The options for this parameter depend on the type of the composite model
337
+ * in which you created the asset property that is associated with your time series.
338
+ * Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
339
+ * @public
340
+ */
341
+ dataTypeSpec?: string | undefined;
342
+ /**
343
+ * <p>The date that the time series was created, in Unix epoch time.</p>
344
+ * @public
345
+ */
346
+ timeSeriesCreationDate: Date | undefined;
347
+ /**
348
+ * <p>The date that the time series was last updated, in Unix epoch time.</p>
349
+ * @public
350
+ */
351
+ timeSeriesLastUpdateDate: Date | undefined;
352
+ /**
353
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
354
+ * <p>
355
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
356
+ * </p>
357
+ * @public
358
+ */
359
+ timeSeriesArn: string | undefined;
360
+ /**
361
+ * <p>The name of the workspace.</p>
362
+ * @public
363
+ */
364
+ workspaceName?: string | undefined;
365
+ }
366
+ /**
367
+ * @public
368
+ */
369
+ export interface DescribeWorkspaceRequest {
370
+ /**
371
+ * <p>The name of the workspace.</p>
372
+ * @public
373
+ */
374
+ workspaceName: string | undefined;
375
+ }
376
+ /**
377
+ * <p>Contains the encryption configuration information for a workspace.</p>
378
+ * @public
379
+ */
380
+ export interface WorkspaceEncryptionConfigurationInfo {
381
+ /**
382
+ * <p>The type of encryption used for the workspace.</p>
383
+ * @public
384
+ */
385
+ encryptionType: EncryptionType | undefined;
386
+ /**
387
+ * <p>The key ARN of the KMS key used for KMS encryption if <code>encryptionType</code>
388
+ * is <code>KMS_BASED_ENCRYPTION</code>.</p>
389
+ * @public
390
+ */
391
+ kmsKeyArn?: string | undefined;
392
+ }
393
+ /**
394
+ * @public
395
+ */
396
+ export interface DescribeWorkspaceResponse {
397
+ /**
398
+ * <p>The ARN of the workspace.</p>
399
+ * @public
400
+ */
401
+ workspaceArn: string | undefined;
402
+ /**
403
+ * <p>The name of the workspace.</p>
404
+ * @public
405
+ */
406
+ workspaceName: string | undefined;
407
+ /**
408
+ * <p>The description of the workspace.</p>
409
+ * @public
410
+ */
411
+ workspaceDescription?: string | undefined;
412
+ /**
413
+ * <p>The status of the workspace, which contains the state and any error message.</p>
414
+ * @public
415
+ */
416
+ workspaceStatus: WorkspaceStatus | undefined;
417
+ /**
418
+ * <p>The encryption configuration information for the workspace.</p>
419
+ * @public
420
+ */
421
+ encryptionConfiguration?: WorkspaceEncryptionConfigurationInfo | undefined;
422
+ /**
423
+ * <p>The date the workspace was created, in Unix epoch time.</p>
424
+ * @public
425
+ */
426
+ createdAt: Date | undefined;
427
+ /**
428
+ * <p>The date the workspace was last updated, in Unix epoch time.</p>
429
+ * @public
430
+ */
431
+ updatedAt: Date | undefined;
432
+ }
433
+ /**
434
+ * @public
435
+ */
436
+ export interface DisassociateAssetsRequest {
437
+ /**
438
+ * <p>The ID of the parent asset from which to disassociate the child asset.
439
+ * This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
440
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
441
+ * @public
442
+ */
443
+ assetId: string | undefined;
444
+ /**
445
+ * <p>The ID of a hierarchy in the parent asset's model. (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
446
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.) Hierarchies allow
447
+ * different groupings of assets to be formed that all come from the same asset model. You can
448
+ * use the hierarchy ID to identify the correct asset to disassociate. For more information, see
449
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
450
+ * @public
451
+ */
452
+ hierarchyId: string | undefined;
453
+ /**
454
+ * <p>The ID of the child asset to disassociate. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
455
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
456
+ * @public
457
+ */
458
+ childAssetId: string | undefined;
459
+ /**
460
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
461
+ * @public
462
+ */
463
+ clientToken?: string | undefined;
464
+ }
465
+ /**
466
+ * @public
467
+ */
468
+ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
469
+ /**
470
+ * <p>The alias that identifies the time series.</p>
471
+ * @public
472
+ */
473
+ alias: string | undefined;
474
+ /**
475
+ * <p>The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
476
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
477
+ * @public
478
+ */
479
+ assetId: string | undefined;
480
+ /**
481
+ * <p>The ID of the asset property. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
482
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
483
+ * @public
484
+ */
485
+ propertyId: string | undefined;
486
+ /**
487
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
488
+ * @public
489
+ */
490
+ clientToken?: string | undefined;
491
+ }
492
+ /**
493
+ * @public
494
+ */
495
+ export interface ExecuteActionRequest {
496
+ /**
497
+ * <p>The resource the action will be taken on.</p>
498
+ * @public
499
+ */
500
+ targetResource: TargetResource | undefined;
501
+ /**
502
+ * <p>The ID of the action definition.</p>
503
+ * @public
504
+ */
505
+ actionDefinitionId: string | undefined;
506
+ /**
507
+ * <p>The JSON payload of the action.</p>
508
+ * @public
509
+ */
510
+ actionPayload: ActionPayload | undefined;
511
+ /**
512
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
513
+ * @public
514
+ */
515
+ clientToken?: string | undefined;
516
+ /**
517
+ * <p>The detailed resource this action resolves to.</p>
518
+ * @public
519
+ */
520
+ resolveTo?: ResolveTo | undefined;
521
+ }
522
+ /**
523
+ * @public
524
+ */
525
+ export interface ExecuteActionResponse {
526
+ /**
527
+ * <p>The ID of the action.</p>
528
+ * @public
529
+ */
530
+ actionId: string | undefined;
531
+ }
532
+ /**
533
+ * @public
534
+ */
535
+ export interface ExecuteQueryRequest {
536
+ /**
537
+ * <p>The IoT SiteWise query statement.</p>
538
+ * @public
539
+ */
540
+ queryStatement: string | undefined;
541
+ /**
542
+ * <p>The string that specifies the next page of results.</p>
543
+ * @public
544
+ */
545
+ nextToken?: string | undefined;
546
+ /**
547
+ * <p>The maximum number of results to return at one time.</p>
548
+ * <ul>
549
+ * <li>
550
+ * <p>Minimum is 1</p>
551
+ * </li>
552
+ * <li>
553
+ * <p>Maximum is 20000</p>
554
+ * </li>
555
+ * <li>
556
+ * <p>Default is 20000</p>
557
+ * </li>
558
+ * </ul>
559
+ * @public
560
+ */
561
+ maxResults?: number | undefined;
562
+ /**
563
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
564
+ * @public
565
+ */
566
+ clientToken?: string | undefined;
567
+ }
568
+ /**
569
+ * <p>The data type of the column.</p>
570
+ * @public
571
+ */
572
+ export interface ColumnType {
573
+ /**
574
+ * <p>The allowed data types that the column has as it's value.</p>
575
+ * @public
576
+ */
577
+ scalarType?: ScalarType | undefined;
578
+ }
579
+ /**
580
+ * <p>A description of the column in the query results.</p>
581
+ * @public
582
+ */
583
+ export interface ColumnInfo {
584
+ /**
585
+ * <p>The name of the column description.</p>
586
+ * @public
587
+ */
588
+ name?: string | undefined;
589
+ /**
590
+ * <p>The type of the column description.</p>
591
+ * @public
592
+ */
593
+ type?: ColumnType | undefined;
594
+ }
595
+ /**
596
+ * @public
597
+ */
598
+ export interface GetAssetPropertyAggregatesRequest {
599
+ /**
600
+ * <p>The ID of the asset, in UUID format.</p>
601
+ * @public
602
+ */
603
+ assetId?: string | undefined;
604
+ /**
605
+ * <p>The ID of the asset property, in UUID format.</p>
606
+ * @public
607
+ */
608
+ propertyId?: string | undefined;
609
+ /**
610
+ * <p>The alias that identifies the property, such as an OPC-UA server data stream path
611
+ * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
612
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
613
+ * <i>IoT SiteWise User Guide</i>.</p>
614
+ * @public
615
+ */
616
+ propertyAlias?: string | undefined;
617
+ /**
618
+ * <p>The data aggregating function.</p>
619
+ * @public
620
+ */
621
+ aggregateTypes: AggregateType[] | undefined;
622
+ /**
623
+ * <p>The time interval over which to aggregate data.</p>
624
+ * @public
625
+ */
626
+ resolution: string | undefined;
627
+ /**
628
+ * <p>The quality by which to filter asset data.</p>
629
+ * @public
630
+ */
631
+ qualities?: Quality[] | undefined;
632
+ /**
633
+ * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
634
+ * @public
635
+ */
636
+ startDate: Date | undefined;
637
+ /**
638
+ * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
639
+ * @public
640
+ */
641
+ endDate: Date | undefined;
642
+ /**
643
+ * <p>The chronological sorting order of the requested information.</p>
644
+ * <p>Default: <code>ASCENDING</code>
645
+ * </p>
646
+ * @public
647
+ */
648
+ timeOrdering?: TimeOrdering | undefined;
649
+ /**
650
+ * <p>The token to be used for the next set of paginated results.</p>
651
+ * @public
652
+ */
653
+ nextToken?: string | undefined;
654
+ /**
655
+ * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
656
+ * first.</p>
657
+ * <ul>
658
+ * <li>
659
+ * <p>The size of the result set is equal to 1 MB.</p>
660
+ * </li>
661
+ * <li>
662
+ * <p>The number of data points in the result set is equal to the value of
663
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 2500.</p>
664
+ * </li>
665
+ * </ul>
666
+ * @public
667
+ */
668
+ maxResults?: number | undefined;
669
+ }
670
+ /**
671
+ * @public
672
+ */
673
+ export interface GetAssetPropertyAggregatesResponse {
674
+ /**
675
+ * <p>The requested aggregated values.</p>
676
+ * @public
677
+ */
678
+ aggregatedValues: AggregatedValue[] | undefined;
679
+ /**
680
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
681
+ * @public
682
+ */
683
+ nextToken?: string | undefined;
684
+ }
685
+ /**
686
+ * @public
687
+ */
688
+ export interface GetAssetPropertyValueRequest {
689
+ /**
690
+ * <p>The ID of the asset, in UUID format.</p>
691
+ * @public
692
+ */
693
+ assetId?: string | undefined;
694
+ /**
695
+ * <p>The ID of the asset property, in UUID format.</p>
696
+ * @public
697
+ */
698
+ propertyId?: string | undefined;
699
+ /**
700
+ * <p>The alias that identifies the property, such as an OPC-UA server data stream path
701
+ * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
702
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
703
+ * <i>IoT SiteWise User Guide</i>.</p>
704
+ * @public
705
+ */
706
+ propertyAlias?: string | undefined;
707
+ }
708
+ /**
709
+ * @public
710
+ */
711
+ export interface GetAssetPropertyValueResponse {
712
+ /**
713
+ * <p>The current asset property value.</p>
714
+ * @public
715
+ */
716
+ propertyValue?: AssetPropertyValue | undefined;
717
+ }
718
+ /**
719
+ * @public
720
+ */
721
+ export interface GetAssetPropertyValueHistoryRequest {
722
+ /**
723
+ * <p>The ID of the asset, in UUID format.</p>
724
+ * @public
725
+ */
726
+ assetId?: string | undefined;
727
+ /**
728
+ * <p>The ID of the asset property, in UUID format.</p>
729
+ * @public
730
+ */
731
+ propertyId?: string | undefined;
732
+ /**
733
+ * <p>The alias that identifies the property, such as an OPC-UA server data stream path
734
+ * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
735
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
736
+ * <i>IoT SiteWise User Guide</i>.</p>
737
+ * @public
738
+ */
739
+ propertyAlias?: string | undefined;
740
+ /**
741
+ * <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
742
+ * @public
743
+ */
744
+ startDate?: Date | undefined;
745
+ /**
746
+ * <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
747
+ * @public
748
+ */
749
+ endDate?: Date | undefined;
750
+ /**
751
+ * <p>The quality by which to filter asset data.</p>
752
+ * @public
753
+ */
754
+ qualities?: Quality[] | undefined;
755
+ /**
756
+ * <p>The chronological sorting order of the requested information.</p>
757
+ * <p>Default: <code>ASCENDING</code>
758
+ * </p>
759
+ * @public
760
+ */
761
+ timeOrdering?: TimeOrdering | undefined;
762
+ /**
763
+ * <p>The token to be used for the next set of paginated results.</p>
764
+ * @public
765
+ */
766
+ nextToken?: string | undefined;
767
+ /**
768
+ * <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs
769
+ * first.</p>
770
+ * <ul>
771
+ * <li>
772
+ * <p>The size of the result set is equal to 4 MB.</p>
773
+ * </li>
774
+ * <li>
775
+ * <p>The number of data points in the result set is equal to the value of
776
+ * <code>maxResults</code>. The maximum value of <code>maxResults</code> is 20000.</p>
777
+ * </li>
778
+ * </ul>
779
+ * @public
780
+ */
781
+ maxResults?: number | undefined;
782
+ }
783
+ /**
784
+ * @public
785
+ */
786
+ export interface GetAssetPropertyValueHistoryResponse {
787
+ /**
788
+ * <p>The asset property's value history.</p>
789
+ * @public
790
+ */
791
+ assetPropertyValueHistory: AssetPropertyValue[] | undefined;
792
+ /**
793
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
794
+ * @public
795
+ */
796
+ nextToken?: string | undefined;
797
+ }
798
+ /**
799
+ * <p>Request to retrieve video data for a specific time range. Exactly one of timeSeriesId or propertyAlias must be provided.</p>
800
+ * @public
801
+ */
802
+ export interface GetCaptureDataRequest {
803
+ /**
804
+ * <p>The name of the workspace that contains the capture source.</p>
805
+ * @public
806
+ */
807
+ workspaceName: string | undefined;
808
+ /**
809
+ * <p>The start time for the video data range.</p>
810
+ * @public
811
+ */
812
+ startTime: TimeInNanos | undefined;
813
+ /**
814
+ * <p>The end time for the video data range. Must be greater than startTime.</p>
815
+ * @public
816
+ */
817
+ endTime: TimeInNanos | undefined;
818
+ /**
819
+ * <p>The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.</p>
820
+ * @public
821
+ */
822
+ timeSeriesId?: string | undefined;
823
+ /**
824
+ * <p>The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.</p>
825
+ * @public
826
+ */
827
+ propertyAlias?: string | undefined;
828
+ /**
829
+ * <p>The optional format settings for the output.</p>
830
+ * @public
831
+ */
832
+ formatSettings?: FormatSettings | undefined;
833
+ /**
834
+ * <p>The token from a previous response used to continue retrieving data.</p>
835
+ * @public
836
+ */
837
+ nextToken?: string | undefined;
838
+ }
839
+ /**
840
+ * <p>Response containing the video data.</p>
841
+ * @public
842
+ */
843
+ export interface GetCaptureDataResponse {
844
+ /**
845
+ * <p>The binary video data.</p>
846
+ * @public
847
+ */
848
+ data: Uint8Array | undefined;
849
+ /**
850
+ * <p>The actual start time of the returned data.</p>
851
+ * @public
852
+ */
853
+ startTime: TimeInNanos | undefined;
854
+ /**
855
+ * <p>The actual end time of the returned data.</p>
856
+ * @public
857
+ */
858
+ endTime: TimeInNanos | undefined;
859
+ /**
860
+ * <p>The type of the returned data.</p>
861
+ * @public
862
+ */
863
+ dataType: VideoDataType | undefined;
864
+ /**
865
+ * <p>The token used to retrieve the next chunk. Absent if no more data is available.</p>
866
+ * @public
867
+ */
868
+ nextToken?: string | undefined;
869
+ }
870
+ /**
871
+ * @public
872
+ */
873
+ export interface GetInterpolatedAssetPropertyValuesRequest {
874
+ /**
875
+ * <p>The ID of the asset, in UUID format.</p>
876
+ * @public
877
+ */
878
+ assetId?: string | undefined;
879
+ /**
880
+ * <p>The ID of the asset property, in UUID format.</p>
881
+ * @public
882
+ */
883
+ propertyId?: string | undefined;
884
+ /**
885
+ * <p>The alias that identifies the property, such as an OPC-UA server data stream path
886
+ * (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
887
+ * <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
888
+ * <i>IoT SiteWise User Guide</i>.</p>
889
+ * @public
890
+ */
891
+ propertyAlias?: string | undefined;
892
+ /**
893
+ * <p>The exclusive start of the range from which to interpolate data, expressed in seconds in
894
+ * Unix epoch time.</p>
895
+ * @public
896
+ */
897
+ startTimeInSeconds: number | undefined;
898
+ /**
899
+ * <p>The nanosecond offset converted from <code>startTimeInSeconds</code>.</p>
900
+ * @public
901
+ */
902
+ startTimeOffsetInNanos?: number | undefined;
903
+ /**
904
+ * <p>The inclusive end of the range from which to interpolate data, expressed in seconds in
905
+ * Unix epoch time.</p>
906
+ * @public
907
+ */
908
+ endTimeInSeconds: number | undefined;
909
+ /**
910
+ * <p>The nanosecond offset converted from <code>endTimeInSeconds</code>.</p>
911
+ * @public
912
+ */
913
+ endTimeOffsetInNanos?: number | undefined;
914
+ /**
915
+ * <p>The quality of the asset property value. You can use this parameter as a filter to choose
916
+ * only the asset property values that have a specific quality.</p>
917
+ * @public
918
+ */
919
+ quality: Quality | undefined;
920
+ /**
921
+ * <p>The time interval in seconds over which to interpolate data. Each interval starts when the
922
+ * previous one ends.</p>
923
+ * @public
924
+ */
925
+ intervalInSeconds: number | undefined;
926
+ /**
927
+ * <p>The token to be used for the next set of paginated results.</p>
928
+ * @public
929
+ */
930
+ nextToken?: string | undefined;
931
+ /**
932
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 10.</p>
933
+ * @public
934
+ */
935
+ maxResults?: number | undefined;
936
+ /**
937
+ * <p>The interpolation type.</p>
938
+ * <p>Valid values: <code>LINEAR_INTERPOLATION | LOCF_INTERPOLATION</code>
939
+ * </p>
940
+ * <ul>
941
+ * <li>
942
+ * <p>
943
+ * <code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear
944
+ * interpolation</a>.</p>
945
+ * <p>For example, you can use this operation to return the interpolated temperature values
946
+ * for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts
947
+ * July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM,
948
+ * the second interpolated value on July 3, 2021, at 9 AM, and so on.</p>
949
+ * </li>
950
+ * <li>
951
+ * <p>
952
+ * <code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation
953
+ * carried forward interpolation</p>
954
+ * <p>If no data point is found for an interval, IoT SiteWise returns the last observed data point
955
+ * for the previous interval and carries forward this interpolated value until a new data
956
+ * point is found.</p>
957
+ * <p>For example, you can get the state of an on-off valve every 24 hours over a duration
958
+ * of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last
959
+ * observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
960
+ * interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the
961
+ * same interpolated value for the rest of the days.</p>
962
+ * </li>
963
+ * </ul>
964
+ * @public
965
+ */
966
+ type: string | undefined;
967
+ /**
968
+ * <p>The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by
969
+ * using data points from the timestamp of each interval, minus the window to the timestamp of
970
+ * each interval plus the window. If not specified, the window ranges between the start time
971
+ * minus the interval and the end time plus the interval.</p>
972
+ * <note>
973
+ * <ul>
974
+ * <li>
975
+ * <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter, the
976
+ * value for the <code>type</code> parameter must be
977
+ * <code>LINEAR_INTERPOLATION</code>.</p>
978
+ * </li>
979
+ * <li>
980
+ * <p>If a data point isn't found during the specified query window, IoT SiteWise won't return an
981
+ * interpolated value for the interval. This indicates that there's a gap in the ingested
982
+ * data points.</p>
983
+ * </li>
984
+ * </ul>
985
+ * </note>
986
+ * <p>For example, you can get the interpolated temperature values for a wind turbine every 24
987
+ * hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a
988
+ * window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM
989
+ * plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the
990
+ * data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to
991
+ * compute the second interpolated value, and so on. </p>
992
+ * @public
993
+ */
994
+ intervalWindowInSeconds?: number | undefined;
995
+ }
996
+ /**
997
+ * <p>Contains information about an interpolated asset property value.</p>
998
+ * @public
999
+ */
1000
+ export interface InterpolatedAssetPropertyValue {
1001
+ /**
1002
+ * <p>Contains a timestamp with optional nanosecond granularity.</p>
1003
+ * @public
1004
+ */
1005
+ timestamp: TimeInNanos | undefined;
1006
+ /**
1007
+ * <p>Contains an asset property value (of a single type only).</p>
1008
+ * @public
1009
+ */
1010
+ value: Variant | undefined;
1011
+ }
1012
+ /**
1013
+ * @public
1014
+ */
1015
+ export interface GetInterpolatedAssetPropertyValuesResponse {
1016
+ /**
1017
+ * <p>The requested interpolated values.</p>
1018
+ * @public
1019
+ */
1020
+ interpolatedAssetPropertyValues: InterpolatedAssetPropertyValue[] | undefined;
1021
+ /**
1022
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1023
+ * @public
1024
+ */
1025
+ nextToken?: string | undefined;
1026
+ }
1027
+ /**
1028
+ * @public
1029
+ */
1030
+ export interface GetQueryResultsRequest {
1031
+ /**
1032
+ * <p>The name of the workspace associated with the query.</p>
1033
+ * @public
1034
+ */
1035
+ workspaceName: string | undefined;
1036
+ /**
1037
+ * <p>The unique identifier for the query execution.</p>
1038
+ * @public
1039
+ */
1040
+ queryId: string | undefined;
1041
+ /**
1042
+ * <p>The maximum number of results to return for each paginated request.</p>
1043
+ * @public
1044
+ */
1045
+ maxResults?: number | undefined;
1046
+ /**
1047
+ * <p>The token to be used for the next set of paginated results.</p>
1048
+ * @public
1049
+ */
1050
+ nextToken?: string | undefined;
1051
+ }
1052
+ /**
1053
+ * <p>Contains metadata about a column in the query results.</p>
1054
+ * @public
1055
+ */
1056
+ export interface ColumnInformation {
1057
+ /**
1058
+ * <p>The name of the column.</p>
1059
+ * @public
1060
+ */
1061
+ name: string | undefined;
1062
+ /**
1063
+ * <p>The data type of the column. Valid values are STRING, DOUBLE, BOOLEAN, INTEGER, TIMESTAMP, and VARIANT.</p>
1064
+ * @public
1065
+ */
1066
+ type: string | undefined;
1067
+ }
1068
+ /**
1069
+ * <p>Contains the response for the GetQueryResults operation.</p>
1070
+ * @public
1071
+ */
1072
+ export interface GetQueryResultsResponse {
1073
+ /**
1074
+ * <p>A list of column metadata for the query results. Each entry contains the column name and data type. Present when the query status is COMPLETED.</p>
1075
+ * @public
1076
+ */
1077
+ columnInfo?: ColumnInformation[] | undefined;
1078
+ /**
1079
+ * <p>The result rows. Each row is a list of string column values, positional to match the columnInfo order. Present when the query status is COMPLETED.</p>
1080
+ * @public
1081
+ */
1082
+ rows?: (string | null)[][] | undefined;
1083
+ /**
1084
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1085
+ * @public
1086
+ */
1087
+ nextToken?: string | undefined;
1088
+ }
1089
+ /**
1090
+ * <p>Input for the GetSearchResults operation.</p>
1091
+ * @public
1092
+ */
1093
+ export interface GetSearchResultsRequest {
1094
+ /**
1095
+ * <p>The identifier of the search whose results are retrieved.</p>
1096
+ * @public
1097
+ */
1098
+ searchId: string | undefined;
1099
+ /**
1100
+ * <p>The name of the workspace the search belongs to.</p>
1101
+ * @public
1102
+ */
1103
+ workspaceName: string | undefined;
1104
+ /**
1105
+ * <p>The maximum number of results to return in a single page. Valid range is 1 to 10,000; if
1106
+ * omitted, a service-defined default is used.</p>
1107
+ * @public
1108
+ */
1109
+ maxResults?: number | undefined;
1110
+ /**
1111
+ * <p>The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the
1112
+ * next page of results; omit it to retrieve the first page.</p>
1113
+ * @public
1114
+ */
1115
+ nextToken?: string | undefined;
1116
+ }
1117
+ /**
1118
+ * <p>A single matching segment of time-series data returned by a search.</p>
1119
+ * @public
1120
+ */
1121
+ export interface SearchResult {
1122
+ /**
1123
+ * <p>The identifier of the search that produced this result.</p>
1124
+ * @public
1125
+ */
1126
+ searchId: string | undefined;
1127
+ /**
1128
+ * <p>The name of the workspace the search ran against.</p>
1129
+ * @public
1130
+ */
1131
+ workspaceName: string | undefined;
1132
+ /**
1133
+ * <p>The identifier of the dataset that contains the matching data.</p>
1134
+ * @public
1135
+ */
1136
+ datasetId: string | undefined;
1137
+ /**
1138
+ * <p>The identifier of the time series that contains the matching data.</p>
1139
+ * @public
1140
+ */
1141
+ timeSeriesId: string | undefined;
1142
+ /**
1143
+ * <p>The start of the matching time-series segment, in nanoseconds since the Unix epoch.</p>
1144
+ * @public
1145
+ */
1146
+ startTimestamp: TimeInNanos | undefined;
1147
+ /**
1148
+ * <p>The end of the matching time-series segment, in nanoseconds since the Unix epoch.</p>
1149
+ * @public
1150
+ */
1151
+ endTimestamp: TimeInNanos | undefined;
1152
+ /**
1153
+ * <p>The timestamp of the most relevant point within the matching segment, in nanoseconds since the
1154
+ * Unix epoch.</p>
1155
+ * @public
1156
+ */
1157
+ topTimestamp: TimeInNanos | undefined;
1158
+ /**
1159
+ * <p>The relevance score of this result. Higher scores indicate a stronger match.</p>
1160
+ * @public
1161
+ */
1162
+ score: number | undefined;
1163
+ }
1164
+ /**
1165
+ * <p>Output of the GetSearchResults operation.</p>
1166
+ * @public
1167
+ */
1168
+ export interface GetSearchResultsResponse {
1169
+ /**
1170
+ * <p>A page of search results, ordered by descending relevance score.</p>
1171
+ * @public
1172
+ */
1173
+ searchResults: SearchResult[] | undefined;
1174
+ /**
1175
+ * <p>The pagination token to use in a subsequent GetSearchResults call to retrieve the next page.
1176
+ * Absent when there are no more results.</p>
1177
+ * @public
1178
+ */
1179
+ nextToken?: string | undefined;
1180
+ }
1181
+ /**
1182
+ * @public
1183
+ */
1184
+ export interface InvokeAssistantRequest {
1185
+ /**
1186
+ * <p>The ID assigned to a conversation. IoT SiteWise automatically generates a unique ID for you, and this parameter is never required.
1187
+ * However, if you prefer to have your own ID, you must specify it here in UUID format. If you specify your own ID, it must be globally unique.</p>
1188
+ * @public
1189
+ */
1190
+ conversationId?: string | undefined;
1191
+ /**
1192
+ * <p>A text message sent to the SiteWise Assistant by the user.</p>
1193
+ * @public
1194
+ */
1195
+ message: string | undefined;
1196
+ /**
1197
+ * <p>Specifies if to turn trace on or not. It is used to track the SiteWise Assistant's
1198
+ * reasoning, and data access process.</p>
1199
+ * @public
1200
+ */
1201
+ enableTrace?: boolean | undefined;
1202
+ }
1203
+ /**
1204
+ * <p>Contains the cited text from the data source.</p>
1205
+ * @public
1206
+ */
1207
+ export interface Content {
1208
+ /**
1209
+ * <p>The cited text from the data source.</p>
1210
+ * @public
1211
+ */
1212
+ text?: string | undefined;
1213
+ }
1214
+ /**
1215
+ * <p>Contains location information about the cited text and where it's stored.</p>
1216
+ * @public
1217
+ */
1218
+ export interface Location {
1219
+ /**
1220
+ * <p>The URI of the location.</p>
1221
+ * @public
1222
+ */
1223
+ uri?: string | undefined;
1224
+ }
1225
+ /**
1226
+ * <p>The data source for the dataset.</p>
1227
+ * @public
1228
+ */
1229
+ export interface Source {
1230
+ /**
1231
+ * <p>Contains the ARN of the dataset. If the source is Kendra, it's the ARN of the Kendra index.</p>
1232
+ * @public
1233
+ */
1234
+ arn?: string | undefined;
1235
+ /**
1236
+ * <p>Contains the location information where the cited text is originally stored.
1237
+ * For example, if the data source is Kendra, and the text synchronized is from an S3 bucket, then the location refers to an S3 object.</p>
1238
+ * @public
1239
+ */
1240
+ location?: Location | undefined;
1241
+ }
1242
+ /**
1243
+ * <p>Contains information about the dataset use and it's source.</p>
1244
+ * @public
1245
+ */
1246
+ export interface DataSetReference {
1247
+ /**
1248
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
1249
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
1250
+ * @public
1251
+ */
1252
+ datasetArn?: string | undefined;
1253
+ /**
1254
+ * <p>The data source for the dataset.</p>
1255
+ * @public
1256
+ */
1257
+ source?: Source | undefined;
1258
+ }
1259
+ /**
1260
+ * <p>Contains the reference information.</p>
1261
+ * @public
1262
+ */
1263
+ export interface Reference {
1264
+ /**
1265
+ * <p>Contains the dataset reference information.</p>
1266
+ * @public
1267
+ */
1268
+ dataset?: DataSetReference | undefined;
1269
+ }
1270
+ /**
1271
+ * <p>Contains text content to which the SiteWise Assistant refers to, and generate the final response.
1272
+ * It also contains information about the source.</p>
1273
+ * @public
1274
+ */
1275
+ export interface Citation {
1276
+ /**
1277
+ * <p>Contains information about the data source.</p>
1278
+ * @public
1279
+ */
1280
+ reference?: Reference | undefined;
1281
+ /**
1282
+ * <p>Contains the cited text from the data source.</p>
1283
+ * @public
1284
+ */
1285
+ content?: Content | undefined;
1286
+ }
1287
+ /**
1288
+ * <p>This contains the SiteWise Assistant's response and the corresponding citation.</p>
1289
+ * @public
1290
+ */
1291
+ export interface InvocationOutput {
1292
+ /**
1293
+ * <p>The text message of the SiteWise Assistant's response.</p>
1294
+ * @public
1295
+ */
1296
+ message?: string | undefined;
1297
+ /**
1298
+ * <p>A list of citations, and related information for the SiteWise Assistant's response.</p>
1299
+ * @public
1300
+ */
1301
+ citations?: Citation[] | undefined;
1302
+ }
1303
+ /**
1304
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
1305
+ * @public
1306
+ */
1307
+ export interface Trace {
1308
+ /**
1309
+ * <p>The cited text from the data source.</p>
1310
+ * @public
1311
+ */
1312
+ text?: string | undefined;
1313
+ }
1314
+ /**
1315
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
1316
+ * @public
1317
+ */
1318
+ export type ResponseStream = ResponseStream.AccessDeniedExceptionMember | ResponseStream.ConflictingOperationExceptionMember | ResponseStream.InternalFailureExceptionMember | ResponseStream.InvalidRequestExceptionMember | ResponseStream.LimitExceededExceptionMember | ResponseStream.OutputMember | ResponseStream.ResourceNotFoundExceptionMember | ResponseStream.ThrottlingExceptionMember | ResponseStream.TraceMember | ResponseStream.$UnknownMember;
1319
+ /**
1320
+ * @public
1321
+ */
1322
+ export declare namespace ResponseStream {
1323
+ /**
1324
+ * <p>Contains tracing information of the SiteWise Assistant's reasoning and data access.</p>
1325
+ * @public
1326
+ */
1327
+ interface TraceMember {
1328
+ trace: Trace;
1329
+ output?: never;
1330
+ accessDeniedException?: never;
1331
+ conflictingOperationException?: never;
1332
+ internalFailureException?: never;
1333
+ invalidRequestException?: never;
1334
+ limitExceededException?: never;
1335
+ resourceNotFoundException?: never;
1336
+ throttlingException?: never;
1337
+ $unknown?: never;
1338
+ }
1339
+ /**
1340
+ * <p>Contains the SiteWise Assistant's response.</p>
1341
+ * @public
1342
+ */
1343
+ interface OutputMember {
1344
+ trace?: never;
1345
+ output: InvocationOutput;
1346
+ accessDeniedException?: never;
1347
+ conflictingOperationException?: never;
1348
+ internalFailureException?: never;
1349
+ invalidRequestException?: never;
1350
+ limitExceededException?: never;
1351
+ resourceNotFoundException?: never;
1352
+ throttlingException?: never;
1353
+ $unknown?: never;
1354
+ }
1355
+ /**
1356
+ * <p>Access is denied.</p>
1357
+ * @public
1358
+ */
1359
+ interface AccessDeniedExceptionMember {
1360
+ trace?: never;
1361
+ output?: never;
1362
+ accessDeniedException: AccessDeniedException;
1363
+ conflictingOperationException?: never;
1364
+ internalFailureException?: never;
1365
+ invalidRequestException?: never;
1366
+ limitExceededException?: never;
1367
+ resourceNotFoundException?: never;
1368
+ throttlingException?: never;
1369
+ $unknown?: never;
1370
+ }
1371
+ /**
1372
+ * <p>Your request has conflicting operations. This can occur if you're trying to perform more
1373
+ * than one operation on the same resource at the same time.</p>
1374
+ * @public
1375
+ */
1376
+ interface ConflictingOperationExceptionMember {
1377
+ trace?: never;
1378
+ output?: never;
1379
+ accessDeniedException?: never;
1380
+ conflictingOperationException: ConflictingOperationException;
1381
+ internalFailureException?: never;
1382
+ invalidRequestException?: never;
1383
+ limitExceededException?: never;
1384
+ resourceNotFoundException?: never;
1385
+ throttlingException?: never;
1386
+ $unknown?: never;
1387
+ }
1388
+ /**
1389
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
1390
+ * @public
1391
+ */
1392
+ interface InternalFailureExceptionMember {
1393
+ trace?: never;
1394
+ output?: never;
1395
+ accessDeniedException?: never;
1396
+ conflictingOperationException?: never;
1397
+ internalFailureException: InternalFailureException;
1398
+ invalidRequestException?: never;
1399
+ limitExceededException?: never;
1400
+ resourceNotFoundException?: never;
1401
+ throttlingException?: never;
1402
+ $unknown?: never;
1403
+ }
1404
+ /**
1405
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
1406
+ * unsupported characters. Check your request and try again.</p>
1407
+ * @public
1408
+ */
1409
+ interface InvalidRequestExceptionMember {
1410
+ trace?: never;
1411
+ output?: never;
1412
+ accessDeniedException?: never;
1413
+ conflictingOperationException?: never;
1414
+ internalFailureException?: never;
1415
+ invalidRequestException: InvalidRequestException;
1416
+ limitExceededException?: never;
1417
+ resourceNotFoundException?: never;
1418
+ throttlingException?: never;
1419
+ $unknown?: never;
1420
+ }
1421
+ /**
1422
+ * <p>You've reached the quota for a resource. For example, this can occur if you're trying to
1423
+ * associate more than the allowed number of child assets or attempting to create more than the
1424
+ * allowed number of properties for an asset model.</p>
1425
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
1426
+ * @public
1427
+ */
1428
+ interface LimitExceededExceptionMember {
1429
+ trace?: never;
1430
+ output?: never;
1431
+ accessDeniedException?: never;
1432
+ conflictingOperationException?: never;
1433
+ internalFailureException?: never;
1434
+ invalidRequestException?: never;
1435
+ limitExceededException: LimitExceededException;
1436
+ resourceNotFoundException?: never;
1437
+ throttlingException?: never;
1438
+ $unknown?: never;
1439
+ }
1440
+ /**
1441
+ * <p>The requested resource can't be found.</p>
1442
+ * @public
1443
+ */
1444
+ interface ResourceNotFoundExceptionMember {
1445
+ trace?: never;
1446
+ output?: never;
1447
+ accessDeniedException?: never;
1448
+ conflictingOperationException?: never;
1449
+ internalFailureException?: never;
1450
+ invalidRequestException?: never;
1451
+ limitExceededException?: never;
1452
+ resourceNotFoundException: ResourceNotFoundException;
1453
+ throttlingException?: never;
1454
+ $unknown?: never;
1455
+ }
1456
+ /**
1457
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
1458
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
1459
+ * on.</p>
1460
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
1461
+ * @public
1462
+ */
1463
+ interface ThrottlingExceptionMember {
1464
+ trace?: never;
1465
+ output?: never;
1466
+ accessDeniedException?: never;
1467
+ conflictingOperationException?: never;
1468
+ internalFailureException?: never;
1469
+ invalidRequestException?: never;
1470
+ limitExceededException?: never;
1471
+ resourceNotFoundException?: never;
1472
+ throttlingException: ThrottlingException;
1473
+ $unknown?: never;
1474
+ }
1475
+ /**
1476
+ * @public
1477
+ */
1478
+ interface $UnknownMember {
1479
+ trace?: never;
1480
+ output?: never;
1481
+ accessDeniedException?: never;
1482
+ conflictingOperationException?: never;
1483
+ internalFailureException?: never;
1484
+ invalidRequestException?: never;
1485
+ limitExceededException?: never;
1486
+ resourceNotFoundException?: never;
1487
+ throttlingException?: never;
1488
+ $unknown: [string, any];
1489
+ }
1490
+ /**
1491
+ * @deprecated unused in schema-serde mode.
1492
+ *
1493
+ */
1494
+ interface Visitor<T> {
1495
+ trace: (value: Trace) => T;
1496
+ output: (value: InvocationOutput) => T;
1497
+ accessDeniedException: (value: AccessDeniedException) => T;
1498
+ conflictingOperationException: (value: ConflictingOperationException) => T;
1499
+ internalFailureException: (value: InternalFailureException) => T;
1500
+ invalidRequestException: (value: InvalidRequestException) => T;
1501
+ limitExceededException: (value: LimitExceededException) => T;
1502
+ resourceNotFoundException: (value: ResourceNotFoundException) => T;
1503
+ throttlingException: (value: ThrottlingException) => T;
1504
+ _: (name: string, value: any) => T;
1505
+ }
1506
+ }
1507
+ /**
1508
+ * @public
1509
+ */
1510
+ export interface InvokeAssistantResponse {
1511
+ /**
1512
+ * <p>Contains the response, citation, and trace from the SiteWise Assistant.</p>
1513
+ * @public
1514
+ */
1515
+ body: AsyncIterable<ResponseStream> | undefined;
1516
+ /**
1517
+ * <p>The ID of the conversation, in UUID format. This ID uniquely identifies the conversation within IoT SiteWise.</p>
1518
+ * @public
1519
+ */
1520
+ conversationId: string | undefined;
1521
+ }
1522
+ /**
1523
+ * @public
1524
+ */
1525
+ export interface ListAccessPoliciesRequest {
1526
+ /**
1527
+ * <p>The type of identity (IAM Identity Center user, IAM Identity Center group, or IAM user). This parameter is required
1528
+ * if you specify <code>identityId</code>.</p>
1529
+ * @public
1530
+ */
1531
+ identityType?: IdentityType | undefined;
1532
+ /**
1533
+ * <p>The ID of the identity. This parameter is required if you specify <code>USER</code> or
1534
+ * <code>GROUP</code> for <code>identityType</code>.</p>
1535
+ * @public
1536
+ */
1537
+ identityId?: string | undefined;
1538
+ /**
1539
+ * <p>The type of resource (portal or project). This parameter is required if you specify
1540
+ * <code>resourceId</code>.</p>
1541
+ * @public
1542
+ */
1543
+ resourceType?: ResourceType | undefined;
1544
+ /**
1545
+ * <p>The ID of the resource. This parameter is required if you specify
1546
+ * <code>resourceType</code>.</p>
1547
+ * @public
1548
+ */
1549
+ resourceId?: string | undefined;
1550
+ /**
1551
+ * <p>The ARN of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM ARNs</a> in the
1552
+ * <i>IAM User Guide</i>. This parameter is required if you specify
1553
+ * <code>IAM</code> for <code>identityType</code>.</p>
1554
+ * @public
1555
+ */
1556
+ iamArn?: string | undefined;
1557
+ /**
1558
+ * <p>The token to be used for the next set of paginated results.</p>
1559
+ * @public
1560
+ */
1561
+ nextToken?: string | undefined;
1562
+ /**
1563
+ * <p>The maximum number of results to return for each paginated request.</p>
1564
+ * <p>Default: 50</p>
1565
+ * @public
1566
+ */
1567
+ maxResults?: number | undefined;
1568
+ }
1569
+ /**
1570
+ * @public
1571
+ */
1572
+ export interface ListAccessPoliciesResponse {
1573
+ /**
1574
+ * <p>A list that summarizes each access policy.</p>
1575
+ * @public
1576
+ */
1577
+ accessPolicySummaries: AccessPolicySummary[] | undefined;
1578
+ /**
1579
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1580
+ * @public
1581
+ */
1582
+ nextToken?: string | undefined;
1583
+ }
1584
+ /**
1585
+ * @public
1586
+ */
1587
+ export interface ListActionsRequest {
1588
+ /**
1589
+ * <p>The type of resource.</p>
1590
+ * @public
1591
+ */
1592
+ targetResourceType: TargetResourceType | undefined;
1593
+ /**
1594
+ * <p>The ID of the target resource.</p>
1595
+ * @public
1596
+ */
1597
+ targetResourceId: string | undefined;
1598
+ /**
1599
+ * <p>The token to be used for the next set of paginated results.</p>
1600
+ * @public
1601
+ */
1602
+ nextToken?: string | undefined;
1603
+ /**
1604
+ * <p>The maximum number of results to return for each paginated request.</p>
1605
+ * @public
1606
+ */
1607
+ maxResults?: number | undefined;
1608
+ /**
1609
+ * <p>The type of the resolved resource.</p>
1610
+ * @public
1611
+ */
1612
+ resolveToResourceType?: ResolveToResourceType | undefined;
1613
+ /**
1614
+ * <p>The ID of the resolved resource.</p>
1615
+ * @public
1616
+ */
1617
+ resolveToResourceId?: string | undefined;
1618
+ }
1619
+ /**
1620
+ * @public
1621
+ */
1622
+ export interface ListActionsResponse {
1623
+ /**
1624
+ * <p>A list that summarizes the actions associated with the specified asset.</p>
1625
+ * @public
1626
+ */
1627
+ actionSummaries: ActionSummary[] | undefined;
1628
+ /**
1629
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1630
+ * @public
1631
+ */
1632
+ nextToken: string | undefined;
1633
+ }
1634
+ /**
1635
+ * @public
1636
+ */
1637
+ export interface ListApplicationsRequest {
1638
+ /**
1639
+ * <p>Maximum number of results to return</p>
1640
+ * @public
1641
+ */
1642
+ maxResults?: number | undefined;
1643
+ /**
1644
+ * <p>Next Page Token</p>
1645
+ * @public
1646
+ */
1647
+ nextToken?: string | undefined;
1648
+ }
1649
+ /**
1650
+ * @public
1651
+ */
1652
+ export interface ListApplicationsResponse {
1653
+ /**
1654
+ * <p>Next Page Token</p>
1655
+ * @public
1656
+ */
1657
+ nextToken?: string | undefined;
1658
+ /**
1659
+ * <p>List of applications</p>
1660
+ * @public
1661
+ */
1662
+ applications: ApplicationSummary[] | undefined;
1663
+ }
1664
+ /**
1665
+ * @public
1666
+ */
1667
+ export interface ListAssetModelCompositeModelsRequest {
1668
+ /**
1669
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1670
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1671
+ * @public
1672
+ */
1673
+ assetModelId: string | undefined;
1674
+ /**
1675
+ * <p>The token to be used for the next set of paginated results.</p>
1676
+ * @public
1677
+ */
1678
+ nextToken?: string | undefined;
1679
+ /**
1680
+ * <p>The maximum number of results to return for each paginated request.</p>
1681
+ * <p>Default: 50</p>
1682
+ * @public
1683
+ */
1684
+ maxResults?: number | undefined;
1685
+ /**
1686
+ * <p>The version alias that specifies the latest or active version of the asset model.
1687
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
1688
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
1689
+ * @public
1690
+ */
1691
+ assetModelVersion?: string | undefined;
1692
+ }
1693
+ /**
1694
+ * @public
1695
+ */
1696
+ export interface ListAssetModelCompositeModelsResponse {
1697
+ /**
1698
+ * <p>A list that summarizes each composite model.</p>
1699
+ * @public
1700
+ */
1701
+ assetModelCompositeModelSummaries: AssetModelCompositeModelSummary[] | undefined;
1702
+ /**
1703
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1704
+ * @public
1705
+ */
1706
+ nextToken?: string | undefined;
1707
+ }
1708
+ /**
1709
+ * @public
1710
+ */
1711
+ export interface ListAssetModelPropertiesRequest {
1712
+ /**
1713
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1714
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1715
+ * @public
1716
+ */
1717
+ assetModelId: string | undefined;
1718
+ /**
1719
+ * <p>The token to be used for the next set of paginated results.</p>
1720
+ * @public
1721
+ */
1722
+ nextToken?: string | undefined;
1723
+ /**
1724
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
1725
+ * @public
1726
+ */
1727
+ maxResults?: number | undefined;
1728
+ /**
1729
+ * <p> Filters the requested list of asset model properties. You can choose one of the following
1730
+ * options:</p>
1731
+ * <ul>
1732
+ * <li>
1733
+ * <p>
1734
+ * <code>ALL</code> – The list includes all asset model properties for a given asset
1735
+ * model ID. </p>
1736
+ * </li>
1737
+ * <li>
1738
+ * <p>
1739
+ * <code>BASE</code> – The list includes only base asset model properties for a given
1740
+ * asset model ID. </p>
1741
+ * </li>
1742
+ * </ul>
1743
+ * <p>Default: <code>BASE</code>
1744
+ * </p>
1745
+ * @public
1746
+ */
1747
+ filter?: ListAssetModelPropertiesFilter | undefined;
1748
+ /**
1749
+ * <p>The version alias that specifies the latest or active version of the asset model.
1750
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
1751
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
1752
+ * @public
1753
+ */
1754
+ assetModelVersion?: string | undefined;
1755
+ }
1756
+ /**
1757
+ * @public
1758
+ */
1759
+ export interface ListAssetModelPropertiesResponse {
1760
+ /**
1761
+ * <p>A list that summarizes the properties associated with the specified asset model.</p>
1762
+ * @public
1763
+ */
1764
+ assetModelPropertySummaries: AssetModelPropertySummary[] | undefined;
1765
+ /**
1766
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1767
+ * @public
1768
+ */
1769
+ nextToken?: string | undefined;
1770
+ }
1771
+ /**
1772
+ * @public
1773
+ */
1774
+ export interface ListAssetModelsRequest {
1775
+ /**
1776
+ * <p>The type of asset model. If you don't provide an <code>assetModelTypes</code>, all types
1777
+ * of asset models are returned.</p>
1778
+ * <ul>
1779
+ * <li>
1780
+ * <p>
1781
+ * <b>ASSET_MODEL</b> – An asset model that you can use
1782
+ * to create assets. Can't be included as a component in another asset model.</p>
1783
+ * </li>
1784
+ * <li>
1785
+ * <p>
1786
+ * <b>COMPONENT_MODEL</b> – A reusable component that
1787
+ * you can include in the composite models of other asset models. You can't create
1788
+ * assets directly from this type of asset model. </p>
1789
+ * </li>
1790
+ * <li>
1791
+ * <p>
1792
+ * <b>INTERFACE</b> – An interface is a type of model
1793
+ * that defines a standard structure that can be applied to different asset models.</p>
1794
+ * </li>
1795
+ * </ul>
1796
+ * @public
1797
+ */
1798
+ assetModelTypes?: AssetModelType[] | undefined;
1799
+ /**
1800
+ * <p>The token to be used for the next set of paginated results.</p>
1801
+ * @public
1802
+ */
1803
+ nextToken?: string | undefined;
1804
+ /**
1805
+ * <p>The maximum number of results to return for each paginated request.</p>
1806
+ * <p>Default: 50</p>
1807
+ * @public
1808
+ */
1809
+ maxResults?: number | undefined;
1810
+ /**
1811
+ * <p>The version alias that specifies the latest or active version of the asset model.
1812
+ * The details are returned in the response. The default value is <code>LATEST</code>. See <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/model-active-version.html">
1813
+ * Asset model versions</a> in the <i>IoT SiteWise User Guide</i>.</p>
1814
+ * @public
1815
+ */
1816
+ assetModelVersion?: string | undefined;
1817
+ }
1818
+ /**
1819
+ * @public
1820
+ */
1821
+ export interface ListAssetModelsResponse {
1822
+ /**
1823
+ * <p>A list that summarizes each asset model.</p>
1824
+ * @public
1825
+ */
1826
+ assetModelSummaries: AssetModelSummary[] | undefined;
1827
+ /**
1828
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1829
+ * @public
1830
+ */
1831
+ nextToken?: string | undefined;
1832
+ }
1833
+ /**
1834
+ * @public
1835
+ */
1836
+ export interface ListAssetPropertiesRequest {
1837
+ /**
1838
+ * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1839
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1840
+ * @public
1841
+ */
1842
+ assetId: string | undefined;
1843
+ /**
1844
+ * <p>The token to be used for the next set of paginated results.</p>
1845
+ * @public
1846
+ */
1847
+ nextToken?: string | undefined;
1848
+ /**
1849
+ * <p>The maximum number of results to return for each paginated request. If not specified, the default value is 50.</p>
1850
+ * @public
1851
+ */
1852
+ maxResults?: number | undefined;
1853
+ /**
1854
+ * <p> Filters the requested list of asset properties. You can choose one of the following
1855
+ * options:</p>
1856
+ * <ul>
1857
+ * <li>
1858
+ * <p>
1859
+ * <code>ALL</code> – The list includes all asset properties for a given asset model ID.
1860
+ * </p>
1861
+ * </li>
1862
+ * <li>
1863
+ * <p>
1864
+ * <code>BASE</code> – The list includes only base asset properties for a given asset
1865
+ * model ID. </p>
1866
+ * </li>
1867
+ * </ul>
1868
+ * <p>Default: <code>BASE</code>
1869
+ * </p>
1870
+ * @public
1871
+ */
1872
+ filter?: ListAssetPropertiesFilter | undefined;
1873
+ }
1874
+ /**
1875
+ * @public
1876
+ */
1877
+ export interface ListAssetPropertiesResponse {
1878
+ /**
1879
+ * <p>A list that summarizes the properties associated with the specified asset.</p>
1880
+ * @public
1881
+ */
1882
+ assetPropertySummaries: AssetPropertySummary[] | undefined;
1883
+ /**
1884
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1885
+ * @public
1886
+ */
1887
+ nextToken?: string | undefined;
1888
+ }
1889
+ /**
1890
+ * @public
1891
+ */
1892
+ export interface ListAssetRelationshipsRequest {
1893
+ /**
1894
+ * <p>The ID of the asset. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1895
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1896
+ * @public
1897
+ */
1898
+ assetId: string | undefined;
1899
+ /**
1900
+ * <p>The type of traversal to use to identify asset relationships. Choose the following
1901
+ * option:</p>
1902
+ * <ul>
1903
+ * <li>
1904
+ * <p>
1905
+ * <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root
1906
+ * asset. The asset that you specify in <code>assetId</code> is the first result in the list
1907
+ * of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p>
1908
+ * </li>
1909
+ * </ul>
1910
+ * @public
1911
+ */
1912
+ traversalType: TraversalType | undefined;
1913
+ /**
1914
+ * <p>The token to be used for the next set of paginated results.</p>
1915
+ * @public
1916
+ */
1917
+ nextToken?: string | undefined;
1918
+ /**
1919
+ * <p>The maximum number of results to return for each paginated request.</p>
1920
+ * @public
1921
+ */
1922
+ maxResults?: number | undefined;
1923
+ }
1924
+ /**
1925
+ * @public
1926
+ */
1927
+ export interface ListAssetRelationshipsResponse {
1928
+ /**
1929
+ * <p>A list that summarizes each asset relationship.</p>
1930
+ * @public
1931
+ */
1932
+ assetRelationshipSummaries: AssetRelationshipSummary[] | undefined;
1933
+ /**
1934
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1935
+ * @public
1936
+ */
1937
+ nextToken?: string | undefined;
1938
+ }
1939
+ /**
1940
+ * @public
1941
+ */
1942
+ export interface ListAssetsRequest {
1943
+ /**
1944
+ * <p>The token to be used for the next set of paginated results.</p>
1945
+ * @public
1946
+ */
1947
+ nextToken?: string | undefined;
1948
+ /**
1949
+ * <p>The maximum number of results to return for each paginated request.</p>
1950
+ * <p>Default: 50</p>
1951
+ * @public
1952
+ */
1953
+ maxResults?: number | undefined;
1954
+ /**
1955
+ * <p>The ID of the asset model by which to filter the list of assets. This parameter is
1956
+ * required if you choose <code>ALL</code> for <code>filter</code>. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
1957
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
1958
+ * @public
1959
+ */
1960
+ assetModelId?: string | undefined;
1961
+ /**
1962
+ * <p>The filter for the requested list of assets. Choose one of the following options:</p>
1963
+ * <ul>
1964
+ * <li>
1965
+ * <p>
1966
+ * <code>ALL</code> – The list includes all assets for a given asset model ID. The
1967
+ * <code>assetModelId</code> parameter is required if you filter by
1968
+ * <code>ALL</code>.</p>
1969
+ * </li>
1970
+ * <li>
1971
+ * <p>
1972
+ * <code>TOP_LEVEL</code> – The list includes only top-level assets in the asset
1973
+ * hierarchy tree.</p>
1974
+ * </li>
1975
+ * </ul>
1976
+ * <p>Default: <code>ALL</code>
1977
+ * </p>
1978
+ * @public
1979
+ */
1980
+ filter?: ListAssetsFilter | undefined;
1981
+ }
1982
+ /**
1983
+ * @public
1984
+ */
1985
+ export interface ListAssetsResponse {
1986
+ /**
1987
+ * <p>A list that summarizes each asset.</p>
1988
+ * @public
1989
+ */
1990
+ assetSummaries: AssetSummary[] | undefined;
1991
+ /**
1992
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
1993
+ * @public
1994
+ */
1995
+ nextToken?: string | undefined;
1996
+ }
1997
+ /**
1998
+ * @public
1999
+ */
2000
+ export interface ListAssociatedAssetsRequest {
2001
+ /**
2002
+ * <p>The ID of the asset to query. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
2003
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
2004
+ * @public
2005
+ */
2006
+ assetId: string | undefined;
2007
+ /**
2008
+ * <p>(Optional) If you don't provide a <code>hierarchyId</code>, all the immediate assets in
2009
+ * the <code>traversalDirection</code> will be returned. </p>
2010
+ * <p> The ID of the hierarchy by which child assets are associated to the asset.
2011
+ * (This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
2012
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.)</p>
2013
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html">Asset hierarchies</a> in the <i>IoT SiteWise User Guide</i>.</p>
2014
+ * @public
2015
+ */
2016
+ hierarchyId?: string | undefined;
2017
+ /**
2018
+ * <p>The direction to list associated assets. Choose one of the following options:</p>
2019
+ * <ul>
2020
+ * <li>
2021
+ * <p>
2022
+ * <code>CHILD</code> – The list includes all child assets associated to the
2023
+ * asset.</p>
2024
+ * </li>
2025
+ * <li>
2026
+ * <p>
2027
+ * <code>PARENT</code> – The list includes the asset's parent asset.</p>
2028
+ * </li>
2029
+ * </ul>
2030
+ * <p>Default: <code>CHILD</code>
2031
+ * </p>
2032
+ * @public
2033
+ */
2034
+ traversalDirection?: TraversalDirection | undefined;
2035
+ /**
2036
+ * <p>The token to be used for the next set of paginated results.</p>
2037
+ * @public
2038
+ */
2039
+ nextToken?: string | undefined;
2040
+ /**
2041
+ * <p>The maximum number of results to return for each paginated request.</p>
2042
+ * <p>Default: 50</p>
2043
+ * @public
2044
+ */
2045
+ maxResults?: number | undefined;
2046
+ }
2047
+ /**
2048
+ * @public
2049
+ */
2050
+ export interface ListAssociatedAssetsResponse {
2051
+ /**
2052
+ * <p>A list that summarizes the associated assets.</p>
2053
+ * @public
2054
+ */
2055
+ assetSummaries: AssociatedAssetsSummary[] | undefined;
2056
+ /**
2057
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2058
+ * @public
2059
+ */
2060
+ nextToken?: string | undefined;
2061
+ }
2062
+ /**
2063
+ * @public
2064
+ */
2065
+ export interface ListBulkImportJobsRequest {
2066
+ /**
2067
+ * <p>The token to be used for the next set of paginated results.</p>
2068
+ * @public
2069
+ */
2070
+ nextToken?: string | undefined;
2071
+ /**
2072
+ * <p>The maximum number of results to return for each paginated request.</p>
2073
+ * @public
2074
+ */
2075
+ maxResults?: number | undefined;
2076
+ /**
2077
+ * <p>You can use a filter to select the bulk import jobs that you want to retrieve.</p>
2078
+ * @public
2079
+ */
2080
+ filter?: ListBulkImportJobsFilter | undefined;
2081
+ /**
2082
+ * <p>The name of the workspace.</p>
2083
+ * @public
2084
+ */
2085
+ workspaceName?: string | undefined;
2086
+ }
2087
+ /**
2088
+ * <p>Contains the job summary information.</p>
2089
+ * @public
2090
+ */
2091
+ export interface JobSummary {
2092
+ /**
2093
+ * <p>The ID of the job.</p>
2094
+ * @public
2095
+ */
2096
+ id: string | undefined;
2097
+ /**
2098
+ * <p>The unique name that helps identify the job request.</p>
2099
+ * @public
2100
+ */
2101
+ name: string | undefined;
2102
+ /**
2103
+ * <p>The status of the bulk import job can be one of following values:</p>
2104
+ * <ul>
2105
+ * <li>
2106
+ * <p>
2107
+ * <code>PENDING</code> – IoT SiteWise is waiting for the current bulk import job to finish.</p>
2108
+ * </li>
2109
+ * <li>
2110
+ * <p>
2111
+ * <code>CANCELLED</code> – The bulk import job has been canceled.</p>
2112
+ * </li>
2113
+ * <li>
2114
+ * <p>
2115
+ * <code>RUNNING</code> – IoT SiteWise is processing your request to import your data from Amazon S3.</p>
2116
+ * </li>
2117
+ * <li>
2118
+ * <p>
2119
+ * <code>COMPLETED</code> – IoT SiteWise successfully completed your request to import data from Amazon S3.</p>
2120
+ * </li>
2121
+ * <li>
2122
+ * <p>
2123
+ * <code>FAILED</code> – IoT SiteWise couldn't process your request to import data from Amazon S3.
2124
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
2125
+ * </li>
2126
+ * <li>
2127
+ * <p>
2128
+ * <code>COMPLETED_WITH_FAILURES</code> – IoT SiteWise completed your request to import data from Amazon S3 with errors.
2129
+ * You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.</p>
2130
+ * </li>
2131
+ * </ul>
2132
+ * @public
2133
+ */
2134
+ status: JobStatus | undefined;
2135
+ }
2136
+ /**
2137
+ * @public
2138
+ */
2139
+ export interface ListBulkImportJobsResponse {
2140
+ /**
2141
+ * <p>One or more job summaries to list.</p>
2142
+ * @public
2143
+ */
2144
+ jobSummaries: JobSummary[] | undefined;
2145
+ /**
2146
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2147
+ * @public
2148
+ */
2149
+ nextToken?: string | undefined;
2150
+ }
2151
+ /**
2152
+ * @public
2153
+ */
2154
+ export interface ListCompositionRelationshipsRequest {
2155
+ /**
2156
+ * <p>The ID of the asset model. This can be either the actual ID in UUID format, or else <code>externalId:</code> followed by the external ID, if it has one.
2157
+ * For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references">Referencing objects with external IDs</a> in the <i>IoT SiteWise User Guide</i>.</p>
2158
+ * @public
2159
+ */
2160
+ assetModelId: string | undefined;
2161
+ /**
2162
+ * <p>The token to be used for the next set of paginated results.</p>
2163
+ * @public
2164
+ */
2165
+ nextToken?: string | undefined;
2166
+ /**
2167
+ * <p>The maximum number of results to return for each paginated request.</p>
2168
+ * <p>Default: 50</p>
2169
+ * @public
2170
+ */
2171
+ maxResults?: number | undefined;
2172
+ }
2173
+ /**
2174
+ * <p>Contains a summary of the components of the composite model.</p>
2175
+ * @public
2176
+ */
2177
+ export interface CompositionRelationshipSummary {
2178
+ /**
2179
+ * <p>The ID of the asset model, in UUID format.</p>
2180
+ * @public
2181
+ */
2182
+ assetModelId: string | undefined;
2183
+ /**
2184
+ * <p>The ID of a composite model on this asset model.</p>
2185
+ * @public
2186
+ */
2187
+ assetModelCompositeModelId: string | undefined;
2188
+ /**
2189
+ * <p>The composite model type. Valid values are <code>AWS/ALARM</code>, <code>CUSTOM</code>, or
2190
+ * <code> AWS/L4E_ANOMALY</code>.</p>
2191
+ * @public
2192
+ */
2193
+ assetModelCompositeModelType: string | undefined;
2194
+ }
2195
+ /**
2196
+ * @public
2197
+ */
2198
+ export interface ListCompositionRelationshipsResponse {
2199
+ /**
2200
+ * <p>A list that summarizes each composition relationship.</p>
2201
+ * @public
2202
+ */
2203
+ compositionRelationshipSummaries: CompositionRelationshipSummary[] | undefined;
2204
+ /**
2205
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2206
+ * @public
2207
+ */
2208
+ nextToken?: string | undefined;
2209
+ }
2210
+ /**
2211
+ * <p>A filter used to match specific data binding values based on criteria. This filter allows
2212
+ * searching for data bindings by asset, asset model, asset property, or asset model
2213
+ * property.</p>
2214
+ * @public
2215
+ */
2216
+ export interface DataBindingValueFilter {
2217
+ /**
2218
+ * <p>Filter criteria for matching data bindings based on a specific asset. Used to list all
2219
+ * data bindings referencing a particular asset or its properties.</p>
2220
+ * @public
2221
+ */
2222
+ asset?: AssetBindingValueFilter | undefined;
2223
+ /**
2224
+ * <p>Filter criteria for matching data bindings based on a specific asset model. Used to list
2225
+ * all data bindings referencing a particular asset model or its properties.</p>
2226
+ * @public
2227
+ */
2228
+ assetModel?: AssetModelBindingValueFilter | undefined;
2229
+ /**
2230
+ * <p>Filter criteria for matching data bindings based on a specific asset property. Used to
2231
+ * list all data bindings referencing a particular property of an asset.</p>
2232
+ * @public
2233
+ */
2234
+ assetProperty?: AssetPropertyBindingValueFilter | undefined;
2235
+ /**
2236
+ * <p>Filter criteria for matching data bindings based on a specific asset model property. Used
2237
+ * to list all data bindings referencing a particular property of an asset model.</p>
2238
+ * @public
2239
+ */
2240
+ assetModelProperty?: AssetModelPropertyBindingValueFilter | undefined;
2241
+ }
2242
+ /**
2243
+ * @public
2244
+ */
2245
+ export interface ListComputationModelDataBindingUsagesRequest {
2246
+ /**
2247
+ * <p>A filter used to limit the returned data binding usages based on specific data binding
2248
+ * values. You can filter by asset, asset model, asset property, or asset model property to find
2249
+ * all computation models using these specific data sources.</p>
2250
+ * @public
2251
+ */
2252
+ dataBindingValueFilter: DataBindingValueFilter | undefined;
2253
+ /**
2254
+ * <p>The token used for the next set of paginated results.</p>
2255
+ * @public
2256
+ */
2257
+ nextToken?: string | undefined;
2258
+ /**
2259
+ * <p>The maximum number of results returned for each paginated request.</p>
2260
+ * @public
2261
+ */
2262
+ maxResults?: number | undefined;
2263
+ }
2264
+ /**
2265
+ * <p>Represents a value used in a data binding. It can be an asset property or an asset model
2266
+ * property.</p>
2267
+ * @public
2268
+ */
2269
+ export interface DataBindingValue {
2270
+ /**
2271
+ * <p>Contains information about an <code>assetModelProperty</code> binding value.</p>
2272
+ * @public
2273
+ */
2274
+ assetModelProperty?: AssetModelPropertyBindingValue | undefined;
2275
+ /**
2276
+ * <p>The asset property value used in the data binding.</p>
2277
+ * @public
2278
+ */
2279
+ assetProperty?: AssetPropertyBindingValue | undefined;
2280
+ }
2281
+ /**
2282
+ * <p>Represents a data binding that matches the specified filter criteria.</p>
2283
+ * @public
2284
+ */
2285
+ export interface MatchedDataBinding {
2286
+ /**
2287
+ * <p>The value of the matched data binding.</p>
2288
+ * @public
2289
+ */
2290
+ value: DataBindingValue | undefined;
2291
+ }
2292
+ /**
2293
+ * <p>A summary of how a specific data binding is used across computation models. This tracks
2294
+ * dependencies between data sources and computation models, allowing you to understand the
2295
+ * impact of changes to data sources.</p>
2296
+ * @public
2297
+ */
2298
+ export interface ComputationModelDataBindingUsageSummary {
2299
+ /**
2300
+ * <p>The list of computation model IDs that use this data binding. This allows identification
2301
+ * of all computation models affected by changes to the referenced data source.</p>
2302
+ * @public
2303
+ */
2304
+ computationModelIds: string[] | undefined;
2305
+ /**
2306
+ * <p>The data binding matched by the filter criteria. Contains details about specific data
2307
+ * binding values used by the computation models.</p>
2308
+ * @public
2309
+ */
2310
+ matchedDataBinding: MatchedDataBinding | undefined;
2311
+ }
2312
+ /**
2313
+ * @public
2314
+ */
2315
+ export interface ListComputationModelDataBindingUsagesResponse {
2316
+ /**
2317
+ * <p>A list of summaries describing the data binding usages across computation models. Each
2318
+ * summary includes the computation model IDs and the matched data binding details.</p>
2319
+ * @public
2320
+ */
2321
+ dataBindingUsageSummaries: ComputationModelDataBindingUsageSummary[] | undefined;
2322
+ /**
2323
+ * <p>The token for the next set of paginated results, or null if there are no additional
2324
+ * results.</p>
2325
+ * @public
2326
+ */
2327
+ nextToken?: string | undefined;
2328
+ }
2329
+ /**
2330
+ * @public
2331
+ */
2332
+ export interface ListComputationModelResolveToResourcesRequest {
2333
+ /**
2334
+ * <p>The ID of the computation model for which to list resolved resources.</p>
2335
+ * @public
2336
+ */
2337
+ computationModelId: string | undefined;
2338
+ /**
2339
+ * <p>The token used for the next set of paginated results.</p>
2340
+ * @public
2341
+ */
2342
+ nextToken?: string | undefined;
2343
+ /**
2344
+ * <p>The maximum number of results returned for each paginated request.</p>
2345
+ * @public
2346
+ */
2347
+ maxResults?: number | undefined;
2348
+ }
2349
+ /**
2350
+ * <p>A summary of the resource that a computation model resolves to.</p>
2351
+ * @public
2352
+ */
2353
+ export interface ComputationModelResolveToResourceSummary {
2354
+ /**
2355
+ * <p>The detailed resource this execution summary resolves to.</p>
2356
+ * @public
2357
+ */
2358
+ resolveTo?: ResolveTo | undefined;
2359
+ }
2360
+ /**
2361
+ * @public
2362
+ */
2363
+ export interface ListComputationModelResolveToResourcesResponse {
2364
+ /**
2365
+ * <p>A list of summaries describing the distinct resources that this computation model resolves
2366
+ * to when actions were executed.</p>
2367
+ * @public
2368
+ */
2369
+ computationModelResolveToResourceSummaries: ComputationModelResolveToResourceSummary[] | undefined;
2370
+ /**
2371
+ * <p>The token for the next set of paginated results, or null if there are no additional
2372
+ * results.</p>
2373
+ * @public
2374
+ */
2375
+ nextToken?: string | undefined;
2376
+ }
2377
+ /**
2378
+ * @public
2379
+ */
2380
+ export interface ListComputationModelsRequest {
2381
+ /**
2382
+ * <p>The type of computation model. If a <code>computationModelType</code> is not provided, all
2383
+ * types of computation models are returned.</p>
2384
+ * @public
2385
+ */
2386
+ computationModelType?: ComputationModelType | undefined;
2387
+ /**
2388
+ * <p>The token to be used for the next set of paginated results.</p>
2389
+ * @public
2390
+ */
2391
+ nextToken?: string | undefined;
2392
+ /**
2393
+ * <p>The maximum number of results to return for each paginated request.</p>
2394
+ * @public
2395
+ */
2396
+ maxResults?: number | undefined;
2397
+ }
2398
+ /**
2399
+ * <p>Contains a summary of a computation model.</p>
2400
+ * @public
2401
+ */
2402
+ export interface ComputationModelSummary {
2403
+ /**
2404
+ * <p>The ID of the computation model.</p>
2405
+ * @public
2406
+ */
2407
+ id: string | undefined;
2408
+ /**
2409
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the computation model, which has the following format.</p>
2410
+ * <p>
2411
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:computation-model/$\{ComputationModelId\}</code>
2412
+ * </p>
2413
+ * @public
2414
+ */
2415
+ arn: string | undefined;
2416
+ /**
2417
+ * <p>The name of the computation model.</p>
2418
+ * @public
2419
+ */
2420
+ name: string | undefined;
2421
+ /**
2422
+ * <p>The description of the computation model.</p>
2423
+ * @public
2424
+ */
2425
+ description?: string | undefined;
2426
+ /**
2427
+ * <p>The type of the computation model.</p>
2428
+ * @public
2429
+ */
2430
+ type: ComputationModelType | undefined;
2431
+ /**
2432
+ * <p>The model creation date, in Unix epoch time.</p>
2433
+ * @public
2434
+ */
2435
+ creationDate: Date | undefined;
2436
+ /**
2437
+ * <p>The time the model was last updated, in Unix epoch time.</p>
2438
+ * @public
2439
+ */
2440
+ lastUpdateDate: Date | undefined;
2441
+ /**
2442
+ * <p>The current status of the computation model.</p>
2443
+ * @public
2444
+ */
2445
+ status: ComputationModelStatus | undefined;
2446
+ /**
2447
+ * <p>The version of the computation model.</p>
2448
+ * @public
2449
+ */
2450
+ version: string | undefined;
2451
+ }
2452
+ /**
2453
+ * @public
2454
+ */
2455
+ export interface ListComputationModelsResponse {
2456
+ /**
2457
+ * <p>A list summarizing each computation model.</p>
2458
+ * @public
2459
+ */
2460
+ computationModelSummaries: ComputationModelSummary[] | undefined;
2461
+ /**
2462
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2463
+ * @public
2464
+ */
2465
+ nextToken?: string | undefined;
2466
+ }
2467
+ /**
2468
+ * @public
2469
+ */
2470
+ export interface ListDashboardsRequest {
2471
+ /**
2472
+ * <p>The ID of the project.</p>
2473
+ * @public
2474
+ */
2475
+ projectId: string | undefined;
2476
+ /**
2477
+ * <p>The token to be used for the next set of paginated results.</p>
2478
+ * @public
2479
+ */
2480
+ nextToken?: string | undefined;
2481
+ /**
2482
+ * <p>The maximum number of results to return for each paginated request.</p>
2483
+ * <p>Default: 50</p>
2484
+ * @public
2485
+ */
2486
+ maxResults?: number | undefined;
2487
+ }
2488
+ /**
2489
+ * <p>Contains a dashboard summary.</p>
2490
+ * @public
2491
+ */
2492
+ export interface DashboardSummary {
2493
+ /**
2494
+ * <p>The ID of the dashboard.</p>
2495
+ * @public
2496
+ */
2497
+ id: string | undefined;
2498
+ /**
2499
+ * <p>The name of the dashboard</p>
2500
+ * @public
2501
+ */
2502
+ name: string | undefined;
2503
+ /**
2504
+ * <p>The dashboard's description.</p>
2505
+ * @public
2506
+ */
2507
+ description?: string | undefined;
2508
+ /**
2509
+ * <p>The date the dashboard was created, in Unix epoch time.</p>
2510
+ * @public
2511
+ */
2512
+ creationDate?: Date | undefined;
2513
+ /**
2514
+ * <p>The date the dashboard was last updated, in Unix epoch time.</p>
2515
+ * @public
2516
+ */
2517
+ lastUpdateDate?: Date | undefined;
2518
+ }
2519
+ /**
2520
+ * @public
2521
+ */
2522
+ export interface ListDashboardsResponse {
2523
+ /**
2524
+ * <p>A list that summarizes each dashboard in the project.</p>
2525
+ * @public
2526
+ */
2527
+ dashboardSummaries: DashboardSummary[] | undefined;
2528
+ /**
2529
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2530
+ * @public
2531
+ */
2532
+ nextToken?: string | undefined;
2533
+ }
2534
+ /**
2535
+ * @public
2536
+ */
2537
+ export interface ListDatasetDataSegmentRelationshipsRequest {
2538
+ /**
2539
+ * <p>The ID of the session dataset to list data segment relationships for.</p>
2540
+ * @public
2541
+ */
2542
+ datasetId: string | undefined;
2543
+ /**
2544
+ * <p>The name of the workspace that contains the dataset.</p>
2545
+ * @public
2546
+ */
2547
+ workspaceName: string | undefined;
2548
+ /**
2549
+ * <p>The maximum number of results to return for each paginated request. Default: 50.</p>
2550
+ * @public
2551
+ */
2552
+ maxResults?: number | undefined;
2553
+ /**
2554
+ * <p>The token to be used for the next set of paginated results.</p>
2555
+ * @public
2556
+ */
2557
+ nextToken?: string | undefined;
2558
+ }
2559
+ /**
2560
+ * <p>Contains summary information about a data segment relationship between a source session
2561
+ * dataset that contains the data and a curated dataset that references it, including the time
2562
+ * series and timestamp range.</p>
2563
+ * @public
2564
+ */
2565
+ export interface DataSegmentRelationshipSummary {
2566
+ /**
2567
+ * <p>The ID of the curated dataset that references the data segment.</p>
2568
+ * @public
2569
+ */
2570
+ targetDatasetId: string | undefined;
2571
+ /**
2572
+ * <p>The ID of the source session dataset that contains the data segment.</p>
2573
+ * @public
2574
+ */
2575
+ sourceDatasetId: string | undefined;
2576
+ /**
2577
+ * <p>The ID of the time series.</p>
2578
+ * @public
2579
+ */
2580
+ timeSeriesId: string | undefined;
2581
+ /**
2582
+ * <p>The nanosecond-precision start time of the data segment.</p>
2583
+ * @public
2584
+ */
2585
+ startTimestamp: TimeInNanos | undefined;
2586
+ /**
2587
+ * <p>The nanosecond-precision end time of the data segment.</p>
2588
+ * @public
2589
+ */
2590
+ endTimestamp: TimeInNanos | undefined;
2591
+ }
2592
+ /**
2593
+ * @public
2594
+ */
2595
+ export interface ListDatasetDataSegmentRelationshipsResponse {
2596
+ /**
2597
+ * <p>A list that summarizes each data segment relationship.</p>
2598
+ * @public
2599
+ */
2600
+ dataSegmentRelationshipSummaries: DataSegmentRelationshipSummary[] | undefined;
2601
+ /**
2602
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2603
+ * @public
2604
+ */
2605
+ nextToken?: string | undefined;
2606
+ }
2607
+ /**
2608
+ * @public
2609
+ */
2610
+ export interface ListDatasetDataSegmentsRequest {
2611
+ /**
2612
+ * <p>The ID of the dataset.</p>
2613
+ * @public
2614
+ */
2615
+ datasetId: string | undefined;
2616
+ /**
2617
+ * <p>The name of the workspace that contains the dataset.</p>
2618
+ * @public
2619
+ */
2620
+ workspaceName: string | undefined;
2621
+ /**
2622
+ * <p>The version of the dataset to list data segments for.</p>
2623
+ * @public
2624
+ */
2625
+ datasetVersion?: string | undefined;
2626
+ /**
2627
+ * <p>The maximum number of results to return for each paginated request. Default: 50.</p>
2628
+ * @public
2629
+ */
2630
+ maxResults?: number | undefined;
2631
+ /**
2632
+ * <p>The token to be used for the next set of paginated results.</p>
2633
+ * @public
2634
+ */
2635
+ nextToken?: string | undefined;
2636
+ }
2637
+ /**
2638
+ * <p>Contains enrichment status information for a data segment.</p>
2639
+ * @public
2640
+ */
2641
+ export interface DataSegmentEnrichment {
2642
+ /**
2643
+ * <p>The enrichment status of the data segment.</p>
2644
+ * @public
2645
+ */
2646
+ status: EnrichmentStatus | undefined;
2647
+ /**
2648
+ * <p>The date the data segment was last enriched, in Unix epoch time.</p>
2649
+ * @public
2650
+ */
2651
+ lastEnrichedAt?: Date | undefined;
2652
+ }
2653
+ /**
2654
+ * <p>Contains summary information about a data segment, including its source dataset, time
2655
+ * series, timestamp range, and enrichment status.</p>
2656
+ * @public
2657
+ */
2658
+ export interface DataSegmentSummary {
2659
+ /**
2660
+ * <p>The ID of the source dataset that contains the data segment.</p>
2661
+ * @public
2662
+ */
2663
+ sourceDatasetId: string | undefined;
2664
+ /**
2665
+ * <p>The ID of the time series.</p>
2666
+ * @public
2667
+ */
2668
+ timeSeriesId: string | undefined;
2669
+ /**
2670
+ * <p>The nanosecond-precision start time of the data segment.</p>
2671
+ * @public
2672
+ */
2673
+ startTimestamp: TimeInNanos | undefined;
2674
+ /**
2675
+ * <p>The nanosecond-precision end time of the data segment.</p>
2676
+ * @public
2677
+ */
2678
+ endTimestamp: TimeInNanos | undefined;
2679
+ /**
2680
+ * <p>The alias of the time series.</p>
2681
+ * @public
2682
+ */
2683
+ alias: string | undefined;
2684
+ /**
2685
+ * <p>The data type of the time series.</p>
2686
+ * @public
2687
+ */
2688
+ dataType: PropertyDataType | undefined;
2689
+ /**
2690
+ * <p>The enrichment information for the data segment.</p>
2691
+ * @public
2692
+ */
2693
+ enrichment?: DataSegmentEnrichment | undefined;
2694
+ }
2695
+ /**
2696
+ * @public
2697
+ */
2698
+ export interface ListDatasetDataSegmentsResponse {
2699
+ /**
2700
+ * <p>A list that summarizes each data segment.</p>
2701
+ * @public
2702
+ */
2703
+ dataSegments: DataSegmentSummary[] | undefined;
2704
+ /**
2705
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2706
+ * @public
2707
+ */
2708
+ nextToken?: string | undefined;
2709
+ }
2710
+ /**
2711
+ * <p>Request to list dataset export jobs for a workspace.</p>
2712
+ * @public
2713
+ */
2714
+ export interface ListDatasetExportJobsRequest {
2715
+ /**
2716
+ * <p>The name of the workspace whose dataset export jobs should be listed.</p>
2717
+ * @public
2718
+ */
2719
+ workspaceName: string | undefined;
2720
+ /**
2721
+ * <p>The optional filter that returns only jobs matching the given filter value. Defaults to ALL.</p>
2722
+ * @public
2723
+ */
2724
+ filter?: DatasetExportJobFilter | undefined;
2725
+ /**
2726
+ * <p>The maximum number of results to return for each paginated request.</p>
2727
+ * @public
2728
+ */
2729
+ maxResults?: number | undefined;
2730
+ /**
2731
+ * <p>The token to be used for the next set of paginated results.</p>
2732
+ * @public
2733
+ */
2734
+ nextToken?: string | undefined;
2735
+ }
2736
+ /**
2737
+ * <p>Contains summary information about a dataset export job.</p>
2738
+ * @public
2739
+ */
2740
+ export interface ExportJobSummary {
2741
+ /**
2742
+ * <p>The unique identifier for the dataset export job.</p>
2743
+ * @public
2744
+ */
2745
+ jobId: string | undefined;
2746
+ /**
2747
+ * <p>The current status of the dataset export job.</p>
2748
+ * @public
2749
+ */
2750
+ status: DatasetExportJobStatus | undefined;
2751
+ /**
2752
+ * <p>The timestamp when the job started processing.</p>
2753
+ * @public
2754
+ */
2755
+ startedAt: Date | undefined;
2756
+ /**
2757
+ * <p>The timestamp when the job completed, or null if the job is still running.</p>
2758
+ * @public
2759
+ */
2760
+ completedAt?: Date | undefined;
2761
+ /**
2762
+ * <p>The S3 URI where output clips are written.</p>
2763
+ * @public
2764
+ */
2765
+ destinationS3Uri: string | undefined;
2766
+ }
2767
+ /**
2768
+ * <p>Response for list dataset export jobs request.</p>
2769
+ * @public
2770
+ */
2771
+ export interface ListDatasetExportJobsResponse {
2772
+ /**
2773
+ * <p>A list of dataset export job summaries.</p>
2774
+ * @public
2775
+ */
2776
+ jobs: ExportJobSummary[] | undefined;
2777
+ /**
2778
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2779
+ * @public
2780
+ */
2781
+ nextToken?: string | undefined;
2782
+ }
2783
+ /**
2784
+ * @public
2785
+ */
2786
+ export interface ListDatasetsRequest {
2787
+ /**
2788
+ * <p>The type of data source for the dataset.</p>
2789
+ * @public
2790
+ */
2791
+ sourceType: DatasetSourceType | undefined;
2792
+ /**
2793
+ * <p>The name of the workspace to filter datasets by.</p>
2794
+ * @public
2795
+ */
2796
+ workspaceName?: string | undefined;
2797
+ /**
2798
+ * <p>The type of dataset to filter by: a session dataset, a curated dataset, or a connection
2799
+ * to an external datasource.</p>
2800
+ * @public
2801
+ */
2802
+ datasetType?: DatasetTypeEnum | undefined;
2803
+ /**
2804
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2805
+ * @public
2806
+ */
2807
+ nextToken?: string | undefined;
2808
+ /**
2809
+ * <p>The maximum number of results to return for each paginated request.</p>
2810
+ * @public
2811
+ */
2812
+ maxResults?: number | undefined;
2813
+ }
2814
+ /**
2815
+ * <p>The summary details for the dataset.</p>
2816
+ * @public
2817
+ */
2818
+ export interface DatasetSummary {
2819
+ /**
2820
+ * <p>The ID of the dataset.</p>
2821
+ * @public
2822
+ */
2823
+ id: string | undefined;
2824
+ /**
2825
+ * <p>The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">ARN</a> of the dataset.
2826
+ * The format is <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:dataset/$\{DatasetId\}</code>.</p>
2827
+ * @public
2828
+ */
2829
+ arn: string | undefined;
2830
+ /**
2831
+ * <p>The name of the dataset.</p>
2832
+ * @public
2833
+ */
2834
+ name: string | undefined;
2835
+ /**
2836
+ * <p>A description about the dataset, and its functionality.</p>
2837
+ * @public
2838
+ */
2839
+ description: string | undefined;
2840
+ /**
2841
+ * <p>The data source type of the dataset.</p>
2842
+ * @public
2843
+ */
2844
+ sourceType?: DatasetSourceType | undefined;
2845
+ /**
2846
+ * <p>The type of dataset: a session dataset, a curated dataset, or a connection to an external
2847
+ * datasource.</p>
2848
+ * @public
2849
+ */
2850
+ datasetType?: DatasetTypeEnum | undefined;
2851
+ /**
2852
+ * <p>The dataset creation date, in Unix epoch time.</p>
2853
+ * @public
2854
+ */
2855
+ creationDate: Date | undefined;
2856
+ /**
2857
+ * <p>The date the dataset was last updated, in Unix epoch time.</p>
2858
+ * @public
2859
+ */
2860
+ lastUpdateDate: Date | undefined;
2861
+ /**
2862
+ * <p>The status of the dataset. This contains the state and any error messages. The state is
2863
+ * <code>ACTIVE</code> when ready to use.</p>
2864
+ * @public
2865
+ */
2866
+ status: DatasetStatus | undefined;
2867
+ /**
2868
+ * <p>The enrichment status of the dataset.</p>
2869
+ * @public
2870
+ */
2871
+ enrichmentStatus?: DatasetEnrichment | undefined;
2872
+ }
2873
+ /**
2874
+ * @public
2875
+ */
2876
+ export interface ListDatasetsResponse {
2877
+ /**
2878
+ * <p>A list that summarizes the dataset response.</p>
2879
+ * @public
2880
+ */
2881
+ datasetSummaries: DatasetSummary[] | undefined;
2882
+ /**
2883
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
2884
+ * @public
2885
+ */
2886
+ nextToken?: string | undefined;
2887
+ /**
2888
+ * <p>The name of the workspace.</p>
2889
+ * @public
2890
+ */
2891
+ workspaceName?: string | undefined;
2892
+ }
2893
+ /**
2894
+ * @public
2895
+ */
2896
+ export interface ListEnrichmentJobsRequest {
2897
+ /**
2898
+ * <p>The name of the IoT SiteWise workspace to list enrichment jobs from.</p>
2899
+ * @public
2900
+ */
2901
+ workspaceName: string | undefined;
2902
+ /**
2903
+ * <p>Filter jobs by dataset ID. Returns only jobs analyzing data from the specified dataset.</p>
2904
+ * @public
2905
+ */
2906
+ datasetId?: string | undefined;
2907
+ /**
2908
+ * <p>Filter by property alias (human-readable sensor name). Specify either propertyAlias or timeSeriesId,
2909
+ * but not both. Returns only jobs analyzing the specified property alias.</p>
2910
+ * @public
2911
+ */
2912
+ propertyAlias?: string | undefined;
2913
+ /**
2914
+ * <p>Filter by time series ID (system identifier). Specify either timeSeriesId or propertyAlias, but not
2915
+ * both. Returns only jobs analyzing the specified time series.</p>
2916
+ * @public
2917
+ */
2918
+ timeSeriesId?: string | undefined;
2919
+ /**
2920
+ * <p>Filter by job status. Returns only jobs in the specified status.
2921
+ * Use RUNNING to find active jobs, or FAILED to identify jobs requiring attention.</p>
2922
+ * @public
2923
+ */
2924
+ status?: EnrichmentJobStatus | undefined;
2925
+ /**
2926
+ * <p>Filter by enrichment job type. Currently only EVENT_DETECTION is supported.
2927
+ * Use this filter to future-proof queries when additional job types are added.</p>
2928
+ * @public
2929
+ */
2930
+ jobType?: JobType | undefined;
2931
+ /**
2932
+ * <p>The exclusive start of the date range for filtering jobs by creation time. Jobs created after this
2933
+ * timestamp are included. Use ISO 8601 format (e.g., 2024-01-01T00:00:00Z).</p>
2934
+ * @public
2935
+ */
2936
+ startDate?: Date | undefined;
2937
+ /**
2938
+ * <p>The inclusive end of the date range for filtering jobs by creation time. Jobs created on or before
2939
+ * this timestamp are included. Use ISO 8601 format (e.g., 2024-01-31T23:59:59Z).</p>
2940
+ * @public
2941
+ */
2942
+ endDate?: Date | undefined;
2943
+ /**
2944
+ * <p>Maximum number of jobs to return per page. Defaults to 50 if not specified.
2945
+ * Use smaller values for faster responses, larger values to reduce API calls.</p>
2946
+ * @public
2947
+ */
2948
+ maxResults?: number | undefined;
2949
+ /**
2950
+ * <p>Pagination token from a previous ListEnrichmentJobs response. Include this token to retrieve the
2951
+ * next page of results. Omit for the first request.</p>
2952
+ * @public
2953
+ */
2954
+ nextToken?: string | undefined;
2955
+ }
2956
+ /**
2957
+ * <p>Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight
2958
+ * representation includes identifiers, status, and key metadata without the full job configuration.</p>
2959
+ * <p>Use DescribeEnrichmentJob to retrieve:</p>
2960
+ * <ul>
2961
+ * <li>Complete job configuration (trim settings, full parameters)</li>
2962
+ * <li>Detailed timestamps (completedAt, cancelledAt)</li>
2963
+ * <li>Failure messages for failed jobs</li>
2964
+ * </ul>
2965
+ * <p>The summary is optimized for display in lists and dashboards, providing enough information to
2966
+ * identify and filter jobs without the overhead of full configuration details.</p>
2967
+ * @public
2968
+ */
2969
+ export interface EnrichmentJobSummary {
2970
+ /**
2971
+ * <p>Unique identifier for the enrichment job.</p>
2972
+ * @public
2973
+ */
2974
+ jobId: string | undefined;
2975
+ /**
2976
+ * <p>Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED.
2977
+ * Use this to quickly identify active jobs or jobs requiring attention.</p>
2978
+ * @public
2979
+ */
2980
+ status: EnrichmentJobStatus | undefined;
2981
+ /**
2982
+ * <p>The name of the IoT SiteWise workspace containing this job.</p>
2983
+ * @public
2984
+ */
2985
+ workspaceName: string | undefined;
2986
+ /**
2987
+ * <p>The type of enrichment job. Currently EVENT_DETECTION is the only supported type.</p>
2988
+ * @public
2989
+ */
2990
+ jobType: JobType | undefined;
2991
+ /**
2992
+ * <p>The dataset being enriched. Useful for filtering and identifying jobs without fetching the full
2993
+ * configuration. This allows you to quickly find all jobs related to a specific dataset.</p>
2994
+ * @public
2995
+ */
2996
+ datasetId: string | undefined;
2997
+ /**
2998
+ * <p>The property alias (human-readable sensor name) of the time series being enriched.
2999
+ * Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.</p>
3000
+ * @public
3001
+ */
3002
+ propertyAlias?: string | undefined;
3003
+ /**
3004
+ * <p>The system identifier of the time series being enriched.
3005
+ * Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.</p>
3006
+ * @public
3007
+ */
3008
+ timeSeriesId?: string | undefined;
3009
+ /**
3010
+ * <p>Timestamp when the job was created in ISO 8601 format.</p>
3011
+ * @public
3012
+ */
3013
+ createdAt: Date | undefined;
3014
+ /**
3015
+ * <p>Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity
3016
+ * and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.</p>
3017
+ * @public
3018
+ */
3019
+ updatedAt?: Date | undefined;
3020
+ }
3021
+ /**
3022
+ * @public
3023
+ */
3024
+ export interface ListEnrichmentJobsResponse {
3025
+ /**
3026
+ * <p>Array of job summaries matching the filter criteria, ordered by creation time descending (newest first).
3027
+ * Each summary includes key identifiers (jobId, datasetId, propertyAlias/timeSeriesId) and status
3028
+ * information without the full job configuration. Use DescribeEnrichmentJob to retrieve complete details.</p>
3029
+ * @public
3030
+ */
3031
+ jobs: EnrichmentJobSummary[] | undefined;
3032
+ /**
3033
+ * <p>Pagination token to retrieve the next page of results. If present, more jobs exist that match the
3034
+ * filter criteria. Include this token in a subsequent ListEnrichmentJobs request to retrieve the next
3035
+ * page. If absent, you have retrieved all matching jobs.</p>
3036
+ * @public
3037
+ */
3038
+ nextToken?: string | undefined;
3039
+ }
3040
+ /**
3041
+ * @public
3042
+ */
3043
+ export interface ListExecutionsRequest {
3044
+ /**
3045
+ * <p>The type of the target resource.</p>
3046
+ * @public
3047
+ */
3048
+ targetResourceType: TargetResourceType | undefined;
3049
+ /**
3050
+ * <p>The ID of the target resource.</p>
3051
+ * @public
3052
+ */
3053
+ targetResourceId: string | undefined;
3054
+ /**
3055
+ * <p>The type of the resolved resource.</p>
3056
+ * @public
3057
+ */
3058
+ resolveToResourceType?: ResolveToResourceType | undefined;
3059
+ /**
3060
+ * <p>The ID of the resolved resource.</p>
3061
+ * @public
3062
+ */
3063
+ resolveToResourceId?: string | undefined;
3064
+ /**
3065
+ * <p>The token used for the next set of paginated results.</p>
3066
+ * @public
3067
+ */
3068
+ nextToken?: string | undefined;
3069
+ /**
3070
+ * <p>The maximum number of results returned for each paginated request.</p>
3071
+ * @public
3072
+ */
3073
+ maxResults?: number | undefined;
3074
+ /**
3075
+ * <p>The type of action exectued.</p>
3076
+ * @public
3077
+ */
3078
+ actionType?: string | undefined;
3079
+ }
3080
+ /**
3081
+ * <p>Contains the execution summary of the computation model.</p>
3082
+ * @public
3083
+ */
3084
+ export interface ExecutionSummary {
3085
+ /**
3086
+ * <p>The ID of the execution.</p>
3087
+ * @public
3088
+ */
3089
+ executionId: string | undefined;
3090
+ /**
3091
+ * <p>The type of action exectued.</p>
3092
+ * @public
3093
+ */
3094
+ actionType?: string | undefined;
3095
+ /**
3096
+ * <p>The resource the action will be taken on. This can include asset-based resources and
3097
+ * computation model resources.</p>
3098
+ * @public
3099
+ */
3100
+ targetResource: TargetResource | undefined;
3101
+ /**
3102
+ * <p>The version of the target resource.</p>
3103
+ * @public
3104
+ */
3105
+ targetResourceVersion: string | undefined;
3106
+ /**
3107
+ * <p>The detailed resource this execution resolves to.</p>
3108
+ * @public
3109
+ */
3110
+ resolveTo?: ResolveTo | undefined;
3111
+ /**
3112
+ * <p>The time the process started.</p>
3113
+ * @public
3114
+ */
3115
+ executionStartTime: Date | undefined;
3116
+ /**
3117
+ * <p>The time the process ended.</p>
3118
+ * @public
3119
+ */
3120
+ executionEndTime?: Date | undefined;
3121
+ /**
3122
+ * <p>The status of the execution process.</p>
3123
+ * @public
3124
+ */
3125
+ executionStatus: ExecutionStatus | undefined;
3126
+ /**
3127
+ * <p>The execution entity version associated with the summary.</p>
3128
+ * @public
3129
+ */
3130
+ executionEntityVersion?: string | undefined;
3131
+ }
3132
+ /**
3133
+ * @public
3134
+ */
3135
+ export interface ListExecutionsResponse {
3136
+ /**
3137
+ * <p>Contains the list of execution summaries of the computation models.</p>
3138
+ * @public
3139
+ */
3140
+ executionSummaries: ExecutionSummary[] | undefined;
3141
+ /**
3142
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3143
+ * @public
3144
+ */
3145
+ nextToken?: string | undefined;
3146
+ }
3147
+ /**
3148
+ * @public
3149
+ */
3150
+ export interface ListGatewaysRequest {
3151
+ /**
3152
+ * <p>The token to be used for the next set of paginated results.</p>
3153
+ * @public
3154
+ */
3155
+ nextToken?: string | undefined;
3156
+ /**
3157
+ * <p>The maximum number of results to return for each paginated request.</p>
3158
+ * <p>Default: 50</p>
3159
+ * @public
3160
+ */
3161
+ maxResults?: number | undefined;
3162
+ }
3163
+ /**
3164
+ * <p>Contains a summary of a gateway.</p>
3165
+ * @public
3166
+ */
3167
+ export interface GatewaySummary {
3168
+ /**
3169
+ * <p>The ID of the gateway device.</p>
3170
+ * @public
3171
+ */
3172
+ gatewayId: string | undefined;
3173
+ /**
3174
+ * <p>The name of the gateway.</p>
3175
+ * @public
3176
+ */
3177
+ gatewayName: string | undefined;
3178
+ /**
3179
+ * <p>The gateway's platform configuration. You can only specify one platform type in a
3180
+ * gateway.</p>
3181
+ * <p>(Legacy only) For Greengrass V1 gateways, specify the <code>greengrass</code> parameter
3182
+ * with a valid Greengrass group ARN.</p>
3183
+ * <p>For Greengrass V2 gateways, specify the <code>greengrassV2</code> parameter with a valid
3184
+ * core device thing name. If creating a V3 gateway (<code>gatewayVersion=3</code>), you must
3185
+ * also specify the <code>coreDeviceOperatingSystem</code>.</p>
3186
+ * <p>For Siemens Industrial Edge gateways, specify the <code>siemensIE</code> parameter with a
3187
+ * valid IoT Core thing name.</p>
3188
+ * @public
3189
+ */
3190
+ gatewayPlatform?: GatewayPlatform | undefined;
3191
+ /**
3192
+ * <p>The version of the gateway. A value of <code>3</code> indicates an MQTT-enabled, V3
3193
+ * gateway, while <code>2</code> indicates a Classic streams, V2 gateway.</p>
3194
+ * @public
3195
+ */
3196
+ gatewayVersion?: string | undefined;
3197
+ /**
3198
+ * <p>A list of gateway capability summaries that each contain a namespace and status. Each
3199
+ * gateway capability defines data sources for the gateway. To retrieve a capability
3200
+ * configuration's definition, use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html">DescribeGatewayCapabilityConfiguration</a>.</p>
3201
+ * @public
3202
+ */
3203
+ gatewayCapabilitySummaries?: GatewayCapabilitySummary[] | undefined;
3204
+ /**
3205
+ * <p>The date the gateway was created, in Unix epoch time.</p>
3206
+ * @public
3207
+ */
3208
+ creationDate: Date | undefined;
3209
+ /**
3210
+ * <p>The date the gateway was last updated, in Unix epoch time.</p>
3211
+ * @public
3212
+ */
3213
+ lastUpdateDate: Date | undefined;
3214
+ }
3215
+ /**
3216
+ * @public
3217
+ */
3218
+ export interface ListGatewaysResponse {
3219
+ /**
3220
+ * <p>A list that summarizes each gateway.</p>
3221
+ * @public
3222
+ */
3223
+ gatewaySummaries: GatewaySummary[] | undefined;
3224
+ /**
3225
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3226
+ * @public
3227
+ */
3228
+ nextToken?: string | undefined;
3229
+ }
3
3230
  /**
4
3231
  * @public
5
3232
  */
@@ -29,22 +3256,215 @@ export interface ListInterfaceRelationshipsRequest {
29
3256
  */
30
3257
  export interface InterfaceRelationshipSummary {
31
3258
  /**
32
- * <p>The ID of the asset model that has the interface applied to it.</p>
3259
+ * <p>The ID of the asset model that has the interface applied to it.</p>
3260
+ * @public
3261
+ */
3262
+ id: string | undefined;
3263
+ }
3264
+ /**
3265
+ * @public
3266
+ */
3267
+ export interface ListInterfaceRelationshipsResponse {
3268
+ /**
3269
+ * <p>A list that summarizes each interface relationship.</p>
3270
+ * @public
3271
+ */
3272
+ interfaceRelationshipSummaries: InterfaceRelationshipSummary[] | undefined;
3273
+ /**
3274
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3275
+ * @public
3276
+ */
3277
+ nextToken?: string | undefined;
3278
+ }
3279
+ /**
3280
+ * <p>Request structure for ListPipelineExecutions operation.</p>
3281
+ * @public
3282
+ */
3283
+ export interface ListPipelineExecutionsRequest {
3284
+ /**
3285
+ * <p>The name of the workspace.</p>
3286
+ * @public
3287
+ */
3288
+ workspaceName: string | undefined;
3289
+ /**
3290
+ * <p>The name of the pipeline.</p>
3291
+ * @public
3292
+ */
3293
+ pipelineName: string | undefined;
3294
+ /**
3295
+ * <p>The token to be used for the next set of paginated results.</p>
3296
+ * @public
3297
+ */
3298
+ nextToken?: string | undefined;
3299
+ /**
3300
+ * <p>The maximum number of results to return per request.
3301
+ * This is an upper bound; the actual number of results may be less. Default: 50.</p>
3302
+ * @public
3303
+ */
3304
+ maxResults?: number | undefined;
3305
+ /**
3306
+ * <p>Filter by execution state.
3307
+ * If not specified, executions in all states are returned.</p>
3308
+ * @public
3309
+ */
3310
+ state?: PipelineExecutionState | undefined;
3311
+ /**
3312
+ * <p>Inclusive lower bound on execution start time (ISO-8601).
3313
+ * Only executions with startTime &gt;= startTimeAfter are returned.
3314
+ * Cannot be combined with endTimeAfter or endTimeBefore.</p>
3315
+ * @public
3316
+ */
3317
+ startTimeAfter?: Date | undefined;
3318
+ /**
3319
+ * <p>Exclusive upper bound on execution start time (ISO-8601).
3320
+ * Only executions with startTime &lt; startTimeBefore are returned.
3321
+ * Cannot be combined with endTimeAfter or endTimeBefore.</p>
3322
+ * @public
3323
+ */
3324
+ startTimeBefore?: Date | undefined;
3325
+ /**
3326
+ * <p>Inclusive lower bound on execution end time (ISO-8601).
3327
+ * Only executions with endTime &gt;= endTimeAfter are returned.
3328
+ * Cannot be combined with startTimeAfter or startTimeBefore.
3329
+ * Only matches executions in terminal states.</p>
3330
+ * @public
3331
+ */
3332
+ endTimeAfter?: Date | undefined;
3333
+ /**
3334
+ * <p>Exclusive upper bound on execution end time (ISO-8601).
3335
+ * Only executions with endTime &lt; endTimeBefore are returned.
3336
+ * Cannot be combined with startTimeAfter or startTimeBefore.
3337
+ * Only matches executions in terminal states.</p>
3338
+ * @public
3339
+ */
3340
+ endTimeBefore?: Date | undefined;
3341
+ }
3342
+ /**
3343
+ * <p>Contains summary information about a pipeline execution.</p>
3344
+ * @public
3345
+ */
3346
+ export interface PipelineExecutionSummary {
3347
+ /**
3348
+ * <p>The unique identifier of the pipeline execution.</p>
3349
+ * @public
3350
+ */
3351
+ pipelineExecutionId: string | undefined;
3352
+ /**
3353
+ * <p>The pipeline version this execution ran against.</p>
3354
+ * @public
3355
+ */
3356
+ pipelineVersion: string | undefined;
3357
+ /**
3358
+ * <p>The current execution status of the pipeline.</p>
3359
+ * @public
3360
+ */
3361
+ status: PipelineExecutionStatus | undefined;
3362
+ /**
3363
+ * <p>Scheduling priority for the execution. When not specified, defaults to lowest priority.</p>
3364
+ * @public
3365
+ */
3366
+ executionPriority?: number | undefined;
3367
+ /**
3368
+ * <p>The time the pipeline execution started, in Unix epoch time.</p>
3369
+ * @public
3370
+ */
3371
+ startTime?: Date | undefined;
3372
+ /**
3373
+ * <p>The time the pipeline execution completed, in Unix epoch time.</p>
3374
+ * @public
3375
+ */
3376
+ endTime?: Date | undefined;
3377
+ }
3378
+ /**
3379
+ * <p>Response structure for ListPipelineExecutions operation.</p>
3380
+ * @public
3381
+ */
3382
+ export interface ListPipelineExecutionsResponse {
3383
+ /**
3384
+ * <p>A list that summarizes each pipeline execution.</p>
3385
+ * @public
3386
+ */
3387
+ pipelineExecutionSummaries: PipelineExecutionSummary[] | undefined;
3388
+ /**
3389
+ * <p>The token to be used for the next set of paginated results.</p>
3390
+ * @public
3391
+ */
3392
+ nextToken?: string | undefined;
3393
+ }
3394
+ /**
3395
+ * <p>Request structure for ListPipelines operation.</p>
3396
+ * @public
3397
+ */
3398
+ export interface ListPipelinesRequest {
3399
+ /**
3400
+ * <p>The name of the workspace.</p>
3401
+ * @public
3402
+ */
3403
+ workspaceName: string | undefined;
3404
+ /**
3405
+ * <p>The token to be used for the next set of paginated results.</p>
3406
+ * @public
3407
+ */
3408
+ nextToken?: string | undefined;
3409
+ /**
3410
+ * <p>The maximum number of results to return for each paginated request. Default: 50.</p>
3411
+ * @public
3412
+ */
3413
+ maxResults?: number | undefined;
3414
+ }
3415
+ /**
3416
+ * <p>Contains summary information about a pipeline.</p>
3417
+ * @public
3418
+ */
3419
+ export interface PipelineSummary {
3420
+ /**
3421
+ * <p>The name of the pipeline.</p>
3422
+ * @public
3423
+ */
3424
+ pipelineName: string | undefined;
3425
+ /**
3426
+ * <p>The description of the pipeline.</p>
3427
+ * @public
3428
+ */
3429
+ description?: string | undefined;
3430
+ /**
3431
+ * <p>The ARN of the pipeline.</p>
3432
+ * @public
3433
+ */
3434
+ pipelineArn: string | undefined;
3435
+ /**
3436
+ * <p>The version of the pipeline.</p>
3437
+ * @public
3438
+ */
3439
+ version: string | undefined;
3440
+ /**
3441
+ * <p>The current lifecycle status of the pipeline.</p>
33
3442
  * @public
34
3443
  */
35
- id: string | undefined;
3444
+ status: ResourceStatus | undefined;
3445
+ /**
3446
+ * <p>The time the pipeline was created, in Unix epoch time.</p>
3447
+ * @public
3448
+ */
3449
+ createdAt: Date | undefined;
3450
+ /**
3451
+ * <p>The time the pipeline was last updated, in Unix epoch time.</p>
3452
+ * @public
3453
+ */
3454
+ updatedAt: Date | undefined;
36
3455
  }
37
3456
  /**
3457
+ * <p>Response structure for ListPipelines operation.</p>
38
3458
  * @public
39
3459
  */
40
- export interface ListInterfaceRelationshipsResponse {
3460
+ export interface ListPipelinesResponse {
41
3461
  /**
42
- * <p>A list that summarizes each interface relationship.</p>
3462
+ * <p>A list that summarizes each pipeline in the workspace.</p>
43
3463
  * @public
44
3464
  */
45
- interfaceRelationshipSummaries: InterfaceRelationshipSummary[] | undefined;
3465
+ pipelineSummaries: PipelineSummary[] | undefined;
46
3466
  /**
47
- * <p>The token for the next set of results, or null if there are no additional results.</p>
3467
+ * <p>The token to be used for the next set of paginated results.</p>
48
3468
  * @public
49
3469
  */
50
3470
  nextToken?: string | undefined;
@@ -238,6 +3658,195 @@ export interface ListProjectsResponse {
238
3658
  */
239
3659
  nextToken?: string | undefined;
240
3660
  }
3661
+ /**
3662
+ * @public
3663
+ */
3664
+ export interface ListQueriesRequest {
3665
+ /**
3666
+ * <p>The name of the workspace to list queries for.</p>
3667
+ * @public
3668
+ */
3669
+ workspaceName: string | undefined;
3670
+ /**
3671
+ * <p>An optional filter to return only queries with the specified status. The value must be one of the supported query statuses: SUBMITTED, RUNNING, COMPLETED, FAILED, CANCELED, or CANCELING.</p>
3672
+ * @public
3673
+ */
3674
+ filter?: string | undefined;
3675
+ /**
3676
+ * <p>The maximum number of results to return for each paginated request.</p>
3677
+ * @public
3678
+ */
3679
+ maxResults?: number | undefined;
3680
+ /**
3681
+ * <p>The token to be used for the next set of paginated results.</p>
3682
+ * @public
3683
+ */
3684
+ nextToken?: string | undefined;
3685
+ }
3686
+ /**
3687
+ * <p>Contains summary information about a query.</p>
3688
+ * @public
3689
+ */
3690
+ export interface QuerySummary {
3691
+ /**
3692
+ * <p>The unique identifier for the query execution.</p>
3693
+ * @public
3694
+ */
3695
+ queryId: string | undefined;
3696
+ /**
3697
+ * <p>The current query status.</p>
3698
+ * @public
3699
+ */
3700
+ status: QueryStatus | undefined;
3701
+ /**
3702
+ * <p>The date and time when the query was submitted, in Unix epoch time.</p>
3703
+ * @public
3704
+ */
3705
+ submittedAt: Date | undefined;
3706
+ /**
3707
+ * <p>The date and time when the query reached a terminal state, in Unix epoch time.</p>
3708
+ * @public
3709
+ */
3710
+ completedAt?: Date | undefined;
3711
+ }
3712
+ /**
3713
+ * <p>Contains the response for the ListQueries operation.</p>
3714
+ * @public
3715
+ */
3716
+ export interface ListQueriesResponse {
3717
+ /**
3718
+ * <p>A list of query summaries for the workspace.</p>
3719
+ * @public
3720
+ */
3721
+ queries: QuerySummary[] | undefined;
3722
+ /**
3723
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
3724
+ * @public
3725
+ */
3726
+ nextToken?: string | undefined;
3727
+ }
3728
+ /**
3729
+ * <p>Optional filters for ListSearches. When multiple filters are set, a search must match all of them.</p>
3730
+ * @public
3731
+ */
3732
+ export interface ListSearchesFilters {
3733
+ /**
3734
+ * <p>Returns only searches whose status is one of the listed values.</p>
3735
+ * @public
3736
+ */
3737
+ statusFilter?: SearchStatus[] | undefined;
3738
+ /**
3739
+ * <p>Returns only searches started at or after this time.</p>
3740
+ * @public
3741
+ */
3742
+ startedAfter?: Date | undefined;
3743
+ /**
3744
+ * <p>Returns only searches started at or before this time.</p>
3745
+ * @public
3746
+ */
3747
+ startedBefore?: Date | undefined;
3748
+ /**
3749
+ * <p>Returns only searches whose <code>groupId</code> is one of the listed values.</p>
3750
+ * @public
3751
+ */
3752
+ groupIdFilter?: string[] | undefined;
3753
+ /**
3754
+ * <p>Returns only searches whose <code>searchType</code> is one of the listed values.</p>
3755
+ * @public
3756
+ */
3757
+ searchTypeFilter?: SearchType[] | undefined;
3758
+ }
3759
+ /**
3760
+ * <p>Input for the ListSearches operation.</p>
3761
+ * @public
3762
+ */
3763
+ export interface ListSearchesRequest {
3764
+ /**
3765
+ * <p>The name of the workspace whose searches are listed.</p>
3766
+ * @public
3767
+ */
3768
+ workspaceName: string | undefined;
3769
+ /**
3770
+ * <p>The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if
3771
+ * omitted, a service-defined default is used.</p>
3772
+ * @public
3773
+ */
3774
+ maxResults?: number | undefined;
3775
+ /**
3776
+ * <p>The pagination token returned by a previous ListSearches call. Provide it to retrieve the next
3777
+ * page; omit it to retrieve the first page.</p>
3778
+ * @public
3779
+ */
3780
+ nextToken?: string | undefined;
3781
+ /**
3782
+ * <p>Optional filters that restrict which searches are returned.</p>
3783
+ * @public
3784
+ */
3785
+ listSearchesFilters?: ListSearchesFilters | undefined;
3786
+ }
3787
+ /**
3788
+ * <p>A summary of a single search as returned by ListSearches.</p>
3789
+ * @public
3790
+ */
3791
+ export interface SearchSummary {
3792
+ /**
3793
+ * <p>The unique identifier of the search.</p>
3794
+ * @public
3795
+ */
3796
+ searchId: string | undefined;
3797
+ /**
3798
+ * <p>The name of the workspace the search runs against.</p>
3799
+ * @public
3800
+ */
3801
+ workspaceName: string | undefined;
3802
+ /**
3803
+ * <p>The current status of the search.</p>
3804
+ * @public
3805
+ */
3806
+ status: SearchStatus | undefined;
3807
+ /**
3808
+ * <p>The natural-language query that was submitted for the search.</p>
3809
+ * @public
3810
+ */
3811
+ queryStatement: string | undefined;
3812
+ /**
3813
+ * <p>The search strategy used for the search.</p>
3814
+ * @public
3815
+ */
3816
+ searchType: SearchType | undefined;
3817
+ /**
3818
+ * <p>A human-readable explanation of the current status. Populated when the search has <code>FAILED</code>.</p>
3819
+ * @public
3820
+ */
3821
+ statusReason?: string | undefined;
3822
+ /**
3823
+ * <p>The time at which the search was started.</p>
3824
+ * @public
3825
+ */
3826
+ startedAt?: Date | undefined;
3827
+ /**
3828
+ * <p>The group identifier associated with the search, if one was supplied on the request.</p>
3829
+ * @public
3830
+ */
3831
+ groupId?: string | undefined;
3832
+ }
3833
+ /**
3834
+ * <p>Output of the ListSearches operation.</p>
3835
+ * @public
3836
+ */
3837
+ export interface ListSearchesResponse {
3838
+ /**
3839
+ * <p>A page of search summaries, most recently started first.</p>
3840
+ * @public
3841
+ */
3842
+ searchSummaries: SearchSummary[] | undefined;
3843
+ /**
3844
+ * <p>The pagination token to use in a subsequent ListSearches call to retrieve the next page. Absent
3845
+ * when there are no more searches.</p>
3846
+ * @public
3847
+ */
3848
+ nextToken?: string | undefined;
3849
+ }
241
3850
  /**
242
3851
  * @public
243
3852
  */
@@ -260,6 +3869,84 @@ export interface ListTagsForResourceResponse {
260
3869
  */
261
3870
  tags?: Record<string, string> | undefined;
262
3871
  }
3872
+ /**
3873
+ * <p>Request structure for ListTasks operation.</p>
3874
+ * @public
3875
+ */
3876
+ export interface ListTasksRequest {
3877
+ /**
3878
+ * <p>The name of the workspace.</p>
3879
+ * @public
3880
+ */
3881
+ workspaceName: string | undefined;
3882
+ /**
3883
+ * <p>The token to be used for the next set of paginated results.</p>
3884
+ * @public
3885
+ */
3886
+ nextToken?: string | undefined;
3887
+ /**
3888
+ * <p>The maximum number of results to return for each paginated request. Default: 50.</p>
3889
+ * @public
3890
+ */
3891
+ maxResults?: number | undefined;
3892
+ }
3893
+ /**
3894
+ * <p>Contains summary information about a task.</p>
3895
+ * @public
3896
+ */
3897
+ export interface TaskSummary {
3898
+ /**
3899
+ * <p>The name of the task.</p>
3900
+ * @public
3901
+ */
3902
+ taskName: string | undefined;
3903
+ /**
3904
+ * <p>The description of the task.</p>
3905
+ * @public
3906
+ */
3907
+ description?: string | undefined;
3908
+ /**
3909
+ * <p>The ARN of the task.</p>
3910
+ * @public
3911
+ */
3912
+ taskArn: string | undefined;
3913
+ /**
3914
+ * <p>The version of the task.</p>
3915
+ * @public
3916
+ */
3917
+ version: string | undefined;
3918
+ /**
3919
+ * <p>The current lifecycle status of the task.</p>
3920
+ * @public
3921
+ */
3922
+ status: ResourceStatus | undefined;
3923
+ /**
3924
+ * <p>The time the task was created, in Unix epoch time.</p>
3925
+ * @public
3926
+ */
3927
+ createdAt: Date | undefined;
3928
+ /**
3929
+ * <p>The time the task was last updated, in Unix epoch time.</p>
3930
+ * @public
3931
+ */
3932
+ updatedAt: Date | undefined;
3933
+ }
3934
+ /**
3935
+ * <p>Response structure for ListTasks operation.</p>
3936
+ * @public
3937
+ */
3938
+ export interface ListTasksResponse {
3939
+ /**
3940
+ * <p>A list that summarizes each task in the workspace.</p>
3941
+ * @public
3942
+ */
3943
+ taskSummaries: TaskSummary[] | undefined;
3944
+ /**
3945
+ * <p>The token to be used for the next set of paginated results.</p>
3946
+ * @public
3947
+ */
3948
+ nextToken?: string | undefined;
3949
+ }
263
3950
  /**
264
3951
  * @public
265
3952
  */
@@ -303,6 +3990,11 @@ export interface ListTimeSeriesRequest {
303
3990
  * @public
304
3991
  */
305
3992
  timeSeriesType?: ListTimeSeriesType | undefined;
3993
+ /**
3994
+ * <p>The name of the workspace.</p>
3995
+ * @public
3996
+ */
3997
+ workspaceName?: string | undefined;
306
3998
  }
307
3999
  /**
308
4000
  * <p>Contains a summary of a time series (data stream).</p>
@@ -320,58 +4012,125 @@ export interface TimeSeriesSummary {
320
4012
  */
321
4013
  propertyId?: string | undefined;
322
4014
  /**
323
- * <p>The alias that identifies the time series.</p>
4015
+ * <p>The alias that identifies the time series.</p>
4016
+ * @public
4017
+ */
4018
+ alias?: string | undefined;
4019
+ /**
4020
+ * <p>The ID of the time series.</p>
4021
+ * @public
4022
+ */
4023
+ timeSeriesId: string | undefined;
4024
+ /**
4025
+ * <p>The data type of the time series.</p>
4026
+ * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
4027
+ * @public
4028
+ */
4029
+ dataType: PropertyDataType | undefined;
4030
+ /**
4031
+ * <p>The data type of the structure for this time series. This parameter is required for time series
4032
+ * that have the <code>STRUCT</code> data type.</p>
4033
+ * <p>The options for this parameter depend on the type of the composite model
4034
+ * in which you created the asset property that is associated with your time series.
4035
+ * Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
4036
+ * @public
4037
+ */
4038
+ dataTypeSpec?: string | undefined;
4039
+ /**
4040
+ * <p>The date that the time series was created, in Unix epoch time.</p>
4041
+ * @public
4042
+ */
4043
+ timeSeriesCreationDate: Date | undefined;
4044
+ /**
4045
+ * <p>The date that the time series was last updated, in Unix epoch time.</p>
4046
+ * @public
4047
+ */
4048
+ timeSeriesLastUpdateDate: Date | undefined;
4049
+ /**
4050
+ * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
4051
+ * <p>
4052
+ * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
4053
+ * </p>
4054
+ * @public
4055
+ */
4056
+ timeSeriesArn: string | undefined;
4057
+ }
4058
+ /**
4059
+ * @public
4060
+ */
4061
+ export interface ListTimeSeriesResponse {
4062
+ /**
4063
+ * <p>One or more time series summaries to list.</p>
4064
+ * @public
4065
+ */
4066
+ TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
4067
+ /**
4068
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
4069
+ * @public
4070
+ */
4071
+ nextToken?: string | undefined;
4072
+ /**
4073
+ * <p>The name of the workspace.</p>
4074
+ * @public
4075
+ */
4076
+ workspaceName?: string | undefined;
4077
+ }
4078
+ /**
4079
+ * @public
4080
+ */
4081
+ export interface ListWorkspacesRequest {
4082
+ /**
4083
+ * <p>The token to be used for the next set of paginated results.</p>
324
4084
  * @public
325
4085
  */
326
- alias?: string | undefined;
4086
+ nextToken?: string | undefined;
327
4087
  /**
328
- * <p>The ID of the time series.</p>
4088
+ * <p>The maximum number of results to return for each paginated request. Default: 50.</p>
329
4089
  * @public
330
4090
  */
331
- timeSeriesId: string | undefined;
4091
+ maxResults?: number | undefined;
4092
+ }
4093
+ /**
4094
+ * <p>Contains summary information about a workspace, including its name, ARN, status, and
4095
+ * creation and update timestamps.</p>
4096
+ * @public
4097
+ */
4098
+ export interface WorkspaceSummary {
332
4099
  /**
333
- * <p>The data type of the time series.</p>
334
- * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
4100
+ * <p>The name of the workspace.</p>
335
4101
  * @public
336
4102
  */
337
- dataType: PropertyDataType | undefined;
4103
+ name: string | undefined;
338
4104
  /**
339
- * <p>The data type of the structure for this time series. This parameter is required for time series
340
- * that have the <code>STRUCT</code> data type.</p>
341
- * <p>The options for this parameter depend on the type of the composite model
342
- * in which you created the asset property that is associated with your time series.
343
- * Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
4105
+ * <p>The ARN of the workspace.</p>
344
4106
  * @public
345
4107
  */
346
- dataTypeSpec?: string | undefined;
4108
+ arn: string | undefined;
347
4109
  /**
348
- * <p>The date that the time series was created, in Unix epoch time.</p>
4110
+ * <p>The status of the workspace.</p>
349
4111
  * @public
350
4112
  */
351
- timeSeriesCreationDate: Date | undefined;
4113
+ status: WorkspaceStatus | undefined;
352
4114
  /**
353
- * <p>The date that the time series was last updated, in Unix epoch time.</p>
4115
+ * <p>The date the workspace was created, in Unix epoch time.</p>
354
4116
  * @public
355
4117
  */
356
- timeSeriesLastUpdateDate: Date | undefined;
4118
+ createdAt: Date | undefined;
357
4119
  /**
358
- * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the time series, which has the following format.</p>
359
- * <p>
360
- * <code>arn:$\{Partition\}:iotsitewise:$\{Region\}:$\{Account\}:time-series/$\{TimeSeriesId\}</code>
361
- * </p>
4120
+ * <p>The date the workspace was last updated, in Unix epoch time.</p>
362
4121
  * @public
363
4122
  */
364
- timeSeriesArn: string | undefined;
4123
+ updatedAt: Date | undefined;
365
4124
  }
366
4125
  /**
367
4126
  * @public
368
4127
  */
369
- export interface ListTimeSeriesResponse {
4128
+ export interface ListWorkspacesResponse {
370
4129
  /**
371
- * <p>One or more time series summaries to list.</p>
4130
+ * <p>A list that summarizes each workspace.</p>
372
4131
  * @public
373
4132
  */
374
- TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
4133
+ workspaceSummaries: WorkspaceSummary[] | undefined;
375
4134
  /**
376
4135
  * <p>The token for the next set of results, or null if there are no additional results.</p>
377
4136
  * @public
@@ -509,6 +4268,11 @@ export interface PutLoggingOptionsRequest {
509
4268
  * @public
510
4269
  */
511
4270
  loggingOptions: LoggingOptions | undefined;
4271
+ /**
4272
+ * <p>The name of the workspace.</p>
4273
+ * @public
4274
+ */
4275
+ workspaceName?: string | undefined;
512
4276
  }
513
4277
  /**
514
4278
  * @public
@@ -661,6 +4425,189 @@ export interface PutStorageConfigurationResponse {
661
4425
  */
662
4426
  disallowIngestNullNaN?: boolean | undefined;
663
4427
  }
4428
+ /**
4429
+ * <p>Request structure for StartPipelineExecution operation.</p>
4430
+ * @public
4431
+ */
4432
+ export interface StartPipelineExecutionRequest {
4433
+ /**
4434
+ * <p>The name of the workspace containing the pipeline.</p>
4435
+ * @public
4436
+ */
4437
+ workspaceName: string | undefined;
4438
+ /**
4439
+ * <p>The name of the pipeline to execute.</p>
4440
+ * @public
4441
+ */
4442
+ pipelineName: string | undefined;
4443
+ /**
4444
+ * <p>Runtime environment variable overrides for the execution. Includes global variables
4445
+ * that apply to all compute nodes and computeNodes for per-node overrides. These take the highest
4446
+ * priority in the environment variable hierarchy.</p>
4447
+ * @public
4448
+ */
4449
+ executionEnvironmentVariableOverrides?: ExecutionEnvironmentVariables | undefined;
4450
+ /**
4451
+ * <p>Scheduling priority for the execution. Lower values indicate higher priority. Defaults to 2 when not specified.</p>
4452
+ * @public
4453
+ */
4454
+ executionPriority?: number | undefined;
4455
+ /**
4456
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
4457
+ * If you retry a request that completed successfully using the same client token, the server returns the
4458
+ * cached result from the original successful request without performing the operation again.</p>
4459
+ * @public
4460
+ */
4461
+ clientToken?: string | undefined;
4462
+ }
4463
+ /**
4464
+ * <p>Response structure for StartPipelineExecution operation.</p>
4465
+ * @public
4466
+ */
4467
+ export interface StartPipelineExecutionResponse {
4468
+ /**
4469
+ * <p>The unique identifier of the created pipeline execution.</p>
4470
+ * @public
4471
+ */
4472
+ pipelineExecutionId: string | undefined;
4473
+ }
4474
+ /**
4475
+ * @public
4476
+ */
4477
+ export interface StartQueryRequest {
4478
+ /**
4479
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
4480
+ * @public
4481
+ */
4482
+ clientToken?: string | undefined;
4483
+ /**
4484
+ * <p>The name of the workspace to query.</p>
4485
+ * @public
4486
+ */
4487
+ workspaceName: string | undefined;
4488
+ /**
4489
+ * <p>The SQL query to execute against the workspace telemetry, annotations, data segment, and dataset data.</p>
4490
+ * @public
4491
+ */
4492
+ queryStatement: string | undefined;
4493
+ }
4494
+ /**
4495
+ * <p>Contains the response for the StartQuery operation.</p>
4496
+ * @public
4497
+ */
4498
+ export interface StartQueryResponse {
4499
+ /**
4500
+ * <p>The unique identifier for the query execution.</p>
4501
+ * @public
4502
+ */
4503
+ queryId: string | undefined;
4504
+ /**
4505
+ * <p>The initial query status. The value is always SUBMITTED upon creation.</p>
4506
+ * @public
4507
+ */
4508
+ status: QueryStatus | undefined;
4509
+ }
4510
+ /**
4511
+ * <p>Contains a time interval with a start time and an end time. Use a time interval to restrict an operation, such as a search, to a specific time range.</p>
4512
+ * @public
4513
+ */
4514
+ export interface TimeInterval {
4515
+ /**
4516
+ * <p>The start of the time interval.</p>
4517
+ * @public
4518
+ */
4519
+ startTime: TimeInNanos | undefined;
4520
+ /**
4521
+ * <p>The end of the time interval.</p>
4522
+ * @public
4523
+ */
4524
+ endTime: TimeInNanos | undefined;
4525
+ }
4526
+ /**
4527
+ * <p>Optional filters that restrict a search to a subset of the workspace's data.</p>
4528
+ * @public
4529
+ */
4530
+ export interface SearchFilters {
4531
+ /**
4532
+ * <p>Restricts the search to these time series.</p>
4533
+ * @public
4534
+ */
4535
+ timeSeriesIds?: string[] | undefined;
4536
+ /**
4537
+ * <p>Restricts the search to these datasets.</p>
4538
+ * @public
4539
+ */
4540
+ datasetIds?: string[] | undefined;
4541
+ /**
4542
+ * <p>Restricts the search to these time intervals.</p>
4543
+ * @public
4544
+ */
4545
+ timeIntervals?: TimeInterval[] | undefined;
4546
+ }
4547
+ /**
4548
+ * <p>Input for the StartSearch operation.</p>
4549
+ * @public
4550
+ */
4551
+ export interface StartSearchRequest {
4552
+ /**
4553
+ * <p>The name of the workspace whose data is searched.</p>
4554
+ * @public
4555
+ */
4556
+ workspaceName: string | undefined;
4557
+ /**
4558
+ * <p>The natural-language query describing the data to search for.</p>
4559
+ * @public
4560
+ */
4561
+ queryStatement: string | undefined;
4562
+ /**
4563
+ * <p>A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating
4564
+ * a StartSearch call with the same <code>clientToken</code> returns the original search rather than starting
4565
+ * a new one. If omitted, the SDK autogenerates one.</p>
4566
+ * @public
4567
+ */
4568
+ clientToken?: string | undefined;
4569
+ /**
4570
+ * <p>The search strategy to use. Defaults to <code>QUICK</code> when omitted.</p>
4571
+ * @public
4572
+ */
4573
+ searchType?: SearchType | undefined;
4574
+ /**
4575
+ * <p>Optional filters that restrict the search to a subset of the workspace's data.</p>
4576
+ * @public
4577
+ */
4578
+ searchFilters?: SearchFilters | undefined;
4579
+ /**
4580
+ * <p>An optional caller-supplied identifier used to group related searches together.</p>
4581
+ * @public
4582
+ */
4583
+ groupId?: string | undefined;
4584
+ }
4585
+ /**
4586
+ * <p>Output of the StartSearch operation.</p>
4587
+ * @public
4588
+ */
4589
+ export interface StartSearchResponse {
4590
+ /**
4591
+ * <p>The unique identifier assigned to the newly started search.</p>
4592
+ * @public
4593
+ */
4594
+ searchId: string | undefined;
4595
+ /**
4596
+ * <p>The name of the workspace the search runs against.</p>
4597
+ * @public
4598
+ */
4599
+ workspaceName: string | undefined;
4600
+ /**
4601
+ * <p>The initial status of the search. A newly started search is <code>QUEUED</code>.</p>
4602
+ * @public
4603
+ */
4604
+ status: SearchStatus | undefined;
4605
+ /**
4606
+ * <p>The group identifier associated with the search, if one was supplied on the request.</p>
4607
+ * @public
4608
+ */
4609
+ groupId?: string | undefined;
4610
+ }
664
4611
  /**
665
4612
  * @public
666
4613
  */
@@ -774,6 +4721,11 @@ export interface UpdateAssetRequest {
774
4721
  * @public
775
4722
  */
776
4723
  export interface UpdateAssetResponse {
4724
+ /**
4725
+ * <p>The ID of the asset.</p>
4726
+ * @public
4727
+ */
4728
+ assetId?: string | undefined;
777
4729
  /**
778
4730
  * <p>The status of the asset, which contains a state (<code>UPDATING</code> after successfully
779
4731
  * calling this operation) and any error message.</p>
@@ -867,6 +4819,11 @@ export interface UpdateAssetModelRequest {
867
4819
  * @public
868
4820
  */
869
4821
  export interface UpdateAssetModelResponse {
4822
+ /**
4823
+ * <p>The ID of the asset model.</p>
4824
+ * @public
4825
+ */
4826
+ assetModelId?: string | undefined;
870
4827
  /**
871
4828
  * <p>The status of the asset model, which contains a state (<code>UPDATING</code> after
872
4829
  * successfully calling this operation) and any error message.</p>
@@ -954,6 +4911,11 @@ export interface UpdateAssetModelCompositeModelResponse {
954
4911
  * @public
955
4912
  */
956
4913
  assetModelStatus: AssetModelStatus | undefined;
4914
+ /**
4915
+ * <p>The ID of the asset model.</p>
4916
+ * @public
4917
+ */
4918
+ assetModelId?: string | undefined;
957
4919
  }
958
4920
  /**
959
4921
  * @public
@@ -1068,6 +5030,11 @@ export interface UpdateDatasetRequest {
1068
5030
  * @public
1069
5031
  */
1070
5032
  datasetId: string | undefined;
5033
+ /**
5034
+ * <p>The name of the workspace that contains the dataset.</p>
5035
+ * @public
5036
+ */
5037
+ workspaceName?: string | undefined;
1071
5038
  /**
1072
5039
  * <p>The name of the dataset.</p>
1073
5040
  * @public
@@ -1078,6 +5045,16 @@ export interface UpdateDatasetRequest {
1078
5045
  * @public
1079
5046
  */
1080
5047
  datasetDescription?: string | undefined;
5048
+ /**
5049
+ * <p>The updated configuration for the dataset.</p>
5050
+ * @public
5051
+ */
5052
+ datasetConfig?: DatasetConfig | undefined;
5053
+ /**
5054
+ * <p>The updated metadata for the dataset.</p>
5055
+ * @public
5056
+ */
5057
+ metadata?: Record<string, string> | undefined;
1081
5058
  /**
1082
5059
  * <p>The data source for the dataset.</p>
1083
5060
  * @public
@@ -1190,6 +5167,53 @@ export interface UpdateGatewayCapabilityConfigurationResponse {
1190
5167
  */
1191
5168
  capabilitySyncStatus: CapabilitySyncStatus | undefined;
1192
5169
  }
5170
+ /**
5171
+ * <p>Request structure for UpdatePipeline operation.</p>
5172
+ * @public
5173
+ */
5174
+ export interface UpdatePipelineRequest {
5175
+ /**
5176
+ * <p>The name of the workspace.</p>
5177
+ * @public
5178
+ */
5179
+ workspaceName: string | undefined;
5180
+ /**
5181
+ * <p>The name of the pipeline to update.</p>
5182
+ * @public
5183
+ */
5184
+ pipelineName: string | undefined;
5185
+ /**
5186
+ * <p>A new description for the pipeline.</p>
5187
+ * @public
5188
+ */
5189
+ description?: string | undefined;
5190
+ /**
5191
+ * <p>Updated environment variables shared across all compute nodes.</p>
5192
+ * @public
5193
+ */
5194
+ environmentVariables?: Record<string, string> | undefined;
5195
+ /**
5196
+ * <p>Updated list of compute nodes forming the pipeline DAG.</p>
5197
+ * @public
5198
+ */
5199
+ computations?: ComputeNode[] | undefined;
5200
+ }
5201
+ /**
5202
+ * <p>Response structure for UpdatePipeline operation.</p>
5203
+ * @public
5204
+ */
5205
+ export interface UpdatePipelineResponse {
5206
+ /**
5207
+ * <p>The new version of the pipeline created by this update.</p>
5208
+ * @public
5209
+ */
5210
+ version: string | undefined;
5211
+ /**
5212
+ * <p>The current lifecycle status of the pipeline.</p>
5213
+ * @public
5214
+ */
5215
+ status: ResourceStatus | undefined;
5216
+ }
1193
5217
  /**
1194
5218
  * <p>Contains an image that is one of the following:</p>
1195
5219
  * <ul>
@@ -1327,6 +5351,88 @@ export interface UpdateProjectRequest {
1327
5351
  */
1328
5352
  export interface UpdateProjectResponse {
1329
5353
  }
5354
+ /**
5355
+ * <p>Request structure for UpdateTask operation.</p>
5356
+ * @public
5357
+ */
5358
+ export interface UpdateTaskRequest {
5359
+ /**
5360
+ * <p>The name of the workspace.</p>
5361
+ * @public
5362
+ */
5363
+ workspaceName: string | undefined;
5364
+ /**
5365
+ * <p>The name of the task to update.</p>
5366
+ * @public
5367
+ */
5368
+ taskName: string | undefined;
5369
+ /**
5370
+ * <p>A new description for the task.</p>
5371
+ * @public
5372
+ */
5373
+ description?: string | undefined;
5374
+ /**
5375
+ * <p>The updated task execution configuration.</p>
5376
+ * @public
5377
+ */
5378
+ taskConfiguration?: TaskConfiguration | undefined;
5379
+ }
5380
+ /**
5381
+ * <p>Response structure for UpdateTask operation.</p>
5382
+ * @public
5383
+ */
5384
+ export interface UpdateTaskResponse {
5385
+ /**
5386
+ * <p>The new version of the task created by this update.</p>
5387
+ * @public
5388
+ */
5389
+ version: string | undefined;
5390
+ /**
5391
+ * <p>The current lifecycle status of the task.</p>
5392
+ * @public
5393
+ */
5394
+ status: ResourceStatus | undefined;
5395
+ }
5396
+ /**
5397
+ * @public
5398
+ */
5399
+ export interface UpdateWorkspaceRequest {
5400
+ /**
5401
+ * <p>The name of the workspace to update.</p>
5402
+ * @public
5403
+ */
5404
+ workspaceName: string | undefined;
5405
+ /**
5406
+ * <p>A new description for the workspace.</p>
5407
+ * @public
5408
+ */
5409
+ workspaceDescription?: string | undefined;
5410
+ /**
5411
+ * <p>The encryption configuration for the workspace. Omit this field to leave encryption
5412
+ * unchanged. After a customer managed key configuration becomes active, the key can't be
5413
+ * changed; supplying the same key is accepted.</p>
5414
+ * @public
5415
+ */
5416
+ encryptionConfiguration?: WorkspaceEncryptionConfiguration | undefined;
5417
+ /**
5418
+ * <p>A unique, case-sensitive identifier that you provide to ensure that the request is
5419
+ * idempotent. If you retry a request that completed successfully using the same client token,
5420
+ * the retry succeeds without performing any further actions.</p>
5421
+ * @public
5422
+ */
5423
+ clientToken?: string | undefined;
5424
+ }
5425
+ /**
5426
+ * @public
5427
+ */
5428
+ export interface UpdateWorkspaceResponse {
5429
+ /**
5430
+ * <p>The status of the workspace after the update, which is <code>UPDATING</code> when the
5431
+ * operation returns.</p>
5432
+ * @public
5433
+ */
5434
+ workspaceStatus: WorkspaceStatus | undefined;
5435
+ }
1330
5436
  /**
1331
5437
  * <p>Contains computation model data binding value information, which can be one of
1332
5438
  * <code>assetModelProperty</code>, <code>list</code>.</p>