iot.d.ts
308 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class Iot extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Iot.Types.ClientConfiguration)
config: Config & Iot.Types.ClientConfiguration;
/**
* Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
*/
acceptCertificateTransfer(params: Iot.Types.AcceptCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Accepts a pending certificate transfer. The default state of the certificate is INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates.
*/
acceptCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds a thing to a billing group.
*/
addThingToBillingGroup(params: Iot.Types.AddThingToBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
/**
* Adds a thing to a billing group.
*/
addThingToBillingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToBillingGroupResponse) => void): Request<Iot.Types.AddThingToBillingGroupResponse, AWSError>;
/**
* Adds a thing to a thing group.
*/
addThingToThingGroup(params: Iot.Types.AddThingToThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
/**
* Adds a thing to a thing group.
*/
addThingToThingGroup(callback?: (err: AWSError, data: Iot.Types.AddThingToThingGroupResponse) => void): Request<Iot.Types.AddThingToThingGroupResponse, AWSError>;
/**
* Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100.
*/
associateTargetsWithJob(params: Iot.Types.AssociateTargetsWithJobRequest, callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
/**
* Associates a group with a continuous job. The following criteria must be met: The job must have been created with the targetSelection field set to "CONTINUOUS". The job status must currently be "IN_PROGRESS". The total number of targets associated with a job must not exceed 100.
*/
associateTargetsWithJob(callback?: (err: AWSError, data: Iot.Types.AssociateTargetsWithJobResponse) => void): Request<Iot.Types.AssociateTargetsWithJobResponse, AWSError>;
/**
* Attaches a policy to the specified target.
*/
attachPolicy(params: Iot.Types.AttachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches a policy to the specified target.
*/
attachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead.
*/
attachPrincipalPolicy(params: Iot.Types.AttachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attaches the specified policy to the specified principal (certificate or other credential). Note: This API is deprecated. Please use AttachPolicy instead.
*/
attachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
*/
attachSecurityProfile(params: Iot.Types.AttachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
/**
* Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.
*/
attachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.AttachSecurityProfileResponse) => void): Request<Iot.Types.AttachSecurityProfileResponse, AWSError>;
/**
* Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
attachThingPrincipal(params: Iot.Types.AttachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
/**
* Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
attachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.AttachThingPrincipalResponse) => void): Request<Iot.Types.AttachThingPrincipalResponse, AWSError>;
/**
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
*/
cancelAuditMitigationActionsTask(params: Iot.Types.CancelAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
/**
* Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.
*/
cancelAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.CancelAuditMitigationActionsTaskResponse, AWSError>;
/**
* Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
*/
cancelAuditTask(params: Iot.Types.CancelAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
/**
* Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an "InvalidRequestException" occurs.
*/
cancelAuditTask(callback?: (err: AWSError, data: Iot.Types.CancelAuditTaskResponse) => void): Request<Iot.Types.CancelAuditTaskResponse, AWSError>;
/**
* Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
*/
cancelCertificateTransfer(params: Iot.Types.CancelCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels a pending transfer for the specified certificate. Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled. After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.
*/
cancelCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels a job.
*/
cancelJob(params: Iot.Types.CancelJobRequest, callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
/**
* Cancels a job.
*/
cancelJob(callback?: (err: AWSError, data: Iot.Types.CancelJobResponse) => void): Request<Iot.Types.CancelJobResponse, AWSError>;
/**
* Cancels the execution of a job for a given thing.
*/
cancelJobExecution(params: Iot.Types.CancelJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Cancels the execution of a job for a given thing.
*/
cancelJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Clears the default authorizer.
*/
clearDefaultAuthorizer(params: Iot.Types.ClearDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
/**
* Clears the default authorizer.
*/
clearDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.ClearDefaultAuthorizerResponse) => void): Request<Iot.Types.ClearDefaultAuthorizerResponse, AWSError>;
/**
* Creates an authorizer.
*/
createAuthorizer(params: Iot.Types.CreateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
/**
* Creates an authorizer.
*/
createAuthorizer(callback?: (err: AWSError, data: Iot.Types.CreateAuthorizerResponse) => void): Request<Iot.Types.CreateAuthorizerResponse, AWSError>;
/**
* Creates a billing group.
*/
createBillingGroup(params: Iot.Types.CreateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
/**
* Creates a billing group.
*/
createBillingGroup(callback?: (err: AWSError, data: Iot.Types.CreateBillingGroupResponse) => void): Request<Iot.Types.CreateBillingGroupResponse, AWSError>;
/**
* Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*/
createCertificateFromCsr(params: Iot.Types.CreateCertificateFromCsrRequest, callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
/**
* Creates an X.509 certificate using the specified certificate signing request. Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. Note: Reusing the same certificate signing request (CSR) results in a distinct certificate. You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs. Assuming a set of CSRs are located inside of the directory my-csr-directory: On Linux and OS X, the command is: $ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR. The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process: $ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{} On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is: > ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_} On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is: > forfiles /p my-csr-directory /c "cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path"
*/
createCertificateFromCsr(callback?: (err: AWSError, data: Iot.Types.CreateCertificateFromCsrResponse) => void): Request<Iot.Types.CreateCertificateFromCsrResponse, AWSError>;
/**
* Creates a dynamic thing group.
*/
createDynamicThingGroup(params: Iot.Types.CreateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
/**
* Creates a dynamic thing group.
*/
createDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateDynamicThingGroupResponse) => void): Request<Iot.Types.CreateDynamicThingGroupResponse, AWSError>;
/**
* Creates a job.
*/
createJob(params: Iot.Types.CreateJobRequest, callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
/**
* Creates a job.
*/
createJob(callback?: (err: AWSError, data: Iot.Types.CreateJobResponse) => void): Request<Iot.Types.CreateJobResponse, AWSError>;
/**
* Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
*/
createKeysAndCertificate(params: Iot.Types.CreateKeysAndCertificateRequest, callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
/**
* Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.
*/
createKeysAndCertificate(callback?: (err: AWSError, data: Iot.Types.CreateKeysAndCertificateResponse) => void): Request<Iot.Types.CreateKeysAndCertificateResponse, AWSError>;
/**
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.
*/
createMitigationAction(params: Iot.Types.CreateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
/**
* Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.
*/
createMitigationAction(callback?: (err: AWSError, data: Iot.Types.CreateMitigationActionResponse) => void): Request<Iot.Types.CreateMitigationActionResponse, AWSError>;
/**
* Creates an AWS IoT OTAUpdate on a target group of things or groups.
*/
createOTAUpdate(params: Iot.Types.CreateOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
/**
* Creates an AWS IoT OTAUpdate on a target group of things or groups.
*/
createOTAUpdate(callback?: (err: AWSError, data: Iot.Types.CreateOTAUpdateResponse) => void): Request<Iot.Types.CreateOTAUpdateResponse, AWSError>;
/**
* Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
*/
createPolicy(params: Iot.Types.CreatePolicyRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
/**
* Creates an AWS IoT policy. The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.
*/
createPolicy(callback?: (err: AWSError, data: Iot.Types.CreatePolicyResponse) => void): Request<Iot.Types.CreatePolicyResponse, AWSError>;
/**
* Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
*/
createPolicyVersion(params: Iot.Types.CreatePolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
/**
* Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one. Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
*/
createPolicyVersion(callback?: (err: AWSError, data: Iot.Types.CreatePolicyVersionResponse) => void): Request<Iot.Types.CreatePolicyVersionResponse, AWSError>;
/**
* Creates a role alias.
*/
createRoleAlias(params: Iot.Types.CreateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
/**
* Creates a role alias.
*/
createRoleAlias(callback?: (err: AWSError, data: Iot.Types.CreateRoleAliasResponse) => void): Request<Iot.Types.CreateRoleAliasResponse, AWSError>;
/**
* Creates a scheduled audit that is run at a specified time interval.
*/
createScheduledAudit(params: Iot.Types.CreateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
/**
* Creates a scheduled audit that is run at a specified time interval.
*/
createScheduledAudit(callback?: (err: AWSError, data: Iot.Types.CreateScheduledAuditResponse) => void): Request<Iot.Types.CreateScheduledAuditResponse, AWSError>;
/**
* Creates a Device Defender security profile.
*/
createSecurityProfile(params: Iot.Types.CreateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
/**
* Creates a Device Defender security profile.
*/
createSecurityProfile(callback?: (err: AWSError, data: Iot.Types.CreateSecurityProfileResponse) => void): Request<Iot.Types.CreateSecurityProfileResponse, AWSError>;
/**
* Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
*/
createStream(params: Iot.Types.CreateStreamRequest, callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
/**
* Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.
*/
createStream(callback?: (err: AWSError, data: Iot.Types.CreateStreamResponse) => void): Request<Iot.Types.CreateStreamResponse, AWSError>;
/**
* Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions.
*/
createThing(params: Iot.Types.CreateThingRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
/**
* Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown. This is a control plane operation. See Authorization for information about authorizing control plane actions.
*/
createThing(callback?: (err: AWSError, data: Iot.Types.CreateThingResponse) => void): Request<Iot.Types.CreateThingResponse, AWSError>;
/**
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
*/
createThingGroup(params: Iot.Types.CreateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
/**
* Create a thing group. This is a control plane operation. See Authorization for information about authorizing control plane actions.
*/
createThingGroup(callback?: (err: AWSError, data: Iot.Types.CreateThingGroupResponse) => void): Request<Iot.Types.CreateThingGroupResponse, AWSError>;
/**
* Creates a new thing type.
*/
createThingType(params: Iot.Types.CreateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
/**
* Creates a new thing type.
*/
createThingType(callback?: (err: AWSError, data: Iot.Types.CreateThingTypeResponse) => void): Request<Iot.Types.CreateThingTypeResponse, AWSError>;
/**
* Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
*/
createTopicRule(params: Iot.Types.CreateTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
*/
createTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
*/
deleteAccountAuditConfiguration(params: Iot.Types.DeleteAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
/**
* Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.
*/
deleteAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DeleteAccountAuditConfigurationResponse) => void): Request<Iot.Types.DeleteAccountAuditConfigurationResponse, AWSError>;
/**
* Deletes an authorizer.
*/
deleteAuthorizer(params: Iot.Types.DeleteAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
/**
* Deletes an authorizer.
*/
deleteAuthorizer(callback?: (err: AWSError, data: Iot.Types.DeleteAuthorizerResponse) => void): Request<Iot.Types.DeleteAuthorizerResponse, AWSError>;
/**
* Deletes the billing group.
*/
deleteBillingGroup(params: Iot.Types.DeleteBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
/**
* Deletes the billing group.
*/
deleteBillingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteBillingGroupResponse) => void): Request<Iot.Types.DeleteBillingGroupResponse, AWSError>;
/**
* Deletes a registered CA certificate.
*/
deleteCACertificate(params: Iot.Types.DeleteCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
/**
* Deletes a registered CA certificate.
*/
deleteCACertificate(callback?: (err: AWSError, data: Iot.Types.DeleteCACertificateResponse) => void): Request<Iot.Types.DeleteCACertificateResponse, AWSError>;
/**
* Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
*/
deleteCertificate(params: Iot.Types.DeleteCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified certificate. A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.
*/
deleteCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a dynamic thing group.
*/
deleteDynamicThingGroup(params: Iot.Types.DeleteDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
/**
* Deletes a dynamic thing group.
*/
deleteDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteDynamicThingGroupResponse) => void): Request<Iot.Types.DeleteDynamicThingGroupResponse, AWSError>;
/**
* Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
*/
deleteJob(params: Iot.Types.DeleteJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a job and its related job executions. Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Attempting to delete or cancel a job whose status is already "DELETION_IN_PROGRESS" will result in an error. Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time, or a LimitExceededException will occur.
*/
deleteJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a job execution.
*/
deleteJobExecution(params: Iot.Types.DeleteJobExecutionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a job execution.
*/
deleteJobExecution(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a defined mitigation action from your AWS account.
*/
deleteMitigationAction(params: Iot.Types.DeleteMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
/**
* Deletes a defined mitigation action from your AWS account.
*/
deleteMitigationAction(callback?: (err: AWSError, data: Iot.Types.DeleteMitigationActionResponse) => void): Request<Iot.Types.DeleteMitigationActionResponse, AWSError>;
/**
* Delete an OTA update.
*/
deleteOTAUpdate(params: Iot.Types.DeleteOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
/**
* Delete an OTA update.
*/
deleteOTAUpdate(callback?: (err: AWSError, data: Iot.Types.DeleteOTAUpdateResponse) => void): Request<Iot.Types.DeleteOTAUpdateResponse, AWSError>;
/**
* Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it.
*/
deletePolicy(params: Iot.Types.DeletePolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified policy. A policy cannot be deleted if it has non-default versions or it is attached to any certificate. To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy. When a policy is deleted using DeletePolicy, its default version is deleted with it.
*/
deletePolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
*/
deletePolicyVersion(params: Iot.Types.DeletePolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.
*/
deletePolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a CA certificate registration code.
*/
deleteRegistrationCode(params: Iot.Types.DeleteRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
/**
* Deletes a CA certificate registration code.
*/
deleteRegistrationCode(callback?: (err: AWSError, data: Iot.Types.DeleteRegistrationCodeResponse) => void): Request<Iot.Types.DeleteRegistrationCodeResponse, AWSError>;
/**
* Deletes a role alias
*/
deleteRoleAlias(params: Iot.Types.DeleteRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
/**
* Deletes a role alias
*/
deleteRoleAlias(callback?: (err: AWSError, data: Iot.Types.DeleteRoleAliasResponse) => void): Request<Iot.Types.DeleteRoleAliasResponse, AWSError>;
/**
* Deletes a scheduled audit.
*/
deleteScheduledAudit(params: Iot.Types.DeleteScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
/**
* Deletes a scheduled audit.
*/
deleteScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DeleteScheduledAuditResponse) => void): Request<Iot.Types.DeleteScheduledAuditResponse, AWSError>;
/**
* Deletes a Device Defender security profile.
*/
deleteSecurityProfile(params: Iot.Types.DeleteSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
/**
* Deletes a Device Defender security profile.
*/
deleteSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DeleteSecurityProfileResponse) => void): Request<Iot.Types.DeleteSecurityProfileResponse, AWSError>;
/**
* Deletes a stream.
*/
deleteStream(params: Iot.Types.DeleteStreamRequest, callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
/**
* Deletes a stream.
*/
deleteStream(callback?: (err: AWSError, data: Iot.Types.DeleteStreamResponse) => void): Request<Iot.Types.DeleteStreamResponse, AWSError>;
/**
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
*/
deleteThing(params: Iot.Types.DeleteThingRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
/**
* Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.
*/
deleteThing(callback?: (err: AWSError, data: Iot.Types.DeleteThingResponse) => void): Request<Iot.Types.DeleteThingResponse, AWSError>;
/**
* Deletes a thing group.
*/
deleteThingGroup(params: Iot.Types.DeleteThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
/**
* Deletes a thing group.
*/
deleteThingGroup(callback?: (err: AWSError, data: Iot.Types.DeleteThingGroupResponse) => void): Request<Iot.Types.DeleteThingGroupResponse, AWSError>;
/**
* Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
*/
deleteThingType(params: Iot.Types.DeleteThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
/**
* Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.
*/
deleteThingType(callback?: (err: AWSError, data: Iot.Types.DeleteThingTypeResponse) => void): Request<Iot.Types.DeleteThingTypeResponse, AWSError>;
/**
* Deletes the rule.
*/
deleteTopicRule(params: Iot.Types.DeleteTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the rule.
*/
deleteTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a logging level.
*/
deleteV2LoggingLevel(params: Iot.Types.DeleteV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a logging level.
*/
deleteV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deprecates a thing type. You can not associate new things with deprecated thing type.
*/
deprecateThingType(params: Iot.Types.DeprecateThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
/**
* Deprecates a thing type. You can not associate new things with deprecated thing type.
*/
deprecateThingType(callback?: (err: AWSError, data: Iot.Types.DeprecateThingTypeResponse) => void): Request<Iot.Types.DeprecateThingTypeResponse, AWSError>;
/**
* Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
*/
describeAccountAuditConfiguration(params: Iot.Types.DescribeAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
/**
* Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
*/
describeAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.DescribeAccountAuditConfigurationResponse) => void): Request<Iot.Types.DescribeAccountAuditConfigurationResponse, AWSError>;
/**
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
*/
describeAuditFinding(params: Iot.Types.DescribeAuditFindingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
/**
* Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.
*/
describeAuditFinding(callback?: (err: AWSError, data: Iot.Types.DescribeAuditFindingResponse) => void): Request<Iot.Types.DescribeAuditFindingResponse, AWSError>;
/**
* Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
*/
describeAuditMitigationActionsTask(params: Iot.Types.DescribeAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeAuditMitigationActionsTaskResponse, AWSError>;
/**
* Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.
*/
describeAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.DescribeAuditMitigationActionsTaskResponse, AWSError>;
/**
* Gets information about a Device Defender audit.
*/
describeAuditTask(params: Iot.Types.DescribeAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
/**
* Gets information about a Device Defender audit.
*/
describeAuditTask(callback?: (err: AWSError, data: Iot.Types.DescribeAuditTaskResponse) => void): Request<Iot.Types.DescribeAuditTaskResponse, AWSError>;
/**
* Describes an authorizer.
*/
describeAuthorizer(params: Iot.Types.DescribeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
/**
* Describes an authorizer.
*/
describeAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeAuthorizerResponse) => void): Request<Iot.Types.DescribeAuthorizerResponse, AWSError>;
/**
* Returns information about a billing group.
*/
describeBillingGroup(params: Iot.Types.DescribeBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
/**
* Returns information about a billing group.
*/
describeBillingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeBillingGroupResponse) => void): Request<Iot.Types.DescribeBillingGroupResponse, AWSError>;
/**
* Describes a registered CA certificate.
*/
describeCACertificate(params: Iot.Types.DescribeCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
/**
* Describes a registered CA certificate.
*/
describeCACertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCACertificateResponse) => void): Request<Iot.Types.DescribeCACertificateResponse, AWSError>;
/**
* Gets information about the specified certificate.
*/
describeCertificate(params: Iot.Types.DescribeCertificateRequest, callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
/**
* Gets information about the specified certificate.
*/
describeCertificate(callback?: (err: AWSError, data: Iot.Types.DescribeCertificateResponse) => void): Request<Iot.Types.DescribeCertificateResponse, AWSError>;
/**
* Describes the default authorizer.
*/
describeDefaultAuthorizer(params: Iot.Types.DescribeDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
/**
* Describes the default authorizer.
*/
describeDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.DescribeDefaultAuthorizerResponse) => void): Request<Iot.Types.DescribeDefaultAuthorizerResponse, AWSError>;
/**
* Returns a unique endpoint specific to the AWS account making the call.
*/
describeEndpoint(params: Iot.Types.DescribeEndpointRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
/**
* Returns a unique endpoint specific to the AWS account making the call.
*/
describeEndpoint(callback?: (err: AWSError, data: Iot.Types.DescribeEndpointResponse) => void): Request<Iot.Types.DescribeEndpointResponse, AWSError>;
/**
* Describes event configurations.
*/
describeEventConfigurations(params: Iot.Types.DescribeEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
/**
* Describes event configurations.
*/
describeEventConfigurations(callback?: (err: AWSError, data: Iot.Types.DescribeEventConfigurationsResponse) => void): Request<Iot.Types.DescribeEventConfigurationsResponse, AWSError>;
/**
* Describes a search index.
*/
describeIndex(params: Iot.Types.DescribeIndexRequest, callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
/**
* Describes a search index.
*/
describeIndex(callback?: (err: AWSError, data: Iot.Types.DescribeIndexResponse) => void): Request<Iot.Types.DescribeIndexResponse, AWSError>;
/**
* Describes a job.
*/
describeJob(params: Iot.Types.DescribeJobRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
/**
* Describes a job.
*/
describeJob(callback?: (err: AWSError, data: Iot.Types.DescribeJobResponse) => void): Request<Iot.Types.DescribeJobResponse, AWSError>;
/**
* Describes a job execution.
*/
describeJobExecution(params: Iot.Types.DescribeJobExecutionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
/**
* Describes a job execution.
*/
describeJobExecution(callback?: (err: AWSError, data: Iot.Types.DescribeJobExecutionResponse) => void): Request<Iot.Types.DescribeJobExecutionResponse, AWSError>;
/**
* Gets information about a mitigation action.
*/
describeMitigationAction(params: Iot.Types.DescribeMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
/**
* Gets information about a mitigation action.
*/
describeMitigationAction(callback?: (err: AWSError, data: Iot.Types.DescribeMitigationActionResponse) => void): Request<Iot.Types.DescribeMitigationActionResponse, AWSError>;
/**
* Describes a role alias.
*/
describeRoleAlias(params: Iot.Types.DescribeRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
/**
* Describes a role alias.
*/
describeRoleAlias(callback?: (err: AWSError, data: Iot.Types.DescribeRoleAliasResponse) => void): Request<Iot.Types.DescribeRoleAliasResponse, AWSError>;
/**
* Gets information about a scheduled audit.
*/
describeScheduledAudit(params: Iot.Types.DescribeScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
/**
* Gets information about a scheduled audit.
*/
describeScheduledAudit(callback?: (err: AWSError, data: Iot.Types.DescribeScheduledAuditResponse) => void): Request<Iot.Types.DescribeScheduledAuditResponse, AWSError>;
/**
* Gets information about a Device Defender security profile.
*/
describeSecurityProfile(params: Iot.Types.DescribeSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
/**
* Gets information about a Device Defender security profile.
*/
describeSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DescribeSecurityProfileResponse) => void): Request<Iot.Types.DescribeSecurityProfileResponse, AWSError>;
/**
* Gets information about a stream.
*/
describeStream(params: Iot.Types.DescribeStreamRequest, callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
/**
* Gets information about a stream.
*/
describeStream(callback?: (err: AWSError, data: Iot.Types.DescribeStreamResponse) => void): Request<Iot.Types.DescribeStreamResponse, AWSError>;
/**
* Gets information about the specified thing.
*/
describeThing(params: Iot.Types.DescribeThingRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
/**
* Gets information about the specified thing.
*/
describeThing(callback?: (err: AWSError, data: Iot.Types.DescribeThingResponse) => void): Request<Iot.Types.DescribeThingResponse, AWSError>;
/**
* Describe a thing group.
*/
describeThingGroup(params: Iot.Types.DescribeThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
/**
* Describe a thing group.
*/
describeThingGroup(callback?: (err: AWSError, data: Iot.Types.DescribeThingGroupResponse) => void): Request<Iot.Types.DescribeThingGroupResponse, AWSError>;
/**
* Describes a bulk thing provisioning task.
*/
describeThingRegistrationTask(params: Iot.Types.DescribeThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
/**
* Describes a bulk thing provisioning task.
*/
describeThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.DescribeThingRegistrationTaskResponse) => void): Request<Iot.Types.DescribeThingRegistrationTaskResponse, AWSError>;
/**
* Gets information about the specified thing type.
*/
describeThingType(params: Iot.Types.DescribeThingTypeRequest, callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
/**
* Gets information about the specified thing type.
*/
describeThingType(callback?: (err: AWSError, data: Iot.Types.DescribeThingTypeResponse) => void): Request<Iot.Types.DescribeThingTypeResponse, AWSError>;
/**
* Detaches a policy from the specified target.
*/
detachPolicy(params: Iot.Types.DetachPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Detaches a policy from the specified target.
*/
detachPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead.
*/
detachPrincipalPolicy(params: Iot.Types.DetachPrincipalPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified policy from the specified certificate. Note: This API is deprecated. Please use DetachPolicy instead.
*/
detachPrincipalPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates a Device Defender security profile from a thing group or from this account.
*/
detachSecurityProfile(params: Iot.Types.DetachSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
/**
* Disassociates a Device Defender security profile from a thing group or from this account.
*/
detachSecurityProfile(callback?: (err: AWSError, data: Iot.Types.DetachSecurityProfileResponse) => void): Request<Iot.Types.DetachSecurityProfileResponse, AWSError>;
/**
* Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate.
*/
detachThingPrincipal(params: Iot.Types.DetachThingPrincipalRequest, callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
/**
* Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities. This call is asynchronous. It might take several seconds for the detachment to propagate.
*/
detachThingPrincipal(callback?: (err: AWSError, data: Iot.Types.DetachThingPrincipalResponse) => void): Request<Iot.Types.DetachThingPrincipalResponse, AWSError>;
/**
* Disables the rule.
*/
disableTopicRule(params: Iot.Types.DisableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disables the rule.
*/
disableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables the rule.
*/
enableTopicRule(params: Iot.Types.EnableTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables the rule.
*/
enableTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns the number of things with distinct values for the aggregation field.
*/
getCardinality(params: Iot.Types.GetCardinalityRequest, callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
/**
* Returns the number of things with distinct values for the aggregation field.
*/
getCardinality(callback?: (err: AWSError, data: Iot.Types.GetCardinalityResponse) => void): Request<Iot.Types.GetCardinalityResponse, AWSError>;
/**
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
*/
getEffectivePolicies(params: Iot.Types.GetEffectivePoliciesRequest, callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
/**
* Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.
*/
getEffectivePolicies(callback?: (err: AWSError, data: Iot.Types.GetEffectivePoliciesResponse) => void): Request<Iot.Types.GetEffectivePoliciesResponse, AWSError>;
/**
* Gets the search configuration.
*/
getIndexingConfiguration(params: Iot.Types.GetIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
/**
* Gets the search configuration.
*/
getIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.GetIndexingConfigurationResponse) => void): Request<Iot.Types.GetIndexingConfigurationResponse, AWSError>;
/**
* Gets a job document.
*/
getJobDocument(params: Iot.Types.GetJobDocumentRequest, callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
/**
* Gets a job document.
*/
getJobDocument(callback?: (err: AWSError, data: Iot.Types.GetJobDocumentResponse) => void): Request<Iot.Types.GetJobDocumentResponse, AWSError>;
/**
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
*/
getLoggingOptions(params: Iot.Types.GetLoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
/**
* Gets the logging options. NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.
*/
getLoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetLoggingOptionsResponse) => void): Request<Iot.Types.GetLoggingOptionsResponse, AWSError>;
/**
* Gets an OTA update.
*/
getOTAUpdate(params: Iot.Types.GetOTAUpdateRequest, callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
/**
* Gets an OTA update.
*/
getOTAUpdate(callback?: (err: AWSError, data: Iot.Types.GetOTAUpdateResponse) => void): Request<Iot.Types.GetOTAUpdateResponse, AWSError>;
/**
* Returns the percentile values for the aggregation field. The results from GetPercentiles is an approximation. The default percentile groupings are: 1,5,25,50,75,95,99. You can specify custom percentile grouping using the percents argument to the GetPercentiles API.
*/
getPercentiles(params: Iot.Types.GetPercentilesRequest, callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
/**
* Returns the percentile values for the aggregation field. The results from GetPercentiles is an approximation. The default percentile groupings are: 1,5,25,50,75,95,99. You can specify custom percentile grouping using the percents argument to the GetPercentiles API.
*/
getPercentiles(callback?: (err: AWSError, data: Iot.Types.GetPercentilesResponse) => void): Request<Iot.Types.GetPercentilesResponse, AWSError>;
/**
* Gets information about the specified policy with the policy document of the default version.
*/
getPolicy(params: Iot.Types.GetPolicyRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
/**
* Gets information about the specified policy with the policy document of the default version.
*/
getPolicy(callback?: (err: AWSError, data: Iot.Types.GetPolicyResponse) => void): Request<Iot.Types.GetPolicyResponse, AWSError>;
/**
* Gets information about the specified policy version.
*/
getPolicyVersion(params: Iot.Types.GetPolicyVersionRequest, callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
/**
* Gets information about the specified policy version.
*/
getPolicyVersion(callback?: (err: AWSError, data: Iot.Types.GetPolicyVersionResponse) => void): Request<Iot.Types.GetPolicyVersionResponse, AWSError>;
/**
* Gets a registration code used to register a CA certificate with AWS IoT.
*/
getRegistrationCode(params: Iot.Types.GetRegistrationCodeRequest, callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
/**
* Gets a registration code used to register a CA certificate with AWS IoT.
*/
getRegistrationCode(callback?: (err: AWSError, data: Iot.Types.GetRegistrationCodeResponse) => void): Request<Iot.Types.GetRegistrationCodeResponse, AWSError>;
/**
* Gets statistics returns the count, average, sum, minimum, maximum, sumOfSquares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.
*/
getStatistics(params: Iot.Types.GetStatisticsRequest, callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
/**
* Gets statistics returns the count, average, sum, minimum, maximum, sumOfSquares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.
*/
getStatistics(callback?: (err: AWSError, data: Iot.Types.GetStatisticsResponse) => void): Request<Iot.Types.GetStatisticsResponse, AWSError>;
/**
* Gets information about the rule.
*/
getTopicRule(params: Iot.Types.GetTopicRuleRequest, callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
/**
* Gets information about the rule.
*/
getTopicRule(callback?: (err: AWSError, data: Iot.Types.GetTopicRuleResponse) => void): Request<Iot.Types.GetTopicRuleResponse, AWSError>;
/**
* Gets the fine grained logging options.
*/
getV2LoggingOptions(params: Iot.Types.GetV2LoggingOptionsRequest, callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
/**
* Gets the fine grained logging options.
*/
getV2LoggingOptions(callback?: (err: AWSError, data: Iot.Types.GetV2LoggingOptionsResponse) => void): Request<Iot.Types.GetV2LoggingOptionsResponse, AWSError>;
/**
* Lists the active violations for a given Device Defender security profile.
*/
listActiveViolations(params: Iot.Types.ListActiveViolationsRequest, callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
/**
* Lists the active violations for a given Device Defender security profile.
*/
listActiveViolations(callback?: (err: AWSError, data: Iot.Types.ListActiveViolationsResponse) => void): Request<Iot.Types.ListActiveViolationsResponse, AWSError>;
/**
* Lists the policies attached to the specified thing group.
*/
listAttachedPolicies(params: Iot.Types.ListAttachedPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
/**
* Lists the policies attached to the specified thing group.
*/
listAttachedPolicies(callback?: (err: AWSError, data: Iot.Types.ListAttachedPoliciesResponse) => void): Request<Iot.Types.ListAttachedPoliciesResponse, AWSError>;
/**
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
*/
listAuditFindings(params: Iot.Types.ListAuditFindingsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
/**
* Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)
*/
listAuditFindings(callback?: (err: AWSError, data: Iot.Types.ListAuditFindingsResponse) => void): Request<Iot.Types.ListAuditFindingsResponse, AWSError>;
/**
* Gets the status of audit mitigation action tasks that were executed.
*/
listAuditMitigationActionsExecutions(params: Iot.Types.ListAuditMitigationActionsExecutionsRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
/**
* Gets the status of audit mitigation action tasks that were executed.
*/
listAuditMitigationActionsExecutions(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsExecutionsResponse) => void): Request<Iot.Types.ListAuditMitigationActionsExecutionsResponse, AWSError>;
/**
* Gets a list of audit mitigation action tasks that match the specified filters.
*/
listAuditMitigationActionsTasks(params: Iot.Types.ListAuditMitigationActionsTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
/**
* Gets a list of audit mitigation action tasks that match the specified filters.
*/
listAuditMitigationActionsTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditMitigationActionsTasksResponse) => void): Request<Iot.Types.ListAuditMitigationActionsTasksResponse, AWSError>;
/**
* Lists the Device Defender audits that have been performed during a given time period.
*/
listAuditTasks(params: Iot.Types.ListAuditTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
/**
* Lists the Device Defender audits that have been performed during a given time period.
*/
listAuditTasks(callback?: (err: AWSError, data: Iot.Types.ListAuditTasksResponse) => void): Request<Iot.Types.ListAuditTasksResponse, AWSError>;
/**
* Lists the authorizers registered in your account.
*/
listAuthorizers(params: Iot.Types.ListAuthorizersRequest, callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
/**
* Lists the authorizers registered in your account.
*/
listAuthorizers(callback?: (err: AWSError, data: Iot.Types.ListAuthorizersResponse) => void): Request<Iot.Types.ListAuthorizersResponse, AWSError>;
/**
* Lists the billing groups you have created.
*/
listBillingGroups(params: Iot.Types.ListBillingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
/**
* Lists the billing groups you have created.
*/
listBillingGroups(callback?: (err: AWSError, data: Iot.Types.ListBillingGroupsResponse) => void): Request<Iot.Types.ListBillingGroupsResponse, AWSError>;
/**
* Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
*/
listCACertificates(params: Iot.Types.ListCACertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
/**
* Lists the CA certificates registered for your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
*/
listCACertificates(callback?: (err: AWSError, data: Iot.Types.ListCACertificatesResponse) => void): Request<Iot.Types.ListCACertificatesResponse, AWSError>;
/**
* Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
*/
listCertificates(params: Iot.Types.ListCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
/**
* Lists the certificates registered in your AWS account. The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.
*/
listCertificates(callback?: (err: AWSError, data: Iot.Types.ListCertificatesResponse) => void): Request<Iot.Types.ListCertificatesResponse, AWSError>;
/**
* List the device certificates signed by the specified CA certificate.
*/
listCertificatesByCA(params: Iot.Types.ListCertificatesByCARequest, callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
/**
* List the device certificates signed by the specified CA certificate.
*/
listCertificatesByCA(callback?: (err: AWSError, data: Iot.Types.ListCertificatesByCAResponse) => void): Request<Iot.Types.ListCertificatesByCAResponse, AWSError>;
/**
* Lists the search indices.
*/
listIndices(params: Iot.Types.ListIndicesRequest, callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
/**
* Lists the search indices.
*/
listIndices(callback?: (err: AWSError, data: Iot.Types.ListIndicesResponse) => void): Request<Iot.Types.ListIndicesResponse, AWSError>;
/**
* Lists the job executions for a job.
*/
listJobExecutionsForJob(params: Iot.Types.ListJobExecutionsForJobRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
/**
* Lists the job executions for a job.
*/
listJobExecutionsForJob(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForJobResponse) => void): Request<Iot.Types.ListJobExecutionsForJobResponse, AWSError>;
/**
* Lists the job executions for the specified thing.
*/
listJobExecutionsForThing(params: Iot.Types.ListJobExecutionsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
/**
* Lists the job executions for the specified thing.
*/
listJobExecutionsForThing(callback?: (err: AWSError, data: Iot.Types.ListJobExecutionsForThingResponse) => void): Request<Iot.Types.ListJobExecutionsForThingResponse, AWSError>;
/**
* Lists jobs.
*/
listJobs(params: Iot.Types.ListJobsRequest, callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
/**
* Lists jobs.
*/
listJobs(callback?: (err: AWSError, data: Iot.Types.ListJobsResponse) => void): Request<Iot.Types.ListJobsResponse, AWSError>;
/**
* Gets a list of all mitigation actions that match the specified filter criteria.
*/
listMitigationActions(params: Iot.Types.ListMitigationActionsRequest, callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
/**
* Gets a list of all mitigation actions that match the specified filter criteria.
*/
listMitigationActions(callback?: (err: AWSError, data: Iot.Types.ListMitigationActionsResponse) => void): Request<Iot.Types.ListMitigationActionsResponse, AWSError>;
/**
* Lists OTA updates.
*/
listOTAUpdates(params: Iot.Types.ListOTAUpdatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
/**
* Lists OTA updates.
*/
listOTAUpdates(callback?: (err: AWSError, data: Iot.Types.ListOTAUpdatesResponse) => void): Request<Iot.Types.ListOTAUpdatesResponse, AWSError>;
/**
* Lists certificates that are being transferred but not yet accepted.
*/
listOutgoingCertificates(params: Iot.Types.ListOutgoingCertificatesRequest, callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
/**
* Lists certificates that are being transferred but not yet accepted.
*/
listOutgoingCertificates(callback?: (err: AWSError, data: Iot.Types.ListOutgoingCertificatesResponse) => void): Request<Iot.Types.ListOutgoingCertificatesResponse, AWSError>;
/**
* Lists your policies.
*/
listPolicies(params: Iot.Types.ListPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
/**
* Lists your policies.
*/
listPolicies(callback?: (err: AWSError, data: Iot.Types.ListPoliciesResponse) => void): Request<Iot.Types.ListPoliciesResponse, AWSError>;
/**
* Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead.
*/
listPolicyPrincipals(params: Iot.Types.ListPolicyPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
/**
* Lists the principals associated with the specified policy. Note: This API is deprecated. Please use ListTargetsForPolicy instead.
*/
listPolicyPrincipals(callback?: (err: AWSError, data: Iot.Types.ListPolicyPrincipalsResponse) => void): Request<Iot.Types.ListPolicyPrincipalsResponse, AWSError>;
/**
* Lists the versions of the specified policy and identifies the default version.
*/
listPolicyVersions(params: Iot.Types.ListPolicyVersionsRequest, callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
/**
* Lists the versions of the specified policy and identifies the default version.
*/
listPolicyVersions(callback?: (err: AWSError, data: Iot.Types.ListPolicyVersionsResponse) => void): Request<Iot.Types.ListPolicyVersionsResponse, AWSError>;
/**
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead.
*/
listPrincipalPolicies(params: Iot.Types.ListPrincipalPoliciesRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
/**
* Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format. Note: This API is deprecated. Please use ListAttachedPolicies instead.
*/
listPrincipalPolicies(callback?: (err: AWSError, data: Iot.Types.ListPrincipalPoliciesResponse) => void): Request<Iot.Types.ListPrincipalPoliciesResponse, AWSError>;
/**
* Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
listPrincipalThings(params: Iot.Types.ListPrincipalThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
/**
* Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
listPrincipalThings(callback?: (err: AWSError, data: Iot.Types.ListPrincipalThingsResponse) => void): Request<Iot.Types.ListPrincipalThingsResponse, AWSError>;
/**
* Lists the role aliases registered in your account.
*/
listRoleAliases(params: Iot.Types.ListRoleAliasesRequest, callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
/**
* Lists the role aliases registered in your account.
*/
listRoleAliases(callback?: (err: AWSError, data: Iot.Types.ListRoleAliasesResponse) => void): Request<Iot.Types.ListRoleAliasesResponse, AWSError>;
/**
* Lists all of your scheduled audits.
*/
listScheduledAudits(params: Iot.Types.ListScheduledAuditsRequest, callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
/**
* Lists all of your scheduled audits.
*/
listScheduledAudits(callback?: (err: AWSError, data: Iot.Types.ListScheduledAuditsResponse) => void): Request<Iot.Types.ListScheduledAuditsResponse, AWSError>;
/**
* Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
*/
listSecurityProfiles(params: Iot.Types.ListSecurityProfilesRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
/**
* Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.
*/
listSecurityProfiles(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesResponse) => void): Request<Iot.Types.ListSecurityProfilesResponse, AWSError>;
/**
* Lists the Device Defender security profiles attached to a target (thing group).
*/
listSecurityProfilesForTarget(params: Iot.Types.ListSecurityProfilesForTargetRequest, callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
/**
* Lists the Device Defender security profiles attached to a target (thing group).
*/
listSecurityProfilesForTarget(callback?: (err: AWSError, data: Iot.Types.ListSecurityProfilesForTargetResponse) => void): Request<Iot.Types.ListSecurityProfilesForTargetResponse, AWSError>;
/**
* Lists all of the streams in your AWS account.
*/
listStreams(params: Iot.Types.ListStreamsRequest, callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
/**
* Lists all of the streams in your AWS account.
*/
listStreams(callback?: (err: AWSError, data: Iot.Types.ListStreamsResponse) => void): Request<Iot.Types.ListStreamsResponse, AWSError>;
/**
* Lists the tags (metadata) you have assigned to the resource.
*/
listTagsForResource(params: Iot.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags (metadata) you have assigned to the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Iot.Types.ListTagsForResourceResponse) => void): Request<Iot.Types.ListTagsForResourceResponse, AWSError>;
/**
* List targets for the specified policy.
*/
listTargetsForPolicy(params: Iot.Types.ListTargetsForPolicyRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
/**
* List targets for the specified policy.
*/
listTargetsForPolicy(callback?: (err: AWSError, data: Iot.Types.ListTargetsForPolicyResponse) => void): Request<Iot.Types.ListTargetsForPolicyResponse, AWSError>;
/**
* Lists the targets (thing groups) associated with a given Device Defender security profile.
*/
listTargetsForSecurityProfile(params: Iot.Types.ListTargetsForSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
/**
* Lists the targets (thing groups) associated with a given Device Defender security profile.
*/
listTargetsForSecurityProfile(callback?: (err: AWSError, data: Iot.Types.ListTargetsForSecurityProfileResponse) => void): Request<Iot.Types.ListTargetsForSecurityProfileResponse, AWSError>;
/**
* List the thing groups in your account.
*/
listThingGroups(params: Iot.Types.ListThingGroupsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
/**
* List the thing groups in your account.
*/
listThingGroups(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsResponse) => void): Request<Iot.Types.ListThingGroupsResponse, AWSError>;
/**
* List the thing groups to which the specified thing belongs.
*/
listThingGroupsForThing(params: Iot.Types.ListThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
/**
* List the thing groups to which the specified thing belongs.
*/
listThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.ListThingGroupsForThingResponse) => void): Request<Iot.Types.ListThingGroupsForThingResponse, AWSError>;
/**
* Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
listThingPrincipals(params: Iot.Types.ListThingPrincipalsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
/**
* Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.
*/
listThingPrincipals(callback?: (err: AWSError, data: Iot.Types.ListThingPrincipalsResponse) => void): Request<Iot.Types.ListThingPrincipalsResponse, AWSError>;
/**
* Information about the thing registration tasks.
*/
listThingRegistrationTaskReports(params: Iot.Types.ListThingRegistrationTaskReportsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request<Iot.Types.ListThingRegistrationTaskReportsResponse, AWSError>;
/**
* Information about the thing registration tasks.
*/
listThingRegistrationTaskReports(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTaskReportsResponse) => void): Request<Iot.Types.ListThingRegistrationTaskReportsResponse, AWSError>;
/**
* List bulk thing provisioning tasks.
*/
listThingRegistrationTasks(params: Iot.Types.ListThingRegistrationTasksRequest, callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
/**
* List bulk thing provisioning tasks.
*/
listThingRegistrationTasks(callback?: (err: AWSError, data: Iot.Types.ListThingRegistrationTasksResponse) => void): Request<Iot.Types.ListThingRegistrationTasksResponse, AWSError>;
/**
* Lists the existing thing types.
*/
listThingTypes(params: Iot.Types.ListThingTypesRequest, callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
/**
* Lists the existing thing types.
*/
listThingTypes(callback?: (err: AWSError, data: Iot.Types.ListThingTypesResponse) => void): Request<Iot.Types.ListThingTypesResponse, AWSError>;
/**
* Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.
*/
listThings(params: Iot.Types.ListThingsRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
/**
* Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.
*/
listThings(callback?: (err: AWSError, data: Iot.Types.ListThingsResponse) => void): Request<Iot.Types.ListThingsResponse, AWSError>;
/**
* Lists the things you have added to the given billing group.
*/
listThingsInBillingGroup(params: Iot.Types.ListThingsInBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
/**
* Lists the things you have added to the given billing group.
*/
listThingsInBillingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInBillingGroupResponse) => void): Request<Iot.Types.ListThingsInBillingGroupResponse, AWSError>;
/**
* Lists the things in the specified group.
*/
listThingsInThingGroup(params: Iot.Types.ListThingsInThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
/**
* Lists the things in the specified group.
*/
listThingsInThingGroup(callback?: (err: AWSError, data: Iot.Types.ListThingsInThingGroupResponse) => void): Request<Iot.Types.ListThingsInThingGroupResponse, AWSError>;
/**
* Lists the rules for the specific topic.
*/
listTopicRules(params: Iot.Types.ListTopicRulesRequest, callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
/**
* Lists the rules for the specific topic.
*/
listTopicRules(callback?: (err: AWSError, data: Iot.Types.ListTopicRulesResponse) => void): Request<Iot.Types.ListTopicRulesResponse, AWSError>;
/**
* Lists logging levels.
*/
listV2LoggingLevels(params: Iot.Types.ListV2LoggingLevelsRequest, callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
/**
* Lists logging levels.
*/
listV2LoggingLevels(callback?: (err: AWSError, data: Iot.Types.ListV2LoggingLevelsResponse) => void): Request<Iot.Types.ListV2LoggingLevelsResponse, AWSError>;
/**
* Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
*/
listViolationEvents(params: Iot.Types.ListViolationEventsRequest, callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
/**
* Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).
*/
listViolationEvents(callback?: (err: AWSError, data: Iot.Types.ListViolationEventsResponse) => void): Request<Iot.Types.ListViolationEventsResponse, AWSError>;
/**
* Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
*/
registerCACertificate(params: Iot.Types.RegisterCACertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
/**
* Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.
*/
registerCACertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCACertificateResponse) => void): Request<Iot.Types.RegisterCACertificateResponse, AWSError>;
/**
* Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
*/
registerCertificate(params: Iot.Types.RegisterCertificateRequest, callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
/**
* Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.
*/
registerCertificate(callback?: (err: AWSError, data: Iot.Types.RegisterCertificateResponse) => void): Request<Iot.Types.RegisterCertificateResponse, AWSError>;
/**
* Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
*/
registerThing(params: Iot.Types.RegisterThingRequest, callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
/**
* Provisions a thing in the device registry. RegisterThing calls other AWS IoT control plane APIs. These calls might exceed your account level AWS IoT Throttling Limits and cause throttle errors. Please contact AWS Customer Support to raise your throttling limits if necessary.
*/
registerThing(callback?: (err: AWSError, data: Iot.Types.RegisterThingResponse) => void): Request<Iot.Types.RegisterThingResponse, AWSError>;
/**
* Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
*/
rejectCertificateTransfer(params: Iot.Types.RejectCertificateTransferRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE. To check for pending certificate transfers, call ListCertificates to enumerate your certificates. This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.
*/
rejectCertificateTransfer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the given thing from the billing group.
*/
removeThingFromBillingGroup(params: Iot.Types.RemoveThingFromBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
/**
* Removes the given thing from the billing group.
*/
removeThingFromBillingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromBillingGroupResponse) => void): Request<Iot.Types.RemoveThingFromBillingGroupResponse, AWSError>;
/**
* Remove the specified thing from the specified group.
*/
removeThingFromThingGroup(params: Iot.Types.RemoveThingFromThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
/**
* Remove the specified thing from the specified group.
*/
removeThingFromThingGroup(callback?: (err: AWSError, data: Iot.Types.RemoveThingFromThingGroupResponse) => void): Request<Iot.Types.RemoveThingFromThingGroupResponse, AWSError>;
/**
* Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
*/
replaceTopicRule(params: Iot.Types.ReplaceTopicRuleRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.
*/
replaceTopicRule(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* The query search index.
*/
searchIndex(params: Iot.Types.SearchIndexRequest, callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
/**
* The query search index.
*/
searchIndex(callback?: (err: AWSError, data: Iot.Types.SearchIndexResponse) => void): Request<Iot.Types.SearchIndexResponse, AWSError>;
/**
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
*/
setDefaultAuthorizer(params: Iot.Types.SetDefaultAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
/**
* Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.
*/
setDefaultAuthorizer(callback?: (err: AWSError, data: Iot.Types.SetDefaultAuthorizerResponse) => void): Request<Iot.Types.SetDefaultAuthorizerResponse, AWSError>;
/**
* Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
*/
setDefaultPolicyVersion(params: Iot.Types.SetDefaultPolicyVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.
*/
setDefaultPolicyVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
*/
setLoggingOptions(params: Iot.Types.SetLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging options. NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.
*/
setLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging level.
*/
setV2LoggingLevel(params: Iot.Types.SetV2LoggingLevelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging level.
*/
setV2LoggingLevel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging options for the V2 logging service.
*/
setV2LoggingOptions(params: Iot.Types.SetV2LoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets the logging options for the V2 logging service.
*/
setV2LoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Starts a task that applies a set of mitigation actions to the specified target.
*/
startAuditMitigationActionsTask(params: Iot.Types.StartAuditMitigationActionsTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
/**
* Starts a task that applies a set of mitigation actions to the specified target.
*/
startAuditMitigationActionsTask(callback?: (err: AWSError, data: Iot.Types.StartAuditMitigationActionsTaskResponse) => void): Request<Iot.Types.StartAuditMitigationActionsTaskResponse, AWSError>;
/**
* Starts an on-demand Device Defender audit.
*/
startOnDemandAuditTask(params: Iot.Types.StartOnDemandAuditTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
/**
* Starts an on-demand Device Defender audit.
*/
startOnDemandAuditTask(callback?: (err: AWSError, data: Iot.Types.StartOnDemandAuditTaskResponse) => void): Request<Iot.Types.StartOnDemandAuditTaskResponse, AWSError>;
/**
* Creates a bulk thing provisioning task.
*/
startThingRegistrationTask(params: Iot.Types.StartThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
/**
* Creates a bulk thing provisioning task.
*/
startThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StartThingRegistrationTaskResponse) => void): Request<Iot.Types.StartThingRegistrationTaskResponse, AWSError>;
/**
* Cancels a bulk thing provisioning task.
*/
stopThingRegistrationTask(params: Iot.Types.StopThingRegistrationTaskRequest, callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
/**
* Cancels a bulk thing provisioning task.
*/
stopThingRegistrationTask(callback?: (err: AWSError, data: Iot.Types.StopThingRegistrationTaskResponse) => void): Request<Iot.Types.StopThingRegistrationTaskResponse, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
*/
tagResource(params: Iot.Types.TagResourceRequest, callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
*/
tagResource(callback?: (err: AWSError, data: Iot.Types.TagResourceResponse) => void): Request<Iot.Types.TagResourceResponse, AWSError>;
/**
* Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
*/
testAuthorization(params: Iot.Types.TestAuthorizationRequest, callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
/**
* Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.
*/
testAuthorization(callback?: (err: AWSError, data: Iot.Types.TestAuthorizationResponse) => void): Request<Iot.Types.TestAuthorizationResponse, AWSError>;
/**
* Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
*/
testInvokeAuthorizer(params: Iot.Types.TestInvokeAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
/**
* Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.
*/
testInvokeAuthorizer(callback?: (err: AWSError, data: Iot.Types.TestInvokeAuthorizerResponse) => void): Request<Iot.Types.TestInvokeAuthorizerResponse, AWSError>;
/**
* Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
*/
transferCertificate(params: Iot.Types.TransferCertificateRequest, callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
/**
* Transfers the specified certificate to the specified AWS account. You can cancel the transfer until it is acknowledged by the recipient. No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target. The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it. The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.
*/
transferCertificate(callback?: (err: AWSError, data: Iot.Types.TransferCertificateResponse) => void): Request<Iot.Types.TransferCertificateResponse, AWSError>;
/**
* Removes the given tags (metadata) from the resource.
*/
untagResource(params: Iot.Types.UntagResourceRequest, callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
/**
* Removes the given tags (metadata) from the resource.
*/
untagResource(callback?: (err: AWSError, data: Iot.Types.UntagResourceResponse) => void): Request<Iot.Types.UntagResourceResponse, AWSError>;
/**
* Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
*/
updateAccountAuditConfiguration(params: Iot.Types.UpdateAccountAuditConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
/**
* Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.
*/
updateAccountAuditConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateAccountAuditConfigurationResponse) => void): Request<Iot.Types.UpdateAccountAuditConfigurationResponse, AWSError>;
/**
* Updates an authorizer.
*/
updateAuthorizer(params: Iot.Types.UpdateAuthorizerRequest, callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
/**
* Updates an authorizer.
*/
updateAuthorizer(callback?: (err: AWSError, data: Iot.Types.UpdateAuthorizerResponse) => void): Request<Iot.Types.UpdateAuthorizerResponse, AWSError>;
/**
* Updates information about the billing group.
*/
updateBillingGroup(params: Iot.Types.UpdateBillingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
/**
* Updates information about the billing group.
*/
updateBillingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateBillingGroupResponse) => void): Request<Iot.Types.UpdateBillingGroupResponse, AWSError>;
/**
* Updates a registered CA certificate.
*/
updateCACertificate(params: Iot.Types.UpdateCACertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a registered CA certificate.
*/
updateCACertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
*/
updateCertificate(params: Iot.Types.UpdateCertificateRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the status of the specified certificate. This operation is idempotent. Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect. The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.
*/
updateCertificate(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates a dynamic thing group.
*/
updateDynamicThingGroup(params: Iot.Types.UpdateDynamicThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
/**
* Updates a dynamic thing group.
*/
updateDynamicThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateDynamicThingGroupResponse) => void): Request<Iot.Types.UpdateDynamicThingGroupResponse, AWSError>;
/**
* Updates the event configurations.
*/
updateEventConfigurations(params: Iot.Types.UpdateEventConfigurationsRequest, callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
/**
* Updates the event configurations.
*/
updateEventConfigurations(callback?: (err: AWSError, data: Iot.Types.UpdateEventConfigurationsResponse) => void): Request<Iot.Types.UpdateEventConfigurationsResponse, AWSError>;
/**
* Updates the search configuration.
*/
updateIndexingConfiguration(params: Iot.Types.UpdateIndexingConfigurationRequest, callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
/**
* Updates the search configuration.
*/
updateIndexingConfiguration(callback?: (err: AWSError, data: Iot.Types.UpdateIndexingConfigurationResponse) => void): Request<Iot.Types.UpdateIndexingConfigurationResponse, AWSError>;
/**
* Updates supported fields of the specified job.
*/
updateJob(params: Iot.Types.UpdateJobRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates supported fields of the specified job.
*/
updateJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the definition for the specified mitigation action.
*/
updateMitigationAction(params: Iot.Types.UpdateMitigationActionRequest, callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
/**
* Updates the definition for the specified mitigation action.
*/
updateMitigationAction(callback?: (err: AWSError, data: Iot.Types.UpdateMitigationActionResponse) => void): Request<Iot.Types.UpdateMitigationActionResponse, AWSError>;
/**
* Updates a role alias.
*/
updateRoleAlias(params: Iot.Types.UpdateRoleAliasRequest, callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
/**
* Updates a role alias.
*/
updateRoleAlias(callback?: (err: AWSError, data: Iot.Types.UpdateRoleAliasResponse) => void): Request<Iot.Types.UpdateRoleAliasResponse, AWSError>;
/**
* Updates a scheduled audit, including which checks are performed and how often the audit takes place.
*/
updateScheduledAudit(params: Iot.Types.UpdateScheduledAuditRequest, callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
/**
* Updates a scheduled audit, including which checks are performed and how often the audit takes place.
*/
updateScheduledAudit(callback?: (err: AWSError, data: Iot.Types.UpdateScheduledAuditResponse) => void): Request<Iot.Types.UpdateScheduledAuditResponse, AWSError>;
/**
* Updates a Device Defender security profile.
*/
updateSecurityProfile(params: Iot.Types.UpdateSecurityProfileRequest, callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
/**
* Updates a Device Defender security profile.
*/
updateSecurityProfile(callback?: (err: AWSError, data: Iot.Types.UpdateSecurityProfileResponse) => void): Request<Iot.Types.UpdateSecurityProfileResponse, AWSError>;
/**
* Updates an existing stream. The stream version will be incremented by one.
*/
updateStream(params: Iot.Types.UpdateStreamRequest, callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
/**
* Updates an existing stream. The stream version will be incremented by one.
*/
updateStream(callback?: (err: AWSError, data: Iot.Types.UpdateStreamResponse) => void): Request<Iot.Types.UpdateStreamResponse, AWSError>;
/**
* Updates the data for a thing.
*/
updateThing(params: Iot.Types.UpdateThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
/**
* Updates the data for a thing.
*/
updateThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingResponse) => void): Request<Iot.Types.UpdateThingResponse, AWSError>;
/**
* Update a thing group.
*/
updateThingGroup(params: Iot.Types.UpdateThingGroupRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
/**
* Update a thing group.
*/
updateThingGroup(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupResponse) => void): Request<Iot.Types.UpdateThingGroupResponse, AWSError>;
/**
* Updates the groups to which the thing belongs.
*/
updateThingGroupsForThing(params: Iot.Types.UpdateThingGroupsForThingRequest, callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
/**
* Updates the groups to which the thing belongs.
*/
updateThingGroupsForThing(callback?: (err: AWSError, data: Iot.Types.UpdateThingGroupsForThingResponse) => void): Request<Iot.Types.UpdateThingGroupsForThingResponse, AWSError>;
/**
* Validates a Device Defender security profile behaviors specification.
*/
validateSecurityProfileBehaviors(params: Iot.Types.ValidateSecurityProfileBehaviorsRequest, callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
/**
* Validates a Device Defender security profile behaviors specification.
*/
validateSecurityProfileBehaviors(callback?: (err: AWSError, data: Iot.Types.ValidateSecurityProfileBehaviorsResponse) => void): Request<Iot.Types.ValidateSecurityProfileBehaviorsResponse, AWSError>;
}
declare namespace Iot {
export type AbortAction = "CANCEL"|string;
export interface AbortConfig {
/**
* The list of abort criteria to define rules to abort the job.
*/
criteriaList: AbortCriteriaList;
}
export interface AbortCriteria {
/**
* The type of job execution failure to define a rule to initiate a job abort.
*/
failureType: JobExecutionFailureType;
/**
* The type of abort action to initiate a job abort.
*/
action: AbortAction;
/**
* The threshold as a percentage of the total number of executed things that will initiate a job abort. AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
*/
thresholdPercentage: AbortThresholdPercentage;
/**
* Minimum number of executed things before evaluating an abort rule.
*/
minNumberOfExecutedThings: MinimumNumberOfExecutedThings;
}
export type AbortCriteriaList = AbortCriteria[];
export type AbortThresholdPercentage = number;
export interface AcceptCertificateTransferRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
/**
* Specifies whether the certificate is active.
*/
setAsActive?: SetAsActive;
}
export interface Action {
/**
* Write to a DynamoDB table.
*/
dynamoDB?: DynamoDBAction;
/**
* Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
*/
dynamoDBv2?: DynamoDBv2Action;
/**
* Invoke a Lambda function.
*/
lambda?: LambdaAction;
/**
* Publish to an Amazon SNS topic.
*/
sns?: SnsAction;
/**
* Publish to an Amazon SQS queue.
*/
sqs?: SqsAction;
/**
* Write data to an Amazon Kinesis stream.
*/
kinesis?: KinesisAction;
/**
* Publish to another MQTT topic.
*/
republish?: RepublishAction;
/**
* Write to an Amazon S3 bucket.
*/
s3?: S3Action;
/**
* Write to an Amazon Kinesis Firehose stream.
*/
firehose?: FirehoseAction;
/**
* Capture a CloudWatch metric.
*/
cloudwatchMetric?: CloudwatchMetricAction;
/**
* Change the state of a CloudWatch alarm.
*/
cloudwatchAlarm?: CloudwatchAlarmAction;
/**
* Write data to an Amazon Elasticsearch Service domain.
*/
elasticsearch?: ElasticsearchAction;
/**
* Send a message to a Salesforce IoT Cloud Input Stream.
*/
salesforce?: SalesforceAction;
/**
* Sends message data to an AWS IoT Analytics channel.
*/
iotAnalytics?: IotAnalyticsAction;
/**
* Sends an input to an AWS IoT Events detector.
*/
iotEvents?: IotEventsAction;
/**
* Starts execution of a Step Functions state machine.
*/
stepFunctions?: StepFunctionsAction;
}
export type ActionList = Action[];
export type ActionType = "PUBLISH"|"SUBSCRIBE"|"RECEIVE"|"CONNECT"|string;
export interface ActiveViolation {
/**
* The ID of the active violation.
*/
violationId?: ViolationId;
/**
* The name of the thing responsible for the active violation.
*/
thingName?: DeviceDefenderThingName;
/**
* The security profile whose behavior is in violation.
*/
securityProfileName?: SecurityProfileName;
/**
* The behavior which is being violated.
*/
behavior?: Behavior;
/**
* The value of the metric (the measurement) which caused the most recent violation.
*/
lastViolationValue?: MetricValue;
/**
* The time the most recent violation occurred.
*/
lastViolationTime?: Timestamp;
/**
* The time the violation started.
*/
violationStartTime?: Timestamp;
}
export type ActiveViolations = ActiveViolation[];
export interface AddThingToBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName?: BillingGroupName;
/**
* The ARN of the billing group.
*/
billingGroupArn?: BillingGroupArn;
/**
* The name of the thing to be added to the billing group.
*/
thingName?: ThingName;
/**
* The ARN of the thing to be added to the billing group.
*/
thingArn?: ThingArn;
}
export interface AddThingToBillingGroupResponse {
}
export interface AddThingToThingGroupRequest {
/**
* The name of the group to which you are adding a thing.
*/
thingGroupName?: ThingGroupName;
/**
* The ARN of the group to which you are adding a thing.
*/
thingGroupArn?: ThingGroupArn;
/**
* The name of the thing to add to a group.
*/
thingName?: ThingName;
/**
* The ARN of the thing to add to a group.
*/
thingArn?: ThingArn;
/**
* Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
*/
overrideDynamicGroups?: OverrideDynamicGroups;
}
export interface AddThingToThingGroupResponse {
}
export interface AddThingsToThingGroupParams {
/**
* The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.
*/
thingGroupNames: ThingGroupNames;
/**
* Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.
*/
overrideDynamicGroups?: OverrideDynamicGroups;
}
export type AdditionalMetricsToRetainList = BehaviorMetric[];
export type AdditionalParameterMap = {[key: string]: Value};
export type AggregationField = string;
export type AlarmName = string;
export interface AlertTarget {
/**
* The ARN of the notification target to which alerts are sent.
*/
alertTargetArn: AlertTargetArn;
/**
* The ARN of the role that grants permission to send alerts to the notification target.
*/
roleArn: RoleArn;
}
export type AlertTargetArn = string;
export type AlertTargetType = "SNS"|string;
export type AlertTargets = {[key: string]: AlertTarget};
export type AllowAutoRegistration = boolean;
export interface Allowed {
/**
* A list of policies that allowed the authentication.
*/
policies?: Policies;
}
export type ApproximateSecondsBeforeTimedOut = number;
export type AscendingOrder = boolean;
export interface AssociateTargetsWithJobRequest {
/**
* A list of thing group ARNs that define the targets of the job.
*/
targets: JobTargets;
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
/**
* An optional comment string describing why the job was associated with the targets.
*/
comment?: Comment;
}
export interface AssociateTargetsWithJobResponse {
/**
* An ARN identifying the job.
*/
jobArn?: JobArn;
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId?: JobId;
/**
* A short text description of the job.
*/
description?: JobDescription;
}
export interface AttachPolicyRequest {
/**
* The name of the policy to attach.
*/
policyName: PolicyName;
/**
* The identity to which the policy is attached.
*/
target: PolicyTarget;
}
export interface AttachPrincipalPolicyRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
*/
principal: Principal;
}
export interface AttachSecurityProfileRequest {
/**
* The security profile that is attached.
*/
securityProfileName: SecurityProfileName;
/**
* The ARN of the target (thing group) to which the security profile is attached.
*/
securityProfileTargetArn: SecurityProfileTargetArn;
}
export interface AttachSecurityProfileResponse {
}
export interface AttachThingPrincipalRequest {
/**
* The name of the thing.
*/
thingName: ThingName;
/**
* The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.
*/
principal: Principal;
}
export interface AttachThingPrincipalResponse {
}
export type AttributeKey = string;
export type AttributeName = string;
export interface AttributePayload {
/**
* A JSON string containing up to three key-value pair in JSON format. For example: {\"attributes\":{\"string1\":\"string2\"}}
*/
attributes?: Attributes;
/**
* Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them. To remove an attribute, call UpdateThing with an empty attribute value. The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.
*/
merge?: Flag;
}
export type AttributeValue = string;
export type Attributes = {[key: string]: AttributeValue};
export type AttributesMap = {[key: string]: Value};
export interface AuditCheckConfiguration {
/**
* True if this audit check is enabled for this account.
*/
enabled?: Enabled;
}
export type AuditCheckConfigurations = {[key: string]: AuditCheckConfiguration};
export interface AuditCheckDetails {
/**
* The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED", "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
*/
checkRunStatus?: AuditCheckRunStatus;
/**
* True if the check is complete and found all resources compliant.
*/
checkCompliant?: CheckCompliant;
/**
* The number of resources on which the check was performed.
*/
totalResourcesCount?: TotalResourcesCount;
/**
* The number of resources that were found noncompliant during the check.
*/
nonCompliantResourcesCount?: NonCompliantResourcesCount;
/**
* The code of any error encountered when this check is performed during this audit. One of "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
*/
errorCode?: ErrorCode;
/**
* The message associated with any error encountered when this check is performed during this audit.
*/
message?: ErrorMessage;
}
export type AuditCheckName = string;
export type AuditCheckRunStatus = "IN_PROGRESS"|"WAITING_FOR_DATA_COLLECTION"|"CANCELED"|"COMPLETED_COMPLIANT"|"COMPLETED_NON_COMPLIANT"|"FAILED"|string;
export type AuditCheckToActionsMapping = {[key: string]: MitigationActionNameList};
export type AuditCheckToReasonCodeFilter = {[key: string]: ReasonForNonComplianceCodes};
export type AuditDetails = {[key: string]: AuditCheckDetails};
export interface AuditFinding {
/**
* A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.
*/
findingId?: FindingId;
/**
* The ID of the audit that generated this result (finding).
*/
taskId?: AuditTaskId;
/**
* The audit check that generated this result.
*/
checkName?: AuditCheckName;
/**
* The time the audit started.
*/
taskStartTime?: Timestamp;
/**
* The time the result (finding) was discovered.
*/
findingTime?: Timestamp;
/**
* The severity of the result (finding).
*/
severity?: AuditFindingSeverity;
/**
* The resource that was found to be noncompliant with the audit check.
*/
nonCompliantResource?: NonCompliantResource;
/**
* The list of related resources.
*/
relatedResources?: RelatedResources;
/**
* The reason the resource was noncompliant.
*/
reasonForNonCompliance?: ReasonForNonCompliance;
/**
* A code that indicates the reason that the resource was noncompliant.
*/
reasonForNonComplianceCode?: ReasonForNonComplianceCode;
}
export type AuditFindingSeverity = "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|string;
export type AuditFindings = AuditFinding[];
export type AuditFrequency = "DAILY"|"WEEKLY"|"BIWEEKLY"|"MONTHLY"|string;
export interface AuditMitigationActionExecutionMetadata {
/**
* The unique identifier for the task that applies the mitigation action.
*/
taskId?: AuditMitigationActionsTaskId;
/**
* The unique identifier for the findings to which the task and associated mitigation action are applied.
*/
findingId?: FindingId;
/**
* The friendly name of the mitigation action being applied by the task.
*/
actionName?: MitigationActionName;
/**
* The unique identifier for the mitigation action being applied by the task.
*/
actionId?: MitigationActionId;
/**
* The current status of the task being executed.
*/
status?: AuditMitigationActionsExecutionStatus;
/**
* The date and time when the task was started.
*/
startTime?: Timestamp;
/**
* The date and time when the task was completed or canceled. Blank if the task is still running.
*/
endTime?: Timestamp;
/**
* If an error occurred, the code that indicates which type of error occurred.
*/
errorCode?: ErrorCode;
/**
* If an error occurred, a message that describes the error.
*/
message?: ErrorMessage;
}
export type AuditMitigationActionExecutionMetadataList = AuditMitigationActionExecutionMetadata[];
export type AuditMitigationActionsExecutionStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|"SKIPPED"|"PENDING"|string;
export type AuditMitigationActionsTaskId = string;
export interface AuditMitigationActionsTaskMetadata {
/**
* The unique identifier for the task.
*/
taskId?: AuditMitigationActionsTaskId;
/**
* The time at which the audit mitigation actions task was started.
*/
startTime?: Timestamp;
/**
* The current state of the audit mitigation actions task.
*/
taskStatus?: AuditMitigationActionsTaskStatus;
}
export type AuditMitigationActionsTaskMetadataList = AuditMitigationActionsTaskMetadata[];
export type AuditMitigationActionsTaskStatistics = {[key: string]: TaskStatisticsForAuditCheck};
export type AuditMitigationActionsTaskStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|string;
export interface AuditMitigationActionsTaskTarget {
/**
* If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.
*/
auditTaskId?: AuditTaskId;
/**
* If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.
*/
findingIds?: FindingIds;
/**
* Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.
*/
auditCheckToReasonCodeFilter?: AuditCheckToReasonCodeFilter;
}
export interface AuditNotificationTarget {
/**
* The ARN of the target (SNS topic) to which audit notifications are sent.
*/
targetArn?: TargetArn;
/**
* The ARN of the role that grants permission to send notifications to the target.
*/
roleArn?: RoleArn;
/**
* True if notifications to the target are enabled.
*/
enabled?: Enabled;
}
export type AuditNotificationTargetConfigurations = {[key: string]: AuditNotificationTarget};
export type AuditNotificationType = "SNS"|string;
export type AuditTaskId = string;
export interface AuditTaskMetadata {
/**
* The ID of this audit.
*/
taskId?: AuditTaskId;
/**
* The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
*/
taskStatus?: AuditTaskStatus;
/**
* The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
*/
taskType?: AuditTaskType;
}
export type AuditTaskMetadataList = AuditTaskMetadata[];
export type AuditTaskStatus = "IN_PROGRESS"|"COMPLETED"|"FAILED"|"CANCELED"|string;
export type AuditTaskType = "ON_DEMAND_AUDIT_TASK"|"SCHEDULED_AUDIT_TASK"|string;
export type AuthDecision = "ALLOWED"|"EXPLICIT_DENY"|"IMPLICIT_DENY"|string;
export interface AuthInfo {
/**
* The type of action for which the principal is being authorized.
*/
actionType?: ActionType;
/**
* The resources for which the principal is being authorized to perform the specified action.
*/
resources?: Resources;
}
export type AuthInfos = AuthInfo[];
export interface AuthResult {
/**
* Authorization information.
*/
authInfo?: AuthInfo;
/**
* The policies and statements that allowed the specified action.
*/
allowed?: Allowed;
/**
* The policies and statements that denied the specified action.
*/
denied?: Denied;
/**
* The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.
*/
authDecision?: AuthDecision;
/**
* Contains any missing context values found while evaluating policy.
*/
missingContextValues?: MissingContextValues;
}
export type AuthResults = AuthResult[];
export type AuthorizerArn = string;
export interface AuthorizerDescription {
/**
* The authorizer name.
*/
authorizerName?: AuthorizerName;
/**
* The authorizer ARN.
*/
authorizerArn?: AuthorizerArn;
/**
* The authorizer's Lambda function ARN.
*/
authorizerFunctionArn?: AuthorizerFunctionArn;
/**
* The key used to extract the token from the HTTP headers.
*/
tokenKeyName?: TokenKeyName;
/**
* The public keys used to validate the token signature returned by your custom authentication service.
*/
tokenSigningPublicKeys?: PublicKeyMap;
/**
* The status of the authorizer.
*/
status?: AuthorizerStatus;
/**
* The UNIX timestamp of when the authorizer was created.
*/
creationDate?: DateType;
/**
* The UNIX timestamp of when the authorizer was last updated.
*/
lastModifiedDate?: DateType;
}
export type AuthorizerFunctionArn = string;
export type AuthorizerName = string;
export type AuthorizerStatus = "ACTIVE"|"INACTIVE"|string;
export interface AuthorizerSummary {
/**
* The authorizer name.
*/
authorizerName?: AuthorizerName;
/**
* The authorizer ARN.
*/
authorizerArn?: AuthorizerArn;
}
export type Authorizers = AuthorizerSummary[];
export type AutoRegistrationStatus = "ENABLE"|"DISABLE"|string;
export type Average = number;
export type AwsAccountId = string;
export type AwsArn = string;
export type AwsIotJobArn = string;
export type AwsIotJobId = string;
export type AwsIotSqlVersion = string;
export interface AwsJobExecutionsRolloutConfig {
/**
* The maximum number of OTA update job executions started per minute.
*/
maximumPerMinute?: MaximumPerMinute;
}
export interface Behavior {
/**
* The name you have given to the behavior.
*/
name: BehaviorName;
/**
* What is measured by the behavior.
*/
metric?: BehaviorMetric;
/**
* The criteria that determine if a device is behaving normally in regard to the metric.
*/
criteria?: BehaviorCriteria;
}
export interface BehaviorCriteria {
/**
* The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).
*/
comparisonOperator?: ComparisonOperator;
/**
* The value to be compared with the metric.
*/
value?: MetricValue;
/**
* Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.
*/
durationSeconds?: DurationSeconds;
/**
* If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
*/
consecutiveDatapointsToAlarm?: ConsecutiveDatapointsToAlarm;
/**
* If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
*/
consecutiveDatapointsToClear?: ConsecutiveDatapointsToClear;
/**
* A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
*/
statisticalThreshold?: StatisticalThreshold;
}
export type BehaviorMetric = string;
export type BehaviorName = string;
export type Behaviors = Behavior[];
export type BillingGroupArn = string;
export type BillingGroupDescription = string;
export type BillingGroupId = string;
export interface BillingGroupMetadata {
/**
* The date the billing group was created.
*/
creationDate?: CreationDate;
}
export type BillingGroupName = string;
export type BillingGroupNameAndArnList = GroupNameAndArn[];
export interface BillingGroupProperties {
/**
* The description of the billing group.
*/
billingGroupDescription?: BillingGroupDescription;
}
export type Boolean = boolean;
export type BucketName = string;
export interface CACertificate {
/**
* The ARN of the CA certificate.
*/
certificateArn?: CertificateArn;
/**
* The ID of the CA certificate.
*/
certificateId?: CertificateId;
/**
* The status of the CA certificate. The status value REGISTER_INACTIVE is deprecated and should not be used.
*/
status?: CACertificateStatus;
/**
* The date the CA certificate was created.
*/
creationDate?: DateType;
}
export interface CACertificateDescription {
/**
* The CA certificate ARN.
*/
certificateArn?: CertificateArn;
/**
* The CA certificate ID.
*/
certificateId?: CertificateId;
/**
* The status of a CA certificate.
*/
status?: CACertificateStatus;
/**
* The CA certificate data, in PEM format.
*/
certificatePem?: CertificatePem;
/**
* The owner of the CA certificate.
*/
ownedBy?: AwsAccountId;
/**
* The date the CA certificate was created.
*/
creationDate?: DateType;
/**
* Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and "DISABLE"
*/
autoRegistrationStatus?: AutoRegistrationStatus;
/**
* The date the CA certificate was last modified.
*/
lastModifiedDate?: DateType;
/**
* The customer version of the CA certificate.
*/
customerVersion?: CustomerVersion;
/**
* The generation ID of the CA certificate.
*/
generationId?: GenerationId;
/**
* When the CA certificate is valid.
*/
validity?: CertificateValidity;
}
export type CACertificateStatus = "ACTIVE"|"INACTIVE"|string;
export type CACertificateUpdateAction = "DEACTIVATE"|string;
export type CACertificates = CACertificate[];
export interface CancelAuditMitigationActionsTaskRequest {
/**
* The unique identifier for the task that you want to cancel.
*/
taskId: AuditMitigationActionsTaskId;
}
export interface CancelAuditMitigationActionsTaskResponse {
}
export interface CancelAuditTaskRequest {
/**
* The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
*/
taskId: AuditTaskId;
}
export interface CancelAuditTaskResponse {
}
export interface CancelCertificateTransferRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
}
export interface CancelJobExecutionRequest {
/**
* The ID of the job to be canceled.
*/
jobId: JobId;
/**
* The name of the thing whose execution of the job will be canceled.
*/
thingName: ThingName;
/**
* (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false. Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*/
force?: ForceFlag;
/**
* (Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
*/
expectedVersion?: ExpectedVersion;
/**
* A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.
*/
statusDetails?: DetailsMap;
}
export interface CancelJobRequest {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
/**
* (Optional)A reason code string that explains why the job was canceled.
*/
reasonCode?: ReasonCode;
/**
* An optional comment string describing why the job was canceled.
*/
comment?: Comment;
/**
* (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false. Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.
*/
force?: ForceFlag;
}
export interface CancelJobResponse {
/**
* The job ARN.
*/
jobArn?: JobArn;
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId?: JobId;
/**
* A short text description of the job.
*/
description?: JobDescription;
}
export type CanceledChecksCount = number;
export type CanceledFindingsCount = number;
export type CanceledThings = number;
export type CannedAccessControlList = "private"|"public-read"|"public-read-write"|"aws-exec-read"|"authenticated-read"|"bucket-owner-read"|"bucket-owner-full-control"|"log-delivery-write"|string;
export interface Certificate {
/**
* The ARN of the certificate.
*/
certificateArn?: CertificateArn;
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId?: CertificateId;
/**
* The status of the certificate. The status value REGISTER_INACTIVE is deprecated and should not be used.
*/
status?: CertificateStatus;
/**
* The date and time the certificate was created.
*/
creationDate?: DateType;
}
export type CertificateArn = string;
export interface CertificateDescription {
/**
* The ARN of the certificate.
*/
certificateArn?: CertificateArn;
/**
* The ID of the certificate.
*/
certificateId?: CertificateId;
/**
* The certificate ID of the CA certificate used to sign this certificate.
*/
caCertificateId?: CertificateId;
/**
* The status of the certificate.
*/
status?: CertificateStatus;
/**
* The certificate data, in PEM format.
*/
certificatePem?: CertificatePem;
/**
* The ID of the AWS account that owns the certificate.
*/
ownedBy?: AwsAccountId;
/**
* The ID of the AWS account of the previous owner of the certificate.
*/
previousOwnedBy?: AwsAccountId;
/**
* The date and time the certificate was created.
*/
creationDate?: DateType;
/**
* The date and time the certificate was last modified.
*/
lastModifiedDate?: DateType;
/**
* The customer version of the certificate.
*/
customerVersion?: CustomerVersion;
/**
* The transfer data.
*/
transferData?: TransferData;
/**
* The generation ID of the certificate.
*/
generationId?: GenerationId;
/**
* When the certificate is valid.
*/
validity?: CertificateValidity;
}
export type CertificateId = string;
export type CertificateName = string;
export type CertificatePathOnDevice = string;
export type CertificatePem = string;
export type CertificateSigningRequest = string;
export type CertificateStatus = "ACTIVE"|"INACTIVE"|"REVOKED"|"PENDING_TRANSFER"|"REGISTER_INACTIVE"|"PENDING_ACTIVATION"|string;
export interface CertificateValidity {
/**
* The certificate is not valid before this date.
*/
notBefore?: DateType;
/**
* The certificate is not valid after this date.
*/
notAfter?: DateType;
}
export type Certificates = Certificate[];
export type ChannelName = string;
export type CheckCompliant = boolean;
export type Cidr = string;
export type Cidrs = Cidr[];
export interface ClearDefaultAuthorizerRequest {
}
export interface ClearDefaultAuthorizerResponse {
}
export type ClientId = string;
export type ClientRequestToken = string;
export interface CloudwatchAlarmAction {
/**
* The IAM role that allows access to the CloudWatch alarm.
*/
roleArn: AwsArn;
/**
* The CloudWatch alarm name.
*/
alarmName: AlarmName;
/**
* The reason for the alarm change.
*/
stateReason: StateReason;
/**
* The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
*/
stateValue: StateValue;
}
export interface CloudwatchMetricAction {
/**
* The IAM role that allows access to the CloudWatch metric.
*/
roleArn: AwsArn;
/**
* The CloudWatch metric namespace name.
*/
metricNamespace: String;
/**
* The CloudWatch metric name.
*/
metricName: String;
/**
* The CloudWatch metric value.
*/
metricValue: String;
/**
* The metric unit supported by CloudWatch.
*/
metricUnit: String;
/**
* An optional Unix timestamp.
*/
metricTimestamp?: String;
}
export type Code = string;
export interface CodeSigning {
/**
* The ID of the AWSSignerJob which was created to sign the file.
*/
awsSignerJobId?: SigningJobId;
/**
* Describes the code-signing job.
*/
startSigningJobParameter?: StartSigningJobParameter;
/**
* A custom method for code signing a file.
*/
customCodeSigning?: CustomCodeSigning;
}
export interface CodeSigningCertificateChain {
/**
* The name of the certificate.
*/
certificateName?: CertificateName;
/**
* A base64 encoded binary representation of the code signing certificate chain.
*/
inlineDocument?: InlineDocument;
}
export interface CodeSigningSignature {
/**
* A base64 encoded binary representation of the code signing signature.
*/
inlineDocument?: Signature;
}
export type CognitoIdentityPoolId = string;
export type Comment = string;
export type ComparisonOperator = "less-than"|"less-than-equals"|"greater-than"|"greater-than-equals"|"in-cidr-set"|"not-in-cidr-set"|"in-port-set"|"not-in-port-set"|string;
export type CompliantChecksCount = number;
export interface Configuration {
/**
* True to enable the configuration.
*/
Enabled?: Enabled;
}
export type ConnectivityTimestamp = number;
export type ConsecutiveDatapointsToAlarm = number;
export type ConsecutiveDatapointsToClear = number;
export type Count = number;
export interface CreateAuthorizerRequest {
/**
* The authorizer name.
*/
authorizerName: AuthorizerName;
/**
* The ARN of the authorizer's Lambda function.
*/
authorizerFunctionArn: AuthorizerFunctionArn;
/**
* The name of the token key used to extract the token from the HTTP headers.
*/
tokenKeyName: TokenKeyName;
/**
* The public keys used to verify the digital signature returned by your custom authentication service.
*/
tokenSigningPublicKeys: PublicKeyMap;
/**
* The status of the create authorizer request.
*/
status?: AuthorizerStatus;
}
export interface CreateAuthorizerResponse {
/**
* The authorizer's name.
*/
authorizerName?: AuthorizerName;
/**
* The authorizer ARN.
*/
authorizerArn?: AuthorizerArn;
}
export interface CreateBillingGroupRequest {
/**
* The name you wish to give to the billing group.
*/
billingGroupName: BillingGroupName;
/**
* The properties of the billing group.
*/
billingGroupProperties?: BillingGroupProperties;
/**
* Metadata which can be used to manage the billing group.
*/
tags?: TagList;
}
export interface CreateBillingGroupResponse {
/**
* The name you gave to the billing group.
*/
billingGroupName?: BillingGroupName;
/**
* The ARN of the billing group.
*/
billingGroupArn?: BillingGroupArn;
/**
* The ID of the billing group.
*/
billingGroupId?: BillingGroupId;
}
export interface CreateCertificateFromCsrRequest {
/**
* The certificate signing request (CSR).
*/
certificateSigningRequest: CertificateSigningRequest;
/**
* Specifies whether the certificate is active.
*/
setAsActive?: SetAsActive;
}
export interface CreateCertificateFromCsrResponse {
/**
* The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.
*/
certificateArn?: CertificateArn;
/**
* The ID of the certificate. Certificate management operations only take a certificateId.
*/
certificateId?: CertificateId;
/**
* The certificate data, in PEM format.
*/
certificatePem?: CertificatePem;
}
export interface CreateDynamicThingGroupRequest {
/**
* The dynamic thing group name to create.
*/
thingGroupName: ThingGroupName;
/**
* The dynamic thing group properties.
*/
thingGroupProperties?: ThingGroupProperties;
/**
* The dynamic thing group index name. Currently one index is supported: "AWS_Things".
*/
indexName?: IndexName;
/**
* The dynamic thing group search query string. See Query Syntax for information about query string syntax.
*/
queryString: QueryString;
/**
* The dynamic thing group query version. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
*/
queryVersion?: QueryVersion;
/**
* Metadata which can be used to manage the dynamic thing group.
*/
tags?: TagList;
}
export interface CreateDynamicThingGroupResponse {
/**
* The dynamic thing group name.
*/
thingGroupName?: ThingGroupName;
/**
* The dynamic thing group ARN.
*/
thingGroupArn?: ThingGroupArn;
/**
* The dynamic thing group ID.
*/
thingGroupId?: ThingGroupId;
/**
* The dynamic thing group index name.
*/
indexName?: IndexName;
/**
* The dynamic thing group search query string.
*/
queryString?: QueryString;
/**
* The dynamic thing group query version.
*/
queryVersion?: QueryVersion;
}
export interface CreateJobRequest {
/**
* A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
*/
jobId: JobId;
/**
* A list of things and thing groups to which the job should be sent.
*/
targets: JobTargets;
/**
* An S3 link to the job document.
*/
documentSource?: JobDocumentSource;
/**
* The job document. If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking.
*/
document?: JobDocument;
/**
* A short text description of the job.
*/
description?: JobDescription;
/**
* Configuration information for pre-signed S3 URLs.
*/
presignedUrlConfig?: PresignedUrlConfig;
/**
* Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
*/
targetSelection?: TargetSelection;
/**
* Allows you to create a staged rollout of the job.
*/
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
/**
* Allows you to create criteria to abort a job.
*/
abortConfig?: AbortConfig;
/**
* Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
*/
timeoutConfig?: TimeoutConfig;
/**
* Metadata which can be used to manage the job.
*/
tags?: TagList;
}
export interface CreateJobResponse {
/**
* The job ARN.
*/
jobArn?: JobArn;
/**
* The unique identifier you assigned to this job.
*/
jobId?: JobId;
/**
* The job description.
*/
description?: JobDescription;
}
export interface CreateKeysAndCertificateRequest {
/**
* Specifies whether the certificate is active.
*/
setAsActive?: SetAsActive;
}
export interface CreateKeysAndCertificateResponse {
/**
* The ARN of the certificate.
*/
certificateArn?: CertificateArn;
/**
* The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).
*/
certificateId?: CertificateId;
/**
* The certificate data, in PEM format.
*/
certificatePem?: CertificatePem;
/**
* The generated key pair.
*/
keyPair?: KeyPair;
}
export interface CreateMitigationActionRequest {
/**
* A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).
*/
actionName: MitigationActionName;
/**
* The ARN of the IAM role that is used to apply the mitigation action.
*/
roleArn: RoleArn;
/**
* Defines the type of action and the parameters for that action.
*/
actionParams: MitigationActionParams;
/**
* Metadata that can be used to manage the mitigation action.
*/
tags?: TagList;
}
export interface CreateMitigationActionResponse {
/**
* The ARN for the new mitigation action.
*/
actionArn?: MitigationActionArn;
/**
* A unique identifier for the new mitigation action.
*/
actionId?: MitigationActionId;
}
export interface CreateOTAUpdateRequest {
/**
* The ID of the OTA update to be created.
*/
otaUpdateId: OTAUpdateId;
/**
* The description of the OTA update.
*/
description?: OTAUpdateDescription;
/**
* The targeted devices to receive OTA updates.
*/
targets: Targets;
/**
* Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
*/
targetSelection?: TargetSelection;
/**
* Configuration for the rollout of OTA updates.
*/
awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
/**
* The files to be streamed by the OTA update.
*/
files: OTAUpdateFiles;
/**
* The IAM role that allows access to the AWS IoT Jobs service.
*/
roleArn: RoleArn;
/**
* A list of additional OTA update parameters which are name-value pairs.
*/
additionalParameters?: AdditionalParameterMap;
/**
* Metadata which can be used to manage updates.
*/
tags?: TagList;
}
export interface CreateOTAUpdateResponse {
/**
* The OTA update ID.
*/
otaUpdateId?: OTAUpdateId;
/**
* The AWS IoT job ID associated with the OTA update.
*/
awsIotJobId?: AwsIotJobId;
/**
* The OTA update ARN.
*/
otaUpdateArn?: OTAUpdateArn;
/**
* The AWS IoT job ARN associated with the OTA update.
*/
awsIotJobArn?: AwsIotJobArn;
/**
* The OTA update status.
*/
otaUpdateStatus?: OTAUpdateStatus;
}
export interface CreatePolicyRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.
*/
policyDocument: PolicyDocument;
}
export interface CreatePolicyResponse {
/**
* The policy name.
*/
policyName?: PolicyName;
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
/**
* The JSON document that describes the policy.
*/
policyDocument?: PolicyDocument;
/**
* The policy version ID.
*/
policyVersionId?: PolicyVersionId;
}
export interface CreatePolicyVersionRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
*/
policyDocument: PolicyDocument;
/**
* Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).
*/
setAsDefault?: SetAsDefault;
}
export interface CreatePolicyVersionResponse {
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
/**
* The JSON document that describes the policy.
*/
policyDocument?: PolicyDocument;
/**
* The policy version ID.
*/
policyVersionId?: PolicyVersionId;
/**
* Specifies whether the policy version is the default.
*/
isDefaultVersion?: IsDefaultVersion;
}
export interface CreateRoleAliasRequest {
/**
* The role alias that points to a role ARN. This allows you to change the role without having to update the device.
*/
roleAlias: RoleAlias;
/**
* The role ARN.
*/
roleArn: RoleArn;
/**
* How long (in seconds) the credentials will be valid.
*/
credentialDurationSeconds?: CredentialDurationSeconds;
}
export interface CreateRoleAliasResponse {
/**
* The role alias.
*/
roleAlias?: RoleAlias;
/**
* The role alias ARN.
*/
roleAliasArn?: RoleAliasArn;
}
export interface CreateScheduledAuditRequest {
/**
* How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start time of each audit is determined by the system.
*/
frequency: AuditFrequency;
/**
* The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
*/
dayOfMonth?: DayOfMonth;
/**
* The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
*/
dayOfWeek?: DayOfWeek;
/**
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*/
targetCheckNames: TargetAuditCheckNames;
/**
* The name you want to give to the scheduled audit. (Max. 128 chars)
*/
scheduledAuditName: ScheduledAuditName;
/**
* Metadata that can be used to manage the scheduled audit.
*/
tags?: TagList;
}
export interface CreateScheduledAuditResponse {
/**
* The ARN of the scheduled audit.
*/
scheduledAuditArn?: ScheduledAuditArn;
}
export interface CreateSecurityProfileRequest {
/**
* The name you are giving to the security profile.
*/
securityProfileName: SecurityProfileName;
/**
* A description of the security profile.
*/
securityProfileDescription?: SecurityProfileDescription;
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
behaviors?: Behaviors;
/**
* Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
*/
alertTargets?: AlertTargets;
/**
* A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
*/
additionalMetricsToRetain?: AdditionalMetricsToRetainList;
/**
* Metadata that can be used to manage the security profile.
*/
tags?: TagList;
}
export interface CreateSecurityProfileResponse {
/**
* The name you gave to the security profile.
*/
securityProfileName?: SecurityProfileName;
/**
* The ARN of the security profile.
*/
securityProfileArn?: SecurityProfileArn;
}
export interface CreateStreamRequest {
/**
* The stream ID.
*/
streamId: StreamId;
/**
* A description of the stream.
*/
description?: StreamDescription;
/**
* The files to stream.
*/
files: StreamFiles;
/**
* An IAM role that allows the IoT service principal assumes to access your S3 files.
*/
roleArn: RoleArn;
/**
* Metadata which can be used to manage streams.
*/
tags?: TagList;
}
export interface CreateStreamResponse {
/**
* The stream ID.
*/
streamId?: StreamId;
/**
* The stream ARN.
*/
streamArn?: StreamArn;
/**
* A description of the stream.
*/
description?: StreamDescription;
/**
* The version of the stream.
*/
streamVersion?: StreamVersion;
}
export interface CreateThingGroupRequest {
/**
* The thing group name to create.
*/
thingGroupName: ThingGroupName;
/**
* The name of the parent thing group.
*/
parentGroupName?: ThingGroupName;
/**
* The thing group properties.
*/
thingGroupProperties?: ThingGroupProperties;
/**
* Metadata which can be used to manage the thing group.
*/
tags?: TagList;
}
export interface CreateThingGroupResponse {
/**
* The thing group name.
*/
thingGroupName?: ThingGroupName;
/**
* The thing group ARN.
*/
thingGroupArn?: ThingGroupArn;
/**
* The thing group ID.
*/
thingGroupId?: ThingGroupId;
}
export interface CreateThingRequest {
/**
* The name of the thing to create.
*/
thingName: ThingName;
/**
* The name of the thing type associated with the new thing.
*/
thingTypeName?: ThingTypeName;
/**
* The attribute payload, which consists of up to three name/value pairs in a JSON document. For example: {\"attributes\":{\"string1\":\"string2\"}}
*/
attributePayload?: AttributePayload;
/**
* The name of the billing group the thing will be added to.
*/
billingGroupName?: BillingGroupName;
}
export interface CreateThingResponse {
/**
* The name of the new thing.
*/
thingName?: ThingName;
/**
* The ARN of the new thing.
*/
thingArn?: ThingArn;
/**
* The thing ID.
*/
thingId?: ThingId;
}
export interface CreateThingTypeRequest {
/**
* The name of the thing type.
*/
thingTypeName: ThingTypeName;
/**
* The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.
*/
thingTypeProperties?: ThingTypeProperties;
/**
* Metadata which can be used to manage the thing type.
*/
tags?: TagList;
}
export interface CreateThingTypeResponse {
/**
* The name of the thing type.
*/
thingTypeName?: ThingTypeName;
/**
* The Amazon Resource Name (ARN) of the thing type.
*/
thingTypeArn?: ThingTypeArn;
/**
* The thing type ID.
*/
thingTypeId?: ThingTypeId;
}
export interface CreateTopicRuleRequest {
/**
* The name of the rule.
*/
ruleName: RuleName;
/**
* The rule payload.
*/
topicRulePayload: TopicRulePayload;
/**
* Metadata which can be used to manage the topic rule. For URI Request parameters use format: ...key1=value1&key2=value2... For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..." For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
*/
tags?: String;
}
export type CreatedAtDate = Date;
export type CreationDate = Date;
export type CredentialDurationSeconds = number;
export interface CustomCodeSigning {
/**
* The signature for the file.
*/
signature?: CodeSigningSignature;
/**
* The certificate chain.
*/
certificateChain?: CodeSigningCertificateChain;
/**
* The hash algorithm used to code sign the file.
*/
hashAlgorithm?: HashAlgorithm;
/**
* The signature algorithm used to code sign the file.
*/
signatureAlgorithm?: SignatureAlgorithm;
}
export type CustomerVersion = number;
export type DateType = Date;
export type DayOfMonth = string;
export type DayOfWeek = "SUN"|"MON"|"TUE"|"WED"|"THU"|"FRI"|"SAT"|string;
export interface DeleteAccountAuditConfigurationRequest {
/**
* If true, all scheduled audits are deleted.
*/
deleteScheduledAudits?: DeleteScheduledAudits;
}
export interface DeleteAccountAuditConfigurationResponse {
}
export type DeleteAdditionalMetricsToRetain = boolean;
export type DeleteAlertTargets = boolean;
export interface DeleteAuthorizerRequest {
/**
* The name of the authorizer to delete.
*/
authorizerName: AuthorizerName;
}
export interface DeleteAuthorizerResponse {
}
export type DeleteBehaviors = boolean;
export interface DeleteBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName: BillingGroupName;
/**
* The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.
*/
expectedVersion?: OptionalVersion;
}
export interface DeleteBillingGroupResponse {
}
export interface DeleteCACertificateRequest {
/**
* The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
}
export interface DeleteCACertificateResponse {
}
export interface DeleteCertificateRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
/**
* Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
*/
forceDelete?: ForceDelete;
}
export interface DeleteDynamicThingGroupRequest {
/**
* The name of the dynamic thing group to delete.
*/
thingGroupName: ThingGroupName;
/**
* The expected version of the dynamic thing group to delete.
*/
expectedVersion?: OptionalVersion;
}
export interface DeleteDynamicThingGroupResponse {
}
export interface DeleteJobExecutionRequest {
/**
* The ID of the job whose execution on a particular device will be deleted.
*/
jobId: JobId;
/**
* The name of the thing whose job execution will be deleted.
*/
thingName: ThingName;
/**
* The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device. Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.
*/
executionNumber: ExecutionNumber;
/**
* (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an exception will occur. The default is false. Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
*/
force?: ForceFlag;
}
export interface DeleteJobRequest {
/**
* The ID of the job to be deleted. After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
*/
jobId: JobId;
/**
* (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false. Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.
*/
force?: ForceFlag;
}
export interface DeleteMitigationActionRequest {
/**
* The name of the mitigation action that you want to delete.
*/
actionName: MitigationActionName;
}
export interface DeleteMitigationActionResponse {
}
export interface DeleteOTAUpdateRequest {
/**
* The OTA update ID to delete.
*/
otaUpdateId: OTAUpdateId;
/**
* Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
*/
deleteStream?: DeleteStream;
/**
* Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
*/
forceDeleteAWSJob?: ForceDeleteAWSJob;
}
export interface DeleteOTAUpdateResponse {
}
export interface DeletePolicyRequest {
/**
* The name of the policy to delete.
*/
policyName: PolicyName;
}
export interface DeletePolicyVersionRequest {
/**
* The name of the policy.
*/
policyName: PolicyName;
/**
* The policy version ID.
*/
policyVersionId: PolicyVersionId;
}
export interface DeleteRegistrationCodeRequest {
}
export interface DeleteRegistrationCodeResponse {
}
export interface DeleteRoleAliasRequest {
/**
* The role alias to delete.
*/
roleAlias: RoleAlias;
}
export interface DeleteRoleAliasResponse {
}
export interface DeleteScheduledAuditRequest {
/**
* The name of the scheduled audit you want to delete.
*/
scheduledAuditName: ScheduledAuditName;
}
export interface DeleteScheduledAuditResponse {
}
export type DeleteScheduledAudits = boolean;
export interface DeleteSecurityProfileRequest {
/**
* The name of the security profile to be deleted.
*/
securityProfileName: SecurityProfileName;
/**
* The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
*/
expectedVersion?: OptionalVersion;
}
export interface DeleteSecurityProfileResponse {
}
export type DeleteStream = boolean;
export interface DeleteStreamRequest {
/**
* The stream ID.
*/
streamId: StreamId;
}
export interface DeleteStreamResponse {
}
export interface DeleteThingGroupRequest {
/**
* The name of the thing group to delete.
*/
thingGroupName: ThingGroupName;
/**
* The expected version of the thing group to delete.
*/
expectedVersion?: OptionalVersion;
}
export interface DeleteThingGroupResponse {
}
export interface DeleteThingRequest {
/**
* The name of the thing to delete.
*/
thingName: ThingName;
/**
* The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.
*/
expectedVersion?: OptionalVersion;
}
export interface DeleteThingResponse {
}
export interface DeleteThingTypeRequest {
/**
* The name of the thing type.
*/
thingTypeName: ThingTypeName;
}
export interface DeleteThingTypeResponse {
}
export interface DeleteTopicRuleRequest {
/**
* The name of the rule.
*/
ruleName: RuleName;
}
export interface DeleteV2LoggingLevelRequest {
/**
* The type of resource for which you are configuring logging. Must be THING_Group.
*/
targetType: LogTargetType;
/**
* The name of the resource for which you are configuring logging.
*/
targetName: LogTargetName;
}
export type DeliveryStreamName = string;
export interface Denied {
/**
* Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.
*/
implicitDeny?: ImplicitDeny;
/**
* Information that explicitly denies the authorization.
*/
explicitDeny?: ExplicitDeny;
}
export interface DeprecateThingTypeRequest {
/**
* The name of the thing type to deprecate.
*/
thingTypeName: ThingTypeName;
/**
* Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.
*/
undoDeprecate?: UndoDeprecate;
}
export interface DeprecateThingTypeResponse {
}
export type DeprecationDate = Date;
export interface DescribeAccountAuditConfigurationRequest {
}
export interface DescribeAccountAuditConfigurationResponse {
/**
* The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit. On the first call to UpdateAccountAuditConfiguration, this parameter is required.
*/
roleArn?: RoleArn;
/**
* Information about the targets to which audit notifications are sent for this account.
*/
auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations;
/**
* Which audit checks are enabled and disabled for this account.
*/
auditCheckConfigurations?: AuditCheckConfigurations;
}
export interface DescribeAuditFindingRequest {
/**
* A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.
*/
findingId: FindingId;
}
export interface DescribeAuditFindingResponse {
finding?: AuditFinding;
}
export interface DescribeAuditMitigationActionsTaskRequest {
/**
* The unique identifier for the audit mitigation task.
*/
taskId: AuditMitigationActionsTaskId;
}
export interface DescribeAuditMitigationActionsTaskResponse {
/**
* The current status of the task.
*/
taskStatus?: AuditMitigationActionsTaskStatus;
/**
* The date and time when the task was started.
*/
startTime?: Timestamp;
/**
* The date and time when the task was completed or canceled.
*/
endTime?: Timestamp;
/**
* Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.
*/
taskStatistics?: AuditMitigationActionsTaskStatistics;
/**
* Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.
*/
target?: AuditMitigationActionsTaskTarget;
/**
* Specifies the mitigation actions that should be applied to specific audit checks.
*/
auditCheckToActionsMapping?: AuditCheckToActionsMapping;
/**
* Specifies the mitigation actions and their parameters that are applied as part of this task.
*/
actionsDefinition?: MitigationActionList;
}
export interface DescribeAuditTaskRequest {
/**
* The ID of the audit whose information you want to get.
*/
taskId: AuditTaskId;
}
export interface DescribeAuditTaskResponse {
/**
* The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
*/
taskStatus?: AuditTaskStatus;
/**
* The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
*/
taskType?: AuditTaskType;
/**
* The time the audit started.
*/
taskStartTime?: Timestamp;
/**
* Statistical information about the audit.
*/
taskStatistics?: TaskStatistics;
/**
* The name of the scheduled audit (only if the audit was a scheduled audit).
*/
scheduledAuditName?: ScheduledAuditName;
/**
* Detailed information about each check performed during this audit.
*/
auditDetails?: AuditDetails;
}
export interface DescribeAuthorizerRequest {
/**
* The name of the authorizer to describe.
*/
authorizerName: AuthorizerName;
}
export interface DescribeAuthorizerResponse {
/**
* The authorizer description.
*/
authorizerDescription?: AuthorizerDescription;
}
export interface DescribeBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName: BillingGroupName;
}
export interface DescribeBillingGroupResponse {
/**
* The name of the billing group.
*/
billingGroupName?: BillingGroupName;
/**
* The ID of the billing group.
*/
billingGroupId?: BillingGroupId;
/**
* The ARN of the billing group.
*/
billingGroupArn?: BillingGroupArn;
/**
* The version of the billing group.
*/
version?: Version;
/**
* The properties of the billing group.
*/
billingGroupProperties?: BillingGroupProperties;
/**
* Additional information about the billing group.
*/
billingGroupMetadata?: BillingGroupMetadata;
}
export interface DescribeCACertificateRequest {
/**
* The CA certificate identifier.
*/
certificateId: CertificateId;
}
export interface DescribeCACertificateResponse {
/**
* The CA certificate description.
*/
certificateDescription?: CACertificateDescription;
/**
* Information about the registration configuration.
*/
registrationConfig?: RegistrationConfig;
}
export interface DescribeCertificateRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
}
export interface DescribeCertificateResponse {
/**
* The description of the certificate.
*/
certificateDescription?: CertificateDescription;
}
export interface DescribeDefaultAuthorizerRequest {
}
export interface DescribeDefaultAuthorizerResponse {
/**
* The default authorizer's description.
*/
authorizerDescription?: AuthorizerDescription;
}
export interface DescribeEndpointRequest {
/**
* The endpoint type. Valid endpoint types include: iot:Data - Returns a VeriSign signed data endpoint. iot:Data-ATS - Returns an ATS signed data endpoint. iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint. iot:Jobs - Returns an AWS IoT device management Jobs API endpoint.
*/
endpointType?: EndpointType;
}
export interface DescribeEndpointResponse {
/**
* The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.
*/
endpointAddress?: EndpointAddress;
}
export interface DescribeEventConfigurationsRequest {
}
export interface DescribeEventConfigurationsResponse {
/**
* The event configurations.
*/
eventConfigurations?: EventConfigurations;
/**
* The creation date of the event configuration.
*/
creationDate?: CreationDate;
/**
* The date the event configurations were last modified.
*/
lastModifiedDate?: LastModifiedDate;
}
export interface DescribeIndexRequest {
/**
* The index name.
*/
indexName: IndexName;
}
export interface DescribeIndexResponse {
/**
* The index name.
*/
indexName?: IndexName;
/**
* The index status.
*/
indexStatus?: IndexStatus;
/**
* Contains a value that specifies the type of indexing performed. Valid values are: REGISTRY – Your thing index contains only registry data. REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data. REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data. REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.
*/
schema?: IndexSchema;
}
export interface DescribeJobExecutionRequest {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
/**
* The name of the thing on which the job execution is running.
*/
thingName: ThingName;
/**
* A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.
*/
executionNumber?: ExecutionNumber;
}
export interface DescribeJobExecutionResponse {
/**
* Information about the job execution.
*/
execution?: JobExecution;
}
export interface DescribeJobRequest {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
}
export interface DescribeJobResponse {
/**
* An S3 link to the job document.
*/
documentSource?: JobDocumentSource;
/**
* Information about the job.
*/
job?: Job;
}
export interface DescribeMitigationActionRequest {
/**
* The friendly name that uniquely identifies the mitigation action.
*/
actionName: MitigationActionName;
}
export interface DescribeMitigationActionResponse {
/**
* The friendly name that uniquely identifies the mitigation action.
*/
actionName?: MitigationActionName;
/**
* The type of mitigation action.
*/
actionType?: MitigationActionType;
/**
* The ARN that identifies this migration action.
*/
actionArn?: MitigationActionArn;
/**
* A unique identifier for this action.
*/
actionId?: MitigationActionId;
/**
* The ARN of the IAM role used to apply this action.
*/
roleArn?: RoleArn;
/**
* Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
*/
actionParams?: MitigationActionParams;
/**
* The date and time when the mitigation action was added to your AWS account.
*/
creationDate?: Timestamp;
/**
* The date and time when the mitigation action was last changed.
*/
lastModifiedDate?: Timestamp;
}
export interface DescribeRoleAliasRequest {
/**
* The role alias to describe.
*/
roleAlias: RoleAlias;
}
export interface DescribeRoleAliasResponse {
/**
* The role alias description.
*/
roleAliasDescription?: RoleAliasDescription;
}
export interface DescribeScheduledAuditRequest {
/**
* The name of the scheduled audit whose information you want to get.
*/
scheduledAuditName: ScheduledAuditName;
}
export interface DescribeScheduledAuditResponse {
/**
* How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
*/
frequency?: AuditFrequency;
/**
* The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
*/
dayOfMonth?: DayOfMonth;
/**
* The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT".
*/
dayOfWeek?: DayOfWeek;
/**
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*/
targetCheckNames?: TargetAuditCheckNames;
/**
* The name of the scheduled audit.
*/
scheduledAuditName?: ScheduledAuditName;
/**
* The ARN of the scheduled audit.
*/
scheduledAuditArn?: ScheduledAuditArn;
}
export interface DescribeSecurityProfileRequest {
/**
* The name of the security profile whose information you want to get.
*/
securityProfileName: SecurityProfileName;
}
export interface DescribeSecurityProfileResponse {
/**
* The name of the security profile.
*/
securityProfileName?: SecurityProfileName;
/**
* The ARN of the security profile.
*/
securityProfileArn?: SecurityProfileArn;
/**
* A description of the security profile (associated with the security profile when it was created or updated).
*/
securityProfileDescription?: SecurityProfileDescription;
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
behaviors?: Behaviors;
/**
* Where the alerts are sent. (Alerts are always sent to the console.)
*/
alertTargets?: AlertTargets;
/**
* A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
*/
additionalMetricsToRetain?: AdditionalMetricsToRetainList;
/**
* The version of the security profile. A new version is generated whenever the security profile is updated.
*/
version?: Version;
/**
* The time the security profile was created.
*/
creationDate?: Timestamp;
/**
* The time the security profile was last modified.
*/
lastModifiedDate?: Timestamp;
}
export interface DescribeStreamRequest {
/**
* The stream ID.
*/
streamId: StreamId;
}
export interface DescribeStreamResponse {
/**
* Information about the stream.
*/
streamInfo?: StreamInfo;
}
export interface DescribeThingGroupRequest {
/**
* The name of the thing group.
*/
thingGroupName: ThingGroupName;
}
export interface DescribeThingGroupResponse {
/**
* The name of the thing group.
*/
thingGroupName?: ThingGroupName;
/**
* The thing group ID.
*/
thingGroupId?: ThingGroupId;
/**
* The thing group ARN.
*/
thingGroupArn?: ThingGroupArn;
/**
* The version of the thing group.
*/
version?: Version;
/**
* The thing group properties.
*/
thingGroupProperties?: ThingGroupProperties;
/**
* Thing group metadata.
*/
thingGroupMetadata?: ThingGroupMetadata;
/**
* The dynamic thing group index name.
*/
indexName?: IndexName;
/**
* The dynamic thing group search query string.
*/
queryString?: QueryString;
/**
* The dynamic thing group query version.
*/
queryVersion?: QueryVersion;
/**
* The dynamic thing group status.
*/
status?: DynamicGroupStatus;
}
export interface DescribeThingRegistrationTaskRequest {
/**
* The task ID.
*/
taskId: TaskId;
}
export interface DescribeThingRegistrationTaskResponse {
/**
* The task ID.
*/
taskId?: TaskId;
/**
* The task creation date.
*/
creationDate?: CreationDate;
/**
* The date when the task was last modified.
*/
lastModifiedDate?: LastModifiedDate;
/**
* The task's template.
*/
templateBody?: TemplateBody;
/**
* The S3 bucket that contains the input file.
*/
inputFileBucket?: RegistryS3BucketName;
/**
* The input file key.
*/
inputFileKey?: RegistryS3KeyName;
/**
* The role ARN that grants access to the input file bucket.
*/
roleArn?: RoleArn;
/**
* The status of the bulk thing provisioning task.
*/
status?: Status;
/**
* The message.
*/
message?: ErrorMessage;
/**
* The number of things successfully provisioned.
*/
successCount?: Count;
/**
* The number of things that failed to be provisioned.
*/
failureCount?: Count;
/**
* The progress of the bulk provisioning task expressed as a percentage.
*/
percentageProgress?: Percentage;
}
export interface DescribeThingRequest {
/**
* The name of the thing.
*/
thingName: ThingName;
}
export interface DescribeThingResponse {
/**
* The default client ID.
*/
defaultClientId?: ClientId;
/**
* The name of the thing.
*/
thingName?: ThingName;
/**
* The ID of the thing to describe.
*/
thingId?: ThingId;
/**
* The ARN of the thing to describe.
*/
thingArn?: ThingArn;
/**
* The thing type name.
*/
thingTypeName?: ThingTypeName;
/**
* The thing attributes.
*/
attributes?: Attributes;
/**
* The current version of the thing record in the registry. To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.
*/
version?: Version;
/**
* The name of the billing group the thing belongs to.
*/
billingGroupName?: BillingGroupName;
}
export interface DescribeThingTypeRequest {
/**
* The name of the thing type.
*/
thingTypeName: ThingTypeName;
}
export interface DescribeThingTypeResponse {
/**
* The name of the thing type.
*/
thingTypeName?: ThingTypeName;
/**
* The thing type ID.
*/
thingTypeId?: ThingTypeId;
/**
* The thing type ARN.
*/
thingTypeArn?: ThingTypeArn;
/**
* The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.
*/
thingTypeProperties?: ThingTypeProperties;
/**
* The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
*/
thingTypeMetadata?: ThingTypeMetadata;
}
export type Description = string;
export interface Destination {
/**
* Describes the location in S3 of the updated firmware.
*/
s3Destination?: S3Destination;
}
export interface DetachPolicyRequest {
/**
* The policy to detach.
*/
policyName: PolicyName;
/**
* The target from which the policy will be detached.
*/
target: PolicyTarget;
}
export interface DetachPrincipalPolicyRequest {
/**
* The name of the policy to detach.
*/
policyName: PolicyName;
/**
* The principal. If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.
*/
principal: Principal;
}
export interface DetachSecurityProfileRequest {
/**
* The security profile that is detached.
*/
securityProfileName: SecurityProfileName;
/**
* The ARN of the thing group from which the security profile is detached.
*/
securityProfileTargetArn: SecurityProfileTargetArn;
}
export interface DetachSecurityProfileResponse {
}
export interface DetachThingPrincipalRequest {
/**
* The name of the thing.
*/
thingName: ThingName;
/**
* If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.
*/
principal: Principal;
}
export interface DetachThingPrincipalResponse {
}
export type DetailsKey = string;
export type DetailsMap = {[key: string]: DetailsValue};
export type DetailsValue = string;
export type DeviceCertificateUpdateAction = "DEACTIVATE"|string;
export type DeviceDefenderThingName = string;
export type DisableAllLogs = boolean;
export interface DisableTopicRuleRequest {
/**
* The name of the rule to disable.
*/
ruleName: RuleName;
}
export type DurationSeconds = number;
export type DynamicGroupStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string;
export interface DynamoDBAction {
/**
* The name of the DynamoDB table.
*/
tableName: TableName;
/**
* The ARN of the IAM role that grants access to the DynamoDB table.
*/
roleArn: AwsArn;
/**
* The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
*/
operation?: DynamoOperation;
/**
* The hash key name.
*/
hashKeyField: HashKeyField;
/**
* The hash key value.
*/
hashKeyValue: HashKeyValue;
/**
* The hash key type. Valid values are "STRING" or "NUMBER"
*/
hashKeyType?: DynamoKeyType;
/**
* The range key name.
*/
rangeKeyField?: RangeKeyField;
/**
* The range key value.
*/
rangeKeyValue?: RangeKeyValue;
/**
* The range key type. Valid values are "STRING" or "NUMBER"
*/
rangeKeyType?: DynamoKeyType;
/**
* The action payload. This name can be customized.
*/
payloadField?: PayloadField;
}
export interface DynamoDBv2Action {
/**
* The ARN of the IAM role that grants access to the DynamoDB table.
*/
roleArn: AwsArn;
/**
* Specifies the DynamoDB table to which the message data will be written. For example: { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } } Each attribute in the message payload will be written to a separate column in the DynamoDB database.
*/
putItem: PutItemInput;
}
export type DynamoKeyType = "STRING"|"NUMBER"|string;
export type DynamoOperation = string;
export type EffectivePolicies = EffectivePolicy[];
export interface EffectivePolicy {
/**
* The policy name.
*/
policyName?: PolicyName;
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
/**
* The IAM policy document.
*/
policyDocument?: PolicyDocument;
}
export interface ElasticsearchAction {
/**
* The IAM role ARN that has access to Elasticsearch.
*/
roleArn: AwsArn;
/**
* The endpoint of your Elasticsearch domain.
*/
endpoint: ElasticsearchEndpoint;
/**
* The Elasticsearch index where you want to store your data.
*/
index: ElasticsearchIndex;
/**
* The type of document you are storing.
*/
type: ElasticsearchType;
/**
* The unique identifier for the document you are storing.
*/
id: ElasticsearchId;
}
export type ElasticsearchEndpoint = string;
export type ElasticsearchId = string;
export type ElasticsearchIndex = string;
export type ElasticsearchType = string;
export interface EnableIoTLoggingParams {
/**
* The ARN of the IAM role used for logging.
*/
roleArnForLogging: RoleArn;
/**
* Specifies the types of information to be logged.
*/
logLevel: LogLevel;
}
export interface EnableTopicRuleRequest {
/**
* The name of the topic rule to enable.
*/
ruleName: RuleName;
}
export type Enabled = boolean;
export type EndpointAddress = string;
export type EndpointType = string;
export type ErrorCode = string;
export interface ErrorInfo {
/**
* The error code.
*/
code?: Code;
/**
* The error message.
*/
message?: OTAUpdateErrorMessage;
}
export type ErrorMessage = string;
export type EvaluationStatistic = string;
export type EventConfigurations = {[key: string]: Configuration};
export type EventType = "THING"|"THING_GROUP"|"THING_TYPE"|"THING_GROUP_MEMBERSHIP"|"THING_GROUP_HIERARCHY"|"THING_TYPE_ASSOCIATION"|"JOB"|"JOB_EXECUTION"|"POLICY"|"CERTIFICATE"|"CA_CERTIFICATE"|string;
export type ExecutionNamePrefix = string;
export type ExecutionNumber = number;
export type ExpectedVersion = number;
export type ExpiresInSec = number;
export interface ExplicitDeny {
/**
* The policies that denied the authorization.
*/
policies?: Policies;
}
export interface ExponentialRolloutRate {
/**
* The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.
*/
baseRatePerMinute: RolloutRatePerMinute;
/**
* The exponential factor to increase the rate of rollout for a job.
*/
incrementFactor: IncrementFactor;
/**
* The criteria to initiate the increase in rate of rollout for a job. AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).
*/
rateIncreaseCriteria: RateIncreaseCriteria;
}
export type FailedChecksCount = number;
export type FailedFindingsCount = number;
export type FailedThings = number;
export interface Field {
/**
* The name of the field.
*/
name?: FieldName;
/**
* The datatype of the field.
*/
type?: FieldType;
}
export type FieldName = string;
export type FieldType = "Number"|"String"|"Boolean"|string;
export type Fields = Field[];
export type FileId = number;
export interface FileLocation {
/**
* The stream that contains the OTA update.
*/
stream?: Stream;
/**
* The location of the updated firmware in S3.
*/
s3Location?: S3Location;
}
export type FileName = string;
export type FindingId = string;
export type FindingIds = FindingId[];
export interface FirehoseAction {
/**
* The IAM role that grants access to the Amazon Kinesis Firehose stream.
*/
roleArn: AwsArn;
/**
* The delivery stream name.
*/
deliveryStreamName: DeliveryStreamName;
/**
* A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
*/
separator?: FirehoseSeparator;
}
export type FirehoseSeparator = string;
export type Flag = boolean;
export type ForceDelete = boolean;
export type ForceDeleteAWSJob = boolean;
export type ForceFlag = boolean;
export type Forced = boolean;
export type FunctionArn = string;
export type GEMaxResults = number;
export type GenerationId = string;
export interface GetCardinalityRequest {
/**
* The name of the index to search.
*/
indexName?: IndexName;
/**
* The search query.
*/
queryString: QueryString;
/**
* The field to aggregate.
*/
aggregationField?: AggregationField;
/**
* The query version.
*/
queryVersion?: QueryVersion;
}
export interface GetCardinalityResponse {
/**
* The number of things that match the query.
*/
cardinality?: Count;
}
export interface GetEffectivePoliciesRequest {
/**
* The principal.
*/
principal?: Principal;
/**
* The Cognito identity pool ID.
*/
cognitoIdentityPoolId?: CognitoIdentityPoolId;
/**
* The thing name.
*/
thingName?: ThingName;
}
export interface GetEffectivePoliciesResponse {
/**
* The effective policies.
*/
effectivePolicies?: EffectivePolicies;
}
export interface GetIndexingConfigurationRequest {
}
export interface GetIndexingConfigurationResponse {
/**
* Thing indexing configuration.
*/
thingIndexingConfiguration?: ThingIndexingConfiguration;
/**
* The index configuration.
*/
thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
}
export interface GetJobDocumentRequest {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
}
export interface GetJobDocumentResponse {
/**
* The job document content.
*/
document?: JobDocument;
}
export interface GetLoggingOptionsRequest {
}
export interface GetLoggingOptionsResponse {
/**
* The ARN of the IAM role that grants access.
*/
roleArn?: AwsArn;
/**
* The logging level.
*/
logLevel?: LogLevel;
}
export interface GetOTAUpdateRequest {
/**
* The OTA update ID.
*/
otaUpdateId: OTAUpdateId;
}
export interface GetOTAUpdateResponse {
/**
* The OTA update info.
*/
otaUpdateInfo?: OTAUpdateInfo;
}
export interface GetPercentilesRequest {
/**
* The name of the index to search.
*/
indexName?: IndexName;
/**
* The query string.
*/
queryString: QueryString;
/**
* The field to aggregate.
*/
aggregationField?: AggregationField;
/**
* The query version.
*/
queryVersion?: QueryVersion;
/**
* The percentile groups returned.
*/
percents?: PercentList;
}
export interface GetPercentilesResponse {
/**
* The percentile values of the aggregated fields.
*/
percentiles?: Percentiles;
}
export interface GetPolicyRequest {
/**
* The name of the policy.
*/
policyName: PolicyName;
}
export interface GetPolicyResponse {
/**
* The policy name.
*/
policyName?: PolicyName;
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
/**
* The JSON document that describes the policy.
*/
policyDocument?: PolicyDocument;
/**
* The default policy version ID.
*/
defaultVersionId?: PolicyVersionId;
/**
* The date the policy was created.
*/
creationDate?: DateType;
/**
* The date the policy was last modified.
*/
lastModifiedDate?: DateType;
/**
* The generation ID of the policy.
*/
generationId?: GenerationId;
}
export interface GetPolicyVersionRequest {
/**
* The name of the policy.
*/
policyName: PolicyName;
/**
* The policy version ID.
*/
policyVersionId: PolicyVersionId;
}
export interface GetPolicyVersionResponse {
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
/**
* The policy name.
*/
policyName?: PolicyName;
/**
* The JSON document that describes the policy.
*/
policyDocument?: PolicyDocument;
/**
* The policy version ID.
*/
policyVersionId?: PolicyVersionId;
/**
* Specifies whether the policy version is the default.
*/
isDefaultVersion?: IsDefaultVersion;
/**
* The date the policy was created.
*/
creationDate?: DateType;
/**
* The date the policy was last modified.
*/
lastModifiedDate?: DateType;
/**
* The generation ID of the policy version.
*/
generationId?: GenerationId;
}
export interface GetRegistrationCodeRequest {
}
export interface GetRegistrationCodeResponse {
/**
* The CA certificate registration code.
*/
registrationCode?: RegistrationCode;
}
export interface GetStatisticsRequest {
/**
* The name of the index to search. The default value is AWS_Things.
*/
indexName?: IndexName;
/**
* The query used to search. You can specify "*" for the query string to get the count of all indexed things in your AWS account.
*/
queryString: QueryString;
/**
* The aggregation field name.
*/
aggregationField?: AggregationField;
/**
* The version of the query used to search.
*/
queryVersion?: QueryVersion;
}
export interface GetStatisticsResponse {
/**
* The statistics returned by the Fleet Indexing service based on the query and aggregation field.
*/
statistics?: Statistics;
}
export interface GetTopicRuleRequest {
/**
* The name of the rule.
*/
ruleName: RuleName;
}
export interface GetTopicRuleResponse {
/**
* The rule ARN.
*/
ruleArn?: RuleArn;
/**
* The rule.
*/
rule?: TopicRule;
}
export interface GetV2LoggingOptionsRequest {
}
export interface GetV2LoggingOptionsResponse {
/**
* The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
*/
roleArn?: AwsArn;
/**
* The default log level.
*/
defaultLogLevel?: LogLevel;
/**
* Disables all logs.
*/
disableAllLogs?: DisableAllLogs;
}
export interface GroupNameAndArn {
/**
* The group name.
*/
groupName?: ThingGroupName;
/**
* The group ARN.
*/
groupArn?: ThingGroupArn;
}
export type HashAlgorithm = string;
export type HashKeyField = string;
export type HashKeyValue = string;
export interface ImplicitDeny {
/**
* Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.
*/
policies?: Policies;
}
export type InProgressChecksCount = number;
export type InProgressThings = number;
export type InProgressTimeoutInMinutes = number;
export type IncrementFactor = number;
export type IndexName = string;
export type IndexNamesList = IndexName[];
export type IndexSchema = string;
export type IndexStatus = "ACTIVE"|"BUILDING"|"REBUILDING"|string;
export type InlineDocument = string;
export type InputName = string;
export interface IotAnalyticsAction {
/**
* (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
*/
channelArn?: AwsArn;
/**
* The name of the IoT Analytics channel to which message data will be sent.
*/
channelName?: ChannelName;
/**
* The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
*/
roleArn?: AwsArn;
}
export interface IotEventsAction {
/**
* The name of the AWS IoT Events input.
*/
inputName: InputName;
/**
* [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.
*/
messageId?: MessageId;
/**
* The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
*/
roleArn: AwsArn;
}
export type IsAuthenticated = boolean;
export type IsDefaultVersion = boolean;
export type IsDisabled = boolean;
export interface Job {
/**
* An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
*/
jobArn?: JobArn;
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId?: JobId;
/**
* Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
*/
targetSelection?: TargetSelection;
/**
* The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.
*/
status?: JobStatus;
/**
* Will be true if the job was canceled with the optional force parameter set to true.
*/
forceCanceled?: Forced;
/**
* If the job was updated, provides the reason code for the update.
*/
reasonCode?: ReasonCode;
/**
* If the job was updated, describes the reason for the update.
*/
comment?: Comment;
/**
* A list of IoT things and thing groups to which the job should be sent.
*/
targets?: JobTargets;
/**
* A short text description of the job.
*/
description?: JobDescription;
/**
* Configuration for pre-signed S3 URLs.
*/
presignedUrlConfig?: PresignedUrlConfig;
/**
* Allows you to create a staged rollout of a job.
*/
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
/**
* Configuration for criteria to abort the job.
*/
abortConfig?: AbortConfig;
/**
* The time, in seconds since the epoch, when the job was created.
*/
createdAt?: DateType;
/**
* The time, in seconds since the epoch, when the job was last updated.
*/
lastUpdatedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job was completed.
*/
completedAt?: DateType;
/**
* Details about the job process.
*/
jobProcessDetails?: JobProcessDetails;
/**
* Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.
*/
timeoutConfig?: TimeoutConfig;
}
export type JobArn = string;
export type JobDescription = string;
export type JobDocument = string;
export type JobDocumentSource = string;
export interface JobExecution {
/**
* The unique identifier you assigned to the job when it was created.
*/
jobId?: JobId;
/**
* The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
*/
status?: JobExecutionStatus;
/**
* Will be true if the job execution was canceled with the optional force parameter set to true.
*/
forceCanceled?: Forced;
/**
* A collection of name/value pairs that describe the status of the job execution.
*/
statusDetails?: JobExecutionStatusDetails;
/**
* The ARN of the thing on which the job execution is running.
*/
thingArn?: ThingArn;
/**
* The time, in seconds since the epoch, when the job execution was queued.
*/
queuedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job execution started.
*/
startedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job execution was last updated.
*/
lastUpdatedAt?: DateType;
/**
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
*/
executionNumber?: ExecutionNumber;
/**
* The version of the job execution. Job execution versions are incremented each time they are updated by a device.
*/
versionNumber?: VersionNumber;
/**
* The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.
*/
approximateSecondsBeforeTimedOut?: ApproximateSecondsBeforeTimedOut;
}
export type JobExecutionFailureType = "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL"|string;
export type JobExecutionStatus = "QUEUED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"REJECTED"|"REMOVED"|"CANCELED"|string;
export interface JobExecutionStatusDetails {
/**
* The job execution status.
*/
detailsMap?: DetailsMap;
}
export interface JobExecutionSummary {
/**
* The status of the job execution.
*/
status?: JobExecutionStatus;
/**
* The time, in seconds since the epoch, when the job execution was queued.
*/
queuedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job execution started.
*/
startedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job execution was last updated.
*/
lastUpdatedAt?: DateType;
/**
* A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.
*/
executionNumber?: ExecutionNumber;
}
export interface JobExecutionSummaryForJob {
/**
* The ARN of the thing on which the job execution is running.
*/
thingArn?: ThingArn;
/**
* Contains a subset of information about a job execution.
*/
jobExecutionSummary?: JobExecutionSummary;
}
export type JobExecutionSummaryForJobList = JobExecutionSummaryForJob[];
export interface JobExecutionSummaryForThing {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId?: JobId;
/**
* Contains a subset of information about a job execution.
*/
jobExecutionSummary?: JobExecutionSummary;
}
export type JobExecutionSummaryForThingList = JobExecutionSummaryForThing[];
export interface JobExecutionsRolloutConfig {
/**
* The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
*/
maximumPerMinute?: MaxJobExecutionsPerMin;
/**
* The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
*/
exponentialRate?: ExponentialRolloutRate;
}
export type JobId = string;
export interface JobProcessDetails {
/**
* The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.
*/
processingTargets?: ProcessingTargetNameList;
/**
* The number of things that cancelled the job.
*/
numberOfCanceledThings?: CanceledThings;
/**
* The number of things which successfully completed the job.
*/
numberOfSucceededThings?: SucceededThings;
/**
* The number of things that failed executing the job.
*/
numberOfFailedThings?: FailedThings;
/**
* The number of things that rejected the job.
*/
numberOfRejectedThings?: RejectedThings;
/**
* The number of things that are awaiting execution of the job.
*/
numberOfQueuedThings?: QueuedThings;
/**
* The number of things currently executing the job.
*/
numberOfInProgressThings?: InProgressThings;
/**
* The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.
*/
numberOfRemovedThings?: RemovedThings;
/**
* The number of things whose job execution status is TIMED_OUT.
*/
numberOfTimedOutThings?: TimedOutThings;
}
export type JobStatus = "IN_PROGRESS"|"CANCELED"|"COMPLETED"|"DELETION_IN_PROGRESS"|string;
export interface JobSummary {
/**
* The job ARN.
*/
jobArn?: JobArn;
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId?: JobId;
/**
* The ID of the thing group.
*/
thingGroupId?: ThingGroupId;
/**
* Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
*/
targetSelection?: TargetSelection;
/**
* The job summary status.
*/
status?: JobStatus;
/**
* The time, in seconds since the epoch, when the job was created.
*/
createdAt?: DateType;
/**
* The time, in seconds since the epoch, when the job was last updated.
*/
lastUpdatedAt?: DateType;
/**
* The time, in seconds since the epoch, when the job completed.
*/
completedAt?: DateType;
}
export type JobSummaryList = JobSummary[];
export type JobTargets = TargetArn[];
export type JsonDocument = string;
export type Key = string;
export type KeyName = string;
export interface KeyPair {
/**
* The public key.
*/
PublicKey?: PublicKey;
/**
* The private key.
*/
PrivateKey?: PrivateKey;
}
export type KeyValue = string;
export interface KinesisAction {
/**
* The ARN of the IAM role that grants access to the Amazon Kinesis stream.
*/
roleArn: AwsArn;
/**
* The name of the Amazon Kinesis stream.
*/
streamName: StreamName;
/**
* The partition key.
*/
partitionKey?: PartitionKey;
}
export interface LambdaAction {
/**
* The ARN of the Lambda function.
*/
functionArn: FunctionArn;
}
export type LaserMaxResults = number;
export type LastModifiedDate = Date;
export interface ListActiveViolationsRequest {
/**
* The name of the thing whose active violations are listed.
*/
thingName?: DeviceDefenderThingName;
/**
* The name of the Device Defender security profile for which violations are listed.
*/
securityProfileName?: SecurityProfileName;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
}
export interface ListActiveViolationsResponse {
/**
* The list of active violations.
*/
activeViolations?: ActiveViolations;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListAttachedPoliciesRequest {
/**
* The group or principal for which the policies will be listed.
*/
target: PolicyTarget;
/**
* When true, recursively list attached policies.
*/
recursive?: Recursive;
/**
* The token to retrieve the next set of results.
*/
marker?: Marker;
/**
* The maximum number of results to be returned per request.
*/
pageSize?: PageSize;
}
export interface ListAttachedPoliciesResponse {
/**
* The policies.
*/
policies?: Policies;
/**
* The token to retrieve the next set of results, or ``null`` if there are no more results.
*/
nextMarker?: Marker;
}
export interface ListAuditFindingsRequest {
/**
* A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
*/
taskId?: AuditTaskId;
/**
* A filter to limit results to the findings for the specified audit check.
*/
checkName?: AuditCheckName;
/**
* Information identifying the noncompliant resource.
*/
resourceIdentifier?: ResourceIdentifier;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
*/
startTime?: Timestamp;
/**
* A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
*/
endTime?: Timestamp;
}
export interface ListAuditFindingsResponse {
/**
* The findings (results) of the audit.
*/
findings?: AuditFindings;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListAuditMitigationActionsExecutionsRequest {
/**
* Specify this filter to limit results to actions for a specific audit mitigation actions task.
*/
taskId: AuditMitigationActionsTaskId;
/**
* Specify this filter to limit results to those with a specific status.
*/
actionStatus?: AuditMitigationActionsExecutionStatus;
/**
* Specify this filter to limit results to those that were applied to a specific audit finding.
*/
findingId: FindingId;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
}
export interface ListAuditMitigationActionsExecutionsResponse {
/**
* A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.
*/
actionsExecutions?: AuditMitigationActionExecutionMetadataList;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
}
export interface ListAuditMitigationActionsTasksRequest {
/**
* Specify this filter to limit results to tasks that were applied to results for a specific audit.
*/
auditTaskId?: AuditTaskId;
/**
* Specify this filter to limit results to tasks that were applied to a specific audit finding.
*/
findingId?: FindingId;
/**
* Specify this filter to limit results to tasks that are in a specific state.
*/
taskStatus?: AuditMitigationActionsTaskStatus;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* Specify this filter to limit results to tasks that began on or after a specific date and time.
*/
startTime: Timestamp;
/**
* Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.
*/
endTime: Timestamp;
}
export interface ListAuditMitigationActionsTasksResponse {
/**
* The collection of audit mitigation tasks that matched the filter criteria.
*/
tasks?: AuditMitigationActionsTaskMetadataList;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
}
export interface ListAuditTasksRequest {
/**
* The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
*/
startTime: Timestamp;
/**
* The end of the time period.
*/
endTime: Timestamp;
/**
* A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
*/
taskType?: AuditTaskType;
/**
* A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
*/
taskStatus?: AuditTaskStatus;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
}
export interface ListAuditTasksResponse {
/**
* The audits that were performed during the specified time period.
*/
tasks?: AuditTaskMetadataList;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListAuthorizersRequest {
/**
* The maximum number of results to return at one time.
*/
pageSize?: PageSize;
/**
* A marker used to get the next set of results.
*/
marker?: Marker;
/**
* Return the list of authorizers in ascending alphabetical order.
*/
ascendingOrder?: AscendingOrder;
/**
* The status of the list authorizers request.
*/
status?: AuthorizerStatus;
}
export interface ListAuthorizersResponse {
/**
* The authorizers.
*/
authorizers?: Authorizers;
/**
* A marker used to get the next set of results.
*/
nextMarker?: Marker;
}
export interface ListBillingGroupsRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return per request.
*/
maxResults?: RegistryMaxResults;
/**
* Limit the results to billing groups whose names have the given prefix.
*/
namePrefixFilter?: BillingGroupName;
}
export interface ListBillingGroupsResponse {
/**
* The list of billing groups.
*/
billingGroups?: BillingGroupNameAndArnList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListCACertificatesRequest {
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* Determines the order of the results.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListCACertificatesResponse {
/**
* The CA certificates registered in your AWS account.
*/
certificates?: CACertificates;
/**
* The current position within the list of CA certificates.
*/
nextMarker?: Marker;
}
export interface ListCertificatesByCARequest {
/**
* The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.
*/
caCertificateId: CertificateId;
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListCertificatesByCAResponse {
/**
* The device certificates signed by the specified CA certificate.
*/
certificates?: Certificates;
/**
* The marker for the next set of results, or null if there are no additional results.
*/
nextMarker?: Marker;
}
export interface ListCertificatesRequest {
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListCertificatesResponse {
/**
* The descriptions of the certificates.
*/
certificates?: Certificates;
/**
* The marker for the next set of results, or null if there are no additional results.
*/
nextMarker?: Marker;
}
export interface ListIndicesRequest {
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: QueryMaxResults;
}
export interface ListIndicesResponse {
/**
* The index names.
*/
indexNames?: IndexNamesList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListJobExecutionsForJobRequest {
/**
* The unique identifier you assigned to this job when it was created.
*/
jobId: JobId;
/**
* The status of the job.
*/
status?: JobExecutionStatus;
/**
* The maximum number of results to be returned per request.
*/
maxResults?: LaserMaxResults;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
}
export interface ListJobExecutionsForJobResponse {
/**
* A list of job execution summaries.
*/
executionSummaries?: JobExecutionSummaryForJobList;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListJobExecutionsForThingRequest {
/**
* The thing name.
*/
thingName: ThingName;
/**
* An optional filter that lets you search for jobs that have the specified status.
*/
status?: JobExecutionStatus;
/**
* The maximum number of results to be returned per request.
*/
maxResults?: LaserMaxResults;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
}
export interface ListJobExecutionsForThingResponse {
/**
* A list of job execution summaries.
*/
executionSummaries?: JobExecutionSummaryForThingList;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListJobsRequest {
/**
* An optional filter that lets you search for jobs that have the specified status.
*/
status?: JobStatus;
/**
* Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.
*/
targetSelection?: TargetSelection;
/**
* The maximum number of results to return per request.
*/
maxResults?: LaserMaxResults;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* A filter that limits the returned jobs to those for the specified group.
*/
thingGroupName?: ThingGroupName;
/**
* A filter that limits the returned jobs to those for the specified group.
*/
thingGroupId?: ThingGroupId;
}
export interface ListJobsResponse {
/**
* A list of jobs.
*/
jobs?: JobSummaryList;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListMitigationActionsRequest {
/**
* Specify a value to limit the result to mitigation actions with a specific action type.
*/
actionType?: MitigationActionType;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
}
export interface ListMitigationActionsResponse {
/**
* A set of actions that matched the specified filter criteria.
*/
actionIdentifiers?: MitigationActionIdentifierList;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
}
export interface ListOTAUpdatesRequest {
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
/**
* A token used to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The OTA update job status.
*/
otaUpdateStatus?: OTAUpdateStatus;
}
export interface ListOTAUpdatesResponse {
/**
* A list of OTA update jobs.
*/
otaUpdates?: OTAUpdatesSummary;
/**
* A token to use to get the next set of results.
*/
nextToken?: NextToken;
}
export interface ListOutgoingCertificatesRequest {
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListOutgoingCertificatesResponse {
/**
* The certificates that are being transferred but not yet accepted.
*/
outgoingCertificates?: OutgoingCertificates;
/**
* The marker for the next set of results.
*/
nextMarker?: Marker;
}
export interface ListPoliciesRequest {
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* Specifies the order for results. If true, the results are returned in ascending creation order.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListPoliciesResponse {
/**
* The descriptions of the policies.
*/
policies?: Policies;
/**
* The marker for the next set of results, or null if there are no additional results.
*/
nextMarker?: Marker;
}
export interface ListPolicyPrincipalsRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* Specifies the order for results. If true, the results are returned in ascending creation order.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListPolicyPrincipalsResponse {
/**
* The descriptions of the principals.
*/
principals?: Principals;
/**
* The marker for the next set of results, or null if there are no additional results.
*/
nextMarker?: Marker;
}
export interface ListPolicyVersionsRequest {
/**
* The policy name.
*/
policyName: PolicyName;
}
export interface ListPolicyVersionsResponse {
/**
* The policy versions.
*/
policyVersions?: PolicyVersions;
}
export interface ListPrincipalPoliciesRequest {
/**
* The principal.
*/
principal: Principal;
/**
* The marker for the next set of results.
*/
marker?: Marker;
/**
* The result page size.
*/
pageSize?: PageSize;
/**
* Specifies the order for results. If true, results are returned in ascending creation order.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListPrincipalPoliciesResponse {
/**
* The policies.
*/
policies?: Policies;
/**
* The marker for the next set of results, or null if there are no additional results.
*/
nextMarker?: Marker;
}
export interface ListPrincipalThingsRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return in this operation.
*/
maxResults?: RegistryMaxResults;
/**
* The principal.
*/
principal: Principal;
}
export interface ListPrincipalThingsResponse {
/**
* The things.
*/
things?: ThingNameList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListRoleAliasesRequest {
/**
* The maximum number of results to return at one time.
*/
pageSize?: PageSize;
/**
* A marker used to get the next set of results.
*/
marker?: Marker;
/**
* Return the list of role aliases in ascending alphabetical order.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListRoleAliasesResponse {
/**
* The role aliases.
*/
roleAliases?: RoleAliases;
/**
* A marker used to get the next set of results.
*/
nextMarker?: Marker;
}
export interface ListScheduledAuditsRequest {
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time. The default is 25.
*/
maxResults?: MaxResults;
}
export interface ListScheduledAuditsResponse {
/**
* The list of scheduled audits.
*/
scheduledAudits?: ScheduledAuditMetadataList;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListSecurityProfilesForTargetRequest {
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
/**
* If true, return child groups too.
*/
recursive?: Recursive;
/**
* The ARN of the target (thing group) whose attached security profiles you want to get.
*/
securityProfileTargetArn: SecurityProfileTargetArn;
}
export interface ListSecurityProfilesForTargetResponse {
/**
* A list of security profiles and their associated targets.
*/
securityProfileTargetMappings?: SecurityProfileTargetMappings;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListSecurityProfilesRequest {
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
}
export interface ListSecurityProfilesResponse {
/**
* A list of security profile identifiers (names and ARNs).
*/
securityProfileIdentifiers?: SecurityProfileIdentifiers;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListStreamsRequest {
/**
* The maximum number of results to return at a time.
*/
maxResults?: MaxResults;
/**
* A token used to get the next set of results.
*/
nextToken?: NextToken;
/**
* Set to true to return the list of streams in ascending order.
*/
ascendingOrder?: AscendingOrder;
}
export interface ListStreamsResponse {
/**
* A list of streams.
*/
streams?: StreamsSummary;
/**
* A token used to get the next set of results.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: ResourceArn;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceResponse {
/**
* The list of tags assigned to the resource.
*/
tags?: TagList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListTargetsForPolicyRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* A marker used to get the next set of results.
*/
marker?: Marker;
/**
* The maximum number of results to return at one time.
*/
pageSize?: PageSize;
}
export interface ListTargetsForPolicyResponse {
/**
* The policy targets.
*/
targets?: PolicyTargets;
/**
* A marker used to get the next set of results.
*/
nextMarker?: Marker;
}
export interface ListTargetsForSecurityProfileRequest {
/**
* The security profile.
*/
securityProfileName: SecurityProfileName;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
}
export interface ListTargetsForSecurityProfileResponse {
/**
* The thing groups to which the security profile is attached.
*/
securityProfileTargets?: SecurityProfileTargets;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingGroupsForThingRequest {
/**
* The thing name.
*/
thingName: ThingName;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: RegistryMaxResults;
}
export interface ListThingGroupsForThingResponse {
/**
* The thing groups.
*/
thingGroups?: ThingGroupNameAndArnList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingGroupsRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: RegistryMaxResults;
/**
* A filter that limits the results to those with the specified parent group.
*/
parentGroup?: ThingGroupName;
/**
* A filter that limits the results to those with the specified name prefix.
*/
namePrefixFilter?: ThingGroupName;
/**
* If true, return child groups as well.
*/
recursive?: RecursiveWithoutDefault;
}
export interface ListThingGroupsResponse {
/**
* The thing groups.
*/
thingGroups?: ThingGroupNameAndArnList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingPrincipalsRequest {
/**
* The name of the thing.
*/
thingName: ThingName;
}
export interface ListThingPrincipalsResponse {
/**
* The principals associated with the thing.
*/
principals?: Principals;
}
export interface ListThingRegistrationTaskReportsRequest {
/**
* The id of the task.
*/
taskId: TaskId;
/**
* The type of task report.
*/
reportType: ReportType;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return per request.
*/
maxResults?: RegistryMaxResults;
}
export interface ListThingRegistrationTaskReportsResponse {
/**
* Links to the task resources.
*/
resourceLinks?: S3FileUrlList;
/**
* The type of task report.
*/
reportType?: ReportType;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingRegistrationTasksRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: RegistryMaxResults;
/**
* The status of the bulk thing provisioning task.
*/
status?: Status;
}
export interface ListThingRegistrationTasksResponse {
/**
* A list of bulk thing provisioning task IDs.
*/
taskIds?: TaskIdList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingTypesRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return in this operation.
*/
maxResults?: RegistryMaxResults;
/**
* The name of the thing type.
*/
thingTypeName?: ThingTypeName;
}
export interface ListThingTypesResponse {
/**
* The thing types.
*/
thingTypes?: ThingTypeList;
/**
* The token for the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingsInBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName: BillingGroupName;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return per request.
*/
maxResults?: RegistryMaxResults;
}
export interface ListThingsInBillingGroupResponse {
/**
* A list of things in the billing group.
*/
things?: ThingNameList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingsInThingGroupRequest {
/**
* The thing group name.
*/
thingGroupName: ThingGroupName;
/**
* When true, list things in this thing group and in all child groups as well.
*/
recursive?: Recursive;
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: RegistryMaxResults;
}
export interface ListThingsInThingGroupResponse {
/**
* The things in the specified thing group.
*/
things?: ThingNameList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListThingsRequest {
/**
* The token to retrieve the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return in this operation.
*/
maxResults?: RegistryMaxResults;
/**
* The attribute name used to search for things.
*/
attributeName?: AttributeName;
/**
* The attribute value used to search for things.
*/
attributeValue?: AttributeValue;
/**
* The name of the thing type used to search for things.
*/
thingTypeName?: ThingTypeName;
}
export interface ListThingsResponse {
/**
* The things.
*/
things?: ThingAttributeList;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListTopicRulesRequest {
/**
* The topic.
*/
topic?: Topic;
/**
* The maximum number of results to return.
*/
maxResults?: GEMaxResults;
/**
* A token used to retrieve the next value.
*/
nextToken?: NextToken;
/**
* Specifies whether the rule is disabled.
*/
ruleDisabled?: IsDisabled;
}
export interface ListTopicRulesResponse {
/**
* The rules.
*/
rules?: TopicRuleList;
/**
* A token used to retrieve the next value.
*/
nextToken?: NextToken;
}
export interface ListV2LoggingLevelsRequest {
/**
* The type of resource for which you are configuring logging. Must be THING_Group.
*/
targetType?: LogTargetType;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: SkyfallMaxResults;
}
export interface ListV2LoggingLevelsResponse {
/**
* The logging configuration for a target.
*/
logTargetConfigurations?: LogTargetConfigurations;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export interface ListViolationEventsRequest {
/**
* The start time for the alerts to be listed.
*/
startTime: Timestamp;
/**
* The end time for the alerts to be listed.
*/
endTime: Timestamp;
/**
* A filter to limit results to those alerts caused by the specified thing.
*/
thingName?: DeviceDefenderThingName;
/**
* A filter to limit results to those alerts generated by the specified security profile.
*/
securityProfileName?: SecurityProfileName;
/**
* The token for the next set of results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: MaxResults;
}
export interface ListViolationEventsResponse {
/**
* The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
*/
violationEvents?: ViolationEvents;
/**
* A token that can be used to retrieve the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
}
export type LogLevel = "DEBUG"|"INFO"|"ERROR"|"WARN"|"DISABLED"|string;
export interface LogTarget {
/**
* The target type.
*/
targetType: LogTargetType;
/**
* The target name.
*/
targetName?: LogTargetName;
}
export interface LogTargetConfiguration {
/**
* A log target
*/
logTarget?: LogTarget;
/**
* The logging level.
*/
logLevel?: LogLevel;
}
export type LogTargetConfigurations = LogTargetConfiguration[];
export type LogTargetName = string;
export type LogTargetType = "DEFAULT"|"THING_GROUP"|string;
export interface LoggingOptionsPayload {
/**
* The ARN of the IAM role that grants access.
*/
roleArn: AwsArn;
/**
* The log level.
*/
logLevel?: LogLevel;
}
export type Marker = string;
export type MaxJobExecutionsPerMin = number;
export type MaxResults = number;
export type Maximum = number;
export type MaximumPerMinute = number;
export type Message = string;
export type MessageFormat = "RAW"|"JSON"|string;
export type MessageId = string;
export interface MetricValue {
/**
* If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.
*/
count?: UnsignedLong;
/**
* If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.
*/
cidrs?: Cidrs;
/**
* If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.
*/
ports?: Ports;
}
export type Minimum = number;
export type MinimumNumberOfExecutedThings = number;
export type MissingContextValue = string;
export type MissingContextValues = MissingContextValue[];
export interface MitigationAction {
/**
* A user-friendly name for the mitigation action.
*/
name?: MitigationActionName;
/**
* A unique identifier for the mitigation action.
*/
id?: MitigationActionId;
/**
* The IAM role ARN used to apply this mitigation action.
*/
roleArn?: RoleArn;
/**
* The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
*/
actionParams?: MitigationActionParams;
}
export type MitigationActionArn = string;
export type MitigationActionId = string;
export interface MitigationActionIdentifier {
/**
* The friendly name of the mitigation action.
*/
actionName?: MitigationActionName;
/**
* The IAM role ARN used to apply this mitigation action.
*/
actionArn?: MitigationActionArn;
/**
* The date when this mitigation action was created.
*/
creationDate?: Timestamp;
}
export type MitigationActionIdentifierList = MitigationActionIdentifier[];
export type MitigationActionList = MitigationAction[];
export type MitigationActionName = string;
export type MitigationActionNameList = MitigationActionName[];
export interface MitigationActionParams {
/**
* Parameters to define a mitigation action that changes the state of the device certificate to inactive.
*/
updateDeviceCertificateParams?: UpdateDeviceCertificateParams;
/**
* Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
*/
updateCACertificateParams?: UpdateCACertificateParams;
/**
* Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.
*/
addThingsToThingGroupParams?: AddThingsToThingGroupParams;
/**
* Parameters to define a mitigation action that adds a blank policy to restrict permissions.
*/
replaceDefaultPolicyVersionParams?: ReplaceDefaultPolicyVersionParams;
/**
* Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.
*/
enableIoTLoggingParams?: EnableIoTLoggingParams;
/**
* Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.
*/
publishFindingToSnsParams?: PublishFindingToSnsParams;
}
export type MitigationActionType = "UPDATE_DEVICE_CERTIFICATE"|"UPDATE_CA_CERTIFICATE"|"ADD_THINGS_TO_THING_GROUP"|"REPLACE_DEFAULT_POLICY_VERSION"|"ENABLE_IOT_LOGGING"|"PUBLISH_FINDING_TO_SNS"|string;
export type NextToken = string;
export type NonCompliantChecksCount = number;
export interface NonCompliantResource {
/**
* The type of the noncompliant resource.
*/
resourceType?: ResourceType;
/**
* Information that identifies the noncompliant resource.
*/
resourceIdentifier?: ResourceIdentifier;
/**
* Other information about the noncompliant resource.
*/
additionalInfo?: StringMap;
}
export type NonCompliantResourcesCount = number;
export type NumberOfThings = number;
export type OTAUpdateArn = string;
export type OTAUpdateDescription = string;
export type OTAUpdateErrorMessage = string;
export interface OTAUpdateFile {
/**
* The name of the file.
*/
fileName?: FileName;
/**
* The file version.
*/
fileVersion?: OTAUpdateFileVersion;
/**
* The location of the updated firmware.
*/
fileLocation?: FileLocation;
/**
* The code signing method of the file.
*/
codeSigning?: CodeSigning;
/**
* A list of name/attribute pairs.
*/
attributes?: AttributesMap;
}
export type OTAUpdateFileVersion = string;
export type OTAUpdateFiles = OTAUpdateFile[];
export type OTAUpdateId = string;
export interface OTAUpdateInfo {
/**
* The OTA update ID.
*/
otaUpdateId?: OTAUpdateId;
/**
* The OTA update ARN.
*/
otaUpdateArn?: OTAUpdateArn;
/**
* The date when the OTA update was created.
*/
creationDate?: DateType;
/**
* The date when the OTA update was last updated.
*/
lastModifiedDate?: DateType;
/**
* A description of the OTA update.
*/
description?: OTAUpdateDescription;
/**
* The targets of the OTA update.
*/
targets?: Targets;
/**
* Configuration for the rollout of OTA updates.
*/
awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig;
/**
* Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.
*/
targetSelection?: TargetSelection;
/**
* A list of files associated with the OTA update.
*/
otaUpdateFiles?: OTAUpdateFiles;
/**
* The status of the OTA update.
*/
otaUpdateStatus?: OTAUpdateStatus;
/**
* The AWS IoT job ID associated with the OTA update.
*/
awsIotJobId?: AwsIotJobId;
/**
* The AWS IoT job ARN associated with the OTA update.
*/
awsIotJobArn?: AwsIotJobArn;
/**
* Error information associated with the OTA update.
*/
errorInfo?: ErrorInfo;
/**
* A collection of name/value pairs
*/
additionalParameters?: AdditionalParameterMap;
}
export type OTAUpdateStatus = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"CREATE_FAILED"|string;
export interface OTAUpdateSummary {
/**
* The OTA update ID.
*/
otaUpdateId?: OTAUpdateId;
/**
* The OTA update ARN.
*/
otaUpdateArn?: OTAUpdateArn;
/**
* The date when the OTA update was created.
*/
creationDate?: DateType;
}
export type OTAUpdatesSummary = OTAUpdateSummary[];
export type OptionalVersion = number;
export interface OutgoingCertificate {
/**
* The certificate ARN.
*/
certificateArn?: CertificateArn;
/**
* The certificate ID.
*/
certificateId?: CertificateId;
/**
* The AWS account to which the transfer was made.
*/
transferredTo?: AwsAccountId;
/**
* The date the transfer was initiated.
*/
transferDate?: DateType;
/**
* The transfer message.
*/
transferMessage?: Message;
/**
* The certificate creation date.
*/
creationDate?: DateType;
}
export type OutgoingCertificates = OutgoingCertificate[];
export type OverrideDynamicGroups = boolean;
export type PageSize = number;
export type Parameter = string;
export type Parameters = {[key: string]: Value};
export type PartitionKey = string;
export type PayloadField = string;
export type Percent = number;
export type PercentList = Percent[];
export interface PercentPair {
/**
* The percentile.
*/
percent?: Percent;
/**
* The value.
*/
value?: PercentValue;
}
export type PercentValue = number;
export type Percentage = number;
export type Percentiles = PercentPair[];
export type Platform = string;
export type Policies = Policy[];
export interface Policy {
/**
* The policy name.
*/
policyName?: PolicyName;
/**
* The policy ARN.
*/
policyArn?: PolicyArn;
}
export type PolicyArn = string;
export type PolicyDocument = string;
export type PolicyDocuments = PolicyDocument[];
export type PolicyName = string;
export type PolicyNames = PolicyName[];
export type PolicyTarget = string;
export type PolicyTargets = PolicyTarget[];
export type PolicyTemplateName = "BLANK_POLICY"|string;
export interface PolicyVersion {
/**
* The policy version ID.
*/
versionId?: PolicyVersionId;
/**
* Specifies whether the policy version is the default.
*/
isDefaultVersion?: IsDefaultVersion;
/**
* The date and time the policy was created.
*/
createDate?: DateType;
}
export type PolicyVersionId = string;
export interface PolicyVersionIdentifier {
/**
* The name of the policy.
*/
policyName?: PolicyName;
/**
* The ID of the version of the policy associated with the resource.
*/
policyVersionId?: PolicyVersionId;
}
export type PolicyVersions = PolicyVersion[];
export type Port = number;
export type Ports = Port[];
export type Prefix = string;
export interface PresignedUrlConfig {
/**
* The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.
*/
roleArn?: RoleArn;
/**
* How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
*/
expiresInSec?: ExpiresInSec;
}
export type Principal = string;
export type PrincipalArn = string;
export type PrincipalId = string;
export type Principals = PrincipalArn[];
export type PrivateKey = string;
export type ProcessingTargetName = string;
export type ProcessingTargetNameList = ProcessingTargetName[];
export type PublicKey = string;
export type PublicKeyMap = {[key: string]: KeyValue};
export interface PublishFindingToSnsParams {
/**
* The ARN of the topic to which you want to publish the findings.
*/
topicArn: SnsTopicArn;
}
export interface PutItemInput {
/**
* The table where the message data will be written.
*/
tableName: TableName;
}
export type Qos = number;
export type QueryMaxResults = number;
export type QueryString = string;
export type QueryVersion = string;
export type QueueUrl = string;
export type QueuedThings = number;
export type RangeKeyField = string;
export type RangeKeyValue = string;
export interface RateIncreaseCriteria {
/**
* The threshold for number of notified things that will initiate the increase in rate of rollout.
*/
numberOfNotifiedThings?: NumberOfThings;
/**
* The threshold for number of succeeded things that will initiate the increase in rate of rollout.
*/
numberOfSucceededThings?: NumberOfThings;
}
export type ReasonCode = string;
export type ReasonForNonCompliance = string;
export type ReasonForNonComplianceCode = string;
export type ReasonForNonComplianceCodes = ReasonForNonComplianceCode[];
export type Recursive = boolean;
export type RecursiveWithoutDefault = boolean;
export interface RegisterCACertificateRequest {
/**
* The CA certificate.
*/
caCertificate: CertificatePem;
/**
* The private key verification certificate.
*/
verificationCertificate: CertificatePem;
/**
* A boolean value that specifies if the CA certificate is set to active.
*/
setAsActive?: SetAsActive;
/**
* Allows this CA certificate to be used for auto registration of device certificates.
*/
allowAutoRegistration?: AllowAutoRegistration;
/**
* Information about the registration configuration.
*/
registrationConfig?: RegistrationConfig;
}
export interface RegisterCACertificateResponse {
/**
* The CA certificate ARN.
*/
certificateArn?: CertificateArn;
/**
* The CA certificate identifier.
*/
certificateId?: CertificateId;
}
export interface RegisterCertificateRequest {
/**
* The certificate data, in PEM format.
*/
certificatePem: CertificatePem;
/**
* The CA certificate used to sign the device certificate being registered.
*/
caCertificatePem?: CertificatePem;
/**
* A boolean value that specifies if the certificate is set to active.
*/
setAsActive?: SetAsActiveFlag;
/**
* The status of the register certificate request.
*/
status?: CertificateStatus;
}
export interface RegisterCertificateResponse {
/**
* The certificate ARN.
*/
certificateArn?: CertificateArn;
/**
* The certificate identifier.
*/
certificateId?: CertificateId;
}
export interface RegisterThingRequest {
/**
* The provisioning template. See Programmatic Provisioning for more information.
*/
templateBody: TemplateBody;
/**
* The parameters for provisioning a thing. See Programmatic Provisioning for more information.
*/
parameters?: Parameters;
}
export interface RegisterThingResponse {
/**
* .
*/
certificatePem?: CertificatePem;
/**
* ARNs for the generated resources.
*/
resourceArns?: ResourceArns;
}
export type RegistrationCode = string;
export interface RegistrationConfig {
/**
* The template body.
*/
templateBody?: TemplateBody;
/**
* The ARN of the role.
*/
roleArn?: RoleArn;
}
export type RegistryMaxResults = number;
export type RegistryS3BucketName = string;
export type RegistryS3KeyName = string;
export interface RejectCertificateTransferRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
/**
* The reason the certificate transfer was rejected.
*/
rejectReason?: Message;
}
export type RejectedThings = number;
export interface RelatedResource {
/**
* The type of resource.
*/
resourceType?: ResourceType;
/**
* Information that identifies the resource.
*/
resourceIdentifier?: ResourceIdentifier;
/**
* Other information about the resource.
*/
additionalInfo?: StringMap;
}
export type RelatedResources = RelatedResource[];
export type RemoveAutoRegistration = boolean;
export interface RemoveThingFromBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName?: BillingGroupName;
/**
* The ARN of the billing group.
*/
billingGroupArn?: BillingGroupArn;
/**
* The name of the thing to be removed from the billing group.
*/
thingName?: ThingName;
/**
* The ARN of the thing to be removed from the billing group.
*/
thingArn?: ThingArn;
}
export interface RemoveThingFromBillingGroupResponse {
}
export interface RemoveThingFromThingGroupRequest {
/**
* The group name.
*/
thingGroupName?: ThingGroupName;
/**
* The group ARN.
*/
thingGroupArn?: ThingGroupArn;
/**
* The name of the thing to remove from the group.
*/
thingName?: ThingName;
/**
* The ARN of the thing to remove from the group.
*/
thingArn?: ThingArn;
}
export interface RemoveThingFromThingGroupResponse {
}
export type RemoveThingType = boolean;
export type RemovedThings = number;
export interface ReplaceDefaultPolicyVersionParams {
/**
* The name of the template to be applied. The only supported value is BLANK_POLICY.
*/
templateName: PolicyTemplateName;
}
export interface ReplaceTopicRuleRequest {
/**
* The name of the rule.
*/
ruleName: RuleName;
/**
* The rule payload.
*/
topicRulePayload: TopicRulePayload;
}
export type ReportType = "ERRORS"|"RESULTS"|string;
export interface RepublishAction {
/**
* The ARN of the IAM role that grants access.
*/
roleArn: AwsArn;
/**
* The name of the MQTT topic.
*/
topic: TopicPattern;
/**
* The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
*/
qos?: Qos;
}
export type Resource = string;
export type ResourceArn = string;
export type ResourceArns = {[key: string]: ResourceArn};
export interface ResourceIdentifier {
/**
* The ID of the certificate attached to the resource.
*/
deviceCertificateId?: CertificateId;
/**
* The ID of the CA certificate used to authorize the certificate.
*/
caCertificateId?: CertificateId;
/**
* The ID of the Amazon Cognito identity pool.
*/
cognitoIdentityPoolId?: CognitoIdentityPoolId;
/**
* The client ID.
*/
clientId?: ClientId;
/**
* The version of the policy associated with the resource.
*/
policyVersionIdentifier?: PolicyVersionIdentifier;
/**
* The account with which the resource is associated.
*/
account?: AwsAccountId;
}
export type ResourceLogicalId = string;
export type ResourceType = "DEVICE_CERTIFICATE"|"CA_CERTIFICATE"|"IOT_POLICY"|"COGNITO_IDENTITY_POOL"|"CLIENT_ID"|"ACCOUNT_SETTINGS"|string;
export type Resources = Resource[];
export type RoleAlias = string;
export type RoleAliasArn = string;
export interface RoleAliasDescription {
/**
* The role alias.
*/
roleAlias?: RoleAlias;
/**
* The ARN of the role alias.
*/
roleAliasArn?: RoleAliasArn;
/**
* The role ARN.
*/
roleArn?: RoleArn;
/**
* The role alias owner.
*/
owner?: AwsAccountId;
/**
* The number of seconds for which the credential is valid.
*/
credentialDurationSeconds?: CredentialDurationSeconds;
/**
* The UNIX timestamp of when the role alias was created.
*/
creationDate?: DateType;
/**
* The UNIX timestamp of when the role alias was last modified.
*/
lastModifiedDate?: DateType;
}
export type RoleAliases = RoleAlias[];
export type RoleArn = string;
export type RolloutRatePerMinute = number;
export type RuleArn = string;
export type RuleName = string;
export interface S3Action {
/**
* The ARN of the IAM role that grants access.
*/
roleArn: AwsArn;
/**
* The Amazon S3 bucket.
*/
bucketName: BucketName;
/**
* The object key.
*/
key: Key;
/**
* The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.
*/
cannedAcl?: CannedAccessControlList;
}
export type S3Bucket = string;
export interface S3Destination {
/**
* The S3 bucket that contains the updated firmware.
*/
bucket?: S3Bucket;
/**
* The S3 prefix.
*/
prefix?: Prefix;
}
export type S3FileUrl = string;
export type S3FileUrlList = S3FileUrl[];
export type S3Key = string;
export interface S3Location {
/**
* The S3 bucket.
*/
bucket?: S3Bucket;
/**
* The S3 key.
*/
key?: S3Key;
/**
* The S3 bucket version.
*/
version?: S3Version;
}
export type S3Version = string;
export type SQL = string;
export interface SalesforceAction {
/**
* The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
*/
token: SalesforceToken;
/**
* The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
*/
url: SalesforceEndpoint;
}
export type SalesforceEndpoint = string;
export type SalesforceToken = string;
export type ScheduledAuditArn = string;
export interface ScheduledAuditMetadata {
/**
* The name of the scheduled audit.
*/
scheduledAuditName?: ScheduledAuditName;
/**
* The ARN of the scheduled audit.
*/
scheduledAuditArn?: ScheduledAuditArn;
/**
* How often the scheduled audit occurs.
*/
frequency?: AuditFrequency;
/**
* The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
*/
dayOfMonth?: DayOfMonth;
/**
* The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or "BIWEEKLY").
*/
dayOfWeek?: DayOfWeek;
}
export type ScheduledAuditMetadataList = ScheduledAuditMetadata[];
export type ScheduledAuditName = string;
export interface SearchIndexRequest {
/**
* The search index name.
*/
indexName?: IndexName;
/**
* The search query string.
*/
queryString: QueryString;
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return at one time.
*/
maxResults?: QueryMaxResults;
/**
* The query version.
*/
queryVersion?: QueryVersion;
}
export interface SearchIndexResponse {
/**
* The token used to get the next set of results, or null if there are no additional results.
*/
nextToken?: NextToken;
/**
* The things that match the search query.
*/
things?: ThingDocumentList;
/**
* The thing groups that match the search query.
*/
thingGroups?: ThingGroupDocumentList;
}
export type SearchableAttributes = AttributeName[];
export type Seconds = number;
export type SecurityProfileArn = string;
export type SecurityProfileDescription = string;
export interface SecurityProfileIdentifier {
/**
* The name you have given to the security profile.
*/
name: SecurityProfileName;
/**
* The ARN of the security profile.
*/
arn: SecurityProfileArn;
}
export type SecurityProfileIdentifiers = SecurityProfileIdentifier[];
export type SecurityProfileName = string;
export interface SecurityProfileTarget {
/**
* The ARN of the security profile.
*/
arn: SecurityProfileTargetArn;
}
export type SecurityProfileTargetArn = string;
export interface SecurityProfileTargetMapping {
/**
* Information that identifies the security profile.
*/
securityProfileIdentifier?: SecurityProfileIdentifier;
/**
* Information about the target (thing group) associated with the security profile.
*/
target?: SecurityProfileTarget;
}
export type SecurityProfileTargetMappings = SecurityProfileTargetMapping[];
export type SecurityProfileTargets = SecurityProfileTarget[];
export type SetAsActive = boolean;
export type SetAsActiveFlag = boolean;
export type SetAsDefault = boolean;
export interface SetDefaultAuthorizerRequest {
/**
* The authorizer name.
*/
authorizerName: AuthorizerName;
}
export interface SetDefaultAuthorizerResponse {
/**
* The authorizer name.
*/
authorizerName?: AuthorizerName;
/**
* The authorizer ARN.
*/
authorizerArn?: AuthorizerArn;
}
export interface SetDefaultPolicyVersionRequest {
/**
* The policy name.
*/
policyName: PolicyName;
/**
* The policy version ID.
*/
policyVersionId: PolicyVersionId;
}
export interface SetLoggingOptionsRequest {
/**
* The logging options payload.
*/
loggingOptionsPayload: LoggingOptionsPayload;
}
export interface SetV2LoggingLevelRequest {
/**
* The log target.
*/
logTarget: LogTarget;
/**
* The log level.
*/
logLevel: LogLevel;
}
export interface SetV2LoggingOptionsRequest {
/**
* The ARN of the role that allows IoT to write to Cloudwatch logs.
*/
roleArn?: AwsArn;
/**
* The default logging level.
*/
defaultLogLevel?: LogLevel;
/**
* If true all logs are disabled. The default is false.
*/
disableAllLogs?: DisableAllLogs;
}
export type Signature = Buffer|Uint8Array|Blob|string;
export type SignatureAlgorithm = string;
export type SigningJobId = string;
export type SigningProfileName = string;
export interface SigningProfileParameter {
/**
* Certificate ARN.
*/
certificateArn?: CertificateArn;
/**
* The hardware platform of your device.
*/
platform?: Platform;
/**
* The location of the code-signing certificate on your device.
*/
certificatePathOnDevice?: CertificatePathOnDevice;
}
export type SkippedFindingsCount = number;
export type SkyfallMaxResults = number;
export interface SnsAction {
/**
* The ARN of the SNS topic.
*/
targetArn: AwsArn;
/**
* The ARN of the IAM role that grants access.
*/
roleArn: AwsArn;
/**
* (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
*/
messageFormat?: MessageFormat;
}
export type SnsTopicArn = string;
export interface SqsAction {
/**
* The ARN of the IAM role that grants access.
*/
roleArn: AwsArn;
/**
* The URL of the Amazon SQS queue.
*/
queueUrl: QueueUrl;
/**
* Specifies whether to use Base64 encoding.
*/
useBase64?: UseBase64;
}
export interface StartAuditMitigationActionsTaskRequest {
/**
* A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
*/
taskId: AuditMitigationActionsTaskId;
/**
* Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.
*/
target: AuditMitigationActionsTaskTarget;
/**
* For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.
*/
auditCheckToActionsMapping: AuditCheckToActionsMapping;
/**
* Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.
*/
clientRequestToken: ClientRequestToken;
}
export interface StartAuditMitigationActionsTaskResponse {
/**
* The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.
*/
taskId?: AuditMitigationActionsTaskId;
}
export interface StartOnDemandAuditTaskRequest {
/**
* Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.
*/
targetCheckNames: TargetAuditCheckNames;
}
export interface StartOnDemandAuditTaskResponse {
/**
* The ID of the on-demand audit you started.
*/
taskId?: AuditTaskId;
}
export interface StartSigningJobParameter {
/**
* Describes the code-signing profile.
*/
signingProfileParameter?: SigningProfileParameter;
/**
* The code-signing profile name.
*/
signingProfileName?: SigningProfileName;
/**
* The location to write the code-signed file.
*/
destination?: Destination;
}
export interface StartThingRegistrationTaskRequest {
/**
* The provisioning template.
*/
templateBody: TemplateBody;
/**
* The S3 bucket that contains the input file.
*/
inputFileBucket: RegistryS3BucketName;
/**
* The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).
*/
inputFileKey: RegistryS3KeyName;
/**
* The IAM role ARN that grants permission the input file.
*/
roleArn: RoleArn;
}
export interface StartThingRegistrationTaskResponse {
/**
* The bulk thing provisioning task ID.
*/
taskId?: TaskId;
}
export type StateMachineName = string;
export type StateReason = string;
export type StateValue = string;
export interface StatisticalThreshold {
/**
* The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
*/
statistic?: EvaluationStatistic;
}
export interface Statistics {
/**
* The count of things that match the query.
*/
count?: Count;
/**
* The average of the aggregated field values.
*/
average?: Average;
/**
* The sum of the aggregated field values.
*/
sum?: Sum;
/**
* The minimum aggregated field value.
*/
minimum?: Minimum;
/**
* The maximum aggregated field value.
*/
maximum?: Maximum;
/**
* The sum of the squares of the aggregated field values.
*/
sumOfSquares?: SumOfSquares;
/**
* The variance of the aggregated field values.
*/
variance?: Variance;
/**
* The standard deviation of the aggregated field valuesl
*/
stdDeviation?: StdDeviation;
}
export type Status = "InProgress"|"Completed"|"Failed"|"Cancelled"|"Cancelling"|string;
export type StdDeviation = number;
export interface StepFunctionsAction {
/**
* (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
*/
executionNamePrefix?: ExecutionNamePrefix;
/**
* The name of the Step Functions state machine whose execution will be started.
*/
stateMachineName: StateMachineName;
/**
* The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
*/
roleArn: AwsArn;
}
export interface StopThingRegistrationTaskRequest {
/**
* The bulk thing provisioning task ID.
*/
taskId: TaskId;
}
export interface StopThingRegistrationTaskResponse {
}
export interface Stream {
/**
* The stream ID.
*/
streamId?: StreamId;
/**
* The ID of a file associated with a stream.
*/
fileId?: FileId;
}
export type StreamArn = string;
export type StreamDescription = string;
export interface StreamFile {
/**
* The file ID.
*/
fileId?: FileId;
/**
* The location of the file in S3.
*/
s3Location?: S3Location;
}
export type StreamFiles = StreamFile[];
export type StreamId = string;
export interface StreamInfo {
/**
* The stream ID.
*/
streamId?: StreamId;
/**
* The stream ARN.
*/
streamArn?: StreamArn;
/**
* The stream version.
*/
streamVersion?: StreamVersion;
/**
* The description of the stream.
*/
description?: StreamDescription;
/**
* The files to stream.
*/
files?: StreamFiles;
/**
* The date when the stream was created.
*/
createdAt?: DateType;
/**
* The date when the stream was last updated.
*/
lastUpdatedAt?: DateType;
/**
* An IAM role AWS IoT assumes to access your S3 files.
*/
roleArn?: RoleArn;
}
export type StreamName = string;
export interface StreamSummary {
/**
* The stream ID.
*/
streamId?: StreamId;
/**
* The stream ARN.
*/
streamArn?: StreamArn;
/**
* The stream version.
*/
streamVersion?: StreamVersion;
/**
* A description of the stream.
*/
description?: StreamDescription;
}
export type StreamVersion = number;
export type StreamsSummary = StreamSummary[];
export type String = string;
export type StringMap = {[key: string]: String};
export type SucceededFindingsCount = number;
export type SucceededThings = number;
export type Sum = number;
export type SumOfSquares = number;
export type TableName = string;
export interface Tag {
/**
* The tag's key.
*/
Key?: TagKey;
/**
* The tag's value.
*/
Value?: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: ResourceArn;
/**
* The new or modified tags for the resource.
*/
tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Target = string;
export type TargetArn = string;
export type TargetAuditCheckNames = AuditCheckName[];
export type TargetSelection = "CONTINUOUS"|"SNAPSHOT"|string;
export type Targets = Target[];
export type TaskId = string;
export type TaskIdList = TaskId[];
export interface TaskStatistics {
/**
* The number of checks in this audit.
*/
totalChecks?: TotalChecksCount;
/**
* The number of checks in progress.
*/
inProgressChecks?: InProgressChecksCount;
/**
* The number of checks waiting for data collection.
*/
waitingForDataCollectionChecks?: WaitingForDataCollectionChecksCount;
/**
* The number of checks that found compliant resources.
*/
compliantChecks?: CompliantChecksCount;
/**
* The number of checks that found noncompliant resources.
*/
nonCompliantChecks?: NonCompliantChecksCount;
/**
* The number of checks.
*/
failedChecks?: FailedChecksCount;
/**
* The number of checks that did not run because the audit was canceled.
*/
canceledChecks?: CanceledChecksCount;
}
export interface TaskStatisticsForAuditCheck {
/**
* The total number of findings to which a task is being applied.
*/
totalFindingsCount?: TotalFindingsCount;
/**
* The number of findings for which at least one of the actions failed when applied.
*/
failedFindingsCount?: FailedFindingsCount;
/**
* The number of findings for which all mitigation actions succeeded when applied.
*/
succeededFindingsCount?: SucceededFindingsCount;
/**
* The number of findings skipped because of filter conditions provided in the parameters to the command.
*/
skippedFindingsCount?: SkippedFindingsCount;
/**
* The number of findings to which the mitigation action task was canceled when applied.
*/
canceledFindingsCount?: CanceledFindingsCount;
}
export type TemplateBody = string;
export interface TestAuthorizationRequest {
/**
* The principal.
*/
principal?: Principal;
/**
* The Cognito identity pool ID.
*/
cognitoIdentityPoolId?: CognitoIdentityPoolId;
/**
* A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.
*/
authInfos: AuthInfos;
/**
* The MQTT client ID.
*/
clientId?: ClientId;
/**
* When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.
*/
policyNamesToAdd?: PolicyNames;
/**
* When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.
*/
policyNamesToSkip?: PolicyNames;
}
export interface TestAuthorizationResponse {
/**
* The authentication results.
*/
authResults?: AuthResults;
}
export interface TestInvokeAuthorizerRequest {
/**
* The custom authorizer name.
*/
authorizerName: AuthorizerName;
/**
* The token returned by your custom authentication service.
*/
token: Token;
/**
* The signature made with the token and your custom authentication service's private key.
*/
tokenSignature: TokenSignature;
}
export interface TestInvokeAuthorizerResponse {
/**
* True if the token is authenticated, otherwise false.
*/
isAuthenticated?: IsAuthenticated;
/**
* The principal ID.
*/
principalId?: PrincipalId;
/**
* IAM policy documents.
*/
policyDocuments?: PolicyDocuments;
/**
* The number of seconds after which the temporary credentials are refreshed.
*/
refreshAfterInSeconds?: Seconds;
/**
* The number of seconds after which the connection is terminated.
*/
disconnectAfterInSeconds?: Seconds;
}
export type ThingArn = string;
export interface ThingAttribute {
/**
* The name of the thing.
*/
thingName?: ThingName;
/**
* The name of the thing type, if the thing has been associated with a type.
*/
thingTypeName?: ThingTypeName;
/**
* The thing ARN.
*/
thingArn?: ThingArn;
/**
* A list of thing attributes which are name-value pairs.
*/
attributes?: Attributes;
/**
* The version of the thing record in the registry.
*/
version?: Version;
}
export type ThingAttributeList = ThingAttribute[];
export interface ThingConnectivity {
/**
* True if the thing is connected to the AWS IoT service; false if it is not connected.
*/
connected?: Boolean;
/**
* The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.
*/
timestamp?: ConnectivityTimestamp;
}
export type ThingConnectivityIndexingMode = "OFF"|"STATUS"|string;
export interface ThingDocument {
/**
* The thing name.
*/
thingName?: ThingName;
/**
* The thing ID.
*/
thingId?: ThingId;
/**
* The thing type name.
*/
thingTypeName?: ThingTypeName;
/**
* Thing group names.
*/
thingGroupNames?: ThingGroupNameList;
/**
* The attributes.
*/
attributes?: Attributes;
/**
* The shadow.
*/
shadow?: JsonDocument;
/**
* Indicates whether the thing is connected to the AWS IoT service.
*/
connectivity?: ThingConnectivity;
}
export type ThingDocumentList = ThingDocument[];
export type ThingGroupArn = string;
export type ThingGroupDescription = string;
export interface ThingGroupDocument {
/**
* The thing group name.
*/
thingGroupName?: ThingGroupName;
/**
* The thing group ID.
*/
thingGroupId?: ThingGroupId;
/**
* The thing group description.
*/
thingGroupDescription?: ThingGroupDescription;
/**
* The thing group attributes.
*/
attributes?: Attributes;
/**
* Parent group names.
*/
parentGroupNames?: ThingGroupNameList;
}
export type ThingGroupDocumentList = ThingGroupDocument[];
export type ThingGroupId = string;
export interface ThingGroupIndexingConfiguration {
/**
* Thing group indexing mode.
*/
thingGroupIndexingMode: ThingGroupIndexingMode;
/**
* Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
*/
managedFields?: Fields;
/**
* Contains custom field names and their data type.
*/
customFields?: Fields;
}
export type ThingGroupIndexingMode = "OFF"|"ON"|string;
export type ThingGroupList = ThingGroupName[];
export interface ThingGroupMetadata {
/**
* The parent thing group name.
*/
parentGroupName?: ThingGroupName;
/**
* The root parent thing group.
*/
rootToParentThingGroups?: ThingGroupNameAndArnList;
/**
* The UNIX timestamp of when the thing group was created.
*/
creationDate?: CreationDate;
}
export type ThingGroupName = string;
export type ThingGroupNameAndArnList = GroupNameAndArn[];
export type ThingGroupNameList = ThingGroupName[];
export type ThingGroupNames = ThingGroupName[];
export interface ThingGroupProperties {
/**
* The thing group description.
*/
thingGroupDescription?: ThingGroupDescription;
/**
* The thing group attributes in JSON format.
*/
attributePayload?: AttributePayload;
}
export type ThingId = string;
export interface ThingIndexingConfiguration {
/**
* Thing indexing mode. Valid values are: REGISTRY – Your thing index contains registry data only. REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data. OFF - Thing indexing is disabled.
*/
thingIndexingMode: ThingIndexingMode;
/**
* Thing connectivity indexing mode. Valid values are: STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF. OFF - Thing connectivity status indexing is disabled.
*/
thingConnectivityIndexingMode?: ThingConnectivityIndexingMode;
/**
* Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
*/
managedFields?: Fields;
/**
* Contains custom field names and their data type.
*/
customFields?: Fields;
}
export type ThingIndexingMode = "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW"|string;
export type ThingName = string;
export type ThingNameList = ThingName[];
export type ThingTypeArn = string;
export interface ThingTypeDefinition {
/**
* The name of the thing type.
*/
thingTypeName?: ThingTypeName;
/**
* The thing type ARN.
*/
thingTypeArn?: ThingTypeArn;
/**
* The ThingTypeProperties for the thing type.
*/
thingTypeProperties?: ThingTypeProperties;
/**
* The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
*/
thingTypeMetadata?: ThingTypeMetadata;
}
export type ThingTypeDescription = string;
export type ThingTypeId = string;
export type ThingTypeList = ThingTypeDefinition[];
export interface ThingTypeMetadata {
/**
* Whether the thing type is deprecated. If true, no new things could be associated with this type.
*/
deprecated?: Boolean;
/**
* The date and time when the thing type was deprecated.
*/
deprecationDate?: DeprecationDate;
/**
* The date and time when the thing type was created.
*/
creationDate?: CreationDate;
}
export type ThingTypeName = string;
export interface ThingTypeProperties {
/**
* The description of the thing type.
*/
thingTypeDescription?: ThingTypeDescription;
/**
* A list of searchable thing attribute names.
*/
searchableAttributes?: SearchableAttributes;
}
export type TimedOutThings = number;
export interface TimeoutConfig {
/**
* Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
*/
inProgressTimeoutInMinutes?: InProgressTimeoutInMinutes;
}
export type Timestamp = Date;
export type Token = string;
export type TokenKeyName = string;
export type TokenSignature = string;
export type Topic = string;
export type TopicPattern = string;
export interface TopicRule {
/**
* The name of the rule.
*/
ruleName?: RuleName;
/**
* The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
*/
sql?: SQL;
/**
* The description of the rule.
*/
description?: Description;
/**
* The date and time the rule was created.
*/
createdAt?: CreatedAtDate;
/**
* The actions associated with the rule.
*/
actions?: ActionList;
/**
* Specifies whether the rule is disabled.
*/
ruleDisabled?: IsDisabled;
/**
* The version of the SQL rules engine to use when evaluating the rule.
*/
awsIotSqlVersion?: AwsIotSqlVersion;
/**
* The action to perform when an error occurs.
*/
errorAction?: Action;
}
export type TopicRuleList = TopicRuleListItem[];
export interface TopicRuleListItem {
/**
* The rule ARN.
*/
ruleArn?: RuleArn;
/**
* The name of the rule.
*/
ruleName?: RuleName;
/**
* The pattern for the topic names that apply.
*/
topicPattern?: TopicPattern;
/**
* The date and time the rule was created.
*/
createdAt?: CreatedAtDate;
/**
* Specifies whether the rule is disabled.
*/
ruleDisabled?: IsDisabled;
}
export interface TopicRulePayload {
/**
* The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
*/
sql: SQL;
/**
* The description of the rule.
*/
description?: Description;
/**
* The actions associated with the rule.
*/
actions: ActionList;
/**
* Specifies whether the rule is disabled.
*/
ruleDisabled?: IsDisabled;
/**
* The version of the SQL rules engine to use when evaluating the rule.
*/
awsIotSqlVersion?: AwsIotSqlVersion;
/**
* The action to take when an error occurs.
*/
errorAction?: Action;
}
export type TotalChecksCount = number;
export type TotalFindingsCount = number;
export type TotalResourcesCount = number;
export interface TransferCertificateRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
/**
* The AWS account.
*/
targetAwsAccount: AwsAccountId;
/**
* The transfer message.
*/
transferMessage?: Message;
}
export interface TransferCertificateResponse {
/**
* The ARN of the certificate.
*/
transferredCertificateArn?: CertificateArn;
}
export interface TransferData {
/**
* The transfer message.
*/
transferMessage?: Message;
/**
* The reason why the transfer was rejected.
*/
rejectReason?: Message;
/**
* The date the transfer took place.
*/
transferDate?: DateType;
/**
* The date the transfer was accepted.
*/
acceptDate?: DateType;
/**
* The date the transfer was rejected.
*/
rejectDate?: DateType;
}
export type UndoDeprecate = boolean;
export type UnsignedLong = number;
export interface UntagResourceRequest {
/**
* The ARN of the resource.
*/
resourceArn: ResourceArn;
/**
* A list of the keys of the tags to be removed from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateAccountAuditConfigurationRequest {
/**
* The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.
*/
roleArn?: RoleArn;
/**
* Information about the targets to which audit notifications are sent.
*/
auditNotificationTargetConfigurations?: AuditNotificationTargetConfigurations;
/**
* Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled. Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted. You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself. On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.
*/
auditCheckConfigurations?: AuditCheckConfigurations;
}
export interface UpdateAccountAuditConfigurationResponse {
}
export interface UpdateAuthorizerRequest {
/**
* The authorizer name.
*/
authorizerName: AuthorizerName;
/**
* The ARN of the authorizer's Lambda function.
*/
authorizerFunctionArn?: AuthorizerFunctionArn;
/**
* The key used to extract the token from the HTTP headers.
*/
tokenKeyName?: TokenKeyName;
/**
* The public keys used to verify the token signature.
*/
tokenSigningPublicKeys?: PublicKeyMap;
/**
* The status of the update authorizer request.
*/
status?: AuthorizerStatus;
}
export interface UpdateAuthorizerResponse {
/**
* The authorizer name.
*/
authorizerName?: AuthorizerName;
/**
* The authorizer ARN.
*/
authorizerArn?: AuthorizerArn;
}
export interface UpdateBillingGroupRequest {
/**
* The name of the billing group.
*/
billingGroupName: BillingGroupName;
/**
* The properties of the billing group.
*/
billingGroupProperties: BillingGroupProperties;
/**
* The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.
*/
expectedVersion?: OptionalVersion;
}
export interface UpdateBillingGroupResponse {
/**
* The latest version of the billing group.
*/
version?: Version;
}
export interface UpdateCACertificateParams {
/**
* The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE.
*/
action: CACertificateUpdateAction;
}
export interface UpdateCACertificateRequest {
/**
* The CA certificate identifier.
*/
certificateId: CertificateId;
/**
* The updated status of the CA certificate. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
*/
newStatus?: CACertificateStatus;
/**
* The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
*/
newAutoRegistrationStatus?: AutoRegistrationStatus;
/**
* Information about the registration configuration.
*/
registrationConfig?: RegistrationConfig;
/**
* If true, removes auto registration.
*/
removeAutoRegistration?: RemoveAutoRegistration;
}
export interface UpdateCertificateRequest {
/**
* The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
*/
certificateId: CertificateId;
/**
* The new status. Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use. Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
*/
newStatus: CertificateStatus;
}
export interface UpdateDeviceCertificateParams {
/**
* The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE.
*/
action: DeviceCertificateUpdateAction;
}
export interface UpdateDynamicThingGroupRequest {
/**
* The name of the dynamic thing group to update.
*/
thingGroupName: ThingGroupName;
/**
* The dynamic thing group properties to update.
*/
thingGroupProperties: ThingGroupProperties;
/**
* The expected version of the dynamic thing group to update.
*/
expectedVersion?: OptionalVersion;
/**
* The dynamic thing group index to update. Currently one index is supported: 'AWS_Things'.
*/
indexName?: IndexName;
/**
* The dynamic thing group search query string to update.
*/
queryString?: QueryString;
/**
* The dynamic thing group query version to update. Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this value.
*/
queryVersion?: QueryVersion;
}
export interface UpdateDynamicThingGroupResponse {
/**
* The dynamic thing group version.
*/
version?: Version;
}
export interface UpdateEventConfigurationsRequest {
/**
* The new event configuration values.
*/
eventConfigurations?: EventConfigurations;
}
export interface UpdateEventConfigurationsResponse {
}
export interface UpdateIndexingConfigurationRequest {
/**
* Thing indexing configuration.
*/
thingIndexingConfiguration?: ThingIndexingConfiguration;
/**
* Thing group indexing configuration.
*/
thingGroupIndexingConfiguration?: ThingGroupIndexingConfiguration;
}
export interface UpdateIndexingConfigurationResponse {
}
export interface UpdateJobRequest {
/**
* The ID of the job to be updated.
*/
jobId: JobId;
/**
* A short text description of the job.
*/
description?: JobDescription;
/**
* Configuration information for pre-signed S3 URLs.
*/
presignedUrlConfig?: PresignedUrlConfig;
/**
* Allows you to create a staged rollout of the job.
*/
jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig;
/**
* Allows you to create criteria to abort a job.
*/
abortConfig?: AbortConfig;
/**
* Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.
*/
timeoutConfig?: TimeoutConfig;
}
export interface UpdateMitigationActionRequest {
/**
* The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.
*/
actionName: MitigationActionName;
/**
* The ARN of the IAM role that is used to apply the mitigation action.
*/
roleArn?: RoleArn;
/**
* Defines the type of action and the parameters for that action.
*/
actionParams?: MitigationActionParams;
}
export interface UpdateMitigationActionResponse {
/**
* The ARN for the new mitigation action.
*/
actionArn?: MitigationActionArn;
/**
* A unique identifier for the mitigation action.
*/
actionId?: MitigationActionId;
}
export interface UpdateRoleAliasRequest {
/**
* The role alias to update.
*/
roleAlias: RoleAlias;
/**
* The role ARN.
*/
roleArn?: RoleArn;
/**
* The number of seconds the credential will be valid.
*/
credentialDurationSeconds?: CredentialDurationSeconds;
}
export interface UpdateRoleAliasResponse {
/**
* The role alias.
*/
roleAlias?: RoleAlias;
/**
* The role alias ARN.
*/
roleAliasArn?: RoleAliasArn;
}
export interface UpdateScheduledAuditRequest {
/**
* How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of each audit is determined by the system.
*/
frequency?: AuditFrequency;
/**
* The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
*/
dayOfMonth?: DayOfMonth;
/**
* The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU", "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
*/
dayOfWeek?: DayOfWeek;
/**
* Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)
*/
targetCheckNames?: TargetAuditCheckNames;
/**
* The name of the scheduled audit. (Max. 128 chars)
*/
scheduledAuditName: ScheduledAuditName;
}
export interface UpdateScheduledAuditResponse {
/**
* The ARN of the scheduled audit.
*/
scheduledAuditArn?: ScheduledAuditArn;
}
export interface UpdateSecurityProfileRequest {
/**
* The name of the security profile you want to update.
*/
securityProfileName: SecurityProfileName;
/**
* A description of the security profile.
*/
securityProfileDescription?: SecurityProfileDescription;
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
behaviors?: Behaviors;
/**
* Where the alerts are sent. (Alerts are always sent to the console.)
*/
alertTargets?: AlertTargets;
/**
* A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
*/
additionalMetricsToRetain?: AdditionalMetricsToRetainList;
/**
* If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
*/
deleteBehaviors?: DeleteBehaviors;
/**
* If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
*/
deleteAlertTargets?: DeleteAlertTargets;
/**
* If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
*/
deleteAdditionalMetricsToRetain?: DeleteAdditionalMetricsToRetain;
/**
* The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
*/
expectedVersion?: OptionalVersion;
}
export interface UpdateSecurityProfileResponse {
/**
* The name of the security profile that was updated.
*/
securityProfileName?: SecurityProfileName;
/**
* The ARN of the security profile that was updated.
*/
securityProfileArn?: SecurityProfileArn;
/**
* The description of the security profile.
*/
securityProfileDescription?: SecurityProfileDescription;
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
behaviors?: Behaviors;
/**
* Where the alerts are sent. (Alerts are always sent to the console.)
*/
alertTargets?: AlertTargets;
/**
* A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.
*/
additionalMetricsToRetain?: AdditionalMetricsToRetainList;
/**
* The updated version of the security profile.
*/
version?: Version;
/**
* The time the security profile was created.
*/
creationDate?: Timestamp;
/**
* The time the security profile was last modified.
*/
lastModifiedDate?: Timestamp;
}
export interface UpdateStreamRequest {
/**
* The stream ID.
*/
streamId: StreamId;
/**
* The description of the stream.
*/
description?: StreamDescription;
/**
* The files associated with the stream.
*/
files?: StreamFiles;
/**
* An IAM role that allows the IoT service principal assumes to access your S3 files.
*/
roleArn?: RoleArn;
}
export interface UpdateStreamResponse {
/**
* The stream ID.
*/
streamId?: StreamId;
/**
* The stream ARN.
*/
streamArn?: StreamArn;
/**
* A description of the stream.
*/
description?: StreamDescription;
/**
* The stream version.
*/
streamVersion?: StreamVersion;
}
export interface UpdateThingGroupRequest {
/**
* The thing group to update.
*/
thingGroupName: ThingGroupName;
/**
* The thing group properties.
*/
thingGroupProperties: ThingGroupProperties;
/**
* The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.
*/
expectedVersion?: OptionalVersion;
}
export interface UpdateThingGroupResponse {
/**
* The version of the updated thing group.
*/
version?: Version;
}
export interface UpdateThingGroupsForThingRequest {
/**
* The thing whose group memberships will be updated.
*/
thingName?: ThingName;
/**
* The groups to which the thing will be added.
*/
thingGroupsToAdd?: ThingGroupList;
/**
* The groups from which the thing will be removed.
*/
thingGroupsToRemove?: ThingGroupList;
/**
* Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.
*/
overrideDynamicGroups?: OverrideDynamicGroups;
}
export interface UpdateThingGroupsForThingResponse {
}
export interface UpdateThingRequest {
/**
* The name of the thing to update.
*/
thingName: ThingName;
/**
* The name of the thing type.
*/
thingTypeName?: ThingTypeName;
/**
* A list of thing attributes, a JSON string containing name-value pairs. For example: {\"attributes\":{\"name1\":\"value2\"}} This data is used to add new attributes or update existing attributes.
*/
attributePayload?: AttributePayload;
/**
* The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.
*/
expectedVersion?: OptionalVersion;
/**
* Remove a thing type association. If true, the association is removed.
*/
removeThingType?: RemoveThingType;
}
export interface UpdateThingResponse {
}
export type UseBase64 = boolean;
export type Valid = boolean;
export interface ValidateSecurityProfileBehaviorsRequest {
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
behaviors: Behaviors;
}
export interface ValidateSecurityProfileBehaviorsResponse {
/**
* True if the behaviors were valid.
*/
valid?: Valid;
/**
* The list of any errors found in the behaviors.
*/
validationErrors?: ValidationErrors;
}
export interface ValidationError {
/**
* The description of an error found in the behaviors.
*/
errorMessage?: ErrorMessage;
}
export type ValidationErrors = ValidationError[];
export type Value = string;
export type Variance = number;
export type Version = number;
export type VersionNumber = number;
export interface ViolationEvent {
/**
* The ID of the violation event.
*/
violationId?: ViolationId;
/**
* The name of the thing responsible for the violation event.
*/
thingName?: DeviceDefenderThingName;
/**
* The name of the security profile whose behavior was violated.
*/
securityProfileName?: SecurityProfileName;
/**
* The behavior which was violated.
*/
behavior?: Behavior;
/**
* The value of the metric (the measurement).
*/
metricValue?: MetricValue;
/**
* The type of violation event.
*/
violationEventType?: ViolationEventType;
/**
* The time the violation event occurred.
*/
violationEventTime?: Timestamp;
}
export type ViolationEventType = "in-alarm"|"alarm-cleared"|"alarm-invalidated"|string;
export type ViolationEvents = ViolationEvent[];
export type ViolationId = string;
export type WaitingForDataCollectionChecksCount = number;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2015-05-28"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the Iot client.
*/
export import Types = Iot;
}
export = Iot;