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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Contains an access policy that defines an identity's access to an IoT SiteWise
// Monitor resource.
type AccessPolicySummary struct {
// The ID of the access policy.
//
// This member is required.
Id *string
// The identity (an IAM Identity Center user, an IAM Identity Center group, or an
// IAM user).
//
// This member is required.
Identity *Identity
// The permissions for the access policy. Note that a project ADMINISTRATOR is
// also known as a project owner.
//
// This member is required.
Permission Permission
// The IoT SiteWise Monitor resource (a portal or project).
//
// This member is required.
Resource *Resource
// The date the access policy was created, in Unix epoch time.
CreationDate *time.Time
// The date the access policy was last updated, in Unix epoch time.
LastUpdateDate *time.Time
noSmithyDocumentSerde
}
// Contains a definition for an action.
type ActionDefinition struct {
// The ID of the action definition.
//
// This member is required.
ActionDefinitionId *string
// The name of the action definition.
//
// This member is required.
ActionName *string
// The type of the action definition.
//
// This member is required.
ActionType *string
noSmithyDocumentSerde
}
// The JSON payload of the action.
type ActionPayload struct {
// The payload of the action in a JSON string.
//
// This member is required.
StringValue *string
noSmithyDocumentSerde
}
// Contains the summary of the actions.
type ActionSummary struct {
// The ID of the action definition.
ActionDefinitionId *string
// The ID of the action.
ActionId *string
// The resource the action will be taken on.
TargetResource *TargetResource
noSmithyDocumentSerde
}
// Contains aggregated asset property values (for example, average, minimum, and
// maximum).
type AggregatedValue struct {
// The date the aggregating computations occurred, in Unix epoch time.
//
// This member is required.
Timestamp *time.Time
// The value of the aggregates.
//
// This member is required.
Value *Aggregates
// The quality of the aggregated data.
Quality Quality
noSmithyDocumentSerde
}
// Contains the (pre-calculated) aggregate values for an asset property.
type Aggregates struct {
// The average (mean) value of the time series over a time interval window.
Average *float64
// The count of data points in the time series over a time interval window.
Count *float64
// The maximum value of the time series over a time interval window.
Maximum *float64
// The minimum value of the time series over a time interval window.
Minimum *float64
// The standard deviation of the time series over a time interval window.
StandardDeviation *float64
// The sum of the time series over a time interval window.
Sum *float64
noSmithyDocumentSerde
}
// Contains the configuration information of an alarm created in an IoT SiteWise
// Monitor portal. You can use the alarm to monitor an asset property and get
// notified when the asset property value is outside a specified range. For more
// information, see Monitoring with alarms (https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html)
// in the IoT SiteWise Application Guide.
type Alarms struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the IAM role that allows the alarm to perform actions and access Amazon Web
// Services resources and services, such as IoT Events.
//
// This member is required.
AlarmRoleArn *string
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Lambda function that manages alarm notifications. For more information,
// see Managing alarm notifications (https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html)
// in the IoT Events Developer Guide.
NotificationLambdaArn *string
noSmithyDocumentSerde
}
// Contains information about a composite model in an asset. This object contains
// the asset's properties that you define in the composite model.
type AssetCompositeModel struct {
// The name of the composite model.
//
// This member is required.
Name *string
// The asset properties that this composite model defines.
//
// This member is required.
Properties []AssetProperty
// The type of the composite model. For alarm composite models, this type is
// AWS/ALARM .
//
// This member is required.
Type *string
// The description of the composite model.
Description *string
// The external ID of the asset composite model. For more information, see Using
// external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the asset composite model.
Id *string
noSmithyDocumentSerde
}
// Represents one level between a composite model and the root of the asset.
type AssetCompositeModelPathSegment struct {
// The ID of the path segment.
Id *string
// The name of the path segment.
Name *string
noSmithyDocumentSerde
}
// Contains a summary of the composite model for a specific asset.
type AssetCompositeModelSummary struct {
// A description of the composite model that this summary describes.
//
// This member is required.
Description *string
// The ID of the composite model that this summary describes.
//
// This member is required.
Id *string
// The name of the composite model that this summary describes.
//
// This member is required.
Name *string
// The path that includes all the components of the asset model for the asset.
//
// This member is required.
Path []AssetCompositeModelPathSegment
// The type of asset model.
// - ASSET_MODEL – (default) An asset model that you can use to create assets.
// Can't be included as a component in another asset model.
// - COMPONENT_MODEL – A reusable component that you can include in the
// composite models of other asset models. You can't create assets directly from
// this type of asset model.
//
// This member is required.
Type *string
// An external ID to assign to the asset model. If the composite model is a
// derived composite model, or one nested inside a component model, you can only
// set the external ID using UpdateAssetModelCompositeModel and specifying the
// derived ID of the model or property from the created model it's a part of.
ExternalId *string
noSmithyDocumentSerde
}
// Contains error details for the requested associate project asset action.
type AssetErrorDetails struct {
// The ID of the asset, in UUID format.
//
// This member is required.
AssetId *string
// The error code.
//
// This member is required.
Code AssetErrorCode
// The error message.
//
// This member is required.
Message *string
noSmithyDocumentSerde
}
// Describes an asset hierarchy that contains a hierarchy's name and ID.
type AssetHierarchy struct {
// The hierarchy name provided in the CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// API operation.
//
// This member is required.
Name *string
// The external ID of the hierarchy, if it has one. When you update an asset
// hierarchy, you may assign an external ID if it doesn't already have one. You
// can't change the external ID of an asset hierarchy that already has one. For
// more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the hierarchy. This ID is a hierarchyId .
Id *string
noSmithyDocumentSerde
}
// Contains information about a parent asset and a child asset that are related
// through an asset hierarchy.
type AssetHierarchyInfo struct {
// The ID of the child asset in this asset relationship.
ChildAssetId *string
// The ID of the parent asset in this asset relationship.
ParentAssetId *string
noSmithyDocumentSerde
}
// Contains information about a composite model in an asset model. This object
// contains the asset property definitions that you define in the composite model.
type AssetModelCompositeModel struct {
// The name of the composite model.
//
// This member is required.
Name *string
// The type of the composite model. For alarm composite models, this type is
// AWS/ALARM .
//
// This member is required.
Type *string
// The description of the composite model.
Description *string
// The external ID of the asset model composite model. For more information, see
// Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the asset model composite model.
Id *string
// The asset property definitions for this composite model.
Properties []AssetModelProperty
noSmithyDocumentSerde
}
// Contains a composite model definition in an asset model. This composite model
// definition is applied to all assets created from the asset model.
type AssetModelCompositeModelDefinition struct {
// The name of the composite model.
//
// This member is required.
Name *string
// The type of the composite model. For alarm composite models, this type is
// AWS/ALARM .
//
// This member is required.
Type *string
// The description of the composite model.
Description *string
// An external ID to assign to the composite model. The external ID must be unique
// among composite models within this asset model. For more information, see Using
// external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID to assign to the composite model, if desired. IoT SiteWise automatically
// generates a unique ID for you, so this parameter is never required. However, if
// you prefer to supply your own ID instead, you can specify it here in UUID
// format. If you specify your own ID, it must be globally unique.
Id *string
// The asset property definitions for this composite model.
Properties []AssetModelPropertyDefinition
noSmithyDocumentSerde
}
// Represents one level between a composite model and the root of the asset model.
type AssetModelCompositeModelPathSegment struct {
// The ID of the path segment.
Id *string
// The name of the path segment.
Name *string
noSmithyDocumentSerde
}
// Contains a summary of the composite model.
type AssetModelCompositeModelSummary struct {
// The ID of the the composite model that this summary describes..
//
// This member is required.
Id *string
// The name of the the composite model that this summary describes..
//
// This member is required.
Name *string
// The type of asset model.
// - ASSET_MODEL – (default) An asset model that you can use to create assets.
// Can't be included as a component in another asset model.
// - COMPONENT_MODEL – A reusable component that you can include in the
// composite models of other asset models. You can't create assets directly from
// this type of asset model.
//
// This member is required.
Type *string
// The description of the the composite model that this summary describes..
Description *string
// The external ID of a composite model on this asset model. For more information,
// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The path that includes all the pieces that make up the composite model.
Path []AssetModelCompositeModelPathSegment
noSmithyDocumentSerde
}
// Describes an asset hierarchy that contains a hierarchy's name, ID, and child
// asset model ID that specifies the type of asset that can be in this hierarchy.
type AssetModelHierarchy struct {
// The ID of the asset model, in UUID format. All assets in this hierarchy must be
// instances of the childAssetModelId asset model. IoT SiteWise will always return
// the actual asset model ID for this value. However, when you are specifying this
// value as part of a call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// , you may provide either the asset model ID or else externalId: followed by the
// asset model's external ID. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
//
// This member is required.
ChildAssetModelId *string
// The name of the asset model hierarchy that you specify by using the
// CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// API operation.
//
// This member is required.
Name *string
// The external ID (if any) provided in the CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// operation. You can assign an external ID by specifying this value as part of a
// call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// . However, you can't change the external ID if one is already assigned. For more
// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the asset model hierarchy. This ID is a hierarchyId .
// - If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// to create a new hierarchy: You can specify its ID here, if desired. IoT SiteWise
// automatically generates a unique ID for you, so this parameter is never
// required. However, if you prefer to supply your own ID instead, you can specify
// it here in UUID format. If you specify your own ID, it must be globally unique.
// - If you are calling UpdateAssetModel to modify an existing hierarchy: This
// can be either the actual ID in UUID format, or else externalId: followed by
// the external ID, if it has one. For more information, see Referencing objects
// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
// in the IoT SiteWise User Guide.
Id *string
noSmithyDocumentSerde
}
// Contains an asset model hierarchy used in asset model creation. An asset model
// hierarchy determines the kind (or type) of asset that can belong to a hierarchy.
type AssetModelHierarchyDefinition struct {
// The ID of an asset model for this hierarchy. This can be either the actual ID
// in UUID format, or else externalId: followed by the external ID, if it has one.
// For more information, see Referencing objects with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
// in the IoT SiteWise User Guide.
//
// This member is required.
ChildAssetModelId *string
// The name of the asset model hierarchy definition (as specified in the
// CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// API operation).
//
// This member is required.
Name *string
// An external ID to assign to the asset model hierarchy. The external ID must be
// unique among asset model hierarchies within this asset model. For more
// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID to assign to the asset model hierarchy, if desired. IoT SiteWise
// automatically generates a unique ID for you, so this parameter is never
// required. However, if you prefer to supply your own ID instead, you can specify
// it here in UUID format. If you specify your own ID, it must be globally unique.
Id *string
noSmithyDocumentSerde
}
// Contains information about an asset model property.
type AssetModelProperty struct {
// The data type of the asset model property.
//
// This member is required.
DataType PropertyDataType
// The name of the asset model property.
//
// This member is required.
Name *string
// The property type (see PropertyType ).
//
// This member is required.
Type *PropertyType
// The data type of the structure for this property. This parameter exists on
// properties that have the STRUCT data type.
DataTypeSpec *string
// The external ID (if any) provided in the CreateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModel.html)
// or UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// operation. You can assign an external ID by specifying this value as part of a
// call to UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// . However, you can't change the external ID if one is already assigned. For more
// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the asset model property.
// - If you are callling UpdateAssetModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetModel.html)
// to create a new property: You can specify its ID here, if desired. IoT SiteWise
// automatically generates a unique ID for you, so this parameter is never
// required. However, if you prefer to supply your own ID instead, you can specify
// it here in UUID format. If you specify your own ID, it must be globally unique.
// - If you are calling UpdateAssetModel to modify an existing property: This
// can be either the actual ID in UUID format, or else externalId: followed by
// the external ID, if it has one. For more information, see Referencing objects
// with external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references)
// in the IoT SiteWise User Guide.
Id *string
// The structured path to the property from the root of the asset model.
Path []AssetModelPropertyPathSegment
// The unit of the asset model property, such as Newtons or RPM .
Unit *string
noSmithyDocumentSerde
}
// Contains an asset model property definition. This property definition is
// applied to all assets created from the asset model.
type AssetModelPropertyDefinition struct {
// The data type of the property definition. If you specify STRUCT , you must also
// specify dataTypeSpec to identify the type of the structure for this property.
//
// This member is required.
DataType PropertyDataType
// The name of the property definition.
//
// This member is required.
Name *string
// The property definition type (see PropertyType ). You can only specify one type
// in a property definition.
//
// This member is required.
Type *PropertyType
// The data type of the structure for this property. This parameter is required on
// properties that have the STRUCT data type. The options for this parameter
// depend on the type of the composite model in which you define this property. Use
// AWS/ALARM_STATE for alarm state in alarm composite models.
DataTypeSpec *string
// An external ID to assign to the property definition. The external ID must be
// unique among property definitions within this asset model. For more information,
// see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID to assign to the asset model property, if desired. IoT SiteWise
// automatically generates a unique ID for you, so this parameter is never
// required. However, if you prefer to supply your own ID instead, you can specify
// it here in UUID format. If you specify your own ID, it must be globally unique.
Id *string
// The unit of the property definition, such as Newtons or RPM .
Unit *string
noSmithyDocumentSerde
}
// Represents one level between a property and the root of the asset model.
type AssetModelPropertyPathSegment struct {
// The ID of the path segment.
Id *string
// The name of the path segment.
Name *string
noSmithyDocumentSerde
}
// Contains a summary of a property associated with a model.
type AssetModelPropertySummary struct {
// The data type of the property.
//
// This member is required.
DataType PropertyDataType
// The name of the property.
//
// This member is required.
Name *string
// Contains a property type, which can be one of attribute , measurement , metric ,
// or transform .
//
// This member is required.
Type *PropertyType
// The ID of the composite model that contains the asset model property.
AssetModelCompositeModelId *string
// The data type of the structure for this property. This parameter exists on
// properties that have the STRUCT data type.
DataTypeSpec *string
// The external ID of the property. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the property.
Id *string
// The structured path to the property from the root of the asset model.
Path []AssetModelPropertyPathSegment
// The unit (such as Newtons or RPM ) of the property.
Unit *string
noSmithyDocumentSerde
}
// Contains current status information for an asset model. For more information,
// see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html)
// in the IoT SiteWise User Guide.
type AssetModelStatus struct {
// The current state of the asset model.
//
// This member is required.
State AssetModelState
// Contains associated error information, if any.
Error *ErrorDetails
noSmithyDocumentSerde
}
// Contains a summary of an asset model.
type AssetModelSummary struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the asset model, which has the following format.
// arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}
//
// This member is required.
Arn *string
// The date the asset model was created, in Unix epoch time.
//
// This member is required.
CreationDate *time.Time
// The asset model description.
//
// This member is required.
Description *string
// The ID of the asset model (used with IoT SiteWise API operations).
//
// This member is required.
Id *string
// The date the asset model was last updated, in Unix epoch time.
//
// This member is required.
LastUpdateDate *time.Time
// The name of the asset model.
//
// This member is required.
Name *string
// The current status of the asset model.
//
// This member is required.
Status *AssetModelStatus
// The type of asset model.
// - ASSET_MODEL – (default) An asset model that you can use to create assets.
// Can't be included as a component in another asset model.
// - COMPONENT_MODEL – A reusable component that you can include in the
// composite models of other asset models. You can't create assets directly from
// this type of asset model.
AssetModelType AssetModelType
// The external ID of the asset model. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
noSmithyDocumentSerde
}
// Contains asset property information.
type AssetProperty struct {
// The data type of the asset property.
//
// This member is required.
DataType PropertyDataType
// The ID of the asset property.
//
// This member is required.
Id *string
// The name of the property.
//
// This member is required.
Name *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
Alias *string
// The data type of the structure for this property. This parameter exists on
// properties that have the STRUCT data type.
DataTypeSpec *string
// The external ID of the asset property. For more information, see Using external
// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The asset property's notification topic and state. For more information, see
// UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
Notification *PropertyNotification
// The structured path to the property from the root of the asset.
Path []AssetPropertyPathSegment
// The unit (such as Newtons or RPM ) of the asset property.
Unit *string
noSmithyDocumentSerde
}
// Represents one level between a property and the root of the asset.
type AssetPropertyPathSegment struct {
// The ID of the path segment.
Id *string
// The name of the path segment.
Name *string
noSmithyDocumentSerde
}
// Contains a summary of a property associated with an asset.
type AssetPropertySummary struct {
// The ID of the property.
//
// This member is required.
Id *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
Alias *string
// The ID of the composite model that contains the asset property.
AssetCompositeModelId *string
// The external ID of the property. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// Contains asset property value notification information. When the notification
// state is enabled, IoT SiteWise publishes property value updates to a unique MQTT
// topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)
// in the IoT SiteWise User Guide.
Notification *PropertyNotification
// The structured path to the property from the root of the asset.
Path []AssetPropertyPathSegment
// The unit of measure (such as Newtons or RPM) of the asset property.
Unit *string
noSmithyDocumentSerde
}
// Contains asset property value information.
type AssetPropertyValue struct {
// The timestamp of the asset property value.
//
// This member is required.
Timestamp *TimeInNanos
// The value of the asset property (see Variant ).
//
// This member is required.
Value *Variant
// The quality of the asset property value.
Quality Quality
noSmithyDocumentSerde
}
// Contains information about assets that are related to one another.
type AssetRelationshipSummary struct {
// The relationship type of the assets in this relationship. This value is one of
// the following:
// - HIERARCHY – The assets are related through an asset hierarchy. If you
// specify this relationship type, this asset relationship includes the
// hierarchyInfo object.
//
// This member is required.
RelationshipType AssetRelationshipType
// The assets that are related through an asset hierarchy. This object is present
// if the relationshipType is HIERARCHY .
HierarchyInfo *AssetHierarchyInfo
noSmithyDocumentSerde
}
// Contains information about the current status of an asset. For more
// information, see Asset and model states (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-and-model-states.html)
// in the IoT SiteWise User Guide.
type AssetStatus struct {
// The current status of the asset.
//
// This member is required.
State AssetState
// Contains associated error information, if any.
Error *ErrorDetails
noSmithyDocumentSerde
}
// Contains a summary of an asset.
type AssetSummary struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the asset, which has the following format.
// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
//
// This member is required.
Arn *string
// The ID of the asset model used to create this asset.
//
// This member is required.
AssetModelId *string
// The date the asset was created, in Unix epoch time.
//
// This member is required.
CreationDate *time.Time
// A list of asset hierarchies that each contain a hierarchyId . A hierarchy
// specifies allowed parent/child asset relationships.
//
// This member is required.
Hierarchies []AssetHierarchy
// The ID of the asset, in UUID format.
//
// This member is required.
Id *string
// The date the asset was last updated, in Unix epoch time.
//
// This member is required.
LastUpdateDate *time.Time
// The name of the asset.
//
// This member is required.
Name *string
// The current status of the asset.
//
// This member is required.
Status *AssetStatus
// A description for the asset.
Description *string
// The external ID of the asset. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
noSmithyDocumentSerde
}
// Contains a summary of an associated asset.
type AssociatedAssetsSummary struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the asset, which has the following format.
// arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}
//
// This member is required.
Arn *string
// The ID of the asset model used to create the asset.
//
// This member is required.
AssetModelId *string
// The date the asset was created, in Unix epoch time.
//
// This member is required.
CreationDate *time.Time
// A list of asset hierarchies that each contain a hierarchyId . A hierarchy
// specifies allowed parent/child asset relationships.
//
// This member is required.
Hierarchies []AssetHierarchy
// The ID of the asset, in UUID format.
//
// This member is required.
Id *string
// The date the asset was last updated, in Unix epoch time.
//
// This member is required.
LastUpdateDate *time.Time
// The name of the asset.
//
// This member is required.
Name *string
// The current status of the asset.
//
// This member is required.
Status *AssetStatus
// A description for the asset.
Description *string
// The external ID of the asset. For more information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
noSmithyDocumentSerde
}
// Contains an asset attribute property. For more information, see Attributes (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#attributes)
// in the IoT SiteWise User Guide.
type Attribute struct {
// 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-attribute-values.html)
// in the IoT SiteWise User Guide.
DefaultValue *string
noSmithyDocumentSerde
}
// Contains information for an asset property aggregate entry that is associated
// with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// API. 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 (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
type BatchGetAssetPropertyAggregatesEntry struct {
// The data aggregating function.
//
// This member is required.
AggregateTypes []AggregateType
// The inclusive end of the range from which to query historical data, expressed
// in seconds in Unix epoch time.
//
// This member is required.
EndDate *time.Time
// The ID of the entry.
//
// This member is required.
EntryId *string
// The time interval over which to aggregate data.
//
// This member is required.
Resolution *string
// The exclusive start of the range from which to query historical data, expressed
// in seconds in Unix epoch time.
//
// This member is required.
StartDate *time.Time
// The ID of the asset in which the asset property was created.
AssetId *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
PropertyAlias *string
// The ID of the asset property, in UUID format.
PropertyId *string
// The quality by which to filter asset data.
Qualities []Quality
// The chronological sorting order of the requested information. Default: ASCENDING
TimeOrdering TimeOrdering
noSmithyDocumentSerde
}
// Contains error information for an asset property aggregate entry that is
// associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// API.
type BatchGetAssetPropertyAggregatesErrorEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyAggregatesErrorCode
// The associated error message.
//
// This member is required.
ErrorMessage *string
noSmithyDocumentSerde
}
// Contains the error code and the timestamp for an asset property aggregate entry
// that is associated with the BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// API.
type BatchGetAssetPropertyAggregatesErrorInfo struct {
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyAggregatesErrorCode
// The date the error occurred, in Unix epoch time.
//
// This member is required.
ErrorTimestamp *time.Time
noSmithyDocumentSerde
}
// Contains information for an entry that has been processed by the previous
// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// request.
type BatchGetAssetPropertyAggregatesSkippedEntry struct {
// The completion status of each entry that is associated with the
// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// API.
//
// This member is required.
CompletionStatus BatchEntryCompletionStatus
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error information, such as the error code and the timestamp.
ErrorInfo *BatchGetAssetPropertyAggregatesErrorInfo
noSmithyDocumentSerde
}
// Contains success information for an entry that is associated with the
// BatchGetAssetPropertyAggregates (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html)
// API.
type BatchGetAssetPropertyAggregatesSuccessEntry struct {
// The requested aggregated asset property values (for example, average, minimum,
// and maximum).
//
// This member is required.
AggregatedValues []AggregatedValue
// The ID of the entry.
//
// This member is required.
EntryId *string
noSmithyDocumentSerde
}
// Contains information for an asset property value entry that is associated with
// the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// API. 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 (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
type BatchGetAssetPropertyValueEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// The ID of the asset in which the asset property was created.
AssetId *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
PropertyAlias *string
// The ID of the asset property, in UUID format.
PropertyId *string
noSmithyDocumentSerde
}
// Contains error information for an asset property value entry that is associated
// with the BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// API.
type BatchGetAssetPropertyValueErrorEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyValueErrorCode
// The associated error message.
//
// This member is required.
ErrorMessage *string
noSmithyDocumentSerde
}
// The error information, such as the error code and the timestamp.
type BatchGetAssetPropertyValueErrorInfo struct {
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyValueErrorCode
// The date the error occurred, in Unix epoch time.
//
// This member is required.
ErrorTimestamp *time.Time
noSmithyDocumentSerde
}
// Contains information for an asset property historical value entry that is
// associated with the BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// API. 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 (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
type BatchGetAssetPropertyValueHistoryEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// The ID of the asset in which the asset property was created.
AssetId *string
// The inclusive end of the range from which to query historical data, expressed
// in seconds in Unix epoch time.
EndDate *time.Time
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
PropertyAlias *string
// The ID of the asset property, in UUID format.
PropertyId *string
// The quality by which to filter asset data.
Qualities []Quality
// The exclusive start of the range from which to query historical data, expressed
// in seconds in Unix epoch time.
StartDate *time.Time
// The chronological sorting order of the requested information. Default: ASCENDING
TimeOrdering TimeOrdering
noSmithyDocumentSerde
}
// A list of the errors (if any) associated with the batch request. Each error
// entry contains the entryId of the entry that failed.
type BatchGetAssetPropertyValueHistoryErrorEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyValueHistoryErrorCode
// The associated error message.
//
// This member is required.
ErrorMessage *string
noSmithyDocumentSerde
}
// The error information, such as the error code and the timestamp.
type BatchGetAssetPropertyValueHistoryErrorInfo struct {
// The error code.
//
// This member is required.
ErrorCode BatchGetAssetPropertyValueHistoryErrorCode
// The date the error occurred, in Unix epoch time.
//
// This member is required.
ErrorTimestamp *time.Time
noSmithyDocumentSerde
}
// Contains information for an entry that has been processed by the previous
// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// request.
type BatchGetAssetPropertyValueHistorySkippedEntry struct {
// The completion status of each entry that is associated with the
// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html)
// API.
//
// This member is required.
CompletionStatus BatchEntryCompletionStatus
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error information, such as the error code and the timestamp.
ErrorInfo *BatchGetAssetPropertyValueHistoryErrorInfo
noSmithyDocumentSerde
}
// Contains success information for an entry that is associated with the
// BatchGetAssetPropertyValueHistory (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// API.
type BatchGetAssetPropertyValueHistorySuccessEntry struct {
// The requested historical values for the specified asset property.
//
// This member is required.
AssetPropertyValueHistory []AssetPropertyValue
// The ID of the entry.
//
// This member is required.
EntryId *string
noSmithyDocumentSerde
}
// Contains information for an entry that has been processed by the previous
// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// request.
type BatchGetAssetPropertyValueSkippedEntry struct {
// The completion status of each entry that is associated with the
// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// request.
//
// This member is required.
CompletionStatus BatchEntryCompletionStatus
// The ID of the entry.
//
// This member is required.
EntryId *string
// The error information, such as the error code and the timestamp.
ErrorInfo *BatchGetAssetPropertyValueErrorInfo
noSmithyDocumentSerde
}
// Contains success information for an entry that is associated with the
// BatchGetAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html)
// API.
type BatchGetAssetPropertyValueSuccessEntry struct {
// The ID of the entry.
//
// This member is required.
EntryId *string
// Contains asset property value information.
AssetPropertyValue *AssetPropertyValue
noSmithyDocumentSerde
}
// Contains error information from updating a batch of asset property values.
type BatchPutAssetPropertyError struct {
// The error code.
//
// This member is required.
ErrorCode BatchPutAssetPropertyValueErrorCode
// The associated error message.
//
// This member is required.
ErrorMessage *string
// A list of timestamps for each error, if any.
//
// This member is required.
Timestamps []TimeInNanos
noSmithyDocumentSerde
}
// Contains error information for asset property value entries that are associated
// with the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html)
// API.
type BatchPutAssetPropertyErrorEntry struct {
// The ID of the failed entry.
//
// This member is required.
EntryId *string
// The list of update property value errors.
//
// This member is required.
Errors []BatchPutAssetPropertyError
noSmithyDocumentSerde
}
// A description of the column in the query results.
type ColumnInfo struct {
// The name of the column description.
Name *string
// The type of the column description.
Type *ColumnType
noSmithyDocumentSerde
}
// The data type of the column.
type ColumnType struct {
// The allowed data types that the column has as it's value.
ScalarType ScalarType
noSmithyDocumentSerde
}
// Contains information about a composite model property on an asset.
type CompositeModelProperty struct {
// Contains asset property information.
//
// This member is required.
AssetProperty *Property
// The name of the property.
//
// This member is required.
Name *string
// The type of the composite model that defines this property.
//
// This member is required.
Type *string
// The external ID of the composite model that contains the property. For more
// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The ID of the composite model that contains the property.
Id *string
noSmithyDocumentSerde
}
// Metadata for the composition relationship established by using
// composedAssetModelId in CreateAssetModelCompositeModel (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html)
// .
type CompositionDetails struct {
// An array detailing the composition relationship for this composite model.
CompositionRelationship []CompositionRelationshipItem
noSmithyDocumentSerde
}
// Represents a composite model that composed an asset model of type
// COMPONENT_MODEL .
type CompositionRelationshipItem struct {
// The ID of the component.
Id *string
noSmithyDocumentSerde
}
// Contains a summary of the components of the composite model.
type CompositionRelationshipSummary struct {
// The ID of a composite model on this asset model.
//
// This member is required.
AssetModelCompositeModelId *string
// The composite model type. Valid values are AWS/ALARM , CUSTOM , or
// AWS/L4E_ANOMALY .
//
// This member is required.
AssetModelCompositeModelType *string
// The ID of the asset model, in UUID format.
//
// This member is required.
AssetModelId *string
noSmithyDocumentSerde
}
// Contains the details of an IoT SiteWise configuration error.
type ConfigurationErrorDetails struct {
// The error code.
//
// This member is required.
Code ErrorCode
// The error message.
//
// This member is required.
Message *string
noSmithyDocumentSerde
}
// Contains current status information for the configuration.
type ConfigurationStatus struct {
// The current state of the configuration.
//
// This member is required.
State ConfigurationState
// Contains associated error information, if any.
Error *ConfigurationErrorDetails
noSmithyDocumentSerde
}
// A .CSV file.
type Csv struct {
// The column names specified in the .csv file.
//
// This member is required.
ColumnNames []ColumnName
noSmithyDocumentSerde
}
// Contains information about a customer managed Amazon S3 bucket.
type CustomerManagedS3Storage struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Identity and Access Management role that allows IoT SiteWise to send data
// to Amazon S3.
//
// This member is required.
RoleArn *string
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Amazon S3 object. For more information about how to find the ARN for an
// Amazon S3 object, see Amazon S3 resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html)
// in the Amazon Simple Storage Service User Guide.
//
// This member is required.
S3ResourceArn *string
noSmithyDocumentSerde
}
// Contains a dashboard summary.
type DashboardSummary struct {
// The ID of the dashboard.
//
// This member is required.
Id *string
// The name of the dashboard
//
// This member is required.
Name *string
// The date the dashboard was created, in Unix epoch time.
CreationDate *time.Time
// The dashboard's description.
Description *string
// The date the dashboard was last updated, in Unix epoch time.
LastUpdateDate *time.Time
noSmithyDocumentSerde
}
// Represents a single data point in a query result.
type Datum struct {
// Indicates if the data point is an array.
ArrayValue []Datum
// Indicates if the data point is null.
NullValue *bool
// Indicates if the data point is a row.
RowValue *Row
// Indicates if the data point is a scalar value such as integer, string, double,
// or Boolean.
ScalarValue *string
noSmithyDocumentSerde
}
// Contains detailed error information.
type DetailedError struct {
// The error code.
//
// This member is required.
Code DetailedErrorCode
// The error message.
//
// This member is required.
Message *string
noSmithyDocumentSerde
}
// Contains the details of an IoT SiteWise error.
type ErrorDetails struct {
// The error code.
//
// This member is required.
Code ErrorCode
// The error message.
//
// This member is required.
Message *string
// A list of detailed errors.
Details []DetailedError
noSmithyDocumentSerde
}
// The Amazon S3 destination where errors associated with the job creation request
// are saved.
type ErrorReportLocation struct {
// The name of the Amazon S3 bucket to which errors associated with the bulk
// import job are sent.
//
// This member is required.
Bucket *string
// Amazon S3 uses the prefix as a folder name to organize data in the bucket. Each
// Amazon S3 object has a key that is its unique identifier in the bucket. Each
// object in a bucket has exactly one key. The prefix must end with a forward slash
// (/). For more information, see Organizing objects using prefixes (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html)
// in the Amazon Simple Storage Service User Guide.
//
// This member is required.
Prefix *string
noSmithyDocumentSerde
}
// Contains expression variable information.
type ExpressionVariable struct {
// The friendly name of the variable to be used in the expression.
//
// This member is required.
Name *string
// The variable that identifies an asset property from which to use values.
//
// This member is required.
Value *VariableValue
noSmithyDocumentSerde
}
// The file in Amazon S3 where your data is saved.
type File struct {
// The name of the Amazon S3 bucket from which data is imported.
//
// This member is required.
Bucket *string
// The key of the Amazon S3 object that contains your data. Each object has a key
// that is a unique identifier. Each object has exactly one key.
//
// This member is required.
Key *string
// The version ID to identify a specific version of the Amazon S3 object that
// contains your data.
VersionId *string
noSmithyDocumentSerde
}
// The file format of the data in S3.
type FileFormat struct {
// The file is in .CSV format.
Csv *Csv
// The file is in parquet format.
Parquet *Parquet
noSmithyDocumentSerde
}
// The forwarding configuration for a given property.
type ForwardingConfig struct {
// The forwarding state for the given property.
//
// This member is required.
State ForwardingConfigState
noSmithyDocumentSerde
}
// Contains a summary of a gateway capability configuration.
type GatewayCapabilitySummary struct {
// The namespace of the capability configuration. For example, if you configure
// OPC-UA sources from the IoT SiteWise console, your OPC-UA capability
// configuration has the namespace iotsitewise:opcuacollector:version , where
// version is a number such as 1 .
//
// This member is required.
CapabilityNamespace *string
// 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.
//
// This member is required.
CapabilitySyncStatus CapabilitySyncStatus
noSmithyDocumentSerde
}
// Contains a gateway's platform information.
type GatewayPlatform struct {
// A gateway that runs on IoT Greengrass.
Greengrass *Greengrass
// A gateway that runs on IoT Greengrass V2.
GreengrassV2 *GreengrassV2
noSmithyDocumentSerde
}
// Contains a summary of a gateway.
type GatewaySummary struct {
// The date the gateway was created, in Unix epoch time.
//
// This member is required.
CreationDate *time.Time
// The ID of the gateway device.
//
// This member is required.
GatewayId *string
// The name of the asset.
//
// This member is required.
GatewayName *string
// The date the gateway was last updated, in Unix epoch time.
//
// This member is required.
LastUpdateDate *time.Time
// 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 (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeGatewayCapabilityConfiguration.html)
// .
GatewayCapabilitySummaries []GatewayCapabilitySummary
// Contains a gateway's platform information.
GatewayPlatform *GatewayPlatform
noSmithyDocumentSerde
}
// Contains details for a gateway that runs on IoT Greengrass. To create a gateway
// that runs on IoT Greengrass, you must add the IoT SiteWise connector to a
// Greengrass group and deploy it. Your Greengrass group must also have permissions
// to upload data to IoT SiteWise. For more information, see Ingesting data using
// a gateway (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateway-connector.html)
// in the IoT SiteWise User Guide.
type Greengrass struct {
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the Greengrass group. For more information about how to find a group's ARN,
// see ListGroups (https://docs.aws.amazon.com/greengrass/latest/apireference/listgroups-get.html)
// and GetGroup (https://docs.aws.amazon.com/greengrass/latest/apireference/getgroup-get.html)
// in the IoT Greengrass API Reference.
//
// This member is required.
GroupArn *string
noSmithyDocumentSerde
}
// Contains details for a gateway that runs on IoT Greengrass V2. To create a
// gateway that runs on IoT Greengrass V2, you must deploy the IoT SiteWise Edge
// component to your gateway device. Your Greengrass device role (https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html)
// must use the AWSIoTSiteWiseEdgeAccess policy. For more information, see Using
// IoT SiteWise at the edge (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html)
// in the IoT SiteWise User Guide.
type GreengrassV2 struct {
// The name of the IoT thing for your IoT Greengrass V2 core device.
//
// This member is required.
CoreDeviceThingName *string
noSmithyDocumentSerde
}
// Contains information for a group identity in an access policy.
type GroupIdentity struct {
// The IAM Identity Center ID of the group.
//
// This member is required.
Id *string
noSmithyDocumentSerde
}
// Contains information about an Identity and Access Management role. For more
// information, see IAM roles (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)
// in the IAM User Guide.
type IAMRoleIdentity struct {
// The ARN of the IAM role. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
// in the IAM User Guide.
//
// This member is required.
Arn *string
noSmithyDocumentSerde
}
// Contains information about an Identity and Access Management user.
type IAMUserIdentity struct {
// The ARN of the IAM user. For more information, see IAM ARNs (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
// 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.
//
// This member is required.
Arn *string
noSmithyDocumentSerde
}
// Contains an identity that can access an IoT SiteWise Monitor resource.
// Currently, you can't use Amazon Web Services API operations to retrieve IAM
// Identity Center identity IDs. You can find the IAM Identity Center identity IDs
// in the URL of user and group pages in the IAM Identity Center console (https://console.aws.amazon.com/singlesignon)
// .
type Identity struct {
// An IAM Identity Center group identity.
Group *GroupIdentity
// An IAM role identity.
IamRole *IAMRoleIdentity
// An IAM user identity.
IamUser *IAMUserIdentity
// An IAM Identity Center user identity.
User *UserIdentity
noSmithyDocumentSerde
}
// Contains an image that is one of the following:
// - An image file. Choose this option to upload a new image.
// - The ID of an existing image. Choose this option to keep an existing image.
type Image struct {
// Contains an image file.
File *ImageFile
// The ID of an existing image. Specify this parameter to keep an existing image.
Id *string
noSmithyDocumentSerde
}
// Contains an image file.
type ImageFile struct {
// The image file contents, represented as a base64-encoded string. The file size
// must be less than 1 MB.
//
// This member is required.
Data []byte
// The file type of the image.
//
// This member is required.
Type ImageFileType
noSmithyDocumentSerde
}
// Contains an image that is uploaded to IoT SiteWise and available at a URL.
type ImageLocation struct {
// The ID of the image.
//
// This member is required.
Id *string
// The URL where the image is available. The URL is valid for 15 minutes so that
// you can view and download the image
//
// This member is required.
Url *string
noSmithyDocumentSerde
}
// Contains information about an interpolated asset property value.
type InterpolatedAssetPropertyValue struct {
// Contains a timestamp with optional nanosecond granularity.
//
// This member is required.
Timestamp *TimeInNanos
// Contains an asset property value (of a single type only).
//
// This member is required.
Value *Variant
noSmithyDocumentSerde
}
// Contains the configuration information of a job, such as the file format used
// to save data in Amazon S3.
type JobConfiguration struct {
// The file format of the data in S3.
//
// This member is required.
FileFormat *FileFormat
noSmithyDocumentSerde
}
// Contains the job summary information.
type JobSummary struct {
// The ID of the job.
//
// This member is required.
Id *string
// The unique name that helps identify the job request.
//
// This member is required.
Name *string
// The status of the bulk import job can be one of following values:
// - PENDING – IoT SiteWise is waiting for the current bulk import job to finish.
// - CANCELLED – The bulk import job has been canceled.
// - RUNNING – IoT SiteWise is processing your request to import your data from
// Amazon S3.
// - COMPLETED – IoT SiteWise successfully completed your request to import data
// from Amazon S3.
// - FAILED – IoT SiteWise couldn't process your request to import data from
// Amazon S3. You can use logs saved in the specified error report location in
// Amazon S3 to troubleshoot issues.
// - COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data
// from Amazon S3 with errors. You can use logs saved in the specified error report
// location in Amazon S3 to troubleshoot issues.
//
// This member is required.
Status JobStatus
noSmithyDocumentSerde
}
// Contains logging options.
type LoggingOptions struct {
// The IoT SiteWise logging verbosity level.
//
// This member is required.
Level LoggingLevel
noSmithyDocumentSerde
}
// Contains an asset measurement property. For more information, see Measurements (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements)
// in the IoT SiteWise User Guide.
type Measurement struct {
// The processing configuration for the given measurement property. You can
// configure measurements to be kept at the edge or forwarded to the Amazon Web
// Services Cloud. By default, measurements are forwarded to the cloud.
ProcessingConfig *MeasurementProcessingConfig
noSmithyDocumentSerde
}
// The processing configuration for the given measurement property. You can
// configure measurements to be kept at the edge or forwarded to the Amazon Web
// Services Cloud. By default, measurements are forwarded to the cloud.
type MeasurementProcessingConfig struct {
// The forwarding configuration for the given measurement property.
//
// This member is required.
ForwardingConfig *ForwardingConfig
noSmithyDocumentSerde
}
// Contains an asset metric property. With metrics, you can calculate aggregate
// functions, such as an average, maximum, or minimum, as specified through an
// expression. A metric maps several values to a single value (such as a sum). The
// maximum number of dependent/cascading variables used in any one metric
// calculation is 10. Therefore, a root metric can have up to 10 cascading metrics
// in its computational dependency tree. Additionally, a metric can only have a
// data type of DOUBLE and consume properties with data types of INTEGER or DOUBLE
// . For more information, see Metrics (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#metrics)
// in the IoT SiteWise User Guide.
type Metric struct {
// 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
// in the IoT SiteWise User Guide.
//
// This member is required.
Expression *string
// The list of variables used in the expression.
//
// This member is required.
Variables []ExpressionVariable
// The window (time interval) over which IoT SiteWise computes the metric's
// aggregation expression. IoT SiteWise computes one data point per window .
//
// This member is required.
Window *MetricWindow
// The processing configuration for the given metric property. You can configure
// metrics to be computed at the edge or in the Amazon Web Services Cloud. By
// default, metrics are forwarded to the cloud.
ProcessingConfig *MetricProcessingConfig
noSmithyDocumentSerde
}
// The processing configuration for the given metric property. You can configure
// metrics to be computed at the edge or in the Amazon Web Services Cloud. By
// default, metrics are forwarded to the cloud.
type MetricProcessingConfig struct {
// The compute location for the given metric property.
//
// This member is required.
ComputeLocation ComputeLocation
noSmithyDocumentSerde
}
// Contains a time interval window used for data aggregate computations (for
// example, average, sum, count, and so on).
type MetricWindow struct {
// The tumbling time interval window.
Tumbling *TumblingWindow
noSmithyDocumentSerde
}
// Contains IoT SiteWise Monitor error details.
type MonitorErrorDetails struct {
// The error code.
Code MonitorErrorCode
// The error message.
Message *string
noSmithyDocumentSerde
}
// Contains information about the storage destination.
type MultiLayerStorage struct {
// Contains information about a customer managed Amazon S3 bucket.
//
// This member is required.
CustomerManagedS3Storage *CustomerManagedS3Storage
noSmithyDocumentSerde
}
// A parquet file.
type Parquet struct {
noSmithyDocumentSerde
}
// Identifies an IoT SiteWise Monitor portal.
type PortalResource struct {
// The ID of the portal.
//
// This member is required.
Id *string
noSmithyDocumentSerde
}
// Contains information about the current status of a portal.
type PortalStatus struct {
// The current state of the portal.
//
// This member is required.
State PortalState
// Contains associated error information, if any.
Error *MonitorErrorDetails
noSmithyDocumentSerde
}
// Contains a portal summary.
type PortalSummary struct {
// The ID of the portal.
//
// This member is required.
Id *string
// The name of the portal.
//
// This member is required.
Name *string
// The URL for the IoT SiteWise Monitor portal. You can use this URL to access
// portals that use IAM Identity Center for authentication. For portals that use
// IAM for authentication, you must use the IoT SiteWise console to get a URL that
// you can use to access the portal.
//
// This member is required.
StartUrl *string
// Contains information about the current status of a portal.
//
// This member is required.
Status *PortalStatus
// The date the portal was created, in Unix epoch time.
CreationDate *time.Time
// The portal's description.
Description *string
// The date the portal was last updated, in Unix epoch time.
LastUpdateDate *time.Time
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the service role that allows the portal's users to access your IoT SiteWise
// resources on your behalf. For more information, see Using service roles for IoT
// SiteWise Monitor (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html)
// in the IoT SiteWise User Guide.
RoleArn *string
noSmithyDocumentSerde
}
// Identifies a specific IoT SiteWise Monitor project.
type ProjectResource struct {
// The ID of the project.
//
// This member is required.
Id *string
noSmithyDocumentSerde
}
// Contains project summary information.
type ProjectSummary struct {
// The ID of the project.
//
// This member is required.
Id *string
// The name of the project.
//
// This member is required.
Name *string
// The date the project was created, in Unix epoch time.
CreationDate *time.Time
// The project's description.
Description *string
// The date the project was last updated, in Unix epoch time.
LastUpdateDate *time.Time
noSmithyDocumentSerde
}
// Contains asset property information.
type Property struct {
// The property data type.
//
// This member is required.
DataType PropertyDataType
// The ID of the asset property.
//
// This member is required.
Id *string
// The name of the property.
//
// This member is required.
Name *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
Alias *string
// The external ID of the asset property. For more information, see Using external
// IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
ExternalId *string
// The asset property's notification topic and state. For more information, see
// UpdateAssetProperty (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html)
// .
Notification *PropertyNotification
// The structured path to the property from the root of the asset.
Path []AssetPropertyPathSegment
// The property type (see PropertyType ). A property contains one type.
Type *PropertyType
// The unit (such as Newtons or RPM ) of the asset property.
Unit *string
noSmithyDocumentSerde
}
// Contains asset property value notification information. When the notification
// state is enabled, IoT SiteWise publishes property value updates to a unique MQTT
// topic. For more information, see Interacting with other services (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)
// in the IoT SiteWise User Guide.
type PropertyNotification struct {
// The current notification state.
//
// This member is required.
State PropertyNotificationState
// The MQTT topic to which IoT SiteWise publishes property value update
// notifications.
//
// This member is required.
Topic *string
noSmithyDocumentSerde
}
// Contains a property type, which can be one of attribute , measurement , metric ,
// or transform .
type PropertyType struct {
// Specifies an asset attribute property. An attribute generally contains static
// information, such as the serial number of an IIoT (https://en.wikipedia.org/wiki/Internet_of_things#Industrial_applications)
// 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 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
// 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
noSmithyDocumentSerde
}
// Contains a list of value updates for an asset property in the list of asset
// entries consumed by the BatchPutAssetPropertyValue (https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html)
// API operation.
type PutAssetPropertyValueEntry struct {
// The user specified ID for the entry. You can use this ID to identify which
// entries failed.
//
// This member is required.
EntryId *string
// The list of property values to upload. You can specify up to 10 propertyValues
// array elements.
//
// This member is required.
PropertyValues []AssetPropertyValue
// The ID of the asset to update.
AssetId *string
// The 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)
// in the IoT SiteWise User Guide.
PropertyAlias *string
// The ID of the asset property for this entry.
PropertyId *string
noSmithyDocumentSerde
}
// Contains an IoT SiteWise Monitor resource ID for a portal or project.
type Resource struct {
// A portal resource.
Portal *PortalResource
// A project resource.
Project *ProjectResource
noSmithyDocumentSerde
}
// The number of days your data is kept in the hot tier. By default, your data is
// kept indefinitely in the hot tier.
type RetentionPeriod struct {
// The number of days that your data is kept. If you specified a value for this
// parameter, the unlimited parameter must be false .
NumberOfDays *int32
// If true, your data is kept indefinitely. If configured to true , you must not
// specify a value for the numberOfDays parameter.
Unlimited *bool
noSmithyDocumentSerde
}
// Represents a single row in the query results.
type Row struct {
// List of data points in a single row of the result set.
//
// This member is required.
Data []Datum
noSmithyDocumentSerde
}
// The resource the action will be taken on.
type TargetResource struct {
// The ID of the asset, in UUID format.
//
// This member is required.
AssetId *string
noSmithyDocumentSerde
}
// Contains a timestamp with optional nanosecond granularity.
type TimeInNanos struct {
// The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond
// data is provided by offsetInNanos .
//
// This member is required.
TimeInSeconds *int64
// The nanosecond offset from timeInSeconds .
OffsetInNanos *int32
noSmithyDocumentSerde
}
// Contains a summary of a time series (data stream).
type TimeSeriesSummary struct {
// The data type of the time series. If you specify STRUCT , you must also specify
// dataTypeSpec to identify the type of the structure for this time series.
//
// This member is required.
DataType PropertyDataType
// The ARN (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the time series, which has the following format.
// arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
//
// This member is required.
TimeSeriesArn *string
// The date that the time series was created, in Unix epoch time.
//
// This member is required.
TimeSeriesCreationDate *time.Time
// The ID of the time series.
//
// This member is required.
TimeSeriesId *string
// The date that the time series was last updated, in Unix epoch time.
//
// This member is required.
TimeSeriesLastUpdateDate *time.Time
// The alias that identifies the time series.
Alias *string
// The ID of the asset in which the asset property was created.
AssetId *string
// The data type of the structure for this time series. This parameter is required
// for time series that have the STRUCT data type. The options for this parameter
// depend on the type of the composite model in which you created the asset
// property that is associated with your time series. Use AWS/ALARM_STATE for
// alarm state in alarm composite models.
DataTypeSpec *string
// The ID of the asset property, in UUID format.
PropertyId *string
noSmithyDocumentSerde
}
// Contains an asset transform property. A transform is a one-to-one mapping of a
// property's data points from one form to another. For example, you can use a
// transform to convert a Celsius data stream to Fahrenheit by applying the
// transformation expression to each data point of the Celsius stream. A transform
// can only have a data type of DOUBLE and consume properties with data types of
// INTEGER or DOUBLE . For more information, see Transforms (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#transforms)
// in the IoT SiteWise User Guide.
type Transform struct {
// 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html)
// in the IoT SiteWise User Guide.
//
// This member is required.
Expression *string
// The list of variables used in the expression.
//
// This member is required.
Variables []ExpressionVariable
// The processing configuration for the given transform property. You can
// configure transforms to be kept at the edge or forwarded to the Amazon Web
// Services Cloud. You can also configure transforms to be computed at the edge or
// in the cloud.
ProcessingConfig *TransformProcessingConfig
noSmithyDocumentSerde
}
// The processing configuration for the given transform property. You can
// configure transforms to be kept at the edge or forwarded to the Amazon Web
// Services Cloud. You can also configure transforms to be computed at the edge or
// in the cloud.
type TransformProcessingConfig struct {
// The compute location for the given transform property.
//
// This member is required.
ComputeLocation ComputeLocation
// The forwarding configuration for a given property.
ForwardingConfig *ForwardingConfig
noSmithyDocumentSerde
}
// Contains a tumbling window, which is a repeating fixed-sized, non-overlapping,
// and contiguous time window. You can use this window in metrics to aggregate data
// from properties and other assets. You can use m , h , d , and w when you
// specify an interval or offset. Note that m represents minutes, h represents
// hours, d represents days, and w represents weeks. You can also use s to
// represent seconds in offset . The interval and offset parameters support the
// ISO 8601 format (https://en.wikipedia.org/wiki/ISO_8601) . For example, PT5S
// represents 5 seconds, PT5M represents 5 minutes, and PT5H represents 5 hours.
type TumblingWindow struct {
// The time interval for the tumbling window. The interval time must be between 1
// minute and 1 week. 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 IoT SiteWise
// aggregates data points for metric computations, the start of each interval is
// exclusive and the end of each interval is inclusive. IoT SiteWise places the
// computed data point at the end of the interval.
//
// This member is required.
Interval *string
// The offset for the tumbling window. The offset parameter accepts the following:
// - The offset time. For example, if you specify 18h for offset and 1d for
// interval , IoT SiteWise aggregates data in one of the following ways:
// - If you create the metric before or at 6 PM (UTC), you get the first
// aggregation result at 6 PM (UTC) on the day when you create the metric.
// - If you create the metric after 6 PM (UTC), you get the first aggregation
// result at 6 PM (UTC) the next day.
// - The ISO 8601 format. For example, if you specify PT18H for offset and 1d for
// interval , IoT SiteWise aggregates data in one of the following ways:
// - If you create the metric before or at 6 PM (UTC), you get the first
// aggregation result at 6 PM (UTC) on the day when you create the metric.
// - If you create the metric after 6 PM (UTC), you get the first aggregation
// result at 6 PM (UTC) the next day.
// - The 24-hour clock. For example, if you specify 00:03:00 for offset , 5m for
// interval , and you create the metric at 2 PM (UTC), you get the first
// aggregation result at 2:03 PM (UTC). You get the second aggregation result at
// 2:08 PM (UTC).
// - The offset time zone. For example, if you specify 2021-07-23T18:00-08 for
// offset and 1d for interval , IoT SiteWise aggregates data in one of the
// following ways:
// - If you create the metric before or at 6 PM (PST), you get the first
// aggregation result at 6 PM (PST) on the day when you create the metric.
// - If you create the metric after 6 PM (PST), you get the first aggregation
// result at 6 PM (PST) the next day.
Offset *string
noSmithyDocumentSerde
}
// Contains information for a user identity in an access policy.
type UserIdentity struct {
// The IAM Identity Center ID of the user.
//
// This member is required.
Id *string
noSmithyDocumentSerde
}
// Identifies a property value used in an expression.
type VariableValue struct {
// The ID of the hierarchy to query for the property ID. You can use the
// hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external
// ID, you can specify externalId: followed by the external ID. For more
// information, see Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide. 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 (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html)
// in the IoT SiteWise User Guide.
HierarchyId *string
// The ID of the property to use as the variable. You can use the property name if
// it's from the same asset model. If the property has an external ID, you can
// specify externalId: followed by the external ID. For more information, see
// Using external IDs (https://docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids)
// in the IoT SiteWise User Guide.
PropertyId *string
// The path of the property.
PropertyPath []AssetModelPropertyPathSegment
noSmithyDocumentSerde
}
// Contains an asset property value (of a single type only).
type Variant struct {
// Asset property data of type Boolean (true or false).
BooleanValue *bool
// Asset property data of type double (floating point number).
DoubleValue *float64
// Asset property data of type integer (number that's greater than or equal to
// zero).
IntegerValue *int32
// Asset property data of type string (sequence of characters).
StringValue *string
noSmithyDocumentSerde
}
// Set this period to specify how long your data is stored in the warm tier before
// it is deleted. You can set this only if cold tier is enabled.
type WarmTierRetentionPeriod struct {
// The number of days the data is stored in the warm tier.
NumberOfDays *int32
// If set to true, the data is stored indefinitely in the warm tier.
Unlimited *bool
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|