@aws-sdk/client-backup 3.449.0 → 3.451.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.
Files changed (52) hide show
  1. package/README.md +25 -1
  2. package/dist-cjs/Backup.js +6 -0
  3. package/dist-cjs/commands/ListBackupJobSummariesCommand.js +51 -0
  4. package/dist-cjs/commands/ListCopyJobSummariesCommand.js +51 -0
  5. package/dist-cjs/commands/ListRestoreJobSummariesCommand.js +51 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/models/models_0.js +42 -1
  8. package/dist-cjs/pagination/ListBackupJobSummariesPaginator.js +29 -0
  9. package/dist-cjs/pagination/ListCopyJobSummariesPaginator.js +29 -0
  10. package/dist-cjs/pagination/ListRestoreJobSummariesPaginator.js +29 -0
  11. package/dist-cjs/pagination/index.js +3 -0
  12. package/dist-cjs/protocols/Aws_restJson1.js +262 -3
  13. package/dist-es/Backup.js +6 -0
  14. package/dist-es/commands/ListBackupJobSummariesCommand.js +47 -0
  15. package/dist-es/commands/ListCopyJobSummariesCommand.js +47 -0
  16. package/dist-es/commands/ListRestoreJobSummariesCommand.js +47 -0
  17. package/dist-es/commands/index.js +3 -0
  18. package/dist-es/models/models_0.js +41 -0
  19. package/dist-es/pagination/ListBackupJobSummariesPaginator.js +25 -0
  20. package/dist-es/pagination/ListCopyJobSummariesPaginator.js +25 -0
  21. package/dist-es/pagination/ListRestoreJobSummariesPaginator.js +25 -0
  22. package/dist-es/pagination/index.js +3 -0
  23. package/dist-es/protocols/Aws_restJson1.js +252 -0
  24. package/dist-types/Backup.d.ts +21 -0
  25. package/dist-types/BackupClient.d.ts +5 -2
  26. package/dist-types/commands/DescribeBackupJobCommand.d.ts +1 -0
  27. package/dist-types/commands/DescribeCopyJobCommand.d.ts +1 -0
  28. package/dist-types/commands/ListBackupJobSummariesCommand.d.ts +106 -0
  29. package/dist-types/commands/ListBackupJobsCommand.d.ts +2 -0
  30. package/dist-types/commands/ListCopyJobSummariesCommand.d.ts +106 -0
  31. package/dist-types/commands/ListCopyJobsCommand.d.ts +2 -0
  32. package/dist-types/commands/ListRestoreJobSummariesCommand.d.ts +104 -0
  33. package/dist-types/commands/index.d.ts +3 -0
  34. package/dist-types/models/models_0.d.ts +727 -0
  35. package/dist-types/pagination/ListBackupJobSummariesPaginator.d.ts +7 -0
  36. package/dist-types/pagination/ListCopyJobSummariesPaginator.d.ts +7 -0
  37. package/dist-types/pagination/ListRestoreJobSummariesPaginator.d.ts +7 -0
  38. package/dist-types/pagination/index.d.ts +3 -0
  39. package/dist-types/protocols/Aws_restJson1.d.ts +27 -0
  40. package/dist-types/ts3.4/Backup.d.ts +51 -0
  41. package/dist-types/ts3.4/BackupClient.d.ts +18 -0
  42. package/dist-types/ts3.4/commands/ListBackupJobSummariesCommand.d.ts +42 -0
  43. package/dist-types/ts3.4/commands/ListCopyJobSummariesCommand.d.ts +42 -0
  44. package/dist-types/ts3.4/commands/ListRestoreJobSummariesCommand.d.ts +42 -0
  45. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +123 -0
  47. package/dist-types/ts3.4/pagination/ListBackupJobSummariesPaginator.d.ts +11 -0
  48. package/dist-types/ts3.4/pagination/ListCopyJobSummariesPaginator.d.ts +11 -0
  49. package/dist-types/ts3.4/pagination/ListRestoreJobSummariesPaginator.d.ts +11 -0
  50. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  51. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +36 -0
  52. package/package.json +35 -35
@@ -30,6 +30,19 @@ export interface AdvancedBackupSetting {
30
30
  */
31
31
  BackupOptions?: Record<string, string>;
32
32
  }
