@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
@@ -0,0 +1,120 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DescribePipelineRequest, DescribePipelineResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DescribePipelineCommand}.
11
+ */
12
+ export interface DescribePipelineCommandInput extends DescribePipelineRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DescribePipelineCommand}.
18
+ */
19
+ export interface DescribePipelineCommandOutput extends DescribePipelineResponse, __MetadataBearer {
20
+ }
21
+ declare const DescribePipelineCommand_base: {
22
+ new (input: DescribePipelineCommandInput): import("@smithy/core/client").CommandImpl<DescribePipelineCommandInput, DescribePipelineCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DescribePipelineCommandInput): import("@smithy/core/client").CommandImpl<DescribePipelineCommandInput, DescribePipelineCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific pipeline in a workspace.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IoTSiteWiseClient, DescribePipelineCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
+ * // const { IoTSiteWiseClient, DescribePipelineCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
34
+ * const config = {}; // type is IoTSiteWiseClientConfig
35
+ * const client = new IoTSiteWiseClient(config);
36
+ * const input = { // DescribePipelineRequest
37
+ * workspaceName: "STRING_VALUE", // required
38
+ * pipelineName: "STRING_VALUE", // required
39
+ * pipelineVersion: "STRING_VALUE",
40
+ * };
41
+ * const command = new DescribePipelineCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // DescribePipelineResponse
44
+ * // pipelineName: "STRING_VALUE", // required
45
+ * // workspaceName: "STRING_VALUE", // required
46
+ * // description: "STRING_VALUE",
47
+ * // pipelineArn: "STRING_VALUE", // required
48
+ * // version: "STRING_VALUE", // required
49
+ * // environmentVariables: { // EnvironmentVariablesMap
50
+ * // "<keys>": "STRING_VALUE",
51
+ * // },
52
+ * // computations: [ // ComputeNodeList // required
53
+ * // { // ComputeNode
54
+ * // computeNodeName: "STRING_VALUE", // required
55
+ * // taskName: "STRING_VALUE", // required
56
+ * // environmentVariables: {
57
+ * // "<keys>": "STRING_VALUE",
58
+ * // },
59
+ * // dependsOn: [ // ComputeNodeNameList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // },
63
+ * // ],
64
+ * // status: { // ResourceStatus
65
+ * // error: { // ResourceError
66
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE",
67
+ * // message: "STRING_VALUE",
68
+ * // },
69
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
70
+ * // },
71
+ * // createdAt: new Date("TIMESTAMP"), // required
72
+ * // updatedAt: new Date("TIMESTAMP"), // required
73
+ * // };
74
+ *
75
+ * ```
76
+ *
77
+ * @param DescribePipelineCommandInput - {@link DescribePipelineCommandInput}
78
+ * @returns {@link DescribePipelineCommandOutput}
79
+ * @see {@link DescribePipelineCommandInput} for command's `input` shape.
80
+ * @see {@link DescribePipelineCommandOutput} for command's `response` shape.
81
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>Access is denied.</p>
85
+ *
86
+ * @throws {@link InternalFailureException} (server fault)
87
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
88
+ *
89
+ * @throws {@link InvalidRequestException} (client fault)
90
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
91
+ * unsupported characters. Check your request and try again.</p>
92
+ *
93
+ * @throws {@link ResourceNotFoundException} (client fault)
94
+ * <p>The requested resource can't be found.</p>
95
+ *
96
+ * @throws {@link ThrottlingException} (client fault)
97
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
98
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
99
+ * on.</p>
100
+ * <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>
101
+ *
102
+ * @throws {@link IoTSiteWiseServiceException}
103
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
104
+ *
105
+ *
106
+ * @public
107
+ */
108
+ export declare class DescribePipelineCommand extends DescribePipelineCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: DescribePipelineRequest;
113
+ output: DescribePipelineResponse;
114
+ };
115
+ sdk: {
116
+ input: DescribePipelineCommandInput;
117
+ output: DescribePipelineCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -0,0 +1,156 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DescribePipelineExecutionRequest, DescribePipelineExecutionResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DescribePipelineExecutionCommand}.
11
+ */
12
+ export interface DescribePipelineExecutionCommandInput extends DescribePipelineExecutionRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DescribePipelineExecutionCommand}.
18
+ */
19
+ export interface DescribePipelineExecutionCommandOutput extends DescribePipelineExecutionResponse, __MetadataBearer {
20
+ }
21
+ declare const DescribePipelineExecutionCommand_base: {
22
+ new (input: DescribePipelineExecutionCommandInput): import("@smithy/core/client").CommandImpl<DescribePipelineExecutionCommandInput, DescribePipelineExecutionCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DescribePipelineExecutionCommandInput): import("@smithy/core/client").CommandImpl<DescribePipelineExecutionCommandInput, DescribePipelineExecutionCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific pipeline execution, including the
28
+ * overall execution status and the status of each individual compute node. Use this
29
+ * operation to monitor execution progress and inspect per-node results, environment
30
+ * variables, and error details.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { IoTSiteWiseClient, DescribePipelineExecutionCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
35
+ * // const { IoTSiteWiseClient, DescribePipelineExecutionCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
36
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
37
+ * const config = {}; // type is IoTSiteWiseClientConfig
38
+ * const client = new IoTSiteWiseClient(config);
39
+ * const input = { // DescribePipelineExecutionRequest
40
+ * workspaceName: "STRING_VALUE", // required
41
+ * pipelineName: "STRING_VALUE", // required
42
+ * pipelineExecutionId: "STRING_VALUE", // required
43
+ * nextToken: "STRING_VALUE",
44
+ * maxResults: Number("int"),
45
+ * };
46
+ * const command = new DescribePipelineExecutionCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // DescribePipelineExecutionResponse
49
+ * // pipelineExecutionId: "STRING_VALUE", // required
50
+ * // pipelineName: "STRING_VALUE", // required
51
+ * // workspaceName: "STRING_VALUE", // required
52
+ * // pipelineVersion: "STRING_VALUE", // required
53
+ * // status: { // PipelineExecutionStatus
54
+ * // state: "NOT_STARTED" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLING" || "CANCELLED", // required
55
+ * // stateDetails: { // PipelineExecutionStateDetails
56
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE" || "EXECUTION_ERROR" || "TIMED_OUT",
57
+ * // message: "STRING_VALUE", // required
58
+ * // details: [ // DetailedErrorList
59
+ * // { // DetailedPipelineError
60
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE" || "EXECUTION_ERROR" || "TIMED_OUT", // required
61
+ * // message: "STRING_VALUE", // required
62
+ * // },
63
+ * // ],
64
+ * // },
65
+ * // },
66
+ * // startTime: new Date("TIMESTAMP"),
67
+ * // endTime: new Date("TIMESTAMP"),
68
+ * // requestEnvironmentVariables: { // ExecutionEnvironmentVariables
69
+ * // global: { // EnvironmentVariablesMap
70
+ * // "<keys>": "STRING_VALUE",
71
+ * // },
72
+ * // computeNodes: { // ComputeNodeEnvironmentVariablesMap
73
+ * // "<keys>": {
74
+ * // "<keys>": "STRING_VALUE",
75
+ * // },
76
+ * // },
77
+ * // },
78
+ * // executionPriority: Number("int"),
79
+ * // computeNodeExecutionDetails: [ // ComputeNodeExecutionDetailsList // required
80
+ * // { // ComputeNodeExecutionDetails
81
+ * // computeNodeName: "STRING_VALUE", // required
82
+ * // taskName: "STRING_VALUE", // required
83
+ * // taskArn: "STRING_VALUE", // required
84
+ * // taskVersion: "STRING_VALUE", // required
85
+ * // dependsOn: [ // ComputeNodeNameList // required
86
+ * // "STRING_VALUE",
87
+ * // ],
88
+ * // status: { // ComputeNodeExecutionStatus
89
+ * // state: "NOT_STARTED" || "QUEUED" || "RUNNING" || "SUCCEEDED" || "FAILED", // required
90
+ * // stateDetails: { // ComputeNodeExecutionStateDetails
91
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE" || "EXECUTION_ERROR" || "TIMED_OUT", // required
92
+ * // message: "STRING_VALUE", // required
93
+ * // details: [
94
+ * // {
95
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE" || "EXECUTION_ERROR" || "TIMED_OUT", // required
96
+ * // message: "STRING_VALUE", // required
97
+ * // },
98
+ * // ],
99
+ * // },
100
+ * // },
101
+ * // startTime: new Date("TIMESTAMP"),
102
+ * // endTime: new Date("TIMESTAMP"),
103
+ * // executionEnvironmentVariables: { // ExecutionEnvironmentVariablesMap
104
+ * // "<keys>": "STRING_VALUE",
105
+ * // },
106
+ * // },
107
+ * // ],
108
+ * // nextToken: "STRING_VALUE",
109
+ * // };
110
+ *
111
+ * ```
112
+ *
113
+ * @param DescribePipelineExecutionCommandInput - {@link DescribePipelineExecutionCommandInput}
114
+ * @returns {@link DescribePipelineExecutionCommandOutput}
115
+ * @see {@link DescribePipelineExecutionCommandInput} for command's `input` shape.
116
+ * @see {@link DescribePipelineExecutionCommandOutput} for command's `response` shape.
117
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
118
+ *
119
+ * @throws {@link AccessDeniedException} (client fault)
120
+ * <p>Access is denied.</p>
121
+ *
122
+ * @throws {@link InternalFailureException} (server fault)
123
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
124
+ *
125
+ * @throws {@link InvalidRequestException} (client fault)
126
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
127
+ * unsupported characters. Check your request and try again.</p>
128
+ *
129
+ * @throws {@link ResourceNotFoundException} (client fault)
130
+ * <p>The requested resource can't be found.</p>
131
+ *
132
+ * @throws {@link ThrottlingException} (client fault)
133
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
134
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
135
+ * on.</p>
136
+ * <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>
137
+ *
138
+ * @throws {@link IoTSiteWiseServiceException}
139
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
140
+ *
141
+ *
142
+ * @public
143
+ */
144
+ export declare class DescribePipelineExecutionCommand extends DescribePipelineExecutionCommand_base {
145
+ /** @internal type navigation helper, not in runtime. */
146
+ protected static __types: {
147
+ api: {
148
+ input: DescribePipelineExecutionRequest;
149
+ output: DescribePipelineExecutionResponse;
150
+ };
151
+ sdk: {
152
+ input: DescribePipelineExecutionCommandInput;
153
+ output: DescribePipelineExecutionCommandOutput;
154
+ };
155
+ };
156
+ }
@@ -0,0 +1,100 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DescribeQueryRequest, DescribeQueryResponse } from "../models/models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DescribeQueryCommand}.
11
+ */
12
+ export interface DescribeQueryCommandInput extends DescribeQueryRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DescribeQueryCommand}.
18
+ */
19
+ export interface DescribeQueryCommandOutput extends DescribeQueryResponse, __MetadataBearer {
20
+ }
21
+ declare const DescribeQueryCommand_base: {
22
+ new (input: DescribeQueryCommandInput): import("@smithy/core/client").CommandImpl<DescribeQueryCommandInput, DescribeQueryCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DescribeQueryCommandInput): import("@smithy/core/client").CommandImpl<DescribeQueryCommandInput, DescribeQueryCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves information about a query, including its status.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IoTSiteWiseClient, DescribeQueryCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
+ * // const { IoTSiteWiseClient, DescribeQueryCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
34
+ * const config = {}; // type is IoTSiteWiseClientConfig
35
+ * const client = new IoTSiteWiseClient(config);
36
+ * const input = { // DescribeQueryRequest
37
+ * workspaceName: "STRING_VALUE", // required
38
+ * queryId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new DescribeQueryCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // DescribeQueryResponse
43
+ * // queryId: "STRING_VALUE", // required
44
+ * // status: "SUBMITTED" || "RUNNING" || "COMPLETED" || "FAILED" || "CANCELED" || "CANCELING", // required
45
+ * // submittedAt: new Date("TIMESTAMP"), // required
46
+ * // completedAt: new Date("TIMESTAMP"),
47
+ * // statistics: { // QueryStatistics
48
+ * // rowCount: Number("long"), // required
49
+ * // bytesScanned: Number("long"), // required
50
+ * // executionTimeInMillis: Number("long"), // required
51
+ * // },
52
+ * // errorMessage: "STRING_VALUE",
53
+ * // };
54
+ *
55
+ * ```
56
+ *
57
+ * @param DescribeQueryCommandInput - {@link DescribeQueryCommandInput}
58
+ * @returns {@link DescribeQueryCommandOutput}
59
+ * @see {@link DescribeQueryCommandInput} for command's `input` shape.
60
+ * @see {@link DescribeQueryCommandOutput} for command's `response` shape.
61
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
62
+ *
63
+ * @throws {@link AccessDeniedException} (client fault)
64
+ * <p>Access is denied.</p>
65
+ *
66
+ * @throws {@link InternalFailureException} (server fault)
67
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
68
+ *
69
+ * @throws {@link InvalidRequestException} (client fault)
70
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
71
+ * unsupported characters. Check your request and try again.</p>
72
+ *
73
+ * @throws {@link ResourceNotFoundException} (client fault)
74
+ * <p>The requested resource can't be found.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
78
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
79
+ * on.</p>
80
+ * <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>
81
+ *
82
+ * @throws {@link IoTSiteWiseServiceException}
83
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
84
+ *
85
+ *
86
+ * @public
87
+ */
88
+ export declare class DescribeQueryCommand extends DescribeQueryCommand_base {
89
+ /** @internal type navigation helper, not in runtime. */
90
+ protected static __types: {
91
+ api: {
92
+ input: DescribeQueryRequest;
93
+ output: DescribeQueryResponse;
94
+ };
95
+ sdk: {
96
+ input: DescribeQueryCommandInput;
97
+ output: DescribeQueryCommandOutput;
98
+ };
99
+ };
100
+ }
@@ -0,0 +1,102 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DescribeSearchRequest } from "../models/models_0";
3
+ import type { DescribeSearchResponse } from "../models/models_1";
4
+ /**
5
+ * @public
6
+ */
7
+ export type { __MetadataBearer };
8
+ /**
9
+ * @public
10
+ *
11
+ * The input for {@link DescribeSearchCommand}.
12
+ */
13
+ export interface DescribeSearchCommandInput extends DescribeSearchRequest {
14
+ }
15
+ /**
16
+ * @public
17
+ *
18
+ * The output of {@link DescribeSearchCommand}.
19
+ */
20
+ export interface DescribeSearchCommandOutput extends DescribeSearchResponse, __MetadataBearer {
21
+ }
22
+ declare const DescribeSearchCommand_base: {
23
+ new (input: DescribeSearchCommandInput): import("@smithy/core/client").CommandImpl<DescribeSearchCommandInput, DescribeSearchCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ new (input: DescribeSearchCommandInput): import("@smithy/core/client").CommandImpl<DescribeSearchCommandInput, DescribeSearchCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
25
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
26
+ };
27
+ /**
28
+ * <p>Returns the current status and metadata of a single search, including the query that was
29
+ * submitted, the search type, and — when the search has failed — the reason. Use this to poll a
30
+ * search started with <code>StartSearch</code> until it reaches a terminal status (<code>SUCCEEDED</code> or
31
+ * <code>FAILED</code>).</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { IoTSiteWiseClient, DescribeSearchCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
36
+ * // const { IoTSiteWiseClient, DescribeSearchCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
37
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
38
+ * const config = {}; // type is IoTSiteWiseClientConfig
39
+ * const client = new IoTSiteWiseClient(config);
40
+ * const input = { // DescribeSearchRequest
41
+ * workspaceName: "STRING_VALUE", // required
42
+ * searchId: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new DescribeSearchCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // DescribeSearchResponse
47
+ * // searchId: "STRING_VALUE", // required
48
+ * // workspaceName: "STRING_VALUE", // required
49
+ * // status: "QUEUED" || "RUNNING" || "SUCCEEDED" || "FAILED", // required
50
+ * // queryStatement: "STRING_VALUE", // required
51
+ * // searchType: "DEEP" || "QUICK", // required
52
+ * // statusReason: "STRING_VALUE",
53
+ * // startedAt: new Date("TIMESTAMP"),
54
+ * // groupId: "STRING_VALUE",
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param DescribeSearchCommandInput - {@link DescribeSearchCommandInput}
60
+ * @returns {@link DescribeSearchCommandOutput}
61
+ * @see {@link DescribeSearchCommandInput} for command's `input` shape.
62
+ * @see {@link DescribeSearchCommandOutput} for command's `response` shape.
63
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
64
+ *
65
+ * @throws {@link AccessDeniedException} (client fault)
66
+ * <p>Access is denied.</p>
67
+ *
68
+ * @throws {@link InternalFailureException} (server fault)
69
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
70
+ *
71
+ * @throws {@link InvalidRequestException} (client fault)
72
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
73
+ * unsupported characters. Check your request and try again.</p>
74
+ *
75
+ * @throws {@link ResourceNotFoundException} (client fault)
76
+ * <p>The requested resource can't be found.</p>
77
+ *
78
+ * @throws {@link ThrottlingException} (client fault)
79
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
80
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
81
+ * on.</p>
82
+ * <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>
83
+ *
84
+ * @throws {@link IoTSiteWiseServiceException}
85
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class DescribeSearchCommand extends DescribeSearchCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: DescribeSearchRequest;
95
+ output: DescribeSearchResponse;
96
+ };
97
+ sdk: {
98
+ input: DescribeSearchCommandInput;
99
+ output: DescribeSearchCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { DescribeStorageConfigurationRequest, DescribeStorageConfigurationResponse } from "../models/models_0";
2
+ import type { DescribeStorageConfigurationRequest, DescribeStorageConfigurationResponse } from "../models/models_1";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -0,0 +1,120 @@
1
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
+ import type { DescribeTaskRequest, DescribeTaskResponse } from "../models/models_1";
3
+ /**
4
+ * @public
5
+ */
6
+ export type { __MetadataBearer };
7
+ /**
8
+ * @public
9
+ *
10
+ * The input for {@link DescribeTaskCommand}.
11
+ */
12
+ export interface DescribeTaskCommandInput extends DescribeTaskRequest {
13
+ }
14
+ /**
15
+ * @public
16
+ *
17
+ * The output of {@link DescribeTaskCommand}.
18
+ */
19
+ export interface DescribeTaskCommandOutput extends DescribeTaskResponse, __MetadataBearer {
20
+ }
21
+ declare const DescribeTaskCommand_base: {
22
+ new (input: DescribeTaskCommandInput): import("@smithy/core/client").CommandImpl<DescribeTaskCommandInput, DescribeTaskCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
23
+ new (input: DescribeTaskCommandInput): import("@smithy/core/client").CommandImpl<DescribeTaskCommandInput, DescribeTaskCommandOutput, import("..").IoTSiteWiseClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
24
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
25
+ };
26
+ /**
27
+ * <p>Retrieves detailed information about a specific task in a workspace.</p>
28
+ * @example
29
+ * Use a bare-bones client and the command you need to make an API call.
30
+ * ```javascript
31
+ * import { IoTSiteWiseClient, DescribeTaskCommand } from "@aws-sdk/client-iotsitewise"; // ES Modules import
32
+ * // const { IoTSiteWiseClient, DescribeTaskCommand } = require("@aws-sdk/client-iotsitewise"); // CommonJS import
33
+ * // import type { IoTSiteWiseClientConfig } from "@aws-sdk/client-iotsitewise";
34
+ * const config = {}; // type is IoTSiteWiseClientConfig
35
+ * const client = new IoTSiteWiseClient(config);
36
+ * const input = { // DescribeTaskRequest
37
+ * workspaceName: "STRING_VALUE", // required
38
+ * taskName: "STRING_VALUE", // required
39
+ * taskVersion: "STRING_VALUE",
40
+ * };
41
+ * const command = new DescribeTaskCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // DescribeTaskResponse
44
+ * // workspaceName: "STRING_VALUE", // required
45
+ * // taskName: "STRING_VALUE", // required
46
+ * // description: "STRING_VALUE",
47
+ * // taskArn: "STRING_VALUE", // required
48
+ * // version: "STRING_VALUE", // required
49
+ * // taskConfiguration: { // TaskConfiguration Union: only one key present
50
+ * // containerTaskConfiguration: { // ContainerTaskConfiguration
51
+ * // ecrUri: "STRING_VALUE", // required
52
+ * // taskExecutionRole: "STRING_VALUE", // required
53
+ * // processingType: "GENERIC_COMPUTE_PROCESSING" || "HARDWARE_ACCELERATED_PROCESSING", // required
54
+ * // processingUnit: "UNITS_2" || "UNITS_4" || "UNITS_8" || "UNITS_12" || "UNITS_16" || "UNITS_24" || "UNITS_32" || "UNITS_36" || "UNITS_48" || "UNITS_60" || "UNITS_64" || "UNITS_72" || "UNITS_84" || "UNITS_96", // required
55
+ * // command: [ // CommandList
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // timeoutSeconds: Number("long"),
59
+ * // environmentVariables: { // EnvironmentVariablesMap
60
+ * // "<keys>": "STRING_VALUE",
61
+ * // },
62
+ * // },
63
+ * // },
64
+ * // status: { // ResourceStatus
65
+ * // error: { // ResourceError
66
+ * // code: "VALIDATION_ERROR" || "INTERNAL_FAILURE",
67
+ * // message: "STRING_VALUE",
68
+ * // },
69
+ * // state: "CREATING" || "ACTIVE" || "UPDATING" || "DELETING" || "FAILED",
70
+ * // },
71
+ * // createdAt: new Date("TIMESTAMP"), // required
72
+ * // updatedAt: new Date("TIMESTAMP"), // required
73
+ * // };
74
+ *
75
+ * ```
76
+ *
77
+ * @param DescribeTaskCommandInput - {@link DescribeTaskCommandInput}
78
+ * @returns {@link DescribeTaskCommandOutput}
79
+ * @see {@link DescribeTaskCommandInput} for command's `input` shape.
80
+ * @see {@link DescribeTaskCommandOutput} for command's `response` shape.
81
+ * @see {@link IoTSiteWiseClientResolvedConfig | config} for IoTSiteWiseClient's `config` shape.
82
+ *
83
+ * @throws {@link AccessDeniedException} (client fault)
84
+ * <p>Access is denied.</p>
85
+ *
86
+ * @throws {@link InternalFailureException} (server fault)
87
+ * <p>IoT SiteWise can't process your request right now. Try again later.</p>
88
+ *
89
+ * @throws {@link InvalidRequestException} (client fault)
90
+ * <p>The request isn't valid. This can occur if your request contains malformed JSON or
91
+ * unsupported characters. Check your request and try again.</p>
92
+ *
93
+ * @throws {@link ResourceNotFoundException} (client fault)
94
+ * <p>The requested resource can't be found.</p>
95
+ *
96
+ * @throws {@link ThrottlingException} (client fault)
97
+ * <p>Your request exceeded a rate limit. For example, you might have exceeded the number of
98
+ * IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so
99
+ * on.</p>
100
+ * <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>
101
+ *
102
+ * @throws {@link IoTSiteWiseServiceException}
103
+ * <p>Base exception class for all service exceptions from IoTSiteWise service.</p>
104
+ *
105
+ *
106
+ * @public
107
+ */
108
+ export declare class DescribeTaskCommand extends DescribeTaskCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: DescribeTaskRequest;
113
+ output: DescribeTaskResponse;
114
+ };
115
+ sdk: {
116
+ input: DescribeTaskCommandInput;
117
+ output: DescribeTaskCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -1,5 +1,5 @@
1
1
  import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
2
- import type { DescribeTimeSeriesRequest, DescribeTimeSeriesResponse } from "../models/models_0";
2
+ import type { DescribeTimeSeriesRequest, DescribeTimeSeriesResponse } from "../models/models_1";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -56,6 +56,7 @@ declare const DescribeTimeSeriesCommand_base: {
56
56
  * alias: "STRING_VALUE",
57
57
  * assetId: "STRING_VALUE",
58
58
  * propertyId: "STRING_VALUE",
59
+ * workspaceName: "STRING_VALUE",
59
60
  * };
60
61
  * const command = new DescribeTimeSeriesCommand(input);
61
62
  * const response = await client.send(command);
@@ -64,11 +65,12 @@ declare const DescribeTimeSeriesCommand_base: {
64
65
  * // propertyId: "STRING_VALUE",
65
66
  * // alias: "STRING_VALUE",
66
67
  * // timeSeriesId: "STRING_VALUE", // required
67
- * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT", // required
68
+ * // dataType: "STRING" || "INTEGER" || "DOUBLE" || "BOOLEAN" || "STRUCT" || "VIDEO" || "ANNOTATION" || "JSON", // required
68
69
  * // dataTypeSpec: "STRING_VALUE",
69
70
  * // timeSeriesCreationDate: new Date("TIMESTAMP"), // required
70
71
  * // timeSeriesLastUpdateDate: new Date("TIMESTAMP"), // required
71
72
  * // timeSeriesArn: "STRING_VALUE", // required
73
+ * // workspaceName: "STRING_VALUE",
72
74
  * // };
73
75
  *
74
76
  * ```