aws-sdk-backup 1.12.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-backup.rb +3 -1
- data/lib/aws-sdk-backup/client.rb +123 -33
- data/lib/aws-sdk-backup/client_api.rb +38 -0
- data/lib/aws-sdk-backup/errors.rb +2 -0
- data/lib/aws-sdk-backup/resource.rb +3 -7
- data/lib/aws-sdk-backup/types.rb +199 -46
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: f654fea0530771204924ddeb2caf0334ee9da84dfc98be9217d6030c1b6476d5
|
4
|
+
data.tar.gz: 7a07adb67131d5a528b705874f21d097a541329d08dbc6cee5213275e5911f2e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a4637afaebf3f74b0d105e6e37c3112e71904ff602392d719135ae57adb6ddbb09f7c3c5e3a5bcc7c3a52d1bdb95ad4e1c5d9a349d644eabc023451af18bb17f
|
7
|
+
data.tar.gz: ec90c96dd23b62a0ed7b89f60b136426d2a8ec4361bd36023b2f44c1513b41787cc4edb20db7e438c65d40bca6aaef4cfd32f24bb9b994c924cee9458256c878
|
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.17.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
|
|
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:backup)
|
|
32
35
|
module Aws::Backup
|
33
36
|
# An API client for Backup. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
37
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# client = Aws::Backup::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
40
43
|
#
|
41
44
|
# For details on configuring region and credentials see
|
42
45
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -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
|
|
@@ -105,7 +109,7 @@ module Aws::Backup
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -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
|
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.
|
@@ -229,15 +233,19 @@ module Aws::Backup
|
|
229
233
|
#
|
230
234
|
# @option options [String] :retry_mode ("legacy")
|
231
235
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
236
|
+
#
|
237
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
238
|
+
# no retry mode is provided.
|
239
|
+
#
|
240
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
241
|
+
# This includes support for retry quotas, which limit the number of
|
242
|
+
# unsuccessful retries a client can make.
|
243
|
+
#
|
244
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
245
|
+
# functionality of `standard` mode along with automatic client side
|
246
|
+
# throttling. This is a provisional mode that may change behavior
|
247
|
+
# in the future.
|
248
|
+
#
|
241
249
|
#
|
242
250
|
# @option options [String] :secret_access_key
|
243
251
|
#
|
@@ -265,8 +273,7 @@ module Aws::Backup
|
|
265
273
|
#
|
266
274
|
# @option options [Integer] :http_read_timeout (60) The default
|
267
275
|
# number of seconds to wait for response data. This value can
|
268
|
-
# safely be set
|
269
|
-
# per-request on the session yielded by {#session_for}.
|
276
|
+
# safely be set per-request on the session.
|
270
277
|
#
|
271
278
|
# @option options [Float] :http_idle_timeout (5) The number of
|
272
279
|
# seconds a connection is allowed to sit idle before it is
|
@@ -278,7 +285,7 @@ module Aws::Backup
|
|
278
285
|
# request body. This option has no effect unless the request has
|
279
286
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
280
287
|
# disables this behaviour. This value can safely be set per
|
281
|
-
# request on the session
|
288
|
+
# request on the session.
|
282
289
|
#
|
283
290
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
284
291
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -600,7 +607,7 @@ module Aws::Backup
|
|
600
607
|
# @option params [required, String] :backup_vault_name
|
601
608
|
# The name of a logical container where backups are stored. Backup
|
602
609
|
# vaults are identified by names that are unique to the account used to
|
603
|
-
# create them and
|
610
|
+
# create them and the AWS Region where they are created. They consist of
|
604
611
|
# lowercase letters, numbers, and hyphens.
|
605
612
|
#
|
606
613
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -809,7 +816,7 @@ module Aws::Backup
|
|
809
816
|
# Returns metadata associated with creating a copy of a resource.
|
810
817
|
#
|
811
818
|
# @option params [required, String] :copy_job_id
|
812
|
-
# Uniquely identifies a
|
819
|
+
# Uniquely identifies a copy job.
|
813
820
|
#
|
814
821
|
# @return [Types::DescribeCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
815
822
|
#
|
@@ -851,7 +858,7 @@ module Aws::Backup
|
|
851
858
|
end
|
852
859
|
|
853
860
|
# Returns information about a saved resource, including the last time it
|
854
|
-
# was backed
|
861
|
+
# was backed up, its Amazon Resource Name (ARN), and the AWS service
|
855
862
|
# type of the saved resource.
|
856
863
|
#
|
857
864
|
# @option params [required, String] :resource_arn
|
@@ -960,6 +967,31 @@ module Aws::Backup
|
|
960
967
|
req.send_request(options)
|
961
968
|
end
|
962
969
|
|
970
|
+
# Returns the current service opt-in settings for the region. If the
|
971
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
972
|
+
# that service's resources in this region, when included in an
|
973
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
974
|
+
# false for a service, AWS Backup will not attempt to protect that
|
975
|
+
# service's resources in this region.
|
976
|
+
#
|
977
|
+
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
978
|
+
#
|
979
|
+
# * {Types::DescribeRegionSettingsOutput#resource_type_opt_in_preference #resource_type_opt_in_preference} => Hash<String,Boolean>
|
980
|
+
#
|
981
|
+
# @example Response structure
|
982
|
+
#
|
983
|
+
# resp.resource_type_opt_in_preference #=> Hash
|
984
|
+
# resp.resource_type_opt_in_preference["ResourceType"] #=> Boolean
|
985
|
+
#
|
986
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings AWS API Documentation
|
987
|
+
#
|
988
|
+
# @overload describe_region_settings(params = {})
|
989
|
+
# @param [Hash] params ({})
|
990
|
+
def describe_region_settings(params = {}, options = {})
|
991
|
+
req = build_request(:describe_region_settings, params)
|
992
|
+
req.send_request(options)
|
993
|
+
end
|
994
|
+
|
963
995
|
# Returns metadata associated with a restore job that is specified by a
|
964
996
|
# job ID.
|
965
997
|
#
|
@@ -1421,6 +1453,8 @@ module Aws::Backup
|
|
1421
1453
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
1422
1454
|
# * {Types::ListBackupJobsOutput#next_token #next_token} => String
|
1423
1455
|
#
|
1456
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1457
|
+
#
|
1424
1458
|
# @example Request syntax with placeholder values
|
1425
1459
|
#
|
1426
1460
|
# resp = client.list_backup_jobs({
|
@@ -1485,6 +1519,8 @@ module Aws::Backup
|
|
1485
1519
|
# * {Types::ListBackupPlanTemplatesOutput#next_token #next_token} => String
|
1486
1520
|
# * {Types::ListBackupPlanTemplatesOutput#backup_plan_templates_list #backup_plan_templates_list} => Array<Types::BackupPlanTemplatesListMember>
|
1487
1521
|
#
|
1522
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1523
|
+
#
|
1488
1524
|
# @example Request syntax with placeholder values
|
1489
1525
|
#
|
1490
1526
|
# resp = client.list_backup_plan_templates({
|
@@ -1529,6 +1565,8 @@ module Aws::Backup
|
|
1529
1565
|
# * {Types::ListBackupPlanVersionsOutput#next_token #next_token} => String
|
1530
1566
|
# * {Types::ListBackupPlanVersionsOutput#backup_plan_versions_list #backup_plan_versions_list} => Array<Types::BackupPlansListMember>
|
1531
1567
|
#
|
1568
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1569
|
+
#
|
1532
1570
|
# @example Request syntax with placeholder values
|
1533
1571
|
#
|
1534
1572
|
# resp = client.list_backup_plan_versions({
|
@@ -1581,6 +1619,8 @@ module Aws::Backup
|
|
1581
1619
|
# * {Types::ListBackupPlansOutput#next_token #next_token} => String
|
1582
1620
|
# * {Types::ListBackupPlansOutput#backup_plans_list #backup_plans_list} => Array<Types::BackupPlansListMember>
|
1583
1621
|
#
|
1622
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1623
|
+
#
|
1584
1624
|
# @example Request syntax with placeholder values
|
1585
1625
|
#
|
1586
1626
|
# resp = client.list_backup_plans({
|
@@ -1631,6 +1671,8 @@ module Aws::Backup
|
|
1631
1671
|
# * {Types::ListBackupSelectionsOutput#next_token #next_token} => String
|
1632
1672
|
# * {Types::ListBackupSelectionsOutput#backup_selections_list #backup_selections_list} => Array<Types::BackupSelectionsListMember>
|
1633
1673
|
#
|
1674
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1675
|
+
#
|
1634
1676
|
# @example Request syntax with placeholder values
|
1635
1677
|
#
|
1636
1678
|
# resp = client.list_backup_selections({
|
@@ -1676,6 +1718,8 @@ module Aws::Backup
|
|
1676
1718
|
# * {Types::ListBackupVaultsOutput#backup_vault_list #backup_vault_list} => Array<Types::BackupVaultListMember>
|
1677
1719
|
# * {Types::ListBackupVaultsOutput#next_token #next_token} => String
|
1678
1720
|
#
|
1721
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1722
|
+
#
|
1679
1723
|
# @example Request syntax with placeholder values
|
1680
1724
|
#
|
1681
1725
|
# resp = client.list_backup_vaults({
|
@@ -1730,8 +1774,6 @@ module Aws::Backup
|
|
1730
1774
|
# @option params [String] :by_resource_type
|
1731
1775
|
# Returns only backup jobs for the specified resources:
|
1732
1776
|
#
|
1733
|
-
# * `DynamoDB` for Amazon DynamoDB
|
1734
|
-
#
|
1735
1777
|
# * `EBS` for Amazon Elastic Block Store
|
1736
1778
|
#
|
1737
1779
|
# * `EFS` for Amazon Elastic File System
|
@@ -1743,13 +1785,15 @@ module Aws::Backup
|
|
1743
1785
|
# @option params [String] :by_destination_vault_arn
|
1744
1786
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
1745
1787
|
# vault to copy from; for example,
|
1746
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
1788
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1747
1789
|
#
|
1748
1790
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1749
1791
|
#
|
1750
1792
|
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
1751
1793
|
# * {Types::ListCopyJobsOutput#next_token #next_token} => String
|
1752
1794
|
#
|
1795
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1796
|
+
#
|
1753
1797
|
# @example Request syntax with placeholder values
|
1754
1798
|
#
|
1755
1799
|
# resp = client.list_copy_jobs({
|
@@ -1812,6 +1856,8 @@ module Aws::Backup
|
|
1812
1856
|
# * {Types::ListProtectedResourcesOutput#results #results} => Array<Types::ProtectedResource>
|
1813
1857
|
# * {Types::ListProtectedResourcesOutput#next_token #next_token} => String
|
1814
1858
|
#
|
1859
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1860
|
+
#
|
1815
1861
|
# @example Request syntax with placeholder values
|
1816
1862
|
#
|
1817
1863
|
# resp = client.list_protected_resources({
|
@@ -1877,6 +1923,8 @@ module Aws::Backup
|
|
1877
1923
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#next_token #next_token} => String
|
1878
1924
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByBackupVault>
|
1879
1925
|
#
|
1926
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1927
|
+
#
|
1880
1928
|
# @example Request syntax with placeholder values
|
1881
1929
|
#
|
1882
1930
|
# resp = client.list_recovery_points_by_backup_vault({
|
@@ -1946,6 +1994,8 @@ module Aws::Backup
|
|
1946
1994
|
# * {Types::ListRecoveryPointsByResourceOutput#next_token #next_token} => String
|
1947
1995
|
# * {Types::ListRecoveryPointsByResourceOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByResource>
|
1948
1996
|
#
|
1997
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1998
|
+
#
|
1949
1999
|
# @example Request syntax with placeholder values
|
1950
2000
|
#
|
1951
2001
|
# resp = client.list_recovery_points_by_resource({
|
@@ -1991,6 +2041,8 @@ module Aws::Backup
|
|
1991
2041
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
1992
2042
|
# * {Types::ListRestoreJobsOutput#next_token #next_token} => String
|
1993
2043
|
#
|
2044
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2045
|
+
#
|
1994
2046
|
# @example Request syntax with placeholder values
|
1995
2047
|
#
|
1996
2048
|
# resp = client.list_restore_jobs({
|
@@ -2026,6 +2078,10 @@ module Aws::Backup
|
|
2026
2078
|
# Returns a list of key-value pairs assigned to a target recovery point,
|
2027
2079
|
# backup plan, or backup vault.
|
2028
2080
|
#
|
2081
|
+
# <note markdown="1"> `ListTags` are currently only supported with Amazon EFS backups.
|
2082
|
+
#
|
2083
|
+
# </note>
|
2084
|
+
#
|
2029
2085
|
# @option params [required, String] :resource_arn
|
2030
2086
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
2031
2087
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -2045,6 +2101,8 @@ module Aws::Backup
|
|
2045
2101
|
# * {Types::ListTagsOutput#next_token #next_token} => String
|
2046
2102
|
# * {Types::ListTagsOutput#tags #tags} => Hash<String,String>
|
2047
2103
|
#
|
2104
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2105
|
+
#
|
2048
2106
|
# @example Request syntax with placeholder values
|
2049
2107
|
#
|
2050
2108
|
# resp = client.list_tags({
|
@@ -2157,11 +2215,13 @@ module Aws::Backup
|
|
2157
2215
|
# to `StartBackupJob`.
|
2158
2216
|
#
|
2159
2217
|
# @option params [Integer] :start_window_minutes
|
2160
|
-
#
|
2218
|
+
# A value in minutes after a backup is scheduled before a job will be
|
2219
|
+
# canceled if it doesn't start successfully. This value is optional.
|
2161
2220
|
#
|
2162
2221
|
# @option params [Integer] :complete_window_minutes
|
2163
|
-
#
|
2164
|
-
#
|
2222
|
+
# A value in minutes after a backup job is successfully started before
|
2223
|
+
# it must be completed or it will be canceled by AWS Backup. This value
|
2224
|
+
# is optional.
|
2165
2225
|
#
|
2166
2226
|
# @option params [Types::Lifecycle] :lifecycle
|
2167
2227
|
# The lifecycle defines when a protected resource is transitioned to
|
@@ -2229,7 +2289,7 @@ module Aws::Backup
|
|
2229
2289
|
# The name of a logical source container where backups are stored.
|
2230
2290
|
# Backup vaults are identified by names that are unique to the account
|
2231
2291
|
# used to create them and the AWS Region where they are created. They
|
2232
|
-
# consist of lowercase letters, numbers, and hyphens.
|
2292
|
+
# consist of lowercase letters, numbers, and hyphens.
|
2233
2293
|
#
|
2234
2294
|
# @option params [required, String] :destination_backup_vault_arn
|
2235
2295
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
@@ -2238,7 +2298,7 @@ module Aws::Backup
|
|
2238
2298
|
#
|
2239
2299
|
# @option params [required, String] :iam_role_arn
|
2240
2300
|
# Specifies the IAM role ARN used to copy the target recovery point; for
|
2241
|
-
# example, arn:aws:iam::123456789012:role/S3Access
|
2301
|
+
# example, `arn:aws:iam::123456789012:role/S3Access`.
|
2242
2302
|
#
|
2243
2303
|
# @option params [String] :idempotency_token
|
2244
2304
|
# A customer chosen string that can be used to distinguish between calls
|
@@ -2303,7 +2363,7 @@ module Aws::Backup
|
|
2303
2363
|
# resource name, required to restore a recovery point.
|
2304
2364
|
#
|
2305
2365
|
# You can get configuration metadata about a resource at the time it was
|
2306
|
-
# backed
|
2366
|
+
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
2307
2367
|
# values in addition to those provided by
|
2308
2368
|
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
2309
2369
|
# resource. For example, you might need to provide a new resource name
|
@@ -2603,6 +2663,36 @@ module Aws::Backup
|
|
2603
2663
|
req.send_request(options)
|
2604
2664
|
end
|
2605
2665
|
|
2666
|
+
# Updates the current service opt-in settings for the region. If the
|
2667
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
2668
|
+
# that service's resources in this region, when included in an
|
2669
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
2670
|
+
# false for a service, AWS Backup will not attempt to protect that
|
2671
|
+
# service's resources in this region.
|
2672
|
+
#
|
2673
|
+
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2674
|
+
# Updates the list of services along with the opt-in preferences for the
|
2675
|
+
# region.
|
2676
|
+
#
|
2677
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2678
|
+
#
|
2679
|
+
# @example Request syntax with placeholder values
|
2680
|
+
#
|
2681
|
+
# resp = client.update_region_settings({
|
2682
|
+
# resource_type_opt_in_preference: {
|
2683
|
+
# "ResourceType" => false,
|
2684
|
+
# },
|
2685
|
+
# })
|
2686
|
+
#
|
2687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings AWS API Documentation
|
2688
|
+
#
|
2689
|
+
# @overload update_region_settings(params = {})
|
2690
|
+
# @param [Hash] params ({})
|
2691
|
+
def update_region_settings(params = {}, options = {})
|
2692
|
+
req = build_request(:update_region_settings, params)
|
2693
|
+
req.send_request(options)
|
2694
|
+
end
|
2695
|
+
|
2606
2696
|
# @!endgroup
|
2607
2697
|
|
2608
2698
|
# @param params ({})
|
@@ -2616,7 +2706,7 @@ module Aws::Backup
|
|
2616
2706
|
params: params,
|
2617
2707
|
config: config)
|
2618
2708
|
context[:gem_name] = 'aws-sdk-backup'
|
2619
|
-
context[:gem_version] = '1.
|
2709
|
+
context[:gem_version] = '1.17.0'
|
2620
2710
|
Seahorse::Client::Request.new(handlers, context)
|
2621
2711
|
end
|
2622
2712
|
|
@@ -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:
|
@@ -74,6 +76,8 @@ module Aws::Backup
|
|
74
76
|
DescribeProtectedResourceOutput = Shapes::StructureShape.new(name: 'DescribeProtectedResourceOutput')
|
75
77
|
DescribeRecoveryPointInput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointInput')
|
76
78
|
DescribeRecoveryPointOutput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointOutput')
|
79
|
+
DescribeRegionSettingsInput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsInput')
|
80
|
+
DescribeRegionSettingsOutput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsOutput')
|
77
81
|
DescribeRestoreJobInput = Shapes::StructureShape.new(name: 'DescribeRestoreJobInput')
|
78
82
|
DescribeRestoreJobOutput = Shapes::StructureShape.new(name: 'DescribeRestoreJobOutput')
|
79
83
|
ExportBackupPlanTemplateInput = Shapes::StructureShape.new(name: 'ExportBackupPlanTemplateInput')
|
@@ -97,6 +101,7 @@ module Aws::Backup
|
|
97
101
|
IAMRoleArn = Shapes::StringShape.new(name: 'IAMRoleArn')
|
98
102
|
InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
|
99
103
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
104
|
+
IsEnabled = Shapes::BooleanShape.new(name: 'IsEnabled')
|
100
105
|
Lifecycle = Shapes::StructureShape.new(name: 'Lifecycle')
|
101
106
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
102
107
|
ListBackupJobsInput = Shapes::StructureShape.new(name: 'ListBackupJobsInput')
|
@@ -143,6 +148,7 @@ module Aws::Backup
|
|
143
148
|
ResourceArns = Shapes::ListShape.new(name: 'ResourceArns')
|
144
149
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
145
150
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
151
|
+
ResourceTypeOptInPreference = Shapes::MapShape.new(name: 'ResourceTypeOptInPreference')
|
146
152
|
ResourceTypes = Shapes::ListShape.new(name: 'ResourceTypes')
|
147
153
|
RestoreJobId = Shapes::StringShape.new(name: 'RestoreJobId')
|
148
154
|
RestoreJobStatus = Shapes::StringShape.new(name: 'RestoreJobStatus')
|
@@ -167,6 +173,7 @@ module Aws::Backup
|
|
167
173
|
UpdateBackupPlanOutput = Shapes::StructureShape.new(name: 'UpdateBackupPlanOutput')
|
168
174
|
UpdateRecoveryPointLifecycleInput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleInput')
|
169
175
|
UpdateRecoveryPointLifecycleOutput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleOutput')
|
176
|
+
UpdateRegionSettingsInput = Shapes::StructureShape.new(name: 'UpdateRegionSettingsInput')
|
170
177
|
WindowMinutes = Shapes::IntegerShape.new(name: 'WindowMinutes')
|
171
178
|
boolean = Shapes::BooleanShape.new(name: 'boolean')
|
172
179
|
long = Shapes::IntegerShape.new(name: 'long')
|
@@ -450,6 +457,11 @@ module Aws::Backup
|
|
450
457
|
DescribeRecoveryPointOutput.add_member(:last_restore_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastRestoreTime"))
|
451
458
|
DescribeRecoveryPointOutput.struct_class = Types::DescribeRecoveryPointOutput
|
452
459
|
|
460
|
+
DescribeRegionSettingsInput.struct_class = Types::DescribeRegionSettingsInput
|
461
|
+
|
462
|
+
DescribeRegionSettingsOutput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
463
|
+
DescribeRegionSettingsOutput.struct_class = Types::DescribeRegionSettingsOutput
|
464
|
+
|
453
465
|
DescribeRestoreJobInput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: RestoreJobId, required: true, location: "uri", location_name: "restoreJobId"))
|
454
466
|
DescribeRestoreJobInput.struct_class = Types::DescribeRestoreJobInput
|
455
467
|
|
@@ -750,6 +762,9 @@ module Aws::Backup
|
|
750
762
|
ResourceNotFoundException.add_member(:context, Shapes::ShapeRef.new(shape: string, location_name: "Context"))
|
751
763
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
752
764
|
|
765
|
+
ResourceTypeOptInPreference.key = Shapes::ShapeRef.new(shape: ResourceType)
|
766
|
+
ResourceTypeOptInPreference.value = Shapes::ShapeRef.new(shape: IsEnabled)
|
767
|
+
|
753
768
|
ResourceTypes.member = Shapes::ShapeRef.new(shape: ResourceType)
|
754
769
|
|
755
770
|
RestoreJobsList.member = Shapes::ShapeRef.new(shape: RestoreJobsListMember)
|
@@ -847,6 +862,9 @@ module Aws::Backup
|
|
847
862
|
UpdateRecoveryPointLifecycleOutput.add_member(:calculated_lifecycle, Shapes::ShapeRef.new(shape: CalculatedLifecycle, location_name: "CalculatedLifecycle"))
|
848
863
|
UpdateRecoveryPointLifecycleOutput.struct_class = Types::UpdateRecoveryPointLifecycleOutput
|
849
864
|
|
865
|
+
UpdateRegionSettingsInput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
866
|
+
UpdateRegionSettingsInput.struct_class = Types::UpdateRegionSettingsInput
|
867
|
+
|
850
868
|
|
851
869
|
# @api private
|
852
870
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -1039,6 +1057,15 @@ module Aws::Backup
|
|
1039
1057
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1040
1058
|
end)
|
1041
1059
|
|
1060
|
+
api.add_operation(:describe_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1061
|
+
o.name = "DescribeRegionSettings"
|
1062
|
+
o.http_method = "GET"
|
1063
|
+
o.http_request_uri = "/account-settings"
|
1064
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeRegionSettingsInput)
|
1065
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeRegionSettingsOutput)
|
1066
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1067
|
+
end)
|
1068
|
+
|
1042
1069
|
api.add_operation(:describe_restore_job, Seahorse::Model::Operation.new.tap do |o|
|
1043
1070
|
o.name = "DescribeRestoreJob"
|
1044
1071
|
o.http_method = "GET"
|
@@ -1492,6 +1519,17 @@ module Aws::Backup
|
|
1492
1519
|
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1493
1520
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1494
1521
|
end)
|
1522
|
+
|
1523
|
+
api.add_operation(:update_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1524
|
+
o.name = "UpdateRegionSettings"
|
1525
|
+
o.http_method = "PUT"
|
1526
|
+
o.http_request_uri = "/account-settings"
|
1527
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateRegionSettingsInput)
|
1528
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1529
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1530
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1531
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1532
|
+
end)
|
1495
1533
|
end
|
1496
1534
|
|
1497
1535
|
end
|