33
+ /**
34
+ * @public
35
+ * @enum
36
+ */
37
+ export declare const AggregationPeriod: {
38
+ readonly FOURTEEN_DAYS: "FOURTEEN_DAYS";
39
+ readonly ONE_DAY: "ONE_DAY";
40
+ readonly SEVEN_DAYS: "SEVEN_DAYS";
41
+ };
42
+ /**
43
+ * @public
44
+ */
45
+ export type AggregationPeriod = (typeof AggregationPeriod)[keyof typeof AggregationPeriod];
33
46
  /**
34
47
  * @public
35
48
  * <p>The required resource already exists.</p>
@@ -270,6 +283,109 @@ export interface BackupJob {
270
283
  * belongs to the specified backup.</p>
271
284
  */
272
285
  ResourceName?: string;
286
+ /**
287
+ * @public
288
+ * <p>This parameter is the job count for the specified
289
+ * message category.</p>
290
+ * <p>Example strings include <code>AccessDenied</code>,
291
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
292
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
293
+ * for a list of MessageCategory strings.</p>
294
+ * <p>The the value ANY returns count of all message categories.</p>
295
+ * <p>
296
+ * <code>AGGREGATE_ALL</code> aggregates job counts
297
+ * for all message categories and returns the sum.</p>
298
+ */
299
+ MessageCategory?: string;
300
+ }
301
+ /**
302
+ * @public
303
+ * @enum
304
+ */
305
+ export declare const BackupJobStatus: {
306
+ readonly ABORTED: "ABORTED";
307
+ readonly ABORTING: "ABORTING";
308
+ readonly AGGREGATE_ALL: "AGGREGATE_ALL";
309
+ readonly ANY: "ANY";
310
+ readonly COMPLETED: "COMPLETED";
311
+ readonly CREATED: "CREATED";
312
+ readonly EXPIRED: "EXPIRED";
313
+ readonly FAILED: "FAILED";
314
+ readonly PARTIAL: "PARTIAL";
315
+ readonly PENDING: "PENDING";
316
+ readonly RUNNING: "RUNNING";
317
+ };
318
+ /**
319
+ * @public
320
+ */
321
+ export type BackupJobStatus = (typeof BackupJobStatus)[keyof typeof BackupJobStatus];
322
+ /**
323
+ * @public
324
+ * <p>This is a summary of jobs created
325
+ * or running within the most recent 30 days.</p>
326
+ * <p>The returned summary may contain the following:
327
+ * Region, Account, State, RestourceType, MessageCategory,
328
+ * StartTime, EndTime, and Count of included jobs.</p>
329
+ */
330
+ export interface BackupJobSummary {
331
+ /**
332
+ * @public
333
+ * <p>The Amazon Web Services Regions within the job summary.</p>
334
+ */
335
+ Region?: string;
336
+ /**
337
+ * @public
338
+ * <p>The account ID that owns the jobs within the summary.</p>
339
+ */
340
+ AccountId?: string;
341
+ /**
342
+ * @public
343
+ * <p>This value is job count for jobs
344
+ * with the specified state.</p>
345
+ */
346
+ State?: BackupJobStatus;
347
+ /**
348
+ * @public
349
+ * <p>This value is the job count for the specified resource type.
350
+ * The request <code>GetSupportedResourceTypes</code> returns
351
+ * strings for supported resource types.</p>
352
+ */
353
+ ResourceType?: string;
354
+ /**
355
+ * @public
356
+ * <p>This parameter is the job count for the specified
357
+ * message category.</p>
358
+ * <p>Example strings include <code>AccessDenied</code>,
359
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
360
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
361
+ * for a list of MessageCategory strings.</p>
362
+ * <p>The the value ANY returns count of all message categories.</p>
363
+ * <p>
364
+ * <code>AGGREGATE_ALL</code> aggregates job counts
365
+ * for all message categories and returns the sum.</p>
366
+ */
367
+ MessageCategory?: string;
368
+ /**
369
+ * @public
370
+ * <p>The value as a number of jobs in a job summary.</p>
371
+ */
372
+ Count?: number;
373
+ /**
374
+ * @public
375
+ * <p>The value of time in number format of a job start time.</p>
376
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
377
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
378
+ * 12:11:30.087 AM.</p>
379
+ */
380
+ StartTime?: Date;
381
+ /**
382
+ * @public
383
+ * <p>The value of time in number format of a job end time.</p>
384
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
385
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
386
+ * 12:11:30.087 AM.</p>
387
+ */
388
+ EndTime?: Date;
273
389
  }
