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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e98045c0456ddce0531fc02b79a256b4d485284acf4bd4a9cb82b89811f4697a
|
4
|
+
data.tar.gz: 6071b8ac2e21abee8f281d7210be0bb11c700a004e9661182634021567ff10c5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5856225aa494cb39f6b7f3276a373da7bd0c2e874b8ae79c941c9b1713caee6197e35d34a9fbe51325100e7e49006b8efe79146a42dff220351f4c50e3670c8e
|
7
|
+
data.tar.gz: 6f96784bbc839203afba65087a5b01686833912033f30d044edb4f0cb71b3e49f88844832549dbbb7c26f69df8064f89d9bc13420d61a36ea38b6ec19fed62f8
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.60.0
|
@@ -1309,6 +1309,7 @@ module Aws::Backup
|
|
1309
1309
|
# * {Types::DescribeBackupJobOutput#number_of_child_jobs #number_of_child_jobs} => Integer
|
1310
1310
|
# * {Types::DescribeBackupJobOutput#child_jobs_in_state #child_jobs_in_state} => Hash<String,Integer>
|
1311
1311
|
# * {Types::DescribeBackupJobOutput#resource_name #resource_name} => String
|
1312
|
+
# * {Types::DescribeBackupJobOutput#message_category #message_category} => String
|
1312
1313
|
#
|
1313
1314
|
# @example Request syntax with placeholder values
|
1314
1315
|
#
|
@@ -1348,6 +1349,7 @@ module Aws::Backup
|
|
1348
1349
|
# resp.child_jobs_in_state #=> Hash
|
1349
1350
|
# resp.child_jobs_in_state["BackupJobState"] #=> Integer
|
1350
1351
|
# resp.resource_name #=> String
|
1352
|
+
# resp.message_category #=> String
|
1351
1353
|
#
|
1352
1354
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob AWS API Documentation
|
1353
1355
|
#
|
@@ -1455,6 +1457,7 @@ module Aws::Backup
|
|
1455
1457
|
# resp.copy_job.child_jobs_in_state #=> Hash
|
1456
1458
|
# resp.copy_job.child_jobs_in_state["CopyJobState"] #=> Integer
|
1457
1459
|
# resp.copy_job.resource_name #=> String
|
1460
|
+
# resp.copy_job.message_category #=> String
|
1458
1461
|
#
|
1459
1462
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob AWS API Documentation
|
1460
1463
|
#
|
@@ -2365,6 +2368,133 @@ module Aws::Backup
|
|
2365
2368
|
req.send_request(options)
|
2366
2369
|
end
|
2367
2370
|
|
2371
|
+
# This is a request for a summary of backup jobs created or running
|
2372
|
+
# within the most recent 30 days. You can include parameters AccountID,
|
2373
|
+
# State, ResourceType, MessageCategory, AggregationPeriod, MaxResults,
|
2374
|
+
# or NextToken to filter results.
|
2375
|
+
#
|
2376
|
+
# This request returns a summary that contains Region, Account, State,
|
2377
|
+
# ResourceType, MessageCategory, StartTime, EndTime, and Count of
|
2378
|
+
# included jobs.
|
2379
|
+
#
|
2380
|
+
# @option params [String] :account_id
|
2381
|
+
# Returns the job count for the specified account.
|
2382
|
+
#
|
2383
|
+
# If the request is sent from a member account or an account not part of
|
2384
|
+
# Amazon Web Services Organizations, jobs within requestor's account
|
2385
|
+
# will be returned.
|
2386
|
+
#
|
2387
|
+
# Root, admin, and delegated administrator accounts can use the value
|
2388
|
+
# ANY to return job counts from every account in the organization.
|
2389
|
+
#
|
2390
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
2391
|
+
# authenticated organization, then returns the sum.
|
2392
|
+
#
|
2393
|
+
# @option params [String] :state
|
2394
|
+
# This parameter returns the job count for jobs with the specified
|
2395
|
+
# state.
|
2396
|
+
#
|
2397
|
+
# The the value ANY returns count of all states.
|
2398
|
+
#
|
2399
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
2400
|
+
# sum.
|
2401
|
+
#
|
2402
|
+
# @option params [String] :resource_type
|
2403
|
+
# Returns the job count for the specified resource type. Use request
|
2404
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
2405
|
+
# types.
|
2406
|
+
#
|
2407
|
+
# The the value ANY returns count of all resource types.
|
2408
|
+
#
|
2409
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
2410
|
+
# returns the sum.
|
2411
|
+
#
|
2412
|
+
# The type of Amazon Web Services resource to be backed up; for example,
|
2413
|
+
# an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
2414
|
+
# Relational Database Service (Amazon RDS) database.
|
2415
|
+
#
|
2416
|
+
# @option params [String] :message_category
|
2417
|
+
# This parameter returns the job count for the specified message
|
2418
|
+
# category.
|
2419
|
+
#
|
2420
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
2421
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
2422
|
+
# MessageCategory strings.
|
2423
|
+
#
|
2424
|
+
# The the value ANY returns count of all message categories.
|
2425
|
+
#
|
2426
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
2427
|
+
# returns the sum.
|
2428
|
+
#
|
2429
|
+
#
|
2430
|
+
#
|
2431
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2432
|
+
#
|
2433
|
+
# @option params [String] :aggregation_period
|
2434
|
+
# This is the period that sets the boundaries for returned results.
|
2435
|
+
#
|
2436
|
+
# Acceptable values include
|
2437
|
+
#
|
2438
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
2439
|
+
#
|
2440
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
2441
|
+
#
|
2442
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
2443
|
+
#
|
2444
|
+
# @option params [Integer] :max_results
|
2445
|
+
# This parameter sets the maximum number of items to be returned.
|
2446
|
+
#
|
2447
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
2448
|
+
#
|
2449
|
+
# @option params [String] :next_token
|
2450
|
+
# The next item following a partial list of returned resources. For
|
2451
|
+
# example, if a request is made to return `maxResults` number of
|
2452
|
+
# resources, `NextToken` allows you to return more items in your list
|
2453
|
+
# starting at the location pointed to by the next token.
|
2454
|
+
#
|
2455
|
+
# @return [Types::ListBackupJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
|
+
#
|
2457
|
+
# * {Types::ListBackupJobSummariesOutput#backup_job_summaries #backup_job_summaries} => Array<Types::BackupJobSummary>
|
2458
|
+
# * {Types::ListBackupJobSummariesOutput#aggregation_period #aggregation_period} => String
|
2459
|
+
# * {Types::ListBackupJobSummariesOutput#next_token #next_token} => String
|
2460
|
+
#
|
2461
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2462
|
+
#
|
2463
|
+
# @example Request syntax with placeholder values
|
2464
|
+
#
|
2465
|
+
# resp = client.list_backup_job_summaries({
|
2466
|
+
# account_id: "AccountId",
|
2467
|
+
# state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTING, ABORTED, COMPLETED, FAILED, EXPIRED, PARTIAL, AGGREGATE_ALL, ANY
|
2468
|
+
# resource_type: "ResourceType",
|
2469
|
+
# message_category: "MessageCategory",
|
2470
|
+
# aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
|
2471
|
+
# max_results: 1,
|
2472
|
+
# next_token: "string",
|
2473
|
+
# })
|
2474
|
+
#
|
2475
|
+
# @example Response structure
|
2476
|
+
#
|
2477
|
+
# resp.backup_job_summaries #=> Array
|
2478
|
+
# resp.backup_job_summaries[0].region #=> String
|
2479
|
+
# resp.backup_job_summaries[0].account_id #=> String
|
2480
|
+
# resp.backup_job_summaries[0].state #=> String, one of "CREATED", "PENDING", "RUNNING", "ABORTING", "ABORTED", "COMPLETED", "FAILED", "EXPIRED", "PARTIAL", "AGGREGATE_ALL", "ANY"
|
2481
|
+
# resp.backup_job_summaries[0].resource_type #=> String
|
2482
|
+
# resp.backup_job_summaries[0].message_category #=> String
|
2483
|
+
# resp.backup_job_summaries[0].count #=> Integer
|
2484
|
+
# resp.backup_job_summaries[0].start_time #=> Time
|
2485
|
+
# resp.backup_job_summaries[0].end_time #=> Time
|
2486
|
+
# resp.aggregation_period #=> String
|
2487
|
+
# resp.next_token #=> String
|
2488
|
+
#
|
2489
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobSummaries AWS API Documentation
|
2490
|
+
#
|
2491
|
+
# @overload list_backup_job_summaries(params = {})
|
2492
|
+
# @param [Hash] params ({})
|
2493
|
+
def list_backup_job_summaries(params = {}, options = {})
|
2494
|
+
req = build_request(:list_backup_job_summaries, params)
|
2495
|
+
req.send_request(options)
|
2496
|
+
end
|
2497
|
+
|
2368
2498
|
# Returns a list of existing backup jobs for an authenticated account
|
2369
2499
|
# for the last 30 days. For a longer period of time, consider using
|
2370
2500
|
# these [monitoring tools][1].
|
@@ -2447,6 +2577,17 @@ module Aws::Backup
|
|
2447
2577
|
# @option params [String] :by_parent_job_id
|
2448
2578
|
# This is a filter to list child (nested) jobs based on parent job ID.
|
2449
2579
|
#
|
2580
|
+
# @option params [String] :by_message_category
|
2581
|
+
# This returns a list of backup jobs for the specified message category.
|
2582
|
+
#
|
2583
|
+
# Example strings may include `AccessDenied`, `Success`, and
|
2584
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of MessageCategory
|
2585
|
+
# strings.
|
2586
|
+
#
|
2587
|
+
#
|
2588
|
+
#
|
2589
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2590
|
+
#
|
2450
2591
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2451
2592
|
#
|
2452
2593
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
@@ -2469,6 +2610,7 @@ module Aws::Backup
|
|
2469
2610
|
# by_complete_after: Time.now,
|
2470
2611
|
# by_complete_before: Time.now,
|
2471
2612
|
# by_parent_job_id: "string",
|
2613
|
+
# by_message_category: "string",
|
2472
2614
|
# })
|
2473
2615
|
#
|
2474
2616
|
# @example Response structure
|
@@ -2501,6 +2643,7 @@ module Aws::Backup
|
|
2501
2643
|
# resp.backup_jobs[0].parent_job_id #=> String
|
2502
2644
|
# resp.backup_jobs[0].is_parent #=> Boolean
|
2503
2645
|
# resp.backup_jobs[0].resource_name #=> String
|
2646
|
+
# resp.backup_jobs[0].message_category #=> String
|
2504
2647
|
# resp.next_token #=> String
|
2505
2648
|
#
|
2506
2649
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs AWS API Documentation
|
@@ -2778,6 +2921,131 @@ module Aws::Backup
|
|
2778
2921
|
req.send_request(options)
|
2779
2922
|
end
|
2780
2923
|
|
2924
|
+
# This request obtains a list of copy jobs created or running within the
|
2925
|
+
# the most recent 30 days. You can include parameters AccountID, State,
|
2926
|
+
# ResourceType, MessageCategory, AggregationPeriod, MaxResults, or
|
2927
|
+
# NextToken to filter results.
|
2928
|
+
#
|
2929
|
+
# This request returns a summary that contains Region, Account, State,
|
2930
|
+
# RestourceType, MessageCategory, StartTime, EndTime, and Count of
|
2931
|
+
# included jobs.
|
2932
|
+
#
|
2933
|
+
# @option params [String] :account_id
|
2934
|
+
# Returns the job count for the specified account.
|
2935
|
+
#
|
2936
|
+
# If the request is sent from a member account or an account not part of
|
2937
|
+
# Amazon Web Services Organizations, jobs within requestor's account
|
2938
|
+
# will be returned.
|
2939
|
+
#
|
2940
|
+
# Root, admin, and delegated administrator accounts can use the value
|
2941
|
+
# ANY to return job counts from every account in the organization.
|
2942
|
+
#
|
2943
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
2944
|
+
# authenticated organization, then returns the sum.
|
2945
|
+
#
|
2946
|
+
# @option params [String] :state
|
2947
|
+
# This parameter returns the job count for jobs with the specified
|
2948
|
+
# state.
|
2949
|
+
#
|
2950
|
+
# The the value ANY returns count of all states.
|
2951
|
+
#
|
2952
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
2953
|
+
# sum.
|
2954
|
+
#
|
2955
|
+
# @option params [String] :resource_type
|
2956
|
+
# Returns the job count for the specified resource type. Use request
|
2957
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
2958
|
+
# types.
|
2959
|
+
#
|
2960
|
+
# The the value ANY returns count of all resource types.
|
2961
|
+
#
|
2962
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
2963
|
+
# returns the sum.
|
2964
|
+
#
|
2965
|
+
# The type of Amazon Web Services resource to be backed up; for example,
|
2966
|
+
# an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
2967
|
+
# Relational Database Service (Amazon RDS) database.
|
2968
|
+
#
|
2969
|
+
# @option params [String] :message_category
|
2970
|
+
# This parameter returns the job count for the specified message
|
2971
|
+
# category.
|
2972
|
+
#
|
2973
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
2974
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
2975
|
+
# MessageCategory strings.
|
2976
|
+
#
|
2977
|
+
# The the value ANY returns count of all message categories.
|
2978
|
+
#
|
2979
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
2980
|
+
# returns the sum.
|
2981
|
+
#
|
2982
|
+
#
|
2983
|
+
#
|
2984
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2985
|
+
#
|
2986
|
+
# @option params [String] :aggregation_period
|
2987
|
+
# This is the period that sets the boundaries for returned results.
|
2988
|
+
#
|
2989
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
2990
|
+
#
|
2991
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
2992
|
+
#
|
2993
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
2994
|
+
#
|
2995
|
+
# @option params [Integer] :max_results
|
2996
|
+
# This parameter sets the maximum number of items to be returned.
|
2997
|
+
#
|
2998
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
2999
|
+
#
|
3000
|
+
# @option params [String] :next_token
|
3001
|
+
# The next item following a partial list of returned resources. For
|
3002
|
+
# example, if a request is made to return `maxResults` number of
|
3003
|
+
# resources, `NextToken` allows you to return more items in your list
|
3004
|
+
# starting at the location pointed to by the next token.
|
3005
|
+
#
|
3006
|
+
# @return [Types::ListCopyJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3007
|
+
#
|
3008
|
+
# * {Types::ListCopyJobSummariesOutput#copy_job_summaries #copy_job_summaries} => Array<Types::CopyJobSummary>
|
3009
|
+
# * {Types::ListCopyJobSummariesOutput#aggregation_period #aggregation_period} => String
|
3010
|
+
# * {Types::ListCopyJobSummariesOutput#next_token #next_token} => String
|
3011
|
+
#
|
3012
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3013
|
+
#
|
3014
|
+
# @example Request syntax with placeholder values
|
3015
|
+
#
|
3016
|
+
# resp = client.list_copy_job_summaries({
|
3017
|
+
# account_id: "AccountId",
|
3018
|
+
# state: "CREATED", # accepts CREATED, RUNNING, ABORTING, ABORTED, COMPLETING, COMPLETED, FAILING, FAILED, PARTIAL, AGGREGATE_ALL, ANY
|
3019
|
+
# resource_type: "ResourceType",
|
3020
|
+
# message_category: "MessageCategory",
|
3021
|
+
# aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
|
3022
|
+
# max_results: 1,
|
3023
|
+
# next_token: "string",
|
3024
|
+
# })
|
3025
|
+
#
|
3026
|
+
# @example Response structure
|
3027
|
+
#
|
3028
|
+
# resp.copy_job_summaries #=> Array
|
3029
|
+
# resp.copy_job_summaries[0].region #=> String
|
3030
|
+
# resp.copy_job_summaries[0].account_id #=> String
|
3031
|
+
# resp.copy_job_summaries[0].state #=> String, one of "CREATED", "RUNNING", "ABORTING", "ABORTED", "COMPLETING", "COMPLETED", "FAILING", "FAILED", "PARTIAL", "AGGREGATE_ALL", "ANY"
|
3032
|
+
# resp.copy_job_summaries[0].resource_type #=> String
|
3033
|
+
# resp.copy_job_summaries[0].message_category #=> String
|
3034
|
+
# resp.copy_job_summaries[0].count #=> Integer
|
3035
|
+
# resp.copy_job_summaries[0].start_time #=> Time
|
3036
|
+
# resp.copy_job_summaries[0].end_time #=> Time
|
3037
|
+
# resp.aggregation_period #=> String
|
3038
|
+
# resp.next_token #=> String
|
3039
|
+
#
|
3040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobSummaries AWS API Documentation
|
3041
|
+
#
|
3042
|
+
# @overload list_copy_job_summaries(params = {})
|
3043
|
+
# @param [Hash] params ({})
|
3044
|
+
def list_copy_job_summaries(params = {}, options = {})
|
3045
|
+
req = build_request(:list_copy_job_summaries, params)
|
3046
|
+
req.send_request(options)
|
3047
|
+
end
|
3048
|
+
|
2781
3049
|
# Returns metadata about your copy jobs.
|
2782
3050
|
#
|
2783
3051
|
# @option params [String] :next_token
|
@@ -2849,6 +3117,23 @@ module Aws::Backup
|
|
2849
3117
|
# @option params [String] :by_parent_job_id
|
2850
3118
|
# This is a filter to list child (nested) jobs based on parent job ID.
|
2851
3119
|
#
|
3120
|
+
# @option params [String] :by_message_category
|
3121
|
+
# This parameter returns the job count for the specified message
|
3122
|
+
# category.
|
3123
|
+
#
|
3124
|
+
# Example accepted strings include `AccessDenied`, `Success`, and
|
3125
|
+
# `InvalidParameters`. See [Monitoring][1] for a list of accepted
|
3126
|
+
# MessageCategory strings.
|
3127
|
+
#
|
3128
|
+
# The the value ANY returns count of all message categories.
|
3129
|
+
#
|
3130
|
+
# `AGGREGATE_ALL` aggregates job counts for all message categories and
|
3131
|
+
# returns the sum.
|
3132
|
+
#
|
3133
|
+
#
|
3134
|
+
#
|
3135
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
3136
|
+
#
|
2852
3137
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2853
3138
|
#
|
2854
3139
|
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
@@ -2871,6 +3156,7 @@ module Aws::Backup
|
|
2871
3156
|
# by_complete_before: Time.now,
|
2872
3157
|
# by_complete_after: Time.now,
|
2873
3158
|
# by_parent_job_id: "string",
|
3159
|
+
# by_message_category: "string",
|
2874
3160
|
# })
|
2875
3161
|
#
|
2876
3162
|
# @example Response structure
|
@@ -2901,6 +3187,7 @@ module Aws::Backup
|
|
2901
3187
|
# resp.copy_jobs[0].child_jobs_in_state #=> Hash
|
2902
3188
|
# resp.copy_jobs[0].child_jobs_in_state["CopyJobState"] #=> Integer
|
2903
3189
|
# resp.copy_jobs[0].resource_name #=> String
|
3190
|
+
# resp.copy_jobs[0].message_category #=> String
|
2904
3191
|
# resp.next_token #=> String
|
2905
3192
|
#
|
2906
3193
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs AWS API Documentation
|
@@ -3461,6 +3748,114 @@ module Aws::Backup
|
|
3461
3748
|
req.send_request(options)
|
3462
3749
|
end
|
3463
3750
|
|
3751
|
+
# This request obtains a summary of restore jobs created or running
|
3752
|
+
# within the the most recent 30 days. You can include parameters
|
3753
|
+
# AccountID, State, ResourceType, AggregationPeriod, MaxResults, or
|
3754
|
+
# NextToken to filter results.
|
3755
|
+
#
|
3756
|
+
# This request returns a summary that contains Region, Account, State,
|
3757
|
+
# RestourceType, MessageCategory, StartTime, EndTime, and Count of
|
3758
|
+
# included jobs.
|
3759
|
+
#
|
3760
|
+
# @option params [String] :account_id
|
3761
|
+
# Returns the job count for the specified account.
|
3762
|
+
#
|
3763
|
+
# If the request is sent from a member account or an account not part of
|
3764
|
+
# Amazon Web Services Organizations, jobs within requestor's account
|
3765
|
+
# will be returned.
|
3766
|
+
#
|
3767
|
+
# Root, admin, and delegated administrator accounts can use the value
|
3768
|
+
# ANY to return job counts from every account in the organization.
|
3769
|
+
#
|
3770
|
+
# `AGGREGATE_ALL` aggregates job counts from all accounts within the
|
3771
|
+
# authenticated organization, then returns the sum.
|
3772
|
+
#
|
3773
|
+
# @option params [String] :state
|
3774
|
+
# This parameter returns the job count for jobs with the specified
|
3775
|
+
# state.
|
3776
|
+
#
|
3777
|
+
# The the value ANY returns count of all states.
|
3778
|
+
#
|
3779
|
+
# `AGGREGATE_ALL` aggregates job counts for all states and returns the
|
3780
|
+
# sum.
|
3781
|
+
#
|
3782
|
+
# @option params [String] :resource_type
|
3783
|
+
# Returns the job count for the specified resource type. Use request
|
3784
|
+
# `GetSupportedResourceTypes` to obtain strings for supported resource
|
3785
|
+
# types.
|
3786
|
+
#
|
3787
|
+
# The the value ANY returns count of all resource types.
|
3788
|
+
#
|
3789
|
+
# `AGGREGATE_ALL` aggregates job counts for all resource types and
|
3790
|
+
# returns the sum.
|
3791
|
+
#
|
3792
|
+
# The type of Amazon Web Services resource to be backed up; for example,
|
3793
|
+
# an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
3794
|
+
# Relational Database Service (Amazon RDS) database.
|
3795
|
+
#
|
3796
|
+
# @option params [String] :aggregation_period
|
3797
|
+
# This is the period that sets the boundaries for returned results.
|
3798
|
+
#
|
3799
|
+
# Acceptable values include
|
3800
|
+
#
|
3801
|
+
# * `ONE_DAY` for daily job count for the prior 14 days.
|
3802
|
+
#
|
3803
|
+
# * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
|
3804
|
+
#
|
3805
|
+
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
3806
|
+
#
|
3807
|
+
# @option params [Integer] :max_results
|
3808
|
+
# This parameter sets the maximum number of items to be returned.
|
3809
|
+
#
|
3810
|
+
# The value is an integer. Range of accepted values is from 1 to 500.
|
3811
|
+
#
|
3812
|
+
# @option params [String] :next_token
|
3813
|
+
# The next item following a partial list of returned resources. For
|
3814
|
+
# example, if a request is made to return `maxResults` number of
|
3815
|
+
# resources, `NextToken` allows you to return more items in your list
|
3816
|
+
# starting at the location pointed to by the next token.
|
3817
|
+
#
|
3818
|
+
# @return [Types::ListRestoreJobSummariesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3819
|
+
#
|
3820
|
+
# * {Types::ListRestoreJobSummariesOutput#restore_job_summaries #restore_job_summaries} => Array<Types::RestoreJobSummary>
|
3821
|
+
# * {Types::ListRestoreJobSummariesOutput#aggregation_period #aggregation_period} => String
|
3822
|
+
# * {Types::ListRestoreJobSummariesOutput#next_token #next_token} => String
|
3823
|
+
#
|
3824
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3825
|
+
#
|
3826
|
+
# @example Request syntax with placeholder values
|
3827
|
+
#
|
3828
|
+
# resp = client.list_restore_job_summaries({
|
3829
|
+
# account_id: "AccountId",
|
3830
|
+
# state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTED, COMPLETED, FAILED, AGGREGATE_ALL, ANY
|
3831
|
+
# resource_type: "ResourceType",
|
3832
|
+
# aggregation_period: "ONE_DAY", # accepts ONE_DAY, SEVEN_DAYS, FOURTEEN_DAYS
|
3833
|
+
# max_results: 1,
|
3834
|
+
# next_token: "string",
|
3835
|
+
# })
|
3836
|
+
#
|
3837
|
+
# @example Response structure
|
3838
|
+
#
|
3839
|
+
# resp.restore_job_summaries #=> Array
|
3840
|
+
# resp.restore_job_summaries[0].region #=> String
|
3841
|
+
# resp.restore_job_summaries[0].account_id #=> String
|
3842
|
+
# resp.restore_job_summaries[0].state #=> String, one of "CREATED", "PENDING", "RUNNING", "ABORTED", "COMPLETED", "FAILED", "AGGREGATE_ALL", "ANY"
|
3843
|
+
# resp.restore_job_summaries[0].resource_type #=> String
|
3844
|
+
# resp.restore_job_summaries[0].count #=> Integer
|
3845
|
+
# resp.restore_job_summaries[0].start_time #=> Time
|
3846
|
+
# resp.restore_job_summaries[0].end_time #=> Time
|
3847
|
+
# resp.aggregation_period #=> String
|
3848
|
+
# resp.next_token #=> String
|
3849
|
+
#
|
3850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobSummaries AWS API Documentation
|
3851
|
+
#
|
3852
|
+
# @overload list_restore_job_summaries(params = {})
|
3853
|
+
# @param [Hash] params ({})
|
3854
|
+
def list_restore_job_summaries(params = {}, options = {})
|
3855
|
+
req = build_request(:list_restore_job_summaries, params)
|
3856
|
+
req.send_request(options)
|
3857
|
+
end
|
3858
|
+
|
3464
3859
|
# Returns a list of jobs that Backup initiated to restore a saved
|
3465
3860
|
# resource, including details about the recovery process.
|
3466
3861
|
#
|
@@ -4661,7 +5056,7 @@ module Aws::Backup
|
|
4661
5056
|
params: params,
|
4662
5057
|
config: config)
|
4663
5058
|
context[:gem_name] = 'aws-sdk-backup'
|
4664
|
-
context[:gem_version] = '1.
|
5059
|
+
context[:gem_version] = '1.60.0'
|
4665
5060
|
Seahorse::Client::Request.new(handlers, context)
|
4666
5061
|
end
|
4667
5062
|
|