amplify.d.ts
65.5 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
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 Amplify extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Amplify.Types.ClientConfiguration)
config: Config & Amplify.Types.ClientConfiguration;
/**
* Creates a new Amplify app.
*/
createApp(params: Amplify.Types.CreateAppRequest, callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>;
/**
* Creates a new Amplify app.
*/
createApp(callback?: (err: AWSError, data: Amplify.Types.CreateAppResult) => void): Request<Amplify.Types.CreateAppResult, AWSError>;
/**
* Creates a new backend environment for an Amplify app.
*/
createBackendEnvironment(params: Amplify.Types.CreateBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBackendEnvironmentResult) => void): Request<Amplify.Types.CreateBackendEnvironmentResult, AWSError>;
/**
* Creates a new backend environment for an Amplify app.
*/
createBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.CreateBackendEnvironmentResult) => void): Request<Amplify.Types.CreateBackendEnvironmentResult, AWSError>;
/**
* Creates a new branch for an Amplify app.
*/
createBranch(params: Amplify.Types.CreateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>;
/**
* Creates a new branch for an Amplify app.
*/
createBranch(callback?: (err: AWSError, data: Amplify.Types.CreateBranchResult) => void): Request<Amplify.Types.CreateBranchResult, AWSError>;
/**
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
*/
createDeployment(params: Amplify.Types.CreateDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>;
/**
* Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.
*/
createDeployment(callback?: (err: AWSError, data: Amplify.Types.CreateDeploymentResult) => void): Request<Amplify.Types.CreateDeploymentResult, AWSError>;
/**
* Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
*/
createDomainAssociation(params: Amplify.Types.CreateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
/**
* Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app
*/
createDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.CreateDomainAssociationResult) => void): Request<Amplify.Types.CreateDomainAssociationResult, AWSError>;
/**
* Creates a new webhook on an Amplify app.
*/
createWebhook(params: Amplify.Types.CreateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>;
/**
* Creates a new webhook on an Amplify app.
*/
createWebhook(callback?: (err: AWSError, data: Amplify.Types.CreateWebhookResult) => void): Request<Amplify.Types.CreateWebhookResult, AWSError>;
/**
* Deletes an existing Amplify app specified by an app ID.
*/
deleteApp(params: Amplify.Types.DeleteAppRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
/**
* Deletes an existing Amplify app specified by an app ID.
*/
deleteApp(callback?: (err: AWSError, data: Amplify.Types.DeleteAppResult) => void): Request<Amplify.Types.DeleteAppResult, AWSError>;
/**
* Deletes a backend environment for an Amplify app.
*/
deleteBackendEnvironment(params: Amplify.Types.DeleteBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBackendEnvironmentResult) => void): Request<Amplify.Types.DeleteBackendEnvironmentResult, AWSError>;
/**
* Deletes a backend environment for an Amplify app.
*/
deleteBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.DeleteBackendEnvironmentResult) => void): Request<Amplify.Types.DeleteBackendEnvironmentResult, AWSError>;
/**
* Deletes a branch for an Amplify app.
*/
deleteBranch(params: Amplify.Types.DeleteBranchRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
/**
* Deletes a branch for an Amplify app.
*/
deleteBranch(callback?: (err: AWSError, data: Amplify.Types.DeleteBranchResult) => void): Request<Amplify.Types.DeleteBranchResult, AWSError>;
/**
* Deletes a domain association for an Amplify app.
*/
deleteDomainAssociation(params: Amplify.Types.DeleteDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
/**
* Deletes a domain association for an Amplify app.
*/
deleteDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.DeleteDomainAssociationResult) => void): Request<Amplify.Types.DeleteDomainAssociationResult, AWSError>;
/**
* Deletes a job for a branch of an Amplify app.
*/
deleteJob(params: Amplify.Types.DeleteJobRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
/**
* Deletes a job for a branch of an Amplify app.
*/
deleteJob(callback?: (err: AWSError, data: Amplify.Types.DeleteJobResult) => void): Request<Amplify.Types.DeleteJobResult, AWSError>;
/**
* Deletes a webhook.
*/
deleteWebhook(params: Amplify.Types.DeleteWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>;
/**
* Deletes a webhook.
*/
deleteWebhook(callback?: (err: AWSError, data: Amplify.Types.DeleteWebhookResult) => void): Request<Amplify.Types.DeleteWebhookResult, AWSError>;
/**
* Returns the website access logs for a specific time range using a presigned URL.
*/
generateAccessLogs(params: Amplify.Types.GenerateAccessLogsRequest, callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>;
/**
* Returns the website access logs for a specific time range using a presigned URL.
*/
generateAccessLogs(callback?: (err: AWSError, data: Amplify.Types.GenerateAccessLogsResult) => void): Request<Amplify.Types.GenerateAccessLogsResult, AWSError>;
/**
* Returns an existing Amplify app by appID.
*/
getApp(params: Amplify.Types.GetAppRequest, callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
/**
* Returns an existing Amplify app by appID.
*/
getApp(callback?: (err: AWSError, data: Amplify.Types.GetAppResult) => void): Request<Amplify.Types.GetAppResult, AWSError>;
/**
* Returns the artifact info that corresponds to an artifact id.
*/
getArtifactUrl(params: Amplify.Types.GetArtifactUrlRequest, callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>;
/**
* Returns the artifact info that corresponds to an artifact id.
*/
getArtifactUrl(callback?: (err: AWSError, data: Amplify.Types.GetArtifactUrlResult) => void): Request<Amplify.Types.GetArtifactUrlResult, AWSError>;
/**
* Returns a backend environment for an Amplify app.
*/
getBackendEnvironment(params: Amplify.Types.GetBackendEnvironmentRequest, callback?: (err: AWSError, data: Amplify.Types.GetBackendEnvironmentResult) => void): Request<Amplify.Types.GetBackendEnvironmentResult, AWSError>;
/**
* Returns a backend environment for an Amplify app.
*/
getBackendEnvironment(callback?: (err: AWSError, data: Amplify.Types.GetBackendEnvironmentResult) => void): Request<Amplify.Types.GetBackendEnvironmentResult, AWSError>;
/**
* Returns a branch for an Amplify app.
*/
getBranch(params: Amplify.Types.GetBranchRequest, callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
/**
* Returns a branch for an Amplify app.
*/
getBranch(callback?: (err: AWSError, data: Amplify.Types.GetBranchResult) => void): Request<Amplify.Types.GetBranchResult, AWSError>;
/**
* Returns the domain information for an Amplify app.
*/
getDomainAssociation(params: Amplify.Types.GetDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
/**
* Returns the domain information for an Amplify app.
*/
getDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.GetDomainAssociationResult) => void): Request<Amplify.Types.GetDomainAssociationResult, AWSError>;
/**
* Returns a job for a branch of an Amplify app.
*/
getJob(params: Amplify.Types.GetJobRequest, callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
/**
* Returns a job for a branch of an Amplify app.
*/
getJob(callback?: (err: AWSError, data: Amplify.Types.GetJobResult) => void): Request<Amplify.Types.GetJobResult, AWSError>;
/**
* Returns the webhook information that corresponds to a specified webhook ID.
*/
getWebhook(params: Amplify.Types.GetWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>;
/**
* Returns the webhook information that corresponds to a specified webhook ID.
*/
getWebhook(callback?: (err: AWSError, data: Amplify.Types.GetWebhookResult) => void): Request<Amplify.Types.GetWebhookResult, AWSError>;
/**
* Returns a list of the existing Amplify apps.
*/
listApps(params: Amplify.Types.ListAppsRequest, callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
/**
* Returns a list of the existing Amplify apps.
*/
listApps(callback?: (err: AWSError, data: Amplify.Types.ListAppsResult) => void): Request<Amplify.Types.ListAppsResult, AWSError>;
/**
* Returns a list of artifacts for a specified app, branch, and job.
*/
listArtifacts(params: Amplify.Types.ListArtifactsRequest, callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>;
/**
* Returns a list of artifacts for a specified app, branch, and job.
*/
listArtifacts(callback?: (err: AWSError, data: Amplify.Types.ListArtifactsResult) => void): Request<Amplify.Types.ListArtifactsResult, AWSError>;
/**
* Lists the backend environments for an Amplify app.
*/
listBackendEnvironments(params: Amplify.Types.ListBackendEnvironmentsRequest, callback?: (err: AWSError, data: Amplify.Types.ListBackendEnvironmentsResult) => void): Request<Amplify.Types.ListBackendEnvironmentsResult, AWSError>;
/**
* Lists the backend environments for an Amplify app.
*/
listBackendEnvironments(callback?: (err: AWSError, data: Amplify.Types.ListBackendEnvironmentsResult) => void): Request<Amplify.Types.ListBackendEnvironmentsResult, AWSError>;
/**
* Lists the branches of an Amplify app.
*/
listBranches(params: Amplify.Types.ListBranchesRequest, callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
/**
* Lists the branches of an Amplify app.
*/
listBranches(callback?: (err: AWSError, data: Amplify.Types.ListBranchesResult) => void): Request<Amplify.Types.ListBranchesResult, AWSError>;
/**
* Returns the domain associations for an Amplify app.
*/
listDomainAssociations(params: Amplify.Types.ListDomainAssociationsRequest, callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
/**
* Returns the domain associations for an Amplify app.
*/
listDomainAssociations(callback?: (err: AWSError, data: Amplify.Types.ListDomainAssociationsResult) => void): Request<Amplify.Types.ListDomainAssociationsResult, AWSError>;
/**
* Lists the jobs for a branch of an Amplify app.
*/
listJobs(params: Amplify.Types.ListJobsRequest, callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
/**
* Lists the jobs for a branch of an Amplify app.
*/
listJobs(callback?: (err: AWSError, data: Amplify.Types.ListJobsResult) => void): Request<Amplify.Types.ListJobsResult, AWSError>;
/**
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*/
listTagsForResource(params: Amplify.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of tags for a specified Amazon Resource Name (ARN).
*/
listTagsForResource(callback?: (err: AWSError, data: Amplify.Types.ListTagsForResourceResponse) => void): Request<Amplify.Types.ListTagsForResourceResponse, AWSError>;
/**
* Returns a list of webhooks for an Amplify app.
*/
listWebhooks(params: Amplify.Types.ListWebhooksRequest, callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>;
/**
* Returns a list of webhooks for an Amplify app.
*/
listWebhooks(callback?: (err: AWSError, data: Amplify.Types.ListWebhooksResult) => void): Request<Amplify.Types.ListWebhooksResult, AWSError>;
/**
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
*/
startDeployment(params: Amplify.Types.StartDeploymentRequest, callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>;
/**
* Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.
*/
startDeployment(callback?: (err: AWSError, data: Amplify.Types.StartDeploymentResult) => void): Request<Amplify.Types.StartDeploymentResult, AWSError>;
/**
* Starts a new job for a branch of an Amplify app.
*/
startJob(params: Amplify.Types.StartJobRequest, callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
/**
* Starts a new job for a branch of an Amplify app.
*/
startJob(callback?: (err: AWSError, data: Amplify.Types.StartJobResult) => void): Request<Amplify.Types.StartJobResult, AWSError>;
/**
* Stops a job that is in progress for a branch of an Amplify app.
*/
stopJob(params: Amplify.Types.StopJobRequest, callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
/**
* Stops a job that is in progress for a branch of an Amplify app.
*/
stopJob(callback?: (err: AWSError, data: Amplify.Types.StopJobResult) => void): Request<Amplify.Types.StopJobResult, AWSError>;
/**
* Tags the resource with a tag key and value.
*/
tagResource(params: Amplify.Types.TagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>;
/**
* Tags the resource with a tag key and value.
*/
tagResource(callback?: (err: AWSError, data: Amplify.Types.TagResourceResponse) => void): Request<Amplify.Types.TagResourceResponse, AWSError>;
/**
* Untags a resource with a specified Amazon Resource Name (ARN).
*/
untagResource(params: Amplify.Types.UntagResourceRequest, callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>;
/**
* Untags a resource with a specified Amazon Resource Name (ARN).
*/
untagResource(callback?: (err: AWSError, data: Amplify.Types.UntagResourceResponse) => void): Request<Amplify.Types.UntagResourceResponse, AWSError>;
/**
* Updates an existing Amplify app.
*/
updateApp(params: Amplify.Types.UpdateAppRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
/**
* Updates an existing Amplify app.
*/
updateApp(callback?: (err: AWSError, data: Amplify.Types.UpdateAppResult) => void): Request<Amplify.Types.UpdateAppResult, AWSError>;
/**
* Updates a branch for an Amplify app.
*/
updateBranch(params: Amplify.Types.UpdateBranchRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
/**
* Updates a branch for an Amplify app.
*/
updateBranch(callback?: (err: AWSError, data: Amplify.Types.UpdateBranchResult) => void): Request<Amplify.Types.UpdateBranchResult, AWSError>;
/**
* Creates a new domain association for an Amplify app.
*/
updateDomainAssociation(params: Amplify.Types.UpdateDomainAssociationRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
/**
* Creates a new domain association for an Amplify app.
*/
updateDomainAssociation(callback?: (err: AWSError, data: Amplify.Types.UpdateDomainAssociationResult) => void): Request<Amplify.Types.UpdateDomainAssociationResult, AWSError>;
/**
* Updates a webhook.
*/
updateWebhook(params: Amplify.Types.UpdateWebhookRequest, callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>;
/**
* Updates a webhook.
*/
updateWebhook(callback?: (err: AWSError, data: Amplify.Types.UpdateWebhookResult) => void): Request<Amplify.Types.UpdateWebhookResult, AWSError>;
}
declare namespace Amplify {
export type AccessToken = string;
export type ActiveJobId = string;
export interface App {
/**
* The unique ID of the Amplify app.
*/
appId: AppId;
/**
* The Amazon Resource Name (ARN) of the Amplify app.
*/
appArn: AppArn;
/**
* The name for the Amplify app.
*/
name: Name;
/**
* The tag for the Amplify app.
*/
tags?: TagMap;
/**
* The description for the Amplify app.
*/
description: Description;
/**
* The repository for the Amplify app.
*/
repository: Repository;
/**
* The platform for the Amplify app.
*/
platform: Platform;
/**
* Creates a date and time for the Amplify app.
*/
createTime: CreateTime;
/**
* Updates the date and time for the Amplify app.
*/
updateTime: UpdateTime;
/**
* The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
*/
iamServiceRoleArn?: ServiceRoleArn;
/**
* The environment variables for the Amplify app.
*/
environmentVariables: EnvironmentVariables;
/**
* The default domain for the Amplify app.
*/
defaultDomain: DefaultDomain;
/**
* Enables the auto-building of branches for the Amplify app.
*/
enableBranchAutoBuild: EnableBranchAutoBuild;
/**
* Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
*/
enableBranchAutoDeletion?: EnableBranchAutoDeletion;
/**
* Enables basic authorization for the Amplify app's branches.
*/
enableBasicAuth: EnableBasicAuth;
/**
* The basic authorization credentials for branches for the Amplify app.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* Describes the custom redirect and rewrite rules for the Amplify app.
*/
customRules?: CustomRules;
/**
* Describes the information about a production branch of the Amplify app.
*/
productionBranch?: ProductionBranch;
/**
* Describes the content of the build specification (build spec) for the Amplify app.
*/
buildSpec?: BuildSpec;
/**
* Enables automated branch creation for the Amplify app.
*/
enableAutoBranchCreation?: EnableAutoBranchCreation;
/**
* Describes the automated branch creation glob patterns for the Amplify app.
*/
autoBranchCreationPatterns?: AutoBranchCreationPatterns;
/**
* Describes the automated branch creation configuration for the Amplify app.
*/
autoBranchCreationConfig?: AutoBranchCreationConfig;
}
export type AppArn = string;
export type AppId = string;
export type Apps = App[];
export interface Artifact {
/**
* The file name for the artifact.
*/
artifactFileName: ArtifactFileName;
/**
* The unique ID for the artifact.
*/
artifactId: ArtifactId;
}
export type ArtifactFileName = string;
export type ArtifactId = string;
export type ArtifactUrl = string;
export type Artifacts = Artifact[];
export type ArtifactsUrl = string;
export type AssociatedResource = string;
export type AssociatedResources = AssociatedResource[];
export interface AutoBranchCreationConfig {
/**
* Describes the current stage for the autocreated branch.
*/
stage?: Stage;
/**
* The framework for the autocreated branch.
*/
framework?: Framework;
/**
* Enables auto building for the autocreated branch.
*/
enableAutoBuild?: EnableAutoBuild;
/**
* The environment variables for the autocreated branch.
*/
environmentVariables?: EnvironmentVariables;
/**
* The basic authorization credentials for the autocreated branch.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* Enables basic authorization for the autocreated branch.
*/
enableBasicAuth?: EnableBasicAuth;
/**
* Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
*/
enablePerformanceMode?: EnablePerformanceMode;
/**
* The build specification (build spec) for the autocreated branch.
*/
buildSpec?: BuildSpec;
/**
* Enables pull request preview for the autocreated branch.
*/
enablePullRequestPreview?: EnablePullRequestPreview;
/**
* The Amplify environment name for the pull request.
*/
pullRequestEnvironmentName?: PullRequestEnvironmentName;
}
export type AutoBranchCreationPattern = string;
export type AutoBranchCreationPatterns = AutoBranchCreationPattern[];
export type AutoSubDomainCreationPattern = string;
export type AutoSubDomainCreationPatterns = AutoSubDomainCreationPattern[];
export type AutoSubDomainIAMRole = string;
export interface BackendEnvironment {
/**
* The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
*/
backendEnvironmentArn: BackendEnvironmentArn;
/**
* The name for a backend environment that is part of an Amplify app.
*/
environmentName: EnvironmentName;
/**
* The AWS CloudFormation stack name of a backend environment.
*/
stackName?: StackName;
/**
* The name of deployment artifacts.
*/
deploymentArtifacts?: DeploymentArtifacts;
/**
* The creation date and time for a backend environment that is part of an Amplify app.
*/
createTime: CreateTime;
/**
* The last updated date and time for a backend environment that is part of an Amplify app.
*/
updateTime: UpdateTime;
}
export type BackendEnvironmentArn = string;
export type BackendEnvironments = BackendEnvironment[];
export type BasicAuthCredentials = string;
export interface Branch {
/**
* The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
*/
branchArn: BranchArn;
/**
* The name for the branch that is part of an Amplify app.
*/
branchName: BranchName;
/**
* The description for the branch that is part of an Amplify app.
*/
description: Description;
/**
* The tag for the branch of an Amplify app.
*/
tags?: TagMap;
/**
* The current stage for the branch that is part of an Amplify app.
*/
stage: Stage;
/**
* The display name for the branch. This is used as the default domain prefix.
*/
displayName: DisplayName;
/**
* Enables notifications for a branch that is part of an Amplify app.
*/
enableNotification: EnableNotification;
/**
* The creation date and time for a branch that is part of an Amplify app.
*/
createTime: CreateTime;
/**
* The last updated date and time for a branch that is part of an Amplify app.
*/
updateTime: UpdateTime;
/**
* The environment variables specific to a branch of an Amplify app.
*/
environmentVariables: EnvironmentVariables;
/**
* Enables auto-building on push for a branch of an Amplify app.
*/
enableAutoBuild: EnableAutoBuild;
/**
* The custom domains for a branch of an Amplify app.
*/
customDomains: CustomDomains;
/**
* The framework for a branch of an Amplify app.
*/
framework: Framework;
/**
* The ID of the active job for a branch of an Amplify app.
*/
activeJobId: ActiveJobId;
/**
* The total number of jobs that are part of an Amplify app.
*/
totalNumberOfJobs: TotalNumberOfJobs;
/**
* Enables basic authorization for a branch of an Amplify app.
*/
enableBasicAuth: EnableBasicAuth;
/**
* Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
*/
enablePerformanceMode?: EnablePerformanceMode;
/**
* The thumbnail URL for the branch of an Amplify app.
*/
thumbnailUrl?: ThumbnailUrl;
/**
* The basic authorization credentials for a branch of an Amplify app.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* The build specification (build spec) content for the branch of an Amplify app.
*/
buildSpec?: BuildSpec;
/**
* The content Time to Live (TTL) for the website in seconds.
*/
ttl: TTL;
/**
* A list of custom resources that are linked to this branch.
*/
associatedResources?: AssociatedResources;
/**
* Enables pull request preview for the branch.
*/
enablePullRequestPreview: EnablePullRequestPreview;
/**
* The Amplify environment name for the pull request.
*/
pullRequestEnvironmentName?: PullRequestEnvironmentName;
/**
* The destination branch if the branch is a pull request branch.
*/
destinationBranch?: BranchName;
/**
* The source branch if the branch is a pull request branch.
*/
sourceBranch?: BranchName;
/**
* The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
*/
backendEnvironmentArn?: BackendEnvironmentArn;
}
export type BranchArn = string;
export type BranchName = string;
export type Branches = Branch[];
export type BuildSpec = string;
export type CertificateVerificationDNSRecord = string;
export type CommitId = string;
export type CommitMessage = string;
export type CommitTime = Date;
export type Condition = string;
export type Context = string;
export interface CreateAppRequest {
/**
* The name for the Amplify app.
*/
name: Name;
/**
* The description for an Amplify app.
*/
description?: Description;
/**
* The repository for an Amplify app.
*/
repository?: Repository;
/**
* The platform or framework for an Amplify app.
*/
platform?: Platform;
/**
* The AWS Identity and Access Management (IAM) service role for an Amplify app.
*/
iamServiceRoleArn?: ServiceRoleArn;
/**
* The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
*/
oauthToken?: OauthToken;
/**
* The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
*/
accessToken?: AccessToken;
/**
* The environment variables map for an Amplify app.
*/
environmentVariables?: EnvironmentVariables;
/**
* Enables the auto building of branches for an Amplify app.
*/
enableBranchAutoBuild?: EnableBranchAutoBuild;
/**
* Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
*/
enableBranchAutoDeletion?: EnableBranchAutoDeletion;
/**
* Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
*/
enableBasicAuth?: EnableBasicAuth;
/**
* The credentials for basic authorization for an Amplify app.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* The custom rewrite and redirect rules for an Amplify app.
*/
customRules?: CustomRules;
/**
* The tag for an Amplify app.
*/
tags?: TagMap;
/**
* The build specification (build spec) for an Amplify app.
*/
buildSpec?: BuildSpec;
/**
* Enables automated branch creation for the Amplify app.
*/
enableAutoBranchCreation?: EnableAutoBranchCreation;
/**
* The automated branch creation glob patterns for the Amplify app.
*/
autoBranchCreationPatterns?: AutoBranchCreationPatterns;
/**
* The automated branch creation configuration for the Amplify app.
*/
autoBranchCreationConfig?: AutoBranchCreationConfig;
}
export interface CreateAppResult {
app: App;
}
export interface CreateBackendEnvironmentRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the backend environment.
*/
environmentName: EnvironmentName;
/**
* The AWS CloudFormation stack name of a backend environment.
*/
stackName?: StackName;
/**
* The name of deployment artifacts.
*/
deploymentArtifacts?: DeploymentArtifacts;
}
export interface CreateBackendEnvironmentResult {
/**
* Describes the backend environment for an Amplify app.
*/
backendEnvironment: BackendEnvironment;
}
export interface CreateBranchRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch.
*/
branchName: BranchName;
/**
* The description for the branch.
*/
description?: Description;
/**
* Describes the current stage for the branch.
*/
stage?: Stage;
/**
* The framework for the branch.
*/
framework?: Framework;
/**
* Enables notifications for the branch.
*/
enableNotification?: EnableNotification;
/**
* Enables auto building for the branch.
*/
enableAutoBuild?: EnableAutoBuild;
/**
* The environment variables for the branch.
*/
environmentVariables?: EnvironmentVariables;
/**
* The basic authorization credentials for the branch.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* Enables basic authorization for the branch.
*/
enableBasicAuth?: EnableBasicAuth;
/**
* Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
*/
enablePerformanceMode?: EnablePerformanceMode;
/**
* The tag for the branch.
*/
tags?: TagMap;
/**
* The build specification (build spec) for the branch.
*/
buildSpec?: BuildSpec;
/**
* The content Time To Live (TTL) for the website in seconds.
*/
ttl?: TTL;
/**
* The display name for a branch. This is used as the default domain prefix.
*/
displayName?: DisplayName;
/**
* Enables pull request preview for this branch.
*/
enablePullRequestPreview?: EnablePullRequestPreview;
/**
* The Amplify environment name for the pull request.
*/
pullRequestEnvironmentName?: PullRequestEnvironmentName;
/**
* The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
*/
backendEnvironmentArn?: BackendEnvironmentArn;
}
export interface CreateBranchResult {
/**
* Describes the branch for an Amplify app, which maps to a third-party repository branch.
*/
branch: Branch;
}
export interface CreateDeploymentRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch, for the job.
*/
branchName: BranchName;
/**
* An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.
*/
fileMap?: FileMap;
}
export interface CreateDeploymentResult {
/**
* The job ID for this deployment. will supply to start deployment api.
*/
jobId?: JobId;
/**
* When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.
*/
fileUploadUrls: FileUploadUrls;
/**
* When the fileMap argument is not provided in the request, this zipUploadUrl is returned.
*/
zipUploadUrl: UploadUrl;
}
export interface CreateDomainAssociationRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The domain name for the domain association.
*/
domainName: DomainName;
/**
* Enables the automated creation of subdomains for branches.
*/
enableAutoSubDomain?: EnableAutoSubDomain;
/**
* The setting for the subdomain.
*/
subDomainSettings: SubDomainSettings;
/**
* Sets the branch patterns for automatic subdomain creation.
*/
autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns;
/**
* The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
*/
autoSubDomainIAMRole?: AutoSubDomainIAMRole;
}
export interface CreateDomainAssociationResult {
/**
* Describes the structure of a domain association, which associates a custom domain with an Amplify app.
*/
domainAssociation: DomainAssociation;
}
export type CreateTime = Date;
export interface CreateWebhookRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for a branch that is part of an Amplify app.
*/
branchName: BranchName;
/**
* The description for a webhook.
*/
description?: Description;
}
export interface CreateWebhookResult {
/**
* Describes a webhook that connects repository events to an Amplify app.
*/
webhook: Webhook;
}
export type CustomDomain = string;
export type CustomDomains = CustomDomain[];
export interface CustomRule {
/**
* The source pattern for a URL rewrite or redirect rule.
*/
source: Source;
/**
* The target pattern for a URL rewrite or redirect rule.
*/
target: Target;
/**
* The status code for a URL rewrite or redirect rule. 200 Represents a 200 rewrite rule. 301 Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. 302 Represents a 302 temporary redirect rule. 404 Represents a 404 redirect rule. 404-200 Represents a 404 rewrite rule.
*/
status?: Status;
/**
* The condition for a URL rewrite or redirect rule, such as a country code.
*/
condition?: Condition;
}
export type CustomRules = CustomRule[];
export type DNSRecord = string;
export type DefaultDomain = string;
export interface DeleteAppRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
}
export interface DeleteAppResult {
app: App;
}
export interface DeleteBackendEnvironmentRequest {
/**
* The unique ID of an Amplify app.
*/
appId: AppId;
/**
* The name of a backend environment of an Amplify app.
*/
environmentName: EnvironmentName;
}
export interface DeleteBackendEnvironmentResult {
/**
* Describes the backend environment for an Amplify app.
*/
backendEnvironment: BackendEnvironment;
}
export interface DeleteBranchRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch.
*/
branchName: BranchName;
}
export interface DeleteBranchResult {
/**
* The branch for an Amplify app, which maps to a third-party repository branch.
*/
branch: Branch;
}
export interface DeleteDomainAssociationRequest {
/**
* The unique id for an Amplify app.
*/
appId: AppId;
/**
* The name of the domain.
*/
domainName: DomainName;
}
export interface DeleteDomainAssociationResult {
domainAssociation: DomainAssociation;
}
export interface DeleteJobRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch, for the job.
*/
branchName: BranchName;
/**
* The unique ID for the job.
*/
jobId: JobId;
}
export interface DeleteJobResult {
jobSummary: JobSummary;
}
export interface DeleteWebhookRequest {
/**
* The unique ID for a webhook.
*/
webhookId: WebhookId;
}
export interface DeleteWebhookResult {
/**
* Describes a webhook that connects repository events to an Amplify app.
*/
webhook: Webhook;
}
export type DeploymentArtifacts = string;
export type Description = string;
export type DisplayName = string;
export interface DomainAssociation {
/**
* The Amazon Resource Name (ARN) for the domain association.
*/
domainAssociationArn: DomainAssociationArn;
/**
* The name of the domain.
*/
domainName: DomainName;
/**
* Enables the automated creation of subdomains for branches.
*/
enableAutoSubDomain: EnableAutoSubDomain;
/**
* Sets branch patterns for automatic subdomain creation.
*/
autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns;
/**
* The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
*/
autoSubDomainIAMRole?: AutoSubDomainIAMRole;
/**
* The current status of the domain association.
*/
domainStatus: DomainStatus;
/**
* The reason for the current status of the domain association.
*/
statusReason: StatusReason;
/**
* The DNS record for certificate verification.
*/
certificateVerificationDNSRecord?: CertificateVerificationDNSRecord;
/**
* The subdomains for the domain association.
*/
subDomains: SubDomains;
}
export type DomainAssociationArn = string;
export type DomainAssociations = DomainAssociation[];
export type DomainName = string;
export type DomainPrefix = string;
export type DomainStatus = "PENDING_VERIFICATION"|"IN_PROGRESS"|"AVAILABLE"|"PENDING_DEPLOYMENT"|"FAILED"|"CREATING"|"REQUESTING_CERTIFICATE"|"UPDATING"|string;
export type EnableAutoBranchCreation = boolean;
export type EnableAutoBuild = boolean;
export type EnableAutoSubDomain = boolean;
export type EnableBasicAuth = boolean;
export type EnableBranchAutoBuild = boolean;
export type EnableBranchAutoDeletion = boolean;
export type EnableNotification = boolean;
export type EnablePerformanceMode = boolean;
export type EnablePullRequestPreview = boolean;
export type EndTime = Date;
export type EnvKey = string;
export type EnvValue = string;
export type EnvironmentName = string;
export type EnvironmentVariables = {[key: string]: EnvValue};
export type FileMap = {[key: string]: MD5Hash};
export type FileName = string;
export type FileUploadUrls = {[key: string]: UploadUrl};
export type Framework = string;
export interface GenerateAccessLogsRequest {
/**
* The time at which the logs should start. The time range specified is inclusive of the start time.
*/
startTime?: StartTime;
/**
* The time at which the logs should end. The time range specified is inclusive of the end time.
*/
endTime?: EndTime;
/**
* The name of the domain.
*/
domainName: DomainName;
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
}
export interface GenerateAccessLogsResult {
/**
* The pre-signed URL for the requested access logs.
*/
logUrl?: LogUrl;
}
export interface GetAppRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
}
export interface GetAppResult {
app: App;
}
export interface GetArtifactUrlRequest {
/**
* The unique ID for an artifact.
*/
artifactId: ArtifactId;
}
export interface GetArtifactUrlResult {
/**
* The unique ID for an artifact.
*/
artifactId: ArtifactId;
/**
* The presigned URL for the artifact.
*/
artifactUrl: ArtifactUrl;
}
export interface GetBackendEnvironmentRequest {
/**
* The unique id for an Amplify app.
*/
appId: AppId;
/**
* The name for the backend environment.
*/
environmentName: EnvironmentName;
}
export interface GetBackendEnvironmentResult {
/**
* Describes the backend environment for an Amplify app.
*/
backendEnvironment: BackendEnvironment;
}
export interface GetBranchRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch.
*/
branchName: BranchName;
}
export interface GetBranchResult {
branch: Branch;
}
export interface GetDomainAssociationRequest {
/**
* The unique id for an Amplify app.
*/
appId: AppId;
/**
* The name of the domain.
*/
domainName: DomainName;
}
export interface GetDomainAssociationResult {
/**
* Describes the structure of a domain association, which associates a custom domain with an Amplify app.
*/
domainAssociation: DomainAssociation;
}
export interface GetJobRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The branch name for the job.
*/
branchName: BranchName;
/**
* The unique ID for the job.
*/
jobId: JobId;
}
export interface GetJobResult {
job: Job;
}
export interface GetWebhookRequest {
/**
* The unique ID for a webhook.
*/
webhookId: WebhookId;
}
export interface GetWebhookResult {
/**
* Describes the structure of a webhook.
*/
webhook: Webhook;
}
export interface Job {
/**
* Describes the summary for an execution job for an Amplify app.
*/
summary: JobSummary;
/**
* The execution steps for an execution job, for an Amplify app.
*/
steps: Steps;
}
export type JobArn = string;
export type JobId = string;
export type JobReason = string;
export type JobStatus = "PENDING"|"PROVISIONING"|"RUNNING"|"FAILED"|"SUCCEED"|"CANCELLING"|"CANCELLED"|string;
export type JobSummaries = JobSummary[];
export interface JobSummary {
/**
* The Amazon Resource Name (ARN) for the job.
*/
jobArn: JobArn;
/**
* The unique ID for the job.
*/
jobId: JobId;
/**
* The commit ID from a third-party repository provider for the job.
*/
commitId: CommitId;
/**
* The commit message from a third-party repository provider for the job.
*/
commitMessage: CommitMessage;
/**
* The commit date and time for the job.
*/
commitTime: CommitTime;
/**
* The start date and time for the job.
*/
startTime: StartTime;
/**
* The current status for the job.
*/
status: JobStatus;
/**
* The end date and time for the job.
*/
endTime?: EndTime;
/**
* The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks.
*/
jobType: JobType;
}
export type JobType = "RELEASE"|"RETRY"|"MANUAL"|"WEB_HOOK"|string;
export type LastDeployTime = Date;
export interface ListAppsRequest {
/**
* A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListAppsResult {
/**
* A list of Amplify apps.
*/
apps: Apps;
/**
* A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects.
*/
nextToken?: NextToken;
}
export interface ListArtifactsRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name of a branch that is part of an Amplify app.
*/
branchName: BranchName;
/**
* The unique ID for a job.
*/
jobId: JobId;
/**
* A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListArtifactsResult {
/**
* A list of artifacts.
*/
artifacts: Artifacts;
/**
* A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export interface ListBackendEnvironmentsRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name of the backend environment
*/
environmentName?: EnvironmentName;
/**
* A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListBackendEnvironmentsResult {
/**
* The list of backend environments for an Amplify app.
*/
backendEnvironments: BackendEnvironments;
/**
* A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export interface ListBranchesRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListBranchesResult {
/**
* A list of branches for an Amplify app.
*/
branches: Branches;
/**
* A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export interface ListDomainAssociationsRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListDomainAssociationsResult {
/**
* A list of domain associations.
*/
domainAssociations: DomainAssociations;
/**
* A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export interface ListJobsRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for a branch.
*/
branchName: BranchName;
/**
* A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListJobsResult {
/**
* The result structure for the list job result request.
*/
jobSummaries: JobSummaries;
/**
* A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) to use to list tags.
*/
resourceArn: ResourceArn;
}
export interface ListTagsForResourceResponse {
/**
* A list of tags for the specified The Amazon Resource Name (ARN).
*/
tags?: TagMap;
}
export interface ListWebhooksRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks.
*/
nextToken?: NextToken;
/**
* The maximum number of records to list in a single response.
*/
maxResults?: MaxResults;
}
export interface ListWebhooksResult {
/**
* A list of webhooks.
*/
webhooks: Webhooks;
/**
* A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries.
*/
nextToken?: NextToken;
}
export type LogUrl = string;
export type MD5Hash = string;
export type MaxResults = number;
export type Name = string;
export type NextToken = string;
export type OauthToken = string;
export type Platform = "WEB"|string;
export interface ProductionBranch {
/**
* The last deploy time of the production branch.
*/
lastDeployTime?: LastDeployTime;
/**
* The status of the production branch.
*/
status?: Status;
/**
* The thumbnail URL for the production branch.
*/
thumbnailUrl?: ThumbnailUrl;
/**
* The branch name for the production branch.
*/
branchName?: BranchName;
}
export type PullRequestEnvironmentName = string;
export type Repository = string;
export type ResourceArn = string;
export type Screenshots = {[key: string]: ThumbnailUrl};
export type ServiceRoleArn = string;
export type Source = string;
export type SourceUrl = string;
export type StackName = string;
export type Stage = "PRODUCTION"|"BETA"|"DEVELOPMENT"|"EXPERIMENTAL"|"PULL_REQUEST"|string;
export interface StartDeploymentRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch, for the job.
*/
branchName: BranchName;
/**
* The job ID for this deployment, generated by the create deployment request.
*/
jobId?: JobId;
/**
* The source URL for this deployment, used when calling start deployment without create deployment. The source URL can be any HTTP GET URL that is publicly accessible and downloads a single .zip file.
*/
sourceUrl?: SourceUrl;
}
export interface StartDeploymentResult {
/**
* The summary for the job.
*/
jobSummary: JobSummary;
}
export interface StartJobRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The branch name for the job.
*/
branchName: BranchName;
/**
* The unique ID for an existing job. This is required if the value of jobType is RETRY.
*/
jobId?: JobId;
/**
* Describes the type for the job. The job type RELEASE starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required.
*/
jobType: JobType;
/**
* A descriptive reason for starting this job.
*/
jobReason?: JobReason;
/**
* The commit ID from a third-party repository provider for the job.
*/
commitId?: CommitId;
/**
* The commit message from a third-party repository provider for the job.
*/
commitMessage?: CommitMessage;
/**
* The commit date and time for the job.
*/
commitTime?: CommitTime;
}
export interface StartJobResult {
/**
* The summary for the job.
*/
jobSummary: JobSummary;
}
export type StartTime = Date;
export type Status = string;
export type StatusReason = string;
export interface Step {
/**
* The name of the execution step.
*/
stepName: StepName;
/**
* The start date and time of the execution step.
*/
startTime: StartTime;
/**
* The status of the execution step.
*/
status: JobStatus;
/**
* The end date and time of the execution step.
*/
endTime: EndTime;
/**
* The URL to the logs for the execution step.
*/
logUrl?: LogUrl;
/**
* The URL to the artifact for the execution step.
*/
artifactsUrl?: ArtifactsUrl;
/**
* The URL to the test artifact for the execution step.
*/
testArtifactsUrl?: TestArtifactsUrl;
/**
* The URL to the test configuration for the execution step.
*/
testConfigUrl?: TestConfigUrl;
/**
* The list of screenshot URLs for the execution step, if relevant.
*/
screenshots?: Screenshots;
/**
* The reason for the current step status.
*/
statusReason?: StatusReason;
/**
* The context for the current step. Includes a build image if the step is build.
*/
context?: Context;
}
export type StepName = string;
export type Steps = Step[];
export interface StopJobRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch, for the job.
*/
branchName: BranchName;
/**
* The unique id for the job.
*/
jobId: JobId;
}
export interface StopJobResult {
/**
* The summary for the job.
*/
jobSummary: JobSummary;
}
export interface SubDomain {
/**
* Describes the settings for the subdomain.
*/
subDomainSetting: SubDomainSetting;
/**
* The verified status of the subdomain
*/
verified: Verified;
/**
* The DNS record for the subdomain.
*/
dnsRecord: DNSRecord;
}
export interface SubDomainSetting {
/**
* The prefix setting for the subdomain.
*/
prefix: DomainPrefix;
/**
* The branch name setting for the subdomain.
*/
branchName: BranchName;
}
export type SubDomainSettings = SubDomainSetting[];
export type SubDomains = SubDomain[];
export type TTL = string;
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) to use to tag a resource.
*/
resourceArn: ResourceArn;
/**
* The tags used to tag the resource.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Target = string;
export type TestArtifactsUrl = string;
export type TestConfigUrl = string;
export type ThumbnailName = string;
export type ThumbnailUrl = string;
export type TotalNumberOfJobs = string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) to use to untag a resource.
*/
resourceArn: ResourceArn;
/**
* The tag keys to use to untag a resource.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateAppRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for an Amplify app.
*/
name?: Name;
/**
* The description for an Amplify app.
*/
description?: Description;
/**
* The platform for an Amplify app.
*/
platform?: Platform;
/**
* The AWS Identity and Access Management (IAM) service role for an Amplify app.
*/
iamServiceRoleArn?: ServiceRoleArn;
/**
* The environment variables for an Amplify app.
*/
environmentVariables?: EnvironmentVariables;
/**
* Enables branch auto-building for an Amplify app.
*/
enableBranchAutoBuild?: EnableAutoBuild;
/**
* Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
*/
enableBranchAutoDeletion?: EnableBranchAutoDeletion;
/**
* Enables basic authorization for an Amplify app.
*/
enableBasicAuth?: EnableBasicAuth;
/**
* The basic authorization credentials for an Amplify app.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* The custom redirect and rewrite rules for an Amplify app.
*/
customRules?: CustomRules;
/**
* The build specification (build spec) for an Amplify app.
*/
buildSpec?: BuildSpec;
/**
* Enables automated branch creation for the Amplify app.
*/
enableAutoBranchCreation?: EnableAutoBranchCreation;
/**
* Describes the automated branch creation glob patterns for the Amplify app.
*/
autoBranchCreationPatterns?: AutoBranchCreationPatterns;
/**
* The automated branch creation configuration for the Amplify app.
*/
autoBranchCreationConfig?: AutoBranchCreationConfig;
/**
* The name of the repository for an Amplify app
*/
repository?: Repository;
/**
* The OAuth token for a third-party source control system for an Amplify app. The token is used to create a webhook and a read-only deploy key. The OAuth token is not stored.
*/
oauthToken?: OauthToken;
/**
* The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored.
*/
accessToken?: AccessToken;
}
export interface UpdateAppResult {
/**
* Represents the updated Amplify app.
*/
app: App;
}
export interface UpdateBranchRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name for the branch.
*/
branchName: BranchName;
/**
* The description for the branch.
*/
description?: Description;
/**
* The framework for the branch.
*/
framework?: Framework;
/**
* Describes the current stage for the branch.
*/
stage?: Stage;
/**
* Enables notifications for the branch.
*/
enableNotification?: EnableNotification;
/**
* Enables auto building for the branch.
*/
enableAutoBuild?: EnableAutoBuild;
/**
* The environment variables for the branch.
*/
environmentVariables?: EnvironmentVariables;
/**
* The basic authorization credentials for the branch.
*/
basicAuthCredentials?: BasicAuthCredentials;
/**
* Enables basic authorization for the branch.
*/
enableBasicAuth?: EnableBasicAuth;
/**
* Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
*/
enablePerformanceMode?: EnablePerformanceMode;
/**
* The build specification (build spec) for the branch.
*/
buildSpec?: BuildSpec;
/**
* The content Time to Live (TTL) for the website in seconds.
*/
ttl?: TTL;
/**
* The display name for a branch. This is used as the default domain prefix.
*/
displayName?: DisplayName;
/**
* Enables pull request preview for this branch.
*/
enablePullRequestPreview?: EnablePullRequestPreview;
/**
* The Amplify environment name for the pull request.
*/
pullRequestEnvironmentName?: PullRequestEnvironmentName;
/**
* The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
*/
backendEnvironmentArn?: BackendEnvironmentArn;
}
export interface UpdateBranchResult {
/**
* The branch for an Amplify app, which maps to a third-party repository branch.
*/
branch: Branch;
}
export interface UpdateDomainAssociationRequest {
/**
* The unique ID for an Amplify app.
*/
appId: AppId;
/**
* The name of the domain.
*/
domainName: DomainName;
/**
* Enables the automated creation of subdomains for branches.
*/
enableAutoSubDomain?: EnableAutoSubDomain;
/**
* Describes the settings for the subdomain.
*/
subDomainSettings: SubDomainSettings;
/**
* Sets the branch patterns for automatic subdomain creation.
*/
autoSubDomainCreationPatterns?: AutoSubDomainCreationPatterns;
/**
* The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
*/
autoSubDomainIAMRole?: AutoSubDomainIAMRole;
}
export interface UpdateDomainAssociationResult {
/**
* Describes a domain association, which associates a custom domain with an Amplify app.
*/
domainAssociation: DomainAssociation;
}
export type UpdateTime = Date;
export interface UpdateWebhookRequest {
/**
* The unique ID for a webhook.
*/
webhookId: WebhookId;
/**
* The name for a branch that is part of an Amplify app.
*/
branchName?: BranchName;
/**
* The description for a webhook.
*/
description?: Description;
}
export interface UpdateWebhookResult {
/**
* Describes a webhook that connects repository events to an Amplify app.
*/
webhook: Webhook;
}
export type UploadUrl = string;
export type Verified = boolean;
export interface Webhook {
/**
* The Amazon Resource Name (ARN) for the webhook.
*/
webhookArn: WebhookArn;
/**
* The ID of the webhook.
*/
webhookId: WebhookId;
/**
* The URL of the webhook.
*/
webhookUrl: WebhookUrl;
/**
* The name for a branch that is part of an Amplify app.
*/
branchName: BranchName;
/**
* The description for a webhook.
*/
description: Description;
/**
* The create date and time for a webhook.
*/
createTime: CreateTime;
/**
* Updates the date and time for a webhook.
*/
updateTime: UpdateTime;
}
export type WebhookArn = string;
export type WebhookId = string;
export type WebhookUrl = string;
export type Webhooks = Webhook[];
/**
* 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 = "2017-07-25"|"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 Amplify client.
*/
export import Types = Amplify;
}
export = Amplify;