274
390
  /**
275
391
  * @public
@@ -1389,6 +1505,109 @@ export interface CopyJob {
1389
1505
  * belongs to the specified backup.</p>
1390
1506
  */
1391
1507
  ResourceName?: string;
1508
+ /**
1509
+ * @public
1510
+ * <p>This parameter is the job count for the specified
1511
+ * message category.</p>
1512
+ * <p>Example strings include <code>AccessDenied</code>,
1513
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
1514
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
1515
+ * for a list of MessageCategory strings.</p>
1516
+ * <p>The the value ANY returns count of all message categories.</p>
1517
+ * <p>
1518
+ * <code>AGGREGATE_ALL</code> aggregates job counts
1519
+ * for all message categories and returns the sum</p>
1520
+ */
1521
+ MessageCategory?: string;
1522
+ }
1523
+ /**
1524
+ * @public
1525
+ * @enum
1526
+ */
1527
+ export declare const CopyJobStatus: {
1528
+ readonly ABORTED: "ABORTED";
1529
+ readonly ABORTING: "ABORTING";
1530
+ readonly AGGREGATE_ALL: "AGGREGATE_ALL";
1531
+ readonly ANY: "ANY";
1532
+ readonly COMPLETED: "COMPLETED";
1533
+ readonly COMPLETING: "COMPLETING";
1534
+ readonly CREATED: "CREATED";
1535
+ readonly FAILED: "FAILED";
1536
+ readonly FAILING: "FAILING";
1537
+ readonly PARTIAL: "PARTIAL";
1538
+ readonly RUNNING: "RUNNING";
1539
+ };
1540
+ /**
1541
+ * @public
1542
+ */
1543
+ export type CopyJobStatus = (typeof CopyJobStatus)[keyof typeof CopyJobStatus];
1544
+ /**
1545
+ * @public
1546
+ * <p>This is a summary of copy jobs created
1547
+ * or running within the most recent 30 days.</p>
1548
+ * <p>The returned summary may contain the following:
1549
+ * Region, Account, State, RestourceType, MessageCategory,
1550
+ * StartTime, EndTime, and Count of included jobs.</p>
1551
+ */
1552
+ export interface CopyJobSummary {
1553
+ /**
1554
+ * @public
1555
+ * <p>This is the Amazon Web Services Regions within the job summary.</p>
1556
+ */
1557
+ Region?: string;
1558
+ /**
1559
+ * @public
1560
+ * <p>The account ID that owns the jobs within the summary.</p>
1561
+ */
1562
+ AccountId?: string;
1563
+ /**
1564
+ * @public
1565
+ * <p>This value is job count for jobs
1566
+ * with the specified state.</p>
1567
+ */
1568
+ State?: CopyJobStatus;
1569
+ /**
1570
+ * @public
1571
+ * <p>This value is the job count for the specified resource type.
1572
+ * The request <code>GetSupportedResourceTypes</code> returns
1573
+ * strings for supported resource types</p>
1574
+ */
1575
+ ResourceType?: string;
1576
+ /**
1577
+ * @public
1578
+ * <p>This parameter is the job count for the specified
1579
+ * message category.</p>
1580
+ * <p>Example strings include <code>AccessDenied</code>,
1581
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
1582
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
1583
+ * for a list of MessageCategory strings.</p>
1584
+ * <p>The the value ANY returns count of all message categories.</p>
1585
+ * <p>
1586
+ * <code>AGGREGATE_ALL</code> aggregates job counts
1587
+ * for all message categories and returns the sum.</p>
1588
+ */
1589
+ MessageCategory?: string;
1590
+ /**
1591
+ * @public
1592
+ * <p>The value as a number of jobs in a job summary.</p>
1593
+ */
1594
+ Count?: number;
1595
+ /**
1596
+ * @public
1597
+ * <p>The value of time in number format of a job start time.</p>
1598
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
1599
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
1600
+ * 12:11:30.087 AM.</p>
1601
+ */
1602
+ StartTime?: Date;
1603
+ /**
1604
+ * @public
1605
+ * <p>The value of time in number format of a job end time.</p>
1606
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
1607
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
1608
+ * 12:11:30.087 AM.</p>
1609
+ */
1610
+ EndTime?: Date;
1392
1611
  }
