bin/Net45/AWSSDK.SecurityToken.xml
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 |
<?xml version="1.0"?>
<doc> <assembly> <name>AWSSDK.SecurityToken</name> </assembly> <members> <member name="T:Amazon.SecurityToken.AmazonSecurityTokenServiceClient"> <summary> Implementation for accessing SecurityTokenService AWS Security Token Service <para> The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>. </para> <note> <para> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </para> </note> <para> For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html">AWS Services That Work with IAM</a> in the <i>IAM User Guide</i>. </para> <para> If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://aws.amazon.com/documentation/">http://aws.amazon.com/documentation/</a>. </para> <para> <b>Endpoints</b> </para> <para> The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available and are activated by default. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </para> <para> For information about STS endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region">Regions and Endpoints</a> in the <i>AWS General Reference</i>. </para> <para> <b>Recording API requests</b> </para> <para> STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">AWS CloudTrail User Guide</a>. </para> </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.Amazon#Runtime#SharedInterfaces#ICoreAmazonSTS#CredentialsFromAssumeRoleAuthentication(System.String,System.String,Amazon.Runtime.AssumeRoleAWSCredentialsOptions)"> <summary> <see cref="T:Amazon.Runtime.SharedInterfaces.ICoreAmazonSTS"/> </summary> <param name="roleArn"></param> <param name="roleSessionName"></param> <param name="options"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. <code> <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> </code> </summary> <param name="config">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials </summary> <param name="credentials">AWS Credentials</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(Amazon.Runtime.AWSCredentials,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Credentials and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="credentials">AWS Credentials</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String,Amazon.RegionEndpoint)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID and AWS Secret Key </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="region">The region to connect.</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.#ctor(System.String,System.String,System.String,Amazon.SecurityToken.AmazonSecurityTokenServiceConfig)"> <summary> Constructs AmazonSecurityTokenServiceClient with AWS Access Key ID, AWS Secret Key and an AmazonSecurityTokenServiceClient Configuration object. </summary> <param name="awsAccessKeyId">AWS Access Key ID</param> <param name="awsSecretAccessKey">AWS Secret Access Key</param> <param name="awsSessionToken">AWS Session Token</param> <param name="clientConfig">The AmazonSecurityTokenServiceClient Configuration Object</param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.CreateSigner"> <summary> Creates the signer for the service. </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.Dispose(System.Boolean)"> <summary> Disposes the service client. </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRole(Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. For a comparison of <code>AssumeRole</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>. </para> <para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>IAM User Guide</i>. </para> <para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRole</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. </para> <para> The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy </para> <para> <b>Using MFA with AssumeRole</b> </para> <para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para> <para> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide. </para> <para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole service method.</param> <returns>The response from the AssumeRole service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole">REST API Reference for AssumeRole Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleAsync(Amazon.SecurityToken.Model.AssumeRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRole operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole">REST API Reference for AssumeRole Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithSAML(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para> <para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para> <important> <para> Calling <code>AssumeRoleWithSAML</code> can result in an entry in your AWS CloudTrail logs. The entry includes the value in the <code>NameID</code> element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>). </para> </important> <para> For more information, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>IAM User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML service method.</param> <returns>The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML">REST API Reference for AssumeRoleWithSAML Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithSAMLAsync(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithSAML operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML">REST API Reference for AssumeRoleWithSAML Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithWebIdentity(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. <note> <para> For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application. </para> <para> To learn more about Amazon Cognito, see <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>. </para> </note> <para> Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of <code>AssumeRoleWithWebIdentity</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. </para> <para> The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </para> <important> <para> Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your AWS CloudTrail logs. The entry includes the <a href="http://openid.net/specs/openid-connect-core-1_0.html#Claims">Subject</a> of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as <a href="http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes">suggested in the OIDC specification</a>. </para> </important> <para> For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation APIs for Mobile Apps</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </li> <li> <para> <a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </para> </li> <li> <para> <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </para> </li> <li> <para> <a href="http://aws.amazon.com/articles/4617974389850313">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method.</param> <returns>The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPCommunicationErrorException"> The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity">REST API Reference for AssumeRoleWithWebIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.AssumeRoleWithWebIdentityAsync(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithWebIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity">REST API Reference for AssumeRoleWithWebIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.DecodeAuthorizationMessage(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest)"> <summary> Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para> <note> <para> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </para> </note> <para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para> <para> The decoded message includes the following type of information: </para> <ul> <li> <para> Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> The principal who made the request. </para> </li> <li> <para> The requested action. </para> </li> <li> <para> The requested resource. </para> </li> <li> <para> The values of condition keys in the context of the user's request. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.</param> <returns>The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException"> The error returned if the message passed to <code>DecodeAuthorizationMessage</code> was invalid. This can happen if the token contains invalid characters, such as linebreaks. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage">REST API Reference for DecodeAuthorizationMessage Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.DecodeAuthorizationMessageAsync(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecodeAuthorizationMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage">REST API Reference for DecodeAuthorizationMessage Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetCallerIdentity(Amazon.SecurityToken.Model.GetCallerIdentityRequest)"> <summary> Returns details about the IAM identity whose credentials are used to call the API. </summary> <param name="request">Container for the necessary parameters to execute the GetCallerIdentity service method.</param> <returns>The response from the GetCallerIdentity service method, as returned by SecurityTokenService.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity">REST API Reference for GetCallerIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetCallerIdentityAsync(Amazon.SecurityToken.Model.GetCallerIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCallerIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCallerIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity">REST API Reference for GetCallerIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetFederationToken(Amazon.SecurityToken.Model.GetFederationTokenRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of <code>GetFederationToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <note> <para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </note> <para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour). </para> <para> The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot use these credentials to call any IAM APIs. </para> </li> <li> <para> You cannot call any STS APIs except <code>GetCallerIdentity</code>. </para> </li> </ul> <para> <b>Permissions</b> </para> <para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para> <ul> <li> <para> The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. </para> </li> <li> <para> The policy that is passed as a parameter in the call. </para> </li> </ul> <para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i> <b>and</b> </i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para> <para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken service method.</param> <returns>The response from the GetFederationToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken">REST API Reference for GetFederationToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetFederationTokenAsync(Amazon.SecurityToken.Model.GetFederationTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFederationToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken">REST API Reference for GetFederationToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionToken"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionToken(Amazon.SecurityToken.Model.GetSessionTokenRequest)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken service method.</param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionTokenAsync(System.Threading.CancellationToken)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceClient.GetSessionTokenAsync(Amazon.SecurityToken.Model.GetSessionTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSessionToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="T:Amazon.SecurityToken.STSAssumeRoleAWSCredentials"> <summary> Credentials that are retrieved by invoking AWS Security Token Service AssumeRole or AssumeRoleWithSAML action. </summary> <summary> Assumed role credentials retrieved and automatically refreshed from an instance of IAmazonSecurityTokenService. </summary> </member> <member name="M:Amazon.SecurityToken.STSAssumeRoleAWSCredentials.#ctor(Amazon.SecurityToken.IAmazonSecurityTokenService,Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified role. The credentials are refreshed before expiration. </summary> <param name="sts"> Instance of IAmazonSecurityTokenService that will be used to make the AssumeRole service call. </param> <param name="assumeRoleRequest">Configuration for the role to assume.</param> </member> <member name="M:Amazon.SecurityToken.STSAssumeRoleAWSCredentials.#ctor(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Instantiates STSAssumeRoleAWSCredentials which automatically assumes a specified SAML role. The credentials are refreshed before expiration. </summary> <param name="assumeRoleWithSamlRequest">Configuration for the SAML role to assume.</param> </member> <member name="M:Amazon.SecurityToken.STSAssumeRoleAWSCredentials.GenerateNewCredentials"> <summary> Generate new credentials. </summary> <returns></returns> </member> <member name="M:Amazon.SecurityToken.STSAssumeRoleAWSCredentials.Dispose(System.Boolean)"> <summary> Implements the Dispose pattern </summary> <param name="disposing">Whether this object is being disposed via a call to Dispose or garbage collected.</param> </member> <member name="M:Amazon.SecurityToken.STSAssumeRoleAWSCredentials.Dispose"> <summary> Disposes of all managed and unmanaged resources. </summary> </member> <member name="T:Amazon.SecurityToken.IAmazonSecurityTokenService"> <summary> Interface for accessing SecurityTokenService AWS Security Token Service <para> The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary Security Credentials</a>. </para> <note> <para> As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services page</a>. </para> </note> <para> For information about setting up signatures and authorization through the API, go to <a href="http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about the Query API, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html">Making Query Requests</a> in <i>Using IAM</i>. For information about using security tokens with other AWS products, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html">AWS Services That Work with IAM</a> in the <i>IAM User Guide</i>. </para> <para> If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href="http://aws.amazon.com/documentation/">http://aws.amazon.com/documentation/</a>. </para> <para> <b>Endpoints</b> </para> <para> The AWS Security Token Service (STS) has a default endpoint of https://sts.amazonaws.com that maps to the US East (N. Virginia) region. Additional regions are available and are activated by default. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </para> <para> For information about STS endpoints, see <a href="http://docs.aws.amazon.com/general/latest/gr/rande.html#sts_region">Regions and Endpoints</a> in the <i>AWS General Reference</i>. </para> <para> <b>Recording API requests</b> </para> <para> STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html">AWS CloudTrail User Guide</a>. </para> </summary> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRole(Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. For a comparison of <code>AssumeRole</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>. </para> <para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>IAM User Guide</i>. </para> <para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRole</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. </para> <para> The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy </para> <para> <b>Using MFA with AssumeRole</b> </para> <para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para> <para> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide. </para> <para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole service method.</param> <returns>The response from the AssumeRole service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole">REST API Reference for AssumeRole Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleAsync(Amazon.SecurityToken.Model.AssumeRoleRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRole operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRole operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRole">REST API Reference for AssumeRole Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithSAML(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para> <para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para> <important> <para> Calling <code>AssumeRoleWithSAML</code> can result in an entry in your AWS CloudTrail logs. The entry includes the value in the <code>NameID</code> element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>). </para> </important> <para> For more information, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>IAM User Guide</i>. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML service method.</param> <returns>The response from the AssumeRoleWithSAML service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML">REST API Reference for AssumeRoleWithSAML Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithSAMLAsync(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithSAML operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithSAML operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithSAML">REST API Reference for AssumeRoleWithSAML Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithWebIdentity(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest)"> <summary> Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. <note> <para> For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application. </para> <para> To learn more about Amazon Cognito, see <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>. </para> </note> <para> Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of <code>AssumeRoleWithWebIdentity</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. </para> <para> The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </para> <important> <para> Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your AWS CloudTrail logs. The entry includes the <a href="http://openid.net/specs/openid-connect-core-1_0.html#Claims">Subject</a> of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as <a href="http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes">suggested in the OIDC specification</a>. </para> </important> <para> For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation APIs for Mobile Apps</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </li> <li> <para> <a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </para> </li> <li> <para> <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </para> </li> <li> <para> <a href="http://aws.amazon.com/articles/4617974389850313">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity service method.</param> <returns>The response from the AssumeRoleWithWebIdentity service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.ExpiredTokenException"> The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPCommunicationErrorException"> The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding. </exception> <exception cref="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid. <para> If this error is returned for the <code>AssumeRoleWithWebIdentity</code> operation, it can also mean that the claim has expired or has been explicitly revoked. </para> </exception> <exception cref="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request. </exception> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity">REST API Reference for AssumeRoleWithWebIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.AssumeRoleWithWebIdentityAsync(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the AssumeRoleWithWebIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the AssumeRoleWithWebIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/AssumeRoleWithWebIdentity">REST API Reference for AssumeRoleWithWebIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.DecodeAuthorizationMessage(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest)"> <summary> Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para> <note> <para> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </para> </note> <para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para> <para> The decoded message includes the following type of information: </para> <ul> <li> <para> Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> The principal who made the request. </para> </li> <li> <para> The requested action. </para> </li> <li> <para> The requested resource. </para> </li> <li> <para> The values of condition keys in the context of the user's request. </para> </li> </ul> </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage service method.</param> <returns>The response from the DecodeAuthorizationMessage service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException"> The error returned if the message passed to <code>DecodeAuthorizationMessage</code> was invalid. This can happen if the token contains invalid characters, such as linebreaks. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage">REST API Reference for DecodeAuthorizationMessage Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.DecodeAuthorizationMessageAsync(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the DecodeAuthorizationMessage operation. </summary> <param name="request">Container for the necessary parameters to execute the DecodeAuthorizationMessage operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/DecodeAuthorizationMessage">REST API Reference for DecodeAuthorizationMessage Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetCallerIdentity(Amazon.SecurityToken.Model.GetCallerIdentityRequest)"> <summary> Returns details about the IAM identity whose credentials are used to call the API. </summary> <param name="request">Container for the necessary parameters to execute the GetCallerIdentity service method.</param> <returns>The response from the GetCallerIdentity service method, as returned by SecurityTokenService.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity">REST API Reference for GetCallerIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetCallerIdentityAsync(Amazon.SecurityToken.Model.GetCallerIdentityRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetCallerIdentity operation. </summary> <param name="request">Container for the necessary parameters to execute the GetCallerIdentity operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetCallerIdentity">REST API Reference for GetCallerIdentity Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetFederationToken(Amazon.SecurityToken.Model.GetFederationTokenRequest)"> <summary> Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of <code>GetFederationToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <note> <para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </note> <para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour). </para> <para> The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot use these credentials to call any IAM APIs. </para> </li> <li> <para> You cannot call any STS APIs except <code>GetCallerIdentity</code>. </para> </li> </ul> <para> <b>Permissions</b> </para> <para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para> <ul> <li> <para> The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. </para> </li> <li> <para> The policy that is passed as a parameter in the call. </para> </li> </ul> <para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i> <b>and</b> </i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para> <para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken service method.</param> <returns>The response from the GetFederationToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> The request was rejected because the policy document was malformed. The error message describes the specific error. </exception> <exception cref="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows. </exception> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken">REST API Reference for GetFederationToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetFederationTokenAsync(Amazon.SecurityToken.Model.GetFederationTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetFederationToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetFederationToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetFederationToken">REST API Reference for GetFederationToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionToken"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionToken(Amazon.SecurityToken.Model.GetSessionTokenRequest)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken service method.</param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionTokenAsync(System.Threading.CancellationToken)"> <summary> Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The response from the GetSessionToken service method, as returned by SecurityTokenService.</returns> <exception cref="T:Amazon.SecurityToken.Model.RegionDisabledException"> STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html">Activating and Deactivating AWS STS in an AWS Region</a> in the <i>IAM User Guide</i>. </exception> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="M:Amazon.SecurityToken.IAmazonSecurityTokenService.GetSessionTokenAsync(Amazon.SecurityToken.Model.GetSessionTokenRequest,System.Threading.CancellationToken)"> <summary> Initiates the asynchronous execution of the GetSessionToken operation. </summary> <param name="request">Container for the necessary parameters to execute the GetSessionToken operation.</param> <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation. </param> <returns>The task object representing the asynchronous operation.</returns> <seealso href="http://docs.aws.amazon.com/goto/WebAPI/sts-2011-06-15/GetSessionToken">REST API Reference for GetSessionToken Operation</seealso> </member> <member name="T:Amazon.SecurityToken.Model.Credentials"> <summary> <para>AWS credentials for API authentication.</para> </summary> <summary> AWS credentials for API authentication. </summary> </member> <member name="M:Amazon.SecurityToken.Model.Credentials.GetCredentials"> <summary> Returns a copy of ImmutableCredentials corresponding to these credentials </summary> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Credentials.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.SecurityToken.Model.Credentials.#ctor(System.String,System.String,System.String,System.DateTime)"> <summary> Instantiates Credentials with the parameterized properties </summary> <param name="accessKeyId">The access key ID that identifies the temporary security credentials.</param> <param name="secretAccessKey">The secret access key that can be used to sign requests.</param> <param name="sessionToken">The token that users must pass to the service API to use the temporary credentials.</param> <param name="expiration">The date on which the current credentials expire.</param> </member> <member name="P:Amazon.SecurityToken.Model.Credentials.AccessKeyId"> <summary> Gets and sets the property AccessKeyId. <para> The access key ID that identifies the temporary security credentials. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.Credentials.Expiration"> <summary> Gets and sets the property Expiration. <para> The date on which the current credentials expire. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.Credentials.SecretAccessKey"> <summary> Gets and sets the property SecretAccessKey. <para> The secret access key that can be used to sign requests. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.Credentials.SessionToken"> <summary> Gets and sets the property SessionToken. <para> The token that users must pass to the service API to use the temporary credentials. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumedRoleUser"> <summary> The identifiers for the temporary security credentials that the operation returns. </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumedRoleUser.Arn"> <summary> Gets and sets the property Arn. <para> The ARN of the temporary security credentials that are returned from the <a>AssumeRole</a> action. For more information about ARNs and how to use them in policies, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in <i>Using IAM</i>. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumedRoleUser.AssumedRoleId"> <summary> Gets and sets the property AssumedRoleId. <para> A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleRequest"> <summary> Container for the parameters to the AssumeRole operation. Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) that you can use to access AWS resources that you might not normally have access to. Typically, you use <code>AssumeRole</code> for cross-account access or federation. For a comparison of <code>AssumeRole</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> <b>Important:</b> You cannot call <code>AssumeRole</code> by using AWS root account credentials; access is denied. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>. </para> <para> For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account and then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html">IAM Roles (Delegation and Federation)</a> in the <i>IAM User Guide</i>. </para> <para> For federation, you can, for example, grant single sign-on access to the AWS Management Console. If you already have an identity and authentication system in your corporate network, you don't have to recreate user identities in AWS in order to grant those user identities access to AWS. Instead, after a user has been authenticated, you call <code>AssumeRole</code> (and specify the role with the appropriate permissions) to get temporary security credentials for that user. With those temporary security credentials, you construct a sign-in URL that users can use to access the console. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html#sts-introduction">Common Scenarios for Temporary Credentials</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRole</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> To assume a role, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate access to this account's role. </para> <para> The user who wants to access the role must also have permissions delegated from the role's administrator. If the user is in a different account than the role, then the user's administrator must attach a policy that allows the user to call AssumeRole on the ARN of the role in the other account. If the user is in the same account as the role, then you can either attach a policy to the user (identical to the previous different account user), or you can add the user as a principal directly in the role's trust policy </para> <para> <b>Using MFA with AssumeRole</b> </para> <para> You can optionally include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios in which you want to make sure that the user who is assuming the role has been authenticated using an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication; if the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example. </para> <para> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide. </para> <para> To use MFA with <code>AssumeRole</code>, you pass values for the <code>SerialNumber</code> and <code>TokenCode</code> parameters. The <code>SerialNumber</code> value identifies the user's hardware or virtual MFA device. The <code>TokenCode</code> is the time-based one-time password (TOTP) that the MFA devices produces. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.DurationSeconds"> <summary> Gets and sets the property DurationSeconds. <para> The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. </para> <note> <para> This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.ExternalId"> <summary> Gets and sets the property ExternalId. <para> A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html">How to Use an External ID When Granting Access to Your AWS Resources to a Third Party</a> in the <i>IAM User Guide</i>. </para> <para> The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.Policy"> <summary> Gets and sets the property Policy. <para> An IAM policy in JSON format. </para> <para> This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, <i>and</i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. </para> <note> <para> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The Amazon Resource Name (ARN) of the role to assume. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.RoleSessionName"> <summary> Gets and sets the property RoleSessionName. <para> An identifier for the assumed role session. </para> <para> Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs. </para> <para> The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.SerialNumber"> <summary> Gets and sets the property SerialNumber. <para> The identification number of the MFA device that is associated with the user who is making the <code>AssumeRole</code> call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). </para> <para> The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleRequest.TokenCode"> <summary> Gets and sets the property TokenCode. <para> The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the <code>TokenCode</code> value is missing or expired, the <code>AssumeRole</code> call returns an "access denied" error. </para> <para> The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleResponse"> <summary> Contains the response to a successful <a>AssumeRole</a> request, including temporary AWS credentials that can be used to make AWS requests. </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleResponse.AssumedRoleUser"> <summary> Gets and sets the property AssumedRoleUser. <para> The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the <code>RoleSessionName</code> that you specified when you called <code>AssumeRole</code>. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleResponse.Credentials"> <summary> Gets and sets the property Credentials. <para> The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. </para> <para> <b>Note:</b> The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleResponse.PackedPolicySize"> <summary> Gets and sets the property PackedPolicySize. <para> A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest"> <summary> Container for the parameters to the AssumeRoleWithSAML operation. Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of <code>AssumeRoleWithSAML</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services. </para> <para> The temporary security credentials are valid for the duration that you specified when calling <code>AssumeRole</code>, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. The duration can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithSAML</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by the intersection of both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This means that both policies must grant the permission for the action to be allowed. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithSAML</code>, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider, and create an IAM role that specifies this SAML provider in its trust policy. </para> <para> Calling <code>AssumeRoleWithSAML</code> does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider. </para> <important> <para> Calling <code>AssumeRoleWithSAML</code> can result in an entry in your AWS CloudTrail logs. The entry includes the value in the <code>NameID</code> element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (<code>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</code>). </para> </important> <para> For more information, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html">Creating SAML Identity Providers</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml_relying-party.html">Configuring a Relying Party and Claims</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_saml.html">Creating a Role for SAML 2.0 Federation</a> in the <i>IAM User Guide</i>. </para> </li> </ul> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest.DurationSeconds"> <summary> Gets and sets the property DurationSeconds. <para> The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value. The actual expiration time is whichever value is shorter. </para> <note> <para> This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest.Policy"> <summary> Gets and sets the property Policy. <para> An IAM policy in JSON format. </para> <para> The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. </para> <note> <para> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest.PrincipalArn"> <summary> Gets and sets the property PrincipalArn. <para> The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The Amazon Resource Name (ARN) of the role that the caller is assuming. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest.SAMLAssertion"> <summary> Gets and sets the property SAMLAssertion. <para> The base-64 encoded SAML authentication response provided by the IdP. </para> <para> For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>Using IAM</i> guide. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse"> <summary> Contains the response to a successful <a>AssumeRoleWithSAML</a> request, including temporary AWS credentials that can be used to make AWS requests. </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.AssumedRoleUser"> <summary> Gets and sets the property AssumedRoleUser. <para> The identifiers for the temporary security credentials that the operation returns. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.Audience"> <summary> Gets and sets the property Audience. <para> The value of the <code>Recipient</code> attribute of the <code>SubjectConfirmationData</code> element of the SAML assertion. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.Credentials"> <summary> Gets and sets the property Credentials. <para> The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. </para> <para> <b>Note:</b> The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.Issuer"> <summary> Gets and sets the property Issuer. <para> The value of the <code>Issuer</code> element of the SAML assertion. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.NameQualifier"> <summary> Gets and sets the property NameQualifier. <para> A hash value based on the concatenation of the <code>Issuer</code> response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of <code>NameQualifier</code> and <code>Subject</code> can be used to uniquely identify a federated user. </para> <para> The following pseudocode shows how the hash value is calculated: </para> <para> <code>BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )</code> </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.PackedPolicySize"> <summary> Gets and sets the property PackedPolicySize. <para> A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.Subject"> <summary> Gets and sets the property Subject. <para> The value of the <code>NameID</code> element in the <code>Subject</code> element of the SAML assertion. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithSAMLResponse.SubjectType"> <summary> Gets and sets the property SubjectType. <para> The format of the name ID, as defined by the <code>Format</code> attribute in the <code>NameID</code> element of the SAML assertion. Typical examples of the format are <code>transient</code> or <code>persistent</code>. </para> <para> If the format includes the prefix <code>urn:oasis:names:tc:SAML:2.0:nameid-format</code>, that prefix is removed. For example, <code>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</code> is returned as <code>transient</code>. If the format includes any other prefix, the format is returned with no modifications. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest"> <summary> Container for the parameters to the AssumeRoleWithWebIdentity operation. Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider, such as Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider. <note> <para> For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a> to uniquely identify a user and supply the user with a consistent identity throughout the lifetime of an application. </para> <para> To learn more about Amazon Cognito, see <a href="http://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in the <i>AWS SDK for Android Developer Guide</i> guide and <a href="http://docs.aws.amazon.com/mobile/sdkforios/developerguide/cognito-auth.html#d0e664">Amazon Cognito Overview</a> in the <i>AWS SDK for iOS Developer Guide</i>. </para> </note> <para> Calling <code>AssumeRoleWithWebIdentity</code> does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application, and without deploying server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of <code>AssumeRoleWithWebIdentity</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service APIs. </para> <para> The credentials are valid for the duration that you specified when calling <code>AssumeRoleWithWebIdentity</code>, which can be from 900 seconds (15 minutes) to a maximum of 3600 seconds (1 hour). The default is 1 hour. </para> <para> The temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> can be used to make API calls to any AWS service with the following exception: you cannot call the STS service's <code>GetFederationToken</code> or <code>GetSessionToken</code> APIs. </para> <para> Optionally, you can pass an IAM access policy to this operation. If you choose not to pass a policy, the temporary security credentials that are returned by the operation have the permissions that are defined in the access policy of the role that is being assumed. If you pass a policy to this operation, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> Before your application can call <code>AssumeRoleWithWebIdentity</code>, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy. </para> <important> <para> Calling <code>AssumeRoleWithWebIdentity</code> can result in an entry in your AWS CloudTrail logs. The entry includes the <a href="http://openid.net/specs/openid-connect-core-1_0.html#Claims">Subject</a> of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as <a href="http://openid.net/specs/openid-connect-core-1_0.html#SubjectIDTypes">suggested in the OIDC specification</a>. </para> </important> <para> For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </para> <ul> <li> <para> <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation APIs for Mobile Apps</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </li> <li> <para> <a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. This interactive website lets you walk through the process of authenticating via Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </para> </li> <li> <para> <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android</a>. These toolkits contain sample apps that show how to invoke the identity providers, and then how to use the information from these providers to get and use temporary security credentials. </para> </li> <li> <para> <a href="http://aws.amazon.com/articles/4617974389850313">Web Identity Federation with Mobile Applications</a>. This article discusses web identity federation and shows an example of how to use web identity federation to get access to content in Amazon S3. </para> </li> </ul> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.DurationSeconds"> <summary> Gets and sets the property DurationSeconds. <para> The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. </para> <note> <para> This is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a <code>SessionDuration</code> parameter that specifies the maximum length of the console session, separately from the <code>DurationSeconds</code> parameter on this API. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-custom-url.html">Creating a URL that Enables Federated Users to Access the AWS Management Console</a> in the <i>IAM User Guide</i>. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.Policy"> <summary> Gets and sets the property Policy. <para> An IAM policy in JSON format. </para> <para> The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, <i> <b>and</b> </i> the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_assumerole.html">Permissions for AssumeRoleWithWebIdentity</a> in the <i>IAM User Guide</i>. </para> <para> The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. </para> <note> <para> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </note> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.ProviderId"> <summary> Gets and sets the property ProviderId. <para> The fully qualified host component of the domain name of the identity provider. </para> <para> Specify this value only for OAuth 2.0 access tokens. Currently <code>www.amazon.com</code> and <code>graph.facebook.com</code> are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers. </para> <para> Do not specify this value for OpenID Connect ID tokens. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.RoleArn"> <summary> Gets and sets the property RoleArn. <para> The Amazon Resource Name (ARN) of the role that the caller is assuming. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.RoleSessionName"> <summary> Gets and sets the property RoleSessionName. <para> An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the <code>AssumedRoleUser</code> response element. </para> <para> The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest.WebIdentityToken"> <summary> Gets and sets the property WebIdentityToken. <para> The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an <code>AssumeRoleWithWebIdentity</code> call. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse"> <summary> Contains the response to a successful <a>AssumeRoleWithWebIdentity</a> request, including temporary AWS credentials that can be used to make AWS requests. </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.AssumedRoleUser"> <summary> Gets and sets the property AssumedRoleUser. <para> The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the <code>RoleSessionName</code> that you specified when you called <code>AssumeRole</code>. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.Audience"> <summary> Gets and sets the property Audience. <para> The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.Credentials"> <summary> Gets and sets the property Credentials. <para> The temporary security credentials, which include an access key ID, a secret access key, and a security token. </para> <para> <b>Note:</b> The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.PackedPolicySize"> <summary> Gets and sets the property PackedPolicySize. <para> A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.Provider"> <summary> Gets and sets the property Provider. <para> The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the <code>iss</code> field. For OAuth 2.0 access tokens, this contains the value of the <code>ProviderId</code> parameter that was passed in the <code>AssumeRoleWithWebIdentity</code> request. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityResponse.SubjectFromWebIdentityToken"> <summary> Gets and sets the property SubjectFromWebIdentityToken. <para> The unique user identifier that is returned by the identity provider. This identifier is associated with the <code>WebIdentityToken</code> that was submitted with the <code>AssumeRoleWithWebIdentity</code> call. The identifier is typically unique to the user and the application that acquired the <code>WebIdentityToken</code> (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's <code>sub</code> (Subject) claim. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest"> <summary> Container for the parameters to the DecodeAuthorizationMessage operation. Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request. <para> For example, if a user is not authorized to perform an action that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS actions additionally return an encoded message that can provide details about this authorization failure. </para> <note> <para> Only certain AWS actions return an encoded authorization message. The documentation for an individual action indicates whether that action returns an encoded message in addition to returning an HTTP code. </para> </note> <para> The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the action should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the <code>DecodeAuthorizationMessage</code> (<code>sts:DecodeAuthorizationMessage</code>) action. </para> <para> The decoded message includes the following type of information: </para> <ul> <li> <para> Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow">Determining Whether a Request is Allowed or Denied</a> in the <i>IAM User Guide</i>. </para> </li> <li> <para> The principal who made the request. </para> </li> <li> <para> The requested action. </para> </li> <li> <para> The requested resource. </para> </li> <li> <para> The values of condition keys in the context of the user's request. </para> </li> </ul> </summary> </member> <member name="P:Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest.EncodedMessage"> <summary> Gets and sets the property EncodedMessage. <para> The encoded message that was returned with the response. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse"> <summary> A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request. </summary> </member> <member name="P:Amazon.SecurityToken.Model.DecodeAuthorizationMessageResponse.DecodedMessage"> <summary> Gets and sets the property DecodedMessage. <para> An XML document that contains the decoded message. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.ExpiredTokenException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.String)"> <summary> Constructs a new ExpiredTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.String,System.Exception)"> <summary> Construct instance of ExpiredTokenException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.Exception)"> <summary> Construct instance of ExpiredTokenException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of ExpiredTokenException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of ExpiredTokenException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.ExpiredTokenException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the ExpiredTokenException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.FederatedUser"> <summary> Identifiers for the federated user that is associated with the credentials. </summary> </member> <member name="M:Amazon.SecurityToken.Model.FederatedUser.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.SecurityToken.Model.FederatedUser.#ctor(System.String,System.String)"> <summary> Instantiates FederatedUser with the parameterized properties </summary> <param name="federatedUserId">The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.</param> <param name="arn">The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in <i>Using IAM</i>. </param> </member> <member name="P:Amazon.SecurityToken.Model.FederatedUser.Arn"> <summary> Gets and sets the property Arn. <para> The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in <i>Using IAM</i>. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.FederatedUser.FederatedUserId"> <summary> Gets and sets the property FederatedUserId. <para> The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetCallerIdentityRequest"> <summary> Container for the parameters to the GetCallerIdentity operation. Returns details about the IAM identity whose credentials are used to call the API. </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetCallerIdentityResponse"> <summary> Contains the response to a successful <a>GetCallerIdentity</a> request, including information about the entity making the request. </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetCallerIdentityResponse.Account"> <summary> Gets and sets the property Account. <para> The AWS account ID number of the account that owns or contains the calling entity. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetCallerIdentityResponse.Arn"> <summary> Gets and sets the property Arn. <para> The AWS ARN associated with the calling entity. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetCallerIdentityResponse.UserId"> <summary> Gets and sets the property UserId. <para> The unique identifier of the calling entity. The exact value depends on the type of entity making the call. The values returned are those listed in the <b>aws:userid</b> column in the <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_variables.html#principaltable">Principal table</a> found on the <b>Policy Variables</b> reference page in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetFederationTokenRequest"> <summary> Container for the parameters to the GetFederationToken operation. Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. Because you must call the <code>GetFederationToken</code> action using the long-term security credentials of an IAM user, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of <code>GetFederationToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <note> <para> If you are creating a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider, we recommend that you use <a href="http://aws.amazon.com/cognito/">Amazon Cognito</a> or <code>AssumeRoleWithWebIdentity</code>. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </para> </note> <para> The <code>GetFederationToken</code> action must be called by using the long-term AWS security credentials of an IAM user. You can also call <code>GetFederationToken</code> using the security credentials of an AWS root account, but we do not recommended it. Instead, we recommend that you create an IAM user for the purpose of the proxy application and then attach a policy to the IAM user that limits federated users to only the actions and resources that they need access to. For more information, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. </para> <para> The temporary security credentials that are obtained by using the long-term credentials of an IAM user are valid for the specified duration, from 900 seconds (15 minutes) up to a maximium of 129600 seconds (36 hours). The default is 43200 seconds (12 hours). Temporary credentials that are obtained by using AWS root account credentials have a maximum duration of 3600 seconds (1 hour). </para> <para> The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot use these credentials to call any IAM APIs. </para> </li> <li> <para> You cannot call any STS APIs except <code>GetCallerIdentity</code>. </para> </li> </ul> <para> <b>Permissions</b> </para> <para> The permissions for the temporary security credentials returned by <code>GetFederationToken</code> are determined by a combination of the following: </para> <ul> <li> <para> The policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. </para> </li> <li> <para> The policy that is passed as a parameter in the call. </para> </li> </ul> <para> The passed policy is attached to the temporary security credentials that result from the <code>GetFederationToken</code> API call--that is, to the <i>federated user</i>. When the federated user makes an AWS request, AWS evaluates the policy attached to the federated user in combination with the policy or policies attached to the IAM user whose credentials were used to call <code>GetFederationToken</code>. AWS allows the federated user's request only when both the federated user <i> <b>and</b> </i> the IAM user are explicitly allowed to perform the requested action. The passed policy cannot grant more permissions than those that are defined in the IAM user policy. </para> <para> A typical use case is that the permissions of the IAM user whose credentials are used to call <code>GetFederationToken</code> are designed to allow access to all the actions and resources that any federated user will need. Then, for individual users, you pass a policy to the operation that scopes down the permissions to a level that's appropriate to that individual user, using a policy that allows only a subset of permissions that are granted to the IAM user. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </para> </summary> </member> <member name="M:Amazon.SecurityToken.Model.GetFederationTokenRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="M:Amazon.SecurityToken.Model.GetFederationTokenRequest.#ctor(System.String)"> <summary> Instantiates GetFederationTokenRequest with the parameterized properties </summary> <param name="name">The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-</param> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenRequest.DurationSeconds"> <summary> Gets and sets the property DurationSeconds. <para> The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenRequest.Name"> <summary> Gets and sets the property Name. <para> The name of the federated user. The name is used as an identifier for the temporary security credentials (such as <code>Bob</code>). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy. </para> <para> The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenRequest.Policy"> <summary> Gets and sets the property Policy. <para> An IAM policy in JSON format that is passed with the <code>GetFederationToken</code> call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call <code>GetFederationToken</code>. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy. </para> <para> If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource. </para> <para> The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list (\u0020-\u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters. </para> <note> <para> The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size. </para> </note> <para> For more information about how permissions work, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_control-access_getfederationtoken.html">Permissions for GetFederationToken</a>. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetFederationTokenResponse"> <summary> Contains the response to a successful <a>GetFederationToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenResponse.Credentials"> <summary> Gets and sets the property Credentials. <para> The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. </para> <para> <b>Note:</b> The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenResponse.FederatedUser"> <summary> Gets and sets the property FederatedUser. <para> Identifiers for the federated user associated with the credentials (such as <code>arn:aws:sts::123456789012:federated-user/Bob</code> or <code>123456789012:Bob</code>). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetFederationTokenResponse.PackedPolicySize"> <summary> Gets and sets the property PackedPolicySize. <para> A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetSessionTokenRequest"> <summary> Container for the parameters to the GetSessionToken operation. Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>GetSessionToken</code> if you want to use MFA to protect programmatic calls to specific AWS APIs like Amazon EC2 <code>StopInstances</code>. MFA-enabled IAM users would need to call <code>GetSessionToken</code> and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to APIs that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of <code>GetSessionToken</code> with the other APIs that produce temporary credentials, see <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS APIs</a> in the <i>IAM User Guide</i>. <para> The <code>GetSessionToken</code> action must be called by using the long-term AWS security credentials of the AWS account or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify, from 900 seconds (15 minutes) up to a maximum of 129600 seconds (36 hours), with a default of 43200 seconds (12 hours); credentials that are created by using account credentials can range from 900 seconds (15 minutes) up to a maximum of 3600 seconds (1 hour), with a default of 1 hour. </para> <para> The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions: </para> <ul> <li> <para> You cannot call any IAM APIs unless MFA authentication information is included in the request. </para> </li> <li> <para> You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>. </para> </li> </ul> <note> <para> We recommend that you do not call <code>GetSessionToken</code> with root account credentials. Instead, follow our <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users">best practices</a> by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS. </para> </note> <para> The permissions associated with the temporary security credentials returned by <code>GetSessionToken</code> are based on the permissions associated with account or IAM user whose credentials are used to call the action. If <code>GetSessionToken</code> is called using root account credentials, the temporary credentials have root account permissions. Similarly, if <code>GetSessionToken</code> is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user. </para> <para> For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getsessiontoken">Temporary Credentials for Users in Untrusted Environments</a> in the <i>IAM User Guide</i>. </para> </summary> </member> <member name="M:Amazon.SecurityToken.Model.GetSessionTokenRequest.#ctor"> <summary> Empty constructor used to set properties independently even when a simple constructor is available </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetSessionTokenRequest.DurationSeconds"> <summary> Gets and sets the property DurationSeconds. <para> The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour. </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetSessionTokenRequest.SerialNumber"> <summary> Gets and sets the property SerialNumber. <para> The identification number of the MFA device that is associated with the IAM user who is making the <code>GetSessionToken</code> call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as <code>GAHT12345678</code>) or an Amazon Resource Name (ARN) for a virtual device (such as <code>arn:aws:iam::123456789012:mfa/user</code>). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials. </para> <para> The regex used to validated this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/- </para> </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetSessionTokenRequest.TokenCode"> <summary> Gets and sets the property TokenCode. <para> The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication. </para> <para> The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.GetSessionTokenResponse"> <summary> Contains the response to a successful <a>GetSessionToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </summary> </member> <member name="P:Amazon.SecurityToken.Model.GetSessionTokenResponse.Credentials"> <summary> Gets and sets the property Credentials. <para> The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token. </para> <para> <b>Note:</b> The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes. </para> </summary> </member> <member name="T:Amazon.SecurityToken.Model.IDPCommunicationErrorException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.String)"> <summary> Constructs a new IDPCommunicationErrorException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.String,System.Exception)"> <summary> Construct instance of IDPCommunicationErrorException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.Exception)"> <summary> Construct instance of IDPCommunicationErrorException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of IDPCommunicationErrorException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of IDPCommunicationErrorException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPCommunicationErrorException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the IDPCommunicationErrorException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.IDPRejectedClaimException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.String)"> <summary> Constructs a new IDPRejectedClaimException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.String,System.Exception)"> <summary> Construct instance of IDPRejectedClaimException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.Exception)"> <summary> Construct instance of IDPRejectedClaimException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of IDPRejectedClaimException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of IDPRejectedClaimException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.IDPRejectedClaimException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the IDPRejectedClaimException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumedRoleUserUnmarshaller"> <summary> Response Unmarshaller for AssumedRoleUser Object </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumedRoleUserUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumedRoleUserUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumedRoleUserUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleRequestMarshaller"> <summary> AssumeRole Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleRequestMarshaller.Marshall(Amazon.SecurityToken.Model.AssumeRoleRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleResponseUnmarshaller"> <summary> Response Unmarshaller for AssumeRole operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLRequestMarshaller"> <summary> AssumeRoleWithSAML Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLRequestMarshaller.Marshall(Amazon.SecurityToken.Model.AssumeRoleWithSAMLRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLResponseUnmarshaller"> <summary> Response Unmarshaller for AssumeRoleWithSAML operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithSAMLResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityRequestMarshaller"> <summary> AssumeRoleWithWebIdentity Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityRequestMarshaller.Marshall(Amazon.SecurityToken.Model.AssumeRoleWithWebIdentityRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for AssumeRoleWithWebIdentity operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.AssumeRoleWithWebIdentityResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.CredentialsUnmarshaller"> <summary> Response Unmarshaller for Credentials Object </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.CredentialsUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.CredentialsUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.CredentialsUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageRequestMarshaller"> <summary> DecodeAuthorizationMessage Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageRequestMarshaller.Marshall(Amazon.SecurityToken.Model.DecodeAuthorizationMessageRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageResponseUnmarshaller"> <summary> Response Unmarshaller for DecodeAuthorizationMessage operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.DecodeAuthorizationMessageResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.FederatedUserUnmarshaller"> <summary> Response Unmarshaller for FederatedUser Object </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.FederatedUserUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.FederatedUserUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.JsonUnmarshallerContext)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.FederatedUserUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityRequestMarshaller"> <summary> GetCallerIdentity Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityRequestMarshaller.Marshall(Amazon.SecurityToken.Model.GetCallerIdentityRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityResponseUnmarshaller"> <summary> Response Unmarshaller for GetCallerIdentity operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetCallerIdentityResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenRequestMarshaller"> <summary> GetFederationToken Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenRequestMarshaller.Marshall(Amazon.SecurityToken.Model.GetFederationTokenRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenResponseUnmarshaller"> <summary> Response Unmarshaller for GetFederationToken operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetFederationTokenResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenRequestMarshaller"> <summary> GetSessionToken Request Marshaller </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenRequestMarshaller.Marshall(Amazon.Runtime.AmazonWebServiceRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="input"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenRequestMarshaller.Marshall(Amazon.SecurityToken.Model.GetSessionTokenRequest)"> <summary> Marshaller the request object to the HTTP request. </summary> <param name="publicRequest"></param> <returns></returns> </member> <member name="T:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenResponseUnmarshaller"> <summary> Response Unmarshaller for GetSessionToken operation </summary> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenResponseUnmarshaller.Unmarshall(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext)"> <summary> Unmarshaller the response from the service to the response class. </summary> <param name="context"></param> <returns></returns> </member> <member name="M:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenResponseUnmarshaller.UnmarshallException(Amazon.Runtime.Internal.Transform.XmlUnmarshallerContext,System.Exception,System.Net.HttpStatusCode)"> <summary> Unmarshaller error response to exception. </summary> <param name="context"></param> <param name="innerException"></param> <param name="statusCode"></param> <returns></returns> </member> <member name="P:Amazon.SecurityToken.Model.Internal.MarshallTransformations.GetSessionTokenResponseUnmarshaller.Instance"> <summary> Gets the singleton. </summary> </member> <member name="T:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.String)"> <summary> Constructs a new InvalidAuthorizationMessageException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.String,System.Exception)"> <summary> Construct instance of InvalidAuthorizationMessageException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.Exception)"> <summary> Construct instance of InvalidAuthorizationMessageException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of InvalidAuthorizationMessageException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of InvalidAuthorizationMessageException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidAuthorizationMessageException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the InvalidAuthorizationMessageException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.InvalidIdentityTokenException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.String)"> <summary> Constructs a new InvalidIdentityTokenException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.String,System.Exception)"> <summary> Construct instance of InvalidIdentityTokenException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.Exception)"> <summary> Construct instance of InvalidIdentityTokenException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of InvalidIdentityTokenException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of InvalidIdentityTokenException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.InvalidIdentityTokenException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the InvalidIdentityTokenException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.MalformedPolicyDocumentException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.String)"> <summary> Constructs a new MalformedPolicyDocumentException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.String,System.Exception)"> <summary> Construct instance of MalformedPolicyDocumentException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.Exception)"> <summary> Construct instance of MalformedPolicyDocumentException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of MalformedPolicyDocumentException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of MalformedPolicyDocumentException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.MalformedPolicyDocumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the MalformedPolicyDocumentException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.PackedPolicyTooLargeException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.String)"> <summary> Constructs a new PackedPolicyTooLargeException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.String,System.Exception)"> <summary> Construct instance of PackedPolicyTooLargeException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.Exception)"> <summary> Construct instance of PackedPolicyTooLargeException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of PackedPolicyTooLargeException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of PackedPolicyTooLargeException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.PackedPolicyTooLargeException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the PackedPolicyTooLargeException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.Model.RegionDisabledException"> <summary> SecurityTokenService exception </summary> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.String)"> <summary> Constructs a new RegionDisabledException with the specified error message. </summary> <param name="message"> Describes the error encountered. </param> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.String,System.Exception)"> <summary> Construct instance of RegionDisabledException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.Exception)"> <summary> Construct instance of RegionDisabledException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of RegionDisabledException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of RegionDisabledException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.Model.RegionDisabledException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the RegionDisabledException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.SAML.AdfsAuthenticationController"> <summary> Implementation of IAuthenticationController, allowing authentication calls against an AD FS endpoint. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationController.Authenticate(System.Uri,System.Net.ICredentials,System.String,System.Net.WebProxy)"> <summary> Authenticates the user with the specified AD FS endpoint and yields the SAML response data for subsequent parsing. </summary> <param name="identityProvider"> The https endpoint of the federated identity provider. </param> <param name="credentials"> Credentials for the call. If null, the user's default network credentials will be used in a temporary impersonation context. </param> <param name="authenticationType"> The authentication type to be used with the endpoint. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. </param> <param name="proxySettings">Null or configured proxy settings for the HTTPS call.</param> <returns>The response data from a successful authentication request.</returns> </member> <member name="T:Amazon.SecurityToken.SAML.AdfsAuthenticationControllerException"> <summary> Custom exception thrown when authentication failure is detected against a configured AD FS endpoint. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationControllerException.#ctor(System.String)"> <summary> Initializes a new exception instance. </summary> <param name="message"></param> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationControllerException.#ctor(System.String,System.Exception)"> <summary> Initializes a new exception instance. </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationControllerException.#ctor(System.Exception)"> <summary> Initializes a new exception instance. </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationControllerException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the AdfsAuthenticationControllerException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.SAML.AdfsAuthenticationResponseParser"> <summary> Implementation of IAuthenticationResponseParser, allowing parsing of the responses for successful authentication calls against AD FS endpoints. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.AdfsAuthenticationResponseParser.Parse(System.String)"> <summary> Parses the authentication response (html) and extracts the SAML response (xml) for further parsing. </summary> <param name="authenticationResponse"> The HTML response data from the successful authentication call. </param> <returns> Assertion instance containing the data needed to support credential generation. </returns> </member> <member name="T:Amazon.SecurityToken.SAML.ImpersonationState"> <summary> Holds the temporary user impersonation state data, if needed across the SAML negotiation calls. </summary> </member> <member name="T:Amazon.SecurityToken.SAML.SAMLAssertion"> <summary> Contains the parsed SAML response data following successful user authentication against a federated endpoint. We only parse out the data we need to support generation of temporary AWS credentials. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.SAMLAssertion.AssertionDocument"> <summary> The full SAML assertion parsed from the identity provider's response. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.SAMLAssertion.RoleSet"> <summary> The collection of roles available to the authenticated user. he parsed friendly role name is used to key the entries. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAssertion.GetRoleCredentials(Amazon.SecurityToken.IAmazonSecurityTokenService,System.String,System.TimeSpan)"> <summary> Retrieves a set of temporary credentials for the specified role, valid for the specified timespan. If the SAML authentication data yield more than one role, a valid role name must be specified. </summary> <param name="stsClient">The STS client to use when making the AssumeRoleWithSAML request.</param> <param name="principalAndRoleArns"> The arns of the principal and role as returned in the SAML assertion. </param> <param name="duration">The valid timespan for the credentials.</param> <returns>Temporary session credentials for the specified or default role for the user.</returns> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAssertion.#ctor(System.String)"> <summary> Constructs a new SAML assertion wrapper based on a successful authentication response and extracts the role data contained in the assertion. </summary> <param name="assertion"></param> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAssertion.ExtractRoleData"> <summary> Parses the role data out of the assertion using xpath queries. We additionally parse the role ARNs to extract friendly role names that can be used in UI prompts in tooling. </summary> <returns>Dictionary of friendly role names to role arn mappings.</returns> </member> <member name="T:Amazon.SecurityToken.SAML.IAuthenticationController"> <summary> Interface implemented by plugins supplied to the SAMLAuthenticationController to perform the call to the authentication endpoint. The implementor returns the final response from the authentication process for subsequent parsing. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.IAuthenticationController.Authenticate(System.Uri,System.Net.ICredentials,System.String,System.Net.WebProxy)"> <summary> Calls the specified endpoint, optionally providing custom credentials. </summary> <param name="identityProvider">The endpoint providing </param> <param name="credentials"> Optional, if not supplied the token for the currently logged-in user is supplied to the authentication endpoint. </param> <param name="authenticationType"> The authentication type expected by the endpoint. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. </param> <param name="proxySettings">Null or configured proxy settings for the HTTPS call.</param> <returns>The raw response data from the authentication request.</returns> </member> <member name="T:Amazon.SecurityToken.SAML.IAuthenticationResponseParser"> <summary> Interface implemented by plugins supplied to the SAMLAuthenticationController to parse an authentication response returned by an IAuthenticator instance and yield a SAMLAssertion instance. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.IAuthenticationResponseParser.Parse(System.String)"> <summary> Parses the supplied reponse data to instantiate a SAMLAssertion instance containing IAM role and token data that can be used to generate temporary AWS credentials. </summary> <param name="authenticationResponse"> The response that was returned from user authentication. </param> <returns>SAMLAssertion instance corresponding to the response data.</returns> </member> <member name="T:Amazon.SecurityToken.SAML.SAMLAuthenticationController"> <summary> Helper class to perform SAML authentication negotiation for an identity provider and relying party combination. Yields a SAMLAssertion instance that can be used to retrieve temporary, auto-refreshing AWS credentials. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.SAMLAuthenticationController.AuthenticationController"> <summary> Handler that will be called to perform the authentication process to a defined endpoint. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.SAMLAuthenticationController.ResponseParser"> <summary> Handler that will be called to parse the response from a succesful authentication request. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.SAMLAuthenticationController.ProxySettings"> <summary> Proxy details if required for communication with the authentication endpoint. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAuthenticationController.#ctor"> <summary> Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAuthenticationController.#ctor(System.Net.WebProxy)"> <summary> Instantiates a controller instance configured to use the built-in AD FS classes to authenticate and parse the responses. The supplied proxy settings will be used in the HTTPS calls to the authentication endpoint. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAuthenticationController.#ctor(Amazon.SecurityToken.SAML.IAuthenticationController,Amazon.SecurityToken.SAML.IAuthenticationResponseParser,System.Net.WebProxy)"> <summary> Instantiates the controller to use the specified instances to perform authentication and response parsing. </summary> <param name="authenticationController"> Handler that will be called to perform authentication. </param> <param name="responseParser"> Handler that will be called to parse successful authentication responses </param> <param name="proxySettings"> Null or proxy settings that should be used when communicating with the authentication endpoint. </param> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAuthenticationController.GetSAMLAssertion(System.String,System.Net.ICredentials,System.String)"> <summary> Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained. </summary> <param name="identityProviderUrl">The authentication endpoint to be called.</param> <param name="credentials"> Credentials for the call. If null, the users default network credentials will be used in a temporary impersonation context. </param> <param name="authenticationType"> The authentication type expected by the endpoint. The default value if not specified is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. </param> <returns>SAMLAssertion instance wrapping the returned document on successful authentication.</returns> </member> <member name="M:Amazon.SecurityToken.SAML.SAMLAuthenticationController.GetSAMLAssertion(System.Uri,System.Net.ICredentials,System.String)"> <summary> Authenticates the specified network credentials with a provider endpoint and returns the SAML assertion data from which temporary AWS credentials can be obtained. </summary> <param name="identityProviderUrl">The authentication endpoint to be called.</param> <param name="credentials"> Credentials for the call. If null, the users default network credentials will be used in a temporary impersonation context. </param> <param name="authenticationType"> The authentication type expected by the endpoint. The default value if not specified is 'Kerberos'. Valid values are 'NTLM', 'Digest', 'Kerberos' and 'Negotiate'. </param> <returns>SAMLAssertion instance wrapping the returned document on successful authentication.</returns> </member> <member name="T:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials"> <summary> Temporary credentials that are created following successful authentication with a federated endpoint supporting SAML. </summary> <remarks> Currently only the SDK store supports profiles that contain the necessary data to support authentication and role-based credential generation. </remarks> </member> <member name="P:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.CustomCallbackState"> <summary> Any custom state passed when a credential callback was registered. </summary> </member> <member name="F:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.MinimumCredentialTimespan"> <summary> The minimum allowed timespan for generated credentials, per STS documentation. </summary> </member> <member name="F:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.MaximumCredentialTimespan"> <summary> The maximum allowed timespan for generated credentials, per STS documentation. </summary> </member> <member name="T:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.RequestUserCredential"> <summary> Callback signature for obtaining user credentials for authentication demands when the role profile is configured to not use the default identity. </summary> <param name="args"> Data about the credential demand including any custom state data that was supplied when the callback was registered. </param> <returns> The network credential to use in user authentication. Return null to signal the user declined to provide credentials and authentication should not proceed. </returns> </member> <member name="P:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.RequestUserCredentialCallback"> <summary> Registered callback for obtaining credentials to use in authentication. Required to be set if the role profile is not configured to use the default identity. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.#ctor"> <summary> Constructs an instance of StoredProfileSAMLCredentials. This constructor searches for details of the role to assume, and optional credentials to use with the endpoint, using the profile name specified in the App.config. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.#ctor(System.String,System.String)"> <summary> <para> Constructs an instance of StoredProfileSAMLCredentials. After construction call one of the Authenticate methods to authenticate the user/process and obtain temporary AWS credentials. </para> <para> For users who are domain joined (the role profile does not contain user identity information) the temporary credentials will be refreshed automatically as needed. Non domain-joined users (those with user identity data in the profile) are required to re-authenticate when credential refresh is required. An exception is thrown when attempt is made to refresh credentials in this scenario. The consuming code of this class should catch the exception and prompt the user for credentials, then call Authenticate to re-initialize with a new set of temporary AWS credentials. </para> </summary> <param name="profileName"> The name of the profile holding the necessary role data to enable authentication and credential generation. </param> <param name="profilesLocation">Reserved for future use.</param> <remarks>The ini-format credentials file is not currently supported.</remarks> </member> <member name="P:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.ProfileName"> <summary> Name of the profile being used. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.ProfilesLocation"> <summary> Location of the profiles, if used. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.ProfileData"> <summary> The data about the SAML endpoint and any required user credentials parsed from the profile. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.Validate"> <summary> If non-default credentials are to be used for authentication, validates that the authentication required callback has been populated. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.StoredProfileSAMLCredentials.GenerateNewCredentials"> <summary> Refresh credentials after expiry. If the role profile is configured to not use the default user identity, an exception is thrown if the UserAuthenticationCallback property has not been set. </summary> <returns></returns> </member> <member name="T:Amazon.SecurityToken.SAML.CredentialCallbackArgs"> <summary> State class passed on callback to demand user credentials when authentication is performed using a non-default identity. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.CredentialCallbackArgs.UserIdentity"> <summary> Contains the user identity that the user should supply a password for. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.CredentialCallbackArgs.CustomState"> <summary> Any custom state that was registered with the callback. </summary> </member> <member name="P:Amazon.SecurityToken.SAML.CredentialCallbackArgs.PreviousAuthenticationFailed"> <summary> Set if the callback was due to a failed authentication attempt. If false we are beginning to obtain or refresh credentials. </summary> </member> <member name="T:Amazon.SecurityToken.SAML.CredentialCallbackRequiredException"> <summary> Exception thrown on validation of a StoredProfileSAMLCredentials instance if the role profile is configured to use a non-default user identity and the QueryUserCredentialCallback on the instance has not been set. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.CredentialCallbackRequiredException.#ctor(System.String)"> <summary> Initializes a new exception instance. </summary> <param name="msg"></param> </member> <member name="M:Amazon.SecurityToken.SAML.CredentialCallbackRequiredException.#ctor(System.String,System.Exception)"> <summary> Initializes a new exception instance. </summary> <param name="msg"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.SAML.CredentialCallbackRequiredException.#ctor(System.Exception)"> <summary> Initializes a new exception instance. </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.SAML.CredentialCallbackRequiredException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the AdfsAuthenticationControllerException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.SAML.AuthenticationFailedException"> <summary> Custom exception type thrown when authentication for a user against the configured endpoint fails and a valid SAML assertion document could not be obtained. </summary> </member> <member name="M:Amazon.SecurityToken.SAML.AuthenticationFailedException.#ctor(System.String)"> <summary> Initializes a new exception instance. </summary> <param name="msg"></param> </member> <member name="M:Amazon.SecurityToken.SAML.AuthenticationFailedException.#ctor(System.String,System.Exception)"> <summary> Initializes a new exception instance. </summary> <param name="msg"></param> <param name="inner"></param> </member> <member name="M:Amazon.SecurityToken.SAML.AuthenticationFailedException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the AuthenticationFailedException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.AmazonSecurityTokenServiceConfig"> <summary> Configuration for accessing Amazon SecurityTokenService service </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceConfig.#ctor"> <summary> Default constructor </summary> </member> <member name="P:Amazon.SecurityToken.AmazonSecurityTokenServiceConfig.RegionEndpointServiceName"> <summary> The constant used to lookup in the region hash the endpoint. </summary> </member> <member name="P:Amazon.SecurityToken.AmazonSecurityTokenServiceConfig.ServiceVersion"> <summary> Gets the ServiceVersion property. </summary> </member> <member name="P:Amazon.SecurityToken.AmazonSecurityTokenServiceConfig.UserAgent"> <summary> Gets the value of UserAgent property. </summary> </member> <member name="T:Amazon.SecurityToken.AmazonSecurityTokenServiceException"> <summary> Common exception for the SecurityTokenService service. </summary> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.String)"> <summary> Construct instance of AmazonSecurityTokenServiceException </summary> <param name="message"></param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.String,System.Exception)"> <summary> Construct instance of AmazonSecurityTokenServiceException </summary> <param name="message"></param> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.Exception)"> <summary> Construct instance of AmazonSecurityTokenServiceException </summary> <param name="innerException"></param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.String,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of AmazonSecurityTokenServiceException </summary> <param name="message"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.String,System.Exception,Amazon.Runtime.ErrorType,System.String,System.String,System.Net.HttpStatusCode)"> <summary> Construct instance of AmazonSecurityTokenServiceException </summary> <param name="message"></param> <param name="innerException"></param> <param name="errorType"></param> <param name="errorCode"></param> <param name="requestId"></param> <param name="statusCode"></param> </member> <member name="M:Amazon.SecurityToken.AmazonSecurityTokenServiceException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)"> <summary> Constructs a new instance of the AmazonSecurityTokenServiceException class with serialized data. </summary> <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param> <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param> <exception cref="T:System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception> <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult" /> is zero (0). </exception> </member> <member name="T:Amazon.SecurityToken.AmazonSecurityTokenServiceRequest"> <summary> Base class for SecurityTokenService operation requests. </summary> </member> </members> </doc> |