aws-sdk-backup 1.59.0 → 1.60.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +396 -1
- data/lib/aws-sdk-backup/client_api.rb +147 -0
- data/lib/aws-sdk-backup/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-backup/endpoints.rb +42 -0
- data/lib/aws-sdk-backup/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-backup/types.rb +666 -5
- data/lib/aws-sdk-backup.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -233,6 +233,23 @@ module Aws::Backup
|
|
233
233
|
# specified backup.
|
234
234
|
# @return [String]
|
235
235
|
#
|
236
|
+
# @!attribute [rw] message_category
|
237
|
+
# This parameter is the job count for the specified message category.
|
238
|
+
#
|
239
|
+
# Example strings include `AccessDenied`, `Success`, and
|
240
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
241
|
+
# MessageCategory strings.
|
242
|
+
#
|
243
|
+
# The the value ANY returns count of all message categories.
|
244
|
+
#
|
245
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
246
|
+
# returns the sum.
|
247
|
+
#
|
248
|
+
#
|
249
|
+
#
|
250
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
251
|
+
# @return [String]
|
252
|
+
#
|
236
253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation
|
237
254
|
#
|
238
255
|
class BackupJob < Struct.new(
|
@@ -258,7 +275,85 @@ module Aws::Backup
|
|
258
275
|
:backup_type,
|
259
276
|
:parent_job_id,
|
260
277
|
:is_parent,
|
261
|
-
:resource_name
|
278
|
+
:resource_name,
|
279
|
+
:message_category)
|
280
|
+
SENSITIVE = []
|
281
|
+
include Aws::Structure
|
282
|
+
end
|
283
|
+
|
284
|
+
# This is a summary of jobs created or running within the most recent 30
|
285
|
+
# days.
|
286
|
+
#
|
287
|
+
# The returned summary may contain the following: Region, Account,
|
288
|
+
# State, RestourceType, MessageCategory, StartTime, EndTime, and Count
|
289
|
+
# of included jobs.
|
290
|
+
#
|
291
|
+
# @!attribute [rw] region
|
292
|
+
# The Amazon Web Services Regions within the job summary.
|
293
|
+
# @return [String]
|
294
|
+
#
|
295
|
+
# @!attribute [rw] account_id
|
296
|
+
# The account ID that owns the jobs within the summary.
|
297
|
+
# @return [String]
|
298
|
+
#
|
299
|
+
# @!attribute [rw] state
|
300
|
+
# This value is job count for jobs with the specified state.
|
301
|
+
# @return [String]
|
302
|
+
#
|
303
|
+
# @!attribute [rw] resource_type
|
304
|
+
# This value is the job count for the specified resource type. The
|
305
|
+
# request `GetSupportedResourceTypes` returns strings for supported
|
306
|
+
# resource types.
|
307
|
+
# @return [String]
|
308
|
+
#
|
309
|
+
# @!attribute [rw] message_category
|
310
|
+
# This parameter is the job count for the specified message category.
|
311
|
+
#
|
312
|
+
# Example strings include `AccessDenied`, `Success`, and
|
313
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
314
|
+
# MessageCategory strings.
|
315
|
+
#
|
316
|
+
# The the value ANY returns count of all message categories.
|
317
|
+
#
|
318
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
319
|
+
# returns the sum.
|
320
|
+
#
|
321
|
+
#
|
322
|
+
#
|
323
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
324
|
+
# @return [String]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] count
|
327
|
+
# The value as a number of jobs in a job summary.
|
328
|
+
# @return [Integer]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] start_time
|
331
|
+
# The value of time in number format of a job start time.
|
332
|
+
#
|
333
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
334
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
335
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
336
|
+
# @return [Time]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] end_time
|
339
|
+
# The value of time in number format of a job end time.
|
340
|
+
#
|
341
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
342
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
343
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
344
|
+
# @return [Time]
|
345
|
+
#
|
346
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJobSummary AWS API Documentation
|
347
|
+
#
|
348
|
+
class BackupJobSummary < Struct.new(
|
349
|
+
:region,
|
350
|
+
:account_id,
|
351
|
+
:state,
|
352
|
+
:resource_type,
|
353
|
+
:message_category,
|
354
|
+
:count,
|
355
|
+
:start_time,
|
356
|
+
:end_time)
|
262
357
|
SENSITIVE = []
|
263
358
|
include Aws::Structure
|
264
359
|
end
|
@@ -1301,6 +1396,23 @@ module Aws::Backup
|
|
1301
1396
|
# specified backup.
|
1302
1397
|
# @return [String]
|
1303
1398
|
#
|
1399
|
+
# @!attribute [rw] message_category
|
1400
|
+
# This parameter is the job count for the specified message category.
|
1401
|
+
#
|
1402
|
+
# Example strings include `AccessDenied`, `Success`, and
|
1403
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
1404
|
+
# MessageCategory strings.
|
1405
|
+
#
|
1406
|
+
# The the value ANY returns count of all message categories.
|
1407
|
+
#
|
1408
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
1409
|
+
# returns the sum
|
1410
|
+
#
|
1411
|
+
#
|
1412
|
+
#
|
1413
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
1414
|
+
# @return [String]
|
1415
|
+
#
|
1304
1416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyJob AWS API Documentation
|
1305
1417
|
#
|
1306
1418
|
class CopyJob < Struct.new(
|
@@ -1324,7 +1436,85 @@ module Aws::Backup
|
|
1324
1436
|
:composite_member_identifier,
|
1325
1437
|
:number_of_child_jobs,
|
1326
1438
|
:child_jobs_in_state,
|
1327
|
-
:resource_name
|
1439
|
+
:resource_name,
|
1440
|
+
:message_category)
|
1441
|
+
SENSITIVE = []
|
1442
|
+
include Aws::Structure
|
1443
|
+
end
|
1444
|
+
|
1445
|
+
# This is a summary of copy jobs created or running within the most
|
1446
|
+
# recent 30 days.
|
1447
|
+
#
|
1448
|
+
# The returned summary may contain the following: Region, Account,
|
1449
|
+
# State, RestourceType, MessageCategory, StartTime, EndTime, and Count
|
1450
|
+
# of included jobs.
|
1451
|
+
#
|
1452
|
+
# @!attribute [rw] region
|
1453
|
+
# This is the Amazon Web Services Regions within the job summary.
|
1454
|
+
# @return [String]
|
1455
|
+
#
|
1456
|
+
# @!attribute [rw] account_id
|
1457
|
+
# The account ID that owns the jobs within the summary.
|
1458
|
+
# @return [String]
|
1459
|
+
#
|
1460
|
+
# @!attribute [rw] state
|
1461
|
+
# This value is job count for jobs with the specified state.
|
1462
|
+
# @return [String]
|
1463
|
+
#
|
1464
|
+
# @!attribute [rw] resource_type
|
1465
|
+
# This value is the job count for the specified resource type. The
|
1466
|
+
# request `GetSupportedResourceTypes` returns strings for supported
|
1467
|
+
# resource types
|
1468
|
+
# @return [String]
|
1469
|
+
#
|
1470
|
+
# @!attribute [rw] message_category
|
1471
|
+
# This parameter is the job count for the specified message category.
|
1472
|
+
#
|
1473
|
+
# Example strings include `AccessDenied`, `Success`, and
|
1474
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
1475
|
+
# MessageCategory strings.
|
1476
|
+
#
|
1477
|
+
# The the value ANY returns count of all message categories.
|
1478
|
+
#
|
1479
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
1480
|
+
# returns the sum.
|
1481
|
+
#
|
1482
|
+
#
|
1483
|
+
#
|
1484
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
1485
|
+
# @return [String]
|
1486
|
+
#
|
1487
|
+
# @!attribute [rw] count
|
1488
|
+
# The value as a number of jobs in a job summary.
|
1489
|
+
# @return [Integer]
|
1490
|
+
#
|
1491
|
+
# @!attribute [rw] start_time
|
1492
|
+
# The value of time in number format of a job start time.
|
1493
|
+
#
|
1494
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
1495
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
1496
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
1497
|
+
# @return [Time]
|
1498
|
+
#
|
1499
|
+
# @!attribute [rw] end_time
|
1500
|
+
# The value of time in number format of a job end time.
|
1501
|
+
#
|
1502
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
1503
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
1504
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
1505
|
+
# @return [Time]
|
1506
|
+
#
|
1507
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyJobSummary AWS API Documentation
|
1508
|
+
#
|
1509
|
+
class CopyJobSummary < Struct.new(
|
1510
|
+
:region,
|
1511
|
+
:account_id,
|
1512
|
+
:state,
|
1513
|
+
:resource_type,
|
1514
|
+
:message_category,
|
1515
|
+
:count,
|
1516
|
+
:start_time,
|
1517
|
+
:end_time)
|
1328
1518
|
SENSITIVE = []
|
1329
1519
|
include Aws::Structure
|
1330
1520
|
end
|
@@ -2216,6 +2406,18 @@ module Aws::Backup
|
|
2216
2406
|
# specified backup.
|
2217
2407
|
# @return [String]
|
2218
2408
|
#
|
2409
|
+
# @!attribute [rw] message_category
|
2410
|
+
# This is the job count for the specified message category.
|
2411
|
+
#
|
2412
|
+
# Example strings may include `AccessDenied`, `Success`, and
|
2413
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
2414
|
+
# MessageCategory strings.
|
2415
|
+
#
|
2416
|
+
#
|
2417
|
+
#
|
2418
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2419
|
+
# @return [String]
|
2420
|
+
#
|
2219
2421
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJobOutput AWS API Documentation
|
2220
2422
|
#
|
2221
2423
|
class DescribeBackupJobOutput < Struct.new(
|
@@ -2243,7 +2445,8 @@ module Aws::Backup
|
|
2243
2445
|
:is_parent,
|
2244
2446
|
:number_of_child_jobs,
|
2245
2447
|
:child_jobs_in_state,
|
2246
|
-
:resource_name
|
2448
|
+
:resource_name,
|
2449
|
+
:message_category)
|
2247
2450
|
SENSITIVE = []
|
2248
2451
|
include Aws::Structure
|
2249
2452
|
end
|
@@ -3792,6 +3995,135 @@ module Aws::Backup
|
|
3792
3995
|
include Aws::Structure
|
3793
3996
|
end
|
3794
3997
|
|
3998
|
+
# @!attribute [rw] account_id
|
3999
|
+
# Returns the job count for the specified account.
|
4000
|
+
#
|
4001
|
+
# If the request is sent from a member account or an account not part
|
4002
|
+
# of Amazon Web Services Organizations, jobs within requestor's
|
4003
|
+
# account will be returned.
|
4004
|
+
#
|
4005
|
+
# Root, admin, and delegated administrator accounts can use the value
|
4006
|
+
# ANY to return job counts from every account in the organization.
|
4007
|
+
#
|
4008
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
4009
|
+
# authenticated organization, then returns the sum.
|
4010
|
+
# @return [String]
|
4011
|
+
#
|
4012
|
+
# @!attribute [rw] state
|
4013
|
+
# This parameter returns the job count for jobs with the specified
|
4014
|
+
# state.
|
4015
|
+
#
|
4016
|
+
# The the value ANY returns count of all states.
|
4017
|
+
#
|
4018
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
4019
|
+
# sum.
|
4020
|
+
# @return [String]
|
4021
|
+
#
|
4022
|
+
# @!attribute [rw] resource_type
|
4023
|
+
# Returns the job count for the specified resource type. Use request
|
4024
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
4025
|
+
# types.
|
4026
|
+
#
|
4027
|
+
# The the value ANY returns count of all resource types.
|
4028
|
+
#
|
4029
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
4030
|
+
# returns the sum.
|
4031
|
+
#
|
4032
|
+
# The type of Amazon Web Services resource to be backed up; for
|
4033
|
+
# example, an Amazon Elastic Block Store (Amazon EBS) volume or an
|
4034
|
+
# Amazon Relational Database Service (Amazon RDS) database.
|
4035
|
+
# @return [String]
|
4036
|
+
#
|
4037
|
+
# @!attribute [rw] message_category
|
4038
|
+
# This parameter returns the job count for the specified message
|
4039
|
+
# category.
|
4040
|
+
#
|
4041
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
4042
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
4043
|
+
# MessageCategory strings.
|
4044
|
+
#
|
4045
|
+
# The the value ANY returns count of all message categories.
|
4046
|
+
#
|
4047
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
4048
|
+
# returns the sum.
|
4049
|
+
#
|
4050
|
+
#
|
4051
|
+
#
|
4052
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
4053
|
+
# @return [String]
|
4054
|
+
#
|
4055
|
+
# @!attribute [rw] aggregation_period
|
4056
|
+
# This is the period that sets the boundaries for returned results.
|
4057
|
+
#
|
4058
|
+
# Acceptable values include
|
4059
|
+
#
|
4060
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
4061
|
+
#
|
4062
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
4063
|
+
#
|
4064
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
4065
|
+
# @return [String]
|
4066
|
+
#
|
4067
|
+
# @!attribute [rw] max_results
|
4068
|
+
# This parameter sets the maximum number of items to be returned.
|
4069
|
+
#
|
4070
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
4071
|
+
# @return [Integer]
|
4072
|
+
#
|
4073
|
+
# @!attribute [rw] next_token
|
4074
|
+
# The next item following a partial list of returned resources. For
|
4075
|
+
# example, if a request is made to return `maxResults` number of
|
4076
|
+
# resources, `NextToken` allows you to return more items in your list
|
4077
|
+
# starting at the location pointed to by the next token.
|
4078
|
+
# @return [String]
|
4079
|
+
#
|
4080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobSummariesInput AWS API Documentation
|
4081
|
+
#
|
4082
|
+
class ListBackupJobSummariesInput < Struct.new(
|
4083
|
+
:account_id,
|
4084
|
+
:state,
|
4085
|
+
:resource_type,
|
4086
|
+
:message_category,
|
4087
|
+
:aggregation_period,
|
4088
|
+
:max_results,
|
4089
|
+
:next_token)
|
4090
|
+
SENSITIVE = []
|
4091
|
+
include Aws::Structure
|
4092
|
+
end
|
4093
|
+
|
4094
|
+
# @!attribute [rw] backup_job_summaries
|
4095
|
+
# This request returns a summary that contains Region, Account, State,
|
4096
|
+
# ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
4097
|
+
# included jobs.
|
4098
|
+
# @return [Array<Types::BackupJobSummary>]
|
4099
|
+
#
|
4100
|
+
# @!attribute [rw] aggregation_period
|
4101
|
+
# This is the period that sets the boundaries for returned results.
|
4102
|
+
#
|
4103
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
4104
|
+
#
|
4105
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
4106
|
+
#
|
4107
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
4108
|
+
# @return [String]
|
4109
|
+
#
|
4110
|
+
# @!attribute [rw] next_token
|
4111
|
+
# The next item following a partial list of returned resources. For
|
4112
|
+
# example, if a request is made to return `maxResults` number of
|
4113
|
+
# resources, `NextToken` allows you to return more items in your list
|
4114
|
+
# starting at the location pointed to by the next token.
|
4115
|
+
# @return [String]
|
4116
|
+
#
|
4117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobSummariesOutput AWS API Documentation
|
4118
|
+
#
|
4119
|
+
class ListBackupJobSummariesOutput < Struct.new(
|
4120
|
+
:backup_job_summaries,
|
4121
|
+
:aggregation_period,
|
4122
|
+
:next_token)
|
4123
|
+
SENSITIVE = []
|
4124
|
+
include Aws::Structure
|
4125
|
+
end
|
4126
|
+
|
3795
4127
|
# @!attribute [rw] next_token
|
3796
4128
|
# The next item following a partial list of returned items. For
|
3797
4129
|
# example, if a request is made to return `maxResults` number of
|
@@ -3879,6 +4211,19 @@ module Aws::Backup
|
|
3879
4211
|
# This is a filter to list child (nested) jobs based on parent job ID.
|
3880
4212
|
# @return [String]
|
3881
4213
|
#
|
4214
|
+
# @!attribute [rw] by_message_category
|
4215
|
+
# This returns a list of backup jobs for the specified message
|
4216
|
+
# category.
|
4217
|
+
#
|
4218
|
+
# Example strings may include `AccessDenied`, `Success`, and
|
4219
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of
|
4220
|
+
# MessageCategory strings.
|
4221
|
+
#
|
4222
|
+
#
|
4223
|
+
#
|
4224
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
4225
|
+
# @return [String]
|
4226
|
+
#
|
3882
4227
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobsInput AWS API Documentation
|
3883
4228
|
#
|
3884
4229
|
class ListBackupJobsInput < Struct.new(
|
@@ -3893,7 +4238,8 @@ module Aws::Backup
|
|
3893
4238
|
:by_account_id,
|
3894
4239
|
:by_complete_after,
|
3895
4240
|
:by_complete_before,
|
3896
|
-
:by_parent_job_id
|
4241
|
+
:by_parent_job_id,
|
4242
|
+
:by_message_category)
|
3897
4243
|
SENSITIVE = []
|
3898
4244
|
include Aws::Structure
|
3899
4245
|
end
|
@@ -4152,6 +4498,133 @@ module Aws::Backup
|
|
4152
4498
|
include Aws::Structure
|
4153
4499
|
end
|
4154
4500
|
|
4501
|
+
# @!attribute [rw] account_id
|
4502
|
+
# Returns the job count for the specified account.
|
4503
|
+
#
|
4504
|
+
# If the request is sent from a member account or an account not part
|
4505
|
+
# of Amazon Web Services Organizations, jobs within requestor's
|
4506
|
+
# account will be returned.
|
4507
|
+
#
|
4508
|
+
# Root, admin, and delegated administrator accounts can use the value
|
4509
|
+
# ANY to return job counts from every account in the organization.
|
4510
|
+
#
|
4511
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
4512
|
+
# authenticated organization, then returns the sum.
|
4513
|
+
# @return [String]
|
4514
|
+
#
|
4515
|
+
# @!attribute [rw] state
|
4516
|
+
# This parameter returns the job count for jobs with the specified
|
4517
|
+
# state.
|
4518
|
+
#
|
4519
|
+
# The the value ANY returns count of all states.
|
4520
|
+
#
|
4521
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
4522
|
+
# sum.
|
4523
|
+
# @return [String]
|
4524
|
+
#
|
4525
|
+
# @!attribute [rw] resource_type
|
4526
|
+
# Returns the job count for the specified resource type. Use request
|
4527
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
4528
|
+
# types.
|
4529
|
+
#
|
4530
|
+
# The the value ANY returns count of all resource types.
|
4531
|
+
#
|
4532
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
4533
|
+
# returns the sum.
|
4534
|
+
#
|
4535
|
+
# The type of Amazon Web Services resource to be backed up; for
|
4536
|
+
# example, an Amazon Elastic Block Store (Amazon EBS) volume or an
|
4537
|
+
# Amazon Relational Database Service (Amazon RDS) database.
|
4538
|
+
# @return [String]
|
4539
|
+
#
|
4540
|
+
# @!attribute [rw] message_category
|
4541
|
+
# This parameter returns the job count for the specified message
|
4542
|
+
# category.
|
4543
|
+
#
|
4544
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
4545
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
4546
|
+
# MessageCategory strings.
|
4547
|
+
#
|
4548
|
+
# The the value ANY returns count of all message categories.
|
4549
|
+
#
|
4550
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
4551
|
+
# returns the sum.
|
4552
|
+
#
|
4553
|
+
#
|
4554
|
+
#
|
4555
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
4556
|
+
# @return [String]
|
4557
|
+
#
|
4558
|
+
# @!attribute [rw] aggregation_period
|
4559
|
+
# This is the period that sets the boundaries for returned results.
|
4560
|
+
#
|
4561
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
4562
|
+
#
|
4563
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
4564
|
+
#
|
4565
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
4566
|
+
# @return [String]
|
4567
|
+
#
|
4568
|
+
# @!attribute [rw] max_results
|
4569
|
+
# This parameter sets the maximum number of items to be returned.
|
4570
|
+
#
|
4571
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
4572
|
+
# @return [Integer]
|
4573
|
+
#
|
4574
|
+
# @!attribute [rw] next_token
|
4575
|
+
# The next item following a partial list of returned resources. For
|
4576
|
+
# example, if a request is made to return `maxResults` number of
|
4577
|
+
# resources, `NextToken` allows you to return more items in your list
|
4578
|
+
# starting at the location pointed to by the next token.
|
4579
|
+
# @return [String]
|
4580
|
+
#
|
4581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobSummariesInput AWS API Documentation
|
4582
|
+
#
|
4583
|
+
class ListCopyJobSummariesInput < Struct.new(
|
4584
|
+
:account_id,
|
4585
|
+
:state,
|
4586
|
+
:resource_type,
|
4587
|
+
:message_category,
|
4588
|
+
:aggregation_period,
|
4589
|
+
:max_results,
|
4590
|
+
:next_token)
|
4591
|
+
SENSITIVE = []
|
4592
|
+
include Aws::Structure
|
4593
|
+
end
|
4594
|
+
|
4595
|
+
# @!attribute [rw] copy_job_summaries
|
4596
|
+
# This return shows a summary that contains Region, Account, State,
|
4597
|
+
# ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
4598
|
+
# included jobs.
|
4599
|
+
# @return [Array<Types::CopyJobSummary>]
|
4600
|
+
#
|
4601
|
+
# @!attribute [rw] aggregation_period
|
4602
|
+
# This is the period that sets the boundaries for returned results.
|
4603
|
+
#
|
4604
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
4605
|
+
#
|
4606
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
4607
|
+
#
|
4608
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
4609
|
+
# @return [String]
|
4610
|
+
#
|
4611
|
+
# @!attribute [rw] next_token
|
4612
|
+
# The next item following a partial list of returned resources. For
|
4613
|
+
# example, if a request is made to return `maxResults` number of
|
4614
|
+
# resources, `NextToken` allows you to return more items in your list
|
4615
|
+
# starting at the location pointed to by the next token.
|
4616
|
+
# @return [String]
|
4617
|
+
#
|
4618
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobSummariesOutput AWS API Documentation
|
4619
|
+
#
|
4620
|
+
class ListCopyJobSummariesOutput < Struct.new(
|
4621
|
+
:copy_job_summaries,
|
4622
|
+
:aggregation_period,
|
4623
|
+
:next_token)
|
4624
|
+
SENSITIVE = []
|
4625
|
+
include Aws::Structure
|
4626
|
+
end
|
4627
|
+
|
4155
4628
|
# @!attribute [rw] next_token
|
4156
4629
|
# The next item following a partial list of returned items. For
|
4157
4630
|
# example, if a request is made to return maxResults number of items,
|
@@ -4233,6 +4706,24 @@ module Aws::Backup
|
|
4233
4706
|
# This is a filter to list child (nested) jobs based on parent job ID.
|
4234
4707
|
# @return [String]
|
4235
4708
|
#
|
4709
|
+
# @!attribute [rw] by_message_category
|
4710
|
+
# This parameter returns the job count for the specified message
|
4711
|
+
# category.
|
4712
|
+
#
|
4713
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
4714
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
4715
|
+
# MessageCategory strings.
|
4716
|
+
#
|
4717
|
+
# The the value ANY returns count of all message categories.
|
4718
|
+
#
|
4719
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
4720
|
+
# returns the sum.
|
4721
|
+
#
|
4722
|
+
#
|
4723
|
+
#
|
4724
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
4725
|
+
# @return [String]
|
4726
|
+
#
|
4236
4727
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobsInput AWS API Documentation
|
4237
4728
|
#
|
4238
4729
|
class ListCopyJobsInput < Struct.new(
|
@@ -4247,7 +4738,8 @@ module Aws::Backup
|
|
4247
4738
|
:by_account_id,
|
4248
4739
|
:by_complete_before,
|
4249
4740
|
:by_complete_after,
|
4250
|
-
:by_parent_job_id
|
4741
|
+
:by_parent_job_id,
|
4742
|
+
:by_message_category)
|
4251
4743
|
SENSITIVE = []
|
4252
4744
|
include Aws::Structure
|
4253
4745
|
end
|
@@ -4754,6 +5246,116 @@ module Aws::Backup
|
|
4754
5246
|
include Aws::Structure
|
4755
5247
|
end
|
4756
5248
|
|
5249
|
+
# @!attribute [rw] account_id
|
5250
|
+
# Returns the job count for the specified account.
|
5251
|
+
#
|
5252
|
+
# If the request is sent from a member account or an account not part
|
5253
|
+
# of Amazon Web Services Organizations, jobs within requestor's
|
5254
|
+
# account will be returned.
|
5255
|
+
#
|
5256
|
+
# Root, admin, and delegated administrator accounts can use the value
|
5257
|
+
# ANY to return job counts from every account in the organization.
|
5258
|
+
#
|
5259
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
5260
|
+
# authenticated organization, then returns the sum.
|
5261
|
+
# @return [String]
|
5262
|
+
#
|
5263
|
+
# @!attribute [rw] state
|
5264
|
+
# This parameter returns the job count for jobs with the specified
|
5265
|
+
# state.
|
5266
|
+
#
|
5267
|
+
# The the value ANY returns count of all states.
|
5268
|
+
#
|
5269
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
5270
|
+
# sum.
|
5271
|
+
# @return [String]
|
5272
|
+
#
|
5273
|
+
# @!attribute [rw] resource_type
|
5274
|
+
# Returns the job count for the specified resource type. Use request
|
5275
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
5276
|
+
# types.
|
5277
|
+
#
|
5278
|
+
# The the value ANY returns count of all resource types.
|
5279
|
+
#
|
5280
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
5281
|
+
# returns the sum.
|
5282
|
+
#
|
5283
|
+
# The type of Amazon Web Services resource to be backed up; for
|
5284
|
+
# example, an Amazon Elastic Block Store (Amazon EBS) volume or an
|
5285
|
+
# Amazon Relational Database Service (Amazon RDS) database.
|
5286
|
+
# @return [String]
|
5287
|
+
#
|
5288
|
+
# @!attribute [rw] aggregation_period
|
5289
|
+
# This is the period that sets the boundaries for returned results.
|
5290
|
+
#
|
5291
|
+
# Acceptable values include
|
5292
|
+
#
|
5293
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
5294
|
+
#
|
5295
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
5296
|
+
#
|
5297
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
5298
|
+
# @return [String]
|
5299
|
+
#
|
5300
|
+
# @!attribute [rw] max_results
|
5301
|
+
# This parameter sets the maximum number of items to be returned.
|
5302
|
+
#
|
5303
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
5304
|
+
# @return [Integer]
|
5305
|
+
#
|
5306
|
+
# @!attribute [rw] next_token
|
5307
|
+
# The next item following a partial list of returned resources. For
|
5308
|
+
# example, if a request is made to return `maxResults` number of
|
5309
|
+
# resources, `NextToken` allows you to return more items in your list
|
5310
|
+
# starting at the location pointed to by the next token.
|
5311
|
+
# @return [String]
|
5312
|
+
#
|
5313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobSummariesInput AWS API Documentation
|
5314
|
+
#
|
5315
|
+
class ListRestoreJobSummariesInput < Struct.new(
|
5316
|
+
:account_id,
|
5317
|
+
:state,
|
5318
|
+
:resource_type,
|
5319
|
+
:aggregation_period,
|
5320
|
+
:max_results,
|
5321
|
+
:next_token)
|
5322
|
+
SENSITIVE = []
|
5323
|
+
include Aws::Structure
|
5324
|
+
end
|
5325
|
+
|
5326
|
+
# @!attribute [rw] restore_job_summaries
|
5327
|
+
# This return contains a summary that contains Region, Account, State,
|
5328
|
+
# ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
5329
|
+
# included jobs.
|
5330
|
+
# @return [Array<Types::RestoreJobSummary>]
|
5331
|
+
#
|
5332
|
+
# @!attribute [rw] aggregation_period
|
5333
|
+
# This is the period that sets the boundaries for returned results.
|
5334
|
+
#
|
5335
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
5336
|
+
#
|
5337
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
5338
|
+
#
|
5339
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
5340
|
+
# @return [String]
|
5341
|
+
#
|
5342
|
+
# @!attribute [rw] next_token
|
5343
|
+
# The next item following a partial list of returned resources. For
|
5344
|
+
# example, if a request is made to return `maxResults` number of
|
5345
|
+
# resources, `NextToken` allows you to return more items in your list
|
5346
|
+
# starting at the location pointed to by the next token.
|
5347
|
+
# @return [String]
|
5348
|
+
#
|
5349
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobSummariesOutput AWS API Documentation
|
5350
|
+
#
|
5351
|
+
class ListRestoreJobSummariesOutput < Struct.new(
|
5352
|
+
:restore_job_summaries,
|
5353
|
+
:aggregation_period,
|
5354
|
+
:next_token)
|
5355
|
+
SENSITIVE = []
|
5356
|
+
include Aws::Structure
|
5357
|
+
end
|
5358
|
+
|
4757
5359
|
# @!attribute [rw] next_token
|
4758
5360
|
# The next item following a partial list of returned items. For
|
4759
5361
|
# example, if a request is made to return `maxResults` number of
|
@@ -5723,6 +6325,65 @@ module Aws::Backup
|
|
5723
6325
|
include Aws::Structure
|
5724
6326
|
end
|
5725
6327
|
|
6328
|
+
# This is a summary of restore jobs created or running within the most
|
6329
|
+
# recent 30 days.
|
6330
|
+
#
|
6331
|
+
# The returned summary may contain the following: Region, Account,
|
6332
|
+
# State, ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
6333
|
+
# included jobs.
|
6334
|
+
#
|
6335
|
+
# @!attribute [rw] region
|
6336
|
+
# The Amazon Web Services Regions within the job summary.
|
6337
|
+
# @return [String]
|
6338
|
+
#
|
6339
|
+
# @!attribute [rw] account_id
|
6340
|
+
# The account ID that owns the jobs within the summary.
|
6341
|
+
# @return [String]
|
6342
|
+
#
|
6343
|
+
# @!attribute [rw] state
|
6344
|
+
# This value is job count for jobs with the specified state.
|
6345
|
+
# @return [String]
|
6346
|
+
#
|
6347
|
+
# @!attribute [rw] resource_type
|
6348
|
+
# This value is the job count for the specified resource type. The
|
6349
|
+
# request `GetSupportedResourceTypes` returns strings for supported
|
6350
|
+
# resource types.
|
6351
|
+
# @return [String]
|
6352
|
+
#
|
6353
|
+
# @!attribute [rw] count
|
6354
|
+
# The value as a number of jobs in a job summary.
|
6355
|
+
# @return [Integer]
|
6356
|
+
#
|
6357
|
+
# @!attribute [rw] start_time
|
6358
|
+
# The value of time in number format of a job start time.
|
6359
|
+
#
|
6360
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
6361
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
6362
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
6363
|
+
# @return [Time]
|
6364
|
+
#
|
6365
|
+
# @!attribute [rw] end_time
|
6366
|
+
# The value of time in number format of a job end time.
|
6367
|
+
#
|
6368
|
+
# This value is the time in Unix format, Coordinated Universal Time
|
6369
|
+
# (UTC), and accurate to milliseconds. For example, the value
|
6370
|
+
# 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
|
6371
|
+
# @return [Time]
|
6372
|
+
#
|
6373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreJobSummary AWS API Documentation
|
6374
|
+
#
|
6375
|
+
class RestoreJobSummary < Struct.new(
|
6376
|
+
:region,
|
6377
|
+
:account_id,
|
6378
|
+
:state,
|
6379
|
+
:resource_type,
|
6380
|
+
:count,
|
6381
|
+
:start_time,
|
6382
|
+
:end_time)
|
6383
|
+
SENSITIVE = []
|
6384
|
+
include Aws::Structure
|
6385
|
+
end
|
6386
|
+
|
5726
6387
|
# Contains metadata about a restore job.
|
5727
6388
|
#
|
5728
6389
|
# @!attribute [rw] account_id
|