1393
1612
  /**
1394
1613
  * @public
@@ -2401,6 +2620,16 @@ export interface DescribeBackupJobOutput {
2401
2620
  * belongs to the specified backup.</p>
2402
2621
  */
2403
2622
  ResourceName?: string;
2623
+ /**
2624
+ * @public
2625
+ * <p>This is the job count for the specified
2626
+ * message category.</p>
2627
+ * <p>Example strings may include <code>AccessDenied</code>,
2628
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
2629
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
2630
+ * for a list of MessageCategory strings.</p>
2631
+ */
2632
+ MessageCategory?: string;
2404
2633
  }
2405
2634
  /**
2406
2635
  * @public
@@ -3889,6 +4118,16 @@ export interface ListBackupJobsInput {
3889
4118
  * <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
3890
4119
  */
3891
4120
  ByParentJobId?: string;
4121
+ /**
4122
+ * @public
4123
+ * <p>This returns a list of backup jobs for the specified
4124
+ * message category.</p>
4125
+ * <p>Example strings may include <code>AccessDenied</code>,
4126
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
4127
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
4128
+ * for a list of MessageCategory strings.</p>
4129
+ */
4130
+ ByMessageCategory?: string;
3892
4131
  }
3893
4132
  /**
3894
4133
  * @public
@@ -3909,6 +4148,145 @@ export interface ListBackupJobsOutput {
3909
4148
  */
3910
4149
  NextToken?: string;
3911
4150
  }
