imagebuilder.d.ts
82.1 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
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
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';
interface Blob {}
declare class Imagebuilder extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Imagebuilder.Types.ClientConfiguration)
config: Config & Imagebuilder.Types.ClientConfiguration;
/**
* CancelImageCreation cancels the creation of Image. This operation may only be used on images in a non-terminal state.
*/
cancelImageCreation(params: Imagebuilder.Types.CancelImageCreationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CancelImageCreationResponse) => void): Request<Imagebuilder.Types.CancelImageCreationResponse, AWSError>;
/**
* CancelImageCreation cancels the creation of Image. This operation may only be used on images in a non-terminal state.
*/
cancelImageCreation(callback?: (err: AWSError, data: Imagebuilder.Types.CancelImageCreationResponse) => void): Request<Imagebuilder.Types.CancelImageCreationResponse, AWSError>;
/**
* Creates a new component that can be used to build, validate, test and assess your image.
*/
createComponent(params: Imagebuilder.Types.CreateComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateComponentResponse) => void): Request<Imagebuilder.Types.CreateComponentResponse, AWSError>;
/**
* Creates a new component that can be used to build, validate, test and assess your image.
*/
createComponent(callback?: (err: AWSError, data: Imagebuilder.Types.CreateComponentResponse) => void): Request<Imagebuilder.Types.CreateComponentResponse, AWSError>;
/**
* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
createDistributionConfiguration(params: Imagebuilder.Types.CreateDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.CreateDistributionConfigurationResponse, AWSError>;
/**
* Creates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
createDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.CreateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.CreateDistributionConfigurationResponse, AWSError>;
/**
* Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
*/
createImage(params: Imagebuilder.Types.CreateImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageResponse) => void): Request<Imagebuilder.Types.CreateImageResponse, AWSError>;
/**
* Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration.
*/
createImage(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageResponse) => void): Request<Imagebuilder.Types.CreateImageResponse, AWSError>;
/**
* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
createImagePipeline(params: Imagebuilder.Types.CreateImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImagePipelineResponse) => void): Request<Imagebuilder.Types.CreateImagePipelineResponse, AWSError>;
/**
* Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
createImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImagePipelineResponse) => void): Request<Imagebuilder.Types.CreateImagePipelineResponse, AWSError>;
/**
* Creates a new image recipe. Image Recipes defines how images are configured, tested and assessed.
*/
createImageRecipe(params: Imagebuilder.Types.CreateImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageRecipeResponse) => void): Request<Imagebuilder.Types.CreateImageRecipeResponse, AWSError>;
/**
* Creates a new image recipe. Image Recipes defines how images are configured, tested and assessed.
*/
createImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.CreateImageRecipeResponse) => void): Request<Imagebuilder.Types.CreateImageRecipeResponse, AWSError>;
/**
* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
createInfrastructureConfiguration(params: Imagebuilder.Types.CreateInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.CreateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.CreateInfrastructureConfigurationResponse, AWSError>;
/**
* Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
createInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.CreateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.CreateInfrastructureConfigurationResponse, AWSError>;
/**
* Deletes a component build version.
*/
deleteComponent(params: Imagebuilder.Types.DeleteComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteComponentResponse) => void): Request<Imagebuilder.Types.DeleteComponentResponse, AWSError>;
/**
* Deletes a component build version.
*/
deleteComponent(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteComponentResponse) => void): Request<Imagebuilder.Types.DeleteComponentResponse, AWSError>;
/**
* Deletes a distribution configuration.
*/
deleteDistributionConfiguration(params: Imagebuilder.Types.DeleteDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteDistributionConfigurationResponse, AWSError>;
/**
* Deletes a distribution configuration.
*/
deleteDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteDistributionConfigurationResponse, AWSError>;
/**
* Deletes an image.
*/
deleteImage(params: Imagebuilder.Types.DeleteImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageResponse) => void): Request<Imagebuilder.Types.DeleteImageResponse, AWSError>;
/**
* Deletes an image.
*/
deleteImage(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageResponse) => void): Request<Imagebuilder.Types.DeleteImageResponse, AWSError>;
/**
* Deletes an image pipeline.
*/
deleteImagePipeline(params: Imagebuilder.Types.DeleteImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImagePipelineResponse) => void): Request<Imagebuilder.Types.DeleteImagePipelineResponse, AWSError>;
/**
* Deletes an image pipeline.
*/
deleteImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImagePipelineResponse) => void): Request<Imagebuilder.Types.DeleteImagePipelineResponse, AWSError>;
/**
* Deletes an image recipe.
*/
deleteImageRecipe(params: Imagebuilder.Types.DeleteImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageRecipeResponse) => void): Request<Imagebuilder.Types.DeleteImageRecipeResponse, AWSError>;
/**
* Deletes an image recipe.
*/
deleteImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteImageRecipeResponse) => void): Request<Imagebuilder.Types.DeleteImageRecipeResponse, AWSError>;
/**
* Deletes an infrastructure configuration.
*/
deleteInfrastructureConfiguration(params: Imagebuilder.Types.DeleteInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.DeleteInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteInfrastructureConfigurationResponse, AWSError>;
/**
* Deletes an infrastructure configuration.
*/
deleteInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.DeleteInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.DeleteInfrastructureConfigurationResponse, AWSError>;
/**
* Gets a component object.
*/
getComponent(params: Imagebuilder.Types.GetComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentResponse) => void): Request<Imagebuilder.Types.GetComponentResponse, AWSError>;
/**
* Gets a component object.
*/
getComponent(callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentResponse) => void): Request<Imagebuilder.Types.GetComponentResponse, AWSError>;
/**
* Gets a component policy.
*/
getComponentPolicy(params: Imagebuilder.Types.GetComponentPolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentPolicyResponse) => void): Request<Imagebuilder.Types.GetComponentPolicyResponse, AWSError>;
/**
* Gets a component policy.
*/
getComponentPolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetComponentPolicyResponse) => void): Request<Imagebuilder.Types.GetComponentPolicyResponse, AWSError>;
/**
* Gets a distribution configuration.
*/
getDistributionConfiguration(params: Imagebuilder.Types.GetDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.GetDistributionConfigurationResponse, AWSError>;
/**
* Gets a distribution configuration.
*/
getDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.GetDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.GetDistributionConfigurationResponse, AWSError>;
/**
* Gets an image.
*/
getImage(params: Imagebuilder.Types.GetImageRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageResponse) => void): Request<Imagebuilder.Types.GetImageResponse, AWSError>;
/**
* Gets an image.
*/
getImage(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageResponse) => void): Request<Imagebuilder.Types.GetImageResponse, AWSError>;
/**
* Gets an image pipeline.
*/
getImagePipeline(params: Imagebuilder.Types.GetImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePipelineResponse) => void): Request<Imagebuilder.Types.GetImagePipelineResponse, AWSError>;
/**
* Gets an image pipeline.
*/
getImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePipelineResponse) => void): Request<Imagebuilder.Types.GetImagePipelineResponse, AWSError>;
/**
* Gets an image policy.
*/
getImagePolicy(params: Imagebuilder.Types.GetImagePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePolicyResponse) => void): Request<Imagebuilder.Types.GetImagePolicyResponse, AWSError>;
/**
* Gets an image policy.
*/
getImagePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetImagePolicyResponse) => void): Request<Imagebuilder.Types.GetImagePolicyResponse, AWSError>;
/**
* Gets an image recipe.
*/
getImageRecipe(params: Imagebuilder.Types.GetImageRecipeRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipeResponse) => void): Request<Imagebuilder.Types.GetImageRecipeResponse, AWSError>;
/**
* Gets an image recipe.
*/
getImageRecipe(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipeResponse) => void): Request<Imagebuilder.Types.GetImageRecipeResponse, AWSError>;
/**
* Gets an image recipe policy.
*/
getImageRecipePolicy(params: Imagebuilder.Types.GetImageRecipePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.GetImageRecipePolicyResponse, AWSError>;
/**
* Gets an image recipe policy.
*/
getImageRecipePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.GetImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.GetImageRecipePolicyResponse, AWSError>;
/**
* Gets a infrastructure configuration.
*/
getInfrastructureConfiguration(params: Imagebuilder.Types.GetInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.GetInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.GetInfrastructureConfigurationResponse, AWSError>;
/**
* Gets a infrastructure configuration.
*/
getInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.GetInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.GetInfrastructureConfigurationResponse, AWSError>;
/**
* Imports a component and transforms its data into a component document.
*/
importComponent(params: Imagebuilder.Types.ImportComponentRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ImportComponentResponse) => void): Request<Imagebuilder.Types.ImportComponentResponse, AWSError>;
/**
* Imports a component and transforms its data into a component document.
*/
importComponent(callback?: (err: AWSError, data: Imagebuilder.Types.ImportComponentResponse) => void): Request<Imagebuilder.Types.ImportComponentResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponentBuildVersions(params: Imagebuilder.Types.ListComponentBuildVersionsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListComponentBuildVersionsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponentBuildVersions(callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListComponentBuildVersionsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponents(params: Imagebuilder.Types.ListComponentsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentsResponse) => void): Request<Imagebuilder.Types.ListComponentsResponse, AWSError>;
/**
* Returns the list of component build versions for the specified semantic version.
*/
listComponents(callback?: (err: AWSError, data: Imagebuilder.Types.ListComponentsResponse) => void): Request<Imagebuilder.Types.ListComponentsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listDistributionConfigurations(params: Imagebuilder.Types.ListDistributionConfigurationsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListDistributionConfigurationsResponse) => void): Request<Imagebuilder.Types.ListDistributionConfigurationsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listDistributionConfigurations(callback?: (err: AWSError, data: Imagebuilder.Types.ListDistributionConfigurationsResponse) => void): Request<Imagebuilder.Types.ListDistributionConfigurationsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listImageBuildVersions(params: Imagebuilder.Types.ListImageBuildVersionsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImageBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListImageBuildVersionsResponse, AWSError>;
/**
* Returns a list of distribution configurations.
*/
listImageBuildVersions(callback?: (err: AWSError, data: Imagebuilder.Types.ListImageBuildVersionsResponse) => void): Request<Imagebuilder.Types.ListImageBuildVersionsResponse, AWSError>;
/**
* Returns a list of images created by the specified pipeline.
*/
listImagePipelineImages(params: Imagebuilder.Types.ListImagePipelineImagesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelineImagesResponse) => void): Request<Imagebuilder.Types.ListImagePipelineImagesResponse, AWSError>;
/**
* Returns a list of images created by the specified pipeline.
*/
listImagePipelineImages(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelineImagesResponse) => void): Request<Imagebuilder.Types.ListImagePipelineImagesResponse, AWSError>;
/**
* Returns a list of image pipelines.
*/
listImagePipelines(params: Imagebuilder.Types.ListImagePipelinesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelinesResponse) => void): Request<Imagebuilder.Types.ListImagePipelinesResponse, AWSError>;
/**
* Returns a list of image pipelines.
*/
listImagePipelines(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagePipelinesResponse) => void): Request<Imagebuilder.Types.ListImagePipelinesResponse, AWSError>;
/**
* Returns a list of image recipes.
*/
listImageRecipes(params: Imagebuilder.Types.ListImageRecipesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImageRecipesResponse) => void): Request<Imagebuilder.Types.ListImageRecipesResponse, AWSError>;
/**
* Returns a list of image recipes.
*/
listImageRecipes(callback?: (err: AWSError, data: Imagebuilder.Types.ListImageRecipesResponse) => void): Request<Imagebuilder.Types.ListImageRecipesResponse, AWSError>;
/**
* Returns the list of image build versions for the specified semantic version.
*/
listImages(params: Imagebuilder.Types.ListImagesRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListImagesResponse) => void): Request<Imagebuilder.Types.ListImagesResponse, AWSError>;
/**
* Returns the list of image build versions for the specified semantic version.
*/
listImages(callback?: (err: AWSError, data: Imagebuilder.Types.ListImagesResponse) => void): Request<Imagebuilder.Types.ListImagesResponse, AWSError>;
/**
* Returns a list of infrastructure configurations.
*/
listInfrastructureConfigurations(params: Imagebuilder.Types.ListInfrastructureConfigurationsRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListInfrastructureConfigurationsResponse) => void): Request<Imagebuilder.Types.ListInfrastructureConfigurationsResponse, AWSError>;
/**
* Returns a list of infrastructure configurations.
*/
listInfrastructureConfigurations(callback?: (err: AWSError, data: Imagebuilder.Types.ListInfrastructureConfigurationsResponse) => void): Request<Imagebuilder.Types.ListInfrastructureConfigurationsResponse, AWSError>;
/**
* Returns the list of tags for the specified resource.
*/
listTagsForResource(params: Imagebuilder.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.ListTagsForResourceResponse) => void): Request<Imagebuilder.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns the list of tags for the specified resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Imagebuilder.Types.ListTagsForResourceResponse) => void): Request<Imagebuilder.Types.ListTagsForResourceResponse, AWSError>;
/**
* Applies a policy to a component.
*/
putComponentPolicy(params: Imagebuilder.Types.PutComponentPolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutComponentPolicyResponse) => void): Request<Imagebuilder.Types.PutComponentPolicyResponse, AWSError>;
/**
* Applies a policy to a component.
*/
putComponentPolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutComponentPolicyResponse) => void): Request<Imagebuilder.Types.PutComponentPolicyResponse, AWSError>;
/**
* Applies a policy to an image.
*/
putImagePolicy(params: Imagebuilder.Types.PutImagePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutImagePolicyResponse) => void): Request<Imagebuilder.Types.PutImagePolicyResponse, AWSError>;
/**
* Applies a policy to an image.
*/
putImagePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutImagePolicyResponse) => void): Request<Imagebuilder.Types.PutImagePolicyResponse, AWSError>;
/**
* Applies a policy to an image recipe.
*/
putImageRecipePolicy(params: Imagebuilder.Types.PutImageRecipePolicyRequest, callback?: (err: AWSError, data: Imagebuilder.Types.PutImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.PutImageRecipePolicyResponse, AWSError>;
/**
* Applies a policy to an image recipe.
*/
putImageRecipePolicy(callback?: (err: AWSError, data: Imagebuilder.Types.PutImageRecipePolicyResponse) => void): Request<Imagebuilder.Types.PutImageRecipePolicyResponse, AWSError>;
/**
* Manually triggers a pipeline to create an image.
*/
startImagePipelineExecution(params: Imagebuilder.Types.StartImagePipelineExecutionRequest, callback?: (err: AWSError, data: Imagebuilder.Types.StartImagePipelineExecutionResponse) => void): Request<Imagebuilder.Types.StartImagePipelineExecutionResponse, AWSError>;
/**
* Manually triggers a pipeline to create an image.
*/
startImagePipelineExecution(callback?: (err: AWSError, data: Imagebuilder.Types.StartImagePipelineExecutionResponse) => void): Request<Imagebuilder.Types.StartImagePipelineExecutionResponse, AWSError>;
/**
* Adds a tag to a resource.
*/
tagResource(params: Imagebuilder.Types.TagResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.TagResourceResponse) => void): Request<Imagebuilder.Types.TagResourceResponse, AWSError>;
/**
* Adds a tag to a resource.
*/
tagResource(callback?: (err: AWSError, data: Imagebuilder.Types.TagResourceResponse) => void): Request<Imagebuilder.Types.TagResourceResponse, AWSError>;
/**
* Removes a tag from a resource.
*/
untagResource(params: Imagebuilder.Types.UntagResourceRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UntagResourceResponse) => void): Request<Imagebuilder.Types.UntagResourceResponse, AWSError>;
/**
* Removes a tag from a resource.
*/
untagResource(callback?: (err: AWSError, data: Imagebuilder.Types.UntagResourceResponse) => void): Request<Imagebuilder.Types.UntagResourceResponse, AWSError>;
/**
* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
updateDistributionConfiguration(params: Imagebuilder.Types.UpdateDistributionConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateDistributionConfigurationResponse, AWSError>;
/**
* Updates a new distribution configuration. Distribution configurations define and configure the outputs of your pipeline.
*/
updateDistributionConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateDistributionConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateDistributionConfigurationResponse, AWSError>;
/**
* Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
updateImagePipeline(params: Imagebuilder.Types.UpdateImagePipelineRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateImagePipelineResponse) => void): Request<Imagebuilder.Types.UpdateImagePipelineResponse, AWSError>;
/**
* Updates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.
*/
updateImagePipeline(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateImagePipelineResponse) => void): Request<Imagebuilder.Types.UpdateImagePipelineResponse, AWSError>;
/**
* Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
updateInfrastructureConfiguration(params: Imagebuilder.Types.UpdateInfrastructureConfigurationRequest, callback?: (err: AWSError, data: Imagebuilder.Types.UpdateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateInfrastructureConfigurationResponse, AWSError>;
/**
* Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.
*/
updateInfrastructureConfiguration(callback?: (err: AWSError, data: Imagebuilder.Types.UpdateInfrastructureConfigurationResponse) => void): Request<Imagebuilder.Types.UpdateInfrastructureConfigurationResponse, AWSError>;
}
declare namespace Imagebuilder {
export type AccountList = NonEmptyString[];
export interface Ami {
/**
* The region of the EC2 AMI.
*/
region?: NonEmptyString;
/**
* The AMI ID of the EC2 AMI.
*/
image?: NonEmptyString;
/**
* The name of the EC2 AMI.
*/
name?: NonEmptyString;
/**
* The description of the EC2 AMI.
*/
description?: NonEmptyString;
state?: ImageState;
}
export interface AmiDistributionConfiguration {
/**
* The name of the distribution configuration.
*/
name?: NonEmptyString;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The tags to apply to AMIs distributed to this region.
*/
amiTags?: TagMap;
/**
* Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
*/
launchPermission?: LaunchPermissionConfiguration;
}
export type AmiList = Ami[];
export type Arn = string;
export type ArnList = Arn[];
export interface CancelImageCreationRequest {
/**
* The Amazon Resource Name (ARN) of the image whose creation you wish to cancel.
*/
imageBuildVersionArn: ImageBuildVersionArn;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CancelImageCreationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export type ClientToken = string;
export interface Component {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The version of the component.
*/
version?: VersionNumber;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The change description of the component.
*/
changeDescription?: NonEmptyString;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The data of the component.
*/
data?: ComponentData;
/**
* The KMS key identifier used to encrypt the component.
*/
kmsKeyId?: NonEmptyString;
/**
* The encryption status of the component.
*/
encrypted?: NullableBoolean;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
/**
* The tags associated with the component.
*/
tags?: TagMap;
}
export type ComponentBuildVersionArn = string;
export interface ComponentConfiguration {
/**
* The Amazon Resource Name (ARN) of the component.
*/
componentArn: ComponentBuildVersionArn;
}
export type ComponentConfigurationList = ComponentConfiguration[];
export type ComponentData = string;
export type ComponentFormat = "SHELL"|string;
export interface ComponentSummary {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The version of the component.
*/
version?: VersionNumber;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The change description of the component.
*/
changeDescription?: NonEmptyString;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
/**
* The tags associated with the component.
*/
tags?: TagMap;
}
export type ComponentSummaryList = ComponentSummary[];
export type ComponentType = "BUILD"|"TEST"|string;
export interface ComponentVersion {
/**
* The Amazon Resource Name (ARN) of the component.
*/
arn?: ImageBuilderArn;
/**
* The name of the component.
*/
name?: ResourceName;
/**
* The semantic version of the component.
*/
version?: VersionNumber;
/**
* The description of the component.
*/
description?: NonEmptyString;
/**
* The platform of the component.
*/
platform?: Platform;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type?: ComponentType;
/**
* The owner of the component.
*/
owner?: NonEmptyString;
/**
* The date that the component was created.
*/
dateCreated?: DateTime;
}
export type ComponentVersionArn = string;
export type ComponentVersionList = ComponentVersion[];
export interface CreateComponentRequest {
/**
* The name of the component.
*/
name: ResourceName;
/**
* The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
*/
semanticVersion: VersionNumber;
/**
* CThe description of the component. Describes the contents of the component.
*/
description?: NonEmptyString;
/**
* CThe change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component.
*/
changeDescription?: NonEmptyString;
/**
* CThe platform of the component.
*/
platform: Platform;
/**
* CThe data of the component.
*/
data?: InlineComponentData;
/**
* CThe uri of the component.
*/
uri?: Uri;
/**
* The ID of the KMS key that should be used to encrypt this component.
*/
kmsKeyId?: NonEmptyString;
/**
* CThe tags of the component.
*/
tags?: TagMap;
/**
* CThe idempotency token of the component.
*/
clientToken: ClientToken;
}
export interface CreateComponentResponse {
/**
* CThe request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* CThe idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* CThe Amazon Resource Name (ARN) of the component that was created by this request.
*/
componentBuildVersionArn?: ComponentBuildVersionArn;
}
export interface CreateDistributionConfigurationRequest {
/**
* The name of the distribution configuration.
*/
name: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The distributions of the distribution configuration.
*/
distributions: DistributionList;
/**
* The tags of the distribution configuration.
*/
tags?: TagMap;
/**
* The idempotency token of the distribution configuration.
*/
clientToken: ClientToken;
}
export interface CreateDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
}
export interface CreateImagePipelineRequest {
/**
* The name of the image pipeline.
*/
name: ResourceName;
/**
* The description of the image pipeline.
*/
description?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
*/
imageRecipeArn: ImageRecipeArn;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
/**
* The image test configuration of the image pipeline.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* The schedule of the image pipeline.
*/
schedule?: Schedule;
/**
* The status of the image pipeline.
*/
status?: PipelineStatus;
/**
* The tags of the image pipeline.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
*/
imagePipelineArn?: ImagePipelineArn;
}
export interface CreateImageRecipeRequest {
/**
* The name of the image recipe.
*/
name: ResourceName;
/**
* The description of the image recipe.
*/
description?: NonEmptyString;
/**
* The semantic version of the image recipe.
*/
semanticVersion: VersionNumber;
/**
* The components of the image recipe.
*/
components: ComponentConfigurationList;
/**
* The parent image of the image recipe.
*/
parentImage: NonEmptyString;
/**
* The block device mappings of the image recipe.
*/
blockDeviceMappings?: InstanceBlockDeviceMappings;
/**
* The tags of the image recipe.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImageRecipeResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image recipe that was created by this request.
*/
imageRecipeArn?: ImageRecipeArn;
}
export interface CreateImageRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested and assessed.
*/
imageRecipeArn: ImageRecipeArn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
/**
* The image tests configuration of the image.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* The tags of the image.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateImageResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image that was created by this request.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export interface CreateInfrastructureConfigurationRequest {
/**
* The name of the infrastructure configuration.
*/
name: ResourceName;
/**
* The description of the infrastructure configuration.
*/
description?: NonEmptyString;
/**
* The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability.
*/
instanceTypes?: InstanceTypeList;
/**
* The instance profile to associate with the instance used to customize your EC2 AMI.
*/
instanceProfileName: NonEmptyString;
/**
* The security group IDs to associate with the instance used to customize your EC2 AMI.
*/
securityGroupIds?: SecurityGroupIds;
/**
* The subnet ID to place the instance used to customize your EC2 AMI in.
*/
subnetId?: NonEmptyString;
/**
* The logging configuration of the infrastructure configuration.
*/
logging?: Logging;
/**
* The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image.
*/
keyPair?: NonEmptyString;
/**
* The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed.
*/
terminateInstanceOnFailure?: NullableBoolean;
/**
* The SNS topic on which to send image build events.
*/
snsTopicArn?: NonEmptyString;
/**
* The tags of the infrastructure configuration.
*/
tags?: TagMap;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface CreateInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
}
export type DateTime = string;
export interface DeleteComponentRequest {
/**
* The Amazon Resource Name (ARN) of the component build version to delete.
*/
componentBuildVersionArn: ComponentBuildVersionArn;
}
export interface DeleteComponentResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the component build version that was deleted.
*/
componentBuildVersionArn?: ComponentBuildVersionArn;
}
export interface DeleteDistributionConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the distribution configuration to delete.
*/
distributionConfigurationArn: DistributionConfigurationArn;
}
export interface DeleteDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
}
export interface DeleteImagePipelineRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline to delete.
*/
imagePipelineArn: ImagePipelineArn;
}
export interface DeleteImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image pipeline that was deleted.
*/
imagePipelineArn?: ImagePipelineArn;
}
export interface DeleteImageRecipeRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe to delete.
*/
imageRecipeArn: ImageRecipeArn;
}
export interface DeleteImageRecipeResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that was deleted.
*/
imageRecipeArn?: ImageRecipeArn;
}
export interface DeleteImageRequest {
/**
* The Amazon Resource Name (ARN) of the image to delete.
*/
imageBuildVersionArn: ImageBuildVersionArn;
}
export interface DeleteImageResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image that was deleted.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export interface DeleteInfrastructureConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
}
export interface DeleteInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
}
export interface Distribution {
/**
*
*/
region: NonEmptyString;
/**
*
*/
amiDistributionConfiguration?: AmiDistributionConfiguration;
/**
*
*/
licenseConfigurationArns?: ArnList;
}
export interface DistributionConfiguration {
/**
* The Amazon Resource Name (ARN) of the distribution configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the distribution configuration.
*/
name?: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The distributions of the distribution configuration.
*/
distributions?: DistributionList;
/**
* The maximum duration in minutes for this distribution configuration.
*/
timeoutMinutes: DistributionTimeoutMinutes;
/**
* The date on which this distribution configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which this distribution configuration was last updated.
*/
dateUpdated?: DateTime;
/**
* The tags of the distribution configuration.
*/
tags?: TagMap;
}
export type DistributionConfigurationArn = string;
export interface DistributionConfigurationSummary {
/**
* The Amazon Resource Name (ARN) of the distribution configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the distribution configuration.
*/
name?: ResourceName;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The date on which the distribution configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which the distribution configuration was updated.
*/
dateUpdated?: DateTime;
/**
* The tags associated with the distribution configuration.
*/
tags?: TagMap;
}
export type DistributionConfigurationSummaryList = DistributionConfigurationSummary[];
export type DistributionList = Distribution[];
export type DistributionTimeoutMinutes = number;
export interface EbsInstanceBlockDeviceSpecification {
/**
* Use to configure device encryption.
*/
encrypted?: NullableBoolean;
/**
* Use to configure delete on termination of the associated device.
*/
deleteOnTermination?: NullableBoolean;
/**
* Use to configure device IOPS.
*/
iops?: EbsIopsInteger;
/**
* Use to configure the KMS key to use when encrypting the device.
*/
kmsKeyId?: NonEmptyString;
/**
* The snapshot that defines the device contents.
*/
snapshotId?: NonEmptyString;
/**
* Use to override the device's volume size.
*/
volumeSize?: EbsVolumeSizeInteger;
/**
* Use to override the device's volume type.
*/
volumeType?: EbsVolumeType;
}
export type EbsIopsInteger = number;
export type EbsVolumeSizeInteger = number;
export type EbsVolumeType = "standard"|"io1"|"gp2"|"sc1"|"st1"|string;
export interface Filter {
/**
*
*/
name?: FilterName;
/**
*
*/
values?: FilterValues;
}
export type FilterList = Filter[];
export type FilterName = string;
export type FilterValue = string;
export type FilterValues = FilterValue[];
export interface GetComponentPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the component whose policy you wish to retrieve.
*/
componentArn: ComponentBuildVersionArn;
}
export interface GetComponentPolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The component policy.
*/
policy?: NonEmptyString;
}
export interface GetComponentRequest {
/**
* The Amazon Resource Name (ARN) of the component that you wish to retrieve.
*/
componentBuildVersionArn: ComponentBuildVersionArn;
}
export interface GetComponentResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The component object associated with the specified ARN.
*/
component?: Component;
}
export interface GetDistributionConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the distribution configuration that you wish to retrieve.
*/
distributionConfigurationArn: DistributionConfigurationArn;
}
export interface GetDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The distribution configuration object.
*/
distributionConfiguration?: DistributionConfiguration;
}
export interface GetImagePipelineRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline that you wish to retrieve.
*/
imagePipelineArn: ImagePipelineArn;
}
export interface GetImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The image pipeline object.
*/
imagePipeline?: ImagePipeline;
}
export interface GetImagePolicyRequest {
/**
* The Amazon Resource Name (ARN) of the image whose policy you wish to retrieve.
*/
imageArn: ImageBuildVersionArn;
}
export interface GetImagePolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The image policy object.
*/
policy?: NonEmptyString;
}
export interface GetImageRecipePolicyRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe whose policy you wish to retrieve.
*/
imageRecipeArn: ImageRecipeArn;
}
export interface GetImageRecipePolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The image recipe policy object.
*/
policy?: NonEmptyString;
}
export interface GetImageRecipeRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe that you wish to retrieve.
*/
imageRecipeArn: ImageRecipeArn;
}
export interface GetImageRecipeResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The image recipe object.
*/
imageRecipe?: ImageRecipe;
}
export interface GetImageRequest {
/**
* The Amazon Resource Name (ARN) of the image that you wish to retrieve.
*/
imageBuildVersionArn: ImageBuildVersionArn;
}
export interface GetImageResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The image object.
*/
image?: Image;
}
export interface GetInfrastructureConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to retrieve.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
}
export interface GetInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The infrastructure configuration object.
*/
infrastructureConfiguration?: InfrastructureConfiguration;
}
export interface Image {
/**
* The Amazon Resource Name (ARN) of the image.
*/
arn?: ImageBuilderArn;
/**
* The name of the image.
*/
name?: ResourceName;
/**
* The semantic version of the image.
*/
version?: VersionNumber;
/**
* The platform of the image.
*/
platform?: Platform;
/**
* The state of the image.
*/
state?: ImageState;
/**
* The image recipe used when creating the image.
*/
imageRecipe?: ImageRecipe;
/**
* The name of the image pipeline that created this image.
*/
sourcePipelineName?: ResourceName;
/**
* The Amazon Resource Name (ARN) of the image pipeline that created this image.
*/
sourcePipelineArn?: Arn;
/**
* The infrastructure used when creating this image.
*/
infrastructureConfiguration?: InfrastructureConfiguration;
/**
* The distribution configuration used when creating this image.
*/
distributionConfiguration?: DistributionConfiguration;
/**
* The image tests configuration used when creating this image.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* The date on which this image was created.
*/
dateCreated?: DateTime;
/**
* The output resources produced when creating this image.
*/
outputResources?: OutputResources;
/**
* The tags of the image.
*/
tags?: TagMap;
}
export type ImageBuildVersionArn = string;
export type ImageBuilderArn = string;
export interface ImagePipeline {
/**
* The Amazon Resource Name (ARN) of the image pipeline.
*/
arn?: ImageBuilderArn;
/**
* The name of the image pipeline.
*/
name?: ResourceName;
/**
* The description of the image pipeline.
*/
description?: NonEmptyString;
/**
* The platform of the image pipeline.
*/
platform?: Platform;
/**
* The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
*/
imageRecipeArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the infrastruction configuration associated with this image pipeline.
*/
infrastructureConfigurationArn?: Arn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
*/
distributionConfigurationArn?: Arn;
/**
* The image tests configuration of the image pipeline.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* The schedule of the image pipeline.
*/
schedule?: Schedule;
/**
* The status of the image pipeline.
*/
status?: PipelineStatus;
/**
* The date on which this image pipeline was created.
*/
dateCreated?: DateTime;
/**
* The date on which this image pipeline was last updated.
*/
dateUpdated?: DateTime;
/**
* The date on which this image pipeline was last run.
*/
dateLastRun?: DateTime;
/**
* The date on which this image pipeline will next be run.
*/
dateNextRun?: DateTime;
/**
* The tags of this image pipeline.
*/
tags?: TagMap;
}
export type ImagePipelineArn = string;
export type ImagePipelineList = ImagePipeline[];
export interface ImageRecipe {
/**
* The Amazon Resource Name (ARN) of the image recipe.
*/
arn?: ImageBuilderArn;
/**
* The name of the image recipe.
*/
name?: ResourceName;
/**
* The description of the image recipe.
*/
description?: NonEmptyString;
/**
* The platform of the image recipe.
*/
platform?: Platform;
/**
* The owner of the image recipe.
*/
owner?: NonEmptyString;
/**
* The version of the image recipe.
*/
version?: VersionNumber;
/**
* The components of the image recipe.
*/
components?: ComponentConfigurationList;
/**
* The parent image of the image recipe.
*/
parentImage?: NonEmptyString;
/**
* The block device mappings to apply when creating images from this recipe.
*/
blockDeviceMappings?: InstanceBlockDeviceMappings;
/**
* The date on which this image recipe was created.
*/
dateCreated?: DateTime;
/**
* The tags of the image recipe.
*/
tags?: TagMap;
}
export type ImageRecipeArn = string;
export interface ImageRecipeSummary {
/**
* The Amazon Resource Name (ARN) of the image recipe.
*/
arn?: ImageBuilderArn;
/**
* The name of the image recipe.
*/
name?: ResourceName;
/**
* The platform of the image recipe.
*/
platform?: Platform;
/**
* The owner of the image recipe.
*/
owner?: NonEmptyString;
/**
* The parent image of the image recipe.
*/
parentImage?: NonEmptyString;
/**
* The date on which this image recipe was created.
*/
dateCreated?: DateTime;
/**
* The tags of the image recipe.
*/
tags?: TagMap;
}
export type ImageRecipeSummaryList = ImageRecipeSummary[];
export interface ImageState {
/**
* The status of the image.
*/
status?: ImageStatus;
/**
* The reason for the image's status.
*/
reason?: NonEmptyString;
}
export type ImageStatus = "PENDING"|"CREATING"|"BUILDING"|"TESTING"|"DISTRIBUTING"|"INTEGRATING"|"AVAILABLE"|"CANCELLED"|"FAILED"|"DEPRECATED"|"DELETED"|string;
export interface ImageSummary {
/**
* The Amazon Resource Name (ARN) of the image.
*/
arn?: ImageBuilderArn;
/**
* The name of the image.
*/
name?: ResourceName;
/**
* The version of the image.
*/
version?: VersionNumber;
/**
* The platform of the image.
*/
platform?: Platform;
/**
* The state of the image.
*/
state?: ImageState;
/**
* The owner of the image.
*/
owner?: NonEmptyString;
/**
* The date on which this image was created.
*/
dateCreated?: DateTime;
/**
* The output resources produced when creating this image.
*/
outputResources?: OutputResources;
/**
* The tags of the image.
*/
tags?: TagMap;
}
export type ImageSummaryList = ImageSummary[];
export interface ImageTestsConfiguration {
/**
* Defines if tests should be executed when building this image.
*/
imageTestsEnabled?: NullableBoolean;
/**
* The maximum time in minutes that tests are permitted to run for.
*/
timeoutMinutes?: ImageTestsTimeoutMinutes;
}
export type ImageTestsTimeoutMinutes = number;
export interface ImageVersion {
/**
* The Amazon Resource Name (ARN) of the image semantic verion.
*/
arn?: ImageBuilderArn;
/**
* The name of the image semantic version.
*/
name?: ResourceName;
/**
* The semantic version of the image semantic version.
*/
version?: VersionNumber;
/**
* The platform of the image semantic version.
*/
platform?: Platform;
/**
* The owner of the image semantic version.
*/
owner?: NonEmptyString;
/**
* The date at which this image semantic version was created.
*/
dateCreated?: DateTime;
}
export type ImageVersionArn = string;
export type ImageVersionList = ImageVersion[];
export interface ImportComponentRequest {
/**
* The name of the component.
*/
name: ResourceName;
/**
* The semantic version of the component. This version to follow the semantic version syntax. i.e. major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
*/
semanticVersion: VersionNumber;
/**
* The description of the component. Describes the contents of the component.
*/
description?: NonEmptyString;
/**
* The change description of the component. Describes what change has been made in this version. In other words what makes this version different from other versions of this component.
*/
changeDescription?: NonEmptyString;
/**
* The type of the component denotes whether the component is used to build the image or only to test it.
*/
type: ComponentType;
/**
* The format of the resource that you wish to import as a component.
*/
format: ComponentFormat;
/**
* The platform of the component.
*/
platform: Platform;
/**
* The data of the component.
*/
data?: NonEmptyString;
/**
* The uri of the component.
*/
uri?: Uri;
/**
* The ID of the KMS key that should be used to encrypt this component.
*/
kmsKeyId?: NonEmptyString;
/**
* The tags of the component.
*/
tags?: TagMap;
/**
* The idempotency token of the component.
*/
clientToken: ClientToken;
}
export interface ImportComponentResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the imported component.
*/
componentBuildVersionArn?: ComponentBuildVersionArn;
}
export interface InfrastructureConfiguration {
/**
* The Amazon Resource Name (ARN) of the infrastruction configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the infrastruction configuration.
*/
name?: ResourceName;
/**
* The description of the infrastruction configuration.
*/
description?: NonEmptyString;
/**
* The instance types of the infrastruction configuration.
*/
instanceTypes?: InstanceTypeList;
/**
* The instance profile of the infrastruction configuration.
*/
instanceProfileName?: NonEmptyString;
/**
* The security group IDs of the infrastruction configuration.
*/
securityGroupIds?: SecurityGroupIds;
/**
* The subnet ID of the infrastruction configuration.
*/
subnetId?: NonEmptyString;
/**
* The logging configuration of the infrastruction configuration.
*/
logging?: Logging;
/**
* The EC2 key pair of the infrastruction configuration.
*/
keyPair?: NonEmptyString;
/**
* The terminate instance on failure configuration of the infrastruction configuration.
*/
terminateInstanceOnFailure?: NullableBoolean;
/**
* The SNS Topic Amazon Resource Name (ARN) of the infrastruction configuration.
*/
snsTopicArn?: NonEmptyString;
/**
* The date on which the infrastructure configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which the infrastructure configuration was last updated.
*/
dateUpdated?: DateTime;
/**
* The tags of the infrastruction configuration.
*/
tags?: TagMap;
}
export type InfrastructureConfigurationArn = string;
export interface InfrastructureConfigurationSummary {
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration.
*/
arn?: ImageBuilderArn;
/**
* The name of the infrastructure configuration.
*/
name?: ResourceName;
/**
* The description of the infrastructure configuration.
*/
description?: NonEmptyString;
/**
* The date on which the infrastructure configuration was created.
*/
dateCreated?: DateTime;
/**
* The date on which the infrastructure configuration was last updated.
*/
dateUpdated?: DateTime;
/**
* The tags of the infrastructure configuration.
*/
tags?: TagMap;
}
export type InfrastructureConfigurationSummaryList = InfrastructureConfigurationSummary[];
export type InlineComponentData = string;
export interface InstanceBlockDeviceMapping {
/**
* The device to which these mappings apply.
*/
deviceName?: NonEmptyString;
/**
* Use to manage EBS specific configuration for this mapping.
*/
ebs?: EbsInstanceBlockDeviceSpecification;
/**
* Use to manage instance ephemeral devices.
*/
virtualName?: NonEmptyString;
/**
* Use to remove a mapping from the parent image.
*/
noDevice?: NonEmptyString;
}
export type InstanceBlockDeviceMappings = InstanceBlockDeviceMapping[];
export type InstanceType = string;
export type InstanceTypeList = InstanceType[];
export interface LaunchPermissionConfiguration {
/**
*
*/
userIds?: AccountList;
/**
*
*/
userGroups?: StringList;
}
export interface ListComponentBuildVersionsRequest {
/**
* The component version arn whose versions you wish to list.
*/
componentVersionArn: ComponentVersionArn;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListComponentBuildVersionsResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of component summaries for the specified semantic version.
*/
componentSummaryList?: ComponentSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListComponentsRequest {
/**
* The owner defines whose components you wish to list. By default this request will only show components owned by your account. You may use this field to specify if you wish to view components owned by yourself, Amazon, or those components that have been shared with you by other customers.
*/
owner?: Ownership;
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListComponentsResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of component semantic versions.
*/
componentVersionList?: ComponentVersionList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListDistributionConfigurationsRequest {
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListDistributionConfigurationsResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of distributions.
*/
distributionConfigurationSummaryList?: DistributionConfigurationSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListImageBuildVersionsRequest {
/**
* The Amazon Resource Name (ARN) of the image whose build versions you wish to retrieve.
*/
imageVersionArn: ImageVersionArn;
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListImageBuildVersionsResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of image build versions.
*/
imageSummaryList?: ImageSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListImagePipelineImagesRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline whose images you wish to view.
*/
imagePipelineArn?: ImagePipelineArn;
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListImagePipelineImagesResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of images built by this pipeline.
*/
imageSummaryList?: ImageSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListImagePipelinesRequest {
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListImagePipelinesResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of image pipelines.
*/
imagePipelineList?: ImagePipelineList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListImageRecipesRequest {
/**
* The owner defines whose image recipes you wish to list. By default this request will only show image recipes owned by your account. You may use this field to specify if you wish to view image recipes owned by yourself, Amazon, or those image recipes that have been shared with you by other customers.
*/
owner?: Ownership;
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListImageRecipesResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of image pipelines.
*/
imageRecipeSummaryList?: ImageRecipeSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListImagesRequest {
/**
* The owner defines whose images you wish to list. By default this request will only show images owned by your account. You may use this field to specify if you wish to view images owned by yourself, Amazon, or those images that have been shared with you by other customers.
*/
owner?: Ownership;
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListImagesResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of image semantic versions.
*/
imageVersionList?: ImageVersionList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListInfrastructureConfigurationsRequest {
/**
*
*/
filters?: FilterList;
/**
* The maximum items to return in a request.
*/
maxResults?: RestrictedInteger;
/**
* A token to specify where to start paginating. This is the NextToken from a previously truncated response.
*/
nextToken?: NonEmptyString;
}
export interface ListInfrastructureConfigurationsResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The list of infrastructure configurations.
*/
infrastructureConfigurationSummaryList?: InfrastructureConfigurationSummaryList;
/**
* The next token used for paginated responses. When this is not empty then there are additional elements that the service that not include in this request. Use this token with the next request to retrieve additional object.
*/
nextToken?: NonEmptyString;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource whose tags you wish to retrieve.
*/
resourceArn: ImageBuilderArn;
}
export interface ListTagsForResourceResponse {
/**
* The tags for the specified resource.
*/
tags?: TagMap;
}
export interface Logging {
/**
* The S3 logging configuration.
*/
s3Logs?: S3Logs;
}
export type NonEmptyString = string;
export type NullableBoolean = boolean;
export interface OutputResources {
/**
* The EC2 AMIs created by this image.
*/
amis?: AmiList;
}
export type Ownership = "Self"|"Shared"|"Amazon"|string;
export type PipelineExecutionStartCondition = "EXPRESSION_MATCH_ONLY"|"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"|string;
export type PipelineStatus = "DISABLED"|"ENABLED"|string;
export type Platform = "Windows"|"Linux"|string;
export interface PutComponentPolicyRequest {
/**
* The Amazon Resource Name (ARN) of the component that this policy should be applied to.
*/
componentArn: ComponentBuildVersionArn;
/**
* The policy to apply.
*/
policy: NonEmptyString;
}
export interface PutComponentPolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the component that this policy was applied to.
*/
componentArn?: ComponentBuildVersionArn;
}
export interface PutImagePolicyRequest {
/**
* The Amazon Resource Name (ARN) of the image that this policy should be applied to.
*/
imageArn: ImageBuildVersionArn;
/**
* The policy to apply.
*/
policy: NonEmptyString;
}
export interface PutImagePolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image that this policy was applied to.
*/
imageArn?: ImageBuildVersionArn;
}
export interface PutImageRecipePolicyRequest {
/**
* The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
*/
imageRecipeArn: ImageRecipeArn;
/**
* The policy to apply.
*/
policy: NonEmptyString;
}
export interface PutImageRecipePolicyResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
*/
imageRecipeArn?: ImageRecipeArn;
}
export type ResourceName = string;
export type RestrictedInteger = number;
export interface S3Logs {
/**
* The S3 bucket in which to store the logs.
*/
s3BucketName?: NonEmptyString;
/**
* The S3 path in which to store the logs.
*/
s3KeyPrefix?: NonEmptyString;
}
export interface Schedule {
/**
* The expression determines how often a pipeline starts the creation of new images.
*/
scheduleExpression?: NonEmptyString;
/**
* The condition configures when the pipeline should trigger a new image build.
*/
pipelineExecutionStartCondition?: PipelineExecutionStartCondition;
}
export type SecurityGroupIds = NonEmptyString[];
export interface StartImagePipelineExecutionRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline that you wish to manually invoke.
*/
imagePipelineArn: ImagePipelineArn;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface StartImagePipelineExecutionResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image that was created by this request.
*/
imageBuildVersionArn?: ImageBuildVersionArn;
}
export type StringList = NonEmptyString[];
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that you wish to tag.
*/
resourceArn: ImageBuilderArn;
/**
* The tags to apply to the resource.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource that you wish to untag.
*/
resourceArn: ImageBuilderArn;
/**
* The tag keys to remove from the resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateDistributionConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the distribution configuration that you wish to update.
*/
distributionConfigurationArn: DistributionConfigurationArn;
/**
* The description of the distribution configuration.
*/
description?: NonEmptyString;
/**
* The distributions of the distribution configuration.
*/
distributions?: DistributionList;
/**
* The idempotency token of the distribution configuration.
*/
clientToken: ClientToken;
}
export interface UpdateDistributionConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
}
export interface UpdateImagePipelineRequest {
/**
* The Amazon Resource Name (ARN) of the image pipeline that you wish to update.
*/
imagePipelineArn: ImagePipelineArn;
/**
* The description of the image pipeline.
*/
description?: NonEmptyString;
/**
* The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
*/
imageRecipeArn?: ImageRecipeArn;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
/**
* The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
*/
distributionConfigurationArn?: DistributionConfigurationArn;
/**
* The image test configuration of the image pipeline.
*/
imageTestsConfiguration?: ImageTestsConfiguration;
/**
* The schedule of the image pipeline.
*/
schedule?: Schedule;
/**
* The status of the image pipeline.
*/
status?: PipelineStatus;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface UpdateImagePipelineResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
*/
imagePipelineArn?: ImagePipelineArn;
}
export interface UpdateInfrastructureConfigurationRequest {
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to update.
*/
infrastructureConfigurationArn: InfrastructureConfigurationArn;
/**
* The description of the infrastructure configuration.
*/
description?: NonEmptyString;
/**
* The instance types of the infrastructure configuration. You may specify one or more instance types to use for this build, the service will pick one of these instance types based on availability.
*/
instanceTypes?: InstanceTypeList;
/**
* The instance profile to associate with the instance used to customize your EC2 AMI.
*/
instanceProfileName?: NonEmptyString;
/**
* The security group IDs to associate with the instance used to customize your EC2 AMI.
*/
securityGroupIds?: SecurityGroupIds;
/**
* The subnet ID to place the instance used to customize your EC2 AMI in.
*/
subnetId?: NonEmptyString;
/**
* The logging configuration of the infrastructure configuration.
*/
logging?: Logging;
/**
* The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to create your image.
*/
keyPair?: NonEmptyString;
/**
* The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image Builder to retain the instance used to configure your AMI in the event that the build or test phase of your workflow failed.
*/
terminateInstanceOnFailure?: NullableBoolean;
/**
* The SNS topic on which to send image build events.
*/
snsTopicArn?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken: ClientToken;
}
export interface UpdateInfrastructureConfigurationResponse {
/**
* The request ID that uniquely identifies this request.
*/
requestId?: NonEmptyString;
/**
* The idempotency token used to make this request idempotent.
*/
clientToken?: ClientToken;
/**
* The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
*/
infrastructureConfigurationArn?: InfrastructureConfigurationArn;
}
export type Uri = string;
export type VersionNumber = 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 = "2019-12-02"|"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 Imagebuilder client.
*/
export import Types = Imagebuilder;
}
export = Imagebuilder;