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
|
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package datapipeline provides a client for AWS Data Pipeline.
package datapipeline
import (
"time"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/private/protocol"
"github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
)
const opActivatePipeline = "ActivatePipeline"
// ActivatePipelineRequest generates a request for the ActivatePipeline operation.
func (c *DataPipeline) ActivatePipelineRequest(input *ActivatePipelineInput) (req *request.Request, output *ActivatePipelineOutput) {
op := &request.Operation{
Name: opActivatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ActivatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &ActivatePipelineOutput{}
req.Data = output
return
}
// Validates the specified pipeline and starts processing pipeline tasks. If
// the pipeline does not pass validation, activation fails.
//
// If you need to pause the pipeline to investigate an issue with a component,
// such as a data source or script, call DeactivatePipeline.
//
// To activate a finished pipeline, modify the end date for the pipeline and
// then activate it.
func (c *DataPipeline) ActivatePipeline(input *ActivatePipelineInput) (*ActivatePipelineOutput, error) {
req, out := c.ActivatePipelineRequest(input)
err := req.Send()
return out, err
}
const opAddTags = "AddTags"
// AddTagsRequest generates a request for the AddTags operation.
func (c *DataPipeline) AddTagsRequest(input *AddTagsInput) (req *request.Request, output *AddTagsOutput) {
op := &request.Operation{
Name: opAddTags,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AddTagsInput{}
}
req = c.newRequest(op, input, output)
output = &AddTagsOutput{}
req.Data = output
return
}
// Adds or modifies tags for the specified pipeline.
func (c *DataPipeline) AddTags(input *AddTagsInput) (*AddTagsOutput, error) {
req, out := c.AddTagsRequest(input)
err := req.Send()
return out, err
}
const opCreatePipeline = "CreatePipeline"
// CreatePipelineRequest generates a request for the CreatePipeline operation.
func (c *DataPipeline) CreatePipelineRequest(input *CreatePipelineInput) (req *request.Request, output *CreatePipelineOutput) {
op := &request.Operation{
Name: opCreatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &CreatePipelineOutput{}
req.Data = output
return
}
// Creates a new, empty pipeline. Use PutPipelineDefinition to populate the
// pipeline.
func (c *DataPipeline) CreatePipeline(input *CreatePipelineInput) (*CreatePipelineOutput, error) {
req, out := c.CreatePipelineRequest(input)
err := req.Send()
return out, err
}
const opDeactivatePipeline = "DeactivatePipeline"
// DeactivatePipelineRequest generates a request for the DeactivatePipeline operation.
func (c *DataPipeline) DeactivatePipelineRequest(input *DeactivatePipelineInput) (req *request.Request, output *DeactivatePipelineOutput) {
op := &request.Operation{
Name: opDeactivatePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeactivatePipelineInput{}
}
req = c.newRequest(op, input, output)
output = &DeactivatePipelineOutput{}
req.Data = output
return
}
// Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING
// state until the deactivation process completes.
//
// To resume a deactivated pipeline, use ActivatePipeline. By default, the
// pipeline resumes from the last completed execution. Optionally, you can specify
// the date and time to resume the pipeline.
func (c *DataPipeline) DeactivatePipeline(input *DeactivatePipelineInput) (*DeactivatePipelineOutput, error) {
req, out := c.DeactivatePipelineRequest(input)
err := req.Send()
return out, err
}
const opDeletePipeline = "DeletePipeline"
// DeletePipelineRequest generates a request for the DeletePipeline operation.
func (c *DataPipeline) DeletePipelineRequest(input *DeletePipelineInput) (req *request.Request, output *DeletePipelineOutput) {
op := &request.Operation{
Name: opDeletePipeline,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeletePipelineInput{}
}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output = &DeletePipelineOutput{}
req.Data = output
return
}
// Deletes a pipeline, its pipeline definition, and its run history. AWS Data
// Pipeline attempts to cancel instances associated with the pipeline that are
// currently being processed by task runners.
//
// Deleting a pipeline cannot be undone. You cannot query or restore a deleted
// pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus
// with the status set to PAUSE on individual components. Components that are
// paused by SetStatus can be resumed.
func (c *DataPipeline) DeletePipeline(input *DeletePipelineInput) (*DeletePipelineOutput, error) {
req, out := c.DeletePipelineRequest(input)
err := req.Send()
return out, err
}
const opDescribeObjects = "DescribeObjects"
// DescribeObjectsRequest generates a request for the DescribeObjects operation.
func (c *DataPipeline) DescribeObjectsRequest(input *DescribeObjectsInput) (req *request.Request, output *DescribeObjectsOutput) {
op := &request.Operation{
Name: opDescribeObjects,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &DescribeObjectsInput{}
}
req = c.newRequest(op, input, output)
output = &DescribeObjectsOutput{}
req.Data = output
return
}
// Gets 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.
func (c *DataPipeline) DescribeObjects(input *DescribeObjectsInput) (*DescribeObjectsOutput, error) {
req, out := c.DescribeObjectsRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) DescribeObjectsPages(input *DescribeObjectsInput, fn func(p *DescribeObjectsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.DescribeObjectsRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*DescribeObjectsOutput), lastPage)
})
}
const opDescribePipelines = "DescribePipelines"
// DescribePipelinesRequest generates a request for the DescribePipelines operation.
func (c *DataPipeline) DescribePipelinesRequest(input *DescribePipelinesInput) (req *request.Request, output *DescribePipelinesOutput) {
op := &request.Operation{
Name: opDescribePipelines,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DescribePipelinesInput{}
}
req = c.newRequest(op, input, output)
output = &DescribePipelinesOutput{}
req.Data = output
return
}
// Retrieves 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 for which you have read permissions.
//
// To retrieve the full pipeline definition instead of metadata about the pipeline,
// call GetPipelineDefinition.
func (c *DataPipeline) DescribePipelines(input *DescribePipelinesInput) (*DescribePipelinesOutput, error) {
req, out := c.DescribePipelinesRequest(input)
err := req.Send()
return out, err
}
const opEvaluateExpression = "EvaluateExpression"
// EvaluateExpressionRequest generates a request for the EvaluateExpression operation.
func (c *DataPipeline) EvaluateExpressionRequest(input *EvaluateExpressionInput) (req *request.Request, output *EvaluateExpressionOutput) {
op := &request.Operation{
Name: opEvaluateExpression,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &EvaluateExpressionInput{}
}
req = c.newRequest(op, input, output)
output = &EvaluateExpressionOutput{}
req.Data = output
return
}
// Task runners call EvaluateExpression to evaluate a string in the context
// of the specified object. For example, a task runner can evaluate SQL queries
// stored in Amazon S3.
func (c *DataPipeline) EvaluateExpression(input *EvaluateExpressionInput) (*EvaluateExpressionOutput, error) {
req, out := c.EvaluateExpressionRequest(input)
err := req.Send()
return out, err
}
const opGetPipelineDefinition = "GetPipelineDefinition"
// GetPipelineDefinitionRequest generates a request for the GetPipelineDefinition operation.
func (c *DataPipeline) GetPipelineDefinitionRequest(input *GetPipelineDefinitionInput) (req *request.Request, output *GetPipelineDefinitionOutput) {
op := &request.Operation{
Name: opGetPipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetPipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &GetPipelineDefinitionOutput{}
req.Data = output
return
}
// Gets the definition of the specified pipeline. You can call GetPipelineDefinition
// to retrieve the pipeline definition that you provided using PutPipelineDefinition.
func (c *DataPipeline) GetPipelineDefinition(input *GetPipelineDefinitionInput) (*GetPipelineDefinitionOutput, error) {
req, out := c.GetPipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
const opListPipelines = "ListPipelines"
// ListPipelinesRequest generates a request for the ListPipelines operation.
func (c *DataPipeline) ListPipelinesRequest(input *ListPipelinesInput) (req *request.Request, output *ListPipelinesOutput) {
op := &request.Operation{
Name: opListPipelines,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &ListPipelinesInput{}
}
req = c.newRequest(op, input, output)
output = &ListPipelinesOutput{}
req.Data = output
return
}
// Lists the pipeline identifiers for all active pipelines that you have permission
// to access.
func (c *DataPipeline) ListPipelines(input *ListPipelinesInput) (*ListPipelinesOutput, error) {
req, out := c.ListPipelinesRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) ListPipelinesPages(input *ListPipelinesInput, fn func(p *ListPipelinesOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.ListPipelinesRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*ListPipelinesOutput), lastPage)
})
}
const opPollForTask = "PollForTask"
// PollForTaskRequest generates a request for the PollForTask operation.
func (c *DataPipeline) PollForTaskRequest(input *PollForTaskInput) (req *request.Request, output *PollForTaskOutput) {
op := &request.Operation{
Name: opPollForTask,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PollForTaskInput{}
}
req = c.newRequest(op, input, output)
output = &PollForTaskOutput{}
req.Data = output
return
}
// Task runners call PollForTask 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. The task returned can 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.
//
// If tasks are ready in the work queue, PollForTask returns a response immediately.
// If no tasks are available in the queue, PollForTask 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 PollForTask again on the same workerGroup until it receives
// a response, and this can take up to 90 seconds.
func (c *DataPipeline) PollForTask(input *PollForTaskInput) (*PollForTaskOutput, error) {
req, out := c.PollForTaskRequest(input)
err := req.Send()
return out, err
}
const opPutPipelineDefinition = "PutPipelineDefinition"
// PutPipelineDefinitionRequest generates a request for the PutPipelineDefinition operation.
func (c *DataPipeline) PutPipelineDefinitionRequest(input *PutPipelineDefinitionInput) (req *request.Request, output *PutPipelineDefinitionOutput) {
op := &request.Operation{
Name: opPutPipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PutPipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &PutPipelineDefinitionOutput{}
req.Data = output
return
}
// Adds tasks, schedules, and preconditions to the specified pipeline. You can
// use PutPipelineDefinition to populate a new pipeline.
//
// PutPipelineDefinition 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.
//
// An object is missing a name or identifier field. A string or reference
// field is empty. The number of objects in the pipeline exceeds the maximum
// allowed objects. The pipeline is in a FINISHED state. Pipeline object definitions
// are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition
// action.
func (c *DataPipeline) PutPipelineDefinition(input *PutPipelineDefinitionInput) (*PutPipelineDefinitionOutput, error) {
req, out := c.PutPipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
const opQueryObjects = "QueryObjects"
// QueryObjectsRequest generates a request for the QueryObjects operation.
func (c *DataPipeline) QueryObjectsRequest(input *QueryObjectsInput) (req *request.Request, output *QueryObjectsOutput) {
op := &request.Operation{
Name: opQueryObjects,
HTTPMethod: "POST",
HTTPPath: "/",
Paginator: &request.Paginator{
InputTokens: []string{"marker"},
OutputTokens: []string{"marker"},
LimitToken: "limit",
TruncationToken: "hasMoreResults",
},
}
if input == nil {
input = &QueryObjectsInput{}
}
req = c.newRequest(op, input, output)
output = &QueryObjectsOutput{}
req.Data = output
return
}
// Queries the specified pipeline for the names of objects that match the specified
// set of conditions.
func (c *DataPipeline) QueryObjects(input *QueryObjectsInput) (*QueryObjectsOutput, error) {
req, out := c.QueryObjectsRequest(input)
err := req.Send()
return out, err
}
func (c *DataPipeline) QueryObjectsPages(input *QueryObjectsInput, fn func(p *QueryObjectsOutput, lastPage bool) (shouldContinue bool)) error {
page, _ := c.QueryObjectsRequest(input)
page.Handlers.Build.PushBack(request.MakeAddToUserAgentFreeFormHandler("Paginator"))
return page.EachPage(func(p interface{}, lastPage bool) bool {
return fn(p.(*QueryObjectsOutput), lastPage)
})
}
const opRemoveTags = "RemoveTags"
// RemoveTagsRequest generates a request for the RemoveTags operation.
func (c *DataPipeline) RemoveTagsRequest(input *RemoveTagsInput) (req *request.Request, output *RemoveTagsOutput) {
op := &request.Operation{
Name: opRemoveTags,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RemoveTagsInput{}
}
req = c.newRequest(op, input, output)
output = &RemoveTagsOutput{}
req.Data = output
return
}
// Removes existing tags from the specified pipeline.
func (c *DataPipeline) RemoveTags(input *RemoveTagsInput) (*RemoveTagsOutput, error) {
req, out := c.RemoveTagsRequest(input)
err := req.Send()
return out, err
}
const opReportTaskProgress = "ReportTaskProgress"
// ReportTaskProgressRequest generates a request for the ReportTaskProgress operation.
func (c *DataPipeline) ReportTaskProgressRequest(input *ReportTaskProgressInput) (req *request.Request, output *ReportTaskProgressOutput) {
op := &request.Operation{
Name: opReportTaskProgress,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ReportTaskProgressInput{}
}
req = c.newRequest(op, input, output)
output = &ReportTaskProgressOutput{}
req.Data = output
return
}
// Task runners call ReportTaskProgress when assigned a task to acknowledge
// that it has the task. If the web service does not receive this acknowledgement
// within 2 minutes, it assigns the task in a subsequent PollForTask 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 reportProgressTimeout field
// in your pipeline.
//
// If a task runner does not report its status after 5 minutes, AWS Data Pipeline
// assumes that the task runner is unable to process the task and reassigns
// the task in a subsequent response to PollForTask. Task runners should call
// ReportTaskProgress every 60 seconds.
func (c *DataPipeline) ReportTaskProgress(input *ReportTaskProgressInput) (*ReportTaskProgressOutput, error) {
req, out := c.ReportTaskProgressRequest(input)
err := req.Send()
return out, err
}
const opReportTaskRunnerHeartbeat = "ReportTaskRunnerHeartbeat"
// ReportTaskRunnerHeartbeatRequest generates a request for the ReportTaskRunnerHeartbeat operation.
func (c *DataPipeline) ReportTaskRunnerHeartbeatRequest(input *ReportTaskRunnerHeartbeatInput) (req *request.Request, output *ReportTaskRunnerHeartbeatOutput) {
op := &request.Operation{
Name: opReportTaskRunnerHeartbeat,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ReportTaskRunnerHeartbeatInput{}
}
req = c.newRequest(op, input, output)
output = &ReportTaskRunnerHeartbeatOutput{}
req.Data = output
return
}
// Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate
// that they are operational. If the AWS Data Pipeline Task Runner is 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.
func (c *DataPipeline) ReportTaskRunnerHeartbeat(input *ReportTaskRunnerHeartbeatInput) (*ReportTaskRunnerHeartbeatOutput, error) {
req, out := c.ReportTaskRunnerHeartbeatRequest(input)
err := req.Send()
return out, err
}
const opSetStatus = "SetStatus"
// SetStatusRequest generates a request for the SetStatus operation.
func (c *DataPipeline) SetStatusRequest(input *SetStatusInput) (req *request.Request, output *SetStatusOutput) {
op := &request.Operation{
Name: opSetStatus,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetStatusInput{}
}
req = c.newRequest(op, input, output)
req.Handlers.Unmarshal.Remove(jsonrpc.UnmarshalHandler)
req.Handlers.Unmarshal.PushBackNamed(protocol.UnmarshalDiscardBodyHandler)
output = &SetStatusOutput{}
req.Data = output
return
}
// Requests that the status of the specified physical or logical pipeline objects
// be updated in the specified pipeline. This update might not occur immediately,
// but is eventually consistent. The status that can be set depends on the type
// of object (for example, DataNode or Activity). You cannot perform this operation
// on FINISHED pipelines and attempting to do so returns InvalidRequestException.
func (c *DataPipeline) SetStatus(input *SetStatusInput) (*SetStatusOutput, error) {
req, out := c.SetStatusRequest(input)
err := req.Send()
return out, err
}
const opSetTaskStatus = "SetTaskStatus"
// SetTaskStatusRequest generates a request for the SetTaskStatus operation.
func (c *DataPipeline) SetTaskStatusRequest(input *SetTaskStatusInput) (req *request.Request, output *SetTaskStatusOutput) {
op := &request.Operation{
Name: opSetTaskStatus,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetTaskStatusInput{}
}
req = c.newRequest(op, input, output)
output = &SetTaskStatusOutput{}
req.Data = output
return
}
// Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is
// completed and provide information about the final status. A task runner makes
// this call regardless of whether the task was sucessful. A task runner does
// not need to call SetTaskStatus for tasks that are canceled by the web service
// during a call to ReportTaskProgress.
func (c *DataPipeline) SetTaskStatus(input *SetTaskStatusInput) (*SetTaskStatusOutput, error) {
req, out := c.SetTaskStatusRequest(input)
err := req.Send()
return out, err
}
const opValidatePipelineDefinition = "ValidatePipelineDefinition"
// ValidatePipelineDefinitionRequest generates a request for the ValidatePipelineDefinition operation.
func (c *DataPipeline) ValidatePipelineDefinitionRequest(input *ValidatePipelineDefinitionInput) (req *request.Request, output *ValidatePipelineDefinitionOutput) {
op := &request.Operation{
Name: opValidatePipelineDefinition,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ValidatePipelineDefinitionInput{}
}
req = c.newRequest(op, input, output)
output = &ValidatePipelineDefinitionOutput{}
req.Data = output
return
}
// Validates the specified pipeline definition to ensure that it is well formed
// and can be run without error.
func (c *DataPipeline) ValidatePipelineDefinition(input *ValidatePipelineDefinitionInput) (*ValidatePipelineDefinitionOutput, error) {
req, out := c.ValidatePipelineDefinitionRequest(input)
err := req.Send()
return out, err
}
// Contains the parameters for ActivatePipeline.
type ActivatePipelineInput struct {
_ struct{} `type:"structure"`
// A list of parameter values to pass to the pipeline at activation.
ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The date and time to resume the pipeline. By default, the pipeline resumes
// from the last completed execution.
StartTimestamp *time.Time `locationName:"startTimestamp" type:"timestamp" timestampFormat:"unix"`
}
// String returns the string representation
func (s ActivatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ActivatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of ActivatePipeline.
type ActivatePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s ActivatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ActivatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for AddTags.
type AddTagsInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The tags to add, as key/value pairs.
Tags []*Tag `locationName:"tags" type:"list" required:"true"`
}
// String returns the string representation
func (s AddTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AddTagsInput) GoString() string {
return s.String()
}
// Contains the output of AddTags.
type AddTagsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s AddTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s AddTagsOutput) GoString() string {
return s.String()
}
// Contains the parameters for CreatePipeline.
type CreatePipelineInput struct {
_ struct{} `type:"structure"`
// The description for the pipeline.
Description *string `locationName:"description" type:"string"`
// The name for the pipeline. You can use the same name for multiple pipelines
// associated with your AWS account, because AWS Data Pipeline assigns each
// pipeline a unique pipeline identifier.
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// A list of tags to associate with the pipeline at creation. Tags let you control
// access to pipelines. For more information, see Controlling User Access to
// Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
Tags []*Tag `locationName:"tags" type:"list"`
// A unique identifier. 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 CreatePipeline. For example,
// if the first call to CreatePipeline does not succeed, you can pass in the
// same unique identifier and pipeline name combination on a subsequent call
// to CreatePipeline. CreatePipeline ensures that if a pipeline already exists
// with the same name and unique identifier, a new pipeline is not 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.
UniqueId *string `locationName:"uniqueId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s CreatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of CreatePipeline.
type CreatePipelineOutput struct {
_ struct{} `type:"structure"`
// The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
// df-06372391ZG65EXAMPLE.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s CreatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s CreatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DeactivatePipeline.
type DeactivatePipelineInput struct {
_ struct{} `type:"structure"`
// Indicates whether to cancel any running objects. The default is true, which
// sets the state of any running objects to CANCELED. If this value is false,
// the pipeline is deactivated after all running objects finish.
CancelActive *bool `locationName:"cancelActive" type:"boolean"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeactivatePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeactivatePipelineInput) GoString() string {
return s.String()
}
// Contains the output of DeactivatePipeline.
type DeactivatePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeactivatePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeactivatePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DeletePipeline.
type DeletePipelineInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DeletePipelineInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeletePipelineInput) GoString() string {
return s.String()
}
type DeletePipelineOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s DeletePipelineOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DeletePipelineOutput) GoString() string {
return s.String()
}
// Contains the parameters for DescribeObjects.
type DescribeObjectsInput struct {
_ struct{} `type:"structure"`
// Indicates whether any expressions in the object should be evaluated when
// the object descriptions are returned.
EvaluateExpressions *bool `locationName:"evaluateExpressions" type:"boolean"`
// The starting point for the results to be returned. For the first call, this
// value should be empty. As long as there are more results, continue to call
// DescribeObjects with the marker value from the previous call to retrieve
// the next set of results.
Marker *string `locationName:"marker" type:"string"`
// The IDs 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.
ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
// The ID of the pipeline that contains the object definitions.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s DescribeObjectsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeObjectsInput) GoString() string {
return s.String()
}
// Contains the output of DescribeObjects.
type DescribeObjectsOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there are more results to return.
HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
// The starting point for the next page of results. To view the next page of
// results, call DescribeObjects again with this marker value. If the value
// is null, there are no more results.
Marker *string `locationName:"marker" type:"string"`
// An array of object definitions.
PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribeObjectsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribeObjectsOutput) GoString() string {
return s.String()
}
// Contains the parameters for DescribePipelines.
type DescribePipelinesInput struct {
_ struct{} `type:"structure"`
// The IDs of the pipelines to describe. You can pass as many as 25 identifiers
// in a single call. To obtain pipeline IDs, call ListPipelines.
PipelineIds []*string `locationName:"pipelineIds" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribePipelinesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribePipelinesInput) GoString() string {
return s.String()
}
// Contains the output of DescribePipelines.
type DescribePipelinesOutput struct {
_ struct{} `type:"structure"`
// An array of descriptions for the specified pipelines.
PipelineDescriptionList []*PipelineDescription `locationName:"pipelineDescriptionList" type:"list" required:"true"`
}
// String returns the string representation
func (s DescribePipelinesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s DescribePipelinesOutput) GoString() string {
return s.String()
}
// Contains the parameters for EvaluateExpression.
type EvaluateExpressionInput struct {
_ struct{} `type:"structure"`
// The expression to evaluate.
Expression *string `locationName:"expression" type:"string" required:"true"`
// The ID of the object.
ObjectId *string `locationName:"objectId" min:"1" type:"string" required:"true"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s EvaluateExpressionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s EvaluateExpressionInput) GoString() string {
return s.String()
}
// Contains the output of EvaluateExpression.
type EvaluateExpressionOutput struct {
_ struct{} `type:"structure"`
// The evaluated expression.
EvaluatedExpression *string `locationName:"evaluatedExpression" type:"string" required:"true"`
}
// String returns the string representation
func (s EvaluateExpressionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s EvaluateExpressionOutput) GoString() string {
return s.String()
}
// A key-value pair that describes a property of a pipeline object. The value
// is specified as either a string value (StringValue) or a reference to another
// object (RefValue) but not as both.
type Field struct {
_ struct{} `type:"structure"`
// The field identifier.
Key *string `locationName:"key" min:"1" type:"string" required:"true"`
// The field value, expressed as the identifier of another object.
RefValue *string `locationName:"refValue" min:"1" type:"string"`
// The field value, expressed as a String.
StringValue *string `locationName:"stringValue" type:"string"`
}
// String returns the string representation
func (s Field) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Field) GoString() string {
return s.String()
}
// Contains the parameters for GetPipelineDefinition.
type GetPipelineDefinitionInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The version of the pipeline definition to retrieve. Set this parameter to
// latest (default) to use the last definition saved to the pipeline or active
// to use the last definition that was activated.
Version *string `locationName:"version" type:"string"`
}
// String returns the string representation
func (s GetPipelineDefinitionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetPipelineDefinitionInput) GoString() string {
return s.String()
}
// Contains the output of GetPipelineDefinition.
type GetPipelineDefinitionOutput struct {
_ struct{} `type:"structure"`
// The parameter objects used in the pipeline definition.
ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
// The parameter values used in the pipeline definition.
ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
// The objects defined in the pipeline.
PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list"`
}
// String returns the string representation
func (s GetPipelineDefinitionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s GetPipelineDefinitionOutput) GoString() string {
return s.String()
}
// Identity information for the EC2 instance that is hosting the task runner.
// You can get this value by calling a metadata URI from the EC2 instance. For
// more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html)
// in the Amazon Elastic Compute Cloud User Guide. 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.
type InstanceIdentity struct {
_ struct{} `type:"structure"`
// A description of an 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.
Document *string `locationName:"document" type:"string"`
// A signature which can be used to verify the accuracy and authenticity of
// the information provided in the instance identity document.
Signature *string `locationName:"signature" type:"string"`
}
// String returns the string representation
func (s InstanceIdentity) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s InstanceIdentity) GoString() string {
return s.String()
}
// Contains the parameters for ListPipelines.
type ListPipelinesInput struct {
_ struct{} `type:"structure"`
// The starting point for the results to be returned. For the first call, this
// value should be empty. As long as there are more results, continue to call
// ListPipelines with the marker value from the previous call to retrieve the
// next set of results.
Marker *string `locationName:"marker" type:"string"`
}
// String returns the string representation
func (s ListPipelinesInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListPipelinesInput) GoString() string {
return s.String()
}
// Contains the output of ListPipelines.
type ListPipelinesOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there are more results that can be obtained by a subsequent
// call.
HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
// The starting point for the next page of results. To view the next page of
// results, call ListPipelinesOutput again with this marker value. If the value
// is null, there are no more results.
Marker *string `locationName:"marker" type:"string"`
// The pipeline identifiers. If you require additional information about the
// pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.
PipelineIdList []*PipelineIdName `locationName:"pipelineIdList" type:"list" required:"true"`
}
// String returns the string representation
func (s ListPipelinesOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ListPipelinesOutput) GoString() string {
return s.String()
}
// Contains a logical operation for comparing the value of a field with a specified
// value.
type Operator struct {
_ struct{} `type:"structure"`
// The logical operation to be performed: equal (EQ), equal reference (REF_EQ),
// less than or equal (LE), greater than or equal (GE), or between (BETWEEN).
// Equal reference (REF_EQ) 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.
//
// The comparison operators EQ and REF_EQ act on the following fields:
//
// name @sphere parent @componentParent @instanceParent @status @scheduledStartTime
// @scheduledEndTime @actualStartTime @actualEndTime The comparison operators
// GE, LE, and BETWEEN act on the following fields:
//
// @scheduledStartTime @scheduledEndTime @actualStartTime @actualEndTime
// 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".
Type *string `locationName:"type" type:"string" enum:"OperatorType"`
// The value that the actual field value will be compared with.
Values []*string `locationName:"values" type:"list"`
}
// String returns the string representation
func (s Operator) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Operator) GoString() string {
return s.String()
}
// The attributes allowed or specified with a parameter object.
type ParameterAttribute struct {
_ struct{} `type:"structure"`
// The field identifier.
Key *string `locationName:"key" min:"1" type:"string" required:"true"`
// The field value, expressed as a String.
StringValue *string `locationName:"stringValue" type:"string" required:"true"`
}
// String returns the string representation
func (s ParameterAttribute) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ParameterAttribute) GoString() string {
return s.String()
}
// Contains information about a parameter object.
type ParameterObject struct {
_ struct{} `type:"structure"`
// The attributes of the parameter object.
Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`
// The ID of the parameter object.
Id *string `locationName:"id" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s ParameterObject) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ParameterObject) GoString() string {
return s.String()
}
// A value or list of parameter values.
type ParameterValue struct {
_ struct{} `type:"structure"`
// The ID of the parameter value.
Id *string `locationName:"id" min:"1" type:"string" required:"true"`
// The field value, expressed as a String.
StringValue *string `locationName:"stringValue" type:"string" required:"true"`
}
// String returns the string representation
func (s ParameterValue) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ParameterValue) GoString() string {
return s.String()
}
// Contains pipeline metadata.
type PipelineDescription struct {
_ struct{} `type:"structure"`
// Description of the pipeline.
Description *string `locationName:"description" type:"string"`
// A list of read-only fields that contain metadata about the pipeline: @userId,
// @accountId, and @pipelineState.
Fields []*Field `locationName:"fields" type:"list" required:"true"`
// The name of the pipeline.
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
// The pipeline identifier that was assigned by AWS Data Pipeline. This is a
// string of the form df-297EG78HU43EEXAMPLE.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// A list of tags to associated with a pipeline. Tags let you control access
// to pipelines. For more information, see Controlling User Access to Pipelines
// (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
Tags []*Tag `locationName:"tags" type:"list"`
}
// String returns the string representation
func (s PipelineDescription) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PipelineDescription) GoString() string {
return s.String()
}
// Contains the name and identifier of a pipeline.
type PipelineIdName struct {
_ struct{} `type:"structure"`
// The ID of the pipeline that was assigned by AWS Data Pipeline. This is a
// string of the form df-297EG78HU43EEXAMPLE.
Id *string `locationName:"id" min:"1" type:"string"`
// The name of the pipeline.
Name *string `locationName:"name" min:"1" type:"string"`
}
// String returns the string representation
func (s PipelineIdName) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PipelineIdName) GoString() string {
return s.String()
}
// 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.
type PipelineObject struct {
_ struct{} `type:"structure"`
// Key-value pairs that define the properties of the object.
Fields []*Field `locationName:"fields" type:"list" required:"true"`
// The ID of the object.
Id *string `locationName:"id" min:"1" type:"string" required:"true"`
// The name of the object.
Name *string `locationName:"name" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s PipelineObject) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PipelineObject) GoString() string {
return s.String()
}
// Contains the parameters for PollForTask.
type PollForTaskInput struct {
_ struct{} `type:"structure"`
// The public DNS name of the calling task runner.
Hostname *string `locationName:"hostname" min:"1" type:"string"`
// Identity information for the EC2 instance that is hosting the task runner.
// You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id.
// For more information, see Instance Metadata (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html)
// in the Amazon Elastic Compute Cloud User Guide. 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.
InstanceIdentity *InstanceIdentity `locationName:"instanceIdentity" type:"structure"`
// 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 workerGroup in the call to PollForTask.
// There are no wildcard values permitted in workerGroup; the string must be
// an exact, case-sensitive, match.
WorkerGroup *string `locationName:"workerGroup" type:"string" required:"true"`
}
// String returns the string representation
func (s PollForTaskInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PollForTaskInput) GoString() string {
return s.String()
}
// Contains the output of PollForTask.
type PollForTaskOutput struct {
_ struct{} `type:"structure"`
// 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 ReportTaskProgress and SetTaskStatus.
TaskObject *TaskObject `locationName:"taskObject" type:"structure"`
}
// String returns the string representation
func (s PollForTaskOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PollForTaskOutput) GoString() string {
return s.String()
}
// Contains the parameters for PutPipelineDefinition.
type PutPipelineDefinitionInput struct {
_ struct{} `type:"structure"`
// The parameter objects used with the pipeline.
ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
// The parameter values used with the pipeline.
ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The objects that define the pipeline. These objects overwrite the existing
// pipeline definition.
PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
}
// String returns the string representation
func (s PutPipelineDefinitionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PutPipelineDefinitionInput) GoString() string {
return s.String()
}
// Contains the output of PutPipelineDefinition.
type PutPipelineDefinitionOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there were validation errors, and the pipeline definition
// is stored but cannot be activated until you correct the pipeline and call
// PutPipelineDefinition to commit the corrected pipeline.
Errored *bool `locationName:"errored" type:"boolean" required:"true"`
// The validation errors that are associated with the objects defined in pipelineObjects.
ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`
// The validation warnings that are associated with the objects defined in pipelineObjects.
ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
}
// String returns the string representation
func (s PutPipelineDefinitionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s PutPipelineDefinitionOutput) GoString() string {
return s.String()
}
// Defines the query to run against an object.
type Query struct {
_ struct{} `type:"structure"`
// List of selectors that define the query. An object must satisfy all of the
// selectors to match the query.
Selectors []*Selector `locationName:"selectors" type:"list"`
}
// String returns the string representation
func (s Query) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Query) GoString() string {
return s.String()
}
// Contains the parameters for QueryObjects.
type QueryObjectsInput struct {
_ struct{} `type:"structure"`
// The maximum number of object names that QueryObjects will return in a single
// call. The default value is 100.
Limit *int64 `locationName:"limit" type:"integer"`
// The starting point for the results to be returned. For the first call, this
// value should be empty. As long as there are more results, continue to call
// QueryObjects with the marker value from the previous call to retrieve the
// next set of results.
Marker *string `locationName:"marker" type:"string"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The query that defines the objects to be returned. The Query object can contain
// a maximum of ten selectors. The conditions in the query are limited to top-level
// String fields in the object. These filters can be applied to components,
// instances, and attempts.
Query *Query `locationName:"query" type:"structure"`
// Indicates whether the query applies to components or instances. The possible
// values are: COMPONENT, INSTANCE, and ATTEMPT.
Sphere *string `locationName:"sphere" type:"string" required:"true"`
}
// String returns the string representation
func (s QueryObjectsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s QueryObjectsInput) GoString() string {
return s.String()
}
// Contains the output of QueryObjects.
type QueryObjectsOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there are more results that can be obtained by a subsequent
// call.
HasMoreResults *bool `locationName:"hasMoreResults" type:"boolean"`
// The identifiers that match the query selectors.
Ids []*string `locationName:"ids" type:"list"`
// The starting point for the next page of results. To view the next page of
// results, call QueryObjects again with this marker value. If the value is
// null, there are no more results.
Marker *string `locationName:"marker" type:"string"`
}
// String returns the string representation
func (s QueryObjectsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s QueryObjectsOutput) GoString() string {
return s.String()
}
// Contains the parameters for RemoveTags.
type RemoveTagsInput struct {
_ struct{} `type:"structure"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The keys of the tags to remove.
TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
}
// String returns the string representation
func (s RemoveTagsInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s RemoveTagsInput) GoString() string {
return s.String()
}
// Contains the output of RemoveTags.
type RemoveTagsOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s RemoveTagsOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s RemoveTagsOutput) GoString() string {
return s.String()
}
// Contains the parameters for ReportTaskProgress.
type ReportTaskProgressInput struct {
_ struct{} `type:"structure"`
// Key-value pairs that define the properties of the ReportTaskProgressInput
// object.
Fields []*Field `locationName:"fields" type:"list"`
// The ID of the task assigned to the task runner. This value is provided in
// the response for PollForTask.
TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
}
// String returns the string representation
func (s ReportTaskProgressInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ReportTaskProgressInput) GoString() string {
return s.String()
}
// Contains the output of ReportTaskProgress.
type ReportTaskProgressOutput struct {
_ struct{} `type:"structure"`
// If true, the calling task runner should cancel processing of the task. The
// task runner does not need to call SetTaskStatus for canceled tasks.
Canceled *bool `locationName:"canceled" type:"boolean" required:"true"`
}
// String returns the string representation
func (s ReportTaskProgressOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ReportTaskProgressOutput) GoString() string {
return s.String()
}
// Contains the parameters for ReportTaskRunnerHeartbeat.
type ReportTaskRunnerHeartbeatInput struct {
_ struct{} `type:"structure"`
// The public DNS name of the task runner.
Hostname *string `locationName:"hostname" min:"1" type:"string"`
// The ID 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.
TaskrunnerId *string `locationName:"taskrunnerId" min:"1" type:"string" required:"true"`
// 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 workerGroup. There are no wildcard
// values permitted in workerGroup; the string must be an exact, case-sensitive,
// match.
WorkerGroup *string `locationName:"workerGroup" type:"string"`
}
// String returns the string representation
func (s ReportTaskRunnerHeartbeatInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ReportTaskRunnerHeartbeatInput) GoString() string {
return s.String()
}
// Contains the output of ReportTaskRunnerHeartbeat.
type ReportTaskRunnerHeartbeatOutput struct {
_ struct{} `type:"structure"`
// Indicates whether the calling task runner should terminate.
Terminate *bool `locationName:"terminate" type:"boolean" required:"true"`
}
// String returns the string representation
func (s ReportTaskRunnerHeartbeatOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ReportTaskRunnerHeartbeatOutput) GoString() string {
return s.String()
}
// A comparision that is used to determine whether a query should return this
// object.
type Selector struct {
_ struct{} `type:"structure"`
// 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.
FieldName *string `locationName:"fieldName" type:"string"`
// Contains a logical operation for comparing the value of a field with a specified
// value.
Operator *Operator `locationName:"operator" type:"structure"`
}
// String returns the string representation
func (s Selector) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Selector) GoString() string {
return s.String()
}
// Contains the parameters for SetStatus.
type SetStatusInput struct {
_ struct{} `type:"structure"`
// The IDs of the objects. The corresponding objects can be either physical
// or components, but not a mix of both types.
ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
// The ID of the pipeline that contains the objects.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The status to be set on all the objects specified in objectIds. For components,
// use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
Status *string `locationName:"status" type:"string" required:"true"`
}
// String returns the string representation
func (s SetStatusInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s SetStatusInput) GoString() string {
return s.String()
}
type SetStatusOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s SetStatusOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s SetStatusOutput) GoString() string {
return s.String()
}
// Contains the parameters for SetTaskStatus.
type SetTaskStatusInput struct {
_ struct{} `type:"structure"`
// If an error occurred during the task, this value specifies the error code.
// 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.
ErrorId *string `locationName:"errorId" type:"string"`
// 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.
ErrorMessage *string `locationName:"errorMessage" type:"string"`
// 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.
ErrorStackTrace *string `locationName:"errorStackTrace" type:"string"`
// The ID of the task assigned to the task runner. This value is provided in
// the response for PollForTask.
TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
// If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully.
// Preconditions use false.
TaskStatus *string `locationName:"taskStatus" type:"string" required:"true" enum:"TaskStatus"`
}
// String returns the string representation
func (s SetTaskStatusInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s SetTaskStatusInput) GoString() string {
return s.String()
}
// Contains the output of SetTaskStatus.
type SetTaskStatusOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s SetTaskStatusOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s SetTaskStatusOutput) GoString() string {
return s.String()
}
// Tags are key/value pairs defined by a user and associated with a pipeline
// to control access. AWS Data Pipeline allows you to associate ten tags per
// pipeline. For more information, see Controlling User Access to Pipelines
// (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
type Tag struct {
_ struct{} `type:"structure"`
// The key name of a tag defined by a user. For more information, see Controlling
// User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
Key *string `locationName:"key" min:"1" type:"string" required:"true"`
// The optional value portion of a tag defined by a user. For more information,
// see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
// in the AWS Data Pipeline Developer Guide.
Value *string `locationName:"value" type:"string" required:"true"`
}
// String returns the string representation
func (s Tag) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s Tag) GoString() string {
return s.String()
}
// Contains information about a pipeline task that is assigned to a task runner.
type TaskObject struct {
_ struct{} `type:"structure"`
// The ID of the pipeline task attempt object. AWS Data Pipeline uses this value
// to track how many times a task is attempted.
AttemptId *string `locationName:"attemptId" min:"1" type:"string"`
// Connection information for the location where the task runner will publish
// the output of the task.
Objects map[string]*PipelineObject `locationName:"objects" type:"map"`
// The ID of the pipeline that provided the task.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string"`
// An internal identifier for the task. This ID is passed to the SetTaskStatus
// and ReportTaskProgress actions.
TaskId *string `locationName:"taskId" min:"1" type:"string"`
}
// String returns the string representation
func (s TaskObject) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s TaskObject) GoString() string {
return s.String()
}
// Contains the parameters for ValidatePipelineDefinition.
type ValidatePipelineDefinitionInput struct {
_ struct{} `type:"structure"`
// The parameter objects used with the pipeline.
ParameterObjects []*ParameterObject `locationName:"parameterObjects" type:"list"`
// The parameter values used with the pipeline.
ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
// The ID of the pipeline.
PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
// The objects that define the pipeline changes to validate against the pipeline.
PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
}
// String returns the string representation
func (s ValidatePipelineDefinitionInput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ValidatePipelineDefinitionInput) GoString() string {
return s.String()
}
// Contains the output of ValidatePipelineDefinition.
type ValidatePipelineDefinitionOutput struct {
_ struct{} `type:"structure"`
// Indicates whether there were validation errors.
Errored *bool `locationName:"errored" type:"boolean" required:"true"`
// Any validation errors that were found.
ValidationErrors []*ValidationError `locationName:"validationErrors" type:"list"`
// Any validation warnings that were found.
ValidationWarnings []*ValidationWarning `locationName:"validationWarnings" type:"list"`
}
// String returns the string representation
func (s ValidatePipelineDefinitionOutput) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ValidatePipelineDefinitionOutput) GoString() string {
return s.String()
}
// Defines a validation error. Validation errors prevent pipeline activation.
// The set of validation errors that can be returned are defined by AWS Data
// Pipeline.
type ValidationError struct {
_ struct{} `type:"structure"`
// A description of the validation error.
Errors []*string `locationName:"errors" type:"list"`
// The identifier of the object that contains the validation error.
Id *string `locationName:"id" min:"1" type:"string"`
}
// String returns the string representation
func (s ValidationError) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ValidationError) GoString() string {
return s.String()
}
// Defines a validation warning. Validation warnings do not prevent pipeline
// activation. The set of validation warnings that can be returned are defined
// by AWS Data Pipeline.
type ValidationWarning struct {
_ struct{} `type:"structure"`
// The identifier of the object that contains the validation warning.
Id *string `locationName:"id" min:"1" type:"string"`
// A description of the validation warning.
Warnings []*string `locationName:"warnings" type:"list"`
}
// String returns the string representation
func (s ValidationWarning) String() string {
return awsutil.Prettify(s)
}
// GoString returns the string representation
func (s ValidationWarning) GoString() string {
return s.String()
}
const (
// @enum OperatorType
OperatorTypeEq = "EQ"
// @enum OperatorType
OperatorTypeRefEq = "REF_EQ"
// @enum OperatorType
OperatorTypeLe = "LE"
// @enum OperatorType
OperatorTypeGe = "GE"
// @enum OperatorType
OperatorTypeBetween = "BETWEEN"
)
const (
// @enum TaskStatus
TaskStatusFinished = "FINISHED"
// @enum TaskStatus
TaskStatusFailed = "FAILED"
// @enum TaskStatus
TaskStatusFalse = "FALSE"
)
|