iotsitewise.d.ts
125 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IoTSiteWise extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IoTSiteWise.Types.ClientConfiguration)
config: Config & IoTSiteWise.Types.ClientConfiguration;
/**
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.
*/
associateAssets(params: IoTSiteWise.Types.AssociateAssetsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the AWS IoT SiteWise User Guide.
*/
associateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
*/
batchAssociateProjectAssets(params: IoTSiteWise.Types.BatchAssociateProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchAssociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchAssociateProjectAssetsResponse, AWSError>;
/**
* Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
*/
batchAssociateProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchAssociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchAssociateProjectAssetsResponse, AWSError>;
/**
* Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
*/
batchDisassociateProjectAssets(params: IoTSiteWise.Types.BatchDisassociateProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse, AWSError>;
/**
* Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
*/
batchDisassociateProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse, AWSError>;
/**
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error. For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
*/
batchPutAssetPropertyValue(params: IoTSiteWise.Types.BatchPutAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>;
/**
* Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error. For each asset property, AWS IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. AWS IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the AWS IoT SiteWise User Guide.
*/
batchPutAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>;
/**
* Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
*/
createAccessPolicy(params: IoTSiteWise.Types.CreateAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.CreateAccessPolicyResponse, AWSError>;
/**
* Creates an access policy that grants the specified identity (AWS SSO user, AWS SSO group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
*/
createAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.CreateAccessPolicyResponse, AWSError>;
/**
* Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
*/
createAsset(params: IoTSiteWise.Types.CreateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>;
/**
* Creates an asset from an existing asset model. For more information, see Creating assets in the AWS IoT SiteWise User Guide.
*/
createAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>;
/**
* Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide.
*/
createAssetModel(params: IoTSiteWise.Types.CreateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
/**
* Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the AWS IoT SiteWise User Guide.
*/
createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>;
/**
* Creates a dashboard in an AWS IoT SiteWise Monitor project.
*/
createDashboard(params: IoTSiteWise.Types.CreateDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateDashboardResponse) => void): Request<IoTSiteWise.Types.CreateDashboardResponse, AWSError>;
/**
* Creates a dashboard in an AWS IoT SiteWise Monitor project.
*/
createDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateDashboardResponse) => void): Request<IoTSiteWise.Types.CreateDashboardResponse, AWSError>;
/**
* Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
*/
createGateway(params: IoTSiteWise.Types.CreateGatewayRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateGatewayResponse) => void): Request<IoTSiteWise.Types.CreateGatewayResponse, AWSError>;
/**
* Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
*/
createGateway(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateGatewayResponse) => void): Request<IoTSiteWise.Types.CreateGatewayResponse, AWSError>;
/**
* Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.
*/
createPortal(params: IoTSiteWise.Types.CreatePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>;
/**
* Creates a portal, which can contain projects and dashboards. AWS IoT SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the AWS IoT SiteWise User Guide.
*/
createPortal(callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>;
/**
* Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains a session token that lets the IAM user access the portal.
*/
createPresignedPortalUrl(params: IoTSiteWise.Types.CreatePresignedPortalUrlRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePresignedPortalUrlResponse) => void): Request<IoTSiteWise.Types.CreatePresignedPortalUrlResponse, AWSError>;
/**
* Creates a pre-signed URL to a portal. Use this operation to create URLs to portals that use AWS Identity and Access Management (IAM) to authenticate users. An IAM user with access to a portal can call this API to get a URL to that portal. The URL contains a session token that lets the IAM user access the portal.
*/
createPresignedPortalUrl(callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePresignedPortalUrlResponse) => void): Request<IoTSiteWise.Types.CreatePresignedPortalUrlResponse, AWSError>;
/**
* Creates a project in the specified portal.
*/
createProject(params: IoTSiteWise.Types.CreateProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateProjectResponse) => void): Request<IoTSiteWise.Types.CreateProjectResponse, AWSError>;
/**
* Creates a project in the specified portal.
*/
createProject(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateProjectResponse) => void): Request<IoTSiteWise.Types.CreateProjectResponse, AWSError>;
/**
* Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
*/
deleteAccessPolicy(params: IoTSiteWise.Types.DeleteAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>;
/**
* Deletes an access policy that grants the specified identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
*/
deleteAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>;
/**
* Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
*/
deleteAsset(params: IoTSiteWise.Types.DeleteAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
/**
* Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
*/
deleteAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>;
/**
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
*/
deleteAssetModel(params: IoTSiteWise.Types.DeleteAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>;
/**
* Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the AWS IoT SiteWise User Guide.
*/
deleteAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>;
/**
* Deletes a dashboard from AWS IoT SiteWise Monitor.
*/
deleteDashboard(params: IoTSiteWise.Types.DeleteDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteDashboardResponse) => void): Request<IoTSiteWise.Types.DeleteDashboardResponse, AWSError>;
/**
* Deletes a dashboard from AWS IoT SiteWise Monitor.
*/
deleteDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteDashboardResponse) => void): Request<IoTSiteWise.Types.DeleteDashboardResponse, AWSError>;
/**
* Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
*/
deleteGateway(params: IoTSiteWise.Types.DeleteGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
*/
deleteGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a portal from AWS IoT SiteWise Monitor.
*/
deletePortal(params: IoTSiteWise.Types.DeletePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeletePortalResponse) => void): Request<IoTSiteWise.Types.DeletePortalResponse, AWSError>;
/**
* Deletes a portal from AWS IoT SiteWise Monitor.
*/
deletePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.DeletePortalResponse) => void): Request<IoTSiteWise.Types.DeletePortalResponse, AWSError>;
/**
* Deletes a project from AWS IoT SiteWise Monitor.
*/
deleteProject(params: IoTSiteWise.Types.DeleteProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteProjectResponse) => void): Request<IoTSiteWise.Types.DeleteProjectResponse, AWSError>;
/**
* Deletes a project from AWS IoT SiteWise Monitor.
*/
deleteProject(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteProjectResponse) => void): Request<IoTSiteWise.Types.DeleteProjectResponse, AWSError>;
/**
* Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
*/
describeAccessPolicy(params: IoTSiteWise.Types.DescribeAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DescribeAccessPolicyResponse, AWSError>;
/**
* Describes an access policy, which specifies an identity's access to an AWS IoT SiteWise Monitor portal or project.
*/
describeAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DescribeAccessPolicyResponse, AWSError>;
/**
* Retrieves information about an asset.
*/
describeAsset(params: IoTSiteWise.Types.DescribeAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Retrieves information about an asset.
*/
describeAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Retrieves information about an asset model.
*/
describeAssetModel(params: IoTSiteWise.Types.DescribeAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Retrieves information about an asset model.
*/
describeAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
*/
describeAssetProperty(params: IoTSiteWise.Types.DescribeAssetPropertyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
/**
* Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue.
*/
describeAssetProperty(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>;
/**
* Retrieves information about a dashboard.
*/
describeDashboard(params: IoTSiteWise.Types.DescribeDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDashboardResponse) => void): Request<IoTSiteWise.Types.DescribeDashboardResponse, AWSError>;
/**
* Retrieves information about a dashboard.
*/
describeDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDashboardResponse) => void): Request<IoTSiteWise.Types.DescribeDashboardResponse, AWSError>;
/**
* Retrieves information about a gateway.
*/
describeGateway(params: IoTSiteWise.Types.DescribeGatewayRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayResponse, AWSError>;
/**
* Retrieves information about a gateway.
*/
describeGateway(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayResponse, AWSError>;
/**
* Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
*/
describeGatewayCapabilityConfiguration(params: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse, AWSError>;
/**
* Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
*/
describeGatewayCapabilityConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse, AWSError>;
/**
* Retrieves the current AWS IoT SiteWise logging options.
*/
describeLoggingOptions(params: IoTSiteWise.Types.DescribeLoggingOptionsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.DescribeLoggingOptionsResponse, AWSError>;
/**
* Retrieves the current AWS IoT SiteWise logging options.
*/
describeLoggingOptions(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.DescribeLoggingOptionsResponse, AWSError>;
/**
* Retrieves information about a portal.
*/
describePortal(params: IoTSiteWise.Types.DescribePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
/**
* Retrieves information about a portal.
*/
describePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
/**
* Retrieves information about a project.
*/
describeProject(params: IoTSiteWise.Types.DescribeProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeProjectResponse) => void): Request<IoTSiteWise.Types.DescribeProjectResponse, AWSError>;
/**
* Retrieves information about a project.
*/
describeProject(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeProjectResponse) => void): Request<IoTSiteWise.Types.DescribeProjectResponse, AWSError>;
/**
* Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
*/
disassociateAssets(params: IoTSiteWise.Types.DisassociateAssetsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
*/
disassociateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyAggregates(params: IoTSiteWise.Types.GetAssetPropertyAggregatesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>;
/**
* Gets aggregated values for an asset property. For more information, see Querying aggregates in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyAggregates(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>;
/**
* Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyValue(params: IoTSiteWise.Types.GetAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>;
/**
* Gets an asset property's current value. For more information, see Querying current values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>;
/**
* Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyValueHistory(params: IoTSiteWise.Types.GetAssetPropertyValueHistoryRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>;
/**
* Gets the history of an asset property's values. For more information, see Querying historical values in the AWS IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
*/
getAssetPropertyValueHistory(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>;
/**
* Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
*/
listAccessPolicies(params: IoTSiteWise.Types.ListAccessPoliciesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAccessPoliciesResponse) => void): Request<IoTSiteWise.Types.ListAccessPoliciesResponse, AWSError>;
/**
* Retrieves a paginated list of access policies for an identity (an AWS SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise Monitor resource (a portal or project).
*/
listAccessPolicies(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAccessPoliciesResponse) => void): Request<IoTSiteWise.Types.ListAccessPoliciesResponse, AWSError>;
/**
* Retrieves a paginated list of summaries of all asset models.
*/
listAssetModels(params: IoTSiteWise.Types.ListAssetModelsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelsResponse, AWSError>;
/**
* Retrieves a paginated list of summaries of all asset models.
*/
listAssetModels(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelsResponse, AWSError>;
/**
* Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
*/
listAssets(params: IoTSiteWise.Types.ListAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model.
*/
listAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
*/
listAssociatedAssets(params: IoTSiteWise.Types.ListAssociatedAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of associated assets. You can use this operation to do the following: List child assets associated to a parent asset by a hierarchy that you specify. List an asset's parent asset.
*/
listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
*/
listDashboards(params: IoTSiteWise.Types.ListDashboardsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListDashboardsResponse) => void): Request<IoTSiteWise.Types.ListDashboardsResponse, AWSError>;
/**
* Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
*/
listDashboards(callback?: (err: AWSError, data: IoTSiteWise.Types.ListDashboardsResponse) => void): Request<IoTSiteWise.Types.ListDashboardsResponse, AWSError>;
/**
* Retrieves a paginated list of gateways.
*/
listGateways(params: IoTSiteWise.Types.ListGatewaysRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListGatewaysResponse) => void): Request<IoTSiteWise.Types.ListGatewaysResponse, AWSError>;
/**
* Retrieves a paginated list of gateways.
*/
listGateways(callback?: (err: AWSError, data: IoTSiteWise.Types.ListGatewaysResponse) => void): Request<IoTSiteWise.Types.ListGatewaysResponse, AWSError>;
/**
* Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
*/
listPortals(params: IoTSiteWise.Types.ListPortalsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListPortalsResponse) => void): Request<IoTSiteWise.Types.ListPortalsResponse, AWSError>;
/**
* Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
*/
listPortals(callback?: (err: AWSError, data: IoTSiteWise.Types.ListPortalsResponse) => void): Request<IoTSiteWise.Types.ListPortalsResponse, AWSError>;
/**
* Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
*/
listProjectAssets(params: IoTSiteWise.Types.ListProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectAssetsResponse) => void): Request<IoTSiteWise.Types.ListProjectAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
*/
listProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectAssetsResponse) => void): Request<IoTSiteWise.Types.ListProjectAssetsResponse, AWSError>;
/**
* Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
*/
listProjects(params: IoTSiteWise.Types.ListProjectsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectsResponse) => void): Request<IoTSiteWise.Types.ListProjectsResponse, AWSError>;
/**
* Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
*/
listProjects(callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectsResponse) => void): Request<IoTSiteWise.Types.ListProjectsResponse, AWSError>;
/**
* Retrieves the list of tags for an AWS IoT SiteWise resource.
*/
listTagsForResource(params: IoTSiteWise.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListTagsForResourceResponse) => void): Request<IoTSiteWise.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the list of tags for an AWS IoT SiteWise resource.
*/
listTagsForResource(callback?: (err: AWSError, data: IoTSiteWise.Types.ListTagsForResourceResponse) => void): Request<IoTSiteWise.Types.ListTagsForResourceResponse, AWSError>;
/**
* Sets logging options for AWS IoT SiteWise.
*/
putLoggingOptions(params: IoTSiteWise.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.PutLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.PutLoggingOptionsResponse, AWSError>;
/**
* Sets logging options for AWS IoT SiteWise.
*/
putLoggingOptions(callback?: (err: AWSError, data: IoTSiteWise.Types.PutLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.PutLoggingOptionsResponse, AWSError>;
/**
* Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
*/
tagResource(params: IoTSiteWise.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.TagResourceResponse) => void): Request<IoTSiteWise.Types.TagResourceResponse, AWSError>;
/**
* Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
*/
tagResource(callback?: (err: AWSError, data: IoTSiteWise.Types.TagResourceResponse) => void): Request<IoTSiteWise.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag from an AWS IoT SiteWise resource.
*/
untagResource(params: IoTSiteWise.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UntagResourceResponse) => void): Request<IoTSiteWise.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag from an AWS IoT SiteWise resource.
*/
untagResource(callback?: (err: AWSError, data: IoTSiteWise.Types.UntagResourceResponse) => void): Request<IoTSiteWise.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.
*/
updateAccessPolicy(params: IoTSiteWise.Types.UpdateAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.UpdateAccessPolicyResponse, AWSError>;
/**
* Updates an existing access policy that specifies an identity's access to an AWS IoT SiteWise Monitor portal or project resource.
*/
updateAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.UpdateAccessPolicyResponse, AWSError>;
/**
* Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
*/
updateAsset(params: IoTSiteWise.Types.UpdateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>;
/**
* Updates an asset's name. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide.
*/
updateAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>;
/**
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
*/
updateAssetModel(params: IoTSiteWise.Types.UpdateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
/**
* Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the AWS IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
*/
updateAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>;
/**
* Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
*/
updateAssetProperty(params: IoTSiteWise.Types.UpdateAssetPropertyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.
*/
updateAssetProperty(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor dashboard.
*/
updateDashboard(params: IoTSiteWise.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateDashboardResponse) => void): Request<IoTSiteWise.Types.UpdateDashboardResponse, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor dashboard.
*/
updateDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateDashboardResponse) => void): Request<IoTSiteWise.Types.UpdateDashboardResponse, AWSError>;
/**
* Updates a gateway's name.
*/
updateGateway(params: IoTSiteWise.Types.UpdateGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a gateway's name.
*/
updateGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
*/
updateGatewayCapabilityConfiguration(params: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse, AWSError>;
/**
* Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the AWS IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway.
*/
updateGatewayCapabilityConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor portal.
*/
updatePortal(params: IoTSiteWise.Types.UpdatePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdatePortalResponse) => void): Request<IoTSiteWise.Types.UpdatePortalResponse, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor portal.
*/
updatePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdatePortalResponse) => void): Request<IoTSiteWise.Types.UpdatePortalResponse, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor project.
*/
updateProject(params: IoTSiteWise.Types.UpdateProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateProjectResponse) => void): Request<IoTSiteWise.Types.UpdateProjectResponse, AWSError>;
/**
* Updates an AWS IoT SiteWise Monitor project.
*/
updateProject(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateProjectResponse) => void): Request<IoTSiteWise.Types.UpdateProjectResponse, AWSError>;
/**
* Waits for the assetModelNotExists state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetModelNotExists", params: IoTSiteWise.Types.DescribeAssetModelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Waits for the assetModelNotExists state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetModelNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Waits for the assetModelActive state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetModelActive", params: IoTSiteWise.Types.DescribeAssetModelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Waits for the assetModelActive state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetModelActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>;
/**
* Waits for the assetNotExists state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetNotExists", params: IoTSiteWise.Types.DescribeAssetRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Waits for the assetNotExists state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Waits for the assetActive state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetActive", params: IoTSiteWise.Types.DescribeAssetRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Waits for the assetActive state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times).
*/
waitFor(state: "assetActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>;
/**
* Waits for the portalNotExists state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "portalNotExists", params: IoTSiteWise.Types.DescribePortalRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
/**
* Waits for the portalNotExists state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "portalNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
/**
* Waits for the portalActive state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "portalActive", params: IoTSiteWise.Types.DescribePortalRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
/**
* Waits for the portalActive state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times).
*/
waitFor(state: "portalActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>;
}
declare namespace IoTSiteWise {
export type ARN = string;
export type AccessPolicySummaries = AccessPolicySummary[];
export interface AccessPolicySummary {
/**
* The ID of the access policy.
*/
id: ID;
/**
* The identity (an AWS SSO user, an AWS SSO group, or an IAM user).
*/
identity: Identity;
/**
* The AWS IoT SiteWise Monitor resource (a portal or project).
*/
resource: Resource;
/**
* The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner.
*/
permission: Permission;
/**
* The date the access policy was created, in Unix epoch time.
*/
creationDate?: Timestamp;
/**
* The date the access policy was last updated, in Unix epoch time.
*/
lastUpdateDate?: Timestamp;
}
export type AggregateType = "AVERAGE"|"COUNT"|"MAXIMUM"|"MINIMUM"|"SUM"|"STANDARD_DEVIATION"|string;
export type AggregateTypes = AggregateType[];
export type AggregatedDoubleValue = number;
export interface AggregatedValue {
/**
* The date the aggregating computations occurred, in Unix epoch time.
*/
timestamp: Timestamp;
/**
* The quality of the aggregated data.
*/
quality?: Quality;
/**
* The value of the aggregates.
*/
value: Aggregates;
}
export type AggregatedValues = AggregatedValue[];
export interface Aggregates {
/**
* The average (mean) value of the time series over a time interval window.
*/
average?: AggregatedDoubleValue;
/**
* The count of data points in the time series over a time interval window.
*/
count?: AggregatedDoubleValue;
/**
* The maximum value of the time series over a time interval window.
*/
maximum?: AggregatedDoubleValue;
/**
* The minimum value of the time series over a time interval window.
*/
minimum?: AggregatedDoubleValue;
/**
* The sum of the time series over a time interval window.
*/
sum?: AggregatedDoubleValue;
/**
* The standard deviation of the time series over a time interval window.
*/
standardDeviation?: AggregatedDoubleValue;
}
export type AmazonResourceName = string;
export type AssetErrorCode = "INTERNAL_FAILURE"|string;
export interface AssetErrorDetails {
/**
* The ID of the asset.
*/
assetId: ID;
/**
* The error code.
*/
code: AssetErrorCode;
/**
* The error message.
*/
message: AssetErrorMessage;
}
export type AssetErrorMessage = string;
export type AssetHierarchies = AssetHierarchy[];
export interface AssetHierarchy {
/**
* The ID of the hierarchy. This ID is a hierarchyId.
*/
id?: ID;
/**
* The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.
*/
name: Name;
}
export type AssetIDs = ID[];
export type AssetModelHierarchies = AssetModelHierarchy[];
export interface AssetModelHierarchy {
/**
* The ID of the asset model hierarchy. This ID is a hierarchyId.
*/
id?: ID;
/**
* The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.
*/
name: Name;
/**
* The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model.
*/
childAssetModelId: ID;
}
export interface AssetModelHierarchyDefinition {
/**
* The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation).
*/
name: Name;
/**
* The ID of an asset model for this hierarchy.
*/
childAssetModelId: ID;
}
export type AssetModelHierarchyDefinitions = AssetModelHierarchyDefinition[];
export type AssetModelProperties = AssetModelProperty[];
export interface AssetModelProperty {
/**
* The ID of the asset model property.
*/
id?: ID;
/**
* The name of the asset model property.
*/
name: Name;
/**
* The data type of the asset model property.
*/
dataType: PropertyDataType;
/**
* The unit of the asset model property, such as Newtons or RPM.
*/
unit?: PropertyUnit;
/**
* The property type (see PropertyType).
*/
type: PropertyType;
}
export interface AssetModelPropertyDefinition {
/**
* The name of the property definition.
*/
name: Name;
/**
* The data type of the property definition.
*/
dataType: PropertyDataType;
/**
* The unit of the property definition, such as Newtons or RPM.
*/
unit?: PropertyUnit;
/**
* The property definition type (see PropertyType). You can only specify one type in a property definition.
*/
type: PropertyType;
}
export type AssetModelPropertyDefinitions = AssetModelPropertyDefinition[];
export type AssetModelState = "CREATING"|"ACTIVE"|"UPDATING"|"PROPAGATING"|"DELETING"|"FAILED"|string;
export interface AssetModelStatus {
/**
* The current state of the asset model.
*/
state: AssetModelState;
/**
* Contains associated error information, if any.
*/
error?: ErrorDetails;
}
export type AssetModelSummaries = AssetModelSummary[];
export interface AssetModelSummary {
/**
* The ID of the asset model (used with AWS IoT SiteWise APIs).
*/
id: ID;
/**
* The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
*/
arn: ARN;
/**
* The name of the asset model.
*/
name: Name;
/**
* The asset model description.
*/
description: Description;
/**
* The date the asset model was created, in Unix epoch time.
*/
creationDate: Timestamp;
/**
* The date the asset model was last updated, in Unix epoch time.
*/
lastUpdateDate: Timestamp;
/**
* The current status of the asset model.
*/
status: AssetModelStatus;
}
export type AssetProperties = AssetProperty[];
export interface AssetProperty {
/**
* The ID of the asset property.
*/
id: ID;
/**
* The name of the property.
*/
name: Name;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
alias?: PropertyAlias;
/**
* The asset property's notification topic and state. For more information, see UpdateAssetProperty.
*/
notification?: PropertyNotification;
/**
* The data type of the asset property.
*/
dataType: PropertyDataType;
/**
* The unit (such as Newtons or RPM) of the asset property.
*/
unit?: PropertyUnit;
}
export type AssetPropertyAlias = string;
export interface AssetPropertyValue {
/**
* The value of the asset property (see Variant).
*/
value: Variant;
/**
* The timestamp of the asset property value.
*/
timestamp: TimeInNanos;
/**
* The quality of the asset property value.
*/
quality?: Quality;
}
export type AssetPropertyValueHistory = AssetPropertyValue[];
export type AssetPropertyValues = AssetPropertyValue[];
export type AssetState = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|string;
export interface AssetStatus {
/**
* The current status of the asset.
*/
state: AssetState;
/**
* Contains associated error information, if any.
*/
error?: ErrorDetails;
}
export type AssetSummaries = AssetSummary[];
export interface AssetSummary {
/**
* The ID of the asset.
*/
id: ID;
/**
* The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
*/
arn: ARN;
/**
* The name of the asset.
*/
name: Name;
/**
* The ID of the asset model used to create this asset.
*/
assetModelId: ID;
/**
* The date the asset was created, in Unix epoch time.
*/
creationDate: Timestamp;
/**
* The date the asset was last updated, in Unix epoch time.
*/
lastUpdateDate: Timestamp;
/**
* The current status of the asset.
*/
status: AssetStatus;
/**
* A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
*/
hierarchies: AssetHierarchies;
}
export interface AssociateAssetsRequest {
/**
* The ID of the parent asset.
*/
assetId: ID;
/**
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
*/
hierarchyId: ID;
/**
* The ID of the child asset to be associated.
*/
childAssetId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export type AssociatedAssetsSummaries = AssociatedAssetsSummary[];
export interface AssociatedAssetsSummary {
/**
* The ID of the asset.
*/
id: ID;
/**
* The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
*/
arn: ARN;
/**
* The name of the asset.
*/
name: Name;
/**
* The ID of the asset model used to create the asset.
*/
assetModelId: ID;
/**
* The date the asset was created, in Unix epoch time.
*/
creationDate: Timestamp;
/**
* The date the asset was last updated, in Unix epoch time.
*/
lastUpdateDate: Timestamp;
/**
* The current status of the asset.
*/
status: AssetStatus;
/**
* A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
*/
hierarchies: AssetHierarchies;
}
export interface Attribute {
/**
* The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide.
*/
defaultValue?: DefaultValue;
}
export type AuthMode = "IAM"|"SSO"|string;
export type BatchAssociateProjectAssetsErrors = AssetErrorDetails[];
export interface BatchAssociateProjectAssetsRequest {
/**
* The ID of the project to which to associate the assets.
*/
projectId: ID;
/**
* The IDs of the assets to be associated to the project.
*/
assetIds: IDs;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface BatchAssociateProjectAssetsResponse {
/**
* A list of associated error information, if any.
*/
errors?: BatchAssociateProjectAssetsErrors;
}
export type BatchDisassociateProjectAssetsErrors = AssetErrorDetails[];
export interface BatchDisassociateProjectAssetsRequest {
/**
* The ID of the project from which to disassociate the assets.
*/
projectId: ID;
/**
* The IDs of the assets to be disassociated from the project.
*/
assetIds: IDs;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface BatchDisassociateProjectAssetsResponse {
/**
* A list of associated error information, if any.
*/
errors?: BatchDisassociateProjectAssetsErrors;
}
export interface BatchPutAssetPropertyError {
/**
* The error code.
*/
errorCode: BatchPutAssetPropertyValueErrorCode;
/**
* The associated error message.
*/
errorMessage: ErrorMessage;
/**
* A list of timestamps for each error, if any.
*/
timestamps: Timestamps;
}
export type BatchPutAssetPropertyErrorEntries = BatchPutAssetPropertyErrorEntry[];
export interface BatchPutAssetPropertyErrorEntry {
/**
* The ID of the failed entry.
*/
entryId: EntryId;
/**
* The list of update property value errors.
*/
errors: BatchPutAssetPropertyErrors;
}
export type BatchPutAssetPropertyErrors = BatchPutAssetPropertyError[];
export type BatchPutAssetPropertyValueErrorCode = "ResourceNotFoundException"|"InvalidRequestException"|"InternalFailureException"|"ServiceUnavailableException"|"ThrottlingException"|"LimitExceededException"|"ConflictingOperationException"|"TimestampOutOfRangeException"|"AccessDeniedException"|string;
export interface BatchPutAssetPropertyValueRequest {
/**
* The list of asset property value entries for the batch put request. You can specify up to 10 entries per request.
*/
entries: PutAssetPropertyValueEntries;
}
export interface BatchPutAssetPropertyValueResponse {
/**
* A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed.
*/
errorEntries: BatchPutAssetPropertyErrorEntries;
}
export type CapabilityConfiguration = string;
export type CapabilityNamespace = string;
export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|string;
export type ClientToken = string;
export interface CreateAccessPolicyRequest {
/**
* The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.
*/
accessPolicyIdentity: Identity;
/**
* The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*/
accessPolicyResource: Resource;
/**
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
*/
accessPolicyPermission: Permission;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateAccessPolicyResponse {
/**
* The ID of the access policy.
*/
accessPolicyId: ID;
/**
* The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
*/
accessPolicyArn: ARN;
}
export interface CreateAssetModelRequest {
/**
* A unique, friendly name for the asset model.
*/
assetModelName: Name;
/**
* A description for the asset model.
*/
assetModelDescription?: Description;
/**
* The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
assetModelProperties?: AssetModelPropertyDefinitions;
/**
* The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
assetModelHierarchies?: AssetModelHierarchyDefinitions;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A list of key-value pairs that contain metadata for the asset model. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateAssetModelResponse {
/**
* The ID of the asset model. You can use this ID when you call other AWS IoT SiteWise APIs.
*/
assetModelId: ID;
/**
* The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
*/
assetModelArn: ARN;
/**
* The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message.
*/
assetModelStatus: AssetModelStatus;
}
export interface CreateAssetRequest {
/**
* A unique, friendly name for the asset.
*/
assetName: Name;
/**
* The ID of the asset model from which to create the asset.
*/
assetModelId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateAssetResponse {
/**
* The ID of the asset. This ID uniquely identifies the asset within AWS IoT SiteWise and can be used with other AWS IoT SiteWise APIs.
*/
assetId: ID;
/**
* The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
*/
assetArn: ARN;
/**
* The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message.
*/
assetStatus: AssetStatus;
}
export interface CreateDashboardRequest {
/**
* The ID of the project in which to create the dashboard.
*/
projectId: ID;
/**
* A friendly name for the dashboard.
*/
dashboardName: Name;
/**
* A description for the dashboard.
*/
dashboardDescription?: Description;
/**
* The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
*/
dashboardDefinition: DashboardDefinition;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateDashboardResponse {
/**
* The ID of the dashboard.
*/
dashboardId: ID;
/**
* The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
*/
dashboardArn: ARN;
}
export interface CreateGatewayRequest {
/**
* A unique, friendly name for the gateway.
*/
gatewayName: Name;
/**
* The gateway's platform. You can only specify one platform in a gateway.
*/
gatewayPlatform: GatewayPlatform;
/**
* A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateGatewayResponse {
/**
* The ID of the gateway device. You can use this ID when you call other AWS IoT SiteWise APIs.
*/
gatewayId: ID;
/**
* The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
*/
gatewayArn: ARN;
}
export interface CreatePortalRequest {
/**
* A friendly name for the portal.
*/
portalName: Name;
/**
* A description for the portal.
*/
portalDescription?: Description;
/**
* The AWS administrator's contact email address.
*/
portalContactEmail: Email;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.
*/
portalLogoImageFile?: ImageFile;
/**
* The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
*/
roleArn: ARN;
/**
* A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
/**
* The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions. IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. This option is only available in the China Regions. You can't change this value after you create a portal. Default: SSO
*/
portalAuthMode?: AuthMode;
}
export interface CreatePortalResponse {
/**
* The ID of the created portal.
*/
portalId: ID;
/**
* The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*/
portalArn: ARN;
/**
* The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.
*/
portalStartUrl: Url;
/**
* The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
*/
portalStatus: PortalStatus;
/**
* The associated AWS SSO application ID, if the portal uses AWS SSO.
*/
ssoApplicationId: SSOApplicationId;
}
export interface CreatePresignedPortalUrlRequest {
/**
* The ID of the portal to access.
*/
portalId: ID;
/**
* The duration (in seconds) for which the session at the URL is valid. Default: 900 seconds (15 minutes)
*/
sessionDurationSeconds?: SessionDurationSeconds;
}
export interface CreatePresignedPortalUrlResponse {
/**
* The pre-signed URL to the portal. The URL contains the portal ID and a session token that lets you access the portal. The URL has the following format. https://<portal-id>.app.iotsitewise.aws/auth?token=<encrypted-token>
*/
presignedPortalUrl: Url;
}
export interface CreateProjectRequest {
/**
* The ID of the portal in which to create the project.
*/
portalId: ID;
/**
* A friendly name for the project.
*/
projectName: Name;
/**
* A description for the project.
*/
projectDescription?: Description;
/**
* 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.
*/
clientToken?: ClientToken;
/**
* A list of key-value pairs that contain metadata for the project. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export interface CreateProjectResponse {
/**
* The ID of the project.
*/
projectId: ID;
/**
* The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
*/
projectArn: ARN;
}
export type DashboardDefinition = string;
export type DashboardSummaries = DashboardSummary[];
export interface DashboardSummary {
/**
* The ID of the dashboard.
*/
id: ID;
/**
* The name of the dashboard
*/
name: Name;
/**
* The dashboard's description.
*/
description?: Description;
/**
* The date the dashboard was created, in Unix epoch time.
*/
creationDate?: Timestamp;
/**
* The date the dashboard was last updated, in Unix epoch time.
*/
lastUpdateDate?: Timestamp;
}
export type DefaultValue = string;
export interface DeleteAccessPolicyRequest {
/**
* The ID of the access policy to be deleted.
*/
accessPolicyId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteAccessPolicyResponse {
}
export interface DeleteAssetModelRequest {
/**
* The ID of the asset model to delete.
*/
assetModelId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteAssetModelResponse {
/**
* The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message.
*/
assetModelStatus: AssetModelStatus;
}
export interface DeleteAssetRequest {
/**
* The ID of the asset to delete.
*/
assetId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteAssetResponse {
/**
* The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message.
*/
assetStatus: AssetStatus;
}
export interface DeleteDashboardRequest {
/**
* The ID of the dashboard to delete.
*/
dashboardId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteDashboardResponse {
}
export interface DeleteGatewayRequest {
/**
* The ID of the gateway to delete.
*/
gatewayId: ID;
}
export interface DeletePortalRequest {
/**
* The ID of the portal to delete.
*/
portalId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeletePortalResponse {
/**
* The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message.
*/
portalStatus: PortalStatus;
}
export interface DeleteProjectRequest {
/**
* The ID of the project.
*/
projectId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface DeleteProjectResponse {
}
export interface DescribeAccessPolicyRequest {
/**
* The ID of the access policy.
*/
accessPolicyId: ID;
}
export interface DescribeAccessPolicyResponse {
/**
* The ID of the access policy.
*/
accessPolicyId: ID;
/**
* The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}
*/
accessPolicyArn: ARN;
/**
* The identity (AWS SSO user, AWS SSO group, or IAM user) to which this access policy applies.
*/
accessPolicyIdentity: Identity;
/**
* The AWS IoT SiteWise Monitor resource (portal or project) to which this access policy provides access.
*/
accessPolicyResource: Resource;
/**
* The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner.
*/
accessPolicyPermission: Permission;
/**
* The date the access policy was created, in Unix epoch time.
*/
accessPolicyCreationDate: Timestamp;
/**
* The date the access policy was last updated, in Unix epoch time.
*/
accessPolicyLastUpdateDate: Timestamp;
}
export interface DescribeAssetModelRequest {
/**
* The ID of the asset model.
*/
assetModelId: ID;
}
export interface DescribeAssetModelResponse {
/**
* The ID of the asset model.
*/
assetModelId: ID;
/**
* The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
*/
assetModelArn: ARN;
/**
* The name of the asset model.
*/
assetModelName: Name;
/**
* The asset model's description.
*/
assetModelDescription: Description;
/**
* The list of asset properties for the asset model.
*/
assetModelProperties: AssetModelProperties;
/**
* A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model.
*/
assetModelHierarchies: AssetModelHierarchies;
/**
* The date the asset model was created, in Unix epoch time.
*/
assetModelCreationDate: Timestamp;
/**
* The date the asset model was last updated, in Unix epoch time.
*/
assetModelLastUpdateDate: Timestamp;
/**
* The current status of the asset model, which contains a state and any error message.
*/
assetModelStatus: AssetModelStatus;
}
export interface DescribeAssetPropertyRequest {
/**
* The ID of the asset.
*/
assetId: ID;
/**
* The ID of the asset property.
*/
propertyId: ID;
}
export interface DescribeAssetPropertyResponse {
/**
* The ID of the asset.
*/
assetId: ID;
/**
* The name of the asset.
*/
assetName: Name;
/**
* The ID of the asset model.
*/
assetModelId: ID;
/**
* The asset property's definition, alias, and notification state.
*/
assetProperty: Property;
}
export interface DescribeAssetRequest {
/**
* The ID of the asset.
*/
assetId: ID;
}
export interface DescribeAssetResponse {
/**
* The ID of the asset.
*/
assetId: ID;
/**
* The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
*/
assetArn: ARN;
/**
* The name of the asset.
*/
assetName: Name;
/**
* The ID of the asset model that was used to create the asset.
*/
assetModelId: ID;
/**
* The list of asset properties for the asset.
*/
assetProperties: AssetProperties;
/**
* A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships.
*/
assetHierarchies: AssetHierarchies;
/**
* The date the asset was created, in Unix epoch time.
*/
assetCreationDate: Timestamp;
/**
* The date the asset was last updated, in Unix epoch time.
*/
assetLastUpdateDate: Timestamp;
/**
* The current status of the asset, which contains a state and any error message.
*/
assetStatus: AssetStatus;
}
export interface DescribeDashboardRequest {
/**
* The ID of the dashboard.
*/
dashboardId: ID;
}
export interface DescribeDashboardResponse {
/**
* The ID of the dashboard.
*/
dashboardId: ID;
/**
* The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}
*/
dashboardArn: ARN;
/**
* The name of the dashboard.
*/
dashboardName: Name;
/**
* The ID of the project that the dashboard is in.
*/
projectId: ID;
/**
* The dashboard's description.
*/
dashboardDescription?: Description;
/**
* The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
*/
dashboardDefinition: DashboardDefinition;
/**
* The date the dashboard was created, in Unix epoch time.
*/
dashboardCreationDate: Timestamp;
/**
* The date the dashboard was last updated, in Unix epoch time.
*/
dashboardLastUpdateDate: Timestamp;
}
export interface DescribeGatewayCapabilityConfigurationRequest {
/**
* The ID of the gateway that defines the capability configuration.
*/
gatewayId: ID;
/**
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.
*/
capabilityNamespace: CapabilityNamespace;
}
export interface DescribeGatewayCapabilityConfigurationResponse {
/**
* The ID of the gateway that defines the capability configuration.
*/
gatewayId: ID;
/**
* The namespace of the gateway capability.
*/
capabilityNamespace: CapabilityNamespace;
/**
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
*/
capabilityConfiguration: CapabilityConfiguration;
/**
* The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration.
*/
capabilitySyncStatus: CapabilitySyncStatus;
}
export interface DescribeGatewayRequest {
/**
* The ID of the gateway device.
*/
gatewayId: ID;
}
export interface DescribeGatewayResponse {
/**
* The ID of the gateway device.
*/
gatewayId: ID;
/**
* The name of the gateway.
*/
gatewayName: Name;
/**
* The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}
*/
gatewayArn: ARN;
/**
* The gateway's platform.
*/
gatewayPlatform?: GatewayPlatform;
/**
* A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
*/
gatewayCapabilitySummaries: GatewayCapabilitySummaries;
/**
* The date the gateway was created, in Unix epoch time.
*/
creationDate: Timestamp;
/**
* The date the gateway was last updated, in Unix epoch time.
*/
lastUpdateDate: Timestamp;
}
export interface DescribeLoggingOptionsRequest {
}
export interface DescribeLoggingOptionsResponse {
/**
* The current logging options.
*/
loggingOptions: LoggingOptions;
}
export interface DescribePortalRequest {
/**
* The ID of the portal.
*/
portalId: ID;
}
export interface DescribePortalResponse {
/**
* The ID of the portal.
*/
portalId: ID;
/**
* The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*/
portalArn: ARN;
/**
* The name of the portal.
*/
portalName: Name;
/**
* The portal's description.
*/
portalDescription?: Description;
/**
* The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
*/
portalClientId: PortalClientId;
/**
* The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.
*/
portalStartUrl: Url;
/**
* The AWS administrator's contact email address.
*/
portalContactEmail: Email;
/**
* The current status of the portal, which contains a state and any error message.
*/
portalStatus: PortalStatus;
/**
* The date the portal was created, in Unix epoch time.
*/
portalCreationDate: Timestamp;
/**
* The date the portal was last updated, in Unix epoch time.
*/
portalLastUpdateDate: Timestamp;
/**
* The portal's logo image, which is available at a URL.
*/
portalLogoImageLocation?: ImageLocation;
/**
* The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
*/
roleArn?: ARN;
/**
* The service to use to authenticate users to the portal.
*/
portalAuthMode?: AuthMode;
}
export interface DescribeProjectRequest {
/**
* The ID of the project.
*/
projectId: ID;
}
export interface DescribeProjectResponse {
/**
* The ID of the project.
*/
projectId: ID;
/**
* The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
*/
projectArn: ARN;
/**
* The name of the project.
*/
projectName: Name;
/**
* The ID of the portal that the project is in.
*/
portalId: ID;
/**
* The project's description.
*/
projectDescription?: Description;
/**
* The date the project was created, in Unix epoch time.
*/
projectCreationDate: Timestamp;
/**
* The date the project was last updated, in Unix epoch time.
*/
projectLastUpdateDate: Timestamp;
}
export type Description = string;
export interface DisassociateAssetsRequest {
/**
* The ID of the parent asset from which to disassociate the child asset.
*/
assetId: ID;
/**
* The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
*/
hierarchyId: ID;
/**
* The ID of the child asset to disassociate.
*/
childAssetId: ID;
/**
* 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.
*/
clientToken?: ClientToken;
}
export type Email = string;
export type EntryId = string;
export type ErrorCode = "VALIDATION_ERROR"|"INTERNAL_FAILURE"|string;
export interface ErrorDetails {
/**
* The error code.
*/
code: ErrorCode;
/**
* The error message.
*/
message: ErrorMessage;
}
export type ErrorMessage = string;
export type Expression = string;
export interface ExpressionVariable {
/**
* The friendly name of the variable to be used in the expression.
*/
name: VariableName;
/**
* The variable that identifies an asset property from which to use values.
*/
value: VariableValue;
}
export type ExpressionVariables = ExpressionVariable[];
export type GatewayCapabilitySummaries = GatewayCapabilitySummary[];
export interface GatewayCapabilitySummary {
/**
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.
*/
capabilityNamespace: CapabilityNamespace;
/**
* The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration.
*/
capabilitySyncStatus: CapabilitySyncStatus;
}
export interface GatewayPlatform {
/**
* A gateway that runs on AWS IoT Greengrass.
*/
greengrass: Greengrass;
}
export type GatewaySummaries = GatewaySummary[];
export interface GatewaySummary {
/**
* The ID of the gateway device.
*/
gatewayId: ID;
/**
* The name of the asset.
*/
gatewayName: Name;
/**
* A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
*/
gatewayCapabilitySummaries?: GatewayCapabilitySummaries;
/**
* The date the gateway was created, in Unix epoch time.
*/
creationDate: Timestamp;
/**
* The date the gateway was last updated, in Unix epoch time.
*/
lastUpdateDate: Timestamp;
}
export interface GetAssetPropertyAggregatesRequest {
/**
* The ID of the asset.
*/
assetId?: ID;
/**
* The ID of the asset property.
*/
propertyId?: ID;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
propertyAlias?: AssetPropertyAlias;
/**
* The data aggregating function.
*/
aggregateTypes: AggregateTypes;
/**
* The time interval over which to aggregate data.
*/
resolution: Resolution;
/**
* The quality by which to filter asset data.
*/
qualities?: Qualities;
/**
* The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
startDate: Timestamp;
/**
* The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
endDate: Timestamp;
/**
* The chronological sorting order of the requested information. Default: ASCENDING
*/
timeOrdering?: TimeOrdering;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 100
*/
maxResults?: MaxResults;
}
export interface GetAssetPropertyAggregatesResponse {
/**
* The requested aggregated values.
*/
aggregatedValues: AggregatedValues;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface GetAssetPropertyValueHistoryRequest {
/**
* The ID of the asset.
*/
assetId?: ID;
/**
* The ID of the asset property.
*/
propertyId?: ID;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
propertyAlias?: AssetPropertyAlias;
/**
* The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
startDate?: Timestamp;
/**
* The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
*/
endDate?: Timestamp;
/**
* The quality by which to filter asset data.
*/
qualities?: Qualities;
/**
* The chronological sorting order of the requested information. Default: ASCENDING
*/
timeOrdering?: TimeOrdering;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 100
*/
maxResults?: MaxResults;
}
export interface GetAssetPropertyValueHistoryResponse {
/**
* The asset property's value history.
*/
assetPropertyValueHistory: AssetPropertyValueHistory;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface GetAssetPropertyValueRequest {
/**
* The ID of the asset.
*/
assetId?: ID;
/**
* The ID of the asset property.
*/
propertyId?: ID;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
propertyAlias?: AssetPropertyAlias;
}
export interface GetAssetPropertyValueResponse {
/**
* The current asset property value.
*/
propertyValue?: AssetPropertyValue;
}
export interface Greengrass {
/**
* The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the AWS IoT Greengrass API Reference.
*/
groupArn: ARN;
}
export interface GroupIdentity {
/**
* The AWS SSO ID of the group.
*/
id: IdentityId;
}
export interface IAMUserIdentity {
/**
* The ARN of the IAM user. IAM users must have the iotsitewise:CreatePresignedPortalUrl permission to sign in to the portal. For more information, see IAM ARNs in the IAM User Guide. If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists.
*/
arn: ARN;
}
export type ID = string;
export type IDs = ID[];
export interface Identity {
/**
* An AWS SSO user identity.
*/
user?: UserIdentity;
/**
* An AWS SSO group identity.
*/
group?: GroupIdentity;
/**
* An IAM user identity.
*/
iamUser?: IAMUserIdentity;
}
export type IdentityId = string;
export type IdentityType = "USER"|"GROUP"|"IAM"|string;
export interface Image {
/**
* The ID of an existing image. Specify this parameter to keep an existing image.
*/
id?: ID;
file?: ImageFile;
}
export interface ImageFile {
/**
* The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB.
*/
data: ImageFileData;
/**
* The file type of the image.
*/
type: ImageFileType;
}
export type ImageFileData = Buffer|Uint8Array|Blob|string;
export type ImageFileType = "PNG"|string;
export interface ImageLocation {
/**
* The ID of the image.
*/
id: ID;
/**
* The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image
*/
url: Url;
}
export type Interval = string;
export interface ListAccessPoliciesRequest {
/**
* The type of identity (AWS SSO user, AWS SSO group, or IAM user). This parameter is required if you specify identityId.
*/
identityType?: IdentityType;
/**
* The ID of the identity. This parameter is required if you specify USER or GROUP for identityType.
*/
identityId?: IdentityId;
/**
* The type of resource (portal or project). This parameter is required if you specify resourceId.
*/
resourceType?: ResourceType;
/**
* The ID of the resource. This parameter is required if you specify resourceType.
*/
resourceId?: ID;
/**
* The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType.
*/
iamArn?: ARN;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListAccessPoliciesResponse {
/**
* A list that summarizes each access policy.
*/
accessPolicySummaries: AccessPolicySummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListAssetModelsRequest {
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListAssetModelsResponse {
/**
* A list that summarizes each asset model.
*/
assetModelSummaries: AssetModelSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export type ListAssetsFilter = "ALL"|"TOP_LEVEL"|string;
export interface ListAssetsRequest {
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
/**
* The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.
*/
assetModelId?: ID;
/**
* The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree. Default: ALL
*/
filter?: ListAssetsFilter;
}
export interface ListAssetsResponse {
/**
* A list that summarizes each asset.
*/
assetSummaries: AssetSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListAssociatedAssetsRequest {
/**
* The ID of the asset to query.
*/
assetId: ID;
/**
* The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
*/
hierarchyId?: ID;
/**
* The direction to list associated assets. Choose one of the following options: CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD. PARENT – The list includes the asset's parent asset. Default: CHILD
*/
traversalDirection?: TraversalDirection;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListAssociatedAssetsResponse {
/**
* A list that summarizes the associated assets.
*/
assetSummaries: AssociatedAssetsSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListDashboardsRequest {
/**
* The ID of the project.
*/
projectId: ID;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListDashboardsResponse {
/**
* A list that summarizes each dashboard in the project.
*/
dashboardSummaries: DashboardSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListGatewaysRequest {
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListGatewaysResponse {
/**
* A list that summarizes each gateway.
*/
gatewaySummaries: GatewaySummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListPortalsRequest {
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListPortalsResponse {
/**
* A list that summarizes each portal.
*/
portalSummaries?: PortalSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListProjectAssetsRequest {
/**
* The ID of the project.
*/
projectId: ID;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListProjectAssetsResponse {
/**
* A list that contains the IDs of each asset associated with the project.
*/
assetIds: AssetIDs;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListProjectsRequest {
/**
* The ID of the portal.
*/
portalId: ID;
/**
* The token to be used for the next set of paginated results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to be returned per paginated request. Default: 50
*/
maxResults?: MaxResults;
}
export interface ListProjectsResponse {
/**
* A list that summarizes each project in the portal.
*/
projectSummaries: ProjectSummaries;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: AmazonResourceName;
}
export interface ListTagsForResourceResponse {
/**
* The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags?: TagMap;
}
export type LoggingLevel = "ERROR"|"INFO"|"OFF"|string;
export interface LoggingOptions {
/**
* The AWS IoT SiteWise logging verbosity level.
*/
level: LoggingLevel;
}
export type Macro = string;
export type MaxResults = number;
export interface Measurement {
}
export interface Metric {
/**
* The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
expression: Expression;
/**
* The list of variables used in the expression.
*/
variables: ExpressionVariables;
/**
* The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression. AWS IoT SiteWise computes one data point per window.
*/
window: MetricWindow;
}
export interface MetricWindow {
/**
* The tumbling time interval window.
*/
tumbling?: TumblingWindow;
}
export type MonitorErrorCode = "INTERNAL_FAILURE"|"VALIDATION_ERROR"|"LIMIT_EXCEEDED"|string;
export interface MonitorErrorDetails {
/**
* The error code.
*/
code?: MonitorErrorCode;
/**
* The error message.
*/
message?: MonitorErrorMessage;
}
export type MonitorErrorMessage = string;
export type Name = string;
export type NextToken = string;
export type OffsetInNanos = number;
export type Permission = "ADMINISTRATOR"|"VIEWER"|string;
export type PortalClientId = string;
export interface PortalResource {
/**
* The ID of the portal.
*/
id: ID;
}
export type PortalState = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|string;
export interface PortalStatus {
/**
* The current state of the portal.
*/
state: PortalState;
/**
* Contains associated error information, if any.
*/
error?: MonitorErrorDetails;
}
export type PortalSummaries = PortalSummary[];
export interface PortalSummary {
/**
* The ID of the portal.
*/
id: ID;
/**
* The name of the portal.
*/
name: Name;
/**
* The portal's description.
*/
description?: Description;
/**
* The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the CreatePresignedPortalUrl operation to create a URL that you can use to access the portal.
*/
startUrl: Url;
/**
* The date the portal was created, in Unix epoch time.
*/
creationDate?: Timestamp;
/**
* The date the portal was last updated, in Unix epoch time.
*/
lastUpdateDate?: Timestamp;
/**
* The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
*/
roleArn?: ARN;
status: PortalStatus;
}
export interface ProjectResource {
/**
* The ID of the project.
*/
id: ID;
}
export type ProjectSummaries = ProjectSummary[];
export interface ProjectSummary {
/**
* The ID of the project.
*/
id: ID;
/**
* The name of the project.
*/
name: Name;
/**
* The project's description.
*/
description?: Description;
/**
* The date the project was created, in Unix epoch time.
*/
creationDate?: Timestamp;
/**
* The date the project was last updated, in Unix epoch time.
*/
lastUpdateDate?: Timestamp;
}
export interface Property {
/**
* The ID of the asset property.
*/
id: ID;
/**
* The name of the property.
*/
name: Name;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
alias?: PropertyAlias;
/**
* The asset property's notification topic and state. For more information, see UpdateAssetProperty.
*/
notification?: PropertyNotification;
/**
* The property data type.
*/
dataType: PropertyDataType;
/**
* The unit (such as Newtons or RPM) of the asset property.
*/
unit?: PropertyUnit;
/**
* The property type (see PropertyType). A property contains one type.
*/
type?: PropertyType;
}
export type PropertyAlias = string;
export type PropertyDataType = "STRING"|"INTEGER"|"DOUBLE"|"BOOLEAN"|string;
export interface PropertyNotification {
/**
* The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.
*/
topic: PropertyNotificationTopic;
/**
* The current notification state.
*/
state: PropertyNotificationState;
}
export type PropertyNotificationState = "ENABLED"|"DISABLED"|string;
export type PropertyNotificationTopic = string;
export interface PropertyType {
/**
* Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
*/
attribute?: Attribute;
/**
* Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values.
*/
measurement?: Measurement;
/**
* Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
*/
transform?: Transform;
/**
* Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
*/
metric?: Metric;
}
export type PropertyUnit = string;
export type PropertyValueBooleanValue = boolean;
export type PropertyValueDoubleValue = number;
export type PropertyValueIntegerValue = number;
export type PropertyValueStringValue = string;
export type PutAssetPropertyValueEntries = PutAssetPropertyValueEntry[];
export interface PutAssetPropertyValueEntry {
/**
* The user specified ID for the entry. You can use this ID to identify which entries failed.
*/
entryId: EntryId;
/**
* The ID of the asset to update.
*/
assetId?: ID;
/**
* The ID of the asset property for this entry.
*/
propertyId?: ID;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.
*/
propertyAlias?: AssetPropertyAlias;
/**
* The list of property values to upload. You can specify up to 10 propertyValues array elements.
*/
propertyValues: AssetPropertyValues;
}
export interface PutLoggingOptionsRequest {
/**
* The logging options to set.
*/
loggingOptions: LoggingOptions;
}
export interface PutLoggingOptionsResponse {
}
export type Qualities = Quality[];
export type Quality = "GOOD"|"BAD"|"UNCERTAIN"|string;
export type Resolution = string;
export interface Resource {
/**
* A portal resource.
*/
portal?: PortalResource;
/**
* A project resource.
*/
project?: ProjectResource;
}
export type ResourceType = "PORTAL"|"PROJECT"|string;
export type SSOApplicationId = string;
export type SessionDurationSeconds = number;
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The ARN of the resource to tag.
*/
resourceArn: AmazonResourceName;
/**
* A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface TimeInNanos {
/**
* The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
*/
timeInSeconds: TimeInSeconds;
/**
* The nanosecond offset from timeInSeconds.
*/
offsetInNanos?: OffsetInNanos;
}
export type TimeInSeconds = number;
export type TimeOrdering = "ASCENDING"|"DESCENDING"|string;
export type Timestamp = Date;
export type Timestamps = TimeInNanos[];
export interface Transform {
/**
* The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
expression: Expression;
/**
* The list of variables used in the expression.
*/
variables: ExpressionVariables;
}
export type TraversalDirection = "PARENT"|"CHILD"|string;
export interface TumblingWindow {
/**
* The time interval for the tumbling window. Note that w represents weeks, d represents days, h represents hours, and m represents minutes. AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on. When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.
*/
interval: Interval;
}
export interface UntagResourceRequest {
/**
* The ARN of the resource to untag.
*/
resourceArn: AmazonResourceName;
/**
* A list of keys for tags to remove from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateAccessPolicyRequest {
/**
* The ID of the access policy.
*/
accessPolicyId: ID;
/**
* The identity for this access policy. Choose an AWS SSO user, an AWS SSO group, or an IAM user.
*/
accessPolicyIdentity: Identity;
/**
* The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
*/
accessPolicyResource: Resource;
/**
* The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner.
*/
accessPolicyPermission: Permission;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateAccessPolicyResponse {
}
export interface UpdateAssetModelRequest {
/**
* The ID of the asset model to update.
*/
assetModelId: ID;
/**
* A unique, friendly name for the asset model.
*/
assetModelName: Name;
/**
* A description for the asset model.
*/
assetModelDescription?: Description;
/**
* The updated property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
assetModelProperties?: AssetModelProperties;
/**
* The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide.
*/
assetModelHierarchies?: AssetModelHierarchies;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateAssetModelResponse {
/**
* The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message.
*/
assetModelStatus: AssetModelStatus;
}
export interface UpdateAssetPropertyRequest {
/**
* The ID of the asset to be updated.
*/
assetId: ID;
/**
* The ID of the asset property to be updated.
*/
propertyId: ID;
/**
* The property alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property.
*/
propertyAlias?: PropertyAlias;
/**
* The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED.
*/
propertyNotificationState?: PropertyNotificationState;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateAssetRequest {
/**
* The ID of the asset to update.
*/
assetId: ID;
/**
* A unique, friendly name for the asset.
*/
assetName: Name;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateAssetResponse {
/**
* The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message.
*/
assetStatus: AssetStatus;
}
export interface UpdateDashboardRequest {
/**
* The ID of the dashboard to update.
*/
dashboardId: ID;
/**
* A new friendly name for the dashboard.
*/
dashboardName: Name;
/**
* A new description for the dashboard.
*/
dashboardDescription?: Description;
/**
* The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.
*/
dashboardDefinition: DashboardDefinition;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateDashboardResponse {
}
export interface UpdateGatewayCapabilityConfigurationRequest {
/**
* The ID of the gateway to be updated.
*/
gatewayId: ID;
/**
* The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the AWS IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1.
*/
capabilityNamespace: CapabilityNamespace;
/**
* The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the AWS IoT SiteWise User Guide.
*/
capabilityConfiguration: CapabilityConfiguration;
}
export interface UpdateGatewayCapabilityConfigurationResponse {
/**
* The namespace of the gateway capability.
*/
capabilityNamespace: CapabilityNamespace;
/**
* The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration. After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration.
*/
capabilitySyncStatus: CapabilitySyncStatus;
}
export interface UpdateGatewayRequest {
/**
* The ID of the gateway to update.
*/
gatewayId: ID;
/**
* A unique, friendly name for the gateway.
*/
gatewayName: Name;
}
export interface UpdatePortalRequest {
/**
* The ID of the portal to update.
*/
portalId: ID;
/**
* A new friendly name for the portal.
*/
portalName: Name;
/**
* A new description for the portal.
*/
portalDescription?: Description;
/**
* The AWS administrator's contact email address.
*/
portalContactEmail: Email;
portalLogoImage?: Image;
/**
* The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.
*/
roleArn: ARN;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdatePortalResponse {
/**
* The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message.
*/
portalStatus: PortalStatus;
}
export interface UpdateProjectRequest {
/**
* The ID of the project to update.
*/
projectId: ID;
/**
* A new friendly name for the project.
*/
projectName: Name;
/**
* A new description for the project.
*/
projectDescription?: Description;
/**
* 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.
*/
clientToken?: ClientToken;
}
export interface UpdateProjectResponse {
}
export type Url = string;
export interface UserIdentity {
/**
* The AWS SSO ID of the user.
*/
id: IdentityId;
}
export type VariableName = string;
export interface VariableValue {
/**
* The ID of the property to use as the variable. You can use the property name if it's from the same asset model.
*/
propertyId: Macro;
/**
* The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.
*/
hierarchyId?: Macro;
}
export interface Variant {
/**
* Asset property data of type string (sequence of characters).
*/
stringValue?: PropertyValueStringValue;
/**
* Asset property data of type integer (whole number).
*/
integerValue?: PropertyValueIntegerValue;
/**
* Asset property data of type double (floating point number).
*/
doubleValue?: PropertyValueDoubleValue;
/**
* Asset property data of type Boolean (true or false).
*/
booleanValue?: PropertyValueBooleanValue;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2019-12-02"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the IoTSiteWise client.
*/
export import Types = IoTSiteWise;
}
export = IoTSiteWise;