4151
+ /**
4152
+ * @public
4153
+ */
4154
+ export interface ListBackupJobSummariesInput {
4155
+ /**
4156
+ * @public
4157
+ * <p>Returns the job count for the specified account.</p>
4158
+ * <p>If the request is sent from a member account or an account
4159
+ * not part of Amazon Web Services Organizations, jobs within requestor's account
4160
+ * will be returned.</p>
4161
+ * <p>Root, admin, and delegated administrator accounts can use
4162
+ * the value ANY to return job counts from every account in the
4163
+ * organization.</p>
4164
+ * <p>
4165
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4166
+ * from all accounts within the authenticated organization,
4167
+ * then returns the sum.</p>
4168
+ */
4169
+ AccountId?: string;
4170
+ /**
4171
+ * @public
4172
+ * <p>This parameter returns the job count for jobs
4173
+ * with the specified state.</p>
4174
+ * <p>The the value ANY returns count of all states.</p>
4175
+ * <p>
4176
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4177
+ * for all states and returns the sum.</p>
4178
+ */
4179
+ State?: BackupJobStatus;
4180
+ /**
4181
+ * @public
4182
+ * <p>Returns the job count for the specified resource type.
4183
+ * Use request <code>GetSupportedResourceTypes</code> to obtain
4184
+ * strings for supported resource types.</p>
4185
+ * <p>The the value ANY returns count of all resource types.</p>
4186
+ * <p>
4187
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4188
+ * for all resource types and returns the sum.</p>
4189
+ * <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>
4190
+ */
4191
+ ResourceType?: string;
4192
+ /**
4193
+ * @public
4194
+ * <p>This parameter returns the job count for the specified
4195
+ * message category.</p>
4196
+ * <p>Example accepted strings include <code>AccessDenied</code>,
4197
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
4198
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
4199
+ * for a list of accepted MessageCategory strings.</p>
4200
+ * <p>The the value ANY returns count of all message categories.</p>
4201
+ * <p>
4202
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4203
+ * for all message categories and returns the sum.</p>
4204
+ */
4205
+ MessageCategory?: string;
4206
+ /**
4207
+ * @public
4208
+ * <p>This is the period that sets the boundaries for returned
4209
+ * results.</p>
4210
+ * <p>Acceptable values include</p>
4211
+ * <ul>
4212
+ * <li>
4213
+ * <p>
4214
+ * <code>ONE_DAY</code> for daily job count
4215
+ * for the prior 14 days.</p>
4216
+ * </li>
4217
+ * <li>
4218
+ * <p>
4219
+ * <code>SEVEN_DAYS</code> for the aggregated
4220
+ * job count for the prior 7 days.</p>
4221
+ * </li>
4222
+ * <li>
4223
+ * <p>
4224
+ * <code>FOURTEEN_DAYS</code> for aggregated
4225
+ * job count for prior 14 days.</p>
4226
+ * </li>
4227
+ * </ul>
4228
+ */
4229
+ AggregationPeriod?: AggregationPeriod;
4230
+ /**
4231
+ * @public
4232
+ * <p>This parameter sets the maximum number of items
4233
+ * to be returned.</p>
4234
+ * <p>The value is an integer. Range of accepted values is from
4235
+ * 1 to 500.</p>
4236
+ */
4237
+ MaxResults?: number;
4238
+ /**
4239
+ * @public
4240
+ * <p>The next item following a partial list of returned resources. For example, if a request
4241
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
4242
+ * allows you to return more items in your list starting at the location pointed to by the
4243
+ * next token.</p>
4244
+ */
4245
+ NextToken?: string;
4246
+ }
4247
+ /**
4248
+ * @public
4249
+ */
4250
+ export interface ListBackupJobSummariesOutput {
4251
+ /**
4252
+ * @public
4253
+ * <p>This request returns a summary that contains
4254
+ * Region, Account, State, ResourceType, MessageCategory,
4255
+ * StartTime, EndTime, and Count of included jobs.</p>
4256
+ */
4257
+ BackupJobSummaries?: BackupJobSummary[];
4258
+ /**
4259
+ * @public
4260
+ * <p>This is the period that sets the boundaries for returned
4261
+ * results.</p>
4262
+ * <ul>
4263
+ * <li>
4264
+ * <p>
4265
+ * <code>ONE_DAY</code> for daily job count
4266
+ * for the prior 14 days.</p>
4267
+ * </li>
4268
+ * <li>
4269
+ * <p>
4270
+ * <code>SEVEN_DAYS</code> for the aggregated
4271
+ * job count for the prior 7 days.</p>
4272
+ * </li>
4273
+ * <li>
4274
+ * <p>
4275
+ * <code>FOURTEEN_DAYS</code> for aggregated
4276
+ * job count for prior 14 days.</p>
4277
+ * </li>
4278
+ * </ul>
4279
+ */
4280
+ AggregationPeriod?: string;
4281
+ /**
4282
+ * @public
4283
+ * <p>The next item following a partial list of returned resources. For example, if a request
4284
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
4285
+ * allows you to return more items in your list starting at the location pointed to by the
4286
+ * next token.</p>
4287
+ */
4288
+ NextToken?: string;
4289
+ }
3912
4290
  /**
3913
4291
  * @public
3914
4292
  */
@@ -4241,6 +4619,20 @@ export interface ListCopyJobsInput {
4241
4619
  * <p>This is a filter to list child (nested) jobs based on parent job ID.</p>
4242
4620
  */
4243
4621
  ByParentJobId?: string;
4622
+ /**
4623
+ * @public
4624
+ * <p>This parameter returns the job count for the specified
4625
+ * message category.</p>
4626
+ * <p>Example accepted strings include <code>AccessDenied</code>,
4627
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
4628
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
4629
+ * for a list of accepted MessageCategory strings.</p>
4630
+ * <p>The the value ANY returns count of all message categories.</p>
4631
+ * <p>
4632
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4633
+ * for all message categories and returns the sum.</p>
4634
+ */
4635
+ ByMessageCategory?: string;
4244
4636
  }
4245
4637
  /**
4246
4638
  * @public
@@ -4260,6 +4652,144 @@ export interface ListCopyJobsOutput {
4260
4652
  */
4261
4653
  NextToken?: string;
4262
4654
  }
