/usr/lib/python3/dist-packages/botocore/data/aws/elb/2012-06-01.json is in python3-botocore 0.62.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 | {
"api_version": "2012-06-01",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"service_full_name": "Elastic Load Balancing",
"endpoint_prefix": "elasticloadbalancing",
"xmlnamespace": "http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/",
"documentation": "\n \t<fullname>Elastic Load Balancing</fullname>\n \n <p>Elastic Load Balancing is a way to automatically distribute incoming web traffic across \n applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances. \n </p>\n \n <p>You can create, access, and manage Elastic Load Balancing \n using the AWS Management Console or the Elastic Load Balancing API. \n For more information about Elastic Load Balancing interfaces, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/SvcIntro_Interfaces.html\">Accessing Elastic Load Balancing</a>.</p>\n \n <p>This reference guide contains documentation for the Query API and the AWS command line interface commands, to manage Elastic Load Balancing. </p>\n \n <p>For detailed information about Elastic Load Balancing features and their associated actions or commands, go to \n <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenarios.html\">Managing Load Balancers</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n <p>This reference guide is based on the current WSDL, which is available at:\n <a href=\"http://ec2-downloads.s3.amazonaws.com/ElasticLoadBalancing.wsdl\"></a>. </p>\n <p><b>Endpoints</b></p>\n <p>The examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.</p>\n <p>You can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see \n <a href=\"http://docs.aws.amazon.com/general/latest/gr/index.html?rande.html\">Regions and Endpoints</a> \n in the Amazon Web Services General Reference.\n </p>\n \n ",
"operations": {
"AddTags": {
"name": "AddTags",
"input": {
"shape_name": "AddTagsInput",
"type": "structure",
"members": {
"LoadBalancerNames": {
"shape_name": "LoadBalancerNames",
"type": "list",
"members": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The name of the load balancer to tag. You can specify a maximum of one load balancer name.</p>\n ",
"required": true
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "TagKey",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 1,
"max_length": 128,
"documentation": "\n <p>The key of the tag.</p> \n ",
"required": true
},
"Value": {
"shape_name": "TagValue",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 0,
"max_length": 256,
"documentation": " \n <p>The value of the tag.</p>\n "
}
},
"documentation": "\n <p>Metadata assigned to a load balancer consisting of key-value pair.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb\">Tagging</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n "
},
"min_length": 1,
"documentation": "\n <p>A list of tags for each load balancer.</p>\n \n ",
"required": true
}
},
"documentation": "\n The input for the <a>AddTags</a> action \n "
},
"output": {
"shape_name": "AddTagsOutput",
"type": "structure",
"members": {},
"documentation": "\n The output for the <a>AddTags</a> action. \n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "TooManyTagsException",
"type": "structure",
"members": {},
"documentation": "\n <p>The quota for the number of tags that can be assigned to a load balancer has been reached.</p>\n "
},
{
"shape_name": "DuplicateTagKeysException",
"type": "structure",
"members": {},
"documentation": "\n <p>The same tag key specified multiple times.</p> \n "
}
],
"documentation": "\n <p>Adds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. \n Each tag consists of a key and an optional value.</p>\n \n <p>Tag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, \n this action will update the value of the key.</p> \n \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb\">Tagging</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerNames.member.1=my-test-loadbalancer\n&Action=AddTags\n&Tags.member.1.Key=project\n&Tags.member.1.Value=my-test-project\n&Version=2012-06-01\n&AUTHPARAMS </queryrequest> \n <queryresponse><AddTagsResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <AddTagsResult/>\n <ResponseMetadata>\n <RequestId>360e81f7-1100-11e4-b6ed-0f30EXAMPLE</RequestId>\n </ResponseMetadata>\n</AddTagsResponse> \n </queryresponse>\n </examples> \n "
},
"ApplySecurityGroupsToLoadBalancer": {
"name": "ApplySecurityGroupsToLoadBalancer",
"input": {
"shape_name": "ApplySecurityGroupsToLoadBalancerInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account. \n </p> \n ",
"required": true
},
"SecurityGroups": {
"shape_name": "SecurityGroups",
"type": "list",
"members": {
"shape_name": "SecurityGroupId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of security group IDs to associate with your load balancer in VPC. The security\n group IDs must be provided as the ID and not the security group name (For example, sg-1234).\n </p> \n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>ApplySecurityGroupsToLoadBalancer</a> action.\n </p> \n "
},
"output": {
"shape_name": "ApplySecurityGroupsToLoadBalancerOutput",
"type": "structure",
"members": {
"SecurityGroups": {
"shape_name": "SecurityGroups",
"type": "list",
"members": {
"shape_name": "SecurityGroupId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of security group IDs associated with your load balancer.\n </p> \n "
}
},
"documentation": "\n <p>\n The out for the <a>ApplySecurityGroupsToLoadBalancer</a> action.\n </p> \n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
},
{
"shape_name": "InvalidSecurityGroupException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more specified security groups do not exist. \n </p>\n "
}
],
"documentation": "\n <p>\n Associates one or more security groups with your load balancer in Amazon Virtual Private Cloud (Amazon VPC). \n The provided security group IDs will override any currently applied security groups.\n </p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/USVPC_ApplySG.html\">Manage Security Groups in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?SecurityGroups.member.1=sg-123456789\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=ApplySecurityGroupsToLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><ApplySecurityGroupsToLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <ApplySecurityGroupsToLoadBalancerResult>\n <SecurityGroups>\n <member>sg-123456789</member>\n </SecurityGroups>\n </ApplySecurityGroupsToLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>06b5decc-102a-11e3-9ad6-bf3e4EXAMPLE</RequestId>\n </ResponseMetadata>\n</ApplySecurityGroupsToLoadBalancerResponse>\n </queryresponse>\n </examples> \n "
},
"AttachLoadBalancerToSubnets": {
"name": "AttachLoadBalancerToSubnets",
"input": {
"shape_name": "AttachLoadBalancerToSubnetsInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account.\n </p>\n ",
"required": true
},
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of subnet IDs to add for the load balancer. You can add only one subnet per Availability Zone.\n </p> \n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>AttachLoadBalancerToSubnets</a> action. \n </p> \n "
},
"output": {
"shape_name": "AttachLoadBalancerToSubnetsOutput",
"type": "structure",
"members": {
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of subnet IDs attached to the load balancer. \n </p> \n "
}
},
"documentation": "\n <p>\n The output for the <a>AttachLoadBalancerToSubnets</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
},
{
"shape_name": "SubnetNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more subnets were not found.\n </p>\n "
},
{
"shape_name": "InvalidSubnetException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The VPC has no Internet gateway. \n </p>\n "
}
],
"documentation": "\n <p>\n Adds one or more subnets to the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer.\n </p> \n <p>\n The load balancers evenly distribute requests across all of the registered subnets. \n For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html\">Deploy Elastic Load Balancing in Amazon VPC</a> in the <i>Elastic Load Balancing Developer Guide</i>.\n </p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Subnets.member.1=subnet-3561b05e\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=AttachLoadBalancerToSubnets\n&AUTHPARAMS </queryrequest> \n <queryresponse><AttachLoadBalancerToSubnetsResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<AttachLoadBalancerToSubnetsResult>\n <Subnets>\n <member>subnet-119f0078</member>\n <member>subnet-3561b05e</member>\n </Subnets>\n</AttachLoadBalancerToSubnetsResult>\n <ResponseMetadata>\n <RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>\n </ResponseMetadata>\n</AttachLoadBalancerToSubnetsResponse>\n </queryresponse>\n </examples> \n "
},
"ConfigureHealthCheck": {
"name": "ConfigureHealthCheck",
"input": {
"shape_name": "ConfigureHealthCheckInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The mnemonic name associated with the load balancer.\n The name must be unique within the set of load balancers associated with your AWS account.\n </p>\n ",
"required": true
},
"HealthCheck": {
"shape_name": "HealthCheck",
"type": "structure",
"members": {
"Target": {
"shape_name": "HealthCheckTarget",
"type": "string",
"documentation": "\n <p>\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n </p>\n <note>\n <p>\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n </p>\n <p>SSL is also specified as SSL: port pair, for example, SSL:5000.</p>\n <p>\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n </p>\n <p>\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n </p>\n </note>\n ",
"required": true
},
"Interval": {
"shape_name": "HealthCheckInterval",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n </p>\n ",
"required": true
},
"Timeout": {
"shape_name": "HealthCheckTimeout",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n </p>\n <note>\n This value must be less than the <i>Interval</i> value.\n </note>\n ",
"required": true
},
"UnhealthyThreshold": {
"shape_name": "UnhealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe failures required\n before moving the instance to the <i>Unhealthy</i> state.\n </p>\n ",
"required": true
},
"HealthyThreshold": {
"shape_name": "HealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe successes required before\n moving the instance to the <i>Healthy</i> state.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n A structure containing the configuration information\n for the new healthcheck.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Input for the <a>ConfigureHealthCheck</a> action.\n </p>\n "
},
"output": {
"shape_name": "ConfigureHealthCheckOutput",
"type": "structure",
"members": {
"HealthCheck": {
"shape_name": "HealthCheck",
"type": "structure",
"members": {
"Target": {
"shape_name": "HealthCheckTarget",
"type": "string",
"documentation": "\n <p>\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n </p>\n <note>\n <p>\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n </p>\n <p>SSL is also specified as SSL: port pair, for example, SSL:5000.</p>\n <p>\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n </p>\n <p>\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n </p>\n </note>\n ",
"required": true
},
"Interval": {
"shape_name": "HealthCheckInterval",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n </p>\n ",
"required": true
},
"Timeout": {
"shape_name": "HealthCheckTimeout",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n </p>\n <note>\n This value must be less than the <i>Interval</i> value.\n </note>\n ",
"required": true
},
"UnhealthyThreshold": {
"shape_name": "UnhealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe failures required\n before moving the instance to the <i>Unhealthy</i> state.\n </p>\n ",
"required": true
},
"HealthyThreshold": {
"shape_name": "HealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe successes required before\n moving the instance to the <i>Healthy</i> state.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The updated healthcheck for the instances.\n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>ConfigureHealthCheck</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>\n Specifies the health check settings to use for evaluating the health state of your back-end instances. \n </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#healthcheck\">Health Check</a> in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?HealthCheck.HealthyThreshold=2\n&HealthCheck.UnhealthyThreshold=2\n&LoadBalancerName=MyLoadBalancer\n&HealthCheck.Target=HTTP:80/ping\n&HealthCheck.Interval=30\n&HealthCheck.Timeout=3\n&Version=2012-06-01\n&Action=ConfigureHealthCheck\n&AUTHPARAMS </queryrequest> \n <queryresponse><ConfigureHealthCheckResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<ConfigureHealthCheckResult>\n <HealthCheck>\n <Interval>30</Interval>\n <Target>HTTP:80/ping</Target>\n <HealthyThreshold>2</HealthyThreshold>\n <Timeout>3</Timeout>\n <UnhealthyThreshold>2</UnhealthyThreshold>\n </HealthCheck>\n</ConfigureHealthCheckResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ConfigureHealthCheckResponse>\n </queryresponse>\n </examples> \n "
},
"CreateAppCookieStickinessPolicy": {
"name": "CreateAppCookieStickinessPolicy",
"input": {
"shape_name": "CreateAppCookieStickinessPolicyInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name of the load balancer. \n </p>\n ",
"required": true
},
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>\n The name of the policy being created. \n The name must be unique within the set of policies for this load balancer. \n </p>\n ",
"required": true
},
"CookieName": {
"shape_name": "CookieName",
"type": "string",
"documentation": "\n <p>\n Name of the application cookie used for stickiness. \n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>CreateAppCookieStickinessPolicy</a> action.\n </p>\n "
},
"output": {
"shape_name": "CreateAppCookieStickinessPolicyOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>CreateAppCookieStickinessPolicy</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "DuplicatePolicyNameException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Policy with the same name exists for this load balancer.\n Please choose another name.\n </p>\n "
},
{
"shape_name": "TooManyPoliciesException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Quota for number of policies for this load balancer\n has already been reached.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Generates a stickiness policy with sticky session lifetimes that follow \n that of an application-generated cookie. This policy can be associated\n only with HTTP/HTTPS listeners.\n </p>\n <p>\n This policy is similar to the policy created by <a>CreateLBCookieStickinessPolicy</a>, \n except that the lifetime of the special Elastic Load Balancing cookie follows the\n lifetime of the application-generated cookie specified in the policy configuration. \n The load balancer only inserts a new stickiness cookie when the application response\n includes a new application cookie. \n </p>\n <p>\n If the application cookie is explicitly removed or expires, the session stops being\n sticky until a new application cookie is issued. \n </p>\n <note>\n An application client must receive and send two cookies: the application-generated \n cookie and the special Elastic Load Balancing cookie named <code>AWSELB</code>. \n This is the default behavior for many common web browsers.\n </note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsAppCookies\">Enabling Application-Controlled Session Stickiness</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?CookieName=MyAppCookie\n&LoadBalancerName=MyLoadBalancer\n&PolicyName=MyAppStickyPolicy\n&Version=2012-06-01\n&Action=CreateAppCookieStickinessPolicy\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateAppCookieStickinessPolicyResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateAppCookieStickinessPolicyResult/>\n<ResponseMetadata>\n <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId>\n</ResponseMetadata>\n</CreateAppCookieStickinessPolicyResponse>\n </queryresponse>\n </examples> \n "
},
"CreateLBCookieStickinessPolicy": {
"name": "CreateLBCookieStickinessPolicy",
"input": {
"shape_name": "CreateLBCookieStickinessPolicyInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer. \n </p>\n ",
"required": true
},
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>\n The name of the policy being created. \n The name must be unique within the set of policies for this load balancer. \n </p>\n ",
"required": true
},
"CookieExpirationPeriod": {
"shape_name": "CookieExpirationPeriod",
"type": "long",
"documentation": "\n <p>\n The time period in seconds after which the cookie should be considered stale. \n Not specifying this parameter indicates that the sticky session will last for the duration \n of the browser session. \n </p>\n "
}
},
"documentation": "\n <p>\n The input for the <a>CreateLBCookieStickinessPolicy</a> action.\n </p>\n "
},
"output": {
"shape_name": "CreateLBCookieStickinessPolicyOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>CreateLBCookieStickinessPolicy</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "DuplicatePolicyNameException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Policy with the same name exists for this load balancer.\n Please choose another name.\n </p>\n "
},
{
"shape_name": "TooManyPoliciesException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Quota for number of policies for this load balancer\n has already been reached.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Generates a stickiness policy with sticky session lifetimes controlled by the \n lifetime of the browser (user-agent) or a specified expiration period. This \n policy can be associated only with HTTP/HTTPS listeners.\n </p>\n <p>\n When a load balancer implements this policy, the load balancer uses a special\n cookie to track the backend server instance for each request. When the load balancer\n receives a request, it first checks to see if this cookie is present in the request. \n If so, the load balancer sends the request to the application server specified in the\n cookie. If not, the load balancer sends the request to a server that is chosen based on\n the existing load balancing algorithm.\n </p>\n <p>\n A cookie is inserted into the response for binding subsequent requests from the same user to\n that server. The validity of the cookie is based on the cookie expiration time, which is \n specified in the policy configuration. \n </p>\n \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_StickySessions.html#US_EnableStickySessionsLBCookies\">Enabling Duration-Based Session Stickiness</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p> \n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?CookieExpirationPeriod=60\n&LoadBalancerName=MyLoadBalancer&PolicyName=MyDurationStickyPolicy\n&Version=2012-06-01\n&Action=CreateLBCookieStickinessPolicy\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLBCookieStickinessPolicyResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLBCookieStickinessPolicyResult/>\n<ResponseMetadata>\n <RequestId>99a693e9-12b8-11e3-9ad6-bf3e4EXAMPLE</RequestId>\n</ResponseMetadata>\n</CreateLBCookieStickinessPolicyResponse>\n </queryresponse>\n </examples> \n \n "
},
"CreateLoadBalancer": {
"name": "CreateLoadBalancer",
"input": {
"shape_name": "CreateAccessPointInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer.\n The name must be unique within your set of load balancers, \n must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.\n </p>\n ",
"required": true
},
"Listeners": {
"shape_name": "Listeners",
"type": "list",
"members": {
"shape_name": "Listener",
"type": "structure",
"members": {
"Protocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n <p>\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"LoadBalancerPort": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": "\n <p>\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"InstanceProtocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n \t<p>\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t</p>\n \t<note>\n \tIf the front-end protocol is HTTP or HTTPS, <code>InstanceProtocol</code> has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t</note>\n \t<note>\n \tIf there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is secure,\n \ti.e., HTTPS or SSL, the listener's <code>InstanceProtocol</code> has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is HTTP or TCP,\n the listener's <code>InstanceProtocol</code> must be either HTTP or TCP. \n \t</note>\n "
},
"InstancePort": {
"shape_name": "InstancePort",
"type": "integer",
"min_length": 1,
"max_length": 65535,
"documentation": "\n <p>\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"SSLCertificateId": {
"shape_name": "SSLCertificateId",
"type": "string",
"documentation": "\n <p>\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html\">UploadServerCertificate \t\n </a> API. </p>\n "
}
},
"documentation": "\n <p>\n The Listener data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of the following tuples:\n Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.\n </p>\n ",
"required": true
},
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of Availability Zones.\n </p>\n <p>\n At least one Availability Zone must be specified.\n Specified Availability Zones must be in the same EC2 Region\n as the load balancer.\n Traffic will be equally distributed across all zones.\n </p>\n <p>\n You can later add more Availability Zones after the creation of the \n load balancer by calling <a>EnableAvailabilityZonesForLoadBalancer</a> action.\n </p>\n "
},
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of subnet IDs in your VPC to attach to your load balancer.\n Specify one subnet per Availability Zone.\n </p> \n "
},
"SecurityGroups": {
"shape_name": "SecurityGroups",
"type": "list",
"members": {
"shape_name": "SecurityGroupId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n The security groups to assign to your load balancer within your VPC.\n </p> \n "
},
"Scheme": {
"shape_name": "LoadBalancerScheme",
"type": "string",
"documentation": "\n <p>The type of a load balancer. </p> \n \n <p>By default, Elastic Load Balancing creates an Internet-facing load balancer\n with a publicly resolvable DNS name, which resolves to public IP addresses.\n For more information about Internet-facing and Internal load balancers, \n see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/vpc-loadbalancer-types.html\">Internet-facing and Internal Load Balancers</a>.</p>\n \n <p>Specify the value <code>internal</code> for this option to create an internal load balancer\n with a DNS name that resolves to private IP addresses.</p>\n <note>\n <p>This option is only available for load balancers created within EC2-VPC.</p>\n </note> \n "
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "TagKey",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 1,
"max_length": 128,
"documentation": "\n <p>The key of the tag.</p> \n ",
"required": true
},
"Value": {
"shape_name": "TagValue",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 0,
"max_length": 256,
"documentation": " \n <p>The value of the tag.</p>\n "
}
},
"documentation": "\n <p>Metadata assigned to a load balancer consisting of key-value pair.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb\">Tagging</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n "
},
"min_length": 1,
"documentation": "\n <p>A list of tags to assign to the load balancer.</p>\n <p>For more information about setting tags for your load balancer, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb\">Tagging</a>.</p>\n "
}
},
"documentation": "\n <p>\n The input for the <a>CreateLoadBalancer</a> action.\n </p>\n "
},
"output": {
"shape_name": "CreateAccessPointOutput",
"type": "structure",
"members": {
"DNSName": {
"shape_name": "DNSName",
"type": "string",
"documentation": "\n <p>\n The DNS name for the load balancer.\n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>CreateLoadBalancer</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "DuplicateAccessPointNameException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The load balancer name already exists for this account.\n Please choose another name.\n </p>\n "
},
{
"shape_name": "TooManyAccessPointsException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The quota for the number of load balancers has already been reached.\n </p>\n "
},
{
"shape_name": "CertificateNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
},
{
"shape_name": "SubnetNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more subnets were not found.\n </p>\n "
},
{
"shape_name": "InvalidSubnetException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The VPC has no Internet gateway. \n </p>\n "
},
{
"shape_name": "InvalidSecurityGroupException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more specified security groups do not exist. \n </p>\n "
},
{
"shape_name": "InvalidSchemeException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Invalid value for scheme. Scheme can only be specified for load balancers in VPC. \n </p>\n "
},
{
"shape_name": "TooManyTagsException",
"type": "structure",
"members": {},
"documentation": "\n <p>The quota for the number of tags that can be assigned to a load balancer has been reached.</p>\n "
},
{
"shape_name": "DuplicateTagKeysException",
"type": "structure",
"members": {},
"documentation": "\n <p>The same tag key specified multiple times.</p> \n "
}
],
"documentation": "\n <p>\n Creates a new load balancer.\n </p>\n <p>\n After the call has completed successfully, a new load balancer\n is created with a unique Domain Name Service (DNS) name. The DNS \n name includes the name of the AWS region in which the load balance \n was created. For example, if your load balancer was created in the\n United States, the DNS name might end with either of the following:</p> \n <ul>\n <li>\n <i>us-east-1.elb.amazonaws.com</i> (for the Northern Virginia region)\n </li>\n <li>\n <i>us-west-1.elb.amazonaws.com</i> (for the Northern California region)\n </li>\n </ul>\n <p>For information about the AWS regions supported by Elastic Load Balancing, \n see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#elb_region\">Regions and Endpoints</a>.</p> \n \n <p>You can create up to 20 load balancers per region per account.</p>\n \n <p>Elastic Load Balancing supports load balancing your Amazon EC2 instances launched\n within any one of the following platforms:</p>\n <ul>\n <li>\n <i>EC2-Classic</i>\n <p>For information on creating and managing your load balancers in EC2-Classic, \n see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForEC2.html\">Deploy Elastic Load Balancing in Amazon EC2-Classic</a>.</p>\n </li>\n <li>\n <i>EC2-VPC</i>\n <p>For information on creating and managing your load balancers in EC2-VPC, \n see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/UserScenariosForVPC.html\">Deploy Elastic Load Balancing in Amazon VPC</a>.</p>\n </li>\n </ul> \n \n <examples> \n <example>\n <name>Create a TCP Load Balancer in EC2-Classic</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&AvailabilityZones.member.1=us-east-1c\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>my-test-loadbalancer-1234567890.us-east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n <example>\n <name>Create an HTTPS Load Balancer in EC2-Classic</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyHTTPSLoadBalancer\n&AvailabilityZones.member.1=us-east-1c\n&Listeners.member.1.LoadBalancerPort=443\n&Listeners.member.1.InstancePort=443\n&Listeners.member.1.Protocol=https\n&Listeners.member.1.InstanceProtocol=https\n&Listeners.member.1.SSLCertificateId=arn:aws:iam::123456789012:server-certificate/servercert\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>MyHTTPSLoadBalancer-1234567890.us-east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n <example>\n <name>Create a TCP Load Balancer in EC2-VPC</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?SecurityGroups.member.1=sg-6801da07\n&LoadBalancerName=MyVPCLoadBalancer\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Subnets.member.1=subnet-6dec9f03\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>MyVPCLoadBalancer-1234567890.us-east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n <example>\n <name>Create an Internal TCP Load Balancer in EC2-VPC</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Scheme=internal\n&SecurityGroups.member.1=sg-706cb61f\n&LoadBalancerName=MyInternalLoadBalancer\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Subnets.member.1=subnet-9edc97f0\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>internal-MyInternalLoadBalancer-1234567890.us-east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n <example>\n <name>Create a TCP Load Balancer in a Default VPC</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyDefaultVPCLoadBalancer\n&AvailabilityZones.member.1=sa-east-1b\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>MyDefaultVPCLoadBalancer-1234567890.sa.east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n <example>\n <name>Create a TCP Load Balancer in EC2-Classic and Assign a Tag</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&AvailabilityZones.member.1=us-east-1c\n&Listeners.member.1.LoadBalancerPort=80\n&Listeners.member.1.InstancePort=80\n&Listeners.member.1.Protocol=http\n&Listeners.member.1.InstanceProtocol=http\n&Tags.member.1.Value=test\n&Tags.member.1.Key=environment\n&Version=2012-06-01\n&Action=CreateLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerResult>\n <DNSName>my-test-loadbalancer-1234567890.us-east-1.elb.amazonaws.com</DNSName>\n </CreateLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerResponse>\n </queryresponse>\n </example> \n </examples> \n "
},
"CreateLoadBalancerListeners": {
"name": "CreateLoadBalancerListeners",
"input": {
"shape_name": "CreateLoadBalancerListenerInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name of the load balancer. \n </p>\n ",
"required": true
},
"Listeners": {
"shape_name": "Listeners",
"type": "list",
"members": {
"shape_name": "Listener",
"type": "structure",
"members": {
"Protocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n <p>\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"LoadBalancerPort": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": "\n <p>\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"InstanceProtocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n \t<p>\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t</p>\n \t<note>\n \tIf the front-end protocol is HTTP or HTTPS, <code>InstanceProtocol</code> has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t</note>\n \t<note>\n \tIf there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is secure,\n \ti.e., HTTPS or SSL, the listener's <code>InstanceProtocol</code> has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is HTTP or TCP,\n the listener's <code>InstanceProtocol</code> must be either HTTP or TCP. \n \t</note>\n "
},
"InstancePort": {
"shape_name": "InstancePort",
"type": "integer",
"min_length": 1,
"max_length": 65535,
"documentation": "\n <p>\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"SSLCertificateId": {
"shape_name": "SSLCertificateId",
"type": "string",
"documentation": "\n <p>\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html\">UploadServerCertificate \t\n </a> API. </p>\n "
}
},
"documentation": "\n <p>\n The Listener data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of <code>LoadBalancerPort</code>, \n <code>InstancePort</code>, \n <code>Protocol</code>, \n <code>InstanceProtocol</code>, and \n <code>SSLCertificateId</code> items. \t\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>CreateLoadBalancerListeners</a> action.\n </p>\n \n "
},
"output": {
"shape_name": "CreateLoadBalancerListenerOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>CreateLoadBalancerListeners</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "DuplicateListenerException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n A <code>Listener</code> already exists for the given \n <code>LoadBalancerName</code> and <code>LoadBalancerPort</code>, \n but with a different <code>InstancePort</code>, <code>Protocol</code>, \n or <code>SSLCertificateId</code>. \t\n </p>\n "
},
{
"shape_name": "CertificateNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Creates one or more listeners on a load balancer for the specified port. \n If a listener with the given port does not already exist, it will be created; \n otherwise, the properties of the new listener must match the properties \n of the existing listener. \n </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/us-add-listener.html\">Add a Listener to Your Load Balancer</a> \n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n <examples>\n <name>Create an HTTPS Load Balancer listener in EC2-Classic</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Listeners.member.1.Protocol=https\n&Listeners.member.1.LoadBalancerPort=443\n&Listeners.member.1.InstancePort=443\n&Listeners.member.1.InstanceProtocol=https\n&Listeners.member.1.SSLCertificateId=arn:aws:iam::123456789012:server-certificate/servercert\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=CreateLoadBalancerListeners\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerListenersResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <CreateLoadBalancerListenersResult/>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</CreateLoadBalancerListenersResponse>\n </queryresponse>\n </examples> \n "
},
"CreateLoadBalancerPolicy": {
"name": "CreateLoadBalancerPolicy",
"input": {
"shape_name": "CreateLoadBalancerPolicyInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n \t<p>\n \tThe name associated with the LoadBalancer for which the policy is being created. \t\n \t</p>\n ",
"required": true
},
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n \t<p>\n \tThe name of the load balancer policy being created.\n \tThe name must be unique within the set of policies for this load balancer.\n \t</p>\n ",
"required": true
},
"PolicyTypeName": {
"shape_name": "PolicyTypeName",
"type": "string",
"documentation": "\n \t<p>\n \tThe name of the base policy type being used to create this policy.\n \tTo get the list of policy types, use the <a>DescribeLoadBalancerPolicyTypes</a> action.\n \t</p>\n ",
"required": true
},
"PolicyAttributes": {
"shape_name": "PolicyAttributes",
"type": "list",
"members": {
"shape_name": "PolicyAttribute",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "AttributeName",
"type": "string",
"documentation": "\n <p>\n The name of the attribute associated with the policy.\n </p>\n "
},
"AttributeValue": {
"shape_name": "AttributeValue",
"type": "string",
"documentation": "\n <p>\n The value of the attribute associated with the policy.\n </p>\n "
}
},
"documentation": "\n <p>\n The <a>PolicyAttribute</a> data type. This data type contains a key/value pair that defines properties of\n a specific policy.\n </p>\n "
},
"documentation": "\n \t<p>\n \tA list of attributes associated with the policy being created.\n \t</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "CreateLoadBalancerPolicyOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>The output for the <a>CreateLoadBalancerPolicy</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "PolicyTypeNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more of the specified policy types do not exist.\n </p>\n "
},
{
"shape_name": "DuplicatePolicyNameException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Policy with the same name exists for this load balancer.\n Please choose another name.\n </p>\n "
},
{
"shape_name": "TooManyPoliciesException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Quota for number of policies for this load balancer\n has already been reached.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n \t<p>\n \tCreates a new policy that contains the necessary attributes depending on the policy type.\n \tPolicies are settings that are saved for your load balancer and that can be applied to the\n \tfront-end listener, or the back-end application server, depending on your policy type.\n \t</p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?PolicyAttributes.member.1.AttributeName=ProxyProtocol\n&PolicyAttributes.member.1.AttributeValue=true\n&PolicyTypeName=ProxyProtocolPolicyType\n&LoadBalancerName=my-test-loadbalancer\n&PolicyName=EnableProxyProtocol\n&Version=2012-06-01\n&Action=CreateLoadBalancerPolicy\n&AUTHPARAMS </queryrequest> \n <queryresponse><CreateLoadBalancerPolicyResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<CreateLoadBalancerPolicyResult/>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</CreateLoadBalancerPolicyResponse>\n </queryresponse>\n </examples> \n \n "
},
"DeleteLoadBalancer": {
"name": "DeleteLoadBalancer",
"input": {
"shape_name": "DeleteAccessPointInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer. \n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DeleteLoadBalancer</a> action.\n </p>\n "
},
"output": {
"shape_name": "DeleteAccessPointOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>DeleteLoadBalancer</a> action.\n </p>\n "
},
"errors": [],
"documentation": "\n <p>\n Deletes the specified load balancer.\n </p>\n <p>\n If attempting to recreate the load balancer,\n you must reconfigure all the settings.\n The DNS name associated with a deleted load balancer\n will no longer be usable.\n Once deleted, the name and associated DNS record of the\n load balancer no longer exist and traffic sent to any of its\n IP addresses will no longer be delivered to back-end instances. \n </p>\n <p>\n To successfully call this API, you must provide the same\n account credentials as were used to create the load balancer.\n </p>\n <note>\n By design, if the load balancer does not exist or has already been deleted, a call to\n <code>DeleteLoadBalancer</code> action still succeeds.\n </note>\n "
},
"DeleteLoadBalancerListeners": {
"name": "DeleteLoadBalancerListeners",
"input": {
"shape_name": "DeleteLoadBalancerListenerInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The mnemonic name associated with the load balancer. \n </p>\n ",
"required": true
},
"LoadBalancerPorts": {
"shape_name": "Ports",
"type": "list",
"members": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": null
},
"documentation": "\n <p>\n The client port number(s) of the load balancer listener(s) to be removed. \n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DeleteLoadBalancerListeners</a> action.\n </p>\n "
},
"output": {
"shape_name": "DeleteLoadBalancerListenerOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>DeleteLoadBalancerListeners</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>\n Deletes listeners from the load balancer for the specified port.\n </p>\n \n "
},
"DeleteLoadBalancerPolicy": {
"name": "DeleteLoadBalancerPolicy",
"input": {
"shape_name": "DeleteLoadBalancerPolicyInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The mnemonic name associated with the load balancer. \n </p>\n ",
"required": true
},
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>\n The mnemonic name for the policy being deleted. \n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DeleteLoadBalancerPolicy</a> action.\n </p>\n "
},
"output": {
"shape_name": "DeleteLoadBalancerPolicyOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>DeleteLoadBalancerPolicy</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Deletes a policy from the load balancer. \n The specified policy must not be enabled for any listeners.\n </p>\n "
},
"DeregisterInstancesFromLoadBalancer": {
"name": "DeregisterInstancesFromLoadBalancer",
"input": {
"shape_name": "DeregisterEndPointsInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer. \n </p>\n ",
"required": true
},
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of EC2 instance IDs consisting of all\n instances to be deregistered.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DeregisterInstancesFromLoadBalancer</a> action.\n </p>\n "
},
"output": {
"shape_name": "DeregisterEndPointsOutput",
"type": "structure",
"members": {
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n An updated list of remaining instances\n registered with the load balancer.\n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>DeregisterInstancesFromLoadBalancer</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidEndPointException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified EndPoint is not valid.\n </p>\n "
}
],
"documentation": "\n <p>\n Deregisters instances from the load balancer.\n Once the instance is deregistered,\n it will stop receiving traffic from the load balancer. \n </p>\n <p>\n In order to successfully call this API,\n the same account credentials as those\n used to create the load balancer must be provided.\n </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html\">De-register and Register Amazon EC2 Instances</a> \n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n <p>You can use <a>DescribeLoadBalancers</a> to verify if the instance is deregistered from the load balancer.</p> \n <examples>\n <example>\n <name>Deregister instance <i>i-e3677ad7</i> from <i>MyHTTPSLoadBalancer</i> load balancer.</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Instances.member.1.InstanceId=i-e3677ad7\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=DeregisterInstancesFromLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><DeregisterInstancesFromLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DeregisterInstancesFromLoadBalancerResult>\n <Instances>\n <member>\n <InstanceId>i-6ec63d59</InstanceId>\n </member>\n </Instances>\n </DeregisterInstancesFromLoadBalancerResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</DeregisterInstancesFromLoadBalancerResponse>\n </queryresponse>\n </example>\n </examples> \n "
},
"DescribeInstanceHealth": {
"name": "DescribeInstanceHealth",
"input": {
"shape_name": "DescribeEndPointStateInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name of the load balancer. \n </p>\n ",
"required": true
},
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of instance IDs whose states are being queried.\n </p>\n "
}
},
"documentation": "\n <p>\n The input for the <a>DescribeEndPointState</a> action.\n </p>\n "
},
"output": {
"shape_name": "DescribeEndPointStateOutput",
"type": "structure",
"members": {
"InstanceStates": {
"shape_name": "InstanceStates",
"type": "list",
"members": {
"shape_name": "InstanceState",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
},
"State": {
"shape_name": "State",
"type": "string",
"documentation": "\n <p>Specifies the current state of the instance.</p>\n \n <p>Valid value: <code>InService</code>|<code>OutOfService</code>|<code>Unknown</code></p>\n "
},
"ReasonCode": {
"shape_name": "ReasonCode",
"type": "string",
"documentation": "\n <p>\n Provides information about the cause of <i>OutOfService</i> instances.\n Specifically, it indicates whether the cause is Elastic Load Balancing\n or the instance behind the load balancer.\n </p>\n <p>Valid value: <code>ELB</code>|<code>Instance</code>|<code>N/A</code></p>\n "
},
"Description": {
"shape_name": "Description",
"type": "string",
"documentation": "\n <p>\n Provides a description of the instance state.\n </p>\n "
}
},
"documentation": "\n <p>\n The InstanceState data type.\n </p>\n "
},
"documentation": "\n <p>\n A list containing health information\n for the specified instances.\n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>DescribeInstanceHealth</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidEndPointException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified EndPoint is not valid.\n </p>\n "
}
],
"documentation": "\n <p>\n Returns the current state of the specified instances registered with the specified load balancer.\n If no instances are specified, the state of all the instances registered with the load balancer is returned.\n </p>\n <note>\n You must provide the same account credentials\n as those that were used to create the load balancer.\n </note>\n <examples>\n <example>\n <name>Description of a healthy (InService) instance</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeInstanceHealthResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeInstanceHealthResult>\n <InstanceStates>\n <member>\n <Description>N/A</Description>\n <InstanceId>i-90d8c2a5</InstanceId>\n <State>InService</State>\n <ReasonCode>N/A</ReasonCode>\n </member>\n </InstanceStates>\n </DescribeInstanceHealthResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeInstanceHealthResponse> \n </queryresponse>\n </example> \n <example>\n <name>Description of an instance with registration in progress</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeInstanceHealthResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeInstanceHealthResult>\n <InstanceStates>\n <member>\n <Description>Instance registration is still in progress.</Description>\n <InstanceId>i-315b7e51</InstanceId>\n <State>OutOfService</State>\n <ReasonCode>ELB</ReasonCode>\n </member>\n </InstanceStates>\n </DescribeInstanceHealthResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeInstanceHealthResponse> \n </queryresponse>\n </example> \n <example>\n <name>Description of an unhealthy (OutOfService) instance</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeInstanceHealthResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeInstanceHealthResult>\n <InstanceStates>\n <member>\n <Description>Instance has failed at least the UnhealthyThreshold number of health checks consecutively.</Description>\n <InstanceId>i-fda142c9</InstanceId>\n <State>OutOfService</State>\n <ReasonCode>Instance</ReasonCode>\n </member>\n </InstanceStates>\n </DescribeInstanceHealthResult>\n <ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</DescribeInstanceHealthResponse>\n </queryresponse>\n </example> \n <example>\n <name>Description of an instance in an unknown state</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeInstanceHealth\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeInstanceHealthResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeInstanceHealthResult>\n <InstanceStates>\n <member>\n <Description>A transient error occurred. Please try again later.</Description>\n <InstanceId>i-7f12e649</InstanceId>\n <State>Unknown</State>\n <ReasonCode>ELB</ReasonCode>\n </member>\n </InstanceStates>\n </DescribeInstanceHealthResult>\n <ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</DescribeInstanceHealthResponse>\n </queryresponse>\n </example> \n </examples> \n "
},
"DescribeLoadBalancerAttributes": {
"name": "DescribeLoadBalancerAttributes",
"input": {
"shape_name": "DescribeLoadBalancerAttributesInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>The name of the load balancer.</p> \n ",
"required": true
}
},
"documentation": "\n <p>The input for the <a>DescribeLoadBalancerAttributes</a> action.</p> \n "
},
"output": {
"shape_name": "DescribeLoadBalancerAttributesOutput",
"type": "structure",
"members": {
"LoadBalancerAttributes": {
"shape_name": "LoadBalancerAttributes",
"type": "structure",
"members": {
"CrossZoneLoadBalancing": {
"shape_name": "CrossZoneLoadBalancing",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "CrossZoneLoadBalancingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether cross-zone load balancing is enabled for the load balancer.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. \n If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-disable-crosszone-lb.html\">Enable Cross-Zone Load Balancing</a>.</p>\n "
},
"AccessLog": {
"shape_name": "AccessLog",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "AccessLogEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether access log is enabled for the load balancer.</p>\n ",
"required": true
},
"S3BucketName": {
"shape_name": "S3BucketName",
"type": "string",
"documentation": "\n <p>The name of the Amazon S3 bucket where the access logs are stored.</p>\n "
},
"EmitInterval": {
"shape_name": "AccessLogInterval",
"type": "integer",
"documentation": "\n <p>The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.</p>\n <p>Default: 60 minutes</p>\n "
},
"S3BucketPrefix": {
"shape_name": "AccessLogPrefix",
"type": "string",
"documentation": "\n <p>The logical hierarchy you created for your Amazon S3 bucket, for example <code>my-bucket-prefix/prod</code>. \n If the prefix is not provided, the log is placed at the root level of the bucket.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-access-logs.html\">Enable Access Logs</a>.</p>\n "
},
"ConnectionDraining": {
"shape_name": "ConnectionDraining",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "ConnectionDrainingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether connection draining is enabled for the load balancer.</p>\n ",
"required": true
},
"Timeout": {
"shape_name": "ConnectionDrainingTimeout",
"type": "integer",
"documentation": "\n <p>Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance. </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-conn-drain.html\">Enable Connection Draining</a>.</p>\n \n "
},
"ConnectionSettings": {
"shape_name": "ConnectionSettings",
"type": "structure",
"members": {
"IdleTimeout": {
"shape_name": "IdleTimeout",
"type": "integer",
"min_length": 1,
"max_length": 3600,
"documentation": "\n <p>Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.</p> \n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. </p>\n <p>By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the <code>ConnectionSettings</code> attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-idle-timeout.html\">Configure Idle Connection Timeout</a>.</p>\n "
}
},
"documentation": "\n <p>The load balancer attributes structure.</p> \n "
}
},
"documentation": "\n <p>The following element is returned in a structure named <code>DescribeLoadBalancerAttributesResult</code>.</p> \n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "LoadBalancerAttributeNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>The specified load balancer attribute could not be found.</p> \n "
}
],
"documentation": "\n <p>Returns detailed information about all of the attributes associated with the specified load balancer.</p> \n <examples>\n <example> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancerAttributes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancerAttributesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeLoadBalancerAttributesResult>\n <LoadBalancerAttributes>\n <AccessLog>\n <Enabled>true</Enabled>\n <S3BucketName>my-loadbalancer-logs</S3BucketName>\n <S3BucketPrefix>testprefix</S3BucketPrefix>\n <EmitInterval>5</EmitInterval>\n </AccessLog>\n <ConnectionSettings>\n <IdleTimeout>30</IdleTimeout>\n </ConnectionSettings>\n <CrossZoneLoadBalancing>\n <Enabled>true</Enabled>\n </CrossZoneLoadBalancing>\n <ConnectionDraining>\n <Enabled>true</Enabled>\n <Timeout>60</Timeout>\n </ConnectionDraining> \n </LoadBalancerAttributes>\n </DescribeLoadBalancerAttributesResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</DescribeLoadBalancerAttributesResponse>\n </queryresponse>\n </example>\n </examples> \n "
},
"DescribeLoadBalancerPolicies": {
"name": "DescribeLoadBalancerPolicies",
"input": {
"shape_name": "DescribeLoadBalancerPoliciesInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n \t<p>\n \tThe mnemonic name associated with the load balancer.\n \tIf no name is specified, the operation returns the attributes of either all the sample policies pre-defined by Elastic Load Balancing or the specified sample polices.\n \t</p>\n "
},
"PolicyNames": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n \t<p>\n \t The names of load balancer policies you've created or Elastic Load Balancing sample policy names.\n \t</p>\n "
}
},
"documentation": "\n "
},
"output": {
"shape_name": "DescribeLoadBalancerPoliciesOutput",
"type": "structure",
"members": {
"PolicyDescriptions": {
"shape_name": "PolicyDescriptions",
"type": "list",
"members": {
"shape_name": "PolicyDescription",
"type": "structure",
"members": {
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>\n The name of the policy associated with the load balancer.\n </p>\n "
},
"PolicyTypeName": {
"shape_name": "PolicyTypeName",
"type": "string",
"documentation": "\n <p>\n The name of the policy type associated with the load balancer.\n </p>\n "
},
"PolicyAttributeDescriptions": {
"shape_name": "PolicyAttributeDescriptions",
"type": "list",
"members": {
"shape_name": "PolicyAttributeDescription",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "AttributeName",
"type": "string",
"documentation": "\n <p>\n The name of the attribute associated with the policy.\n </p>\n "
},
"AttributeValue": {
"shape_name": "AttributeValue",
"type": "string",
"documentation": "\n <p>\n The value of the attribute associated with the policy.\n </p>\n "
}
},
"documentation": "\n <p>\n The <code>PolicyAttributeDescription</code> data type.\n This data type is used to describe the attributes and values\n associated with a policy.\n </p>\n "
},
"documentation": "\n <p>\n A list of policy attribute description structures.\n </p>\n "
}
},
"documentation": "\n <p>\n The <code>PolicyDescription</code> data type.\n </p>\n "
},
"documentation": "\n \t<p>\n \tA list of policy description structures.\n \t</p>\n "
}
},
"documentation": "\n <p>The output for the <a>DescribeLoadBalancerPolicies</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "PolicyNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more specified policies were not found.\n </p>\n "
}
],
"documentation": "\n <p>Returns detailed descriptions of the policies.\n If you specify a load balancer name, the action returns the descriptions of all the policies created for the load balancer.\n If you specify a policy name associated with your load balancer, the action returns the description of that policy. \n If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all the sample policies.\n The names of the sample policies have the <code>ELBSample-</code> prefix.\n </p>\n <examples>\n <example>\n <name>Description of all the policies associated with a load balancer</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyLoadBalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicies\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancerPoliciesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeLoadBalancerPoliciesResult>\n <PolicyDescriptions>\n <member>\n <PolicyName>MyDurationStickyPolicy</PolicyName>\n <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName>\n <PolicyAttributeDescriptions>\n <member>\n <AttributeName>CookieExpirationPeriod</AttributeName>\n <AttributeValue>60</AttributeValue>\n </member>\n </PolicyAttributeDescriptions>\n </member>\n <member>\n <PolicyName>MyAppStickyPolicy</PolicyName>\n <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName>\n <PolicyAttributeDescriptions>\n <member>\n <AttributeName>CookieName</AttributeName>\n <AttributeValue>MyAppCookie</AttributeValue>\n </member>\n </PolicyAttributeDescriptions>\n </member>\n </PolicyDescriptions>\n </DescribeLoadBalancerPoliciesResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</DescribeLoadBalancerPoliciesResponse>\n </queryresponse>\n </example> \n <example>\n <name>Description of a specified policy associated with the load balancer</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?PolicyNames.member.1=EnableProxyProtocol\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicies\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancerPoliciesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeLoadBalancerPoliciesResult>\n <PolicyDescriptions>\n <member>\n <PolicyName>EnableProxyProtocol</PolicyName>\n <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName>\n <PolicyAttributeDescriptions>\n <member>\n <AttributeName>ProxyProtocol</AttributeName>\n <AttributeValue>true</AttributeValue>\n </member>\n </PolicyAttributeDescriptions>\n </member>\n </PolicyDescriptions> \n </DescribeLoadBalancerPoliciesResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeLoadBalancerPoliciesResponse>\n </queryresponse>\n </example> \n </examples> \n "
},
"DescribeLoadBalancerPolicyTypes": {
"name": "DescribeLoadBalancerPolicyTypes",
"input": {
"shape_name": "DescribeLoadBalancerPolicyTypesInput",
"type": "structure",
"members": {
"PolicyTypeNames": {
"shape_name": "PolicyTypeNames",
"type": "list",
"members": {
"shape_name": "PolicyTypeName",
"type": "string",
"documentation": null
},
"documentation": "\n \t<p>\n \tSpecifies the name of the policy types. If no names are specified,\n \treturns the description of all\n \tthe policy types defined by Elastic Load Balancing service.\n \t</p>\n "
}
},
"documentation": "\n \t"
},
"output": {
"shape_name": "DescribeLoadBalancerPolicyTypesOutput",
"type": "structure",
"members": {
"PolicyTypeDescriptions": {
"shape_name": "PolicyTypeDescriptions",
"type": "list",
"members": {
"shape_name": "PolicyTypeDescription",
"type": "structure",
"members": {
"PolicyTypeName": {
"shape_name": "PolicyTypeName",
"type": "string",
"documentation": "\n <p>\n The name of the policy type.\n </p>\n "
},
"Description": {
"shape_name": "Description",
"type": "string",
"documentation": "\n <p>\n A human-readable description of the policy type.\n </p>\n "
},
"PolicyAttributeTypeDescriptions": {
"shape_name": "PolicyAttributeTypeDescriptions",
"type": "list",
"members": {
"shape_name": "PolicyAttributeTypeDescription",
"type": "structure",
"members": {
"AttributeName": {
"shape_name": "AttributeName",
"type": "string",
"documentation": "\n <p>\n The name of the attribute associated with the policy type.\n </p>\n "
},
"AttributeType": {
"shape_name": "AttributeType",
"type": "string",
"documentation": "\n <p>\n The type of attribute. For example, Boolean, Integer, etc.\n </p>\n "
},
"Description": {
"shape_name": "Description",
"type": "string",
"documentation": "\n <p>\n A human-readable description of the attribute.\n </p>\n "
},
"DefaultValue": {
"shape_name": "DefaultValue",
"type": "string",
"documentation": "\n <p>\n The default value of the attribute, if applicable.\n </p>\n "
},
"Cardinality": {
"shape_name": "Cardinality",
"type": "string",
"documentation": "\n <p>\n The cardinality of the attribute. Valid Values:\n <ul>\n <li>ONE(1) : Single value required</li>\n <li>ZERO_OR_ONE(0..1) : Up to one value can be supplied</li>\n <li>ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed</li>\n <li>ONE_OR_MORE(1..*0) : Required. Multiple values are allowed</li>\n </ul>\n </p>\n "
}
},
"documentation": "\n <p>\n The <code>PolicyAttributeTypeDescription</code> data type. This data type is used to describe values\n that are acceptable for the policy attribute.\n </p>\n "
},
"documentation": "\n <p>\n The description of the policy attributes associated with the load balancer policies defined by the Elastic Load Balancing service.\n </p>\n "
}
},
"documentation": "\n <p>\n The <a>PolicyTypeDescription</a> data type.\n </p>\n "
},
"documentation": "\n \t<p>\n \tList of policy type description structures of the specified policy type.\n \tIf no policy type names are specified,\n \treturns the description of all the policy types defined by Elastic Load Balancing service.\n \t</p>\n "
}
},
"documentation": "\n \t<p>\n \tThe output for the <a>DescribeLoadBalancerPolicyTypes</a> action.\n \t</p>\n "
},
"errors": [
{
"shape_name": "PolicyTypeNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more of the specified policy types do not exist.\n </p>\n "
}
],
"documentation": "\n \t<p>\n \tReturns meta-information on the specified load balancer policies defined by the\n \tElastic Load Balancing service. The policy types that are\n \treturned from this action can be used in a <a>CreateLoadBalancerPolicy</a> action to\n \tinstantiate specific policy configurations that will be applied to a load balancer.\n \t</p>\n <examples>\n <example>\n <name>Partial description of all the policy types defined by Elastic Load Balancing for your account</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Version=2012-06-01\n&Action=DescribeLoadBalancerPolicyTypes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancerPolicyTypesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<DescribeLoadBalancerPolicyTypesResult>\n <PolicyTypeName>SSLNegotiationPolicyType</PolicyTypeName>\n < . . . .>\n <PolicyTypeName>BackendServerAuthenticationPolicyType</PolicyTypeName>\n < . . . .>\n <PolicyTypeName>PublicKeyPolicyType</PolicyTypeName>\n < . . . .>\n <PolicyTypeName>AppCookieStickinessPolicyType</PolicyTypeName>\n < . . . .>\n <PolicyTypeName>LBCookieStickinessPolicyType</PolicyTypeName>\n < . . . .>\n <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName>\n < . . . .>\n</DescribeLoadBalancerPolicyTypesResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ DescribeLoadBalancerPolicyTypesResponse >\t\n </queryresponse>\n </example> \n <example>\n <name>Description of ProxyProtocolPolicyType</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?PolicyTypeNames.member.1=ProxyProtocolPolicyType\n&Version=2012-06-01\n&Action=DescribeLoadBalancerPolicyTypes\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancerPolicyTypesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeLoadBalancerPolicyTypesResult>\n <PolicyTypeDescriptions>\n <member>\n <PolicyAttributeTypeDescriptions>\n <member>\n <AttributeName>ProxyProtocol</AttributeName>\n <AttributeType>Boolean</AttributeType>\n <Cardinality>ONE</Cardinality>\n </member>\n </PolicyAttributeTypeDescriptions>\n <PolicyTypeName>ProxyProtocolPolicyType</PolicyTypeName>\n <Description>Policy that controls whether to include the IP address and port of the originating request for TCP messages.\n This policy operates on TCP/SSL listeners only</Description>\n </member>\n </PolicyTypeDescriptions>\n </DescribeLoadBalancerPolicyTypesResult>\n <ResponseMetadata>\n <RequestId>1549581b-12b7-11e3-895e-1334aEXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeLoadBalancerPolicyTypesResponse>\n </queryresponse>\n </example> \n </examples> \n \n "
},
"DescribeLoadBalancers": {
"name": "DescribeLoadBalancers",
"input": {
"shape_name": "DescribeAccessPointsInput",
"type": "structure",
"members": {
"LoadBalancerNames": {
"shape_name": "LoadBalancerNames",
"type": "list",
"members": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of load balancer names associated with the account.\n </p>\n "
},
"Marker": {
"shape_name": "Marker",
"type": "string",
"documentation": "\n <p>\n An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker. \n </p>\n "
},
"PageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 1,
"max_length": 400,
"documentation": " \n <p>\n The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1. \n </p> \n "
}
},
"documentation": "\n <p>\n The input for the <a>DescribeLoadBalancers</a> action.\n </p>\n "
},
"output": {
"shape_name": "DescribeAccessPointsOutput",
"type": "structure",
"members": {
"LoadBalancerDescriptions": {
"shape_name": "LoadBalancerDescriptions",
"type": "list",
"members": {
"shape_name": "LoadBalancerDescription",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n Specifies the name associated with the load balancer.\n </p>\n "
},
"DNSName": {
"shape_name": "DNSName",
"type": "string",
"documentation": "\n <p>\n Specifies the external DNS name associated with the load balancer.\n </p>\n "
},
"CanonicalHostedZoneName": {
"shape_name": "DNSName",
"type": "string",
"documentation": "\n <p>\n Provides the name of the Amazon Route 53 hosted zone that is associated\n with the load balancer. For information on how to associate your load\n balancer with a hosted zone, go to <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html\">Using Domain Names With Elastic Load Balancing</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.\n </p>\n "
},
"CanonicalHostedZoneNameID": {
"shape_name": "DNSName",
"type": "string",
"documentation": "\n <p>\n Provides the ID of the Amazon Route 53 hosted zone name that is associated\n with the load balancer. For information on how to associate or disassociate your load\n balancer with a hosted zone, go to <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/using-domain-names-with-elb.html\">Using Domain Names With Elastic Load Balancing</a>\n in the <i>Elastic Load Balancing Developer Guide</i>. \n </p>\n "
},
"ListenerDescriptions": {
"shape_name": "ListenerDescriptions",
"type": "list",
"members": {
"shape_name": "ListenerDescription",
"type": "structure",
"members": {
"Listener": {
"shape_name": "Listener",
"type": "structure",
"members": {
"Protocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n <p>\n Specifies the load balancer transport protocol to use for routing\n - HTTP, HTTPS, TCP or SSL.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"LoadBalancerPort": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": "\n <p>\n Specifies the external load balancer port number.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"InstanceProtocol": {
"shape_name": "Protocol",
"type": "string",
"documentation": "\n \t<p>\n \tSpecifies the protocol to use for routing traffic to back-end instances - HTTP, HTTPS, TCP, or SSL.\n \tThis property cannot be modified for the life of the load balancer.\n \t</p>\n \t<note>\n \tIf the front-end protocol is HTTP or HTTPS, <code>InstanceProtocol</code> has to be at the same protocol layer,\n \t i.e., HTTP or HTTPS. Likewise, if the front-end protocol is TCP or SSL, InstanceProtocol has to be TCP or SSL.\n \t</note>\n \t<note>\n \tIf there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is secure,\n \ti.e., HTTPS or SSL, the listener's <code>InstanceProtocol</code> has to be secure, i.e., HTTPS or SSL. \n If there is another listener with the same <code>InstancePort</code> whose <code>InstanceProtocol</code> is HTTP or TCP,\n the listener's <code>InstanceProtocol</code> must be either HTTP or TCP. \n \t</note>\n "
},
"InstancePort": {
"shape_name": "InstancePort",
"type": "integer",
"min_length": 1,
"max_length": 65535,
"documentation": "\n <p>\n Specifies the TCP port on which the instance server is listening.\n This property cannot be modified for the life of the load balancer.\n </p>\n ",
"required": true
},
"SSLCertificateId": {
"shape_name": "SSLCertificateId",
"type": "string",
"documentation": "\n <p>\n The ARN string of the server certificate. \n To get the ARN of the server certificate, call the AWS Identity and Access Management \n <a href=\"http://docs.aws.amazon.com/IAM/latest/APIReference/index.html?API_UploadServerCertificate.html\">UploadServerCertificate \t\n </a> API. </p>\n "
}
},
"documentation": "\n <p>\n The Listener data type.\n </p>\n "
},
"PolicyNames": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of policies enabled for this listener. \n An empty list indicates that no policies are enabled.\n </p>\n "
}
},
"documentation": "\n <p>\n The ListenerDescription data type. \n </p>\n "
},
"documentation": "\n <p>\n LoadBalancerPort, InstancePort, Protocol, InstanceProtocol, and PolicyNames are returned\n in a list of tuples in the ListenerDescriptions element.\n </p>\n "
},
"Policies": {
"shape_name": "Policies",
"type": "structure",
"members": {
"AppCookieStickinessPolicies": {
"shape_name": "AppCookieStickinessPolicies",
"type": "list",
"members": {
"shape_name": "AppCookieStickinessPolicy",
"type": "structure",
"members": {
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.\n </p>\n "
},
"CookieName": {
"shape_name": "CookieName",
"type": "string",
"documentation": "\n <p>The name of the application cookie used for stickiness.\n </p>\n \n "
}
},
"documentation": "\n <p>The AppCookieStickinessPolicy data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of the <a>AppCookieStickinessPolicy</a> objects created with <a>CreateAppCookieStickinessPolicy</a>.\n </p>\n "
},
"LBCookieStickinessPolicies": {
"shape_name": "LBCookieStickinessPolicies",
"type": "list",
"members": {
"shape_name": "LBCookieStickinessPolicy",
"type": "structure",
"members": {
"PolicyName": {
"shape_name": "PolicyName",
"type": "string",
"documentation": "\n <p>The name for the policy being created. The name must be unique within the set of policies for this load balancer.\n </p>\n "
},
"CookieExpirationPeriod": {
"shape_name": "CookieExpirationPeriod",
"type": "long",
"documentation": "\n <p>The time period in seconds after which the cookie should be considered stale. Not specifying this parameter indicates that the stickiness session will last for the duration of the browser session.\n </p>\n "
}
},
"documentation": "\n <p>The LBCookieStickinessPolicy data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of <a>LBCookieStickinessPolicy</a> objects created with <a>CreateAppCookieStickinessPolicy</a>.\n </p>\n "
},
"OtherPolicies": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of policy names other than the stickiness policies.\n </p>\n "
}
},
"documentation": "\n \t\t<p>\n \t\tProvides a list of policies defined for the load balancer.\n \t\t</p>\n \t"
},
"BackendServerDescriptions": {
"shape_name": "BackendServerDescriptions",
"type": "list",
"members": {
"shape_name": "BackendServerDescription",
"type": "structure",
"members": {
"InstancePort": {
"shape_name": "InstancePort",
"type": "integer",
"min_length": 1,
"max_length": 65535,
"documentation": "\n <p>\n Provides the port on which the back-end server is listening.\n </p>\n "
},
"PolicyNames": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n Provides a list of policy names enabled for the back-end server.\n </p>\n "
}
},
"documentation": "\n <p>\n This data type is used as a response element in the <a>DescribeLoadBalancers</a> action to describe the configuration of the back-end server.\n </p>\n "
},
"documentation": "\n <p>\n Contains a list of back-end server descriptions.\n </p>\n "
},
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n Specifies a list of Availability Zones.\n </p>\n "
},
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n Provides a list of VPC subnet IDs for the load balancer.\n </p> \n "
},
"VPCId": {
"shape_name": "VPCId",
"type": "string",
"documentation": "\n <p>\n Provides the ID of the VPC attached to the load balancer.\n </p> \n "
},
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n Provides a list of EC2 instance IDs for the load balancer.\n </p>\n "
},
"HealthCheck": {
"shape_name": "HealthCheck",
"type": "structure",
"members": {
"Target": {
"shape_name": "HealthCheckTarget",
"type": "string",
"documentation": "\n <p>\n Specifies the instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.\n The range of valid ports is one (1) through 65535.\n </p>\n <note>\n <p>\n TCP is the default, specified as a TCP: port pair,\n for example \"TCP:5000\". In this case a healthcheck simply\n attempts to open a TCP connection to the instance on the\n specified port. Failure to connect within the configured\n timeout is considered unhealthy.\n </p>\n <p>SSL is also specified as SSL: port pair, for example, SSL:5000.</p>\n <p>\n For HTTP or HTTPS protocol, the situation is different. You have to include a ping path in the string. HTTP is specified\n as a HTTP:port;/;PathToPing; grouping, for example\n \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET\n request is issued to the instance on the given port and path.\n Any answer other than \"200 OK\" within the timeout period is\n considered unhealthy.\n </p>\n <p>\n The total length of the HTTP ping target needs to\n be 1024 16-bit Unicode characters or less.\n </p>\n </note>\n ",
"required": true
},
"Interval": {
"shape_name": "HealthCheckInterval",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the approximate interval, in seconds,\n between health checks of an individual instance.\n </p>\n ",
"required": true
},
"Timeout": {
"shape_name": "HealthCheckTimeout",
"type": "integer",
"min_length": 1,
"max_length": 300,
"documentation": "\n <p>\n Specifies the amount of time, in seconds, during which no response\n means a failed health probe.\n </p>\n <note>\n This value must be less than the <i>Interval</i> value.\n </note>\n ",
"required": true
},
"UnhealthyThreshold": {
"shape_name": "UnhealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe failures required\n before moving the instance to the <i>Unhealthy</i> state.\n </p>\n ",
"required": true
},
"HealthyThreshold": {
"shape_name": "HealthyThreshold",
"type": "integer",
"min_length": 2,
"max_length": 10,
"documentation": "\n <p>\n Specifies the number of consecutive health probe successes required before\n moving the instance to the <i>Healthy</i> state.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Specifies information regarding the\n various health probes conducted on the load balancer.\n </p>\n "
},
"SourceSecurityGroup": {
"shape_name": "SourceSecurityGroup",
"type": "structure",
"members": {
"OwnerAlias": {
"shape_name": "SecurityGroupOwnerAlias",
"type": "string",
"documentation": "\n <p>\n Owner of the source security group. Use this value for the \n <code>--source-group-user</code> parameter of the <code>ec2-authorize</code>\n command in the Amazon EC2 command line tool.\n </p>\n "
},
"GroupName": {
"shape_name": "SecurityGroupName",
"type": "string",
"documentation": "\n <p>\n Name of the source security group. Use this value for the \n <code>--source-group</code> parameter of the <code>ec2-authorize</code>\n command in the Amazon EC2 command line tool.\n </p>\n "
}
},
"documentation": "\n <p>\n The security group that you can use as part of your inbound rules for \n your load balancer's back-end Amazon EC2 application instances. \n To only allow traffic from load balancers, add a security group rule to your back end instance that specifies this\n source security group as the inbound source. \n </p>\n "
},
"SecurityGroups": {
"shape_name": "SecurityGroups",
"type": "list",
"members": {
"shape_name": "SecurityGroupId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n The security groups the load balancer is a member of (VPC only).\n </p> \n "
},
"CreatedTime": {
"shape_name": "CreatedTime",
"type": "timestamp",
"documentation": "\n <p>\n Provides the date and time the load balancer was created.\n </p>\n "
},
"Scheme": {
"shape_name": "LoadBalancerScheme",
"type": "string",
"documentation": "\n <p>Specifies the type of load balancer.</p>\n\n <p>If the <code>Scheme</code> is <code>internet-facing</code>, the load balancer\n has a publicly resolvable DNS name that resolves to public IP addresses.</p>\n \n <p>If the <code>Scheme</code> is <code>internal</code>, the load balancer has a publicly resolvable\n DNS name that resolves to private IP addresses.</p>\n \n <p> This option is only available for load balancers attached to an Amazon VPC. </p> \n "
}
},
"documentation": "\n <p>\n Contains the result of a successful invocation of <a>DescribeLoadBalancers</a>.\n </p>\n "
},
"documentation": "\n <p>\n A list of load balancer description structures.\n </p>\n "
},
"NextMarker": {
"shape_name": "Marker",
"type": "string",
"documentation": "\n <p>\n Specifies the value of next marker if the request returned more than one page of results. \n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>DescribeLoadBalancers</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>\n Returns detailed configuration information for all the load balancers created for the account.\n If you specify load balancer names, the action returns configuration information of the specified\n load balancers. </p>\n <note>\n In order to retrieve this information, you must provide the same account credentials \n that was used to create the load balancer.</note>\n <examples>\n <example>\n <name>Description of a specified load balancer</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerNames.member.1=MyLoadBalancer\n&Version=2012-06-01\n&Action=DescribeLoadBalancers\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeLoadBalancersResult>\n <LoadBalancerDescriptions>\n <member>\n <SecurityGroups/>\n <LoadBalancerName>MyLoadBalancer</LoadBalancerName>\n <CreatedTime>2013-05-24T21:15:31.280Z</CreatedTime>\n <HealthCheck>\n <Interval>90</Interval>\n <Target>HTTP:80/</Target>\n <HealthyThreshold>2</HealthyThreshold>\n <Timeout>60</Timeout>\n <UnhealthyThreshold>10</UnhealthyThreshold>\n </HealthCheck>\n <ListenerDescriptions>\n <member>\n <PolicyNames/>\n <Listener>\n <Protocol>HTTP</Protocol>\n <LoadBalancerPort>80</LoadBalancerPort>\n <InstanceProtocol>HTTP</InstanceProtocol>\n <InstancePort>80</InstancePort>\n </Listener>\n </member>\n </ListenerDescriptions>\n <Instances>\n <member>\n <InstanceId>i-e4cbe38d</InstanceId>\n </member>\n </Instances>\n <Policies>\n <AppCookieStickinessPolicies/>\n <OtherPolicies/>\n <LBCookieStickinessPolicies/>\n </Policies>\n <AvailabilityZones>\n <member>us-east-1a</member>\n </AvailabilityZones>\n <CanonicalHostedZoneNameID>ZZZZZZZZZZZ123X</CanonicalHostedZoneNameID>\n <CanonicalHostedZoneName>MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com</CanonicalHostedZoneName>\n <Scheme>internet-facing</Scheme>\n <SourceSecurityGroup>\n <OwnerAlias>amazon-elb</OwnerAlias>\n <GroupName>amazon-elb-sg</GroupName>\n </SourceSecurityGroup>\n <DNSName>MyLoadBalancer-123456789.us-east-1.elb.amazonaws.com</DNSName>\n <BackendServerDescriptions/>\n <Subnets/>\n </member>\n </LoadBalancerDescriptions>\n </DescribeLoadBalancersResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ DescribeLoadBalancerPolicyTypesResponse >\t\n </queryresponse>\n </example>\n </examples> \n ",
"pagination": {
"input_token": "Marker",
"output_token": "NextMarker",
"result_key": "LoadBalancerDescriptions",
"py_input_token": "marker"
}
},
"DescribeTags": {
"name": "DescribeTags",
"input": {
"shape_name": "DescribeTagsInput",
"type": "structure",
"members": {
"LoadBalancerNames": {
"shape_name": "LoadBalancerNamesMax20",
"type": "list",
"members": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": null
},
"min_length": 1,
"max_length": 20,
"documentation": "\n <p>\n The names of the load balancers. \n </p> \n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DescribeTags</a> action.\n </p> \n "
},
"output": {
"shape_name": "DescribeTagsOutput",
"type": "structure",
"members": {
"TagDescriptions": {
"shape_name": "TagDescriptions",
"type": "list",
"members": {
"shape_name": "TagDescription",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>The name of the load balancer.</p>\n "
},
"Tags": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "structure",
"members": {
"Key": {
"shape_name": "TagKey",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 1,
"max_length": 128,
"documentation": "\n <p>The key of the tag.</p> \n ",
"required": true
},
"Value": {
"shape_name": "TagValue",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 0,
"max_length": 256,
"documentation": " \n <p>The value of the tag.</p>\n "
}
},
"documentation": "\n <p>Metadata assigned to a load balancer consisting of key-value pair.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb\">Tagging</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n "
},
"min_length": 1,
"documentation": "\n <p>List of tags associated with the load balancer.</p>\n "
}
},
"documentation": "\n <p>The descriptions of all the tags associated with load balancer.</p>\n "
},
"documentation": "\n <p>\n A list of tag description structures.\n </p>\n "
}
},
"documentation": "\n <p>\n The output for the <a>DescribeTags</a> action.\n </p> \n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>Describes the tags associated with one or more load balancers.</p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com//?Action=DescribeTags\n&LoadBalancerNames.member.1=my-test-loadbalancer\n&Version=2012-06-01\n&AUTHPARAMS </queryrequest> \n <queryresponse><DescribeTagsResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DescribeTagsResult>\n <TagDescriptions>\n <member>\n <Tags>\n <Value>my-test-project</Value>\n <Key>project</Key>\n </member>\n <member>\n <Value>test</Value>\n <Key>environment</Key>\n </member>\n </Tags>\n <LoadBalancerName>my-test-loadbalancer</LoadBalancerName>\n </member>\n </TagDescriptions>\n <ResponseMetadata>\n <RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>\n </ResponseMetadata>\n</DescribeTagsResponse>\n </queryresponse>\n </examples> \n \n "
},
"DetachLoadBalancerFromSubnets": {
"name": "DetachLoadBalancerFromSubnets",
"input": {
"shape_name": "DetachLoadBalancerFromSubnetsInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer to be detached. \n </p>\n ",
"required": true
},
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of subnet IDs to remove from the set of configured subnets for the load balancer.\n </p> \n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>DetachLoadBalancerFromSubnets</a> action. \n </p> \n "
},
"output": {
"shape_name": "DetachLoadBalancerFromSubnetsOutput",
"type": "structure",
"members": {
"Subnets": {
"shape_name": "Subnets",
"type": "list",
"members": {
"shape_name": "SubnetId",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of subnet IDs the load balancer is now attached to. \n </p> \n "
}
},
"documentation": "\n <p>\n The output for the <a>DetachLoadBalancerFromSubnets</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Removes subnets from the set of configured subnets in the Amazon Virtual Private Cloud (Amazon VPC) for the load balancer. \n </p> \n <p>\n After a subnet is removed all of the EC2 instances registered with the load balancer that are \n in the removed subnet will go into the <i>OutOfService</i> state. When a subnet is removed, the load balancer\n will balance the traffic among the remaining routable subnets for the load balancer. \n </p>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Subnets.member.1=subnet-119f0078\n&LoadBalancerName=my-test-vpc-loadbalancer\n&Version=2012-06-01\n&Action=DetachLoadBalancerFromSubnets\n&AUTHPARAMS </queryrequest> \n <queryresponse><DetachLoadBalancerFromSubnetsResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DetachLoadBalancerFromSubnetsResult>\n <Subnets>\n <member>subnet-159f007c</member>\n <member>subnet-3561b05e</member>\n </Subnets>\n </DetachLoadBalancerFromSubnetsResult>\n <ResponseMetadata>\n <RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>\n </ResponseMetadata>\n</DetachLoadBalancerFromSubnetsResponse>\n </queryresponse>\n </examples> \n "
},
"DisableAvailabilityZonesForLoadBalancer": {
"name": "DisableAvailabilityZonesForLoadBalancer",
"input": {
"shape_name": "RemoveAvailabilityZonesInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer. \n </p>\n ",
"required": true
},
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of Availability Zones to be removed from the load balancer.\n </p>\n <note>\n There must be at least one Availability Zone\n registered with a load balancer at all times. \n Specified Availability Zones must be in the same region.\n </note>\n ",
"required": true
}
},
"documentation": "\n\t\t<p>\n\t\tThe input for the <a>DisableAvailabilityZonesForLoadBalancer</a> action.\n\t\t</p>\n "
},
"output": {
"shape_name": "RemoveAvailabilityZonesOutput",
"type": "structure",
"members": {
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of updated Availability Zones for the load balancer.\n </p>\n "
}
},
"documentation": "\n\t\t<p>\n\t\tThe output for the <a>DisableAvailabilityZonesForLoadBalancer</a> action.\n\t\t</p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Removes the specified EC2 Availability Zones from\n the set of configured Availability Zones for the load balancer.\n </p>\n <p>\n There must be at least one Availability Zone registered\n with a load balancer at all times. \n Once an Availability Zone is removed, all the instances\n registered with the load balancer that are in the removed\n Availability Zone go into the <i>OutOfService</i> state. Upon Availability\n Zone removal, the load balancer attempts to equally balance\n the traffic among its remaining usable Availability Zones.\n Trying to remove an Availability Zone that was not associated with\n the load balancer does nothing.\n </p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_ShrinkLBApp04.html\">Disable an Availability Zone from a Load-Balanced Application</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p> \n <examples>\n <example> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?AvailabilityZones.member.1=us-east-1a\n&LoadBalancerName=MyHTTPSLoadBalancer\n&Version=2012-06-01\n&Action=DisableAvailabilityZonesForLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><DisableAvailabilityZonesForLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <DisableAvailabilityZonesForLoadBalancerResult>\n <AvailabilityZones>\n <member>us-east-1b</member>\n </AvailabilityZones>\n </DisableAvailabilityZonesForLoadBalancerResult>\n <ResponseMetadata>\n <RequestId>ba6267d5-2566-11e3-9c6d-eb728EXAMPLE</RequestId>\n </ResponseMetadata>\n</DisableAvailabilityZonesForLoadBalancerResponse>\n </queryresponse>\n </example>\n </examples> \n "
},
"EnableAvailabilityZonesForLoadBalancer": {
"name": "EnableAvailabilityZonesForLoadBalancer",
"input": {
"shape_name": "AddAvailabilityZonesInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer. \n </p>\n ",
"required": true
},
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n A list of new Availability Zones for the load balancer.\n Each Availability Zone must be in the same region as the load balancer.\n </p>\n ",
"required": true
}
},
"documentation": "\n\t\t<p>\n\t\tThe input for the <a>EnableAvailabilityZonesForLoadBalancer</a> action.\n\t\t</p>\n "
},
"output": {
"shape_name": "AddAvailabilityZonesOutput",
"type": "structure",
"members": {
"AvailabilityZones": {
"shape_name": "AvailabilityZones",
"type": "list",
"members": {
"shape_name": "AvailabilityZone",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n An updated list of Availability Zones for the load balancer.\n </p>\n "
}
},
"documentation": "\n\t\t<p>\n\t\tThe output for the <a>EnableAvailabilityZonesForLoadBalancer</a> action.\n\t\t</p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>\n Adds one or more EC2 Availability Zones to the load balancer.\n </p>\n <p>\n The load balancer evenly distributes requests across all\n its registered Availability Zones that contain instances. \n </p>\n <note>\n The new EC2 Availability Zones to be added must be in the same\n EC2 Region as the Availability Zones for which the\n load balancer was created.\n </note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_AddLBAvailabilityZone.html\">Expand a Load Balanced Application to an Additional Availability Zone</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n <examples>\n <example>\n <name>Enable Availability Zone <i>us-east-1c</i> for <i>my-test-loadbalancer</i>.</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?AvailabilityZones.member.1=us-east-1c\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=EnableAvailabilityZonesForLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><EnableAvailabilityZonesForLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <EnableAvailabilityZonesForLoadBalancerResult>\n <AvailabilityZones>\n <member>us-east-1a</member>\n <member>us-east-1c</member>\n </AvailabilityZones>\n </EnableAvailabilityZonesForLoadBalancerResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</EnableAvailabilityZonesForLoadBalancerResponse>\n </queryresponse>\n </example>\n </examples> \n "
},
"ModifyLoadBalancerAttributes": {
"name": "ModifyLoadBalancerAttributes",
"input": {
"shape_name": "ModifyLoadBalancerAttributesInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>The name of the load balancer.</p> \n ",
"required": true
},
"LoadBalancerAttributes": {
"shape_name": "LoadBalancerAttributes",
"type": "structure",
"members": {
"CrossZoneLoadBalancing": {
"shape_name": "CrossZoneLoadBalancing",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "CrossZoneLoadBalancingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether cross-zone load balancing is enabled for the load balancer.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. \n If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-disable-crosszone-lb.html\">Enable Cross-Zone Load Balancing</a>.</p>\n "
},
"AccessLog": {
"shape_name": "AccessLog",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "AccessLogEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether access log is enabled for the load balancer.</p>\n ",
"required": true
},
"S3BucketName": {
"shape_name": "S3BucketName",
"type": "string",
"documentation": "\n <p>The name of the Amazon S3 bucket where the access logs are stored.</p>\n "
},
"EmitInterval": {
"shape_name": "AccessLogInterval",
"type": "integer",
"documentation": "\n <p>The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.</p>\n <p>Default: 60 minutes</p>\n "
},
"S3BucketPrefix": {
"shape_name": "AccessLogPrefix",
"type": "string",
"documentation": "\n <p>The logical hierarchy you created for your Amazon S3 bucket, for example <code>my-bucket-prefix/prod</code>. \n If the prefix is not provided, the log is placed at the root level of the bucket.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-access-logs.html\">Enable Access Logs</a>.</p>\n "
},
"ConnectionDraining": {
"shape_name": "ConnectionDraining",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "ConnectionDrainingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether connection draining is enabled for the load balancer.</p>\n ",
"required": true
},
"Timeout": {
"shape_name": "ConnectionDrainingTimeout",
"type": "integer",
"documentation": "\n <p>Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance. </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-conn-drain.html\">Enable Connection Draining</a>.</p>\n \n "
},
"ConnectionSettings": {
"shape_name": "ConnectionSettings",
"type": "structure",
"members": {
"IdleTimeout": {
"shape_name": "IdleTimeout",
"type": "integer",
"min_length": 1,
"max_length": 3600,
"documentation": "\n <p>Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.</p> \n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. </p>\n <p>By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the <code>ConnectionSettings</code> attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-idle-timeout.html\">Configure Idle Connection Timeout</a>.</p>\n "
}
},
"documentation": "\n <p>Attributes of the load balancer.</p> \n ",
"required": true
}
},
"documentation": "\n <p>The input for the <a>ModifyLoadBalancerAttributes</a> action.</p> \n "
},
"output": {
"shape_name": "ModifyLoadBalancerAttributesOutput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>The name of the load balancer.</p> \n "
},
"LoadBalancerAttributes": {
"shape_name": "LoadBalancerAttributes",
"type": "structure",
"members": {
"CrossZoneLoadBalancing": {
"shape_name": "CrossZoneLoadBalancing",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "CrossZoneLoadBalancingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether cross-zone load balancing is enabled for the load balancer.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. \n If enabled, the load balancer routes the request traffic evenly across all back-end instances regardless of the Availability Zones.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-disable-crosszone-lb.html\">Enable Cross-Zone Load Balancing</a>.</p>\n "
},
"AccessLog": {
"shape_name": "AccessLog",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "AccessLogEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether access log is enabled for the load balancer.</p>\n ",
"required": true
},
"S3BucketName": {
"shape_name": "S3BucketName",
"type": "string",
"documentation": "\n <p>The name of the Amazon S3 bucket where the access logs are stored.</p>\n "
},
"EmitInterval": {
"shape_name": "AccessLogInterval",
"type": "integer",
"documentation": "\n <p>The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.</p>\n <p>Default: 60 minutes</p>\n "
},
"S3BucketPrefix": {
"shape_name": "AccessLogPrefix",
"type": "string",
"documentation": "\n <p>The logical hierarchy you created for your Amazon S3 bucket, for example <code>my-bucket-prefix/prod</code>. \n If the prefix is not provided, the log is placed at the root level of the bucket.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/enable-access-logs.html\">Enable Access Logs</a>.</p>\n "
},
"ConnectionDraining": {
"shape_name": "ConnectionDraining",
"type": "structure",
"members": {
"Enabled": {
"shape_name": "ConnectionDrainingEnabled",
"type": "boolean",
"documentation": "\n <p>Specifies whether connection draining is enabled for the load balancer.</p>\n ",
"required": true
},
"Timeout": {
"shape_name": "ConnectionDrainingTimeout",
"type": "integer",
"documentation": "\n <p>Specifies the maximum time (in seconds) to keep the existing connections open before deregistering the instances.</p>\n "
}
},
"documentation": "\n <p>The name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance. </p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-conn-drain.html\">Enable Connection Draining</a>.</p>\n \n "
},
"ConnectionSettings": {
"shape_name": "ConnectionSettings",
"type": "structure",
"members": {
"IdleTimeout": {
"shape_name": "IdleTimeout",
"type": "integer",
"min_length": 1,
"max_length": 3600,
"documentation": "\n <p>Specifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.</p> \n ",
"required": true
}
},
"documentation": "\n <p>The name of the load balancer attribute. </p>\n <p>By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the <code>ConnectionSettings</code> attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.</p> \n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/config-idle-timeout.html\">Configure Idle Connection Timeout</a>.</p>\n "
}
},
"documentation": "\n <p>The <code>LoadBalancerAttributes</code> data type.</p>\n "
}
},
"documentation": "\n <p>The output for the <a>ModifyLoadBalancerAttributes</a> action.</p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "LoadBalancerAttributeNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>The specified load balancer attribute could not be found.</p> \n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>Modifies the attributes of a specified load balancer.</p> \n <p>You can modify the load balancer attributes, such as <code>AccessLogs</code>, <code>ConnectionDraining</code>, and \n <code>CrossZoneLoadBalancing</code> by either enabling or disabling them. Or, you can modify the load balancer attribute \n <code>ConnectionSettings</code> by specifying an idle connection timeout value for your load balancer.</p> \n <p>For more information, see the following:</p> \n \n <ul>\n <li><a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#request-routing\">Cross-Zone Load Balancing</a></li>\n <li><a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain\">Connection Draining</a></li>\n <li><a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/access-log-collection.html\">Access Logs</a></li> \n <li><a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#idle-timeout\">Idle Connection Timeout</a></li>\n </ul>\n \n \n <examples>\n <example>\n <name>Enable Cross-Zone Load Balancing</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&LoadBalancerAttributes.CrossZoneLoadBalancing.Enabled=true \n&Version=2012-06-01\n&Action=ModifyLoadBalancerAttributes\n&AUTHPARAMS </queryrequest> \n <queryresponse><<ModifyLoadBalancerAttributesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<ModifyLoadBalancerAttributesResult> \n<LoadBalancerName>my-test-loadbalancer</LoadBalancerName>\n <LoadBalancerAttributes>\n <CrossZoneLoadBalancing>\n <Enabled>true</Enabled>\n </CrossZoneLoadBalancing>\n </LoadBalancerAttributes>\n </ModifyLoadBalancerAttributesResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ModifyLoadBalancerAttributesResponse>\n </queryresponse>\n </example>\n <example>\n <name>Enable Access Log</name>\n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&LoadBalancerAttributes.AccessLog.Enabled=true \n&LoadBalancerAttributes.AccessLog.S3BucketName=my-loadbalancer-logs\n&LoadBalancerAttributes.AccessLog.S3BucketPrefix=my-bucket-prefix/prod\n&LoadBalancerAttributes.AccessLog.EmitInterval=60\n&Version=2012-06-01\n&Action=ModifyLoadBalancerAttributes\n&AUTHPARAMS </queryrequest>\n \n <queryresponse><<ModifyLoadBalancerAttributesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<ModifyLoadBalancerAttributesResult>\n <LoadBalancerName>my-test-loadbalancer</LoadBalancerName>\n <LoadBalancerAttributes>\n <AccessLog>\n <Enabled>true</Enabled>\n <S3BucketName>my-loadbalancer-logs</S3BucketName>\n <S3BucketPrefix>my-bucket-prefix/prod</S3BucketPrefix>\n <EmitInterval>60</EmitInterval>\n </AccessLog>\n </LoadBalancerAttributes>\n </ModifyLoadBalancerAttributesResult> \n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ModifyLoadBalancerAttributesResponse>\n </queryresponse>\n \n </example>\n <example>\n <name>Enable Connection Draining</name>\n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&LoadBalancerAttributes.ConnectionDraining.Enabled=true \n&LoadBalancerAttributes.ConnectionDraining.Timeout=60\n&Version=2012-06-01\n&Action=ModifyLoadBalancerAttributes\n&AUTHPARAMS </queryrequest>\n \n <queryresponse><<ModifyLoadBalancerAttributesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<ModifyLoadBalancerAttributesResult>\n <LoadBalancerName>my-test-loadbalancer</LoadBalancerName>\n <LoadBalancerAttributes>\n <ConnectionDraining>\n <Enabled>true</Enabled>\n <Timeout>60</Timeout> \n </ConnectionDraining>\n </LoadBalancerAttributes>\n </ModifyLoadBalancerAttributesResult> \n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ModifyLoadBalancerAttributesResponse>\n </queryresponse>\n \n </example>\n \n <example>\n <name>Configure Connection Settings</name>\n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&LoadBalancerAttributes.ConnectionSettings.IdleTimeout=30\n&Version=2012-06-01\n&Action=ModifyLoadBalancerAttributes\n&AUTHPARAMS </queryrequest>\n \n <queryresponse><<ModifyLoadBalancerAttributesResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n<ModifyLoadBalancerAttributesResult>\n <LoadBalancerName>my-test-loadbalancer</LoadBalancerName>\n <LoadBalancerAttributes>\n <ConnectionSettings>\n <IdleTimeout>30</IdleTimeout>\n </ConnectionSettings>\n </LoadBalancerAttributes>\n </ModifyLoadBalancerAttributesResult> \n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</ModifyLoadBalancerAttributesResponse>\n </queryresponse>\n \n </example>\n </examples> \n "
},
"RegisterInstancesWithLoadBalancer": {
"name": "RegisterInstancesWithLoadBalancer",
"input": {
"shape_name": "RegisterEndPointsInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name associated with the load balancer.\n The name must be unique within your set of load balancers. \n </p>\n ",
"required": true
},
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n A list of instance IDs that should be registered with the load balancer.</p> \n \n ",
"required": true
}
},
"documentation": "\n\t\t<p>\n\t\tThe input for the <a>RegisterInstancesWithLoadBalancer</a> action.\n\t\t</p>\n "
},
"output": {
"shape_name": "RegisterEndPointsOutput",
"type": "structure",
"members": {
"Instances": {
"shape_name": "Instances",
"type": "list",
"members": {
"shape_name": "Instance",
"type": "structure",
"members": {
"InstanceId": {
"shape_name": "InstanceId",
"type": "string",
"documentation": "\n <p>\n Provides an EC2 instance ID.\n </p>\n "
}
},
"documentation": "\n <p>\n The Instance data type.\n </p>\n "
},
"documentation": "\n <p>\n An updated list of instances for the load balancer.\n </p>\n "
}
},
"documentation": "\n\t\t<p>\n\t\tThe output for the <a>RegisterInstancesWithLoadBalancer</a> action.\n\t\t</p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "InvalidEndPointException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified EndPoint is not valid.\n </p>\n "
}
],
"documentation": "\n <p>\n Adds new instances to the load balancer.\n </p>\n <p>\n Once the instance is registered, it starts receiving traffic\n and requests from the load balancer. Any instance that is not\n in any of the Availability Zones registered for the load balancer\n will be moved to the <i>OutOfService</i> state. It will move to the\n <i>InService</i> state when the Availability Zone is added to the load balancer.\n </p>\n <p>When an instance registered with a load balancer is stopped and then restarted, \n the IP addresses associated with the instance changes. Elastic Load Balancing \n cannot recognize the new IP address, which prevents it from routing traffic to\n the instances. We recommend that you de-register your Amazon EC2 instances from\n your load balancer after you stop your instance, and then register the load \n balancer with your instance after you've restarted. To de-register your instances \n from load balancer, use <a>DeregisterInstancesFromLoadBalancer</a> action.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_DeReg_Reg_Instances.html\">De-register and Register Amazon EC2 Instances</a> \n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n <note>\n In order for this call to be successful, you must provide the same \n account credentials as those that were used to create the load balancer.\n </note>\n <note>\n Completion of this API does not guarantee that operation has completed.\n Rather, it means that the request has been registered and the\n changes will happen shortly.\n </note>\n <p>You can use <a>DescribeLoadBalancers</a> or <a>DescribeInstanceHealth</a> action to check the state of the newly registered instances.</p> \n <examples>\n <example> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?Instances.member.1.InstanceId=i-315b7e51\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=RegisterInstancesWithLoadBalancer\n&AUTHPARAMS </queryrequest> \n <queryresponse><RegisterInstancesWithLoadBalancerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <RegisterInstancesWithLoadBalancerResult>\n <Instances>\n <member>\n <InstanceId>i-315b7e51</InstanceId>\n </member>\n </Instances>\n </RegisterInstancesWithLoadBalancerResult>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</RegisterInstancesWithLoadBalancerResponse>\n </queryresponse>\n </example>\n </examples> \n \n "
},
"RemoveTags": {
"name": "RemoveTags",
"input": {
"shape_name": "RemoveTagsInput",
"type": "structure",
"members": {
"LoadBalancerNames": {
"shape_name": "LoadBalancerNames",
"type": "list",
"members": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The name of the load balancer. You can specify a maximum of one load balancer name.</p>\n ",
"required": true
},
"Tags": {
"shape_name": "TagKeyList",
"type": "list",
"members": {
"shape_name": "TagKeyOnly",
"type": "structure",
"members": {
"Key": {
"shape_name": "TagKey",
"type": "string",
"pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$",
"min_length": 1,
"max_length": 128,
"documentation": "\n <p>The name of the key.</p>\n "
}
},
"documentation": "\n <p>The key of a tag to be removed.</p> \n "
},
"min_length": 1,
"documentation": "\n <p>A list of tag keys to remove.</p> \n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>RemoveTags</a> action.\n </p>\n "
},
"output": {
"shape_name": "RemoveTagsOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>RemoveTags</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
}
],
"documentation": "\n <p>Removes one or more tags from the specified load balancer.</p>\n <examples>\n <example>\n <name>Remove Two Tag Keys from the Load Balancer</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=my-test-loadbalancer\n&Tags.member.1.Key=owner\n&Tags.member.2.Key=project\n&Action=RemoveTags\n&Version=2012-06-01\n&AUTHPARAMS </queryrequest> \n <queryresponse><RemoveTagsResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <RemoveTagsResult/>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</RemoveTagsResponse>\n </queryresponse>\n </example>\n </examples> \n \n "
},
"SetLoadBalancerListenerSSLCertificate": {
"name": "SetLoadBalancerListenerSSLCertificate",
"input": {
"shape_name": "SetLoadBalancerListenerSSLCertificateInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name of the load balancer. \n </p>\n ",
"required": true
},
"LoadBalancerPort": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": "\n <p>\n The port that uses the specified SSL certificate. \n </p>\n ",
"required": true
},
"SSLCertificateId": {
"shape_name": "SSLCertificateId",
"type": "string",
"documentation": "\n <p>\n The Amazon Resource Number (ARN) of the SSL certificate chain to use. \n For more information on SSL certificates, see \n <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html\">\n Managing Server Certificates</a> in the <i>AWS Identity and Access Management User Guide</i>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>SetLoadBalancerListenerSSLCertificate</a> action.\n </p>\n "
},
"output": {
"shape_name": "SetLoadBalancerListenerSSLCertificateOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>SetLoadBalancerListenerSSLCertificate</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "CertificateNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified SSL ID does not refer to a valid SSL certificate \n in the AWS Identity and Access Management Service.\n </p>\n "
},
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "ListenerNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Load balancer does not have a listener configured at the given port.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Sets the certificate that terminates the specified listener's SSL connections. \n The specified certificate replaces any prior certificate that was used on the same load balancer and port. \n </p>\n <p>For more information on updating your SSL certificate, see <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/US_UpdatingLoadBalancerSSL.html\">Updating an SSL Certificate for a Load Balancer</a>\n in the <i>Elastic Load Balancing Developer Guide</i>.</p>\n \n <examples>\n <example> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?LoadBalancerName=MyInternalLoadBalancer\n&SSLCertificateId=arn:aws:iam::123456789012:server-certificate/testcert\n&LoadBalancerPort=443\n&Version=2012-06-01\n&Action=SetLoadBalancerListenerSSLCertificate\n&AUTHPARAMS </queryrequest> \n <queryresponse><SetLoadBalancerListenerSSLCertificateResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <SetLoadBalancerListenerSSLCertificateResult/>\n<ResponseMetadata>\n <RequestId>83c88b9d-12b7-11e3-8b82-87b12EXAMPLE</RequestId>\n</ResponseMetadata>\n</SetLoadBalancerListenerSSLCertificateResponse>\n </queryresponse>\n </example>\n </examples> \n "
},
"SetLoadBalancerPoliciesForBackendServer": {
"name": "SetLoadBalancerPoliciesForBackendServer",
"input": {
"shape_name": "SetLoadBalancerPoliciesForBackendServerInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The mnemonic name associated with the load balancer.\n This name must be unique within the set of your load balancers.\n </p>\n ",
"required": true
},
"InstancePort": {
"shape_name": "EndPointPort",
"type": "integer",
"documentation": "\n <p>\n The port number associated with the back-end server.\n </p>\n ",
"required": true
},
"PolicyNames": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n List of policy names to be set. If the list is empty, then all current polices are\n removed from the back-end server.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>The input for the <a>SetLoadBalancerPoliciesForBackendServer</a> action.</p>\n "
},
"output": {
"shape_name": "SetLoadBalancerPoliciesForBackendServerOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>SetLoadBalancerPoliciesForBackendServer</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "PolicyNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more specified policies were not found.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Replaces the current set of policies associated with a port on which the back-end server is listening with a new set of policies. After the policies have been created using <a>CreateLoadBalancerPolicy</a>, \n they can be applied here as a list. At this time, only the back-end server authentication policy type can be applied to the back-end ports; this policy type is composed of multiple public key policies.\n </p>\n <note>\n <p>The <i>SetLoadBalancerPoliciesForBackendServer</i> replaces the current set of policies associated with the specified instance port. \n Every time you use this action to enable the policies, use the <code>PolicyNames</code> parameter to list all the policies you want to enable.</p>\n </note>\n <examples> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?InstancePort=80\n&PolicyNames.member.1=EnableProxyProtocol\n&PolicyNames.member.2=MyPolicyName2\n&PolicyNames.member.3=MyPolicyName3\n&LoadBalancerName=my-test-loadbalancer\n&Version=2012-06-01\n&Action=SetLoadBalancerPoliciesForBackendServer\n&AUTHPARAMS </queryrequest> \n <queryresponse><SetLoadBalancerPoliciesForBackendServerResponse xmlns=\"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/\">\n <SetLoadBalancerPoliciesForBackendServerResult/>\n <ResponseMetadata>\n <RequestId>0eb9b381-dde0-11e2-8d78-6ddbaEXAMPLE</RequestId>\n </ResponseMetadata>\n</SetLoadBalancerPoliciesForBackendServerResponse> \n </queryresponse>\n </examples> \n <p>You can use <a>DescribeLoadBalancers</a> or <a>DescribeLoadBalancerPolicies</a> action to verify that the policy has been associated with the back-end server.</p> \n "
},
"SetLoadBalancerPoliciesOfListener": {
"name": "SetLoadBalancerPoliciesOfListener",
"input": {
"shape_name": "SetLoadBalancerPoliciesOfListenerInput",
"type": "structure",
"members": {
"LoadBalancerName": {
"shape_name": "AccessPointName",
"type": "string",
"documentation": "\n <p>\n The name of the load balancer. \n </p>\n ",
"required": true
},
"LoadBalancerPort": {
"shape_name": "AccessPointPort",
"type": "integer",
"documentation": "\n <p>\n The external port of the load balancer to associate the policy. \n </p>\n ",
"required": true
},
"PolicyNames": {
"shape_name": "PolicyNames",
"type": "list",
"members": {
"shape_name": "PolicyName",
"type": "string",
"documentation": null
},
"documentation": "\n <p>\n List of policies to be associated with the listener. If the list is empty, the current policy is removed from the listener.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The input for the <a>SetLoadBalancerPoliciesOfListener</a> action.\n </p>\n "
},
"output": {
"shape_name": "SetLoadBalancerPoliciesOfListenerOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The output for the <a>SetLoadBalancerPoliciesOfListener</a> action.\n </p>\n "
},
"errors": [
{
"shape_name": "AccessPointNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n The specified load balancer could not be found.\n </p>\n "
},
{
"shape_name": "PolicyNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n One or more specified policies were not found.\n </p>\n "
},
{
"shape_name": "ListenerNotFoundException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Load balancer does not have a listener configured at the given port.\n </p>\n "
},
{
"shape_name": "InvalidConfigurationRequestException",
"type": "structure",
"members": {},
"documentation": "\n <p>\n Requested configuration change is invalid.\n </p>\n "
}
],
"documentation": "\n <p>\n Associates, updates, or disables a policy with a listener on the load balancer. \n You can associate multiple policies with a listener. \n </p>\n <examples>\n <name>Associate <i>MySSLNegotiationPolicy</i> with the load balancer port <i>443</i> on the <i>MyInternalLoadbalancer</i> load balancer.</name> \n <queryrequest>https://elasticloadbalancing.amazonaws.com/?PolicyNames.member.1=MySSLNegotiationPolicy\n&LoadBalancerName=MyInternalLoadBalancer\n&LoadBalancerPort=443\n&Version=2012-06-01\n&Action=SetLoadBalancerPoliciesOfListener\n&AUTHPARAMS </queryrequest> \n <queryresponse><SetLoadBalancerPoliciesOfListenerResponse xmlns=\"http://elasticloadbalancing.am\nazonaws.com/doc/2012-06-01/\">\n <SetLoadBalancerPoliciesOfListenerResult/>\n <ResponseMetadata>\n <RequestId>07b1ecbc-1100-11e3-acaf-dd7edEXAMPLE</RequestId>\n </ResponseMetadata>\n</SetLoadBalancerPoliciesOfListenerResponse>\n </queryresponse>\n </examples> \n \n "
}
},
"pagination": {
"DescribeLoadBalancers": {
"input_token": "Marker",
"output_token": "NextMarker",
"result_key": "LoadBalancerDescriptions",
"py_input_token": "marker"
}
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
}
}
}
}
}
|