@aws-sdk/client-backup 3.216.0 → 3.222.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -7
- package/dist-cjs/Backup.js +90 -0
- package/dist-cjs/commands/CancelLegalHoldCommand.js +46 -0
- package/dist-cjs/commands/CreateLegalHoldCommand.js +46 -0
- package/dist-cjs/commands/DisassociateRecoveryPointFromParentCommand.js +46 -0
- package/dist-cjs/commands/GetLegalHoldCommand.js +46 -0
- package/dist-cjs/commands/ListLegalHoldsCommand.js +46 -0
- package/dist-cjs/commands/ListRecoveryPointsByLegalHoldCommand.js +46 -0
- package/dist-cjs/commands/index.js +6 -0
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/models_0.js +116 -46
- package/dist-cjs/pagination/ListLegalHoldsPaginator.js +36 -0
- package/dist-cjs/pagination/ListRecoveryPointsByLegalHoldPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +615 -3
- package/dist-es/Backup.js +90 -0
- package/dist-es/commands/CancelLegalHoldCommand.js +42 -0
- package/dist-es/commands/CreateLegalHoldCommand.js +42 -0
- package/dist-es/commands/DisassociateRecoveryPointFromParentCommand.js +42 -0
- package/dist-es/commands/GetLegalHoldCommand.js +42 -0
- package/dist-es/commands/ListLegalHoldsCommand.js +42 -0
- package/dist-es/commands/ListRecoveryPointsByLegalHoldCommand.js +42 -0
- package/dist-es/commands/index.js +6 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +90 -35
- package/dist-es/pagination/ListLegalHoldsPaginator.js +32 -0
- package/dist-es/pagination/ListRecoveryPointsByLegalHoldPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +600 -0
- package/dist-types/Backup.d.ts +63 -0
- package/dist-types/BackupClient.d.ts +8 -2
- package/dist-types/commands/CancelLegalHoldCommand.d.ts +38 -0
- package/dist-types/commands/CreateLegalHoldCommand.d.ts +40 -0
- package/dist-types/commands/DeleteRecoveryPointCommand.d.ts +10 -0
- package/dist-types/commands/DisassociateRecoveryPointFromParentCommand.d.ts +38 -0
- package/dist-types/commands/GetLegalHoldCommand.d.ts +38 -0
- package/dist-types/commands/ListLegalHoldsCommand.d.ts +37 -0
- package/dist-types/commands/ListRecoveryPointsByLegalHoldCommand.d.ts +38 -0
- package/dist-types/commands/StopBackupJobCommand.d.ts +4 -0
- package/dist-types/commands/index.d.ts +6 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +653 -128
- package/dist-types/pagination/ListLegalHoldsPaginator.d.ts +4 -0
- package/dist-types/pagination/ListRecoveryPointsByLegalHoldPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Backup.d.ts +108 -0
- package/dist-types/ts3.4/BackupClient.d.ts +36 -0
- package/dist-types/ts3.4/commands/CancelLegalHoldCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/CreateLegalHoldCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DisassociateRecoveryPointFromParentCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetLegalHoldCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListLegalHoldsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListRecoveryPointsByLegalHoldCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +6 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +210 -55
- package/dist-types/ts3.4/pagination/ListLegalHoldsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecoveryPointsByLegalHoldPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +72 -0
- package/package.json +29 -28
|
@@ -88,6 +88,7 @@ export declare enum BackupJobState {
|
|
|
88
88
|
CREATED = "CREATED",
|
|
89
89
|
EXPIRED = "EXPIRED",
|
|
90
90
|
FAILED = "FAILED",
|
|
91
|
+
PARTIAL = "PARTIAL",
|
|
91
92
|
PENDING = "PENDING",
|
|
92
93
|
RUNNING = "RUNNING"
|
|
93
94
|
}
|
|
@@ -208,6 +209,17 @@ export interface BackupJob {
|
|
|
208
209
|
* <p>Represents the type of backup for a backup job.</p>
|
|
209
210
|
*/
|
|
210
211
|
BackupType?: string;
|
|
212
|
+
/**
|
|
213
|
+
* <p>This uniquely identifies a request to Backup
|
|
214
|
+
* to back up a resource. The return will be the
|
|
215
|
+
* parent (composite) job ID.</p>
|
|
216
|
+
*/
|
|
217
|
+
ParentJobId?: string;
|
|
218
|
+
/**
|
|
219
|
+
* <p>This is a boolean value indicating this is
|
|
220
|
+
* a parent (composite) backup job.</p>
|
|
221
|
+
*/
|
|
222
|
+
IsParent?: boolean;
|
|
211
223
|
}
|
|
212
224
|
/**
|
|
213
225
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
@@ -284,7 +296,8 @@ export interface BackupRule {
|
|
|
284
296
|
ScheduleExpression?: string;
|
|
285
297
|
/**
|
|
286
298
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
287
|
-
* doesn't start successfully. This value is optional
|
|
299
|
+
* doesn't start successfully. This value is optional.
|
|
300
|
+
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
288
301
|
*/
|
|
289
302
|
StartWindowMinutes?: number;
|
|
290
303
|
/**
|
|
@@ -372,7 +385,8 @@ export interface BackupRuleInput {
|
|
|
372
385
|
ScheduleExpression?: string;
|
|
373
386
|
/**
|
|
374
387
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
375
|
-
* doesn't start successfully. This value is optional
|
|
388
|
+
* doesn't start successfully. This value is optional.
|
|
389
|
+
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
376
390
|
*/
|
|
377
391
|
StartWindowMinutes?: number;
|
|
378
392
|
/**
|
|
@@ -820,6 +834,130 @@ export interface CalculatedLifecycle {
|
|
|
820
834
|
*/
|
|
821
835
|
DeleteAt?: Date;
|
|
822
836
|
}
|
|
837
|
+
export interface CancelLegalHoldInput {
|
|
838
|
+
/**
|
|
839
|
+
* <p>Legal hold ID required to remove the specified legal hold on a recovery point.</p>
|
|
840
|
+
*/
|
|
841
|
+
LegalHoldId: string | undefined;
|
|
842
|
+
/**
|
|
843
|
+
* <p>String describing the reason for removing the legal hold.</p>
|
|
844
|
+
*/
|
|
845
|
+
CancelDescription: string | undefined;
|
|
846
|
+
/**
|
|
847
|
+
* <p>The integer amount in days specifying amount of days after this
|
|
848
|
+
* API operation to remove legal hold.</p>
|
|
849
|
+
*/
|
|
850
|
+
RetainRecordInDays?: number;
|
|
851
|
+
}
|
|
852
|
+
export interface CancelLegalHoldOutput {
|
|
853
|
+
}
|
|
854
|
+
/**
|
|
855
|
+
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
856
|
+
* out of range.</p>
|
|
857
|
+
*/
|
|
858
|
+
export declare class InvalidParameterValueException extends __BaseException {
|
|
859
|
+
readonly name: "InvalidParameterValueException";
|
|
860
|
+
readonly $fault: "client";
|
|
861
|
+
Code?: string;
|
|
862
|
+
Message?: string;
|
|
863
|
+
/**
|
|
864
|
+
* <p></p>
|
|
865
|
+
*/
|
|
866
|
+
Type?: string;
|
|
867
|
+
/**
|
|
868
|
+
* <p></p>
|
|
869
|
+
*/
|
|
870
|
+
Context?: string;
|
|
871
|
+
/**
|
|
872
|
+
* @internal
|
|
873
|
+
*/
|
|
874
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
|
|
875
|
+
}
|
|
876
|
+
/**
|
|
877
|
+
* <p>Backup is already performing an action on this recovery point. It can't
|
|
878
|
+
* perform the action you requested until the first action finishes. Try again later.</p>
|
|
879
|
+
*/
|
|
880
|
+
export declare class InvalidResourceStateException extends __BaseException {
|
|
881
|
+
readonly name: "InvalidResourceStateException";
|
|
882
|
+
readonly $fault: "client";
|
|
883
|
+
Code?: string;
|
|
884
|
+
Message?: string;
|
|
885
|
+
/**
|
|
886
|
+
* <p></p>
|
|
887
|
+
*/
|
|
888
|
+
Type?: string;
|
|
889
|
+
/**
|
|
890
|
+
* <p></p>
|
|
891
|
+
*/
|
|
892
|
+
Context?: string;
|
|
893
|
+
/**
|
|
894
|
+
* @internal
|
|
895
|
+
*/
|
|
896
|
+
constructor(opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>);
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* <p>Indicates that a required parameter is missing.</p>
|
|
900
|
+
*/
|
|
901
|
+
export declare class MissingParameterValueException extends __BaseException {
|
|
902
|
+
readonly name: "MissingParameterValueException";
|
|
903
|
+
readonly $fault: "client";
|
|
904
|
+
Code?: string;
|
|
905
|
+
Message?: string;
|
|
906
|
+
/**
|
|
907
|
+
* <p></p>
|
|
908
|
+
*/
|
|
909
|
+
Type?: string;
|
|
910
|
+
/**
|
|
911
|
+
* <p></p>
|
|
912
|
+
*/
|
|
913
|
+
Context?: string;
|
|
914
|
+
/**
|
|
915
|
+
* @internal
|
|
916
|
+
*/
|
|
917
|
+
constructor(opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>);
|
|
918
|
+
}
|
|
919
|
+
/**
|
|
920
|
+
* <p>A resource that is required for the action doesn't exist.</p>
|
|
921
|
+
*/
|
|
922
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
923
|
+
readonly name: "ResourceNotFoundException";
|
|
924
|
+
readonly $fault: "client";
|
|
925
|
+
Code?: string;
|
|
926
|
+
Message?: string;
|
|
927
|
+
/**
|
|
928
|
+
* <p></p>
|
|
929
|
+
*/
|
|
930
|
+
Type?: string;
|
|
931
|
+
/**
|
|
932
|
+
* <p></p>
|
|
933
|
+
*/
|
|
934
|
+
Context?: string;
|
|
935
|
+
/**
|
|
936
|
+
* @internal
|
|
937
|
+
*/
|
|
938
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
* <p>The request failed due to a temporary failure of the server.</p>
|
|
942
|
+
*/
|
|
943
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
944
|
+
readonly name: "ServiceUnavailableException";
|
|
945
|
+
readonly $fault: "server";
|
|
946
|
+
Code?: string;
|
|
947
|
+
Message?: string;
|
|
948
|
+
/**
|
|
949
|
+
* <p></p>
|
|
950
|
+
*/
|
|
951
|
+
Type?: string;
|
|
952
|
+
/**
|
|
953
|
+
* <p></p>
|
|
954
|
+
*/
|
|
955
|
+
Context?: string;
|
|
956
|
+
/**
|
|
957
|
+
* @internal
|
|
958
|
+
*/
|
|
959
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
960
|
+
}
|
|
823
961
|
/**
|
|
824
962
|
* <p>Backup can't perform the action that you requested until it finishes
|
|
825
963
|
* performing a previous action. Try again later.</p>
|
|
@@ -893,6 +1031,7 @@ export declare enum CopyJobState {
|
|
|
893
1031
|
COMPLETED = "COMPLETED",
|
|
894
1032
|
CREATED = "CREATED",
|
|
895
1033
|
FAILED = "FAILED",
|
|
1034
|
+
PARTIAL = "PARTIAL",
|
|
896
1035
|
RUNNING = "RUNNING"
|
|
897
1036
|
}
|
|
898
1037
|
/**
|
|
@@ -971,6 +1110,34 @@ export interface CopyJob {
|
|
|
971
1110
|
* <p>The type of Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>
|
|
972
1111
|
*/
|
|
973
1112
|
ResourceType?: string;
|
|
1113
|
+
/**
|
|
1114
|
+
* <p>This uniquely identifies a request to Backup
|
|
1115
|
+
* to copy a resource. The return will be the
|
|
1116
|
+
* parent (composite) job ID.</p>
|
|
1117
|
+
*/
|
|
1118
|
+
ParentJobId?: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* <p>This is a boolean value indicating this is
|
|
1121
|
+
* a parent (composite) copy job.</p>
|
|
1122
|
+
*/
|
|
1123
|
+
IsParent?: boolean;
|
|
1124
|
+
/**
|
|
1125
|
+
* <p>This is the identifier of a resource within a composite group, such as
|
|
1126
|
+
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
1127
|
+
* ID is transferred from
|
|
1128
|
+
* the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax">
|
|
1129
|
+
* logical ID</a> within a stack.</p>
|
|
1130
|
+
*/
|
|
1131
|
+
CompositeMemberIdentifier?: string;
|
|
1132
|
+
/**
|
|
1133
|
+
* <p>This is the number of child (nested) copy jobs.</p>
|
|
1134
|
+
*/
|
|
1135
|
+
NumberOfChildJobs?: number;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>This returns the statistics of the included
|
|
1138
|
+
* child (nested) copy jobs.</p>
|
|
1139
|
+
*/
|
|
1140
|
+
ChildJobsInState?: Record<string, number>;
|
|
974
1141
|
}
|
|
975
1142
|
export interface CreateBackupPlanInput {
|
|
976
1143
|
/**
|
|
@@ -1020,28 +1187,6 @@ export interface CreateBackupPlanOutput {
|
|
|
1020
1187
|
*/
|
|
1021
1188
|
AdvancedBackupSettings?: AdvancedBackupSetting[];
|
|
1022
1189
|
}
|
|
1023
|
-
/**
|
|
1024
|
-
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
1025
|
-
* out of range.</p>
|
|
1026
|
-
*/
|
|
1027
|
-
export declare class InvalidParameterValueException extends __BaseException {
|
|
1028
|
-
readonly name: "InvalidParameterValueException";
|
|
1029
|
-
readonly $fault: "client";
|
|
1030
|
-
Code?: string;
|
|
1031
|
-
Message?: string;
|
|
1032
|
-
/**
|
|
1033
|
-
* <p></p>
|
|
1034
|
-
*/
|
|
1035
|
-
Type?: string;
|
|
1036
|
-
/**
|
|
1037
|
-
* <p></p>
|
|
1038
|
-
*/
|
|
1039
|
-
Context?: string;
|
|
1040
|
-
/**
|
|
1041
|
-
* @internal
|
|
1042
|
-
*/
|
|
1043
|
-
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
|
|
1044
|
-
}
|
|
1045
1190
|
/**
|
|
1046
1191
|
* <p>A limit in the request has been exceeded; for example, a maximum number of items allowed
|
|
1047
1192
|
* in a request.</p>
|
|
@@ -1064,48 +1209,6 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1064
1209
|
*/
|
|
1065
1210
|
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1066
1211
|
}
|
|
1067
|
-
/**
|
|
1068
|
-
* <p>Indicates that a required parameter is missing.</p>
|
|
1069
|
-
*/
|
|
1070
|
-
export declare class MissingParameterValueException extends __BaseException {
|
|
1071
|
-
readonly name: "MissingParameterValueException";
|
|
1072
|
-
readonly $fault: "client";
|
|
1073
|
-
Code?: string;
|
|
1074
|
-
Message?: string;
|
|
1075
|
-
/**
|
|
1076
|
-
* <p></p>
|
|
1077
|
-
*/
|
|
1078
|
-
Type?: string;
|
|
1079
|
-
/**
|
|
1080
|
-
* <p></p>
|
|
1081
|
-
*/
|
|
1082
|
-
Context?: string;
|
|
1083
|
-
/**
|
|
1084
|
-
* @internal
|
|
1085
|
-
*/
|
|
1086
|
-
constructor(opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>);
|
|
1087
|
-
}
|
|
1088
|
-
/**
|
|
1089
|
-
* <p>The request failed due to a temporary failure of the server.</p>
|
|
1090
|
-
*/
|
|
1091
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
1092
|
-
readonly name: "ServiceUnavailableException";
|
|
1093
|
-
readonly $fault: "server";
|
|
1094
|
-
Code?: string;
|
|
1095
|
-
Message?: string;
|
|
1096
|
-
/**
|
|
1097
|
-
* <p></p>
|
|
1098
|
-
*/
|
|
1099
|
-
Type?: string;
|
|
1100
|
-
/**
|
|
1101
|
-
* <p></p>
|
|
1102
|
-
*/
|
|
1103
|
-
Context?: string;
|
|
1104
|
-
/**
|
|
1105
|
-
* @internal
|
|
1106
|
-
*/
|
|
1107
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1108
|
-
}
|
|
1109
1212
|
export interface CreateBackupSelectionInput {
|
|
1110
1213
|
/**
|
|
1111
1214
|
* <p>Uniquely identifies the backup plan to be associated with the selection of
|
|
@@ -1248,6 +1351,125 @@ export interface CreateFrameworkOutput {
|
|
|
1248
1351
|
*/
|
|
1249
1352
|
FrameworkArn?: string;
|
|
1250
1353
|
}
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>This is a resource filter containing FromDate: DateTime
|
|
1356
|
+
* and ToDate: DateTime. Both values are required. Future DateTime
|
|
1357
|
+
* values are not permitted.</p>
|
|
1358
|
+
* <p>The date and time are in Unix format and Coordinated
|
|
1359
|
+
* Universal Time (UTC), and it is accurate to milliseconds
|
|
1360
|
+
* ((milliseconds are optional).
|
|
1361
|
+
* For example, the value 1516925490.087 represents Friday, January
|
|
1362
|
+
* 26, 2018 12:11:30.087 AM.</p>
|
|
1363
|
+
*/
|
|
1364
|
+
export interface DateRange {
|
|
1365
|
+
/**
|
|
1366
|
+
* <p>This value is the beginning date, inclusive.</p>
|
|
1367
|
+
* <p>The date and time are in Unix format and Coordinated
|
|
1368
|
+
* Universal Time (UTC), and it is accurate to milliseconds
|
|
1369
|
+
* (milliseconds are optional).</p>
|
|
1370
|
+
*/
|
|
1371
|
+
FromDate: Date | undefined;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>This value is the end date, inclusive.</p>
|
|
1374
|
+
* <p>The date and time are in Unix format and Coordinated
|
|
1375
|
+
* Universal Time (UTC), and it is accurate to milliseconds
|
|
1376
|
+
* (milliseconds are optional).</p>
|
|
1377
|
+
*/
|
|
1378
|
+
ToDate: Date | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* <p>This specifies criteria to assign
|
|
1382
|
+
* a set of resources, such as resource types or backup vaults.</p>
|
|
1383
|
+
*/
|
|
1384
|
+
export interface RecoveryPointSelection {
|
|
1385
|
+
/**
|
|
1386
|
+
* <p>These are the names of the vaults in which the selected
|
|
1387
|
+
* recovery points are contained.</p>
|
|
1388
|
+
*/
|
|
1389
|
+
VaultNames?: string[];
|
|
1390
|
+
/**
|
|
1391
|
+
* <p>These are the resources included in the resource selection
|
|
1392
|
+
* (including type of resources and vaults).</p>
|
|
1393
|
+
*/
|
|
1394
|
+
ResourceIdentifiers?: string[];
|
|
1395
|
+
/**
|
|
1396
|
+
* <p>This is a resource filter containing FromDate: DateTime
|
|
1397
|
+
* and ToDate: DateTime. Both values are required. Future DateTime
|
|
1398
|
+
* values are not permitted.</p>
|
|
1399
|
+
* <p>The date and time are in Unix format and Coordinated
|
|
1400
|
+
* Universal Time (UTC), and it is accurate to milliseconds
|
|
1401
|
+
* ((milliseconds are optional).
|
|
1402
|
+
* For example, the value 1516925490.087 represents Friday, January
|
|
1403
|
+
* 26, 2018 12:11:30.087 AM.</p>
|
|
1404
|
+
*/
|
|
1405
|
+
DateRange?: DateRange;
|
|
1406
|
+
}
|
|
1407
|
+
export interface CreateLegalHoldInput {
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>This is the string title of the legal hold.</p>
|
|
1410
|
+
*/
|
|
1411
|
+
Title: string | undefined;
|
|
1412
|
+
/**
|
|
1413
|
+
* <p>This is the string description of the legal hold.</p>
|
|
1414
|
+
*/
|
|
1415
|
+
Description: string | undefined;
|
|
1416
|
+
/**
|
|
1417
|
+
* <p>This is a user-chosen string used to distinguish between otherwise identical
|
|
1418
|
+
* calls. Retrying a successful request with the
|
|
1419
|
+
* same idempotency token results in a success message with no action taken.</p>
|
|
1420
|
+
*/
|
|
1421
|
+
IdempotencyToken?: string;
|
|
1422
|
+
/**
|
|
1423
|
+
* <p>This specifies criteria to assign
|
|
1424
|
+
* a set of resources, such as resource types or backup vaults.</p>
|
|
1425
|
+
*/
|
|
1426
|
+
RecoveryPointSelection?: RecoveryPointSelection;
|
|
1427
|
+
/**
|
|
1428
|
+
* <p>Optional tags to include. A tag is a key-value pair you can use to manage,
|
|
1429
|
+
* filter, and search for your resources. Allowed characters include UTF-8 letters,
|
|
1430
|
+
* numbers, spaces, and the following characters: + - = . _ : /. </p>
|
|
1431
|
+
*/
|
|
1432
|
+
Tags?: Record<string, string>;
|
|
1433
|
+
}
|
|
1434
|
+
export declare enum LegalHoldStatus {
|
|
1435
|
+
ACTIVE = "ACTIVE",
|
|
1436
|
+
CANCELED = "CANCELED",
|
|
1437
|
+
CANCELING = "CANCELING",
|
|
1438
|
+
CREATING = "CREATING"
|
|
1439
|
+
}
|
|
1440
|
+
export interface CreateLegalHoldOutput {
|
|
1441
|
+
/**
|
|
1442
|
+
* <p>This is the string title of the legal hold returned after creating the legal hold.</p>
|
|
1443
|
+
*/
|
|
1444
|
+
Title?: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>This displays the status of the legal hold returned after creating the legal hold.
|
|
1447
|
+
* Statuses can be <code>ACTIVE</code>, <code>PENDING</code>, <code>CANCELED</code>,
|
|
1448
|
+
* <code>CANCELING</code>, or <code>FAILED</code>.</p>
|
|
1449
|
+
*/
|
|
1450
|
+
Status?: LegalHoldStatus | string;
|
|
1451
|
+
/**
|
|
1452
|
+
* <p>This is the returned string description of the legal hold.</p>
|
|
1453
|
+
*/
|
|
1454
|
+
Description?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* <p>Legal hold ID returned for the specified legal hold on a recovery point.</p>
|
|
1457
|
+
*/
|
|
1458
|
+
LegalHoldId?: string;
|
|
1459
|
+
/**
|
|
1460
|
+
* <p>This is the ARN (Amazon Resource Number) of the created legal hold.</p>
|
|
1461
|
+
*/
|
|
1462
|
+
LegalHoldArn?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* <p>Time in number format when legal hold was created.</p>
|
|
1465
|
+
*/
|
|
1466
|
+
CreationDate?: Date;
|
|
1467
|
+
/**
|
|
1468
|
+
* <p>This specifies criteria to assign
|
|
1469
|
+
* a set of resources, such as resource types or backup vaults.</p>
|
|
1470
|
+
*/
|
|
1471
|
+
RecoveryPointSelection?: RecoveryPointSelection;
|
|
1472
|
+
}
|
|
1251
1473
|
/**
|
|
1252
1474
|
* <p>Contains information from your report plan about where to deliver your reports,
|
|
1253
1475
|
* specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your
|
|
@@ -1291,6 +1513,18 @@ export interface ReportSetting {
|
|
|
1291
1513
|
* <p>The number of frameworks a report covers.</p>
|
|
1292
1514
|
*/
|
|
1293
1515
|
NumberOfFrameworks?: number;
|
|
1516
|
+
/**
|
|
1517
|
+
* <p>These are the accounts to be included in the report.</p>
|
|
1518
|
+
*/
|
|
1519
|
+
Accounts?: string[];
|
|
1520
|
+
/**
|
|
1521
|
+
* <p>These are the Organizational Units to be included in the report.</p>
|
|
1522
|
+
*/
|
|
1523
|
+
OrganizationUnits?: string[];
|
|
1524
|
+
/**
|
|
1525
|
+
* <p>These are the Regions to be included in the report.</p>
|
|
1526
|
+
*/
|
|
1527
|
+
Regions?: string[];
|
|
1294
1528
|
}
|
|
1295
1529
|
export interface CreateReportPlanInput {
|
|
1296
1530
|
/**
|
|
@@ -1402,27 +1636,6 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1402
1636
|
*/
|
|
1403
1637
|
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
1404
1638
|
}
|
|
1405
|
-
/**
|
|
1406
|
-
* <p>A resource that is required for the action doesn't exist.</p>
|
|
1407
|
-
*/
|
|
1408
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
1409
|
-
readonly name: "ResourceNotFoundException";
|
|
1410
|
-
readonly $fault: "client";
|
|
1411
|
-
Code?: string;
|
|
1412
|
-
Message?: string;
|
|
1413
|
-
/**
|
|
1414
|
-
* <p></p>
|
|
1415
|
-
*/
|
|
1416
|
-
Type?: string;
|
|
1417
|
-
/**
|
|
1418
|
-
* <p></p>
|
|
1419
|
-
*/
|
|
1420
|
-
Context?: string;
|
|
1421
|
-
/**
|
|
1422
|
-
* @internal
|
|
1423
|
-
*/
|
|
1424
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1425
|
-
}
|
|
1426
1639
|
export interface DeleteBackupSelectionInput {
|
|
1427
1640
|
/**
|
|
1428
1641
|
* <p>Uniquely identifies a backup plan.</p>
|
|
@@ -1486,28 +1699,6 @@ export interface DeleteRecoveryPointInput {
|
|
|
1486
1699
|
*/
|
|
1487
1700
|
RecoveryPointArn: string | undefined;
|
|
1488
1701
|
}
|
|
1489
|
-
/**
|
|
1490
|
-
* <p>Backup is already performing an action on this recovery point. It can't
|
|
1491
|
-
* perform the action you requested until the first action finishes. Try again later.</p>
|
|
1492
|
-
*/
|
|
1493
|
-
export declare class InvalidResourceStateException extends __BaseException {
|
|
1494
|
-
readonly name: "InvalidResourceStateException";
|
|
1495
|
-
readonly $fault: "client";
|
|
1496
|
-
Code?: string;
|
|
1497
|
-
Message?: string;
|
|
1498
|
-
/**
|
|
1499
|
-
* <p></p>
|
|
1500
|
-
*/
|
|
1501
|
-
Type?: string;
|
|
1502
|
-
/**
|
|
1503
|
-
* <p></p>
|
|
1504
|
-
*/
|
|
1505
|
-
Context?: string;
|
|
1506
|
-
/**
|
|
1507
|
-
* @internal
|
|
1508
|
-
*/
|
|
1509
|
-
constructor(opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>);
|
|
1510
|
-
}
|
|
1511
1702
|
export interface DeleteReportPlanInput {
|
|
1512
1703
|
/**
|
|
1513
1704
|
* <p>The unique name of a report plan.</p>
|
|
@@ -1650,6 +1841,22 @@ export interface DescribeBackupJobOutput {
|
|
|
1650
1841
|
* empty, then the backup type was a regular backup.</p>
|
|
1651
1842
|
*/
|
|
1652
1843
|
BackupType?: string;
|
|
1844
|
+
/**
|
|
1845
|
+
* <p>This returns the parent (composite) resource backup job ID.</p>
|
|
1846
|
+
*/
|
|
1847
|
+
ParentJobId?: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* <p>This returns the boolean value that a backup job is a parent (composite) job.</p>
|
|
1850
|
+
*/
|
|
1851
|
+
IsParent?: boolean;
|
|
1852
|
+
/**
|
|
1853
|
+
* <p>This returns the number of child (nested) backup jobs.</p>
|
|
1854
|
+
*/
|
|
1855
|
+
NumberOfChildJobs?: number;
|
|
1856
|
+
/**
|
|
1857
|
+
* <p>This returns the statistics of the included child (nested) backup jobs.</p>
|
|
1858
|
+
*/
|
|
1859
|
+
ChildJobsInState?: Record<string, number>;
|
|
1653
1860
|
}
|
|
1654
1861
|
export interface DescribeBackupVaultInput {
|
|
1655
1862
|
/**
|
|
@@ -1774,10 +1981,9 @@ export interface DescribeFrameworkOutput {
|
|
|
1774
1981
|
*/
|
|
1775
1982
|
FrameworkControls?: FrameworkControl[];
|
|
1776
1983
|
/**
|
|
1777
|
-
* <p>The date and time that a framework is created, in
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
* AM.</p>
|
|
1984
|
+
* <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example,
|
|
1985
|
+
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
1986
|
+
* UTC.</p>
|
|
1781
1987
|
*/
|
|
1782
1988
|
CreationTime?: Date;
|
|
1783
1989
|
/**
|
|
@@ -1948,6 +2154,15 @@ export interface DescribeRecoveryPointOutput {
|
|
|
1948
2154
|
* manually delete these recovery points, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups"> Step 3:
|
|
1949
2155
|
* Delete the recovery points</a> in the <i>Clean up resources</i>
|
|
1950
2156
|
* section of <i>Getting started</i>.</p>
|
|
2157
|
+
* <p>
|
|
2158
|
+
* <code>STOPPED</code> status occurs on a continuous backup where a user has taken some
|
|
2159
|
+
* action that causes the continuous backup to be disabled. This can be caused by the removal
|
|
2160
|
+
* of permissions, turning off versioning, turning off events being sent to EventBridge,
|
|
2161
|
+
* or disabling the EventBridge rules that are put in place by Backup.</p>
|
|
2162
|
+
* <p>To resolve <code>STOPPED</code> status, ensure that all requested permissions are in place and
|
|
2163
|
+
* that versioning is enabled on the S3 bucket. Once these conditions are met, the next instance
|
|
2164
|
+
* of a backup rule running will result in a new continuous recovery point being created.
|
|
2165
|
+
* The recovery points with STOPPED status do not need to be deleted.</p>
|
|
1951
2166
|
*/
|
|
1952
2167
|
Status?: RecoveryPointStatus | string;
|
|
1953
2168
|
/**
|
|
@@ -2013,6 +2228,23 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2013
2228
|
* 12:11:30.087 AM.</p>
|
|
2014
2229
|
*/
|
|
2015
2230
|
LastRestoreTime?: Date;
|
|
2231
|
+
/**
|
|
2232
|
+
* <p>This is an ARN that uniquely identifies a parent (composite) recovery point; for example,
|
|
2233
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
2234
|
+
*/
|
|
2235
|
+
ParentRecoveryPointArn?: string;
|
|
2236
|
+
/**
|
|
2237
|
+
* <p>This is the identifier of a resource within a composite group, such as
|
|
2238
|
+
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
2239
|
+
* ID is transferred from
|
|
2240
|
+
* the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax">
|
|
2241
|
+
* logical ID</a> within a stack.</p>
|
|
2242
|
+
*/
|
|
2243
|
+
CompositeMemberIdentifier?: string;
|
|
2244
|
+
/**
|
|
2245
|
+
* <p>This returns the boolean value that a recovery point is a parent (composite) job.</p>
|
|
2246
|
+
*/
|
|
2247
|
+
IsParent?: boolean;
|
|
2016
2248
|
}
|
|
2017
2249
|
export interface DescribeRegionSettingsInput {
|
|
2018
2250
|
}
|
|
@@ -2292,6 +2524,22 @@ export interface DisassociateRecoveryPointInput {
|
|
|
2292
2524
|
*/
|
|
2293
2525
|
RecoveryPointArn: string | undefined;
|
|
2294
2526
|
}
|
|
2527
|
+
export interface DisassociateRecoveryPointFromParentInput {
|
|
2528
|
+
/**
|
|
2529
|
+
* <p>This is the name of a logical container where the child (nested) recovery point
|
|
2530
|
+
* is stored. Backup vaults are identified by names that are unique to the account used
|
|
2531
|
+
* to create them and the Amazon Web Services Region where they are created. They consist of lowercase
|
|
2532
|
+
* letters, numbers, and hyphens.</p>
|
|
2533
|
+
*/
|
|
2534
|
+
BackupVaultName: string | undefined;
|
|
2535
|
+
/**
|
|
2536
|
+
* <p>This is the Amazon Resource Name (ARN) that uniquely identifies the child
|
|
2537
|
+
* (nested) recovery point; for example,
|
|
2538
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.</code>
|
|
2539
|
+
* </p>
|
|
2540
|
+
*/
|
|
2541
|
+
RecoveryPointArn: string | undefined;
|
|
2542
|
+
}
|
|
2295
2543
|
export interface ExportBackupPlanTemplateInput {
|
|
2296
2544
|
/**
|
|
2297
2545
|
* <p>Uniquely identifies a backup plan.</p>
|
|
@@ -2494,6 +2742,61 @@ export interface GetBackupVaultNotificationsOutput {
|
|
|
2494
2742
|
*/
|
|
2495
2743
|
BackupVaultEvents?: (BackupVaultEvent | string)[];
|
|
2496
2744
|
}
|
|
2745
|
+
export interface GetLegalHoldInput {
|
|
2746
|
+
/**
|
|
2747
|
+
* <p>This is the ID required to use <code>GetLegalHold</code>. This unique ID
|
|
2748
|
+
* is associated with a specific legal hold.</p>
|
|
2749
|
+
*/
|
|
2750
|
+
LegalHoldId: string | undefined;
|
|
2751
|
+
}
|
|
2752
|
+
export interface GetLegalHoldOutput {
|
|
2753
|
+
/**
|
|
2754
|
+
* <p>This is the string title of the legal hold.</p>
|
|
2755
|
+
*/
|
|
2756
|
+
Title?: string;
|
|
2757
|
+
/**
|
|
2758
|
+
* <p>This is the status of the legal hold. Statuses can be
|
|
2759
|
+
* <code>ACTIVE</code>, <code>CREATING</code>, <code>CANCELED</code>, and
|
|
2760
|
+
* <code>CANCELING</code>.</p>
|
|
2761
|
+
*/
|
|
2762
|
+
Status?: LegalHoldStatus | string;
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>This is the returned string description of the legal hold.</p>
|
|
2765
|
+
*/
|
|
2766
|
+
Description?: string;
|
|
2767
|
+
/**
|
|
2768
|
+
* <p>String describing the reason for removing the legal hold.</p>
|
|
2769
|
+
*/
|
|
2770
|
+
CancelDescription?: string;
|
|
2771
|
+
/**
|
|
2772
|
+
* <p>This is the returned ID associated with a specified legal hold.</p>
|
|
2773
|
+
*/
|
|
2774
|
+
LegalHoldId?: string;
|
|
2775
|
+
/**
|
|
2776
|
+
* <p>This is the returned framework ARN for the specified legal hold.
|
|
2777
|
+
* An Amazon Resource Name (ARN) uniquely identifies a resource. The format
|
|
2778
|
+
* of the ARN depends on the resource type.</p>
|
|
2779
|
+
*/
|
|
2780
|
+
LegalHoldArn?: string;
|
|
2781
|
+
/**
|
|
2782
|
+
* <p>Time in number format when legal hold was created.</p>
|
|
2783
|
+
*/
|
|
2784
|
+
CreationDate?: Date;
|
|
2785
|
+
/**
|
|
2786
|
+
* <p>Time in number when legal hold was cancelled.</p>
|
|
2787
|
+
*/
|
|
2788
|
+
CancellationDate?: Date;
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>This is the date and time until which the legal hold record will
|
|
2791
|
+
* be retained.</p>
|
|
2792
|
+
*/
|
|
2793
|
+
RetainRecordUntil?: Date;
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>This specifies criteria to assign
|
|
2796
|
+
* a set of resources, such as resource types or backup vaults.</p>
|
|
2797
|
+
*/
|
|
2798
|
+
RecoveryPointSelection?: RecoveryPointSelection;
|
|
2799
|
+
}
|
|
2497
2800
|
export interface GetRecoveryPointRestoreMetadataInput {
|
|
2498
2801
|
/**
|
|
2499
2802
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
@@ -2681,6 +2984,10 @@ export interface ListBackupJobsInput {
|
|
|
2681
2984
|
* Coordinated Universal Time (UTC).</p>
|
|
2682
2985
|
*/
|
|
2683
2986
|
ByCompleteBefore?: Date;
|
|
2987
|
+
/**
|
|
2988
|
+
* <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
|
|
2989
|
+
*/
|
|
2990
|
+
ByParentJobId?: string;
|
|
2684
2991
|
}
|
|
2685
2992
|
export interface ListBackupJobsOutput {
|
|
2686
2993
|
/**
|
|
@@ -2946,6 +3253,10 @@ export interface ListCopyJobsInput {
|
|
|
2946
3253
|
* Universal Time (UTC).</p>
|
|
2947
3254
|
*/
|
|
2948
3255
|
ByCompleteAfter?: Date;
|
|
3256
|
+
/**
|
|
3257
|
+
* <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
|
|
3258
|
+
*/
|
|
3259
|
+
ByParentJobId?: string;
|
|
2949
3260
|
}
|
|
2950
3261
|
export interface ListCopyJobsOutput {
|
|
2951
3262
|
/**
|
|
@@ -2997,10 +3308,10 @@ export interface Framework {
|
|
|
2997
3308
|
*/
|
|
2998
3309
|
NumberOfControls?: number;
|
|
2999
3310
|
/**
|
|
3000
|
-
* <p>The date and time that a framework is created, in
|
|
3001
|
-
*
|
|
3002
|
-
*
|
|
3003
|
-
*
|
|
3311
|
+
* <p>The date and time that a framework is created, in ISO 8601 representation.
|
|
3312
|
+
* The value of <code>CreationTime</code> is accurate to milliseconds. For example,
|
|
3313
|
+
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
3314
|
+
* UTC.</p>
|
|
3004
3315
|
*/
|
|
3005
3316
|
CreationTime?: Date;
|
|
3006
3317
|
/**
|
|
@@ -3025,6 +3336,75 @@ export interface ListFrameworksOutput {
|
|
|
3025
3336
|
*/
|
|
3026
3337
|
NextToken?: string;
|
|
3027
3338
|
}
|
|
3339
|
+
export interface ListLegalHoldsInput {
|
|
3340
|
+
/**
|
|
3341
|
+
* <p>The next item following a partial list of returned resources. For example, if a request
|
|
3342
|
+
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
3343
|
+
* allows you to return more items in your list starting at the location pointed to by the
|
|
3344
|
+
* next token.</p>
|
|
3345
|
+
*/
|
|
3346
|
+
NextToken?: string;
|
|
3347
|
+
/**
|
|
3348
|
+
* <p>The maximum number of resource list items to be returned.</p>
|
|
3349
|
+
*/
|
|
3350
|
+
MaxResults?: number;
|
|
3351
|
+
}
|
|
3352
|
+
/**
|
|
3353
|
+
* <p>A legal hold is an administrative tool that helps prevent backups
|
|
3354
|
+
* from being deleted while under a hold. While the hold is in place,
|
|
3355
|
+
* backups under a hold cannot be deleted and lifecycle policies that
|
|
3356
|
+
* would alter the backup status (such as transition to cold storage) are
|
|
3357
|
+
* delayed until the legal hold is removed. A backup can have more than
|
|
3358
|
+
* one legal hold. Legal holds are applied to one or more backups
|
|
3359
|
+
* (also known as recovery points). These backups can be filtered by resource
|
|
3360
|
+
* types and by resource IDs.</p>
|
|
3361
|
+
*/
|
|
3362
|
+
export interface LegalHold {
|
|
3363
|
+
/**
|
|
3364
|
+
* <p>This is the title of a legal hold.</p>
|
|
3365
|
+
*/
|
|
3366
|
+
Title?: string;
|
|
3367
|
+
/**
|
|
3368
|
+
* <p>This is the status of the legal hold. Statuses can be
|
|
3369
|
+
* <code>ACTIVE</code>, <code>CREATING</code>, <code>CANCELED</code>, and
|
|
3370
|
+
* <code>CANCELING</code>.</p>
|
|
3371
|
+
*/
|
|
3372
|
+
Status?: LegalHoldStatus | string;
|
|
3373
|
+
/**
|
|
3374
|
+
* <p>This is the description of a legal hold.</p>
|
|
3375
|
+
*/
|
|
3376
|
+
Description?: string;
|
|
3377
|
+
/**
|
|
3378
|
+
* <p>ID of specific legal hold on one or more recovery points.</p>
|
|
3379
|
+
*/
|
|
3380
|
+
LegalHoldId?: string;
|
|
3381
|
+
/**
|
|
3382
|
+
* <p>This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example,
|
|
3383
|
+
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
3384
|
+
*/
|
|
3385
|
+
LegalHoldArn?: string;
|
|
3386
|
+
/**
|
|
3387
|
+
* <p>This is the time in number format when legal hold was created.</p>
|
|
3388
|
+
*/
|
|
3389
|
+
CreationDate?: Date;
|
|
3390
|
+
/**
|
|
3391
|
+
* <p>This is the time in number format when legal hold was cancelled.</p>
|
|
3392
|
+
*/
|
|
3393
|
+
CancellationDate?: Date;
|
|
3394
|
+
}
|
|
3395
|
+
export interface ListLegalHoldsOutput {
|
|
3396
|
+
/**
|
|
3397
|
+
* <p>The next item following a partial list of returned resources. For example, if a request
|
|
3398
|
+
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
3399
|
+
* allows you to return more items in your list starting at the location pointed to by the
|
|
3400
|
+
* next token.</p>
|
|
3401
|
+
*/
|
|
3402
|
+
NextToken?: string;
|
|
3403
|
+
/**
|
|
3404
|
+
* <p>This is an array of returned legal holds, both active and previous.</p>
|
|
3405
|
+
*/
|
|
3406
|
+
LegalHolds?: LegalHold[];
|
|
3407
|
+
}
|
|
3028
3408
|
export interface ListProtectedResourcesInput {
|
|
3029
3409
|
/**
|
|
3030
3410
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
@@ -3120,6 +3500,11 @@ export interface ListRecoveryPointsByBackupVaultInput {
|
|
|
3120
3500
|
* <p>Returns only recovery points that were created after the specified timestamp.</p>
|
|
3121
3501
|
*/
|
|
3122
3502
|
ByCreatedAfter?: Date;
|
|
3503
|
+
/**
|
|
3504
|
+
* <p>This returns only recovery points that match the specified parent (composite)
|
|
3505
|
+
* recovery point Amazon Resource Name (ARN).</p>
|
|
3506
|
+
*/
|
|
3507
|
+
ByParentRecoveryPointArn?: string;
|
|
3123
3508
|
}
|
|
3124
3509
|
/**
|
|
3125
3510
|
* <p>Contains detailed information about the recovery points stored in a backup vault.</p>
|
|
@@ -3231,6 +3616,24 @@ export interface RecoveryPointByBackupVault {
|
|
|
3231
3616
|
* 12:11:30.087 AM.</p>
|
|
3232
3617
|
*/
|
|
3233
3618
|
LastRestoreTime?: Date;
|
|
3619
|
+
/**
|
|
3620
|
+
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
3621
|
+
* recovery point.</p>
|
|
3622
|
+
*/
|
|
3623
|
+
ParentRecoveryPointArn?: string;
|
|
3624
|
+
/**
|
|
3625
|
+
* <p>This is the identifier of a resource within a composite group, such as
|
|
3626
|
+
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
3627
|
+
* ID is transferred from
|
|
3628
|
+
* the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax">
|
|
3629
|
+
* logical ID</a> within a stack.</p>
|
|
3630
|
+
*/
|
|
3631
|
+
CompositeMemberIdentifier?: string;
|
|
3632
|
+
/**
|
|
3633
|
+
* <p>This is a boolean value indicating this is
|
|
3634
|
+
* a parent (composite) recovery point.</p>
|
|
3635
|
+
*/
|
|
3636
|
+
IsParent?: boolean;
|
|
3234
3637
|
}
|
|
3235
3638
|
export interface ListRecoveryPointsByBackupVaultOutput {
|
|
3236
3639
|
/**
|
|
@@ -3246,6 +3649,47 @@ export interface ListRecoveryPointsByBackupVaultOutput {
|
|
|
3246
3649
|
*/
|
|
3247
3650
|
RecoveryPoints?: RecoveryPointByBackupVault[];
|
|
3248
3651
|
}
|
|
3652
|
+
export interface ListRecoveryPointsByLegalHoldInput {
|
|
3653
|
+
/**
|
|
3654
|
+
* <p>This is the ID of the legal hold.</p>
|
|
3655
|
+
*/
|
|
3656
|
+
LegalHoldId: string | undefined;
|
|
3657
|
+
/**
|
|
3658
|
+
* <p>This is the next item following a partial list of returned resources. For example, if a request
|
|
3659
|
+
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
3660
|
+
* allows you to return more items in your list starting at the location pointed to by the
|
|
3661
|
+
* next token.</p>
|
|
3662
|
+
*/
|
|
3663
|
+
NextToken?: string;
|
|
3664
|
+
/**
|
|
3665
|
+
* <p>This is the maximum number of resource list items to be returned.</p>
|
|
3666
|
+
*/
|
|
3667
|
+
MaxResults?: number;
|
|
3668
|
+
}
|
|
3669
|
+
/**
|
|
3670
|
+
* <p>This is a recovery point which is a child (nested) recovery point
|
|
3671
|
+
* of a parent (composite) recovery point. These recovery points
|
|
3672
|
+
* can be disassociated from their parent (composite) recovery
|
|
3673
|
+
* point, in which case they will no longer be a member.</p>
|
|
3674
|
+
*/
|
|
3675
|
+
export interface RecoveryPointMember {
|
|
3676
|
+
/**
|
|
3677
|
+
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
3678
|
+
* recovery point.</p>
|
|
3679
|
+
*/
|
|
3680
|
+
RecoveryPointArn?: string;
|
|
3681
|
+
}
|
|
3682
|
+
export interface ListRecoveryPointsByLegalHoldOutput {
|
|
3683
|
+
/**
|
|
3684
|
+
* <p>This is a list of the recovery points returned by
|
|
3685
|
+
* <code>ListRecoveryPointsByLegalHold</code>.</p>
|
|
3686
|
+
*/
|
|
3687
|
+
RecoveryPoints?: RecoveryPointMember[];
|
|
3688
|
+
/**
|
|
3689
|
+
* <p>This return is the next item following a partial list of returned resources.</p>
|
|
3690
|
+
*/
|
|
3691
|
+
NextToken?: string;
|
|
3692
|
+
}
|
|
3249
3693
|
export interface ListRecoveryPointsByResourceInput {
|
|
3250
3694
|
/**
|
|
3251
3695
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the
|
|
@@ -3307,6 +3751,16 @@ export interface RecoveryPointByResource {
|
|
|
3307
3751
|
* hyphens.</p>
|
|
3308
3752
|
*/
|
|
3309
3753
|
BackupVaultName?: string;
|
|
3754
|
+
/**
|
|
3755
|
+
* <p>This is a boolean value indicating this is
|
|
3756
|
+
* a parent (composite) recovery point.</p>
|
|
3757
|
+
*/
|
|
3758
|
+
IsParent?: boolean;
|
|
3759
|
+
/**
|
|
3760
|
+
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
3761
|
+
* recovery point.</p>
|
|
3762
|
+
*/
|
|
3763
|
+
ParentRecoveryPointArn?: string;
|
|
3310
3764
|
}
|
|
3311
3765
|
export interface ListRecoveryPointsByResourceOutput {
|
|
3312
3766
|
/**
|
|
@@ -3671,8 +4125,9 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
3671
4125
|
* </li>
|
|
3672
4126
|
* </ul>
|
|
3673
4127
|
* <note>
|
|
3674
|
-
* <p>
|
|
3675
|
-
*
|
|
4128
|
+
* <p>The list below shows items that are deprecated events (for reference) and are no longer
|
|
4129
|
+
* in use. They are no longer supported and will not return statuses or notifications.
|
|
4130
|
+
* Refer to the list above for current supported events.</p>
|
|
3676
4131
|
* </note>
|
|
3677
4132
|
*/
|
|
3678
4133
|
BackupVaultEvents: (BackupVaultEvent | string)[] | undefined;
|
|
@@ -3703,7 +4158,8 @@ export interface StartBackupJobInput {
|
|
|
3703
4158
|
IdempotencyToken?: string;
|
|
3704
4159
|
/**
|
|
3705
4160
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
3706
|
-
* doesn't start successfully. This value is optional, and the default is 8 hours
|
|
4161
|
+
* doesn't start successfully. This value is optional, and the default is 8 hours.
|
|
4162
|
+
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
3707
4163
|
*/
|
|
3708
4164
|
StartWindowMinutes?: number;
|
|
3709
4165
|
/**
|
|
@@ -3736,9 +4192,9 @@ export interface StartBackupJobInput {
|
|
|
3736
4192
|
* <p>Specifies the backup option for a selected resource. This option is only available for
|
|
3737
4193
|
* Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
|
|
3738
4194
|
* <p>Valid values: Set to <code>"WindowsVSS":"enabled"</code> to enable the
|
|
3739
|
-
*
|
|
3740
|
-
*
|
|
3741
|
-
*
|
|
4195
|
+
* <code>WindowsVSS</code> backup option and create a Windows VSS backup. Set to
|
|
4196
|
+
* <code>"WindowsVSS""disabled"</code> to create a regular backup. The
|
|
4197
|
+
* <code>WindowsVSS</code> option is not enabled by default.</p>
|
|
3742
4198
|
*/
|
|
3743
4199
|
BackupOptions?: Record<string, string>;
|
|
3744
4200
|
}
|
|
@@ -3759,6 +4215,11 @@ export interface StartBackupJobOutput {
|
|
|
3759
4215
|
* AM.</p>
|
|
3760
4216
|
*/
|
|
3761
4217
|
CreationDate?: Date;
|
|
4218
|
+
/**
|
|
4219
|
+
* <p>This is a returned boolean value indicating this is a parent (composite)
|
|
4220
|
+
* backup job.</p>
|
|
4221
|
+
*/
|
|
4222
|
+
IsParent?: boolean;
|
|
3762
4223
|
}
|
|
3763
4224
|
export interface StartCopyJobInput {
|
|
3764
4225
|
/**
|
|
@@ -3816,6 +4277,11 @@ export interface StartCopyJobOutput {
|
|
|
3816
4277
|
* AM.</p>
|
|
3817
4278
|
*/
|
|
3818
4279
|
CreationDate?: Date;
|
|
4280
|
+
/**
|
|
4281
|
+
* <p>This is a returned boolean value indicating this is a parent (composite)
|
|
4282
|
+
* copy job.</p>
|
|
4283
|
+
*/
|
|
4284
|
+
IsParent?: boolean;
|
|
3819
4285
|
}
|
|
3820
4286
|
export interface StartReportJobInput {
|
|
3821
4287
|
/**
|
|
@@ -3896,7 +4362,7 @@ export interface StartRestoreJobInput {
|
|
|
3896
4362
|
Metadata: Record<string, string> | undefined;
|
|
3897
4363
|
/**
|
|
3898
4364
|
* <p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create
|
|
3899
|
-
* the target
|
|
4365
|
+
* the target resource; for example:
|
|
3900
4366
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
3901
4367
|
*/
|
|
3902
4368
|
IamRoleArn?: string;
|
|
@@ -4069,10 +4535,9 @@ export interface UpdateFrameworkOutput {
|
|
|
4069
4535
|
*/
|
|
4070
4536
|
FrameworkArn?: string;
|
|
4071
4537
|
/**
|
|
4072
|
-
* <p>The date and time that a framework is created, in
|
|
4073
|
-
*
|
|
4074
|
-
*
|
|
4075
|
-
* AM.</p>
|
|
4538
|
+
* <p>The date and time that a framework is created, in ISO 8601 representation. The value of <code>CreationTime</code> is accurate to milliseconds. For example,
|
|
4539
|
+
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
4540
|
+
* UTC.</p>
|
|
4076
4541
|
*/
|
|
4077
4542
|
CreationTime?: Date;
|
|
4078
4543
|
}
|
|
@@ -4277,6 +4742,14 @@ export declare const BackupVaultListMemberFilterSensitiveLog: (obj: BackupVaultL
|
|
|
4277
4742
|
* @internal
|
|
4278
4743
|
*/
|
|
4279
4744
|
export declare const CalculatedLifecycleFilterSensitiveLog: (obj: CalculatedLifecycle) => any;
|
|
4745
|
+
/**
|
|
4746
|
+
* @internal
|
|
4747
|
+
*/
|
|
4748
|
+
export declare const CancelLegalHoldInputFilterSensitiveLog: (obj: CancelLegalHoldInput) => any;
|
|
4749
|
+
/**
|
|
4750
|
+
* @internal
|
|
4751
|
+
*/
|
|
4752
|
+
export declare const CancelLegalHoldOutputFilterSensitiveLog: (obj: CancelLegalHoldOutput) => any;
|
|
4280
4753
|
/**
|
|
4281
4754
|
* @internal
|
|
4282
4755
|
*/
|
|
@@ -4325,6 +4798,22 @@ export declare const CreateFrameworkInputFilterSensitiveLog: (obj: CreateFramewo
|
|
|
4325
4798
|
* @internal
|
|
4326
4799
|
*/
|
|
4327
4800
|
export declare const CreateFrameworkOutputFilterSensitiveLog: (obj: CreateFrameworkOutput) => any;
|
|
4801
|
+
/**
|
|
4802
|
+
* @internal
|
|
4803
|
+
*/
|
|
4804
|
+
export declare const DateRangeFilterSensitiveLog: (obj: DateRange) => any;
|
|
4805
|
+
/**
|
|
4806
|
+
* @internal
|
|
4807
|
+
*/
|
|
4808
|
+
export declare const RecoveryPointSelectionFilterSensitiveLog: (obj: RecoveryPointSelection) => any;
|
|
4809
|
+
/**
|
|
4810
|
+
* @internal
|
|
4811
|
+
*/
|
|
4812
|
+
export declare const CreateLegalHoldInputFilterSensitiveLog: (obj: CreateLegalHoldInput) => any;
|
|
4813
|
+
/**
|
|
4814
|
+
* @internal
|
|
4815
|
+
*/
|
|
4816
|
+
export declare const CreateLegalHoldOutputFilterSensitiveLog: (obj: CreateLegalHoldOutput) => any;
|
|
4328
4817
|
/**
|
|
4329
4818
|
* @internal
|
|
4330
4819
|
*/
|
|
@@ -4485,6 +4974,10 @@ export declare const DescribeRestoreJobOutputFilterSensitiveLog: (obj: DescribeR
|
|
|
4485
4974
|
* @internal
|
|
4486
4975
|
*/
|
|
4487
4976
|
export declare const DisassociateRecoveryPointInputFilterSensitiveLog: (obj: DisassociateRecoveryPointInput) => any;
|
|
4977
|
+
/**
|
|
4978
|
+
* @internal
|
|
4979
|
+
*/
|
|
4980
|
+
export declare const DisassociateRecoveryPointFromParentInputFilterSensitiveLog: (obj: DisassociateRecoveryPointFromParentInput) => any;
|
|
4488
4981
|
/**
|
|
4489
4982
|
* @internal
|
|
4490
4983
|
*/
|
|
@@ -4541,6 +5034,14 @@ export declare const GetBackupVaultNotificationsInputFilterSensitiveLog: (obj: G
|
|
|
4541
5034
|
* @internal
|
|
4542
5035
|
*/
|
|
4543
5036
|
export declare const GetBackupVaultNotificationsOutputFilterSensitiveLog: (obj: GetBackupVaultNotificationsOutput) => any;
|
|
5037
|
+
/**
|
|
5038
|
+
* @internal
|
|
5039
|
+
*/
|
|
5040
|
+
export declare const GetLegalHoldInputFilterSensitiveLog: (obj: GetLegalHoldInput) => any;
|
|
5041
|
+
/**
|
|
5042
|
+
* @internal
|
|
5043
|
+
*/
|
|
5044
|
+
export declare const GetLegalHoldOutputFilterSensitiveLog: (obj: GetLegalHoldOutput) => any;
|
|
4544
5045
|
/**
|
|
4545
5046
|
* @internal
|
|
4546
5047
|
*/
|
|
@@ -4621,6 +5122,18 @@ export declare const FrameworkFilterSensitiveLog: (obj: Framework) => any;
|
|
|
4621
5122
|
* @internal
|
|
4622
5123
|
*/
|
|
4623
5124
|
export declare const ListFrameworksOutputFilterSensitiveLog: (obj: ListFrameworksOutput) => any;
|
|
5125
|
+
/**
|
|
5126
|
+
* @internal
|
|
5127
|
+
*/
|
|
5128
|
+
export declare const ListLegalHoldsInputFilterSensitiveLog: (obj: ListLegalHoldsInput) => any;
|
|
5129
|
+
/**
|
|
5130
|
+
* @internal
|
|
5131
|
+
*/
|
|
5132
|
+
export declare const LegalHoldFilterSensitiveLog: (obj: LegalHold) => any;
|
|
5133
|
+
/**
|
|
5134
|
+
* @internal
|
|
5135
|
+
*/
|
|
5136
|
+
export declare const ListLegalHoldsOutputFilterSensitiveLog: (obj: ListLegalHoldsOutput) => any;
|
|
4624
5137
|
/**
|
|
4625
5138
|
* @internal
|
|
4626
5139
|
*/
|
|
@@ -4645,6 +5158,18 @@ export declare const RecoveryPointByBackupVaultFilterSensitiveLog: (obj: Recover
|
|
|
4645
5158
|
* @internal
|
|
4646
5159
|
*/
|
|
4647
5160
|
export declare const ListRecoveryPointsByBackupVaultOutputFilterSensitiveLog: (obj: ListRecoveryPointsByBackupVaultOutput) => any;
|
|
5161
|
+
/**
|
|
5162
|
+
* @internal
|
|
5163
|
+
*/
|
|
5164
|
+
export declare const ListRecoveryPointsByLegalHoldInputFilterSensitiveLog: (obj: ListRecoveryPointsByLegalHoldInput) => any;
|
|
5165
|
+
/**
|
|
5166
|
+
* @internal
|
|
5167
|
+
*/
|
|
5168
|
+
export declare const RecoveryPointMemberFilterSensitiveLog: (obj: RecoveryPointMember) => any;
|
|
5169
|
+
/**
|
|
5170
|
+
* @internal
|
|
5171
|
+
*/
|
|
5172
|
+
export declare const ListRecoveryPointsByLegalHoldOutputFilterSensitiveLog: (obj: ListRecoveryPointsByLegalHoldOutput) => any;
|
|
4648
5173
|
/**
|
|
4649
5174
|
* @internal
|
|
4650
5175
|
*/
|