@aws-sdk/client-backup 3.378.0 → 3.382.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.
|
@@ -6,6 +6,7 @@ import { BackupServiceException as __BaseException } from "./BackupServiceExcept
|
|
|
6
6
|
*/
|
|
7
7
|
export interface AdvancedBackupSetting {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>Specifies an object containing resource type and backup options. The only supported
|
|
10
11
|
* resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service
|
|
11
12
|
* (VSS). For a CloudFormation example, see the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html">sample
|
|
@@ -14,6 +15,7 @@ export interface AdvancedBackupSetting {
|
|
|
14
15
|
*/
|
|
15
16
|
ResourceType?: string;
|
|
16
17
|
/**
|
|
18
|
+
* @public
|
|
17
19
|
* <p>Specifies the backup option for a selected resource. This option is only available for
|
|
18
20
|
* Windows VSS backup jobs.</p>
|
|
19
21
|
* <p>Valid values: </p>
|
|
@@ -38,18 +40,22 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
38
40
|
Code?: string;
|
|
39
41
|
Message?: string;
|
|
40
42
|
/**
|
|
43
|
+
* @public
|
|
41
44
|
* <p></p>
|
|
42
45
|
*/
|
|
43
46
|
CreatorRequestId?: string;
|
|
44
47
|
/**
|
|
48
|
+
* @public
|
|
45
49
|
* <p></p>
|
|
46
50
|
*/
|
|
47
51
|
Arn?: string;
|
|
48
52
|
/**
|
|
53
|
+
* @public
|
|
49
54
|
* <p></p>
|
|
50
55
|
*/
|
|
51
56
|
Type?: string;
|
|
52
57
|
/**
|
|
58
|
+
* @public
|
|
53
59
|
* <p></p>
|
|
54
60
|
*/
|
|
55
61
|
Context?: string;
|
|
@@ -65,20 +71,24 @@ export declare class AlreadyExistsException extends __BaseException {
|
|
|
65
71
|
*/
|
|
66
72
|
export interface RecoveryPointCreator {
|
|
67
73
|
/**
|
|
74
|
+
* @public
|
|
68
75
|
* <p>Uniquely identifies a backup plan.</p>
|
|
69
76
|
*/
|
|
70
77
|
BackupPlanId?: string;
|
|
71
78
|
/**
|
|
79
|
+
* @public
|
|
72
80
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
73
81
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
74
82
|
*/
|
|
75
83
|
BackupPlanArn?: string;
|
|
76
84
|
/**
|
|
85
|
+
* @public
|
|
77
86
|
* <p>Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at
|
|
78
87
|
* most 1,024 bytes long. They cannot be edited.</p>
|
|
79
88
|
*/
|
|
80
89
|
BackupPlanVersion?: string;
|
|
81
90
|
/**
|
|
91
|
+
* @public
|
|
82
92
|
* <p>Uniquely identifies a rule used to schedule the backup of a selection of
|
|
83
93
|
* resources.</p>
|
|
84
94
|
*/
|
|
@@ -109,14 +119,17 @@ export type BackupJobState = (typeof BackupJobState)[keyof typeof BackupJobState
|
|
|
109
119
|
*/
|
|
110
120
|
export interface BackupJob {
|
|
111
121
|
/**
|
|
122
|
+
* @public
|
|
112
123
|
* <p>The account ID that owns the backup job.</p>
|
|
113
124
|
*/
|
|
114
125
|
AccountId?: string;
|
|
115
126
|
/**
|
|
127
|
+
* @public
|
|
116
128
|
* <p>Uniquely identifies a request to Backup to back up a resource.</p>
|
|
117
129
|
*/
|
|
118
130
|
BackupJobId?: string;
|
|
119
131
|
/**
|
|
132
|
+
* @public
|
|
120
133
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
121
134
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
122
135
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -124,27 +137,32 @@ export interface BackupJob {
|
|
|
124
137
|
*/
|
|
125
138
|
BackupVaultName?: string;
|
|
126
139
|
/**
|
|
140
|
+
* @public
|
|
127
141
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
128
142
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
129
143
|
*/
|
|
130
144
|
BackupVaultArn?: string;
|
|
131
145
|
/**
|
|
146
|
+
* @public
|
|
132
147
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
133
148
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
134
149
|
*/
|
|
135
150
|
RecoveryPointArn?: string;
|
|
136
151
|
/**
|
|
152
|
+
* @public
|
|
137
153
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the
|
|
138
154
|
* resource type.</p>
|
|
139
155
|
*/
|
|
140
156
|
ResourceArn?: string;
|
|
141
157
|
/**
|
|
158
|
+
* @public
|
|
142
159
|
* <p>The date and time a backup job is created, in Unix format and Coordinated Universal Time
|
|
143
160
|
* (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the
|
|
144
161
|
* value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
145
162
|
*/
|
|
146
163
|
CreationDate?: Date;
|
|
147
164
|
/**
|
|
165
|
+
* @public
|
|
148
166
|
* <p>The date and time a job to create a backup job is completed, in Unix format and
|
|
149
167
|
* Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to
|
|
150
168
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -152,23 +170,28 @@ export interface BackupJob {
|
|
|
152
170
|
*/
|
|
153
171
|
CompletionDate?: Date;
|
|
154
172
|
/**
|
|
173
|
+
* @public
|
|
155
174
|
* <p>The current state of a resource recovery point.</p>
|
|
156
175
|
*/
|
|
157
176
|
State?: BackupJobState | string;
|
|
158
177
|
/**
|
|
178
|
+
* @public
|
|
159
179
|
* <p>A detailed message explaining the status of the job to back up a resource.</p>
|
|
160
180
|
*/
|
|
161
181
|
StatusMessage?: string;
|
|
162
182
|
/**
|
|
183
|
+
* @public
|
|
163
184
|
* <p>Contains an estimated percentage complete of a job at the time the job status was
|
|
164
185
|
* queried.</p>
|
|
165
186
|
*/
|
|
166
187
|
PercentDone?: string;
|
|
167
188
|
/**
|
|
189
|
+
* @public
|
|
168
190
|
* <p>The size, in bytes, of a backup.</p>
|
|
169
191
|
*/
|
|
170
192
|
BackupSizeInBytes?: number;
|
|
171
193
|
/**
|
|
194
|
+
* @public
|
|
172
195
|
* <p>Specifies the IAM role ARN used to create the target recovery point. IAM roles other
|
|
173
196
|
* than the default role must include either <code>AWSBackup</code> or <code>AwsBackup</code>
|
|
174
197
|
* in the role name. For example,
|
|
@@ -177,12 +200,14 @@ export interface BackupJob {
|
|
|
177
200
|
*/
|
|
178
201
|
IamRoleArn?: string;
|
|
179
202
|
/**
|
|
203
|
+
* @public
|
|
180
204
|
* <p>Contains identifying information about the creation of a backup job, including the
|
|
181
205
|
* <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>,
|
|
182
206
|
* and <code>BackupRuleId</code> of the backup plan used to create it.</p>
|
|
183
207
|
*/
|
|
184
208
|
CreatedBy?: RecoveryPointCreator;
|
|
185
209
|
/**
|
|
210
|
+
* @public
|
|
186
211
|
* <p>The date and time a job to back up resources is expected to be completed, in Unix format
|
|
187
212
|
* and Coordinated Universal Time (UTC). The value of <code>ExpectedCompletionDate</code> is
|
|
188
213
|
* accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January
|
|
@@ -190,6 +215,7 @@ export interface BackupJob {
|
|
|
190
215
|
*/
|
|
191
216
|
ExpectedCompletionDate?: Date;
|
|
192
217
|
/**
|
|
218
|
+
* @public
|
|
193
219
|
* <p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job
|
|
194
220
|
* must be started before it is canceled. The value is calculated by adding the start window
|
|
195
221
|
* to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2
|
|
@@ -199,16 +225,19 @@ export interface BackupJob {
|
|
|
199
225
|
*/
|
|
200
226
|
StartBy?: Date;
|
|
201
227
|
/**
|
|
228
|
+
* @public
|
|
202
229
|
* <p>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only
|
|
203
230
|
* supported resource type is Amazon EC2.</p>
|
|
204
231
|
*/
|
|
205
232
|
ResourceType?: string;
|
|
206
233
|
/**
|
|
234
|
+
* @public
|
|
207
235
|
* <p>The size in bytes transferred to a backup vault at the time that the job status was
|
|
208
236
|
* queried.</p>
|
|
209
237
|
*/
|
|
210
238
|
BytesTransferred?: number;
|
|
211
239
|
/**
|
|
240
|
+
* @public
|
|
212
241
|
* <p>Specifies the backup option for a selected resource. This option is only available for
|
|
213
242
|
* Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
|
|
214
243
|
* <p>Valid values: Set to <code>"WindowsVSS":"enabled"</code> to enable the
|
|
@@ -218,21 +247,25 @@ export interface BackupJob {
|
|
|
218
247
|
*/
|
|
219
248
|
BackupOptions?: Record<string, string>;
|
|
220
249
|
/**
|
|
250
|
+
* @public
|
|
221
251
|
* <p>Represents the type of backup for a backup job.</p>
|
|
222
252
|
*/
|
|
223
253
|
BackupType?: string;
|
|
224
254
|
/**
|
|
255
|
+
* @public
|
|
225
256
|
* <p>This uniquely identifies a request to Backup
|
|
226
257
|
* to back up a resource. The return will be the
|
|
227
258
|
* parent (composite) job ID.</p>
|
|
228
259
|
*/
|
|
229
260
|
ParentJobId?: string;
|
|
230
261
|
/**
|
|
262
|
+
* @public
|
|
231
263
|
* <p>This is a boolean value indicating this is
|
|
232
264
|
* a parent (composite) backup job.</p>
|
|
233
265
|
*/
|
|
234
266
|
IsParent?: boolean;
|
|
235
267
|
/**
|
|
268
|
+
* @public
|
|
236
269
|
* <p>This is the non-unique name of the resource that
|
|
237
270
|
* belongs to the specified backup.</p>
|
|
238
271
|
*/
|
|
@@ -253,11 +286,13 @@ export interface BackupJob {
|
|
|
253
286
|
*/
|
|
254
287
|
export interface Lifecycle {
|
|
255
288
|
/**
|
|
289
|
+
* @public
|
|
256
290
|
* <p>Specifies the number of days after creation that a recovery point is moved to cold
|
|
257
291
|
* storage.</p>
|
|
258
292
|
*/
|
|
259
293
|
MoveToColdStorageAfterDays?: number;
|
|
260
294
|
/**
|
|
295
|
+
* @public
|
|
261
296
|
* <p>Specifies the number of days after creation that a recovery point is deleted. Must be
|
|
262
297
|
* greater than 90 days plus <code>MoveToColdStorageAfterDays</code>.</p>
|
|
263
298
|
*/
|
|
@@ -269,6 +304,7 @@ export interface Lifecycle {
|
|
|
269
304
|
*/
|
|
270
305
|
export interface CopyAction {
|
|
271
306
|
/**
|
|
307
|
+
* @public
|
|
272
308
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
273
309
|
* a recovery point transitions to cold storage or is deleted.</p>
|
|
274
310
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
@@ -282,6 +318,7 @@ export interface CopyAction {
|
|
|
282
318
|
*/
|
|
283
319
|
Lifecycle?: Lifecycle;
|
|
284
320
|
/**
|
|
321
|
+
* @public
|
|
285
322
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for
|
|
286
323
|
* the copied backup. For example,
|
|
287
324
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
@@ -294,11 +331,13 @@ export interface CopyAction {
|
|
|
294
331
|
*/
|
|
295
332
|
export interface BackupRule {
|
|
296
333
|
/**
|
|
334
|
+
* @public
|
|
297
335
|
* <p>A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
|
|
298
336
|
* characters.</p>
|
|
299
337
|
*/
|
|
300
338
|
RuleName: string | undefined;
|
|
301
339
|
/**
|
|
340
|
+
* @public
|
|
302
341
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
303
342
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
304
343
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -306,6 +345,7 @@ export interface BackupRule {
|
|
|
306
345
|
*/
|
|
307
346
|
TargetBackupVaultName: string | undefined;
|
|
308
347
|
/**
|
|
348
|
+
* @public
|
|
309
349
|
* <p>A cron expression in UTC specifying when Backup initiates a backup job. For
|
|
310
350
|
* more information about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User
|
|
311
351
|
* Guide.</i>. Two examples of Amazon Web Services cron expressions are <code> 15 * ?
|
|
@@ -315,6 +355,7 @@ export interface BackupRule {
|
|
|
315
355
|
*/
|
|
316
356
|
ScheduleExpression?: string;
|
|
317
357
|
/**
|
|
358
|
+
* @public
|
|
318
359
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
319
360
|
* doesn't start successfully. This value is optional.
|
|
320
361
|
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
@@ -328,11 +369,13 @@ export interface BackupRule {
|
|
|
328
369
|
*/
|
|
329
370
|
StartWindowMinutes?: number;
|
|
330
371
|
/**
|
|
372
|
+
* @public
|
|
331
373
|
* <p>A value in minutes after a backup job is successfully started before it must be
|
|
332
374
|
* completed or it will be canceled by Backup. This value is optional.</p>
|
|
333
375
|
*/
|
|
334
376
|
CompletionWindowMinutes?: number;
|
|
335
377
|
/**
|
|
378
|
+
* @public
|
|
336
379
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
337
380
|
* it expires. Backup transitions and expires backups automatically according to
|
|
338
381
|
* the lifecycle that you define. </p>
|
|
@@ -347,21 +390,25 @@ export interface BackupRule {
|
|
|
347
390
|
*/
|
|
348
391
|
Lifecycle?: Lifecycle;
|
|
349
392
|
/**
|
|
393
|
+
* @public
|
|
350
394
|
* <p>An array of key-value pair strings that are assigned to resources that are associated
|
|
351
395
|
* with this rule when restored from backup.</p>
|
|
352
396
|
*/
|
|
353
397
|
RecoveryPointTags?: Record<string, string>;
|
|
354
398
|
/**
|
|
399
|
+
* @public
|
|
355
400
|
* <p>Uniquely identifies a rule that is used to schedule the backup of a selection of
|
|
356
401
|
* resources.</p>
|
|
357
402
|
*/
|
|
358
403
|
RuleId?: string;
|
|
359
404
|
/**
|
|
405
|
+
* @public
|
|
360
406
|
* <p>An array of <code>CopyAction</code> objects, which contains the details of the copy
|
|
361
407
|
* operation.</p>
|
|
362
408
|
*/
|
|
363
409
|
CopyActions?: CopyAction[];
|
|
364
410
|
/**
|
|
411
|
+
* @public
|
|
365
412
|
* <p>Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False
|
|
366
413
|
* (or not specified) causes Backup to create snapshot backups.</p>
|
|
367
414
|
*/
|
|
@@ -376,16 +423,19 @@ export interface BackupRule {
|
|
|
376
423
|
*/
|
|
377
424
|
export interface BackupPlan {
|
|
378
425
|
/**
|
|
426
|
+
* @public
|
|
379
427
|
* <p>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
|
|
380
428
|
* characters.</p>
|
|
381
429
|
*/
|
|
382
430
|
BackupPlanName: string | undefined;
|
|
383
431
|
/**
|
|
432
|
+
* @public
|
|
384
433
|
* <p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task
|
|
385
434
|
* that is used to back up a selection of resources. </p>
|
|
386
435
|
*/
|
|
387
436
|
Rules: BackupRule[] | undefined;
|
|
388
437
|
/**
|
|
438
|
+
* @public
|
|
389
439
|
* <p>Contains a list of <code>BackupOptions</code> for each resource type.</p>
|
|
390
440
|
*/
|
|
391
441
|
AdvancedBackupSettings?: AdvancedBackupSetting[];
|
|
@@ -396,11 +446,13 @@ export interface BackupPlan {
|
|
|
396
446
|
*/
|
|
397
447
|
export interface BackupRuleInput {
|
|
398
448
|
/**
|
|
449
|
+
* @public
|
|
399
450
|
* <p>A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
|
|
400
451
|
* characters.</p>
|
|
401
452
|
*/
|
|
402
453
|
RuleName: string | undefined;
|
|
403
454
|
/**
|
|
455
|
+
* @public
|
|
404
456
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
405
457
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
406
458
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -408,11 +460,13 @@ export interface BackupRuleInput {
|
|
|
408
460
|
*/
|
|
409
461
|
TargetBackupVaultName: string | undefined;
|
|
410
462
|
/**
|
|
463
|
+
* @public
|
|
411
464
|
* <p>A CRON expression in UTC specifying when Backup initiates a backup
|
|
412
465
|
* job.</p>
|
|
413
466
|
*/
|
|
414
467
|
ScheduleExpression?: string;
|
|
415
468
|
/**
|
|
469
|
+
* @public
|
|
416
470
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
417
471
|
* doesn't start successfully. This value is optional.
|
|
418
472
|
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
@@ -426,11 +480,13 @@ export interface BackupRuleInput {
|
|
|
426
480
|
*/
|
|
427
481
|
StartWindowMinutes?: number;
|
|
428
482
|
/**
|
|
483
|
+
* @public
|
|
429
484
|
* <p>A value in minutes after a backup job is successfully started before it must be
|
|
430
485
|
* completed or it will be canceled by Backup. This value is optional.</p>
|
|
431
486
|
*/
|
|
432
487
|
CompletionWindowMinutes?: number;
|
|
433
488
|
/**
|
|
489
|
+
* @public
|
|
434
490
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
435
491
|
* it expires. Backup will transition and expire backups automatically according
|
|
436
492
|
* to the lifecycle that you define. </p>
|
|
@@ -445,16 +501,19 @@ export interface BackupRuleInput {
|
|
|
445
501
|
*/
|
|
446
502
|
Lifecycle?: Lifecycle;
|
|
447
503
|
/**
|
|
504
|
+
* @public
|
|
448
505
|
* <p>To help organize your resources, you can assign your own metadata to the resources that
|
|
449
506
|
* you create. Each tag is a key-value pair.</p>
|
|
450
507
|
*/
|
|
451
508
|
RecoveryPointTags?: Record<string, string>;
|
|
452
509
|
/**
|
|
510
|
+
* @public
|
|
453
511
|
* <p>An array of <code>CopyAction</code> objects, which contains the details of the copy
|
|
454
512
|
* operation.</p>
|
|
455
513
|
*/
|
|
456
514
|
CopyActions?: CopyAction[];
|
|
457
515
|
/**
|
|
516
|
+
* @public
|
|
458
517
|
* <p>Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False
|
|
459
518
|
* (or not specified) causes Backup to create snapshot backups.</p>
|
|
460
519
|
*/
|
|
@@ -468,16 +527,19 @@ export interface BackupRuleInput {
|
|
|
468
527
|
*/
|
|
469
528
|
export interface BackupPlanInput {
|
|
470
529
|
/**
|
|
530
|
+
* @public
|
|
471
531
|
* <p>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
|
|
472
532
|
* characters.</p>
|
|
473
533
|
*/
|
|
474
534
|
BackupPlanName: string | undefined;
|
|
475
535
|
/**
|
|
536
|
+
* @public
|
|
476
537
|
* <p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task
|
|
477
538
|
* that is used to back up a selection of resources.</p>
|
|
478
539
|
*/
|
|
479
540
|
Rules: BackupRuleInput[] | undefined;
|
|
480
541
|
/**
|
|
542
|
+
* @public
|
|
481
543
|
* <p>Specifies a list of <code>BackupOptions</code> for each resource type. These settings
|
|
482
544
|
* are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
|
|
483
545
|
*/
|
|
@@ -489,15 +551,18 @@ export interface BackupPlanInput {
|
|
|
489
551
|
*/
|
|
490
552
|
export interface BackupPlansListMember {
|
|
491
553
|
/**
|
|
554
|
+
* @public
|
|
492
555
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
493
556
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
494
557
|
*/
|
|
495
558
|
BackupPlanArn?: string;
|
|
496
559
|
/**
|
|
560
|
+
* @public
|
|
497
561
|
* <p>Uniquely identifies a backup plan.</p>
|
|
498
562
|
*/
|
|
499
563
|
BackupPlanId?: string;
|
|
500
564
|
/**
|
|
565
|
+
* @public
|
|
501
566
|
* <p>The date and time a resource backup plan is created, in Unix format and Coordinated
|
|
502
567
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
503
568
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -505,6 +570,7 @@ export interface BackupPlansListMember {
|
|
|
505
570
|
*/
|
|
506
571
|
CreationDate?: Date;
|
|
507
572
|
/**
|
|
573
|
+
* @public
|
|
508
574
|
* <p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal
|
|
509
575
|
* Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For
|
|
510
576
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -512,21 +578,25 @@ export interface BackupPlansListMember {
|
|
|
512
578
|
*/
|
|
513
579
|
DeletionDate?: Date;
|
|
514
580
|
/**
|
|
581
|
+
* @public
|
|
515
582
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
516
583
|
* long. Version IDs cannot be edited.</p>
|
|
517
584
|
*/
|
|
518
585
|
VersionId?: string;
|
|
519
586
|
/**
|
|
587
|
+
* @public
|
|
520
588
|
* <p>The display name of a saved backup plan.</p>
|
|
521
589
|
*/
|
|
522
590
|
BackupPlanName?: string;
|
|
523
591
|
/**
|
|
592
|
+
* @public
|
|
524
593
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
525
594
|
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
526
595
|
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
527
596
|
*/
|
|
528
597
|
CreatorRequestId?: string;
|
|
529
598
|
/**
|
|
599
|
+
* @public
|
|
530
600
|
* <p>The last time a job to back up resources was run with this rule. A date and time, in
|
|
531
601
|
* Unix format and Coordinated Universal Time (UTC). The value of
|
|
532
602
|
* <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value
|
|
@@ -534,6 +604,7 @@ export interface BackupPlansListMember {
|
|
|
534
604
|
*/
|
|
535
605
|
LastExecutionDate?: Date;
|
|
536
606
|
/**
|
|
607
|
+
* @public
|
|
537
608
|
* <p>Contains a list of <code>BackupOptions</code> for a resource type.</p>
|
|
538
609
|
*/
|
|
539
610
|
AdvancedBackupSettings?: AdvancedBackupSetting[];
|
|
@@ -544,10 +615,12 @@ export interface BackupPlansListMember {
|
|
|
544
615
|
*/
|
|
545
616
|
export interface BackupPlanTemplatesListMember {
|
|
546
617
|
/**
|
|
618
|
+
* @public
|
|
547
619
|
* <p>Uniquely identifies a stored backup plan template.</p>
|
|
548
620
|
*/
|
|
549
621
|
BackupPlanTemplateId?: string;
|
|
550
622
|
/**
|
|
623
|
+
* @public
|
|
551
624
|
* <p>The optional display name of a backup plan template.</p>
|
|
552
625
|
*/
|
|
553
626
|
BackupPlanTemplateName?: string;
|
|
@@ -559,11 +632,13 @@ export interface BackupPlanTemplatesListMember {
|
|
|
559
632
|
*/
|
|
560
633
|
export interface ConditionParameter {
|
|
561
634
|
/**
|
|
635
|
+
* @public
|
|
562
636
|
* <p>The key in a key-value pair. For example, in the tag <code>Department:
|
|
563
637
|
* Accounting</code>, <code>Department</code> is the key.</p>
|
|
564
638
|
*/
|
|
565
639
|
ConditionKey?: string;
|
|
566
640
|
/**
|
|
641
|
+
* @public
|
|
567
642
|
* <p>The value in a key-value pair. For example, in the tag <code>Department:
|
|
568
643
|
* Accounting</code>, <code>Accounting</code> is the value.</p>
|
|
569
644
|
*/
|
|
@@ -576,22 +651,26 @@ export interface ConditionParameter {
|
|
|
576
651
|
*/
|
|
577
652
|
export interface Conditions {
|
|
578
653
|
/**
|
|
654
|
+
* @public
|
|
579
655
|
* <p>Filters the values of your tagged resources for only those resources that you tagged
|
|
580
656
|
* with the same value. Also called "exact matching."</p>
|
|
581
657
|
*/
|
|
582
658
|
StringEquals?: ConditionParameter[];
|
|
583
659
|
/**
|
|
660
|
+
* @public
|
|
584
661
|
* <p>Filters the values of your tagged resources for only those resources that you tagged
|
|
585
662
|
* that do not have the same value. Also called "negated matching."</p>
|
|
586
663
|
*/
|
|
587
664
|
StringNotEquals?: ConditionParameter[];
|
|
588
665
|
/**
|
|
666
|
+
* @public
|
|
589
667
|
* <p>Filters the values of your tagged resources for matching tag values with the use of a
|
|
590
668
|
* wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the
|
|
591
669
|
* tag value "production".</p>
|
|
592
670
|
*/
|
|
593
671
|
StringLike?: ConditionParameter[];
|
|
594
672
|
/**
|
|
673
|
+
* @public
|
|
595
674
|
* <p>Filters the values of your tagged resources for non-matching tag values with the use of
|
|
596
675
|
* a wildcard character (*) anywhere in the string.</p>
|
|
597
676
|
*/
|
|
@@ -616,6 +695,7 @@ export type ConditionType = (typeof ConditionType)[keyof typeof ConditionType];
|
|
|
616
695
|
*/
|
|
617
696
|
export interface Condition {
|
|
618
697
|
/**
|
|
698
|
+
* @public
|
|
619
699
|
* <p>An operation applied to a key-value pair used to assign resources to your backup plan.
|
|
620
700
|
* Condition only supports <code>StringEquals</code>. For more flexible assignment options,
|
|
621
701
|
* including <code>StringLike</code> and the ability to exclude resources from your backup
|
|
@@ -625,11 +705,13 @@ export interface Condition {
|
|
|
625
705
|
*/
|
|
626
706
|
ConditionType: ConditionType | string | undefined;
|
|
627
707
|
/**
|
|
708
|
+
* @public
|
|
628
709
|
* <p>The key in a key-value pair. For example, in the tag <code>Department:
|
|
629
710
|
* Accounting</code>, <code>Department</code> is the key.</p>
|
|
630
711
|
*/
|
|
631
712
|
ConditionKey: string | undefined;
|
|
632
713
|
/**
|
|
714
|
+
* @public
|
|
633
715
|
* <p>The value in a key-value pair. For example, in the tag <code>Department:
|
|
634
716
|
* Accounting</code>, <code>Accounting</code> is the value.</p>
|
|
635
717
|
*/
|
|
@@ -644,16 +726,19 @@ export interface Condition {
|
|
|
644
726
|
*/
|
|
645
727
|
export interface BackupSelection {
|
|
646
728
|
/**
|
|
729
|
+
* @public
|
|
647
730
|
* <p>The display name of a resource selection document. Must contain 1 to 50 alphanumeric or
|
|
648
731
|
* '-_.' characters.</p>
|
|
649
732
|
*/
|
|
650
733
|
SelectionName: string | undefined;
|
|
651
734
|
/**
|
|
735
|
+
* @public
|
|
652
736
|
* <p>The ARN of the IAM role that Backup uses to authenticate when backing up the
|
|
653
737
|
* target resource; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
654
738
|
*/
|
|
655
739
|
IamRoleArn: string | undefined;
|
|
656
740
|
/**
|
|
741
|
+
* @public
|
|
657
742
|
* <p>A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of
|
|
658
743
|
* ARNs is 500 without wildcards, or 30 ARNs with wildcards.</p>
|
|
659
744
|
* <p>If you need to assign many resources to a backup plan, consider a different resource
|
|
@@ -662,6 +747,7 @@ export interface BackupSelection {
|
|
|
662
747
|
*/
|
|
663
748
|
Resources?: string[];
|
|
664
749
|
/**
|
|
750
|
+
* @public
|
|
665
751
|
* <p>A list of conditions that you define to assign resources to your backup plans using
|
|
666
752
|
* tags. For example, <code>"StringEquals": \{
|
|
667
753
|
* "ConditionKey": "aws:ResourceTag/CreatedByCryo",
|
|
@@ -686,6 +772,7 @@ export interface BackupSelection {
|
|
|
686
772
|
*/
|
|
687
773
|
ListOfTags?: Condition[];
|
|
688
774
|
/**
|
|
775
|
+
* @public
|
|
689
776
|
* <p>A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number
|
|
690
777
|
* of ARNs is 500 without wildcards, or 30 ARNs with wildcards.</p>
|
|
691
778
|
* <p>If you need to exclude many resources from a backup plan, consider a different resource
|
|
@@ -694,6 +781,7 @@ export interface BackupSelection {
|
|
|
694
781
|
*/
|
|
695
782
|
NotResources?: string[];
|
|
696
783
|
/**
|
|
784
|
+
* @public
|
|
697
785
|
* <p>A list of conditions that you define to assign resources to your backup plans using
|
|
698
786
|
* tags. For example, <code>"StringEquals": \{
|
|
699
787
|
* "ConditionKey": "aws:ResourceTag/CreatedByCryo",
|
|
@@ -724,18 +812,22 @@ export interface BackupSelection {
|
|
|
724
812
|
*/
|
|
725
813
|
export interface BackupSelectionsListMember {
|
|
726
814
|
/**
|
|
815
|
+
* @public
|
|
727
816
|
* <p>Uniquely identifies a request to assign a set of resources to a backup plan.</p>
|
|
728
817
|
*/
|
|
729
818
|
SelectionId?: string;
|
|
730
819
|
/**
|
|
820
|
+
* @public
|
|
731
821
|
* <p>The display name of a resource selection document.</p>
|
|
732
822
|
*/
|
|
733
823
|
SelectionName?: string;
|
|
734
824
|
/**
|
|
825
|
+
* @public
|
|
735
826
|
* <p>Uniquely identifies a backup plan.</p>
|
|
736
827
|
*/
|
|
737
828
|
BackupPlanId?: string;
|
|
738
829
|
/**
|
|
830
|
+
* @public
|
|
739
831
|
* <p>The date and time a backup plan is created, in Unix format and Coordinated Universal
|
|
740
832
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
741
833
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -743,12 +835,14 @@ export interface BackupSelectionsListMember {
|
|
|
743
835
|
*/
|
|
744
836
|
CreationDate?: Date;
|
|
745
837
|
/**
|
|
838
|
+
* @public
|
|
746
839
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
747
840
|
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
748
841
|
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
749
842
|
*/
|
|
750
843
|
CreatorRequestId?: string;
|
|
751
844
|
/**
|
|
845
|
+
* @public
|
|
752
846
|
* <p>Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point;
|
|
753
847
|
* for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
754
848
|
*/
|
|
@@ -787,6 +881,7 @@ export type BackupVaultEvent = (typeof BackupVaultEvent)[keyof typeof BackupVaul
|
|
|
787
881
|
*/
|
|
788
882
|
export interface BackupVaultListMember {
|
|
789
883
|
/**
|
|
884
|
+
* @public
|
|
790
885
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
791
886
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
792
887
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -794,11 +889,13 @@ export interface BackupVaultListMember {
|
|
|
794
889
|
*/
|
|
795
890
|
BackupVaultName?: string;
|
|
796
891
|
/**
|
|
892
|
+
* @public
|
|
797
893
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
798
894
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
799
895
|
*/
|
|
800
896
|
BackupVaultArn?: string;
|
|
801
897
|
/**
|
|
898
|
+
* @public
|
|
802
899
|
* <p>The date and time a resource backup is created, in Unix format and Coordinated Universal
|
|
803
900
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
804
901
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -806,6 +903,7 @@ export interface BackupVaultListMember {
|
|
|
806
903
|
*/
|
|
807
904
|
CreationDate?: Date;
|
|
808
905
|
/**
|
|
906
|
+
* @public
|
|
809
907
|
* <p>A server-side encryption key you can specify to encrypt your backups from services
|
|
810
908
|
* that support full Backup management; for example,
|
|
811
909
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
|
|
@@ -819,22 +917,26 @@ export interface BackupVaultListMember {
|
|
|
819
917
|
*/
|
|
820
918
|
EncryptionKeyArn?: string;
|
|
821
919
|
/**
|
|
920
|
+
* @public
|
|
822
921
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
823
922
|
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
824
923
|
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
825
924
|
*/
|
|
826
925
|
CreatorRequestId?: string;
|
|
827
926
|
/**
|
|
927
|
+
* @public
|
|
828
928
|
* <p>The number of recovery points that are stored in a backup vault.</p>
|
|
829
929
|
*/
|
|
830
930
|
NumberOfRecoveryPoints?: number;
|
|
831
931
|
/**
|
|
932
|
+
* @public
|
|
832
933
|
* <p>A Boolean value that indicates whether Backup Vault Lock applies to the
|
|
833
934
|
* selected backup vault. If <code>true</code>, Vault Lock prevents delete and update
|
|
834
935
|
* operations on the recovery points in the selected vault.</p>
|
|
835
936
|
*/
|
|
836
937
|
Locked?: boolean;
|
|
837
938
|
/**
|
|
939
|
+
* @public
|
|
838
940
|
* <p>The Backup Vault Lock setting that specifies the minimum retention period
|
|
839
941
|
* that the vault retains its recovery points. If this parameter is not specified, Vault Lock
|
|
840
942
|
* does not enforce a minimum retention period.</p>
|
|
@@ -847,6 +949,7 @@ export interface BackupVaultListMember {
|
|
|
847
949
|
*/
|
|
848
950
|
MinRetentionDays?: number;
|
|
849
951
|
/**
|
|
952
|
+
* @public
|
|
850
953
|
* <p>The Backup Vault Lock setting that specifies the maximum retention period
|
|
851
954
|
* that the vault retains its recovery points. If this parameter is not specified, Vault Lock
|
|
852
955
|
* does not enforce a maximum retention period on the recovery points in the vault (allowing
|
|
@@ -860,6 +963,7 @@ export interface BackupVaultListMember {
|
|
|
860
963
|
*/
|
|
861
964
|
MaxRetentionDays?: number;
|
|
862
965
|
/**
|
|
966
|
+
* @public
|
|
863
967
|
* <p>The date and time when Backup Vault Lock configuration becomes immutable,
|
|
864
968
|
* meaning it cannot be changed or deleted.</p>
|
|
865
969
|
* <p>If you applied Vault Lock to your vault without specifying a lock date, you can change
|
|
@@ -888,10 +992,12 @@ export interface BackupVaultListMember {
|
|
|
888
992
|
*/
|
|
889
993
|
export interface CalculatedLifecycle {
|
|
890
994
|
/**
|
|
995
|
+
* @public
|
|
891
996
|
* <p>A timestamp that specifies when to transition a recovery point to cold storage.</p>
|
|
892
997
|
*/
|
|
893
998
|
MoveToColdStorageAt?: Date;
|
|
894
999
|
/**
|
|
1000
|
+
* @public
|
|
895
1001
|
* <p>A timestamp that specifies when to delete a recovery point.</p>
|
|
896
1002
|
*/
|
|
897
1003
|
DeleteAt?: Date;
|
|
@@ -901,14 +1007,17 @@ export interface CalculatedLifecycle {
|
|
|
901
1007
|
*/
|
|
902
1008
|
export interface CancelLegalHoldInput {
|
|
903
1009
|
/**
|
|
1010
|
+
* @public
|
|
904
1011
|
* <p>Legal hold ID required to remove the specified legal hold on a recovery point.</p>
|
|
905
1012
|
*/
|
|
906
1013
|
LegalHoldId: string | undefined;
|
|
907
1014
|
/**
|
|
1015
|
+
* @public
|
|
908
1016
|
* <p>String describing the reason for removing the legal hold.</p>
|
|
909
1017
|
*/
|
|
910
1018
|
CancelDescription: string | undefined;
|
|
911
1019
|
/**
|
|
1020
|
+
* @public
|
|
912
1021
|
* <p>The integer amount in days specifying amount of days after this
|
|
913
1022
|
* API operation to remove legal hold.</p>
|
|
914
1023
|
*/
|
|
@@ -930,10 +1039,12 @@ export declare class InvalidParameterValueException extends __BaseException {
|
|
|
930
1039
|
Code?: string;
|
|
931
1040
|
Message?: string;
|
|
932
1041
|
/**
|
|
1042
|
+
* @public
|
|
933
1043
|
* <p></p>
|
|
934
1044
|
*/
|
|
935
1045
|
Type?: string;
|
|
936
1046
|
/**
|
|
1047
|
+
* @public
|
|
937
1048
|
* <p></p>
|
|
938
1049
|
*/
|
|
939
1050
|
Context?: string;
|
|
@@ -953,10 +1064,12 @@ export declare class InvalidResourceStateException extends __BaseException {
|
|
|
953
1064
|
Code?: string;
|
|
954
1065
|
Message?: string;
|
|
955
1066
|
/**
|
|
1067
|
+
* @public
|
|
956
1068
|
* <p></p>
|
|
957
1069
|
*/
|
|
958
1070
|
Type?: string;
|
|
959
1071
|
/**
|
|
1072
|
+
* @public
|
|
960
1073
|
* <p></p>
|
|
961
1074
|
*/
|
|
962
1075
|
Context?: string;
|
|
@@ -975,10 +1088,12 @@ export declare class MissingParameterValueException extends __BaseException {
|
|
|
975
1088
|
Code?: string;
|
|
976
1089
|
Message?: string;
|
|
977
1090
|
/**
|
|
1091
|
+
* @public
|
|
978
1092
|
* <p></p>
|
|
979
1093
|
*/
|
|
980
1094
|
Type?: string;
|
|
981
1095
|
/**
|
|
1096
|
+
* @public
|
|
982
1097
|
* <p></p>
|
|
983
1098
|
*/
|
|
984
1099
|
Context?: string;
|
|
@@ -997,10 +1112,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
997
1112
|
Code?: string;
|
|
998
1113
|
Message?: string;
|
|
999
1114
|
/**
|
|
1115
|
+
* @public
|
|
1000
1116
|
* <p></p>
|
|
1001
1117
|
*/
|
|
1002
1118
|
Type?: string;
|
|
1003
1119
|
/**
|
|
1120
|
+
* @public
|
|
1004
1121
|
* <p></p>
|
|
1005
1122
|
*/
|
|
1006
1123
|
Context?: string;
|
|
@@ -1019,10 +1136,12 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
1019
1136
|
Code?: string;
|
|
1020
1137
|
Message?: string;
|
|
1021
1138
|
/**
|
|
1139
|
+
* @public
|
|
1022
1140
|
* <p></p>
|
|
1023
1141
|
*/
|
|
1024
1142
|
Type?: string;
|
|
1025
1143
|
/**
|
|
1144
|
+
* @public
|
|
1026
1145
|
* <p></p>
|
|
1027
1146
|
*/
|
|
1028
1147
|
Context?: string;
|
|
@@ -1042,10 +1161,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
1042
1161
|
Code?: string;
|
|
1043
1162
|
Message?: string;
|
|
1044
1163
|
/**
|
|
1164
|
+
* @public
|
|
1045
1165
|
* <p></p>
|
|
1046
1166
|
*/
|
|
1047
1167
|
Type?: string;
|
|
1048
1168
|
/**
|
|
1169
|
+
* @public
|
|
1049
1170
|
* <p></p>
|
|
1050
1171
|
*/
|
|
1051
1172
|
Context?: string;
|
|
@@ -1063,10 +1184,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
1063
1184
|
*/
|
|
1064
1185
|
export interface ControlInputParameter {
|
|
1065
1186
|
/**
|
|
1187
|
+
* @public
|
|
1066
1188
|
* <p>The name of a parameter, for example, <code>BackupPlanFrequency</code>.</p>
|
|
1067
1189
|
*/
|
|
1068
1190
|
ParameterName?: string;
|
|
1069
1191
|
/**
|
|
1192
|
+
* @public
|
|
1070
1193
|
* <p>The value of parameter, for example, <code>hourly</code>.</p>
|
|
1071
1194
|
*/
|
|
1072
1195
|
ParameterValue?: string;
|
|
@@ -1086,16 +1209,19 @@ export interface ControlInputParameter {
|
|
|
1086
1209
|
*/
|
|
1087
1210
|
export interface ControlScope {
|
|
1088
1211
|
/**
|
|
1212
|
+
* @public
|
|
1089
1213
|
* <p>The ID of the only Amazon Web Services resource that you want your control scope to
|
|
1090
1214
|
* contain.</p>
|
|
1091
1215
|
*/
|
|
1092
1216
|
ComplianceResourceIds?: string[];
|
|
1093
1217
|
/**
|
|
1218
|
+
* @public
|
|
1094
1219
|
* <p>Describes whether the control scope includes one or more types of resources, such as
|
|
1095
1220
|
* <code>EFS</code> or <code>RDS</code>.</p>
|
|
1096
1221
|
*/
|
|
1097
1222
|
ComplianceResourceTypes?: string[];
|
|
1098
1223
|
/**
|
|
1224
|
+
* @public
|
|
1099
1225
|
* <p>The tag key-value pair applied to those Amazon Web Services resources that you want to
|
|
1100
1226
|
* trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag
|
|
1101
1227
|
* value is optional, but it cannot be an empty string. The structure to assign a tag is:
|
|
@@ -1124,89 +1250,107 @@ export type CopyJobState = (typeof CopyJobState)[keyof typeof CopyJobState];
|
|
|
1124
1250
|
*/
|
|
1125
1251
|
export interface CopyJob {
|
|
1126
1252
|
/**
|
|
1253
|
+
* @public
|
|
1127
1254
|
* <p>The account ID that owns the copy job.</p>
|
|
1128
1255
|
*/
|
|
1129
1256
|
AccountId?: string;
|
|
1130
1257
|
/**
|
|
1258
|
+
* @public
|
|
1131
1259
|
* <p>Uniquely identifies a copy job.</p>
|
|
1132
1260
|
*/
|
|
1133
1261
|
CopyJobId?: string;
|
|
1134
1262
|
/**
|
|
1263
|
+
* @public
|
|
1135
1264
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example,
|
|
1136
1265
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>. </p>
|
|
1137
1266
|
*/
|
|
1138
1267
|
SourceBackupVaultArn?: string;
|
|
1139
1268
|
/**
|
|
1269
|
+
* @public
|
|
1140
1270
|
* <p>An ARN that uniquely identifies a source recovery point; for example,
|
|
1141
1271
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
1142
1272
|
*/
|
|
1143
1273
|
SourceRecoveryPointArn?: string;
|
|
1144
1274
|
/**
|
|
1275
|
+
* @public
|
|
1145
1276
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for
|
|
1146
1277
|
* example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
1147
1278
|
*/
|
|
1148
1279
|
DestinationBackupVaultArn?: string;
|
|
1149
1280
|
/**
|
|
1281
|
+
* @public
|
|
1150
1282
|
* <p>An ARN that uniquely identifies a destination recovery point; for example,
|
|
1151
1283
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
1152
1284
|
*/
|
|
1153
1285
|
DestinationRecoveryPointArn?: string;
|
|
1154
1286
|
/**
|
|
1287
|
+
* @public
|
|
1155
1288
|
* <p>The Amazon Web Services resource to be copied; for example, an Amazon Elastic Block Store
|
|
1156
1289
|
* (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)
|
|
1157
1290
|
* database.</p>
|
|
1158
1291
|
*/
|
|
1159
1292
|
ResourceArn?: string;
|
|
1160
1293
|
/**
|
|
1294
|
+
* @public
|
|
1161
1295
|
* <p>The date and time a copy job is created, in Unix format and Coordinated Universal Time
|
|
1162
1296
|
* (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the
|
|
1163
1297
|
* value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1164
1298
|
*/
|
|
1165
1299
|
CreationDate?: Date;
|
|
1166
1300
|
/**
|
|
1301
|
+
* @public
|
|
1167
1302
|
* <p>The date and time a copy job is completed, in Unix format and Coordinated Universal Time
|
|
1168
1303
|
* (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example,
|
|
1169
1304
|
* the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
|
|
1170
1305
|
*/
|
|
1171
1306
|
CompletionDate?: Date;
|
|
1172
1307
|
/**
|
|
1308
|
+
* @public
|
|
1173
1309
|
* <p>The current state of a copy job.</p>
|
|
1174
1310
|
*/
|
|
1175
1311
|
State?: CopyJobState | string;
|
|
1176
1312
|
/**
|
|
1313
|
+
* @public
|
|
1177
1314
|
* <p>A detailed message explaining the status of the job to copy a resource.</p>
|
|
1178
1315
|
*/
|
|
1179
1316
|
StatusMessage?: string;
|
|
1180
1317
|
/**
|
|
1318
|
+
* @public
|
|
1181
1319
|
* <p>The size, in bytes, of a copy job.</p>
|
|
1182
1320
|
*/
|
|
1183
1321
|
BackupSizeInBytes?: number;
|
|
1184
1322
|
/**
|
|
1323
|
+
* @public
|
|
1185
1324
|
* <p>Specifies the IAM role ARN used to copy the target recovery point; for example,
|
|
1186
1325
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
1187
1326
|
*/
|
|
1188
1327
|
IamRoleArn?: string;
|
|
1189
1328
|
/**
|
|
1329
|
+
* @public
|
|
1190
1330
|
* <p>Contains information about the backup plan and rule that Backup used to
|
|
1191
1331
|
* initiate the recovery point backup.</p>
|
|
1192
1332
|
*/
|
|
1193
1333
|
CreatedBy?: RecoveryPointCreator;
|
|
1194
1334
|
/**
|
|
1335
|
+
* @public
|
|
1195
1336
|
* <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>
|
|
1196
1337
|
*/
|
|
1197
1338
|
ResourceType?: string;
|
|
1198
1339
|
/**
|
|
1340
|
+
* @public
|
|
1199
1341
|
* <p>This uniquely identifies a request to Backup
|
|
1200
1342
|
* to copy a resource. The return will be the
|
|
1201
1343
|
* parent (composite) job ID.</p>
|
|
1202
1344
|
*/
|
|
1203
1345
|
ParentJobId?: string;
|
|
1204
1346
|
/**
|
|
1347
|
+
* @public
|
|
1205
1348
|
* <p>This is a boolean value indicating this is
|
|
1206
1349
|
* a parent (composite) copy job.</p>
|
|
1207
1350
|
*/
|
|
1208
1351
|
IsParent?: boolean;
|
|
1209
1352
|
/**
|
|
1353
|
+
* @public
|
|
1210
1354
|
* <p>This is the identifier of a resource within a composite group, such as
|
|
1211
1355
|
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
1212
1356
|
* ID is transferred from
|
|
@@ -1215,15 +1359,18 @@ export interface CopyJob {
|
|
|
1215
1359
|
*/
|
|
1216
1360
|
CompositeMemberIdentifier?: string;
|
|
1217
1361
|
/**
|
|
1362
|
+
* @public
|
|
1218
1363
|
* <p>This is the number of child (nested) copy jobs.</p>
|
|
1219
1364
|
*/
|
|
1220
1365
|
NumberOfChildJobs?: number;
|
|
1221
1366
|
/**
|
|
1367
|
+
* @public
|
|
1222
1368
|
* <p>This returns the statistics of the included
|
|
1223
1369
|
* child (nested) copy jobs.</p>
|
|
1224
1370
|
*/
|
|
1225
1371
|
ChildJobsInState?: Record<string, number>;
|
|
1226
1372
|
/**
|
|
1373
|
+
* @public
|
|
1227
1374
|
* <p>This is the non-unique name of the resource that
|
|
1228
1375
|
* belongs to the specified backup.</p>
|
|
1229
1376
|
*/
|
|
@@ -1234,17 +1381,20 @@ export interface CopyJob {
|
|
|
1234
1381
|
*/
|
|
1235
1382
|
export interface CreateBackupPlanInput {
|
|
1236
1383
|
/**
|
|
1384
|
+
* @public
|
|
1237
1385
|
* <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or
|
|
1238
1386
|
* more sets of <code>Rules</code>.</p>
|
|
1239
1387
|
*/
|
|
1240
1388
|
BackupPlan: BackupPlanInput | undefined;
|
|
1241
1389
|
/**
|
|
1390
|
+
* @public
|
|
1242
1391
|
* <p>To help organize your resources, you can assign your own metadata to the resources that
|
|
1243
1392
|
* you create. Each tag is a key-value pair. The specified tags are assigned to all backups
|
|
1244
1393
|
* created with this plan.</p>
|
|
1245
1394
|
*/
|
|
1246
1395
|
BackupPlanTags?: Record<string, string>;
|
|
1247
1396
|
/**
|
|
1397
|
+
* @public
|
|
1248
1398
|
* <p>Identifies the request and allows failed requests to be retried without the risk of
|
|
1249
1399
|
* running the operation twice. If the request includes a <code>CreatorRequestId</code> that
|
|
1250
1400
|
* matches an existing backup plan, that plan is returned. This parameter is optional.</p>
|
|
@@ -1257,15 +1407,18 @@ export interface CreateBackupPlanInput {
|
|
|
1257
1407
|
*/
|
|
1258
1408
|
export interface CreateBackupPlanOutput {
|
|
1259
1409
|
/**
|
|
1410
|
+
* @public
|
|
1260
1411
|
* <p>Uniquely identifies a backup plan.</p>
|
|
1261
1412
|
*/
|
|
1262
1413
|
BackupPlanId?: string;
|
|
1263
1414
|
/**
|
|
1415
|
+
* @public
|
|
1264
1416
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
1265
1417
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
1266
1418
|
*/
|
|
1267
1419
|
BackupPlanArn?: string;
|
|
1268
1420
|
/**
|
|
1421
|
+
* @public
|
|
1269
1422
|
* <p>The date and time that a backup plan is created, in Unix format and Coordinated
|
|
1270
1423
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
1271
1424
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1273,11 +1426,13 @@ export interface CreateBackupPlanOutput {
|
|
|
1273
1426
|
*/
|
|
1274
1427
|
CreationDate?: Date;
|
|
1275
1428
|
/**
|
|
1429
|
+
* @public
|
|
1276
1430
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
1277
1431
|
* long. They cannot be edited.</p>
|
|
1278
1432
|
*/
|
|
1279
1433
|
VersionId?: string;
|
|
1280
1434
|
/**
|
|
1435
|
+
* @public
|
|
1281
1436
|
* <p>A list of <code>BackupOptions</code> settings for a resource type. This option is only
|
|
1282
1437
|
* available for Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
|
|
1283
1438
|
*/
|
|
@@ -1294,10 +1449,12 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1294
1449
|
Code?: string;
|
|
1295
1450
|
Message?: string;
|
|
1296
1451
|
/**
|
|
1452
|
+
* @public
|
|
1297
1453
|
* <p></p>
|
|
1298
1454
|
*/
|
|
1299
1455
|
Type?: string;
|
|
1300
1456
|
/**
|
|
1457
|
+
* @public
|
|
1301
1458
|
* <p></p>
|
|
1302
1459
|
*/
|
|
1303
1460
|
Context?: string;
|
|
@@ -1311,15 +1468,18 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
1311
1468
|
*/
|
|
1312
1469
|
export interface CreateBackupSelectionInput {
|
|
1313
1470
|
/**
|
|
1471
|
+
* @public
|
|
1314
1472
|
* <p>Uniquely identifies the backup plan to be associated with the selection of
|
|
1315
1473
|
* resources.</p>
|
|
1316
1474
|
*/
|
|
1317
1475
|
BackupPlanId: string | undefined;
|
|
1318
1476
|
/**
|
|
1477
|
+
* @public
|
|
1319
1478
|
* <p>Specifies the body of a request to assign a set of resources to a backup plan.</p>
|
|
1320
1479
|
*/
|
|
1321
1480
|
BackupSelection: BackupSelection | undefined;
|
|
1322
1481
|
/**
|
|
1482
|
+
* @public
|
|
1323
1483
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
1324
1484
|
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
1325
1485
|
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
@@ -1331,15 +1491,18 @@ export interface CreateBackupSelectionInput {
|
|
|
1331
1491
|
*/
|
|
1332
1492
|
export interface CreateBackupSelectionOutput {
|
|
1333
1493
|
/**
|
|
1494
|
+
* @public
|
|
1334
1495
|
* <p>Uniquely identifies the body of a request to assign a set of resources to a backup
|
|
1335
1496
|
* plan.</p>
|
|
1336
1497
|
*/
|
|
1337
1498
|
SelectionId?: string;
|
|
1338
1499
|
/**
|
|
1500
|
+
* @public
|
|
1339
1501
|
* <p>Uniquely identifies a backup plan.</p>
|
|
1340
1502
|
*/
|
|
1341
1503
|
BackupPlanId?: string;
|
|
1342
1504
|
/**
|
|
1505
|
+
* @public
|
|
1343
1506
|
* <p>The date and time a backup selection is created, in Unix format and Coordinated
|
|
1344
1507
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
1345
1508
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1352,22 +1515,26 @@ export interface CreateBackupSelectionOutput {
|
|
|
1352
1515
|
*/
|
|
1353
1516
|
export interface CreateBackupVaultInput {
|
|
1354
1517
|
/**
|
|
1518
|
+
* @public
|
|
1355
1519
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1356
1520
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
1357
1521
|
* Region where they are created. They consist of letters, numbers, and hyphens.</p>
|
|
1358
1522
|
*/
|
|
1359
1523
|
BackupVaultName: string | undefined;
|
|
1360
1524
|
/**
|
|
1525
|
+
* @public
|
|
1361
1526
|
* <p>Metadata that you can assign to help organize the resources that you create. Each tag is
|
|
1362
1527
|
* a key-value pair.</p>
|
|
1363
1528
|
*/
|
|
1364
1529
|
BackupVaultTags?: Record<string, string>;
|
|
1365
1530
|
/**
|
|
1531
|
+
* @public
|
|
1366
1532
|
* <p>The server-side encryption key that is used to protect your backups; for example,
|
|
1367
1533
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
1368
1534
|
*/
|
|
1369
1535
|
EncryptionKeyArn?: string;
|
|
1370
1536
|
/**
|
|
1537
|
+
* @public
|
|
1371
1538
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
1372
1539
|
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
1373
1540
|
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
@@ -1379,17 +1546,20 @@ export interface CreateBackupVaultInput {
|
|
|
1379
1546
|
*/
|
|
1380
1547
|
export interface CreateBackupVaultOutput {
|
|
1381
1548
|
/**
|
|
1549
|
+
* @public
|
|
1382
1550
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1383
1551
|
* by names that are unique to the account used to create them and the Region where they are
|
|
1384
1552
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
1385
1553
|
*/
|
|
1386
1554
|
BackupVaultName?: string;
|
|
1387
1555
|
/**
|
|
1556
|
+
* @public
|
|
1388
1557
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
1389
1558
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
1390
1559
|
*/
|
|
1391
1560
|
BackupVaultArn?: string;
|
|
1392
1561
|
/**
|
|
1562
|
+
* @public
|
|
1393
1563
|
* <p>The date and time a backup vault is created, in Unix format and Coordinated Universal
|
|
1394
1564
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
1395
1565
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1404,14 +1574,17 @@ export interface CreateBackupVaultOutput {
|
|
|
1404
1574
|
*/
|
|
1405
1575
|
export interface FrameworkControl {
|
|
1406
1576
|
/**
|
|
1577
|
+
* @public
|
|
1407
1578
|
* <p>The name of a control. This name is between 1 and 256 characters.</p>
|
|
1408
1579
|
*/
|
|
1409
1580
|
ControlName: string | undefined;
|
|
1410
1581
|
/**
|
|
1582
|
+
* @public
|
|
1411
1583
|
* <p>A list of <code>ParameterName</code> and <code>ParameterValue</code> pairs.</p>
|
|
1412
1584
|
*/
|
|
1413
1585
|
ControlInputParameters?: ControlInputParameter[];
|
|
1414
1586
|
/**
|
|
1587
|
+
* @public
|
|
1415
1588
|
* <p>The scope of a control. The control scope defines what the control will evaluate. Three
|
|
1416
1589
|
* examples of control scopes are: a specific backup plan, all backup plans with a specific
|
|
1417
1590
|
* tag, or all backup plans. For more information, see <a href="aws-backup/latest/devguide/API_ControlScope.html">
|
|
@@ -1425,27 +1598,32 @@ export interface FrameworkControl {
|
|
|
1425
1598
|
*/
|
|
1426
1599
|
export interface CreateFrameworkInput {
|
|
1427
1600
|
/**
|
|
1601
|
+
* @public
|
|
1428
1602
|
* <p>The unique name of the framework. The name must be between 1 and 256 characters,
|
|
1429
1603
|
* starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and
|
|
1430
1604
|
* underscores (_).</p>
|
|
1431
1605
|
*/
|
|
1432
1606
|
FrameworkName: string | undefined;
|
|
1433
1607
|
/**
|
|
1608
|
+
* @public
|
|
1434
1609
|
* <p>An optional description of the framework with a maximum of 1,024 characters.</p>
|
|
1435
1610
|
*/
|
|
1436
1611
|
FrameworkDescription?: string;
|
|
1437
1612
|
/**
|
|
1613
|
+
* @public
|
|
1438
1614
|
* <p>A list of the controls that make up the framework. Each control in the list has a name,
|
|
1439
1615
|
* input parameters, and scope.</p>
|
|
1440
1616
|
*/
|
|
1441
1617
|
FrameworkControls: FrameworkControl[] | undefined;
|
|
1442
1618
|
/**
|
|
1619
|
+
* @public
|
|
1443
1620
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
1444
1621
|
* calls to <code>CreateFrameworkInput</code>. Retrying a successful request with the same
|
|
1445
1622
|
* idempotency token results in a success message with no action taken.</p>
|
|
1446
1623
|
*/
|
|
1447
1624
|
IdempotencyToken?: string;
|
|
1448
1625
|
/**
|
|
1626
|
+
* @public
|
|
1449
1627
|
* <p>Metadata that you can assign to help organize the frameworks that you create. Each tag
|
|
1450
1628
|
* is a key-value pair.</p>
|
|
1451
1629
|
*/
|
|
@@ -1456,12 +1634,14 @@ export interface CreateFrameworkInput {
|
|
|
1456
1634
|
*/
|
|
1457
1635
|
export interface CreateFrameworkOutput {
|
|
1458
1636
|
/**
|
|
1637
|
+
* @public
|
|
1459
1638
|
* <p>The unique name of the framework. The name must be between 1 and 256 characters,
|
|
1460
1639
|
* starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and
|
|
1461
1640
|
* underscores (_).</p>
|
|
1462
1641
|
*/
|
|
1463
1642
|
FrameworkName?: string;
|
|
1464
1643
|
/**
|
|
1644
|
+
* @public
|
|
1465
1645
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
1466
1646
|
* depends on the resource type.</p>
|
|
1467
1647
|
*/
|
|
@@ -1480,6 +1660,7 @@ export interface CreateFrameworkOutput {
|
|
|
1480
1660
|
*/
|
|
1481
1661
|
export interface DateRange {
|
|
1482
1662
|
/**
|
|
1663
|
+
* @public
|
|
1483
1664
|
* <p>This value is the beginning date, inclusive.</p>
|
|
1484
1665
|
* <p>The date and time are in Unix format and Coordinated
|
|
1485
1666
|
* Universal Time (UTC), and it is accurate to milliseconds
|
|
@@ -1487,6 +1668,7 @@ export interface DateRange {
|
|
|
1487
1668
|
*/
|
|
1488
1669
|
FromDate: Date | undefined;
|
|
1489
1670
|
/**
|
|
1671
|
+
* @public
|
|
1490
1672
|
* <p>This value is the end date, inclusive.</p>
|
|
1491
1673
|
* <p>The date and time are in Unix format and Coordinated
|
|
1492
1674
|
* Universal Time (UTC), and it is accurate to milliseconds
|
|
@@ -1501,16 +1683,19 @@ export interface DateRange {
|
|
|
1501
1683
|
*/
|
|
1502
1684
|
export interface RecoveryPointSelection {
|
|
1503
1685
|
/**
|
|
1686
|
+
* @public
|
|
1504
1687
|
* <p>These are the names of the vaults in which the selected
|
|
1505
1688
|
* recovery points are contained.</p>
|
|
1506
1689
|
*/
|
|
1507
1690
|
VaultNames?: string[];
|
|
1508
1691
|
/**
|
|
1692
|
+
* @public
|
|
1509
1693
|
* <p>These are the resources included in the resource selection
|
|
1510
1694
|
* (including type of resources and vaults).</p>
|
|
1511
1695
|
*/
|
|
1512
1696
|
ResourceIdentifiers?: string[];
|
|
1513
1697
|
/**
|
|
1698
|
+
* @public
|
|
1514
1699
|
* <p>This is a resource filter containing FromDate: DateTime
|
|
1515
1700
|
* and ToDate: DateTime. Both values are required. Future DateTime
|
|
1516
1701
|
* values are not permitted.</p>
|
|
@@ -1527,25 +1712,30 @@ export interface RecoveryPointSelection {
|
|
|
1527
1712
|
*/
|
|
1528
1713
|
export interface CreateLegalHoldInput {
|
|
1529
1714
|
/**
|
|
1715
|
+
* @public
|
|
1530
1716
|
* <p>This is the string title of the legal hold.</p>
|
|
1531
1717
|
*/
|
|
1532
1718
|
Title: string | undefined;
|
|
1533
1719
|
/**
|
|
1720
|
+
* @public
|
|
1534
1721
|
* <p>This is the string description of the legal hold.</p>
|
|
1535
1722
|
*/
|
|
1536
1723
|
Description: string | undefined;
|
|
1537
1724
|
/**
|
|
1725
|
+
* @public
|
|
1538
1726
|
* <p>This is a user-chosen string used to distinguish between otherwise identical
|
|
1539
1727
|
* calls. Retrying a successful request with the
|
|
1540
1728
|
* same idempotency token results in a success message with no action taken.</p>
|
|
1541
1729
|
*/
|
|
1542
1730
|
IdempotencyToken?: string;
|
|
1543
1731
|
/**
|
|
1732
|
+
* @public
|
|
1544
1733
|
* <p>This specifies criteria to assign
|
|
1545
1734
|
* a set of resources, such as resource types or backup vaults.</p>
|
|
1546
1735
|
*/
|
|
1547
1736
|
RecoveryPointSelection?: RecoveryPointSelection;
|
|
1548
1737
|
/**
|
|
1738
|
+
* @public
|
|
1549
1739
|
* <p>Optional tags to include. A tag is a key-value pair you can use to manage,
|
|
1550
1740
|
* filter, and search for your resources. Allowed characters include UTF-8 letters,
|
|
1551
1741
|
* numbers, spaces, and the following characters: + - = . _ : /. </p>
|
|
@@ -1571,32 +1761,39 @@ export type LegalHoldStatus = (typeof LegalHoldStatus)[keyof typeof LegalHoldSta
|
|
|
1571
1761
|
*/
|
|
1572
1762
|
export interface CreateLegalHoldOutput {
|
|
1573
1763
|
/**
|
|
1764
|
+
* @public
|
|
1574
1765
|
* <p>This is the string title of the legal hold returned after creating the legal hold.</p>
|
|
1575
1766
|
*/
|
|
1576
1767
|
Title?: string;
|
|
1577
1768
|
/**
|
|
1769
|
+
* @public
|
|
1578
1770
|
* <p>This displays the status of the legal hold returned after creating the legal hold.
|
|
1579
1771
|
* Statuses can be <code>ACTIVE</code>, <code>PENDING</code>, <code>CANCELED</code>,
|
|
1580
1772
|
* <code>CANCELING</code>, or <code>FAILED</code>.</p>
|
|
1581
1773
|
*/
|
|
1582
1774
|
Status?: LegalHoldStatus | string;
|
|
1583
1775
|
/**
|
|
1776
|
+
* @public
|
|
1584
1777
|
* <p>This is the returned string description of the legal hold.</p>
|
|
1585
1778
|
*/
|
|
1586
1779
|
Description?: string;
|
|
1587
1780
|
/**
|
|
1781
|
+
* @public
|
|
1588
1782
|
* <p>Legal hold ID returned for the specified legal hold on a recovery point.</p>
|
|
1589
1783
|
*/
|
|
1590
1784
|
LegalHoldId?: string;
|
|
1591
1785
|
/**
|
|
1786
|
+
* @public
|
|
1592
1787
|
* <p>This is the ARN (Amazon Resource Number) of the created legal hold.</p>
|
|
1593
1788
|
*/
|
|
1594
1789
|
LegalHoldArn?: string;
|
|
1595
1790
|
/**
|
|
1791
|
+
* @public
|
|
1596
1792
|
* <p>Time in number format when legal hold was created.</p>
|
|
1597
1793
|
*/
|
|
1598
1794
|
CreationDate?: Date;
|
|
1599
1795
|
/**
|
|
1796
|
+
* @public
|
|
1600
1797
|
* <p>This specifies criteria to assign
|
|
1601
1798
|
* a set of resources, such as resource types or backup vaults.</p>
|
|
1602
1799
|
*/
|
|
@@ -1610,16 +1807,19 @@ export interface CreateLegalHoldOutput {
|
|
|
1610
1807
|
*/
|
|
1611
1808
|
export interface ReportDeliveryChannel {
|
|
1612
1809
|
/**
|
|
1810
|
+
* @public
|
|
1613
1811
|
* <p>The unique name of the S3 bucket that receives your reports.</p>
|
|
1614
1812
|
*/
|
|
1615
1813
|
S3BucketName: string | undefined;
|
|
1616
1814
|
/**
|
|
1815
|
+
* @public
|
|
1617
1816
|
* <p>The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path:
|
|
1618
1817
|
* s3://your-bucket-name/<code>prefix</code>/Backup/us-west-2/year/month/day/report-name.
|
|
1619
1818
|
* If not specified, there is no prefix.</p>
|
|
1620
1819
|
*/
|
|
1621
1820
|
S3KeyPrefix?: string;
|
|
1622
1821
|
/**
|
|
1822
|
+
* @public
|
|
1623
1823
|
* <p>A list of the format of your reports: <code>CSV</code>, <code>JSON</code>, or both. If
|
|
1624
1824
|
* not specified, the default format is <code>CSV</code>.</p>
|
|
1625
1825
|
*/
|
|
@@ -1631,6 +1831,7 @@ export interface ReportDeliveryChannel {
|
|
|
1631
1831
|
*/
|
|
1632
1832
|
export interface ReportSetting {
|
|
1633
1833
|
/**
|
|
1834
|
+
* @public
|
|
1634
1835
|
* <p>Identifies the report template for the report. Reports are built using a report
|
|
1635
1836
|
* template. The report templates are:</p>
|
|
1636
1837
|
* <p>
|
|
@@ -1640,22 +1841,27 @@ export interface ReportSetting {
|
|
|
1640
1841
|
*/
|
|
1641
1842
|
ReportTemplate: string | undefined;
|
|
1642
1843
|
/**
|
|
1844
|
+
* @public
|
|
1643
1845
|
* <p>The Amazon Resource Names (ARNs) of the frameworks a report covers.</p>
|
|
1644
1846
|
*/
|
|
1645
1847
|
FrameworkArns?: string[];
|
|
1646
1848
|
/**
|
|
1849
|
+
* @public
|
|
1647
1850
|
* <p>The number of frameworks a report covers.</p>
|
|
1648
1851
|
*/
|
|
1649
1852
|
NumberOfFrameworks?: number;
|
|
1650
1853
|
/**
|
|
1854
|
+
* @public
|
|
1651
1855
|
* <p>These are the accounts to be included in the report.</p>
|
|
1652
1856
|
*/
|
|
1653
1857
|
Accounts?: string[];
|
|
1654
1858
|
/**
|
|
1859
|
+
* @public
|
|
1655
1860
|
* <p>These are the Organizational Units to be included in the report.</p>
|
|
1656
1861
|
*/
|
|
1657
1862
|
OrganizationUnits?: string[];
|
|
1658
1863
|
/**
|
|
1864
|
+
* @public
|
|
1659
1865
|
* <p>These are the Regions to be included in the report.</p>
|
|
1660
1866
|
*/
|
|
1661
1867
|
Regions?: string[];
|
|
@@ -1665,22 +1871,26 @@ export interface ReportSetting {
|
|
|
1665
1871
|
*/
|
|
1666
1872
|
export interface CreateReportPlanInput {
|
|
1667
1873
|
/**
|
|
1874
|
+
* @public
|
|
1668
1875
|
* <p>The unique name of the report plan. The name must be between 1 and 256 characters,
|
|
1669
1876
|
* starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and
|
|
1670
1877
|
* underscores (_).</p>
|
|
1671
1878
|
*/
|
|
1672
1879
|
ReportPlanName: string | undefined;
|
|
1673
1880
|
/**
|
|
1881
|
+
* @public
|
|
1674
1882
|
* <p>An optional description of the report plan with a maximum of 1,024 characters.</p>
|
|
1675
1883
|
*/
|
|
1676
1884
|
ReportPlanDescription?: string;
|
|
1677
1885
|
/**
|
|
1886
|
+
* @public
|
|
1678
1887
|
* <p>A structure that contains information about where and how to deliver your reports,
|
|
1679
1888
|
* specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your
|
|
1680
1889
|
* reports.</p>
|
|
1681
1890
|
*/
|
|
1682
1891
|
ReportDeliveryChannel: ReportDeliveryChannel | undefined;
|
|
1683
1892
|
/**
|
|
1893
|
+
* @public
|
|
1684
1894
|
* <p>Identifies the report template for the report. Reports are built using a report
|
|
1685
1895
|
* template. The report templates are:</p>
|
|
1686
1896
|
* <p>
|
|
@@ -1693,11 +1903,13 @@ export interface CreateReportPlanInput {
|
|
|
1693
1903
|
*/
|
|
1694
1904
|
ReportSetting: ReportSetting | undefined;
|
|
1695
1905
|
/**
|
|
1906
|
+
* @public
|
|
1696
1907
|
* <p>Metadata that you can assign to help organize the report plans that you create. Each tag
|
|
1697
1908
|
* is a key-value pair.</p>
|
|
1698
1909
|
*/
|
|
1699
1910
|
ReportPlanTags?: Record<string, string>;
|
|
1700
1911
|
/**
|
|
1912
|
+
* @public
|
|
1701
1913
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
1702
1914
|
* calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same
|
|
1703
1915
|
* idempotency token results in a success message with no action taken.</p>
|
|
@@ -1709,15 +1921,18 @@ export interface CreateReportPlanInput {
|
|
|
1709
1921
|
*/
|
|
1710
1922
|
export interface CreateReportPlanOutput {
|
|
1711
1923
|
/**
|
|
1924
|
+
* @public
|
|
1712
1925
|
* <p>The unique name of the report plan.</p>
|
|
1713
1926
|
*/
|
|
1714
1927
|
ReportPlanName?: string;
|
|
1715
1928
|
/**
|
|
1929
|
+
* @public
|
|
1716
1930
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
1717
1931
|
* depends on the resource type.</p>
|
|
1718
1932
|
*/
|
|
1719
1933
|
ReportPlanArn?: string;
|
|
1720
1934
|
/**
|
|
1935
|
+
* @public
|
|
1721
1936
|
* <p>The date and time a backup vault is created, in Unix format and Coordinated Universal
|
|
1722
1937
|
* Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For
|
|
1723
1938
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1730,6 +1945,7 @@ export interface CreateReportPlanOutput {
|
|
|
1730
1945
|
*/
|
|
1731
1946
|
export interface DeleteBackupPlanInput {
|
|
1732
1947
|
/**
|
|
1948
|
+
* @public
|
|
1733
1949
|
* <p>Uniquely identifies a backup plan.</p>
|
|
1734
1950
|
*/
|
|
1735
1951
|
BackupPlanId: string | undefined;
|
|
@@ -1739,15 +1955,18 @@ export interface DeleteBackupPlanInput {
|
|
|
1739
1955
|
*/
|
|
1740
1956
|
export interface DeleteBackupPlanOutput {
|
|
1741
1957
|
/**
|
|
1958
|
+
* @public
|
|
1742
1959
|
* <p>Uniquely identifies a backup plan.</p>
|
|
1743
1960
|
*/
|
|
1744
1961
|
BackupPlanId?: string;
|
|
1745
1962
|
/**
|
|
1963
|
+
* @public
|
|
1746
1964
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
1747
1965
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
1748
1966
|
*/
|
|
1749
1967
|
BackupPlanArn?: string;
|
|
1750
1968
|
/**
|
|
1969
|
+
* @public
|
|
1751
1970
|
* <p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal
|
|
1752
1971
|
* Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For
|
|
1753
1972
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1755,6 +1974,7 @@ export interface DeleteBackupPlanOutput {
|
|
|
1755
1974
|
*/
|
|
1756
1975
|
DeletionDate?: Date;
|
|
1757
1976
|
/**
|
|
1977
|
+
* @public
|
|
1758
1978
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
1759
1979
|
* long. Version IDs cannot be edited.</p>
|
|
1760
1980
|
*/
|
|
@@ -1771,10 +1991,12 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1771
1991
|
Code?: string;
|
|
1772
1992
|
Message?: string;
|
|
1773
1993
|
/**
|
|
1994
|
+
* @public
|
|
1774
1995
|
* <p></p>
|
|
1775
1996
|
*/
|
|
1776
1997
|
Type?: string;
|
|
1777
1998
|
/**
|
|
1999
|
+
* @public
|
|
1778
2000
|
* <p></p>
|
|
1779
2001
|
*/
|
|
1780
2002
|
Context?: string;
|
|
@@ -1788,10 +2010,12 @@ export declare class InvalidRequestException extends __BaseException {
|
|
|
1788
2010
|
*/
|
|
1789
2011
|
export interface DeleteBackupSelectionInput {
|
|
1790
2012
|
/**
|
|
2013
|
+
* @public
|
|
1791
2014
|
* <p>Uniquely identifies a backup plan.</p>
|
|
1792
2015
|
*/
|
|
1793
2016
|
BackupPlanId: string | undefined;
|
|
1794
2017
|
/**
|
|
2018
|
+
* @public
|
|
1795
2019
|
* <p>Uniquely identifies the body of a request to assign a set of resources to a backup
|
|
1796
2020
|
* plan.</p>
|
|
1797
2021
|
*/
|
|
@@ -1802,6 +2026,7 @@ export interface DeleteBackupSelectionInput {
|
|
|
1802
2026
|
*/
|
|
1803
2027
|
export interface DeleteBackupVaultInput {
|
|
1804
2028
|
/**
|
|
2029
|
+
* @public
|
|
1805
2030
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1806
2031
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
1807
2032
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -1814,6 +2039,7 @@ export interface DeleteBackupVaultInput {
|
|
|
1814
2039
|
*/
|
|
1815
2040
|
export interface DeleteBackupVaultAccessPolicyInput {
|
|
1816
2041
|
/**
|
|
2042
|
+
* @public
|
|
1817
2043
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1818
2044
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
1819
2045
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -1826,6 +2052,7 @@ export interface DeleteBackupVaultAccessPolicyInput {
|
|
|
1826
2052
|
*/
|
|
1827
2053
|
export interface DeleteBackupVaultLockConfigurationInput {
|
|
1828
2054
|
/**
|
|
2055
|
+
* @public
|
|
1829
2056
|
* <p>The name of the backup vault from which to delete Backup Vault Lock.</p>
|
|
1830
2057
|
*/
|
|
1831
2058
|
BackupVaultName: string | undefined;
|
|
@@ -1835,6 +2062,7 @@ export interface DeleteBackupVaultLockConfigurationInput {
|
|
|
1835
2062
|
*/
|
|
1836
2063
|
export interface DeleteBackupVaultNotificationsInput {
|
|
1837
2064
|
/**
|
|
2065
|
+
* @public
|
|
1838
2066
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1839
2067
|
* by names that are unique to the account used to create them and the Region where they are
|
|
1840
2068
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
@@ -1846,6 +2074,7 @@ export interface DeleteBackupVaultNotificationsInput {
|
|
|
1846
2074
|
*/
|
|
1847
2075
|
export interface DeleteFrameworkInput {
|
|
1848
2076
|
/**
|
|
2077
|
+
* @public
|
|
1849
2078
|
* <p>The unique name of a framework.</p>
|
|
1850
2079
|
*/
|
|
1851
2080
|
FrameworkName: string | undefined;
|
|
@@ -1855,6 +2084,7 @@ export interface DeleteFrameworkInput {
|
|
|
1855
2084
|
*/
|
|
1856
2085
|
export interface DeleteRecoveryPointInput {
|
|
1857
2086
|
/**
|
|
2087
|
+
* @public
|
|
1858
2088
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1859
2089
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
1860
2090
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -1862,6 +2092,7 @@ export interface DeleteRecoveryPointInput {
|
|
|
1862
2092
|
*/
|
|
1863
2093
|
BackupVaultName: string | undefined;
|
|
1864
2094
|
/**
|
|
2095
|
+
* @public
|
|
1865
2096
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
1866
2097
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
1867
2098
|
*/
|
|
@@ -1872,6 +2103,7 @@ export interface DeleteRecoveryPointInput {
|
|
|
1872
2103
|
*/
|
|
1873
2104
|
export interface DeleteReportPlanInput {
|
|
1874
2105
|
/**
|
|
2106
|
+
* @public
|
|
1875
2107
|
* <p>The unique name of a report plan.</p>
|
|
1876
2108
|
*/
|
|
1877
2109
|
ReportPlanName: string | undefined;
|
|
@@ -1886,10 +2118,12 @@ export declare class DependencyFailureException extends __BaseException {
|
|
|
1886
2118
|
Code?: string;
|
|
1887
2119
|
Message?: string;
|
|
1888
2120
|
/**
|
|
2121
|
+
* @public
|
|
1889
2122
|
* <p></p>
|
|
1890
2123
|
*/
|
|
1891
2124
|
Type?: string;
|
|
1892
2125
|
/**
|
|
2126
|
+
* @public
|
|
1893
2127
|
* <p></p>
|
|
1894
2128
|
*/
|
|
1895
2129
|
Context?: string;
|
|
@@ -1903,6 +2137,7 @@ export declare class DependencyFailureException extends __BaseException {
|
|
|
1903
2137
|
*/
|
|
1904
2138
|
export interface DescribeBackupJobInput {
|
|
1905
2139
|
/**
|
|
2140
|
+
* @public
|
|
1906
2141
|
* <p>Uniquely identifies a request to Backup to back up a resource.</p>
|
|
1907
2142
|
*/
|
|
1908
2143
|
BackupJobId: string | undefined;
|
|
@@ -1912,14 +2147,17 @@ export interface DescribeBackupJobInput {
|
|
|
1912
2147
|
*/
|
|
1913
2148
|
export interface DescribeBackupJobOutput {
|
|
1914
2149
|
/**
|
|
2150
|
+
* @public
|
|
1915
2151
|
* <p>Returns the account ID that owns the backup job.</p>
|
|
1916
2152
|
*/
|
|
1917
2153
|
AccountId?: string;
|
|
1918
2154
|
/**
|
|
2155
|
+
* @public
|
|
1919
2156
|
* <p>Uniquely identifies a request to Backup to back up a resource.</p>
|
|
1920
2157
|
*/
|
|
1921
2158
|
BackupJobId?: string;
|
|
1922
2159
|
/**
|
|
2160
|
+
* @public
|
|
1923
2161
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
1924
2162
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
1925
2163
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -1927,21 +2165,25 @@ export interface DescribeBackupJobOutput {
|
|
|
1927
2165
|
*/
|
|
1928
2166
|
BackupVaultName?: string;
|
|
1929
2167
|
/**
|
|
2168
|
+
* @public
|
|
1930
2169
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
1931
2170
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
1932
2171
|
*/
|
|
1933
2172
|
BackupVaultArn?: string;
|
|
1934
2173
|
/**
|
|
2174
|
+
* @public
|
|
1935
2175
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
1936
2176
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
1937
2177
|
*/
|
|
1938
2178
|
RecoveryPointArn?: string;
|
|
1939
2179
|
/**
|
|
2180
|
+
* @public
|
|
1940
2181
|
* <p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the
|
|
1941
2182
|
* resource type.</p>
|
|
1942
2183
|
*/
|
|
1943
2184
|
ResourceArn?: string;
|
|
1944
2185
|
/**
|
|
2186
|
+
* @public
|
|
1945
2187
|
* <p>The date and time that a backup job is created, in Unix format and Coordinated Universal
|
|
1946
2188
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
1947
2189
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -1949,6 +2191,7 @@ export interface DescribeBackupJobOutput {
|
|
|
1949
2191
|
*/
|
|
1950
2192
|
CreationDate?: Date;
|
|
1951
2193
|
/**
|
|
2194
|
+
* @public
|
|
1952
2195
|
* <p>The date and time that a job to create a backup job is completed, in Unix format and
|
|
1953
2196
|
* Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to
|
|
1954
2197
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -1956,43 +2199,52 @@ export interface DescribeBackupJobOutput {
|
|
|
1956
2199
|
*/
|
|
1957
2200
|
CompletionDate?: Date;
|
|
1958
2201
|
/**
|
|
2202
|
+
* @public
|
|
1959
2203
|
* <p>The current state of a resource recovery point.</p>
|
|
1960
2204
|
*/
|
|
1961
2205
|
State?: BackupJobState | string;
|
|
1962
2206
|
/**
|
|
2207
|
+
* @public
|
|
1963
2208
|
* <p>A detailed message explaining the status of the job to back up a resource.</p>
|
|
1964
2209
|
*/
|
|
1965
2210
|
StatusMessage?: string;
|
|
1966
2211
|
/**
|
|
2212
|
+
* @public
|
|
1967
2213
|
* <p>Contains an estimated percentage that is complete of a job at the time the job status
|
|
1968
2214
|
* was queried.</p>
|
|
1969
2215
|
*/
|
|
1970
2216
|
PercentDone?: string;
|
|
1971
2217
|
/**
|
|
2218
|
+
* @public
|
|
1972
2219
|
* <p>The size, in bytes, of a backup.</p>
|
|
1973
2220
|
*/
|
|
1974
2221
|
BackupSizeInBytes?: number;
|
|
1975
2222
|
/**
|
|
2223
|
+
* @public
|
|
1976
2224
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
1977
2225
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
1978
2226
|
*/
|
|
1979
2227
|
IamRoleArn?: string;
|
|
1980
2228
|
/**
|
|
2229
|
+
* @public
|
|
1981
2230
|
* <p>Contains identifying information about the creation of a backup job, including the
|
|
1982
2231
|
* <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>,
|
|
1983
2232
|
* and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>
|
|
1984
2233
|
*/
|
|
1985
2234
|
CreatedBy?: RecoveryPointCreator;
|
|
1986
2235
|
/**
|
|
2236
|
+
* @public
|
|
1987
2237
|
* <p>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>
|
|
1988
2238
|
*/
|
|
1989
2239
|
ResourceType?: string;
|
|
1990
2240
|
/**
|
|
2241
|
+
* @public
|
|
1991
2242
|
* <p>The size in bytes transferred to a backup vault at the time that the job status was
|
|
1992
2243
|
* queried.</p>
|
|
1993
2244
|
*/
|
|
1994
2245
|
BytesTransferred?: number;
|
|
1995
2246
|
/**
|
|
2247
|
+
* @public
|
|
1996
2248
|
* <p>The date and time that a job to back up resources is expected to be completed, in Unix
|
|
1997
2249
|
* format and Coordinated Universal Time (UTC). The value of
|
|
1998
2250
|
* <code>ExpectedCompletionDate</code> is accurate to milliseconds. For example, the value
|
|
@@ -2000,6 +2252,7 @@ export interface DescribeBackupJobOutput {
|
|
|
2000
2252
|
*/
|
|
2001
2253
|
ExpectedCompletionDate?: Date;
|
|
2002
2254
|
/**
|
|
2255
|
+
* @public
|
|
2003
2256
|
* <p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job
|
|
2004
2257
|
* must be started before it is canceled. The value is calculated by adding the start window
|
|
2005
2258
|
* to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2
|
|
@@ -2009,10 +2262,12 @@ export interface DescribeBackupJobOutput {
|
|
|
2009
2262
|
*/
|
|
2010
2263
|
StartBy?: Date;
|
|
2011
2264
|
/**
|
|
2265
|
+
* @public
|
|
2012
2266
|
* <p>Represents the options specified as part of backup plan or on-demand backup job.</p>
|
|
2013
2267
|
*/
|
|
2014
2268
|
BackupOptions?: Record<string, string>;
|
|
2015
2269
|
/**
|
|
2270
|
+
* @public
|
|
2016
2271
|
* <p>Represents the actual backup type selected for a backup job. For example, if a
|
|
2017
2272
|
* successful Windows Volume Shadow Copy Service (VSS) backup was taken,
|
|
2018
2273
|
* <code>BackupType</code> returns <code>"WindowsVSS"</code>. If <code>BackupType</code> is
|
|
@@ -2020,22 +2275,27 @@ export interface DescribeBackupJobOutput {
|
|
|
2020
2275
|
*/
|
|
2021
2276
|
BackupType?: string;
|
|
2022
2277
|
/**
|
|
2278
|
+
* @public
|
|
2023
2279
|
* <p>This returns the parent (composite) resource backup job ID.</p>
|
|
2024
2280
|
*/
|
|
2025
2281
|
ParentJobId?: string;
|
|
2026
2282
|
/**
|
|
2283
|
+
* @public
|
|
2027
2284
|
* <p>This returns the boolean value that a backup job is a parent (composite) job.</p>
|
|
2028
2285
|
*/
|
|
2029
2286
|
IsParent?: boolean;
|
|
2030
2287
|
/**
|
|
2288
|
+
* @public
|
|
2031
2289
|
* <p>This returns the number of child (nested) backup jobs.</p>
|
|
2032
2290
|
*/
|
|
2033
2291
|
NumberOfChildJobs?: number;
|
|
2034
2292
|
/**
|
|
2293
|
+
* @public
|
|
2035
2294
|
* <p>This returns the statistics of the included child (nested) backup jobs.</p>
|
|
2036
2295
|
*/
|
|
2037
2296
|
ChildJobsInState?: Record<string, number>;
|
|
2038
2297
|
/**
|
|
2298
|
+
* @public
|
|
2039
2299
|
* <p>This is the non-unique name of the resource that
|
|
2040
2300
|
* belongs to the specified backup.</p>
|
|
2041
2301
|
*/
|
|
@@ -2046,6 +2306,7 @@ export interface DescribeBackupJobOutput {
|
|
|
2046
2306
|
*/
|
|
2047
2307
|
export interface DescribeBackupVaultInput {
|
|
2048
2308
|
/**
|
|
2309
|
+
* @public
|
|
2049
2310
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
2050
2311
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
2051
2312
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -2058,22 +2319,26 @@ export interface DescribeBackupVaultInput {
|
|
|
2058
2319
|
*/
|
|
2059
2320
|
export interface DescribeBackupVaultOutput {
|
|
2060
2321
|
/**
|
|
2322
|
+
* @public
|
|
2061
2323
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
2062
2324
|
* by names that are unique to the account used to create them and the Region where they are
|
|
2063
2325
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
2064
2326
|
*/
|
|
2065
2327
|
BackupVaultName?: string;
|
|
2066
2328
|
/**
|
|
2329
|
+
* @public
|
|
2067
2330
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
2068
2331
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
2069
2332
|
*/
|
|
2070
2333
|
BackupVaultArn?: string;
|
|
2071
2334
|
/**
|
|
2335
|
+
* @public
|
|
2072
2336
|
* <p>The server-side encryption key that is used to protect your backups; for example,
|
|
2073
2337
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
2074
2338
|
*/
|
|
2075
2339
|
EncryptionKeyArn?: string;
|
|
2076
2340
|
/**
|
|
2341
|
+
* @public
|
|
2077
2342
|
* <p>The date and time that a backup vault is created, in Unix format and Coordinated
|
|
2078
2343
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
2079
2344
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2081,21 +2346,25 @@ export interface DescribeBackupVaultOutput {
|
|
|
2081
2346
|
*/
|
|
2082
2347
|
CreationDate?: Date;
|
|
2083
2348
|
/**
|
|
2349
|
+
* @public
|
|
2084
2350
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
2085
2351
|
* without the risk of running the operation twice.</p>
|
|
2086
2352
|
*/
|
|
2087
2353
|
CreatorRequestId?: string;
|
|
2088
2354
|
/**
|
|
2355
|
+
* @public
|
|
2089
2356
|
* <p>The number of recovery points that are stored in a backup vault.</p>
|
|
2090
2357
|
*/
|
|
2091
2358
|
NumberOfRecoveryPoints?: number;
|
|
2092
2359
|
/**
|
|
2360
|
+
* @public
|
|
2093
2361
|
* <p>A Boolean that indicates whether Backup Vault Lock is currently protecting
|
|
2094
2362
|
* the backup vault. <code>True</code> means that Vault Lock causes delete or update
|
|
2095
2363
|
* operations on the recovery points stored in the vault to fail.</p>
|
|
2096
2364
|
*/
|
|
2097
2365
|
Locked?: boolean;
|
|
2098
2366
|
/**
|
|
2367
|
+
* @public
|
|
2099
2368
|
* <p>The Backup Vault Lock setting that specifies the minimum retention period
|
|
2100
2369
|
* that the vault retains its recovery points. If this parameter is not specified, Vault Lock
|
|
2101
2370
|
* does not enforce a minimum retention period.</p>
|
|
@@ -2108,6 +2377,7 @@ export interface DescribeBackupVaultOutput {
|
|
|
2108
2377
|
*/
|
|
2109
2378
|
MinRetentionDays?: number;
|
|
2110
2379
|
/**
|
|
2380
|
+
* @public
|
|
2111
2381
|
* <p>The Backup Vault Lock setting that specifies the maximum retention period
|
|
2112
2382
|
* that the vault retains its recovery points. If this parameter is not specified, Vault Lock
|
|
2113
2383
|
* does not enforce a maximum retention period on the recovery points in the vault (allowing
|
|
@@ -2121,6 +2391,7 @@ export interface DescribeBackupVaultOutput {
|
|
|
2121
2391
|
*/
|
|
2122
2392
|
MaxRetentionDays?: number;
|
|
2123
2393
|
/**
|
|
2394
|
+
* @public
|
|
2124
2395
|
* <p>The date and time when Backup Vault Lock configuration cannot be changed or
|
|
2125
2396
|
* deleted.</p>
|
|
2126
2397
|
* <p>If you applied Vault Lock to your vault without specifying a lock date, you can change
|
|
@@ -2137,6 +2408,7 @@ export interface DescribeBackupVaultOutput {
|
|
|
2137
2408
|
*/
|
|
2138
2409
|
export interface DescribeCopyJobInput {
|
|
2139
2410
|
/**
|
|
2411
|
+
* @public
|
|
2140
2412
|
* <p>Uniquely identifies a copy job.</p>
|
|
2141
2413
|
*/
|
|
2142
2414
|
CopyJobId: string | undefined;
|
|
@@ -2146,6 +2418,7 @@ export interface DescribeCopyJobInput {
|
|
|
2146
2418
|
*/
|
|
2147
2419
|
export interface DescribeCopyJobOutput {
|
|
2148
2420
|
/**
|
|
2421
|
+
* @public
|
|
2149
2422
|
* <p>Contains detailed information about a copy job.</p>
|
|
2150
2423
|
*/
|
|
2151
2424
|
CopyJob?: CopyJob;
|
|
@@ -2155,6 +2428,7 @@ export interface DescribeCopyJobOutput {
|
|
|
2155
2428
|
*/
|
|
2156
2429
|
export interface DescribeFrameworkInput {
|
|
2157
2430
|
/**
|
|
2431
|
+
* @public
|
|
2158
2432
|
* <p>The unique name of a framework.</p>
|
|
2159
2433
|
*/
|
|
2160
2434
|
FrameworkName: string | undefined;
|
|
@@ -2164,30 +2438,36 @@ export interface DescribeFrameworkInput {
|
|
|
2164
2438
|
*/
|
|
2165
2439
|
export interface DescribeFrameworkOutput {
|
|
2166
2440
|
/**
|
|
2441
|
+
* @public
|
|
2167
2442
|
* <p>The unique name of a framework.</p>
|
|
2168
2443
|
*/
|
|
2169
2444
|
FrameworkName?: string;
|
|
2170
2445
|
/**
|
|
2446
|
+
* @public
|
|
2171
2447
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
2172
2448
|
* depends on the resource type.</p>
|
|
2173
2449
|
*/
|
|
2174
2450
|
FrameworkArn?: string;
|
|
2175
2451
|
/**
|
|
2452
|
+
* @public
|
|
2176
2453
|
* <p>An optional description of the framework.</p>
|
|
2177
2454
|
*/
|
|
2178
2455
|
FrameworkDescription?: string;
|
|
2179
2456
|
/**
|
|
2457
|
+
* @public
|
|
2180
2458
|
* <p>A list of the controls that make up the framework. Each control in the list has a name,
|
|
2181
2459
|
* input parameters, and scope.</p>
|
|
2182
2460
|
*/
|
|
2183
2461
|
FrameworkControls?: FrameworkControl[];
|
|
2184
2462
|
/**
|
|
2463
|
+
* @public
|
|
2185
2464
|
* <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,
|
|
2186
2465
|
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
2187
2466
|
* UTC.</p>
|
|
2188
2467
|
*/
|
|
2189
2468
|
CreationTime?: Date;
|
|
2190
2469
|
/**
|
|
2470
|
+
* @public
|
|
2191
2471
|
* <p>The deployment status of a framework. The statuses are:</p>
|
|
2192
2472
|
* <p>
|
|
2193
2473
|
* <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |
|
|
@@ -2196,6 +2476,7 @@ export interface DescribeFrameworkOutput {
|
|
|
2196
2476
|
*/
|
|
2197
2477
|
DeploymentStatus?: string;
|
|
2198
2478
|
/**
|
|
2479
|
+
* @public
|
|
2199
2480
|
* <p>A framework consists of one or more controls. Each control governs a resource, such as
|
|
2200
2481
|
* backup plans, backup selections, backup vaults, or recovery points. You can also turn
|
|
2201
2482
|
* Config recording on or off for each resource. The statuses are:</p>
|
|
@@ -2224,6 +2505,7 @@ export interface DescribeFrameworkOutput {
|
|
|
2224
2505
|
*/
|
|
2225
2506
|
FrameworkStatus?: string;
|
|
2226
2507
|
/**
|
|
2508
|
+
* @public
|
|
2227
2509
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
2228
2510
|
* calls to <code>DescribeFrameworkOutput</code>. Retrying a successful request with the same
|
|
2229
2511
|
* idempotency token results in a success message with no action taken.</p>
|
|
@@ -2240,10 +2522,12 @@ export interface DescribeGlobalSettingsInput {
|
|
|
2240
2522
|
*/
|
|
2241
2523
|
export interface DescribeGlobalSettingsOutput {
|
|
2242
2524
|
/**
|
|
2525
|
+
* @public
|
|
2243
2526
|
* <p>The status of the flag <code>isCrossAccountBackupEnabled</code>.</p>
|
|
2244
2527
|
*/
|
|
2245
2528
|
GlobalSettings?: Record<string, string>;
|
|
2246
2529
|
/**
|
|
2530
|
+
* @public
|
|
2247
2531
|
* <p>The date and time that the flag <code>isCrossAccountBackupEnabled</code> was last
|
|
2248
2532
|
* updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of
|
|
2249
2533
|
* <code>LastUpdateTime</code> is accurate to milliseconds. For example, the value
|
|
@@ -2256,6 +2540,7 @@ export interface DescribeGlobalSettingsOutput {
|
|
|
2256
2540
|
*/
|
|
2257
2541
|
export interface DescribeProtectedResourceInput {
|
|
2258
2542
|
/**
|
|
2543
|
+
* @public
|
|
2259
2544
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
2260
2545
|
* depends on the resource type.</p>
|
|
2261
2546
|
*/
|
|
@@ -2266,16 +2551,19 @@ export interface DescribeProtectedResourceInput {
|
|
|
2266
2551
|
*/
|
|
2267
2552
|
export interface DescribeProtectedResourceOutput {
|
|
2268
2553
|
/**
|
|
2554
|
+
* @public
|
|
2269
2555
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the
|
|
2270
2556
|
* resource type.</p>
|
|
2271
2557
|
*/
|
|
2272
2558
|
ResourceArn?: string;
|
|
2273
2559
|
/**
|
|
2560
|
+
* @public
|
|
2274
2561
|
* <p>The type of Amazon Web Services resource saved as a recovery point; for example, an
|
|
2275
2562
|
* Amazon EBS volume or an Amazon RDS database.</p>
|
|
2276
2563
|
*/
|
|
2277
2564
|
ResourceType?: string;
|
|
2278
2565
|
/**
|
|
2566
|
+
* @public
|
|
2279
2567
|
* <p>The date and time that a resource was last backed up, in Unix format and Coordinated
|
|
2280
2568
|
* Universal Time (UTC). The value of <code>LastBackupTime</code> is accurate to milliseconds.
|
|
2281
2569
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2283,6 +2571,7 @@ export interface DescribeProtectedResourceOutput {
|
|
|
2283
2571
|
*/
|
|
2284
2572
|
LastBackupTime?: Date;
|
|
2285
2573
|
/**
|
|
2574
|
+
* @public
|
|
2286
2575
|
* <p>This is the non-unique name of the resource that
|
|
2287
2576
|
* belongs to the specified backup.</p>
|
|
2288
2577
|
*/
|
|
@@ -2293,6 +2582,7 @@ export interface DescribeProtectedResourceOutput {
|
|
|
2293
2582
|
*/
|
|
2294
2583
|
export interface DescribeRecoveryPointInput {
|
|
2295
2584
|
/**
|
|
2585
|
+
* @public
|
|
2296
2586
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
2297
2587
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
2298
2588
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -2300,6 +2590,7 @@ export interface DescribeRecoveryPointInput {
|
|
|
2300
2590
|
*/
|
|
2301
2591
|
BackupVaultName: string | undefined;
|
|
2302
2592
|
/**
|
|
2593
|
+
* @public
|
|
2303
2594
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
2304
2595
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
2305
2596
|
*/
|
|
@@ -2337,22 +2628,26 @@ export type StorageClass = (typeof StorageClass)[keyof typeof StorageClass];
|
|
|
2337
2628
|
*/
|
|
2338
2629
|
export interface DescribeRecoveryPointOutput {
|
|
2339
2630
|
/**
|
|
2631
|
+
* @public
|
|
2340
2632
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
2341
2633
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
2342
2634
|
*/
|
|
2343
2635
|
RecoveryPointArn?: string;
|
|
2344
2636
|
/**
|
|
2637
|
+
* @public
|
|
2345
2638
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
2346
2639
|
* by names that are unique to the account used to create them and the Region where they are
|
|
2347
2640
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
2348
2641
|
*/
|
|
2349
2642
|
BackupVaultName?: string;
|
|
2350
2643
|
/**
|
|
2644
|
+
* @public
|
|
2351
2645
|
* <p>An ARN that uniquely identifies a backup vault; for example,
|
|
2352
2646
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
2353
2647
|
*/
|
|
2354
2648
|
BackupVaultArn?: string;
|
|
2355
2649
|
/**
|
|
2650
|
+
* @public
|
|
2356
2651
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies the source vault where the
|
|
2357
2652
|
* resource was originally backed up in; for example,
|
|
2358
2653
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:BackupVault</code>. If the recovery is
|
|
@@ -2361,27 +2656,32 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2361
2656
|
*/
|
|
2362
2657
|
SourceBackupVaultArn?: string;
|
|
2363
2658
|
/**
|
|
2659
|
+
* @public
|
|
2364
2660
|
* <p>An ARN that uniquely identifies a saved resource. The format of the ARN depends on the
|
|
2365
2661
|
* resource type.</p>
|
|
2366
2662
|
*/
|
|
2367
2663
|
ResourceArn?: string;
|
|
2368
2664
|
/**
|
|
2665
|
+
* @public
|
|
2369
2666
|
* <p>The type of Amazon Web Services resource to save as a recovery point; for example, an
|
|
2370
2667
|
* Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>
|
|
2371
2668
|
*/
|
|
2372
2669
|
ResourceType?: string;
|
|
2373
2670
|
/**
|
|
2671
|
+
* @public
|
|
2374
2672
|
* <p>Contains identifying information about the creation of a recovery point, including the
|
|
2375
2673
|
* <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>,
|
|
2376
2674
|
* and <code>BackupRuleId</code> of the backup plan used to create it.</p>
|
|
2377
2675
|
*/
|
|
2378
2676
|
CreatedBy?: RecoveryPointCreator;
|
|
2379
2677
|
/**
|
|
2678
|
+
* @public
|
|
2380
2679
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
2381
2680
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
2382
2681
|
*/
|
|
2383
2682
|
IamRoleArn?: string;
|
|
2384
2683
|
/**
|
|
2684
|
+
* @public
|
|
2385
2685
|
* <p>A status code specifying the state of the recovery point.</p>
|
|
2386
2686
|
* <p>
|
|
2387
2687
|
* <code>PARTIAL</code> status indicates Backup could not create the recovery
|
|
@@ -2409,10 +2709,12 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2409
2709
|
*/
|
|
2410
2710
|
Status?: RecoveryPointStatus | string;
|
|
2411
2711
|
/**
|
|
2712
|
+
* @public
|
|
2412
2713
|
* <p>A status message explaining the status of the recovery point.</p>
|
|
2413
2714
|
*/
|
|
2414
2715
|
StatusMessage?: string;
|
|
2415
2716
|
/**
|
|
2717
|
+
* @public
|
|
2416
2718
|
* <p>The date and time that a recovery point is created, in Unix format and Coordinated
|
|
2417
2719
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
2418
2720
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2420,6 +2722,7 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2420
2722
|
*/
|
|
2421
2723
|
CreationDate?: Date;
|
|
2422
2724
|
/**
|
|
2725
|
+
* @public
|
|
2423
2726
|
* <p>The date and time that a job to create a recovery point is completed, in Unix format and
|
|
2424
2727
|
* Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to
|
|
2425
2728
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -2427,15 +2730,18 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2427
2730
|
*/
|
|
2428
2731
|
CompletionDate?: Date;
|
|
2429
2732
|
/**
|
|
2733
|
+
* @public
|
|
2430
2734
|
* <p>The size, in bytes, of a backup.</p>
|
|
2431
2735
|
*/
|
|
2432
2736
|
BackupSizeInBytes?: number;
|
|
2433
2737
|
/**
|
|
2738
|
+
* @public
|
|
2434
2739
|
* <p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and
|
|
2435
2740
|
* <code>MoveToColdStorageAt</code> timestamps.</p>
|
|
2436
2741
|
*/
|
|
2437
2742
|
CalculatedLifecycle?: CalculatedLifecycle;
|
|
2438
2743
|
/**
|
|
2744
|
+
* @public
|
|
2439
2745
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
2440
2746
|
* it expires. Backup transitions and expires backups automatically according to
|
|
2441
2747
|
* the lifecycle that you define.</p>
|
|
@@ -2450,21 +2756,25 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2450
2756
|
*/
|
|
2451
2757
|
Lifecycle?: Lifecycle;
|
|
2452
2758
|
/**
|
|
2759
|
+
* @public
|
|
2453
2760
|
* <p>The server-side encryption key used to protect your backups; for example,
|
|
2454
2761
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
2455
2762
|
*/
|
|
2456
2763
|
EncryptionKeyArn?: string;
|
|
2457
2764
|
/**
|
|
2765
|
+
* @public
|
|
2458
2766
|
* <p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is
|
|
2459
2767
|
* encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>
|
|
2460
2768
|
*/
|
|
2461
2769
|
IsEncrypted?: boolean;
|
|
2462
2770
|
/**
|
|
2771
|
+
* @public
|
|
2463
2772
|
* <p>Specifies the storage class of the recovery point. Valid values are <code>WARM</code> or
|
|
2464
2773
|
* <code>COLD</code>.</p>
|
|
2465
2774
|
*/
|
|
2466
2775
|
StorageClass?: StorageClass | string;
|
|
2467
2776
|
/**
|
|
2777
|
+
* @public
|
|
2468
2778
|
* <p>The date and time that a recovery point was last restored, in Unix format and
|
|
2469
2779
|
* Coordinated Universal Time (UTC). The value of <code>LastRestoreTime</code> is accurate to
|
|
2470
2780
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -2472,11 +2782,13 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2472
2782
|
*/
|
|
2473
2783
|
LastRestoreTime?: Date;
|
|
2474
2784
|
/**
|
|
2785
|
+
* @public
|
|
2475
2786
|
* <p>This is an ARN that uniquely identifies a parent (composite) recovery point; for example,
|
|
2476
2787
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
2477
2788
|
*/
|
|
2478
2789
|
ParentRecoveryPointArn?: string;
|
|
2479
2790
|
/**
|
|
2791
|
+
* @public
|
|
2480
2792
|
* <p>This is the identifier of a resource within a composite group, such as
|
|
2481
2793
|
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
2482
2794
|
* ID is transferred from
|
|
@@ -2485,10 +2797,12 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2485
2797
|
*/
|
|
2486
2798
|
CompositeMemberIdentifier?: string;
|
|
2487
2799
|
/**
|
|
2800
|
+
* @public
|
|
2488
2801
|
* <p>This returns the boolean value that a recovery point is a parent (composite) job.</p>
|
|
2489
2802
|
*/
|
|
2490
2803
|
IsParent?: boolean;
|
|
2491
2804
|
/**
|
|
2805
|
+
* @public
|
|
2492
2806
|
* <p>This is the non-unique name of the resource that
|
|
2493
2807
|
* belongs to the specified backup.</p>
|
|
2494
2808
|
*/
|
|
@@ -2504,10 +2818,12 @@ export interface DescribeRegionSettingsInput {
|
|
|
2504
2818
|
*/
|
|
2505
2819
|
export interface DescribeRegionSettingsOutput {
|
|
2506
2820
|
/**
|
|
2821
|
+
* @public
|
|
2507
2822
|
* <p>Returns a list of all services along with the opt-in preferences in the Region.</p>
|
|
2508
2823
|
*/
|
|
2509
2824
|
ResourceTypeOptInPreference?: Record<string, boolean>;
|
|
2510
2825
|
/**
|
|
2826
|
+
* @public
|
|
2511
2827
|
* <p>Returns whether Backup fully manages the backups for a resource type.</p>
|
|
2512
2828
|
* <p>For the benefits of full Backup management, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management"> Full Backup management</a>.</p>
|
|
2513
2829
|
* <p>For a list of resource types and whether each supports full Backup
|
|
@@ -2524,6 +2840,7 @@ export interface DescribeRegionSettingsOutput {
|
|
|
2524
2840
|
*/
|
|
2525
2841
|
export interface DescribeReportJobInput {
|
|
2526
2842
|
/**
|
|
2843
|
+
* @public
|
|
2527
2844
|
* <p>The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded
|
|
2528
2845
|
* string that is at most 1,024 bytes long. The report job ID cannot be edited.</p>
|
|
2529
2846
|
*/
|
|
@@ -2535,10 +2852,12 @@ export interface DescribeReportJobInput {
|
|
|
2535
2852
|
*/
|
|
2536
2853
|
export interface ReportDestination {
|
|
2537
2854
|
/**
|
|
2855
|
+
* @public
|
|
2538
2856
|
* <p>The unique name of the Amazon S3 bucket that receives your reports.</p>
|
|
2539
2857
|
*/
|
|
2540
2858
|
S3BucketName?: string;
|
|
2541
2859
|
/**
|
|
2860
|
+
* @public
|
|
2542
2861
|
* <p>The object key that uniquely identifies your reports in your S3 bucket.</p>
|
|
2543
2862
|
*/
|
|
2544
2863
|
S3Keys?: string[];
|
|
@@ -2550,16 +2869,19 @@ export interface ReportDestination {
|
|
|
2550
2869
|
*/
|
|
2551
2870
|
export interface ReportJob {
|
|
2552
2871
|
/**
|
|
2872
|
+
* @public
|
|
2553
2873
|
* <p>The identifier for a report job. A unique, randomly generated, Unicode, UTF-8 encoded
|
|
2554
2874
|
* string that is at most 1,024 bytes long. Report job IDs cannot be edited.</p>
|
|
2555
2875
|
*/
|
|
2556
2876
|
ReportJobId?: string;
|
|
2557
2877
|
/**
|
|
2878
|
+
* @public
|
|
2558
2879
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
2559
2880
|
* depends on the resource type.</p>
|
|
2560
2881
|
*/
|
|
2561
2882
|
ReportPlanArn?: string;
|
|
2562
2883
|
/**
|
|
2884
|
+
* @public
|
|
2563
2885
|
* <p>Identifies the report template for the report. Reports are built using a report
|
|
2564
2886
|
* template. The report templates are: </p>
|
|
2565
2887
|
* <p>
|
|
@@ -2569,6 +2891,7 @@ export interface ReportJob {
|
|
|
2569
2891
|
*/
|
|
2570
2892
|
ReportTemplate?: string;
|
|
2571
2893
|
/**
|
|
2894
|
+
* @public
|
|
2572
2895
|
* <p>The date and time that a report job is created, in Unix format and Coordinated Universal
|
|
2573
2896
|
* Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For
|
|
2574
2897
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2576,6 +2899,7 @@ export interface ReportJob {
|
|
|
2576
2899
|
*/
|
|
2577
2900
|
CreationTime?: Date;
|
|
2578
2901
|
/**
|
|
2902
|
+
* @public
|
|
2579
2903
|
* <p>The date and time that a report job is completed, in Unix format and Coordinated
|
|
2580
2904
|
* Universal Time (UTC). The value of <code>CompletionTime</code> is accurate to milliseconds.
|
|
2581
2905
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2583,6 +2907,7 @@ export interface ReportJob {
|
|
|
2583
2907
|
*/
|
|
2584
2908
|
CompletionTime?: Date;
|
|
2585
2909
|
/**
|
|
2910
|
+
* @public
|
|
2586
2911
|
* <p>The status of a report job. The statuses are:</p>
|
|
2587
2912
|
* <p>
|
|
2588
2913
|
* <code>CREATED | RUNNING | COMPLETED | FAILED</code>
|
|
@@ -2594,10 +2919,12 @@ export interface ReportJob {
|
|
|
2594
2919
|
*/
|
|
2595
2920
|
Status?: string;
|
|
2596
2921
|
/**
|
|
2922
|
+
* @public
|
|
2597
2923
|
* <p>A message explaining the status of the report job.</p>
|
|
2598
2924
|
*/
|
|
2599
2925
|
StatusMessage?: string;
|
|
2600
2926
|
/**
|
|
2927
|
+
* @public
|
|
2601
2928
|
* <p>The S3 bucket name and S3 keys for the destination where the report job publishes the
|
|
2602
2929
|
* report.</p>
|
|
2603
2930
|
*/
|
|
@@ -2608,6 +2935,7 @@ export interface ReportJob {
|
|
|
2608
2935
|
*/
|
|
2609
2936
|
export interface DescribeReportJobOutput {
|
|
2610
2937
|
/**
|
|
2938
|
+
* @public
|
|
2611
2939
|
* <p>A list of information about a report job, including its completion and creation times,
|
|
2612
2940
|
* report destination, unique report job ID, Amazon Resource Name (ARN), report template,
|
|
2613
2941
|
* status, and status message.</p>
|
|
@@ -2619,6 +2947,7 @@ export interface DescribeReportJobOutput {
|
|
|
2619
2947
|
*/
|
|
2620
2948
|
export interface DescribeReportPlanInput {
|
|
2621
2949
|
/**
|
|
2950
|
+
* @public
|
|
2622
2951
|
* <p>The unique name of a report plan.</p>
|
|
2623
2952
|
*/
|
|
2624
2953
|
ReportPlanName: string | undefined;
|
|
@@ -2629,21 +2958,25 @@ export interface DescribeReportPlanInput {
|
|
|
2629
2958
|
*/
|
|
2630
2959
|
export interface ReportPlan {
|
|
2631
2960
|
/**
|
|
2961
|
+
* @public
|
|
2632
2962
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
2633
2963
|
* depends on the resource type.</p>
|
|
2634
2964
|
*/
|
|
2635
2965
|
ReportPlanArn?: string;
|
|
2636
2966
|
/**
|
|
2967
|
+
* @public
|
|
2637
2968
|
* <p>The unique name of the report plan. This name is between 1 and 256 characters starting
|
|
2638
2969
|
* with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores
|
|
2639
2970
|
* (_).</p>
|
|
2640
2971
|
*/
|
|
2641
2972
|
ReportPlanName?: string;
|
|
2642
2973
|
/**
|
|
2974
|
+
* @public
|
|
2643
2975
|
* <p>An optional description of the report plan with a maximum 1,024 characters.</p>
|
|
2644
2976
|
*/
|
|
2645
2977
|
ReportPlanDescription?: string;
|
|
2646
2978
|
/**
|
|
2979
|
+
* @public
|
|
2647
2980
|
* <p>Identifies the report template for the report. Reports are built using a report
|
|
2648
2981
|
* template. The report templates are:</p>
|
|
2649
2982
|
* <p>
|
|
@@ -2656,11 +2989,13 @@ export interface ReportPlan {
|
|
|
2656
2989
|
*/
|
|
2657
2990
|
ReportSetting?: ReportSetting;
|
|
2658
2991
|
/**
|
|
2992
|
+
* @public
|
|
2659
2993
|
* <p>Contains information about where and how to deliver your reports, specifically your
|
|
2660
2994
|
* Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
|
|
2661
2995
|
*/
|
|
2662
2996
|
ReportDeliveryChannel?: ReportDeliveryChannel;
|
|
2663
2997
|
/**
|
|
2998
|
+
* @public
|
|
2664
2999
|
* <p>The deployment status of a report plan. The statuses are:</p>
|
|
2665
3000
|
* <p>
|
|
2666
3001
|
* <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS |
|
|
@@ -2669,6 +3004,7 @@ export interface ReportPlan {
|
|
|
2669
3004
|
*/
|
|
2670
3005
|
DeploymentStatus?: string;
|
|
2671
3006
|
/**
|
|
3007
|
+
* @public
|
|
2672
3008
|
* <p>The date and time that a report plan is created, in Unix format and Coordinated
|
|
2673
3009
|
* Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds.
|
|
2674
3010
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2676,6 +3012,7 @@ export interface ReportPlan {
|
|
|
2676
3012
|
*/
|
|
2677
3013
|
CreationTime?: Date;
|
|
2678
3014
|
/**
|
|
3015
|
+
* @public
|
|
2679
3016
|
* <p>The date and time that a report job associated with this report plan last attempted to
|
|
2680
3017
|
* run, in Unix format and Coordinated Universal Time (UTC). The value of
|
|
2681
3018
|
* <code>LastAttemptedExecutionTime</code> is accurate to milliseconds. For example, the
|
|
@@ -2683,6 +3020,7 @@ export interface ReportPlan {
|
|
|
2683
3020
|
*/
|
|
2684
3021
|
LastAttemptedExecutionTime?: Date;
|
|
2685
3022
|
/**
|
|
3023
|
+
* @public
|
|
2686
3024
|
* <p>The date and time that a report job associated with this report plan last successfully
|
|
2687
3025
|
* ran, in Unix format and Coordinated Universal Time (UTC). The value of
|
|
2688
3026
|
* <code>LastSuccessfulExecutionTime</code> is accurate to milliseconds. For example, the
|
|
@@ -2695,6 +3033,7 @@ export interface ReportPlan {
|
|
|
2695
3033
|
*/
|
|
2696
3034
|
export interface DescribeReportPlanOutput {
|
|
2697
3035
|
/**
|
|
3036
|
+
* @public
|
|
2698
3037
|
* <p>Returns details about the report plan that is specified by its name. These details
|
|
2699
3038
|
* include the report plan's Amazon Resource Name (ARN), description, settings, delivery
|
|
2700
3039
|
* channel, deployment status, creation time, and last attempted and successful run
|
|
@@ -2707,6 +3046,7 @@ export interface DescribeReportPlanOutput {
|
|
|
2707
3046
|
*/
|
|
2708
3047
|
export interface DescribeRestoreJobInput {
|
|
2709
3048
|
/**
|
|
3049
|
+
* @public
|
|
2710
3050
|
* <p>Uniquely identifies the job that restores a recovery point.</p>
|
|
2711
3051
|
*/
|
|
2712
3052
|
RestoreJobId: string | undefined;
|
|
@@ -2731,19 +3071,23 @@ export type RestoreJobStatus = (typeof RestoreJobStatus)[keyof typeof RestoreJob
|
|
|
2731
3071
|
*/
|
|
2732
3072
|
export interface DescribeRestoreJobOutput {
|
|
2733
3073
|
/**
|
|
3074
|
+
* @public
|
|
2734
3075
|
* <p>Returns the account ID that owns the restore job.</p>
|
|
2735
3076
|
*/
|
|
2736
3077
|
AccountId?: string;
|
|
2737
3078
|
/**
|
|
3079
|
+
* @public
|
|
2738
3080
|
* <p>Uniquely identifies the job that restores a recovery point.</p>
|
|
2739
3081
|
*/
|
|
2740
3082
|
RestoreJobId?: string;
|
|
2741
3083
|
/**
|
|
3084
|
+
* @public
|
|
2742
3085
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
2743
3086
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
2744
3087
|
*/
|
|
2745
3088
|
RecoveryPointArn?: string;
|
|
2746
3089
|
/**
|
|
3090
|
+
* @public
|
|
2747
3091
|
* <p>The date and time that a restore job is created, in Unix format and Coordinated
|
|
2748
3092
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
2749
3093
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2751,6 +3095,7 @@ export interface DescribeRestoreJobOutput {
|
|
|
2751
3095
|
*/
|
|
2752
3096
|
CreationDate?: Date;
|
|
2753
3097
|
/**
|
|
3098
|
+
* @public
|
|
2754
3099
|
* <p>The date and time that a job to restore a recovery point is completed, in Unix format
|
|
2755
3100
|
* and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate
|
|
2756
3101
|
* to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -2758,40 +3103,48 @@ export interface DescribeRestoreJobOutput {
|
|
|
2758
3103
|
*/
|
|
2759
3104
|
CompletionDate?: Date;
|
|
2760
3105
|
/**
|
|
3106
|
+
* @public
|
|
2761
3107
|
* <p>Status code specifying the state of the job that is initiated by Backup to
|
|
2762
3108
|
* restore a recovery point.</p>
|
|
2763
3109
|
*/
|
|
2764
3110
|
Status?: RestoreJobStatus | string;
|
|
2765
3111
|
/**
|
|
3112
|
+
* @public
|
|
2766
3113
|
* <p>A message showing the status of a job to restore a recovery point.</p>
|
|
2767
3114
|
*/
|
|
2768
3115
|
StatusMessage?: string;
|
|
2769
3116
|
/**
|
|
3117
|
+
* @public
|
|
2770
3118
|
* <p>Contains an estimated percentage that is complete of a job at the time the job status
|
|
2771
3119
|
* was queried.</p>
|
|
2772
3120
|
*/
|
|
2773
3121
|
PercentDone?: string;
|
|
2774
3122
|
/**
|
|
3123
|
+
* @public
|
|
2775
3124
|
* <p>The size, in bytes, of the restored resource.</p>
|
|
2776
3125
|
*/
|
|
2777
3126
|
BackupSizeInBytes?: number;
|
|
2778
3127
|
/**
|
|
3128
|
+
* @public
|
|
2779
3129
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
2780
3130
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
2781
3131
|
*/
|
|
2782
3132
|
IamRoleArn?: string;
|
|
2783
3133
|
/**
|
|
3134
|
+
* @public
|
|
2784
3135
|
* <p>The amount of time in minutes that a job restoring a recovery point is expected to
|
|
2785
3136
|
* take.</p>
|
|
2786
3137
|
*/
|
|
2787
3138
|
ExpectedCompletionTimeMinutes?: number;
|
|
2788
3139
|
/**
|
|
3140
|
+
* @public
|
|
2789
3141
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point
|
|
2790
3142
|
* is being restored. The format of the ARN depends on the resource type of the backed-up
|
|
2791
3143
|
* resource.</p>
|
|
2792
3144
|
*/
|
|
2793
3145
|
CreatedResourceArn?: string;
|
|
2794
3146
|
/**
|
|
3147
|
+
* @public
|
|
2795
3148
|
* <p>Returns metadata associated with a restore job listed by resource type.</p>
|
|
2796
3149
|
*/
|
|
2797
3150
|
ResourceType?: string;
|
|
@@ -2801,10 +3154,12 @@ export interface DescribeRestoreJobOutput {
|
|
|
2801
3154
|
*/
|
|
2802
3155
|
export interface DisassociateRecoveryPointInput {
|
|
2803
3156
|
/**
|
|
3157
|
+
* @public
|
|
2804
3158
|
* <p>The unique name of an Backup vault.</p>
|
|
2805
3159
|
*/
|
|
2806
3160
|
BackupVaultName: string | undefined;
|
|
2807
3161
|
/**
|
|
3162
|
+
* @public
|
|
2808
3163
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery
|
|
2809
3164
|
* point.</p>
|
|
2810
3165
|
*/
|
|
@@ -2815,6 +3170,7 @@ export interface DisassociateRecoveryPointInput {
|
|
|
2815
3170
|
*/
|
|
2816
3171
|
export interface DisassociateRecoveryPointFromParentInput {
|
|
2817
3172
|
/**
|
|
3173
|
+
* @public
|
|
2818
3174
|
* <p>This is the name of a logical container where the child (nested) recovery point
|
|
2819
3175
|
* is stored. Backup vaults are identified by names that are unique to the account used
|
|
2820
3176
|
* to create them and the Amazon Web Services Region where they are created. They consist of lowercase
|
|
@@ -2822,6 +3178,7 @@ export interface DisassociateRecoveryPointFromParentInput {
|
|
|
2822
3178
|
*/
|
|
2823
3179
|
BackupVaultName: string | undefined;
|
|
2824
3180
|
/**
|
|
3181
|
+
* @public
|
|
2825
3182
|
* <p>This is the Amazon Resource Name (ARN) that uniquely identifies the child
|
|
2826
3183
|
* (nested) recovery point; for example,
|
|
2827
3184
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.</code>
|
|
@@ -2834,6 +3191,7 @@ export interface DisassociateRecoveryPointFromParentInput {
|
|
|
2834
3191
|
*/
|
|
2835
3192
|
export interface ExportBackupPlanTemplateInput {
|
|
2836
3193
|
/**
|
|
3194
|
+
* @public
|
|
2837
3195
|
* <p>Uniquely identifies a backup plan.</p>
|
|
2838
3196
|
*/
|
|
2839
3197
|
BackupPlanId: string | undefined;
|
|
@@ -2843,6 +3201,7 @@ export interface ExportBackupPlanTemplateInput {
|
|
|
2843
3201
|
*/
|
|
2844
3202
|
export interface ExportBackupPlanTemplateOutput {
|
|
2845
3203
|
/**
|
|
3204
|
+
* @public
|
|
2846
3205
|
* <p>The body of a backup plan template in JSON format.</p>
|
|
2847
3206
|
* <note>
|
|
2848
3207
|
* <p>This is a signed JSON document that cannot be modified before being passed to
|
|
@@ -2857,10 +3216,12 @@ export interface ExportBackupPlanTemplateOutput {
|
|
|
2857
3216
|
*/
|
|
2858
3217
|
export interface GetBackupPlanInput {
|
|
2859
3218
|
/**
|
|
3219
|
+
* @public
|
|
2860
3220
|
* <p>Uniquely identifies a backup plan.</p>
|
|
2861
3221
|
*/
|
|
2862
3222
|
BackupPlanId: string | undefined;
|
|
2863
3223
|
/**
|
|
3224
|
+
* @public
|
|
2864
3225
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
2865
3226
|
* long. Version IDs cannot be edited.</p>
|
|
2866
3227
|
*/
|
|
@@ -2871,30 +3232,36 @@ export interface GetBackupPlanInput {
|
|
|
2871
3232
|
*/
|
|
2872
3233
|
export interface GetBackupPlanOutput {
|
|
2873
3234
|
/**
|
|
3235
|
+
* @public
|
|
2874
3236
|
* <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or
|
|
2875
3237
|
* more sets of <code>Rules</code>.</p>
|
|
2876
3238
|
*/
|
|
2877
3239
|
BackupPlan?: BackupPlan;
|
|
2878
3240
|
/**
|
|
3241
|
+
* @public
|
|
2879
3242
|
* <p>Uniquely identifies a backup plan.</p>
|
|
2880
3243
|
*/
|
|
2881
3244
|
BackupPlanId?: string;
|
|
2882
3245
|
/**
|
|
3246
|
+
* @public
|
|
2883
3247
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
2884
3248
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
2885
3249
|
*/
|
|
2886
3250
|
BackupPlanArn?: string;
|
|
2887
3251
|
/**
|
|
3252
|
+
* @public
|
|
2888
3253
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
2889
3254
|
* long. Version IDs cannot be edited.</p>
|
|
2890
3255
|
*/
|
|
2891
3256
|
VersionId?: string;
|
|
2892
3257
|
/**
|
|
3258
|
+
* @public
|
|
2893
3259
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
2894
3260
|
* without the risk of running the operation twice.</p>
|
|
2895
3261
|
*/
|
|
2896
3262
|
CreatorRequestId?: string;
|
|
2897
3263
|
/**
|
|
3264
|
+
* @public
|
|
2898
3265
|
* <p>The date and time that a backup plan is created, in Unix format and Coordinated
|
|
2899
3266
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
2900
3267
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2902,6 +3269,7 @@ export interface GetBackupPlanOutput {
|
|
|
2902
3269
|
*/
|
|
2903
3270
|
CreationDate?: Date;
|
|
2904
3271
|
/**
|
|
3272
|
+
* @public
|
|
2905
3273
|
* <p>The date and time that a backup plan is deleted, in Unix format and Coordinated
|
|
2906
3274
|
* Universal Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds.
|
|
2907
3275
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2909,6 +3277,7 @@ export interface GetBackupPlanOutput {
|
|
|
2909
3277
|
*/
|
|
2910
3278
|
DeletionDate?: Date;
|
|
2911
3279
|
/**
|
|
3280
|
+
* @public
|
|
2912
3281
|
* <p>The last time a job to back up resources was run with this backup plan. A date and time,
|
|
2913
3282
|
* in Unix format and Coordinated Universal Time (UTC). The value of
|
|
2914
3283
|
* <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value
|
|
@@ -2916,6 +3285,7 @@ export interface GetBackupPlanOutput {
|
|
|
2916
3285
|
*/
|
|
2917
3286
|
LastExecutionDate?: Date;
|
|
2918
3287
|
/**
|
|
3288
|
+
* @public
|
|
2919
3289
|
* <p>Contains a list of <code>BackupOptions</code> for each resource type. The list is
|
|
2920
3290
|
* populated only if the advanced option is set for the backup plan.</p>
|
|
2921
3291
|
*/
|
|
@@ -2926,6 +3296,7 @@ export interface GetBackupPlanOutput {
|
|
|
2926
3296
|
*/
|
|
2927
3297
|
export interface GetBackupPlanFromJSONInput {
|
|
2928
3298
|
/**
|
|
3299
|
+
* @public
|
|
2929
3300
|
* <p>A customer-supplied backup plan document in JSON format.</p>
|
|
2930
3301
|
*/
|
|
2931
3302
|
BackupPlanTemplateJson: string | undefined;
|
|
@@ -2935,6 +3306,7 @@ export interface GetBackupPlanFromJSONInput {
|
|
|
2935
3306
|
*/
|
|
2936
3307
|
export interface GetBackupPlanFromJSONOutput {
|
|
2937
3308
|
/**
|
|
3309
|
+
* @public
|
|
2938
3310
|
* <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or
|
|
2939
3311
|
* more sets of <code>Rules</code>.</p>
|
|
2940
3312
|
*/
|
|
@@ -2945,6 +3317,7 @@ export interface GetBackupPlanFromJSONOutput {
|
|
|
2945
3317
|
*/
|
|
2946
3318
|
export interface GetBackupPlanFromTemplateInput {
|
|
2947
3319
|
/**
|
|
3320
|
+
* @public
|
|
2948
3321
|
* <p>Uniquely identifies a stored backup plan template.</p>
|
|
2949
3322
|
*/
|
|
2950
3323
|
BackupPlanTemplateId: string | undefined;
|
|
@@ -2954,6 +3327,7 @@ export interface GetBackupPlanFromTemplateInput {
|
|
|
2954
3327
|
*/
|
|
2955
3328
|
export interface GetBackupPlanFromTemplateOutput {
|
|
2956
3329
|
/**
|
|
3330
|
+
* @public
|
|
2957
3331
|
* <p>Returns the body of a backup plan based on the target template, including the name,
|
|
2958
3332
|
* rules, and backup vault of the plan.</p>
|
|
2959
3333
|
*/
|
|
@@ -2964,10 +3338,12 @@ export interface GetBackupPlanFromTemplateOutput {
|
|
|
2964
3338
|
*/
|
|
2965
3339
|
export interface GetBackupSelectionInput {
|
|
2966
3340
|
/**
|
|
3341
|
+
* @public
|
|
2967
3342
|
* <p>Uniquely identifies a backup plan.</p>
|
|
2968
3343
|
*/
|
|
2969
3344
|
BackupPlanId: string | undefined;
|
|
2970
3345
|
/**
|
|
3346
|
+
* @public
|
|
2971
3347
|
* <p>Uniquely identifies the body of a request to assign a set of resources to a backup
|
|
2972
3348
|
* plan.</p>
|
|
2973
3349
|
*/
|
|
@@ -2978,19 +3354,23 @@ export interface GetBackupSelectionInput {
|
|
|
2978
3354
|
*/
|
|
2979
3355
|
export interface GetBackupSelectionOutput {
|
|
2980
3356
|
/**
|
|
3357
|
+
* @public
|
|
2981
3358
|
* <p>Specifies the body of a request to assign a set of resources to a backup plan.</p>
|
|
2982
3359
|
*/
|
|
2983
3360
|
BackupSelection?: BackupSelection;
|
|
2984
3361
|
/**
|
|
3362
|
+
* @public
|
|
2985
3363
|
* <p>Uniquely identifies the body of a request to assign a set of resources to a backup
|
|
2986
3364
|
* plan.</p>
|
|
2987
3365
|
*/
|
|
2988
3366
|
SelectionId?: string;
|
|
2989
3367
|
/**
|
|
3368
|
+
* @public
|
|
2990
3369
|
* <p>Uniquely identifies a backup plan.</p>
|
|
2991
3370
|
*/
|
|
2992
3371
|
BackupPlanId?: string;
|
|
2993
3372
|
/**
|
|
3373
|
+
* @public
|
|
2994
3374
|
* <p>The date and time a backup selection is created, in Unix format and Coordinated
|
|
2995
3375
|
* Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.
|
|
2996
3376
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -2998,6 +3378,7 @@ export interface GetBackupSelectionOutput {
|
|
|
2998
3378
|
*/
|
|
2999
3379
|
CreationDate?: Date;
|
|
3000
3380
|
/**
|
|
3381
|
+
* @public
|
|
3001
3382
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
3002
3383
|
* without the risk of running the operation twice.</p>
|
|
3003
3384
|
*/
|
|
@@ -3008,6 +3389,7 @@ export interface GetBackupSelectionOutput {
|
|
|
3008
3389
|
*/
|
|
3009
3390
|
export interface GetBackupVaultAccessPolicyInput {
|
|
3010
3391
|
/**
|
|
3392
|
+
* @public
|
|
3011
3393
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3012
3394
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
3013
3395
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -3020,17 +3402,20 @@ export interface GetBackupVaultAccessPolicyInput {
|
|
|
3020
3402
|
*/
|
|
3021
3403
|
export interface GetBackupVaultAccessPolicyOutput {
|
|
3022
3404
|
/**
|
|
3405
|
+
* @public
|
|
3023
3406
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3024
3407
|
* by names that are unique to the account used to create them and the Region where they are
|
|
3025
3408
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
3026
3409
|
*/
|
|
3027
3410
|
BackupVaultName?: string;
|
|
3028
3411
|
/**
|
|
3412
|
+
* @public
|
|
3029
3413
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
3030
3414
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
3031
3415
|
*/
|
|
3032
3416
|
BackupVaultArn?: string;
|
|
3033
3417
|
/**
|
|
3418
|
+
* @public
|
|
3034
3419
|
* <p>The backup vault access policy document in JSON format.</p>
|
|
3035
3420
|
*/
|
|
3036
3421
|
Policy?: string;
|
|
@@ -3040,6 +3425,7 @@ export interface GetBackupVaultAccessPolicyOutput {
|
|
|
3040
3425
|
*/
|
|
3041
3426
|
export interface GetBackupVaultNotificationsInput {
|
|
3042
3427
|
/**
|
|
3428
|
+
* @public
|
|
3043
3429
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3044
3430
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
3045
3431
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -3052,22 +3438,26 @@ export interface GetBackupVaultNotificationsInput {
|
|
|
3052
3438
|
*/
|
|
3053
3439
|
export interface GetBackupVaultNotificationsOutput {
|
|
3054
3440
|
/**
|
|
3441
|
+
* @public
|
|
3055
3442
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3056
3443
|
* by names that are unique to the account used to create them and the Region where they are
|
|
3057
3444
|
* created. They consist of lowercase letters, numbers, and hyphens.</p>
|
|
3058
3445
|
*/
|
|
3059
3446
|
BackupVaultName?: string;
|
|
3060
3447
|
/**
|
|
3448
|
+
* @public
|
|
3061
3449
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,
|
|
3062
3450
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
3063
3451
|
*/
|
|
3064
3452
|
BackupVaultArn?: string;
|
|
3065
3453
|
/**
|
|
3454
|
+
* @public
|
|
3066
3455
|
* <p>An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS)
|
|
3067
3456
|
* topic; for example, <code>arn:aws:sns:us-west-2:111122223333:MyTopic</code>.</p>
|
|
3068
3457
|
*/
|
|
3069
3458
|
SNSTopicArn?: string;
|
|
3070
3459
|
/**
|
|
3460
|
+
* @public
|
|
3071
3461
|
* <p>An array of events that indicate the status of jobs to back up resources to the backup
|
|
3072
3462
|
* vault.</p>
|
|
3073
3463
|
*/
|
|
@@ -3078,6 +3468,7 @@ export interface GetBackupVaultNotificationsOutput {
|
|
|
3078
3468
|
*/
|
|
3079
3469
|
export interface GetLegalHoldInput {
|
|
3080
3470
|
/**
|
|
3471
|
+
* @public
|
|
3081
3472
|
* <p>This is the ID required to use <code>GetLegalHold</code>. This unique ID
|
|
3082
3473
|
* is associated with a specific legal hold.</p>
|
|
3083
3474
|
*/
|
|
@@ -3088,47 +3479,57 @@ export interface GetLegalHoldInput {
|
|
|
3088
3479
|
*/
|
|
3089
3480
|
export interface GetLegalHoldOutput {
|
|
3090
3481
|
/**
|
|
3482
|
+
* @public
|
|
3091
3483
|
* <p>This is the string title of the legal hold.</p>
|
|
3092
3484
|
*/
|
|
3093
3485
|
Title?: string;
|
|
3094
3486
|
/**
|
|
3487
|
+
* @public
|
|
3095
3488
|
* <p>This is the status of the legal hold. Statuses can be
|
|
3096
3489
|
* <code>ACTIVE</code>, <code>CREATING</code>, <code>CANCELED</code>, and
|
|
3097
3490
|
* <code>CANCELING</code>.</p>
|
|
3098
3491
|
*/
|
|
3099
3492
|
Status?: LegalHoldStatus | string;
|
|
3100
3493
|
/**
|
|
3494
|
+
* @public
|
|
3101
3495
|
* <p>This is the returned string description of the legal hold.</p>
|
|
3102
3496
|
*/
|
|
3103
3497
|
Description?: string;
|
|
3104
3498
|
/**
|
|
3499
|
+
* @public
|
|
3105
3500
|
* <p>String describing the reason for removing the legal hold.</p>
|
|
3106
3501
|
*/
|
|
3107
3502
|
CancelDescription?: string;
|
|
3108
3503
|
/**
|
|
3504
|
+
* @public
|
|
3109
3505
|
* <p>This is the returned ID associated with a specified legal hold.</p>
|
|
3110
3506
|
*/
|
|
3111
3507
|
LegalHoldId?: string;
|
|
3112
3508
|
/**
|
|
3509
|
+
* @public
|
|
3113
3510
|
* <p>This is the returned framework ARN for the specified legal hold.
|
|
3114
3511
|
* An Amazon Resource Name (ARN) uniquely identifies a resource. The format
|
|
3115
3512
|
* of the ARN depends on the resource type.</p>
|
|
3116
3513
|
*/
|
|
3117
3514
|
LegalHoldArn?: string;
|
|
3118
3515
|
/**
|
|
3516
|
+
* @public
|
|
3119
3517
|
* <p>Time in number format when legal hold was created.</p>
|
|
3120
3518
|
*/
|
|
3121
3519
|
CreationDate?: Date;
|
|
3122
3520
|
/**
|
|
3521
|
+
* @public
|
|
3123
3522
|
* <p>Time in number when legal hold was cancelled.</p>
|
|
3124
3523
|
*/
|
|
3125
3524
|
CancellationDate?: Date;
|
|
3126
3525
|
/**
|
|
3526
|
+
* @public
|
|
3127
3527
|
* <p>This is the date and time until which the legal hold record will
|
|
3128
3528
|
* be retained.</p>
|
|
3129
3529
|
*/
|
|
3130
3530
|
RetainRecordUntil?: Date;
|
|
3131
3531
|
/**
|
|
3532
|
+
* @public
|
|
3132
3533
|
* <p>This specifies criteria to assign
|
|
3133
3534
|
* a set of resources, such as resource types or backup vaults.</p>
|
|
3134
3535
|
*/
|
|
@@ -3139,6 +3540,7 @@ export interface GetLegalHoldOutput {
|
|
|
3139
3540
|
*/
|
|
3140
3541
|
export interface GetRecoveryPointRestoreMetadataInput {
|
|
3141
3542
|
/**
|
|
3543
|
+
* @public
|
|
3142
3544
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3143
3545
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
3144
3546
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -3146,6 +3548,7 @@ export interface GetRecoveryPointRestoreMetadataInput {
|
|
|
3146
3548
|
*/
|
|
3147
3549
|
BackupVaultName: string | undefined;
|
|
3148
3550
|
/**
|
|
3551
|
+
* @public
|
|
3149
3552
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
3150
3553
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
3151
3554
|
*/
|
|
@@ -3156,16 +3559,19 @@ export interface GetRecoveryPointRestoreMetadataInput {
|
|
|
3156
3559
|
*/
|
|
3157
3560
|
export interface GetRecoveryPointRestoreMetadataOutput {
|
|
3158
3561
|
/**
|
|
3562
|
+
* @public
|
|
3159
3563
|
* <p>An ARN that uniquely identifies a backup vault; for example,
|
|
3160
3564
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
3161
3565
|
*/
|
|
3162
3566
|
BackupVaultArn?: string;
|
|
3163
3567
|
/**
|
|
3568
|
+
* @public
|
|
3164
3569
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
3165
3570
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
3166
3571
|
*/
|
|
3167
3572
|
RecoveryPointArn?: string;
|
|
3168
3573
|
/**
|
|
3574
|
+
* @public
|
|
3169
3575
|
* <p>The set of metadata key-value pairs that describe the original configuration of the
|
|
3170
3576
|
* backed-up resource. These values vary depending on the service that is being
|
|
3171
3577
|
* restored.</p>
|
|
@@ -3177,6 +3583,7 @@ export interface GetRecoveryPointRestoreMetadataOutput {
|
|
|
3177
3583
|
*/
|
|
3178
3584
|
export interface GetSupportedResourceTypesOutput {
|
|
3179
3585
|
/**
|
|
3586
|
+
* @public
|
|
3180
3587
|
* <p>Contains a string with the supported Amazon Web Services resource types:</p>
|
|
3181
3588
|
* <ul>
|
|
3182
3589
|
* <li>
|
|
@@ -3228,6 +3635,7 @@ export interface GetSupportedResourceTypesOutput {
|
|
|
3228
3635
|
*/
|
|
3229
3636
|
export interface ListBackupJobsInput {
|
|
3230
3637
|
/**
|
|
3638
|
+
* @public
|
|
3231
3639
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3232
3640
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3233
3641
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3235,19 +3643,23 @@ export interface ListBackupJobsInput {
|
|
|
3235
3643
|
*/
|
|
3236
3644
|
NextToken?: string;
|
|
3237
3645
|
/**
|
|
3646
|
+
* @public
|
|
3238
3647
|
* <p>The maximum number of items to be returned.</p>
|
|
3239
3648
|
*/
|
|
3240
3649
|
MaxResults?: number;
|
|
3241
3650
|
/**
|
|
3651
|
+
* @public
|
|
3242
3652
|
* <p>Returns only backup jobs that match the specified resource Amazon Resource Name
|
|
3243
3653
|
* (ARN).</p>
|
|
3244
3654
|
*/
|
|
3245
3655
|
ByResourceArn?: string;
|
|
3246
3656
|
/**
|
|
3657
|
+
* @public
|
|
3247
3658
|
* <p>Returns only backup jobs that are in the specified state.</p>
|
|
3248
3659
|
*/
|
|
3249
3660
|
ByState?: BackupJobState | string;
|
|
3250
3661
|
/**
|
|
3662
|
+
* @public
|
|
3251
3663
|
* <p>Returns only backup jobs that will be stored in the specified backup vault. Backup
|
|
3252
3664
|
* vaults are identified by names that are unique to the account used to create them and the
|
|
3253
3665
|
* Amazon Web Services Region where they are created. They consist of lowercase letters,
|
|
@@ -3255,14 +3667,17 @@ export interface ListBackupJobsInput {
|
|
|
3255
3667
|
*/
|
|
3256
3668
|
ByBackupVaultName?: string;
|
|
3257
3669
|
/**
|
|
3670
|
+
* @public
|
|
3258
3671
|
* <p>Returns only backup jobs that were created before the specified date.</p>
|
|
3259
3672
|
*/
|
|
3260
3673
|
ByCreatedBefore?: Date;
|
|
3261
3674
|
/**
|
|
3675
|
+
* @public
|
|
3262
3676
|
* <p>Returns only backup jobs that were created after the specified date.</p>
|
|
3263
3677
|
*/
|
|
3264
3678
|
ByCreatedAfter?: Date;
|
|
3265
3679
|
/**
|
|
3680
|
+
* @public
|
|
3266
3681
|
* <p>Returns only backup jobs for the specified resources:</p>
|
|
3267
3682
|
* <ul>
|
|
3268
3683
|
* <li>
|
|
@@ -3317,6 +3732,7 @@ export interface ListBackupJobsInput {
|
|
|
3317
3732
|
*/
|
|
3318
3733
|
ByResourceType?: string;
|
|
3319
3734
|
/**
|
|
3735
|
+
* @public
|
|
3320
3736
|
* <p>The account ID to list the jobs from. Returns only backup jobs associated with the
|
|
3321
3737
|
* specified account ID.</p>
|
|
3322
3738
|
* <p>If used from an Organizations management account, passing <code>*</code> returns
|
|
@@ -3324,16 +3740,19 @@ export interface ListBackupJobsInput {
|
|
|
3324
3740
|
*/
|
|
3325
3741
|
ByAccountId?: string;
|
|
3326
3742
|
/**
|
|
3743
|
+
* @public
|
|
3327
3744
|
* <p>Returns only backup jobs completed after a date expressed in Unix format and Coordinated
|
|
3328
3745
|
* Universal Time (UTC).</p>
|
|
3329
3746
|
*/
|
|
3330
3747
|
ByCompleteAfter?: Date;
|
|
3331
3748
|
/**
|
|
3749
|
+
* @public
|
|
3332
3750
|
* <p>Returns only backup jobs completed before a date expressed in Unix format and
|
|
3333
3751
|
* Coordinated Universal Time (UTC).</p>
|
|
3334
3752
|
*/
|
|
3335
3753
|
ByCompleteBefore?: Date;
|
|
3336
3754
|
/**
|
|
3755
|
+
* @public
|
|
3337
3756
|
* <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
|
|
3338
3757
|
*/
|
|
3339
3758
|
ByParentJobId?: string;
|
|
@@ -3343,11 +3762,13 @@ export interface ListBackupJobsInput {
|
|
|
3343
3762
|
*/
|
|
3344
3763
|
export interface ListBackupJobsOutput {
|
|
3345
3764
|
/**
|
|
3765
|
+
* @public
|
|
3346
3766
|
* <p>An array of structures containing metadata about your backup jobs returned in JSON
|
|
3347
3767
|
* format.</p>
|
|
3348
3768
|
*/
|
|
3349
3769
|
BackupJobs?: BackupJob[];
|
|
3350
3770
|
/**
|
|
3771
|
+
* @public
|
|
3351
3772
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3352
3773
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3353
3774
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3360,6 +3781,7 @@ export interface ListBackupJobsOutput {
|
|
|
3360
3781
|
*/
|
|
3361
3782
|
export interface ListBackupPlansInput {
|
|
3362
3783
|
/**
|
|
3784
|
+
* @public
|
|
3363
3785
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3364
3786
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3365
3787
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3367,10 +3789,12 @@ export interface ListBackupPlansInput {
|
|
|
3367
3789
|
*/
|
|
3368
3790
|
NextToken?: string;
|
|
3369
3791
|
/**
|
|
3792
|
+
* @public
|
|
3370
3793
|
* <p>The maximum number of items to be returned.</p>
|
|
3371
3794
|
*/
|
|
3372
3795
|
MaxResults?: number;
|
|
3373
3796
|
/**
|
|
3797
|
+
* @public
|
|
3374
3798
|
* <p>A Boolean value with a default value of <code>FALSE</code> that returns deleted backup
|
|
3375
3799
|
* plans when set to <code>TRUE</code>.</p>
|
|
3376
3800
|
*/
|
|
@@ -3381,6 +3805,7 @@ export interface ListBackupPlansInput {
|
|
|
3381
3805
|
*/
|
|
3382
3806
|
export interface ListBackupPlansOutput {
|
|
3383
3807
|
/**
|
|
3808
|
+
* @public
|
|
3384
3809
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3385
3810
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3386
3811
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3388,6 +3813,7 @@ export interface ListBackupPlansOutput {
|
|
|
3388
3813
|
*/
|
|
3389
3814
|
NextToken?: string;
|
|
3390
3815
|
/**
|
|
3816
|
+
* @public
|
|
3391
3817
|
* <p>An array of backup plan list items containing metadata about your saved backup
|
|
3392
3818
|
* plans.</p>
|
|
3393
3819
|
*/
|
|
@@ -3398,6 +3824,7 @@ export interface ListBackupPlansOutput {
|
|
|
3398
3824
|
*/
|
|
3399
3825
|
export interface ListBackupPlanTemplatesInput {
|
|
3400
3826
|
/**
|
|
3827
|
+
* @public
|
|
3401
3828
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3402
3829
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3403
3830
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3405,6 +3832,7 @@ export interface ListBackupPlanTemplatesInput {
|
|
|
3405
3832
|
*/
|
|
3406
3833
|
NextToken?: string;
|
|
3407
3834
|
/**
|
|
3835
|
+
* @public
|
|
3408
3836
|
* <p>The maximum number of items to be returned.</p>
|
|
3409
3837
|
*/
|
|
3410
3838
|
MaxResults?: number;
|
|
@@ -3414,6 +3842,7 @@ export interface ListBackupPlanTemplatesInput {
|
|
|
3414
3842
|
*/
|
|
3415
3843
|
export interface ListBackupPlanTemplatesOutput {
|
|
3416
3844
|
/**
|
|
3845
|
+
* @public
|
|
3417
3846
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3418
3847
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3419
3848
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3421,6 +3850,7 @@ export interface ListBackupPlanTemplatesOutput {
|
|
|
3421
3850
|
*/
|
|
3422
3851
|
NextToken?: string;
|
|
3423
3852
|
/**
|
|
3853
|
+
* @public
|
|
3424
3854
|
* <p>An array of template list items containing metadata about your saved templates.</p>
|
|
3425
3855
|
*/
|
|
3426
3856
|
BackupPlanTemplatesList?: BackupPlanTemplatesListMember[];
|
|
@@ -3430,10 +3860,12 @@ export interface ListBackupPlanTemplatesOutput {
|
|
|
3430
3860
|
*/
|
|
3431
3861
|
export interface ListBackupPlanVersionsInput {
|
|
3432
3862
|
/**
|
|
3863
|
+
* @public
|
|
3433
3864
|
* <p>Uniquely identifies a backup plan.</p>
|
|
3434
3865
|
*/
|
|
3435
3866
|
BackupPlanId: string | undefined;
|
|
3436
3867
|
/**
|
|
3868
|
+
* @public
|
|
3437
3869
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3438
3870
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3439
3871
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3441,6 +3873,7 @@ export interface ListBackupPlanVersionsInput {
|
|
|
3441
3873
|
*/
|
|
3442
3874
|
NextToken?: string;
|
|
3443
3875
|
/**
|
|
3876
|
+
* @public
|
|
3444
3877
|
* <p>The maximum number of items to be returned.</p>
|
|
3445
3878
|
*/
|
|
3446
3879
|
MaxResults?: number;
|
|
@@ -3450,6 +3883,7 @@ export interface ListBackupPlanVersionsInput {
|
|
|
3450
3883
|
*/
|
|
3451
3884
|
export interface ListBackupPlanVersionsOutput {
|
|
3452
3885
|
/**
|
|
3886
|
+
* @public
|
|
3453
3887
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3454
3888
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3455
3889
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3457,6 +3891,7 @@ export interface ListBackupPlanVersionsOutput {
|
|
|
3457
3891
|
*/
|
|
3458
3892
|
NextToken?: string;
|
|
3459
3893
|
/**
|
|
3894
|
+
* @public
|
|
3460
3895
|
* <p>An array of version list items containing metadata about your backup plans.</p>
|
|
3461
3896
|
*/
|
|
3462
3897
|
BackupPlanVersionsList?: BackupPlansListMember[];
|
|
@@ -3466,10 +3901,12 @@ export interface ListBackupPlanVersionsOutput {
|
|
|
3466
3901
|
*/
|
|
3467
3902
|
export interface ListBackupSelectionsInput {
|
|
3468
3903
|
/**
|
|
3904
|
+
* @public
|
|
3469
3905
|
* <p>Uniquely identifies a backup plan.</p>
|
|
3470
3906
|
*/
|
|
3471
3907
|
BackupPlanId: string | undefined;
|
|
3472
3908
|
/**
|
|
3909
|
+
* @public
|
|
3473
3910
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3474
3911
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3475
3912
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3477,6 +3914,7 @@ export interface ListBackupSelectionsInput {
|
|
|
3477
3914
|
*/
|
|
3478
3915
|
NextToken?: string;
|
|
3479
3916
|
/**
|
|
3917
|
+
* @public
|
|
3480
3918
|
* <p>The maximum number of items to be returned.</p>
|
|
3481
3919
|
*/
|
|
3482
3920
|
MaxResults?: number;
|
|
@@ -3486,6 +3924,7 @@ export interface ListBackupSelectionsInput {
|
|
|
3486
3924
|
*/
|
|
3487
3925
|
export interface ListBackupSelectionsOutput {
|
|
3488
3926
|
/**
|
|
3927
|
+
* @public
|
|
3489
3928
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3490
3929
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3491
3930
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3493,6 +3932,7 @@ export interface ListBackupSelectionsOutput {
|
|
|
3493
3932
|
*/
|
|
3494
3933
|
NextToken?: string;
|
|
3495
3934
|
/**
|
|
3935
|
+
* @public
|
|
3496
3936
|
* <p>An array of backup selection list items containing metadata about each resource in the
|
|
3497
3937
|
* list.</p>
|
|
3498
3938
|
*/
|
|
@@ -3503,6 +3943,7 @@ export interface ListBackupSelectionsOutput {
|
|
|
3503
3943
|
*/
|
|
3504
3944
|
export interface ListBackupVaultsInput {
|
|
3505
3945
|
/**
|
|
3946
|
+
* @public
|
|
3506
3947
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3507
3948
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3508
3949
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3510,6 +3951,7 @@ export interface ListBackupVaultsInput {
|
|
|
3510
3951
|
*/
|
|
3511
3952
|
NextToken?: string;
|
|
3512
3953
|
/**
|
|
3954
|
+
* @public
|
|
3513
3955
|
* <p>The maximum number of items to be returned.</p>
|
|
3514
3956
|
*/
|
|
3515
3957
|
MaxResults?: number;
|
|
@@ -3519,12 +3961,14 @@ export interface ListBackupVaultsInput {
|
|
|
3519
3961
|
*/
|
|
3520
3962
|
export interface ListBackupVaultsOutput {
|
|
3521
3963
|
/**
|
|
3964
|
+
* @public
|
|
3522
3965
|
* <p>An array of backup vault list members containing vault metadata, including Amazon
|
|
3523
3966
|
* Resource Name (ARN), display name, creation date, number of saved recovery points, and
|
|
3524
3967
|
* encryption information if the resources saved in the backup vault are encrypted.</p>
|
|
3525
3968
|
*/
|
|
3526
3969
|
BackupVaultList?: BackupVaultListMember[];
|
|
3527
3970
|
/**
|
|
3971
|
+
* @public
|
|
3528
3972
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3529
3973
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3530
3974
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3537,33 +3981,40 @@ export interface ListBackupVaultsOutput {
|
|
|
3537
3981
|
*/
|
|
3538
3982
|
export interface ListCopyJobsInput {
|
|
3539
3983
|
/**
|
|
3984
|
+
* @public
|
|
3540
3985
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3541
3986
|
* made to return maxResults number of items, NextToken allows you to return more items in
|
|
3542
3987
|
* your list starting at the location pointed to by the next token. </p>
|
|
3543
3988
|
*/
|
|
3544
3989
|
NextToken?: string;
|
|
3545
3990
|
/**
|
|
3991
|
+
* @public
|
|
3546
3992
|
* <p>The maximum number of items to be returned.</p>
|
|
3547
3993
|
*/
|
|
3548
3994
|
MaxResults?: number;
|
|
3549
3995
|
/**
|
|
3996
|
+
* @public
|
|
3550
3997
|
* <p>Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
|
|
3551
3998
|
* </p>
|
|
3552
3999
|
*/
|
|
3553
4000
|
ByResourceArn?: string;
|
|
3554
4001
|
/**
|
|
4002
|
+
* @public
|
|
3555
4003
|
* <p>Returns only copy jobs that are in the specified state.</p>
|
|
3556
4004
|
*/
|
|
3557
4005
|
ByState?: CopyJobState | string;
|
|
3558
4006
|
/**
|
|
4007
|
+
* @public
|
|
3559
4008
|
* <p>Returns only copy jobs that were created before the specified date.</p>
|
|
3560
4009
|
*/
|
|
3561
4010
|
ByCreatedBefore?: Date;
|
|
3562
4011
|
/**
|
|
4012
|
+
* @public
|
|
3563
4013
|
* <p>Returns only copy jobs that were created after the specified date.</p>
|
|
3564
4014
|
*/
|
|
3565
4015
|
ByCreatedAfter?: Date;
|
|
3566
4016
|
/**
|
|
4017
|
+
* @public
|
|
3567
4018
|
* <p>Returns only backup jobs for the specified resources:</p>
|
|
3568
4019
|
* <ul>
|
|
3569
4020
|
* <li>
|
|
@@ -3618,27 +4069,32 @@ export interface ListCopyJobsInput {
|
|
|
3618
4069
|
*/
|
|
3619
4070
|
ByResourceType?: string;
|
|
3620
4071
|
/**
|
|
4072
|
+
* @public
|
|
3621
4073
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy
|
|
3622
4074
|
* from; for example, <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.
|
|
3623
4075
|
* </p>
|
|
3624
4076
|
*/
|
|
3625
4077
|
ByDestinationVaultArn?: string;
|
|
3626
4078
|
/**
|
|
4079
|
+
* @public
|
|
3627
4080
|
* <p>The account ID to list the jobs from. Returns only copy jobs associated with the
|
|
3628
4081
|
* specified account ID.</p>
|
|
3629
4082
|
*/
|
|
3630
4083
|
ByAccountId?: string;
|
|
3631
4084
|
/**
|
|
4085
|
+
* @public
|
|
3632
4086
|
* <p>Returns only copy jobs completed before a date expressed in Unix format and Coordinated
|
|
3633
4087
|
* Universal Time (UTC).</p>
|
|
3634
4088
|
*/
|
|
3635
4089
|
ByCompleteBefore?: Date;
|
|
3636
4090
|
/**
|
|
4091
|
+
* @public
|
|
3637
4092
|
* <p>Returns only copy jobs completed after a date expressed in Unix format and Coordinated
|
|
3638
4093
|
* Universal Time (UTC).</p>
|
|
3639
4094
|
*/
|
|
3640
4095
|
ByCompleteAfter?: Date;
|
|
3641
4096
|
/**
|
|
4097
|
+
* @public
|
|
3642
4098
|
* <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
|
|
3643
4099
|
*/
|
|
3644
4100
|
ByParentJobId?: string;
|
|
@@ -3648,11 +4104,13 @@ export interface ListCopyJobsInput {
|
|
|
3648
4104
|
*/
|
|
3649
4105
|
export interface ListCopyJobsOutput {
|
|
3650
4106
|
/**
|
|
4107
|
+
* @public
|
|
3651
4108
|
* <p>An array of structures containing metadata about your copy jobs returned in JSON format.
|
|
3652
4109
|
* </p>
|
|
3653
4110
|
*/
|
|
3654
4111
|
CopyJobs?: CopyJob[];
|
|
3655
4112
|
/**
|
|
4113
|
+
* @public
|
|
3656
4114
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3657
4115
|
* made to return maxResults number of items, NextToken allows you to return more items in
|
|
3658
4116
|
* your list starting at the location pointed to by the next token. </p>
|
|
@@ -3664,11 +4122,13 @@ export interface ListCopyJobsOutput {
|
|
|
3664
4122
|
*/
|
|
3665
4123
|
export interface ListFrameworksInput {
|
|
3666
4124
|
/**
|
|
4125
|
+
* @public
|
|
3667
4126
|
* <p>The number of desired results from 1 to 1000. Optional. If unspecified, the query will
|
|
3668
4127
|
* return 1 MB of data.</p>
|
|
3669
4128
|
*/
|
|
3670
4129
|
MaxResults?: number;
|
|
3671
4130
|
/**
|
|
4131
|
+
* @public
|
|
3672
4132
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
3673
4133
|
* used to return the next set of items in the list.</p>
|
|
3674
4134
|
*/
|
|
@@ -3682,24 +4142,29 @@ export interface ListFrameworksInput {
|
|
|
3682
4142
|
*/
|
|
3683
4143
|
export interface Framework {
|
|
3684
4144
|
/**
|
|
4145
|
+
* @public
|
|
3685
4146
|
* <p>The unique name of a framework. This name is between 1 and 256 characters, starting with
|
|
3686
4147
|
* a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
|
|
3687
4148
|
*/
|
|
3688
4149
|
FrameworkName?: string;
|
|
3689
4150
|
/**
|
|
4151
|
+
* @public
|
|
3690
4152
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
3691
4153
|
* depends on the resource type.</p>
|
|
3692
4154
|
*/
|
|
3693
4155
|
FrameworkArn?: string;
|
|
3694
4156
|
/**
|
|
4157
|
+
* @public
|
|
3695
4158
|
* <p>An optional description of the framework with a maximum 1,024 characters.</p>
|
|
3696
4159
|
*/
|
|
3697
4160
|
FrameworkDescription?: string;
|
|
3698
4161
|
/**
|
|
4162
|
+
* @public
|
|
3699
4163
|
* <p>The number of controls contained by the framework.</p>
|
|
3700
4164
|
*/
|
|
3701
4165
|
NumberOfControls?: number;
|
|
3702
4166
|
/**
|
|
4167
|
+
* @public
|
|
3703
4168
|
* <p>The date and time that a framework is created, in ISO 8601 representation.
|
|
3704
4169
|
* The value of <code>CreationTime</code> is accurate to milliseconds. For example,
|
|
3705
4170
|
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
@@ -3707,6 +4172,7 @@ export interface Framework {
|
|
|
3707
4172
|
*/
|
|
3708
4173
|
CreationTime?: Date;
|
|
3709
4174
|
/**
|
|
4175
|
+
* @public
|
|
3710
4176
|
* <p>The deployment status of a framework. The statuses are:</p>
|
|
3711
4177
|
* <p>
|
|
3712
4178
|
* <code>CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED |
|
|
@@ -3720,12 +4186,14 @@ export interface Framework {
|
|
|
3720
4186
|
*/
|
|
3721
4187
|
export interface ListFrameworksOutput {
|
|
3722
4188
|
/**
|
|
4189
|
+
* @public
|
|
3723
4190
|
* <p>A list of frameworks with details for each framework, including the framework name,
|
|
3724
4191
|
* Amazon Resource Name (ARN), description, number of controls, creation time, and deployment
|
|
3725
4192
|
* status.</p>
|
|
3726
4193
|
*/
|
|
3727
4194
|
Frameworks?: Framework[];
|
|
3728
4195
|
/**
|
|
4196
|
+
* @public
|
|
3729
4197
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
3730
4198
|
* used to return the next set of items in the list.</p>
|
|
3731
4199
|
*/
|
|
@@ -3736,6 +4204,7 @@ export interface ListFrameworksOutput {
|
|
|
3736
4204
|
*/
|
|
3737
4205
|
export interface ListLegalHoldsInput {
|
|
3738
4206
|
/**
|
|
4207
|
+
* @public
|
|
3739
4208
|
* <p>The next item following a partial list of returned resources. For example, if a request
|
|
3740
4209
|
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
3741
4210
|
* allows you to return more items in your list starting at the location pointed to by the
|
|
@@ -3743,6 +4212,7 @@ export interface ListLegalHoldsInput {
|
|
|
3743
4212
|
*/
|
|
3744
4213
|
NextToken?: string;
|
|
3745
4214
|
/**
|
|
4215
|
+
* @public
|
|
3746
4216
|
* <p>The maximum number of resource list items to be returned.</p>
|
|
3747
4217
|
*/
|
|
3748
4218
|
MaxResults?: number;
|
|
@@ -3760,33 +4230,40 @@ export interface ListLegalHoldsInput {
|
|
|
3760
4230
|
*/
|
|
3761
4231
|
export interface LegalHold {
|
|
3762
4232
|
/**
|
|
4233
|
+
* @public
|
|
3763
4234
|
* <p>This is the title of a legal hold.</p>
|
|
3764
4235
|
*/
|
|
3765
4236
|
Title?: string;
|
|
3766
4237
|
/**
|
|
4238
|
+
* @public
|
|
3767
4239
|
* <p>This is the status of the legal hold. Statuses can be
|
|
3768
4240
|
* <code>ACTIVE</code>, <code>CREATING</code>, <code>CANCELED</code>, and
|
|
3769
4241
|
* <code>CANCELING</code>.</p>
|
|
3770
4242
|
*/
|
|
3771
4243
|
Status?: LegalHoldStatus | string;
|
|
3772
4244
|
/**
|
|
4245
|
+
* @public
|
|
3773
4246
|
* <p>This is the description of a legal hold.</p>
|
|
3774
4247
|
*/
|
|
3775
4248
|
Description?: string;
|
|
3776
4249
|
/**
|
|
4250
|
+
* @public
|
|
3777
4251
|
* <p>ID of specific legal hold on one or more recovery points.</p>
|
|
3778
4252
|
*/
|
|
3779
4253
|
LegalHoldId?: string;
|
|
3780
4254
|
/**
|
|
4255
|
+
* @public
|
|
3781
4256
|
* <p>This is an Amazon Resource Number (ARN) that uniquely identifies the legal hold; for example,
|
|
3782
4257
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
3783
4258
|
*/
|
|
3784
4259
|
LegalHoldArn?: string;
|
|
3785
4260
|
/**
|
|
4261
|
+
* @public
|
|
3786
4262
|
* <p>This is the time in number format when legal hold was created.</p>
|
|
3787
4263
|
*/
|
|
3788
4264
|
CreationDate?: Date;
|
|
3789
4265
|
/**
|
|
4266
|
+
* @public
|
|
3790
4267
|
* <p>This is the time in number format when legal hold was cancelled.</p>
|
|
3791
4268
|
*/
|
|
3792
4269
|
CancellationDate?: Date;
|
|
@@ -3796,6 +4273,7 @@ export interface LegalHold {
|
|
|
3796
4273
|
*/
|
|
3797
4274
|
export interface ListLegalHoldsOutput {
|
|
3798
4275
|
/**
|
|
4276
|
+
* @public
|
|
3799
4277
|
* <p>The next item following a partial list of returned resources. For example, if a request
|
|
3800
4278
|
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
3801
4279
|
* allows you to return more items in your list starting at the location pointed to by the
|
|
@@ -3803,6 +4281,7 @@ export interface ListLegalHoldsOutput {
|
|
|
3803
4281
|
*/
|
|
3804
4282
|
NextToken?: string;
|
|
3805
4283
|
/**
|
|
4284
|
+
* @public
|
|
3806
4285
|
* <p>This is an array of returned legal holds, both active and previous.</p>
|
|
3807
4286
|
*/
|
|
3808
4287
|
LegalHolds?: LegalHold[];
|
|
@@ -3812,6 +4291,7 @@ export interface ListLegalHoldsOutput {
|
|
|
3812
4291
|
*/
|
|
3813
4292
|
export interface ListProtectedResourcesInput {
|
|
3814
4293
|
/**
|
|
4294
|
+
* @public
|
|
3815
4295
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3816
4296
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3817
4297
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3819,6 +4299,7 @@ export interface ListProtectedResourcesInput {
|
|
|
3819
4299
|
*/
|
|
3820
4300
|
NextToken?: string;
|
|
3821
4301
|
/**
|
|
4302
|
+
* @public
|
|
3822
4303
|
* <p>The maximum number of items to be returned.</p>
|
|
3823
4304
|
*/
|
|
3824
4305
|
MaxResults?: number;
|
|
@@ -3829,17 +4310,20 @@ export interface ListProtectedResourcesInput {
|
|
|
3829
4310
|
*/
|
|
3830
4311
|
export interface ProtectedResource {
|
|
3831
4312
|
/**
|
|
4313
|
+
* @public
|
|
3832
4314
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
3833
4315
|
* depends on the resource type.</p>
|
|
3834
4316
|
*/
|
|
3835
4317
|
ResourceArn?: string;
|
|
3836
4318
|
/**
|
|
4319
|
+
* @public
|
|
3837
4320
|
* <p>The type of Amazon Web Services resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For
|
|
3838
4321
|
* Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is
|
|
3839
4322
|
* Amazon EC2.</p>
|
|
3840
4323
|
*/
|
|
3841
4324
|
ResourceType?: string;
|
|
3842
4325
|
/**
|
|
4326
|
+
* @public
|
|
3843
4327
|
* <p>The date and time a resource was last backed up, in Unix format and Coordinated
|
|
3844
4328
|
* Universal Time (UTC). The value of <code>LastBackupTime</code> is accurate to milliseconds.
|
|
3845
4329
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -3847,6 +4331,7 @@ export interface ProtectedResource {
|
|
|
3847
4331
|
*/
|
|
3848
4332
|
LastBackupTime?: Date;
|
|
3849
4333
|
/**
|
|
4334
|
+
* @public
|
|
3850
4335
|
* <p>This is the non-unique name of the resource that
|
|
3851
4336
|
* belongs to the specified backup.</p>
|
|
3852
4337
|
*/
|
|
@@ -3857,12 +4342,14 @@ export interface ProtectedResource {
|
|
|
3857
4342
|
*/
|
|
3858
4343
|
export interface ListProtectedResourcesOutput {
|
|
3859
4344
|
/**
|
|
4345
|
+
* @public
|
|
3860
4346
|
* <p>An array of resources successfully backed up by Backup including the time
|
|
3861
4347
|
* the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource
|
|
3862
4348
|
* type.</p>
|
|
3863
4349
|
*/
|
|
3864
4350
|
Results?: ProtectedResource[];
|
|
3865
4351
|
/**
|
|
4352
|
+
* @public
|
|
3866
4353
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3867
4354
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3868
4355
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3875,6 +4362,7 @@ export interface ListProtectedResourcesOutput {
|
|
|
3875
4362
|
*/
|
|
3876
4363
|
export interface ListRecoveryPointsByBackupVaultInput {
|
|
3877
4364
|
/**
|
|
4365
|
+
* @public
|
|
3878
4366
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3879
4367
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
3880
4368
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -3886,6 +4374,7 @@ export interface ListRecoveryPointsByBackupVaultInput {
|
|
|
3886
4374
|
*/
|
|
3887
4375
|
BackupVaultName: string | undefined;
|
|
3888
4376
|
/**
|
|
4377
|
+
* @public
|
|
3889
4378
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
3890
4379
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
3891
4380
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -3893,31 +4382,38 @@ export interface ListRecoveryPointsByBackupVaultInput {
|
|
|
3893
4382
|
*/
|
|
3894
4383
|
NextToken?: string;
|
|
3895
4384
|
/**
|
|
4385
|
+
* @public
|
|
3896
4386
|
* <p>The maximum number of items to be returned.</p>
|
|
3897
4387
|
*/
|
|
3898
4388
|
MaxResults?: number;
|
|
3899
4389
|
/**
|
|
4390
|
+
* @public
|
|
3900
4391
|
* <p>Returns only recovery points that match the specified resource Amazon Resource Name
|
|
3901
4392
|
* (ARN).</p>
|
|
3902
4393
|
*/
|
|
3903
4394
|
ByResourceArn?: string;
|
|
3904
4395
|
/**
|
|
4396
|
+
* @public
|
|
3905
4397
|
* <p>Returns only recovery points that match the specified resource type.</p>
|
|
3906
4398
|
*/
|
|
3907
4399
|
ByResourceType?: string;
|
|
3908
4400
|
/**
|
|
4401
|
+
* @public
|
|
3909
4402
|
* <p>Returns only recovery points that match the specified backup plan ID.</p>
|
|
3910
4403
|
*/
|
|
3911
4404
|
ByBackupPlanId?: string;
|
|
3912
4405
|
/**
|
|
4406
|
+
* @public
|
|
3913
4407
|
* <p>Returns only recovery points that were created before the specified timestamp.</p>
|
|
3914
4408
|
*/
|
|
3915
4409
|
ByCreatedBefore?: Date;
|
|
3916
4410
|
/**
|
|
4411
|
+
* @public
|
|
3917
4412
|
* <p>Returns only recovery points that were created after the specified timestamp.</p>
|
|
3918
4413
|
*/
|
|
3919
4414
|
ByCreatedAfter?: Date;
|
|
3920
4415
|
/**
|
|
4416
|
+
* @public
|
|
3921
4417
|
* <p>This returns only recovery points that match the specified parent (composite)
|
|
3922
4418
|
* recovery point Amazon Resource Name (ARN).</p>
|
|
3923
4419
|
*/
|
|
@@ -3929,11 +4425,13 @@ export interface ListRecoveryPointsByBackupVaultInput {
|
|
|
3929
4425
|
*/
|
|
3930
4426
|
export interface RecoveryPointByBackupVault {
|
|
3931
4427
|
/**
|
|
4428
|
+
* @public
|
|
3932
4429
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
3933
4430
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
3934
4431
|
*/
|
|
3935
4432
|
RecoveryPointArn?: string;
|
|
3936
4433
|
/**
|
|
4434
|
+
* @public
|
|
3937
4435
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
3938
4436
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
3939
4437
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -3941,46 +4439,55 @@ export interface RecoveryPointByBackupVault {
|
|
|
3941
4439
|
*/
|
|
3942
4440
|
BackupVaultName?: string;
|
|
3943
4441
|
/**
|
|
4442
|
+
* @public
|
|
3944
4443
|
* <p>An ARN that uniquely identifies a backup vault; for example,
|
|
3945
4444
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
3946
4445
|
*/
|
|
3947
4446
|
BackupVaultArn?: string;
|
|
3948
4447
|
/**
|
|
4448
|
+
* @public
|
|
3949
4449
|
* <p>The backup vault where the recovery point was originally copied from. If the recovery
|
|
3950
4450
|
* point is restored to the same account this value will be <code>null</code>.</p>
|
|
3951
4451
|
*/
|
|
3952
4452
|
SourceBackupVaultArn?: string;
|
|
3953
4453
|
/**
|
|
4454
|
+
* @public
|
|
3954
4455
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the
|
|
3955
4456
|
* resource type.</p>
|
|
3956
4457
|
*/
|
|
3957
4458
|
ResourceArn?: string;
|
|
3958
4459
|
/**
|
|
4460
|
+
* @public
|
|
3959
4461
|
* <p>The type of Amazon Web Services resource saved as a recovery point; for example, an
|
|
3960
4462
|
* Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only
|
|
3961
4463
|
* supported resource type is Amazon EC2.</p>
|
|
3962
4464
|
*/
|
|
3963
4465
|
ResourceType?: string;
|
|
3964
4466
|
/**
|
|
4467
|
+
* @public
|
|
3965
4468
|
* <p>Contains identifying information about the creation of a recovery point, including the
|
|
3966
4469
|
* <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>,
|
|
3967
4470
|
* and <code>BackupRuleId</code> of the backup plan that is used to create it.</p>
|
|
3968
4471
|
*/
|
|
3969
4472
|
CreatedBy?: RecoveryPointCreator;
|
|
3970
4473
|
/**
|
|
4474
|
+
* @public
|
|
3971
4475
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
3972
4476
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
3973
4477
|
*/
|
|
3974
4478
|
IamRoleArn?: string;
|
|
3975
4479
|
/**
|
|
4480
|
+
* @public
|
|
3976
4481
|
* <p>A status code specifying the state of the recovery point.</p>
|
|
3977
4482
|
*/
|
|
3978
4483
|
Status?: RecoveryPointStatus | string;
|
|
3979
4484
|
/**
|
|
4485
|
+
* @public
|
|
3980
4486
|
* <p>A message explaining the reason of the recovery point deletion failure.</p>
|
|
3981
4487
|
*/
|
|
3982
4488
|
StatusMessage?: string;
|
|
3983
4489
|
/**
|
|
4490
|
+
* @public
|
|
3984
4491
|
* <p>The date and time a recovery point is created, in Unix format and Coordinated Universal
|
|
3985
4492
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
3986
4493
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -3988,6 +4495,7 @@ export interface RecoveryPointByBackupVault {
|
|
|
3988
4495
|
*/
|
|
3989
4496
|
CreationDate?: Date;
|
|
3990
4497
|
/**
|
|
4498
|
+
* @public
|
|
3991
4499
|
* <p>The date and time a job to restore a recovery point is completed, in Unix format and
|
|
3992
4500
|
* Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to
|
|
3993
4501
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -3995,15 +4503,18 @@ export interface RecoveryPointByBackupVault {
|
|
|
3995
4503
|
*/
|
|
3996
4504
|
CompletionDate?: Date;
|
|
3997
4505
|
/**
|
|
4506
|
+
* @public
|
|
3998
4507
|
* <p>The size, in bytes, of a backup.</p>
|
|
3999
4508
|
*/
|
|
4000
4509
|
BackupSizeInBytes?: number;
|
|
4001
4510
|
/**
|
|
4511
|
+
* @public
|
|
4002
4512
|
* <p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and
|
|
4003
4513
|
* <code>MoveToColdStorageAt</code> timestamps.</p>
|
|
4004
4514
|
*/
|
|
4005
4515
|
CalculatedLifecycle?: CalculatedLifecycle;
|
|
4006
4516
|
/**
|
|
4517
|
+
* @public
|
|
4007
4518
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
4008
4519
|
* it expires. Backup transitions and expires backups automatically according to
|
|
4009
4520
|
* the lifecycle that you define. </p>
|
|
@@ -4018,16 +4529,19 @@ export interface RecoveryPointByBackupVault {
|
|
|
4018
4529
|
*/
|
|
4019
4530
|
Lifecycle?: Lifecycle;
|
|
4020
4531
|
/**
|
|
4532
|
+
* @public
|
|
4021
4533
|
* <p>The server-side encryption key that is used to protect your backups; for example,
|
|
4022
4534
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
4023
4535
|
*/
|
|
4024
4536
|
EncryptionKeyArn?: string;
|
|
4025
4537
|
/**
|
|
4538
|
+
* @public
|
|
4026
4539
|
* <p>A Boolean value that is returned as <code>TRUE</code> if the specified recovery point is
|
|
4027
4540
|
* encrypted, or <code>FALSE</code> if the recovery point is not encrypted.</p>
|
|
4028
4541
|
*/
|
|
4029
4542
|
IsEncrypted?: boolean;
|
|
4030
4543
|
/**
|
|
4544
|
+
* @public
|
|
4031
4545
|
* <p>The date and time a recovery point was last restored, in Unix format and Coordinated
|
|
4032
4546
|
* Universal Time (UTC). The value of <code>LastRestoreTime</code> is accurate to
|
|
4033
4547
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -4035,11 +4549,13 @@ export interface RecoveryPointByBackupVault {
|
|
|
4035
4549
|
*/
|
|
4036
4550
|
LastRestoreTime?: Date;
|
|
4037
4551
|
/**
|
|
4552
|
+
* @public
|
|
4038
4553
|
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
4039
4554
|
* recovery point.</p>
|
|
4040
4555
|
*/
|
|
4041
4556
|
ParentRecoveryPointArn?: string;
|
|
4042
4557
|
/**
|
|
4558
|
+
* @public
|
|
4043
4559
|
* <p>This is the identifier of a resource within a composite group, such as
|
|
4044
4560
|
* nested (child) recovery point belonging to a composite (parent) stack. The
|
|
4045
4561
|
* ID is transferred from
|
|
@@ -4048,11 +4564,13 @@ export interface RecoveryPointByBackupVault {
|
|
|
4048
4564
|
*/
|
|
4049
4565
|
CompositeMemberIdentifier?: string;
|
|
4050
4566
|
/**
|
|
4567
|
+
* @public
|
|
4051
4568
|
* <p>This is a boolean value indicating this is
|
|
4052
4569
|
* a parent (composite) recovery point.</p>
|
|
4053
4570
|
*/
|
|
4054
4571
|
IsParent?: boolean;
|
|
4055
4572
|
/**
|
|
4573
|
+
* @public
|
|
4056
4574
|
* <p>This is the non-unique name of the resource that
|
|
4057
4575
|
* belongs to the specified backup.</p>
|
|
4058
4576
|
*/
|
|
@@ -4063,6 +4581,7 @@ export interface RecoveryPointByBackupVault {
|
|
|
4063
4581
|
*/
|
|
4064
4582
|
export interface ListRecoveryPointsByBackupVaultOutput {
|
|
4065
4583
|
/**
|
|
4584
|
+
* @public
|
|
4066
4585
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4067
4586
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4068
4587
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4070,6 +4589,7 @@ export interface ListRecoveryPointsByBackupVaultOutput {
|
|
|
4070
4589
|
*/
|
|
4071
4590
|
NextToken?: string;
|
|
4072
4591
|
/**
|
|
4592
|
+
* @public
|
|
4073
4593
|
* <p>An array of objects that contain detailed information about recovery points saved in a
|
|
4074
4594
|
* backup vault.</p>
|
|
4075
4595
|
*/
|
|
@@ -4080,10 +4600,12 @@ export interface ListRecoveryPointsByBackupVaultOutput {
|
|
|
4080
4600
|
*/
|
|
4081
4601
|
export interface ListRecoveryPointsByLegalHoldInput {
|
|
4082
4602
|
/**
|
|
4603
|
+
* @public
|
|
4083
4604
|
* <p>This is the ID of the legal hold.</p>
|
|
4084
4605
|
*/
|
|
4085
4606
|
LegalHoldId: string | undefined;
|
|
4086
4607
|
/**
|
|
4608
|
+
* @public
|
|
4087
4609
|
* <p>This is the next item following a partial list of returned resources. For example, if a request
|
|
4088
4610
|
* is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
|
|
4089
4611
|
* allows you to return more items in your list starting at the location pointed to by the
|
|
@@ -4091,6 +4613,7 @@ export interface ListRecoveryPointsByLegalHoldInput {
|
|
|
4091
4613
|
*/
|
|
4092
4614
|
NextToken?: string;
|
|
4093
4615
|
/**
|
|
4616
|
+
* @public
|
|
4094
4617
|
* <p>This is the maximum number of resource list items to be returned.</p>
|
|
4095
4618
|
*/
|
|
4096
4619
|
MaxResults?: number;
|
|
@@ -4104,21 +4627,25 @@ export interface ListRecoveryPointsByLegalHoldInput {
|
|
|
4104
4627
|
*/
|
|
4105
4628
|
export interface RecoveryPointMember {
|
|
4106
4629
|
/**
|
|
4630
|
+
* @public
|
|
4107
4631
|
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
4108
4632
|
* recovery point.</p>
|
|
4109
4633
|
*/
|
|
4110
4634
|
RecoveryPointArn?: string;
|
|
4111
4635
|
/**
|
|
4636
|
+
* @public
|
|
4112
4637
|
* <p>This is the Amazon Resource Name (ARN) that uniquely identifies
|
|
4113
4638
|
* a saved resource.</p>
|
|
4114
4639
|
*/
|
|
4115
4640
|
ResourceArn?: string;
|
|
4116
4641
|
/**
|
|
4642
|
+
* @public
|
|
4117
4643
|
* <p>This is the Amazon Web Services resource type that is saved as
|
|
4118
4644
|
* a recovery point.</p>
|
|
4119
4645
|
*/
|
|
4120
4646
|
ResourceType?: string;
|
|
4121
4647
|
/**
|
|
4648
|
+
* @public
|
|
4122
4649
|
* <p>This is the name of the backup vault
|
|
4123
4650
|
* (the logical container in which backups are stored).</p>
|
|
4124
4651
|
*/
|
|
@@ -4129,11 +4656,13 @@ export interface RecoveryPointMember {
|
|
|
4129
4656
|
*/
|
|
4130
4657
|
export interface ListRecoveryPointsByLegalHoldOutput {
|
|
4131
4658
|
/**
|
|
4659
|
+
* @public
|
|
4132
4660
|
* <p>This is a list of the recovery points returned by
|
|
4133
4661
|
* <code>ListRecoveryPointsByLegalHold</code>.</p>
|
|
4134
4662
|
*/
|
|
4135
4663
|
RecoveryPoints?: RecoveryPointMember[];
|
|
4136
4664
|
/**
|
|
4665
|
+
* @public
|
|
4137
4666
|
* <p>This return is the next item following a partial list of returned resources.</p>
|
|
4138
4667
|
*/
|
|
4139
4668
|
NextToken?: string;
|
|
@@ -4143,11 +4672,13 @@ export interface ListRecoveryPointsByLegalHoldOutput {
|
|
|
4143
4672
|
*/
|
|
4144
4673
|
export interface ListRecoveryPointsByResourceInput {
|
|
4145
4674
|
/**
|
|
4675
|
+
* @public
|
|
4146
4676
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the
|
|
4147
4677
|
* resource type.</p>
|
|
4148
4678
|
*/
|
|
4149
4679
|
ResourceArn: string | undefined;
|
|
4150
4680
|
/**
|
|
4681
|
+
* @public
|
|
4151
4682
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4152
4683
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4153
4684
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4155,6 +4686,7 @@ export interface ListRecoveryPointsByResourceInput {
|
|
|
4155
4686
|
*/
|
|
4156
4687
|
NextToken?: string;
|
|
4157
4688
|
/**
|
|
4689
|
+
* @public
|
|
4158
4690
|
* <p>The maximum number of items to be returned.</p>
|
|
4159
4691
|
* <note>
|
|
4160
4692
|
* <p>Amazon RDS requires a value of at least 20.</p>
|
|
@@ -4168,11 +4700,13 @@ export interface ListRecoveryPointsByResourceInput {
|
|
|
4168
4700
|
*/
|
|
4169
4701
|
export interface RecoveryPointByResource {
|
|
4170
4702
|
/**
|
|
4703
|
+
* @public
|
|
4171
4704
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
4172
4705
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
4173
4706
|
*/
|
|
4174
4707
|
RecoveryPointArn?: string;
|
|
4175
4708
|
/**
|
|
4709
|
+
* @public
|
|
4176
4710
|
* <p>The date and time a recovery point is created, in Unix format and Coordinated Universal
|
|
4177
4711
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
4178
4712
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -4180,23 +4714,28 @@ export interface RecoveryPointByResource {
|
|
|
4180
4714
|
*/
|
|
4181
4715
|
CreationDate?: Date;
|
|
4182
4716
|
/**
|
|
4717
|
+
* @public
|
|
4183
4718
|
* <p>A status code specifying the state of the recovery point.</p>
|
|
4184
4719
|
*/
|
|
4185
4720
|
Status?: RecoveryPointStatus | string;
|
|
4186
4721
|
/**
|
|
4722
|
+
* @public
|
|
4187
4723
|
* <p>A message explaining the reason of the recovery point deletion failure.</p>
|
|
4188
4724
|
*/
|
|
4189
4725
|
StatusMessage?: string;
|
|
4190
4726
|
/**
|
|
4727
|
+
* @public
|
|
4191
4728
|
* <p>The server-side encryption key that is used to protect your backups; for example,
|
|
4192
4729
|
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>
|
|
4193
4730
|
*/
|
|
4194
4731
|
EncryptionKeyArn?: string;
|
|
4195
4732
|
/**
|
|
4733
|
+
* @public
|
|
4196
4734
|
* <p>The size, in bytes, of a backup.</p>
|
|
4197
4735
|
*/
|
|
4198
4736
|
BackupSizeBytes?: number;
|
|
4199
4737
|
/**
|
|
4738
|
+
* @public
|
|
4200
4739
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
4201
4740
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
4202
4741
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -4204,16 +4743,19 @@ export interface RecoveryPointByResource {
|
|
|
4204
4743
|
*/
|
|
4205
4744
|
BackupVaultName?: string;
|
|
4206
4745
|
/**
|
|
4746
|
+
* @public
|
|
4207
4747
|
* <p>This is a boolean value indicating this is
|
|
4208
4748
|
* a parent (composite) recovery point.</p>
|
|
4209
4749
|
*/
|
|
4210
4750
|
IsParent?: boolean;
|
|
4211
4751
|
/**
|
|
4752
|
+
* @public
|
|
4212
4753
|
* <p>This is the Amazon Resource Name (ARN) of the parent (composite)
|
|
4213
4754
|
* recovery point.</p>
|
|
4214
4755
|
*/
|
|
4215
4756
|
ParentRecoveryPointArn?: string;
|
|
4216
4757
|
/**
|
|
4758
|
+
* @public
|
|
4217
4759
|
* <p>This is the non-unique name of the resource that
|
|
4218
4760
|
* belongs to the specified backup.</p>
|
|
4219
4761
|
*/
|
|
@@ -4224,6 +4766,7 @@ export interface RecoveryPointByResource {
|
|
|
4224
4766
|
*/
|
|
4225
4767
|
export interface ListRecoveryPointsByResourceOutput {
|
|
4226
4768
|
/**
|
|
4769
|
+
* @public
|
|
4227
4770
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4228
4771
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4229
4772
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4231,6 +4774,7 @@ export interface ListRecoveryPointsByResourceOutput {
|
|
|
4231
4774
|
*/
|
|
4232
4775
|
NextToken?: string;
|
|
4233
4776
|
/**
|
|
4777
|
+
* @public
|
|
4234
4778
|
* <p>An array of objects that contain detailed information about recovery points of the
|
|
4235
4779
|
* specified resource type.</p>
|
|
4236
4780
|
* <note>
|
|
@@ -4245,22 +4789,26 @@ export interface ListRecoveryPointsByResourceOutput {
|
|
|
4245
4789
|
*/
|
|
4246
4790
|
export interface ListReportJobsInput {
|
|
4247
4791
|
/**
|
|
4792
|
+
* @public
|
|
4248
4793
|
* <p>Returns only report jobs with the specified report plan name.</p>
|
|
4249
4794
|
*/
|
|
4250
4795
|
ByReportPlanName?: string;
|
|
4251
4796
|
/**
|
|
4797
|
+
* @public
|
|
4252
4798
|
* <p>Returns only report jobs that were created before the date and time specified in Unix
|
|
4253
4799
|
* format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents
|
|
4254
4800
|
* Friday, January 26, 2018 12:11:30 AM.</p>
|
|
4255
4801
|
*/
|
|
4256
4802
|
ByCreationBefore?: Date;
|
|
4257
4803
|
/**
|
|
4804
|
+
* @public
|
|
4258
4805
|
* <p>Returns only report jobs that were created after the date and time specified in Unix
|
|
4259
4806
|
* format and Coordinated Universal Time (UTC). For example, the value 1516925490 represents
|
|
4260
4807
|
* Friday, January 26, 2018 12:11:30 AM.</p>
|
|
4261
4808
|
*/
|
|
4262
4809
|
ByCreationAfter?: Date;
|
|
4263
4810
|
/**
|
|
4811
|
+
* @public
|
|
4264
4812
|
* <p>Returns only report jobs that are in the specified status. The statuses are:</p>
|
|
4265
4813
|
* <p>
|
|
4266
4814
|
* <code>CREATED | RUNNING | COMPLETED | FAILED</code>
|
|
@@ -4268,11 +4816,13 @@ export interface ListReportJobsInput {
|
|
|
4268
4816
|
*/
|
|
4269
4817
|
ByStatus?: string;
|
|
4270
4818
|
/**
|
|
4819
|
+
* @public
|
|
4271
4820
|
* <p>The number of desired results from 1 to 1000. Optional. If unspecified, the query will
|
|
4272
4821
|
* return 1 MB of data.</p>
|
|
4273
4822
|
*/
|
|
4274
4823
|
MaxResults?: number;
|
|
4275
4824
|
/**
|
|
4825
|
+
* @public
|
|
4276
4826
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
4277
4827
|
* used to return the next set of items in the list.</p>
|
|
4278
4828
|
*/
|
|
@@ -4283,10 +4833,12 @@ export interface ListReportJobsInput {
|
|
|
4283
4833
|
*/
|
|
4284
4834
|
export interface ListReportJobsOutput {
|
|
4285
4835
|
/**
|
|
4836
|
+
* @public
|
|
4286
4837
|
* <p>Details about your report jobs in JSON format.</p>
|
|
4287
4838
|
*/
|
|
4288
4839
|
ReportJobs?: ReportJob[];
|
|
4289
4840
|
/**
|
|
4841
|
+
* @public
|
|
4290
4842
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
4291
4843
|
* used to return the next set of items in the list.</p>
|
|
4292
4844
|
*/
|
|
@@ -4297,11 +4849,13 @@ export interface ListReportJobsOutput {
|
|
|
4297
4849
|
*/
|
|
4298
4850
|
export interface ListReportPlansInput {
|
|
4299
4851
|
/**
|
|
4852
|
+
* @public
|
|
4300
4853
|
* <p>The number of desired results from 1 to 1000. Optional. If unspecified, the query will
|
|
4301
4854
|
* return 1 MB of data.</p>
|
|
4302
4855
|
*/
|
|
4303
4856
|
MaxResults?: number;
|
|
4304
4857
|
/**
|
|
4858
|
+
* @public
|
|
4305
4859
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
4306
4860
|
* used to return the next set of items in the list.</p>
|
|
4307
4861
|
*/
|
|
@@ -4312,6 +4866,7 @@ export interface ListReportPlansInput {
|
|
|
4312
4866
|
*/
|
|
4313
4867
|
export interface ListReportPlansOutput {
|
|
4314
4868
|
/**
|
|
4869
|
+
* @public
|
|
4315
4870
|
* <p>A list of your report plans with detailed information for each plan. This information
|
|
4316
4871
|
* includes the Amazon Resource Name (ARN), report plan name, description, settings, delivery
|
|
4317
4872
|
* channel, deployment status, creation time, and last times the report plan attempted to and
|
|
@@ -4319,6 +4874,7 @@ export interface ListReportPlansOutput {
|
|
|
4319
4874
|
*/
|
|
4320
4875
|
ReportPlans?: ReportPlan[];
|
|
4321
4876
|
/**
|
|
4877
|
+
* @public
|
|
4322
4878
|
* <p>An identifier that was returned from the previous call to this operation, which can be
|
|
4323
4879
|
* used to return the next set of items in the list.</p>
|
|
4324
4880
|
*/
|
|
@@ -4329,6 +4885,7 @@ export interface ListReportPlansOutput {
|
|
|
4329
4885
|
*/
|
|
4330
4886
|
export interface ListRestoreJobsInput {
|
|
4331
4887
|
/**
|
|
4888
|
+
* @public
|
|
4332
4889
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4333
4890
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4334
4891
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4336,32 +4893,39 @@ export interface ListRestoreJobsInput {
|
|
|
4336
4893
|
*/
|
|
4337
4894
|
NextToken?: string;
|
|
4338
4895
|
/**
|
|
4896
|
+
* @public
|
|
4339
4897
|
* <p>The maximum number of items to be returned.</p>
|
|
4340
4898
|
*/
|
|
4341
4899
|
MaxResults?: number;
|
|
4342
4900
|
/**
|
|
4901
|
+
* @public
|
|
4343
4902
|
* <p>The account ID to list the jobs from. Returns only restore jobs associated with the
|
|
4344
4903
|
* specified account ID.</p>
|
|
4345
4904
|
*/
|
|
4346
4905
|
ByAccountId?: string;
|
|
4347
4906
|
/**
|
|
4907
|
+
* @public
|
|
4348
4908
|
* <p>Returns only restore jobs that were created before the specified date.</p>
|
|
4349
4909
|
*/
|
|
4350
4910
|
ByCreatedBefore?: Date;
|
|
4351
4911
|
/**
|
|
4912
|
+
* @public
|
|
4352
4913
|
* <p>Returns only restore jobs that were created after the specified date.</p>
|
|
4353
4914
|
*/
|
|
4354
4915
|
ByCreatedAfter?: Date;
|
|
4355
4916
|
/**
|
|
4917
|
+
* @public
|
|
4356
4918
|
* <p>Returns only restore jobs associated with the specified job status.</p>
|
|
4357
4919
|
*/
|
|
4358
4920
|
ByStatus?: RestoreJobStatus | string;
|
|
4359
4921
|
/**
|
|
4922
|
+
* @public
|
|
4360
4923
|
* <p>Returns only copy jobs completed before a date expressed in Unix format and Coordinated
|
|
4361
4924
|
* Universal Time (UTC).</p>
|
|
4362
4925
|
*/
|
|
4363
4926
|
ByCompleteBefore?: Date;
|
|
4364
4927
|
/**
|
|
4928
|
+
* @public
|
|
4365
4929
|
* <p>Returns only copy jobs completed after a date expressed in Unix format and Coordinated
|
|
4366
4930
|
* Universal Time (UTC).</p>
|
|
4367
4931
|
*/
|
|
@@ -4373,19 +4937,23 @@ export interface ListRestoreJobsInput {
|
|
|
4373
4937
|
*/
|
|
4374
4938
|
export interface RestoreJobsListMember {
|
|
4375
4939
|
/**
|
|
4940
|
+
* @public
|
|
4376
4941
|
* <p>The account ID that owns the restore job.</p>
|
|
4377
4942
|
*/
|
|
4378
4943
|
AccountId?: string;
|
|
4379
4944
|
/**
|
|
4945
|
+
* @public
|
|
4380
4946
|
* <p>Uniquely identifies the job that restores a recovery point.</p>
|
|
4381
4947
|
*/
|
|
4382
4948
|
RestoreJobId?: string;
|
|
4383
4949
|
/**
|
|
4950
|
+
* @public
|
|
4384
4951
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
4385
4952
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
4386
4953
|
*/
|
|
4387
4954
|
RecoveryPointArn?: string;
|
|
4388
4955
|
/**
|
|
4956
|
+
* @public
|
|
4389
4957
|
* <p>The date and time a restore job is created, in Unix format and Coordinated Universal
|
|
4390
4958
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
4391
4959
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -4393,6 +4961,7 @@ export interface RestoreJobsListMember {
|
|
|
4393
4961
|
*/
|
|
4394
4962
|
CreationDate?: Date;
|
|
4395
4963
|
/**
|
|
4964
|
+
* @public
|
|
4396
4965
|
* <p>The date and time a job to restore a recovery point is completed, in Unix format and
|
|
4397
4966
|
* Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to
|
|
4398
4967
|
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
|
|
@@ -4400,39 +4969,47 @@ export interface RestoreJobsListMember {
|
|
|
4400
4969
|
*/
|
|
4401
4970
|
CompletionDate?: Date;
|
|
4402
4971
|
/**
|
|
4972
|
+
* @public
|
|
4403
4973
|
* <p>A status code specifying the state of the job initiated by Backup to restore
|
|
4404
4974
|
* a recovery point.</p>
|
|
4405
4975
|
*/
|
|
4406
4976
|
Status?: RestoreJobStatus | string;
|
|
4407
4977
|
/**
|
|
4978
|
+
* @public
|
|
4408
4979
|
* <p>A detailed message explaining the status of the job to restore a recovery point.</p>
|
|
4409
4980
|
*/
|
|
4410
4981
|
StatusMessage?: string;
|
|
4411
4982
|
/**
|
|
4983
|
+
* @public
|
|
4412
4984
|
* <p>Contains an estimated percentage complete of a job at the time the job status was
|
|
4413
4985
|
* queried.</p>
|
|
4414
4986
|
*/
|
|
4415
4987
|
PercentDone?: string;
|
|
4416
4988
|
/**
|
|
4989
|
+
* @public
|
|
4417
4990
|
* <p>The size, in bytes, of the restored resource.</p>
|
|
4418
4991
|
*/
|
|
4419
4992
|
BackupSizeInBytes?: number;
|
|
4420
4993
|
/**
|
|
4994
|
+
* @public
|
|
4421
4995
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
4422
4996
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
4423
4997
|
*/
|
|
4424
4998
|
IamRoleArn?: string;
|
|
4425
4999
|
/**
|
|
5000
|
+
* @public
|
|
4426
5001
|
* <p>The amount of time in minutes that a job restoring a recovery point is expected to
|
|
4427
5002
|
* take.</p>
|
|
4428
5003
|
*/
|
|
4429
5004
|
ExpectedCompletionTimeMinutes?: number;
|
|
4430
5005
|
/**
|
|
5006
|
+
* @public
|
|
4431
5007
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
4432
5008
|
* depends on the resource type.</p>
|
|
4433
5009
|
*/
|
|
4434
5010
|
CreatedResourceArn?: string;
|
|
4435
5011
|
/**
|
|
5012
|
+
* @public
|
|
4436
5013
|
* <p>The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store
|
|
4437
5014
|
* (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
|
|
4438
5015
|
* For Windows Volume Shadow Copy Service (VSS) backups, the only supported resource type is
|
|
@@ -4445,11 +5022,13 @@ export interface RestoreJobsListMember {
|
|
|
4445
5022
|
*/
|
|
4446
5023
|
export interface ListRestoreJobsOutput {
|
|
4447
5024
|
/**
|
|
5025
|
+
* @public
|
|
4448
5026
|
* <p>An array of objects that contain detailed information about jobs to restore saved
|
|
4449
5027
|
* resources.</p>
|
|
4450
5028
|
*/
|
|
4451
5029
|
RestoreJobs?: RestoreJobsListMember[];
|
|
4452
5030
|
/**
|
|
5031
|
+
* @public
|
|
4453
5032
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4454
5033
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4455
5034
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4462,12 +5041,14 @@ export interface ListRestoreJobsOutput {
|
|
|
4462
5041
|
*/
|
|
4463
5042
|
export interface ListTagsInput {
|
|
4464
5043
|
/**
|
|
5044
|
+
* @public
|
|
4465
5045
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
4466
5046
|
* depends on the type of resource. Valid targets for <code>ListTags</code> are recovery
|
|
4467
5047
|
* points, backup plans, and backup vaults.</p>
|
|
4468
5048
|
*/
|
|
4469
5049
|
ResourceArn: string | undefined;
|
|
4470
5050
|
/**
|
|
5051
|
+
* @public
|
|
4471
5052
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4472
5053
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4473
5054
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4475,6 +5056,7 @@ export interface ListTagsInput {
|
|
|
4475
5056
|
*/
|
|
4476
5057
|
NextToken?: string;
|
|
4477
5058
|
/**
|
|
5059
|
+
* @public
|
|
4478
5060
|
* <p>The maximum number of items to be returned.</p>
|
|
4479
5061
|
*/
|
|
4480
5062
|
MaxResults?: number;
|
|
@@ -4484,6 +5066,7 @@ export interface ListTagsInput {
|
|
|
4484
5066
|
*/
|
|
4485
5067
|
export interface ListTagsOutput {
|
|
4486
5068
|
/**
|
|
5069
|
+
* @public
|
|
4487
5070
|
* <p>The next item following a partial list of returned items. For example, if a request is
|
|
4488
5071
|
* made to return <code>maxResults</code> number of items, <code>NextToken</code> allows you
|
|
4489
5072
|
* to return more items in your list starting at the location pointed to by the next
|
|
@@ -4491,6 +5074,7 @@ export interface ListTagsOutput {
|
|
|
4491
5074
|
*/
|
|
4492
5075
|
NextToken?: string;
|
|
4493
5076
|
/**
|
|
5077
|
+
* @public
|
|
4494
5078
|
* <p>To help organize your resources, you can assign your own metadata to the resources you
|
|
4495
5079
|
* create. Each tag is a key-value pair.</p>
|
|
4496
5080
|
*/
|
|
@@ -4501,6 +5085,7 @@ export interface ListTagsOutput {
|
|
|
4501
5085
|
*/
|
|
4502
5086
|
export interface PutBackupVaultAccessPolicyInput {
|
|
4503
5087
|
/**
|
|
5088
|
+
* @public
|
|
4504
5089
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
4505
5090
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
4506
5091
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -4508,6 +5093,7 @@ export interface PutBackupVaultAccessPolicyInput {
|
|
|
4508
5093
|
*/
|
|
4509
5094
|
BackupVaultName: string | undefined;
|
|
4510
5095
|
/**
|
|
5096
|
+
* @public
|
|
4511
5097
|
* <p>The backup vault access policy document in JSON format.</p>
|
|
4512
5098
|
*/
|
|
4513
5099
|
Policy?: string;
|
|
@@ -4517,11 +5103,13 @@ export interface PutBackupVaultAccessPolicyInput {
|
|
|
4517
5103
|
*/
|
|
4518
5104
|
export interface PutBackupVaultLockConfigurationInput {
|
|
4519
5105
|
/**
|
|
5106
|
+
* @public
|
|
4520
5107
|
* <p>The Backup Vault Lock configuration that specifies the name of the backup
|
|
4521
5108
|
* vault it protects.</p>
|
|
4522
5109
|
*/
|
|
4523
5110
|
BackupVaultName: string | undefined;
|
|
4524
5111
|
/**
|
|
5112
|
+
* @public
|
|
4525
5113
|
* <p>The Backup Vault Lock configuration that specifies the minimum retention
|
|
4526
5114
|
* period that the vault retains its recovery points. This setting can be useful if, for
|
|
4527
5115
|
* example, your organization's policies require you to retain certain data for at least seven
|
|
@@ -4538,6 +5126,7 @@ export interface PutBackupVaultLockConfigurationInput {
|
|
|
4538
5126
|
*/
|
|
4539
5127
|
MinRetentionDays?: number;
|
|
4540
5128
|
/**
|
|
5129
|
+
* @public
|
|
4541
5130
|
* <p>The Backup Vault Lock configuration that specifies the maximum retention
|
|
4542
5131
|
* period that the vault retains its recovery points. This setting can be useful if, for
|
|
4543
5132
|
* example, your organization's policies require you to destroy certain data after retaining
|
|
@@ -4556,6 +5145,7 @@ export interface PutBackupVaultLockConfigurationInput {
|
|
|
4556
5145
|
*/
|
|
4557
5146
|
MaxRetentionDays?: number;
|
|
4558
5147
|
/**
|
|
5148
|
+
* @public
|
|
4559
5149
|
* <p>The Backup Vault Lock configuration that specifies the number of days before
|
|
4560
5150
|
* the lock date. For example, setting <code>ChangeableForDays</code> to 30 on Jan. 1, 2022 at
|
|
4561
5151
|
* 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.</p>
|
|
@@ -4577,6 +5167,7 @@ export interface PutBackupVaultLockConfigurationInput {
|
|
|
4577
5167
|
*/
|
|
4578
5168
|
export interface PutBackupVaultNotificationsInput {
|
|
4579
5169
|
/**
|
|
5170
|
+
* @public
|
|
4580
5171
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
4581
5172
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
4582
5173
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -4584,11 +5175,13 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
4584
5175
|
*/
|
|
4585
5176
|
BackupVaultName: string | undefined;
|
|
4586
5177
|
/**
|
|
5178
|
+
* @public
|
|
4587
5179
|
* <p>The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for
|
|
4588
5180
|
* example, <code>arn:aws:sns:us-west-2:111122223333:MyVaultTopic</code>.</p>
|
|
4589
5181
|
*/
|
|
4590
5182
|
SNSTopicArn: string | undefined;
|
|
4591
5183
|
/**
|
|
5184
|
+
* @public
|
|
4592
5185
|
* <p>An array of events that indicate the status of jobs to back up resources to the backup
|
|
4593
5186
|
* vault.</p>
|
|
4594
5187
|
* <p>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to
|
|
@@ -4631,6 +5224,7 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
4631
5224
|
*/
|
|
4632
5225
|
export interface StartBackupJobInput {
|
|
4633
5226
|
/**
|
|
5227
|
+
* @public
|
|
4634
5228
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
4635
5229
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
4636
5230
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -4638,22 +5232,26 @@ export interface StartBackupJobInput {
|
|
|
4638
5232
|
*/
|
|
4639
5233
|
BackupVaultName: string | undefined;
|
|
4640
5234
|
/**
|
|
5235
|
+
* @public
|
|
4641
5236
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
4642
5237
|
* depends on the resource type.</p>
|
|
4643
5238
|
*/
|
|
4644
5239
|
ResourceArn: string | undefined;
|
|
4645
5240
|
/**
|
|
5241
|
+
* @public
|
|
4646
5242
|
* <p>Specifies the IAM role ARN used to create the target recovery point; for example,
|
|
4647
5243
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
4648
5244
|
*/
|
|
4649
5245
|
IamRoleArn: string | undefined;
|
|
4650
5246
|
/**
|
|
5247
|
+
* @public
|
|
4651
5248
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
4652
5249
|
* calls to <code>StartBackupJob</code>. Retrying a successful request with the same
|
|
4653
5250
|
* idempotency token results in a success message with no action taken.</p>
|
|
4654
5251
|
*/
|
|
4655
5252
|
IdempotencyToken?: string;
|
|
4656
5253
|
/**
|
|
5254
|
+
* @public
|
|
4657
5255
|
* <p>A value in minutes after a backup is scheduled before a job will be canceled if it
|
|
4658
5256
|
* doesn't start successfully. This value is optional, and the default is 8 hours.
|
|
4659
5257
|
* If this value is included, it must be at least 60 minutes to avoid errors.</p>
|
|
@@ -4667,6 +5265,7 @@ export interface StartBackupJobInput {
|
|
|
4667
5265
|
*/
|
|
4668
5266
|
StartWindowMinutes?: number;
|
|
4669
5267
|
/**
|
|
5268
|
+
* @public
|
|
4670
5269
|
* <p>A value in minutes during which a successfully started backup must complete, or else
|
|
4671
5270
|
* Backup will cancel the job. This value is optional. This value begins
|
|
4672
5271
|
* counting down from when the backup was scheduled. It does not add additional time for
|
|
@@ -4674,6 +5273,7 @@ export interface StartBackupJobInput {
|
|
|
4674
5273
|
*/
|
|
4675
5274
|
CompleteWindowMinutes?: number;
|
|
4676
5275
|
/**
|
|
5276
|
+
* @public
|
|
4677
5277
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
4678
5278
|
* it expires. Backup will transition and expire backups automatically according
|
|
4679
5279
|
* to the lifecycle that you define. </p>
|
|
@@ -4688,11 +5288,13 @@ export interface StartBackupJobInput {
|
|
|
4688
5288
|
*/
|
|
4689
5289
|
Lifecycle?: Lifecycle;
|
|
4690
5290
|
/**
|
|
5291
|
+
* @public
|
|
4691
5292
|
* <p>To help organize your resources, you can assign your own metadata to the resources that
|
|
4692
5293
|
* you create. Each tag is a key-value pair.</p>
|
|
4693
5294
|
*/
|
|
4694
5295
|
RecoveryPointTags?: Record<string, string>;
|
|
4695
5296
|
/**
|
|
5297
|
+
* @public
|
|
4696
5298
|
* <p>Specifies the backup option for a selected resource. This option is only available for
|
|
4697
5299
|
* Windows Volume Shadow Copy Service (VSS) backup jobs.</p>
|
|
4698
5300
|
* <p>Valid values: Set to <code>"WindowsVSS":"enabled"</code> to enable the
|
|
@@ -4707,10 +5309,12 @@ export interface StartBackupJobInput {
|
|
|
4707
5309
|
*/
|
|
4708
5310
|
export interface StartBackupJobOutput {
|
|
4709
5311
|
/**
|
|
5312
|
+
* @public
|
|
4710
5313
|
* <p>Uniquely identifies a request to Backup to back up a resource.</p>
|
|
4711
5314
|
*/
|
|
4712
5315
|
BackupJobId?: string;
|
|
4713
5316
|
/**
|
|
5317
|
+
* @public
|
|
4714
5318
|
* <p>
|
|
4715
5319
|
* <i>Note: This field is only returned for Amazon EFS and Advanced DynamoDB
|
|
4716
5320
|
* resources.</i>
|
|
@@ -4720,6 +5324,7 @@ export interface StartBackupJobOutput {
|
|
|
4720
5324
|
*/
|
|
4721
5325
|
RecoveryPointArn?: string;
|
|
4722
5326
|
/**
|
|
5327
|
+
* @public
|
|
4723
5328
|
* <p>The date and time that a backup job is created, in Unix format and Coordinated Universal
|
|
4724
5329
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
4725
5330
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -4727,6 +5332,7 @@ export interface StartBackupJobOutput {
|
|
|
4727
5332
|
*/
|
|
4728
5333
|
CreationDate?: Date;
|
|
4729
5334
|
/**
|
|
5335
|
+
* @public
|
|
4730
5336
|
* <p>This is a returned boolean value indicating this is a parent (composite)
|
|
4731
5337
|
* backup job.</p>
|
|
4732
5338
|
*/
|
|
@@ -4737,35 +5343,41 @@ export interface StartBackupJobOutput {
|
|
|
4737
5343
|
*/
|
|
4738
5344
|
export interface StartCopyJobInput {
|
|
4739
5345
|
/**
|
|
5346
|
+
* @public
|
|
4740
5347
|
* <p>An ARN that uniquely identifies a recovery point to use for the copy job; for example,
|
|
4741
5348
|
* arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
|
|
4742
5349
|
* </p>
|
|
4743
5350
|
*/
|
|
4744
5351
|
RecoveryPointArn: string | undefined;
|
|
4745
5352
|
/**
|
|
5353
|
+
* @public
|
|
4746
5354
|
* <p>The name of a logical source container where backups are stored. Backup vaults are
|
|
4747
5355
|
* identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers,
|
|
4748
5356
|
* and hyphens.</p>
|
|
4749
5357
|
*/
|
|
4750
5358
|
SourceBackupVaultName: string | undefined;
|
|
4751
5359
|
/**
|
|
5360
|
+
* @public
|
|
4752
5361
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to
|
|
4753
5362
|
* copy to; for example,
|
|
4754
5363
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
4755
5364
|
*/
|
|
4756
5365
|
DestinationBackupVaultArn: string | undefined;
|
|
4757
5366
|
/**
|
|
5367
|
+
* @public
|
|
4758
5368
|
* <p>Specifies the IAM role ARN used to copy the target recovery point; for example,
|
|
4759
5369
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
4760
5370
|
*/
|
|
4761
5371
|
IamRoleArn: string | undefined;
|
|
4762
5372
|
/**
|
|
5373
|
+
* @public
|
|
4763
5374
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
4764
5375
|
* calls to <code>StartCopyJob</code>. Retrying a successful request with the same idempotency
|
|
4765
5376
|
* token results in a success message with no action taken.</p>
|
|
4766
5377
|
*/
|
|
4767
5378
|
IdempotencyToken?: string;
|
|
4768
5379
|
/**
|
|
5380
|
+
* @public
|
|
4769
5381
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
4770
5382
|
* a recovery point transitions to cold storage or is deleted.</p>
|
|
4771
5383
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
@@ -4784,10 +5396,12 @@ export interface StartCopyJobInput {
|
|
|
4784
5396
|
*/
|
|
4785
5397
|
export interface StartCopyJobOutput {
|
|
4786
5398
|
/**
|
|
5399
|
+
* @public
|
|
4787
5400
|
* <p>Uniquely identifies a copy job.</p>
|
|
4788
5401
|
*/
|
|
4789
5402
|
CopyJobId?: string;
|
|
4790
5403
|
/**
|
|
5404
|
+
* @public
|
|
4791
5405
|
* <p>The date and time that a copy job is created, in Unix format and Coordinated Universal
|
|
4792
5406
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
4793
5407
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -4795,6 +5409,7 @@ export interface StartCopyJobOutput {
|
|
|
4795
5409
|
*/
|
|
4796
5410
|
CreationDate?: Date;
|
|
4797
5411
|
/**
|
|
5412
|
+
* @public
|
|
4798
5413
|
* <p>This is a returned boolean value indicating this is a parent (composite)
|
|
4799
5414
|
* copy job.</p>
|
|
4800
5415
|
*/
|
|
@@ -4805,10 +5420,12 @@ export interface StartCopyJobOutput {
|
|
|
4805
5420
|
*/
|
|
4806
5421
|
export interface StartReportJobInput {
|
|
4807
5422
|
/**
|
|
5423
|
+
* @public
|
|
4808
5424
|
* <p>The unique name of a report plan.</p>
|
|
4809
5425
|
*/
|
|
4810
5426
|
ReportPlanName: string | undefined;
|
|
4811
5427
|
/**
|
|
5428
|
+
* @public
|
|
4812
5429
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
4813
5430
|
* calls to <code>StartReportJobInput</code>. Retrying a successful request with the same
|
|
4814
5431
|
* idempotency token results in a success message with no action taken.</p>
|
|
@@ -4820,6 +5437,7 @@ export interface StartReportJobInput {
|
|
|
4820
5437
|
*/
|
|
4821
5438
|
export interface StartReportJobOutput {
|
|
4822
5439
|
/**
|
|
5440
|
+
* @public
|
|
4823
5441
|
* <p>The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 encoded
|
|
4824
5442
|
* string that is at most 1,024 bytes long. The report job ID cannot be edited.</p>
|
|
4825
5443
|
*/
|
|
@@ -4830,11 +5448,13 @@ export interface StartReportJobOutput {
|
|
|
4830
5448
|
*/
|
|
4831
5449
|
export interface StartRestoreJobInput {
|
|
4832
5450
|
/**
|
|
5451
|
+
* @public
|
|
4833
5452
|
* <p>An ARN that uniquely identifies a recovery point; for example,
|
|
4834
5453
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
4835
5454
|
*/
|
|
4836
5455
|
RecoveryPointArn: string | undefined;
|
|
4837
5456
|
/**
|
|
5457
|
+
* @public
|
|
4838
5458
|
* <p>A set of metadata key-value pairs. Contains information, such as a resource name,
|
|
4839
5459
|
* required to restore a recovery point.</p>
|
|
4840
5460
|
* <p> You can get configuration metadata about a resource at the time it was backed up by
|
|
@@ -4887,18 +5507,21 @@ export interface StartRestoreJobInput {
|
|
|
4887
5507
|
*/
|
|
4888
5508
|
Metadata: Record<string, string> | undefined;
|
|
4889
5509
|
/**
|
|
5510
|
+
* @public
|
|
4890
5511
|
* <p>The Amazon Resource Name (ARN) of the IAM role that Backup uses to create
|
|
4891
5512
|
* the target resource; for example:
|
|
4892
5513
|
* <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>
|
|
4893
5514
|
*/
|
|
4894
5515
|
IamRoleArn?: string;
|
|
4895
5516
|
/**
|
|
5517
|
+
* @public
|
|
4896
5518
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
4897
5519
|
* calls to <code>StartRestoreJob</code>. Retrying a successful request with the same
|
|
4898
5520
|
* idempotency token results in a success message with no action taken.</p>
|
|
4899
5521
|
*/
|
|
4900
5522
|
IdempotencyToken?: string;
|
|
4901
5523
|
/**
|
|
5524
|
+
* @public
|
|
4902
5525
|
* <p>Starts a job to restore a recovery point for one of the following resources:</p>
|
|
4903
5526
|
* <ul>
|
|
4904
5527
|
* <li>
|
|
@@ -4965,6 +5588,7 @@ export interface StartRestoreJobInput {
|
|
|
4965
5588
|
*/
|
|
4966
5589
|
ResourceType?: string;
|
|
4967
5590
|
/**
|
|
5591
|
+
* @public
|
|
4968
5592
|
* <p>This is an optional parameter. If this equals <code>True</code>, tags included in the backup
|
|
4969
5593
|
* will be copied to the restored resource.</p>
|
|
4970
5594
|
* <p>This can only be applied to backups created through Backup.</p>
|
|
@@ -4976,6 +5600,7 @@ export interface StartRestoreJobInput {
|
|
|
4976
5600
|
*/
|
|
4977
5601
|
export interface StartRestoreJobOutput {
|
|
4978
5602
|
/**
|
|
5603
|
+
* @public
|
|
4979
5604
|
* <p>Uniquely identifies the job that restores a recovery point.</p>
|
|
4980
5605
|
*/
|
|
4981
5606
|
RestoreJobId?: string;
|
|
@@ -4985,6 +5610,7 @@ export interface StartRestoreJobOutput {
|
|
|
4985
5610
|
*/
|
|
4986
5611
|
export interface StopBackupJobInput {
|
|
4987
5612
|
/**
|
|
5613
|
+
* @public
|
|
4988
5614
|
* <p>Uniquely identifies a request to Backup to back up a resource.</p>
|
|
4989
5615
|
*/
|
|
4990
5616
|
BackupJobId: string | undefined;
|
|
@@ -4994,11 +5620,13 @@ export interface StopBackupJobInput {
|
|
|
4994
5620
|
*/
|
|
4995
5621
|
export interface TagResourceInput {
|
|
4996
5622
|
/**
|
|
5623
|
+
* @public
|
|
4997
5624
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of
|
|
4998
5625
|
* the tagged resource.</p>
|
|
4999
5626
|
*/
|
|
5000
5627
|
ResourceArn: string | undefined;
|
|
5001
5628
|
/**
|
|
5629
|
+
* @public
|
|
5002
5630
|
* <p>Key-value pairs that are used to help organize your resources. You can assign your own
|
|
5003
5631
|
* metadata to the resources you create. For clarity, this is the structure to assign tags:
|
|
5004
5632
|
* <code>[\{"Key":"string","Value":"string"\}]</code>.</p>
|
|
@@ -5010,11 +5638,13 @@ export interface TagResourceInput {
|
|
|
5010
5638
|
*/
|
|
5011
5639
|
export interface UntagResourceInput {
|
|
5012
5640
|
/**
|
|
5641
|
+
* @public
|
|
5013
5642
|
* <p>An ARN that uniquely identifies a resource. The format of the ARN depends on the type of
|
|
5014
5643
|
* the tagged resource.</p>
|
|
5015
5644
|
*/
|
|
5016
5645
|
ResourceArn: string | undefined;
|
|
5017
5646
|
/**
|
|
5647
|
+
* @public
|
|
5018
5648
|
* <p>A list of keys to identify which key-value tags to remove from a resource.</p>
|
|
5019
5649
|
*/
|
|
5020
5650
|
TagKeyList: string[] | undefined;
|
|
@@ -5024,10 +5654,12 @@ export interface UntagResourceInput {
|
|
|
5024
5654
|
*/
|
|
5025
5655
|
export interface UpdateBackupPlanInput {
|
|
5026
5656
|
/**
|
|
5657
|
+
* @public
|
|
5027
5658
|
* <p>Uniquely identifies a backup plan.</p>
|
|
5028
5659
|
*/
|
|
5029
5660
|
BackupPlanId: string | undefined;
|
|
5030
5661
|
/**
|
|
5662
|
+
* @public
|
|
5031
5663
|
* <p>Specifies the body of a backup plan. Includes a <code>BackupPlanName</code> and one or
|
|
5032
5664
|
* more sets of <code>Rules</code>.</p>
|
|
5033
5665
|
*/
|
|
@@ -5038,15 +5670,18 @@ export interface UpdateBackupPlanInput {
|
|
|
5038
5670
|
*/
|
|
5039
5671
|
export interface UpdateBackupPlanOutput {
|
|
5040
5672
|
/**
|
|
5673
|
+
* @public
|
|
5041
5674
|
* <p>Uniquely identifies a backup plan.</p>
|
|
5042
5675
|
*/
|
|
5043
5676
|
BackupPlanId?: string;
|
|
5044
5677
|
/**
|
|
5678
|
+
* @public
|
|
5045
5679
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
|
|
5046
5680
|
* <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>
|
|
5047
5681
|
*/
|
|
5048
5682
|
BackupPlanArn?: string;
|
|
5049
5683
|
/**
|
|
5684
|
+
* @public
|
|
5050
5685
|
* <p>The date and time a backup plan is created, in Unix format and Coordinated Universal
|
|
5051
5686
|
* Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For
|
|
5052
5687
|
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|
|
@@ -5054,11 +5689,13 @@ export interface UpdateBackupPlanOutput {
|
|
|
5054
5689
|
*/
|
|
5055
5690
|
CreationDate?: Date;
|
|
5056
5691
|
/**
|
|
5692
|
+
* @public
|
|
5057
5693
|
* <p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes
|
|
5058
5694
|
* long. Version Ids cannot be edited.</p>
|
|
5059
5695
|
*/
|
|
5060
5696
|
VersionId?: string;
|
|
5061
5697
|
/**
|
|
5698
|
+
* @public
|
|
5062
5699
|
* <p>Contains a list of <code>BackupOptions</code> for each resource type.</p>
|
|
5063
5700
|
*/
|
|
5064
5701
|
AdvancedBackupSettings?: AdvancedBackupSetting[];
|
|
@@ -5068,20 +5705,24 @@ export interface UpdateBackupPlanOutput {
|
|
|
5068
5705
|
*/
|
|
5069
5706
|
export interface UpdateFrameworkInput {
|
|
5070
5707
|
/**
|
|
5708
|
+
* @public
|
|
5071
5709
|
* <p>The unique name of a framework. This name is between 1 and 256 characters, starting with
|
|
5072
5710
|
* a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
|
|
5073
5711
|
*/
|
|
5074
5712
|
FrameworkName: string | undefined;
|
|
5075
5713
|
/**
|
|
5714
|
+
* @public
|
|
5076
5715
|
* <p>An optional description of the framework with a maximum 1,024 characters.</p>
|
|
5077
5716
|
*/
|
|
5078
5717
|
FrameworkDescription?: string;
|
|
5079
5718
|
/**
|
|
5719
|
+
* @public
|
|
5080
5720
|
* <p>A list of the controls that make up the framework. Each control in the list has a name,
|
|
5081
5721
|
* input parameters, and scope.</p>
|
|
5082
5722
|
*/
|
|
5083
5723
|
FrameworkControls?: FrameworkControl[];
|
|
5084
5724
|
/**
|
|
5725
|
+
* @public
|
|
5085
5726
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
5086
5727
|
* calls to <code>UpdateFrameworkInput</code>. Retrying a successful request with the same
|
|
5087
5728
|
* idempotency token results in a success message with no action taken.</p>
|
|
@@ -5093,16 +5734,19 @@ export interface UpdateFrameworkInput {
|
|
|
5093
5734
|
*/
|
|
5094
5735
|
export interface UpdateFrameworkOutput {
|
|
5095
5736
|
/**
|
|
5737
|
+
* @public
|
|
5096
5738
|
* <p>The unique name of a framework. This name is between 1 and 256 characters, starting with
|
|
5097
5739
|
* a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).</p>
|
|
5098
5740
|
*/
|
|
5099
5741
|
FrameworkName?: string;
|
|
5100
5742
|
/**
|
|
5743
|
+
* @public
|
|
5101
5744
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
5102
5745
|
* depends on the resource type.</p>
|
|
5103
5746
|
*/
|
|
5104
5747
|
FrameworkArn?: string;
|
|
5105
5748
|
/**
|
|
5749
|
+
* @public
|
|
5106
5750
|
* <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,
|
|
5107
5751
|
* 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind
|
|
5108
5752
|
* UTC.</p>
|
|
@@ -5114,6 +5758,7 @@ export interface UpdateFrameworkOutput {
|
|
|
5114
5758
|
*/
|
|
5115
5759
|
export interface UpdateGlobalSettingsInput {
|
|
5116
5760
|
/**
|
|
5761
|
+
* @public
|
|
5117
5762
|
* <p>A value for <code>isCrossAccountBackupEnabled</code> and a Region. Example:
|
|
5118
5763
|
* <code>update-global-settings --global-settings isCrossAccountBackupEnabled=false
|
|
5119
5764
|
* --region us-west-2</code>.</p>
|
|
@@ -5125,6 +5770,7 @@ export interface UpdateGlobalSettingsInput {
|
|
|
5125
5770
|
*/
|
|
5126
5771
|
export interface UpdateRecoveryPointLifecycleInput {
|
|
5127
5772
|
/**
|
|
5773
|
+
* @public
|
|
5128
5774
|
* <p>The name of a logical container where backups are stored. Backup vaults are identified
|
|
5129
5775
|
* by names that are unique to the account used to create them and the Amazon Web Services
|
|
5130
5776
|
* Region where they are created. They consist of lowercase letters, numbers, and
|
|
@@ -5132,11 +5778,13 @@ export interface UpdateRecoveryPointLifecycleInput {
|
|
|
5132
5778
|
*/
|
|
5133
5779
|
BackupVaultName: string | undefined;
|
|
5134
5780
|
/**
|
|
5781
|
+
* @public
|
|
5135
5782
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
5136
5783
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
5137
5784
|
*/
|
|
5138
5785
|
RecoveryPointArn: string | undefined;
|
|
5139
5786
|
/**
|
|
5787
|
+
* @public
|
|
5140
5788
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
5141
5789
|
* it expires. Backup transitions and expires backups automatically according to
|
|
5142
5790
|
* the lifecycle that you define. </p>
|
|
@@ -5152,16 +5800,19 @@ export interface UpdateRecoveryPointLifecycleInput {
|
|
|
5152
5800
|
*/
|
|
5153
5801
|
export interface UpdateRecoveryPointLifecycleOutput {
|
|
5154
5802
|
/**
|
|
5803
|
+
* @public
|
|
5155
5804
|
* <p>An ARN that uniquely identifies a backup vault; for example,
|
|
5156
5805
|
* <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>
|
|
5157
5806
|
*/
|
|
5158
5807
|
BackupVaultArn?: string;
|
|
5159
5808
|
/**
|
|
5809
|
+
* @public
|
|
5160
5810
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example,
|
|
5161
5811
|
* <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
|
|
5162
5812
|
*/
|
|
5163
5813
|
RecoveryPointArn?: string;
|
|
5164
5814
|
/**
|
|
5815
|
+
* @public
|
|
5165
5816
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
5166
5817
|
* it expires. Backup transitions and expires backups automatically according to
|
|
5167
5818
|
* the lifecycle that you define.</p>
|
|
@@ -5176,6 +5827,7 @@ export interface UpdateRecoveryPointLifecycleOutput {
|
|
|
5176
5827
|
*/
|
|
5177
5828
|
Lifecycle?: Lifecycle;
|
|
5178
5829
|
/**
|
|
5830
|
+
* @public
|
|
5179
5831
|
* <p>A <code>CalculatedLifecycle</code> object containing <code>DeleteAt</code> and
|
|
5180
5832
|
* <code>MoveToColdStorageAt</code> timestamps.</p>
|
|
5181
5833
|
*/
|
|
@@ -5186,10 +5838,12 @@ export interface UpdateRecoveryPointLifecycleOutput {
|
|
|
5186
5838
|
*/
|
|
5187
5839
|
export interface UpdateRegionSettingsInput {
|
|
5188
5840
|
/**
|
|
5841
|
+
* @public
|
|
5189
5842
|
* <p>Updates the list of services along with the opt-in preferences for the Region.</p>
|
|
5190
5843
|
*/
|
|
5191
5844
|
ResourceTypeOptInPreference?: Record<string, boolean>;
|
|
5192
5845
|
/**
|
|
5846
|
+
* @public
|
|
5193
5847
|
* <p>Enables or disables full Backup management of backups for a resource type.
|
|
5194
5848
|
* To enable full Backup management for DynamoDB along with <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html">
|
|
5195
5849
|
* Backup's advanced DynamoDB backup features</a>, follow the
|
|
@@ -5202,21 +5856,25 @@ export interface UpdateRegionSettingsInput {
|
|
|
5202
5856
|
*/
|
|
5203
5857
|
export interface UpdateReportPlanInput {
|
|
5204
5858
|
/**
|
|
5859
|
+
* @public
|
|
5205
5860
|
* <p>The unique name of the report plan. This name is between 1 and 256 characters, starting
|
|
5206
5861
|
* with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores
|
|
5207
5862
|
* (_).</p>
|
|
5208
5863
|
*/
|
|
5209
5864
|
ReportPlanName: string | undefined;
|
|
5210
5865
|
/**
|
|
5866
|
+
* @public
|
|
5211
5867
|
* <p>An optional description of the report plan with a maximum 1,024 characters.</p>
|
|
5212
5868
|
*/
|
|
5213
5869
|
ReportPlanDescription?: string;
|
|
5214
5870
|
/**
|
|
5871
|
+
* @public
|
|
5215
5872
|
* <p>A structure that contains information about where to deliver your reports, specifically
|
|
5216
5873
|
* your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.</p>
|
|
5217
5874
|
*/
|
|
5218
5875
|
ReportDeliveryChannel?: ReportDeliveryChannel;
|
|
5219
5876
|
/**
|
|
5877
|
+
* @public
|
|
5220
5878
|
* <p>Identifies the report template for the report. Reports are built using a report
|
|
5221
5879
|
* template. The report templates are:</p>
|
|
5222
5880
|
* <p>
|
|
@@ -5229,6 +5887,7 @@ export interface UpdateReportPlanInput {
|
|
|
5229
5887
|
*/
|
|
5230
5888
|
ReportSetting?: ReportSetting;
|
|
5231
5889
|
/**
|
|
5890
|
+
* @public
|
|
5232
5891
|
* <p>A customer-chosen string that you can use to distinguish between otherwise identical
|
|
5233
5892
|
* calls to <code>UpdateReportPlanInput</code>. Retrying a successful request with the same
|
|
5234
5893
|
* idempotency token results in a success message with no action taken.</p>
|
|
@@ -5240,15 +5899,18 @@ export interface UpdateReportPlanInput {
|
|
|
5240
5899
|
*/
|
|
5241
5900
|
export interface UpdateReportPlanOutput {
|
|
5242
5901
|
/**
|
|
5902
|
+
* @public
|
|
5243
5903
|
* <p>The unique name of the report plan.</p>
|
|
5244
5904
|
*/
|
|
5245
5905
|
ReportPlanName?: string;
|
|
5246
5906
|
/**
|
|
5907
|
+
* @public
|
|
5247
5908
|
* <p>An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN
|
|
5248
5909
|
* depends on the resource type.</p>
|
|
5249
5910
|
*/
|
|
5250
5911
|
ReportPlanArn?: string;
|
|
5251
5912
|
/**
|
|
5913
|
+
* @public
|
|
5252
5914
|
* <p>The date and time that a report plan is created, in Unix format and Coordinated
|
|
5253
5915
|
* Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds.
|
|
5254
5916
|
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
|