cognitoidentityserviceprovider.d.ts
251 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
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 CognitoIdentityServiceProvider extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CognitoIdentityServiceProvider.Types.ClientConfiguration)
config: Config & CognitoIdentityServiceProvider.Types.ClientConfiguration;
/**
* Adds additional user attributes to the user pool schema.
*/
addCustomAttributes(params: CognitoIdentityServiceProvider.Types.AddCustomAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse, AWSError>;
/**
* Adds additional user attributes to the user pool schema.
*/
addCustomAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AddCustomAttributesResponse, AWSError>;
/**
* Adds the specified user to the specified group. Calling this action requires developer credentials.
*/
adminAddUserToGroup(params: CognitoIdentityServiceProvider.Types.AdminAddUserToGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds the specified user to the specified group. Calling this action requires developer credentials.
*/
adminAddUserToGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Confirms user registration as an admin without using a confirmation code. Works on any user. Calling this action requires developer credentials.
*/
adminConfirmSignUp(params: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse, AWSError>;
/**
* Confirms user registration as an admin without using a confirmation code. Works on any user. Calling this action requires developer credentials.
*/
adminConfirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminConfirmSignUpResponse, AWSError>;
/**
* Creates a new user in the specified user pool. If MessageAction is not set, the default is to send a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials.
*/
adminCreateUser(params: CognitoIdentityServiceProvider.Types.AdminCreateUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>;
/**
* Creates a new user in the specified user pool. If MessageAction is not set, the default is to send a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password. Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email. In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password. AdminCreateUser requires developer credentials.
*/
adminCreateUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminCreateUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminCreateUserResponse, AWSError>;
/**
* Deletes a user as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminDeleteUser(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a user as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminDeleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the user attributes in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminDeleteUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse, AWSError>;
/**
* Deletes the user attributes in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminDeleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDeleteUserAttributesResponse, AWSError>;
/**
* Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See . This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
*/
adminDisableProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse, AWSError>;
/**
* Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See . This action is enabled only for admin access and requires developer credentials. The ProviderName must match the value specified when creating an IdP for the pool. To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user. The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user. For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.
*/
adminDisableProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableProviderForUserResponse, AWSError>;
/**
* Disables the specified user. Calling this action requires developer credentials.
*/
adminDisableUser(params: CognitoIdentityServiceProvider.Types.AdminDisableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableUserResponse, AWSError>;
/**
* Disables the specified user. Calling this action requires developer credentials.
*/
adminDisableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminDisableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminDisableUserResponse, AWSError>;
/**
* Enables the specified user as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminEnableUser(params: CognitoIdentityServiceProvider.Types.AdminEnableUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminEnableUserResponse, AWSError>;
/**
* Enables the specified user as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminEnableUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminEnableUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminEnableUserResponse, AWSError>;
/**
* Forgets the device, as an administrator. Calling this action requires developer credentials.
*/
adminForgetDevice(params: CognitoIdentityServiceProvider.Types.AdminForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Forgets the device, as an administrator. Calling this action requires developer credentials.
*/
adminForgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets the device, as an administrator. Calling this action requires developer credentials.
*/
adminGetDevice(params: CognitoIdentityServiceProvider.Types.AdminGetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse, AWSError>;
/**
* Gets the device, as an administrator. Calling this action requires developer credentials.
*/
adminGetDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetDeviceResponse, AWSError>;
/**
* Gets the specified user by user name in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminGetUser(params: CognitoIdentityServiceProvider.Types.AdminGetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetUserResponse, AWSError>;
/**
* Gets the specified user by user name in a user pool as an administrator. Works on any user. Calling this action requires developer credentials.
*/
adminGetUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminGetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminGetUserResponse, AWSError>;
/**
* Initiates the authentication flow, as an administrator. Calling this action requires developer credentials.
*/
adminInitiateAuth(params: CognitoIdentityServiceProvider.Types.AdminInitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>;
/**
* Initiates the authentication flow, as an administrator. Calling this action requires developer credentials.
*/
adminInitiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminInitiateAuthResponse, AWSError>;
/**
* Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. See also . This action is enabled only for admin access and requires developer credentials.
*/
adminLinkProviderForUser(params: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse, AWSError>;
/**
* Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account. For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account. Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner. See also . This action is enabled only for admin access and requires developer credentials.
*/
adminLinkProviderForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminLinkProviderForUserResponse, AWSError>;
/**
* Lists devices, as an administrator. Calling this action requires developer credentials.
*/
adminListDevices(params: CognitoIdentityServiceProvider.Types.AdminListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListDevicesResponse, AWSError>;
/**
* Lists devices, as an administrator. Calling this action requires developer credentials.
*/
adminListDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListDevicesResponse, AWSError>;
/**
* Lists the groups that the user belongs to. Calling this action requires developer credentials.
*/
adminListGroupsForUser(params: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse, AWSError>;
/**
* Lists the groups that the user belongs to. Calling this action requires developer credentials.
*/
adminListGroupsForUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListGroupsForUserResponse, AWSError>;
/**
* Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
*/
adminListUserAuthEvents(params: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse, AWSError>;
/**
* Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.
*/
adminListUserAuthEvents(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminListUserAuthEventsResponse, AWSError>;
/**
* Removes the specified user from the specified group. Calling this action requires developer credentials.
*/
adminRemoveUserFromGroup(params: CognitoIdentityServiceProvider.Types.AdminRemoveUserFromGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes the specified user from the specified group. Calling this action requires developer credentials.
*/
adminRemoveUserFromGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. Calling this action requires developer credentials.
*/
adminResetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>;
/**
* Resets the specified user's password in a user pool as an administrator. Works on any user. When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password. Calling this action requires developer credentials.
*/
adminResetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminResetUserPasswordResponse, AWSError>;
/**
* Responds to an authentication challenge, as an administrator. Calling this action requires developer credentials.
*/
adminRespondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>;
/**
* Responds to an authentication challenge, as an administrator. Calling this action requires developer credentials.
*/
adminRespondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminRespondToAuthChallengeResponse, AWSError>;
/**
* Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
*/
adminSetUserMFAPreference(params: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse, AWSError>;
/**
* Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
*/
adminSetUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserMFAPreferenceResponse, AWSError>;
/**
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator. Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.
*/
adminSetUserPassword(params: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse, AWSError>;
/**
* Sets the specified user's password in a user pool as an administrator. Works on any user. The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator. Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.
*/
adminSetUserPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserPasswordResponse, AWSError>;
/**
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.
*/
adminSetUserSettings(params: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>;
/**
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.
*/
adminSetUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminSetUserSettingsResponse, AWSError>;
/**
* Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
*/
adminUpdateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse, AWSError>;
/**
* Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
*/
adminUpdateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateAuthEventFeedbackResponse, AWSError>;
/**
* Updates the device status as an administrator. Calling this action requires developer credentials.
*/
adminUpdateDeviceStatus(params: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse, AWSError>;
/**
* Updates the device status as an administrator. Calling this action requires developer credentials.
*/
adminUpdateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateDeviceStatusResponse, AWSError>;
/**
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. Calling this action requires developer credentials.
*/
adminUpdateUserAttributes(params: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>;
/**
* Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user. For custom attributes, you must prepend the custom: prefix to the attribute name. In addition to updating user attributes, this API can also be used to mark phone and email as verified. Calling this action requires developer credentials.
*/
adminUpdateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUpdateUserAttributesResponse, AWSError>;
/**
* Signs out users from all devices, as an administrator. Calling this action requires developer credentials.
*/
adminUserGlobalSignOut(params: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>;
/**
* Signs out users from all devices, as an administrator. Calling this action requires developer credentials.
*/
adminUserGlobalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.AdminUserGlobalSignOutResponse, AWSError>;
/**
* Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
*/
associateSoftwareToken(params: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse, AWSError>;
/**
* Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.
*/
associateSoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.AssociateSoftwareTokenResponse, AWSError>;
/**
* Changes the password for a specified user in a user pool.
*/
changePassword(params: CognitoIdentityServiceProvider.Types.ChangePasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ChangePasswordResponse, AWSError>;
/**
* Changes the password for a specified user in a user pool.
*/
changePassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ChangePasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ChangePasswordResponse, AWSError>;
/**
* Confirms tracking of the device. This API call is the call that begins device tracking.
*/
confirmDevice(params: CognitoIdentityServiceProvider.Types.ConfirmDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse, AWSError>;
/**
* Confirms tracking of the device. This API call is the call that begins device tracking.
*/
confirmDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmDeviceResponse, AWSError>;
/**
* Allows a user to enter a confirmation code to reset a forgotten password.
*/
confirmForgotPassword(params: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse, AWSError>;
/**
* Allows a user to enter a confirmation code to reset a forgotten password.
*/
confirmForgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmForgotPasswordResponse, AWSError>;
/**
* Confirms registration of a user and handles the existing alias from a previous user.
*/
confirmSignUp(params: CognitoIdentityServiceProvider.Types.ConfirmSignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>;
/**
* Confirms registration of a user and handles the existing alias from a previous user.
*/
confirmSignUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.ConfirmSignUpResponse, AWSError>;
/**
* Creates a new group in the specified user pool. Calling this action requires developer credentials.
*/
createGroup(params: CognitoIdentityServiceProvider.Types.CreateGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateGroupResponse, AWSError>;
/**
* Creates a new group in the specified user pool. Calling this action requires developer credentials.
*/
createGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateGroupResponse, AWSError>;
/**
* Creates an identity provider for a user pool.
*/
createIdentityProvider(params: CognitoIdentityServiceProvider.Types.CreateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse, AWSError>;
/**
* Creates an identity provider for a user pool.
*/
createIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateIdentityProviderResponse, AWSError>;
/**
* Creates a new OAuth2.0 resource server and defines custom scopes in it.
*/
createResourceServer(params: CognitoIdentityServiceProvider.Types.CreateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateResourceServerResponse, AWSError>;
/**
* Creates a new OAuth2.0 resource server and defines custom scopes in it.
*/
createResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateResourceServerResponse, AWSError>;
/**
* Creates the user import job.
*/
createUserImportJob(params: CognitoIdentityServiceProvider.Types.CreateUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse, AWSError>;
/**
* Creates the user import job.
*/
createUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserImportJobResponse, AWSError>;
/**
* Creates a new Amazon Cognito user pool and sets the password policy for the pool.
*/
createUserPool(params: CognitoIdentityServiceProvider.Types.CreateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>;
/**
* Creates a new Amazon Cognito user pool and sets the password policy for the pool.
*/
createUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolResponse, AWSError>;
/**
* Creates the user pool client.
*/
createUserPoolClient(params: CognitoIdentityServiceProvider.Types.CreateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>;
/**
* Creates the user pool client.
*/
createUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolClientResponse, AWSError>;
/**
* Creates a new domain for a user pool.
*/
createUserPoolDomain(params: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse, AWSError>;
/**
* Creates a new domain for a user pool.
*/
createUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.CreateUserPoolDomainResponse, AWSError>;
/**
* Deletes a group. Currently only groups with no members can be deleted. Calling this action requires developer credentials.
*/
deleteGroup(params: CognitoIdentityServiceProvider.Types.DeleteGroupRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a group. Currently only groups with no members can be deleted. Calling this action requires developer credentials.
*/
deleteGroup(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an identity provider for a user pool.
*/
deleteIdentityProvider(params: CognitoIdentityServiceProvider.Types.DeleteIdentityProviderRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes an identity provider for a user pool.
*/
deleteIdentityProvider(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a resource server.
*/
deleteResourceServer(params: CognitoIdentityServiceProvider.Types.DeleteResourceServerRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a resource server.
*/
deleteResourceServer(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Allows a user to delete himself or herself.
*/
deleteUser(params: CognitoIdentityServiceProvider.Types.DeleteUserRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Allows a user to delete himself or herself.
*/
deleteUser(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the attributes for a user.
*/
deleteUserAttributes(params: CognitoIdentityServiceProvider.Types.DeleteUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse, AWSError>;
/**
* Deletes the attributes for a user.
*/
deleteUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserAttributesResponse, AWSError>;
/**
* Deletes the specified Amazon Cognito user pool.
*/
deleteUserPool(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified Amazon Cognito user pool.
*/
deleteUserPool(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Allows the developer to delete the user pool client.
*/
deleteUserPoolClient(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolClientRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Allows the developer to delete the user pool client.
*/
deleteUserPoolClient(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a domain for a user pool.
*/
deleteUserPoolDomain(params: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse, AWSError>;
/**
* Deletes a domain for a user pool.
*/
deleteUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.DeleteUserPoolDomainResponse, AWSError>;
/**
* Gets information about a specific identity provider.
*/
describeIdentityProvider(params: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse, AWSError>;
/**
* Gets information about a specific identity provider.
*/
describeIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeIdentityProviderResponse, AWSError>;
/**
* Describes a resource server.
*/
describeResourceServer(params: CognitoIdentityServiceProvider.Types.DescribeResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse, AWSError>;
/**
* Describes a resource server.
*/
describeResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeResourceServerResponse, AWSError>;
/**
* Describes the risk configuration.
*/
describeRiskConfiguration(params: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse, AWSError>;
/**
* Describes the risk configuration.
*/
describeRiskConfiguration(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeRiskConfigurationResponse, AWSError>;
/**
* Describes the user import job.
*/
describeUserImportJob(params: CognitoIdentityServiceProvider.Types.DescribeUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse, AWSError>;
/**
* Describes the user import job.
*/
describeUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserImportJobResponse, AWSError>;
/**
* Returns the configuration information and metadata of the specified user pool.
*/
describeUserPool(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse, AWSError>;
/**
* Returns the configuration information and metadata of the specified user pool.
*/
describeUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolResponse, AWSError>;
/**
* Client method for returning the configuration information and metadata of the specified user pool app client.
*/
describeUserPoolClient(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse, AWSError>;
/**
* Client method for returning the configuration information and metadata of the specified user pool app client.
*/
describeUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolClientResponse, AWSError>;
/**
* Gets information about a domain.
*/
describeUserPoolDomain(params: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse, AWSError>;
/**
* Gets information about a domain.
*/
describeUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.DescribeUserPoolDomainResponse, AWSError>;
/**
* Forgets the specified device.
*/
forgetDevice(params: CognitoIdentityServiceProvider.Types.ForgetDeviceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Forgets the specified device.
*/
forgetDevice(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .
*/
forgotPassword(params: CognitoIdentityServiceProvider.Types.ForgotPasswordRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>;
/**
* Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .
*/
forgotPassword(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ForgotPasswordResponse) => void): Request<CognitoIdentityServiceProvider.Types.ForgotPasswordResponse, AWSError>;
/**
* Gets the header information for the .csv file to be used as input for the user import job.
*/
getCSVHeader(params: CognitoIdentityServiceProvider.Types.GetCSVHeaderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>;
/**
* Gets the header information for the .csv file to be used as input for the user import job.
*/
getCSVHeader(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetCSVHeaderResponse, AWSError>;
/**
* Gets the device.
*/
getDevice(params: CognitoIdentityServiceProvider.Types.GetDeviceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetDeviceResponse, AWSError>;
/**
* Gets the device.
*/
getDevice(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetDeviceResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetDeviceResponse, AWSError>;
/**
* Gets a group. Calling this action requires developer credentials.
*/
getGroup(params: CognitoIdentityServiceProvider.Types.GetGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetGroupResponse, AWSError>;
/**
* Gets a group. Calling this action requires developer credentials.
*/
getGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetGroupResponse, AWSError>;
/**
* Gets the specified identity provider.
*/
getIdentityProviderByIdentifier(params: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse, AWSError>;
/**
* Gets the specified identity provider.
*/
getIdentityProviderByIdentifier(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetIdentityProviderByIdentifierResponse, AWSError>;
/**
* This method takes a user pool ID, and returns the signing certificate.
*/
getSigningCertificate(params: CognitoIdentityServiceProvider.Types.GetSigningCertificateRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse, AWSError>;
/**
* This method takes a user pool ID, and returns the signing certificate.
*/
getSigningCertificate(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetSigningCertificateResponse, AWSError>;
/**
* Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
*/
getUICustomization(params: CognitoIdentityServiceProvider.Types.GetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUICustomizationResponse, AWSError>;
/**
* Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.
*/
getUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUICustomizationResponse, AWSError>;
/**
* Gets the user attributes and metadata for a user.
*/
getUser(params: CognitoIdentityServiceProvider.Types.GetUserRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserResponse, AWSError>;
/**
* Gets the user attributes and metadata for a user.
*/
getUser(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserResponse, AWSError>;
/**
* Gets the user attribute verification code for the specified attribute name.
*/
getUserAttributeVerificationCode(params: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>;
/**
* Gets the user attribute verification code for the specified attribute name.
*/
getUserAttributeVerificationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserAttributeVerificationCodeResponse, AWSError>;
/**
* Gets the user pool multi-factor authentication (MFA) configuration.
*/
getUserPoolMfaConfig(params: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse, AWSError>;
/**
* Gets the user pool multi-factor authentication (MFA) configuration.
*/
getUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.GetUserPoolMfaConfigResponse, AWSError>;
/**
* Signs out users from all devices.
*/
globalSignOut(params: CognitoIdentityServiceProvider.Types.GlobalSignOutRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>;
/**
* Signs out users from all devices.
*/
globalSignOut(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.GlobalSignOutResponse) => void): Request<CognitoIdentityServiceProvider.Types.GlobalSignOutResponse, AWSError>;
/**
* Initiates the authentication flow.
*/
initiateAuth(params: CognitoIdentityServiceProvider.Types.InitiateAuthRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>;
/**
* Initiates the authentication flow.
*/
initiateAuth(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.InitiateAuthResponse) => void): Request<CognitoIdentityServiceProvider.Types.InitiateAuthResponse, AWSError>;
/**
* Lists the devices.
*/
listDevices(params: CognitoIdentityServiceProvider.Types.ListDevicesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>;
/**
* Lists the devices.
*/
listDevices(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListDevicesResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListDevicesResponse, AWSError>;
/**
* Lists the groups associated with a user pool. Calling this action requires developer credentials.
*/
listGroups(params: CognitoIdentityServiceProvider.Types.ListGroupsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListGroupsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListGroupsResponse, AWSError>;
/**
* Lists the groups associated with a user pool. Calling this action requires developer credentials.
*/
listGroups(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListGroupsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListGroupsResponse, AWSError>;
/**
* Lists information about all identity providers for a user pool.
*/
listIdentityProviders(params: CognitoIdentityServiceProvider.Types.ListIdentityProvidersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse, AWSError>;
/**
* Lists information about all identity providers for a user pool.
*/
listIdentityProviders(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListIdentityProvidersResponse, AWSError>;
/**
* Lists the resource servers for a user pool.
*/
listResourceServers(params: CognitoIdentityServiceProvider.Types.ListResourceServersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListResourceServersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListResourceServersResponse, AWSError>;
/**
* Lists the resource servers for a user pool.
*/
listResourceServers(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListResourceServersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListResourceServersResponse, AWSError>;
/**
* Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account.
*/
listTagsForResource(params: CognitoIdentityServiceProvider.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags that are assigned to an Amazon Cognito user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria. You can use this action up to 10 times per second, per account.
*/
listTagsForResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the user import jobs.
*/
listUserImportJobs(params: CognitoIdentityServiceProvider.Types.ListUserImportJobsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse, AWSError>;
/**
* Lists the user import jobs.
*/
listUserImportJobs(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserImportJobsResponse, AWSError>;
/**
* Lists the clients that have been created for the specified user pool.
*/
listUserPoolClients(params: CognitoIdentityServiceProvider.Types.ListUserPoolClientsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse, AWSError>;
/**
* Lists the clients that have been created for the specified user pool.
*/
listUserPoolClients(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolClientsResponse, AWSError>;
/**
* Lists the user pools associated with an AWS account.
*/
listUserPools(params: CognitoIdentityServiceProvider.Types.ListUserPoolsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>;
/**
* Lists the user pools associated with an AWS account.
*/
listUserPools(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUserPoolsResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUserPoolsResponse, AWSError>;
/**
* Lists the users in the Amazon Cognito user pool.
*/
listUsers(params: CognitoIdentityServiceProvider.Types.ListUsersRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersResponse, AWSError>;
/**
* Lists the users in the Amazon Cognito user pool.
*/
listUsers(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersResponse, AWSError>;
/**
* Lists the users in the specified group. Calling this action requires developer credentials.
*/
listUsersInGroup(params: CognitoIdentityServiceProvider.Types.ListUsersInGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse, AWSError>;
/**
* Lists the users in the specified group. Calling this action requires developer credentials.
*/
listUsersInGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.ListUsersInGroupResponse, AWSError>;
/**
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
*/
resendConfirmationCode(params: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>;
/**
* Resends the confirmation (for confirmation of registration) to a specific user in the user pool.
*/
resendConfirmationCode(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse) => void): Request<CognitoIdentityServiceProvider.Types.ResendConfirmationCodeResponse, AWSError>;
/**
* Responds to the authentication challenge.
*/
respondToAuthChallenge(params: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>;
/**
* Responds to the authentication challenge.
*/
respondToAuthChallenge(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse) => void): Request<CognitoIdentityServiceProvider.Types.RespondToAuthChallengeResponse, AWSError>;
/**
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode. See .
*/
setRiskConfiguration(params: CognitoIdentityServiceProvider.Types.SetRiskConfigurationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse, AWSError>;
/**
* Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types. To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode. See .
*/
setRiskConfiguration(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetRiskConfigurationResponse, AWSError>;
/**
* Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
*/
setUICustomization(params: CognitoIdentityServiceProvider.Types.SetUICustomizationRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUICustomizationResponse, AWSError>;
/**
* Sets the UI customization information for a user pool's built-in app UI. You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration. To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.
*/
setUICustomization(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUICustomizationResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUICustomizationResponse, AWSError>;
/**
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
*/
setUserMFAPreference(params: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse, AWSError>;
/**
* Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.
*/
setUserMFAPreference(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserMFAPreferenceResponse, AWSError>;
/**
* Set the user pool multi-factor authentication (MFA) configuration.
*/
setUserPoolMfaConfig(params: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse, AWSError>;
/**
* Set the user pool multi-factor authentication (MFA) configuration.
*/
setUserPoolMfaConfig(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserPoolMfaConfigResponse, AWSError>;
/**
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.
*/
setUserSettings(params: CognitoIdentityServiceProvider.Types.SetUserSettingsRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>;
/**
* This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.
*/
setUserSettings(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SetUserSettingsResponse) => void): Request<CognitoIdentityServiceProvider.Types.SetUserSettingsResponse, AWSError>;
/**
* Registers the user in the specified user pool and creates a user name, password, and user attributes.
*/
signUp(params: CognitoIdentityServiceProvider.Types.SignUpRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>;
/**
* Registers the user in the specified user pool and creates a user name, password, and user attributes.
*/
signUp(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.SignUpResponse) => void): Request<CognitoIdentityServiceProvider.Types.SignUpResponse, AWSError>;
/**
* Starts the user import.
*/
startUserImportJob(params: CognitoIdentityServiceProvider.Types.StartUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StartUserImportJobResponse, AWSError>;
/**
* Starts the user import.
*/
startUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StartUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StartUserImportJobResponse, AWSError>;
/**
* Stops the user import job.
*/
stopUserImportJob(params: CognitoIdentityServiceProvider.Types.StopUserImportJobRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StopUserImportJobResponse, AWSError>;
/**
* Stops the user import job.
*/
stopUserImportJob(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.StopUserImportJobResponse) => void): Request<CognitoIdentityServiceProvider.Types.StopUserImportJobResponse, AWSError>;
/**
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
*/
tagResource(params: CognitoIdentityServiceProvider.Types.TagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.TagResourceResponse, AWSError>;
/**
* Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria. Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other. Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values. You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.
*/
tagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.TagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.TagResourceResponse, AWSError>;
/**
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
*/
untagResource(params: CognitoIdentityServiceProvider.Types.UntagResourceRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.UntagResourceResponse, AWSError>;
/**
* Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account
*/
untagResource(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UntagResourceResponse) => void): Request<CognitoIdentityServiceProvider.Types.UntagResourceResponse, AWSError>;
/**
* Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
*/
updateAuthEventFeedback(params: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse, AWSError>;
/**
* Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.
*/
updateAuthEventFeedback(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateAuthEventFeedbackResponse, AWSError>;
/**
* Updates the device status.
*/
updateDeviceStatus(params: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse, AWSError>;
/**
* Updates the device status.
*/
updateDeviceStatus(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateDeviceStatusResponse, AWSError>;
/**
* Updates the specified group with the specified attributes. Calling this action requires developer credentials. If you don't provide a value for an attribute, it will be set to the default value.
*/
updateGroup(params: CognitoIdentityServiceProvider.Types.UpdateGroupRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateGroupResponse, AWSError>;
/**
* Updates the specified group with the specified attributes. Calling this action requires developer credentials. If you don't provide a value for an attribute, it will be set to the default value.
*/
updateGroup(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateGroupResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateGroupResponse, AWSError>;
/**
* Updates identity provider information for a user pool.
*/
updateIdentityProvider(params: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse, AWSError>;
/**
* Updates identity provider information for a user pool.
*/
updateIdentityProvider(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateIdentityProviderResponse, AWSError>;
/**
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it will be set to the default value.
*/
updateResourceServer(params: CognitoIdentityServiceProvider.Types.UpdateResourceServerRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse, AWSError>;
/**
* Updates the name and scopes of resource server. All other fields are read-only. If you don't provide a value for an attribute, it will be set to the default value.
*/
updateResourceServer(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateResourceServerResponse, AWSError>;
/**
* Allows a user to update a specific attribute (one at a time).
*/
updateUserAttributes(params: CognitoIdentityServiceProvider.Types.UpdateUserAttributesRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>;
/**
* Allows a user to update a specific attribute (one at a time).
*/
updateUserAttributes(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserAttributesResponse, AWSError>;
/**
* Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with . If you don't provide a value for an attribute, it will be set to the default value.
*/
updateUserPool(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>;
/**
* Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings with . If you don't provide a value for an attribute, it will be set to the default value.
*/
updateUserPool(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolResponse, AWSError>;
/**
* Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with . If you don't provide a value for an attribute, it will be set to the default value.
*/
updateUserPoolClient(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse, AWSError>;
/**
* Updates the specified user pool app client with the specified attributes. You can get a list of the current user pool app client settings with . If you don't provide a value for an attribute, it will be set to the default value.
*/
updateUserPoolClient(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolClientResponse, AWSError>;
/**
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
*/
updateUserPoolDomain(params: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse, AWSError>;
/**
* Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool. You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool. A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain. Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically. However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito. When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region. After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
*/
updateUserPoolDomain(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse) => void): Request<CognitoIdentityServiceProvider.Types.UpdateUserPoolDomainResponse, AWSError>;
/**
* Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
*/
verifySoftwareToken(params: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse, AWSError>;
/**
* Use this API to register a user's entered TOTP code and mark the user's software token MFA status as "verified" if successful. The request takes an access token or a session string, but not both.
*/
verifySoftwareToken(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifySoftwareTokenResponse, AWSError>;
/**
* Verifies the specified user attributes in the user pool.
*/
verifyUserAttribute(params: CognitoIdentityServiceProvider.Types.VerifyUserAttributeRequest, callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>;
/**
* Verifies the specified user attributes in the user pool.
*/
verifyUserAttribute(callback?: (err: AWSError, data: CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse) => void): Request<CognitoIdentityServiceProvider.Types.VerifyUserAttributeResponse, AWSError>;
}
declare namespace CognitoIdentityServiceProvider {
export type AWSAccountIdType = string;
export type AccountTakeoverActionNotifyType = boolean;
export interface AccountTakeoverActionType {
/**
* Flag specifying whether to send a notification.
*/
Notify: AccountTakeoverActionNotifyType;
/**
* The event action. BLOCK Choosing this action will block the request. MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request. MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request. NO_ACTION Allow the user sign-in.
*/
EventAction: AccountTakeoverEventActionType;
}
export interface AccountTakeoverActionsType {
/**
* Action to take for a low risk.
*/
LowAction?: AccountTakeoverActionType;
/**
* Action to take for a medium risk.
*/
MediumAction?: AccountTakeoverActionType;
/**
* Action to take for a high risk.
*/
HighAction?: AccountTakeoverActionType;
}
export type AccountTakeoverEventActionType = "BLOCK"|"MFA_IF_CONFIGURED"|"MFA_REQUIRED"|"NO_ACTION"|string;
export interface AccountTakeoverRiskConfigurationType {
/**
* The notify configuration used to construct email notifications.
*/
NotifyConfiguration?: NotifyConfigurationType;
/**
* Account takeover risk configuration actions
*/
Actions: AccountTakeoverActionsType;
}
export interface AddCustomAttributesRequest {
/**
* The user pool ID for the user pool where you want to add custom attributes.
*/
UserPoolId: UserPoolIdType;
/**
* An array of custom attributes, such as Mutable and Name.
*/
CustomAttributes: CustomAttributesListType;
}
export interface AddCustomAttributesResponse {
}
export interface AdminAddUserToGroupRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The username for the user.
*/
Username: UsernameType;
/**
* The group name.
*/
GroupName: GroupNameType;
}
export interface AdminConfirmSignUpRequest {
/**
* The user pool ID for which you want to confirm user registration.
*/
UserPoolId: UserPoolIdType;
/**
* The user name for which you want to confirm user registration.
*/
Username: UsernameType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in AWS Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface AdminConfirmSignUpResponse {
}
export interface AdminCreateUserConfigType {
/**
* Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.
*/
AllowAdminCreateUserOnly?: BooleanType;
/**
* The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7. If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.
*/
UnusedAccountValidityDays?: AdminCreateUserUnusedAccountValidityDaysType;
/**
* The message template to be used for the welcome message to new users. See also Customizing User Invitation Messages.
*/
InviteMessageTemplate?: MessageTemplateType;
}
export interface AdminCreateUserRequest {
/**
* The user pool ID for the user pool where the user will be created.
*/
UserPoolId: UserPoolIdType;
/**
* The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.
*/
Username: UsernameType;
/**
* An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message). For custom attributes, you must prepend the custom: prefix to the attribute name. To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools. In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling .) email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if "EMAIL" is specified in the DesiredDeliveryMediums parameter. phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if "SMS" is specified in the DesiredDeliveryMediums parameter.
*/
UserAttributes?: AttributeListType;
/**
* The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain. To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process. The user's validation data is not persisted.
*/
ValidationData?: AttributeListType;
/**
* The user's temporary password. This password must conform to the password policy that you specified when you created the user pool. The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins. This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you. The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter.
*/
TemporaryPassword?: PasswordType;
/**
* This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored. If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias. If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.
*/
ForceAliasCreation?: ForceAliasCreation;
/**
* Set to "RESEND" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one value can be specified.
*/
MessageAction?: MessageActionType;
/**
* Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the phone number will be used. The default value is "SMS". More than one value can be specified.
*/
DesiredDeliveryMediums?: DeliveryMediumListType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface AdminCreateUserResponse {
/**
* The newly created user.
*/
User?: UserType;
}
export type AdminCreateUserUnusedAccountValidityDaysType = number;
export interface AdminDeleteUserAttributesRequest {
/**
* The user pool ID for the user pool where you want to delete user attributes.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user from which you would like to delete attributes.
*/
Username: UsernameType;
/**
* An array of strings representing the user attribute names you wish to delete. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributeNames: AttributeNameListType;
}
export interface AdminDeleteUserAttributesResponse {
}
export interface AdminDeleteUserRequest {
/**
* The user pool ID for the user pool where you want to delete the user.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user you wish to delete.
*/
Username: UsernameType;
}
export interface AdminDisableProviderForUserRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: StringType;
/**
* The user to be disabled.
*/
User: ProviderUserIdentifierType;
}
export interface AdminDisableProviderForUserResponse {
}
export interface AdminDisableUserRequest {
/**
* The user pool ID for the user pool where you want to disable the user.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user you wish to disable.
*/
Username: UsernameType;
}
export interface AdminDisableUserResponse {
}
export interface AdminEnableUserRequest {
/**
* The user pool ID for the user pool where you want to enable the user.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user you wish to enable.
*/
Username: UsernameType;
}
export interface AdminEnableUserResponse {
}
export interface AdminForgetDeviceRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user name.
*/
Username: UsernameType;
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
}
export interface AdminGetDeviceRequest {
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user name.
*/
Username: UsernameType;
}
export interface AdminGetDeviceResponse {
/**
* The device.
*/
Device: DeviceType;
}
export interface AdminGetUserRequest {
/**
* The user pool ID for the user pool where you want to get information about the user.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user you wish to retrieve.
*/
Username: UsernameType;
}
export interface AdminGetUserResponse {
/**
* The user name of the user about whom you are receiving information.
*/
Username: UsernameType;
/**
* An array of name-value pairs representing user attributes.
*/
UserAttributes?: AttributeListType;
/**
* The date the user was created.
*/
UserCreateDate?: DateType;
/**
* The date the user was last modified.
*/
UserLastModifiedDate?: DateType;
/**
* Indicates that the status is enabled.
*/
Enabled?: BooleanType;
/**
* The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
*/
UserStatus?: UserStatusType;
/**
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.
*/
MFAOptions?: MFAOptionListType;
/**
* The user's preferred MFA setting.
*/
PreferredMfaSetting?: StringType;
/**
* The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
*/
UserMFASettingList?: UserMFASettingListType;
}
export interface AdminInitiateAuthRequest {
/**
* The ID of the Amazon Cognito user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID.
*/
ClientId: ClientIdType;
/**
* The authentication flow for this call to execute. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client. USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords.
*/
AuthFlow: AuthFlowType;
/**
* The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
*/
AuthParameters?: AuthParametersType;
/**
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input: Post authentication Custom message Pre token generation Create auth challenge Define auth challenge Verify auth challenge For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
/**
* The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
ContextData?: ContextDataType;
}
export interface AdminInitiateAuthResponse {
/**
* The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge. MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate. SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow. NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
*/
ChallengeName?: ChallengeNameType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable). The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute cannot be an alias.
*/
ChallengeParameters?: ChallengeParametersType;
/**
* The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
*/
AuthenticationResult?: AuthenticationResultType;
}
export interface AdminLinkProviderForUserRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: StringType;
/**
* The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in. For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id. The ProviderAttributeName of the DestinationUser is ignored. The ProviderName should be set to Cognito for users in Cognito user pools.
*/
DestinationUser: ProviderUserIdentifierType;
/**
* An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user. If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity providers, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social identity provider token. For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.
*/
SourceUser: ProviderUserIdentifierType;
}
export interface AdminLinkProviderForUserResponse {
}
export interface AdminListDevicesRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user name.
*/
Username: UsernameType;
/**
* The limit of the devices request.
*/
Limit?: QueryLimitType;
/**
* The pagination token.
*/
PaginationToken?: SearchPaginationTokenType;
}
export interface AdminListDevicesResponse {
/**
* The devices in the list of devices response.
*/
Devices?: DeviceListType;
/**
* The pagination token.
*/
PaginationToken?: SearchPaginationTokenType;
}
export interface AdminListGroupsForUserRequest {
/**
* The username for the user.
*/
Username: UsernameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The limit of the request to list groups.
*/
Limit?: QueryLimitType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface AdminListGroupsForUserResponse {
/**
* The groups that the user belongs to.
*/
Groups?: GroupListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface AdminListUserAuthEventsRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user pool username or an alias.
*/
Username: UsernameType;
/**
* The maximum number of authentication events to return.
*/
MaxResults?: QueryLimitType;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
}
export interface AdminListUserAuthEventsResponse {
/**
* The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.
*/
AuthEvents?: AuthEventsType;
/**
* A pagination token.
*/
NextToken?: PaginationKey;
}
export interface AdminRemoveUserFromGroupRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The username for the user.
*/
Username: UsernameType;
/**
* The group name.
*/
GroupName: GroupNameType;
}
export interface AdminResetUserPasswordRequest {
/**
* The user pool ID for the user pool where you want to reset the user's password.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user whose password you wish to reset.
*/
Username: UsernameType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface AdminResetUserPasswordResponse {
}
export interface AdminRespondToAuthChallengeRequest {
/**
* The ID of the Amazon Cognito user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID.
*/
ClientId: ClientIdType;
/**
* The challenge name. For more information, see .
*/
ChallengeName: ChallengeNameType;
/**
* The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret). PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret). ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret). NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret). The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.
*/
ChallengeResponses?: ChallengeResponsesType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
ContextData?: ContextDataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, post authentication, user migration, pre token generation, define auth challenge, create auth challenge, and verify auth challenge response. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface AdminRespondToAuthChallengeResponse {
/**
* The name of the challenge. For more information, see .
*/
ChallengeName?: ChallengeNameType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The challenge parameters. For more information, see .
*/
ChallengeParameters?: ChallengeParametersType;
/**
* The result returned by the server in response to the authentication request.
*/
AuthenticationResult?: AuthenticationResultType;
}
export interface AdminSetUserMFAPreferenceRequest {
/**
* The SMS text message MFA settings.
*/
SMSMfaSettings?: SMSMfaSettingsType;
/**
* The time-based one-time password software token MFA settings.
*/
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
/**
* The user pool username or alias.
*/
Username: UsernameType;
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
}
export interface AdminSetUserMFAPreferenceResponse {
}
export interface AdminSetUserPasswordRequest {
/**
* The user pool ID for the user pool where you want to set the user's password.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user whose password you wish to set.
*/
Username: UsernameType;
/**
* The password for the user.
*/
Password: PasswordType;
/**
* True if the password is permanent, False if it is temporary.
*/
Permanent?: BooleanType;
}
export interface AdminSetUserPasswordResponse {
}
export interface AdminSetUserSettingsRequest {
/**
* The ID of the user pool that contains the user that you are setting options for.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user that you are setting options for.
*/
Username: UsernameType;
/**
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*/
MFAOptions: MFAOptionListType;
}
export interface AdminSetUserSettingsResponse {
}
export interface AdminUpdateAuthEventFeedbackRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user pool username.
*/
Username: UsernameType;
/**
* The authentication event ID.
*/
EventId: EventIdType;
/**
* The authentication event feedback value.
*/
FeedbackValue: FeedbackValueType;
}
export interface AdminUpdateAuthEventFeedbackResponse {
}
export interface AdminUpdateDeviceStatusRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user name.
*/
Username: UsernameType;
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
/**
* The status indicating whether a device has been remembered or not.
*/
DeviceRememberedStatus?: DeviceRememberedStatusType;
}
export interface AdminUpdateDeviceStatusResponse {
}
export interface AdminUpdateUserAttributesRequest {
/**
* The user pool ID for the user pool where you want to update user attributes.
*/
UserPoolId: UserPoolIdType;
/**
* The user name of the user for whom you want to update user attributes.
*/
Username: UsernameType;
/**
* An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributes: AttributeListType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface AdminUpdateUserAttributesResponse {
}
export interface AdminUserGlobalSignOutRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user name.
*/
Username: UsernameType;
}
export interface AdminUserGlobalSignOutResponse {
}
export type AdvancedSecurityModeType = "OFF"|"AUDIT"|"ENFORCED"|string;
export type AliasAttributeType = "phone_number"|"email"|"preferred_username"|string;
export type AliasAttributesListType = AliasAttributeType[];
export interface AnalyticsConfigurationType {
/**
* The application ID for an Amazon Pinpoint application.
*/
ApplicationId: HexStringType;
/**
* The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
*/
RoleArn: ArnType;
/**
* The external ID.
*/
ExternalId: StringType;
/**
* If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.
*/
UserDataShared?: BooleanType;
}
export interface AnalyticsMetadataType {
/**
* The endpoint ID.
*/
AnalyticsEndpointId?: StringType;
}
export type ArnType = string;
export interface AssociateSoftwareTokenRequest {
/**
* The access token.
*/
AccessToken?: TokenModelType;
/**
* The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
*/
Session?: SessionType;
}
export interface AssociateSoftwareTokenResponse {
/**
* A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.
*/
SecretCode?: SecretCodeType;
/**
* The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.
*/
Session?: SessionType;
}
export type AttributeDataType = "String"|"Number"|"DateTime"|"Boolean"|string;
export type AttributeListType = AttributeType[];
export type AttributeMappingKeyType = string;
export type AttributeMappingType = {[key: string]: StringType};
export type AttributeNameListType = AttributeNameType[];
export type AttributeNameType = string;
export interface AttributeType {
/**
* The name of the attribute.
*/
Name: AttributeNameType;
/**
* The value of the attribute.
*/
Value?: AttributeValueType;
}
export type AttributeValueType = string;
export interface AuthEventType {
/**
* The event ID.
*/
EventId?: StringType;
/**
* The event type.
*/
EventType?: EventType;
/**
* The creation date
*/
CreationDate?: DateType;
/**
* The event response.
*/
EventResponse?: EventResponseType;
/**
* The event risk.
*/
EventRisk?: EventRiskType;
/**
* The challenge responses.
*/
ChallengeResponses?: ChallengeResponseListType;
/**
* The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.
*/
EventContextData?: EventContextDataType;
/**
* A flag specifying the user feedback captured at the time of an event request is good or bad.
*/
EventFeedback?: EventFeedbackType;
}
export type AuthEventsType = AuthEventType[];
export type AuthFlowType = "USER_SRP_AUTH"|"REFRESH_TOKEN_AUTH"|"REFRESH_TOKEN"|"CUSTOM_AUTH"|"ADMIN_NO_SRP_AUTH"|"USER_PASSWORD_AUTH"|"ADMIN_USER_PASSWORD_AUTH"|string;
export type AuthParametersType = {[key: string]: StringType};
export interface AuthenticationResultType {
/**
* The access token.
*/
AccessToken?: TokenModelType;
/**
* The expiration period of the authentication result in seconds.
*/
ExpiresIn?: IntegerType;
/**
* The token type.
*/
TokenType?: StringType;
/**
* The refresh token.
*/
RefreshToken?: TokenModelType;
/**
* The ID token.
*/
IdToken?: TokenModelType;
/**
* The new device metadata from an authentication result.
*/
NewDeviceMetadata?: NewDeviceMetadataType;
}
export type BlockedIPRangeListType = StringType[];
export type BooleanType = boolean;
export type CSSType = string;
export type CSSVersionType = string;
export type CallbackURLsListType = RedirectUrlType[];
export type ChallengeName = "Password"|"Mfa"|string;
export type ChallengeNameType = "SMS_MFA"|"SOFTWARE_TOKEN_MFA"|"SELECT_MFA_TYPE"|"MFA_SETUP"|"PASSWORD_VERIFIER"|"CUSTOM_CHALLENGE"|"DEVICE_SRP_AUTH"|"DEVICE_PASSWORD_VERIFIER"|"ADMIN_NO_SRP_AUTH"|"NEW_PASSWORD_REQUIRED"|string;
export type ChallengeParametersType = {[key: string]: StringType};
export type ChallengeResponse = "Success"|"Failure"|string;
export type ChallengeResponseListType = ChallengeResponseType[];
export interface ChallengeResponseType {
/**
* The challenge name
*/
ChallengeName?: ChallengeName;
/**
* The challenge response.
*/
ChallengeResponse?: ChallengeResponse;
}
export type ChallengeResponsesType = {[key: string]: StringType};
export interface ChangePasswordRequest {
/**
* The old password.
*/
PreviousPassword: PasswordType;
/**
* The new password.
*/
ProposedPassword: PasswordType;
/**
* The access token.
*/
AccessToken: TokenModelType;
}
export interface ChangePasswordResponse {
}
export type ClientIdType = string;
export type ClientMetadataType = {[key: string]: StringType};
export type ClientNameType = string;
export type ClientPermissionListType = ClientPermissionType[];
export type ClientPermissionType = string;
export type ClientSecretType = string;
export type CodeDeliveryDetailsListType = CodeDeliveryDetailsType[];
export interface CodeDeliveryDetailsType {
/**
* The destination for the code delivery details.
*/
Destination?: StringType;
/**
* The delivery medium (email message or phone number).
*/
DeliveryMedium?: DeliveryMediumType;
/**
* The attribute name.
*/
AttributeName?: AttributeNameType;
}
export type CompletionMessageType = string;
export interface CompromisedCredentialsActionsType {
/**
* The event action.
*/
EventAction: CompromisedCredentialsEventActionType;
}
export type CompromisedCredentialsEventActionType = "BLOCK"|"NO_ACTION"|string;
export interface CompromisedCredentialsRiskConfigurationType {
/**
* Perform the action for these events. The default is to perform all events if no event filter is specified.
*/
EventFilter?: EventFiltersType;
/**
* The compromised credentials risk configuration actions.
*/
Actions: CompromisedCredentialsActionsType;
}
export interface ConfirmDeviceRequest {
/**
* The access token.
*/
AccessToken: TokenModelType;
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
/**
* The configuration of the device secret verifier.
*/
DeviceSecretVerifierConfig?: DeviceSecretVerifierConfigType;
/**
* The device name.
*/
DeviceName?: DeviceNameType;
}
export interface ConfirmDeviceResponse {
/**
* Indicates whether the user confirmation is necessary to confirm the device response.
*/
UserConfirmationNecessary?: BooleanType;
}
export interface ConfirmForgotPasswordRequest {
/**
* The app client ID of the app associated with the user pool.
*/
ClientId: ClientIdType;
/**
* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
*/
SecretHash?: SecretHashType;
/**
* The user name of the user for whom you want to enter a code to retrieve a forgotten password.
*/
Username: UsernameType;
/**
* The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
*/
ConfirmationCode: ConfirmationCodeType;
/**
* The password sent by a user's request to retrieve a forgotten password.
*/
Password: PasswordType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface ConfirmForgotPasswordResponse {
}
export interface ConfirmSignUpRequest {
/**
* The ID of the app client associated with the user pool.
*/
ClientId: ClientIdType;
/**
* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
*/
SecretHash?: SecretHashType;
/**
* The user name of the user whose registration you wish to confirm.
*/
Username: UsernameType;
/**
* The confirmation code sent by a user's request to confirm registration.
*/
ConfirmationCode: ConfirmationCodeType;
/**
* Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
*/
ForceAliasCreation?: ForceAliasCreation;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface ConfirmSignUpResponse {
}
export type ConfirmationCodeType = string;
export interface ContextDataType {
/**
* Source IP address of your user.
*/
IpAddress: StringType;
/**
* Your server endpoint where this API is invoked.
*/
ServerName: StringType;
/**
* Your server path where this API is invoked.
*/
ServerPath: StringType;
/**
* HttpHeaders received on your server in same order.
*/
HttpHeaders: HttpHeaderList;
/**
* Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.
*/
EncodedData?: StringType;
}
export interface CreateGroupRequest {
/**
* The name of the group. Must be unique.
*/
GroupName: GroupNameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* A string containing the description of the group.
*/
Description?: DescriptionType;
/**
* The role ARN for the group.
*/
RoleArn?: ArnType;
/**
* A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. The default Precedence value is null.
*/
Precedence?: PrecedenceType;
}
export interface CreateGroupResponse {
/**
* The group object for the group.
*/
Group?: GroupType;
}
export interface CreateIdentityProviderRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The identity provider name.
*/
ProviderName: ProviderNameTypeV1;
/**
* The identity provider type.
*/
ProviderType: IdentityProviderTypeType;
/**
* The identity provider details, such as MetadataURL and MetadataFile.
*/
ProviderDetails: ProviderDetailsType;
/**
* A mapping of identity provider attributes to standard and custom user pool attributes.
*/
AttributeMapping?: AttributeMappingType;
/**
* A list of identity provider identifiers.
*/
IdpIdentifiers?: IdpIdentifiersListType;
}
export interface CreateIdentityProviderResponse {
/**
* The newly created identity provider object.
*/
IdentityProvider: IdentityProviderType;
}
export interface CreateResourceServerRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.
*/
Identifier: ResourceServerIdentifierType;
/**
* A friendly name for the resource server.
*/
Name: ResourceServerNameType;
/**
* A list of scopes. Each scope is map, where the keys are name and description.
*/
Scopes?: ResourceServerScopeListType;
}
export interface CreateResourceServerResponse {
/**
* The newly created resource server.
*/
ResourceServer: ResourceServerType;
}
export interface CreateUserImportJobRequest {
/**
* The job name for the user import job.
*/
JobName: UserImportJobNameType;
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId: UserPoolIdType;
/**
* The role ARN for the Amazon CloudWatch Logging role for the user import job.
*/
CloudWatchLogsRoleArn: ArnType;
}
export interface CreateUserImportJobResponse {
/**
* The job object that represents the user import job.
*/
UserImportJob?: UserImportJobType;
}
export interface CreateUserPoolClientRequest {
/**
* The user pool ID for the user pool where you want to create a user pool client.
*/
UserPoolId: UserPoolIdType;
/**
* The client name for the user pool client you would like to create.
*/
ClientName: ClientNameType;
/**
* Boolean to specify whether you want to generate a secret for the user pool client being created.
*/
GenerateSecret?: GenerateSecret;
/**
* The time limit, in days, after which the refresh token is no longer valid and cannot be used.
*/
RefreshTokenValidity?: RefreshTokenValidityType;
/**
* The read attributes.
*/
ReadAttributes?: ClientPermissionListType;
/**
* The user pool attributes that the app client can write to. If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
*/
WriteAttributes?: ClientPermissionListType;
/**
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix. Valid values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP based authentication. ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
*/
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
/**
* A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.
*/
SupportedIdentityProviders?: SupportedIdentityProvidersListType;
/**
* A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
CallbackURLs?: CallbackURLsListType;
/**
* A list of allowed logout URLs for the identity providers.
*/
LogoutURLs?: LogoutURLsListType;
/**
* The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
DefaultRedirectURI?: RedirectUrlType;
/**
* Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
*/
AllowedOAuthFlows?: OAuthFlowsType;
/**
* A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". In addition to these values, custom scopes created in Resource Servers are also supported.
*/
AllowedOAuthScopes?: ScopeListType;
/**
* Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
*/
AllowedOAuthFlowsUserPoolClient?: BooleanType;
/**
* The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
*/
AnalyticsConfiguration?: AnalyticsConfigurationType;
/**
* Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool. Valid values include: ENABLED - This prevents user existence-related errors. LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented. This setting affects the behavior of following APIs: AdminInitiateAuth AdminRespondToAuthChallenge InitiateAuth RespondToAuthChallenge ForgotPassword ConfirmForgotPassword ConfirmSignUp ResendConfirmationCode After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
*/
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
}
export interface CreateUserPoolClientResponse {
/**
* The user pool client that was just created.
*/
UserPoolClient?: UserPoolClientType;
}
export interface CreateUserPoolDomainRequest {
/**
* The domain string.
*/
Domain: DomainType;
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application. Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead. For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*/
CustomDomainConfig?: CustomDomainConfigType;
}
export interface CreateUserPoolDomainResponse {
/**
* The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.
*/
CloudFrontDomain?: DomainType;
}
export interface CreateUserPoolRequest {
/**
* A string used to name the user pool.
*/
PoolName: UserPoolNameType;
/**
* The policies associated with the new user pool.
*/
Policies?: UserPoolPolicyType;
/**
* The Lambda trigger configuration information for the new user pool. In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function. For more information on using the Lambda API to add permission, see AddPermission . For adding permission using the AWS CLI, see add-permission .
*/
LambdaConfig?: LambdaConfigType;
/**
* The attributes to be auto-verified. Possible values: email, phone_number.
*/
AutoVerifiedAttributes?: VerifiedAttributesListType;
/**
* Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
*/
AliasAttributes?: AliasAttributesListType;
/**
* Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
*/
UsernameAttributes?: UsernameAttributesListType;
/**
* A string representing the SMS verification message.
*/
SmsVerificationMessage?: SmsVerificationMessageType;
/**
* A string representing the email verification message.
*/
EmailVerificationMessage?: EmailVerificationMessageType;
/**
* A string representing the email verification subject.
*/
EmailVerificationSubject?: EmailVerificationSubjectType;
/**
* The template for the verification message that the user sees when the app requests permission to access the user's information.
*/
VerificationMessageTemplate?: VerificationMessageTemplateType;
/**
* A string representing the SMS authentication message.
*/
SmsAuthenticationMessage?: SmsVerificationMessageType;
/**
* Specifies MFA configuration details.
*/
MfaConfiguration?: UserPoolMfaType;
/**
* The device configuration.
*/
DeviceConfiguration?: DeviceConfigurationType;
/**
* The email configuration.
*/
EmailConfiguration?: EmailConfigurationType;
/**
* The SMS configuration.
*/
SmsConfiguration?: SmsConfigurationType;
/**
* The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
*/
UserPoolTags?: UserPoolTagsType;
/**
* The configuration for AdminCreateUser requests.
*/
AdminCreateUserConfig?: AdminCreateUserConfigType;
/**
* An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
*/
Schema?: SchemaAttributesListType;
/**
* Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
*/
UserPoolAddOns?: UserPoolAddOnsType;
}
export interface CreateUserPoolResponse {
/**
* A container for the user pool details.
*/
UserPool?: UserPoolType;
}
export type CustomAttributeNameType = string;
export type CustomAttributesListType = SchemaAttributeType[];
export interface CustomDomainConfigType {
/**
* The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.
*/
CertificateArn: ArnType;
}
export type DateType = Date;
export type DefaultEmailOptionType = "CONFIRM_WITH_LINK"|"CONFIRM_WITH_CODE"|string;
export interface DeleteGroupRequest {
/**
* The name of the group.
*/
GroupName: GroupNameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
}
export interface DeleteIdentityProviderRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The identity provider name.
*/
ProviderName: ProviderNameType;
}
export interface DeleteResourceServerRequest {
/**
* The user pool ID for the user pool that hosts the resource server.
*/
UserPoolId: UserPoolIdType;
/**
* The identifier for the resource server.
*/
Identifier: ResourceServerIdentifierType;
}
export interface DeleteUserAttributesRequest {
/**
* An array of strings representing the user attribute names you wish to delete. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributeNames: AttributeNameListType;
/**
* The access token used in the request to delete user attributes.
*/
AccessToken: TokenModelType;
}
export interface DeleteUserAttributesResponse {
}
export interface DeleteUserPoolClientRequest {
/**
* The user pool ID for the user pool where you want to delete the client.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID of the app associated with the user pool.
*/
ClientId: ClientIdType;
}
export interface DeleteUserPoolDomainRequest {
/**
* The domain string.
*/
Domain: DomainType;
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
}
export interface DeleteUserPoolDomainResponse {
}
export interface DeleteUserPoolRequest {
/**
* The user pool ID for the user pool you want to delete.
*/
UserPoolId: UserPoolIdType;
}
export interface DeleteUserRequest {
/**
* The access token from a request to delete a user.
*/
AccessToken: TokenModelType;
}
export type DeliveryMediumListType = DeliveryMediumType[];
export type DeliveryMediumType = "SMS"|"EMAIL"|string;
export interface DescribeIdentityProviderRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The identity provider name.
*/
ProviderName: ProviderNameType;
}
export interface DescribeIdentityProviderResponse {
/**
* The identity provider that was deleted.
*/
IdentityProvider: IdentityProviderType;
}
export interface DescribeResourceServerRequest {
/**
* The user pool ID for the user pool that hosts the resource server.
*/
UserPoolId: UserPoolIdType;
/**
* The identifier for the resource server
*/
Identifier: ResourceServerIdentifierType;
}
export interface DescribeResourceServerResponse {
/**
* The resource server.
*/
ResourceServer: ResourceServerType;
}
export interface DescribeRiskConfigurationRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID.
*/
ClientId?: ClientIdType;
}
export interface DescribeRiskConfigurationResponse {
/**
* The risk configuration.
*/
RiskConfiguration: RiskConfigurationType;
}
export interface DescribeUserImportJobRequest {
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId: UserPoolIdType;
/**
* The job ID for the user import job.
*/
JobId: UserImportJobIdType;
}
export interface DescribeUserImportJobResponse {
/**
* The job object that represents the user import job.
*/
UserImportJob?: UserImportJobType;
}
export interface DescribeUserPoolClientRequest {
/**
* The user pool ID for the user pool you want to describe.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID of the app associated with the user pool.
*/
ClientId: ClientIdType;
}
export interface DescribeUserPoolClientResponse {
/**
* The user pool client from a server response to describe the user pool client.
*/
UserPoolClient?: UserPoolClientType;
}
export interface DescribeUserPoolDomainRequest {
/**
* The domain string.
*/
Domain: DomainType;
}
export interface DescribeUserPoolDomainResponse {
/**
* A domain description object containing information about the domain.
*/
DomainDescription?: DomainDescriptionType;
}
export interface DescribeUserPoolRequest {
/**
* The user pool ID for the user pool you want to describe.
*/
UserPoolId: UserPoolIdType;
}
export interface DescribeUserPoolResponse {
/**
* The container of metadata returned by the server to describe the pool.
*/
UserPool?: UserPoolType;
}
export type DescriptionType = string;
export interface DeviceConfigurationType {
/**
* Indicates whether a challenge is required on a new device. Only applicable to a new device.
*/
ChallengeRequiredOnNewDevice?: BooleanType;
/**
* If true, a device is only remembered on user prompt.
*/
DeviceOnlyRememberedOnUserPrompt?: BooleanType;
}
export type DeviceKeyType = string;
export type DeviceListType = DeviceType[];
export type DeviceNameType = string;
export type DeviceRememberedStatusType = "remembered"|"not_remembered"|string;
export interface DeviceSecretVerifierConfigType {
/**
* The password verifier.
*/
PasswordVerifier?: StringType;
/**
* The salt.
*/
Salt?: StringType;
}
export interface DeviceType {
/**
* The device key.
*/
DeviceKey?: DeviceKeyType;
/**
* The device attributes.
*/
DeviceAttributes?: AttributeListType;
/**
* The creation date of the device.
*/
DeviceCreateDate?: DateType;
/**
* The last modified date of the device.
*/
DeviceLastModifiedDate?: DateType;
/**
* The date in which the device was last authenticated.
*/
DeviceLastAuthenticatedDate?: DateType;
}
export interface DomainDescriptionType {
/**
* The user pool ID.
*/
UserPoolId?: UserPoolIdType;
/**
* The AWS account ID for the user pool owner.
*/
AWSAccountId?: AWSAccountIdType;
/**
* The domain string.
*/
Domain?: DomainType;
/**
* The S3 bucket where the static files for this domain are stored.
*/
S3Bucket?: S3BucketType;
/**
* The ARN of the CloudFront distribution.
*/
CloudFrontDistribution?: StringType;
/**
* The app version.
*/
Version?: DomainVersionType;
/**
* The domain status.
*/
Status?: DomainStatusType;
/**
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*/
CustomDomainConfig?: CustomDomainConfigType;
}
export type DomainStatusType = "CREATING"|"DELETING"|"UPDATING"|"ACTIVE"|"FAILED"|string;
export type DomainType = string;
export type DomainVersionType = string;
export type EmailAddressType = string;
export interface EmailConfigurationType {
/**
* The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter: If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account. If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.
*/
SourceArn?: ArnType;
/**
* The destination to which the receiver of the email should reply to.
*/
ReplyToEmailAddress?: EmailAddressType;
/**
* Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values: COGNITO_DEFAULT When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration. To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide. The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter. DEVELOPER When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account. If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter. Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
*/
EmailSendingAccount?: EmailSendingAccountType;
/**
* Identifies either the sender’s email address or the sender’s name with their email address. For example, testuser@example.com or Test User <testuser@example.com>. This address will appear before the body of the email.
*/
From?: StringType;
/**
* The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is applied to an email by including a reference to the configuration set in the headers of the email. Once applied, all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the following types of rules to emails: Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events for each email sent. Use event publishing to send information about these events to other AWS services such as SNS and CloudWatch. IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses, called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
*/
ConfigurationSet?: SESConfigurationSet;
}
export type EmailNotificationBodyType = string;
export type EmailNotificationSubjectType = string;
export type EmailSendingAccountType = "COGNITO_DEFAULT"|"DEVELOPER"|string;
export type EmailVerificationMessageByLinkType = string;
export type EmailVerificationMessageType = string;
export type EmailVerificationSubjectByLinkType = string;
export type EmailVerificationSubjectType = string;
export interface EventContextDataType {
/**
* The user's IP address.
*/
IpAddress?: StringType;
/**
* The user's device name.
*/
DeviceName?: StringType;
/**
* The user's time zone.
*/
Timezone?: StringType;
/**
* The user's city.
*/
City?: StringType;
/**
* The user's country.
*/
Country?: StringType;
}
export interface EventFeedbackType {
/**
* The event feedback value.
*/
FeedbackValue: FeedbackValueType;
/**
* The provider.
*/
Provider: StringType;
/**
* The event feedback date.
*/
FeedbackDate?: DateType;
}
export type EventFilterType = "SIGN_IN"|"PASSWORD_CHANGE"|"SIGN_UP"|string;
export type EventFiltersType = EventFilterType[];
export type EventIdType = string;
export type EventResponseType = "Success"|"Failure"|string;
export interface EventRiskType {
/**
* The risk decision.
*/
RiskDecision?: RiskDecisionType;
/**
* The risk level.
*/
RiskLevel?: RiskLevelType;
}
export type EventType = "SignIn"|"SignUp"|"ForgotPassword"|string;
export type ExplicitAuthFlowsListType = ExplicitAuthFlowsType[];
export type ExplicitAuthFlowsType = "ADMIN_NO_SRP_AUTH"|"CUSTOM_AUTH_FLOW_ONLY"|"USER_PASSWORD_AUTH"|"ALLOW_ADMIN_USER_PASSWORD_AUTH"|"ALLOW_CUSTOM_AUTH"|"ALLOW_USER_PASSWORD_AUTH"|"ALLOW_USER_SRP_AUTH"|"ALLOW_REFRESH_TOKEN_AUTH"|string;
export type FeedbackValueType = "Valid"|"Invalid"|string;
export type ForceAliasCreation = boolean;
export interface ForgetDeviceRequest {
/**
* The access token for the forgotten device request.
*/
AccessToken?: TokenModelType;
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
}
export interface ForgotPasswordRequest {
/**
* The ID of the client associated with the user pool.
*/
ClientId: ClientIdType;
/**
* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
*/
SecretHash?: SecretHashType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* The user name of the user for whom you want to enter a code to reset a forgotten password.
*/
Username: UsernameType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface ForgotPasswordResponse {
/**
* The code delivery details returned by the server in response to the request to reset a password.
*/
CodeDeliveryDetails?: CodeDeliveryDetailsType;
}
export type GenerateSecret = boolean;
export interface GetCSVHeaderRequest {
/**
* The user pool ID for the user pool that the users are to be imported into.
*/
UserPoolId: UserPoolIdType;
}
export interface GetCSVHeaderResponse {
/**
* The user pool ID for the user pool that the users are to be imported into.
*/
UserPoolId?: UserPoolIdType;
/**
* The header information for the .csv file for the user import job.
*/
CSVHeader?: ListOfStringTypes;
}
export interface GetDeviceRequest {
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
/**
* The access token.
*/
AccessToken?: TokenModelType;
}
export interface GetDeviceResponse {
/**
* The device.
*/
Device: DeviceType;
}
export interface GetGroupRequest {
/**
* The name of the group.
*/
GroupName: GroupNameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
}
export interface GetGroupResponse {
/**
* The group object for the group.
*/
Group?: GroupType;
}
export interface GetIdentityProviderByIdentifierRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The identity provider ID.
*/
IdpIdentifier: IdpIdentifierType;
}
export interface GetIdentityProviderByIdentifierResponse {
/**
* The identity provider object.
*/
IdentityProvider: IdentityProviderType;
}
export interface GetSigningCertificateRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
}
export interface GetSigningCertificateResponse {
/**
* The signing certificate.
*/
Certificate?: StringType;
}
export interface GetUICustomizationRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The client ID for the client app.
*/
ClientId?: ClientIdType;
}
export interface GetUICustomizationResponse {
/**
* The UI customization information.
*/
UICustomization: UICustomizationType;
}
export interface GetUserAttributeVerificationCodeRequest {
/**
* The access token returned by the server response to get the user attribute verification code.
*/
AccessToken: TokenModelType;
/**
* The attribute name returned by the server response to get the user attribute verification code.
*/
AttributeName: AttributeNameType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface GetUserAttributeVerificationCodeResponse {
/**
* The code delivery details returned by the server in response to the request to get the user attribute verification code.
*/
CodeDeliveryDetails?: CodeDeliveryDetailsType;
}
export interface GetUserPoolMfaConfigRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
}
export interface GetUserPoolMfaConfigResponse {
/**
* The SMS text message multi-factor (MFA) configuration.
*/
SmsMfaConfiguration?: SmsMfaConfigType;
/**
* The software token multi-factor (MFA) configuration.
*/
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
/**
* The multi-factor (MFA) configuration. Valid values include: OFF MFA will not be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
*/
MfaConfiguration?: UserPoolMfaType;
}
export interface GetUserRequest {
/**
* The access token returned by the server response to get information about the user.
*/
AccessToken: TokenModelType;
}
export interface GetUserResponse {
/**
* The user name of the user you wish to retrieve from the get user request.
*/
Username: UsernameType;
/**
* An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributes: AttributeListType;
/**
* This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.
*/
MFAOptions?: MFAOptionListType;
/**
* The user's preferred MFA setting.
*/
PreferredMfaSetting?: StringType;
/**
* The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
*/
UserMFASettingList?: UserMFASettingListType;
}
export interface GlobalSignOutRequest {
/**
* The access token.
*/
AccessToken: TokenModelType;
}
export interface GlobalSignOutResponse {
}
export type GroupListType = GroupType[];
export type GroupNameType = string;
export interface GroupType {
/**
* The name of the group.
*/
GroupName?: GroupNameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId?: UserPoolIdType;
/**
* A string containing the description of the group.
*/
Description?: DescriptionType;
/**
* The role ARN for the group.
*/
RoleArn?: ArnType;
/**
* A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values. Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens. The default Precedence value is null.
*/
Precedence?: PrecedenceType;
/**
* The date the group was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the group was created.
*/
CreationDate?: DateType;
}
export type HexStringType = string;
export interface HttpHeader {
/**
* The header name
*/
headerName?: StringType;
/**
* The header value.
*/
headerValue?: StringType;
}
export type HttpHeaderList = HttpHeader[];
export interface IdentityProviderType {
/**
* The user pool ID.
*/
UserPoolId?: UserPoolIdType;
/**
* The identity provider name.
*/
ProviderName?: ProviderNameType;
/**
* The identity provider type.
*/
ProviderType?: IdentityProviderTypeType;
/**
* The identity provider details, such as MetadataURL and MetadataFile.
*/
ProviderDetails?: ProviderDetailsType;
/**
* A mapping of identity provider attributes to standard and custom user pool attributes.
*/
AttributeMapping?: AttributeMappingType;
/**
* A list of identity provider identifiers.
*/
IdpIdentifiers?: IdpIdentifiersListType;
/**
* The date the identity provider was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the identity provider was created.
*/
CreationDate?: DateType;
}
export type IdentityProviderTypeType = "SAML"|"Facebook"|"Google"|"LoginWithAmazon"|"OIDC"|string;
export type IdpIdentifierType = string;
export type IdpIdentifiersListType = IdpIdentifierType[];
export type ImageFileType = Buffer|Uint8Array|Blob|string;
export type ImageUrlType = string;
export interface InitiateAuthRequest {
/**
* The authentication flow for this call to execute. The API action will depend on this value. For example: REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens. USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution. USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens. Valid values include: USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol. REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token. CUSTOM_AUTH: Custom authentication flow. USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool. ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request instead of using the SRP process to verify passwords. ADMIN_NO_SRP_AUTH is not a valid value.
*/
AuthFlow: AuthFlowType;
/**
* The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow: For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY
*/
AuthParameters?: AuthParametersType;
/**
* A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers: Pre signup Pre authentication User migration When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs. When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input: Post authentication Custom message Pre token generation Create auth challenge Define auth challenge Verify auth challenge For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
/**
* The app client ID.
*/
ClientId: ClientIdType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
}
export interface InitiateAuthResponse {
/**
* The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge. Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters. SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS. PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations. CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued. DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device. DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only. NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
*/
ChallengeName?: ChallengeNameType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge). All challenges require USERNAME and SECRET_HASH (if applicable).
*/
ChallengeParameters?: ChallengeParametersType;
/**
* The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.
*/
AuthenticationResult?: AuthenticationResultType;
}
export type IntegerType = number;
export interface LambdaConfigType {
/**
* A pre-registration AWS Lambda trigger.
*/
PreSignUp?: ArnType;
/**
* A custom Message AWS Lambda trigger.
*/
CustomMessage?: ArnType;
/**
* A post-confirmation AWS Lambda trigger.
*/
PostConfirmation?: ArnType;
/**
* A pre-authentication AWS Lambda trigger.
*/
PreAuthentication?: ArnType;
/**
* A post-authentication AWS Lambda trigger.
*/
PostAuthentication?: ArnType;
/**
* Defines the authentication challenge.
*/
DefineAuthChallenge?: ArnType;
/**
* Creates an authentication challenge.
*/
CreateAuthChallenge?: ArnType;
/**
* Verifies the authentication challenge response.
*/
VerifyAuthChallengeResponse?: ArnType;
/**
* A Lambda trigger that is invoked before token generation.
*/
PreTokenGeneration?: ArnType;
/**
* The user migration Lambda config type.
*/
UserMigration?: ArnType;
}
export interface ListDevicesRequest {
/**
* The access tokens for the request to list devices.
*/
AccessToken: TokenModelType;
/**
* The limit of the device request.
*/
Limit?: QueryLimitType;
/**
* The pagination token for the list request.
*/
PaginationToken?: SearchPaginationTokenType;
}
export interface ListDevicesResponse {
/**
* The devices returned in the list devices response.
*/
Devices?: DeviceListType;
/**
* The pagination token for the list device response.
*/
PaginationToken?: SearchPaginationTokenType;
}
export interface ListGroupsRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The limit of the request to list groups.
*/
Limit?: QueryLimitType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListGroupsResponse {
/**
* The group objects for the groups.
*/
Groups?: GroupListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListIdentityProvidersRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The maximum number of identity providers to return.
*/
MaxResults?: ListProvidersLimitType;
/**
* A pagination token.
*/
NextToken?: PaginationKeyType;
}
export interface ListIdentityProvidersResponse {
/**
* A list of identity provider objects.
*/
Providers: ProvidersListType;
/**
* A pagination token.
*/
NextToken?: PaginationKeyType;
}
export type ListOfStringTypes = StringType[];
export type ListProvidersLimitType = number;
export type ListResourceServersLimitType = number;
export interface ListResourceServersRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The maximum number of resource servers to return.
*/
MaxResults?: ListResourceServersLimitType;
/**
* A pagination token.
*/
NextToken?: PaginationKeyType;
}
export interface ListResourceServersResponse {
/**
* The resource servers.
*/
ResourceServers: ResourceServersListType;
/**
* A pagination token.
*/
NextToken?: PaginationKeyType;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
*/
ResourceArn: ArnType;
}
export interface ListTagsForResourceResponse {
/**
* The tags that are assigned to the user pool.
*/
Tags?: UserPoolTagsType;
}
export interface ListUserImportJobsRequest {
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId: UserPoolIdType;
/**
* The maximum number of import jobs you want the request to return.
*/
MaxResults: PoolQueryLimitType;
/**
* An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.
*/
PaginationToken?: PaginationKeyType;
}
export interface ListUserImportJobsResponse {
/**
* The user import jobs.
*/
UserImportJobs?: UserImportJobsListType;
/**
* An identifier that can be used to return the next set of user import jobs in the list.
*/
PaginationToken?: PaginationKeyType;
}
export interface ListUserPoolClientsRequest {
/**
* The user pool ID for the user pool where you want to list user pool clients.
*/
UserPoolId: UserPoolIdType;
/**
* The maximum number of results you want the request to return when listing the user pool clients.
*/
MaxResults?: QueryLimit;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListUserPoolClientsResponse {
/**
* The user pool clients in the response that lists user pool clients.
*/
UserPoolClients?: UserPoolClientListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListUserPoolsRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKeyType;
/**
* The maximum number of results you want the request to return when listing the user pools.
*/
MaxResults: PoolQueryLimitType;
}
export interface ListUserPoolsResponse {
/**
* The user pools from the response to list users.
*/
UserPools?: UserPoolListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKeyType;
}
export interface ListUsersInGroupRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The name of the group.
*/
GroupName: GroupNameType;
/**
* The limit of the request to list users.
*/
Limit?: QueryLimitType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListUsersInGroupResponse {
/**
* The users returned in the request to list users.
*/
Users?: UsersListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
NextToken?: PaginationKey;
}
export interface ListUsersRequest {
/**
* The user pool ID for the user pool on which the search should be performed.
*/
UserPoolId: UserPoolIdType;
/**
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.
*/
AttributesToGet?: SearchedAttributeNamesListType;
/**
* Maximum number of users to be returned.
*/
Limit?: QueryLimitType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
PaginationToken?: SearchPaginationTokenType;
/**
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks within the filter string must be escaped using the backslash (\) character. For example, "family_name = \"Reddy\"". AttributeName: The name of the attribute to search for. You can only search for one attribute at a time. Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"". AttributeValue: The attribute value that must be matched for each user. If the filter string is empty, ListUsers returns all users in the user pool. You can only search for the following standard attributes: username (case-sensitive) email phone_number name given_name family_name preferred_username cognito:user_status (called Status in the Console) (case-insensitive) status (called Enabled in the Console) (case-sensitive) sub Custom attributes are not searchable. For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*/
Filter?: UserFilterType;
}
export interface ListUsersResponse {
/**
* The users returned in the request to list users.
*/
Users?: UsersListType;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
PaginationToken?: SearchPaginationTokenType;
}
export type LogoutURLsListType = RedirectUrlType[];
export type LongType = number;
export type MFAOptionListType = MFAOptionType[];
export interface MFAOptionType {
/**
* The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.
*/
DeliveryMedium?: DeliveryMediumType;
/**
* The attribute name of the MFA option type. The only valid value is phone_number.
*/
AttributeName?: AttributeNameType;
}
export type MessageActionType = "RESEND"|"SUPPRESS"|string;
export interface MessageTemplateType {
/**
* The message template for SMS messages.
*/
SMSMessage?: SmsVerificationMessageType;
/**
* The message template for email messages.
*/
EmailMessage?: EmailVerificationMessageType;
/**
* The subject line for email messages.
*/
EmailSubject?: EmailVerificationSubjectType;
}
export interface NewDeviceMetadataType {
/**
* The device key.
*/
DeviceKey?: DeviceKeyType;
/**
* The device group key.
*/
DeviceGroupKey?: StringType;
}
export interface NotifyConfigurationType {
/**
* The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.
*/
From?: StringType;
/**
* The destination to which the receiver of an email should reply to.
*/
ReplyTo?: StringType;
/**
* The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter.
*/
SourceArn: ArnType;
/**
* Email template used when a detected risk event is blocked.
*/
BlockEmail?: NotifyEmailType;
/**
* The email template used when a detected risk event is allowed.
*/
NoActionEmail?: NotifyEmailType;
/**
* The MFA email template used when MFA is challenged as part of a detected risk.
*/
MfaEmail?: NotifyEmailType;
}
export interface NotifyEmailType {
/**
* The subject.
*/
Subject: EmailNotificationSubjectType;
/**
* The HTML body.
*/
HtmlBody?: EmailNotificationBodyType;
/**
* The text body.
*/
TextBody?: EmailNotificationBodyType;
}
export interface NumberAttributeConstraintsType {
/**
* The minimum value of an attribute that is of the number data type.
*/
MinValue?: StringType;
/**
* The maximum value of an attribute that is of the number data type.
*/
MaxValue?: StringType;
}
export type OAuthFlowType = "code"|"implicit"|"client_credentials"|string;
export type OAuthFlowsType = OAuthFlowType[];
export type PaginationKey = string;
export type PaginationKeyType = string;
export type PasswordPolicyMinLengthType = number;
export interface PasswordPolicyType {
/**
* The minimum length of the password policy that you have set. Cannot be less than 6.
*/
MinimumLength?: PasswordPolicyMinLengthType;
/**
* In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
*/
RequireUppercase?: BooleanType;
/**
* In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
*/
RequireLowercase?: BooleanType;
/**
* In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
*/
RequireNumbers?: BooleanType;
/**
* In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
*/
RequireSymbols?: BooleanType;
/**
* In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator. When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool.
*/
TemporaryPasswordValidityDays?: TemporaryPasswordValidityDaysType;
}
export type PasswordType = string;
export type PoolQueryLimitType = number;
export type PreSignedUrlType = string;
export type PrecedenceType = number;
export type PreventUserExistenceErrorTypes = "LEGACY"|"ENABLED"|string;
export interface ProviderDescription {
/**
* The identity provider name.
*/
ProviderName?: ProviderNameType;
/**
* The identity provider type.
*/
ProviderType?: IdentityProviderTypeType;
/**
* The date the provider was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the provider was added to the user pool.
*/
CreationDate?: DateType;
}
export type ProviderDetailsType = {[key: string]: StringType};
export type ProviderNameType = string;
export type ProviderNameTypeV1 = string;
export interface ProviderUserIdentifierType {
/**
* The name of the provider, for example, Facebook, Google, or Login with Amazon.
*/
ProviderName?: ProviderNameType;
/**
* The name of the provider attribute to link to, for example, NameID.
*/
ProviderAttributeName?: StringType;
/**
* The value of the provider attribute to link to, for example, xxxxx_account.
*/
ProviderAttributeValue?: StringType;
}
export type ProvidersListType = ProviderDescription[];
export type QueryLimit = number;
export type QueryLimitType = number;
export type RedirectUrlType = string;
export type RefreshTokenValidityType = number;
export interface ResendConfirmationCodeRequest {
/**
* The ID of the client associated with the user pool.
*/
ClientId: ClientIdType;
/**
* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
*/
SecretHash?: SecretHashType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* The user name of the user to whom you wish to resend a confirmation code.
*/
Username: UsernameType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface ResendConfirmationCodeResponse {
/**
* The code delivery details returned by the server in response to the request to resend the confirmation code.
*/
CodeDeliveryDetails?: CodeDeliveryDetailsType;
}
export type ResourceServerIdentifierType = string;
export type ResourceServerNameType = string;
export type ResourceServerScopeDescriptionType = string;
export type ResourceServerScopeListType = ResourceServerScopeType[];
export type ResourceServerScopeNameType = string;
export interface ResourceServerScopeType {
/**
* The name of the scope.
*/
ScopeName: ResourceServerScopeNameType;
/**
* A description of the scope.
*/
ScopeDescription: ResourceServerScopeDescriptionType;
}
export interface ResourceServerType {
/**
* The user pool ID for the user pool that hosts the resource server.
*/
UserPoolId?: UserPoolIdType;
/**
* The identifier for the resource server.
*/
Identifier?: ResourceServerIdentifierType;
/**
* The name of the resource server.
*/
Name?: ResourceServerNameType;
/**
* A list of scopes that are defined for the resource server.
*/
Scopes?: ResourceServerScopeListType;
}
export type ResourceServersListType = ResourceServerType[];
export interface RespondToAuthChallengeRequest {
/**
* The app client ID.
*/
ClientId: ClientIdType;
/**
* The challenge name. For more information, see . ADMIN_NO_SRP_AUTH is not a valid value.
*/
ChallengeName: ChallengeNameType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The challenge responses. These are inputs corresponding to the value of ChallengeName, for example: SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA). SMS_MFA: SMS_MFA_CODE, USERNAME. PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME. NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME. SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes. DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH). DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.
*/
ChallengeResponses?: ChallengeResponsesType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface RespondToAuthChallengeResponse {
/**
* The challenge name. For more information, see .
*/
ChallengeName?: ChallengeNameType;
/**
* The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
*/
Session?: SessionType;
/**
* The challenge parameters. For more information, see .
*/
ChallengeParameters?: ChallengeParametersType;
/**
* The result returned by the server in response to the request to respond to the authentication challenge.
*/
AuthenticationResult?: AuthenticationResultType;
}
export interface RiskConfigurationType {
/**
* The user pool ID.
*/
UserPoolId?: UserPoolIdType;
/**
* The app client ID.
*/
ClientId?: ClientIdType;
/**
* The compromised credentials risk configuration object including the EventFilter and the EventAction
*/
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
/**
* The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover.
*/
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
/**
* The configuration to override the risk decision.
*/
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
/**
* The last modified date.
*/
LastModifiedDate?: DateType;
}
export type RiskDecisionType = "NoRisk"|"AccountTakeover"|"Block"|string;
export interface RiskExceptionConfigurationType {
/**
* Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.
*/
BlockedIPRangeList?: BlockedIPRangeListType;
/**
* Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.
*/
SkippedIPRangeList?: SkippedIPRangeListType;
}
export type RiskLevelType = "Low"|"Medium"|"High"|string;
export type S3BucketType = string;
export type SESConfigurationSet = string;
export interface SMSMfaSettingsType {
/**
* Specifies whether SMS text message MFA is enabled.
*/
Enabled?: BooleanType;
/**
* Specifies whether SMS is the preferred MFA method.
*/
PreferredMfa?: BooleanType;
}
export interface SchemaAttributeType {
/**
* A schema attribute of the name type.
*/
Name?: CustomAttributeNameType;
/**
* The attribute data type.
*/
AttributeDataType?: AttributeDataType;
/**
* Specifies whether the attribute type is developer only.
*/
DeveloperOnlyAttribute?: BooleanType;
/**
* Specifies whether the value of the attribute can be changed. For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
*/
Mutable?: BooleanType;
/**
* Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
*/
Required?: BooleanType;
/**
* Specifies the constraints for an attribute of the number type.
*/
NumberAttributeConstraints?: NumberAttributeConstraintsType;
/**
* Specifies the constraints for an attribute of the string type.
*/
StringAttributeConstraints?: StringAttributeConstraintsType;
}
export type SchemaAttributesListType = SchemaAttributeType[];
export type ScopeListType = ScopeType[];
export type ScopeType = string;
export type SearchPaginationTokenType = string;
export type SearchedAttributeNamesListType = AttributeNameType[];
export type SecretCodeType = string;
export type SecretHashType = string;
export type SessionType = string;
export interface SetRiskConfigurationRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool. Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool configuration is overridden and the risk configuration for the client is used instead.
*/
ClientId?: ClientIdType;
/**
* The compromised credentials risk configuration.
*/
CompromisedCredentialsRiskConfiguration?: CompromisedCredentialsRiskConfigurationType;
/**
* The account takeover risk configuration.
*/
AccountTakeoverRiskConfiguration?: AccountTakeoverRiskConfigurationType;
/**
* The configuration to override the risk decision.
*/
RiskExceptionConfiguration?: RiskExceptionConfigurationType;
}
export interface SetRiskConfigurationResponse {
/**
* The risk configuration.
*/
RiskConfiguration: RiskConfigurationType;
}
export interface SetUICustomizationRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The client ID for the client app.
*/
ClientId?: ClientIdType;
/**
* The CSS values in the UI customization.
*/
CSS?: CSSType;
/**
* The uploaded logo image for the UI customization.
*/
ImageFile?: ImageFileType;
}
export interface SetUICustomizationResponse {
/**
* The UI customization information.
*/
UICustomization: UICustomizationType;
}
export interface SetUserMFAPreferenceRequest {
/**
* The SMS text message multi-factor authentication (MFA) settings.
*/
SMSMfaSettings?: SMSMfaSettingsType;
/**
* The time-based one-time password software token MFA settings.
*/
SoftwareTokenMfaSettings?: SoftwareTokenMfaSettingsType;
/**
* The access token for the user.
*/
AccessToken: TokenModelType;
}
export interface SetUserMFAPreferenceResponse {
}
export interface SetUserPoolMfaConfigRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The SMS text message MFA configuration.
*/
SmsMfaConfiguration?: SmsMfaConfigType;
/**
* The software token MFA configuration.
*/
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
/**
* The MFA configuration. Valid values include: OFF MFA will not be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
*/
MfaConfiguration?: UserPoolMfaType;
}
export interface SetUserPoolMfaConfigResponse {
/**
* The SMS text message MFA configuration.
*/
SmsMfaConfiguration?: SmsMfaConfigType;
/**
* The software token MFA configuration.
*/
SoftwareTokenMfaConfiguration?: SoftwareTokenMfaConfigType;
/**
* The MFA configuration. Valid values include: OFF MFA will not be used for any users. ON MFA is required for all users to sign in. OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
*/
MfaConfiguration?: UserPoolMfaType;
}
export interface SetUserSettingsRequest {
/**
* The access token for the set user settings request.
*/
AccessToken: TokenModelType;
/**
* You can use this parameter only to set an SMS configuration that uses SMS for delivery.
*/
MFAOptions: MFAOptionListType;
}
export interface SetUserSettingsResponse {
}
export interface SignUpRequest {
/**
* The ID of the client associated with the user pool.
*/
ClientId: ClientIdType;
/**
* A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
*/
SecretHash?: SecretHashType;
/**
* The user name of the user you wish to register.
*/
Username: UsernameType;
/**
* The password of the user you wish to register.
*/
Password: PasswordType;
/**
* An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributes?: AttributeListType;
/**
* The validation data in the request to register a user.
*/
ValidationData?: AttributeListType;
/**
* The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
*/
AnalyticsMetadata?: AnalyticsMetadataType;
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
UserContextData?: UserContextDataType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface SignUpResponse {
/**
* A response from the server indicating that a user registration has been confirmed.
*/
UserConfirmed: BooleanType;
/**
* The code delivery details returned by the server response to the user registration request.
*/
CodeDeliveryDetails?: CodeDeliveryDetailsType;
/**
* The UUID of the authenticated user. This is not the same as username.
*/
UserSub: StringType;
}
export type SkippedIPRangeListType = StringType[];
export interface SmsConfigurationType {
/**
* The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.
*/
SnsCallerArn: ArnType;
/**
* The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.
*/
ExternalId?: StringType;
}
export interface SmsMfaConfigType {
/**
* The SMS authentication message that will be sent to users with the code they need to sign in. The message must contain the ‘{####}’ placeholder, which will be replaced with the code. If the message is not included, and default message will be used.
*/
SmsAuthenticationMessage?: SmsVerificationMessageType;
/**
* The SMS configuration.
*/
SmsConfiguration?: SmsConfigurationType;
}
export type SmsVerificationMessageType = string;
export type SoftwareTokenMFAUserCodeType = string;
export interface SoftwareTokenMfaConfigType {
/**
* Specifies whether software token MFA is enabled.
*/
Enabled?: BooleanType;
}
export interface SoftwareTokenMfaSettingsType {
/**
* Specifies whether software token MFA is enabled.
*/
Enabled?: BooleanType;
/**
* Specifies whether software token MFA is the preferred MFA method.
*/
PreferredMfa?: BooleanType;
}
export interface StartUserImportJobRequest {
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId: UserPoolIdType;
/**
* The job ID for the user import job.
*/
JobId: UserImportJobIdType;
}
export interface StartUserImportJobResponse {
/**
* The job object that represents the user import job.
*/
UserImportJob?: UserImportJobType;
}
export type StatusType = "Enabled"|"Disabled"|string;
export interface StopUserImportJobRequest {
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId: UserPoolIdType;
/**
* The job ID for the user import job.
*/
JobId: UserImportJobIdType;
}
export interface StopUserImportJobResponse {
/**
* The job object that represents the user import job.
*/
UserImportJob?: UserImportJobType;
}
export interface StringAttributeConstraintsType {
/**
* The minimum length.
*/
MinLength?: StringType;
/**
* The maximum length.
*/
MaxLength?: StringType;
}
export type StringType = string;
export type SupportedIdentityProvidersListType = ProviderNameType[];
export type TagKeysType = string;
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the user pool to assign the tags to.
*/
ResourceArn: ArnType;
/**
* The tags to assign to the user pool.
*/
Tags: UserPoolTagsType;
}
export interface TagResourceResponse {
}
export type TagValueType = string;
export type TemporaryPasswordValidityDaysType = number;
export type TokenModelType = string;
export interface UICustomizationType {
/**
* The user pool ID for the user pool.
*/
UserPoolId?: UserPoolIdType;
/**
* The client ID for the client app.
*/
ClientId?: ClientIdType;
/**
* The logo image for the UI customization.
*/
ImageUrl?: ImageUrlType;
/**
* The CSS values in the UI customization.
*/
CSS?: CSSType;
/**
* The CSS version number.
*/
CSSVersion?: CSSVersionType;
/**
* The last-modified date for the UI customization.
*/
LastModifiedDate?: DateType;
/**
* The creation date for the UI customization.
*/
CreationDate?: DateType;
}
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
*/
ResourceArn: ArnType;
/**
* The keys of the tags to remove from the user pool.
*/
TagKeys: UserPoolTagsListType;
}
export interface UntagResourceResponse {
}
export interface UpdateAuthEventFeedbackRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The user pool username.
*/
Username: UsernameType;
/**
* The event ID.
*/
EventId: EventIdType;
/**
* The feedback token.
*/
FeedbackToken: TokenModelType;
/**
* The authentication event feedback value.
*/
FeedbackValue: FeedbackValueType;
}
export interface UpdateAuthEventFeedbackResponse {
}
export interface UpdateDeviceStatusRequest {
/**
* The access token.
*/
AccessToken: TokenModelType;
/**
* The device key.
*/
DeviceKey: DeviceKeyType;
/**
* The status of whether a device is remembered.
*/
DeviceRememberedStatus?: DeviceRememberedStatusType;
}
export interface UpdateDeviceStatusResponse {
}
export interface UpdateGroupRequest {
/**
* The name of the group.
*/
GroupName: GroupNameType;
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* A string containing the new description of the group.
*/
Description?: DescriptionType;
/**
* The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
*/
RoleArn?: ArnType;
/**
* The new precedence value for the group. For more information about this parameter, see .
*/
Precedence?: PrecedenceType;
}
export interface UpdateGroupResponse {
/**
* The group object for the group.
*/
Group?: GroupType;
}
export interface UpdateIdentityProviderRequest {
/**
* The user pool ID.
*/
UserPoolId: UserPoolIdType;
/**
* The identity provider name.
*/
ProviderName: ProviderNameType;
/**
* The identity provider details to be updated, such as MetadataURL and MetadataFile.
*/
ProviderDetails?: ProviderDetailsType;
/**
* The identity provider attribute mapping to be changed.
*/
AttributeMapping?: AttributeMappingType;
/**
* A list of identity provider identifiers.
*/
IdpIdentifiers?: IdpIdentifiersListType;
}
export interface UpdateIdentityProviderResponse {
/**
* The identity provider object.
*/
IdentityProvider: IdentityProviderType;
}
export interface UpdateResourceServerRequest {
/**
* The user pool ID for the user pool.
*/
UserPoolId: UserPoolIdType;
/**
* The identifier for the resource server.
*/
Identifier: ResourceServerIdentifierType;
/**
* The name of the resource server.
*/
Name: ResourceServerNameType;
/**
* The scope values to be set for the resource server.
*/
Scopes?: ResourceServerScopeListType;
}
export interface UpdateResourceServerResponse {
/**
* The resource server.
*/
ResourceServer: ResourceServerType;
}
export interface UpdateUserAttributesRequest {
/**
* An array of name-value pairs representing user attributes. For custom attributes, you must prepend the custom: prefix to the attribute name.
*/
UserAttributes: AttributeListType;
/**
* The access token for the request to update user attributes.
*/
AccessToken: TokenModelType;
/**
* A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers. You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs. For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide. Take the following limitations into consideration when you use the ClientMetadata parameter: Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. Amazon Cognito does not validate the ClientMetadata value. Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
*/
ClientMetadata?: ClientMetadataType;
}
export interface UpdateUserAttributesResponse {
/**
* The code delivery details list from the server for the request to update user attributes.
*/
CodeDeliveryDetailsList?: CodeDeliveryDetailsListType;
}
export interface UpdateUserPoolClientRequest {
/**
* The user pool ID for the user pool where you want to update the user pool client.
*/
UserPoolId: UserPoolIdType;
/**
* The ID of the client associated with the user pool.
*/
ClientId: ClientIdType;
/**
* The client name from the update user pool client request.
*/
ClientName?: ClientNameType;
/**
* The time limit, in days, after which the refresh token is no longer valid and cannot be used.
*/
RefreshTokenValidity?: RefreshTokenValidityType;
/**
* The read-only attributes of the user pool.
*/
ReadAttributes?: ClientPermissionListType;
/**
* The writeable attributes of the user pool.
*/
WriteAttributes?: ClientPermissionListType;
/**
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix. Valid values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP based authentication. ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
*/
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
/**
* A list of provider names for the identity providers that are supported on this client.
*/
SupportedIdentityProviders?: SupportedIdentityProvidersListType;
/**
* A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
CallbackURLs?: CallbackURLsListType;
/**
* A list of allowed logout URLs for the identity providers.
*/
LogoutURLs?: LogoutURLsListType;
/**
* The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
DefaultRedirectURI?: RedirectUrlType;
/**
* Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.
*/
AllowedOAuthFlows?: OAuthFlowsType;
/**
* A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". In addition to these values, custom scopes created in Resource Servers are also supported.
*/
AllowedOAuthScopes?: ScopeListType;
/**
* Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
*/
AllowedOAuthFlowsUserPoolClient?: BooleanType;
/**
* The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
*/
AnalyticsConfiguration?: AnalyticsConfigurationType;
/**
* Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool. Valid values include: ENABLED - This prevents user existence-related errors. LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented. This setting affects the behavior of following APIs: AdminInitiateAuth AdminRespondToAuthChallenge InitiateAuth RespondToAuthChallenge ForgotPassword ConfirmForgotPassword ConfirmSignUp ResendConfirmationCode After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
*/
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
}
export interface UpdateUserPoolClientResponse {
/**
* The user pool client value from the response from the server when an update user pool client request is made.
*/
UserPoolClient?: UserPoolClientType;
}
export interface UpdateUserPoolDomainRequest {
/**
* The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com. This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.
*/
Domain: DomainType;
/**
* The ID of the user pool that is associated with the custom domain that you are updating the certificate for.
*/
UserPoolId: UserPoolIdType;
/**
* The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.
*/
CustomDomainConfig: CustomDomainConfigType;
}
export interface UpdateUserPoolDomainResponse {
/**
* The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
*/
CloudFrontDomain?: DomainType;
}
export interface UpdateUserPoolRequest {
/**
* The user pool ID for the user pool you want to update.
*/
UserPoolId: UserPoolIdType;
/**
* A container with the policies you wish to update in a user pool.
*/
Policies?: UserPoolPolicyType;
/**
* The AWS Lambda configuration information from the request to update the user pool.
*/
LambdaConfig?: LambdaConfigType;
/**
* The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
*/
AutoVerifiedAttributes?: VerifiedAttributesListType;
/**
* A container with information about the SMS verification message.
*/
SmsVerificationMessage?: SmsVerificationMessageType;
/**
* The contents of the email verification message.
*/
EmailVerificationMessage?: EmailVerificationMessageType;
/**
* The subject of the email verification message.
*/
EmailVerificationSubject?: EmailVerificationSubjectType;
/**
* The template for verification messages.
*/
VerificationMessageTemplate?: VerificationMessageTemplateType;
/**
* The contents of the SMS authentication message.
*/
SmsAuthenticationMessage?: SmsVerificationMessageType;
/**
* Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token.
*/
MfaConfiguration?: UserPoolMfaType;
/**
* Device configuration.
*/
DeviceConfiguration?: DeviceConfigurationType;
/**
* Email configuration.
*/
EmailConfiguration?: EmailConfigurationType;
/**
* SMS configuration.
*/
SmsConfiguration?: SmsConfigurationType;
/**
* The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.
*/
UserPoolTags?: UserPoolTagsType;
/**
* The configuration for AdminCreateUser requests.
*/
AdminCreateUserConfig?: AdminCreateUserConfigType;
/**
* Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT".
*/
UserPoolAddOns?: UserPoolAddOnsType;
}
export interface UpdateUserPoolResponse {
}
export interface UserContextDataType {
/**
* Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.
*/
EncodedData?: StringType;
}
export type UserFilterType = string;
export type UserImportJobIdType = string;
export type UserImportJobNameType = string;
export type UserImportJobStatusType = "Created"|"Pending"|"InProgress"|"Stopping"|"Expired"|"Stopped"|"Failed"|"Succeeded"|string;
export interface UserImportJobType {
/**
* The job name for the user import job.
*/
JobName?: UserImportJobNameType;
/**
* The job ID for the user import job.
*/
JobId?: UserImportJobIdType;
/**
* The user pool ID for the user pool that the users are being imported into.
*/
UserPoolId?: UserPoolIdType;
/**
* The pre-signed URL to be used to upload the .csv file.
*/
PreSignedUrl?: PreSignedUrlType;
/**
* The date the user import job was created.
*/
CreationDate?: DateType;
/**
* The date when the user import job was started.
*/
StartDate?: DateType;
/**
* The date when the user import job was completed.
*/
CompletionDate?: DateType;
/**
* The status of the user import job. One of the following: Created - The job was created but not started. Pending - A transition state. You have started the job, but it has not begun importing users yet. InProgress - The job has started, and users are being imported. Stopping - You have stopped the job, but the job has not stopped importing users yet. Stopped - You have stopped the job, and the job has stopped importing users. Succeeded - The job has completed successfully. Failed - The job has stopped due to an error. Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.
*/
Status?: UserImportJobStatusType;
/**
* The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
*/
CloudWatchLogsRoleArn?: ArnType;
/**
* The number of users that were successfully imported.
*/
ImportedUsers?: LongType;
/**
* The number of users that were skipped.
*/
SkippedUsers?: LongType;
/**
* The number of users that could not be imported.
*/
FailedUsers?: LongType;
/**
* The message returned when the user import job is completed.
*/
CompletionMessage?: CompletionMessageType;
}
export type UserImportJobsListType = UserImportJobType[];
export type UserMFASettingListType = StringType[];
export interface UserPoolAddOnsType {
/**
* The advanced security mode.
*/
AdvancedSecurityMode: AdvancedSecurityModeType;
}
export interface UserPoolClientDescription {
/**
* The ID of the client associated with the user pool.
*/
ClientId?: ClientIdType;
/**
* The user pool ID for the user pool where you want to describe the user pool client.
*/
UserPoolId?: UserPoolIdType;
/**
* The client name from the user pool client description.
*/
ClientName?: ClientNameType;
}
export type UserPoolClientListType = UserPoolClientDescription[];
export interface UserPoolClientType {
/**
* The user pool ID for the user pool client.
*/
UserPoolId?: UserPoolIdType;
/**
* The client name from the user pool request of the client type.
*/
ClientName?: ClientNameType;
/**
* The ID of the client associated with the user pool.
*/
ClientId?: ClientIdType;
/**
* The client secret from the user pool request of the client type.
*/
ClientSecret?: ClientSecretType;
/**
* The date the user pool client was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the user pool client was created.
*/
CreationDate?: DateType;
/**
* The time limit, in days, after which the refresh token is no longer valid and cannot be used.
*/
RefreshTokenValidity?: RefreshTokenValidityType;
/**
* The Read-only attributes.
*/
ReadAttributes?: ClientPermissionListType;
/**
* The writeable attributes.
*/
WriteAttributes?: ClientPermissionListType;
/**
* The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_ prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with ALLOW_ prefix cannot be used along with values without ALLOW_ prefix. Valid values include: ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote Password protocol) protocol to verify passwords. ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication. ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives the password in the request instead of using the SRP protocol to verify passwords. ALLOW_USER_SRP_AUTH: Enable SRP based authentication. ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
*/
ExplicitAuthFlows?: ExplicitAuthFlowsListType;
/**
* A list of provider names for the identity providers that are supported on this client.
*/
SupportedIdentityProviders?: SupportedIdentityProvidersListType;
/**
* A list of allowed redirect (callback) URLs for the identity providers. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
CallbackURLs?: CallbackURLsListType;
/**
* A list of allowed logout URLs for the identity providers.
*/
LogoutURLs?: LogoutURLsListType;
/**
* The default redirect URI. Must be in the CallbackURLs list. A redirect URI must: Be an absolute URI. Be registered with the authorization server. Not include a fragment component. See OAuth 2.0 - Redirection Endpoint. Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only. App callback URLs such as myapp://example are also supported.
*/
DefaultRedirectURI?: RedirectUrlType;
/**
* Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint. Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.
*/
AllowedOAuthFlows?: OAuthFlowsType;
/**
* A list of allowed OAuth scopes. Currently supported values are "phone", "email", "openid", and "Cognito". In addition to these values, custom scopes created in Resource Servers are also supported.
*/
AllowedOAuthScopes?: ScopeListType;
/**
* Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
*/
AllowedOAuthFlowsUserPoolClient?: BooleanType;
/**
* The Amazon Pinpoint analytics configuration for the user pool client.
*/
AnalyticsConfiguration?: AnalyticsConfigurationType;
/**
* Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to ENABLED and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to LEGACY, those APIs will return a UserNotFoundException exception if the user does not exist in the user pool. Valid values include: ENABLED - This prevents user existence-related errors. LEGACY - This represents the old behavior of Cognito where user existence related errors are not prevented. This setting affects the behavior of following APIs: AdminInitiateAuth AdminRespondToAuthChallenge InitiateAuth RespondToAuthChallenge ForgotPassword ConfirmForgotPassword ConfirmSignUp ResendConfirmationCode After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED for newly created user pool clients if no value is provided.
*/
PreventUserExistenceErrors?: PreventUserExistenceErrorTypes;
}
export interface UserPoolDescriptionType {
/**
* The ID in a user pool description.
*/
Id?: UserPoolIdType;
/**
* The name in a user pool description.
*/
Name?: UserPoolNameType;
/**
* The AWS Lambda configuration information in a user pool description.
*/
LambdaConfig?: LambdaConfigType;
/**
* The user pool status in a user pool description.
*/
Status?: StatusType;
/**
* The date the user pool description was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the user pool description was created.
*/
CreationDate?: DateType;
}
export type UserPoolIdType = string;
export type UserPoolListType = UserPoolDescriptionType[];
export type UserPoolMfaType = "OFF"|"ON"|"OPTIONAL"|string;
export type UserPoolNameType = string;
export interface UserPoolPolicyType {
/**
* The password policy.
*/
PasswordPolicy?: PasswordPolicyType;
}
export type UserPoolTagsListType = TagKeysType[];
export type UserPoolTagsType = {[key: string]: TagValueType};
export interface UserPoolType {
/**
* The ID of the user pool.
*/
Id?: UserPoolIdType;
/**
* The name of the user pool.
*/
Name?: UserPoolNameType;
/**
* The policies associated with the user pool.
*/
Policies?: UserPoolPolicyType;
/**
* The AWS Lambda triggers associated with the user pool.
*/
LambdaConfig?: LambdaConfigType;
/**
* The status of a user pool.
*/
Status?: StatusType;
/**
* The date the user pool was last modified.
*/
LastModifiedDate?: DateType;
/**
* The date the user pool was created.
*/
CreationDate?: DateType;
/**
* A container with the schema attributes of a user pool.
*/
SchemaAttributes?: SchemaAttributesListType;
/**
* Specifies the attributes that are auto-verified in a user pool.
*/
AutoVerifiedAttributes?: VerifiedAttributesListType;
/**
* Specifies the attributes that are aliased in a user pool.
*/
AliasAttributes?: AliasAttributesListType;
/**
* Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
*/
UsernameAttributes?: UsernameAttributesListType;
/**
* The contents of the SMS verification message.
*/
SmsVerificationMessage?: SmsVerificationMessageType;
/**
* The contents of the email verification message.
*/
EmailVerificationMessage?: EmailVerificationMessageType;
/**
* The subject of the email verification message.
*/
EmailVerificationSubject?: EmailVerificationSubjectType;
/**
* The template for verification messages.
*/
VerificationMessageTemplate?: VerificationMessageTemplateType;
/**
* The contents of the SMS authentication message.
*/
SmsAuthenticationMessage?: SmsVerificationMessageType;
/**
* Can be one of the following values: OFF - MFA tokens are not required and cannot be specified during user registration. ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool. OPTIONAL - Users have the option when registering to create an MFA token.
*/
MfaConfiguration?: UserPoolMfaType;
/**
* The device configuration.
*/
DeviceConfiguration?: DeviceConfigurationType;
/**
* A number estimating the size of the user pool.
*/
EstimatedNumberOfUsers?: IntegerType;
/**
* The email configuration.
*/
EmailConfiguration?: EmailConfigurationType;
/**
* The SMS configuration.
*/
SmsConfiguration?: SmsConfigurationType;
/**
* The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
*/
UserPoolTags?: UserPoolTagsType;
/**
* The reason why the SMS configuration cannot send the messages to your users.
*/
SmsConfigurationFailure?: StringType;
/**
* The reason why the email configuration cannot send the messages to your users.
*/
EmailConfigurationFailure?: StringType;
/**
* Holds the domain prefix if the user pool has a domain associated with it.
*/
Domain?: DomainType;
/**
* A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com. For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.
*/
CustomDomain?: DomainType;
/**
* The configuration for AdminCreateUser requests.
*/
AdminCreateUserConfig?: AdminCreateUserConfigType;
/**
* The user pool add-ons.
*/
UserPoolAddOns?: UserPoolAddOnsType;
/**
* The Amazon Resource Name (ARN) for the user pool.
*/
Arn?: ArnType;
}
export type UserStatusType = "UNCONFIRMED"|"CONFIRMED"|"ARCHIVED"|"COMPROMISED"|"UNKNOWN"|"RESET_REQUIRED"|"FORCE_CHANGE_PASSWORD"|string;
export interface UserType {
/**
* The user name of the user you wish to describe.
*/
Username?: UsernameType;
/**
* A container with information about the user type attributes.
*/
Attributes?: AttributeListType;
/**
* The creation date of the user.
*/
UserCreateDate?: DateType;
/**
* The last modified date of the user.
*/
UserLastModifiedDate?: DateType;
/**
* Specifies whether the user is enabled.
*/
Enabled?: BooleanType;
/**
* The user status. Can be one of the following: UNCONFIRMED - User has been created but not confirmed. CONFIRMED - User has been confirmed. ARCHIVED - User is no longer active. COMPROMISED - User is disabled due to a potential security threat. UNKNOWN - User status is not known. RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in. FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.
*/
UserStatus?: UserStatusType;
/**
* The MFA options for the user.
*/
MFAOptions?: MFAOptionListType;
}
export type UsernameAttributeType = "phone_number"|"email"|string;
export type UsernameAttributesListType = UsernameAttributeType[];
export type UsernameType = string;
export type UsersListType = UserType[];
export interface VerificationMessageTemplateType {
/**
* The SMS message template.
*/
SmsMessage?: SmsVerificationMessageType;
/**
* The email message template.
*/
EmailMessage?: EmailVerificationMessageType;
/**
* The subject line for the email message template.
*/
EmailSubject?: EmailVerificationSubjectType;
/**
* The email message template for sending a confirmation link to the user.
*/
EmailMessageByLink?: EmailVerificationMessageByLinkType;
/**
* The subject line for the email message template for sending a confirmation link to the user.
*/
EmailSubjectByLink?: EmailVerificationSubjectByLinkType;
/**
* The default email option.
*/
DefaultEmailOption?: DefaultEmailOptionType;
}
export type VerifiedAttributeType = "phone_number"|"email"|string;
export type VerifiedAttributesListType = VerifiedAttributeType[];
export interface VerifySoftwareTokenRequest {
/**
* The access token.
*/
AccessToken?: TokenModelType;
/**
* The session which should be passed both ways in challenge-response calls to the service.
*/
Session?: SessionType;
/**
* The one time password computed using the secret code returned by
*/
UserCode: SoftwareTokenMFAUserCodeType;
/**
* The friendly device name.
*/
FriendlyDeviceName?: StringType;
}
export interface VerifySoftwareTokenResponse {
/**
* The status of the verify software token.
*/
Status?: VerifySoftwareTokenResponseType;
/**
* The session which should be passed both ways in challenge-response calls to the service.
*/
Session?: SessionType;
}
export type VerifySoftwareTokenResponseType = "SUCCESS"|"ERROR"|string;
export interface VerifyUserAttributeRequest {
/**
* Represents the access token of the request to verify user attributes.
*/
AccessToken: TokenModelType;
/**
* The attribute name in the request to verify user attributes.
*/
AttributeName: AttributeNameType;
/**
* The verification code in the request to verify user attributes.
*/
Code: ConfirmationCodeType;
}
export interface VerifyUserAttributeResponse {
}
/**
* 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 = "2016-04-18"|"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 CognitoIdentityServiceProvider client.
*/
export import Types = CognitoIdentityServiceProvider;
}
export = CognitoIdentityServiceProvider;