/usr/lib/python2.7/dist-packages/botocore/data/aws/swf.json is in python-botocore 0.29.0+repack-2.
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 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 | {
"api_version": "2012-01-25",
"type": "json",
"json_version": 1.0,
"target_prefix": "SimpleWorkflowService",
"signature_version": "v4",
"timestamp_format": "unixTimestamp",
"service_full_name": "Amazon Simple Workflow Service",
"service_abbreviation": "Amazon SWF",
"endpoint_prefix": "swf",
"documentation": "\n <fullname>Amazon Simple Workflow Service</fullname>\n\n <p>The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate\n work across distributed components. In Amazon SWF, a <emphasis>task</emphasis> represents a logical unit of\n work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing\n intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.</p>\n\n <p>Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about\n underlying complexities such as tracking their progress and maintaining their state.</p>\n\n <p>This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see\n the <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/\">Amazon SWF Developer Guide</a>.</p>\n ",
"operations": {
"CountClosedWorkflowExecutions": {
"name": "CountClosedWorkflowExecutions",
"input": {
"shape_name": "CountClosedWorkflowExecutionsInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The name of the domain containing the workflow executions to count.</p>\n ",
"required": true
},
"startTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, only workflow executions that meet the start time criteria of the filter are counted.\n </p>\n <note><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive.\n You must specify one of these in a request but not both.</note>\n "
},
"closeTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, only workflow executions that meet the close time criteria of the filter are counted.\n </p>\n <note><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive.\n You must specify one of these in a request but not both.</note>\n "
},
"executionFilter": {
"shape_name": "WorkflowExecutionFilter",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId to pass of match the criteria of this filter.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.</p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and\n <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"typeFilter": {
"shape_name": "WorkflowTypeFilter",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Name of the workflow type.\n This field is required.\n </p>\n ",
"required": true
},
"version": {
"shape_name": "VersionOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n Version of the workflow type.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, indicates the type of the workflow executions to be counted.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"tagFilter": {
"shape_name": "TagFilter",
"type": "structure",
"members": {
"tag": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only executions that have a tag that matches the filter are counted.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"closeStatusFilter": {
"shape_name": "CloseStatusFilter",
"type": "structure",
"members": {
"status": {
"shape_name": "CloseStatus",
"enum": [
"COMPLETED",
"FAILED",
"CANCELED",
"TERMINATED",
"CONTINUED_AS_NEW",
"TIMED_OUT"
],
"type": "string",
"documentation": "\n <p>\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only workflow executions that match this close status are counted.\n This filter has an affect only if <code>executionStatus</code>\n is specified as <code>CLOSED</code>.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowExecutionCount",
"type": "structure",
"members": {
"count": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The number of workflow executions.\n </p>\n ",
"required": true
},
"truncated": {
"shape_name": "Truncated",
"type": "boolean",
"documentation": "\n <p>\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains the count of workflow executions returned from <a>CountOpenWorkflowExecutions</a> or <a>CountClosedWorkflowExecutions</a>\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>Returns the number of closed workflow executions within the given domain that meet the specified filtering\n criteria.</p>\n\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><strong>Access Control</strong></p>\n\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n\n <ul>\n <li>\n <p>Use a <code>Resource</code> element with the domain name to limit the action to only specified\n domains.</p>\n </li>\n <li>\n <p>Use an <code>Action</code> element to allow or deny permission to call this action.</p>\n </li>\n <li>\n <p>Constrain the following parameters by using a <code>Condition</code> element with the appropriate\n keys.</p>\n <ul>\n <li>\n <p><code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</p>\n </li>\n <li>\n <p><code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</p>\n </li>\n <li>\n <p><code>typeFilter.version</code>: String constraint. The key is\n <code>swf:typeFilter.version</code>.</p>\n </li>\n </ul>\n </li>\n </ul>\n\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside\n the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and\n example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to\n Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name>CountClosedWorkflowExecutions Example</name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:42:47 GMT\n X-Amz-Target: SimpleWorkflowService.CountClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=jFS74utjeATV7vj72CWdLToPCKW0RQse6OEDkafB+SA=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 157\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\n \"domain\": \"867530901\",\n \"closeTimeFilter\": {\"oldestDate\": 1325376070, \"latestDate\": 1356998399},\n \"closeStatusFilter\": {\"status\": \"TIMED_OUT\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 9bfad387-3f22-11e1-9914-a356b6ea8bdf\n\n { \"count\":3, \"truncated\":false }\n </response>\n </example>\n </examples>\n "
},
"CountOpenWorkflowExecutions": {
"name": "CountOpenWorkflowExecutions",
"input": {
"shape_name": "CountOpenWorkflowExecutionsInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the workflow executions to count.\n </p>\n ",
"required": true
},
"startTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n Specifies the start time criteria that workflow executions must meet in order to be counted.\n </p>\n ",
"required": true
},
"typeFilter": {
"shape_name": "WorkflowTypeFilter",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Name of the workflow type.\n This field is required.\n </p>\n ",
"required": true
},
"version": {
"shape_name": "VersionOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n Version of the workflow type.\n </p>\n "
}
},
"documentation": "\n <p>\n Specifies the type of the workflow executions to be counted.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"tagFilter": {
"shape_name": "TagFilter",
"type": "structure",
"members": {
"tag": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only executions that have a tag that matches the filter are counted.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"executionFilter": {
"shape_name": "WorkflowExecutionFilter",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId to pass of match the criteria of this filter.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowExecutionCount",
"type": "structure",
"members": {
"count": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The number of workflow executions.\n </p>\n ",
"required": true
},
"truncated": {
"shape_name": "Truncated",
"type": "boolean",
"documentation": "\n <p>\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains the count of workflow executions returned from <a>CountOpenWorkflowExecutions</a> or <a>CountClosedWorkflowExecutions</a>\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns the number of open workflow executions within the given domain that meet the specified filtering\n criteria.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li>\n <li>\n<code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li>\n <li>\n<code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> CountOpenWorkflowExecutions Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:13:29 GMT\n X-Amz-Target: SimpleWorkflowService.CountOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=3v6shiGzWukq4KiX/5HFMIUF/w5qajhW4dp+6AKyOtY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 5ea6789e-3f05-11e1-9e8f-57bb03e21482\n\n {\"count\":1,\"truncated\":false}\n </response>\n </example>\n </examples>\n "
},
"CountPendingActivityTasks": {
"name": "CountPendingActivityTasks",
"input": {
"shape_name": "CountPendingActivityTasksInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain that contains the task list.\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "PendingTaskCount",
"type": "structure",
"members": {
"count": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The number of tasks in the task list.\n </p>\n ",
"required": true
},
"truncated": {
"shape_name": "Truncated",
"type": "boolean",
"documentation": "\n <p>\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains the count of tasks in a task list.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no activity task was ever scheduled in then 0 will be returned.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> CountPendingActivityTasks Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:29:28 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingActivityTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=eCNiyyl5qmP0gGQ0hM8LqeRzxEvVZ0LAjE4oxVzzk9w=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4b977c76-3ff2-11e1-a23a-99d60383ae71\n\n {\"count\":1,\"truncated\":false}\n </response>\n\n </example>\n\n </examples>\n\n "
},
"CountPendingDecisionTasks": {
"name": "CountPendingDecisionTasks",
"input": {
"shape_name": "CountPendingDecisionTasksInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain that contains the task list.\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "PendingTaskCount",
"type": "structure",
"members": {
"count": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The number of tasks in the task list.\n </p>\n ",
"required": true
},
"truncated": {
"shape_name": "Truncated",
"type": "boolean",
"documentation": "\n <p>\n If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains the count of tasks in a task list.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact.\n If you specify a task list that no decision task was ever scheduled in then 0 will be returned.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n\n <example>\n\n <name> CountPendingDecisionTasks Example </name>\n\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:25:57 GMT\n X-Amz-Target: SimpleWorkflowService.CountPendingDecisionTasks\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=i9tUkWnZBLfn/T6BOymajCtwArAll6Stuh1x2C4dbsE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 70\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n }\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 29\n Content-Type: application/json\n x-amzn-RequestId: 4718a364-3fd0-11e1-9914-a356b6ea8bdf\n\n {\"count\": 2,\n \"truncated\": false}\n </response>\n\n </example>\n\n </examples>\n\n "
},
"DeprecateActivityType": {
"name": "DeprecateActivityType",
"input": {
"shape_name": "DeprecateActivityTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the activity type is registered.\n </p>\n ",
"required": true
},
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The activity type to deprecate.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "TypeDeprecatedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the specified activity or workflow type was already deprecated.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Deprecates the specified <i>activity type</i>.\n After an activity type has been deprecated, you cannot create new tasks of that activity type.\n Tasks of this type that were scheduled before the type was deprecated will continue to run.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li>\n <li>\n<code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> DeprecateActivityType Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:01:06 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iX/mNMtNH6IaSNwfZq9hHOhDlLnp7buuj9tO93kRIrQ=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 191ee17e-3fff-11e1-a23a-99d60383ae71\n </response>\n </example>\n </examples>\n "
},
"DeprecateDomain": {
"name": "DeprecateDomain",
"input": {
"shape_name": "DeprecateDomainInput",
"type": "structure",
"members": {
"name": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain to deprecate.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "DomainDeprecatedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the specified domain has been deprecated.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions\n or register new types. However, you can still use visibility actions on this domain.\n Deprecating a domain also deprecates all activity and workflow types registered in the domain.\n Executions that were started before the domain was deprecated will continue to run.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name>DeprecateDomain Example</name>\n\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 05:07:47 GMT\nX-Amz-Target: SimpleWorkflowService.DeprecateDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BkJDtbH9uZvrarqXTkBEYuYHO7PPygRI8ykV29Dz/5M=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 0800c01a-4000-11e1-9914-a356b6ea8bdf\n</response>\n\n </example>\n </examples>\n "
},
"DeprecateWorkflowType": {
"name": "DeprecateWorkflowType",
"input": {
"shape_name": "DeprecateWorkflowTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the workflow type is registered.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type to deprecate.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "TypeDeprecatedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the specified activity or workflow type was already deprecated.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Deprecates the specified <i>workflow type</i>. After a workflow type has been deprecated, you cannot create new executions\n of that type. Executions that were started before the type was deprecated will continue to run.\n A deprecated workflow type may still be used when calling visibility actions.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li>\n <li>\n<code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li>\n </ul>\n </li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n\n <example>\n\n <name> DeprecateWorkflowType Example </name>\n\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 05:04:47 GMT\n X-Amz-Target: SimpleWorkflowService.DeprecateWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=BGrr1djQvp+YLq3ci2ffpK8KWhZm/PakBL2fFhc3zds=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 9c8d6d3b-3fff-11e1-9e8f-57bb03e21482\n </response>\n\n </example>\n\n </examples>\n\n "
},
"DescribeActivityType": {
"name": "DescribeActivityType",
"input": {
"shape_name": "DescribeActivityTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the activity type is registered.\n </p>\n ",
"required": true
},
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The activity type to describe.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "ActivityTypeDetail",
"type": "structure",
"members": {
"typeInfo": {
"shape_name": "ActivityTypeInfo",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The <a>ActivityType</a> type structure representing the activity type.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The current status of the activity type.\n </p>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the activity type provided in <a>RegisterActivityType</a>.\n </p>\n "
},
"creationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date and time this activity type was created through <a>RegisterActivityType</a>.\n </p>\n ",
"required": true
},
"deprecationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n If DEPRECATED, the date and time <a>DeprecateActivityType</a> was called.\n </p>\n "
}
},
"documentation": "\n <p>\n General information about the activity type.\n </p>\n <p>\n The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.\n </p>\n <ul>\n <li>\n <b>REGISTERED</b>: The type is registered and available. Workers supporting this\n type should be running.\n </li>\n <li>\n <b>DEPRECATED</b>: The type was deprecated using <a>DeprecateActivityType</a>, but is\n still in use. You should keep workers supporting this type running.\n You cannot create new tasks of this type.\n </li>\n </ul>\n ",
"required": true
},
"configuration": {
"shape_name": "ActivityTypeConfiguration",
"type": "structure",
"members": {
"defaultTaskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum duration for tasks of an activity type specified when\n registering the activity type. You can\n override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskHeartbeatTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum time, specified when registering the activity type,\n before which a worker processing a task must report progress by\n calling <a>RecordActivityTaskHeartbeat</a>.\n You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker\n receives an <code>UnknownResource</code> fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The optional default task list specified for this activity type at registration. This default task list is used\n if a task list is not provided when a task is scheduled through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n "
},
"defaultTaskScheduleToStartTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum duration, specified when registering the activity type,\n that a task of an activity type can wait before being assigned to a worker.\n You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskScheduleToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum duration, specified when registering the activity type,\n for tasks of this activity type.\n You can override this default when scheduling a task through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
}
},
"documentation": "\n <p>\n The configuration settings registered with the activity type.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Detailed information about an activity type.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns information about the specified activity type. This includes\n configuration settings provided at registration time as well as other general information about the type.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>activityType.name</code>: String constraint. The key is <code>swf:activityType.name</code>.</li>\n <li>\n<code>activityType.version</code>: String constraint. The key is <code>swf:activityType.version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> DescribeActivityType Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 03:04:10 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=XiGRwOZNLt+ic3VBWvIlRGdcFcRJVSE8J7zyZLU3oXg=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 95\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 387\n Content-Type: application/json\n x-amzn-RequestId: 98d56ff5-3f25-11e1-9b11-7182192d0b57\n\n {\"configuration\":\n {\"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToCloseTimeout\": \"900\",\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n }\n </response>\n </example>\n </examples>\n "
},
"DescribeDomain": {
"name": "DescribeDomain",
"input": {
"shape_name": "DescribeDomainInput",
"type": "structure",
"members": {
"name": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain to describe.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "DomainDetail",
"type": "structure",
"members": {
"domainInfo": {
"shape_name": "DomainInfo",
"type": "structure",
"members": {
"name": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain. This name is unique within the account.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The status of the domain:\n </p>\n <ul>\n <li>\n <b>REGISTERED</b>: The domain is properly registered and available. You can use this domain\n for registering types and creating new workflow executions.\n </li>\n <li>\n <b>DEPRECATED</b>: The domain was deprecated using <a>DeprecateDomain</a>, but is\n still in use. You should not create new workflow executions in this domain.\n </li>\n </ul>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the domain provided through <a>RegisterDomain</a>.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains general information about a domain.\n </p>\n ",
"required": true
},
"configuration": {
"shape_name": "DomainConfiguration",
"type": "structure",
"members": {
"workflowExecutionRetentionPeriodInDays": {
"shape_name": "DurationInDays",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The retention period for workflow executions in this domain.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Contains the configuration settings of a domain.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Contains details of a domain.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns information about the specified domain including description and status.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n\n<examples>\n <example>\n <name> DescribeDomain Example </name>\n\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:13:33 GMT\nX-Amz-Target: SimpleWorkflowService.DescribeDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=IFJtq3M366CHqMlTpyqYqd9z0ChCoKDC5SCJBsLifu4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 21\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530901\"}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 137\nContent-Type: application/json\nx-amzn-RequestId: e86a6779-3f26-11e1-9a27-0760db01a4a8\n\n{\"configuration\":\n {\"workflowExecutionRetentionPeriodInDays\": \"60\"},\n \"domainInfo\":\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"}\n}\n</response>\n\n </example>\n\n</examples>\n"
},
"DescribeWorkflowExecution": {
"name": "DescribeWorkflowExecution",
"input": {
"shape_name": "DescribeWorkflowExecutionInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the workflow execution.\n </p>\n ",
"required": true
},
"execution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution to describe.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowExecutionDetail",
"type": "structure",
"members": {
"executionInfo": {
"shape_name": "WorkflowExecutionInfo",
"type": "structure",
"members": {
"execution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution this information is about.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow execution.\n </p>\n ",
"required": true
},
"startTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the execution was started.\n </p>\n ",
"required": true
},
"closeTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n </p>\n "
},
"executionStatus": {
"shape_name": "ExecutionStatus",
"enum": [
"OPEN",
"CLOSED"
],
"type": "string",
"documentation": "\n <p>\n The current status of the execution.\n </p>\n ",
"required": true
},
"closeStatus": {
"shape_name": "CloseStatus",
"enum": [
"COMPLETED",
"FAILED",
"CANCELED",
"TERMINATED",
"CONTINUED_AS_NEW",
"TIMED_OUT"
],
"type": "string",
"documentation": "\n <p>\n If the execution status is closed then this specifies how the execution was closed:</p>\n <ul>\n <li>COMPLETED: the execution was successfully completed.</li>\n <li>CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.</li>\n <li>TERMINATED: the execution was force terminated.</li>\n <li>FAILED: the execution failed to complete.</li>\n <li>TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.</li>\n <li>CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on\n the workflow.</li>\n </ul>\n "
},
"parent": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n </p>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n </p>\n "
},
"cancelRequested": {
"shape_name": "Canceled",
"type": "boolean",
"documentation": "\n <p>\n Set to true if a cancellation is requested for this workflow execution.\n </p>\n "
}
},
"documentation": "\n <p>\n Information about the workflow execution.\n </p>\n ",
"required": true
},
"executionConfiguration": {
"shape_name": "WorkflowExecutionConfiguration",
"type": "structure",
"members": {
"taskStartToCloseTimeout": {
"shape_name": "DurationInSeconds",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The maximum duration allowed for decision tasks for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n ",
"required": true
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSeconds",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The total duration for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The task list used for the decision tasks generated for this workflow execution.\n </p>\n ",
"required": true
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
}
},
"documentation": "\n <p>\n The configuration settings for this workflow execution including timeout values, tasklist etc.\n </p>\n ",
"required": true
},
"openCounts": {
"shape_name": "WorkflowExecutionOpenCounts",
"type": "structure",
"members": {
"openActivityTasks": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The count of activity tasks whose status is OPEN.\n </p>\n ",
"required": true
},
"openDecisionTasks": {
"shape_name": "OpenDecisionTasksCount",
"type": "integer",
"min_length": 0,
"max_length": 1,
"documentation": "\n <p>\n The count of decision tasks whose status is OPEN.\n A workflow execution can have at most one open decision task.\n </p>\n ",
"required": true
},
"openTimers": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The count of timers started by this workflow execution that have not fired yet.\n </p>\n ",
"required": true
},
"openChildWorkflowExecutions": {
"shape_name": "Count",
"type": "integer",
"min_length": 0,
"documentation": "\n <p>\n The count of child workflow executions whose status is OPEN.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The number of tasks for this workflow execution. This includes open and closed tasks of all types.\n </p>\n ",
"required": true
},
"latestActivityTaskTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the\n workflow has not made progress for an unusually long period of time and might require a corrective action.\n </p>\n "
},
"latestExecutionContext": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The latest executionContext provided by the decider for this workflow execution.\n A decider can provide an executionContext, which is a free form string, when closing a decision task\n using <a>RespondDecisionTaskCompleted</a>.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains details about a workflow execution.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns information about the specified workflow execution including its type and some statistics.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> DescribeWorkflowExecution Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:05:18 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ufQVcSkfUyGPLiS8xbkEBqEc2PmEEE/3Lb9Kr8yozs8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 127\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\"}\n }\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 577\n Content-Type: application/json\n x-amzn-RequestId: 5f85ef79-3f1d-11e1-9e8f-57bb03e21482\n\n {\"executionConfiguration\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\"},\n \"executionInfo\":\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326592619.474,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n \"openCounts\":\n {\"openActivityTasks\": 0,\n \"openChildWorkflowExecutions\": 0,\n \"openDecisionTasks\": 1,\n \"openTimers\": 0}\n }\n </response>\n </example>\n </examples>\n "
},
"DescribeWorkflowType": {
"name": "DescribeWorkflowType",
"input": {
"shape_name": "DescribeWorkflowTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which this workflow type is registered.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type to describe.\n </p>\n ",
"required": true
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowTypeDetail",
"type": "structure",
"members": {
"typeInfo": {
"shape_name": "WorkflowTypeInfo",
"type": "structure",
"members": {
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type this information is about.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The current status of the workflow type.\n </p>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the type registered through <a>RegisterWorkflowType</a>.\n </p>\n "
},
"creationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date when this type was registered.\n </p>\n ",
"required": true
},
"deprecationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n </p>\n "
}
},
"documentation": "\n <p>General information about the workflow type.</p>\n <p>The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.</p>\n <ul>\n <li>\n<b>REGISTERED</b>: The type is registered and available. Workers supporting this type should be running.</li>\n <li>\n<b>DEPRECATED</b>: The type was deprecated using <a>DeprecateWorkflowType</a>, but is still in use. You should\n keep workers supporting this type running. You cannot create new workflow executions of this type.</li>\n </ul>\n ",
"required": true
},
"configuration": {
"shape_name": "WorkflowTypeConfiguration",
"type": "structure",
"members": {
"defaultTaskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum duration, specified when registering the workflow type, that a decision task for executions\n of this workflow type might take before returning completion or\n failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If\n the decider eventually reports a completion or failure, it is ignored.\n This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or\n the <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultExecutionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The optional default maximum duration, specified when registering the workflow type, for executions of this workflow type.\n This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or\n the <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The optional default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.\n This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or\n the <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n "
},
"defaultChildPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The optional default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or\n the <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n "
}
},
"documentation": "\n <p>Configuration settings of the workflow type registered through <a>RegisterWorkflowType</a></p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains details about a workflow type.</p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns information about the specified <i>workflow type</i>. This includes\n configuration settings specified when the type was registered and other information\n such as creation date, current status, etc.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>workflowType.name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li>\n <li>\n<code>workflowType.version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li>\n </ul>\n </li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> DescribeWorkflowType Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:40:40 GMT\n X-Amz-Target: SimpleWorkflowService.DescribeWorkflowType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=iGt8t83OmrURqu0pKYbcW6mNdjXbFomevCBPUPQEbaM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 102\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 348\n Content-Type: application/json\n x-amzn-RequestId: f35a8e7f-3fc9-11e1-a23a-99d60383ae71\n\n {\"configuration\":\n {\"defaultChildPolicy\": \"TERMINATE\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskStartToCloseTimeout\": \"600\"},\n \"typeInfo\":\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n </response>\n </example>\n </examples>\n "
},
"GetWorkflowExecutionHistory": {
"name": "GetWorkflowExecutionHistory",
"input": {
"shape_name": "GetWorkflowExecutionHistoryInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the workflow execution.\n </p>\n ",
"required": true
},
"execution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Specifies the workflow execution for which to return the history.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If a <code>NextPageToken</code> is returned, the result has more than one pages. To get the next page,\n repeat the call and specify the nextPageToken with all other arguments unchanged.\n </p>\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n Specifies the maximum number of history events returned in one page.\n The next page in the result is identified by the <code>NextPageToken</code> returned.\n By default 100 history events are returned in a page but the caller can override this\n value to a page size <i>smaller</i> than the default. You cannot specify a page size\n larger than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the events in reverse order. By default the results are returned in ascending order\n of the <code>eventTimeStamp</code> of the events.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "History",
"type": "structure",
"members": {
"events": {
"shape_name": "HistoryEventList",
"type": "list",
"members": {
"shape_name": "HistoryEvent",
"type": "structure",
"members": {
"eventTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date and time when the event occurred.\n </p>\n ",
"required": true
},
"eventType": {
"shape_name": "EventType",
"type": "string",
"enum": [
"WorkflowExecutionStarted",
"WorkflowExecutionCancelRequested",
"WorkflowExecutionCompleted",
"CompleteWorkflowExecutionFailed",
"WorkflowExecutionFailed",
"FailWorkflowExecutionFailed",
"WorkflowExecutionTimedOut",
"WorkflowExecutionCanceled",
"CancelWorkflowExecutionFailed",
"WorkflowExecutionContinuedAsNew",
"ContinueAsNewWorkflowExecutionFailed",
"WorkflowExecutionTerminated",
"DecisionTaskScheduled",
"DecisionTaskStarted",
"DecisionTaskCompleted",
"DecisionTaskTimedOut",
"ActivityTaskScheduled",
"ScheduleActivityTaskFailed",
"ActivityTaskStarted",
"ActivityTaskCompleted",
"ActivityTaskFailed",
"ActivityTaskTimedOut",
"ActivityTaskCanceled",
"ActivityTaskCancelRequested",
"RequestCancelActivityTaskFailed",
"WorkflowExecutionSignaled",
"MarkerRecorded",
"RecordMarkerFailed",
"TimerStarted",
"StartTimerFailed",
"TimerFired",
"TimerCanceled",
"CancelTimerFailed",
"StartChildWorkflowExecutionInitiated",
"StartChildWorkflowExecutionFailed",
"ChildWorkflowExecutionStarted",
"ChildWorkflowExecutionCompleted",
"ChildWorkflowExecutionFailed",
"ChildWorkflowExecutionTimedOut",
"ChildWorkflowExecutionCanceled",
"ChildWorkflowExecutionTerminated",
"SignalExternalWorkflowExecutionInitiated",
"SignalExternalWorkflowExecutionFailed",
"ExternalWorkflowExecutionSignaled",
"RequestCancelExternalWorkflowExecutionInitiated",
"RequestCancelExternalWorkflowExecutionFailed",
"ExternalWorkflowExecutionCancelRequested"
],
"documentation": "\n <p>\n The type of the history event.\n </p>\n ",
"required": true
},
"eventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n </p>\n ",
"required": true
},
"workflowExecutionStartedEventAttributes": {
"shape_name": "WorkflowExecutionStartedEventAttributes",
"type": "structure",
"members": {
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the workflow execution (if any).\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration of decision tasks for this workflow type.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n\n The supported child policies are:\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list for scheduling the decision tasks for this workflow execution.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type of this execution.\n </p>\n ",
"required": true
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n </p>\n "
},
"continuedExecutionRunId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n If this workflow execution was started due to a <code>ContinueAsNewWorkflowExecution</code> decision, then\n it contains the <code>runId</code> of the previous workflow execution that was closed and continued as this execution.\n </p>\n "
},
"parentWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n </p>\n "
},
"parentInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCompletedEventAttributes": {
"shape_name": "WorkflowExecutionCompletedEventAttributes",
"type": "structure",
"members": {
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result produced by the workflow execution upon successful completion.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CompleteWorkflowExecution</code> decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"completeWorkflowExecutionFailedEventAttributes": {
"shape_name": "CompleteWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "CompleteWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CompleteWorkflowExecution</code> decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CompleteWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionFailedEventAttributes": {
"shape_name": "WorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The descriptive reason provided for the failure (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>FailWorkflowExecution</code> decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"failWorkflowExecutionFailedEventAttributes": {
"shape_name": "FailWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "FailWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>FailWorkflowExecution</code> decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>FailWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionTimedOutEventAttributes": {
"shape_name": "WorkflowExecutionTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "WorkflowExecutionTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of timeout that caused this event.\n </p>\n ",
"required": true
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCanceledEventAttributes": {
"shape_name": "WorkflowExecutionCanceledEventAttributes",
"type": "structure",
"members": {
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details for the cancellation (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"cancelWorkflowExecutionFailedEventAttributes": {
"shape_name": "CancelWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "CancelWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CancelWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionContinuedAsNewEventAttributes": {
"shape_name": "WorkflowExecutionContinuedAsNewEventAttributes",
"type": "structure",
"members": {
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the new workflow execution.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>ContinueAsNewWorkflowExecution</code> decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"newExecutionRunId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the new workflow execution.\n </p>\n ",
"required": true
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The total duration allowed for the new workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Represents a task list.\n </p>\n ",
"required": true
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration of decision tasks for the new workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p>\n\n <p>The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with the new workflow execution.\n </p>\n "
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Represents a workflow type.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionContinuedAsNew</code> then this member is set and\n provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"continueAsNewWorkflowExecutionFailedEventAttributes": {
"shape_name": "ContinueAsNewWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "ContinueAsNewWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"WORKFLOW_TYPE_DEPRECATED",
"WORKFLOW_TYPE_DOES_NOT_EXIST",
"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_CHILD_POLICY_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>ContinueAsNewWorkflowExecution</code> decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ContinueAsNewWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionTerminatedEventAttributes": {
"shape_name": "WorkflowExecutionTerminatedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "TerminateReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason provided for the termination (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details provided for the termination (if any).\n </p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"cause": {
"shape_name": "WorkflowExecutionTerminatedCause",
"type": "string",
"enum": [
"CHILD_POLICY_APPLIED",
"EVENT_LIMIT_EXCEEDED",
"OPERATOR_INITIATED"
],
"documentation": "\n <p>\n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionTerminated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCancelRequestedEventAttributes": {
"shape_name": "WorkflowExecutionCancelRequestedEventAttributes",
"type": "structure",
"members": {
"externalWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution for which the cancellation was requested.\n </p>\n "
},
"externalInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
},
"cause": {
"shape_name": "WorkflowExecutionCancelRequestedCause",
"type": "string",
"enum": [
"CHILD_POLICY_APPLIED"
],
"documentation": "\n <p>\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCancelRequested</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskScheduledEventAttributes": {
"shape_name": "DecisionTaskScheduledEventAttributes",
"type": "structure",
"members": {
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list in which the decision task was scheduled.\n </p>\n ",
"required": true
},
"startToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskScheduled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskStartedEventAttributes": {
"shape_name": "DecisionTaskStartedEventAttributes",
"type": "structure",
"members": {
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskCompletedEventAttributes": {
"shape_name": "DecisionTaskCompletedEventAttributes",
"type": "structure",
"members": {
"executionContext": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n User defined context for the workflow execution.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>DecisionTaskStarted</code> event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskTimedOutEventAttributes": {
"shape_name": "DecisionTaskTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "DecisionTaskTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of timeout that expired before the decision task could be completed.\n </p>\n ",
"required": true
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>DecisionTaskStarted</code> event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskScheduledEventAttributes": {
"shape_name": "ActivityTaskScheduledEventAttributes",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the activity task.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique id of the activity task.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the activity task.\n </p>\n "
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n </p>\n "
},
"scheduleToStartTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time the activity task can wait to be assigned to a worker.\n </p>\n "
},
"scheduleToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time for this activity task.\n </p>\n "
},
"startToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time a worker may take to process the activity task.\n </p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The task list in which the activity task has been scheduled.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"heartbeatTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum time before which the worker processing this task must report progress by\n calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskScheduled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskStartedEventAttributes": {
"shape_name": "ActivityTaskStartedEventAttributes",
"type": "structure",
"members": {
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCompletedEventAttributes": {
"shape_name": "ActivityTaskCompletedEventAttributes",
"type": "structure",
"members": {
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The results of the activity task (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskFailedEventAttributes": {
"shape_name": "ActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason provided for the failure (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskTimedOutEventAttributes": {
"shape_name": "ActivityTaskTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "ActivityTaskTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE",
"SCHEDULE_TO_START",
"SCHEDULE_TO_CLOSE",
"HEARTBEAT"
],
"documentation": "\n <p>\n The type of the timeout that caused this event.\n </p>\n ",
"required": true
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "LimitedData",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n Contains the content of the <code>details</code> parameter for the last call made by the activity to <code>RecordActivityTaskHeartbeat</code>.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCanceledEventAttributes": {
"shape_name": "ActivityTaskCanceledEventAttributes",
"type": "structure",
"members": {
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the cancellation (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"latestCancelRequestedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n If set, contains the Id of the last <code>ActivityTaskCancelRequested</code> event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCancelRequestedEventAttributes": {
"shape_name": "ActivityTaskCancelRequestedEventAttributes",
"type": "structure",
"members": {
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelActivityTask</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique ID of the task.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskcancelRequested</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionSignaledEventAttributes": {
"shape_name": "WorkflowExecutionSignaledEventAttributes",
"type": "structure",
"members": {
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n </p>\n "
},
"externalWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n </p>\n "
},
"externalInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflow</code> decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionSignaled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"markerRecordedEventAttributes": {
"shape_name": "MarkerRecordedEventAttributes",
"type": "structure",
"members": {
"markerName": {
"shape_name": "MarkerName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the marker.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the marker (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RecordMarker</code> decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>MarkerRecorded</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"recordMarkerFailedEventAttributes": {
"shape_name": "RecordMarkerFailedEventAttributes",
"type": "structure",
"members": {
"markerName": {
"shape_name": "MarkerName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The marker's name.</p>\n ",
"required": true
},
"cause": {
"shape_name": "RecordMarkerFailedCause",
"type": "string",
"enum": [
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RecordMarkerFailed</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerStartedEventAttributes": {
"shape_name": "TimerStartedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that was started.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
},
"startToFireTimeout": {
"shape_name": "DurationInSeconds",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The duration of time after which the timer will fire.\n </p>\n <p>The duration is specified in seconds. The valid values are integers greater than or equal to 0.</p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartTimer</code> decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerFiredEventAttributes": {
"shape_name": "TimerFiredEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that fired.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>TimerStarted</code> event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerFired</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerCanceledEventAttributes": {
"shape_name": "TimerCanceledEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that was canceled.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>TimerStarted</code> event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelTimer</code> decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startChildWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "StartChildWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the child workflow execution.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n </p>\n "
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The inputs provided to the child workflow execution (if any).\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list used for the decision tasks of the child workflow execution.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the <a>TerminateWorkflowExecution</a> action or due to an expired timeout.</p>\n <p>The supported child policies are:</p>\n\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration allowed for the decision tasks for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags to associated with the child workflow execution.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>StartChildWorkflowExecutionInitiated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionStartedEventAttributes": {
"shape_name": "ChildWorkflowExecutionStartedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was started.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionCompletedEventAttributes": {
"shape_name": "ChildWorkflowExecutionCompletedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was completed.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result of the child workflow execution (if any).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionFailedEventAttributes": {
"shape_name": "ChildWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that failed.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason for the failure (if provided).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if provided).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionTimedOutEventAttributes": {
"shape_name": "ChildWorkflowExecutionTimedOutEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that timed out.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"timeoutType": {
"shape_name": "WorkflowExecutionTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of the timeout that caused the child workflow execution to time out.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionCanceledEventAttributes": {
"shape_name": "ChildWorkflowExecutionCanceledEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was canceled.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the cancellation (if provided).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionTerminatedEventAttributes": {
"shape_name": "ChildWorkflowExecutionTerminatedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was terminated.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionTerminated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"signalExternalWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "SignalExternalWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution to send the signal to.\n </p>\n "
},
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Input provided to the signal (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in\n the <code>SignalExternalWorkflowExecution</code> decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>SignalExternalWorkflowExecutionInitiated</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"externalWorkflowExecutionSignaledEventAttributes": {
"shape_name": "ExternalWorkflowExecutionSignaledEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution that the signal was delivered to.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflowExecution</code> decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ExternalWorkflowExecutionSignaled</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"signalExternalWorkflowExecutionFailedEventAttributes": {
"shape_name": "SignalExternalWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution that the signal was being delivered to.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution that the signal was being delivered to.\n </p>\n "
},
"cause": {
"shape_name": "SignalExternalWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION",
"SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflowExecution</code> decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in\n the <code>SignalExternalWorkflowExecution</code> decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>If the event is of type <code>SignalExternalWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.</p>\n "
},
"externalWorkflowExecutionCancelRequestedEventAttributes": {
"shape_name": "ExternalWorkflowExecutionCancelRequestedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution to which the cancellation request was delivered.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ExternalWorkflowExecutionCancelRequested</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelExternalWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution to be canceled.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution to be canceled.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelExternalWorkflowExecutionInitiated</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelExternalWorkflowExecutionFailedEventAttributes": {
"shape_name": "RequestCancelExternalWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow to which the cancel request was to be delivered.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution.\n </p>\n "
},
"cause": {
"shape_name": "RequestCancelExternalWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION",
"REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelExternalWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"scheduleActivityTaskFailedEventAttributes": {
"shape_name": "ScheduleActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The activity type provided in the <code>ScheduleActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The activityId provided in the <code>ScheduleActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "ScheduleActivityTaskFailedCause",
"type": "string",
"enum": [
"ACTIVITY_TYPE_DEPRECATED",
"ACTIVITY_TYPE_DOES_NOT_EXIST",
"ACTIVITY_ID_ALREADY_IN_USE",
"OPEN_ACTIVITIES_LIMIT_EXCEEDED",
"ACTIVITY_CREATION_RATE_EXCEEDED",
"DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED",
"DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ScheduleActivityTaskFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelActivityTaskFailedEventAttributes": {
"shape_name": "RequestCancelActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The activityId provided in the <code>RequestCancelActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "RequestCancelActivityTaskFailedCause",
"type": "string",
"enum": [
"ACTIVITY_ID_UNKNOWN",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelActivityTask</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelActivityTaskFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startTimerFailedEventAttributes": {
"shape_name": "StartTimerFailedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The timerId provided in the <code>StartTimer</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "StartTimerFailedCause",
"type": "string",
"enum": [
"TIMER_ID_ALREADY_IN_USE",
"OPEN_TIMERS_LIMIT_EXCEEDED",
"TIMER_CREATION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartTimer</code> decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>StartTimerFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"cancelTimerFailedEventAttributes": {
"shape_name": "CancelTimerFailedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The timerId provided in the <code>CancelTimer</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "CancelTimerFailedCause",
"type": "string",
"enum": [
"TIMER_ID_UNKNOWN",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n </p>\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelTimer</code> decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CancelTimerFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startChildWorkflowExecutionFailedEventAttributes": {
"shape_name": "StartChildWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type provided in the <code>StartChildWorkflowExecution</code> <a>Decision</a> that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "StartChildWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"WORKFLOW_TYPE_DOES_NOT_EXIST",
"WORKFLOW_TYPE_DEPRECATED",
"OPEN_CHILDREN_LIMIT_EXCEEDED",
"OPEN_WORKFLOWS_LIMIT_EXCEEDED",
"CHILD_CREATION_RATE_EXCEEDED",
"WORKFLOW_ALREADY_RUNNING",
"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_CHILD_POLICY_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>\n If the event is of type <code>StartChildWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
}
},
"documentation": "\n <p>Event within a workflow execution. A history event can be one of these types:</p>\n <ul>\n <li>\n <b>WorkflowExecutionStarted</b>: The workflow execution was started.\n </li>\n <li>\n <b>WorkflowExecutionCompleted</b>: The workflow execution was closed due to successful completion.\n </li>\n <li>\n <b>WorkflowExecutionFailed</b>: The workflow execution closed due to a failure.\n </li>\n <li>\n <b>WorkflowExecutionTimedOut</b>: The workflow execution was closed because a time out was exceeded.\n </li>\n <li>\n <b>WorkflowExecutionCanceled</b>: The workflow execution was successfully canceled and closed.\n </li>\n <li>\n <b>WorkflowExecutionTerminated</b>: The workflow execution was terminated.\n </li>\n <li>\n <b>WorkflowExecutionContinuedAsNew</b>: The workflow execution was closed and a new\n execution of the same type was created with the same workflowId.\n </li>\n <li>\n <b>WorkflowExecutionCancelRequested</b>: A request to cancel this workflow execution was made.\n </li>\n <li>\n <b>DecisionTaskScheduled</b>: A decision task was scheduled for the workflow execution.\n </li>\n <li>\n <b>DecisionTaskStarted</b>: The decision task was dispatched to a decider.\n </li>\n <li>\n <b>DecisionTaskCompleted</b>: The decider successfully completed a decision task by calling <a>RespondDecisionTaskCompleted</a>.\n </li>\n<!--\n <li>\n <b>DecisionTaskFailed</b>: The decider failed a decision task by calling <a>RespondDecisionTaskFailed</a>.\n </li>\n --><li>\n <b>DecisionTaskTimedOut</b>: The decision task timed out.\n </li>\n <li>\n <b>ActivityTaskScheduled</b>: An activity task was scheduled for execution.\n </li>\n <li>\n <b>ScheduleActivityTaskFailed</b>: Failed to process ScheduleActivityTask decision. This happens when\n the decision is not configured properly, for example the activity type specified is not registered.\n </li>\n <li>\n <b>ActivityTaskStarted</b>: The scheduled activity task was dispatched to a worker.\n </li>\n <li>\n <b>ActivityTaskCompleted</b>: An activity worker successfully completed an activity task by calling <a>RespondActivityTaskCompleted</a>.\n </li>\n <li>\n <b>ActivityTaskFailed</b>: An activity worker failed an activity task by calling <a>RespondActivityTaskFailed</a>.\n </li>\n <li>\n <b>ActivityTaskTimedOut</b>: The activity task timed out.\n </li>\n <li>\n <b>ActivityTaskCanceled</b>: The activity task was successfully canceled.\n </li>\n <!--\n <li>\n <b>ActivityTaskHeartbeatRecorded</b>: A call to <a>RecordActivityTaskHeartbeat</a> was\n successfully processed by the system.\n </li>\n -->\n <li>\n <b>ActivityTaskCancelRequested</b>: A <code>RequestCancelActivityTask</code> decision was\n received by the system.\n </li>\n <li>\n <b>RequestCancelActivityTaskFailed</b>: Failed to process RequestCancelActivityTask decision. This happens when\n the decision is not configured properly.\n </li>\n <li>\n <b>WorkflowExecutionSignaled</b>: An external signal was received for the workflow execution.\n </li>\n <li>\n <b>MarkerRecorded</b>: A marker was recorded in the workflow history as the result of a\n <code>RecordMarker</code> decision.\n </li>\n <li>\n <b>TimerStarted</b>: A timer was started for the workflow execution due to a\n <code>StartTimer</code> decision.\n </li>\n <li>\n <b>StartTimerFailed</b>: Failed to process StartTimer decision. This happens when\n the decision is not configured properly, for example a timer already exists with the specified timer Id.\n </li>\n <li>\n <b>TimerFired</b>: A timer, previously started for this workflow execution, fired.\n </li>\n <li>\n <b>TimerCanceled</b>: A timer, previously started for this workflow execution,\n was successfully canceled.\n </li>\n <li>\n <b>CancelTimerFailed</b>: Failed to process CancelTimer decision. This happens when\n the decision is not configured properly, for example no timer exists with the specified timer Id.\n </li>\n <li>\n <b>StartChildWorkflowExecutionInitiated</b>: A request was made to start a child workflow execution.\n </li>\n <li>\n <b>StartChildWorkflowExecutionFailed</b>: Failed to process StartChildWorkflowExecution decision.\n This happens when the decision is not configured properly, for example the workflow type specified is not registered.\n </li>\n <li>\n <b>ChildWorkflowExecutionStarted</b>: A child workflow execution was successfully started.\n </li>\n <li>\n <b>ChildWorkflowExecutionCompleted</b>: A child workflow execution, started by this workflow execution,\n completed successfully and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionFailed</b>: A child workflow execution, started by this workflow execution,\n failed to complete successfully and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionTimedOut</b>: A child workflow execution, started by this workflow execution,\n timed out and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionCanceled</b>: A child workflow execution, started by this workflow execution,\n was canceled and closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionTerminated</b>: A child workflow execution, started by this workflow execution,\n was terminated.\n </li>\n <li>\n <b>SignalExternalWorkflowExecutionInitiated</b>: A request to signal an external workflow was made.\n </li>\n <li>\n <b>ExternalWorkflowExecutionSignaled</b>: A signal, requested by this workflow execution, was successfully\n delivered to the target external workflow execution.\n </li>\n <li>\n <b>SignalExternalWorkflowExecutionFailed</b>: The request to signal an external\n workflow execution failed.\n </li>\n <li>\n <b>RequestCancelExternalWorkflowExecutionInitiated</b>: A request was made to request the cancellation of an external workflow execution.\n </li>\n <li>\n <b>ExternalWorkflowExecutionCancelRequested</b>: Request to cancel an external workflow execution was successfully\n delivered to the target execution.\n </li>\n <li>\n <b>RequestCancelExternalWorkflowExecutionFailed</b>: Request to cancel an external workflow execution\n failed.\n </li>\n </ul>\n "
},
"documentation": "\n <p>\n The list of history events.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n The token for the next page. If set, the history consists of more than one page and the next page can be retrieved by repeating the request\n with this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of\n the events related to all tasks and events in the life of the workflow execution.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns the history of the specified workflow execution.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> GetWorkflowExecutionHistory Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:44:00 GMT\n X-Amz-Target: SimpleWorkflowService.GetWorkflowExecutionHistory\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=90GENeUWJbEAMWuVI0dcWatHjltMWddXfLjl0MbNOzM=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 175\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"execution\":\n {\"workflowId\": \"20110927-T-1\",\n \"runId\": \"d29e60b5-fa71-4276-a4be-948b0adcd20b\"},\n \"maximumPageSize\": 10,\n \"reverseOrder\": true}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 2942\n Content-Type: application/json\n x-amzn-RequestId: 5385723f-3ff4-11e1-b118-3bfa5e8e7fc3\n\n {\"events\":\n [\n {\"eventId\": 11,\n \"eventTimestamp\": 1326671603.102,\n \"eventType\": \"WorkflowExecutionTimedOut\",\n \"workflowExecutionTimedOutEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"timeoutType\": \"START_TO_CLOSE\"}\n },\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 10,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"activityTaskTimedOutEventAttributes\":\n {\"latestHeartbeatRecordedEventId\": 0,\n \"scheduledEventId\": 8,\n \"startedEventId\": 0,\n \"timeoutType\": \"SCHEDULE_TO_START\"},\n \"eventId\": 9,\n \"eventTimestamp\": 1326670566.124,\n \"eventType\": \"ActivityTaskTimedOut\"},\n {\"activityTaskScheduledEventAttributes\":\n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"control\": \"digital music\",\n \"decisionTaskCompletedEventId\": 7,\n \"heartbeatTimeout\": \"120\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 8,\n \"eventTimestamp\": 1326670266.115,\n \"eventType\": \"ActivityTaskScheduled\"},\n {\"decisionTaskCompletedEventAttributes\":\n {\"executionContext\": \"Black Friday\",\n \"scheduledEventId\": 5,\n \"startedEventId\": 6},\n \"eventId\": 7,\n \"eventTimestamp\": 1326670266.103,\n \"eventType\": \"DecisionTaskCompleted\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 5},\n \"eventId\": 6,\n \"eventTimestamp\": 1326670161.497,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 5,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"decisionTaskTimedOutEventAttributes\":\n {\"scheduledEventId\": 2,\n \"startedEventId\": 3,\n \"timeoutType\": \"START_TO_CLOSE\"},\n \"eventId\": 4,\n \"eventTimestamp\": 1326668752.66,\n \"eventType\": \"DecisionTaskTimedOut\"},\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326668152.648,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326668003.094,\n \"eventType\": \"DecisionTaskScheduled\"}\n ],\n \"nextPageToken\": \"AAAAKgAAAAEAAAAAAAAAATeTvAyvqlQz34ctbGhM5nglWmjzk0hGuHf0g4EO4CblQFku70ukjPgrAHy7Tnp7FaZ0okP8EEWnkfg8gi3Fqy/WVrXyxQaa525D31cIq1owXK21CKR6SQ0Job87G8SHvvqvP7yjLGHlHrRGZUCbJgeEuV4Rp/yW+vKhc8dJ54x7wvpQMwZ+ssG6stTyX26vu1gIDuspk13UrDZa4TbLOFdM0aAocHe3xklKMtD/B4ithem6BWm6CBl/UF7lMfNccwUYEityp1Kht/YrcD9zbJkt1FSt4Y6pgt0njAh4FKRO9nyRyvLmbvgtQXEIQz8hdbjwj3xE1+9ocYwXOCAhVkRsh3OD6F8KHilKfdwg4Xz1jtLXOh4lsCecNb8dS7J9hbRErRbw3rh1Sv415U2Ye23OEfF4Jv7JznpmEyzuq8d2bMyOLjAInQVFK4t1tPo5FAhzdICCXBhRq6Wkt++W9sRQXqqX/HTX5kNomHySZloylPuY5gL5zRj39frInfZk4EXWHwrI+18+erGIHO4nBQpMzO64dMP+A/KtVGCn59rAMmilD6wEE9rH8RuZ03Wkvm9yrJvjrI8/6358n8TMB8OcHoqILkMCAXYiIppnFlm+NWXVqxalHLKOrrNzEZM6qsz3Qj3HV1cpy9P7fnS9QAxrgsAYBoDmdOaFkS3ktAkRa0Sle8STfHi4zKbfIGS7rg==\"}\n </response>\n </example>\n </examples>\n "
},
"ListActivityTypes": {
"name": "ListActivityTypes",
"input": {
"shape_name": "ListActivityTypesInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the activity types have been registered.\n </p>\n ",
"required": true
},
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n If specified, only lists the activity types that have this name.\n </p>\n "
},
"registrationStatus": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n Specifies the registration status of the activity types to list.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextResultToken</code> was returned, the results have\n more than one page. To get the next page of results, repeat the call with the <code>nextPageToken</code>\n and keep all other arguments unchanged.\n </p>\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the <code>name</code> of the activity types.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "ActivityTypeInfos",
"type": "structure",
"members": {
"typeInfos": {
"shape_name": "ActivityTypeInfoList",
"type": "list",
"members": {
"shape_name": "ActivityTypeInfo",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The <a>ActivityType</a> type structure representing the activity type.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The current status of the activity type.\n </p>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the activity type provided in <a>RegisterActivityType</a>.\n </p>\n "
},
"creationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date and time this activity type was created through <a>RegisterActivityType</a>.\n </p>\n ",
"required": true
},
"deprecationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n If DEPRECATED, the date and time <a>DeprecateActivityType</a> was called.\n </p>\n "
}
},
"documentation": "\n <p>\n Detailed information about an activity type.\n </p>\n "
},
"documentation": "\n <p>\n List of activity type information.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains a paginated list of activity type information structures.\n </p>\n "
},
"errors": [
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
},
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
}
],
"documentation": "\n <p>\n Returns information about all activities registered in the specified domain that match the\n specified name and registration status. The result includes information like creation date, current status of the activity, etc.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the <code>nextPageToken</code> returned by the initial call.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> ListActivityTypes Example </name>\n <request>\n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 171\n Content-Type: application/json\n x-amzn-RequestId: 11b6fbeb-3f25-11e1-9e8f-57bb03e21482\n\n {\"typeInfos\":\n [\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"creationDate\": 1326586446.471,\n \"description\": \"Verify the customer credit\",\n \"status\": \"REGISTERED\"}\n ]\n }\n </response>\n </example>\n </examples>\n "
},
"ListClosedWorkflowExecutions": {
"name": "ListClosedWorkflowExecutions",
"input": {
"shape_name": "ListClosedWorkflowExecutionsInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain that contains the workflow executions to list.\n </p>\n ",
"required": true
},
"startTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their start times.\n </p>\n <note><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive.\n You must specify one of these in a request but not both.</note>\n "
},
"closeTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter.\n Also, if this parameter is specified, the returned results are ordered by their close times.\n </p>\n <note><code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive.\n You must specify one of these in a request but not both.</note>\n "
},
"executionFilter": {
"shape_name": "WorkflowExecutionFilter",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId to pass of match the criteria of this filter.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"closeStatusFilter": {
"shape_name": "CloseStatusFilter",
"type": "structure",
"members": {
"status": {
"shape_name": "CloseStatus",
"enum": [
"COMPLETED",
"FAILED",
"CANCELED",
"TERMINATED",
"CONTINUED_AS_NEW",
"TIMED_OUT"
],
"type": "string",
"documentation": "\n <p>\n The close status that must match the close status of an execution for it to meet the criteria of this filter. This\n field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only workflow executions that match this <i>close status</i> are listed.\n For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"typeFilter": {
"shape_name": "WorkflowTypeFilter",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Name of the workflow type.\n This field is required.\n </p>\n ",
"required": true
},
"version": {
"shape_name": "VersionOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n Version of the workflow type.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, only executions of the type specified in the filter are returned.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"tagFilter": {
"shape_name": "TagFilter",
"type": "structure",
"members": {
"tag": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only executions that have the matching tag are listed.\n </p>\n <note><code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextPageToken</code> was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n </p>\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the results in reverse order. By default the results are returned in\n descending order of the start or the close time of the executions.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowExecutionInfos",
"type": "structure",
"members": {
"executionInfos": {
"shape_name": "WorkflowExecutionInfoList",
"type": "list",
"members": {
"shape_name": "WorkflowExecutionInfo",
"type": "structure",
"members": {
"execution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution this information is about.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow execution.\n </p>\n ",
"required": true
},
"startTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the execution was started.\n </p>\n ",
"required": true
},
"closeTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n </p>\n "
},
"executionStatus": {
"shape_name": "ExecutionStatus",
"enum": [
"OPEN",
"CLOSED"
],
"type": "string",
"documentation": "\n <p>\n The current status of the execution.\n </p>\n ",
"required": true
},
"closeStatus": {
"shape_name": "CloseStatus",
"enum": [
"COMPLETED",
"FAILED",
"CANCELED",
"TERMINATED",
"CONTINUED_AS_NEW",
"TIMED_OUT"
],
"type": "string",
"documentation": "\n <p>\n If the execution status is closed then this specifies how the execution was closed:</p>\n <ul>\n <li>COMPLETED: the execution was successfully completed.</li>\n <li>CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.</li>\n <li>TERMINATED: the execution was force terminated.</li>\n <li>FAILED: the execution failed to complete.</li>\n <li>TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.</li>\n <li>CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on\n the workflow.</li>\n </ul>\n "
},
"parent": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n </p>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n </p>\n "
},
"cancelRequested": {
"shape_name": "Canceled",
"type": "boolean",
"documentation": "\n <p>\n Set to true if a cancellation is requested for this workflow execution.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains information about a workflow execution.\n\n <!-- This structure is returned from a call to\n <a>DescribeWorkflowExecution</a>. -->\n </p>\n "
},
"documentation": "\n <p>\n The list of workflow information structures.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains a paginated list of information about workflow executions.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns a list of closed workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li>\n <li>\n<code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li>\n <li>\n<code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li>\n </ul>\n </li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> ListClosedWorkflowExecutions Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:51:01 GMT\n X-Amz-Target: SimpleWorkflowService.ListClosedWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=WY9jGbf5E3F9smGJHANhEXz9VL+1oGVgNL0/o7cBxQw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 150\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"closeTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"ricoh-the-dog\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 1084\n Content-Type: application/json\n x-amzn-RequestId: c28b4df4-3f23-11e1-9e8f-57bb03e21482\n\n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326590754.654,\n \"execution\":\n {\"runId\": \"c724e07a-b966-441f-a1c0-4831acbda1cd\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326587154.626,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326586831.628,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n },\n {\"cancelRequested\": false,\n \"closeStatus\": \"TIMED_OUT\",\n \"closeTimestamp\": 1326582914.031,\n \"execution\":\n {\"runId\": \"1e536162-f1ea-48b0-85f3-aade88eef2f7\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"CLOSED\",\n \"startTimestamp\": 1326581114.02,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n </response>\n </example>\n </examples>\n "
},
"ListDomains": {
"name": "ListDomains",
"input": {
"shape_name": "ListDomainsInput",
"type": "structure",
"members": {
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextPageToken</code> was returned, the result has\n more than one page. To get the next page of results, repeat the call with the returned token\n and all other arguments unchanged.\n </p>\n "
},
"registrationStatus": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n Specifies the registration status of the domains to list.\n </p>\n ",
"required": true
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify\n a page size greater than 100.\n Note that the number of domains may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the <code>name</code> of the domains.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "DomainInfos",
"type": "structure",
"members": {
"domainInfos": {
"shape_name": "DomainInfoList",
"type": "list",
"members": {
"shape_name": "DomainInfo",
"type": "structure",
"members": {
"name": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain. This name is unique within the account.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The status of the domain:\n </p>\n <ul>\n <li>\n <b>REGISTERED</b>: The domain is properly registered and available. You can use this domain\n for registering types and creating new workflow executions.\n </li>\n <li>\n <b>DEPRECATED</b>: The domain was deprecated using <a>DeprecateDomain</a>, but is\n still in use. You should not create new workflow executions in this domain.\n </li>\n </ul>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the domain provided through <a>RegisterDomain</a>.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains general information about a domain.\n </p>\n "
},
"documentation": "\n <p>\n A list of DomainInfo structures.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n Returns a value if the results are paginated. To get the next page of results, repeat the request\n specifying this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains a paginated collection of DomainInfo structures.\n </p>\n "
},
"errors": [
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns the list of domains registered in the account.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains. The element must\n be set to <code>arn:aws:swf::AccountID:domain/*\"</code>, where \u201cAccountID\" is the account ID, with no dashes.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n<examples>\n <example>\n <name> ListDomains Example </name>\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sun, 15 Jan 2012 03:09:58 GMT\nX-Amz-Target: SimpleWorkflowService.ListDomains\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=ZCprC72dUxF9ca3w/tbwKZ8lBQn0jaA4xOJqDF0uqMI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 86\nPragma: no-cache\nCache-Control: no-cache\n\n{\"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": false}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 568\nContent-Type: application/json\nx-amzn-RequestId: 67e874cc-3f26-11e1-9b11-7182192d0b57\n\n{\"domainInfos\":\n [\n {\"description\": \"music\",\n \"name\": \"867530901\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"music\",\n \"name\": \"867530902\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Demo\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"DemoDomain\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"Samples\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain2\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain3\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"testDomain4\",\n \"status\": \"REGISTERED\"},\n {\"description\": \"\",\n \"name\": \"zsxfvgsxcv\",\n \"status\": \"REGISTERED\"}\n ]\n}\n</response>\n </example>\n </examples>\n "
},
"ListOpenWorkflowExecutions": {
"name": "ListOpenWorkflowExecutions",
"input": {
"shape_name": "ListOpenWorkflowExecutionsInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain that contains the workflow executions to list.\n </p>\n ",
"required": true
},
"startTimeFilter": {
"shape_name": "ExecutionTimeFilter",
"type": "structure",
"members": {
"oldestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the oldest start or close date and time to return.\n </p>\n ",
"required": true
},
"latestDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n Specifies the latest start or close date and time to return.\n </p>\n "
}
},
"documentation": "\n <p>\n Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.\n </p>\n ",
"required": true
},
"typeFilter": {
"shape_name": "WorkflowTypeFilter",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Name of the workflow type.\n This field is required.\n </p>\n ",
"required": true
},
"version": {
"shape_name": "VersionOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n Version of the workflow type.\n </p>\n "
}
},
"documentation": "\n <p>\n If specified, only executions of the type specified in the filter are returned.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"tagFilter": {
"shape_name": "TagFilter",
"type": "structure",
"members": {
"tag": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Specifies the tag that must be associated with the execution for it to meet the filter criteria.\n This field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only executions that have the matching tag are listed.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextPageToken</code> was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n </p>\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify\n a page size greater than 100.\n Note that the number of executions may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the results in reverse order. By default the results are returned in\n descending order of the start time of the executions.\n </p>\n "
},
"executionFilter": {
"shape_name": "WorkflowExecutionFilter",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId to pass of match the criteria of this filter.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If specified, only workflow executions matching the workflow id specified in the filter are returned.\n </p>\n <note><code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code>\n are mutually exclusive. You can specify at most one of these in a request.</note>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowExecutionInfos",
"type": "structure",
"members": {
"executionInfos": {
"shape_name": "WorkflowExecutionInfoList",
"type": "list",
"members": {
"shape_name": "WorkflowExecutionInfo",
"type": "structure",
"members": {
"execution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution this information is about.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow execution.\n </p>\n ",
"required": true
},
"startTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the execution was started.\n </p>\n ",
"required": true
},
"closeTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The time when the workflow execution was closed. Set only if the execution status is CLOSED.\n </p>\n "
},
"executionStatus": {
"shape_name": "ExecutionStatus",
"enum": [
"OPEN",
"CLOSED"
],
"type": "string",
"documentation": "\n <p>\n The current status of the execution.\n </p>\n ",
"required": true
},
"closeStatus": {
"shape_name": "CloseStatus",
"enum": [
"COMPLETED",
"FAILED",
"CANCELED",
"TERMINATED",
"CONTINUED_AS_NEW",
"TIMED_OUT"
],
"type": "string",
"documentation": "\n <p>\n If the execution status is closed then this specifies how the execution was closed:</p>\n <ul>\n <li>COMPLETED: the execution was successfully completed.</li>\n <li>CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.</li>\n <li>TERMINATED: the execution was force terminated.</li>\n <li>FAILED: the execution failed to complete.</li>\n <li>TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.</li>\n <li>CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on\n the workflow.</li>\n </ul>\n "
},
"parent": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If this workflow execution is a child of another execution then contains\n the workflow execution that started this execution.\n </p>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions\n of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.\n </p>\n "
},
"cancelRequested": {
"shape_name": "Canceled",
"type": "boolean",
"documentation": "\n <p>\n Set to true if a cancellation is requested for this workflow execution.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains information about a workflow execution.\n\n <!-- This structure is returned from a call to\n <a>DescribeWorkflowExecution</a>. -->\n </p>\n "
},
"documentation": "\n <p>\n The list of workflow information structures.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n The token of the next page in the result. If set, the results have more than one page. The next\n page can be retrieved by repeating the request with this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains a paginated list of information about workflow executions.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Returns a list of open workflow executions in the specified domain that meet the filtering criteria.\n The results may be split into multiple pages.\n To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.\n </p>\n <note>\n This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>tagFilter.tag</code>: String constraint. The key is <code>swf:tagFilter.tag</code>.</li>\n <li>\n<code>typeFilter.name</code>: String constraint. The key is <code>swf:typeFilter.name</code>.</li>\n <li>\n<code>typeFilter.version</code>: String constraint. The key is <code>swf:typeFilter.version</code>.</li>\n </ul>\n </li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> ListOpenWorkflowExecutions </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sat, 14 Jan 2012 23:51:04 GMT\n X-Amz-Target: SimpleWorkflowService.ListOpenWorkflowExecutions\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=4kUhpZUp37PgpeOKHlWTsZi+Pq3Egw4mTkPNiEUgp28=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 151\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"startTimeFilter\":\n {\"oldestDate\": 1325376070,\n \"latestDate\": 1356998399},\n \"tagFilter\":\n {\"tag\": \"music purchase\"}\n }\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 313\n Content-Type: application/json\n x-amzn-RequestId: 9efeff4b-3f0a-11e1-9e8f-57bb03e21482\n\n {\"executionInfos\":\n [\n {\"cancelRequested\": false,\n \"execution\":\n {\"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"workflowId\": \"20110927-T-1\"},\n \"executionStatus\": \"OPEN\",\n \"startTimestamp\": 1326585031.619,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n </response>\n </example>\n </examples>\n "
},
"ListWorkflowTypes": {
"name": "ListWorkflowTypes",
"input": {
"shape_name": "ListWorkflowTypesInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the workflow types have been registered.\n </p>\n ",
"required": true
},
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n If specified, lists the workflow type with this name.\n </p>\n "
},
"registrationStatus": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n Specifies the registration status of the workflow types to list.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextPageToken</code> was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and all other arguments\n unchanged.\n </p>\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of results returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify\n a page size greater than 100.\n Note that the number of types may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the results in reverse order. By default the results are returned in ascending\n alphabetical order of the <code>name</code> of the workflow types.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "WorkflowTypeInfos",
"type": "structure",
"members": {
"typeInfos": {
"shape_name": "WorkflowTypeInfoList",
"type": "list",
"members": {
"shape_name": "WorkflowTypeInfo",
"type": "structure",
"members": {
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type this information is about.\n </p>\n ",
"required": true
},
"status": {
"shape_name": "RegistrationStatus",
"type": "string",
"enum": [
"REGISTERED",
"DEPRECATED"
],
"documentation": "\n <p>\n The current status of the workflow type.\n </p>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n The description of the type registered through <a>RegisterWorkflowType</a>.\n </p>\n "
},
"creationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date when this type was registered.\n </p>\n ",
"required": true
},
"deprecationDate": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n If the type is in deprecated state, then it is set to the date when the type was deprecated.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains information about a workflow type.\n </p>\n "
},
"documentation": "\n <p>\n The list of workflow type information.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n The token for the next page of type information. If set then the list consists of more than one page.\n You can retrieve the next page by repeating the request (that returned the structure) with the this token and all other arguments unchanged.\n </p>\n "
}
},
"documentation": "\n <p>\n Contains a paginated list of information structures about workflow types.\n </p>\n "
},
"errors": [
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
},
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
}
],
"documentation": "\n <p>\n Returns information about workflow types in the specified domain. The results may be split into multiple\n pages that can be retrieved by making the call repeatedly.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> ListWorkflowTypes Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 22:25:43 GMT\n X-Amz-Target: SimpleWorkflowService.ListWorkflowTypes\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=uleWQSyVVf0+aG50IoBJG5h0hzxNFNT97Mkn/FSCQ+Q=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 110\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"registrationStatus\": \"REGISTERED\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 174\n Content-Type: application/json\n x-amzn-RequestId: dcde6719-3fc7-11e1-9e8f-57bb03e21482\n\n {\"typeInfos\":\n [\n {\"creationDate\": 1326481174.027,\n \"description\": \"Handle customer orders\",\n \"status\": \"REGISTERED\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n ]\n }\n </response>\n </example>\n </examples>\n "
},
"PollForActivityTask": {
"name": "PollForActivityTask",
"input": {
"shape_name": "PollForActivityTaskInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain that contains the task lists being polled.\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Specifies the task list to poll for activity tasks.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the worker making the request, which is recorded in the\n <code>ActivityTaskStarted</code> event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "ActivityTask",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique ID of the task.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskStarted</code> event recorded in the history.\n </p>\n ",
"required": true
},
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution that started this activity task.\n </p>\n ",
"required": true
},
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of this activity task.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The inputs provided when the activity task was scheduled. The form of the input is\n user defined and should be meaningful to the activity implementation.\n </p>\n "
}
},
"documentation": "\n <p>\n Unit of work sent to an activity worker.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
}
],
"documentation": "\n <p>\n Used by workers to get an <a>ActivityTask</a> from the specified activity <code>taskList</code>.\n This initiates a long poll, where the service holds the HTTP\n connection open and responds as soon as a task becomes available.\n The maximum time the service holds on to the request before responding is 60 seconds. If no task is\n available within 60 seconds, the poll will return an empty result.\n An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string.\n If a task is returned, the worker should use its type to identify and process it correctly.\n </p>\n <important>\n Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).\n </important>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> PollForActivityTask Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:53:52 GMT\n X-Amz-Target: SimpleWorkflowService.PollForActivityTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=dv0H1RPYucoIcRckspWO0f8xG120MWZRKmj3O5/A4rY=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 108\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"mainTaskList\"},\n \"identity\": \"VerifyCreditCardWorker01\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 837\n Content-Type: application/json\n x-amzn-RequestId: b48fb6b5-3ff5-11e1-a23a-99d60383ae71\n\n {\"activityId\": \"verification-27\",\n \"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"startedEventId\": 11,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"workflowExecution\":\n {\"runId\": \"cfa2bd33-31b0-4b75-b131-255bb0d97b3f\",\n \"workflowId\": \"20110927-T-1\"}\n }\n </response>\n </example>\n </examples>\n "
},
"PollForDecisionTask": {
"name": "PollForDecisionTask",
"input": {
"shape_name": "PollForDecisionTaskInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the task lists to poll.\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Specifies the task list to poll for decision tasks.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the decider making the request, which is recorded in the\n DecisionTaskStarted event in the workflow history. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n </p>\n "
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If on a previous call to this method a <code>NextPageToken</code> was returned, the results are\n being paginated. To get the next page of results, repeat the call with the returned token and\n all other arguments unchanged.\n </p>\n <note>The <code>nextPageToken</code> returned by this action cannot be used with\n <a>GetWorkflowExecutionHistory</a> to get the next page. You must call <a>PollForDecisionTask</a> again\n (with the <code>nextPageToken</code>) to retrieve the next page of history records. Calling <a>PollForDecisionTask</a>\n with a <code>nextPageToken</code> will not return a new decision task.</note>.\n\n "
},
"maximumPageSize": {
"shape_name": "PageSize",
"type": "integer",
"min_length": 0,
"max_length": 1000,
"documentation": "\n <p>\n The maximum number of history events returned in each page. The default is 100, but the caller\n can override this value to a page size <i>smaller</i> than the default. You cannot specify a\n page size greater than 100.\n Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.\n </p>\n "
},
"reverseOrder": {
"shape_name": "ReverseOrder",
"type": "boolean",
"documentation": "\n <p>\n When set to <code>true</code>, returns the events in reverse order. By default the results are returned in ascending order\n of the <code>eventTimestamp</code> of the events.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "DecisionTask",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The opaque string used as a handle on the task. This token is used by workers to\n communicate progress and response information back to the system about\n the task.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskStarted</code> event recorded in the history.\n </p>\n ",
"required": true
},
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution for which this decision task was created.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow execution for which this decision task was created.\n </p>\n ",
"required": true
},
"events": {
"shape_name": "HistoryEventList",
"type": "list",
"members": {
"shape_name": "HistoryEvent",
"type": "structure",
"members": {
"eventTimestamp": {
"shape_name": "Timestamp",
"type": "timestamp",
"documentation": "\n <p>\n The date and time when the event occurred.\n </p>\n ",
"required": true
},
"eventType": {
"shape_name": "EventType",
"type": "string",
"enum": [
"WorkflowExecutionStarted",
"WorkflowExecutionCancelRequested",
"WorkflowExecutionCompleted",
"CompleteWorkflowExecutionFailed",
"WorkflowExecutionFailed",
"FailWorkflowExecutionFailed",
"WorkflowExecutionTimedOut",
"WorkflowExecutionCanceled",
"CancelWorkflowExecutionFailed",
"WorkflowExecutionContinuedAsNew",
"ContinueAsNewWorkflowExecutionFailed",
"WorkflowExecutionTerminated",
"DecisionTaskScheduled",
"DecisionTaskStarted",
"DecisionTaskCompleted",
"DecisionTaskTimedOut",
"ActivityTaskScheduled",
"ScheduleActivityTaskFailed",
"ActivityTaskStarted",
"ActivityTaskCompleted",
"ActivityTaskFailed",
"ActivityTaskTimedOut",
"ActivityTaskCanceled",
"ActivityTaskCancelRequested",
"RequestCancelActivityTaskFailed",
"WorkflowExecutionSignaled",
"MarkerRecorded",
"RecordMarkerFailed",
"TimerStarted",
"StartTimerFailed",
"TimerFired",
"TimerCanceled",
"CancelTimerFailed",
"StartChildWorkflowExecutionInitiated",
"StartChildWorkflowExecutionFailed",
"ChildWorkflowExecutionStarted",
"ChildWorkflowExecutionCompleted",
"ChildWorkflowExecutionFailed",
"ChildWorkflowExecutionTimedOut",
"ChildWorkflowExecutionCanceled",
"ChildWorkflowExecutionTerminated",
"SignalExternalWorkflowExecutionInitiated",
"SignalExternalWorkflowExecutionFailed",
"ExternalWorkflowExecutionSignaled",
"RequestCancelExternalWorkflowExecutionInitiated",
"RequestCancelExternalWorkflowExecutionFailed",
"ExternalWorkflowExecutionCancelRequested"
],
"documentation": "\n <p>\n The type of the history event.\n </p>\n ",
"required": true
},
"eventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The system generated id of the event. This id uniquely identifies the event with in the workflow execution history.\n </p>\n ",
"required": true
},
"workflowExecutionStartedEventAttributes": {
"shape_name": "WorkflowExecutionStartedEventAttributes",
"type": "structure",
"members": {
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the workflow execution (if any).\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration of decision tasks for this workflow type.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions if this workflow execution is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n\n The supported child policies are:\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list for scheduling the decision tasks for this workflow execution.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type of this execution.\n </p>\n ",
"required": true
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with this workflow execution. An execution can have up to 5 tags.\n </p>\n "
},
"continuedExecutionRunId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n If this workflow execution was started due to a <code>ContinueAsNewWorkflowExecution</code> decision, then\n it contains the <code>runId</code> of the previous workflow execution that was closed and continued as this execution.\n </p>\n "
},
"parentWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The source workflow execution that started this workflow execution. The member is not set if the workflow execution was\n not started by a workflow.\n </p>\n "
},
"parentInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this workflow execution. The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCompletedEventAttributes": {
"shape_name": "WorkflowExecutionCompletedEventAttributes",
"type": "structure",
"members": {
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result produced by the workflow execution upon successful completion.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CompleteWorkflowExecution</code> decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"completeWorkflowExecutionFailedEventAttributes": {
"shape_name": "CompleteWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "CompleteWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CompleteWorkflowExecution</code> decision to complete this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CompleteWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionFailedEventAttributes": {
"shape_name": "WorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The descriptive reason provided for the failure (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>FailWorkflowExecution</code> decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"failWorkflowExecutionFailedEventAttributes": {
"shape_name": "FailWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "FailWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>FailWorkflowExecution</code> decision to fail this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>FailWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionTimedOutEventAttributes": {
"shape_name": "WorkflowExecutionTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "WorkflowExecutionTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of timeout that caused this event.\n </p>\n ",
"required": true
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCanceledEventAttributes": {
"shape_name": "WorkflowExecutionCanceledEventAttributes",
"type": "structure",
"members": {
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details for the cancellation (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"cancelWorkflowExecutionFailedEventAttributes": {
"shape_name": "CancelWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "CancelWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CancelWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionContinuedAsNewEventAttributes": {
"shape_name": "WorkflowExecutionContinuedAsNewEventAttributes",
"type": "structure",
"members": {
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the new workflow execution.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>ContinueAsNewWorkflowExecution</code> decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"newExecutionRunId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the new workflow execution.\n </p>\n ",
"required": true
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The total duration allowed for the new workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Represents a task list.\n </p>\n ",
"required": true
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration of decision tasks for the new workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions of the new execution if it is terminated\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.</p>\n\n <p>The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags associated with the new workflow execution.\n </p>\n "
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Represents a workflow type.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionContinuedAsNew</code> then this member is set and\n provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"continueAsNewWorkflowExecutionFailedEventAttributes": {
"shape_name": "ContinueAsNewWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"cause": {
"shape_name": "ContinueAsNewWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNHANDLED_DECISION",
"WORKFLOW_TYPE_DEPRECATED",
"WORKFLOW_TYPE_DOES_NOT_EXIST",
"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_CHILD_POLICY_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>ContinueAsNewWorkflowExecution</code> decision that started this execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ContinueAsNewWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionTerminatedEventAttributes": {
"shape_name": "WorkflowExecutionTerminatedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "TerminateReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason provided for the termination (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details provided for the termination (if any).\n </p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy used for the child workflow executions of this workflow execution.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"cause": {
"shape_name": "WorkflowExecutionTerminatedCause",
"type": "string",
"enum": [
"CHILD_POLICY_APPLIED",
"EVENT_LIMIT_EXCEEDED",
"OPERATOR_INITIATED"
],
"documentation": "\n <p>\n If set, indicates that the workflow execution was automatically terminated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionTerminated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionCancelRequestedEventAttributes": {
"shape_name": "WorkflowExecutionCancelRequestedEventAttributes",
"type": "structure",
"members": {
"externalWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution for which the cancellation was requested.\n </p>\n "
},
"externalInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
},
"cause": {
"shape_name": "WorkflowExecutionCancelRequestedCause",
"type": "string",
"enum": [
"CHILD_POLICY_APPLIED"
],
"documentation": "\n <p>\n If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause.\n This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionCancelRequested</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskScheduledEventAttributes": {
"shape_name": "DecisionTaskScheduledEventAttributes",
"type": "structure",
"members": {
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list in which the decision task was scheduled.\n </p>\n ",
"required": true
},
"startToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for this decision task. The task is considered timed out if it does not\n completed within this duration.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskScheduled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskStartedEventAttributes": {
"shape_name": "DecisionTaskStartedEventAttributes",
"type": "structure",
"members": {
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the decider making the request. This enables diagnostic tracing\n when problems arise. The form of this identity is user defined.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskCompletedEventAttributes": {
"shape_name": "DecisionTaskCompletedEventAttributes",
"type": "structure",
"members": {
"executionContext": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n User defined context for the workflow execution.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>DecisionTaskStarted</code> event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"decisionTaskTimedOutEventAttributes": {
"shape_name": "DecisionTaskTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "DecisionTaskTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of timeout that expired before the decision task could be completed.\n </p>\n ",
"required": true
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskScheduled</code> event that was recorded when this decision task was\n scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>DecisionTaskStarted</code> event recorded when this decision task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskScheduledEventAttributes": {
"shape_name": "ActivityTaskScheduledEventAttributes",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the activity task.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique id of the activity task.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the activity task.\n </p>\n "
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n </p>\n "
},
"scheduleToStartTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time the activity task can wait to be assigned to a worker.\n </p>\n "
},
"scheduleToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time for this activity task.\n </p>\n "
},
"startToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum amount of time a worker may take to process the activity task.\n </p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The task list in which the activity task has been scheduled.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"heartbeatTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum time before which the worker processing this task must report progress by\n calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskScheduled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskStartedEventAttributes": {
"shape_name": "ActivityTaskStartedEventAttributes",
"type": "structure",
"members": {
"identity": {
"shape_name": "Identity",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Identity of the worker that was assigned this task. This aids diagnostics\n when problems arise. The form of this identity is user defined.\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCompletedEventAttributes": {
"shape_name": "ActivityTaskCompletedEventAttributes",
"type": "structure",
"members": {
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The results of the activity task (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskFailedEventAttributes": {
"shape_name": "ActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason provided for the failure (if any).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskTimedOutEventAttributes": {
"shape_name": "ActivityTaskTimedOutEventAttributes",
"type": "structure",
"members": {
"timeoutType": {
"shape_name": "ActivityTaskTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE",
"SCHEDULE_TO_START",
"SCHEDULE_TO_CLOSE",
"HEARTBEAT"
],
"documentation": "\n <p>\n The type of the timeout that caused this event.\n </p>\n ",
"required": true
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "LimitedData",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n Contains the content of the <code>details</code> parameter for the last call made by the activity to <code>RecordActivityTaskHeartbeat</code>.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCanceledEventAttributes": {
"shape_name": "ActivityTaskCanceledEventAttributes",
"type": "structure",
"members": {
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the cancellation (if any).\n </p>\n "
},
"scheduledEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>ActivityTaskScheduled</code> event that was recorded when this activity task\n was scheduled.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ActivityTaskStarted</code> event recorded when this activity task was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"latestCancelRequestedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n If set, contains the Id of the last <code>ActivityTaskCancelRequested</code> event recorded for this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"activityTaskCancelRequestedEventAttributes": {
"shape_name": "ActivityTaskCancelRequestedEventAttributes",
"type": "structure",
"members": {
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelActivityTask</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique ID of the task.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ActivityTaskcancelRequested</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"workflowExecutionSignaledEventAttributes": {
"shape_name": "WorkflowExecutionSignaledEventAttributes",
"type": "structure",
"members": {
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal received. The decider can use the signal name and inputs to determine\n how to the process the signal.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine\n how to process the signal.\n </p>\n "
},
"externalWorkflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow execution that sent the signal. This is set only of the signal was sent by another\n workflow execution.\n </p>\n "
},
"externalInitiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflow</code> decision to signal this workflow execution.The source event\n with this Id can be found in the history of the source workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event. This field is set only if the signal was initiated by another workflow execution.\n\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>WorkflowExecutionSignaled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"markerRecordedEventAttributes": {
"shape_name": "MarkerRecordedEventAttributes",
"type": "structure",
"members": {
"markerName": {
"shape_name": "MarkerName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the marker.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the marker (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RecordMarker</code> decision that requested this marker.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>MarkerRecorded</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"recordMarkerFailedEventAttributes": {
"shape_name": "RecordMarkerFailedEventAttributes",
"type": "structure",
"members": {
"markerName": {
"shape_name": "MarkerName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The marker's name.</p>\n ",
"required": true
},
"cause": {
"shape_name": "RecordMarkerFailedCause",
"type": "string",
"enum": [
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RecordMarkerFailed</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>DecisionTaskFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerStartedEventAttributes": {
"shape_name": "TimerStartedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that was started.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
},
"startToFireTimeout": {
"shape_name": "DurationInSeconds",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The duration of time after which the timer will fire.\n </p>\n <p>The duration is specified in seconds. The valid values are integers greater than or equal to 0.</p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartTimer</code> decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerFiredEventAttributes": {
"shape_name": "TimerFiredEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that fired.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>TimerStarted</code> event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerFired</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"timerCanceledEventAttributes": {
"shape_name": "TimerCanceledEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer that was canceled.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>TimerStarted</code> event that was recorded when this timer was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelTimer</code> decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>TimerCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startChildWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "StartChildWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the child workflow execution.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks. This data is not sent to the activity.\n </p>\n "
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The inputs provided to the child workflow execution (if any).\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration,\n it will be timed out and force terminated.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list used for the decision tasks of the child workflow execution.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n The policy to use for the child workflow executions if this execution gets terminated by explicitly calling\n the <a>TerminateWorkflowExecution</a> action or due to an expired timeout.</p>\n <p>The supported child policies are:</p>\n\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n ",
"required": true
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration allowed for the decision tasks for this workflow execution.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags to associated with the child workflow execution.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>StartChildWorkflowExecutionInitiated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionStartedEventAttributes": {
"shape_name": "ChildWorkflowExecutionStartedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was started.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionStarted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionCompletedEventAttributes": {
"shape_name": "ChildWorkflowExecutionCompletedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was completed.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result of the child workflow execution (if any).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionCompleted</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionFailedEventAttributes": {
"shape_name": "ChildWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that failed.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n The reason for the failure (if provided).\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The details of the failure (if provided).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionFailed</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionTimedOutEventAttributes": {
"shape_name": "ChildWorkflowExecutionTimedOutEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that timed out.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"timeoutType": {
"shape_name": "WorkflowExecutionTimeoutType",
"type": "string",
"enum": [
"START_TO_CLOSE"
],
"documentation": "\n <p>\n The type of the timeout that caused the child workflow execution to time out.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionTimedOut</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionCanceledEventAttributes": {
"shape_name": "ChildWorkflowExecutionCanceledEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was canceled.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Details of the cancellation (if provided).\n </p>\n "
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionCanceled</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"childWorkflowExecutionTerminatedEventAttributes": {
"shape_name": "ChildWorkflowExecutionTerminatedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The child workflow execution that was terminated.\n </p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"startedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The Id of the <code>ChildWorkflowExecutionStarted</code> event recorded when this child workflow execution was started.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ChildWorkflowExecutionTerminated</code> then this member is set and provides\n detailed information about the event. It is not set for other event types.\n </p>\n "
},
"signalExternalWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "SignalExternalWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution to send the signal to.\n </p>\n "
},
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Input provided to the signal (if any).\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in\n the <code>SignalExternalWorkflowExecution</code> decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>SignalExternalWorkflowExecutionInitiated</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"externalWorkflowExecutionSignaledEventAttributes": {
"shape_name": "ExternalWorkflowExecutionSignaledEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution that the signal was delivered to.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflowExecution</code> decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ExternalWorkflowExecutionSignaled</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"signalExternalWorkflowExecutionFailedEventAttributes": {
"shape_name": "SignalExternalWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution that the signal was being delivered to.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution that the signal was being delivered to.\n </p>\n "
},
"cause": {
"shape_name": "SignalExternalWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION",
"SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>SignalExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>SignalExternalWorkflowExecution</code> decision to request this signal.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that resulted in\n the <code>SignalExternalWorkflowExecution</code> decision for this signal.\n This information can be useful for diagnosing problems by tracing back the cause of events leading up to this event.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>If the event is of type <code>SignalExternalWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.</p>\n "
},
"externalWorkflowExecutionCancelRequestedEventAttributes": {
"shape_name": "ExternalWorkflowExecutionCancelRequestedEventAttributes",
"type": "structure",
"members": {
"workflowExecution": {
"shape_name": "WorkflowExecution",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n A system generated unique identifier for the workflow execution.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The external workflow execution to which the cancellation request was delivered.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ExternalWorkflowExecutionCancelRequested</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelExternalWorkflowExecutionInitiatedEventAttributes": {
"shape_name": "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution to be canceled.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution to be canceled.\n </p>\n "
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelExternalWorkflowExecutionInitiated</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelExternalWorkflowExecutionFailedEventAttributes": {
"shape_name": "RequestCancelExternalWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow to which the cancel request was to be delivered.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution.\n </p>\n "
},
"cause": {
"shape_name": "RequestCancelExternalWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION",
"REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>RequestCancelExternalWorkflowExecutionInitiated</code> event corresponding to the\n <code>RequestCancelExternalWorkflowExecution</code> decision to cancel this external workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelExternalWorkflowExecution</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelExternalWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"scheduleActivityTaskFailedEventAttributes": {
"shape_name": "ScheduleActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The activity type provided in the <code>ScheduleActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The activityId provided in the <code>ScheduleActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "ScheduleActivityTaskFailedCause",
"type": "string",
"enum": [
"ACTIVITY_TYPE_DEPRECATED",
"ACTIVITY_TYPE_DOES_NOT_EXIST",
"ACTIVITY_ID_ALREADY_IN_USE",
"OPEN_ACTIVITIES_LIMIT_EXCEEDED",
"ACTIVITY_CREATION_RATE_EXCEEDED",
"DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED",
"DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision that\n resulted in the scheduling of this activity task.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>ScheduleActivityTaskFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"requestCancelActivityTaskFailedEventAttributes": {
"shape_name": "RequestCancelActivityTaskFailedEventAttributes",
"type": "structure",
"members": {
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The activityId provided in the <code>RequestCancelActivityTask</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "RequestCancelActivityTaskFailedCause",
"type": "string",
"enum": [
"ACTIVITY_ID_UNKNOWN",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>RequestCancelActivityTask</code> decision for this cancellation request.\n This information can be useful for diagnosing problems by tracing back the cause of events.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>RequestCancelActivityTaskFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startTimerFailedEventAttributes": {
"shape_name": "StartTimerFailedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The timerId provided in the <code>StartTimer</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "StartTimerFailedCause",
"type": "string",
"enum": [
"TIMER_ID_ALREADY_IN_USE",
"OPEN_TIMERS_LIMIT_EXCEEDED",
"TIMER_CREATION_RATE_EXCEEDED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartTimer</code> decision for this activity task.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>StartTimerFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"cancelTimerFailedEventAttributes": {
"shape_name": "CancelTimerFailedEventAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The timerId provided in the <code>CancelTimer</code> decision that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "CancelTimerFailedCause",
"type": "string",
"enum": [
"TIMER_ID_UNKNOWN",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>\n The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.\n </p>\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>CancelTimer</code> decision to cancel this timer.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If the event is of type <code>CancelTimerFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
},
"startChildWorkflowExecutionFailedEventAttributes": {
"shape_name": "StartChildWorkflowExecutionFailedEventAttributes",
"type": "structure",
"members": {
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The workflow type provided in the <code>StartChildWorkflowExecution</code> <a>Decision</a> that failed.\n </p>\n ",
"required": true
},
"cause": {
"shape_name": "StartChildWorkflowExecutionFailedCause",
"type": "string",
"enum": [
"WORKFLOW_TYPE_DOES_NOT_EXIST",
"WORKFLOW_TYPE_DEPRECATED",
"OPEN_CHILDREN_LIMIT_EXCEEDED",
"OPEN_WORKFLOWS_LIMIT_EXCEEDED",
"CHILD_CREATION_RATE_EXCEEDED",
"WORKFLOW_ALREADY_RUNNING",
"DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_TASK_LIST_UNDEFINED",
"DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED",
"DEFAULT_CHILD_POLICY_UNDEFINED",
"OPERATION_NOT_PERMITTED"
],
"documentation": "\n <p>The cause of the failure to process the decision.\n This information is generated by the system and can be useful for diagnostic purposes.</p>\n\n <note>If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</note>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the child workflow execution.\n </p>\n ",
"required": true
},
"initiatedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>StartChildWorkflowExecutionInitiated</code> event corresponding to the\n <code>StartChildWorkflowExecution</code> <a>Decision</a> to start this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the chain of events leading\n up to this event.\n </p>\n ",
"required": true
},
"decisionTaskCompletedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the <code>DecisionTaskCompleted</code> event corresponding to the decision task that\n resulted in the <code>StartChildWorkflowExecution</code> <a>Decision</a> to request this child workflow execution.\n This information can be useful for diagnosing problems by tracing back the cause of events.\n </p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": null
}
},
"documentation": "\n <p>\n If the event is of type <code>StartChildWorkflowExecutionFailed</code> then this member\n is set and provides detailed information about the event. It is not set for other event types.\n </p>\n "
}
},
"documentation": "\n <p>Event within a workflow execution. A history event can be one of these types:</p>\n <ul>\n <li>\n <b>WorkflowExecutionStarted</b>: The workflow execution was started.\n </li>\n <li>\n <b>WorkflowExecutionCompleted</b>: The workflow execution was closed due to successful completion.\n </li>\n <li>\n <b>WorkflowExecutionFailed</b>: The workflow execution closed due to a failure.\n </li>\n <li>\n <b>WorkflowExecutionTimedOut</b>: The workflow execution was closed because a time out was exceeded.\n </li>\n <li>\n <b>WorkflowExecutionCanceled</b>: The workflow execution was successfully canceled and closed.\n </li>\n <li>\n <b>WorkflowExecutionTerminated</b>: The workflow execution was terminated.\n </li>\n <li>\n <b>WorkflowExecutionContinuedAsNew</b>: The workflow execution was closed and a new\n execution of the same type was created with the same workflowId.\n </li>\n <li>\n <b>WorkflowExecutionCancelRequested</b>: A request to cancel this workflow execution was made.\n </li>\n <li>\n <b>DecisionTaskScheduled</b>: A decision task was scheduled for the workflow execution.\n </li>\n <li>\n <b>DecisionTaskStarted</b>: The decision task was dispatched to a decider.\n </li>\n <li>\n <b>DecisionTaskCompleted</b>: The decider successfully completed a decision task by calling <a>RespondDecisionTaskCompleted</a>.\n </li>\n<!--\n <li>\n <b>DecisionTaskFailed</b>: The decider failed a decision task by calling <a>RespondDecisionTaskFailed</a>.\n </li>\n --><li>\n <b>DecisionTaskTimedOut</b>: The decision task timed out.\n </li>\n <li>\n <b>ActivityTaskScheduled</b>: An activity task was scheduled for execution.\n </li>\n <li>\n <b>ScheduleActivityTaskFailed</b>: Failed to process ScheduleActivityTask decision. This happens when\n the decision is not configured properly, for example the activity type specified is not registered.\n </li>\n <li>\n <b>ActivityTaskStarted</b>: The scheduled activity task was dispatched to a worker.\n </li>\n <li>\n <b>ActivityTaskCompleted</b>: An activity worker successfully completed an activity task by calling <a>RespondActivityTaskCompleted</a>.\n </li>\n <li>\n <b>ActivityTaskFailed</b>: An activity worker failed an activity task by calling <a>RespondActivityTaskFailed</a>.\n </li>\n <li>\n <b>ActivityTaskTimedOut</b>: The activity task timed out.\n </li>\n <li>\n <b>ActivityTaskCanceled</b>: The activity task was successfully canceled.\n </li>\n <!--\n <li>\n <b>ActivityTaskHeartbeatRecorded</b>: A call to <a>RecordActivityTaskHeartbeat</a> was\n successfully processed by the system.\n </li>\n -->\n <li>\n <b>ActivityTaskCancelRequested</b>: A <code>RequestCancelActivityTask</code> decision was\n received by the system.\n </li>\n <li>\n <b>RequestCancelActivityTaskFailed</b>: Failed to process RequestCancelActivityTask decision. This happens when\n the decision is not configured properly.\n </li>\n <li>\n <b>WorkflowExecutionSignaled</b>: An external signal was received for the workflow execution.\n </li>\n <li>\n <b>MarkerRecorded</b>: A marker was recorded in the workflow history as the result of a\n <code>RecordMarker</code> decision.\n </li>\n <li>\n <b>TimerStarted</b>: A timer was started for the workflow execution due to a\n <code>StartTimer</code> decision.\n </li>\n <li>\n <b>StartTimerFailed</b>: Failed to process StartTimer decision. This happens when\n the decision is not configured properly, for example a timer already exists with the specified timer Id.\n </li>\n <li>\n <b>TimerFired</b>: A timer, previously started for this workflow execution, fired.\n </li>\n <li>\n <b>TimerCanceled</b>: A timer, previously started for this workflow execution,\n was successfully canceled.\n </li>\n <li>\n <b>CancelTimerFailed</b>: Failed to process CancelTimer decision. This happens when\n the decision is not configured properly, for example no timer exists with the specified timer Id.\n </li>\n <li>\n <b>StartChildWorkflowExecutionInitiated</b>: A request was made to start a child workflow execution.\n </li>\n <li>\n <b>StartChildWorkflowExecutionFailed</b>: Failed to process StartChildWorkflowExecution decision.\n This happens when the decision is not configured properly, for example the workflow type specified is not registered.\n </li>\n <li>\n <b>ChildWorkflowExecutionStarted</b>: A child workflow execution was successfully started.\n </li>\n <li>\n <b>ChildWorkflowExecutionCompleted</b>: A child workflow execution, started by this workflow execution,\n completed successfully and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionFailed</b>: A child workflow execution, started by this workflow execution,\n failed to complete successfully and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionTimedOut</b>: A child workflow execution, started by this workflow execution,\n timed out and was closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionCanceled</b>: A child workflow execution, started by this workflow execution,\n was canceled and closed.\n </li>\n <li>\n <b>ChildWorkflowExecutionTerminated</b>: A child workflow execution, started by this workflow execution,\n was terminated.\n </li>\n <li>\n <b>SignalExternalWorkflowExecutionInitiated</b>: A request to signal an external workflow was made.\n </li>\n <li>\n <b>ExternalWorkflowExecutionSignaled</b>: A signal, requested by this workflow execution, was successfully\n delivered to the target external workflow execution.\n </li>\n <li>\n <b>SignalExternalWorkflowExecutionFailed</b>: The request to signal an external\n workflow execution failed.\n </li>\n <li>\n <b>RequestCancelExternalWorkflowExecutionInitiated</b>: A request was made to request the cancellation of an external workflow execution.\n </li>\n <li>\n <b>ExternalWorkflowExecutionCancelRequested</b>: Request to cancel an external workflow execution was successfully\n delivered to the target execution.\n </li>\n <li>\n <b>RequestCancelExternalWorkflowExecutionFailed</b>: Request to cancel an external workflow execution\n failed.\n </li>\n </ul>\n "
},
"documentation": "\n <p>\n A paginated list of history events of the workflow execution. The decider uses this\n during the processing of the decision task.\n </p>\n ",
"required": true
},
"nextPageToken": {
"shape_name": "PageToken",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n Returns a value if the results are paginated. To get the next page of results,\n repeat the request specifying this token and all other arguments unchanged.\n </p>\n "
},
"previousStartedEventId": {
"shape_name": "EventId",
"type": "long",
"documentation": "\n <p>\n The id of the DecisionTaskStarted event of the previous decision task of this workflow execution\n that was processed by the decider. This can be used to determine the events in the history new since the\n last decision task received by the decider.\n </p>\n "
}
},
"documentation": "\n <p>\n A structure that represents a decision task. Decision tasks are sent to\n deciders in order for them to make decisions.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
}
],
"documentation": "\n <p>\n Used by deciders to get a <a>DecisionTask</a> from the specified decision <code>taskList</code>.\n A decision task may be returned for any open workflow execution that is\n using the specified task list. The task includes a paginated view of the history of the workflow execution.\n The decider should use the workflow type and the history to determine how to properly handle the task.\n </p>\n <p>\n This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available.\n If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned.\n An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.\n </p>\n <important>\n Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).\n </important>\n <important>\n Because the number of workflow history events for a single workflow execution might be very large, the result\n returned might be split up across a number of pages.\n To retrieve subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the <code>nextPageToken</code> returned by the initial call.\n Note that you do <b>not</b> call <code>GetWorkflowExecutionHistory</code> with this <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code> again.\n </important>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the <code>taskList.name</code> parameter by using a <b>Condition</b> element with the <code>swf:taskList.name</code> key to allow the action to access only certain task lists.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n\n <example>\n\n <name> PollForDecisionTask Example </name>\n\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 02:09:54 GMT\n X-Amz-Target: SimpleWorkflowService.PollForDecisionTask\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=R3CJ2HMLSVpc2p6eafeztZCZWcgza+h61gSUuWx15gw=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 171\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"identity\": \"Decider01\",\n \"maximumPageSize\": 50,\n \"reverseOrder\": true}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 1639\n Content-Type: application/json\n x-amzn-RequestId: 03db54cf-3f1e-11e1-b118-3bfa5e8e7fc3\n\n {\"events\":\n [\n {\"decisionTaskStartedEventAttributes\":\n {\"identity\": \"Decider01\",\n \"scheduledEventId\": 2},\n \"eventId\": 3,\n \"eventTimestamp\": 1326593394.566,\n \"eventType\": \"DecisionTaskStarted\"},\n {\"decisionTaskScheduledEventAttributes\":\n {\"startToCloseTimeout\": \"600\",\n \"taskList\":\n {\"name\": \"specialTaskList\"}\n },\n \"eventId\": 2,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"DecisionTaskScheduled\"},\n {\"eventId\": 1,\n \"eventTimestamp\": 1326592619.474,\n \"eventType\": \"WorkflowExecutionStarted\",\n \"workflowExecutionStartedEventAttributes\":\n {\"childPolicy\": \"TERMINATE\",\n \"executionStartToCloseTimeout\": \"3600\",\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"parentInitiatedEventId\": 0,\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"taskStartToCloseTimeout\": \"600\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n }\n ],\n \"previousStartedEventId\": 0,\n \"startedEventId\": 3,\n \"taskToken\": \"AAAAKgAAAAEAAAAAAAAAATZDvCYwk/hP/X1ZGdJhb+T6OWzcBx2DPhsIi5HF4aGQI4OXrDE7Ny3uM+aiAhGrmeNyVAa4yNIBQuoZuJA5G+BoaB0JuHFBOynHDTnm7ayNH43KhMkfdrDG4elfHSz3m/EtbLnFGueAr7+3NKDG6x4sTKg3cZpOtSguSx05yI1X3AtscS8ATcLB2Y3Aub1YonN/i/k67voca/GFsSiwSz3AAnJj1IPvrujgIj9KUvckwRPC5ET7d33XJcRp+gHYzZsBLVBaRmV3gEYAnp2ICslFn4YSjGy+dFXCNpOa4G1O8pczCbFUGbQ3+5wf0RSaa/xMq2pfdBKnuFp0wp8kw1k+5ZsbtDZeZn8g5GyKCLiLms/xD0OxugGGUe5ZlAoHEkTWGxZj/G32P7cMoCgrcACfFPdx1LNYYEre7YiGiyjGnfW2t5mW7VK9Np28vcXVbdpH4JNEB9OuB1xqL8N8ifPVtc72uxB1i9XEdq/8rkXasSEw4TubB2FwgqnuJstmfEhpOdb5HfhR6OwmnHuk9eszO/fUkGucTUXQP2hhB+Gz\",\n \"workflowExecution\":\n {\"runId\": \"06b8f87a-24b3-40b6-9ceb-9676f28e9493\",\n \"workflowId\": \"20110927-T-1\"},\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"}\n }\n </response>\n\n </example>\n\n </examples>\n\n "
},
"RecordActivityTaskHeartbeat": {
"name": "RecordActivityTaskHeartbeat",
"input": {
"shape_name": "RecordActivityTaskHeartbeatInput",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The <code>taskToken</code> of the <a>ActivityTask</a>.\n </p>\n <important>\n The <code>taskToken</code> is generated by the service and should be treated as an opaque value. If the task is passed to another process, its <code>taskToken</code> must also be passed. This enables it to provide its progress and respond with results.\n </important>\n ",
"required": true
},
"details": {
"shape_name": "LimitedData",
"type": "string",
"max_length": 2048,
"documentation": "\n <p>\n If specified, contains details about the progress of the task.\n </p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "ActivityTaskStatus",
"type": "structure",
"members": {
"cancelRequested": {
"shape_name": "Canceled",
"type": "boolean",
"documentation": "\n <p>\n Set to <code>true</code> if cancellation of the task is requested.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Status information about an activity task.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified\n <code>taskToken</code> is still making progress. The worker can also (optionally) specify details of the progress,\n for example percent complete, using the <code>details</code> parameter.\n\n This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task.\n If a cancellation is being attempted for the specified task, then the boolean <code>cancelRequested</code> flag\n returned by the service is set to <code>true</code>.\n </p>\n <p>\n This action resets the <code>taskHeartbeatTimeout</code> clock.\n The <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>.\n </p>\n <p>\n This action does not in itself create an event in the workflow execution history.\n However, if the task times out, the workflow execution history will contain a <code>ActivityTaskTimedOut</code> event\n that contains the information from the last heartbeat generated by the activity worker.\n </p>\n <note>\n The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration of an activity task, regardless\n of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also\n specified in <a>RegisterActivityType</a>.\n </note>\n <note>\n This operation is only useful for long-lived activities to report liveliness of the task and to determine\n if a cancellation is being attempted.\n </note>\n\n <important>\n If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is being\n attempted. If the worker can cancel the activity, it should respond with\n <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation request.\n </important>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RecordActivityTaskHeartbeat Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:55:06 GMT\n X-Amz-Target: SimpleWorkflowService.RecordActivityTaskHeartbeat\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=DEA8rw5TqtpqCeTljl7eotZkuWTgmGZ1PWyDNZPehT0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 623\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"details\": \"starting task\"}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 25\n Content-Type: application/json\n x-amzn-RequestId: e08622cd-3ff5-11e1-9b11-7182192d0b57\n\n {\"cancelRequested\":false}\n </response>\n </example>\n </examples>\n "
},
"RegisterActivityType": {
"name": "RegisterActivityType",
"input": {
"shape_name": "RegisterActivityTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which this activity is to be registered.\n </p>\n ",
"required": true
},
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the activity type within the domain.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the activity type.\n </p>\n <note>\n The activity type consists of the name and version, the combination of which must be unique within the domain.\n </note>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true,
"cli_name": "activity-version"
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n A textual description of the activity type.\n </p>\n "
},
"defaultTaskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.\n This default can be overridden when scheduling an activity task using the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskHeartbeatTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum time before which a worker processing a task of this type must report progress by\n calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out.\n This default can be overridden when scheduling an activity task using the <code>ScheduleActivityTask</code> <a>Decision</a>.\n If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives\n an <code>UnknownResource</code> fault.\n In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used\n if a task list is not provided when a task is scheduled through the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n "
},
"defaultTaskScheduleToStartTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.\n This default can be overridden when scheduling an activity task using the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultTaskScheduleToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum duration for a task of this activity type.\n This default can be overridden when scheduling an activity task using the <code>ScheduleActivityTask</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "TypeAlreadyExistsFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n </p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
},
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Registers a new <i>activity type</i> along with its configuration settings in the specified domain.\n </p>\n\n <important>\n A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the domain. You cannot change any configuration\n settings of the type after its registration, and it must be registered as a new version.\n </important>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li>\n <li>\n<code>name</code>: String constraint. The key is <code>swf:name</code>.</li>\n <li>\n<code>version</code>: String constraint. The key is <code>swf:version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RegisterActivityType Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:14:06 GMT\n X-Amz-Target: SimpleWorkflowService.RegisterActivityType\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=F9cptqaGWa2H7LW3dpctF9J5svsB6FRZ4krghCRnml0=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 343\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"name\": \"activityVerify\",\n \"version\": \"1.0\",\n \"description\": \"Verify the customer credit card\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultTaskHeartbeatTimeout\": \"120\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultTaskScheduleToStartTimeout\": \"300\",\n \"defaultTaskScheduleToCloseTimeout\": \"900\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: d68969c7-3f0d-11e1-9b11-7182192d0b57\n </response>\n </example>\n </examples>\n "
},
"RegisterDomain": {
"name": "RegisterDomain",
"input": {
"shape_name": "RegisterDomainInput",
"type": "structure",
"members": {
"name": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n Name of the domain to register. The name must be unique.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>Textual description of the domain.</p>\n "
},
"workflowExecutionRetentionPeriodInDays": {
"shape_name": "DurationInDays",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>A duration (in days) for which the record (including the history) of workflow executions in this domain should\n be kept by the service. After the retention period, the workflow execution will not be available in the results of\n visibility calls.</p>\n <p>If you pass the value <code>NONE</code> then there is no expiration for workflow execution history (effectively\n an infinite retention period).</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "DomainAlreadyExistsFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned if the specified domain already exists. You will\n get this fault even if the existing domain is in deprecated status.\n </p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Registers a new domain.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>You cannot use an IAM policy to control domain access for this action. The name of the domain being\n registered is available as the resource of this action.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n <p></p>\n<examples>\n <example>\n <name> RegisterDomain Example </name>\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:42:12 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterDomain\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=tzjkF55lxAxPhzp/BRGFYQRQRq6CqrM254dTDE/EncI=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 91\nPragma: no-cache\nCache-Control: no-cache\n\n{\"name\": \"867530902\",\n \"description\": \"music\",\n \"workflowExecutionRetentionPeriodInDays\": \"60\"}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 4ec4ac3f-3e16-11e1-9b11-7182192d0b57\n</response>\n\n </example>\n\n </examples>\n\n "
},
"RegisterWorkflowType": {
"name": "RegisterWorkflowType",
"input": {
"shape_name": "RegisterWorkflowTypeInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which to register the workflow type.\n </p>\n ",
"required": true
},
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n </p>\n <note>\n The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered\n workflow types, use the <a>ListWorkflowTypes</a> action.\n </note>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true,
"cli_name": "workflow-version"
},
"description": {
"shape_name": "Description",
"type": "string",
"max_length": 1024,
"documentation": "\n <p>\n Textual description of the workflow type.\n </p>\n "
},
"defaultTaskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum duration of decision tasks for this workflow type. This\n default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or the\n <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
},
"defaultExecutionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the default maximum duration for executions of this workflow type. You can\n override this default when starting an execution through the <a>StartWorkflowExecution</a> Action or\n <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n\n <p>\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for <code>defaultExecutionStartToCloseTimeout</code>; there is a\n one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.\n </p>\n\n "
},
"defaultTaskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type.\n This default is used only if a task list is not provided when starting the execution\n through the <a>StartWorkflowExecution</a> Action or <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n </p>\n "
},
"defaultChildPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n This default can be overridden when starting a workflow execution using the <a>StartWorkflowExecution</a> action or\n the <code>StartChildWorkflowExecution</code> <a>Decision</a>.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "TypeAlreadyExistsFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned if the type\n already exists in the specified domain. You will get this fault even if the existing\n type is in deprecated status.\n You can specify another version if the intent is to create a new distinct version of the type.\n </p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
},
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Registers a new <i>workflow type</i> and its configuration settings in the specified domain.\n </p>\n <p>\n The retention period for the workflow history is set by the <a>RegisterDomain</a> action.\n </p>\n <important>\n If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned. You cannot change the configuration settings\n of a workflow type once it is registered and it must be registered as a new version.\n </important>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>defaultTaskList.name</code>: String constraint. The key is <code>swf:defaultTaskList.name</code>.</li>\n <li>\n<code>name</code>: String constraint. The key is <code>swf:name</code>.</li>\n <li>\n<code>version</code>: String constraint. The key is <code>swf:version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n<examples>\n\n <example>\n <name> RegisterWorkflowType Example </name>\n\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Fri, 13 Jan 2012 18:59:33 GMT\nX-Amz-Target: SimpleWorkflowService.RegisterWorkflowType\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=p5FUOoV3QXAafb7aK5z79Ztu5v0w9NeEqLu0ei+P9FA=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 300\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\",\n \"description\": \"Handle customer orders\",\n \"defaultTaskStartToCloseTimeout\": \"600\",\n \"defaultExecutionStartToCloseTimeout\": \"3600\",\n \"defaultTaskList\":\n {\"name\": \"mainTaskList\"},\n \"defaultChildPolicy\": \"TERMINATE\"}\n</request>\n\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: bb469e67-3e18-11e1-9914-a356b6ea8bdf\n</response>\n\n </example>\n </examples>\n"
},
"RequestCancelWorkflowExecution": {
"name": "RequestCancelWorkflowExecution",
"input": {
"shape_name": "RequestCancelWorkflowExecutionInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the workflow execution to cancel.\n </p>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId of the workflow execution to cancel.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The runId of the workflow execution to cancel.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running workflow execution\n identified by the given domain, workflowId, and runId. This logically requests the\n cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </p>\n <note>\n If the runId is not specified, the\n <code>WorkflowExecutionCancelRequested</code> event is recorded in the history of the current open workflow execution with the\n specified workflowId in the domain.\n </note>\n <note>\n Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of\n <a>TerminateWorkflowExecution</a> when possible.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RequestCancelWorkflowExecution Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:49:06 GMT\n X-Amz-Target: SimpleWorkflowService.RequestCancelWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=xODwV3kbpJbWVa6bQiV2zQAw9euGI3uXI82urc+bVeo=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 106\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 6bd0627e-3ffd-11e1-9b11-7182192d0b57\n </response>\n </example>\n </examples>\n "
},
"RespondActivityTaskCanceled": {
"name": "RespondActivityTaskCanceled",
"input": {
"shape_name": "RespondActivityTaskCanceledInput",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The <code>taskToken</code> of the <a>ActivityTask</a>.\n </p>\n <important>\n The <code>taskToken</code> is generated by the service and should be treated as an opaque value. If the task is passed to another process, its <code>taskToken</code> must also be passed. This enables it to provide its progress and respond with results.\n </important>\n\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional information about the cancellation.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code>\n was successfully canceled. Additional <code>details</code> can be optionally provided using the <code>details</code> argument.\n </p>\n <p>\n These <code>details</code> (if provided) appear in the <code>ActivityTaskCanceled</code> event added to\n the workflow history.\n </p>\n <important>\n Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns\n <code>true</code> and if the activity can be safely undone or abandoned.\n </important>\n\n <p>\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n <a>RespondActivityTaskCompleted</a>, RespondActivityTaskCanceled,\n <a>RespondActivityTaskFailed</a>, or the task has\n <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RespondActivityTaskCanceled Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:36:44 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCanceled\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=7ZMb0Np0OyXw6hrFSBFDAfBnSaEP1TH7cAG29DL5BUI=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 640\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQlFok8Ay875ki85gos/Okm9kWg1Jm6DbwiBZgxyCrW2OS+DQQtrCTMr+KH1ouxrCVOkTXPOUY/M4Ujfr1CrsMi6S0DMD8/N6yxzd34+PIIvRY8w9M5z89PbPQKjKHKbz2ocbTnHgRThaBO4ZmeadNyZWSeQyZXmsQFmFuHfaH9P2ibzrDS1dU+s/iw/R9RBrRWArsph/FIfWdRUJfu/FH9IFPSb3KYKMVaJAOyWhcR1KrRGywIGxPC7m9tQjapXqitoRYj42qgABydT4NVR5cLCkeYW0LKxUGVU46+gNvRaUfYzP31JVARQh5d0j7S/ERi10m6bamPJ3UcZfLFbM42mIINywmcTORMpQ/nPGLU1iECYrtnAV0YTlGZfGm+Vi6Gcgwyi4hEjg7TCBjc6WBw3JuAfFvUPU5cfvAoX7quUZRA7JUnYGObE0y9zYuTnCx6C1GL7Ks2MEA0coIiAl4JZx6qsGYfeKjIGntTsoCEe1zjp5gRqfeD74kfeZg0HmqA0xiFGZ40OHbImnF5YHsedYfLk6u09SAkQMD8iJhT8\",\n \"details\": \"customer canceled transaction\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: b1a001a6-3ffb-11e1-9b11-7182192d0b57\n </response>\n </example>\n </examples>\n "
},
"RespondActivityTaskCompleted": {
"name": "RespondActivityTaskCompleted",
"input": {
"shape_name": "RespondActivityTaskCompletedInput",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The <code>taskToken</code> of the <a>ActivityTask</a>.\n </p>\n <important>\n The <code>taskToken</code> is generated by the service and should be treated as an opaque value. If the task is passed to another process, its <code>taskToken</code> must also be passed. This enables it to provide its progress and respond with results.\n </important>\n\n ",
"required": true
},
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result of the activity task. It is a free form string that is implementation specific.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code>\n completed successfully with a <code>result</code> (if provided).\n The <code>result</code> appears in the <code>ActivityTaskCompleted</code> event in the workflow\n history.\n </p>\n\n <important>\n If the requested task does not complete successfully, use <a>RespondActivityTaskFailed</a> instead.\n If the worker finds that the task is canceled through the <code>canceled</code> flag returned by\n <a>RecordActivityTaskHeartbeat</a>, it should cancel the task, clean up and then call <a>RespondActivityTaskCanceled</a>.\n </important>\n\n <p>\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n RespondActivityTaskCompleted, <a>RespondActivityTaskCanceled</a>,\n <a>RespondActivityTaskFailed</a>, or the task has\n <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RespondActivityTaskCompleted Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 03:56:15 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=M+ygHbMHSHJiVrsAQTW/BfkgHoNzLPnPD+dVywJiPXE=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 638\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAX9p3pcp3857oLXFUuwdxRU5/zmn9f40XaMF7VohAH4jOtjXpZu7GdOzEi0b3cWYHbG5b5dpdcTXHUDPVMHXiUxCgr+Nc/wUW9016W4YxJGs/jmxzPln8qLftU+SW135Q0UuKp5XRGoRTJp3tbHn2pY1vC8gDB/K69J6q668U1pd4Cd9o43//lGgOIjN0/Ihg+DO+83HNcOuVEQMM28kNMXf7yePh31M4dMKJwQaQZG13huJXDwzJOoZQz+XFuqFly+lPnCE4XvsnhfAvTsh50EtNDEtQzPCFJoUeld9g64V/FS/39PHL3M93PBUuroPyHuCwHsNC6fZ7gM/XOKmW4kKnXPoQweEUkFV/J6E6+M1reBO7nJADTrLSnajg6MY/viWsEYmMw/DS5FlquFaDIhFkLhWUWN+V2KqiKS23GYwpzgZ7fgcWHQF2NLEY3zrjam4LW/UW5VLCyM3FpVD3erCTi9IvUgslPzyVGuWNAoTmgJEWvimgwiHxJMxxc9JBDR390iMmImxVl3eeSDUWx8reQltiviadPDjyRmVhYP8\",\n \"result\": \"customer credit card verified\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: 0976f0f4-3ff6-11e1-9a27-0760db01a4a8\n </response>\n </example>\n </examples>\n "
},
"RespondActivityTaskFailed": {
"name": "RespondActivityTaskFailed",
"input": {
"shape_name": "RespondActivityTaskFailedInput",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The <code>taskToken</code> of the <a>ActivityTask</a>.\n </p>\n <important>\n The <code>taskToken</code> is generated by the service and should be treated as an opaque value. If the task is passed to another process, its <code>taskToken</code> must also be passed. This enables it to provide its progress and respond with results.\n </important>\n\n ",
"required": true
},
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n Description of the error that may assist in diagnostics.\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional detailed information about the failure.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Used by workers to tell the service that the <a>ActivityTask</a> identified by the <code>taskToken</code>\n has failed with <code>reason</code> (if specified).\n The <code>reason</code> and <code>details</code> appear in the\n <code>ActivityTaskFailed</code> event added to the workflow history.\n </p>\n\n <p>\n A task is considered open from the time that it is scheduled until it is\n closed. Therefore a task is reported as open while a worker is\n processing it. A task is closed after it has been specified in a call to\n <a>RespondActivityTaskCompleted</a>, <a>RespondActivityTaskCanceled</a>,\n RespondActivityTaskFailed, or the task has\n <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types\">timed out</a>.\n </p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RespondActivityTaskFailed Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Mon, 16 Jan 2012 04:17:24 GMT\n X-Amz-Target: SimpleWorkflowService.RespondActivityTaskFailed\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JC+/uds/mFEq8qca2WFs5kfp2eAEONc70IqFgHErhpc=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 682\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAdG7j7YFEl9pfKdXRL3Cy3Q3c1Z8QwdOSX53bKiUV6MMGXvf3Lrinmmzj1HFFl5lcwHzEFxLbMaSZ/lMt/RFJPumHXAnUqlYjZLODhrBqsIzDQFKcbCFMq7y4jm0EFzsV2Suv8iu/obcZ/idU8qjd9uG/82zumG2xz1Z4IbOFwOTlpj2++5YVH4ftyycIcjlDw58r0O1vAo4PEondkqjyn+YxBxyZLy1z1fvMi0zeO8Lh16w96y6v+KdVc/ECoez1Og8sROaXG0l8ptW5YR733LIuUBK4sxWa12egF5i4e8AV8JloojOaq0jy4iFsIscRazOSQErjo15Guz89BK2XW911P3I+X7nJjH0wwW55XGCs0jezvsEC8M6D9Ob7CgWr6RrnK3g1AKemcby2XqgQRN52DMIYxzV+lMS/QBYKOqtkLoMY0NKeuRVwm9f1zCY00v6kxqK9m2zFvaxqlJ5/JVCWMNWEWJfQZVtC3GzMWmzeCt7Auq8A5/Caq/DKyOhTIhY/Go00iiDA6ecP8taTYiVzb8VR5xEiQ1uCxnECkwW\",\n \"reason\": \"could not verify customer credit card\",\n \"details\": \"card number invalid\"}\n </request>\n\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feadaedd-3ff8-11e1-9e8f-57bb03e21482\n </response>\n </example>\n </examples>\n "
},
"RespondDecisionTaskCompleted": {
"name": "RespondDecisionTaskCompleted",
"input": {
"shape_name": "RespondDecisionTaskCompletedInput",
"type": "structure",
"members": {
"taskToken": {
"shape_name": "TaskToken",
"type": "string",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The <code>taskToken</code> from the <a>DecisionTask</a>.\n </p>\n <important>\n The <code>taskToken</code> is generated by the service and should be treated as an opaque value. If the task is passed to another process, its <code>taskToken</code> must also be passed. This enables it to provide its progress and respond with results.\n </important>\n\n ",
"required": true
},
"decisions": {
"shape_name": "DecisionList",
"type": "list",
"members": {
"shape_name": "Decision",
"type": "structure",
"members": {
"decisionType": {
"shape_name": "DecisionType",
"type": "string",
"enum": [
"ScheduleActivityTask",
"RequestCancelActivityTask",
"CompleteWorkflowExecution",
"FailWorkflowExecution",
"CancelWorkflowExecution",
"ContinueAsNewWorkflowExecution",
"RecordMarker",
"StartTimer",
"CancelTimer",
"SignalExternalWorkflowExecution",
"RequestCancelExternalWorkflowExecution",
"StartChildWorkflowExecution"
],
"documentation": "\n <p>\n Specifies the type of the decision.\n </p>\n ",
"required": true
},
"scheduleActivityTaskDecisionAttributes": {
"shape_name": "ScheduleActivityTaskDecisionAttributes",
"type": "structure",
"members": {
"activityType": {
"shape_name": "ActivityType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of this activity.\n <note>The combination of activity type name and version must be unique within a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of this activity.\n <note>The combination of activity type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the activity task to schedule.\n This field is required.\n </p>\n ",
"required": true
},
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>activityId</code> of the activity task.\n This field is required.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the activity.\n </p>\n "
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the activity task.\n </p>\n "
},
"scheduleToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The maximum duration for this activity task.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n If set, specifies the name of the task list in which to schedule the activity task. If not specified, the <code>defaultTaskList</code>\n registered with the activity type will be used.\n </p>\n <note>A task list for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default task list was specified at registration time then a fault will be returned.</note>\n\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n "
},
"scheduleToStartTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This\n overrides the default schedule-to-start timeout specified when registering the activity type using <a>RegisterActivityType</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.</note>\n\n "
},
"startToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the maximum duration a worker may take to process this activity task. This\n overrides the default start-to-close timeout specified when registering the activity type using <a>RegisterActivityType</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field.\n If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"heartbeatTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the maximum time before which a worker processing a task of this type must report progress by\n calling <a>RecordActivityTaskHeartbeat</a>. If the timeout is exceeded, the activity task is automatically timed out.\n If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored.\n This overrides the default heartbeat timeout specified when registering the activity type using <a>RegisterActivityType</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>ScheduleActivityTask</code> decision. It is not set for other decision types.\n </p>\n "
},
"requestCancelActivityTaskDecisionAttributes": {
"shape_name": "RequestCancelActivityTaskDecisionAttributes",
"type": "structure",
"members": {
"activityId": {
"shape_name": "ActivityId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>activityId</code> of the activity task to be canceled.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Provides details of the <code>RequestCancelActivityTask</code> decision. It is not set for other decision types.\n </p>\n "
},
"completeWorkflowExecutionDecisionAttributes": {
"shape_name": "CompleteWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"result": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The result of the workflow execution. The form of the result is implementation defined.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>CompleteWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"failWorkflowExecutionDecisionAttributes": {
"shape_name": "FailWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"reason": {
"shape_name": "FailureReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n A descriptive reason for the failure that may help in diagnostics.\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional details of the failure.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>FailWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"cancelWorkflowExecutionDecisionAttributes": {
"shape_name": "CancelWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional details of the cancellation.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>CancelWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"continueAsNewWorkflowExecutionDecisionAttributes": {
"shape_name": "ContinueAsNewWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input provided to the new workflow execution.\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n If set, specifies the total duration for this workflow execution. This overrides\n the <code>defaultExecutionStartToCloseTimeout</code> specified when registering the workflow type.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field.\n If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Represents a task list.\n </p>\n "
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n Specifies the maximum duration of decision tasks for the new workflow execution.\n This parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n The supported child policies are:</p>\n\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n <note>A child policy for the new workflow execution must be specified either as a default registered for its workflow type\n or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n </note>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags to associate with the new workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a>\n or <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>.\n </p>\n "
},
"workflowTypeVersion": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": null
}
},
"documentation": "\n <p>\n Provides details of the <code>ContinueAsNewWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"recordMarkerDecisionAttributes": {
"shape_name": "RecordMarkerDecisionAttributes",
"type": "structure",
"members": {
"markerName": {
"shape_name": "MarkerName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the marker.\n This file is required.\n </p>\n ",
"required": true
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional details of the marker.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>RecordMarker</code> decision. It is not set for other decision types.\n </p>\n "
},
"startTimerDecisionAttributes": {
"shape_name": "StartTimerDecisionAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer.\n This field is required.</p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
},
"startToFireTimeout": {
"shape_name": "DurationInSeconds",
"type": "string",
"min_length": 1,
"max_length": 8,
"documentation": "\n <p>\n The duration to wait before firing the timer.\n This field is required.\n </p>\n <p>The duration is specified in seconds. The valid values are integers greater than or equal to 0.</p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Provides details of the <code>StartTimer</code> decision. It is not set for other decision types.\n </p>\n "
},
"cancelTimerDecisionAttributes": {
"shape_name": "CancelTimerDecisionAttributes",
"type": "structure",
"members": {
"timerId": {
"shape_name": "TimerId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The unique Id of the timer to cancel. This field is required.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n Provides details of the <code>CancelTimer</code> decision. It is not set for other decision types.\n </p>\n "
},
"signalExternalWorkflowExecutionDecisionAttributes": {
"shape_name": "SignalExternalWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the workflow execution to be signaled.\n This field is required.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the workflow execution to be signaled.\n </p>\n "
},
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal.The target workflow execution will use the signal name and\n input to process the signal.\n This field is required.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional input to be provided with the signal.The target workflow execution will use the signal name and\n input to process the signal.\n </p>\n "
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent decision\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>SignalExternalWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"requestCancelExternalWorkflowExecutionDecisionAttributes": {
"shape_name": "RequestCancelExternalWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the external workflow execution to cancel.\n This field is required.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of the external workflow execution to cancel.\n </p>\n "
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>RequestCancelExternalWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
},
"startChildWorkflowExecutionDecisionAttributes": {
"shape_name": "StartChildWorkflowExecutionDecisionAttributes",
"type": "structure",
"members": {
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow execution to be started.\n This field is required.\n </p>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The <code>workflowId</code> of the workflow execution.\n This field is required.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"control": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional data attached to the event that can be used by the decider in subsequent workflow\n tasks. This data is not sent to the child workflow execution.\n </p>\n "
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input to be provided to the workflow execution.\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The name of the task list to be used for decision tasks of the child workflow execution.\n </p>\n <note>A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.</note>\n\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n "
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n </p>\n <p>The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.</p>\n <note>A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n <note>A child policy for the workflow execution being started must be specified either as a default registered for its workflow type\n or through this field. If neither this field is set nor a default child policy was specified at registration time then a fault will be returned.\n </note>\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags to associate with the child workflow execution. A maximum\n of 5 tags can be specified. You can list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a>\n or <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>.\n </p>\n "
}
},
"documentation": "\n <p>\n Provides details of the <code>StartChildWorkflowExecution</code> decision. It is not set for other decision types.\n </p>\n "
}
},
"documentation": "\n <p>\n Specifies a decision made by the decider. A decision can be one of these types:\n </p>\n <ul>\n <li>\n<b>CancelTimer</b> cancels a previously started timer and records a <code>TimerCanceled</code> event in the history.</li>\n <li>\n<b>CancelWorkflowExecution</b> closes the workflow execution and records a <code>WorkflowExecutionCanceled</code> event in the history.</li>\n <li>\n<b>CompleteWorkflowExecution</b> closes the workflow execution and records a <code>WorkflowExecutionCompleted</code> event in the history .</li>\n <li>\n<b>ContinueAsNewWorkflowExecution</b> closes the workflow execution and starts a new workflow execution of the same type using the same\n workflow id and a unique run Id. A <code>WorkflowExecutionContinuedAsNew</code> event is recorded in the history.</li>\n <li>\n<b>FailWorkflowExecution</b> closes the workflow execution and records a <code>WorkflowExecutionFailed</code> event in the history.</li>\n <li>\n<b>RecordMarker</b> records a <code>MarkerRecorded</code> event in the history. Markers can be used for adding\n custom information in the history for instance to let deciders know that they do not need to look at the history beyond\n the marker event.</li>\n <li>\n<b>RequestCancelActivityTask</b> attempts to cancel a previously scheduled activity task. If the activity task was scheduled\n but has not been assigned to a worker, then it will be canceled. If the activity task was already assigned to a worker, then\n the worker will be informed that cancellation has been requested in the response to <a>RecordActivityTaskHeartbeat</a>.</li>\n <li>\n<b>RequestCancelExternalWorkflowExecution</b> requests that a request be made to cancel the specified external workflow execution\n and records a <code>RequestCancelExternalWorkflowExecutionInitiated</code> event in the history.</li>\n <li>\n<b>ScheduleActivityTask</b> schedules an activity task.</li>\n <li>\n<b>SignalExternalWorkflowExecution</b> requests a signal to be delivered to the specified external workflow execution\n and records a <code>SignalExternalWorkflowExecutionInitiated</code> event in the history.</li>\n <li>\n<b>StartChildWorkflowExecution</b> requests that a child workflow execution be started\n and records a <code>StartChildWorkflowExecutionInitiated</code> event in the history. The child workflow execution is a separate workflow execution\n with its own history.</li>\n <li>\n<b>StartTimer</b> starts a timer for this workflow execution and records a <code>TimerStarted</code> event in the history.\n This timer will fire after the specified delay and record a <code>TimerFired</code> event.</li>\n </ul>\n\n <p><b>Access Control</b></p>\n <p>If you grant permission to use <code>RespondDecisionTaskCompleted</code>, you can use IAM policies to express permissions for the list of decisions\n returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps\n keep policies readable. For details and example IAM policies, see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <p><b>Decision Failure</b></p>\n <p>Decisions can fail for several reasons</p>\n <ul>\n <li>The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow\n execution and will therefore fail.</li>\n <li>A limit on your account was reached.</li>\n <li>The decision lacks sufficient permissions.</li>\n </ul>\n <p>One of the following events might be added to the history to indicate an error. The event attribute's <b>cause</b> parameter indicates the cause.\n If <b>cause</b> is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked\n sufficient permissions.\n </p>\n\n <ul>\n <li>\n<b>ScheduleActivityTaskFailed</b> a ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision\n is not registered, is in a deprecated state, or the decision is not properly configured.</li>\n\n <li>\n<b>RequestCancelActivityTaskFailed</b> a RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.</li>\n\n <li>\n<b>StartTimerFailed</b> a StartTimer decision failed. This could happen if there is another open timer with the same timerId.</li>\n\n <li>\n<b>CancelTimerFailed</b> a CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.</li>\n\n <li>\n<b>StartChildWorkflowExecutionFailed</b> a StartChildWorkflowExecution decision failed. This could happen if the workflow type specified is not registered, is deprecated, or the decision is not properly configured.</li>\n\n <li>\n <b>SignalExternalWorkflowExecutionFailed</b>\n a SignalExternalWorkflowExecution decision failed. This could happen if the <code>workflowID</code> specified in the decision was incorrect.\n </li>\n\n <li>\n <b>RequestCancelExternalWorkflowExecutionFailed</b>\n a RequestCancelExternalWorkflowExecution decision failed. This could happen if the <code>workflowID</code> specified in the decision was incorrect.\n </li>\n\n <li>\n <b>CancelWorkflowExecutionFailed</b>\n a CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.\n </li>\n\n <li>\n <b>CompleteWorkflowExecutionFailed</b>\n a CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.\n </li>\n\n <li>\n <b>ContinueAsNewWorkflowExecutionFailed</b>\n a ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.\n </li>\n\n <li>\n <b>FailWorkflowExecutionFailed</b>\n a FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.\n </li>\n </ul>\n\n <p>\n The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.\n </p>\n\n <note>\n A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task:\n <code>CompleteWorkflowExecution</code>, <code>FailWorkflowExecution</code>, <code>CancelWorkflowExecution</code>\n and <code>ContinueAsNewWorkflowExecution</code>.\n An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal\n or activity event had been added to the history while the decision task was being performed by the decider.\n Unlike the above situations which are\n logic issues, this fault is always possible because of race conditions in a distributed system. The right\n action here is to call <a>RespondDecisionTaskCompleted</a> without any decisions. This would result in\n another decision task with these new events included in the history. The decider should handle the new events and\n may decide to close the workflow execution.\n </note>\n\n <p><b>How to Code a Decision</b></p>\n <p>\n You code a decision by first setting the\n decision type field to one of the above decision values, and then set the corresponding attributes field\n shown below:\n </p>\n <ul>\n <li><a>ScheduleActivityTaskDecisionAttributes</a></li>\n <li><a>RequestCancelActivityTaskDecisionAttributes</a></li>\n <li><a>CompleteWorkflowExecutionDecisionAttributes</a></li>\n <li><a>FailWorkflowExecutionDecisionAttributes</a></li>\n <li><a>CancelWorkflowExecutionDecisionAttributes</a></li>\n <li><a>ContinueAsNewWorkflowExecutionDecisionAttributes</a></li>\n <li><a>RecordMarkerDecisionAttributes</a></li>\n <li><a>StartTimerDecisionAttributes</a></li>\n <li><a>CancelTimerDecisionAttributes</a></li>\n <li><a>SignalExternalWorkflowExecutionDecisionAttributes</a></li>\n <li><a>RequestCancelExternalWorkflowExecutionDecisionAttributes</a></li>\n <li><a>StartChildWorkflowExecutionDecisionAttributes</a></li>\n </ul>\n\n "
},
"documentation": "\n <p>\n The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs\n for the <a>Decision</a> structure for details.\n </p>\n "
},
"executionContext": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n User defined context to add to workflow execution.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Used by deciders to tell the service that the <a>DecisionTask</a> identified by the <code>taskToken</code>\n has successfully completed. The <code>decisions</code> argument specifies the list of decisions made while\n processing the task.\n </p>\n <p>\n A <code>DecisionTaskCompleted</code> event is added to the workflow history. The <code>executionContext</code> specified is\n attached to the event in the workflow execution history.\n </p>\n\n <p><b>Access Control</b></p>\n <p>If an IAM policy grants permission to use <code>RespondDecisionTaskCompleted</code>, it can express permissions for the\n list of decisions in the <code>decisions</code> parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies\n to be as readable as possible, you can express permissions on decisions as if they were actual API\n calls, including applying conditions to some parameters. For more information,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> RespondDecisionTaskCompleted Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 23:31:06 GMT\n X-Amz-Target: SimpleWorkflowService.RespondDecisionTaskCompleted\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=FL4ouCb8n6j5egcKOXoa+5Vctc8WmA91B2ekKnks2J8=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 1184\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"taskToken\": \"AAAAKgAAAAEAAAAAAAAAAQLPoqDSLcx4ksNCEQZCyEBqpKhE+FgFSOvHd9zlCROacKYHh640MkANx2y9YM3CQnec0kEb1oRvB6DxKesTY3U/UQhvBqPY7E4BYE6hkDj/NmSbt9EwEJ/a+WD+oc2sDNfeVz2x+6wjb5vQdFKwBoQ6MDWLFbAhcgK+ymoRjoBHrPsrNLX3IA6sQaPmQRZQs3FRZonoVzP6uXMCZPnCZQULFjU1kTM8VHzH7ywqWKVmmdvnqyREOCT9VqmYbhLntJXsDj+scAvuNy17MCX9M9AJ7V/5qrLCeYdWA4FBQgY4Ew6IC+dge/UZdVMmpW/uB7nvSk6owQIhapPh5pEUwwY/yNnoVLTiPOz9KzZlANyw7uDchBRLvUJORFtpP9ZQIouNP8QOvFWm7Idc50ahwGEdTCiG+KDXV8kAzx7wKHs7l1TXYkC15x0h3XPH0MdLeEjipv98EpZaMIVtgGSdRjluOjNWEL2zowZByitleI5bdvxZdgalAXXKEnbYE6/rfLGReAJKdh2n0dmTMI+tK7uuxIWX6F4ocqSI1Xb2x5zZ\",\n \"decisions\":\n [\n {\"decisionType\": \"ScheduleActivityTask\",\n \"scheduleActivityTaskDecisionAttributes\":\n {\"activityType\":\n {\"name\": \"activityVerify\",\n \"version\": \"1.0\"},\n \"activityId\": \"verification-27\",\n \"control\": \"digital music\",\n \"input\": \"5634-0056-4367-0923,12/12,437\",\n \"scheduleToCloseTimeout\": \"900\",\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"scheduleToStartTimeout\": \"300\",\n \"startToCloseTimeout\": \"600\",\n \"heartbeatTimeout\": \"120\"}\n }\n ],\n \"executionContext\": \"Black Friday\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: feef79b5-3fd0-11e1-9a27-0760db01a4a8\n </response>\n </example>\n </examples>\n "
},
"SignalWorkflowExecution": {
"name": "SignalWorkflowExecution",
"input": {
"shape_name": "SignalWorkflowExecutionInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain containing the workflow execution to signal.\n </p>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId of the workflow execution to signal.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The runId of the workflow execution to signal.\n </p>\n "
},
"signalName": {
"shape_name": "SignalName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the signal. This name must be meaningful to the target workflow.\n </p>\n ",
"required": true
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Data to attach to the <code>WorkflowExecutionSignaled</code> event in the target workflow execution's history.\n </p>\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Records a <code>WorkflowExecutionSignaled</code> event in the workflow execution history and creates\n a decision task for the workflow execution\n identified by the given domain, workflowId and runId. The event is recorded with the\n specified user defined signalName and input (if provided).\n </p>\n <note>\n If a runId is not specified, then the <code>WorkflowExecutionSignaled</code>\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n </note>\n <note>\n If the specified workflow execution is not open, this method fails\n with <code>UnknownResource</code>.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n <examples>\n <example>\n <name> SignalWorkflowExecution Example </name>\n <request>\n POST / HTTP/1.1\n Host: swf.us-east-1.amazonaws.com\n User-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\n Accept: application/json, text/javascript, */*\n Accept-Language: en-us,en;q=0.5\n Accept-Encoding: gzip,deflate\n Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\n Keep-Alive: 115\n Connection: keep-alive\n Content-Type: application/x-amz-json-1.0\n X-Requested-With: XMLHttpRequest\n X-Amz-Date: Sun, 15 Jan 2012 00:06:18 GMT\n X-Amz-Target: SimpleWorkflowService.SignalWorkflowExecution\n Content-Encoding: amz-1.0\n X-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=lQpBZezK7JNQrXeWuJE+l7S0ZwjOEONCeRyImoyfX+E=\n Referer: http://swf.us-east-1.amazonaws.com/explorer/index.html\n Content-Length: 162\n Pragma: no-cache\n Cache-Control: no-cache\n\n {\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"f5ebbac6-941c-4342-ad69-dfd2f8be6689\",\n \"signalName\": \"CancelOrder\",\n \"input\": \"order 3553\"}\n </request>\n <response>\n HTTP/1.1 200 OK\n Content-Length: 0\n Content-Type: application/json\n x-amzn-RequestId: bf78ae15-3f0c-11e1-9914-a356b6ea8bdf\n </response>\n </example>\n </examples>\n "
},
"StartWorkflowExecution": {
"name": "StartWorkflowExecution",
"input": {
"shape_name": "StartWorkflowExecutionInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the domain in which the workflow execution is created.\n </p>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The user defined identifier associated with the workflow execution. You can use this to\n associate a custom identifier with the workflow execution. You may specify the same\n identifier if a workflow execution is logically a <i>restart</i> of a previous execution.\n You cannot have two open workflow executions with the same <code>workflowId</code> at the same time.\n </p>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n ",
"required": true
},
"workflowType": {
"shape_name": "WorkflowType",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
},
"version": {
"shape_name": "Version",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The version of the workflow type.\n This field is required.\n <note>The combination of workflow type name and version must be unique with in a domain.</note>\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The type of the workflow to start.\n </p>\n ",
"required": true
},
"taskList": {
"shape_name": "TaskList",
"type": "structure",
"members": {
"name": {
"shape_name": "Name",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The name of the task list.\n </p>\n ",
"required": true
}
},
"documentation": "\n <p>\n The task list to use for the decision tasks generated for this workflow execution.\n This overrides the <code>defaultTaskList</code> specified when registering the workflow type.\n </p>\n <note>A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.</note>\n <p>The specified string must not start or end with whitespace. It must not contain a <code>:</code> (colon), <code>/</code> (slash), <code>|</code> (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f - \\u009f). Also, it must not contain the literal string "arn".</p>\n "
},
"input": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting.\n This <code>input</code> is made available to the new workflow execution in the <code>WorkflowExecutionStarted</code> history event.\n </p>\n "
},
"executionStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n\n <p>\n The total duration for this workflow execution. This overrides\n the defaultExecutionStartToCloseTimeout specified when registering the workflow type.\n </p>\n\n <p>\n The duration is specified in seconds. The valid values are integers greater than or equal to 0.\n Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot\n specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.\n </p>\n\n <note>\n An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered.\n If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.\n </note>\n\n "
},
"tagList": {
"shape_name": "TagList",
"type": "list",
"members": {
"shape_name": "Tag",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": null
},
"max_length": 5,
"documentation": "\n <p>\n The list of tags to associate with the workflow execution. You can specify a maximum\n of 5 tags. You can list workflow executions with a specific tag by calling <a>ListOpenWorkflowExecutions</a> or\n <a>ListClosedWorkflowExecutions</a> and specifying a <a>TagFilter</a>.\n </p>\n "
},
"taskStartToCloseTimeout": {
"shape_name": "DurationInSecondsOptional",
"type": "string",
"max_length": 8,
"documentation": "\n <p>\n Specifies the maximum duration of decision tasks for this workflow execution.\n This parameter overrides the <code>defaultTaskStartToCloseTimout</code> specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n </p>\n\n <p>\n The valid values are integers greater than or equal to <code>0</code>. An integer value can be used to specify the duration in seconds while <code>NONE</code> can be used to specify unlimited duration.\n </p>\n\n <note>A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.</note>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated,\n by calling the <a>TerminateWorkflowExecution</a> action explicitly or due to an expired timeout.\n This policy overrides the default child policy specified when registering the workflow type using <a>RegisterWorkflowType</a>.\n The supported child policies are:</p>\n\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.</note>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "Run",
"type": "structure",
"members": {
"runId": {
"shape_name": "RunId",
"type": "string",
"min_length": 1,
"max_length": 64,
"documentation": "\n <p>\n The <code>runId</code> of a workflow execution. This Id is generated by the service and can be used to uniquely identify\n the workflow execution within a domain.\n </p>\n "
}
},
"documentation": "\n <p>\n Specifies the <code>runId</code> of a workflow execution.\n </p>\n "
},
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "TypeDeprecatedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the specified activity or workflow type was already deprecated.\n </p>\n "
},
{
"shape_name": "WorkflowExecutionAlreadyStartedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by <a>StartWorkflowExecution</a> when an open execution with the same\n workflowId is already running in the specified domain.\n </p>\n "
},
{
"shape_name": "LimitExceededFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned by any operation if a system imposed limitation has been reached.\n To address this fault you should either clean up unused resources or increase the\n limit by contacting AWS.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
},
{
"shape_name": "DefaultUndefinedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": null
}
},
"documentation": null
}
],
"documentation": "\n <p>\n Starts an execution of the workflow type in the specified domain using the provided <code>workflowId</code>\n and input data.\n </p>\n <p>This action returns the newly started workflow execution.</p>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>Constrain the following parameters by using a <code>Condition</code> element with the appropriate keys.\n <ul>\n <li>\n<code>tagList.member.0</code>: The key is <code>swf:tagList.member.0</code>.</li>\n <li>\n<code>tagList.member.1</code>: The key is <code>swf:tagList.member.1</code>.</li>\n <li>\n<code>tagList.member.2</code>: The key is <code>swf:tagList.member.2</code>.</li>\n <li>\n<code>tagList.member.3</code>: The key is <code>swf:tagList.member.3</code>.</li>\n <li>\n<code>tagList.member.4</code>: The key is <code>swf:tagList.member.4</code>.</li>\n <li>\n<code>taskList</code>: String constraint. The key is <code>swf:taskList.name</code>.</li>\n <li>\n<code>name</code>: String constraint. The key is <code>swf:workflowType.name</code>.</li>\n <li>\n<code>version</code>: String constraint. The key is <code>swf:workflowType.version</code>.</li>\n </ul>\n</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n<examples>\n <example>\n <name> StartWorkflowExecution Example </name>\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Sat, 14 Jan 2012 22:45:13 GMT\nX-Amz-Target: SimpleWorkflowService.StartWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=aYxuqLX+TO91kPVg+jh+aA8PWxQazQRN2+SZUGdOgU0=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 417\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"workflowType\":\n {\"name\": \"customerOrderWorkflow\",\n \"version\": \"1.0\"},\n \"taskList\":\n {\"name\": \"specialTaskList\"},\n \"input\": \"arbitrary-string-that-is-meaningful-to-the-workflow\",\n \"executionStartToCloseTimeout\": \"1800\",\n \"tagList\":\n [\"music purchase\", \"digital\", \"ricoh-the-dog\"],\n \"taskStartToCloseTimeout\": \"600\",\n \"childPolicy\": \"TERMINATE\"}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 48\nContent-Type: application/json\nx-amzn-RequestId: 6c25f6e6-3f01-11e1-9a27-0760db01a4a8\n\n{\"runId\":\"1e536162-f1ea-48b0-85f3-aade88eef2f7\"}\n</response>\n </example>\n </examples>\n "
},
"TerminateWorkflowExecution": {
"name": "TerminateWorkflowExecution",
"input": {
"shape_name": "TerminateWorkflowExecutionInput",
"type": "structure",
"members": {
"domain": {
"shape_name": "DomainName",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The domain of the workflow execution to terminate.\n </p>\n ",
"required": true
},
"workflowId": {
"shape_name": "WorkflowId",
"type": "string",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>\n The workflowId of the workflow execution to terminate.\n </p>\n ",
"required": true
},
"runId": {
"shape_name": "RunIdOptional",
"type": "string",
"max_length": 64,
"documentation": "\n <p>\n The runId of the workflow execution to terminate.\n </p>\n "
},
"reason": {
"shape_name": "TerminateReason",
"type": "string",
"max_length": 256,
"documentation": "\n <p>\n An optional descriptive reason for terminating the workflow execution.\n </p>\n "
},
"details": {
"shape_name": "Data",
"type": "string",
"max_length": 32768,
"documentation": "\n <p>\n Optional details for terminating the workflow execution.\n </p>\n "
},
"childPolicy": {
"shape_name": "ChildPolicy",
"type": "string",
"enum": [
"TERMINATE",
"REQUEST_CANCEL",
"ABANDON"
],
"documentation": "\n <p>\n If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.\n This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.\n The supported child policies are:</p>\n <ul>\n <li>\n<b>TERMINATE:</b> the child executions will be terminated.</li>\n <li>\n<b>REQUEST_CANCEL:</b> a request to cancel will be attempted for each child execution by recording a\n <code>WorkflowExecutionCancelRequested</code> event in its history. It is up to the decider to take appropriate actions when it\n receives an execution history with this event.\n </li>\n <li>\n<b>ABANDON:</b> no action will be taken. The child executions will continue to run.</li>\n </ul>\n <note>A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter.\n If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.</note>\n\n "
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "UnknownResourceFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>\n Returned when the named resource cannot be found with in the scope of this operation (region or domain).\n This could happen if the named resource was never created or is no longer available for this operation.\n </p>\n "
},
{
"shape_name": "OperationNotPermittedFault",
"type": "structure",
"members": {
"message": {
"shape_name": "ErrorMessage",
"type": "string",
"documentation": "\n <p>\n A description that may help with diagnosing the cause of the fault.\n </p>\n "
}
},
"documentation": "\n <p>Returned when the caller does not have sufficient permissions to invoke the action.</p>\n "
}
],
"documentation": "\n <p>\n Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the\n workflow execution identified by the given domain, runId, and workflowId.\n The child policy, registered with the workflow type or specified when starting this execution,\n is applied to any open child workflow executions of this\n workflow execution.\n </p>\n <important>\n If the identified workflow execution was in progress, it is terminated immediately.\n </important>\n <note>\n If a runId is not specified, then the <code>WorkflowExecutionTerminated</code>\n event is recorded in the history of the current open workflow with the matching workflowId in the domain.\n </note>\n <note>\n You should consider using <a>RequestCancelWorkflowExecution</a> action instead because it allows the workflow to gracefully close while\n <a>TerminateWorkflowExecution</a> does not.\n </note>\n\n <p><b>Access Control</b></p>\n <p>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</p>\n <ul>\n <li>Use a <code>Resource</code> element with the domain name to limit the action to only specified domains.</li>\n <li>Use an <code>Action</code> element to allow or deny permission to call this action.</li>\n <li>You cannot use an IAM policy to constrain this action's parameters.</li>\n </ul>\n <p>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>. For details and example IAM policies,\n see <a href=\"http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html\">Using IAM to Manage Access to Amazon SWF Workflows</a>.</p>\n\n<examples>\n <example>\n <name> TerminateWorkflowExecution Example </name>\n<request>\nPOST / HTTP/1.1\nHost: swf.us-east-1.amazonaws.com\nUser-Agent: Mozilla/5.0 (Windows; U; Windows NT 6.1; en-US; rv:1.9.2.25) Gecko/20111212 Firefox/3.6.25 ( .NET CLR 3.5.30729; .NET4.0E)\nAccept: application/json, text/javascript, */*\nAccept-Language: en-us,en;q=0.5\nAccept-Encoding: gzip,deflate\nAccept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\nKeep-Alive: 115\nConnection: keep-alive\nContent-Type: application/x-amz-json-1.0\nX-Requested-With: XMLHttpRequest\nX-Amz-Date: Mon, 16 Jan 2012 04:56:34 GMT\nX-Amz-Target: SimpleWorkflowService.TerminateWorkflowExecution\nContent-Encoding: amz-1.0\nX-Amzn-Authorization: AWS3 AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE,Algorithm=HmacSHA256,SignedHeaders=Host;X-Amz-Date;X-Amz-Target;Content-Encoding,Signature=JHMRAjN6JGPawEuhiANHfiCil9KOGfDF/cuXYmuu9S4=\nReferer: http://swf.us-east-1.amazonaws.com/explorer/index.html\nContent-Length: 218\nPragma: no-cache\nCache-Control: no-cache\n\n{\"domain\": \"867530901\",\n \"workflowId\": \"20110927-T-1\",\n \"runId\": \"94861fda-a714-4126-95d7-55ba847da8ab\",\n \"reason\": \"transaction canceled\",\n \"details\": \"customer credit card declined\",\n \"childPolicy\": \"TERMINATE\"}\n</request>\n\n<response>\nHTTP/1.1 200 OK\nContent-Length: 0\nContent-Type: application/json\nx-amzn-RequestId: 76d68a47-3ffe-11e1-b118-3bfa5e8e7fc3\n</response>\n </example>\n </examples>\n "
}
},
"metadata": {
"regions": {
"us-east-1": null,
"ap-northeast-1": null,
"sa-east-1": null,
"ap-southeast-1": null,
"ap-southeast-2": null,
"us-west-2": null,
"us-west-1": null,
"eu-west-1": null,
"us-gov-west-1": null,
"cn-north-1": "https://swf.cn-north-1.amazonaws.com.cn"
},
"protocols": [
"https"
]
},
"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
}
}
},
"throttling": {
"applies_when": {
"response": {
"service_error_code": "Throttling",
"http_status_code": 400
}
}
}
}
}
}
}
|