alexaforbusiness.d.ts
148 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
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 AlexaForBusiness extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AlexaForBusiness.Types.ClientConfiguration)
config: Config & AlexaForBusiness.Types.ClientConfiguration;
/**
* Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
*/
approveSkill(params: AlexaForBusiness.Types.ApproveSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request<AlexaForBusiness.Types.ApproveSkillResponse, AWSError>;
/**
* Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.
*/
approveSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.ApproveSkillResponse) => void): Request<AlexaForBusiness.Types.ApproveSkillResponse, AWSError>;
/**
* Associates a contact with a given address book.
*/
associateContactWithAddressBook(params: AlexaForBusiness.Types.AssociateContactWithAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request<AlexaForBusiness.Types.AssociateContactWithAddressBookResponse, AWSError>;
/**
* Associates a contact with a given address book.
*/
associateContactWithAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateContactWithAddressBookResponse) => void): Request<AlexaForBusiness.Types.AssociateContactWithAddressBookResponse, AWSError>;
/**
* Associates a device with the specified network profile.
*/
associateDeviceWithNetworkProfile(params: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse, AWSError>;
/**
* Associates a device with the specified network profile.
*/
associateDeviceWithNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithNetworkProfileResponse, AWSError>;
/**
* Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
*/
associateDeviceWithRoom(params: AlexaForBusiness.Types.AssociateDeviceWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
/**
* Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required.
*/
associateDeviceWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateDeviceWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateDeviceWithRoomResponse, AWSError>;
/**
* Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
*/
associateSkillGroupWithRoom(params: AlexaForBusiness.Types.AssociateSkillGroupWithRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
/**
* Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.
*/
associateSkillGroupWithRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillGroupWithRoomResponse, AWSError>;
/**
* Associates a skill with a skill group.
*/
associateSkillWithSkillGroup(params: AlexaForBusiness.Types.AssociateSkillWithSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
/**
* Associates a skill with a skill group.
*/
associateSkillWithSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithSkillGroupResponse, AWSError>;
/**
* Makes a private skill available for enrolled users to enable on their devices.
*/
associateSkillWithUsers(params: AlexaForBusiness.Types.AssociateSkillWithUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
/**
* Makes a private skill available for enrolled users to enable on their devices.
*/
associateSkillWithUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.AssociateSkillWithUsersResponse) => void): Request<AlexaForBusiness.Types.AssociateSkillWithUsersResponse, AWSError>;
/**
* Creates an address book with the specified details.
*/
createAddressBook(params: AlexaForBusiness.Types.CreateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
/**
* Creates an address book with the specified details.
*/
createAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateAddressBookResponse) => void): Request<AlexaForBusiness.Types.CreateAddressBookResponse, AWSError>;
/**
* Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
*/
createBusinessReportSchedule(params: AlexaForBusiness.Types.CreateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
/**
* Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.
*/
createBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.CreateBusinessReportScheduleResponse, AWSError>;
/**
* Adds a new conference provider under the user's AWS account.
*/
createConferenceProvider(params: AlexaForBusiness.Types.CreateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
/**
* Adds a new conference provider under the user's AWS account.
*/
createConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.CreateConferenceProviderResponse, AWSError>;
/**
* Creates a contact with the specified details.
*/
createContact(params: AlexaForBusiness.Types.CreateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
/**
* Creates a contact with the specified details.
*/
createContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateContactResponse) => void): Request<AlexaForBusiness.Types.CreateContactResponse, AWSError>;
/**
* Creates a gateway group with the specified details.
*/
createGatewayGroup(params: AlexaForBusiness.Types.CreateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.CreateGatewayGroupResponse, AWSError>;
/**
* Creates a gateway group with the specified details.
*/
createGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.CreateGatewayGroupResponse, AWSError>;
/**
* Creates a network profile with the specified details.
*/
createNetworkProfile(params: AlexaForBusiness.Types.CreateNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.CreateNetworkProfileResponse, AWSError>;
/**
* Creates a network profile with the specified details.
*/
createNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.CreateNetworkProfileResponse, AWSError>;
/**
* Creates a new room profile with the specified details.
*/
createProfile(params: AlexaForBusiness.Types.CreateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
/**
* Creates a new room profile with the specified details.
*/
createProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateProfileResponse) => void): Request<AlexaForBusiness.Types.CreateProfileResponse, AWSError>;
/**
* Creates a room with the specified details.
*/
createRoom(params: AlexaForBusiness.Types.CreateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
/**
* Creates a room with the specified details.
*/
createRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateRoomResponse) => void): Request<AlexaForBusiness.Types.CreateRoomResponse, AWSError>;
/**
* Creates a skill group with a specified name and description.
*/
createSkillGroup(params: AlexaForBusiness.Types.CreateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
/**
* Creates a skill group with a specified name and description.
*/
createSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.CreateSkillGroupResponse, AWSError>;
/**
* Creates a user.
*/
createUser(params: AlexaForBusiness.Types.CreateUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
/**
* Creates a user.
*/
createUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.CreateUserResponse) => void): Request<AlexaForBusiness.Types.CreateUserResponse, AWSError>;
/**
* Deletes an address book by the address book ARN.
*/
deleteAddressBook(params: AlexaForBusiness.Types.DeleteAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
/**
* Deletes an address book by the address book ARN.
*/
deleteAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteAddressBookResponse) => void): Request<AlexaForBusiness.Types.DeleteAddressBookResponse, AWSError>;
/**
* Deletes the recurring report delivery schedule with the specified schedule ARN.
*/
deleteBusinessReportSchedule(params: AlexaForBusiness.Types.DeleteBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
/**
* Deletes the recurring report delivery schedule with the specified schedule ARN.
*/
deleteBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.DeleteBusinessReportScheduleResponse, AWSError>;
/**
* Deletes a conference provider.
*/
deleteConferenceProvider(params: AlexaForBusiness.Types.DeleteConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
/**
* Deletes a conference provider.
*/
deleteConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.DeleteConferenceProviderResponse, AWSError>;
/**
* Deletes a contact by the contact ARN.
*/
deleteContact(params: AlexaForBusiness.Types.DeleteContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
/**
* Deletes a contact by the contact ARN.
*/
deleteContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteContactResponse) => void): Request<AlexaForBusiness.Types.DeleteContactResponse, AWSError>;
/**
* Removes a device from Alexa For Business.
*/
deleteDevice(params: AlexaForBusiness.Types.DeleteDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
/**
* Removes a device from Alexa For Business.
*/
deleteDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceResponse, AWSError>;
/**
* When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
*/
deleteDeviceUsageData(params: AlexaForBusiness.Types.DeleteDeviceUsageDataRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceUsageDataResponse, AWSError>;
/**
* When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.
*/
deleteDeviceUsageData(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteDeviceUsageDataResponse) => void): Request<AlexaForBusiness.Types.DeleteDeviceUsageDataResponse, AWSError>;
/**
* Deletes a gateway group.
*/
deleteGatewayGroup(params: AlexaForBusiness.Types.DeleteGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteGatewayGroupResponse, AWSError>;
/**
* Deletes a gateway group.
*/
deleteGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteGatewayGroupResponse, AWSError>;
/**
* Deletes a network profile by the network profile ARN.
*/
deleteNetworkProfile(params: AlexaForBusiness.Types.DeleteNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteNetworkProfileResponse, AWSError>;
/**
* Deletes a network profile by the network profile ARN.
*/
deleteNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteNetworkProfileResponse, AWSError>;
/**
* Deletes a room profile by the profile ARN.
*/
deleteProfile(params: AlexaForBusiness.Types.DeleteProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
/**
* Deletes a room profile by the profile ARN.
*/
deleteProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteProfileResponse) => void): Request<AlexaForBusiness.Types.DeleteProfileResponse, AWSError>;
/**
* Deletes a room by the room ARN.
*/
deleteRoom(params: AlexaForBusiness.Types.DeleteRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
/**
* Deletes a room by the room ARN.
*/
deleteRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomResponse, AWSError>;
/**
* Deletes room skill parameter details by room, skill, and parameter key ID.
*/
deleteRoomSkillParameter(params: AlexaForBusiness.Types.DeleteRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
/**
* Deletes room skill parameter details by room, skill, and parameter key ID.
*/
deleteRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.DeleteRoomSkillParameterResponse, AWSError>;
/**
* Unlinks a third-party account from a skill.
*/
deleteSkillAuthorization(params: AlexaForBusiness.Types.DeleteSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
/**
* Unlinks a third-party account from a skill.
*/
deleteSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillAuthorizationResponse, AWSError>;
/**
* Deletes a skill group by skill group ARN.
*/
deleteSkillGroup(params: AlexaForBusiness.Types.DeleteSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
/**
* Deletes a skill group by skill group ARN.
*/
deleteSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DeleteSkillGroupResponse, AWSError>;
/**
* Deletes a specified user by user ARN and enrollment ARN.
*/
deleteUser(params: AlexaForBusiness.Types.DeleteUserRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
/**
* Deletes a specified user by user ARN and enrollment ARN.
*/
deleteUser(callback?: (err: AWSError, data: AlexaForBusiness.Types.DeleteUserResponse) => void): Request<AlexaForBusiness.Types.DeleteUserResponse, AWSError>;
/**
* Disassociates a contact from a given address book.
*/
disassociateContactFromAddressBook(params: AlexaForBusiness.Types.DisassociateContactFromAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
/**
* Disassociates a contact from a given address book.
*/
disassociateContactFromAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse) => void): Request<AlexaForBusiness.Types.DisassociateContactFromAddressBookResponse, AWSError>;
/**
* Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
*/
disassociateDeviceFromRoom(params: AlexaForBusiness.Types.DisassociateDeviceFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
/**
* Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.
*/
disassociateDeviceFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateDeviceFromRoomResponse, AWSError>;
/**
* Disassociates a skill from a skill group.
*/
disassociateSkillFromSkillGroup(params: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
/**
* Disassociates a skill from a skill group.
*/
disassociateSkillFromSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromSkillGroupResponse, AWSError>;
/**
* Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
*/
disassociateSkillFromUsers(params: AlexaForBusiness.Types.DisassociateSkillFromUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
/**
* Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.
*/
disassociateSkillFromUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillFromUsersResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillFromUsersResponse, AWSError>;
/**
* Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
*/
disassociateSkillGroupFromRoom(params: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
/**
* Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.
*/
disassociateSkillGroupFromRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse) => void): Request<AlexaForBusiness.Types.DisassociateSkillGroupFromRoomResponse, AWSError>;
/**
* Forgets smart home appliances associated to a room.
*/
forgetSmartHomeAppliances(params: AlexaForBusiness.Types.ForgetSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
/**
* Forgets smart home appliances associated to a room.
*/
forgetSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ForgetSmartHomeAppliancesResponse, AWSError>;
/**
* Gets address the book details by the address book ARN.
*/
getAddressBook(params: AlexaForBusiness.Types.GetAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
/**
* Gets address the book details by the address book ARN.
*/
getAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetAddressBookResponse) => void): Request<AlexaForBusiness.Types.GetAddressBookResponse, AWSError>;
/**
* Retrieves the existing conference preferences.
*/
getConferencePreference(params: AlexaForBusiness.Types.GetConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
/**
* Retrieves the existing conference preferences.
*/
getConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.GetConferencePreferenceResponse, AWSError>;
/**
* Gets details about a specific conference provider.
*/
getConferenceProvider(params: AlexaForBusiness.Types.GetConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
/**
* Gets details about a specific conference provider.
*/
getConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.GetConferenceProviderResponse, AWSError>;
/**
* Gets the contact details by the contact ARN.
*/
getContact(params: AlexaForBusiness.Types.GetContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
/**
* Gets the contact details by the contact ARN.
*/
getContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetContactResponse) => void): Request<AlexaForBusiness.Types.GetContactResponse, AWSError>;
/**
* Gets the details of a device by device ARN.
*/
getDevice(params: AlexaForBusiness.Types.GetDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
/**
* Gets the details of a device by device ARN.
*/
getDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetDeviceResponse) => void): Request<AlexaForBusiness.Types.GetDeviceResponse, AWSError>;
/**
* Retrieves the details of a gateway.
*/
getGateway(params: AlexaForBusiness.Types.GetGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request<AlexaForBusiness.Types.GetGatewayResponse, AWSError>;
/**
* Retrieves the details of a gateway.
*/
getGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayResponse) => void): Request<AlexaForBusiness.Types.GetGatewayResponse, AWSError>;
/**
* Retrieves the details of a gateway group.
*/
getGatewayGroup(params: AlexaForBusiness.Types.GetGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.GetGatewayGroupResponse, AWSError>;
/**
* Retrieves the details of a gateway group.
*/
getGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.GetGatewayGroupResponse, AWSError>;
/**
* Retrieves the configured values for the user enrollment invitation email template.
*/
getInvitationConfiguration(params: AlexaForBusiness.Types.GetInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
/**
* Retrieves the configured values for the user enrollment invitation email template.
*/
getInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.GetInvitationConfigurationResponse, AWSError>;
/**
* Gets the network profile details by the network profile ARN.
*/
getNetworkProfile(params: AlexaForBusiness.Types.GetNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.GetNetworkProfileResponse, AWSError>;
/**
* Gets the network profile details by the network profile ARN.
*/
getNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.GetNetworkProfileResponse, AWSError>;
/**
* Gets the details of a room profile by profile ARN.
*/
getProfile(params: AlexaForBusiness.Types.GetProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
/**
* Gets the details of a room profile by profile ARN.
*/
getProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetProfileResponse) => void): Request<AlexaForBusiness.Types.GetProfileResponse, AWSError>;
/**
* Gets room details by room ARN.
*/
getRoom(params: AlexaForBusiness.Types.GetRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
/**
* Gets room details by room ARN.
*/
getRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomResponse) => void): Request<AlexaForBusiness.Types.GetRoomResponse, AWSError>;
/**
* Gets room skill parameter details by room, skill, and parameter key ARN.
*/
getRoomSkillParameter(params: AlexaForBusiness.Types.GetRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
/**
* Gets room skill parameter details by room, skill, and parameter key ARN.
*/
getRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.GetRoomSkillParameterResponse, AWSError>;
/**
* Gets skill group details by skill group ARN.
*/
getSkillGroup(params: AlexaForBusiness.Types.GetSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
/**
* Gets skill group details by skill group ARN.
*/
getSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.GetSkillGroupResponse) => void): Request<AlexaForBusiness.Types.GetSkillGroupResponse, AWSError>;
/**
* Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
*/
listBusinessReportSchedules(params: AlexaForBusiness.Types.ListBusinessReportSchedulesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
/**
* Lists the details of the schedules that a user configured. A download URL of the report associated with each schedule is returned every time this action is called. A new download URL is returned each time, and is valid for 24 hours.
*/
listBusinessReportSchedules(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListBusinessReportSchedulesResponse) => void): Request<AlexaForBusiness.Types.ListBusinessReportSchedulesResponse, AWSError>;
/**
* Lists conference providers under a specific AWS account.
*/
listConferenceProviders(params: AlexaForBusiness.Types.ListConferenceProvidersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
/**
* Lists conference providers under a specific AWS account.
*/
listConferenceProviders(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListConferenceProvidersResponse) => void): Request<AlexaForBusiness.Types.ListConferenceProvidersResponse, AWSError>;
/**
* Lists the device event history, including device connection status, for up to 30 days.
*/
listDeviceEvents(params: AlexaForBusiness.Types.ListDeviceEventsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
/**
* Lists the device event history, including device connection status, for up to 30 days.
*/
listDeviceEvents(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListDeviceEventsResponse) => void): Request<AlexaForBusiness.Types.ListDeviceEventsResponse, AWSError>;
/**
* Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
*/
listGatewayGroups(params: AlexaForBusiness.Types.ListGatewayGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request<AlexaForBusiness.Types.ListGatewayGroupsResponse, AWSError>;
/**
* Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.
*/
listGatewayGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewayGroupsResponse) => void): Request<AlexaForBusiness.Types.ListGatewayGroupsResponse, AWSError>;
/**
* Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
*/
listGateways(params: AlexaForBusiness.Types.ListGatewaysRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request<AlexaForBusiness.Types.ListGatewaysResponse, AWSError>;
/**
* Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.
*/
listGateways(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListGatewaysResponse) => void): Request<AlexaForBusiness.Types.ListGatewaysResponse, AWSError>;
/**
* Lists all enabled skills in a specific skill group.
*/
listSkills(params: AlexaForBusiness.Types.ListSkillsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
/**
* Lists all enabled skills in a specific skill group.
*/
listSkills(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsResponse) => void): Request<AlexaForBusiness.Types.ListSkillsResponse, AWSError>;
/**
* Lists all categories in the Alexa skill store.
*/
listSkillsStoreCategories(params: AlexaForBusiness.Types.ListSkillsStoreCategoriesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
/**
* Lists all categories in the Alexa skill store.
*/
listSkillsStoreCategories(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreCategoriesResponse, AWSError>;
/**
* Lists all skills in the Alexa skill store by category.
*/
listSkillsStoreSkillsByCategory(params: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
/**
* Lists all skills in the Alexa skill store by category.
*/
listSkillsStoreSkillsByCategory(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse) => void): Request<AlexaForBusiness.Types.ListSkillsStoreSkillsByCategoryResponse, AWSError>;
/**
* Lists all of the smart home appliances associated with a room.
*/
listSmartHomeAppliances(params: AlexaForBusiness.Types.ListSmartHomeAppliancesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
/**
* Lists all of the smart home appliances associated with a room.
*/
listSmartHomeAppliances(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListSmartHomeAppliancesResponse) => void): Request<AlexaForBusiness.Types.ListSmartHomeAppliancesResponse, AWSError>;
/**
* Lists all tags for the specified resource.
*/
listTags(params: AlexaForBusiness.Types.ListTagsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
/**
* Lists all tags for the specified resource.
*/
listTags(callback?: (err: AWSError, data: AlexaForBusiness.Types.ListTagsResponse) => void): Request<AlexaForBusiness.Types.ListTagsResponse, AWSError>;
/**
* Sets the conference preferences on a specific conference provider at the account level.
*/
putConferencePreference(params: AlexaForBusiness.Types.PutConferencePreferenceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
/**
* Sets the conference preferences on a specific conference provider at the account level.
*/
putConferencePreference(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutConferencePreferenceResponse) => void): Request<AlexaForBusiness.Types.PutConferencePreferenceResponse, AWSError>;
/**
* Configures the email template for the user enrollment invitation with the specified attributes.
*/
putInvitationConfiguration(params: AlexaForBusiness.Types.PutInvitationConfigurationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
/**
* Configures the email template for the user enrollment invitation with the specified attributes.
*/
putInvitationConfiguration(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutInvitationConfigurationResponse) => void): Request<AlexaForBusiness.Types.PutInvitationConfigurationResponse, AWSError>;
/**
* Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
*/
putRoomSkillParameter(params: AlexaForBusiness.Types.PutRoomSkillParameterRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
/**
* Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.
*/
putRoomSkillParameter(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutRoomSkillParameterResponse) => void): Request<AlexaForBusiness.Types.PutRoomSkillParameterResponse, AWSError>;
/**
* Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
*/
putSkillAuthorization(params: AlexaForBusiness.Types.PutSkillAuthorizationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
/**
* Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.
*/
putSkillAuthorization(callback?: (err: AWSError, data: AlexaForBusiness.Types.PutSkillAuthorizationResponse) => void): Request<AlexaForBusiness.Types.PutSkillAuthorizationResponse, AWSError>;
/**
* Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
*/
registerAVSDevice(params: AlexaForBusiness.Types.RegisterAVSDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
/**
* Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).
*/
registerAVSDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.RegisterAVSDeviceResponse) => void): Request<AlexaForBusiness.Types.RegisterAVSDeviceResponse, AWSError>;
/**
* Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
*/
rejectSkill(params: AlexaForBusiness.Types.RejectSkillRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
/**
* Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.
*/
rejectSkill(callback?: (err: AWSError, data: AlexaForBusiness.Types.RejectSkillResponse) => void): Request<AlexaForBusiness.Types.RejectSkillResponse, AWSError>;
/**
* Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
*/
resolveRoom(params: AlexaForBusiness.Types.ResolveRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
/**
* Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.
*/
resolveRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.ResolveRoomResponse) => void): Request<AlexaForBusiness.Types.ResolveRoomResponse, AWSError>;
/**
* Revokes an invitation and invalidates the enrollment URL.
*/
revokeInvitation(params: AlexaForBusiness.Types.RevokeInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
/**
* Revokes an invitation and invalidates the enrollment URL.
*/
revokeInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.RevokeInvitationResponse) => void): Request<AlexaForBusiness.Types.RevokeInvitationResponse, AWSError>;
/**
* Searches address books and lists the ones that meet a set of filter and sort criteria.
*/
searchAddressBooks(params: AlexaForBusiness.Types.SearchAddressBooksRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
/**
* Searches address books and lists the ones that meet a set of filter and sort criteria.
*/
searchAddressBooks(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchAddressBooksResponse) => void): Request<AlexaForBusiness.Types.SearchAddressBooksResponse, AWSError>;
/**
* Searches contacts and lists the ones that meet a set of filter and sort criteria.
*/
searchContacts(params: AlexaForBusiness.Types.SearchContactsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
/**
* Searches contacts and lists the ones that meet a set of filter and sort criteria.
*/
searchContacts(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchContactsResponse) => void): Request<AlexaForBusiness.Types.SearchContactsResponse, AWSError>;
/**
* Searches devices and lists the ones that meet a set of filter criteria.
*/
searchDevices(params: AlexaForBusiness.Types.SearchDevicesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
/**
* Searches devices and lists the ones that meet a set of filter criteria.
*/
searchDevices(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchDevicesResponse) => void): Request<AlexaForBusiness.Types.SearchDevicesResponse, AWSError>;
/**
* Searches network profiles and lists the ones that meet a set of filter and sort criteria.
*/
searchNetworkProfiles(params: AlexaForBusiness.Types.SearchNetworkProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchNetworkProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchNetworkProfilesResponse, AWSError>;
/**
* Searches network profiles and lists the ones that meet a set of filter and sort criteria.
*/
searchNetworkProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchNetworkProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchNetworkProfilesResponse, AWSError>;
/**
* Searches room profiles and lists the ones that meet a set of filter criteria.
*/
searchProfiles(params: AlexaForBusiness.Types.SearchProfilesRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
/**
* Searches room profiles and lists the ones that meet a set of filter criteria.
*/
searchProfiles(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchProfilesResponse) => void): Request<AlexaForBusiness.Types.SearchProfilesResponse, AWSError>;
/**
* Searches rooms and lists the ones that meet a set of filter and sort criteria.
*/
searchRooms(params: AlexaForBusiness.Types.SearchRoomsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
/**
* Searches rooms and lists the ones that meet a set of filter and sort criteria.
*/
searchRooms(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchRoomsResponse) => void): Request<AlexaForBusiness.Types.SearchRoomsResponse, AWSError>;
/**
* Searches skill groups and lists the ones that meet a set of filter and sort criteria.
*/
searchSkillGroups(params: AlexaForBusiness.Types.SearchSkillGroupsRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
/**
* Searches skill groups and lists the ones that meet a set of filter and sort criteria.
*/
searchSkillGroups(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchSkillGroupsResponse) => void): Request<AlexaForBusiness.Types.SearchSkillGroupsResponse, AWSError>;
/**
* Searches users and lists the ones that meet a set of filter and sort criteria.
*/
searchUsers(params: AlexaForBusiness.Types.SearchUsersRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
/**
* Searches users and lists the ones that meet a set of filter and sort criteria.
*/
searchUsers(callback?: (err: AWSError, data: AlexaForBusiness.Types.SearchUsersResponse) => void): Request<AlexaForBusiness.Types.SearchUsersResponse, AWSError>;
/**
* Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
*/
sendAnnouncement(params: AlexaForBusiness.Types.SendAnnouncementRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request<AlexaForBusiness.Types.SendAnnouncementResponse, AWSError>;
/**
* Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.
*/
sendAnnouncement(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendAnnouncementResponse) => void): Request<AlexaForBusiness.Types.SendAnnouncementResponse, AWSError>;
/**
* Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
*/
sendInvitation(params: AlexaForBusiness.Types.SendInvitationRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
/**
* Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
*/
sendInvitation(callback?: (err: AWSError, data: AlexaForBusiness.Types.SendInvitationResponse) => void): Request<AlexaForBusiness.Types.SendInvitationResponse, AWSError>;
/**
* Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
*/
startDeviceSync(params: AlexaForBusiness.Types.StartDeviceSyncRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
/**
* Resets a device and its account to the known default settings. This clears all information and settings set by previous users in the following ways: Bluetooth - This unpairs all bluetooth devices paired with your echo device. Volume - This resets the echo device's volume to the default value. Notifications - This clears all notifications from your echo device. Lists - This clears all to-do items from your echo device. Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).
*/
startDeviceSync(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartDeviceSyncResponse) => void): Request<AlexaForBusiness.Types.StartDeviceSyncResponse, AWSError>;
/**
* Initiates the discovery of any smart home appliances associated with the room.
*/
startSmartHomeApplianceDiscovery(params: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
/**
* Initiates the discovery of any smart home appliances associated with the room.
*/
startSmartHomeApplianceDiscovery(callback?: (err: AWSError, data: AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse) => void): Request<AlexaForBusiness.Types.StartSmartHomeApplianceDiscoveryResponse, AWSError>;
/**
* Adds metadata tags to a specified resource.
*/
tagResource(params: AlexaForBusiness.Types.TagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
/**
* Adds metadata tags to a specified resource.
*/
tagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.TagResourceResponse) => void): Request<AlexaForBusiness.Types.TagResourceResponse, AWSError>;
/**
* Removes metadata tags from a specified resource.
*/
untagResource(params: AlexaForBusiness.Types.UntagResourceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
/**
* Removes metadata tags from a specified resource.
*/
untagResource(callback?: (err: AWSError, data: AlexaForBusiness.Types.UntagResourceResponse) => void): Request<AlexaForBusiness.Types.UntagResourceResponse, AWSError>;
/**
* Updates address book details by the address book ARN.
*/
updateAddressBook(params: AlexaForBusiness.Types.UpdateAddressBookRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
/**
* Updates address book details by the address book ARN.
*/
updateAddressBook(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateAddressBookResponse) => void): Request<AlexaForBusiness.Types.UpdateAddressBookResponse, AWSError>;
/**
* Updates the configuration of the report delivery schedule with the specified schedule ARN.
*/
updateBusinessReportSchedule(params: AlexaForBusiness.Types.UpdateBusinessReportScheduleRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
/**
* Updates the configuration of the report delivery schedule with the specified schedule ARN.
*/
updateBusinessReportSchedule(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse) => void): Request<AlexaForBusiness.Types.UpdateBusinessReportScheduleResponse, AWSError>;
/**
* Updates an existing conference provider's settings.
*/
updateConferenceProvider(params: AlexaForBusiness.Types.UpdateConferenceProviderRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
/**
* Updates an existing conference provider's settings.
*/
updateConferenceProvider(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateConferenceProviderResponse) => void): Request<AlexaForBusiness.Types.UpdateConferenceProviderResponse, AWSError>;
/**
* Updates the contact details by the contact ARN.
*/
updateContact(params: AlexaForBusiness.Types.UpdateContactRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
/**
* Updates the contact details by the contact ARN.
*/
updateContact(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateContactResponse) => void): Request<AlexaForBusiness.Types.UpdateContactResponse, AWSError>;
/**
* Updates the device name by device ARN.
*/
updateDevice(params: AlexaForBusiness.Types.UpdateDeviceRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
/**
* Updates the device name by device ARN.
*/
updateDevice(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateDeviceResponse) => void): Request<AlexaForBusiness.Types.UpdateDeviceResponse, AWSError>;
/**
* Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
*/
updateGateway(params: AlexaForBusiness.Types.UpdateGatewayRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayResponse, AWSError>;
/**
* Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.
*/
updateGateway(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayResponse, AWSError>;
/**
* Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
*/
updateGatewayGroup(params: AlexaForBusiness.Types.UpdateGatewayGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayGroupResponse, AWSError>;
/**
* Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.
*/
updateGatewayGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateGatewayGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateGatewayGroupResponse, AWSError>;
/**
* Updates a network profile by the network profile ARN.
*/
updateNetworkProfile(params: AlexaForBusiness.Types.UpdateNetworkProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateNetworkProfileResponse, AWSError>;
/**
* Updates a network profile by the network profile ARN.
*/
updateNetworkProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateNetworkProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateNetworkProfileResponse, AWSError>;
/**
* Updates an existing room profile by room profile ARN.
*/
updateProfile(params: AlexaForBusiness.Types.UpdateProfileRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
/**
* Updates an existing room profile by room profile ARN.
*/
updateProfile(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateProfileResponse) => void): Request<AlexaForBusiness.Types.UpdateProfileResponse, AWSError>;
/**
* Updates room details by room ARN.
*/
updateRoom(params: AlexaForBusiness.Types.UpdateRoomRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
/**
* Updates room details by room ARN.
*/
updateRoom(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateRoomResponse) => void): Request<AlexaForBusiness.Types.UpdateRoomResponse, AWSError>;
/**
* Updates skill group details by skill group ARN.
*/
updateSkillGroup(params: AlexaForBusiness.Types.UpdateSkillGroupRequest, callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
/**
* Updates skill group details by skill group ARN.
*/
updateSkillGroup(callback?: (err: AWSError, data: AlexaForBusiness.Types.UpdateSkillGroupResponse) => void): Request<AlexaForBusiness.Types.UpdateSkillGroupResponse, AWSError>;
}
declare namespace AlexaForBusiness {
export type Address = string;
export interface AddressBook {
/**
* The ARN of the address book.
*/
AddressBookArn?: Arn;
/**
* The name of the address book.
*/
Name?: AddressBookName;
/**
* The description of the address book.
*/
Description?: AddressBookDescription;
}
export interface AddressBookData {
/**
* The ARN of the address book.
*/
AddressBookArn?: Arn;
/**
* The name of the address book.
*/
Name?: AddressBookName;
/**
* The description of the address book.
*/
Description?: AddressBookDescription;
}
export type AddressBookDataList = AddressBookData[];
export type AddressBookDescription = string;
export type AddressBookName = string;
export type AmazonId = string;
export type ApplianceDescription = string;
export type ApplianceFriendlyName = string;
export type ApplianceManufacturerName = string;
export interface ApproveSkillRequest {
/**
* The unique identifier of the skill.
*/
SkillId: SkillId;
}
export interface ApproveSkillResponse {
}
export type Arn = string;
export interface AssociateContactWithAddressBookRequest {
/**
* The ARN of the contact to associate with an address book.
*/
ContactArn: Arn;
/**
* The ARN of the address book with which to associate the contact.
*/
AddressBookArn: Arn;
}
export interface AssociateContactWithAddressBookResponse {
}
export interface AssociateDeviceWithNetworkProfileRequest {
/**
* The device ARN.
*/
DeviceArn: Arn;
/**
* The ARN of the network profile to associate with a device.
*/
NetworkProfileArn: Arn;
}
export interface AssociateDeviceWithNetworkProfileResponse {
}
export interface AssociateDeviceWithRoomRequest {
/**
* The ARN of the device to associate to a room. Required.
*/
DeviceArn?: Arn;
/**
* The ARN of the room with which to associate the device. Required.
*/
RoomArn?: Arn;
}
export interface AssociateDeviceWithRoomResponse {
}
export interface AssociateSkillGroupWithRoomRequest {
/**
* The ARN of the skill group to associate with a room. Required.
*/
SkillGroupArn?: Arn;
/**
* The ARN of the room with which to associate the skill group. Required.
*/
RoomArn?: Arn;
}
export interface AssociateSkillGroupWithRoomResponse {
}
export interface AssociateSkillWithSkillGroupRequest {
/**
* The ARN of the skill group to associate the skill to. Required.
*/
SkillGroupArn?: Arn;
/**
* The unique identifier of the skill.
*/
SkillId: SkillId;
}
export interface AssociateSkillWithSkillGroupResponse {
}
export interface AssociateSkillWithUsersRequest {
/**
* The private skill ID you want to make available to enrolled users.
*/
SkillId: SkillId;
}
export interface AssociateSkillWithUsersResponse {
}
export interface Audio {
/**
* The locale of the audio message. Currently, en-US is supported.
*/
Locale: Locale;
/**
* The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.
*/
Location: AudioLocation;
}
export type AudioList = Audio[];
export type AudioLocation = string;
export type AuthorizationResult = {[key: string]: Value};
export type Boolean = boolean;
export type BulletPoint = string;
export type BulletPoints = BulletPoint[];
export interface BusinessReport {
/**
* The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
*/
Status?: BusinessReportStatus;
/**
* The failure code.
*/
FailureCode?: BusinessReportFailureCode;
/**
* The S3 location of the output reports.
*/
S3Location?: BusinessReportS3Location;
/**
* The time of report delivery.
*/
DeliveryTime?: BusinessReportDeliveryTime;
/**
* The download link where a user can download the report.
*/
DownloadUrl?: BusinessReportDownloadUrl;
}
export interface BusinessReportContentRange {
/**
* The interval of the content range.
*/
Interval?: BusinessReportInterval;
}
export type BusinessReportDeliveryTime = Date;
export type BusinessReportDownloadUrl = string;
export type BusinessReportFailureCode = "ACCESS_DENIED"|"NO_SUCH_BUCKET"|"INTERNAL_FAILURE"|string;
export type BusinessReportFormat = "CSV"|"CSV_ZIP"|string;
export type BusinessReportInterval = "ONE_DAY"|"ONE_WEEK"|"THIRTY_DAYS"|string;
export interface BusinessReportRecurrence {
/**
* The start date.
*/
StartDate?: _Date;
}
export interface BusinessReportS3Location {
/**
* The path of the business report.
*/
Path?: BusinessReportS3Path;
/**
* The S3 bucket name of the output reports.
*/
BucketName?: CustomerS3BucketName;
}
export type BusinessReportS3Path = string;
export interface BusinessReportSchedule {
/**
* The ARN of the business report schedule.
*/
ScheduleArn?: Arn;
/**
* The name identifier of the schedule.
*/
ScheduleName?: BusinessReportScheduleName;
/**
* The S3 bucket name of the output reports.
*/
S3BucketName?: CustomerS3BucketName;
/**
* The S3 key where the report is delivered.
*/
S3KeyPrefix?: S3KeyPrefix;
/**
* The format of the generated report (individual CSV files or zipped files of individual files).
*/
Format?: BusinessReportFormat;
/**
* The content range of the reports.
*/
ContentRange?: BusinessReportContentRange;
/**
* The recurrence of the reports.
*/
Recurrence?: BusinessReportRecurrence;
/**
* The details of the last business report delivery for a specified time interval.
*/
LastBusinessReport?: BusinessReport;
}
export type BusinessReportScheduleList = BusinessReportSchedule[];
export type BusinessReportScheduleName = string;
export type BusinessReportStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|string;
export interface Category {
/**
* The ID of the skill store category.
*/
CategoryId?: CategoryId;
/**
* The name of the skill store category.
*/
CategoryName?: CategoryName;
}
export type CategoryId = number;
export type CategoryList = Category[];
export type CategoryName = string;
export type CertificateTime = Date;
export type ClientId = string;
export type ClientRequestToken = string;
export type CommsProtocol = "SIP"|"SIPS"|"H323"|string;
export interface ConferencePreference {
/**
* The ARN of the default conference provider.
*/
DefaultConferenceProviderArn?: Arn;
}
export interface ConferenceProvider {
/**
* The ARN of the newly created conference provider.
*/
Arn?: Arn;
/**
* The name of the conference provider.
*/
Name?: ConferenceProviderName;
/**
* The type of conference providers.
*/
Type?: ConferenceProviderType;
/**
* The IP endpoint and protocol for calling.
*/
IPDialIn?: IPDialIn;
/**
* The information for PSTN conferencing.
*/
PSTNDialIn?: PSTNDialIn;
/**
* The meeting settings for the conference provider.
*/
MeetingSetting?: MeetingSetting;
}
export type ConferenceProviderName = string;
export type ConferenceProviderType = "CHIME"|"BLUEJEANS"|"FUZE"|"GOOGLE_HANGOUTS"|"POLYCOM"|"RINGCENTRAL"|"SKYPE_FOR_BUSINESS"|"WEBEX"|"ZOOM"|"CUSTOM"|string;
export type ConferenceProvidersList = ConferenceProvider[];
export type ConnectionStatus = "ONLINE"|"OFFLINE"|string;
export interface Contact {
/**
* The ARN of the contact.
*/
ContactArn?: Arn;
/**
* The name of the contact to display on the console.
*/
DisplayName?: ContactName;
/**
* The first name of the contact, used to call the contact on the device.
*/
FirstName?: ContactName;
/**
* The last name of the contact, used to call the contact on the device.
*/
LastName?: ContactName;
/**
* The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
*/
PhoneNumber?: RawPhoneNumber;
/**
* The list of phone numbers for the contact.
*/
PhoneNumbers?: PhoneNumberList;
/**
* The list of SIP addresses for the contact.
*/
SipAddresses?: SipAddressList;
}
export interface ContactData {
/**
* The ARN of the contact.
*/
ContactArn?: Arn;
/**
* The name of the contact to display on the console.
*/
DisplayName?: ContactName;
/**
* The first name of the contact, used to call the contact on the device.
*/
FirstName?: ContactName;
/**
* The last name of the contact, used to call the contact on the device.
*/
LastName?: ContactName;
/**
* The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
*/
PhoneNumber?: RawPhoneNumber;
/**
* The list of phone numbers for the contact.
*/
PhoneNumbers?: PhoneNumberList;
/**
* The list of SIP addresses for the contact.
*/
SipAddresses?: SipAddressList;
}
export type ContactDataList = ContactData[];
export type ContactName = string;
export interface Content {
/**
* The list of text messages.
*/
TextList?: TextList;
/**
* The list of SSML messages.
*/
SsmlList?: SsmlList;
/**
* The list of audio messages.
*/
AudioList?: AudioList;
}
export type CountryCode = string;
export interface CreateAddressBookRequest {
/**
* The name of the address book.
*/
Name: AddressBookName;
/**
* The description of the address book.
*/
Description?: AddressBookDescription;
/**
* A unique, user-specified identifier for the request that ensures idempotency.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateAddressBookResponse {
/**
* The ARN of the newly created address book.
*/
AddressBookArn?: Arn;
}
export interface CreateBusinessReportScheduleRequest {
/**
* The name identifier of the schedule.
*/
ScheduleName?: BusinessReportScheduleName;
/**
* The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
*/
S3BucketName?: CustomerS3BucketName;
/**
* The S3 key where the report is delivered.
*/
S3KeyPrefix?: S3KeyPrefix;
/**
* The format of the generated report (individual CSV files or zipped files of individual files).
*/
Format: BusinessReportFormat;
/**
* The content range of the reports.
*/
ContentRange: BusinessReportContentRange;
/**
* The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
*/
Recurrence?: BusinessReportRecurrence;
/**
* The client request token.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateBusinessReportScheduleResponse {
/**
* The ARN of the business report schedule.
*/
ScheduleArn?: Arn;
}
export interface CreateConferenceProviderRequest {
/**
* The name of the conference provider.
*/
ConferenceProviderName: ConferenceProviderName;
/**
* Represents a type within a list of predefined types.
*/
ConferenceProviderType: ConferenceProviderType;
/**
* The IP endpoint and protocol for calling.
*/
IPDialIn?: IPDialIn;
/**
* The information for PSTN conferencing.
*/
PSTNDialIn?: PSTNDialIn;
/**
* The meeting settings for the conference provider.
*/
MeetingSetting: MeetingSetting;
/**
* The request token of the client.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateConferenceProviderResponse {
/**
* The ARN of the newly-created conference provider.
*/
ConferenceProviderArn?: Arn;
}
export interface CreateContactRequest {
/**
* The name of the contact to display on the console.
*/
DisplayName?: ContactName;
/**
* The first name of the contact that is used to call the contact on the device.
*/
FirstName: ContactName;
/**
* The last name of the contact that is used to call the contact on the device.
*/
LastName?: ContactName;
/**
* The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
*/
PhoneNumber?: RawPhoneNumber;
/**
* The list of phone numbers for the contact.
*/
PhoneNumbers?: PhoneNumberList;
/**
* The list of SIP addresses for the contact.
*/
SipAddresses?: SipAddressList;
/**
* A unique, user-specified identifier for this request that ensures idempotency.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateContactResponse {
/**
* The ARN of the newly created address book.
*/
ContactArn?: Arn;
}
export interface CreateEndOfMeetingReminder {
/**
* A range of 3 to 15 minutes that determines when the reminder begins.
*/
ReminderAtMinutes: EndOfMeetingReminderMinutesList;
/**
* The type of sound that users hear during the end of meeting reminder.
*/
ReminderType: EndOfMeetingReminderType;
/**
* Whether an end of meeting reminder is enabled or not.
*/
Enabled: Boolean;
}
export interface CreateGatewayGroupRequest {
/**
* The name of the gateway group.
*/
Name: GatewayGroupName;
/**
* The description of the gateway group.
*/
Description?: GatewayGroupDescription;
/**
* A unique, user-specified identifier for the request that ensures idempotency.
*/
ClientRequestToken: ClientRequestToken;
}
export interface CreateGatewayGroupResponse {
/**
* The ARN of the created gateway group.
*/
GatewayGroupArn?: Arn;
}
export interface CreateInstantBooking {
/**
* Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
*/
DurationInMinutes: Minutes;
/**
* Whether instant booking is enabled or not.
*/
Enabled: Boolean;
}
export interface CreateMeetingRoomConfiguration {
/**
* Whether room utilization metrics are enabled or not.
*/
RoomUtilizationMetricsEnabled?: Boolean;
EndOfMeetingReminder?: CreateEndOfMeetingReminder;
/**
* Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.
*/
InstantBooking?: CreateInstantBooking;
/**
* Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
*/
RequireCheckIn?: CreateRequireCheckIn;
}
export interface CreateNetworkProfileRequest {
/**
* The name of the network profile associated with a device.
*/
NetworkProfileName: NetworkProfileName;
/**
* Detailed information about a device's network profile.
*/
Description?: NetworkProfileDescription;
/**
* The SSID of the Wi-Fi network.
*/
Ssid: NetworkSsid;
/**
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*/
SecurityType: NetworkSecurityType;
/**
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*/
EapMethod?: NetworkEapMethod;
/**
* The current password of the Wi-Fi network.
*/
CurrentPassword?: CurrentWiFiPassword;
/**
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
*/
NextPassword?: NextWiFiPassword;
/**
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
*/
CertificateAuthorityArn?: Arn;
/**
* The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
*/
TrustAnchors?: TrustAnchorList;
ClientRequestToken: ClientRequestToken;
}
export interface CreateNetworkProfileResponse {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn?: Arn;
}
export interface CreateProfileRequest {
/**
* The name of a room profile.
*/
ProfileName: ProfileName;
/**
* The time zone used by a room profile.
*/
Timezone: Timezone;
/**
* The valid address for the room.
*/
Address: Address;
/**
* The distance unit to be used by devices in the profile.
*/
DistanceUnit: DistanceUnit;
/**
* The temperature unit to be used by devices in the profile.
*/
TemperatureUnit: TemperatureUnit;
/**
* A wake word for Alexa, Echo, Amazon, or a computer.
*/
WakeWord: WakeWord;
/**
* The locale of the room profile. (This is currently only available to a limited preview audience.)
*/
Locale?: DeviceLocale;
/**
* The user-specified token that is used during the creation of a profile.
*/
ClientRequestToken?: ClientRequestToken;
/**
* Whether room profile setup is enabled.
*/
SetupModeDisabled?: Boolean;
/**
* The maximum volume limit for a room profile.
*/
MaxVolumeLimit?: MaxVolumeLimit;
/**
* Whether PSTN calling is enabled.
*/
PSTNEnabled?: Boolean;
/**
* The meeting room settings of a room profile.
*/
MeetingRoomConfiguration?: CreateMeetingRoomConfiguration;
}
export interface CreateProfileResponse {
/**
* The ARN of the newly created room profile in the response.
*/
ProfileArn?: Arn;
}
export interface CreateRequireCheckIn {
/**
* Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
*/
ReleaseAfterMinutes: Minutes;
/**
* Whether require check in is enabled or not.
*/
Enabled: Boolean;
}
export interface CreateRoomRequest {
/**
* The name for the room.
*/
RoomName: RoomName;
/**
* The description for the room.
*/
Description?: RoomDescription;
/**
* The profile ARN for the room.
*/
ProfileArn?: Arn;
/**
* The calendar ARN for the room.
*/
ProviderCalendarId?: ProviderCalendarId;
/**
* A unique, user-specified identifier for this request that ensures idempotency.
*/
ClientRequestToken?: ClientRequestToken;
/**
* The tags for the room.
*/
Tags?: TagList;
}
export interface CreateRoomResponse {
/**
* The ARN of the newly created room in the response.
*/
RoomArn?: Arn;
}
export interface CreateSkillGroupRequest {
/**
* The name for the skill group.
*/
SkillGroupName: SkillGroupName;
/**
* The description for the skill group.
*/
Description?: SkillGroupDescription;
/**
* A unique, user-specified identifier for this request that ensures idempotency.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateSkillGroupResponse {
/**
* The ARN of the newly created skill group in the response.
*/
SkillGroupArn?: Arn;
}
export interface CreateUserRequest {
/**
* The ARN for the user.
*/
UserId: user_UserId;
/**
* The first name for the user.
*/
FirstName?: user_FirstName;
/**
* The last name for the user.
*/
LastName?: user_LastName;
/**
* The email address for the user.
*/
Email?: Email;
/**
* A unique, user-specified identifier for this request that ensures idempotency.
*/
ClientRequestToken?: ClientRequestToken;
/**
* The tags for the user.
*/
Tags?: TagList;
}
export interface CreateUserResponse {
/**
* The ARN of the newly created user in the response.
*/
UserArn?: Arn;
}
export type CurrentWiFiPassword = string;
export type CustomerS3BucketName = string;
export type _Date = string;
export interface DeleteAddressBookRequest {
/**
* The ARN of the address book to delete.
*/
AddressBookArn: Arn;
}
export interface DeleteAddressBookResponse {
}
export interface DeleteBusinessReportScheduleRequest {
/**
* The ARN of the business report schedule.
*/
ScheduleArn: Arn;
}
export interface DeleteBusinessReportScheduleResponse {
}
export interface DeleteConferenceProviderRequest {
/**
* The ARN of the conference provider.
*/
ConferenceProviderArn: Arn;
}
export interface DeleteConferenceProviderResponse {
}
export interface DeleteContactRequest {
/**
* The ARN of the contact to delete.
*/
ContactArn: Arn;
}
export interface DeleteContactResponse {
}
export interface DeleteDeviceRequest {
/**
* The ARN of the device for which to request details.
*/
DeviceArn: Arn;
}
export interface DeleteDeviceResponse {
}
export interface DeleteDeviceUsageDataRequest {
/**
* The ARN of the device.
*/
DeviceArn: Arn;
/**
* The type of usage data to delete.
*/
DeviceUsageType: DeviceUsageType;
}
export interface DeleteDeviceUsageDataResponse {
}
export interface DeleteGatewayGroupRequest {
/**
* The ARN of the gateway group to delete.
*/
GatewayGroupArn: Arn;
}
export interface DeleteGatewayGroupResponse {
}
export interface DeleteNetworkProfileRequest {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn: Arn;
}
export interface DeleteNetworkProfileResponse {
}
export interface DeleteProfileRequest {
/**
* The ARN of the room profile to delete. Required.
*/
ProfileArn?: Arn;
}
export interface DeleteProfileResponse {
}
export interface DeleteRoomRequest {
/**
* The ARN of the room to delete. Required.
*/
RoomArn?: Arn;
}
export interface DeleteRoomResponse {
}
export interface DeleteRoomSkillParameterRequest {
/**
* The ARN of the room from which to remove the room skill parameter details.
*/
RoomArn?: Arn;
/**
* The ID of the skill from which to remove the room skill parameter details.
*/
SkillId: SkillId;
/**
* The room skill parameter key for which to remove details.
*/
ParameterKey: RoomSkillParameterKey;
}
export interface DeleteRoomSkillParameterResponse {
}
export interface DeleteSkillAuthorizationRequest {
/**
* The unique identifier of a skill.
*/
SkillId: SkillId;
/**
* The room that the skill is authorized for.
*/
RoomArn?: Arn;
}
export interface DeleteSkillAuthorizationResponse {
}
export interface DeleteSkillGroupRequest {
/**
* The ARN of the skill group to delete. Required.
*/
SkillGroupArn?: Arn;
}
export interface DeleteSkillGroupResponse {
}
export interface DeleteUserRequest {
/**
* The ARN of the user to delete in the organization. Required.
*/
UserArn?: Arn;
/**
* The ARN of the user's enrollment in the organization. Required.
*/
EnrollmentId: EnrollmentId;
}
export interface DeleteUserResponse {
}
export interface DeveloperInfo {
/**
* The name of the developer.
*/
DeveloperName?: DeveloperName;
/**
* The URL of the privacy policy.
*/
PrivacyPolicy?: PrivacyPolicy;
/**
* The email of the developer.
*/
Email?: Email;
/**
* The website of the developer.
*/
Url?: Url;
}
export type DeveloperName = string;
export interface Device {
/**
* The ARN of a device.
*/
DeviceArn?: Arn;
/**
* The serial number of a device.
*/
DeviceSerialNumber?: DeviceSerialNumber;
/**
* The type of a device.
*/
DeviceType?: DeviceType;
/**
* The name of a device.
*/
DeviceName?: DeviceName;
/**
* The software version of a device.
*/
SoftwareVersion?: SoftwareVersion;
/**
* The MAC address of a device.
*/
MacAddress?: MacAddress;
/**
* The room ARN of a device.
*/
RoomArn?: Arn;
/**
* The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
*/
DeviceStatus?: DeviceStatus;
/**
* Detailed information about a device's status.
*/
DeviceStatusInfo?: DeviceStatusInfo;
/**
* Detailed information about a device's network profile.
*/
NetworkProfileInfo?: DeviceNetworkProfileInfo;
}
export interface DeviceData {
/**
* The ARN of a device.
*/
DeviceArn?: Arn;
/**
* The serial number of a device.
*/
DeviceSerialNumber?: DeviceSerialNumber;
/**
* The type of a device.
*/
DeviceType?: DeviceType;
/**
* The name of a device.
*/
DeviceName?: DeviceName;
/**
* The software version of a device.
*/
SoftwareVersion?: SoftwareVersion;
/**
* The MAC address of a device.
*/
MacAddress?: MacAddress;
/**
* The status of a device.
*/
DeviceStatus?: DeviceStatus;
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn?: Arn;
/**
* The name of the network profile associated with a device.
*/
NetworkProfileName?: NetworkProfileName;
/**
* The room ARN associated with a device.
*/
RoomArn?: Arn;
/**
* The name of the room associated with a device.
*/
RoomName?: RoomName;
/**
* Detailed information about a device's status.
*/
DeviceStatusInfo?: DeviceStatusInfo;
}
export type DeviceDataList = DeviceData[];
export interface DeviceEvent {
/**
* The type of device event.
*/
Type?: DeviceEventType;
/**
* The value of the event.
*/
Value?: DeviceEventValue;
/**
* The time (in epoch) when the event occurred.
*/
Timestamp?: DeviceEventTime;
}
export type DeviceEventList = DeviceEvent[];
export type DeviceEventTime = Date;
export type DeviceEventType = "CONNECTION_STATUS"|"DEVICE_STATUS"|string;
export type DeviceEventValue = string;
export type DeviceLocale = string;
export type DeviceName = string;
export interface DeviceNetworkProfileInfo {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn?: Arn;
/**
* The ARN of the certificate associated with a device.
*/
CertificateArn?: Arn;
/**
* The time (in epoch) when the certificate expires.
*/
CertificateExpirationTime?: CertificateTime;
}
export type DeviceSerialNumber = string;
export type DeviceSerialNumberForAVS = string;
export type DeviceStatus = "READY"|"PENDING"|"WAS_OFFLINE"|"DEREGISTERED"|"FAILED"|string;
export interface DeviceStatusDetail {
/**
* The list of available features on the device.
*/
Feature?: Feature;
/**
* The device status detail code.
*/
Code?: DeviceStatusDetailCode;
}
export type DeviceStatusDetailCode = "DEVICE_SOFTWARE_UPDATE_NEEDED"|"DEVICE_WAS_OFFLINE"|"CREDENTIALS_ACCESS_FAILURE"|"TLS_VERSION_MISMATCH"|"ASSOCIATION_REJECTION"|"AUTHENTICATION_FAILURE"|"DHCP_FAILURE"|"INTERNET_UNAVAILABLE"|"DNS_FAILURE"|"UNKNOWN_FAILURE"|"CERTIFICATE_ISSUING_LIMIT_EXCEEDED"|"INVALID_CERTIFICATE_AUTHORITY"|"NETWORK_PROFILE_NOT_FOUND"|"INVALID_PASSWORD_STATE"|"PASSWORD_NOT_FOUND"|string;
export type DeviceStatusDetails = DeviceStatusDetail[];
export interface DeviceStatusInfo {
/**
* One or more device status detail descriptions.
*/
DeviceStatusDetails?: DeviceStatusDetails;
/**
* The latest available information about the connection status of a device.
*/
ConnectionStatus?: ConnectionStatus;
}
export type DeviceType = string;
export type DeviceUsageType = "VOICE"|string;
export interface DisassociateContactFromAddressBookRequest {
/**
* The ARN of the contact to disassociate from an address book.
*/
ContactArn: Arn;
/**
* The ARN of the address from which to disassociate the contact.
*/
AddressBookArn: Arn;
}
export interface DisassociateContactFromAddressBookResponse {
}
export interface DisassociateDeviceFromRoomRequest {
/**
* The ARN of the device to disassociate from a room. Required.
*/
DeviceArn?: Arn;
}
export interface DisassociateDeviceFromRoomResponse {
}
export interface DisassociateSkillFromSkillGroupRequest {
/**
* The unique identifier of a skill. Required.
*/
SkillGroupArn?: Arn;
/**
* The ARN of a skill group to associate to a skill.
*/
SkillId: SkillId;
}
export interface DisassociateSkillFromSkillGroupResponse {
}
export interface DisassociateSkillFromUsersRequest {
/**
* The private skill ID you want to make unavailable for enrolled users.
*/
SkillId: SkillId;
}
export interface DisassociateSkillFromUsersResponse {
}
export interface DisassociateSkillGroupFromRoomRequest {
/**
* The ARN of the skill group to disassociate from a room. Required.
*/
SkillGroupArn?: Arn;
/**
* The ARN of the room from which the skill group is to be disassociated. Required.
*/
RoomArn?: Arn;
}
export interface DisassociateSkillGroupFromRoomResponse {
}
export type DistanceUnit = "METRIC"|"IMPERIAL"|string;
export type Email = string;
export type EnablementType = "ENABLED"|"PENDING"|string;
export type EnablementTypeFilter = "ENABLED"|"PENDING"|string;
export interface EndOfMeetingReminder {
/**
* A range of 3 to 15 minutes that determines when the reminder begins.
*/
ReminderAtMinutes?: EndOfMeetingReminderMinutesList;
/**
* The type of sound that users hear during the end of meeting reminder.
*/
ReminderType?: EndOfMeetingReminderType;
/**
* Whether an end of meeting reminder is enabled or not.
*/
Enabled?: Boolean;
}
export type EndOfMeetingReminderMinutesList = Minutes[];
export type EndOfMeetingReminderType = "ANNOUNCEMENT_TIME_CHECK"|"ANNOUNCEMENT_VARIABLE_TIME_LEFT"|"CHIME"|"KNOCK"|string;
export type EndUserLicenseAgreement = string;
export type Endpoint = string;
export type EnrollmentId = string;
export type EnrollmentStatus = "INITIALIZED"|"PENDING"|"REGISTERED"|"DISASSOCIATING"|"DEREGISTERING"|string;
export type Feature = "BLUETOOTH"|"VOLUME"|"NOTIFICATIONS"|"LISTS"|"SKILLS"|"NETWORK_PROFILE"|"SETTINGS"|"ALL"|string;
export type Features = Feature[];
export interface Filter {
/**
* The key of a filter.
*/
Key: FilterKey;
/**
* The values of a filter.
*/
Values: FilterValueList;
}
export type FilterKey = string;
export type FilterList = Filter[];
export type FilterValue = string;
export type FilterValueList = FilterValue[];
export interface ForgetSmartHomeAppliancesRequest {
/**
* The room that the appliances are associated with.
*/
RoomArn: Arn;
}
export interface ForgetSmartHomeAppliancesResponse {
}
export interface Gateway {
/**
* The ARN of the gateway.
*/
Arn?: Arn;
/**
* The name of the gateway.
*/
Name?: GatewayName;
/**
* The description of the gateway.
*/
Description?: GatewayDescription;
/**
* The ARN of the gateway group that the gateway is associated to.
*/
GatewayGroupArn?: Arn;
/**
* The software version of the gateway. The gateway automatically updates its software version during normal operation.
*/
SoftwareVersion?: GatewayVersion;
}
export type GatewayDescription = string;
export interface GatewayGroup {
/**
* The ARN of the gateway group.
*/
Arn?: Arn;
/**
* The name of the gateway group.
*/
Name?: GatewayGroupName;
/**
* The description of the gateway group.
*/
Description?: GatewayGroupDescription;
}
export type GatewayGroupDescription = string;
export type GatewayGroupName = string;
export type GatewayGroupSummaries = GatewayGroupSummary[];
export interface GatewayGroupSummary {
/**
* The ARN of the gateway group.
*/
Arn?: Arn;
/**
* The name of the gateway group.
*/
Name?: GatewayGroupName;
/**
* The description of the gateway group.
*/
Description?: GatewayGroupDescription;
}
export type GatewayName = string;
export type GatewaySummaries = GatewaySummary[];
export interface GatewaySummary {
/**
* The ARN of the gateway.
*/
Arn?: Arn;
/**
* The name of the gateway.
*/
Name?: GatewayName;
/**
* The description of the gateway.
*/
Description?: GatewayDescription;
/**
* The ARN of the gateway group that the gateway is associated to.
*/
GatewayGroupArn?: Arn;
/**
* The software version of the gateway. The gateway automatically updates its software version during normal operation.
*/
SoftwareVersion?: GatewayVersion;
}
export type GatewayVersion = string;
export type GenericKeyword = string;
export type GenericKeywords = GenericKeyword[];
export interface GetAddressBookRequest {
/**
* The ARN of the address book for which to request details.
*/
AddressBookArn: Arn;
}
export interface GetAddressBookResponse {
/**
* The details of the requested address book.
*/
AddressBook?: AddressBook;
}
export interface GetConferencePreferenceRequest {
}
export interface GetConferencePreferenceResponse {
/**
* The conference preference.
*/
Preference?: ConferencePreference;
}
export interface GetConferenceProviderRequest {
/**
* The ARN of the newly created conference provider.
*/
ConferenceProviderArn: Arn;
}
export interface GetConferenceProviderResponse {
/**
* The conference provider.
*/
ConferenceProvider?: ConferenceProvider;
}
export interface GetContactRequest {
/**
* The ARN of the contact for which to request details.
*/
ContactArn: Arn;
}
export interface GetContactResponse {
/**
* The details of the requested contact.
*/
Contact?: Contact;
}
export interface GetDeviceRequest {
/**
* The ARN of the device for which to request details. Required.
*/
DeviceArn?: Arn;
}
export interface GetDeviceResponse {
/**
* The details of the device requested. Required.
*/
Device?: Device;
}
export interface GetGatewayGroupRequest {
/**
* The ARN of the gateway group to get.
*/
GatewayGroupArn: Arn;
}
export interface GetGatewayGroupResponse {
GatewayGroup?: GatewayGroup;
}
export interface GetGatewayRequest {
/**
* The ARN of the gateway to get.
*/
GatewayArn: Arn;
}
export interface GetGatewayResponse {
/**
* The details of the gateway.
*/
Gateway?: Gateway;
}
export interface GetInvitationConfigurationRequest {
}
export interface GetInvitationConfigurationResponse {
/**
* The name of the organization sending the enrollment invite to a user.
*/
OrganizationName?: OrganizationName;
/**
* The email ID of the organization or individual contact that the enrolled user can use.
*/
ContactEmail?: Email;
/**
* The list of private skill IDs that you want to recommend to the user to enable in the invitation.
*/
PrivateSkillIds?: ShortSkillIdList;
}
export interface GetNetworkProfileRequest {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn: Arn;
}
export interface GetNetworkProfileResponse {
/**
* The network profile associated with a device.
*/
NetworkProfile?: NetworkProfile;
}
export interface GetProfileRequest {
/**
* The ARN of the room profile for which to request details. Required.
*/
ProfileArn?: Arn;
}
export interface GetProfileResponse {
/**
* The details of the room profile requested. Required.
*/
Profile?: Profile;
}
export interface GetRoomRequest {
/**
* The ARN of the room for which to request details. Required.
*/
RoomArn?: Arn;
}
export interface GetRoomResponse {
/**
* The details of the room requested.
*/
Room?: Room;
}
export interface GetRoomSkillParameterRequest {
/**
* The ARN of the room from which to get the room skill parameter details.
*/
RoomArn?: Arn;
/**
* The ARN of the skill from which to get the room skill parameter details. Required.
*/
SkillId: SkillId;
/**
* The room skill parameter key for which to get details. Required.
*/
ParameterKey: RoomSkillParameterKey;
}
export interface GetRoomSkillParameterResponse {
/**
* The details of the room skill parameter requested. Required.
*/
RoomSkillParameter?: RoomSkillParameter;
}
export interface GetSkillGroupRequest {
/**
* The ARN of the skill group for which to get details. Required.
*/
SkillGroupArn?: Arn;
}
export interface GetSkillGroupResponse {
/**
* The details of the skill group requested. Required.
*/
SkillGroup?: SkillGroup;
}
export interface IPDialIn {
/**
* The IP address.
*/
Endpoint: Endpoint;
/**
* The protocol, including SIP, SIPS, and H323.
*/
CommsProtocol: CommsProtocol;
}
export type IconUrl = string;
export interface InstantBooking {
/**
* Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
*/
DurationInMinutes?: Minutes;
/**
* Whether instant booking is enabled or not.
*/
Enabled?: Boolean;
}
export type InvocationPhrase = string;
export type Key = string;
export interface ListBusinessReportSchedulesRequest {
/**
* The token used to list the remaining schedules from the previous API call.
*/
NextToken?: NextToken;
/**
* The maximum number of schedules listed in the call.
*/
MaxResults?: MaxResults;
}
export interface ListBusinessReportSchedulesResponse {
/**
* The schedule of the reports.
*/
BusinessReportSchedules?: BusinessReportScheduleList;
/**
* The token used to list the remaining schedules from the previous API call.
*/
NextToken?: NextToken;
}
export interface ListConferenceProvidersRequest {
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
/**
* The maximum number of conference providers to be returned, per paginated calls.
*/
MaxResults?: MaxResults;
}
export interface ListConferenceProvidersResponse {
/**
* The conference providers.
*/
ConferenceProviders?: ConferenceProvidersList;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
}
export interface ListDeviceEventsRequest {
/**
* The ARN of a device.
*/
DeviceArn: Arn;
/**
* The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
*/
EventType?: DeviceEventType;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
}
export interface ListDeviceEventsResponse {
/**
* The device events requested for the device ARN.
*/
DeviceEvents?: DeviceEventList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
}
export interface ListGatewayGroupsRequest {
/**
* The token used to paginate though multiple pages of gateway group summaries.
*/
NextToken?: NextToken;
/**
* The maximum number of gateway group summaries to return. The default is 50.
*/
MaxResults?: MaxResults;
}
export interface ListGatewayGroupsResponse {
/**
* The gateway groups in the list.
*/
GatewayGroups?: GatewayGroupSummaries;
/**
* The token used to paginate though multiple pages of gateway group summaries.
*/
NextToken?: NextToken;
}
export interface ListGatewaysRequest {
/**
* The gateway group ARN for which to list gateways.
*/
GatewayGroupArn?: Arn;
/**
* The token used to paginate though multiple pages of gateway summaries.
*/
NextToken?: NextToken;
/**
* The maximum number of gateway summaries to return. The default is 50.
*/
MaxResults?: MaxResults;
}
export interface ListGatewaysResponse {
/**
* The gateways in the list.
*/
Gateways?: GatewaySummaries;
/**
* The token used to paginate though multiple pages of gateway summaries.
*/
NextToken?: NextToken;
}
export interface ListSkillsRequest {
/**
* The ARN of the skill group for which to list enabled skills.
*/
SkillGroupArn?: Arn;
/**
* Whether the skill is enabled under the user's account.
*/
EnablementType?: EnablementTypeFilter;
/**
* Whether the skill is publicly available or is a private skill.
*/
SkillType?: SkillTypeFilter;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: SkillListMaxResults;
}
export interface ListSkillsResponse {
/**
* The list of enabled skills requested. Required.
*/
SkillSummaries?: SkillSummaryList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
}
export interface ListSkillsStoreCategoriesRequest {
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
/**
* The maximum number of categories returned, per paginated calls.
*/
MaxResults?: MaxResults;
}
export interface ListSkillsStoreCategoriesResponse {
/**
* The list of categories.
*/
CategoryList?: CategoryList;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
}
export interface ListSkillsStoreSkillsByCategoryRequest {
/**
* The category ID for which the skills are being retrieved from the skill store.
*/
CategoryId: CategoryId;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
/**
* The maximum number of skills returned per paginated calls.
*/
MaxResults?: SkillListMaxResults;
}
export interface ListSkillsStoreSkillsByCategoryResponse {
/**
* The skill store skills.
*/
SkillsStoreSkills?: SkillsStoreSkillList;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
}
export interface ListSmartHomeAppliancesRequest {
/**
* The room that the appliances are associated with.
*/
RoomArn: Arn;
/**
* The maximum number of appliances to be returned, per paginated calls.
*/
MaxResults?: MaxResults;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
}
export interface ListSmartHomeAppliancesResponse {
/**
* The smart home appliances.
*/
SmartHomeAppliances?: SmartHomeApplianceList;
/**
* The tokens used for pagination.
*/
NextToken?: NextToken;
}
export interface ListTagsRequest {
/**
* The ARN of the specified resource for which to list tags.
*/
Arn: Arn;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
}
export interface ListTagsResponse {
/**
* The tags requested for the specified resource.
*/
Tags?: TagList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
}
export type Locale = "en-US"|string;
export type MacAddress = string;
export type MaxResults = number;
export type MaxVolumeLimit = number;
export interface MeetingRoomConfiguration {
/**
* Whether room utilization metrics are enabled or not.
*/
RoomUtilizationMetricsEnabled?: Boolean;
/**
* Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
*/
EndOfMeetingReminder?: EndOfMeetingReminder;
/**
* Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
*/
InstantBooking?: InstantBooking;
/**
* Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
*/
RequireCheckIn?: RequireCheckIn;
}
export interface MeetingSetting {
/**
* The values that indicate whether the pin is always required.
*/
RequirePin: RequirePin;
}
export type Minutes = number;
export type NetworkEapMethod = "EAP_TLS"|string;
export interface NetworkProfile {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn?: Arn;
/**
* The name of the network profile associated with a device.
*/
NetworkProfileName?: NetworkProfileName;
/**
* Detailed information about a device's network profile.
*/
Description?: NetworkProfileDescription;
/**
* The SSID of the Wi-Fi network.
*/
Ssid?: NetworkSsid;
/**
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*/
SecurityType?: NetworkSecurityType;
/**
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*/
EapMethod?: NetworkEapMethod;
/**
* The current password of the Wi-Fi network.
*/
CurrentPassword?: CurrentWiFiPassword;
/**
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
*/
NextPassword?: NextWiFiPassword;
/**
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
*/
CertificateAuthorityArn?: Arn;
/**
* The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
*/
TrustAnchors?: TrustAnchorList;
}
export interface NetworkProfileData {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn?: Arn;
/**
* The name of the network profile associated with a device.
*/
NetworkProfileName?: NetworkProfileName;
/**
* Detailed information about a device's network profile.
*/
Description?: NetworkProfileDescription;
/**
* The SSID of the Wi-Fi network.
*/
Ssid?: NetworkSsid;
/**
* The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
*/
SecurityType?: NetworkSecurityType;
/**
* The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
*/
EapMethod?: NetworkEapMethod;
/**
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
*/
CertificateAuthorityArn?: Arn;
}
export type NetworkProfileDataList = NetworkProfileData[];
export type NetworkProfileDescription = string;
export type NetworkProfileName = string;
export type NetworkSecurityType = "OPEN"|"WEP"|"WPA_PSK"|"WPA2_PSK"|"WPA2_ENTERPRISE"|string;
export type NetworkSsid = string;
export type NewInThisVersionBulletPoints = BulletPoint[];
export type NextToken = string;
export type NextWiFiPassword = string;
export type OneClickIdDelay = string;
export type OneClickPinDelay = string;
export type OrganizationName = string;
export type OutboundPhoneNumber = string;
export interface PSTNDialIn {
/**
* The zip code.
*/
CountryCode: CountryCode;
/**
* The phone number to call to join the conference.
*/
PhoneNumber: OutboundPhoneNumber;
/**
* The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
*/
OneClickIdDelay: OneClickIdDelay;
/**
* The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
*/
OneClickPinDelay: OneClickPinDelay;
}
export interface PhoneNumber {
/**
* The raw value of the phone number.
*/
Number: RawPhoneNumber;
/**
* The type of the phone number.
*/
Type: PhoneNumberType;
}
export type PhoneNumberList = PhoneNumber[];
export type PhoneNumberType = "MOBILE"|"WORK"|"HOME"|string;
export type PrivacyPolicy = string;
export type ProductDescription = string;
export type ProductId = string;
export interface Profile {
/**
* The ARN of a room profile.
*/
ProfileArn?: Arn;
/**
* The name of a room profile.
*/
ProfileName?: ProfileName;
/**
* Retrieves if the profile is default or not.
*/
IsDefault?: Boolean;
/**
* The address of a room profile.
*/
Address?: Address;
/**
* The time zone of a room profile.
*/
Timezone?: Timezone;
/**
* The distance unit of a room profile.
*/
DistanceUnit?: DistanceUnit;
/**
* The temperature unit of a room profile.
*/
TemperatureUnit?: TemperatureUnit;
/**
* The wake word of a room profile.
*/
WakeWord?: WakeWord;
/**
* The locale of a room profile. (This is currently available only to a limited preview audience.)
*/
Locale?: DeviceLocale;
/**
* The setup mode of a room profile.
*/
SetupModeDisabled?: Boolean;
/**
* The max volume limit of a room profile.
*/
MaxVolumeLimit?: MaxVolumeLimit;
/**
* The PSTN setting of a room profile.
*/
PSTNEnabled?: Boolean;
/**
* The ARN of the address book.
*/
AddressBookArn?: Arn;
/**
* Meeting room settings of a room profile.
*/
MeetingRoomConfiguration?: MeetingRoomConfiguration;
}
export interface ProfileData {
/**
* The ARN of a room profile.
*/
ProfileArn?: Arn;
/**
* The name of a room profile.
*/
ProfileName?: ProfileName;
/**
* Retrieves if the profile data is default or not.
*/
IsDefault?: Boolean;
/**
* The address of a room profile.
*/
Address?: Address;
/**
* The time zone of a room profile.
*/
Timezone?: Timezone;
/**
* The distance unit of a room profile.
*/
DistanceUnit?: DistanceUnit;
/**
* The temperature unit of a room profile.
*/
TemperatureUnit?: TemperatureUnit;
/**
* The wake word of a room profile.
*/
WakeWord?: WakeWord;
/**
* The locale of a room profile. (This is currently available only to a limited preview audience.)
*/
Locale?: DeviceLocale;
}
export type ProfileDataList = ProfileData[];
export type ProfileName = string;
export type ProviderCalendarId = string;
export interface PutConferencePreferenceRequest {
/**
* The conference preference of a specific conference provider.
*/
ConferencePreference: ConferencePreference;
}
export interface PutConferencePreferenceResponse {
}
export interface PutInvitationConfigurationRequest {
/**
* The name of the organization sending the enrollment invite to a user.
*/
OrganizationName: OrganizationName;
/**
* The email ID of the organization or individual contact that the enrolled user can use.
*/
ContactEmail?: Email;
/**
* The list of private skill IDs that you want to recommend to the user to enable in the invitation.
*/
PrivateSkillIds?: ShortSkillIdList;
}
export interface PutInvitationConfigurationResponse {
}
export interface PutRoomSkillParameterRequest {
/**
* The ARN of the room associated with the room skill parameter. Required.
*/
RoomArn?: Arn;
/**
* The ARN of the skill associated with the room skill parameter. Required.
*/
SkillId: SkillId;
/**
* The updated room skill parameter. Required.
*/
RoomSkillParameter: RoomSkillParameter;
}
export interface PutRoomSkillParameterResponse {
}
export interface PutSkillAuthorizationRequest {
/**
* The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
*/
AuthorizationResult: AuthorizationResult;
/**
* The unique identifier of a skill.
*/
SkillId: SkillId;
/**
* The room that the skill is authorized for.
*/
RoomArn?: Arn;
}
export interface PutSkillAuthorizationResponse {
}
export type RawPhoneNumber = string;
export interface RegisterAVSDeviceRequest {
/**
* The client ID of the OEM used for code-based linking authorization on an AVS device.
*/
ClientId: ClientId;
/**
* The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.
*/
UserCode: UserCode;
/**
* The product ID used to identify your AVS device during authorization.
*/
ProductId: ProductId;
/**
* The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
*/
DeviceSerialNumber: DeviceSerialNumberForAVS;
/**
* The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
*/
AmazonId: AmazonId;
}
export interface RegisterAVSDeviceResponse {
/**
* The ARN of the device.
*/
DeviceArn?: Arn;
}
export interface RejectSkillRequest {
/**
* The unique identifier of the skill.
*/
SkillId: SkillId;
}
export interface RejectSkillResponse {
}
export type ReleaseDate = string;
export interface RequireCheckIn {
/**
* Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
*/
ReleaseAfterMinutes?: Minutes;
/**
* Whether require check in is enabled or not.
*/
Enabled?: Boolean;
}
export type RequirePin = "YES"|"NO"|"OPTIONAL"|string;
export interface ResolveRoomRequest {
/**
* The ARN of the user. Required.
*/
UserId: UserId;
/**
* The ARN of the skill that was requested. Required.
*/
SkillId: SkillId;
}
export interface ResolveRoomResponse {
/**
* The ARN of the room from which the skill request was invoked.
*/
RoomArn?: Arn;
/**
* The name of the room from which the skill request was invoked.
*/
RoomName?: RoomName;
/**
* Response to get the room profile request. Required.
*/
RoomSkillParameters?: RoomSkillParameters;
}
export type ReviewKey = string;
export type ReviewValue = string;
export type Reviews = {[key: string]: ReviewValue};
export interface RevokeInvitationRequest {
/**
* The ARN of the user for whom to revoke an enrollment invitation. Required.
*/
UserArn?: Arn;
/**
* The ARN of the enrollment invitation to revoke. Required.
*/
EnrollmentId?: EnrollmentId;
}
export interface RevokeInvitationResponse {
}
export interface Room {
/**
* The ARN of a room.
*/
RoomArn?: Arn;
/**
* The name of a room.
*/
RoomName?: RoomName;
/**
* The description of a room.
*/
Description?: RoomDescription;
/**
* The provider calendar ARN of a room.
*/
ProviderCalendarId?: ProviderCalendarId;
/**
* The profile ARN of a room.
*/
ProfileArn?: Arn;
}
export interface RoomData {
/**
* The ARN of a room.
*/
RoomArn?: Arn;
/**
* The name of a room.
*/
RoomName?: RoomName;
/**
* The description of a room.
*/
Description?: RoomDescription;
/**
* The provider calendar ARN of a room.
*/
ProviderCalendarId?: ProviderCalendarId;
/**
* The profile ARN of a room.
*/
ProfileArn?: Arn;
/**
* The profile name of a room.
*/
ProfileName?: ProfileName;
}
export type RoomDataList = RoomData[];
export type RoomDescription = string;
export type RoomName = string;
export interface RoomSkillParameter {
/**
* The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
*/
ParameterKey: RoomSkillParameterKey;
/**
* The parameter value of a room skill parameter.
*/
ParameterValue: RoomSkillParameterValue;
}
export type RoomSkillParameterKey = string;
export type RoomSkillParameterValue = string;
export type RoomSkillParameters = RoomSkillParameter[];
export type S3KeyPrefix = string;
export type SampleUtterances = Utterance[];
export interface SearchAddressBooksRequest {
/**
* The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
*/
SortCriteria?: SortList;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
}
export interface SearchAddressBooksResponse {
/**
* The address books that meet the specified set of filter criteria, in sort order.
*/
AddressBooks?: AddressBookDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of address books returned.
*/
TotalCount?: TotalCount;
}
export interface SearchContactsRequest {
/**
* The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
*/
SortCriteria?: SortList;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
}
export interface SearchContactsResponse {
/**
* The contacts that meet the specified set of filter criteria, in sort order.
*/
Contacts?: ContactDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of contacts returned.
*/
TotalCount?: TotalCount;
}
export interface SearchDevicesRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
/**
* The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
*/
SortCriteria?: SortList;
}
export interface SearchDevicesResponse {
/**
* The devices that meet the specified set of filter criteria, in sort order.
*/
Devices?: DeviceDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of devices returned.
*/
TotalCount?: TotalCount;
}
export interface SearchNetworkProfilesRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
/**
* The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
*/
Filters?: FilterList;
/**
* The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
*/
SortCriteria?: SortList;
}
export interface SearchNetworkProfilesResponse {
/**
* The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
*/
NetworkProfiles?: NetworkProfileDataList;
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The total number of network profiles returned.
*/
TotalCount?: TotalCount;
}
export interface SearchProfilesRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
/**
* The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
*/
SortCriteria?: SortList;
}
export interface SearchProfilesResponse {
/**
* The profiles that meet the specified set of filter criteria, in sort order.
*/
Profiles?: ProfileDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of room profiles returned.
*/
TotalCount?: TotalCount;
}
export interface SearchRoomsRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
/**
* The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
*/
SortCriteria?: SortList;
}
export interface SearchRoomsResponse {
/**
* The rooms that meet the specified set of filter criteria, in sort order.
*/
Rooms?: RoomDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of rooms returned.
*/
TotalCount?: TotalCount;
}
export interface SearchSkillGroupsRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
*/
MaxResults?: MaxResults;
/**
* The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
*/
SortCriteria?: SortList;
}
export interface SearchSkillGroupsResponse {
/**
* The skill groups that meet the filter criteria, in sort order.
*/
SkillGroups?: SkillGroupDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of skill groups returned.
*/
TotalCount?: TotalCount;
}
export interface SearchUsersRequest {
/**
* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
*/
NextToken?: NextToken;
/**
* The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
*/
MaxResults?: MaxResults;
/**
* The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
*/
Filters?: FilterList;
/**
* The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
*/
SortCriteria?: SortList;
}
export interface SearchUsersResponse {
/**
* The users that meet the specified set of filter criteria, in sort order.
*/
Users?: UserDataList;
/**
* The token returned to indicate that there is more data available.
*/
NextToken?: NextToken;
/**
* The total number of users returned.
*/
TotalCount?: TotalCount;
}
export interface SendAnnouncementRequest {
/**
* The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
*/
RoomFilters: FilterList;
/**
* The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
*/
Content: Content;
/**
* The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
*/
TimeToLiveInSeconds?: TimeToLiveInSeconds;
/**
* The unique, user-specified identifier for the request that ensures idempotency.
*/
ClientRequestToken: ClientRequestToken;
}
export interface SendAnnouncementResponse {
/**
* The identifier of the announcement.
*/
AnnouncementArn?: Arn;
}
export interface SendInvitationRequest {
/**
* The ARN of the user to whom to send an invitation. Required.
*/
UserArn?: Arn;
}
export interface SendInvitationResponse {
}
export type ShortDescription = string;
export type ShortSkillIdList = SkillId[];
export interface SipAddress {
/**
* The URI for the SIP address.
*/
Uri: SipUri;
/**
* The type of the SIP address.
*/
Type: SipType;
}
export type SipAddressList = SipAddress[];
export type SipType = "WORK"|string;
export type SipUri = string;
export interface SkillDetails {
/**
* The description of the product.
*/
ProductDescription?: ProductDescription;
/**
* The phrase used to trigger the skill.
*/
InvocationPhrase?: InvocationPhrase;
/**
* The date when the skill was released.
*/
ReleaseDate?: ReleaseDate;
/**
* The URL of the end user license agreement.
*/
EndUserLicenseAgreement?: EndUserLicenseAgreement;
/**
* The generic keywords associated with the skill that can be used to find a skill.
*/
GenericKeywords?: GenericKeywords;
/**
* The details about what the skill supports organized as bullet points.
*/
BulletPoints?: BulletPoints;
/**
* The updates added in bullet points.
*/
NewInThisVersionBulletPoints?: NewInThisVersionBulletPoints;
/**
* The types of skills.
*/
SkillTypes?: SkillTypes;
/**
* The list of reviews for the skill, including Key and Value pair.
*/
Reviews?: Reviews;
/**
* The details about the developer that published the skill.
*/
DeveloperInfo?: DeveloperInfo;
}
export interface SkillGroup {
/**
* The ARN of a skill group.
*/
SkillGroupArn?: Arn;
/**
* The name of a skill group.
*/
SkillGroupName?: SkillGroupName;
/**
* The description of a skill group.
*/
Description?: SkillGroupDescription;
}
export interface SkillGroupData {
/**
* The skill group ARN of a skill group.
*/
SkillGroupArn?: Arn;
/**
* The skill group name of a skill group.
*/
SkillGroupName?: SkillGroupName;
/**
* The description of a skill group.
*/
Description?: SkillGroupDescription;
}
export type SkillGroupDataList = SkillGroupData[];
export type SkillGroupDescription = string;
export type SkillGroupName = string;
export type SkillId = string;
export type SkillListMaxResults = number;
export type SkillName = string;
export type SkillStoreType = string;
export interface SkillSummary {
/**
* The ARN of the skill summary.
*/
SkillId?: SkillId;
/**
* The name of the skill.
*/
SkillName?: SkillName;
/**
* Linking support for a skill.
*/
SupportsLinking?: boolean;
/**
* Whether the skill is enabled under the user's account, or if it requires linking to be used.
*/
EnablementType?: EnablementType;
/**
* Whether the skill is publicly available or is a private skill.
*/
SkillType?: SkillType;
}
export type SkillSummaryList = SkillSummary[];
export type SkillType = "PUBLIC"|"PRIVATE"|string;
export type SkillTypeFilter = "PUBLIC"|"PRIVATE"|"ALL"|string;
export type SkillTypes = SkillStoreType[];
export interface SkillsStoreSkill {
/**
* The ARN of the skill.
*/
SkillId?: SkillId;
/**
* The name of the skill.
*/
SkillName?: SkillName;
/**
* Short description about the skill.
*/
ShortDescription?: ShortDescription;
/**
* The URL where the skill icon resides.
*/
IconUrl?: IconUrl;
/**
* Sample utterances that interact with the skill.
*/
SampleUtterances?: SampleUtterances;
/**
* Information about the skill.
*/
SkillDetails?: SkillDetails;
/**
* Linking support for a skill.
*/
SupportsLinking?: boolean;
}
export type SkillsStoreSkillList = SkillsStoreSkill[];
export interface SmartHomeAppliance {
/**
* The friendly name of the smart home appliance.
*/
FriendlyName?: ApplianceFriendlyName;
/**
* The description of the smart home appliance.
*/
Description?: ApplianceDescription;
/**
* The name of the manufacturer of the smart home appliance.
*/
ManufacturerName?: ApplianceManufacturerName;
}
export type SmartHomeApplianceList = SmartHomeAppliance[];
export type SoftwareVersion = string;
export interface Sort {
/**
* The sort key of a sort object.
*/
Key: SortKey;
/**
* The sort value of a sort object.
*/
Value: SortValue;
}
export type SortKey = string;
export type SortList = Sort[];
export type SortValue = "ASC"|"DESC"|string;
export interface Ssml {
/**
* The locale of the SSML message. Currently, en-US is supported.
*/
Locale: Locale;
/**
* The value of the SSML message in the correct SSML format. The audio tag is not supported.
*/
Value: SsmlValue;
}
export type SsmlList = Ssml[];
export type SsmlValue = string;
export interface StartDeviceSyncRequest {
/**
* The ARN of the room with which the device to sync is associated. Required.
*/
RoomArn?: Arn;
/**
* The ARN of the device to sync. Required.
*/
DeviceArn?: Arn;
/**
* Request structure to start the device sync. Required.
*/
Features: Features;
}
export interface StartDeviceSyncResponse {
}
export interface StartSmartHomeApplianceDiscoveryRequest {
/**
* The room where smart home appliance discovery was initiated.
*/
RoomArn: Arn;
}
export interface StartSmartHomeApplianceDiscoveryResponse {
}
export interface Tag {
/**
* The key of a tag. Tag keys are case-sensitive.
*/
Key: TagKey;
/**
* The value of a tag. Tag values are case sensitive and can be null.
*/
Value: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceRequest {
/**
* The ARN of the resource to which to add metadata tags. Required.
*/
Arn: Arn;
/**
* The tags to be added to the specified resource. Do not provide system tags. Required.
*/
Tags: TagList;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type TemperatureUnit = "FAHRENHEIT"|"CELSIUS"|string;
export interface Text {
/**
* The locale of the text message. Currently, en-US is supported.
*/
Locale: Locale;
/**
* The value of the text message.
*/
Value: TextValue;
}
export type TextList = Text[];
export type TextValue = string;
export type TimeToLiveInSeconds = number;
export type Timezone = string;
export type TotalCount = number;
export type TrustAnchor = string;
export type TrustAnchorList = TrustAnchor[];
export interface UntagResourceRequest {
/**
* The ARN of the resource from which to remove metadata tags. Required.
*/
Arn: Arn;
/**
* The tags to be removed from the specified resource. Do not provide system tags. Required.
*/
TagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateAddressBookRequest {
/**
* The ARN of the room to update.
*/
AddressBookArn: Arn;
/**
* The updated name of the room.
*/
Name?: AddressBookName;
/**
* The updated description of the room.
*/
Description?: AddressBookDescription;
}
export interface UpdateAddressBookResponse {
}
export interface UpdateBusinessReportScheduleRequest {
/**
* The ARN of the business report schedule.
*/
ScheduleArn: Arn;
/**
* The S3 location of the output reports.
*/
S3BucketName?: CustomerS3BucketName;
/**
* The S3 key where the report is delivered.
*/
S3KeyPrefix?: S3KeyPrefix;
/**
* The format of the generated report (individual CSV files or zipped files of individual files).
*/
Format?: BusinessReportFormat;
/**
* The name identifier of the schedule.
*/
ScheduleName?: BusinessReportScheduleName;
/**
* The recurrence of the reports.
*/
Recurrence?: BusinessReportRecurrence;
}
export interface UpdateBusinessReportScheduleResponse {
}
export interface UpdateConferenceProviderRequest {
/**
* The ARN of the conference provider.
*/
ConferenceProviderArn: Arn;
/**
* The type of the conference provider.
*/
ConferenceProviderType: ConferenceProviderType;
/**
* The IP endpoint and protocol for calling.
*/
IPDialIn?: IPDialIn;
/**
* The information for PSTN conferencing.
*/
PSTNDialIn?: PSTNDialIn;
/**
* The meeting settings for the conference provider.
*/
MeetingSetting: MeetingSetting;
}
export interface UpdateConferenceProviderResponse {
}
export interface UpdateContactRequest {
/**
* The ARN of the contact to update.
*/
ContactArn: Arn;
/**
* The updated display name of the contact.
*/
DisplayName?: ContactName;
/**
* The updated first name of the contact.
*/
FirstName?: ContactName;
/**
* The updated last name of the contact.
*/
LastName?: ContactName;
/**
* The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
*/
PhoneNumber?: RawPhoneNumber;
/**
* The list of phone numbers for the contact.
*/
PhoneNumbers?: PhoneNumberList;
/**
* The list of SIP addresses for the contact.
*/
SipAddresses?: SipAddressList;
}
export interface UpdateContactResponse {
}
export interface UpdateDeviceRequest {
/**
* The ARN of the device to update. Required.
*/
DeviceArn?: Arn;
/**
* The updated device name. Required.
*/
DeviceName?: DeviceName;
}
export interface UpdateDeviceResponse {
}
export interface UpdateEndOfMeetingReminder {
/**
* Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
*/
ReminderAtMinutes?: EndOfMeetingReminderMinutesList;
/**
* The type of sound that users hear during the end of meeting reminder.
*/
ReminderType?: EndOfMeetingReminderType;
/**
* Whether an end of meeting reminder is enabled or not.
*/
Enabled?: Boolean;
}
export interface UpdateGatewayGroupRequest {
/**
* The ARN of the gateway group to update.
*/
GatewayGroupArn: Arn;
/**
* The updated name of the gateway group.
*/
Name?: GatewayGroupName;
/**
* The updated description of the gateway group.
*/
Description?: GatewayGroupDescription;
}
export interface UpdateGatewayGroupResponse {
}
export interface UpdateGatewayRequest {
/**
* The ARN of the gateway to update.
*/
GatewayArn: Arn;
/**
* The updated name of the gateway.
*/
Name?: GatewayName;
/**
* The updated description of the gateway.
*/
Description?: GatewayDescription;
/**
* The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
*/
SoftwareVersion?: GatewayVersion;
}
export interface UpdateGatewayResponse {
}
export interface UpdateInstantBooking {
/**
* Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
*/
DurationInMinutes?: Minutes;
/**
* Whether instant booking is enabled or not.
*/
Enabled?: Boolean;
}
export interface UpdateMeetingRoomConfiguration {
/**
* Whether room utilization metrics are enabled or not.
*/
RoomUtilizationMetricsEnabled?: Boolean;
/**
* Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
*/
EndOfMeetingReminder?: UpdateEndOfMeetingReminder;
/**
* Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.
*/
InstantBooking?: UpdateInstantBooking;
/**
* Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
*/
RequireCheckIn?: UpdateRequireCheckIn;
}
export interface UpdateNetworkProfileRequest {
/**
* The ARN of the network profile associated with a device.
*/
NetworkProfileArn: Arn;
/**
* The name of the network profile associated with a device.
*/
NetworkProfileName?: NetworkProfileName;
/**
* Detailed information about a device's network profile.
*/
Description?: NetworkProfileDescription;
/**
* The current password of the Wi-Fi network.
*/
CurrentPassword?: CurrentWiFiPassword;
/**
* The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
*/
NextPassword?: NextWiFiPassword;
/**
* The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
*/
CertificateAuthorityArn?: Arn;
/**
* The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.
*/
TrustAnchors?: TrustAnchorList;
}
export interface UpdateNetworkProfileResponse {
}
export interface UpdateProfileRequest {
/**
* The ARN of the room profile to update. Required.
*/
ProfileArn?: Arn;
/**
* The updated name for the room profile.
*/
ProfileName?: ProfileName;
/**
* Sets the profile as default if selected. If this is missing, no update is done to the default status.
*/
IsDefault?: Boolean;
/**
* The updated timezone for the room profile.
*/
Timezone?: Timezone;
/**
* The updated address for the room profile.
*/
Address?: Address;
/**
* The updated distance unit for the room profile.
*/
DistanceUnit?: DistanceUnit;
/**
* The updated temperature unit for the room profile.
*/
TemperatureUnit?: TemperatureUnit;
/**
* The updated wake word for the room profile.
*/
WakeWord?: WakeWord;
/**
* The updated locale for the room profile. (This is currently only available to a limited preview audience.)
*/
Locale?: DeviceLocale;
/**
* Whether the setup mode of the profile is enabled.
*/
SetupModeDisabled?: Boolean;
/**
* The updated maximum volume limit for the room profile.
*/
MaxVolumeLimit?: MaxVolumeLimit;
/**
* Whether the PSTN setting of the room profile is enabled.
*/
PSTNEnabled?: Boolean;
/**
* The updated meeting room settings of a room profile.
*/
MeetingRoomConfiguration?: UpdateMeetingRoomConfiguration;
}
export interface UpdateProfileResponse {
}
export interface UpdateRequireCheckIn {
/**
* Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
*/
ReleaseAfterMinutes?: Minutes;
/**
* Whether require check in is enabled or not.
*/
Enabled?: Boolean;
}
export interface UpdateRoomRequest {
/**
* The ARN of the room to update.
*/
RoomArn?: Arn;
/**
* The updated name for the room.
*/
RoomName?: RoomName;
/**
* The updated description for the room.
*/
Description?: RoomDescription;
/**
* The updated provider calendar ARN for the room.
*/
ProviderCalendarId?: ProviderCalendarId;
/**
* The updated profile ARN for the room.
*/
ProfileArn?: Arn;
}
export interface UpdateRoomResponse {
}
export interface UpdateSkillGroupRequest {
/**
* The ARN of the skill group to update.
*/
SkillGroupArn?: Arn;
/**
* The updated name for the skill group.
*/
SkillGroupName?: SkillGroupName;
/**
* The updated description for the skill group.
*/
Description?: SkillGroupDescription;
}
export interface UpdateSkillGroupResponse {
}
export type Url = string;
export type UserCode = string;
export interface UserData {
/**
* The ARN of a user.
*/
UserArn?: Arn;
/**
* The first name of a user.
*/
FirstName?: user_FirstName;
/**
* The last name of a user.
*/
LastName?: user_LastName;
/**
* The email of a user.
*/
Email?: Email;
/**
* The enrollment status of a user.
*/
EnrollmentStatus?: EnrollmentStatus;
/**
* The enrollment ARN of a user.
*/
EnrollmentId?: EnrollmentId;
}
export type UserDataList = UserData[];
export type UserId = string;
export type Utterance = string;
export type Value = string;
export type WakeWord = "ALEXA"|"AMAZON"|"ECHO"|"COMPUTER"|string;
export type user_FirstName = string;
export type user_LastName = string;
export type user_UserId = string;
/**
* 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 = "2017-11-09"|"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 AlexaForBusiness client.
*/
export import Types = AlexaForBusiness;
}
export = AlexaForBusiness;