backup.d.ts
114 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
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 Backup extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Backup.Types.ClientConfiguration)
config: Config & Backup.Types.ClientConfiguration;
/**
* Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.
*/
createBackupPlan(params: Backup.Types.CreateBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupPlanOutput) => void): Request<Backup.Types.CreateBackupPlanOutput, AWSError>;
/**
* Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources. If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.
*/
createBackupPlan(callback?: (err: AWSError, data: Backup.Types.CreateBackupPlanOutput) => void): Request<Backup.Types.CreateBackupPlanOutput, AWSError>;
/**
* Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns: Resources: "arn:aws:ec2:region:account-id:volume/volume-id" ConditionKey:"department" ConditionValue:"finance" ConditionType:"STRINGEQUALS" ConditionKey:"importance" ConditionValue:"critical" ConditionType:"STRINGEQUALS" Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.
*/
createBackupSelection(params: Backup.Types.CreateBackupSelectionInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupSelectionOutput) => void): Request<Backup.Types.CreateBackupSelectionOutput, AWSError>;
/**
* Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources. For example, consider the following patterns: Resources: "arn:aws:ec2:region:account-id:volume/volume-id" ConditionKey:"department" ConditionValue:"finance" ConditionType:"STRINGEQUALS" ConditionKey:"importance" ConditionValue:"critical" ConditionType:"STRINGEQUALS" Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume Id. Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.
*/
createBackupSelection(callback?: (err: AWSError, data: Backup.Types.CreateBackupSelectionOutput) => void): Request<Backup.Types.CreateBackupSelectionOutput, AWSError>;
/**
* Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Sensitive data, such as passport numbers, should not be included the name of a backup vault.
*/
createBackupVault(params: Backup.Types.CreateBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.CreateBackupVaultOutput) => void): Request<Backup.Types.CreateBackupVaultOutput, AWSError>;
/**
* Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Sensitive data, such as passport numbers, should not be included the name of a backup vault.
*/
createBackupVault(callback?: (err: AWSError, data: Backup.Types.CreateBackupVaultOutput) => void): Request<Backup.Types.CreateBackupVaultOutput, AWSError>;
/**
* Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
*/
deleteBackupPlan(params: Backup.Types.DeleteBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.DeleteBackupPlanOutput) => void): Request<Backup.Types.DeleteBackupPlanOutput, AWSError>;
/**
* Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.
*/
deleteBackupPlan(callback?: (err: AWSError, data: Backup.Types.DeleteBackupPlanOutput) => void): Request<Backup.Types.DeleteBackupPlanOutput, AWSError>;
/**
* Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
*/
deleteBackupSelection(params: Backup.Types.DeleteBackupSelectionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
*/
deleteBackupSelection(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
*/
deleteBackupVault(params: Backup.Types.DeleteBackupVaultInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
*/
deleteBackupVault(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the policy document that manages permissions on a backup vault.
*/
deleteBackupVaultAccessPolicy(params: Backup.Types.DeleteBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the policy document that manages permissions on a backup vault.
*/
deleteBackupVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes event notifications for the specified backup vault.
*/
deleteBackupVaultNotifications(params: Backup.Types.DeleteBackupVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes event notifications for the specified backup vault.
*/
deleteBackupVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the recovery point specified by a recovery point ID.
*/
deleteRecoveryPoint(params: Backup.Types.DeleteRecoveryPointInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the recovery point specified by a recovery point ID.
*/
deleteRecoveryPoint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Returns metadata associated with creating a backup of a resource.
*/
describeBackupJob(params: Backup.Types.DescribeBackupJobInput, callback?: (err: AWSError, data: Backup.Types.DescribeBackupJobOutput) => void): Request<Backup.Types.DescribeBackupJobOutput, AWSError>;
/**
* Returns metadata associated with creating a backup of a resource.
*/
describeBackupJob(callback?: (err: AWSError, data: Backup.Types.DescribeBackupJobOutput) => void): Request<Backup.Types.DescribeBackupJobOutput, AWSError>;
/**
* Returns metadata about a backup vault specified by its name.
*/
describeBackupVault(params: Backup.Types.DescribeBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.DescribeBackupVaultOutput) => void): Request<Backup.Types.DescribeBackupVaultOutput, AWSError>;
/**
* Returns metadata about a backup vault specified by its name.
*/
describeBackupVault(callback?: (err: AWSError, data: Backup.Types.DescribeBackupVaultOutput) => void): Request<Backup.Types.DescribeBackupVaultOutput, AWSError>;
/**
* Returns metadata associated with creating a copy of a resource.
*/
describeCopyJob(params: Backup.Types.DescribeCopyJobInput, callback?: (err: AWSError, data: Backup.Types.DescribeCopyJobOutput) => void): Request<Backup.Types.DescribeCopyJobOutput, AWSError>;
/**
* Returns metadata associated with creating a copy of a resource.
*/
describeCopyJob(callback?: (err: AWSError, data: Backup.Types.DescribeCopyJobOutput) => void): Request<Backup.Types.DescribeCopyJobOutput, AWSError>;
/**
* Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
*/
describeProtectedResource(params: Backup.Types.DescribeProtectedResourceInput, callback?: (err: AWSError, data: Backup.Types.DescribeProtectedResourceOutput) => void): Request<Backup.Types.DescribeProtectedResourceOutput, AWSError>;
/**
* Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.
*/
describeProtectedResource(callback?: (err: AWSError, data: Backup.Types.DescribeProtectedResourceOutput) => void): Request<Backup.Types.DescribeProtectedResourceOutput, AWSError>;
/**
* Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
*/
describeRecoveryPoint(params: Backup.Types.DescribeRecoveryPointInput, callback?: (err: AWSError, data: Backup.Types.DescribeRecoveryPointOutput) => void): Request<Backup.Types.DescribeRecoveryPointOutput, AWSError>;
/**
* Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
*/
describeRecoveryPoint(callback?: (err: AWSError, data: Backup.Types.DescribeRecoveryPointOutput) => void): Request<Backup.Types.DescribeRecoveryPointOutput, AWSError>;
/**
* Returns metadata associated with a restore job that is specified by a job ID.
*/
describeRestoreJob(params: Backup.Types.DescribeRestoreJobInput, callback?: (err: AWSError, data: Backup.Types.DescribeRestoreJobOutput) => void): Request<Backup.Types.DescribeRestoreJobOutput, AWSError>;
/**
* Returns metadata associated with a restore job that is specified by a job ID.
*/
describeRestoreJob(callback?: (err: AWSError, data: Backup.Types.DescribeRestoreJobOutput) => void): Request<Backup.Types.DescribeRestoreJobOutput, AWSError>;
/**
* Returns the backup plan that is specified by the plan ID as a backup template.
*/
exportBackupPlanTemplate(params: Backup.Types.ExportBackupPlanTemplateInput, callback?: (err: AWSError, data: Backup.Types.ExportBackupPlanTemplateOutput) => void): Request<Backup.Types.ExportBackupPlanTemplateOutput, AWSError>;
/**
* Returns the backup plan that is specified by the plan ID as a backup template.
*/
exportBackupPlanTemplate(callback?: (err: AWSError, data: Backup.Types.ExportBackupPlanTemplateOutput) => void): Request<Backup.Types.ExportBackupPlanTemplateOutput, AWSError>;
/**
* Returns the body of a backup plan in JSON format, in addition to plan metadata.
*/
getBackupPlan(params: Backup.Types.GetBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanOutput) => void): Request<Backup.Types.GetBackupPlanOutput, AWSError>;
/**
* Returns the body of a backup plan in JSON format, in addition to plan metadata.
*/
getBackupPlan(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanOutput) => void): Request<Backup.Types.GetBackupPlanOutput, AWSError>;
/**
* Returns a valid JSON document specifying a backup plan or an error.
*/
getBackupPlanFromJSON(params: Backup.Types.GetBackupPlanFromJSONInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromJSONOutput) => void): Request<Backup.Types.GetBackupPlanFromJSONOutput, AWSError>;
/**
* Returns a valid JSON document specifying a backup plan or an error.
*/
getBackupPlanFromJSON(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromJSONOutput) => void): Request<Backup.Types.GetBackupPlanFromJSONOutput, AWSError>;
/**
* Returns the template specified by its templateId as a backup plan.
*/
getBackupPlanFromTemplate(params: Backup.Types.GetBackupPlanFromTemplateInput, callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromTemplateOutput) => void): Request<Backup.Types.GetBackupPlanFromTemplateOutput, AWSError>;
/**
* Returns the template specified by its templateId as a backup plan.
*/
getBackupPlanFromTemplate(callback?: (err: AWSError, data: Backup.Types.GetBackupPlanFromTemplateOutput) => void): Request<Backup.Types.GetBackupPlanFromTemplateOutput, AWSError>;
/**
* Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
*/
getBackupSelection(params: Backup.Types.GetBackupSelectionInput, callback?: (err: AWSError, data: Backup.Types.GetBackupSelectionOutput) => void): Request<Backup.Types.GetBackupSelectionOutput, AWSError>;
/**
* Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
*/
getBackupSelection(callback?: (err: AWSError, data: Backup.Types.GetBackupSelectionOutput) => void): Request<Backup.Types.GetBackupSelectionOutput, AWSError>;
/**
* Returns the access policy document that is associated with the named backup vault.
*/
getBackupVaultAccessPolicy(params: Backup.Types.GetBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: Backup.Types.GetBackupVaultAccessPolicyOutput) => void): Request<Backup.Types.GetBackupVaultAccessPolicyOutput, AWSError>;
/**
* Returns the access policy document that is associated with the named backup vault.
*/
getBackupVaultAccessPolicy(callback?: (err: AWSError, data: Backup.Types.GetBackupVaultAccessPolicyOutput) => void): Request<Backup.Types.GetBackupVaultAccessPolicyOutput, AWSError>;
/**
* Returns event notifications for the specified backup vault.
*/
getBackupVaultNotifications(params: Backup.Types.GetBackupVaultNotificationsInput, callback?: (err: AWSError, data: Backup.Types.GetBackupVaultNotificationsOutput) => void): Request<Backup.Types.GetBackupVaultNotificationsOutput, AWSError>;
/**
* Returns event notifications for the specified backup vault.
*/
getBackupVaultNotifications(callback?: (err: AWSError, data: Backup.Types.GetBackupVaultNotificationsOutput) => void): Request<Backup.Types.GetBackupVaultNotificationsOutput, AWSError>;
/**
* Returns a set of metadata key-value pairs that were used to create the backup.
*/
getRecoveryPointRestoreMetadata(params: Backup.Types.GetRecoveryPointRestoreMetadataInput, callback?: (err: AWSError, data: Backup.Types.GetRecoveryPointRestoreMetadataOutput) => void): Request<Backup.Types.GetRecoveryPointRestoreMetadataOutput, AWSError>;
/**
* Returns a set of metadata key-value pairs that were used to create the backup.
*/
getRecoveryPointRestoreMetadata(callback?: (err: AWSError, data: Backup.Types.GetRecoveryPointRestoreMetadataOutput) => void): Request<Backup.Types.GetRecoveryPointRestoreMetadataOutput, AWSError>;
/**
* Returns the AWS resource types supported by AWS Backup.
*/
getSupportedResourceTypes(callback?: (err: AWSError, data: Backup.Types.GetSupportedResourceTypesOutput) => void): Request<Backup.Types.GetSupportedResourceTypesOutput, AWSError>;
/**
* Returns metadata about your backup jobs.
*/
listBackupJobs(params: Backup.Types.ListBackupJobsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupJobsOutput) => void): Request<Backup.Types.ListBackupJobsOutput, AWSError>;
/**
* Returns metadata about your backup jobs.
*/
listBackupJobs(callback?: (err: AWSError, data: Backup.Types.ListBackupJobsOutput) => void): Request<Backup.Types.ListBackupJobsOutput, AWSError>;
/**
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
*/
listBackupPlanTemplates(params: Backup.Types.ListBackupPlanTemplatesInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlanTemplatesOutput) => void): Request<Backup.Types.ListBackupPlanTemplatesOutput, AWSError>;
/**
* Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
*/
listBackupPlanTemplates(callback?: (err: AWSError, data: Backup.Types.ListBackupPlanTemplatesOutput) => void): Request<Backup.Types.ListBackupPlanTemplatesOutput, AWSError>;
/**
* Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
*/
listBackupPlanVersions(params: Backup.Types.ListBackupPlanVersionsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlanVersionsOutput) => void): Request<Backup.Types.ListBackupPlanVersionsOutput, AWSError>;
/**
* Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
*/
listBackupPlanVersions(callback?: (err: AWSError, data: Backup.Types.ListBackupPlanVersionsOutput) => void): Request<Backup.Types.ListBackupPlanVersionsOutput, AWSError>;
/**
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
*/
listBackupPlans(params: Backup.Types.ListBackupPlansInput, callback?: (err: AWSError, data: Backup.Types.ListBackupPlansOutput) => void): Request<Backup.Types.ListBackupPlansOutput, AWSError>;
/**
* Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
*/
listBackupPlans(callback?: (err: AWSError, data: Backup.Types.ListBackupPlansOutput) => void): Request<Backup.Types.ListBackupPlansOutput, AWSError>;
/**
* Returns an array containing metadata of the resources associated with the target backup plan.
*/
listBackupSelections(params: Backup.Types.ListBackupSelectionsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupSelectionsOutput) => void): Request<Backup.Types.ListBackupSelectionsOutput, AWSError>;
/**
* Returns an array containing metadata of the resources associated with the target backup plan.
*/
listBackupSelections(callback?: (err: AWSError, data: Backup.Types.ListBackupSelectionsOutput) => void): Request<Backup.Types.ListBackupSelectionsOutput, AWSError>;
/**
* Returns a list of recovery point storage containers along with information about them.
*/
listBackupVaults(params: Backup.Types.ListBackupVaultsInput, callback?: (err: AWSError, data: Backup.Types.ListBackupVaultsOutput) => void): Request<Backup.Types.ListBackupVaultsOutput, AWSError>;
/**
* Returns a list of recovery point storage containers along with information about them.
*/
listBackupVaults(callback?: (err: AWSError, data: Backup.Types.ListBackupVaultsOutput) => void): Request<Backup.Types.ListBackupVaultsOutput, AWSError>;
/**
* Returns metadata about your copy jobs.
*/
listCopyJobs(params: Backup.Types.ListCopyJobsInput, callback?: (err: AWSError, data: Backup.Types.ListCopyJobsOutput) => void): Request<Backup.Types.ListCopyJobsOutput, AWSError>;
/**
* Returns metadata about your copy jobs.
*/
listCopyJobs(callback?: (err: AWSError, data: Backup.Types.ListCopyJobsOutput) => void): Request<Backup.Types.ListCopyJobsOutput, AWSError>;
/**
* Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
*/
listProtectedResources(params: Backup.Types.ListProtectedResourcesInput, callback?: (err: AWSError, data: Backup.Types.ListProtectedResourcesOutput) => void): Request<Backup.Types.ListProtectedResourcesOutput, AWSError>;
/**
* Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
*/
listProtectedResources(callback?: (err: AWSError, data: Backup.Types.ListProtectedResourcesOutput) => void): Request<Backup.Types.ListProtectedResourcesOutput, AWSError>;
/**
* Returns detailed information about the recovery points stored in a backup vault.
*/
listRecoveryPointsByBackupVault(params: Backup.Types.ListRecoveryPointsByBackupVaultInput, callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByBackupVaultOutput) => void): Request<Backup.Types.ListRecoveryPointsByBackupVaultOutput, AWSError>;
/**
* Returns detailed information about the recovery points stored in a backup vault.
*/
listRecoveryPointsByBackupVault(callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByBackupVaultOutput) => void): Request<Backup.Types.ListRecoveryPointsByBackupVaultOutput, AWSError>;
/**
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
*/
listRecoveryPointsByResource(params: Backup.Types.ListRecoveryPointsByResourceInput, callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByResourceOutput) => void): Request<Backup.Types.ListRecoveryPointsByResourceOutput, AWSError>;
/**
* Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).
*/
listRecoveryPointsByResource(callback?: (err: AWSError, data: Backup.Types.ListRecoveryPointsByResourceOutput) => void): Request<Backup.Types.ListRecoveryPointsByResourceOutput, AWSError>;
/**
* Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
*/
listRestoreJobs(params: Backup.Types.ListRestoreJobsInput, callback?: (err: AWSError, data: Backup.Types.ListRestoreJobsOutput) => void): Request<Backup.Types.ListRestoreJobsOutput, AWSError>;
/**
* Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.
*/
listRestoreJobs(callback?: (err: AWSError, data: Backup.Types.ListRestoreJobsOutput) => void): Request<Backup.Types.ListRestoreJobsOutput, AWSError>;
/**
* Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
*/
listTags(params: Backup.Types.ListTagsInput, callback?: (err: AWSError, data: Backup.Types.ListTagsOutput) => void): Request<Backup.Types.ListTagsOutput, AWSError>;
/**
* Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.
*/
listTags(callback?: (err: AWSError, data: Backup.Types.ListTagsOutput) => void): Request<Backup.Types.ListTagsOutput, AWSError>;
/**
* Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
*/
putBackupVaultAccessPolicy(params: Backup.Types.PutBackupVaultAccessPolicyInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.
*/
putBackupVaultAccessPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Turns on notifications on a backup vault for the specified topic and events.
*/
putBackupVaultNotifications(params: Backup.Types.PutBackupVaultNotificationsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Turns on notifications on a backup vault for the specified topic and events.
*/
putBackupVaultNotifications(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Starts a job to create a one-time backup of the specified resource.
*/
startBackupJob(params: Backup.Types.StartBackupJobInput, callback?: (err: AWSError, data: Backup.Types.StartBackupJobOutput) => void): Request<Backup.Types.StartBackupJobOutput, AWSError>;
/**
* Starts a job to create a one-time backup of the specified resource.
*/
startBackupJob(callback?: (err: AWSError, data: Backup.Types.StartBackupJobOutput) => void): Request<Backup.Types.StartBackupJobOutput, AWSError>;
/**
* Starts a job to create a one-time copy of the specified resource.
*/
startCopyJob(params: Backup.Types.StartCopyJobInput, callback?: (err: AWSError, data: Backup.Types.StartCopyJobOutput) => void): Request<Backup.Types.StartCopyJobOutput, AWSError>;
/**
* Starts a job to create a one-time copy of the specified resource.
*/
startCopyJob(callback?: (err: AWSError, data: Backup.Types.StartCopyJobOutput) => void): Request<Backup.Types.StartCopyJobOutput, AWSError>;
/**
* Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
*/
startRestoreJob(params: Backup.Types.StartRestoreJobInput, callback?: (err: AWSError, data: Backup.Types.StartRestoreJobOutput) => void): Request<Backup.Types.StartRestoreJobOutput, AWSError>;
/**
* Recovers the saved resource identified by an Amazon Resource Name (ARN). If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.
*/
startRestoreJob(callback?: (err: AWSError, data: Backup.Types.StartRestoreJobOutput) => void): Request<Backup.Types.StartRestoreJobOutput, AWSError>;
/**
* Attempts to cancel a job to create a one-time backup of a resource.
*/
stopBackupJob(params: Backup.Types.StopBackupJobInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Attempts to cancel a job to create a one-time backup of a resource.
*/
stopBackupJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
*/
tagResource(params: Backup.Types.TagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
*/
untagResource(params: Backup.Types.UntagResourceInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
*/
updateBackupPlan(params: Backup.Types.UpdateBackupPlanInput, callback?: (err: AWSError, data: Backup.Types.UpdateBackupPlanOutput) => void): Request<Backup.Types.UpdateBackupPlanOutput, AWSError>;
/**
* Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
*/
updateBackupPlan(callback?: (err: AWSError, data: Backup.Types.UpdateBackupPlanOutput) => void): Request<Backup.Types.UpdateBackupPlanOutput, AWSError>;
/**
* Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
updateRecoveryPointLifecycle(params: Backup.Types.UpdateRecoveryPointLifecycleInput, callback?: (err: AWSError, data: Backup.Types.UpdateRecoveryPointLifecycleOutput) => void): Request<Backup.Types.UpdateRecoveryPointLifecycleOutput, AWSError>;
/**
* Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
updateRecoveryPointLifecycle(callback?: (err: AWSError, data: Backup.Types.UpdateRecoveryPointLifecycleOutput) => void): Request<Backup.Types.UpdateRecoveryPointLifecycleOutput, AWSError>;
}
declare namespace Backup {
export type ARN = string;
export interface BackupJob {
/**
* Uniquely identifies a request to AWS Backup to back up a resource.
*/
BackupJobId?: string;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* The current state of a resource recovery point.
*/
State?: BackupJobState;
/**
* A detailed message explaining the status of the job to back up a resource.
*/
StatusMessage?: string;
/**
* Contains an estimated percentage complete of a job at the time the job status was queried.
*/
PercentDone?: string;
/**
* The size, in bytes, of a backup.
*/
BackupSizeInBytes?: Long;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
*/
CreatedBy?: RecoveryPointCreator;
/**
* The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
ExpectedCompletionDate?: timestamp;
/**
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
StartBy?: timestamp;
/**
* The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
/**
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*/
BytesTransferred?: Long;
}
export type BackupJobState = "CREATED"|"PENDING"|"RUNNING"|"ABORTING"|"ABORTED"|"COMPLETED"|"FAILED"|"EXPIRED"|string;
export type BackupJobsList = BackupJob[];
export interface BackupPlan {
/**
* The display name of a backup plan.
*/
BackupPlanName: BackupPlanName;
/**
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
*/
Rules: BackupRules;
}
export interface BackupPlanInput {
/**
* The display name of a backup plan.
*/
BackupPlanName: BackupPlanName;
/**
* An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
*/
Rules: BackupRulesInput;
}
export type BackupPlanName = string;
export type BackupPlanTemplatesList = BackupPlanTemplatesListMember[];
export interface BackupPlanTemplatesListMember {
/**
* Uniquely identifies a stored backup plan template.
*/
BackupPlanTemplateId?: string;
/**
* The optional display name of a backup plan template.
*/
BackupPlanTemplateName?: string;
}
export type BackupPlanVersionsList = BackupPlansListMember[];
export type BackupPlansList = BackupPlansListMember[];
export interface BackupPlansListMember {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
DeletionDate?: timestamp;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
*/
VersionId?: string;
/**
* The display name of a saved backup plan.
*/
BackupPlanName?: BackupPlanName;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
/**
* The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastExecutionDate?: timestamp;
}
export interface BackupRule {
/**
* An optional display name for a backup rule.
*/
RuleName: BackupRuleName;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
TargetBackupVaultName: BackupVaultName;
/**
* A CRON expression specifying when AWS Backup initiates a backup job.
*/
ScheduleExpression?: CronExpression;
/**
* An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.
*/
StartWindowMinutes?: WindowMinutes;
/**
* A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.
*/
CompletionWindowMinutes?: WindowMinutes;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
*/
RecoveryPointTags?: Tags;
/**
* Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
*/
RuleId?: string;
/**
* An array of CopyAction objects, which contains the details of the copy operation.
*/
CopyActions?: CopyActions;
}
export interface BackupRuleInput {
/**
* >An optional display name for a backup rule.
*/
RuleName: BackupRuleName;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
TargetBackupVaultName: BackupVaultName;
/**
* A CRON expression specifying when AWS Backup initiates a backup job.
*/
ScheduleExpression?: CronExpression;
/**
* The amount of time in minutes before beginning a backup.
*/
StartWindowMinutes?: WindowMinutes;
/**
* The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
*/
CompletionWindowMinutes?: WindowMinutes;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
*/
RecoveryPointTags?: Tags;
/**
* An array of CopyAction objects, which contains the details of the copy operation.
*/
CopyActions?: CopyActions;
}
export type BackupRuleName = string;
export type BackupRules = BackupRule[];
export type BackupRulesInput = BackupRuleInput[];
export interface BackupSelection {
/**
* The display name of a resource selection document.
*/
SelectionName: BackupSelectionName;
/**
* The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn: IAMRoleArn;
/**
* An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
*/
Resources?: ResourceArns;
/**
* An array of conditions used to specify a set of resources to assign to a backup plan; for example, "STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting".
*/
ListOfTags?: ListOfTags;
}
export type BackupSelectionName = string;
export type BackupSelectionsList = BackupSelectionsListMember[];
export interface BackupSelectionsListMember {
/**
* Uniquely identifies a request to assign a set of resources to a backup plan.
*/
SelectionId?: string;
/**
* The display name of a resource selection document.
*/
SelectionName?: BackupSelectionName;
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
/**
* Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
}
export type BackupVaultEvent = "BACKUP_JOB_STARTED"|"BACKUP_JOB_COMPLETED"|"BACKUP_JOB_SUCCESSFUL"|"BACKUP_JOB_FAILED"|"BACKUP_JOB_EXPIRED"|"RESTORE_JOB_STARTED"|"RESTORE_JOB_COMPLETED"|"RESTORE_JOB_SUCCESSFUL"|"RESTORE_JOB_FAILED"|"COPY_JOB_STARTED"|"COPY_JOB_SUCCESSFUL"|"COPY_JOB_FAILED"|"RECOVERY_POINT_MODIFIED"|"BACKUP_PLAN_CREATED"|"BACKUP_PLAN_MODIFIED"|string;
export type BackupVaultEvents = BackupVaultEvent[];
export type BackupVaultList = BackupVaultListMember[];
export interface BackupVaultListMember {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
/**
* The number of recovery points that are stored in a backup vault.
*/
NumberOfRecoveryPoints?: long;
}
export type BackupVaultName = string;
export type Boolean = boolean;
export interface CalculatedLifecycle {
/**
* A timestamp that specifies when to transition a recovery point to cold storage.
*/
MoveToColdStorageAt?: timestamp;
/**
* A timestamp that specifies when to delete a recovery point.
*/
DeleteAt?: timestamp;
}
export interface Condition {
/**
* An operation, such as STRINGEQUALS, that is applied to a key-value pair used to filter resources in a selection.
*/
ConditionType: ConditionType;
/**
* The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.
*/
ConditionKey: ConditionKey;
/**
* The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.
*/
ConditionValue: ConditionValue;
}
export type ConditionKey = string;
export type ConditionType = "STRINGEQUALS"|string;
export type ConditionValue = string;
export interface CopyAction {
Lifecycle?: Lifecycle;
/**
* An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
DestinationBackupVaultArn: ARN;
}
export type CopyActions = CopyAction[];
export interface CopyJob {
/**
* Uniquely identifies a request to AWS Backup to copy a resource.
*/
CopyJobId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
SourceBackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
SourceRecoveryPointArn?: ARN;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
DestinationBackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
DestinationRecoveryPointArn?: ARN;
/**
* The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceArn?: ARN;
/**
* The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time a job to create a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* The current state of a resource recovery point.
*/
State?: CopyJobState;
/**
* A detailed message explaining the status of the job that to copy a resource.
*/
StatusMessage?: string;
/**
* The size, in bytes, of a copy job.
*/
BackupSizeInBytes?: Long;
/**
* Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
CreatedBy?: RecoveryPointCreator;
/**
* The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
}
export type CopyJobState = "CREATED"|"RUNNING"|"COMPLETED"|"FAILED"|string;
export type CopyJobsList = CopyJob[];
export interface CreateBackupPlanInput {
/**
* Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
*/
BackupPlan: BackupPlanInput;
/**
* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
*/
BackupPlanTags?: Tags;
/**
* Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
*/
CreatorRequestId?: string;
}
export interface CreateBackupPlanOutput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.
*/
VersionId?: string;
}
export interface CreateBackupSelectionInput {
/**
* Uniquely identifies the backup plan to be associated with the selection of resources.
*/
BackupPlanId: string;
/**
* Specifies the body of a request to assign a set of resources to a backup plan.
*/
BackupSelection: BackupSelection;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
}
export interface CreateBackupSelectionOutput {
/**
* Uniquely identifies the body of a request to assign a set of resources to a backup plan.
*/
SelectionId?: string;
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
}
export interface CreateBackupVaultInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
*/
BackupVaultTags?: Tags;
/**
* The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
}
export interface CreateBackupVaultOutput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
}
export type CronExpression = string;
export interface DeleteBackupPlanInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
}
export interface DeleteBackupPlanOutput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
DeletionDate?: timestamp;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
*/
VersionId?: string;
}
export interface DeleteBackupSelectionInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* Uniquely identifies the body of a request to assign a set of resources to a backup plan.
*/
SelectionId: string;
}
export interface DeleteBackupVaultAccessPolicyInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
}
export interface DeleteBackupVaultInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: string;
}
export interface DeleteBackupVaultNotificationsInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
}
export interface DeleteRecoveryPointInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
}
export interface DescribeBackupJobInput {
/**
* Uniquely identifies a request to AWS Backup to back up a resource.
*/
BackupJobId: string;
}
export interface DescribeBackupJobOutput {
/**
* Uniquely identifies a request to AWS Backup to back up a resource.
*/
BackupJobId?: string;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* The current state of a resource recovery point.
*/
State?: BackupJobState;
/**
* A detailed message explaining the status of the job to back up a resource.
*/
StatusMessage?: string;
/**
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*/
PercentDone?: string;
/**
* The size, in bytes, of a backup.
*/
BackupSizeInBytes?: Long;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
*/
CreatedBy?: RecoveryPointCreator;
/**
* The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
/**
* The size in bytes transferred to a backup vault at the time that the job status was queried.
*/
BytesTransferred?: Long;
/**
* The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
ExpectedCompletionDate?: timestamp;
/**
* Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
StartBy?: timestamp;
}
export interface DescribeBackupVaultInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: string;
}
export interface DescribeBackupVaultOutput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
/**
* The number of recovery points that are stored in a backup vault.
*/
NumberOfRecoveryPoints?: long;
}
export interface DescribeCopyJobInput {
/**
* Uniquely identifies a request to AWS Backup to copy a resource.
*/
CopyJobId: string;
}
export interface DescribeCopyJobOutput {
/**
* Contains detailed information about a copy job.
*/
CopyJob?: CopyJob;
}
export interface DescribeProtectedResourceInput {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn: ARN;
}
export interface DescribeProtectedResourceOutput {
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.
*/
ResourceType?: ResourceType;
/**
* The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastBackupTime?: timestamp;
}
export interface DescribeRecoveryPointInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
}
export interface DescribeRecoveryPointOutput {
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
/**
* Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
*/
CreatedBy?: RecoveryPointCreator;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* A status code specifying the state of the recovery point. A partial status indicates that the recovery point was not successfully re-created and must be retried.
*/
Status?: RecoveryPointStatus;
/**
* The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* The size, in bytes, of a backup.
*/
BackupSizeInBytes?: Long;
/**
* A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
*/
CalculatedLifecycle?: CalculatedLifecycle;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
*/
IsEncrypted?: boolean;
/**
* Specifies the storage class of the recovery point. Valid values are WARM or COLD.
*/
StorageClass?: StorageClass;
/**
* The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastRestoreTime?: timestamp;
}
export interface DescribeRestoreJobInput {
/**
* Uniquely identifies the job that restores a recovery point.
*/
RestoreJobId: RestoreJobId;
}
export interface DescribeRestoreJobOutput {
/**
* Uniquely identifies the job that restores a recovery point.
*/
RestoreJobId?: string;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.
*/
Status?: RestoreJobStatus;
/**
* A detailed message explaining the status of a job to restore a recovery point.
*/
StatusMessage?: string;
/**
* Contains an estimated percentage that is complete of a job at the time the job status was queried.
*/
PercentDone?: string;
/**
* The size, in bytes, of the restored resource.
*/
BackupSizeInBytes?: Long;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* The amount of time in minutes that a job restoring a recovery point is expected to take.
*/
ExpectedCompletionTimeMinutes?: Long;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
*/
CreatedResourceArn?: ARN;
}
export interface ExportBackupPlanTemplateInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
}
export interface ExportBackupPlanTemplateOutput {
/**
* The body of a backup plan template in JSON format. This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
*/
BackupPlanTemplateJson?: string;
}
export interface GetBackupPlanFromJSONInput {
/**
* A customer-supplied backup plan document in JSON format.
*/
BackupPlanTemplateJson: string;
}
export interface GetBackupPlanFromJSONOutput {
/**
* Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
*/
BackupPlan?: BackupPlan;
}
export interface GetBackupPlanFromTemplateInput {
/**
* Uniquely identifies a stored backup plan template.
*/
BackupPlanTemplateId: string;
}
export interface GetBackupPlanFromTemplateOutput {
/**
* Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
*/
BackupPlanDocument?: BackupPlan;
}
export interface GetBackupPlanInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
*/
VersionId?: string;
}
export interface GetBackupPlanOutput {
/**
* Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
*/
BackupPlan?: BackupPlan;
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
*/
VersionId?: string;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
/**
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
DeletionDate?: timestamp;
/**
* The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastExecutionDate?: timestamp;
}
export interface GetBackupSelectionInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* Uniquely identifies the body of a request to assign a set of resources to a backup plan.
*/
SelectionId: string;
}
export interface GetBackupSelectionOutput {
/**
* Specifies the body of a request to assign a set of resources to a backup plan.
*/
BackupSelection?: BackupSelection;
/**
* Uniquely identifies the body of a request to assign a set of resources to a backup plan.
*/
SelectionId?: string;
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
*/
CreatorRequestId?: string;
}
export interface GetBackupVaultAccessPolicyInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
}
export interface GetBackupVaultAccessPolicyOutput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* The backup vault access policy document in JSON format.
*/
Policy?: IAMPolicy;
}
export interface GetBackupVaultNotificationsInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
}
export interface GetBackupVaultNotificationsOutput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
*/
SNSTopicArn?: ARN;
/**
* An array of events that indicate the status of jobs to back up resources to the backup vault.
*/
BackupVaultEvents?: BackupVaultEvents;
}
export interface GetRecoveryPointRestoreMetadataInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
}
export interface GetRecoveryPointRestoreMetadataOutput {
/**
* An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The set of metadata key-value pairs that describes the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
*/
RestoreMetadata?: Metadata;
}
export interface GetSupportedResourceTypesOutput {
/**
* Contains a string with the supported AWS resource types: EBS for Amazon Elastic Block Store Storage Gateway for AWS Storage Gateway RDS for Amazon Relational Database Service DDB for Amazon DynamoDB EFS for Amazon Elastic File System
*/
ResourceTypes?: ResourceTypes;
}
export type IAMPolicy = string;
export type IAMRoleArn = string;
export interface Lifecycle {
/**
* Specifies the number of days after creation that a recovery point is moved to cold storage.
*/
MoveToColdStorageAfterDays?: Long;
/**
* Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
*/
DeleteAfterDays?: Long;
}
export interface ListBackupJobsInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
/**
* Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
*/
ByResourceArn?: ARN;
/**
* Returns only backup jobs that are in the specified state.
*/
ByState?: BackupJobState;
/**
* Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
ByBackupVaultName?: BackupVaultName;
/**
* Returns only backup jobs that were created before the specified date.
*/
ByCreatedBefore?: timestamp;
/**
* Returns only backup jobs that were created after the specified date.
*/
ByCreatedAfter?: timestamp;
/**
* Returns only backup jobs for the specified resources: DynamoDB for Amazon DynamoDB EBS for Amazon Elastic Block Store EFS for Amazon Elastic File System RDS for Amazon Relational Database Service Storage Gateway for AWS Storage Gateway
*/
ByResourceType?: ResourceType;
}
export interface ListBackupJobsOutput {
/**
* An array of structures containing metadata about your backup jobs returned in JSON format.
*/
BackupJobs?: BackupJobsList;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
}
export interface ListBackupPlanTemplatesInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListBackupPlanTemplatesOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of template list items containing metadata about your saved templates.
*/
BackupPlanTemplatesList?: BackupPlanTemplatesList;
}
export interface ListBackupPlanVersionsInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListBackupPlanVersionsOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of version list items containing metadata about your backup plans.
*/
BackupPlanVersionsList?: BackupPlanVersionsList;
}
export interface ListBackupPlansInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
/**
* A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
*/
IncludeDeleted?: Boolean;
}
export interface ListBackupPlansOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of backup plan list items containing metadata about your saved backup plans.
*/
BackupPlansList?: BackupPlansList;
}
export interface ListBackupSelectionsInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListBackupSelectionsOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of backup selection list items containing metadata about each resource in the list.
*/
BackupSelectionsList?: BackupSelectionsList;
}
export interface ListBackupVaultsInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListBackupVaultsOutput {
/**
* An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
*/
BackupVaultList?: BackupVaultList;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
}
export interface ListCopyJobsInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
/**
* Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
*/
ByResourceArn?: ARN;
/**
* Returns only copy jobs that are in the specified state.
*/
ByState?: CopyJobState;
/**
* Returns only copy jobs that were created before the specified date.
*/
ByCreatedBefore?: timestamp;
/**
* Returns only copy jobs that were created after the specified date.
*/
ByCreatedAfter?: timestamp;
/**
* Returns only backup jobs for the specified resources: DynamoDB for Amazon DynamoDB EBS for Amazon Elastic Block Store EFS for Amazon Elastic File System RDS for Amazon Relational Database Service Storage Gateway for AWS Storage Gateway
*/
ByResourceType?: ResourceType;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
ByDestinationVaultArn?: string;
}
export interface ListCopyJobsOutput {
/**
* An array of structures containing metadata about your copy jobs returned in JSON format.
*/
CopyJobs?: CopyJobsList;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
}
export type ListOfTags = Condition[];
export interface ListProtectedResourcesInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListProtectedResourcesOutput {
/**
* An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
*/
Results?: ProtectedResourcesList;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
}
export interface ListRecoveryPointsByBackupVaultInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
/**
* Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
*/
ByResourceArn?: ARN;
/**
* Returns only recovery points that match the specified resource type.
*/
ByResourceType?: ResourceType;
/**
* Returns only recovery points that match the specified backup plan ID.
*/
ByBackupPlanId?: string;
/**
* Returns only recovery points that were created before the specified timestamp.
*/
ByCreatedBefore?: timestamp;
/**
* Returns only recovery points that were created after the specified timestamp.
*/
ByCreatedAfter?: timestamp;
}
export interface ListRecoveryPointsByBackupVaultOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of objects that contain detailed information about recovery points saved in a backup vault.
*/
RecoveryPoints?: RecoveryPointByBackupVaultList;
}
export interface ListRecoveryPointsByResourceInput {
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn: ARN;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListRecoveryPointsByResourceOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* An array of objects that contain detailed information about recovery points of the specified resource type.
*/
RecoveryPoints?: RecoveryPointByResourceList;
}
export interface ListRestoreJobsInput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListRestoreJobsOutput {
/**
* An array of objects that contain detailed information about jobs to restore saved resources.
*/
RestoreJobs?: RestoreJobsList;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
}
export interface ListTagsInput {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.
*/
ResourceArn: ARN;
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* The maximum number of items to be returned.
*/
MaxResults?: MaxResults;
}
export interface ListTagsOutput {
/**
* The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
*/
NextToken?: string;
/**
* To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
*/
Tags?: Tags;
}
export type Long = number;
export type MaxResults = number;
export type Metadata = {[key: string]: MetadataValue};
export type MetadataKey = string;
export type MetadataValue = string;
export interface ProtectedResource {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
/**
* The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastBackupTime?: timestamp;
}
export type ProtectedResourcesList = ProtectedResource[];
export interface PutBackupVaultAccessPolicyInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* The backup vault access policy document in JSON format.
*/
Policy?: IAMPolicy;
}
export interface PutBackupVaultNotificationsInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
*/
SNSTopicArn: ARN;
/**
* An array of events that indicate the status of jobs to back up resources to the backup vault.
*/
BackupVaultEvents: BackupVaultEvents;
}
export interface RecoveryPointByBackupVault {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
/**
* An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn?: ARN;
/**
* The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
*/
ResourceType?: ResourceType;
/**
* Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
*/
CreatedBy?: RecoveryPointCreator;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* A status code specifying the state of the recovery point.
*/
Status?: RecoveryPointStatus;
/**
* The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* The size, in bytes, of a backup.
*/
BackupSizeInBytes?: Long;
/**
* A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
*/
CalculatedLifecycle?: CalculatedLifecycle;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
*/
IsEncrypted?: boolean;
/**
* The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
LastRestoreTime?: timestamp;
}
export type RecoveryPointByBackupVaultList = RecoveryPointByBackupVault[];
export interface RecoveryPointByResource {
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* A status code specifying the state of the recovery point.
*/
Status?: RecoveryPointStatus;
/**
* The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
*/
EncryptionKeyArn?: ARN;
/**
* The size, in bytes, of a backup.
*/
BackupSizeBytes?: Long;
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName?: BackupVaultName;
}
export type RecoveryPointByResourceList = RecoveryPointByResource[];
export interface RecoveryPointCreator {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
*/
BackupPlanVersion?: string;
/**
* Uniquely identifies a rule used to schedule the backup of a selection of resources.
*/
BackupRuleId?: string;
}
export type RecoveryPointStatus = "COMPLETED"|"PARTIAL"|"DELETING"|"EXPIRED"|string;
export type ResourceArns = ARN[];
export type ResourceType = string;
export type ResourceTypes = ResourceType[];
export type RestoreJobId = string;
export type RestoreJobStatus = "PENDING"|"RUNNING"|"COMPLETED"|"ABORTED"|"FAILED"|string;
export type RestoreJobsList = RestoreJobsListMember[];
export interface RestoreJobsListMember {
/**
* Uniquely identifies the job that restores a recovery point.
*/
RestoreJobId?: string;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CompletionDate?: timestamp;
/**
* A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.
*/
Status?: RestoreJobStatus;
/**
* A detailed message explaining the status of the job to restore a recovery point.
*/
StatusMessage?: string;
/**
* Contains an estimated percentage complete of a job at the time the job status was queried.
*/
PercentDone?: string;
/**
* The size, in bytes, of the restored resource.
*/
BackupSizeInBytes?: Long;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn?: IAMRoleArn;
/**
* The amount of time in minutes that a job restoring a recovery point is expected to take.
*/
ExpectedCompletionTimeMinutes?: Long;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
CreatedResourceArn?: ARN;
}
export interface StartBackupJobInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
ResourceArn: ARN;
/**
* Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn: IAMRoleArn;
/**
* A customer chosen string that can be used to distinguish between calls to StartBackupJob.
*/
IdempotencyToken?: string;
/**
* The amount of time in minutes before beginning a backup.
*/
StartWindowMinutes?: WindowMinutes;
/**
* The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
*/
CompleteWindowMinutes?: WindowMinutes;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
*/
RecoveryPointTags?: Tags;
}
export interface StartBackupJobOutput {
/**
* Uniquely identifies a request to AWS Backup to back up a resource.
*/
BackupJobId?: string;
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
}
export interface StartCopyJobInput {
/**
* An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
/**
* The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. >
*/
SourceBackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
DestinationBackupVaultArn: ARN;
/**
* Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn: IAMRoleArn;
/**
* A customer chosen string that can be used to distinguish between calls to StartCopyJob.
*/
IdempotencyToken?: string;
Lifecycle?: Lifecycle;
}
export interface StartCopyJobOutput {
/**
* Uniquely identifies a request to AWS Backup to copy a resource.
*/
CopyJobId?: string;
/**
* The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. >
*/
CreationDate?: timestamp;
}
export interface StartRestoreJobInput {
/**
* An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
/**
* A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point. You can get configuration metadata about a resource at the time it was backed-up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists. You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance: file-system-id: ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata. Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true. KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system. PerformanceMode: Specifies the throughput mode of the file system. CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request. newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
*/
Metadata: Metadata;
/**
* The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
*/
IamRoleArn: IAMRoleArn;
/**
* A customer chosen string that can be used to distinguish between calls to StartRestoreJob.
*/
IdempotencyToken?: string;
/**
* Starts a job to restore a recovery point for one of the following resources: EBS for Amazon Elastic Block Store Storage Gateway for AWS Storage Gateway RDS for Amazon Relational Database Service DDB for Amazon DynamoDB EFS for Amazon Elastic File System
*/
ResourceType?: ResourceType;
}
export interface StartRestoreJobOutput {
/**
* Uniquely identifies the job that restores a recovery point.
*/
RestoreJobId?: RestoreJobId;
}
export interface StopBackupJobInput {
/**
* Uniquely identifies a request to AWS Backup to back up a resource.
*/
BackupJobId: string;
}
export type StorageClass = "WARM"|"COLD"|"DELETED"|string;
export type TagKey = string;
export type TagKeyList = string[];
export interface TagResourceInput {
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
*/
ResourceArn: ARN;
/**
* Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.
*/
Tags: Tags;
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export interface UntagResourceInput {
/**
* An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
*/
ResourceArn: ARN;
/**
* A list of keys to identify which key-value tags to remove from a resource.
*/
TagKeyList: TagKeyList;
}
export interface UpdateBackupPlanInput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId: string;
/**
* Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
*/
BackupPlan: BackupPlanInput;
}
export interface UpdateBackupPlanOutput {
/**
* Uniquely identifies a backup plan.
*/
BackupPlanId?: string;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
*/
BackupPlanArn?: ARN;
/**
* The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
CreationDate?: timestamp;
/**
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
*/
VersionId?: string;
}
export interface UpdateRecoveryPointLifecycleInput {
/**
* The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
*/
BackupVaultName: BackupVaultName;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn: ARN;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
}
export interface UpdateRecoveryPointLifecycleOutput {
/**
* An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
*/
BackupVaultArn?: ARN;
/**
* An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
*/
RecoveryPointArn?: ARN;
/**
* The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
*/
Lifecycle?: Lifecycle;
/**
* A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
*/
CalculatedLifecycle?: CalculatedLifecycle;
}
export type WindowMinutes = number;
export type long = number;
export type timestamp = Date;
/**
* 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 = "2018-11-15"|"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 Backup client.
*/
export import Types = Backup;
}
export = Backup;