4655
+ /**
4656
+ * @public
4657
+ */
4658
+ export interface ListCopyJobSummariesInput {
4659
+ /**
4660
+ * @public
4661
+ * <p>Returns the job count for the specified account.</p>
4662
+ * <p>If the request is sent from a member account or an account
4663
+ * not part of Amazon Web Services Organizations, jobs within requestor's account
4664
+ * will be returned.</p>
4665
+ * <p>Root, admin, and delegated administrator accounts can use
4666
+ * the value ANY to return job counts from every account in the
4667
+ * organization.</p>
4668
+ * <p>
4669
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4670
+ * from all accounts within the authenticated organization,
4671
+ * then returns the sum.</p>
4672
+ */
4673
+ AccountId?: string;
4674
+ /**
4675
+ * @public
4676
+ * <p>This parameter returns the job count for jobs
4677
+ * with the specified state.</p>
4678
+ * <p>The the value ANY returns count of all states.</p>
4679
+ * <p>
4680
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4681
+ * for all states and returns the sum.</p>
4682
+ */
4683
+ State?: CopyJobStatus;
4684
+ /**
4685
+ * @public
4686
+ * <p>Returns the job count for the specified resource type.
4687
+ * Use request <code>GetSupportedResourceTypes</code> to obtain
4688
+ * strings for supported resource types.</p>
4689
+ * <p>The the value ANY returns count of all resource types.</p>
4690
+ * <p>
4691
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4692
+ * for all resource types and returns the sum.</p>
4693
+ * <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>
4694
+ */
4695
+ ResourceType?: string;
4696
+ /**
4697
+ * @public
4698
+ * <p>This parameter returns the job count for the specified
4699
+ * message category.</p>
4700
+ * <p>Example accepted strings include <code>AccessDenied</code>,
4701
+ * <code>Success</code>, and <code>InvalidParameters</code>. See
4702
+ * <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html">Monitoring</a>
4703
+ * for a list of accepted MessageCategory strings.</p>
4704
+ * <p>The the value ANY returns count of all message categories.</p>
4705
+ * <p>
4706
+ * <code>AGGREGATE_ALL</code> aggregates job counts
4707
+ * for all message categories and returns the sum.</p>
4708
+ */
4709
+ MessageCategory?: string;
4710
+ /**
4711
+ * @public
4712
+ * <p>This is the period that sets the boundaries for returned
4713
+ * results.</p>
4714
+ * <ul>
4715
+ * <li>
4716
+ * <p>
4717
+ * <code>ONE_DAY</code> for daily job count
4718
+ * for the prior 14 days.</p>
4719
+ * </li>
4720
+ * <li>
4721
+ * <p>
4722
+ * <code>SEVEN_DAYS</code> for the aggregated
4723
+ * job count for the prior 7 days.</p>
4724
+ * </li>
4725
+ * <li>
4726
+ * <p>
4727
+ * <code>FOURTEEN_DAYS</code> for aggregated
4728
+ * job count for prior 14 days.</p>
4729
+ * </li>
4730
+ * </ul>
4731
+ */
4732
+ AggregationPeriod?: AggregationPeriod;
4733
+ /**
4734
+ * @public
4735
+ * <p>This parameter sets the maximum number of items
4736
+ * to be returned.</p>
4737
+ * <p>The value is an integer. Range of accepted values is from
4738
+ * 1 to 500.</p>
4739
+ */
4740
+ MaxResults?: number;
4741
+ /**
4742
+ * @public
4743
+ * <p>The next item following a partial list of returned resources. For example, if a request
4744
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
4745
+ * allows you to return more items in your list starting at the location pointed to by the
4746
+ * next token.</p>
4747
+ */
4748
+ NextToken?: string;
4749
+ }
4750
+ /**
4751
+ * @public
4752
+ */
4753
+ export interface ListCopyJobSummariesOutput {
4754
+ /**
4755
+ * @public
4756
+ * <p>This return shows a summary that contains
4757
+ * Region, Account, State, ResourceType, MessageCategory,
4758
+ * StartTime, EndTime, and Count of included jobs.</p>
4759
+ */
4760
+ CopyJobSummaries?: CopyJobSummary[];
4761
+ /**
4762
+ * @public
4763
+ * <p>This is the period that sets the boundaries for returned
4764
+ * results.</p>
4765
+ * <ul>
4766
+ * <li>
4767
+ * <p>
4768
+ * <code>ONE_DAY</code> for daily job count
4769
+ * for the prior 14 days.</p>
4770
+ * </li>
4771
+ * <li>
4772
+ * <p>
4773
+ * <code>SEVEN_DAYS</code> for the aggregated
4774
+ * job count for the prior 7 days.</p>
4775
+ * </li>
4776
+ * <li>
4777
+ * <p>
4778
+ * <code>FOURTEEN_DAYS</code> for aggregated
4779
+ * job count for prior 14 days.</p>
4780
+ * </li>
4781
+ * </ul>
4782
+ */
4783
+ AggregationPeriod?: string;
4784
+ /**
4785
+ * @public
4786
+ * <p>The next item following a partial list of returned resources. For example, if a request
4787
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
4788
+ * allows you to return more items in your list starting at the location pointed to by the
4789
+ * next token.</p>
4790
+ */
4791
+ NextToken?: string;
4792
+ }
4263
4793
  /**
4264
4794
  * @public
4265
4795
  */
