aws-sdk-backup 1.13.0 → 1.18.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-backup.rb +3 -1
- data/lib/aws-sdk-backup/client.rb +126 -17
- data/lib/aws-sdk-backup/client_api.rb +52 -1
- data/lib/aws-sdk-backup/errors.rb +2 -0
- data/lib/aws-sdk-backup/resource.rb +2 -0
- data/lib/aws-sdk-backup/types.rb +305 -64
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5f9fba0576ad1b2d98d4a204fbe89644842a72907bb431851aa136cf8a9ba83d
|
4
|
+
data.tar.gz: 3a1bdf4222f008c765b1b14bf96d597df63f551a7e20ed6efc04a788a4bbbe2a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e75c7df74bf4247f950cb273a810d6662f99fa2f3c66d83f5f22aae50eda855fe58b69d672529a86affcf091924e0fdf9aa329e3942e0279f75cf8340fe76920
|
7
|
+
data.tar.gz: 5aacac9b9dcd055f5c20174fbf6a15790c7758ecf5e4a20a737b1ec23a7be9b83f15399abc8f50bfb0a81f71d6692fef623a544be7a29b5456cd5810539ffb15
|
data/lib/aws-sdk-backup.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-backup/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::Backup
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.18.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
32
|
|
@@ -69,6 +72,7 @@ module Aws::Backup
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
74
78
|
|
@@ -161,7 +165,7 @@ module Aws::Backup
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::Backup
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -603,7 +607,7 @@ module Aws::Backup
|
|
603
607
|
# @option params [required, String] :backup_vault_name
|
604
608
|
# The name of a logical container where backups are stored. Backup
|
605
609
|
# vaults are identified by names that are unique to the account used to
|
606
|
-
# create them and
|
610
|
+
# create them and the AWS Region where they are created. They consist of
|
607
611
|
# lowercase letters, numbers, and hyphens.
|
608
612
|
#
|
609
613
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -712,6 +716,7 @@ module Aws::Backup
|
|
712
716
|
#
|
713
717
|
# @return [Types::DescribeBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
714
718
|
#
|
719
|
+
# * {Types::DescribeBackupJobOutput#account_id #account_id} => String
|
715
720
|
# * {Types::DescribeBackupJobOutput#backup_job_id #backup_job_id} => String
|
716
721
|
# * {Types::DescribeBackupJobOutput#backup_vault_name #backup_vault_name} => String
|
717
722
|
# * {Types::DescribeBackupJobOutput#backup_vault_arn #backup_vault_arn} => String
|
@@ -738,6 +743,7 @@ module Aws::Backup
|
|
738
743
|
#
|
739
744
|
# @example Response structure
|
740
745
|
#
|
746
|
+
# resp.account_id #=> String
|
741
747
|
# resp.backup_job_id #=> String
|
742
748
|
# resp.backup_vault_name #=> String
|
743
749
|
# resp.backup_vault_arn #=> String
|
@@ -812,7 +818,7 @@ module Aws::Backup
|
|
812
818
|
# Returns metadata associated with creating a copy of a resource.
|
813
819
|
#
|
814
820
|
# @option params [required, String] :copy_job_id
|
815
|
-
# Uniquely identifies a
|
821
|
+
# Uniquely identifies a copy job.
|
816
822
|
#
|
817
823
|
# @return [Types::DescribeCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
824
|
#
|
@@ -826,6 +832,7 @@ module Aws::Backup
|
|
826
832
|
#
|
827
833
|
# @example Response structure
|
828
834
|
#
|
835
|
+
# resp.copy_job.account_id #=> String
|
829
836
|
# resp.copy_job.copy_job_id #=> String
|
830
837
|
# resp.copy_job.source_backup_vault_arn #=> String
|
831
838
|
# resp.copy_job.source_recovery_point_arn #=> String
|
@@ -854,7 +861,7 @@ module Aws::Backup
|
|
854
861
|
end
|
855
862
|
|
856
863
|
# Returns information about a saved resource, including the last time it
|
857
|
-
# was backed
|
864
|
+
# was backed up, its Amazon Resource Name (ARN), and the AWS service
|
858
865
|
# type of the saved resource.
|
859
866
|
#
|
860
867
|
# @option params [required, String] :resource_arn
|
@@ -963,6 +970,31 @@ module Aws::Backup
|
|
963
970
|
req.send_request(options)
|
964
971
|
end
|
965
972
|
|
973
|
+
# Returns the current service opt-in settings for the Region. If the
|
974
|
+
# service has a value set to `true`, AWS Backup attempts to protect that
|
975
|
+
# service's resources in this Region, when included in an on-demand
|
976
|
+
# backup or scheduled backup plan. If the value is set to `false` for a
|
977
|
+
# service, AWS Backup does not attempt to protect that service's
|
978
|
+
# resources in this Region.
|
979
|
+
#
|
980
|
+
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
981
|
+
#
|
982
|
+
# * {Types::DescribeRegionSettingsOutput#resource_type_opt_in_preference #resource_type_opt_in_preference} => Hash<String,Boolean>
|
983
|
+
#
|
984
|
+
# @example Response structure
|
985
|
+
#
|
986
|
+
# resp.resource_type_opt_in_preference #=> Hash
|
987
|
+
# resp.resource_type_opt_in_preference["ResourceType"] #=> Boolean
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings AWS API Documentation
|
990
|
+
#
|
991
|
+
# @overload describe_region_settings(params = {})
|
992
|
+
# @param [Hash] params ({})
|
993
|
+
def describe_region_settings(params = {}, options = {})
|
994
|
+
req = build_request(:describe_region_settings, params)
|
995
|
+
req.send_request(options)
|
996
|
+
end
|
997
|
+
|
966
998
|
# Returns metadata associated with a restore job that is specified by a
|
967
999
|
# job ID.
|
968
1000
|
#
|
@@ -971,6 +1003,7 @@ module Aws::Backup
|
|
971
1003
|
#
|
972
1004
|
# @return [Types::DescribeRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
973
1005
|
#
|
1006
|
+
# * {Types::DescribeRestoreJobOutput#account_id #account_id} => String
|
974
1007
|
# * {Types::DescribeRestoreJobOutput#restore_job_id #restore_job_id} => String
|
975
1008
|
# * {Types::DescribeRestoreJobOutput#recovery_point_arn #recovery_point_arn} => String
|
976
1009
|
# * {Types::DescribeRestoreJobOutput#creation_date #creation_date} => Time
|
@@ -982,6 +1015,7 @@ module Aws::Backup
|
|
982
1015
|
# * {Types::DescribeRestoreJobOutput#iam_role_arn #iam_role_arn} => String
|
983
1016
|
# * {Types::DescribeRestoreJobOutput#expected_completion_time_minutes #expected_completion_time_minutes} => Integer
|
984
1017
|
# * {Types::DescribeRestoreJobOutput#created_resource_arn #created_resource_arn} => String
|
1018
|
+
# * {Types::DescribeRestoreJobOutput#resource_type #resource_type} => String
|
985
1019
|
#
|
986
1020
|
# @example Request syntax with placeholder values
|
987
1021
|
#
|
@@ -991,6 +1025,7 @@ module Aws::Backup
|
|
991
1025
|
#
|
992
1026
|
# @example Response structure
|
993
1027
|
#
|
1028
|
+
# resp.account_id #=> String
|
994
1029
|
# resp.restore_job_id #=> String
|
995
1030
|
# resp.recovery_point_arn #=> String
|
996
1031
|
# resp.creation_date #=> Time
|
@@ -1002,6 +1037,7 @@ module Aws::Backup
|
|
1002
1037
|
# resp.iam_role_arn #=> String
|
1003
1038
|
# resp.expected_completion_time_minutes #=> Integer
|
1004
1039
|
# resp.created_resource_arn #=> String
|
1040
|
+
# resp.resource_type #=> String
|
1005
1041
|
#
|
1006
1042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob AWS API Documentation
|
1007
1043
|
#
|
@@ -1413,12 +1449,18 @@ module Aws::Backup
|
|
1413
1449
|
#
|
1414
1450
|
# * `EBS` for Amazon Elastic Block Store
|
1415
1451
|
#
|
1452
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
1453
|
+
#
|
1416
1454
|
# * `EFS` for Amazon Elastic File System
|
1417
1455
|
#
|
1418
1456
|
# * `RDS` for Amazon Relational Database Service
|
1419
1457
|
#
|
1420
1458
|
# * `Storage Gateway` for AWS Storage Gateway
|
1421
1459
|
#
|
1460
|
+
# @option params [String] :by_account_id
|
1461
|
+
# The account ID to list the jobs from. Returns only backup jobs
|
1462
|
+
# associated with the specified account ID.
|
1463
|
+
#
|
1422
1464
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1423
1465
|
#
|
1424
1466
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
@@ -1437,11 +1479,13 @@ module Aws::Backup
|
|
1437
1479
|
# by_created_before: Time.now,
|
1438
1480
|
# by_created_after: Time.now,
|
1439
1481
|
# by_resource_type: "ResourceType",
|
1482
|
+
# by_account_id: "AccountId",
|
1440
1483
|
# })
|
1441
1484
|
#
|
1442
1485
|
# @example Response structure
|
1443
1486
|
#
|
1444
1487
|
# resp.backup_jobs #=> Array
|
1488
|
+
# resp.backup_jobs[0].account_id #=> String
|
1445
1489
|
# resp.backup_jobs[0].backup_job_id #=> String
|
1446
1490
|
# resp.backup_jobs[0].backup_vault_name #=> String
|
1447
1491
|
# resp.backup_jobs[0].backup_vault_arn #=> String
|
@@ -1749,6 +1793,8 @@ module Aws::Backup
|
|
1749
1793
|
#
|
1750
1794
|
# * `EBS` for Amazon Elastic Block Store
|
1751
1795
|
#
|
1796
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
1797
|
+
#
|
1752
1798
|
# * `EFS` for Amazon Elastic File System
|
1753
1799
|
#
|
1754
1800
|
# * `RDS` for Amazon Relational Database Service
|
@@ -1758,7 +1804,11 @@ module Aws::Backup
|
|
1758
1804
|
# @option params [String] :by_destination_vault_arn
|
1759
1805
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
1760
1806
|
# vault to copy from; for example,
|
1761
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
1807
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1808
|
+
#
|
1809
|
+
# @option params [String] :by_account_id
|
1810
|
+
# The account ID to list the jobs from. Returns only copy jobs
|
1811
|
+
# associated with the specified account ID.
|
1762
1812
|
#
|
1763
1813
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1764
1814
|
#
|
@@ -1778,11 +1828,13 @@ module Aws::Backup
|
|
1778
1828
|
# by_created_after: Time.now,
|
1779
1829
|
# by_resource_type: "ResourceType",
|
1780
1830
|
# by_destination_vault_arn: "string",
|
1831
|
+
# by_account_id: "AccountId",
|
1781
1832
|
# })
|
1782
1833
|
#
|
1783
1834
|
# @example Response structure
|
1784
1835
|
#
|
1785
1836
|
# resp.copy_jobs #=> Array
|
1837
|
+
# resp.copy_jobs[0].account_id #=> String
|
1786
1838
|
# resp.copy_jobs[0].copy_job_id #=> String
|
1787
1839
|
# resp.copy_jobs[0].source_backup_vault_arn #=> String
|
1788
1840
|
# resp.copy_jobs[0].source_recovery_point_arn #=> String
|
@@ -2009,6 +2061,19 @@ module Aws::Backup
|
|
2009
2061
|
# @option params [Integer] :max_results
|
2010
2062
|
# The maximum number of items to be returned.
|
2011
2063
|
#
|
2064
|
+
# @option params [String] :by_account_id
|
2065
|
+
# The account ID to list the jobs from. Returns only restore jobs
|
2066
|
+
# associated with the specified account ID.
|
2067
|
+
#
|
2068
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
2069
|
+
# Returns only restore jobs that were created before the specified date.
|
2070
|
+
#
|
2071
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_after
|
2072
|
+
# Returns only restore jobs that were created after the specified date.
|
2073
|
+
#
|
2074
|
+
# @option params [String] :by_status
|
2075
|
+
# Returns only restore jobs associated with the specified job status.
|
2076
|
+
#
|
2012
2077
|
# @return [Types::ListRestoreJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2013
2078
|
#
|
2014
2079
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
@@ -2021,11 +2086,16 @@ module Aws::Backup
|
|
2021
2086
|
# resp = client.list_restore_jobs({
|
2022
2087
|
# next_token: "string",
|
2023
2088
|
# max_results: 1,
|
2089
|
+
# by_account_id: "AccountId",
|
2090
|
+
# by_created_before: Time.now,
|
2091
|
+
# by_created_after: Time.now,
|
2092
|
+
# by_status: "PENDING", # accepts PENDING, RUNNING, COMPLETED, ABORTED, FAILED
|
2024
2093
|
# })
|
2025
2094
|
#
|
2026
2095
|
# @example Response structure
|
2027
2096
|
#
|
2028
2097
|
# resp.restore_jobs #=> Array
|
2098
|
+
# resp.restore_jobs[0].account_id #=> String
|
2029
2099
|
# resp.restore_jobs[0].restore_job_id #=> String
|
2030
2100
|
# resp.restore_jobs[0].recovery_point_arn #=> String
|
2031
2101
|
# resp.restore_jobs[0].creation_date #=> Time
|
@@ -2037,6 +2107,7 @@ module Aws::Backup
|
|
2037
2107
|
# resp.restore_jobs[0].iam_role_arn #=> String
|
2038
2108
|
# resp.restore_jobs[0].expected_completion_time_minutes #=> Integer
|
2039
2109
|
# resp.restore_jobs[0].created_resource_arn #=> String
|
2110
|
+
# resp.restore_jobs[0].resource_type #=> String
|
2040
2111
|
# resp.next_token #=> String
|
2041
2112
|
#
|
2042
2113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobs AWS API Documentation
|
@@ -2051,6 +2122,10 @@ module Aws::Backup
|
|
2051
2122
|
# Returns a list of key-value pairs assigned to a target recovery point,
|
2052
2123
|
# backup plan, or backup vault.
|
2053
2124
|
#
|
2125
|
+
# <note markdown="1"> `ListTags` are currently only supported with Amazon EFS backups.
|
2126
|
+
#
|
2127
|
+
# </note>
|
2128
|
+
#
|
2054
2129
|
# @option params [required, String] :resource_arn
|
2055
2130
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
2056
2131
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -2184,11 +2259,13 @@ module Aws::Backup
|
|
2184
2259
|
# to `StartBackupJob`.
|
2185
2260
|
#
|
2186
2261
|
# @option params [Integer] :start_window_minutes
|
2187
|
-
#
|
2262
|
+
# A value in minutes after a backup is scheduled before a job will be
|
2263
|
+
# canceled if it doesn't start successfully. This value is optional.
|
2188
2264
|
#
|
2189
2265
|
# @option params [Integer] :complete_window_minutes
|
2190
|
-
#
|
2191
|
-
#
|
2266
|
+
# A value in minutes after a backup job is successfully started before
|
2267
|
+
# it must be completed or it will be canceled by AWS Backup. This value
|
2268
|
+
# is optional.
|
2192
2269
|
#
|
2193
2270
|
# @option params [Types::Lifecycle] :lifecycle
|
2194
2271
|
# The lifecycle defines when a protected resource is transitioned to
|
@@ -2256,7 +2333,7 @@ module Aws::Backup
|
|
2256
2333
|
# The name of a logical source container where backups are stored.
|
2257
2334
|
# Backup vaults are identified by names that are unique to the account
|
2258
2335
|
# used to create them and the AWS Region where they are created. They
|
2259
|
-
# consist of lowercase letters, numbers, and hyphens.
|
2336
|
+
# consist of lowercase letters, numbers, and hyphens.
|
2260
2337
|
#
|
2261
2338
|
# @option params [required, String] :destination_backup_vault_arn
|
2262
2339
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
@@ -2265,7 +2342,7 @@ module Aws::Backup
|
|
2265
2342
|
#
|
2266
2343
|
# @option params [required, String] :iam_role_arn
|
2267
2344
|
# Specifies the IAM role ARN used to copy the target recovery point; for
|
2268
|
-
# example, arn:aws:iam::123456789012:role/S3Access
|
2345
|
+
# example, `arn:aws:iam::123456789012:role/S3Access`.
|
2269
2346
|
#
|
2270
2347
|
# @option params [String] :idempotency_token
|
2271
2348
|
# A customer chosen string that can be used to distinguish between calls
|
@@ -2330,7 +2407,7 @@ module Aws::Backup
|
|
2330
2407
|
# resource name, required to restore a recovery point.
|
2331
2408
|
#
|
2332
2409
|
# You can get configuration metadata about a resource at the time it was
|
2333
|
-
# backed
|
2410
|
+
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
2334
2411
|
# values in addition to those provided by
|
2335
2412
|
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
2336
2413
|
# resource. For example, you might need to provide a new resource name
|
@@ -2371,15 +2448,17 @@ module Aws::Backup
|
|
2371
2448
|
# Starts a job to restore a recovery point for one of the following
|
2372
2449
|
# resources:
|
2373
2450
|
#
|
2451
|
+
# * `DynamoDB` for Amazon DynamoDB
|
2452
|
+
#
|
2374
2453
|
# * `EBS` for Amazon Elastic Block Store
|
2375
2454
|
#
|
2376
|
-
# * `
|
2455
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
2377
2456
|
#
|
2378
|
-
# * `
|
2457
|
+
# * `EFS` for Amazon Elastic File System
|
2379
2458
|
#
|
2380
|
-
# * `
|
2459
|
+
# * `RDS` for Amazon Relational Database Service
|
2381
2460
|
#
|
2382
|
-
# * `
|
2461
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
2383
2462
|
#
|
2384
2463
|
# @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2385
2464
|
#
|
@@ -2630,6 +2709,36 @@ module Aws::Backup
|
|
2630
2709
|
req.send_request(options)
|
2631
2710
|
end
|
2632
2711
|
|
2712
|
+
# Updates the current service opt-in settings for the Region. If the
|
2713
|
+
# service has a value set to `true`, AWS Backup attempts to protect that
|
2714
|
+
# service's resources in this Region, when included in an on-demand
|
2715
|
+
# backup or scheduled backup plan. If the value is set to `false` for a
|
2716
|
+
# service, AWS Backup does not attempt to protect that service's
|
2717
|
+
# resources in this Region.
|
2718
|
+
#
|
2719
|
+
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2720
|
+
# Updates the list of services along with the opt-in preferences for the
|
2721
|
+
# region.
|
2722
|
+
#
|
2723
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2724
|
+
#
|
2725
|
+
# @example Request syntax with placeholder values
|
2726
|
+
#
|
2727
|
+
# resp = client.update_region_settings({
|
2728
|
+
# resource_type_opt_in_preference: {
|
2729
|
+
# "ResourceType" => false,
|
2730
|
+
# },
|
2731
|
+
# })
|
2732
|
+
#
|
2733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings AWS API Documentation
|
2734
|
+
#
|
2735
|
+
# @overload update_region_settings(params = {})
|
2736
|
+
# @param [Hash] params ({})
|
2737
|
+
def update_region_settings(params = {}, options = {})
|
2738
|
+
req = build_request(:update_region_settings, params)
|
2739
|
+
req.send_request(options)
|
2740
|
+
end
|
2741
|
+
|
2633
2742
|
# @!endgroup
|
2634
2743
|
|
2635
2744
|
# @param params ({})
|
@@ -2643,7 +2752,7 @@ module Aws::Backup
|
|
2643
2752
|
params: params,
|
2644
2753
|
config: config)
|
2645
2754
|
context[:gem_name] = 'aws-sdk-backup'
|
2646
|
-
context[:gem_version] = '1.
|
2755
|
+
context[:gem_version] = '1.18.0'
|
2647
2756
|
Seahorse::Client::Request.new(handlers, context)
|
2648
2757
|
end
|
2649
2758
|
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -12,6 +14,7 @@ module Aws::Backup
|
|
12
14
|
include Seahorse::Model
|
13
15
|
|
14
16
|
ARN = Shapes::StringShape.new(name: 'ARN')
|
17
|
+
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
15
18
|
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
|
16
19
|
BackupJob = Shapes::StructureShape.new(name: 'BackupJob')
|
17
20
|
BackupJobState = Shapes::StringShape.new(name: 'BackupJobState')
|
@@ -74,6 +77,8 @@ module Aws::Backup
|
|
74
77
|
DescribeProtectedResourceOutput = Shapes::StructureShape.new(name: 'DescribeProtectedResourceOutput')
|
75
78
|
DescribeRecoveryPointInput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointInput')
|
76
79
|
DescribeRecoveryPointOutput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointOutput')
|
80
|
+
DescribeRegionSettingsInput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsInput')
|
81
|
+
DescribeRegionSettingsOutput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsOutput')
|
77
82
|
DescribeRestoreJobInput = Shapes::StructureShape.new(name: 'DescribeRestoreJobInput')
|
78
83
|
DescribeRestoreJobOutput = Shapes::StructureShape.new(name: 'DescribeRestoreJobOutput')
|
79
84
|
ExportBackupPlanTemplateInput = Shapes::StructureShape.new(name: 'ExportBackupPlanTemplateInput')
|
@@ -97,6 +102,7 @@ module Aws::Backup
|
|
97
102
|
IAMRoleArn = Shapes::StringShape.new(name: 'IAMRoleArn')
|
98
103
|
InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
|
99
104
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
105
|
+
IsEnabled = Shapes::BooleanShape.new(name: 'IsEnabled')
|
100
106
|
Lifecycle = Shapes::StructureShape.new(name: 'Lifecycle')
|
101
107
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
102
108
|
ListBackupJobsInput = Shapes::StructureShape.new(name: 'ListBackupJobsInput')
|
@@ -143,6 +149,7 @@ module Aws::Backup
|
|
143
149
|
ResourceArns = Shapes::ListShape.new(name: 'ResourceArns')
|
144
150
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
145
151
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
152
|
+
ResourceTypeOptInPreference = Shapes::MapShape.new(name: 'ResourceTypeOptInPreference')
|
146
153
|
ResourceTypes = Shapes::ListShape.new(name: 'ResourceTypes')
|
147
154
|
RestoreJobId = Shapes::StringShape.new(name: 'RestoreJobId')
|
148
155
|
RestoreJobStatus = Shapes::StringShape.new(name: 'RestoreJobStatus')
|
@@ -167,6 +174,7 @@ module Aws::Backup
|
|
167
174
|
UpdateBackupPlanOutput = Shapes::StructureShape.new(name: 'UpdateBackupPlanOutput')
|
168
175
|
UpdateRecoveryPointLifecycleInput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleInput')
|
169
176
|
UpdateRecoveryPointLifecycleOutput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleOutput')
|
177
|
+
UpdateRegionSettingsInput = Shapes::StructureShape.new(name: 'UpdateRegionSettingsInput')
|
170
178
|
WindowMinutes = Shapes::IntegerShape.new(name: 'WindowMinutes')
|
171
179
|
boolean = Shapes::BooleanShape.new(name: 'boolean')
|
172
180
|
long = Shapes::IntegerShape.new(name: 'long')
|
@@ -181,6 +189,7 @@ module Aws::Backup
|
|
181
189
|
AlreadyExistsException.add_member(:context, Shapes::ShapeRef.new(shape: string, location_name: "Context"))
|
182
190
|
AlreadyExistsException.struct_class = Types::AlreadyExistsException
|
183
191
|
|
192
|
+
BackupJob.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
184
193
|
BackupJob.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
185
194
|
BackupJob.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
186
195
|
BackupJob.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
@@ -298,6 +307,7 @@ module Aws::Backup
|
|
298
307
|
|
299
308
|
CopyActions.member = Shapes::ShapeRef.new(shape: CopyAction)
|
300
309
|
|
310
|
+
CopyJob.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
301
311
|
CopyJob.add_member(:copy_job_id, Shapes::ShapeRef.new(shape: string, location_name: "CopyJobId"))
|
302
312
|
CopyJob.add_member(:source_backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceBackupVaultArn"))
|
303
313
|
CopyJob.add_member(:source_recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "SourceRecoveryPointArn"))
|
@@ -383,6 +393,7 @@ module Aws::Backup
|
|
383
393
|
DescribeBackupJobInput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupJobId"))
|
384
394
|
DescribeBackupJobInput.struct_class = Types::DescribeBackupJobInput
|
385
395
|
|
396
|
+
DescribeBackupJobOutput.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
386
397
|
DescribeBackupJobOutput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
387
398
|
DescribeBackupJobOutput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, location_name: "BackupVaultName"))
|
388
399
|
DescribeBackupJobOutput.add_member(:backup_vault_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupVaultArn"))
|
@@ -450,9 +461,15 @@ module Aws::Backup
|
|
450
461
|
DescribeRecoveryPointOutput.add_member(:last_restore_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastRestoreTime"))
|
451
462
|
DescribeRecoveryPointOutput.struct_class = Types::DescribeRecoveryPointOutput
|
452
463
|
|
464
|
+
DescribeRegionSettingsInput.struct_class = Types::DescribeRegionSettingsInput
|
465
|
+
|
466
|
+
DescribeRegionSettingsOutput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
467
|
+
DescribeRegionSettingsOutput.struct_class = Types::DescribeRegionSettingsOutput
|
468
|
+
|
453
469
|
DescribeRestoreJobInput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: RestoreJobId, required: true, location: "uri", location_name: "restoreJobId"))
|
454
470
|
DescribeRestoreJobInput.struct_class = Types::DescribeRestoreJobInput
|
455
471
|
|
472
|
+
DescribeRestoreJobOutput.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
456
473
|
DescribeRestoreJobOutput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: string, location_name: "RestoreJobId"))
|
457
474
|
DescribeRestoreJobOutput.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
458
475
|
DescribeRestoreJobOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
@@ -464,6 +481,7 @@ module Aws::Backup
|
|
464
481
|
DescribeRestoreJobOutput.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, location_name: "IamRoleArn"))
|
465
482
|
DescribeRestoreJobOutput.add_member(:expected_completion_time_minutes, Shapes::ShapeRef.new(shape: Long, location_name: "ExpectedCompletionTimeMinutes"))
|
466
483
|
DescribeRestoreJobOutput.add_member(:created_resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "CreatedResourceArn"))
|
484
|
+
DescribeRestoreJobOutput.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
467
485
|
DescribeRestoreJobOutput.struct_class = Types::DescribeRestoreJobOutput
|
468
486
|
|
469
487
|
ExportBackupPlanTemplateInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -568,6 +586,7 @@ module Aws::Backup
|
|
568
586
|
ListBackupJobsInput.add_member(:by_created_before, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdBefore"))
|
569
587
|
ListBackupJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
570
588
|
ListBackupJobsInput.add_member(:by_resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
589
|
+
ListBackupJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
571
590
|
ListBackupJobsInput.struct_class = Types::ListBackupJobsInput
|
572
591
|
|
573
592
|
ListBackupJobsOutput.add_member(:backup_jobs, Shapes::ShapeRef.new(shape: BackupJobsList, location_name: "BackupJobs"))
|
@@ -625,6 +644,7 @@ module Aws::Backup
|
|
625
644
|
ListCopyJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
626
645
|
ListCopyJobsInput.add_member(:by_resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
627
646
|
ListCopyJobsInput.add_member(:by_destination_vault_arn, Shapes::ShapeRef.new(shape: string, location: "querystring", location_name: "destinationVaultArn"))
|
647
|
+
ListCopyJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
628
648
|
ListCopyJobsInput.struct_class = Types::ListCopyJobsInput
|
629
649
|
|
630
650
|
ListCopyJobsOutput.add_member(:copy_jobs, Shapes::ShapeRef.new(shape: CopyJobsList, location_name: "CopyJobs"))
|
@@ -666,6 +686,10 @@ module Aws::Backup
|
|
666
686
|
|
667
687
|
ListRestoreJobsInput.add_member(:next_token, Shapes::ShapeRef.new(shape: string, location: "querystring", location_name: "nextToken"))
|
668
688
|
ListRestoreJobsInput.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
689
|
+
ListRestoreJobsInput.add_member(:by_account_id, Shapes::ShapeRef.new(shape: AccountId, location: "querystring", location_name: "accountId"))
|
690
|
+
ListRestoreJobsInput.add_member(:by_created_before, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdBefore"))
|
691
|
+
ListRestoreJobsInput.add_member(:by_created_after, Shapes::ShapeRef.new(shape: timestamp, location: "querystring", location_name: "createdAfter"))
|
692
|
+
ListRestoreJobsInput.add_member(:by_status, Shapes::ShapeRef.new(shape: RestoreJobStatus, location: "querystring", location_name: "status"))
|
669
693
|
ListRestoreJobsInput.struct_class = Types::ListRestoreJobsInput
|
670
694
|
|
671
695
|
ListRestoreJobsOutput.add_member(:restore_jobs, Shapes::ShapeRef.new(shape: RestoreJobsList, location_name: "RestoreJobs"))
|
@@ -750,10 +774,14 @@ module Aws::Backup
|
|
750
774
|
ResourceNotFoundException.add_member(:context, Shapes::ShapeRef.new(shape: string, location_name: "Context"))
|
751
775
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
752
776
|
|
777
|
+
ResourceTypeOptInPreference.key = Shapes::ShapeRef.new(shape: ResourceType)
|
778
|
+
ResourceTypeOptInPreference.value = Shapes::ShapeRef.new(shape: IsEnabled)
|
779
|
+
|
753
780
|
ResourceTypes.member = Shapes::ShapeRef.new(shape: ResourceType)
|
754
781
|
|
755
782
|
RestoreJobsList.member = Shapes::ShapeRef.new(shape: RestoreJobsListMember)
|
756
783
|
|
784
|
+
RestoreJobsListMember.add_member(:account_id, Shapes::ShapeRef.new(shape: AccountId, location_name: "AccountId"))
|
757
785
|
RestoreJobsListMember.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: string, location_name: "RestoreJobId"))
|
758
786
|
RestoreJobsListMember.add_member(:recovery_point_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "RecoveryPointArn"))
|
759
787
|
RestoreJobsListMember.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
@@ -765,6 +793,7 @@ module Aws::Backup
|
|
765
793
|
RestoreJobsListMember.add_member(:iam_role_arn, Shapes::ShapeRef.new(shape: IAMRoleArn, location_name: "IamRoleArn"))
|
766
794
|
RestoreJobsListMember.add_member(:expected_completion_time_minutes, Shapes::ShapeRef.new(shape: Long, location_name: "ExpectedCompletionTimeMinutes"))
|
767
795
|
RestoreJobsListMember.add_member(:created_resource_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "CreatedResourceArn"))
|
796
|
+
RestoreJobsListMember.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
768
797
|
RestoreJobsListMember.struct_class = Types::RestoreJobsListMember
|
769
798
|
|
770
799
|
ServiceUnavailableException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
@@ -847,6 +876,9 @@ module Aws::Backup
|
|
847
876
|
UpdateRecoveryPointLifecycleOutput.add_member(:calculated_lifecycle, Shapes::ShapeRef.new(shape: CalculatedLifecycle, location_name: "CalculatedLifecycle"))
|
848
877
|
UpdateRecoveryPointLifecycleOutput.struct_class = Types::UpdateRecoveryPointLifecycleOutput
|
849
878
|
|
879
|
+
UpdateRegionSettingsInput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
880
|
+
UpdateRegionSettingsInput.struct_class = Types::UpdateRegionSettingsInput
|
881
|
+
|
850
882
|
|
851
883
|
# @api private
|
852
884
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -1039,6 +1071,15 @@ module Aws::Backup
|
|
1039
1071
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1040
1072
|
end)
|
1041
1073
|
|
1074
|
+
api.add_operation(:describe_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1075
|
+
o.name = "DescribeRegionSettings"
|
1076
|
+
o.http_method = "GET"
|
1077
|
+
o.http_request_uri = "/account-settings"
|
1078
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeRegionSettingsInput)
|
1079
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeRegionSettingsOutput)
|
1080
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1081
|
+
end)
|
1082
|
+
|
1042
1083
|
api.add_operation(:describe_restore_job, Seahorse::Model::Operation.new.tap do |o|
|
1043
1084
|
o.name = "DescribeRestoreJob"
|
1044
1085
|
o.http_method = "GET"
|
@@ -1165,7 +1206,6 @@ module Aws::Backup
|
|
1165
1206
|
o.input = Shapes::ShapeRef.new(shape: ListBackupJobsInput)
|
1166
1207
|
o.output = Shapes::ShapeRef.new(shape: ListBackupJobsOutput)
|
1167
1208
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1168
|
-
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1169
1209
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1170
1210
|
o[:pager] = Aws::Pager.new(
|
1171
1211
|
limit_key: "max_results",
|
@@ -1492,6 +1532,17 @@ module Aws::Backup
|
|
1492
1532
|
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1493
1533
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1494
1534
|
end)
|
1535
|
+
|
1536
|
+
api.add_operation(:update_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1537
|
+
o.name = "UpdateRegionSettings"
|
1538
|
+
o.http_method = "PUT"
|
1539
|
+
o.http_request_uri = "/account-settings"
|
1540
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateRegionSettingsInput)
|
1541
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1542
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1543
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1544
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1545
|
+
end)
|
1495
1546
|
end
|
1496
1547
|
|
1497
1548
|
end
|