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
// ================================================================= // // * WARNING * // // This file is generated! // // Changes made to this file will be overwritten. If changes are // required to the generated code, the service_crategen project // must be updated to generate the changes. // // ================================================================= use std::error::Error; use std::fmt; #[allow(warnings)] use futures::future; use futures::Future; use rusoto_core::credential::ProvideAwsCredentials; use rusoto_core::region; use rusoto_core::request::{BufferedHttpResponse, DispatchSignedRequest}; use rusoto_core::{Client, RusotoError, RusotoFuture}; use rusoto_core::param::{Params, ServiceParams}; use rusoto_core::proto::xml::error::*; use rusoto_core::proto::xml::util::{ characters, deserialize_elements, end_element, find_start_element, peek_at_name, skip_tree, start_element, }; use rusoto_core::proto::xml::util::{Next, Peek, XmlParseError, XmlResponse}; use rusoto_core::signature::SignedRequest; use serde_urlencoded; use std::str::FromStr; use xml::reader::ParserConfig; use xml::EventReader; struct AccessKeyIdTypeDeserializer; impl AccessKeyIdTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct AccessKeySecretTypeDeserializer; impl AccessKeySecretTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct AccountTypeDeserializer; impl AccountTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct ArnTypeDeserializer; impl ArnTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleRequest { /// <p><p>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds. </p> <note> <p>The <code>DurationSeconds</code> parameter 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. For more information, see <a href="https://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>.</p> </note></p> pub duration_seconds: Option<i64>, /// <p>A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the <code>ExternalId</code> parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see <a href="https://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>.</p> <p>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: =,.@:/-</p> pub external_id: Option<String>, /// <p><p>An IAM policy in JSON format that you want to use as an inline session policy.</p> <p>This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note></p> pub policy: Option<String>, /// <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.</p> <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see <a href="general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note> <p>Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> pub policy_arns: Option<Vec<PolicyDescriptorType>>, /// <p>The Amazon Resource Name (ARN) of the role to assume.</p> pub role_arn: String, /// <p>An identifier for the assumed role session.</p> <p>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 that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.</p> <p>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: =,.@-</p> pub role_session_name: String, /// <p>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>).</p> <p>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: =,.@-</p> pub serial_number: Option<String>, /// <p>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.</p> <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p> pub token_code: Option<String>, } /// Serialize `AssumeRoleRequest` contents to a `SignedRequest`. struct AssumeRoleRequestSerializer; impl AssumeRoleRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &AssumeRoleRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.duration_seconds { params.put(&format!("{}{}", prefix, "DurationSeconds"), &field_value); } if let Some(ref field_value) = obj.external_id { params.put(&format!("{}{}", prefix, "ExternalId"), &field_value); } if let Some(ref field_value) = obj.policy { params.put(&format!("{}{}", prefix, "Policy"), &field_value); } if let Some(ref field_value) = obj.policy_arns { PolicyDescriptorListTypeSerializer::serialize( params, &format!("{}{}", prefix, "PolicyArns"), field_value, ); } params.put(&format!("{}{}", prefix, "RoleArn"), &obj.role_arn); params.put( &format!("{}{}", prefix, "RoleSessionName"), &obj.role_session_name, ); if let Some(ref field_value) = obj.serial_number { params.put(&format!("{}{}", prefix, "SerialNumber"), &field_value); } if let Some(ref field_value) = obj.token_code { params.put(&format!("{}{}", prefix, "TokenCode"), &field_value); } } } /// <p>Contains the response to a successful <a>AssumeRole</a> request, including temporary AWS credentials that can be used to make AWS requests. </p> #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleResponse { /// <p>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>. </p> pub assumed_role_user: Option<AssumedRoleUser>, /// <p><p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p> <note> <p>The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.</p> </note></p> pub credentials: Option<Credentials>, /// <p>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.</p> pub packed_policy_size: Option<i64>, } struct AssumeRoleResponseDeserializer; impl AssumeRoleResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<AssumeRoleResponse, XmlParseError> { deserialize_elements::<_, AssumeRoleResponse, _>(tag_name, stack, |name, stack, obj| { match name { "AssumedRoleUser" => { obj.assumed_role_user = Some(AssumedRoleUserDeserializer::deserialize( "AssumedRoleUser", stack, )?); } "Credentials" => { obj.credentials = Some(CredentialsDeserializer::deserialize("Credentials", stack)?); } "PackedPolicySize" => { obj.packed_policy_size = Some(NonNegativeIntegerTypeDeserializer::deserialize( "PackedPolicySize", stack, )?); } _ => skip_tree(stack), } Ok(()) }) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleWithSAMLRequest { /// <p><p>The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the <code>DurationSeconds</code> parameter, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds. </p> <note> <p>The <code>DurationSeconds</code> parameter 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. For more information, see <a href="https://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>.</p> </note></p> pub duration_seconds: Option<i64>, /// <p><p>An IAM policy in JSON format that you want to use as an inline session policy.</p> <p>This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. </p> <p>The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note></p> pub policy: Option<String>, /// <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.</p> <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see <a href="general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note> <p>Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> pub policy_arns: Option<Vec<PolicyDescriptorType>>, /// <p>The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.</p> pub principal_arn: String, /// <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p> pub role_arn: String, /// <p>The base-64 encoded SAML authentication response provided by the IdP.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html">Configuring a Relying Party and Adding Claims</a> in the <i>IAM User Guide</i>. </p> pub saml_assertion: String, } /// Serialize `AssumeRoleWithSAMLRequest` contents to a `SignedRequest`. struct AssumeRoleWithSAMLRequestSerializer; impl AssumeRoleWithSAMLRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &AssumeRoleWithSAMLRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.duration_seconds { params.put(&format!("{}{}", prefix, "DurationSeconds"), &field_value); } if let Some(ref field_value) = obj.policy { params.put(&format!("{}{}", prefix, "Policy"), &field_value); } if let Some(ref field_value) = obj.policy_arns { PolicyDescriptorListTypeSerializer::serialize( params, &format!("{}{}", prefix, "PolicyArns"), field_value, ); } params.put(&format!("{}{}", prefix, "PrincipalArn"), &obj.principal_arn); params.put(&format!("{}{}", prefix, "RoleArn"), &obj.role_arn); params.put( &format!("{}{}", prefix, "SAMLAssertion"), &obj.saml_assertion, ); } } /// <p>Contains the response to a successful <a>AssumeRoleWithSAML</a> request, including temporary AWS credentials that can be used to make AWS requests. </p> #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleWithSAMLResponse { /// <p>The identifiers for the temporary security credentials that the operation returns.</p> pub assumed_role_user: Option<AssumedRoleUser>, /// <p> The value of the <code>Recipient</code> attribute of the <code>SubjectConfirmationData</code> element of the SAML assertion. </p> pub audience: Option<String>, /// <p><p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p> <note> <p>The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.</p> </note></p> pub credentials: Option<Credentials>, /// <p>The value of the <code>Issuer</code> element of the SAML assertion.</p> pub issuer: Option<String>, /// <p>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. </p> <p>The following pseudocode shows how the hash value is calculated:</p> <p> <code>BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )</code> </p> pub name_qualifier: Option<String>, /// <p>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.</p> pub packed_policy_size: Option<i64>, /// <p>The value of the <code>NameID</code> element in the <code>Subject</code> element of the SAML assertion.</p> pub subject: Option<String>, /// <p> 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>. </p> <p> 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.</p> pub subject_type: Option<String>, } struct AssumeRoleWithSAMLResponseDeserializer; impl AssumeRoleWithSAMLResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<AssumeRoleWithSAMLResponse, XmlParseError> { deserialize_elements::<_, AssumeRoleWithSAMLResponse, _>( tag_name, stack, |name, stack, obj| { match name { "AssumedRoleUser" => { obj.assumed_role_user = Some(AssumedRoleUserDeserializer::deserialize( "AssumedRoleUser", stack, )?); } "Audience" => { obj.audience = Some(AudienceDeserializer::deserialize("Audience", stack)?); } "Credentials" => { obj.credentials = Some(CredentialsDeserializer::deserialize("Credentials", stack)?); } "Issuer" => { obj.issuer = Some(IssuerDeserializer::deserialize("Issuer", stack)?); } "NameQualifier" => { obj.name_qualifier = Some(NameQualifierDeserializer::deserialize( "NameQualifier", stack, )?); } "PackedPolicySize" => { obj.packed_policy_size = Some(NonNegativeIntegerTypeDeserializer::deserialize( "PackedPolicySize", stack, )?); } "Subject" => { obj.subject = Some(SubjectDeserializer::deserialize("Subject", stack)?); } "SubjectType" => { obj.subject_type = Some(SubjectTypeDeserializer::deserialize("SubjectType", stack)?); } _ => skip_tree(stack), } Ok(()) }, ) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleWithWebIdentityRequest { /// <p><p>The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>.</p> <p>By default, the value is set to <code>3600</code> seconds. </p> <note> <p>The <code>DurationSeconds</code> parameter 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. For more information, see <a href="https://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>.</p> </note></p> pub duration_seconds: Option<i64>, /// <p><p>An IAM policy in JSON format that you want to use as an inline session policy.</p> <p>This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note></p> pub policy: Option<String>, /// <p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.</p> <p>This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see <a href="general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note> <p>Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> pub policy_arns: Option<Vec<PolicyDescriptorType>>, /// <p>The fully qualified host component of the domain name of the identity provider.</p> <p>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.</p> <p>Do not specify this value for OpenID Connect ID tokens.</p> pub provider_id: Option<String>, /// <p>The Amazon Resource Name (ARN) of the role that the caller is assuming.</p> pub role_arn: String, /// <p>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.</p> <p>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: =,.@-</p> pub role_session_name: String, /// <p>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. </p> pub web_identity_token: String, } /// Serialize `AssumeRoleWithWebIdentityRequest` contents to a `SignedRequest`. struct AssumeRoleWithWebIdentityRequestSerializer; impl AssumeRoleWithWebIdentityRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &AssumeRoleWithWebIdentityRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.duration_seconds { params.put(&format!("{}{}", prefix, "DurationSeconds"), &field_value); } if let Some(ref field_value) = obj.policy { params.put(&format!("{}{}", prefix, "Policy"), &field_value); } if let Some(ref field_value) = obj.policy_arns { PolicyDescriptorListTypeSerializer::serialize( params, &format!("{}{}", prefix, "PolicyArns"), field_value, ); } if let Some(ref field_value) = obj.provider_id { params.put(&format!("{}{}", prefix, "ProviderId"), &field_value); } params.put(&format!("{}{}", prefix, "RoleArn"), &obj.role_arn); params.put( &format!("{}{}", prefix, "RoleSessionName"), &obj.role_session_name, ); params.put( &format!("{}{}", prefix, "WebIdentityToken"), &obj.web_identity_token, ); } } /// <p>Contains the response to a successful <a>AssumeRoleWithWebIdentity</a> request, including temporary AWS credentials that can be used to make AWS requests. </p> #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumeRoleWithWebIdentityResponse { /// <p>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>. </p> pub assumed_role_user: Option<AssumedRoleUser>, /// <p>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.</p> pub audience: Option<String>, /// <p><p>The temporary security credentials, which include an access key ID, a secret access key, and a security token.</p> <note> <p>The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.</p> </note></p> pub credentials: Option<Credentials>, /// <p>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.</p> pub packed_policy_size: Option<i64>, /// <p> 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.</p> pub provider: Option<String>, /// <p>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. </p> pub subject_from_web_identity_token: Option<String>, } struct AssumeRoleWithWebIdentityResponseDeserializer; impl AssumeRoleWithWebIdentityResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<AssumeRoleWithWebIdentityResponse, XmlParseError> { deserialize_elements::<_, AssumeRoleWithWebIdentityResponse, _>( tag_name, stack, |name, stack, obj| { match name { "AssumedRoleUser" => { obj.assumed_role_user = Some(AssumedRoleUserDeserializer::deserialize( "AssumedRoleUser", stack, )?); } "Audience" => { obj.audience = Some(AudienceDeserializer::deserialize("Audience", stack)?); } "Credentials" => { obj.credentials = Some(CredentialsDeserializer::deserialize("Credentials", stack)?); } "PackedPolicySize" => { obj.packed_policy_size = Some(NonNegativeIntegerTypeDeserializer::deserialize( "PackedPolicySize", stack, )?); } "Provider" => { obj.provider = Some(IssuerDeserializer::deserialize("Provider", stack)?); } "SubjectFromWebIdentityToken" => { obj.subject_from_web_identity_token = Some(WebIdentitySubjectTypeDeserializer::deserialize( "SubjectFromWebIdentityToken", stack, )?); } _ => skip_tree(stack), } Ok(()) }, ) } } struct AssumedRoleIdTypeDeserializer; impl AssumedRoleIdTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } /// <p>The identifiers for the temporary security credentials that the operation returns.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct AssumedRoleUser { /// <p>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="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in <i>Using IAM</i>. </p> pub arn: String, /// <p>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.</p> pub assumed_role_id: String, } struct AssumedRoleUserDeserializer; impl AssumedRoleUserDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<AssumedRoleUser, XmlParseError> { deserialize_elements::<_, AssumedRoleUser, _>(tag_name, stack, |name, stack, obj| { match name { "Arn" => { obj.arn = ArnTypeDeserializer::deserialize("Arn", stack)?; } "AssumedRoleId" => { obj.assumed_role_id = AssumedRoleIdTypeDeserializer::deserialize("AssumedRoleId", stack)?; } _ => skip_tree(stack), } Ok(()) }) } } struct AudienceDeserializer; impl AudienceDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } /// <p>AWS credentials for API authentication.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct Credentials { /// <p>The access key ID that identifies the temporary security credentials.</p> pub access_key_id: String, /// <p>The date on which the current credentials expire.</p> pub expiration: String, /// <p>The secret access key that can be used to sign requests.</p> pub secret_access_key: String, /// <p>The token that users must pass to the service API to use the temporary credentials.</p> pub session_token: String, } struct CredentialsDeserializer; impl CredentialsDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<Credentials, XmlParseError> { deserialize_elements::<_, Credentials, _>(tag_name, stack, |name, stack, obj| { match name { "AccessKeyId" => { obj.access_key_id = AccessKeyIdTypeDeserializer::deserialize("AccessKeyId", stack)?; } "Expiration" => { obj.expiration = DateTypeDeserializer::deserialize("Expiration", stack)?; } "SecretAccessKey" => { obj.secret_access_key = AccessKeySecretTypeDeserializer::deserialize("SecretAccessKey", stack)?; } "SessionToken" => { obj.session_token = TokenTypeDeserializer::deserialize("SessionToken", stack)?; } _ => skip_tree(stack), } Ok(()) }) } } struct DateTypeDeserializer; impl DateTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct DecodeAuthorizationMessageRequest { /// <p>The encoded message that was returned with the response.</p> pub encoded_message: String, } /// Serialize `DecodeAuthorizationMessageRequest` contents to a `SignedRequest`. struct DecodeAuthorizationMessageRequestSerializer; impl DecodeAuthorizationMessageRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &DecodeAuthorizationMessageRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } params.put( &format!("{}{}", prefix, "EncodedMessage"), &obj.encoded_message, ); } } /// <p>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.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct DecodeAuthorizationMessageResponse { /// <p>An XML document that contains the decoded message.</p> pub decoded_message: Option<String>, } struct DecodeAuthorizationMessageResponseDeserializer; impl DecodeAuthorizationMessageResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<DecodeAuthorizationMessageResponse, XmlParseError> { deserialize_elements::<_, DecodeAuthorizationMessageResponse, _>( tag_name, stack, |name, stack, obj| { match name { "DecodedMessage" => { obj.decoded_message = Some(DecodedMessageTypeDeserializer::deserialize( "DecodedMessage", stack, )?); } _ => skip_tree(stack), } Ok(()) }, ) } } struct DecodedMessageTypeDeserializer; impl DecodedMessageTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct FederatedIdTypeDeserializer; impl FederatedIdTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } /// <p>Identifiers for the federated user that is associated with the credentials.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct FederatedUser { /// <p>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="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html">IAM Identifiers</a> in <i>Using IAM</i>. </p> pub arn: String, /// <p>The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.</p> pub federated_user_id: String, } struct FederatedUserDeserializer; impl FederatedUserDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<FederatedUser, XmlParseError> { deserialize_elements::<_, FederatedUser, _>(tag_name, stack, |name, stack, obj| { match name { "Arn" => { obj.arn = ArnTypeDeserializer::deserialize("Arn", stack)?; } "FederatedUserId" => { obj.federated_user_id = FederatedIdTypeDeserializer::deserialize("FederatedUserId", stack)?; } _ => skip_tree(stack), } Ok(()) }) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct GetCallerIdentityRequest {} /// Serialize `GetCallerIdentityRequest` contents to a `SignedRequest`. struct GetCallerIdentityRequestSerializer; impl GetCallerIdentityRequestSerializer { fn serialize(_params: &mut Params, name: &str, _obj: &GetCallerIdentityRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } } } /// <p>Contains the response to a successful <a>GetCallerIdentity</a> request, including information about the entity making the request.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct GetCallerIdentityResponse { /// <p>The AWS account ID number of the account that owns or contains the calling entity.</p> pub account: Option<String>, /// <p>The AWS ARN associated with the calling entity.</p> pub arn: Option<String>, /// <p>The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the <b>aws:userid</b> column in the <a href="https://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>.</p> pub user_id: Option<String>, } struct GetCallerIdentityResponseDeserializer; impl GetCallerIdentityResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<GetCallerIdentityResponse, XmlParseError> { deserialize_elements::<_, GetCallerIdentityResponse, _>( tag_name, stack, |name, stack, obj| { match name { "Account" => { obj.account = Some(AccountTypeDeserializer::deserialize("Account", stack)?); } "Arn" => { obj.arn = Some(ArnTypeDeserializer::deserialize("Arn", stack)?); } "UserId" => { obj.user_id = Some(UserIdTypeDeserializer::deserialize("UserId", stack)?); } _ => skip_tree(stack), } Ok(()) }, ) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct GetFederationTokenRequest { /// <p>The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour.</p> pub duration_seconds: Option<i64>, /// <p>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.</p> <p>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: =,.@-</p> pub name: String, /// <p><p>An IAM policy in JSON format that you want to use as an inline session policy.</p> <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.</p> <p>This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.</p> <p>When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\u0020 through \u00FF). It can also include the tab (\u0009), linefeed (\u000A), and carriage return (\u000D) characters.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note></p> pub policy: Option<String>, /// <p><p>The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.</p> <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see <a href="general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the AWS General Reference.</p> <p>This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy.</p> <p>When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <note> <p>The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The <code>PackedPolicySize</code> response element indicates by percentage how close the policy is to the upper size limit.</p> </note></p> pub policy_arns: Option<Vec<PolicyDescriptorType>>, } /// Serialize `GetFederationTokenRequest` contents to a `SignedRequest`. struct GetFederationTokenRequestSerializer; impl GetFederationTokenRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &GetFederationTokenRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.duration_seconds { params.put(&format!("{}{}", prefix, "DurationSeconds"), &field_value); } params.put(&format!("{}{}", prefix, "Name"), &obj.name); if let Some(ref field_value) = obj.policy { params.put(&format!("{}{}", prefix, "Policy"), &field_value); } if let Some(ref field_value) = obj.policy_arns { PolicyDescriptorListTypeSerializer::serialize( params, &format!("{}{}", prefix, "PolicyArns"), field_value, ); } } } /// <p>Contains the response to a successful <a>GetFederationToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </p> #[derive(Default, Debug, Clone, PartialEq)] pub struct GetFederationTokenResponse { /// <p><p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p> <note> <p>The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.</p> </note></p> pub credentials: Option<Credentials>, /// <p>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. </p> pub federated_user: Option<FederatedUser>, /// <p>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.</p> pub packed_policy_size: Option<i64>, } struct GetFederationTokenResponseDeserializer; impl GetFederationTokenResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<GetFederationTokenResponse, XmlParseError> { deserialize_elements::<_, GetFederationTokenResponse, _>( tag_name, stack, |name, stack, obj| { match name { "Credentials" => { obj.credentials = Some(CredentialsDeserializer::deserialize("Credentials", stack)?); } "FederatedUser" => { obj.federated_user = Some(FederatedUserDeserializer::deserialize( "FederatedUser", stack, )?); } "PackedPolicySize" => { obj.packed_policy_size = Some(NonNegativeIntegerTypeDeserializer::deserialize( "PackedPolicySize", stack, )?); } _ => skip_tree(stack), } Ok(()) }, ) } } #[derive(Default, Debug, Clone, PartialEq)] pub struct GetSessionTokenRequest { /// <p>The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.</p> pub duration_seconds: Option<i64>, /// <p>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. </p> <p>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: =,.@:/-</p> pub serial_number: Option<String>, /// <p>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, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an "access denied" response when requesting resources that require MFA authentication.</p> <p>The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.</p> pub token_code: Option<String>, } /// Serialize `GetSessionTokenRequest` contents to a `SignedRequest`. struct GetSessionTokenRequestSerializer; impl GetSessionTokenRequestSerializer { fn serialize(params: &mut Params, name: &str, obj: &GetSessionTokenRequest) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.duration_seconds { params.put(&format!("{}{}", prefix, "DurationSeconds"), &field_value); } if let Some(ref field_value) = obj.serial_number { params.put(&format!("{}{}", prefix, "SerialNumber"), &field_value); } if let Some(ref field_value) = obj.token_code { params.put(&format!("{}{}", prefix, "TokenCode"), &field_value); } } } /// <p>Contains the response to a successful <a>GetSessionToken</a> request, including temporary AWS credentials that can be used to make AWS requests. </p> #[derive(Default, Debug, Clone, PartialEq)] pub struct GetSessionTokenResponse { /// <p><p>The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.</p> <note> <p>The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.</p> </note></p> pub credentials: Option<Credentials>, } struct GetSessionTokenResponseDeserializer; impl GetSessionTokenResponseDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>( tag_name: &str, stack: &mut T, ) -> Result<GetSessionTokenResponse, XmlParseError> { deserialize_elements::<_, GetSessionTokenResponse, _>( tag_name, stack, |name, stack, obj| { match name { "Credentials" => { obj.credentials = Some(CredentialsDeserializer::deserialize("Credentials", stack)?); } _ => skip_tree(stack), } Ok(()) }, ) } } struct IssuerDeserializer; impl IssuerDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct NameQualifierDeserializer; impl NameQualifierDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct NonNegativeIntegerTypeDeserializer; impl NonNegativeIntegerTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<i64, XmlParseError> { start_element(tag_name, stack)?; let obj = i64::from_str(characters(stack)?.as_ref()).unwrap(); end_element(tag_name, stack)?; Ok(obj) } } /// Serialize `PolicyDescriptorListType` contents to a `SignedRequest`. struct PolicyDescriptorListTypeSerializer; impl PolicyDescriptorListTypeSerializer { fn serialize(params: &mut Params, name: &str, obj: &Vec<PolicyDescriptorType>) { for (index, obj) in obj.iter().enumerate() { let key = format!("{}.member.{}", name, index + 1); PolicyDescriptorTypeSerializer::serialize(params, &key, obj); } } } /// <p>A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user session.</p> #[derive(Default, Debug, Clone, PartialEq)] pub struct PolicyDescriptorType { /// <p>The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy for the role. For more information about ARNs, see <a href="general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p> pub arn: Option<String>, } /// Serialize `PolicyDescriptorType` contents to a `SignedRequest`. struct PolicyDescriptorTypeSerializer; impl PolicyDescriptorTypeSerializer { fn serialize(params: &mut Params, name: &str, obj: &PolicyDescriptorType) { let mut prefix = name.to_string(); if prefix != "" { prefix.push_str("."); } if let Some(ref field_value) = obj.arn { params.put(&format!("{}{}", prefix, "arn"), &field_value); } } } struct SubjectDeserializer; impl SubjectDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct SubjectTypeDeserializer; impl SubjectTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct TokenTypeDeserializer; impl TokenTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct UserIdTypeDeserializer; impl UserIdTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } struct WebIdentitySubjectTypeDeserializer; impl WebIdentitySubjectTypeDeserializer { #[allow(unused_variables)] fn deserialize<T: Peek + Next>(tag_name: &str, stack: &mut T) -> Result<String, XmlParseError> { start_element(tag_name, stack)?; let obj = characters(stack)?; end_element(tag_name, stack)?; Ok(obj) } } /// Errors returned by AssumeRole #[derive(Debug, PartialEq)] pub enum AssumeRoleError { /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p> MalformedPolicyDocument(String), /// <p>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.</p> PackedPolicyTooLarge(String), /// <p>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="https://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>.</p> RegionDisabled(String), } impl AssumeRoleError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<AssumeRoleError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "MalformedPolicyDocument" => { return RusotoError::Service(AssumeRoleError::MalformedPolicyDocument( parsed_error.message, )) } "PackedPolicyTooLarge" => { return RusotoError::Service(AssumeRoleError::PackedPolicyTooLarge( parsed_error.message, )) } "RegionDisabledException" => { return RusotoError::Service(AssumeRoleError::RegionDisabled( parsed_error.message, )) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for AssumeRoleError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for AssumeRoleError { fn description(&self) -> &str { match *self { AssumeRoleError::MalformedPolicyDocument(ref cause) => cause, AssumeRoleError::PackedPolicyTooLarge(ref cause) => cause, AssumeRoleError::RegionDisabled(ref cause) => cause, } } } /// Errors returned by AssumeRoleWithSAML #[derive(Debug, PartialEq)] pub enum AssumeRoleWithSAMLError { /// <p>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.</p> ExpiredToken(String), /// <p>The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.</p> <p>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. </p> IDPRejectedClaim(String), /// <p>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.</p> InvalidIdentityToken(String), /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p> MalformedPolicyDocument(String), /// <p>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.</p> PackedPolicyTooLarge(String), /// <p>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="https://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>.</p> RegionDisabled(String), } impl AssumeRoleWithSAMLError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<AssumeRoleWithSAMLError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "ExpiredTokenException" => { return RusotoError::Service(AssumeRoleWithSAMLError::ExpiredToken( parsed_error.message, )) } "IDPRejectedClaim" => { return RusotoError::Service(AssumeRoleWithSAMLError::IDPRejectedClaim( parsed_error.message, )) } "InvalidIdentityToken" => { return RusotoError::Service(AssumeRoleWithSAMLError::InvalidIdentityToken( parsed_error.message, )) } "MalformedPolicyDocument" => { return RusotoError::Service( AssumeRoleWithSAMLError::MalformedPolicyDocument(parsed_error.message), ) } "PackedPolicyTooLarge" => { return RusotoError::Service(AssumeRoleWithSAMLError::PackedPolicyTooLarge( parsed_error.message, )) } "RegionDisabledException" => { return RusotoError::Service(AssumeRoleWithSAMLError::RegionDisabled( parsed_error.message, )) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for AssumeRoleWithSAMLError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for AssumeRoleWithSAMLError { fn description(&self) -> &str { match *self { AssumeRoleWithSAMLError::ExpiredToken(ref cause) => cause, AssumeRoleWithSAMLError::IDPRejectedClaim(ref cause) => cause, AssumeRoleWithSAMLError::InvalidIdentityToken(ref cause) => cause, AssumeRoleWithSAMLError::MalformedPolicyDocument(ref cause) => cause, AssumeRoleWithSAMLError::PackedPolicyTooLarge(ref cause) => cause, AssumeRoleWithSAMLError::RegionDisabled(ref cause) => cause, } } } /// Errors returned by AssumeRoleWithWebIdentity #[derive(Debug, PartialEq)] pub enum AssumeRoleWithWebIdentityError { /// <p>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.</p> ExpiredToken(String), /// <p>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.</p> IDPCommunicationError(String), /// <p>The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.</p> <p>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. </p> IDPRejectedClaim(String), /// <p>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.</p> InvalidIdentityToken(String), /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p> MalformedPolicyDocument(String), /// <p>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.</p> PackedPolicyTooLarge(String), /// <p>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="https://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>.</p> RegionDisabled(String), } impl AssumeRoleWithWebIdentityError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<AssumeRoleWithWebIdentityError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "ExpiredTokenException" => { return RusotoError::Service(AssumeRoleWithWebIdentityError::ExpiredToken( parsed_error.message, )) } "IDPCommunicationError" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::IDPCommunicationError( parsed_error.message, ), ) } "IDPRejectedClaim" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::IDPRejectedClaim(parsed_error.message), ) } "InvalidIdentityToken" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::InvalidIdentityToken( parsed_error.message, ), ) } "MalformedPolicyDocument" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::MalformedPolicyDocument( parsed_error.message, ), ) } "PackedPolicyTooLarge" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::PackedPolicyTooLarge( parsed_error.message, ), ) } "RegionDisabledException" => { return RusotoError::Service( AssumeRoleWithWebIdentityError::RegionDisabled(parsed_error.message), ) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for AssumeRoleWithWebIdentityError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for AssumeRoleWithWebIdentityError { fn description(&self) -> &str { match *self { AssumeRoleWithWebIdentityError::ExpiredToken(ref cause) => cause, AssumeRoleWithWebIdentityError::IDPCommunicationError(ref cause) => cause, AssumeRoleWithWebIdentityError::IDPRejectedClaim(ref cause) => cause, AssumeRoleWithWebIdentityError::InvalidIdentityToken(ref cause) => cause, AssumeRoleWithWebIdentityError::MalformedPolicyDocument(ref cause) => cause, AssumeRoleWithWebIdentityError::PackedPolicyTooLarge(ref cause) => cause, AssumeRoleWithWebIdentityError::RegionDisabled(ref cause) => cause, } } } /// Errors returned by DecodeAuthorizationMessage #[derive(Debug, PartialEq)] pub enum DecodeAuthorizationMessageError { /// <p>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. </p> InvalidAuthorizationMessage(String), } impl DecodeAuthorizationMessageError { pub fn from_response( res: BufferedHttpResponse, ) -> RusotoError<DecodeAuthorizationMessageError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "InvalidAuthorizationMessageException" => { return RusotoError::Service( DecodeAuthorizationMessageError::InvalidAuthorizationMessage( parsed_error.message, ), ) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for DecodeAuthorizationMessageError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for DecodeAuthorizationMessageError { fn description(&self) -> &str { match *self { DecodeAuthorizationMessageError::InvalidAuthorizationMessage(ref cause) => cause, } } } /// Errors returned by GetCallerIdentity #[derive(Debug, PartialEq)] pub enum GetCallerIdentityError {} impl GetCallerIdentityError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetCallerIdentityError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for GetCallerIdentityError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for GetCallerIdentityError { fn description(&self) -> &str { match *self {} } } /// Errors returned by GetFederationToken #[derive(Debug, PartialEq)] pub enum GetFederationTokenError { /// <p>The request was rejected because the policy document was malformed. The error message describes the specific error.</p> MalformedPolicyDocument(String), /// <p>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.</p> PackedPolicyTooLarge(String), /// <p>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="https://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>.</p> RegionDisabled(String), } impl GetFederationTokenError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetFederationTokenError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "MalformedPolicyDocument" => { return RusotoError::Service( GetFederationTokenError::MalformedPolicyDocument(parsed_error.message), ) } "PackedPolicyTooLarge" => { return RusotoError::Service(GetFederationTokenError::PackedPolicyTooLarge( parsed_error.message, )) } "RegionDisabledException" => { return RusotoError::Service(GetFederationTokenError::RegionDisabled( parsed_error.message, )) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for GetFederationTokenError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for GetFederationTokenError { fn description(&self) -> &str { match *self { GetFederationTokenError::MalformedPolicyDocument(ref cause) => cause, GetFederationTokenError::PackedPolicyTooLarge(ref cause) => cause, GetFederationTokenError::RegionDisabled(ref cause) => cause, } } } /// Errors returned by GetSessionToken #[derive(Debug, PartialEq)] pub enum GetSessionTokenError { /// <p>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="https://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>.</p> RegionDisabled(String), } impl GetSessionTokenError { pub fn from_response(res: BufferedHttpResponse) -> RusotoError<GetSessionTokenError> { { let reader = EventReader::new(res.body.as_ref()); let mut stack = XmlResponse::new(reader.into_iter().peekable()); find_start_element(&mut stack); if let Ok(parsed_error) = Self::deserialize(&mut stack) { match &parsed_error.code[..] { "RegionDisabledException" => { return RusotoError::Service(GetSessionTokenError::RegionDisabled( parsed_error.message, )) } _ => {} } } } RusotoError::Unknown(res) } fn deserialize<T>(stack: &mut T) -> Result<XmlError, XmlParseError> where T: Peek + Next, { start_element("ErrorResponse", stack)?; XmlErrorDeserializer::deserialize("Error", stack) } } impl fmt::Display for GetSessionTokenError { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{}", self.description()) } } impl Error for GetSessionTokenError { fn description(&self) -> &str { match *self { GetSessionTokenError::RegionDisabled(ref cause) => cause, } } } /// Trait representing the capabilities of the AWS STS API. AWS STS clients implement this trait. pub trait Sts { /// <p>Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>AssumeRole</code> within your account or for cross-account access. For a comparison of <code>AssumeRole</code> with other API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <important> <p>You cannot use AWS account root user credentials to call <code>AssumeRole</code>. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>.</p> </important> <p>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. 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="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p>By default, the temporary security credentials created by <code>AssumeRole</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>.</p> <p>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 AWS STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>To assume a role from a different account, 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 that access to users in the account. </p> <p>A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call <code>AssumeRole</code> for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:</p> <ul> <li> <p>Attach a policy to the user (identical to the previous user in a different account).</p> </li> <li> <p>Add the user as a principal directly in the role's trust policy.</p> </li> </ul> <p>In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the <i>IAM User Guide</i>.</p> <p> <b>Using MFA with AssumeRole</b> </p> <p>(Optional) You can include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with 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.</p> <p> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide.</p> <p>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 device produces. </p> fn assume_role( &self, input: AssumeRoleRequest, ) -> RusotoFuture<AssumeRoleResponse, AssumeRoleError>; /// <p><p>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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>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.</p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithSAML</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole<em></code> API operations or the <code>assume-role</em></code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>.</p> <p>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 <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>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. You must also create an IAM role that specifies this SAML provider in its trust policy. </p> <p>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. </p> <important> <p>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 <code>NameIDType</code> 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>).</p> </important> <p>For more information, see the following resources:</p> <ul> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> </ul></p> fn assume_role_with_saml( &self, input: AssumeRoleWithSAMLRequest, ) -> RusotoFuture<AssumeRoleWithSAMLResponse, AssumeRoleWithSAMLError>; /// <p><p>Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.</p> <note> <p>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 Developer Guide</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android Developer Guide</a> to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.</p> <p>To learn more about Amazon Cognito, see <a href="https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in <i>AWS SDK for Android Developer Guide</i> and <a href="https://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>.</p> </note> <p>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. You also don't need to deploy 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>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 API operations.</p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole<em></code> API operations or the <code>assume-role</em></code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p>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 <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>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. </p> <important> <p>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>.</p> </important> <p>For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation API Operations for Mobile Apps</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </p> </li> <li> <p> <a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </p> </li> <li> <p> <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS Developer Guide</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android Developer Guide</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. </p> </li> <li> <p> <a href="http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications">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. </p> </li> </ul></p> fn assume_role_with_web_identity( &self, input: AssumeRoleWithWebIdentityRequest, ) -> RusotoFuture<AssumeRoleWithWebIdentityResponse, AssumeRoleWithWebIdentityError>; /// <p><p>Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.</p> <p>For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. </p> <note> <p>Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.</p> </note> <p>The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation 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. </p> <p>The decoded message includes the following type of information:</p> <ul> <li> <p>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="https://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>. </p> </li> <li> <p>The principal who made the request.</p> </li> <li> <p>The requested action.</p> </li> <li> <p>The requested resource.</p> </li> <li> <p>The values of condition keys in the context of the user's request.</p> </li> </ul></p> fn decode_authorization_message( &self, input: DecodeAuthorizationMessageRequest, ) -> RusotoFuture<DecodeAuthorizationMessageResponse, DecodeAuthorizationMessageError>; /// <p>Returns details about the IAM identity whose credentials are used to call the API.</p> fn get_caller_identity( &self, input: GetCallerIdentityRequest, ) -> RusotoFuture<GetCallerIdentityResponse, GetCallerIdentityError>; /// <p>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. You must call the <code>GetFederationToken</code> operation using the long-term security credentials of an IAM user. As a result, 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <note> <p>You can create 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. In this case, 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="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>.</p> </note> <p>You can also call <code>GetFederationToken</code> using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. </p> <p>The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).</p> <p>The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions:</p> <ul> <li> <p>You cannot use these credentials to call any IAM API operations.</p> </li> <li> <p>You cannot call any STS API operations except <code>GetCallerIdentity</code>.</p> </li> </ul> <p> <b>Permissions</b> </p> <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.</p> <p>Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </p> fn get_federation_token( &self, input: GetFederationTokenRequest, ) -> RusotoFuture<GetFederationTokenResponse, GetFederationTokenError>; /// <p>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 API operations 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 API operations 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>The <code>GetSessionToken</code> operation must be called by using the long-term AWS security credentials of the AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour. </p> <p>The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions:</p> <ul> <li> <p>You cannot call any IAM API operations unless MFA authentication information is included in the request.</p> </li> <li> <p>You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>.</p> </li> </ul> <note> <p>We recommend that you do not call <code>GetSessionToken</code> with AWS account root user credentials. Instead, follow our <a href="https://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. </p> </note> <p>The credentials that are returned by <code>GetSessionToken</code> are based on permissions associated with the user whose credentials were used to call the operation. If <code>GetSessionToken</code> is called using AWS account root user credentials, the temporary credentials have root user 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. </p> <p>For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="https://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>. </p> fn get_session_token( &self, input: GetSessionTokenRequest, ) -> RusotoFuture<GetSessionTokenResponse, GetSessionTokenError>; } /// A client for the AWS STS API. #[derive(Clone)] pub struct StsClient { client: Client, region: region::Region, } impl StsClient { /// Creates a client backed by the default tokio event loop. /// /// The client will use the default credentials provider and tls client. pub fn new(region: region::Region) -> StsClient { StsClient { client: Client::shared(), region, } } pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: region::Region, ) -> StsClient where P: ProvideAwsCredentials + Send + Sync + 'static, P::Future: Send, D: DispatchSignedRequest + Send + Sync + 'static, D::Future: Send, { StsClient { client: Client::new_with(credentials_provider, request_dispatcher), region, } } } impl Sts for StsClient { /// <p>Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use <code>AssumeRole</code> within your account or for cross-account access. For a comparison of <code>AssumeRole</code> with other API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <important> <p>You cannot use AWS account root user credentials to call <code>AssumeRole</code>. You must use credentials for an IAM user or an IAM role to call <code>AssumeRole</code>.</p> </important> <p>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. 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="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p>By default, the temporary security credentials created by <code>AssumeRole</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole*</code> API operations or the <code>assume-role*</code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>.</p> <p>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 AWS STS <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>To assume a role from a different account, 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 that access to users in the account. </p> <p>A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call <code>AssumeRole</code> for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:</p> <ul> <li> <p>Attach a policy to the user (identical to the previous user in a different account).</p> </li> <li> <p>Add the user as a principal directly in the role's trust policy.</p> </li> </ul> <p>In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html">IAM Policies</a> in the <i>IAM User Guide</i>.</p> <p> <b>Using MFA with AssumeRole</b> </p> <p>(Optional) You can include multi-factor authentication (MFA) information when you call <code>AssumeRole</code>. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with 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.</p> <p> <code>"Condition": {"Bool": {"aws:MultiFactorAuthPresent": true}}</code> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/MFAProtectedAPI.html">Configuring MFA-Protected API Access</a> in the <i>IAM User Guide</i> guide.</p> <p>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 device produces. </p> fn assume_role( &self, input: AssumeRoleRequest, ) -> RusotoFuture<AssumeRoleResponse, AssumeRoleError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "AssumeRole"); params.put("Version", "2011-06-15"); AssumeRoleRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new( response .buffer() .from_err() .and_then(|response| Err(AssumeRoleError::from_response(response))), ); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = AssumeRoleResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = AssumeRoleResponseDeserializer::deserialize( "AssumeRoleResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p><p>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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>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.</p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithSAML</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's <code>SessionNotOnOrAfter</code> value, whichever is shorter. You can provide a <code>DurationSeconds</code> value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole<em></code> API operations or the <code>assume-role</em></code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>.</p> <p>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 <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>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. You must also create an IAM role that specifies this SAML provider in its trust policy. </p> <p>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. </p> <important> <p>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 <code>NameIDType</code> 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>).</p> </important> <p>For more information, see the following resources:</p> <ul> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> <li> <p> <a href="https://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>. </p> </li> </ul></p> fn assume_role_with_saml( &self, input: AssumeRoleWithSAMLRequest, ) -> RusotoFuture<AssumeRoleWithSAMLResponse, AssumeRoleWithSAMLError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "AssumeRoleWithSAML"); params.put("Version", "2011-06-15"); AssumeRoleWithSAMLRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new( response .buffer() .from_err() .and_then(|response| Err(AssumeRoleWithSAMLError::from_response(response))), ); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = AssumeRoleWithSAMLResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = AssumeRoleWithSAMLResponseDeserializer::deserialize( "AssumeRoleWithSAMLResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p><p>Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.</p> <note> <p>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 Developer Guide</a> and the <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android Developer Guide</a> to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.</p> <p>To learn more about Amazon Cognito, see <a href="https://docs.aws.amazon.com/mobile/sdkforandroid/developerguide/cognito-auth.html#d0e840">Amazon Cognito Overview</a> in <i>AWS SDK for Android Developer Guide</i> and <a href="https://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>.</p> </note> <p>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. You also don't need to deploy 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>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 API operations.</p> <p>By default, the temporary security credentials created by <code>AssumeRoleWithWebIdentity</code> last for one hour. However, you can use the optional <code>DurationSeconds</code> parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html#id_roles_use_view-role-max-session">View the Maximum Session Duration Setting for a Role</a> in the <i>IAM User Guide</i>. The maximum session duration limit applies when you use the <code>AssumeRole<em></code> API operations or the <code>assume-role</em></code> CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html">Using IAM Roles</a> in the <i>IAM User Guide</i>. </p> <p>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 <code>GetFederationToken</code> or <code>GetSessionToken</code> API operations.</p> <p>(Optional) You can pass inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policies</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>.</p> <p>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. </p> <important> <p>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>.</p> </important> <p>For more information about how to use web identity federation and the <code>AssumeRoleWithWebIdentity</code> API, see the following resources: </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc_manual.html">Using Web Identity Federation API Operations for Mobile Apps</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>. </p> </li> <li> <p> <a href="https://web-identity-federation-playground.s3.amazonaws.com/index.html"> Web Identity Federation Playground</a>. Walk through the process of authenticating through Login with Amazon, Facebook, or Google, getting temporary security credentials, and then using those credentials to make a request to AWS. </p> </li> <li> <p> <a href="http://aws.amazon.com/sdkforios/">AWS SDK for iOS Developer Guide</a> and <a href="http://aws.amazon.com/sdkforandroid/">AWS SDK for Android Developer Guide</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. </p> </li> <li> <p> <a href="http://aws.amazon.com/articles/web-identity-federation-with-mobile-applications">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. </p> </li> </ul></p> fn assume_role_with_web_identity( &self, input: AssumeRoleWithWebIdentityRequest, ) -> RusotoFuture<AssumeRoleWithWebIdentityResponse, AssumeRoleWithWebIdentityError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "AssumeRoleWithWebIdentity"); params.put("Version", "2011-06-15"); AssumeRoleWithWebIdentityRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new(response.buffer().from_err().and_then(|response| { Err(AssumeRoleWithWebIdentityError::from_response(response)) })); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = AssumeRoleWithWebIdentityResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = AssumeRoleWithWebIdentityResponseDeserializer::deserialize( "AssumeRoleWithWebIdentityResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p><p>Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.</p> <p>For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a <code>Client.UnauthorizedOperation</code> response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure. </p> <note> <p>Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.</p> </note> <p>The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation 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. </p> <p>The decoded message includes the following type of information:</p> <ul> <li> <p>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="https://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>. </p> </li> <li> <p>The principal who made the request.</p> </li> <li> <p>The requested action.</p> </li> <li> <p>The requested resource.</p> </li> <li> <p>The values of condition keys in the context of the user's request.</p> </li> </ul></p> fn decode_authorization_message( &self, input: DecodeAuthorizationMessageRequest, ) -> RusotoFuture<DecodeAuthorizationMessageResponse, DecodeAuthorizationMessageError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "DecodeAuthorizationMessage"); params.put("Version", "2011-06-15"); DecodeAuthorizationMessageRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new(response.buffer().from_err().and_then(|response| { Err(DecodeAuthorizationMessageError::from_response(response)) })); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = DecodeAuthorizationMessageResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = DecodeAuthorizationMessageResponseDeserializer::deserialize( "DecodeAuthorizationMessageResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p>Returns details about the IAM identity whose credentials are used to call the API.</p> fn get_caller_identity( &self, input: GetCallerIdentityRequest, ) -> RusotoFuture<GetCallerIdentityResponse, GetCallerIdentityError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "GetCallerIdentity"); params.put("Version", "2011-06-15"); GetCallerIdentityRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new( response .buffer() .from_err() .and_then(|response| Err(GetCallerIdentityError::from_response(response))), ); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = GetCallerIdentityResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = GetCallerIdentityResponseDeserializer::deserialize( "GetCallerIdentityResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p>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. You must call the <code>GetFederationToken</code> operation using the long-term security credentials of an IAM user. As a result, 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <note> <p>You can create 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. In this case, 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="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_assumerolewithwebidentity">Federation Through a Web-based Identity Provider</a>.</p> </note> <p>You can also call <code>GetFederationToken</code> using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html">IAM Best Practices</a> in the <i>IAM User Guide</i>. </p> <p>The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).</p> <p>The temporary security credentials created by <code>GetFederationToken</code> can be used to make API calls to any AWS service with the following exceptions:</p> <ul> <li> <p>You cannot use these credentials to call any IAM API operations.</p> </li> <li> <p>You cannot call any STS API operations except <code>GetCallerIdentity</code>.</p> </li> </ul> <p> <b>Permissions</b> </p> <p>You must pass an inline or managed <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">session policy</a> to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.</p> <p>Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the <code>Principal</code> element of the policy. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session">Session Policies</a> in the <i>IAM User Guide</i>. For information about using <code>GetFederationToken</code> to create temporary security credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken">GetFederationToken—Federation Through a Custom Identity Broker</a>. </p> fn get_federation_token( &self, input: GetFederationTokenRequest, ) -> RusotoFuture<GetFederationTokenResponse, GetFederationTokenError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "GetFederationToken"); params.put("Version", "2011-06-15"); GetFederationTokenRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new( response .buffer() .from_err() .and_then(|response| Err(GetFederationTokenError::from_response(response))), ); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = GetFederationTokenResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = GetFederationTokenResponseDeserializer::deserialize( "GetFederationTokenResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } /// <p>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 API operations 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 API operations 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 API operations that produce temporary credentials, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html">Requesting Temporary Security Credentials</a> and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#stsapi_comparison">Comparing the AWS STS API operations</a> in the <i>IAM User Guide</i>.</p> <p>The <code>GetSessionToken</code> operation must be called by using the long-term AWS security credentials of the AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour. </p> <p>The temporary security credentials created by <code>GetSessionToken</code> can be used to make API calls to any AWS service with the following exceptions:</p> <ul> <li> <p>You cannot call any IAM API operations unless MFA authentication information is included in the request.</p> </li> <li> <p>You cannot call any STS API <i>except</i> <code>AssumeRole</code> or <code>GetCallerIdentity</code>.</p> </li> </ul> <note> <p>We recommend that you do not call <code>GetSessionToken</code> with AWS account root user credentials. Instead, follow our <a href="https://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. </p> </note> <p>The credentials that are returned by <code>GetSessionToken</code> are based on permissions associated with the user whose credentials were used to call the operation. If <code>GetSessionToken</code> is called using AWS account root user credentials, the temporary credentials have root user 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. </p> <p>For more information about using <code>GetSessionToken</code> to create temporary credentials, go to <a href="https://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>. </p> fn get_session_token( &self, input: GetSessionTokenRequest, ) -> RusotoFuture<GetSessionTokenResponse, GetSessionTokenError> { let mut request = SignedRequest::new("POST", "sts", &self.region, "/"); let mut params = Params::new(); params.put("Action", "GetSessionToken"); params.put("Version", "2011-06-15"); GetSessionTokenRequestSerializer::serialize(&mut params, "", &input); request.set_payload(Some(serde_urlencoded::to_string(¶ms).unwrap())); request.set_content_type("application/x-www-form-urlencoded".to_owned()); self.client.sign_and_dispatch(request, |response| { if !response.status.is_success() { return Box::new( response .buffer() .from_err() .and_then(|response| Err(GetSessionTokenError::from_response(response))), ); } Box::new(response.buffer().from_err().and_then(move |response| { let result; if response.body.is_empty() { result = GetSessionTokenResponse::default(); } else { let reader = EventReader::new_with_config( response.body.as_ref(), ParserConfig::new().trim_whitespace(true), ); let mut stack = XmlResponse::new(reader.into_iter().peekable()); let _start_document = stack.next(); let actual_tag_name = peek_at_name(&mut stack)?; start_element(&actual_tag_name, &mut stack)?; result = GetSessionTokenResponseDeserializer::deserialize( "GetSessionTokenResult", &mut stack, )?; skip_tree(&mut stack); end_element(&actual_tag_name, &mut stack)?; } // parse non-payload Ok(result) })) }) } } #[cfg(test)] mod protocol_tests { extern crate rusoto_mock; use self::rusoto_mock::*; use super::*; use rusoto_core::Region as rusoto_region; #[test] fn test_parse_error_sts_get_session_token() { let mock_response = MockResponseReader::read_response( "test_resources/generated/error", "sts-get-session-token.xml", ); let mock = MockRequestDispatcher::with_status(400).with_body(&mock_response); let client = StsClient::new_with(mock, MockCredentialsProvider, rusoto_region::UsEast1); let request = GetSessionTokenRequest::default(); let result = client.get_session_token(request).sync(); assert!(!result.is_ok(), "parse error: {:?}", result); } #[test] fn test_parse_valid_sts_get_session_token() { let mock_response = MockResponseReader::read_response( "test_resources/generated/valid", "sts-get-session-token.xml", ); let mock = MockRequestDispatcher::with_status(200).with_body(&mock_response); let client = StsClient::new_with(mock, MockCredentialsProvider, rusoto_region::UsEast1); let request = GetSessionTokenRequest::default(); let result = client.get_session_token(request).sync(); assert!(result.is_ok(), "parse error: {:?}", result); } }