codepipeline.d.ts
96.9 KB
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
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class CodePipeline extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: CodePipeline.Types.ClientConfiguration)
config: Config & CodePipeline.Types.ClientConfiguration;
/**
* Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
*/
acknowledgeJob(params: CodePipeline.Types.AcknowledgeJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
/**
* Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.
*/
acknowledgeJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeJobOutput) => void): Request<CodePipeline.Types.AcknowledgeJobOutput, AWSError>;
/**
* Confirms a job worker has received the specified job. Used for partner actions only.
*/
acknowledgeThirdPartyJob(params: CodePipeline.Types.AcknowledgeThirdPartyJobInput, callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
/**
* Confirms a job worker has received the specified job. Used for partner actions only.
*/
acknowledgeThirdPartyJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
/**
* Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
*/
createCustomActionType(params: CodePipeline.Types.CreateCustomActionTypeInput, callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
/**
* Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.
*/
createCustomActionType(callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
/**
* Creates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
*/
createPipeline(params: CodePipeline.Types.CreatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
/**
* Creates a pipeline. In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
*/
createPipeline(callback?: (err: AWSError, data: CodePipeline.Types.CreatePipelineOutput) => void): Request<CodePipeline.Types.CreatePipelineOutput, AWSError>;
/**
* Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
*/
deleteCustomActionType(params: CodePipeline.Types.DeleteCustomActionTypeInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only. To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
*/
deleteCustomActionType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(params: CodePipeline.Types.DeletePipelineInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified pipeline.
*/
deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
*/
deleteWebhook(params: CodePipeline.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
/**
* Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
*/
deleteWebhook(callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
/**
* Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
*/
deregisterWebhookWithThirdParty(params: CodePipeline.Types.DeregisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
*/
deregisterWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.DeregisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*/
disableStageTransition(params: CodePipeline.Types.DisableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
*/
disableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*/
enableStageTransition(params: CodePipeline.Types.EnableStageTransitionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables artifacts in a pipeline to transition to a stage in a pipeline.
*/
enableStageTransition(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getJobDetails(params: CodePipeline.Types.GetJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
/**
* Returns information about a job. Used for custom actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
/**
* Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
*/
getPipeline(params: CodePipeline.Types.GetPipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
/**
* Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.
*/
getPipeline(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineOutput) => void): Request<CodePipeline.Types.GetPipelineOutput, AWSError>;
/**
* Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
*/
getPipelineExecution(params: CodePipeline.Types.GetPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
/**
* Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.
*/
getPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineExecutionOutput) => void): Request<CodePipeline.Types.GetPipelineExecutionOutput, AWSError>;
/**
* Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
*/
getPipelineState(params: CodePipeline.Types.GetPipelineStateInput, callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
/**
* Returns information about the state of a pipeline, including the stages and actions. Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.
*/
getPipelineState(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
/**
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getThirdPartyJobDetails(params: CodePipeline.Types.GetThirdPartyJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
/**
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
getThirdPartyJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
/**
* Lists the action executions that have occurred in a pipeline.
*/
listActionExecutions(params: CodePipeline.Types.ListActionExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
/**
* Lists the action executions that have occurred in a pipeline.
*/
listActionExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
/**
* Gets a summary of all AWS CodePipeline action types associated with your account.
*/
listActionTypes(params: CodePipeline.Types.ListActionTypesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
/**
* Gets a summary of all AWS CodePipeline action types associated with your account.
*/
listActionTypes(callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
/**
* Gets a summary of the most recent executions for a pipeline.
*/
listPipelineExecutions(params: CodePipeline.Types.ListPipelineExecutionsInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
/**
* Gets a summary of the most recent executions for a pipeline.
*/
listPipelineExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelineExecutionsOutput) => void): Request<CodePipeline.Types.ListPipelineExecutionsOutput, AWSError>;
/**
* Gets a summary of all of the pipelines associated with your account.
*/
listPipelines(params: CodePipeline.Types.ListPipelinesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
/**
* Gets a summary of all of the pipelines associated with your account.
*/
listPipelines(callback?: (err: AWSError, data: CodePipeline.Types.ListPipelinesOutput) => void): Request<CodePipeline.Types.ListPipelinesOutput, AWSError>;
/**
* Gets the set of key-value pairs (metadata) that are used to manage the resource.
*/
listTagsForResource(params: CodePipeline.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
/**
* Gets the set of key-value pairs (metadata) that are used to manage the resource.
*/
listTagsForResource(callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
/**
* Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
*/
listWebhooks(params: CodePipeline.Types.ListWebhooksInput, callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
/**
* Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
*/
listWebhooks(callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
/**
* Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
pollForJobs(params: CodePipeline.Types.PollForJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
/**
* Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains "AWS" or "ThirdParty" in the owner field, the PollForJobs action returns an error. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
*/
pollForJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
/**
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
*/
pollForThirdPartyJobs(params: CodePipeline.Types.PollForThirdPartyJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
/**
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, AWS CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
*/
pollForThirdPartyJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
/**
* Provides information to AWS CodePipeline about new revisions to a source.
*/
putActionRevision(params: CodePipeline.Types.PutActionRevisionInput, callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
/**
* Provides information to AWS CodePipeline about new revisions to a source.
*/
putActionRevision(callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
/**
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
*/
putApprovalResult(params: CodePipeline.Types.PutApprovalResultInput, callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
/**
* Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.
*/
putApprovalResult(callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
/**
* Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobFailureResult(params: CodePipeline.Types.PutJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobSuccessResult(params: CodePipeline.Types.PutJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.
*/
putJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobFailureResult(params: CodePipeline.Types.PutThirdPartyJobFailureResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobFailureResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobSuccessResult(params: CodePipeline.Types.PutThirdPartyJobSuccessResultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
*/
putThirdPartyJobSuccessResult(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
*/
putWebhook(params: CodePipeline.Types.PutWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
/**
* Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.
*/
putWebhook(callback?: (err: AWSError, data: CodePipeline.Types.PutWebhookOutput) => void): Request<CodePipeline.Types.PutWebhookOutput, AWSError>;
/**
* Configures a connection between the webhook that was created and the external tool with events to be detected.
*/
registerWebhookWithThirdParty(params: CodePipeline.Types.RegisterWebhookWithThirdPartyInput, callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Configures a connection between the webhook that was created and the external tool with events to be detected.
*/
registerWebhookWithThirdParty(callback?: (err: AWSError, data: CodePipeline.Types.RegisterWebhookWithThirdPartyOutput) => void): Request<CodePipeline.Types.RegisterWebhookWithThirdPartyOutput, AWSError>;
/**
* Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
*/
retryStageExecution(params: CodePipeline.Types.RetryStageExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
/**
* Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.
*/
retryStageExecution(callback?: (err: AWSError, data: CodePipeline.Types.RetryStageExecutionOutput) => void): Request<CodePipeline.Types.RetryStageExecutionOutput, AWSError>;
/**
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
*/
startPipelineExecution(params: CodePipeline.Types.StartPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
/**
* Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.
*/
startPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StartPipelineExecutionOutput) => void): Request<CodePipeline.Types.StartPipelineExecutionOutput, AWSError>;
/**
* Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
*/
stopPipelineExecution(params: CodePipeline.Types.StopPipelineExecutionInput, callback?: (err: AWSError, data: CodePipeline.Types.StopPipelineExecutionOutput) => void): Request<CodePipeline.Types.StopPipelineExecutionOutput, AWSError>;
/**
* Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.
*/
stopPipelineExecution(callback?: (err: AWSError, data: CodePipeline.Types.StopPipelineExecutionOutput) => void): Request<CodePipeline.Types.StopPipelineExecutionOutput, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(params: CodePipeline.Types.TagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
/**
* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
*/
tagResource(callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
/**
* Removes tags from an AWS resource.
*/
untagResource(params: CodePipeline.Types.UntagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
/**
* Removes tags from an AWS resource.
*/
untagResource(callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
/**
* Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
*/
updatePipeline(params: CodePipeline.Types.UpdatePipelineInput, callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
/**
* Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.
*/
updatePipeline(callback?: (err: AWSError, data: CodePipeline.Types.UpdatePipelineOutput) => void): Request<CodePipeline.Types.UpdatePipelineOutput, AWSError>;
}
declare namespace CodePipeline {
export type AWSRegionName = string;
export interface AWSSessionCredentials {
/**
* The access key for the session.
*/
accessKeyId: AccessKeyId;
/**
* The secret access key for the session.
*/
secretAccessKey: SecretAccessKey;
/**
* The token for the session.
*/
sessionToken: SessionToken;
}
export type AccessKeyId = string;
export type AccountId = string;
export interface AcknowledgeJobInput {
/**
* The unique system-generated ID of the job for which you want to confirm receipt.
*/
jobId: JobId;
/**
* A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
*/
nonce: Nonce;
}
export interface AcknowledgeJobOutput {
/**
* Whether the job worker has received the specified job.
*/
status?: JobStatus;
}
export interface AcknowledgeThirdPartyJobInput {
/**
* The unique system-generated ID of the job.
*/
jobId: ThirdPartyJobId;
/**
* A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
*/
nonce: Nonce;
/**
* The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*/
clientToken: ClientToken;
}
export interface AcknowledgeThirdPartyJobOutput {
/**
* The status information for the third party job, if any.
*/
status?: JobStatus;
}
export type ActionCategory = "Source"|"Build"|"Deploy"|"Test"|"Invoke"|"Approval"|string;
export interface ActionConfiguration {
/**
* The configuration data for the action.
*/
configuration?: ActionConfigurationMap;
}
export type ActionConfigurationKey = string;
export type ActionConfigurationMap = {[key: string]: ActionConfigurationValue};
export interface ActionConfigurationProperty {
/**
* The name of the action configuration property.
*/
name: ActionConfigurationKey;
/**
* Whether the configuration property is a required value.
*/
required: Boolean;
/**
* Whether the configuration property is a key.
*/
key: Boolean;
/**
* Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs. When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.
*/
secret: Boolean;
/**
* Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret. If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
*/
queryable?: Boolean;
/**
* The description of the action configuration property that is displayed to users.
*/
description?: Description;
/**
* The type of the configuration property.
*/
type?: ActionConfigurationPropertyType;
}
export type ActionConfigurationPropertyList = ActionConfigurationProperty[];
export type ActionConfigurationPropertyType = "String"|"Number"|"Boolean"|string;
export type ActionConfigurationQueryableValue = string;
export type ActionConfigurationValue = string;
export interface ActionContext {
/**
* The name of the action in the context of a job.
*/
name?: ActionName;
/**
* The system-generated unique ID that corresponds to an action's execution.
*/
actionExecutionId?: ActionExecutionId;
}
export interface ActionDeclaration {
/**
* The action declaration's name.
*/
name: ActionName;
/**
* Specifies the action type and the provider of the action.
*/
actionTypeId: ActionTypeId;
/**
* The order in which actions are run.
*/
runOrder?: ActionRunOrder;
/**
* The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide. The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: JSON: "Configuration" : { Key : Value },
*/
configuration?: ActionConfigurationMap;
/**
* The name or ID of the result of the action declaration, such as a test or build artifact.
*/
outputArtifacts?: OutputArtifactList;
/**
* The name or ID of the artifact consumed by the action, such as a test or build artifact.
*/
inputArtifacts?: InputArtifactList;
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
roleArn?: RoleArn;
/**
* The action declaration's AWS Region, such as us-east-1.
*/
region?: AWSRegionName;
/**
* The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*/
namespace?: ActionNamespace;
}
export interface ActionExecution {
/**
* The status of the action, or for a completed action, the last status of the action.
*/
status?: ActionExecutionStatus;
/**
* A summary of the run of the action.
*/
summary?: ExecutionSummary;
/**
* The last status change of the action.
*/
lastStatusChange?: Timestamp;
/**
* The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.
*/
token?: ActionExecutionToken;
/**
* The ARN of the user who last changed the pipeline.
*/
lastUpdatedBy?: LastUpdatedBy;
/**
* The external ID of the run of the action.
*/
externalExecutionId?: ExecutionId;
/**
* The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).
*/
externalExecutionUrl?: Url;
/**
* A percentage of completeness of the action as it runs.
*/
percentComplete?: Percentage;
/**
* The details of an error returned by a URL external to AWS.
*/
errorDetails?: ErrorDetails;
}
export interface ActionExecutionDetail {
/**
* The pipeline execution ID for the action execution.
*/
pipelineExecutionId?: PipelineExecutionId;
/**
* The action execution ID.
*/
actionExecutionId?: ActionExecutionId;
/**
* The version of the pipeline where the action was run.
*/
pipelineVersion?: PipelineVersion;
/**
* The name of the stage that contains the action.
*/
stageName?: StageName;
/**
* The name of the action.
*/
actionName?: ActionName;
/**
* The start time of the action execution.
*/
startTime?: Timestamp;
/**
* The last update time of the action execution.
*/
lastUpdateTime?: Timestamp;
/**
* The status of the action execution. Status categories are InProgress, Succeeded, and Failed.
*/
status?: ActionExecutionStatus;
/**
* Input details for the action execution, such as role ARN, Region, and input artifacts.
*/
input?: ActionExecutionInput;
/**
* Output details for the action execution, such as the action execution result.
*/
output?: ActionExecutionOutput;
}
export type ActionExecutionDetailList = ActionExecutionDetail[];
export interface ActionExecutionFilter {
/**
* The pipeline execution ID used to filter action execution history.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export type ActionExecutionId = string;
export interface ActionExecutionInput {
actionTypeId?: ActionTypeId;
/**
* Configuration data for an action execution.
*/
configuration?: ActionConfigurationMap;
/**
* Configuration data for an action execution with all variable references replaced with their real values for the execution.
*/
resolvedConfiguration?: ResolvedActionConfigurationMap;
/**
* The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.
*/
roleArn?: RoleArn;
/**
* The AWS Region for the action, such as us-east-1.
*/
region?: AWSRegionName;
/**
* Details of input artifacts of the action that correspond to the action execution.
*/
inputArtifacts?: ArtifactDetailList;
/**
* The variable namespace associated with the action. All variables produced as output by this action fall under this namespace.
*/
namespace?: ActionNamespace;
}
export interface ActionExecutionOutput {
/**
* Details of output artifacts of the action that correspond to the action execution.
*/
outputArtifacts?: ArtifactDetailList;
/**
* Execution result information listed in the output details for an action execution.
*/
executionResult?: ActionExecutionResult;
/**
* The outputVariables field shows the key-value pairs that were output as part of that execution.
*/
outputVariables?: OutputVariablesMap;
}
export interface ActionExecutionResult {
/**
* The action provider's external ID for the action execution.
*/
externalExecutionId?: ExternalExecutionId;
/**
* The action provider's summary for the action execution.
*/
externalExecutionSummary?: ExternalExecutionSummary;
/**
* The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.
*/
externalExecutionUrl?: Url;
}
export type ActionExecutionStatus = "InProgress"|"Abandoned"|"Succeeded"|"Failed"|string;
export type ActionExecutionToken = string;
export type ActionName = string;
export type ActionNamespace = string;
export type ActionOwner = "AWS"|"ThirdParty"|"Custom"|string;
export type ActionProvider = string;
export interface ActionRevision {
/**
* The system-generated unique ID that identifies the revision number of the action.
*/
revisionId: Revision;
/**
* The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).
*/
revisionChangeId: RevisionChangeIdentifier;
/**
* The date and time when the most recent version of the action was created, in timestamp format.
*/
created: Timestamp;
}
export type ActionRunOrder = number;
export interface ActionState {
/**
* The name of the action.
*/
actionName?: ActionName;
/**
* Represents information about the version (or revision) of an action.
*/
currentRevision?: ActionRevision;
/**
* Represents information about the run of an action.
*/
latestExecution?: ActionExecution;
/**
* A URL link for more information about the state of the action, such as a deployment group details page.
*/
entityUrl?: Url;
/**
* A URL link for more information about the revision, such as a commit details page.
*/
revisionUrl?: Url;
}
export type ActionStateList = ActionState[];
export interface ActionType {
/**
* Represents information about an action type.
*/
id: ActionTypeId;
/**
* The settings for the action type.
*/
settings?: ActionTypeSettings;
/**
* The configuration properties for the action type.
*/
actionConfigurationProperties?: ActionConfigurationPropertyList;
/**
* The details of the input artifact for the action, such as its commit ID.
*/
inputArtifactDetails: ArtifactDetails;
/**
* The details of the output artifact of the action, such as its commit ID.
*/
outputArtifactDetails: ArtifactDetails;
}
export interface ActionTypeId {
/**
* A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.
*/
category: ActionCategory;
/**
* The creator of the action being called.
*/
owner: ActionOwner;
/**
* The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
*/
provider: ActionProvider;
/**
* A string that describes the action version.
*/
version: Version;
}
export type ActionTypeList = ActionType[];
export interface ActionTypeSettings {
/**
* The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.
*/
thirdPartyConfigurationUrl?: Url;
/**
* The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
*/
entityUrlTemplate?: UrlTemplate;
/**
* The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.
*/
executionUrlTemplate?: UrlTemplate;
/**
* The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
*/
revisionUrlTemplate?: UrlTemplate;
}
export interface ApprovalResult {
/**
* The summary of the current status of the approval request.
*/
summary: ApprovalSummary;
/**
* The response submitted by a reviewer assigned to an approval action request.
*/
status: ApprovalStatus;
}
export type ApprovalStatus = "Approved"|"Rejected"|string;
export type ApprovalSummary = string;
export type ApprovalToken = string;
export interface Artifact {
/**
* The artifact's name.
*/
name?: ArtifactName;
/**
* The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).
*/
revision?: Revision;
/**
* The location of an artifact.
*/
location?: ArtifactLocation;
}
export interface ArtifactDetail {
/**
* The artifact object name for the action execution.
*/
name?: ArtifactName;
/**
* The Amazon S3 artifact location for the action execution.
*/
s3location?: S3Location;
}
export type ArtifactDetailList = ArtifactDetail[];
export interface ArtifactDetails {
/**
* The minimum number of artifacts allowed for the action type.
*/
minimumCount: MinimumArtifactCount;
/**
* The maximum number of artifacts allowed for the action type.
*/
maximumCount: MaximumArtifactCount;
}
export type ArtifactList = Artifact[];
export interface ArtifactLocation {
/**
* The type of artifact in the location.
*/
type?: ArtifactLocationType;
/**
* The S3 bucket that contains the artifact.
*/
s3Location?: S3ArtifactLocation;
}
export type ArtifactLocationType = "S3"|string;
export type ArtifactName = string;
export interface ArtifactRevision {
/**
* The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an action is created.
*/
name?: ArtifactName;
/**
* The revision ID of the artifact.
*/
revisionId?: Revision;
/**
* An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.
*/
revisionChangeIdentifier?: RevisionChangeIdentifier;
/**
* Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
*/
revisionSummary?: RevisionSummary;
/**
* The date and time when the most recent revision of the artifact was created, in timestamp format.
*/
created?: Timestamp;
/**
* The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
*/
revisionUrl?: Url;
}
export type ArtifactRevisionList = ArtifactRevision[];
export interface ArtifactStore {
/**
* The type of the artifact store, such as S3.
*/
type: ArtifactStoreType;
/**
* The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
*/
location: ArtifactStoreLocation;
/**
* The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.
*/
encryptionKey?: EncryptionKey;
}
export type ArtifactStoreLocation = string;
export type ArtifactStoreMap = {[key: string]: ArtifactStore};
export type ArtifactStoreType = "S3"|string;
export interface BlockerDeclaration {
/**
* Reserved for future use.
*/
name: BlockerName;
/**
* Reserved for future use.
*/
type: BlockerType;
}
export type BlockerName = string;
export type BlockerType = "Schedule"|string;
export type Boolean = boolean;
export type ClientId = string;
export type ClientRequestToken = string;
export type ClientToken = string;
export type Code = string;
export type ContinuationToken = string;
export interface CreateCustomActionTypeInput {
/**
* The category of the custom action, such as a build action or a test action. Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.
*/
category: ActionCategory;
/**
* The provider of the service used in the custom action, such as AWS CodeDeploy.
*/
provider: ActionProvider;
/**
* The version identifier of the custom action.
*/
version: Version;
/**
* URLs that provide users information about this custom action.
*/
settings?: ActionTypeSettings;
/**
* The configuration properties for the custom action. You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.
*/
configurationProperties?: ActionConfigurationPropertyList;
/**
* The details of the input artifact for the action, such as its commit ID.
*/
inputArtifactDetails: ArtifactDetails;
/**
* The details of the output artifact of the action, such as its commit ID.
*/
outputArtifactDetails: ArtifactDetails;
/**
* The tags for the custom action.
*/
tags?: TagList;
}
export interface CreateCustomActionTypeOutput {
/**
* Returns information about the details of an action type.
*/
actionType: ActionType;
/**
* Specifies the tags applied to the custom action.
*/
tags?: TagList;
}
export interface CreatePipelineInput {
/**
* Represents the structure of actions and stages to be performed in the pipeline.
*/
pipeline: PipelineDeclaration;
/**
* The tags for the pipeline.
*/
tags?: TagList;
}
export interface CreatePipelineOutput {
/**
* Represents the structure of actions and stages to be performed in the pipeline.
*/
pipeline?: PipelineDeclaration;
/**
* Specifies the tags applied to the pipeline.
*/
tags?: TagList;
}
export interface CurrentRevision {
/**
* The revision ID of the current version of an artifact.
*/
revision: Revision;
/**
* The change identifier for the current revision.
*/
changeIdentifier: RevisionChangeIdentifier;
/**
* The date and time when the most recent revision of the artifact was created, in timestamp format.
*/
created?: Time;
/**
* The summary of the most recent revision of the artifact.
*/
revisionSummary?: RevisionSummary;
}
export interface DeleteCustomActionTypeInput {
/**
* The category of the custom action that you want to delete, such as source or deploy.
*/
category: ActionCategory;
/**
* The provider of the service used in the custom action, such as AWS CodeDeploy.
*/
provider: ActionProvider;
/**
* The version of the custom action to delete.
*/
version: Version;
}
export interface DeletePipelineInput {
/**
* The name of the pipeline to be deleted.
*/
name: PipelineName;
}
export interface DeleteWebhookInput {
/**
* The name of the webhook you want to delete.
*/
name: WebhookName;
}
export interface DeleteWebhookOutput {
}
export interface DeregisterWebhookWithThirdPartyInput {
/**
* The name of the webhook you want to deregister.
*/
webhookName?: WebhookName;
}
export interface DeregisterWebhookWithThirdPartyOutput {
}
export type Description = string;
export interface DisableStageTransitionInput {
/**
* The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
*/
pipelineName: PipelineName;
/**
* The name of the stage where you want to disable the inbound or outbound transition of artifacts.
*/
stageName: StageName;
/**
* Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).
*/
transitionType: StageTransitionType;
/**
* The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.
*/
reason: DisabledReason;
}
export type DisabledReason = string;
export interface EnableStageTransitionInput {
/**
* The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
*/
pipelineName: PipelineName;
/**
* The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).
*/
stageName: StageName;
/**
* Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
*/
transitionType: StageTransitionType;
}
export type Enabled = boolean;
export interface EncryptionKey {
/**
* The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN. Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.
*/
id: EncryptionKeyId;
/**
* The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.
*/
type: EncryptionKeyType;
}
export type EncryptionKeyId = string;
export type EncryptionKeyType = "KMS"|string;
export interface ErrorDetails {
/**
* The system ID or number code of the error.
*/
code?: Code;
/**
* The text of the error message.
*/
message?: Message;
}
export interface ExecutionDetails {
/**
* The summary of the current status of the actions.
*/
summary?: ExecutionSummary;
/**
* The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
*/
externalExecutionId?: ExecutionId;
/**
* The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
*/
percentComplete?: Percentage;
}
export type ExecutionId = string;
export type ExecutionSummary = string;
export interface ExecutionTrigger {
/**
* The type of change-detection method, command, or user interaction that started a pipeline execution.
*/
triggerType?: TriggerType;
/**
* Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.
*/
triggerDetail?: TriggerDetail;
}
export type ExternalExecutionId = string;
export type ExternalExecutionSummary = string;
export interface FailureDetails {
/**
* The type of the failure.
*/
type: FailureType;
/**
* The message about the failure.
*/
message: Message;
/**
* The external ID of the run of the action that failed.
*/
externalExecutionId?: ExecutionId;
}
export type FailureType = "JobFailed"|"ConfigurationError"|"PermissionError"|"RevisionOutOfSync"|"RevisionUnavailable"|"SystemUnavailable"|string;
export interface GetJobDetailsInput {
/**
* The unique system-generated ID for the job.
*/
jobId: JobId;
}
export interface GetJobDetailsOutput {
/**
* The details of the job. If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
*/
jobDetails?: JobDetails;
}
export interface GetPipelineExecutionInput {
/**
* The name of the pipeline about which you want to get execution details.
*/
pipelineName: PipelineName;
/**
* The ID of the pipeline execution about which you want to get execution details.
*/
pipelineExecutionId: PipelineExecutionId;
}
export interface GetPipelineExecutionOutput {
/**
* Represents information about the execution of a pipeline.
*/
pipelineExecution?: PipelineExecution;
}
export interface GetPipelineInput {
/**
* The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.
*/
name: PipelineName;
/**
* The version number of the pipeline. If you do not specify a version, defaults to the current version.
*/
version?: PipelineVersion;
}
export interface GetPipelineOutput {
/**
* Represents the structure of actions and stages to be performed in the pipeline.
*/
pipeline?: PipelineDeclaration;
/**
* Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
*/
metadata?: PipelineMetadata;
}
export interface GetPipelineStateInput {
/**
* The name of the pipeline about which you want to get information.
*/
name: PipelineName;
}
export interface GetPipelineStateOutput {
/**
* The name of the pipeline for which you want to get the state.
*/
pipelineName?: PipelineName;
/**
* The version number of the pipeline. A newly created pipeline is always assigned a version number of 1.
*/
pipelineVersion?: PipelineVersion;
/**
* A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.
*/
stageStates?: StageStateList;
/**
* The date and time the pipeline was created, in timestamp format.
*/
created?: Timestamp;
/**
* The date and time the pipeline was last updated, in timestamp format.
*/
updated?: Timestamp;
}
export interface GetThirdPartyJobDetailsInput {
/**
* The unique system-generated ID used for identifying the job.
*/
jobId: ThirdPartyJobId;
/**
* The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*/
clientToken: ClientToken;
}
export interface GetThirdPartyJobDetailsOutput {
/**
* The details of the job, including any protected values defined for the job.
*/
jobDetails?: ThirdPartyJobDetails;
}
export interface InputArtifact {
/**
* The name of the artifact to be worked on (for example, "My App"). The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
*/
name: ArtifactName;
}
export type InputArtifactList = InputArtifact[];
export interface Job {
/**
* The unique system-generated ID of the job.
*/
id?: JobId;
/**
* Other data about a job.
*/
data?: JobData;
/**
* A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
*/
nonce?: Nonce;
/**
* The ID of the AWS account to use when performing the job.
*/
accountId?: AccountId;
}
export interface JobData {
/**
* Represents information about an action type.
*/
actionTypeId?: ActionTypeId;
/**
* Represents information about an action configuration.
*/
actionConfiguration?: ActionConfiguration;
/**
* Represents information about a pipeline to a job worker. Includes pipelineArn and pipelineExecutionId for custom jobs.
*/
pipelineContext?: PipelineContext;
/**
* The artifact supplied to the job.
*/
inputArtifacts?: ArtifactList;
/**
* The output of the job.
*/
outputArtifacts?: ArtifactList;
/**
* Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.
*/
artifactCredentials?: AWSSessionCredentials;
/**
* A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.
*/
continuationToken?: ContinuationToken;
/**
* Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.
*/
encryptionKey?: EncryptionKey;
}
export interface JobDetails {
/**
* The unique system-generated ID of the job.
*/
id?: JobId;
/**
* Represents other information about a job required for a job worker to complete the job.
*/
data?: JobData;
/**
* The AWS account ID associated with the job.
*/
accountId?: AccountId;
}
export type JobId = string;
export type JobList = Job[];
export type JobStatus = "Created"|"Queued"|"Dispatched"|"InProgress"|"TimedOut"|"Succeeded"|"Failed"|string;
export type JsonPath = string;
export type LastChangedAt = Date;
export type LastChangedBy = string;
export type LastUpdatedBy = string;
export interface ListActionExecutionsInput {
/**
* The name of the pipeline for which you want to list action execution history.
*/
pipelineName: PipelineName;
/**
* Input information used to filter action execution history.
*/
filter?: ActionExecutionFilter;
/**
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100. Detailed execution history is available for executions run on or after February 21, 2019.
*/
maxResults?: MaxResults;
/**
* The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.
*/
nextToken?: NextToken;
}
export interface ListActionExecutionsOutput {
/**
* The details for a list of recent executions, such as action execution ID.
*/
actionExecutionDetails?: ActionExecutionDetailList;
/**
* If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.
*/
nextToken?: NextToken;
}
export interface ListActionTypesInput {
/**
* Filters the list of action types to those created by a specified entity.
*/
actionOwnerFilter?: ActionOwner;
/**
* An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
*/
nextToken?: NextToken;
}
export interface ListActionTypesOutput {
/**
* Provides details of the action types.
*/
actionTypes: ActionTypeList;
/**
* If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.
*/
nextToken?: NextToken;
}
export interface ListPipelineExecutionsInput {
/**
* The name of the pipeline for which you want to get execution summary information.
*/
pipelineName: PipelineName;
/**
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.
*/
maxResults?: MaxResults;
/**
* The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.
*/
nextToken?: NextToken;
}
export interface ListPipelineExecutionsOutput {
/**
* A list of executions in the history of a pipeline.
*/
pipelineExecutionSummaries?: PipelineExecutionSummaryList;
/**
* A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.
*/
nextToken?: NextToken;
}
export interface ListPipelinesInput {
/**
* An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.
*/
nextToken?: NextToken;
}
export interface ListPipelinesOutput {
/**
* The list of pipelines.
*/
pipelines?: PipelineList;
/**
* If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource to get tags for.
*/
resourceArn: ResourceArn;
/**
* The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
*/
nextToken?: NextToken;
/**
* The maximum number of results to return in a single call.
*/
maxResults?: MaxResults;
}
export interface ListTagsForResourceOutput {
/**
* The tags for the resource.
*/
tags?: TagList;
/**
* If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.
*/
nextToken?: NextToken;
}
export interface ListWebhookItem {
/**
* The detail returned for each webhook, such as the webhook authentication type and filter rules.
*/
definition: WebhookDefinition;
/**
* A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.
*/
url: WebhookUrl;
/**
* The text of the error message about the webhook.
*/
errorMessage?: WebhookErrorMessage;
/**
* The number code of the error.
*/
errorCode?: WebhookErrorCode;
/**
* The date and time a webhook was last successfully triggered, in timestamp format.
*/
lastTriggered?: WebhookLastTriggered;
/**
* The Amazon Resource Name (ARN) of the webhook.
*/
arn?: WebhookArn;
/**
* Specifies the tags applied to the webhook.
*/
tags?: TagList;
}
export interface ListWebhooksInput {
/**
* The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.
*/
NextToken?: NextToken;
/**
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.
*/
MaxResults?: MaxResults;
}
export interface ListWebhooksOutput {
/**
* The JSON detail returned for each webhook in the list output for the ListWebhooks call.
*/
webhooks?: WebhookList;
/**
* If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.
*/
NextToken?: NextToken;
}
export type MatchEquals = string;
export type MaxBatchSize = number;
export type MaxResults = number;
export type MaximumArtifactCount = number;
export type Message = string;
export type MinimumArtifactCount = number;
export type NextToken = string;
export type Nonce = string;
export interface OutputArtifact {
/**
* The name of the output of an artifact, such as "My App". The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions. Output artifact names must be unique within a pipeline.
*/
name: ArtifactName;
}
export type OutputArtifactList = OutputArtifact[];
export type OutputVariablesKey = string;
export type OutputVariablesMap = {[key: string]: OutputVariablesValue};
export type OutputVariablesValue = string;
export type Percentage = number;
export type PipelineArn = string;
export interface PipelineContext {
/**
* The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.
*/
pipelineName?: PipelineName;
/**
* The stage of the pipeline.
*/
stage?: StageContext;
/**
* The context of an action to a job worker in the stage of a pipeline.
*/
action?: ActionContext;
/**
* The Amazon Resource Name (ARN) of the pipeline.
*/
pipelineArn?: PipelineArn;
/**
* The execution ID of the pipeline.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export interface PipelineDeclaration {
/**
* The name of the action to be performed.
*/
name: PipelineName;
/**
* The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
*/
roleArn: RoleArn;
/**
* Represents information about the S3 bucket where artifacts are stored for the pipeline. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
*/
artifactStore?: ArtifactStore;
/**
* A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
*/
artifactStores?: ArtifactStoreMap;
/**
* The stage in which to perform the action.
*/
stages: PipelineStageDeclarationList;
/**
* The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.
*/
version?: PipelineVersion;
}
export interface PipelineExecution {
/**
* The name of the pipeline with the specified pipeline execution.
*/
pipelineName?: PipelineName;
/**
* The version number of the pipeline with the specified pipeline execution.
*/
pipelineVersion?: PipelineVersion;
/**
* The ID of the pipeline execution.
*/
pipelineExecutionId?: PipelineExecutionId;
/**
* The status of the pipeline execution. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully.
*/
status?: PipelineExecutionStatus;
/**
* A list of ArtifactRevision objects included in a pipeline execution.
*/
artifactRevisions?: ArtifactRevisionList;
}
export type PipelineExecutionId = string;
export type PipelineExecutionStatus = "InProgress"|"Stopped"|"Stopping"|"Succeeded"|"Superseded"|"Failed"|string;
export interface PipelineExecutionSummary {
/**
* The ID of the pipeline execution.
*/
pipelineExecutionId?: PipelineExecutionId;
/**
* The status of the pipeline execution. InProgress: The pipeline execution is currently running. Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions. Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode, the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions. Succeeded: The pipeline execution was completed successfully. Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead. For more information, see Superseded Executions. Failed: The pipeline execution was not completed successfully.
*/
status?: PipelineExecutionStatus;
/**
* The date and time when the pipeline execution began, in timestamp format.
*/
startTime?: Timestamp;
/**
* The date and time of the last change to the pipeline execution, in timestamp format.
*/
lastUpdateTime?: Timestamp;
/**
* A list of the source artifact revisions that initiated a pipeline execution.
*/
sourceRevisions?: SourceRevisionList;
/**
* The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.
*/
trigger?: ExecutionTrigger;
/**
* The interaction that stopped a pipeline execution.
*/
stopTrigger?: StopExecutionTrigger;
}
export type PipelineExecutionSummaryList = PipelineExecutionSummary[];
export type PipelineList = PipelineSummary[];
export interface PipelineMetadata {
/**
* The Amazon Resource Name (ARN) of the pipeline.
*/
pipelineArn?: PipelineArn;
/**
* The date and time the pipeline was created, in timestamp format.
*/
created?: Timestamp;
/**
* The date and time the pipeline was last updated, in timestamp format.
*/
updated?: Timestamp;
}
export type PipelineName = string;
export type PipelineStageDeclarationList = StageDeclaration[];
export interface PipelineSummary {
/**
* The name of the pipeline.
*/
name?: PipelineName;
/**
* The version number of the pipeline.
*/
version?: PipelineVersion;
/**
* The date and time the pipeline was created, in timestamp format.
*/
created?: Timestamp;
/**
* The date and time of the last update to the pipeline, in timestamp format.
*/
updated?: Timestamp;
}
export type PipelineVersion = number;
export interface PollForJobsInput {
/**
* Represents information about an action type.
*/
actionTypeId: ActionTypeId;
/**
* The maximum number of jobs to return in a poll for jobs call.
*/
maxBatchSize?: MaxBatchSize;
/**
* A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.
*/
queryParam?: QueryParamMap;
}
export interface PollForJobsOutput {
/**
* Information about the jobs to take action on.
*/
jobs?: JobList;
}
export interface PollForThirdPartyJobsInput {
/**
* Represents information about an action type.
*/
actionTypeId: ActionTypeId;
/**
* The maximum number of jobs to return in a poll for jobs call.
*/
maxBatchSize?: MaxBatchSize;
}
export interface PollForThirdPartyJobsOutput {
/**
* Information about the jobs to take action on.
*/
jobs?: ThirdPartyJobList;
}
export interface PutActionRevisionInput {
/**
* The name of the pipeline that starts processing the revision to the source.
*/
pipelineName: PipelineName;
/**
* The name of the stage that contains the action that acts on the revision.
*/
stageName: StageName;
/**
* The name of the action that processes the revision.
*/
actionName: ActionName;
/**
* Represents information about the version (or revision) of an action.
*/
actionRevision: ActionRevision;
}
export interface PutActionRevisionOutput {
/**
* Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
*/
newRevision?: Boolean;
/**
* The ID of the current workflow state of the pipeline.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export interface PutApprovalResultInput {
/**
* The name of the pipeline that contains the action.
*/
pipelineName: PipelineName;
/**
* The name of the stage that contains the action.
*/
stageName: StageName;
/**
* The name of the action for which approval is requested.
*/
actionName: ActionName;
/**
* Represents information about the result of the approval request.
*/
result: ApprovalResult;
/**
* The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.
*/
token: ApprovalToken;
}
export interface PutApprovalResultOutput {
/**
* The timestamp showing when the approval or rejection was submitted.
*/
approvedAt?: Timestamp;
}
export interface PutJobFailureResultInput {
/**
* The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
*/
jobId: JobId;
/**
* The details about the failure of a job.
*/
failureDetails: FailureDetails;
}
export interface PutJobSuccessResultInput {
/**
* The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
*/
jobId: JobId;
/**
* The ID of the current revision of the artifact successfully worked on by the job.
*/
currentRevision?: CurrentRevision;
/**
* A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
*/
continuationToken?: ContinuationToken;
/**
* The execution details of the successful job, such as the actions taken by the job worker.
*/
executionDetails?: ExecutionDetails;
/**
* Key-value pairs produced as output by a job worker that can be made available to a downstream action configuration. outputVariables can be included only when there is no continuation token on the request.
*/
outputVariables?: OutputVariablesMap;
}
export interface PutThirdPartyJobFailureResultInput {
/**
* The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
*/
jobId: ThirdPartyJobId;
/**
* The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*/
clientToken: ClientToken;
/**
* Represents information about failure details.
*/
failureDetails: FailureDetails;
}
export interface PutThirdPartyJobSuccessResultInput {
/**
* The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
*/
jobId: ThirdPartyJobId;
/**
* The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*/
clientToken: ClientToken;
/**
* Represents information about a current revision.
*/
currentRevision?: CurrentRevision;
/**
* A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
*/
continuationToken?: ContinuationToken;
/**
* The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
*/
executionDetails?: ExecutionDetails;
}
export interface PutWebhookInput {
/**
* The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.
*/
webhook: WebhookDefinition;
/**
* The tags for the webhook.
*/
tags?: TagList;
}
export interface PutWebhookOutput {
/**
* The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
*/
webhook?: ListWebhookItem;
}
export type QueryParamMap = {[key: string]: ActionConfigurationQueryableValue};
export interface RegisterWebhookWithThirdPartyInput {
/**
* The name of an existing webhook created with PutWebhook to register with a supported third party.
*/
webhookName?: WebhookName;
}
export interface RegisterWebhookWithThirdPartyOutput {
}
export type ResolvedActionConfigurationMap = {[key: string]: String};
export type ResourceArn = string;
export interface RetryStageExecutionInput {
/**
* The name of the pipeline that contains the failed stage.
*/
pipelineName: PipelineName;
/**
* The name of the failed stage to be retried.
*/
stageName: StageName;
/**
* The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage
*/
pipelineExecutionId: PipelineExecutionId;
/**
* The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
*/
retryMode: StageRetryMode;
}
export interface RetryStageExecutionOutput {
/**
* The ID of the current workflow execution in the failed stage.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export type Revision = string;
export type RevisionChangeIdentifier = string;
export type RevisionSummary = string;
export type RoleArn = string;
export interface S3ArtifactLocation {
/**
* The name of the S3 bucket.
*/
bucketName: S3BucketName;
/**
* The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
*/
objectKey: S3ObjectKey;
}
export type S3Bucket = string;
export type S3BucketName = string;
export type S3Key = string;
export interface S3Location {
/**
* The Amazon S3 artifact bucket for an action's artifacts.
*/
bucket?: S3Bucket;
/**
* The artifact name.
*/
key?: S3Key;
}
export type S3ObjectKey = string;
export type SecretAccessKey = string;
export type SessionToken = string;
export interface SourceRevision {
/**
* The name of the action that processed the revision to the source artifact.
*/
actionName: ActionName;
/**
* The system-generated unique ID that identifies the revision number of the artifact.
*/
revisionId?: Revision;
/**
* Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
*/
revisionSummary?: RevisionSummary;
/**
* The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.
*/
revisionUrl?: Url;
}
export type SourceRevisionList = SourceRevision[];
export type StageActionDeclarationList = ActionDeclaration[];
export type StageBlockerDeclarationList = BlockerDeclaration[];
export interface StageContext {
/**
* The name of the stage.
*/
name?: StageName;
}
export interface StageDeclaration {
/**
* The name of the stage.
*/
name: StageName;
/**
* Reserved for future use.
*/
blockers?: StageBlockerDeclarationList;
/**
* The actions included in a stage.
*/
actions: StageActionDeclarationList;
}
export interface StageExecution {
/**
* The ID of the pipeline execution associated with the stage.
*/
pipelineExecutionId: PipelineExecutionId;
/**
* The status of the stage, or for a completed stage, the last status of the stage.
*/
status: StageExecutionStatus;
}
export type StageExecutionStatus = "InProgress"|"Failed"|"Stopped"|"Stopping"|"Succeeded"|string;
export type StageName = string;
export type StageRetryMode = "FAILED_ACTIONS"|string;
export interface StageState {
/**
* The name of the stage.
*/
stageName?: StageName;
/**
* The state of the inbound transition, which is either enabled or disabled.
*/
inboundTransitionState?: TransitionState;
/**
* The state of the stage.
*/
actionStates?: ActionStateList;
/**
* Information about the latest execution in the stage, including its ID and status.
*/
latestExecution?: StageExecution;
}
export type StageStateList = StageState[];
export type StageTransitionType = "Inbound"|"Outbound"|string;
export interface StartPipelineExecutionInput {
/**
* The name of the pipeline to start.
*/
name: PipelineName;
/**
* The system-generated unique ID used to identify a unique execution request.
*/
clientRequestToken?: ClientRequestToken;
}
export interface StartPipelineExecutionOutput {
/**
* The unique system-generated ID of the pipeline execution that was started.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export interface StopExecutionTrigger {
/**
* The user-specified reason the pipeline was stopped.
*/
reason?: StopPipelineExecutionReason;
}
export interface StopPipelineExecutionInput {
/**
* The name of the pipeline to stop.
*/
pipelineName: PipelineName;
/**
* The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.
*/
pipelineExecutionId: PipelineExecutionId;
/**
* Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions. This option can lead to failed or out-of-sequence tasks.
*/
abandon?: Boolean;
/**
* Use this option to enter comments, such as the reason the pipeline was stopped.
*/
reason?: StopPipelineExecutionReason;
}
export interface StopPipelineExecutionOutput {
/**
* The unique system-generated ID of the pipeline execution that was stopped.
*/
pipelineExecutionId?: PipelineExecutionId;
}
export type StopPipelineExecutionReason = string;
export type String = string;
export interface Tag {
/**
* The tag's key.
*/
key: TagKey;
/**
* The tag's value.
*/
value: TagValue;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagList = Tag[];
export interface TagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource you want to add tags to.
*/
resourceArn: ResourceArn;
/**
* The tags you want to modify or add to the resource.
*/
tags: TagList;
}
export interface TagResourceOutput {
}
export type TagValue = string;
export interface ThirdPartyJob {
/**
* The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.
*/
clientId?: ClientId;
/**
* The identifier used to identify the job in AWS CodePipeline.
*/
jobId?: JobId;
}
export interface ThirdPartyJobData {
/**
* Represents information about an action type.
*/
actionTypeId?: ActionTypeId;
/**
* Represents information about an action configuration.
*/
actionConfiguration?: ActionConfiguration;
/**
* Represents information about a pipeline to a job worker. Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
*/
pipelineContext?: PipelineContext;
/**
* The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.
*/
inputArtifacts?: ArtifactList;
/**
* The name of the artifact that is the result of the action, if any. This name might be system-generated, such as "MyBuiltApp", or it might be defined by the user when the action is created.
*/
outputArtifacts?: ArtifactList;
/**
* Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.
*/
artifactCredentials?: AWSSessionCredentials;
/**
* A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
*/
continuationToken?: ContinuationToken;
/**
* The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.
*/
encryptionKey?: EncryptionKey;
}
export interface ThirdPartyJobDetails {
/**
* The identifier used to identify the job details in AWS CodePipeline.
*/
id?: ThirdPartyJobId;
/**
* The data to be returned by the third party job worker.
*/
data?: ThirdPartyJobData;
/**
* A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
*/
nonce?: Nonce;
}
export type ThirdPartyJobId = string;
export type ThirdPartyJobList = ThirdPartyJob[];
export type Time = Date;
export type Timestamp = Date;
export interface TransitionState {
/**
* Whether the transition between stages is enabled (true) or disabled (false).
*/
enabled?: Enabled;
/**
* The ID of the user who last changed the transition state.
*/
lastChangedBy?: LastChangedBy;
/**
* The timestamp when the transition state was last changed.
*/
lastChangedAt?: LastChangedAt;
/**
* The user-specified reason why the transition between two stages of a pipeline was disabled.
*/
disabledReason?: DisabledReason;
}
export type TriggerDetail = string;
export type TriggerType = "CreatePipeline"|"StartPipelineExecution"|"PollForSourceChanges"|"Webhook"|"CloudWatchEvent"|"PutActionRevision"|string;
export interface UntagResourceInput {
/**
* The Amazon Resource Name (ARN) of the resource to remove tags from.
*/
resourceArn: ResourceArn;
/**
* The list of keys for the tags to be removed from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceOutput {
}
export interface UpdatePipelineInput {
/**
* The name of the pipeline to be updated.
*/
pipeline: PipelineDeclaration;
}
export interface UpdatePipelineOutput {
/**
* The structure of the updated pipeline.
*/
pipeline?: PipelineDeclaration;
}
export type Url = string;
export type UrlTemplate = string;
export type Version = string;
export type WebhookArn = string;
export interface WebhookAuthConfiguration {
/**
* The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.
*/
AllowedIPRange?: WebhookAuthConfigurationAllowedIPRange;
/**
* The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.
*/
SecretToken?: WebhookAuthConfigurationSecretToken;
}
export type WebhookAuthConfigurationAllowedIPRange = string;
export type WebhookAuthConfigurationSecretToken = string;
export type WebhookAuthenticationType = "GITHUB_HMAC"|"IP"|"UNAUTHENTICATED"|string;
export interface WebhookDefinition {
/**
* The name of the webhook.
*/
name: WebhookName;
/**
* The name of the pipeline you want to connect to the webhook.
*/
targetPipeline: PipelineName;
/**
* The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.
*/
targetAction: ActionName;
/**
* A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.
*/
filters: WebhookFilters;
/**
* Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED. For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website. IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration. UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
*/
authentication: WebhookAuthenticationType;
/**
* Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.
*/
authenticationConfiguration: WebhookAuthConfiguration;
}
export type WebhookErrorCode = string;
export type WebhookErrorMessage = string;
export interface WebhookFilterRule {
/**
* A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.
*/
jsonPath: JsonPath;
/**
* The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "master", the MatchEquals value is evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
*/
matchEquals?: MatchEquals;
}
export type WebhookFilters = WebhookFilterRule[];
export type WebhookLastTriggered = Date;
export type WebhookList = ListWebhookItem[];
export type WebhookName = string;
export type WebhookUrl = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2015-07-09"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the CodePipeline client.
*/
export import Types = CodePipeline;
}
export = CodePipeline;