@@ -5230,6 +5760,203 @@ export interface ListRestoreJobsOutput {
5230
5760
  */
5231
5761
  NextToken?: string;
5232
5762
  }
5763
+ /**
5764
+ * @public
5765
+ * @enum
5766
+ */
5767
+ export declare const RestoreJobState: {
5768
+ readonly ABORTED: "ABORTED";
5769
+ readonly AGGREGATE_ALL: "AGGREGATE_ALL";
5770
+ readonly ANY: "ANY";
5771
+ readonly COMPLETED: "COMPLETED";
5772
+ readonly CREATED: "CREATED";
5773
+ readonly FAILED: "FAILED";
5774
+ readonly PENDING: "PENDING";
5775
+ readonly RUNNING: "RUNNING";
5776
+ };
5777
+ /**
5778
+ * @public
5779
+ */
5780
+ export type RestoreJobState = (typeof RestoreJobState)[keyof typeof RestoreJobState];
5781
+ /**
5782
+ * @public
5783
+ */
5784
+ export interface ListRestoreJobSummariesInput {
5785
+ /**
5786
+ * @public
5787
+ * <p>Returns the job count for the specified account.</p>
5788
+ * <p>If the request is sent from a member account or an account
5789
+ * not part of Amazon Web Services Organizations, jobs within requestor's account
5790
+ * will be returned.</p>
5791
+ * <p>Root, admin, and delegated administrator accounts can use
5792
+ * the value ANY to return job counts from every account in the
5793
+ * organization.</p>
5794
+ * <p>
5795
+ * <code>AGGREGATE_ALL</code> aggregates job counts
5796
+ * from all accounts within the authenticated organization,
5797
+ * then returns the sum.</p>
5798
+ */
5799
+ AccountId?: string;
5800
+ /**
5801
+ * @public
5802
+ * <p>This parameter returns the job count for jobs
5803
+ * with the specified state.</p>
5804
+ * <p>The the value ANY returns count of all states.</p>
5805
+ * <p>
5806
+ * <code>AGGREGATE_ALL</code> aggregates job counts
5807
+ * for all states and returns the sum.</p>
5808
+ */
5809
+ State?: RestoreJobState;
5810
+ /**
5811
+ * @public
5812
+ * <p>Returns the job count for the specified resource type.
5813
+ * Use request <code>GetSupportedResourceTypes</code> to obtain
5814
+ * strings for supported resource types.</p>
5815
+ * <p>The the value ANY returns count of all resource types.</p>
5816
+ * <p>
5817
+ * <code>AGGREGATE_ALL</code> aggregates job counts
5818
+ * for all resource types and returns the sum.</p>
5819
+ * <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>
5820
+ */
5821
+ ResourceType?: string;
5822
+ /**
5823
+ * @public
5824
+ * <p>This is the period that sets the boundaries for returned
5825
+ * results.</p>
5826
+ * <p>Acceptable values include</p>
5827
+ * <ul>
5828
+ * <li>
5829
+ * <p>
5830
+ * <code>ONE_DAY</code> for daily job count
5831
+ * for the prior 14 days.</p>
5832
+ * </li>
5833
+ * <li>
5834
+ * <p>
5835
+ * <code>SEVEN_DAYS</code> for the aggregated
5836
+ * job count for the prior 7 days.</p>
5837
+ * </li>
5838
+ * <li>
5839
+ * <p>
5840
+ * <code>FOURTEEN_DAYS</code> for aggregated
5841
+ * job count for prior 14 days.</p>
5842
+ * </li>
5843
+ * </ul>
5844
+ */
5845
+ AggregationPeriod?: AggregationPeriod;
5846
+ /**
5847
+ * @public
5848
+ * <p>This parameter sets the maximum number of items
5849
+ * to be returned.</p>
5850
+ * <p>The value is an integer. Range of accepted values is from
5851
+ * 1 to 500.</p>
5852
+ */
5853
+ MaxResults?: number;
5854
+ /**
5855
+ * @public
5856
+ * <p>The next item following a partial list of returned resources. For example, if a request
5857
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
5858
+ * allows you to return more items in your list starting at the location pointed to by the
5859
+ * next token.</p>
5860
+ */
5861
+ NextToken?: string;
5862
+ }
5863
+ /**
5864
+ * @public
5865
+ * <p>This is a summary of restore jobs created
5866
+ * or running within the most recent 30 days.</p>
5867
+ * <p>The returned summary may contain the following:
5868
+ * Region, Account, State, ResourceType, MessageCategory,
5869
+ * StartTime, EndTime, and Count of included jobs.</p>
5870
+ */
5871
+ export interface RestoreJobSummary {
5872
+ /**
5873
+ * @public
5874
+ * <p>The Amazon Web Services Regions within the job summary.</p>
5875
+ */
5876
+ Region?: string;
5877
+ /**
5878
+ * @public
5879
+ * <p>The account ID that owns the jobs within the summary.</p>
5880
+ */
5881
+ AccountId?: string;
5882
+ /**
5883
+ * @public
5884
+ * <p>This value is job count for jobs
5885
+ * with the specified state.</p>
5886
+ */
5887
+ State?: RestoreJobState;
5888
+ /**
5889
+ * @public
5890
+ * <p>This value is the job count for the specified resource type.
5891
+ * The request <code>GetSupportedResourceTypes</code> returns
5892
+ * strings for supported resource types.</p>
5893
+ */
5894
+ ResourceType?: string;
5895
+ /**
5896
+ * @public
5897
+ * <p>The value as a number of jobs in a job summary.</p>
5898
+ */
5899
+ Count?: number;
5900
+ /**
5901
+ * @public
5902
+ * <p>The value of time in number format of a job start time.</p>
5903
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
5904
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
5905
+ * 12:11:30.087 AM.</p>
5906
+ */
5907
+ StartTime?: Date;
5908
+ /**
5909
+ * @public
5910
+ * <p>The value of time in number format of a job end time.</p>
5911
+ * <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to
5912
+ * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018
5913
+ * 12:11:30.087 AM.</p>
5914
+ */
5915
+ EndTime?: Date;
5916
+ }
5917
+ /**
5918
+ * @public
5919
+ */
5920
+ export interface ListRestoreJobSummariesOutput {
5921
+ /**
5922
+ * @public
5923
+ * <p>This return contains a summary that contains
5924
+ * Region, Account, State, ResourceType, MessageCategory,
5925
+ * StartTime, EndTime, and Count of included jobs.</p>
5926
+ */
5927
+ RestoreJobSummaries?: RestoreJobSummary[];
5928
+ /**
5929
+ * @public
5930
+ * <p>This is the period that sets the boundaries for returned
5931
+ * results.</p>
5932
+ * <ul>
5933
+ * <li>
5934
+ * <p>
5935
+ * <code>ONE_DAY</code> for daily job count
5936
+ * for the prior 14 days.</p>
5937
+ * </li>
5938
+ * <li>
5939
+ * <p>
5940
+ * <code>SEVEN_DAYS</code> for the aggregated
5941
+ * job count for the prior 7 days.</p>
5942
+ * </li>
5943
+ * <li>
5944
+ * <p>
5945
+ * <code>FOURTEEN_DAYS</code> for aggregated
5946
+ * job count for prior 14 days.</p>
5947
+ * </li>
5948
+ * </ul>
5949
+ */
5950
+ AggregationPeriod?: string;
5951
+ /**
5952
+ * @public
5953
+ * <p>The next item following a partial list of returned resources. For example, if a request
5954
+ * is made to return <code>maxResults</code> number of resources, <code>NextToken</code>
5955
+ * allows you to return more items in your list starting at the location pointed to by the
5956
+ * next token.</p>
5957
+ */
5958
+ NextToken?: string;
5959
+ }
5233
5960
  /**
5234
5961
  * @public
5235
5962
  */