/usr/lib/python3/dist-packages/botocore/data/aws/datapipeline/2012-10-29.json is in python3-botocore 0.62.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 | {
"api_version": "2012-10-29",
"type": "json",
"json_version": 1.1,
"target_prefix": "DataPipeline",
"signature_version": "v4",
"service_full_name": "AWS Data Pipeline",
"endpoint_prefix": "datapipeline",
"xmlnamespace": "http://datapipeline.amazonaws.com/doc/2012-10-29/",
"documentation": "\n <p> \n This is the <i>AWS Data Pipeline API Reference</i>. This guide provides descriptions and\n samples of the AWS Data Pipeline API.\n </p>\n \n <p>\n AWS Data Pipeline is a web service that configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so your application can focus on processing the data.</p>\n \n <p>\n The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.\n </p>\n \n <p>\n The second set of actions are used by a task runner application that calls the AWS Data Pipeline API to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.\n </p>\n \n <p>\n AWS Data Pipeline provides an open-source implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.\n </p>\n \n \n <p>\n The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see \n <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.\n </p>\n \n ",
"operations": {
"ActivatePipeline": {
"name": "ActivatePipeline",
"input": {
"shape_name": "ActivatePipelineInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the pipeline to activate. </p>\n ",
"required": true
}
},
"documentation": "\n <p>The input of the ActivatePipeline action.</p>\n "
},
"output": {
"shape_name": "ActivatePipelineOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>Contains the output from the <a>ActivatePipeline</a> action.</p>\n "
},
"errors": [
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
},
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>\n Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.\n </p>\n <p>\n Call this action to start processing pipeline tasks of a pipeline you've created using the <a>CreatePipeline</a> and <a>PutPipelineDefinition</a> actions. A pipeline cannot be modified after it has been successfully activated. \n </p>\n <examples>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ActivatePipeline\nContent-Length: 39\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 2\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n </response>\n </examples>\n "
},
"CreatePipeline": {
"name": "CreatePipeline",
"input": {
"shape_name": "CreatePipelineInput",
"type": "structure",
"members": {
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.\n </p> \n ",
"required": true
},
"uniqueId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>\n A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to <a>CreatePipeline</a>. For example, if the first call to <a>CreatePipeline</a> does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <a>CreatePipeline</a>. <a>CreatePipeline</a> ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.\n </p>\n ",
"required": true
},
"description": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>The description of the new pipeline.</p> \n "
}
},
"documentation": "\n <p>The input for the <a>CreatePipeline</a> action.</p> \n "
},
"output": {
"shape_name": "CreatePipelineOutput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the <a>CreatePipeline</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>Creates a new empty pipeline. When this action succeeds, you can then use the <a>PutPipelineDefinition</a> action to populate the pipeline.</p> \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.CreatePipeline\nContent-Length: 91\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"name\": \"myPipeline\",\n \"uniqueId\": \"123456789\",\n \"description\": \"This is my first pipeline\"}\n \n </request>\n \n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 40\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n \n </response>\n </examples>\n \n "
},
"DeletePipeline": {
"name": "DeletePipeline",
"input": {
"shape_name": "DeletePipelineInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the pipeline to be deleted.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input for the <a>DeletePipeline</a> action.</p>\n "
},
"output": null,
"errors": [
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>\n Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.\n </p>\n <p> \n To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to Pause on individual components. Components that are paused by <a>SetStatus</a> can be resumed.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DeletePipeline\nContent-Length: 50\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n \n <response>\n \nx-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n </response>\n </examples>\n "
},
"DescribeObjects": {
"name": "DescribeObjects",
"input": {
"shape_name": "DescribeObjectsInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the pipeline that contains the object definitions.</p>\n ",
"required": true
},
"objectIds": {
"shape_name": "idList",
"type": "list",
"members": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": null
},
"documentation": "\n <p>Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.</p>\n ",
"required": true
},
"evaluateExpressions": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>\n "
},
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>The starting point for the results to be returned. The first time you call <a>DescribeObjects</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>DescribeObjects</a> again and pass the marker value from the response to retrieve the next set of results.</p>\n "
}
},
"documentation": "\n <p> The <a>DescribeObjects</a> action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results. </p>\n "
},
"output": {
"shape_name": "DescribeObjectsOutput",
"type": "structure",
"members": {
"pipelineObjects": {
"shape_name": "PipelineObjectList",
"type": "list",
"members": {
"shape_name": "PipelineObject",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the object.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the object.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
},
"documentation": "\n <p>An array of object definitions that are returned by the call to <a>DescribeObjects</a>.</p>\n ",
"required": true
},
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>\n The starting point for the next page of results. To view the next page of results, call <a>DescribeObjects</a> again with this marker value.\n </p>\n "
},
"hasMoreResults": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, there are more pages of results to return.</p>\n "
}
},
"documentation": "\n <p>If <code>True</code>, there are more results that can be returned in another call to <a>DescribeObjects</a>.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>\n Returns the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. \n </p>\n \n <examples>\n \n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribeObjects\nContent-Length: 98\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"objectIds\": \n [\"Schedule\"],\n \"evaluateExpressions\": true}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1488\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"COMPONENT\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"PENDING\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-06372391ZG65EXAMPLE\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}\n ]\n}\n \n </response>\n </examples>\n \n ",
"pagination": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"result_key": "pipelineObjects",
"py_input_token": "marker"
}
},
"DescribePipelines": {
"name": "DescribePipelines",
"input": {
"shape_name": "DescribePipelinesInput",
"type": "structure",
"members": {
"pipelineIds": {
"shape_name": "idList",
"type": "list",
"members": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": null
},
"documentation": "\n <p>Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to <a>DescribePipelines</a>. You can obtain pipeline identifiers by calling <a>ListPipelines</a>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input to the <a>DescribePipelines</a> action.</p>\n "
},
"output": {
"shape_name": "DescribePipelinesOutput",
"type": "structure",
"members": {
"pipelineDescriptionList": {
"shape_name": "PipelineDescriptionList",
"type": "list",
"members": {
"shape_name": "PipelineDescription",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the pipeline.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>\n ",
"required": true
},
"description": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>Description of the pipeline.</p>\n "
}
},
"documentation": "\n <p>Contains pipeline metadata.</p>\n "
},
"documentation": "\n <p>An array of descriptions returned for the specified pipelines.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the <a>DescribePipelines</a> action.</p>\n "
},
"errors": [
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
},
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>\n Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.\n </p>\n <p>\n To retrieve the full pipeline definition instead of metadata about the pipeline, call the <a>GetPipelineDefinition</a> action.\n </p>\n \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 70\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineIds\": \n [\"df-08785951KAKJEXAMPLE\"]\n}\n\n </request>\n \n\n <response>\n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 767\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineDescriptionList\": \n [\n {\"description\": \"This is my first pipeline\", \n \"fields\": \n [\n {\"key\": \"@pipelineState\", \n \"stringValue\": \"SCHEDULED\"}, \n {\"key\": \"description\", \n \"stringValue\": \"This is my first pipeline\"}, \n {\"key\": \"name\", \n \"stringValue\": \"myPipeline\"}, \n {\"key\": \"@creationTime\", \n \"stringValue\": \"2012-12-13T01:24:06\"}, \n {\"key\": \"@id\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"PIPELINE\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@userId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"@accountId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"uniqueId\", \n \"stringValue\": \"1234567890\"}\n ], \n \"name\": \"myPipeline\", \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\"}\n ]\n}\n</response>\n </examples> \n \n "
},
"EvaluateExpression": {
"name": "EvaluateExpression",
"input": {
"shape_name": "EvaluateExpressionInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the pipeline.</p>\n ",
"required": true
},
"objectId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the object.</p>\n ",
"required": true
},
"expression": {
"shape_name": "longString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 20971520,
"documentation": "\n <p>The expression to evaluate.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input for the <a>EvaluateExpression</a> action.</p>\n "
},
"output": {
"shape_name": "EvaluateExpressionOutput",
"type": "structure",
"members": {
"evaluatedExpression": {
"shape_name": "longString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 20971520,
"documentation": "\n <p>The evaluated expression.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the <a>EvaluateExpression</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "TaskNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified task was not found. </p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3. </p>\n \n \n \n <examples>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 164\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-08785951KAKJEXAMPLE\",\n \"objectId\": \"Schedule\",\n \"expression\": \"Transform started at #{startDateTime} and finished at #{endDateTime}\"}\n\n </request>\n \n \n <response>\n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 103\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"evaluatedExpression\": \"Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00\"}\n</response>\n </examples> \n "
},
"GetPipelineDefinition": {
"name": "GetPipelineDefinition",
"input": {
"shape_name": "GetPipelineDefinitionInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the pipeline.</p>\n ",
"required": true
},
"version": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>The version of the pipeline definition to retrieve. This parameter accepts the values <code>latest</code> (default) and <code>active</code>. Where <code>latest</code> indicates the last definition saved to the pipeline and <code>active</code> indicates the last definition of the pipeline that was activated.</p>\n "
}
},
"documentation": "\n <p>The input for the <a>GetPipelineDefinition</a> action.</p>\n "
},
"output": {
"shape_name": "GetPipelineDefinitionOutput",
"type": "structure",
"members": {
"pipelineObjects": {
"shape_name": "PipelineObjectList",
"type": "list",
"members": {
"shape_name": "PipelineObject",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the object.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the object.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
},
"documentation": "\n <p>An array of objects defined in the pipeline.</p>\n "
}
},
"documentation": "\n <p>Contains the output from the <a>GetPipelineDefinition</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>Returns the definition of the specified pipeline. You can call <a>GetPipelineDefinition</a> to retrieve the pipeline definition you provided using <a>PutPipelineDefinition</a>.</p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.GetPipelineDefinition\nContent-Length: 40\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n <response>\n \nx-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 890\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ], \n \"id\": \"Default\", \n \"name\": \"Default\"}, \n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}, \n {\"fields\": \n [\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}\n ], \n \"id\": \"SayHello\", \n \"name\": \"SayHello\"}\n ]\n}\n\n </response>\n </examples>\n "
},
"ListPipelines": {
"name": "ListPipelines",
"input": {
"shape_name": "ListPipelinesInput",
"type": "structure",
"members": {
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>The starting point for the results to be returned. The first time you call <a>ListPipelines</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>ListPipelines</a> again and pass the marker value from the response to retrieve the next set of results.</p>\n "
}
},
"documentation": "\n <p>The input to the <a>ListPipelines</a> action.</p>\n "
},
"output": {
"shape_name": "ListPipelinesOutput",
"type": "structure",
"members": {
"pipelineIdList": {
"shape_name": "pipelineList",
"type": "list",
"members": {
"shape_name": "PipelineIdName",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>\n "
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the pipeline.</p>\n "
}
},
"documentation": "\n <p>Contains the name and identifier of a pipeline.</p>\n "
},
"documentation": "\n <p>\n A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.\n </p> \n ",
"required": true
},
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>If not null, indicates the starting point for the set of pipeline identifiers that the next call to <a>ListPipelines</a> will retrieve. If null, there are no more pipeline identifiers.</p>\n "
},
"hasMoreResults": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, there are more results that can be obtained by a subsequent call to <a>ListPipelines</a>.</p>\n "
}
},
"documentation": "\n <p>Contains the output from the <a>ListPipelines</a> action.</p> \n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </p> \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ListPipelines\nContent-Length: 14\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{}\n\n </request>\n \n <response>\n \nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"PipelineIdList\": \n [\n {\"id\": \"df-08785951KAKJEXAMPLE\",\n \"name\": \"MyPipeline\"}, \n {\"id\": \"df-08662578ISYEXAMPLE\", \n \"name\": \"MySecondPipeline\"}\n ]\n} \n </response>\n </examples>\n \n ",
"pagination": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"result_key": "pipelineIdList",
"py_input_token": "marker"
}
},
"PollForTask": {
"name": "PollForTask",
"input": {
"shape_name": "PollForTaskInput",
"type": "structure",
"members": {
"workerGroup": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <a>PollForTask</a>. There are no wildcard values permitted in <code>workerGroup</code>, the string must be an exact, case-sensitive, match.\n </p>\n ",
"required": true
},
"hostname": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The public DNS name of the calling task runner.</p>\n "
},
"instanceIdentity": {
"shape_name": "InstanceIdentity",
"type": "structure",
"members": {
"document": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</p>\n "
},
"signature": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>\n "
}
},
"documentation": "\n <p>Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, <code>http://169.254.169.254/latest/meta-data/instance-id</code>, from the EC2 instance. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html\">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p>\n "
}
},
"documentation": "\n <p>The data type passed in as input to the PollForTask action.</p>\n "
},
"output": {
"shape_name": "PollForTaskOutput",
"type": "structure",
"members": {
"taskObject": {
"shape_name": "TaskObject",
"type": "structure",
"members": {
"taskId": {
"shape_name": "taskId",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 2048,
"documentation": "\n <p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>\n "
},
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the pipeline that provided the task.</p>\n "
},
"attemptId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.</p>\n "
},
"objects": {
"shape_name": "PipelineObjectMap",
"type": "map",
"keys": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": null
},
"members": {
"shape_name": "PipelineObject",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the object.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the object.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
},
"documentation": "\n <p>Connection information for the location where the task runner will publish the output of the task.</p>\n "
}
},
"documentation": "\n <p>An instance of <a>PollForTaskResult</a>, which contains an instance of <a>TaskObject</a>. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to <a>ReportTaskProgress</a> and <a>SetTaskStatus</a>.</p>\n "
}
},
"documentation": "\n <p>Contains the output from the PollForTask action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "TaskNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified task was not found. </p>\n "
}
],
"documentation": "\n <p>\n Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the <a>PollForTask</a> call. The task returned by <a>PollForTask</a> may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.\n </p>\n <p>\n If tasks are ready in the work queue, <a>PollForTask</a> returns a response immediately. If no tasks are available in the queue, <a>PollForTask</a> uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <a>PollForTask</a> again on the same <code>workerGroup</code> until it receives a response, and this may take up to 90 seconds.\n </p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PollForTask\nContent-Length: 59\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"workerGroup\": \"MyworkerGroup\",\n \"hostname\": \"example.com\"}\n\n </request>\n \n <response>\n \nx-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"taskObject\": \n {\"attemptId\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"objects\": \n {\"@SayHello_2012-12-12T00:00:00_Attempt=1\": \n {\"fields\": \n [\n {\"key\": \"@componentParent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@scheduledStartTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"ATTEMPT\"}, \n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}, \n {\"key\": \"@instanceParent\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"WAITING_FOR_RUNNER\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"@actualStartTime\", \n \"stringValue\": \"2012-12-13T01:40:50\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"@scheduledEndTime\", \n \"stringValue\": \"2012-12-12T01:00:00\"}, \n {\"key\": \"@activeInstances\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}\n ], \n \"id\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"name\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\"}\n }, \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\", \n \"taskId\": \"2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1\"}\n}\n \n </response>\n </examples>\n "
},
"PutPipelineDefinition": {
"name": "PutPipelineDefinition",
"input": {
"shape_name": "PutPipelineDefinitionInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the pipeline to be configured.</p>\n ",
"required": true
},
"pipelineObjects": {
"shape_name": "PipelineObjectList",
"type": "list",
"members": {
"shape_name": "PipelineObject",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the object.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the object.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
},
"documentation": "\n <p>The objects that define the pipeline. These will overwrite the existing pipeline definition.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input of the <a>PutPipelineDefinition</a> action.</p>\n "
},
"output": {
"shape_name": "PutPipelineDefinitionOutput",
"type": "structure",
"members": {
"validationErrors": {
"shape_name": "ValidationErrors",
"type": "list",
"members": {
"shape_name": "ValidationError",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the object that contains the validation error.</p>\n "
},
"errors": {
"shape_name": "validationMessages",
"type": "list",
"members": {
"shape_name": "validationMessage",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10000,
"documentation": null
},
"documentation": "\n <p>A description of the validation error.</p>\n "
}
},
"documentation": "\n <p>Defines a validation error returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>\n "
},
"documentation": "\n <p>A list of the validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>\n "
},
"validationWarnings": {
"shape_name": "ValidationWarnings",
"type": "list",
"members": {
"shape_name": "ValidationWarning",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the object that contains the validation warning.</p>\n "
},
"warnings": {
"shape_name": "validationMessages",
"type": "list",
"members": {
"shape_name": "validationMessage",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10000,
"documentation": null
},
"documentation": "\n <p>A description of the validation warning.</p>\n "
}
},
"documentation": "\n <p>Defines a validation warning returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>\n "
},
"documentation": "\n <p>A list of the validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>\n "
},
"errored": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, there were validation errors. If errored is <code>True</code>, the pipeline definition is stored but cannot be activated until you correct the pipeline and call <a>PutPipelineDefinition</a> to commit the corrected pipeline.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output of the <a>PutPipelineDefinition</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline.\n </p>\n <p>\n <a>PutPipelineDefinition</a> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.\n <ol>\n <li>An object is missing a name or identifier field.</li>\n <li>A string or reference field is empty.</li>\n <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li>\n </ol>\n </p>\n <p>\n Pipeline object definitions are passed to the <a>PutPipelineDefinition</a> action and returned by the <a>GetPipelineDefinition</a> action. \n </p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>\n This example sets an valid pipeline configuration and returns success.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 914\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0937003356ZJEXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n ]\n }\n ]\n}\n \n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n\n \n </response>\n </example>\n <example>\n <name>Example 2</name>\n <description>\n This example sets an invalid pipeline configuration (the value for <code>workerGroup</code> is an empty string) and returns an error message.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"__type\": \"com.amazon.setl.webservice#InvalidRequestException\", \n \"message\": \"Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline\"}\n\n \n </response>\n </example>\n </examples>\n "
},
"QueryObjects": {
"name": "QueryObjects",
"input": {
"shape_name": "QueryObjectsInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the pipeline to be queried for object names.</p>\n ",
"required": true
},
"query": {
"shape_name": "Query",
"type": "structure",
"members": {
"selectors": {
"shape_name": "SelectorList",
"type": "list",
"members": {
"shape_name": "Selector",
"type": "structure",
"members": {
"fieldName": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.</p>\n "
},
"operator": {
"shape_name": "Operator",
"type": "structure",
"members": {
"type": {
"shape_name": "OperatorType",
"type": "string",
"enum": [
"EQ",
"REF_EQ",
"LE",
"GE",
"BETWEEN"
],
"documentation": " \n <p>\n The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n </p>\n <p>\n The comparison operators EQ and REF_EQ act on the following fields:\n </p>\n <ul>\n <li>name</li>\n <li>@sphere</li>\n <li>parent</li>\n <li>@componentParent</li>\n <li>@instanceParent</li>\n <li>@status</li>\n <li>@scheduledStartTime</li>\n <li>@scheduledEndTime</li>\n <li>@actualStartTime</li>\n <li>@actualEndTime</li>\n </ul>\n \n <p>\n The comparison operators <code>GE</code>, <code>LE</code>, and <code>BETWEEN</code> act on the following fields:\n </p>\n <ul>\n <li>@scheduledStartTime</li>\n <li>@scheduledEndTime</li>\n <li>@actualStartTime</li>\n <li>@actualEndTime</li>\n </ul>\n <p>Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".</p>\n "
},
"values": {
"shape_name": "stringList",
"type": "list",
"members": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": null
},
"documentation": " \n <p>The value that the actual field value will be compared with.</p>\n "
}
},
"documentation": " \n <p>Contains a logical operation for comparing the value of a field with a specified value.</p> \n "
}
},
"documentation": "\n <p>A comparision that is used to determine whether a query should return this object.</p> \n "
},
"documentation": "\n <p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>\n "
}
},
"documentation": "\n <p>\n Query that defines the objects to be returned. The <a>Query</a> object can contain a maximum of ten selectors. \n The conditions in the query are limited to top-level String fields in the object. \n These filters can be applied to components, instances, and attempts. \n </p>\n "
},
"sphere": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>\n Specifies whether the query applies to components or instances.\t\n Allowable values: <code>COMPONENT</code>, <code>INSTANCE</code>, <code>ATTEMPT</code>.\n </p>\n ",
"required": true
},
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>\n The starting point for the results to be returned. The first time you call <a>QueryObjects</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results.\n </p>\n "
},
"limit": {
"shape_name": "int",
"type": "integer",
"documentation": "\n <p>Specifies the maximum number of object names that <a>QueryObjects</a> will return in a single call. The default value is 100. </p>\n "
}
},
"documentation": "\n <p>The input for the <a>QueryObjects</a> action.</p>\n "
},
"output": {
"shape_name": "QueryObjectsOutput",
"type": "structure",
"members": {
"ids": {
"shape_name": "idList",
"type": "list",
"members": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": null
},
"documentation": "\n <p>A list of identifiers that match the query selectors.</p>\n "
},
"marker": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>\n The starting point for the results to be returned. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results.\n </p>\n "
},
"hasMoreResults": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, there are more results that can be obtained by a subsequent call to <a>QueryObjects</a>.</p>\n "
}
},
"documentation": "\n <p>Contains the output from the <a>QueryObjects</a> action.</p>\n "
},
"errors": [
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
},
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>Queries a pipeline for the names of objects that match a specified set of conditions.</p>\n \n <p>The objects returned by <a>QueryObjects</a> are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If <code>HasMoreResults</code> is set to <code>True</code>, you should continue to call <a>QueryObjects</a>, passing in the returned value for marker, until <code>HasMoreResults</code> returns <code>False</code>.</p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.QueryObjects\nContent-Length: 123\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"query\": \n {\"selectors\": \n [\n ]\n },\n \"sphere\": \"PO\",\n \"marker\": \"\",\n \"limit\": 10}\n\n </request>\n \n \n <response>\n\nx-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 72\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"ids\": \n [\"@SayHello_1_2012-09-25T17:00:00\"]\n}\n </response>\n </examples>\n \n ",
"pagination": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"limit_key": "limit",
"result_key": "ids",
"py_input_token": "marker"
}
},
"ReportTaskProgress": {
"name": "ReportTaskProgress",
"input": {
"shape_name": "ReportTaskProgressInput",
"type": "structure",
"members": {
"taskId": {
"shape_name": "taskId",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 2048,
"documentation": "\n <p>Identifier of the task assigned to the task runner. This value is provided in the <a>TaskObject</a> that the service returns with the response for the <a>PollForTask</a> action.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input for the ReportTaskProgress action.</p>\n "
},
"output": {
"shape_name": "ReportTaskProgressOutput",
"type": "structure",
"members": {
"canceled": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the ReportTaskProgress action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "TaskNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified task was not found. </p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>\n Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline.\n \n \n \n If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to <a>PollForTask</a>. task runners should call <a>ReportTaskProgress</a> every 60 seconds.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskProgress\nContent-Length: 832\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"fields\": \n [\n {\"key\": \"percentComplete\",\n \"stringValue\": \"50\"}\n ]\n}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"canceled\": false}\n \n</response>\n </examples>\n \n "
},
"ReportTaskRunnerHeartbeat": {
"name": "ReportTaskRunnerHeartbeat",
"input": {
"shape_name": "ReportTaskRunnerHeartbeatInput",
"type": "structure",
"members": {
"taskrunnerId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.</p>\n ",
"required": true
},
"workerGroup": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <a>ReportTaskRunnerHeartbeat</a>. There are no wildcard values permitted in <code>workerGroup</code>, the string must be an exact, case-sensitive, match.</p>\n "
},
"hostname": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The public DNS name of the calling task runner.</p>\n "
}
},
"documentation": "\n <p>The input for the ReportTaskRunnerHeartbeat action.</p>\n "
},
"output": {
"shape_name": "ReportTaskRunnerHeartbeatOutput",
"type": "structure",
"members": {
"terminate": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>Indicates whether the calling task runner should terminate. If <code>True</code>, the task runner that called <a>ReportTaskRunnerHeartbeat</a> should terminate. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the <a>ReportTaskRunnerHeartbeat</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>Task runners call <a>ReportTaskRunnerHeartbeat</a> every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.</p>\n \n <examples>\n <request> \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat\nContent-Length: 84\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskrunnerId\": \"1234567890\",\n \"workerGroup\": \"wg-12345\",\n \"hostname\": \"example.com\"}\n\n </request>\n \n <response>\n\nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 20\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"terminate\": false}\n \n </response>\n </examples>\n "
},
"SetStatus": {
"name": "SetStatus",
"input": {
"shape_name": "SetStatusInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifies the pipeline that contains the objects.</p>\n ",
"required": true
},
"objectIds": {
"shape_name": "idList",
"type": "list",
"members": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": null
},
"documentation": "\n <p>Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>\n ",
"required": true
},
"status": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>Specifies the status to be set on all the objects in <code>objectIds</code>. For components, this can be either <code>PAUSE</code> or <code>RESUME</code>. For instances, this can be either <code>CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input to the <a>SetStatus</a> action.</p>\n "
},
"output": null,
"errors": [
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
},
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
}
],
"documentation": "\n <p>Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.</p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetStatus\nContent-Length: 100\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0634701J7KEXAMPLE\", \n \"objectIds\": \n [\"o-08600941GHJWMBR9E2\"], \n \"status\": \"pause\"}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n </response>\n </examples>\n \n "
},
"SetTaskStatus": {
"name": "SetTaskStatus",
"input": {
"shape_name": "SetTaskStatusInput",
"type": "structure",
"members": {
"taskId": {
"shape_name": "taskId",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 2048,
"documentation": "\n <p>Identifies the task assigned to the task runner. This value is set in the <a>TaskObject</a> that is returned by the <a>PollForTask</a> action.</p>\n ",
"required": true
},
"taskStatus": {
"shape_name": "TaskStatus",
"type": "string",
"enum": [
"FINISHED",
"FAILED",
"FALSE"
],
"documentation": "\n <p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code> the task ended unsuccessfully. The <code>FALSE</code> value is used by preconditions.</p>\n ",
"required": true
},
"errorId": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.</p>\n "
},
"errorMessage": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>\n "
},
"errorStackTrace": {
"shape_name": "string",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 1024,
"documentation": "\n <p>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>\n "
}
},
"documentation": "\n <p>The input of the SetTaskStatus action.</p>\n "
},
"output": {
"shape_name": "SetTaskStatusOutput",
"type": "structure",
"members": {},
"documentation": "\n <p>The output from the <a>SetTaskStatus</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "TaskNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified task was not found. </p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>\n Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call <a>SetTaskStatus</a> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetTaskStatus\nContent-Length: 847\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"taskStatus\": \"FINISHED\"}\n \n </request>\n \n <response>\n\nx-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 \nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n </response>\n </examples>\n \n "
},
"ValidatePipelineDefinition": {
"name": "ValidatePipelineDefinition",
"input": {
"shape_name": "ValidatePipelineDefinitionInput",
"type": "structure",
"members": {
"pipelineId": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifies the pipeline whose definition is to be validated.</p>\n ",
"required": true
},
"pipelineObjects": {
"shape_name": "PipelineObjectList",
"type": "list",
"members": {
"shape_name": "PipelineObject",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Identifier of the object.</p>\n ",
"required": true
},
"name": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>Name of the object.</p>\n ",
"required": true
},
"fields": {
"shape_name": "fieldList",
"type": "list",
"members": {
"shape_name": "Field",
"type": "structure",
"members": {
"key": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field identifier.</p>\n ",
"required": true
},
"stringValue": {
"shape_name": "fieldStringValue",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10240,
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
},
"refValue": {
"shape_name": "fieldNameString",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 256,
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
}
},
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
},
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
},
"documentation": "\n <p>A list of objects that define the pipeline changes to validate against the pipeline.</p>\n ",
"required": true
}
},
"documentation": "\n <p>The input of the <a>ValidatePipelineDefinition</a> action.</p>\n "
},
"output": {
"shape_name": "ValidatePipelineDefinitionOutput",
"type": "structure",
"members": {
"validationErrors": {
"shape_name": "ValidationErrors",
"type": "list",
"members": {
"shape_name": "ValidationError",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the object that contains the validation error.</p>\n "
},
"errors": {
"shape_name": "validationMessages",
"type": "list",
"members": {
"shape_name": "validationMessage",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10000,
"documentation": null
},
"documentation": "\n <p>A description of the validation error.</p>\n "
}
},
"documentation": "\n <p>Defines a validation error returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>\n "
},
"documentation": "\n <p>Lists the validation errors that were found by <a>ValidatePipelineDefinition</a>.</p>\n "
},
"validationWarnings": {
"shape_name": "ValidationWarnings",
"type": "list",
"members": {
"shape_name": "ValidationWarning",
"type": "structure",
"members": {
"id": {
"shape_name": "id",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 1,
"max_length": 1024,
"documentation": "\n <p>The identifier of the object that contains the validation warning.</p>\n "
},
"warnings": {
"shape_name": "validationMessages",
"type": "list",
"members": {
"shape_name": "validationMessage",
"type": "string",
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
"min_length": 0,
"max_length": 10000,
"documentation": null
},
"documentation": "\n <p>A description of the validation warning.</p>\n "
}
},
"documentation": "\n <p>Defines a validation warning returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>\n "
},
"documentation": "\n <p>Lists the validation warnings that were found by <a>ValidatePipelineDefinition</a>.</p>\n "
},
"errored": {
"shape_name": "boolean",
"type": "boolean",
"documentation": "\n <p>If <code>True</code>, there were validation errors.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Contains the output from the <a>ValidatePipelineDefinition</a> action.</p>\n "
},
"errors": [
{
"shape_name": "InternalServiceError",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>An internal service error occurred.</p>\n "
},
{
"shape_name": "InvalidRequestException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
},
{
"shape_name": "PipelineNotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
},
{
"shape_name": "PipelineDeletedException",
"type": "structure",
"members": {
"message": {
"shape_name": "errorMessage",
"type": "string",
"documentation": "\n <p>Description of the error message.</p>\n "
}
},
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
}
],
"documentation": "\n <p>Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error. </p>\n\n <examples>\n <example>\n <name>Example 1</name>\n <description>\n This example sets an valid pipeline configuration and returns success.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 936\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nx-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n \n </response>\n </example>\n <example>\n <name>Example 2</name>\n <description>\n This example sets an invalid pipeline configuration and returns the associated set of validation errors.\n </description>\n \n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"bad-time\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nx-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd\nContent-Type: application/x-amz-json-1.1\nContent-Length: 278\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": true, \n \"validationErrors\": \n [\n {\"errors\": \n [\"INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value.\"], \n \"id\": \"Schedule\"}\n ]\n}\n \n </response>\n </example>\n </examples>\n "
}
},
"pagination": {
"ListPipelines": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"result_key": "pipelineIdList",
"py_input_token": "marker"
},
"DescribeObjects": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"result_key": "pipelineObjects",
"py_input_token": "marker"
},
"QueryObjects": {
"input_token": "marker",
"output_token": "marker",
"more_results": "hasMoreResults",
"limit_key": "limit",
"result_key": "ids",
"py_input_token": "marker"
}
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
},
"throttling": {
"applies_when": {
"response": {
"service_error_code": "Throttling",
"http_status_code": 400
}
}
}
}
}
}
}
|