chime.d.ts
124 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
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 Chime extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Chime.Types.ClientConfiguration)
config: Config & Chime.Types.ClientConfiguration;
/**
* Associates a phone number with the specified Amazon Chime user.
*/
associatePhoneNumberWithUser(params: Chime.Types.AssociatePhoneNumberWithUserRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request<Chime.Types.AssociatePhoneNumberWithUserResponse, AWSError>;
/**
* Associates a phone number with the specified Amazon Chime user.
*/
associatePhoneNumberWithUser(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumberWithUserResponse) => void): Request<Chime.Types.AssociatePhoneNumberWithUserResponse, AWSError>;
/**
* Associates phone numbers with the specified Amazon Chime Voice Connector.
*/
associatePhoneNumbersWithVoiceConnector(params: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse, AWSError>;
/**
* Associates phone numbers with the specified Amazon Chime Voice Connector.
*/
associatePhoneNumbersWithVoiceConnector(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorResponse, AWSError>;
/**
* Associates phone numbers with the specified Amazon Chime Voice Connector group.
*/
associatePhoneNumbersWithVoiceConnectorGroup(params: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse, AWSError>;
/**
* Associates phone numbers with the specified Amazon Chime Voice Connector group.
*/
associatePhoneNumbersWithVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse) => void): Request<Chime.Types.AssociatePhoneNumbersWithVoiceConnectorGroupResponse, AWSError>;
/**
* Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
batchCreateAttendee(params: Chime.Types.BatchCreateAttendeeRequest, callback?: (err: AWSError, data: Chime.Types.BatchCreateAttendeeResponse) => void): Request<Chime.Types.BatchCreateAttendeeResponse, AWSError>;
/**
* Creates up to 100 new attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
batchCreateAttendee(callback?: (err: AWSError, data: Chime.Types.BatchCreateAttendeeResponse) => void): Request<Chime.Types.BatchCreateAttendeeResponse, AWSError>;
/**
* Adds up to 50 members to a chat room. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
*/
batchCreateRoomMembership(params: Chime.Types.BatchCreateRoomMembershipRequest, callback?: (err: AWSError, data: Chime.Types.BatchCreateRoomMembershipResponse) => void): Request<Chime.Types.BatchCreateRoomMembershipResponse, AWSError>;
/**
* Adds up to 50 members to a chat room. Members can be either users or bots. The member role designates whether the member is a chat room administrator or a general chat room member.
*/
batchCreateRoomMembership(callback?: (err: AWSError, data: Chime.Types.BatchCreateRoomMembershipResponse) => void): Request<Chime.Types.BatchCreateRoomMembershipResponse, AWSError>;
/**
* Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
*/
batchDeletePhoneNumber(params: Chime.Types.BatchDeletePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request<Chime.Types.BatchDeletePhoneNumberResponse, AWSError>;
/**
* Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted. Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
*/
batchDeletePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchDeletePhoneNumberResponse) => void): Request<Chime.Types.BatchDeletePhoneNumberResponse, AWSError>;
/**
* Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.
*/
batchSuspendUser(params: Chime.Types.BatchSuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request<Chime.Types.BatchSuspendUserResponse, AWSError>;
/**
* Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so. Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action. To sign out users without suspending them, use the LogoutUser action.
*/
batchSuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchSuspendUserResponse) => void): Request<Chime.Types.BatchSuspendUserResponse, AWSError>;
/**
* Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
*/
batchUnsuspendUser(params: Chime.Types.BatchUnsuspendUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request<Chime.Types.BatchUnsuspendUserResponse, AWSError>;
/**
* Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide. Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.
*/
batchUnsuspendUser(callback?: (err: AWSError, data: Chime.Types.BatchUnsuspendUserResponse) => void): Request<Chime.Types.BatchUnsuspendUserResponse, AWSError>;
/**
* Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name. For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
*/
batchUpdatePhoneNumber(params: Chime.Types.BatchUpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request<Chime.Types.BatchUpdatePhoneNumberResponse, AWSError>;
/**
* Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name. For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
*/
batchUpdatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.BatchUpdatePhoneNumberResponse) => void): Request<Chime.Types.BatchUpdatePhoneNumberResponse, AWSError>;
/**
* Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
*/
batchUpdateUser(params: Chime.Types.BatchUpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request<Chime.Types.BatchUpdateUserResponse, AWSError>;
/**
* Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.
*/
batchUpdateUser(callback?: (err: AWSError, data: Chime.Types.BatchUpdateUserResponse) => void): Request<Chime.Types.BatchUpdateUserResponse, AWSError>;
/**
* Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
*/
createAccount(params: Chime.Types.CreateAccountRequest, callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request<Chime.Types.CreateAccountResponse, AWSError>;
/**
* Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
*/
createAccount(callback?: (err: AWSError, data: Chime.Types.CreateAccountResponse) => void): Request<Chime.Types.CreateAccountResponse, AWSError>;
/**
* Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
createAttendee(params: Chime.Types.CreateAttendeeRequest, callback?: (err: AWSError, data: Chime.Types.CreateAttendeeResponse) => void): Request<Chime.Types.CreateAttendeeResponse, AWSError>;
/**
* Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
createAttendee(callback?: (err: AWSError, data: Chime.Types.CreateAttendeeResponse) => void): Request<Chime.Types.CreateAttendeeResponse, AWSError>;
/**
* Creates a bot for an Amazon Chime Enterprise account.
*/
createBot(params: Chime.Types.CreateBotRequest, callback?: (err: AWSError, data: Chime.Types.CreateBotResponse) => void): Request<Chime.Types.CreateBotResponse, AWSError>;
/**
* Creates a bot for an Amazon Chime Enterprise account.
*/
createBot(callback?: (err: AWSError, data: Chime.Types.CreateBotResponse) => void): Request<Chime.Types.CreateBotResponse, AWSError>;
/**
* Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
createMeeting(params: Chime.Types.CreateMeetingRequest, callback?: (err: AWSError, data: Chime.Types.CreateMeetingResponse) => void): Request<Chime.Types.CreateMeetingResponse, AWSError>;
/**
* Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
createMeeting(callback?: (err: AWSError, data: Chime.Types.CreateMeetingResponse) => void): Request<Chime.Types.CreateMeetingResponse, AWSError>;
/**
* Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
*/
createPhoneNumberOrder(params: Chime.Types.CreatePhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request<Chime.Types.CreatePhoneNumberOrderResponse, AWSError>;
/**
* Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.
*/
createPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.CreatePhoneNumberOrderResponse) => void): Request<Chime.Types.CreatePhoneNumberOrderResponse, AWSError>;
/**
* Creates a chat room for the specified Amazon Chime account.
*/
createRoom(params: Chime.Types.CreateRoomRequest, callback?: (err: AWSError, data: Chime.Types.CreateRoomResponse) => void): Request<Chime.Types.CreateRoomResponse, AWSError>;
/**
* Creates a chat room for the specified Amazon Chime account.
*/
createRoom(callback?: (err: AWSError, data: Chime.Types.CreateRoomResponse) => void): Request<Chime.Types.CreateRoomResponse, AWSError>;
/**
* Adds a member to a chat room. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
*/
createRoomMembership(params: Chime.Types.CreateRoomMembershipRequest, callback?: (err: AWSError, data: Chime.Types.CreateRoomMembershipResponse) => void): Request<Chime.Types.CreateRoomMembershipResponse, AWSError>;
/**
* Adds a member to a chat room. A member can be either a user or a bot. The member role designates whether the member is a chat room administrator or a general chat room member.
*/
createRoomMembership(callback?: (err: AWSError, data: Chime.Types.CreateRoomMembershipResponse) => void): Request<Chime.Types.CreateRoomMembershipResponse, AWSError>;
/**
* Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
*/
createVoiceConnector(params: Chime.Types.CreateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request<Chime.Types.CreateVoiceConnectorResponse, AWSError>;
/**
* Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
*/
createVoiceConnector(callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorResponse) => void): Request<Chime.Types.CreateVoiceConnectorResponse, AWSError>;
/**
* Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
*/
createVoiceConnectorGroup(params: Chime.Types.CreateVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorGroupResponse) => void): Request<Chime.Types.CreateVoiceConnectorGroupResponse, AWSError>;
/**
* Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.
*/
createVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.CreateVoiceConnectorGroupResponse) => void): Request<Chime.Types.CreateVoiceConnectorGroupResponse, AWSError>;
/**
* Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
*/
deleteAccount(params: Chime.Types.DeleteAccountRequest, callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request<Chime.Types.DeleteAccountResponse, AWSError>;
/**
* Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so. For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended. Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support. After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
*/
deleteAccount(callback?: (err: AWSError, data: Chime.Types.DeleteAccountResponse) => void): Request<Chime.Types.DeleteAccountResponse, AWSError>;
/**
* Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
deleteAttendee(params: Chime.Types.DeleteAttendeeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an attendee from the specified Amazon Chime SDK meeting and deletes their JoinToken. Attendees are automatically deleted when a Amazon Chime SDK meeting is deleted. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
deleteAttendee(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the events configuration that allows a bot to receive outgoing events.
*/
deleteEventsConfiguration(params: Chime.Types.DeleteEventsConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the events configuration that allows a bot to receive outgoing events.
*/
deleteEventsConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
deleteMeeting(params: Chime.Types.DeleteMeetingRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime SDK meeting. When a meeting is deleted, its attendees are also deleted and clients can no longer join it. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
deleteMeeting(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
*/
deletePhoneNumber(params: Chime.Types.DeletePhoneNumberRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted. Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.
*/
deletePhoneNumber(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a chat room.
*/
deleteRoom(params: Chime.Types.DeleteRoomRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a chat room.
*/
deleteRoom(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a member from a chat room.
*/
deleteRoomMembership(params: Chime.Types.DeleteRoomMembershipRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a member from a chat room.
*/
deleteRoomMembership(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
*/
deleteVoiceConnector(params: Chime.Types.DeleteVoiceConnectorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.
*/
deleteVoiceConnector(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
*/
deleteVoiceConnectorGroup(params: Chime.Types.DeleteVoiceConnectorGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.
*/
deleteVoiceConnectorGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the origination settings for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorOrigination(params: Chime.Types.DeleteVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the origination settings for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorOrigination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorStreamingConfiguration(params: Chime.Types.DeleteVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the streaming configuration for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the termination settings for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorTermination(params: Chime.Types.DeleteVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the termination settings for the specified Amazon Chime Voice Connector.
*/
deleteVoiceConnectorTermination(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
*/
deleteVoiceConnectorTerminationCredentials(params: Chime.Types.DeleteVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified SIP credentials used by your equipment to authenticate during call termination.
*/
deleteVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociates the primary provisioned phone number from the specified Amazon Chime user.
*/
disassociatePhoneNumberFromUser(params: Chime.Types.DisassociatePhoneNumberFromUserRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request<Chime.Types.DisassociatePhoneNumberFromUserResponse, AWSError>;
/**
* Disassociates the primary provisioned phone number from the specified Amazon Chime user.
*/
disassociatePhoneNumberFromUser(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumberFromUserResponse) => void): Request<Chime.Types.DisassociatePhoneNumberFromUserResponse, AWSError>;
/**
* Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
*/
disassociatePhoneNumbersFromVoiceConnector(params: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse, AWSError>;
/**
* Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.
*/
disassociatePhoneNumbersFromVoiceConnector(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorResponse, AWSError>;
/**
* Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
*/
disassociatePhoneNumbersFromVoiceConnectorGroup(params: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse, AWSError>;
/**
* Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.
*/
disassociatePhoneNumbersFromVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse) => void): Request<Chime.Types.DisassociatePhoneNumbersFromVoiceConnectorGroupResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
*/
getAccount(params: Chime.Types.GetAccountRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request<Chime.Types.GetAccountResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.
*/
getAccount(callback?: (err: AWSError, data: Chime.Types.GetAccountResponse) => void): Request<Chime.Types.GetAccountResponse, AWSError>;
/**
* Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
*/
getAccountSettings(params: Chime.Types.GetAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request<Chime.Types.GetAccountSettingsResponse, AWSError>;
/**
* Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
*/
getAccountSettings(callback?: (err: AWSError, data: Chime.Types.GetAccountSettingsResponse) => void): Request<Chime.Types.GetAccountSettingsResponse, AWSError>;
/**
* Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
getAttendee(params: Chime.Types.GetAttendeeRequest, callback?: (err: AWSError, data: Chime.Types.GetAttendeeResponse) => void): Request<Chime.Types.GetAttendeeResponse, AWSError>;
/**
* Gets the Amazon Chime SDK attendee details for a specified meeting ID and attendee ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
getAttendee(callback?: (err: AWSError, data: Chime.Types.GetAttendeeResponse) => void): Request<Chime.Types.GetAttendeeResponse, AWSError>;
/**
* Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
*/
getBot(params: Chime.Types.GetBotRequest, callback?: (err: AWSError, data: Chime.Types.GetBotResponse) => void): Request<Chime.Types.GetBotResponse, AWSError>;
/**
* Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
*/
getBot(callback?: (err: AWSError, data: Chime.Types.GetBotResponse) => void): Request<Chime.Types.GetBotResponse, AWSError>;
/**
* Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
*/
getEventsConfiguration(params: Chime.Types.GetEventsConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetEventsConfigurationResponse) => void): Request<Chime.Types.GetEventsConfigurationResponse, AWSError>;
/**
* Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
*/
getEventsConfiguration(callback?: (err: AWSError, data: Chime.Types.GetEventsConfigurationResponse) => void): Request<Chime.Types.GetEventsConfigurationResponse, AWSError>;
/**
* Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
*/
getGlobalSettings(callback?: (err: AWSError, data: Chime.Types.GetGlobalSettingsResponse) => void): Request<Chime.Types.GetGlobalSettingsResponse, AWSError>;
/**
* Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
getMeeting(params: Chime.Types.GetMeetingRequest, callback?: (err: AWSError, data: Chime.Types.GetMeetingResponse) => void): Request<Chime.Types.GetMeetingResponse, AWSError>;
/**
* Gets the Amazon Chime SDK meeting details for the specified meeting ID. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
getMeeting(callback?: (err: AWSError, data: Chime.Types.GetMeetingResponse) => void): Request<Chime.Types.GetMeetingResponse, AWSError>;
/**
* Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
*/
getPhoneNumber(params: Chime.Types.GetPhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request<Chime.Types.GetPhoneNumberResponse, AWSError>;
/**
* Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.
*/
getPhoneNumber(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberResponse) => void): Request<Chime.Types.GetPhoneNumberResponse, AWSError>;
/**
* Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
*/
getPhoneNumberOrder(params: Chime.Types.GetPhoneNumberOrderRequest, callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request<Chime.Types.GetPhoneNumberOrderResponse, AWSError>;
/**
* Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.
*/
getPhoneNumberOrder(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberOrderResponse) => void): Request<Chime.Types.GetPhoneNumberOrderResponse, AWSError>;
/**
* Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.
*/
getPhoneNumberSettings(callback?: (err: AWSError, data: Chime.Types.GetPhoneNumberSettingsResponse) => void): Request<Chime.Types.GetPhoneNumberSettingsResponse, AWSError>;
/**
* Retrieves room details, such as name.
*/
getRoom(params: Chime.Types.GetRoomRequest, callback?: (err: AWSError, data: Chime.Types.GetRoomResponse) => void): Request<Chime.Types.GetRoomResponse, AWSError>;
/**
* Retrieves room details, such as name.
*/
getRoom(callback?: (err: AWSError, data: Chime.Types.GetRoomResponse) => void): Request<Chime.Types.GetRoomResponse, AWSError>;
/**
* Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
*/
getUser(params: Chime.Types.GetUserRequest, callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request<Chime.Types.GetUserResponse, AWSError>;
/**
* Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN. To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.
*/
getUser(callback?: (err: AWSError, data: Chime.Types.GetUserResponse) => void): Request<Chime.Types.GetUserResponse, AWSError>;
/**
* Retrieves settings for the specified user ID, such as any associated phone number settings.
*/
getUserSettings(params: Chime.Types.GetUserSettingsRequest, callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request<Chime.Types.GetUserSettingsResponse, AWSError>;
/**
* Retrieves settings for the specified user ID, such as any associated phone number settings.
*/
getUserSettings(callback?: (err: AWSError, data: Chime.Types.GetUserSettingsResponse) => void): Request<Chime.Types.GetUserSettingsResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
*/
getVoiceConnector(params: Chime.Types.GetVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request<Chime.Types.GetVoiceConnectorResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.
*/
getVoiceConnector(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorResponse) => void): Request<Chime.Types.GetVoiceConnectorResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
*/
getVoiceConnectorGroup(params: Chime.Types.GetVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
/**
* Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.
*/
getVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorGroupResponse) => void): Request<Chime.Types.GetVoiceConnectorGroupResponse, AWSError>;
/**
* Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
*/
getVoiceConnectorLoggingConfiguration(params: Chime.Types.GetVoiceConnectorLoggingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorLoggingConfigurationResponse, AWSError>;
/**
* Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
*/
getVoiceConnectorLoggingConfiguration(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorLoggingConfigurationResponse, AWSError>;
/**
* Retrieves origination setting details for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorOrigination(params: Chime.Types.GetVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request<Chime.Types.GetVoiceConnectorOriginationResponse, AWSError>;
/**
* Retrieves origination setting details for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorOriginationResponse) => void): Request<Chime.Types.GetVoiceConnectorOriginationResponse, AWSError>;
/**
* Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
*/
getVoiceConnectorStreamingConfiguration(params: Chime.Types.GetVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorStreamingConfigurationResponse, AWSError>;
/**
* Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis. It also shows the retention period, in hours, for the Amazon Kinesis data.
*/
getVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.GetVoiceConnectorStreamingConfigurationResponse, AWSError>;
/**
* Retrieves termination setting details for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorTermination(params: Chime.Types.GetVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationResponse, AWSError>;
/**
* Retrieves termination setting details for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationResponse, AWSError>;
/**
* Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorTerminationHealth(params: Chime.Types.GetVoiceConnectorTerminationHealthRequest, callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationHealthResponse, AWSError>;
/**
* Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.
*/
getVoiceConnectorTerminationHealth(callback?: (err: AWSError, data: Chime.Types.GetVoiceConnectorTerminationHealthResponse) => void): Request<Chime.Types.GetVoiceConnectorTerminationHealthResponse, AWSError>;
/**
* Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
*/
inviteUsers(params: Chime.Types.InviteUsersRequest, callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request<Chime.Types.InviteUsersResponse, AWSError>;
/**
* Sends email to a maximum of 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.
*/
inviteUsers(callback?: (err: AWSError, data: Chime.Types.InviteUsersResponse) => void): Request<Chime.Types.InviteUsersResponse, AWSError>;
/**
* Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
*/
listAccounts(params: Chime.Types.ListAccountsRequest, callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request<Chime.Types.ListAccountsResponse, AWSError>;
/**
* Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
*/
listAccounts(callback?: (err: AWSError, data: Chime.Types.ListAccountsResponse) => void): Request<Chime.Types.ListAccountsResponse, AWSError>;
/**
* Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
listAttendees(params: Chime.Types.ListAttendeesRequest, callback?: (err: AWSError, data: Chime.Types.ListAttendeesResponse) => void): Request<Chime.Types.ListAttendeesResponse, AWSError>;
/**
* Lists the attendees for the specified Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
listAttendees(callback?: (err: AWSError, data: Chime.Types.ListAttendeesResponse) => void): Request<Chime.Types.ListAttendeesResponse, AWSError>;
/**
* Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
*/
listBots(params: Chime.Types.ListBotsRequest, callback?: (err: AWSError, data: Chime.Types.ListBotsResponse) => void): Request<Chime.Types.ListBotsResponse, AWSError>;
/**
* Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
*/
listBots(callback?: (err: AWSError, data: Chime.Types.ListBotsResponse) => void): Request<Chime.Types.ListBotsResponse, AWSError>;
/**
* Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
listMeetings(params: Chime.Types.ListMeetingsRequest, callback?: (err: AWSError, data: Chime.Types.ListMeetingsResponse) => void): Request<Chime.Types.ListMeetingsResponse, AWSError>;
/**
* Lists up to 100 active Amazon Chime SDK meetings. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.
*/
listMeetings(callback?: (err: AWSError, data: Chime.Types.ListMeetingsResponse) => void): Request<Chime.Types.ListMeetingsResponse, AWSError>;
/**
* Lists the phone number orders for the administrator's Amazon Chime account.
*/
listPhoneNumberOrders(params: Chime.Types.ListPhoneNumberOrdersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request<Chime.Types.ListPhoneNumberOrdersResponse, AWSError>;
/**
* Lists the phone number orders for the administrator's Amazon Chime account.
*/
listPhoneNumberOrders(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumberOrdersResponse) => void): Request<Chime.Types.ListPhoneNumberOrdersResponse, AWSError>;
/**
* Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
*/
listPhoneNumbers(params: Chime.Types.ListPhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request<Chime.Types.ListPhoneNumbersResponse, AWSError>;
/**
* Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.
*/
listPhoneNumbers(callback?: (err: AWSError, data: Chime.Types.ListPhoneNumbersResponse) => void): Request<Chime.Types.ListPhoneNumbersResponse, AWSError>;
/**
* Lists the membership details for the specified room, such as member IDs, member email addresses, and member names.
*/
listRoomMemberships(params: Chime.Types.ListRoomMembershipsRequest, callback?: (err: AWSError, data: Chime.Types.ListRoomMembershipsResponse) => void): Request<Chime.Types.ListRoomMembershipsResponse, AWSError>;
/**
* Lists the membership details for the specified room, such as member IDs, member email addresses, and member names.
*/
listRoomMemberships(callback?: (err: AWSError, data: Chime.Types.ListRoomMembershipsResponse) => void): Request<Chime.Types.ListRoomMembershipsResponse, AWSError>;
/**
* Lists the room details for the specified Amazon Chime account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
*/
listRooms(params: Chime.Types.ListRoomsRequest, callback?: (err: AWSError, data: Chime.Types.ListRoomsResponse) => void): Request<Chime.Types.ListRoomsResponse, AWSError>;
/**
* Lists the room details for the specified Amazon Chime account. Optionally, filter the results by a member ID (user ID or bot ID) to see a list of rooms that the member belongs to.
*/
listRooms(callback?: (err: AWSError, data: Chime.Types.ListRoomsResponse) => void): Request<Chime.Types.ListRoomsResponse, AWSError>;
/**
* Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
*/
listUsers(params: Chime.Types.ListUsersRequest, callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request<Chime.Types.ListUsersResponse, AWSError>;
/**
* Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.
*/
listUsers(callback?: (err: AWSError, data: Chime.Types.ListUsersResponse) => void): Request<Chime.Types.ListUsersResponse, AWSError>;
/**
* Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
*/
listVoiceConnectorGroups(params: Chime.Types.ListVoiceConnectorGroupsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorGroupsResponse) => void): Request<Chime.Types.ListVoiceConnectorGroupsResponse, AWSError>;
/**
* Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.
*/
listVoiceConnectorGroups(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorGroupsResponse) => void): Request<Chime.Types.ListVoiceConnectorGroupsResponse, AWSError>;
/**
* Lists the SIP credentials for the specified Amazon Chime Voice Connector.
*/
listVoiceConnectorTerminationCredentials(params: Chime.Types.ListVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request<Chime.Types.ListVoiceConnectorTerminationCredentialsResponse, AWSError>;
/**
* Lists the SIP credentials for the specified Amazon Chime Voice Connector.
*/
listVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorTerminationCredentialsResponse) => void): Request<Chime.Types.ListVoiceConnectorTerminationCredentialsResponse, AWSError>;
/**
* Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
*/
listVoiceConnectors(params: Chime.Types.ListVoiceConnectorsRequest, callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request<Chime.Types.ListVoiceConnectorsResponse, AWSError>;
/**
* Lists the Amazon Chime Voice Connectors for the administrator's AWS account.
*/
listVoiceConnectors(callback?: (err: AWSError, data: Chime.Types.ListVoiceConnectorsResponse) => void): Request<Chime.Types.ListVoiceConnectorsResponse, AWSError>;
/**
* Logs out the specified user from all of the devices they are currently logged into.
*/
logoutUser(params: Chime.Types.LogoutUserRequest, callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request<Chime.Types.LogoutUserResponse, AWSError>;
/**
* Logs out the specified user from all of the devices they are currently logged into.
*/
logoutUser(callback?: (err: AWSError, data: Chime.Types.LogoutUserResponse) => void): Request<Chime.Types.LogoutUserResponse, AWSError>;
/**
* Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
*/
putEventsConfiguration(params: Chime.Types.PutEventsConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutEventsConfigurationResponse) => void): Request<Chime.Types.PutEventsConfigurationResponse, AWSError>;
/**
* Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
*/
putEventsConfiguration(callback?: (err: AWSError, data: Chime.Types.PutEventsConfigurationResponse) => void): Request<Chime.Types.PutEventsConfigurationResponse, AWSError>;
/**
* Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
*/
putVoiceConnectorLoggingConfiguration(params: Chime.Types.PutVoiceConnectorLoggingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorLoggingConfigurationResponse, AWSError>;
/**
* Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.
*/
putVoiceConnectorLoggingConfiguration(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorLoggingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorLoggingConfigurationResponse, AWSError>;
/**
* Adds origination settings for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorOrigination(params: Chime.Types.PutVoiceConnectorOriginationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request<Chime.Types.PutVoiceConnectorOriginationResponse, AWSError>;
/**
* Adds origination settings for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorOrigination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorOriginationResponse) => void): Request<Chime.Types.PutVoiceConnectorOriginationResponse, AWSError>;
/**
* Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
*/
putVoiceConnectorStreamingConfiguration(params: Chime.Types.PutVoiceConnectorStreamingConfigurationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorStreamingConfigurationResponse, AWSError>;
/**
* Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis. It also sets the retention period, in hours, for the Amazon Kinesis data.
*/
putVoiceConnectorStreamingConfiguration(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorStreamingConfigurationResponse) => void): Request<Chime.Types.PutVoiceConnectorStreamingConfigurationResponse, AWSError>;
/**
* Adds termination settings for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorTermination(params: Chime.Types.PutVoiceConnectorTerminationRequest, callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request<Chime.Types.PutVoiceConnectorTerminationResponse, AWSError>;
/**
* Adds termination settings for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorTermination(callback?: (err: AWSError, data: Chime.Types.PutVoiceConnectorTerminationResponse) => void): Request<Chime.Types.PutVoiceConnectorTerminationResponse, AWSError>;
/**
* Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorTerminationCredentials(params: Chime.Types.PutVoiceConnectorTerminationCredentialsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
*/
putVoiceConnectorTerminationCredentials(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Regenerates the security token for a bot.
*/
regenerateSecurityToken(params: Chime.Types.RegenerateSecurityTokenRequest, callback?: (err: AWSError, data: Chime.Types.RegenerateSecurityTokenResponse) => void): Request<Chime.Types.RegenerateSecurityTokenResponse, AWSError>;
/**
* Regenerates the security token for a bot.
*/
regenerateSecurityToken(callback?: (err: AWSError, data: Chime.Types.RegenerateSecurityTokenResponse) => void): Request<Chime.Types.RegenerateSecurityTokenResponse, AWSError>;
/**
* Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
*/
resetPersonalPIN(params: Chime.Types.ResetPersonalPINRequest, callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request<Chime.Types.ResetPersonalPINResponse, AWSError>;
/**
* Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.
*/
resetPersonalPIN(callback?: (err: AWSError, data: Chime.Types.ResetPersonalPINResponse) => void): Request<Chime.Types.ResetPersonalPINResponse, AWSError>;
/**
* Moves a phone number from the Deletion queue back into the phone number Inventory.
*/
restorePhoneNumber(params: Chime.Types.RestorePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request<Chime.Types.RestorePhoneNumberResponse, AWSError>;
/**
* Moves a phone number from the Deletion queue back into the phone number Inventory.
*/
restorePhoneNumber(callback?: (err: AWSError, data: Chime.Types.RestorePhoneNumberResponse) => void): Request<Chime.Types.RestorePhoneNumberResponse, AWSError>;
/**
* Searches phone numbers that can be ordered.
*/
searchAvailablePhoneNumbers(params: Chime.Types.SearchAvailablePhoneNumbersRequest, callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request<Chime.Types.SearchAvailablePhoneNumbersResponse, AWSError>;
/**
* Searches phone numbers that can be ordered.
*/
searchAvailablePhoneNumbers(callback?: (err: AWSError, data: Chime.Types.SearchAvailablePhoneNumbersResponse) => void): Request<Chime.Types.SearchAvailablePhoneNumbersResponse, AWSError>;
/**
* Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
*/
updateAccount(params: Chime.Types.UpdateAccountRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request<Chime.Types.UpdateAccountResponse, AWSError>;
/**
* Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.
*/
updateAccount(callback?: (err: AWSError, data: Chime.Types.UpdateAccountResponse) => void): Request<Chime.Types.UpdateAccountResponse, AWSError>;
/**
* Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
*/
updateAccountSettings(params: Chime.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request<Chime.Types.UpdateAccountSettingsResponse, AWSError>;
/**
* Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
*/
updateAccountSettings(callback?: (err: AWSError, data: Chime.Types.UpdateAccountSettingsResponse) => void): Request<Chime.Types.UpdateAccountSettingsResponse, AWSError>;
/**
* Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
*/
updateBot(params: Chime.Types.UpdateBotRequest, callback?: (err: AWSError, data: Chime.Types.UpdateBotResponse) => void): Request<Chime.Types.UpdateBotResponse, AWSError>;
/**
* Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
*/
updateBot(callback?: (err: AWSError, data: Chime.Types.UpdateBotResponse) => void): Request<Chime.Types.UpdateBotResponse, AWSError>;
/**
* Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
*/
updateGlobalSettings(params: Chime.Types.UpdateGlobalSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.
*/
updateGlobalSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
*/
updatePhoneNumber(params: Chime.Types.UpdatePhoneNumberRequest, callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request<Chime.Types.UpdatePhoneNumberResponse, AWSError>;
/**
* Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you must use the Amazon Chime Voice Connector product type. Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.
*/
updatePhoneNumber(callback?: (err: AWSError, data: Chime.Types.UpdatePhoneNumberResponse) => void): Request<Chime.Types.UpdatePhoneNumberResponse, AWSError>;
/**
* Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
*/
updatePhoneNumberSettings(params: Chime.Types.UpdatePhoneNumberSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to update.
*/
updatePhoneNumberSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates room details, such as the room name.
*/
updateRoom(params: Chime.Types.UpdateRoomRequest, callback?: (err: AWSError, data: Chime.Types.UpdateRoomResponse) => void): Request<Chime.Types.UpdateRoomResponse, AWSError>;
/**
* Updates room details, such as the room name.
*/
updateRoom(callback?: (err: AWSError, data: Chime.Types.UpdateRoomResponse) => void): Request<Chime.Types.UpdateRoomResponse, AWSError>;
/**
* Updates room membership details, such as member role. The member role designates whether the member is a chat room administrator or a general chat room member. Member role can only be updated for user IDs.
*/
updateRoomMembership(params: Chime.Types.UpdateRoomMembershipRequest, callback?: (err: AWSError, data: Chime.Types.UpdateRoomMembershipResponse) => void): Request<Chime.Types.UpdateRoomMembershipResponse, AWSError>;
/**
* Updates room membership details, such as member role. The member role designates whether the member is a chat room administrator or a general chat room member. Member role can only be updated for user IDs.
*/
updateRoomMembership(callback?: (err: AWSError, data: Chime.Types.UpdateRoomMembershipResponse) => void): Request<Chime.Types.UpdateRoomMembershipResponse, AWSError>;
/**
* Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
*/
updateUser(params: Chime.Types.UpdateUserRequest, callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request<Chime.Types.UpdateUserResponse, AWSError>;
/**
* Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.
*/
updateUser(callback?: (err: AWSError, data: Chime.Types.UpdateUserResponse) => void): Request<Chime.Types.UpdateUserResponse, AWSError>;
/**
* Updates the settings for the specified user, such as phone number settings.
*/
updateUserSettings(params: Chime.Types.UpdateUserSettingsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates the settings for the specified user, such as phone number settings.
*/
updateUserSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates details for the specified Amazon Chime Voice Connector.
*/
updateVoiceConnector(params: Chime.Types.UpdateVoiceConnectorRequest, callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request<Chime.Types.UpdateVoiceConnectorResponse, AWSError>;
/**
* Updates details for the specified Amazon Chime Voice Connector.
*/
updateVoiceConnector(callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorResponse) => void): Request<Chime.Types.UpdateVoiceConnectorResponse, AWSError>;
/**
* Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
*/
updateVoiceConnectorGroup(params: Chime.Types.UpdateVoiceConnectorGroupRequest, callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorGroupResponse) => void): Request<Chime.Types.UpdateVoiceConnectorGroupResponse, AWSError>;
/**
* Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.
*/
updateVoiceConnectorGroup(callback?: (err: AWSError, data: Chime.Types.UpdateVoiceConnectorGroupResponse) => void): Request<Chime.Types.UpdateVoiceConnectorGroupResponse, AWSError>;
}
declare namespace Chime {
export interface Account {
/**
* The AWS account ID.
*/
AwsAccountId: String;
/**
* The Amazon Chime account ID.
*/
AccountId: String;
/**
* The Amazon Chime account name.
*/
Name: String;
/**
* The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
*/
AccountType?: AccountType;
/**
* The Amazon Chime account creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The default license for the Amazon Chime account.
*/
DefaultLicense?: License;
/**
* Supported licenses for the Amazon Chime account.
*/
SupportedLicenses?: LicenseList;
}
export type AccountList = Account[];
export type AccountName = string;
export interface AccountSettings {
/**
* Setting that stops or starts remote control of shared screens during meetings.
*/
DisableRemoteControl?: Boolean;
/**
* Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.
*/
EnableDialOut?: Boolean;
}
export type AccountType = "Team"|"EnterpriseDirectory"|"EnterpriseLWA"|"EnterpriseOIDC"|string;
export type Arn = string;
export interface AssociatePhoneNumberWithUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: String;
/**
* The user ID.
*/
UserId: String;
/**
* The phone number, in E.164 format.
*/
E164PhoneNumber: E164PhoneNumber;
}
export interface AssociatePhoneNumberWithUserResponse {
}
export interface AssociatePhoneNumbersWithVoiceConnectorGroupRequest {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId: NonEmptyString;
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers?: E164PhoneNumberList;
/**
* If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
*/
ForceAssociate?: NullableBoolean;
}
export interface AssociatePhoneNumbersWithVoiceConnectorGroupResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export interface AssociatePhoneNumbersWithVoiceConnectorRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers?: E164PhoneNumberList;
/**
* If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.
*/
ForceAssociate?: NullableBoolean;
}
export interface AssociatePhoneNumbersWithVoiceConnectorResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export interface Attendee {
/**
* The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
*/
ExternalUserId?: ExternalUserIdType;
/**
* The Amazon Chime SDK attendee ID.
*/
AttendeeId?: GuidString;
/**
* The join token used by the Amazon Chime SDK attendee.
*/
JoinToken?: JoinTokenString;
}
export type AttendeeList = Attendee[];
export type BatchCreateAttendeeErrorList = CreateAttendeeError[];
export interface BatchCreateAttendeeRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
/**
* The request containing the attendees to create.
*/
Attendees: CreateAttendeeRequestItemList;
}
export interface BatchCreateAttendeeResponse {
/**
* The attendee information, including attendees IDs and join tokens.
*/
Attendees?: AttendeeList;
/**
* If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.
*/
Errors?: BatchCreateAttendeeErrorList;
}
export interface BatchCreateRoomMembershipRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The list of membership items.
*/
MembershipItemList: MembershipItemList;
}
export interface BatchCreateRoomMembershipResponse {
/**
* If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along with error codes and error messages.
*/
Errors?: MemberErrorList;
}
export interface BatchDeletePhoneNumberRequest {
/**
* List of phone number IDs.
*/
PhoneNumberIds: NonEmptyStringList;
}
export interface BatchDeletePhoneNumberResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export interface BatchSuspendUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The request containing the user IDs to suspend.
*/
UserIdList: UserIdList;
}
export interface BatchSuspendUserResponse {
/**
* If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
*/
UserErrors?: UserErrorList;
}
export interface BatchUnsuspendUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The request containing the user IDs to unsuspend.
*/
UserIdList: UserIdList;
}
export interface BatchUnsuspendUserResponse {
/**
* If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
*/
UserErrors?: UserErrorList;
}
export interface BatchUpdatePhoneNumberRequest {
/**
* The request containing the phone number IDs and product types or calling names to update.
*/
UpdatePhoneNumberRequestItems: UpdatePhoneNumberRequestItemList;
}
export interface BatchUpdatePhoneNumberResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export interface BatchUpdateUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The request containing the user IDs and details to update.
*/
UpdateUserRequestItems: UpdateUserRequestItemList;
}
export interface BatchUpdateUserResponse {
/**
* If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.
*/
UserErrors?: UserErrorList;
}
export type Boolean = boolean;
export interface Bot {
/**
* The bot ID.
*/
BotId?: String;
/**
* The unique ID for the bot user.
*/
UserId?: String;
/**
* The bot display name.
*/
DisplayName?: SensitiveString;
/**
* The bot type.
*/
BotType?: BotType;
/**
* When true, the bot is stopped from running in your account.
*/
Disabled?: NullableBoolean;
/**
* The bot creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The updated bot timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
/**
* The bot email address.
*/
BotEmail?: SensitiveString;
/**
* The security token used to authenticate Amazon Chime with the outgoing event endpoint.
*/
SecurityToken?: SensitiveString;
}
export type BotList = Bot[];
export type BotType = "ChatBot"|string;
export interface BusinessCallingSettings {
/**
* The Amazon S3 bucket designated for call detail record storage.
*/
CdrBucket?: String;
}
export type CallingName = string;
export type CallingNameStatus = "Unassigned"|"UpdateInProgress"|"UpdateSucceeded"|"UpdateFailed"|string;
export type CallingRegion = string;
export type CallingRegionList = CallingRegion[];
export type ClientRequestToken = string;
export type CpsLimit = number;
export interface CreateAccountRequest {
/**
* The name of the Amazon Chime account.
*/
Name: AccountName;
}
export interface CreateAccountResponse {
/**
* The Amazon Chime account details.
*/
Account?: Account;
}
export interface CreateAttendeeError {
/**
* The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
*/
ExternalUserId?: ExternalUserIdType;
/**
* The error code.
*/
ErrorCode?: String;
/**
* The error message.
*/
ErrorMessage?: String;
}
export interface CreateAttendeeRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
/**
* The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
*/
ExternalUserId: ExternalUserIdType;
}
export interface CreateAttendeeRequestItem {
/**
* The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
*/
ExternalUserId: ExternalUserIdType;
}
export type CreateAttendeeRequestItemList = CreateAttendeeRequestItem[];
export interface CreateAttendeeResponse {
/**
* The attendee information, including attendee ID and join token.
*/
Attendee?: Attendee;
}
export interface CreateBotRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot display name.
*/
DisplayName: SensitiveString;
/**
* The domain of the Amazon Chime Enterprise account.
*/
Domain?: NonEmptyString;
}
export interface CreateBotResponse {
/**
* The bot details.
*/
Bot?: Bot;
}
export interface CreateMeetingRequest {
/**
* The unique identifier for the client request. Use a different token for different meetings.
*/
ClientRequestToken: ClientRequestToken;
/**
* Reserved.
*/
MeetingHostId?: ExternalUserIdType;
/**
* The Region in which to create the meeting. Available values: us-east-1, us-west-2.
*/
MediaRegion?: String;
/**
* The configuration for resource targets to receive notifications when meeting and attendee events occur.
*/
NotificationsConfiguration?: MeetingNotificationConfiguration;
}
export interface CreateMeetingResponse {
/**
* The meeting information, including the meeting ID and MediaPlacement.
*/
Meeting?: Meeting;
}
export interface CreatePhoneNumberOrderRequest {
/**
* The phone number product type.
*/
ProductType: PhoneNumberProductType;
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers: E164PhoneNumberList;
}
export interface CreatePhoneNumberOrderResponse {
/**
* The phone number order details.
*/
PhoneNumberOrder?: PhoneNumberOrder;
}
export interface CreateRoomMembershipRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The Amazon Chime member ID (user ID or bot ID).
*/
MemberId: NonEmptyString;
/**
* The role of the member.
*/
Role?: RoomMembershipRole;
}
export interface CreateRoomMembershipResponse {
/**
* The room membership details.
*/
RoomMembership?: RoomMembership;
}
export interface CreateRoomRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room name.
*/
Name: SensitiveString;
/**
* The idempotency token for the request.
*/
ClientRequestToken?: ClientRequestToken;
}
export interface CreateRoomResponse {
/**
* The room details.
*/
Room?: Room;
}
export interface CreateVoiceConnectorGroupRequest {
/**
* The name of the Amazon Chime Voice Connector group.
*/
Name: VoiceConnectorGroupName;
/**
* The Amazon Chime Voice Connectors to route inbound calls to.
*/
VoiceConnectorItems?: VoiceConnectorItemList;
}
export interface CreateVoiceConnectorGroupResponse {
/**
* The Amazon Chime Voice Connector group details.
*/
VoiceConnectorGroup?: VoiceConnectorGroup;
}
export interface CreateVoiceConnectorRequest {
/**
* The name of the Amazon Chime Voice Connector.
*/
Name: VoiceConnectorName;
/**
* The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.
*/
AwsRegion?: VoiceConnectorAwsRegion;
/**
* When enabled, requires encryption for the Amazon Chime Voice Connector.
*/
RequireEncryption: Boolean;
}
export interface CreateVoiceConnectorResponse {
/**
* The Amazon Chime Voice Connector details.
*/
VoiceConnector?: VoiceConnector;
}
export interface Credential {
/**
* The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
*/
Username?: SensitiveString;
/**
* The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
*/
Password?: SensitiveString;
}
export type CredentialList = Credential[];
export type DataRetentionInHours = number;
export interface DeleteAccountRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
}
export interface DeleteAccountResponse {
}
export interface DeleteAttendeeRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
/**
* The Amazon Chime SDK attendee ID.
*/
AttendeeId: GuidString;
}
export interface DeleteEventsConfigurationRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
}
export interface DeleteMeetingRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
}
export interface DeletePhoneNumberRequest {
/**
* The phone number ID.
*/
PhoneNumberId: String;
}
export interface DeleteRoomMembershipRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The member ID (user ID or bot ID).
*/
MemberId: NonEmptyString;
}
export interface DeleteRoomRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The chat room ID.
*/
RoomId: NonEmptyString;
}
export interface DeleteVoiceConnectorGroupRequest {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId: NonEmptyString;
}
export interface DeleteVoiceConnectorOriginationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface DeleteVoiceConnectorRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface DeleteVoiceConnectorStreamingConfigurationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface DeleteVoiceConnectorTerminationCredentialsRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
*/
Usernames?: SensitiveStringList;
}
export interface DeleteVoiceConnectorTerminationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface DisassociatePhoneNumberFromUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: String;
/**
* The user ID.
*/
UserId: String;
}
export interface DisassociatePhoneNumberFromUserResponse {
}
export interface DisassociatePhoneNumbersFromVoiceConnectorGroupRequest {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId: NonEmptyString;
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers?: E164PhoneNumberList;
}
export interface DisassociatePhoneNumbersFromVoiceConnectorGroupResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export interface DisassociatePhoneNumbersFromVoiceConnectorRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers?: E164PhoneNumberList;
}
export interface DisassociatePhoneNumbersFromVoiceConnectorResponse {
/**
* If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.
*/
PhoneNumberErrors?: PhoneNumberErrorList;
}
export type E164PhoneNumber = string;
export type E164PhoneNumberList = E164PhoneNumber[];
export type EmailAddress = string;
export type EmailStatus = "NotSent"|"Sent"|"Failed"|string;
export type ErrorCode = "BadRequest"|"Conflict"|"Forbidden"|"NotFound"|"PreconditionFailed"|"ResourceLimitExceeded"|"ServiceFailure"|"AccessDenied"|"ServiceUnavailable"|"Throttled"|"Unauthorized"|"Unprocessable"|"VoiceConnectorGroupAssociationsExist"|"PhoneNumberAssociationsExist"|string;
export interface EventsConfiguration {
/**
* The bot ID.
*/
BotId?: String;
/**
* HTTPS endpoint that allows a bot to receive outgoing events.
*/
OutboundEventsHTTPSEndpoint?: SensitiveString;
/**
* Lambda function ARN that allows a bot to receive outgoing events.
*/
LambdaFunctionArn?: SensitiveString;
}
export type ExternalUserIdType = string;
export interface GetAccountRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
}
export interface GetAccountResponse {
/**
* The Amazon Chime account details.
*/
Account?: Account;
}
export interface GetAccountSettingsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
}
export interface GetAccountSettingsResponse {
/**
* The Amazon Chime account settings.
*/
AccountSettings?: AccountSettings;
}
export interface GetAttendeeRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
/**
* The Amazon Chime SDK attendee ID.
*/
AttendeeId: GuidString;
}
export interface GetAttendeeResponse {
/**
* The Amazon Chime SDK attendee information.
*/
Attendee?: Attendee;
}
export interface GetBotRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
}
export interface GetBotResponse {
/**
* The chat bot details.
*/
Bot?: Bot;
}
export interface GetEventsConfigurationRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
}
export interface GetEventsConfigurationResponse {
/**
* The events configuration details.
*/
EventsConfiguration?: EventsConfiguration;
}
export interface GetGlobalSettingsResponse {
/**
* The Amazon Chime Business Calling settings.
*/
BusinessCalling?: BusinessCallingSettings;
/**
* The Amazon Chime Voice Connector settings.
*/
VoiceConnector?: VoiceConnectorSettings;
}
export interface GetMeetingRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
}
export interface GetMeetingResponse {
/**
* The Amazon Chime SDK meeting information.
*/
Meeting?: Meeting;
}
export interface GetPhoneNumberOrderRequest {
/**
* The ID for the phone number order.
*/
PhoneNumberOrderId: GuidString;
}
export interface GetPhoneNumberOrderResponse {
/**
* The phone number order details.
*/
PhoneNumberOrder?: PhoneNumberOrder;
}
export interface GetPhoneNumberRequest {
/**
* The phone number ID.
*/
PhoneNumberId: String;
}
export interface GetPhoneNumberResponse {
/**
* The phone number details.
*/
PhoneNumber?: PhoneNumber;
}
export interface GetPhoneNumberSettingsResponse {
/**
* The default outbound calling name for the account.
*/
CallingName?: CallingName;
/**
* The updated outbound calling name timestamp, in ISO 8601 format.
*/
CallingNameUpdatedTimestamp?: Iso8601Timestamp;
}
export interface GetRoomRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
}
export interface GetRoomResponse {
/**
* The room details.
*/
Room?: Room;
}
export interface GetUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The user ID.
*/
UserId: NonEmptyString;
}
export interface GetUserResponse {
/**
* The user details.
*/
User?: User;
}
export interface GetUserSettingsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: String;
/**
* The user ID.
*/
UserId: String;
}
export interface GetUserSettingsResponse {
/**
* The user settings.
*/
UserSettings?: UserSettings;
}
export interface GetVoiceConnectorGroupRequest {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId: NonEmptyString;
}
export interface GetVoiceConnectorGroupResponse {
/**
* The Amazon Chime Voice Connector group details.
*/
VoiceConnectorGroup?: VoiceConnectorGroup;
}
export interface GetVoiceConnectorLoggingConfigurationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorLoggingConfigurationResponse {
/**
* The logging configuration details.
*/
LoggingConfiguration?: LoggingConfiguration;
}
export interface GetVoiceConnectorOriginationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorOriginationResponse {
/**
* The origination setting details.
*/
Origination?: Origination;
}
export interface GetVoiceConnectorRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorResponse {
/**
* The Amazon Chime Voice Connector details.
*/
VoiceConnector?: VoiceConnector;
}
export interface GetVoiceConnectorStreamingConfigurationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorStreamingConfigurationResponse {
/**
* The streaming configuration details.
*/
StreamingConfiguration?: StreamingConfiguration;
}
export interface GetVoiceConnectorTerminationHealthRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorTerminationHealthResponse {
/**
* The termination health details.
*/
TerminationHealth?: TerminationHealth;
}
export interface GetVoiceConnectorTerminationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface GetVoiceConnectorTerminationResponse {
/**
* The termination setting details.
*/
Termination?: Termination;
}
export type GuidString = string;
export interface Invite {
/**
* The invite ID.
*/
InviteId?: String;
/**
* The status of the invite.
*/
Status?: InviteStatus;
/**
* The email address to which the invite is sent.
*/
EmailAddress?: EmailAddress;
/**
* The status of the invite email.
*/
EmailStatus?: EmailStatus;
}
export type InviteList = Invite[];
export type InviteStatus = "Pending"|"Accepted"|"Failed"|string;
export interface InviteUsersRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The user email addresses to which to send the email invitation.
*/
UserEmailList: UserEmailList;
}
export interface InviteUsersResponse {
/**
* The email invitation details.
*/
Invites?: InviteList;
}
export type Iso8601Timestamp = Date;
export type JoinTokenString = string;
export type License = "Basic"|"Plus"|"Pro"|"ProTrial"|string;
export type LicenseList = License[];
export interface ListAccountsRequest {
/**
* Amazon Chime account name prefix with which to filter results.
*/
Name?: AccountName;
/**
* User email address with which to filter results.
*/
UserEmail?: EmailAddress;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call. Defaults to 100.
*/
MaxResults?: ProfileServiceMaxResults;
}
export interface ListAccountsResponse {
/**
* List of Amazon Chime accounts and account details.
*/
Accounts?: AccountList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListAttendeesRequest {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId: GuidString;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
}
export interface ListAttendeesResponse {
/**
* The Amazon Chime SDK attendee information.
*/
Attendees?: AttendeeList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListBotsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The maximum number of results to return in a single call. The default is 10.
*/
MaxResults?: ResultMax;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListBotsResponse {
/**
* List of bots and bot details.
*/
Bots?: BotList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListMeetingsRequest {
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
}
export interface ListMeetingsResponse {
/**
* The Amazon Chime SDK meeting information.
*/
Meetings?: MeetingList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListPhoneNumberOrdersRequest {
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
}
export interface ListPhoneNumberOrdersResponse {
/**
* The phone number order details.
*/
PhoneNumberOrders?: PhoneNumberOrderList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListPhoneNumbersRequest {
/**
* The phone number status.
*/
Status?: PhoneNumberStatus;
/**
* The phone number product type.
*/
ProductType?: PhoneNumberProductType;
/**
* The filter to use to limit the number of results.
*/
FilterName?: PhoneNumberAssociationName;
/**
* The value to use for the filter.
*/
FilterValue?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListPhoneNumbersResponse {
/**
* The phone number details.
*/
PhoneNumbers?: PhoneNumberList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListRoomMembershipsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListRoomMembershipsResponse {
/**
* The room membership details.
*/
RoomMemberships?: RoomMembershipList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListRoomsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The member ID (user ID or bot ID).
*/
MemberId?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListRoomsResponse {
/**
* The room details.
*/
Rooms?: RoomList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListUsersRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* Optional. The user email address used to filter results. Maximum 1.
*/
UserEmail?: EmailAddress;
/**
* The maximum number of results to return in a single call. Defaults to 100.
*/
MaxResults?: ProfileServiceMaxResults;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListUsersResponse {
/**
* List of users and user details.
*/
Users?: UserList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListVoiceConnectorGroupsRequest {
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
}
export interface ListVoiceConnectorGroupsResponse {
/**
* The details of the Amazon Chime Voice Connector groups.
*/
VoiceConnectorGroups?: VoiceConnectorGroupList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface ListVoiceConnectorTerminationCredentialsRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
}
export interface ListVoiceConnectorTerminationCredentialsResponse {
/**
* A list of user names.
*/
Usernames?: SensitiveStringList;
}
export interface ListVoiceConnectorsRequest {
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: ResultMax;
}
export interface ListVoiceConnectorsResponse {
/**
* The details of the Amazon Chime Voice Connectors.
*/
VoiceConnectors?: VoiceConnectorList;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface LoggingConfiguration {
/**
* When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
*/
EnableSIPLogs?: Boolean;
}
export interface LogoutUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The user ID.
*/
UserId: NonEmptyString;
}
export interface LogoutUserResponse {
}
export interface MediaPlacement {
/**
* The audio host URL.
*/
AudioHostUrl?: UriType;
/**
* The screen data URL.
*/
ScreenDataUrl?: UriType;
/**
* The screen sharing URL.
*/
ScreenSharingUrl?: UriType;
/**
* The screen viewing URL.
*/
ScreenViewingUrl?: UriType;
/**
* The signaling URL.
*/
SignalingUrl?: UriType;
/**
* The turn control URL.
*/
TurnControlUrl?: UriType;
}
export interface Meeting {
/**
* The Amazon Chime SDK meeting ID.
*/
MeetingId?: GuidString;
/**
* The media placement for the meeting.
*/
MediaPlacement?: MediaPlacement;
/**
* The Region in which to create the meeting. Available values: us-east-1, us-west-2.
*/
MediaRegion?: String;
}
export type MeetingList = Meeting[];
export interface MeetingNotificationConfiguration {
/**
* The SNS topic ARN.
*/
SnsTopicArn?: Arn;
/**
* The SQS queue ARN.
*/
SqsQueueArn?: Arn;
}
export interface Member {
/**
* The member ID (user ID or bot ID).
*/
MemberId?: NonEmptyString;
/**
* The member type.
*/
MemberType?: MemberType;
/**
* The member email address.
*/
Email?: SensitiveString;
/**
* The member name.
*/
FullName?: SensitiveString;
/**
* The Amazon Chime account ID.
*/
AccountId?: NonEmptyString;
}
export interface MemberError {
/**
* The member ID.
*/
MemberId?: NonEmptyString;
/**
* The error code.
*/
ErrorCode?: ErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
}
export type MemberErrorList = MemberError[];
export type MemberType = "User"|"Bot"|"Webhook"|string;
export interface MembershipItem {
/**
* The member ID.
*/
MemberId?: NonEmptyString;
/**
* The member role.
*/
Role?: RoomMembershipRole;
}
export type MembershipItemList = MembershipItem[];
export type NonEmptyString = string;
export type NonEmptyStringList = String[];
export type NullableBoolean = boolean;
export interface OrderedPhoneNumber {
/**
* The phone number, in E.164 format.
*/
E164PhoneNumber?: E164PhoneNumber;
/**
* The phone number status.
*/
Status?: OrderedPhoneNumberStatus;
}
export type OrderedPhoneNumberList = OrderedPhoneNumber[];
export type OrderedPhoneNumberStatus = "Processing"|"Acquired"|"Failed"|string;
export interface Origination {
/**
* The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.
*/
Routes?: OriginationRouteList;
/**
* When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
*/
Disabled?: Boolean;
}
export interface OriginationRoute {
/**
* The FQDN or IP address to contact for origination traffic.
*/
Host?: String;
/**
* The designated origination route port. Defaults to 5060.
*/
Port?: Port;
/**
* The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
*/
Protocol?: OriginationRouteProtocol;
/**
* The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
*/
Priority?: OriginationRoutePriority;
/**
* The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.
*/
Weight?: OriginationRouteWeight;
}
export type OriginationRouteList = OriginationRoute[];
export type OriginationRoutePriority = number;
export type OriginationRouteProtocol = "TCP"|"UDP"|string;
export type OriginationRouteWeight = number;
export interface PhoneNumber {
/**
* The phone number ID.
*/
PhoneNumberId?: String;
/**
* The phone number, in E.164 format.
*/
E164PhoneNumber?: E164PhoneNumber;
/**
* The phone number type.
*/
Type?: PhoneNumberType;
/**
* The phone number product type.
*/
ProductType?: PhoneNumberProductType;
/**
* The phone number status.
*/
Status?: PhoneNumberStatus;
/**
* The phone number capabilities.
*/
Capabilities?: PhoneNumberCapabilities;
/**
* The phone number associations.
*/
Associations?: PhoneNumberAssociationList;
/**
* The outbound calling name associated with the phone number.
*/
CallingName?: CallingName;
/**
* The outbound calling name status.
*/
CallingNameStatus?: CallingNameStatus;
/**
* The phone number creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The updated phone number timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
/**
* The deleted phone number timestamp, in ISO 8601 format.
*/
DeletionTimestamp?: Iso8601Timestamp;
}
export interface PhoneNumberAssociation {
/**
* Contains the ID for the entity specified in Name.
*/
Value?: String;
/**
* Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
*/
Name?: PhoneNumberAssociationName;
/**
* The timestamp of the phone number association, in ISO 8601 format.
*/
AssociatedTimestamp?: Iso8601Timestamp;
}
export type PhoneNumberAssociationList = PhoneNumberAssociation[];
export type PhoneNumberAssociationName = "AccountId"|"UserId"|"VoiceConnectorId"|"VoiceConnectorGroupId"|string;
export interface PhoneNumberCapabilities {
/**
* Allows or denies inbound calling for the specified phone number.
*/
InboundCall?: NullableBoolean;
/**
* Allows or denies outbound calling for the specified phone number.
*/
OutboundCall?: NullableBoolean;
/**
* Allows or denies inbound SMS messaging for the specified phone number.
*/
InboundSMS?: NullableBoolean;
/**
* Allows or denies outbound SMS messaging for the specified phone number.
*/
OutboundSMS?: NullableBoolean;
/**
* Allows or denies inbound MMS messaging for the specified phone number.
*/
InboundMMS?: NullableBoolean;
/**
* Allows or denies outbound MMS messaging for the specified phone number.
*/
OutboundMMS?: NullableBoolean;
}
export interface PhoneNumberError {
/**
* The phone number ID for which the action failed.
*/
PhoneNumberId?: NonEmptyString;
/**
* The error code.
*/
ErrorCode?: ErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
}
export type PhoneNumberErrorList = PhoneNumberError[];
export type PhoneNumberList = PhoneNumber[];
export type PhoneNumberMaxResults = number;
export interface PhoneNumberOrder {
/**
* The phone number order ID.
*/
PhoneNumberOrderId?: GuidString;
/**
* The phone number order product type.
*/
ProductType?: PhoneNumberProductType;
/**
* The status of the phone number order.
*/
Status?: PhoneNumberOrderStatus;
/**
* The ordered phone number details, such as the phone number in E.164 format and the phone number status.
*/
OrderedPhoneNumbers?: OrderedPhoneNumberList;
/**
* The phone number order creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The updated phone number order timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
}
export type PhoneNumberOrderList = PhoneNumberOrder[];
export type PhoneNumberOrderStatus = "Processing"|"Successful"|"Failed"|"Partial"|string;
export type PhoneNumberProductType = "BusinessCalling"|"VoiceConnector"|string;
export type PhoneNumberStatus = "AcquireInProgress"|"AcquireFailed"|"Unassigned"|"Assigned"|"ReleaseInProgress"|"DeleteInProgress"|"ReleaseFailed"|"DeleteFailed"|string;
export type PhoneNumberType = "Local"|"TollFree"|string;
export type Port = number;
export type ProfileServiceMaxResults = number;
export interface PutEventsConfigurationRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
/**
* HTTPS endpoint that allows the bot to receive outgoing events.
*/
OutboundEventsHTTPSEndpoint?: SensitiveString;
/**
* Lambda function ARN that allows the bot to receive outgoing events.
*/
LambdaFunctionArn?: SensitiveString;
}
export interface PutEventsConfigurationResponse {
EventsConfiguration?: EventsConfiguration;
}
export interface PutVoiceConnectorLoggingConfigurationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The logging configuration details to add.
*/
LoggingConfiguration: LoggingConfiguration;
}
export interface PutVoiceConnectorLoggingConfigurationResponse {
/**
* The updated logging configuration details.
*/
LoggingConfiguration?: LoggingConfiguration;
}
export interface PutVoiceConnectorOriginationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The origination setting details to add.
*/
Origination: Origination;
}
export interface PutVoiceConnectorOriginationResponse {
/**
* The updated origination setting details.
*/
Origination?: Origination;
}
export interface PutVoiceConnectorStreamingConfigurationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The streaming configuration details to add.
*/
StreamingConfiguration: StreamingConfiguration;
}
export interface PutVoiceConnectorStreamingConfigurationResponse {
/**
* The updated streaming configuration details.
*/
StreamingConfiguration?: StreamingConfiguration;
}
export interface PutVoiceConnectorTerminationCredentialsRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The termination SIP credentials.
*/
Credentials?: CredentialList;
}
export interface PutVoiceConnectorTerminationRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The termination setting details to add.
*/
Termination: Termination;
}
export interface PutVoiceConnectorTerminationResponse {
/**
* The updated termination setting details.
*/
Termination?: Termination;
}
export interface RegenerateSecurityTokenRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
}
export interface RegenerateSecurityTokenResponse {
Bot?: Bot;
}
export type RegistrationStatus = "Unregistered"|"Registered"|"Suspended"|string;
export interface ResetPersonalPINRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The user ID.
*/
UserId: NonEmptyString;
}
export interface ResetPersonalPINResponse {
/**
* The user details and new personal meeting PIN.
*/
User?: User;
}
export interface RestorePhoneNumberRequest {
/**
* The phone number.
*/
PhoneNumberId: NonEmptyString;
}
export interface RestorePhoneNumberResponse {
/**
* The phone number details.
*/
PhoneNumber?: PhoneNumber;
}
export type ResultMax = number;
export interface Room {
/**
* The room ID.
*/
RoomId?: NonEmptyString;
/**
* The room name.
*/
Name?: SensitiveString;
/**
* The Amazon Chime account ID.
*/
AccountId?: NonEmptyString;
/**
* The identifier of the room creator.
*/
CreatedBy?: NonEmptyString;
/**
* The room creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The room update timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
}
export type RoomList = Room[];
export interface RoomMembership {
/**
* The room ID.
*/
RoomId?: NonEmptyString;
Member?: Member;
/**
* The membership role.
*/
Role?: RoomMembershipRole;
/**
* The identifier of the user that invited the room member.
*/
InvitedBy?: NonEmptyString;
/**
* The room membership update timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
}
export type RoomMembershipList = RoomMembership[];
export type RoomMembershipRole = "Administrator"|"Member"|string;
export interface SearchAvailablePhoneNumbersRequest {
/**
* The area code used to filter results.
*/
AreaCode?: String;
/**
* The city used to filter results.
*/
City?: String;
/**
* The country used to filter results.
*/
Country?: String;
/**
* The state used to filter results.
*/
State?: String;
/**
* The toll-free prefix that you use to filter results.
*/
TollFreePrefix?: TollFreePrefix;
/**
* The maximum number of results to return in a single call.
*/
MaxResults?: PhoneNumberMaxResults;
/**
* The token to use to retrieve the next page of results.
*/
NextToken?: String;
}
export interface SearchAvailablePhoneNumbersResponse {
/**
* List of phone numbers, in E.164 format.
*/
E164PhoneNumbers?: E164PhoneNumberList;
}
export type SensitiveString = string;
export type SensitiveStringList = SensitiveString[];
export interface StreamingConfiguration {
/**
* The retention period, in hours, for the Amazon Kinesis data.
*/
DataRetentionInHours: DataRetentionInHours;
/**
* When true, media streaming to Amazon Kinesis is turned off.
*/
Disabled?: Boolean;
}
export type String = string;
export type StringList = String[];
export interface TelephonySettings {
/**
* Allows or denies inbound calling.
*/
InboundCalling: Boolean;
/**
* Allows or denies outbound calling.
*/
OutboundCalling: Boolean;
/**
* Allows or denies SMS messaging.
*/
SMS: Boolean;
}
export interface Termination {
/**
* The limit on calls per second. Max value based on account service limit. Default value of 1.
*/
CpsLimit?: CpsLimit;
/**
* The default caller ID phone number.
*/
DefaultPhoneNumber?: E164PhoneNumber;
/**
* The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
*/
CallingRegions?: CallingRegionList;
/**
* The IP addresses allowed to make calls, in CIDR format. Required.
*/
CidrAllowedList?: StringList;
/**
* When termination settings are disabled, outbound calls can not be made.
*/
Disabled?: Boolean;
}
export interface TerminationHealth {
/**
* The timestamp, in ISO 8601 format.
*/
Timestamp?: Iso8601Timestamp;
/**
* The source IP address.
*/
Source?: String;
}
export type TollFreePrefix = string;
export interface UpdateAccountRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The new name for the specified Amazon Chime account.
*/
Name?: AccountName;
}
export interface UpdateAccountResponse {
/**
* The updated Amazon Chime account details.
*/
Account?: Account;
}
export interface UpdateAccountSettingsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The Amazon Chime account settings to update.
*/
AccountSettings: AccountSettings;
}
export interface UpdateAccountSettingsResponse {
}
export interface UpdateBotRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The bot ID.
*/
BotId: NonEmptyString;
/**
* When true, stops the specified bot from running in your account.
*/
Disabled?: NullableBoolean;
}
export interface UpdateBotResponse {
/**
* The updated bot details.
*/
Bot?: Bot;
}
export interface UpdateGlobalSettingsRequest {
/**
* The Amazon Chime Business Calling settings.
*/
BusinessCalling: BusinessCallingSettings;
/**
* The Amazon Chime Voice Connector settings.
*/
VoiceConnector: VoiceConnectorSettings;
}
export interface UpdatePhoneNumberRequest {
/**
* The phone number ID.
*/
PhoneNumberId: String;
/**
* The product type.
*/
ProductType?: PhoneNumberProductType;
/**
* The outbound calling name associated with the phone number.
*/
CallingName?: CallingName;
}
export interface UpdatePhoneNumberRequestItem {
/**
* The phone number ID to update.
*/
PhoneNumberId: NonEmptyString;
/**
* The product type to update.
*/
ProductType?: PhoneNumberProductType;
/**
* The outbound calling name to update.
*/
CallingName?: CallingName;
}
export type UpdatePhoneNumberRequestItemList = UpdatePhoneNumberRequestItem[];
export interface UpdatePhoneNumberResponse {
/**
* The updated phone number details.
*/
PhoneNumber?: PhoneNumber;
}
export interface UpdatePhoneNumberSettingsRequest {
/**
* The default outbound calling name for the account.
*/
CallingName: CallingName;
}
export interface UpdateRoomMembershipRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The member ID.
*/
MemberId: NonEmptyString;
/**
* The role of the member.
*/
Role?: RoomMembershipRole;
}
export interface UpdateRoomMembershipResponse {
/**
* The room membership details.
*/
RoomMembership?: RoomMembership;
}
export interface UpdateRoomRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The room ID.
*/
RoomId: NonEmptyString;
/**
* The room name.
*/
Name?: SensitiveString;
}
export interface UpdateRoomResponse {
/**
* The room details.
*/
Room?: Room;
}
export interface UpdateUserRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: NonEmptyString;
/**
* The user ID.
*/
UserId: NonEmptyString;
/**
* The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.
*/
LicenseType?: License;
}
export interface UpdateUserRequestItem {
/**
* The user ID.
*/
UserId: NonEmptyString;
/**
* The user license type.
*/
LicenseType?: License;
}
export type UpdateUserRequestItemList = UpdateUserRequestItem[];
export interface UpdateUserResponse {
/**
* The updated user details.
*/
User?: User;
}
export interface UpdateUserSettingsRequest {
/**
* The Amazon Chime account ID.
*/
AccountId: String;
/**
* The user ID.
*/
UserId: String;
/**
* The user settings to update.
*/
UserSettings: UserSettings;
}
export interface UpdateVoiceConnectorGroupRequest {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId: NonEmptyString;
/**
* The name of the Amazon Chime Voice Connector group.
*/
Name: VoiceConnectorGroupName;
/**
* The VoiceConnectorItems to associate with the group.
*/
VoiceConnectorItems: VoiceConnectorItemList;
}
export interface UpdateVoiceConnectorGroupResponse {
/**
* The updated Amazon Chime Voice Connector group details.
*/
VoiceConnectorGroup?: VoiceConnectorGroup;
}
export interface UpdateVoiceConnectorRequest {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The name of the Amazon Chime Voice Connector.
*/
Name: VoiceConnectorName;
/**
* When enabled, requires encryption for the Amazon Chime Voice Connector.
*/
RequireEncryption: Boolean;
}
export interface UpdateVoiceConnectorResponse {
/**
* The updated Amazon Chime Voice Connector details.
*/
VoiceConnector?: VoiceConnector;
}
export type UriType = string;
export interface User {
/**
* The user ID.
*/
UserId: String;
/**
* The Amazon Chime account ID.
*/
AccountId?: String;
/**
* The primary email address of the user.
*/
PrimaryEmail?: EmailAddress;
/**
* The primary phone number associated with the user.
*/
PrimaryProvisionedNumber?: SensitiveString;
/**
* The display name of the user.
*/
DisplayName?: SensitiveString;
/**
* The license type for the user.
*/
LicenseType?: License;
/**
* The user registration status.
*/
UserRegistrationStatus?: RegistrationStatus;
/**
* The user invite status.
*/
UserInvitationStatus?: InviteStatus;
/**
* Date and time when the user is registered, in ISO 8601 format.
*/
RegisteredOn?: Iso8601Timestamp;
/**
* Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
*/
InvitedOn?: Iso8601Timestamp;
/**
* The user's personal meeting PIN.
*/
PersonalPIN?: String;
}
export type UserEmailList = EmailAddress[];
export interface UserError {
/**
* The user ID for which the action failed.
*/
UserId?: NonEmptyString;
/**
* The error code.
*/
ErrorCode?: ErrorCode;
/**
* The error message.
*/
ErrorMessage?: String;
}
export type UserErrorList = UserError[];
export type UserIdList = NonEmptyString[];
export type UserList = User[];
export interface UserSettings {
/**
* The telephony settings associated with the user.
*/
Telephony: TelephonySettings;
}
export interface VoiceConnector {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId?: NonEmptyString;
/**
* The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
*/
AwsRegion?: VoiceConnectorAwsRegion;
/**
* The name of the Amazon Chime Voice Connector.
*/
Name?: VoiceConnectorName;
/**
* The outbound host name for the Amazon Chime Voice Connector.
*/
OutboundHostName?: String;
/**
* Designates whether encryption is required for the Amazon Chime Voice Connector.
*/
RequireEncryption?: Boolean;
/**
* The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
}
export type VoiceConnectorAwsRegion = "us-east-1"|"us-west-2"|string;
export interface VoiceConnectorGroup {
/**
* The Amazon Chime Voice Connector group ID.
*/
VoiceConnectorGroupId?: NonEmptyString;
/**
* The name of the Amazon Chime Voice Connector group.
*/
Name?: VoiceConnectorGroupName;
/**
* The Amazon Chime Voice Connectors to which to route inbound calls.
*/
VoiceConnectorItems?: VoiceConnectorItemList;
/**
* The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
*/
CreatedTimestamp?: Iso8601Timestamp;
/**
* The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
*/
UpdatedTimestamp?: Iso8601Timestamp;
}
export type VoiceConnectorGroupList = VoiceConnectorGroup[];
export type VoiceConnectorGroupName = string;
export interface VoiceConnectorItem {
/**
* The Amazon Chime Voice Connector ID.
*/
VoiceConnectorId: NonEmptyString;
/**
* The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
*/
Priority: VoiceConnectorItemPriority;
}
export type VoiceConnectorItemList = VoiceConnectorItem[];
export type VoiceConnectorItemPriority = number;
export type VoiceConnectorList = VoiceConnector[];
export type VoiceConnectorName = string;
export interface VoiceConnectorSettings {
/**
* The Amazon S3 bucket designated for call detail record storage.
*/
CdrBucket?: 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 = "2018-05-01"|"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 Chime client.
*/
export import Types = Chime;
}
export = Chime;