aws-sdk-backup 1.11.0 → 1.16.1
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 +5 -5
- data/lib/aws-sdk-backup.rb +7 -4
- data/lib/aws-sdk-backup/client.rb +165 -26
- data/lib/aws-sdk-backup/client_api.rb +36 -0
- data/lib/aws-sdk-backup/errors.rb +30 -8
- data/lib/aws-sdk-backup/resource.rb +1 -0
- data/lib/aws-sdk-backup/types.rb +86 -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: 3c5e55c266800a276866b9f0cf79cf542e49426ec207d2f30359de0d40ed4b5c
|
4
|
+
data.tar.gz: ebc31b8925005de6a547316ec44d869d901383c80f2d6ec1fc86ab9f4f686cde
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 50306e44dd970fcbf9e7dee1bf173f7acf2e00ee7d847e61262c43e8635af03867b47546a26be4ee191028fe745992b40e189aa4ae1a7672f8e7c9b25ed06b9e
|
7
|
+
data.tar.gz: 47067e94a51af8658a0522e63730679d97705c7739234e109c5e43dc4a9ce4024f56351f24730e2a202dd4a01426334bc94d55d15494e54bfaf2b1ec527b1f6c
|
data/lib/aws-sdk-backup.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-backup/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# backup = Aws::Backup::Client.new
|
28
|
+
# resp = backup.create_backup_plan(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS Backup
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS Backup are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Backup::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS Backup API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-backup/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Backup
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.16.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:backup)
|
31
32
|
|
32
33
|
module Aws::Backup
|
34
|
+
# An API client for Backup. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::Backup::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::Backup
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::Backup
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::Backup
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::Backup
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::Backup
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::Backup
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::Backup
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::Backup
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -209,16 +266,15 @@ module Aws::Backup
|
|
209
266
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
267
|
#
|
211
268
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
269
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
270
|
# `Timeout::Error`.
|
214
271
|
#
|
215
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
273
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
219
275
|
#
|
220
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
277
|
+
# seconds a connection is allowed to sit idle before it is
|
222
278
|
# considered stale. Stale connections are closed and removed
|
223
279
|
# from the pool before making a request.
|
224
280
|
#
|
@@ -227,7 +283,7 @@ module Aws::Backup
|
|
227
283
|
# request body. This option has no effect unless the request has
|
228
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
285
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
286
|
+
# request on the session.
|
231
287
|
#
|
232
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -549,7 +605,7 @@ module Aws::Backup
|
|
549
605
|
# @option params [required, String] :backup_vault_name
|
550
606
|
# The name of a logical container where backups are stored. Backup
|
551
607
|
# vaults are identified by names that are unique to the account used to
|
552
|
-
# create them and
|
608
|
+
# create them and the AWS Region where they are created. They consist of
|
553
609
|
# lowercase letters, numbers, and hyphens.
|
554
610
|
#
|
555
611
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -758,7 +814,7 @@ module Aws::Backup
|
|
758
814
|
# Returns metadata associated with creating a copy of a resource.
|
759
815
|
#
|
760
816
|
# @option params [required, String] :copy_job_id
|
761
|
-
# Uniquely identifies a
|
817
|
+
# Uniquely identifies a copy job.
|
762
818
|
#
|
763
819
|
# @return [Types::DescribeCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
764
820
|
#
|
@@ -800,7 +856,7 @@ module Aws::Backup
|
|
800
856
|
end
|
801
857
|
|
802
858
|
# Returns information about a saved resource, including the last time it
|
803
|
-
# was backed
|
859
|
+
# was backed up, its Amazon Resource Name (ARN), and the AWS service
|
804
860
|
# type of the saved resource.
|
805
861
|
#
|
806
862
|
# @option params [required, String] :resource_arn
|
@@ -909,6 +965,31 @@ module Aws::Backup
|
|
909
965
|
req.send_request(options)
|
910
966
|
end
|
911
967
|
|
968
|
+
# Returns the current service opt-in settings for the region. If the
|
969
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
970
|
+
# that service's resources in this region, when included in an
|
971
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
972
|
+
# false for a service, AWS Backup will not attempt to protect that
|
973
|
+
# service's resources in this region.
|
974
|
+
#
|
975
|
+
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
976
|
+
#
|
977
|
+
# * {Types::DescribeRegionSettingsOutput#resource_type_opt_in_preference #resource_type_opt_in_preference} => Hash<String,Boolean>
|
978
|
+
#
|
979
|
+
# @example Response structure
|
980
|
+
#
|
981
|
+
# resp.resource_type_opt_in_preference #=> Hash
|
982
|
+
# resp.resource_type_opt_in_preference["ResourceType"] #=> Boolean
|
983
|
+
#
|
984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings AWS API Documentation
|
985
|
+
#
|
986
|
+
# @overload describe_region_settings(params = {})
|
987
|
+
# @param [Hash] params ({})
|
988
|
+
def describe_region_settings(params = {}, options = {})
|
989
|
+
req = build_request(:describe_region_settings, params)
|
990
|
+
req.send_request(options)
|
991
|
+
end
|
992
|
+
|
912
993
|
# Returns metadata associated with a restore job that is specified by a
|
913
994
|
# job ID.
|
914
995
|
#
|
@@ -1370,6 +1451,8 @@ module Aws::Backup
|
|
1370
1451
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
1371
1452
|
# * {Types::ListBackupJobsOutput#next_token #next_token} => String
|
1372
1453
|
#
|
1454
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1455
|
+
#
|
1373
1456
|
# @example Request syntax with placeholder values
|
1374
1457
|
#
|
1375
1458
|
# resp = client.list_backup_jobs({
|
@@ -1434,6 +1517,8 @@ module Aws::Backup
|
|
1434
1517
|
# * {Types::ListBackupPlanTemplatesOutput#next_token #next_token} => String
|
1435
1518
|
# * {Types::ListBackupPlanTemplatesOutput#backup_plan_templates_list #backup_plan_templates_list} => Array<Types::BackupPlanTemplatesListMember>
|
1436
1519
|
#
|
1520
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1521
|
+
#
|
1437
1522
|
# @example Request syntax with placeholder values
|
1438
1523
|
#
|
1439
1524
|
# resp = client.list_backup_plan_templates({
|
@@ -1478,6 +1563,8 @@ module Aws::Backup
|
|
1478
1563
|
# * {Types::ListBackupPlanVersionsOutput#next_token #next_token} => String
|
1479
1564
|
# * {Types::ListBackupPlanVersionsOutput#backup_plan_versions_list #backup_plan_versions_list} => Array<Types::BackupPlansListMember>
|
1480
1565
|
#
|
1566
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1567
|
+
#
|
1481
1568
|
# @example Request syntax with placeholder values
|
1482
1569
|
#
|
1483
1570
|
# resp = client.list_backup_plan_versions({
|
@@ -1530,6 +1617,8 @@ module Aws::Backup
|
|
1530
1617
|
# * {Types::ListBackupPlansOutput#next_token #next_token} => String
|
1531
1618
|
# * {Types::ListBackupPlansOutput#backup_plans_list #backup_plans_list} => Array<Types::BackupPlansListMember>
|
1532
1619
|
#
|
1620
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1621
|
+
#
|
1533
1622
|
# @example Request syntax with placeholder values
|
1534
1623
|
#
|
1535
1624
|
# resp = client.list_backup_plans({
|
@@ -1580,6 +1669,8 @@ module Aws::Backup
|
|
1580
1669
|
# * {Types::ListBackupSelectionsOutput#next_token #next_token} => String
|
1581
1670
|
# * {Types::ListBackupSelectionsOutput#backup_selections_list #backup_selections_list} => Array<Types::BackupSelectionsListMember>
|
1582
1671
|
#
|
1672
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1673
|
+
#
|
1583
1674
|
# @example Request syntax with placeholder values
|
1584
1675
|
#
|
1585
1676
|
# resp = client.list_backup_selections({
|
@@ -1625,6 +1716,8 @@ module Aws::Backup
|
|
1625
1716
|
# * {Types::ListBackupVaultsOutput#backup_vault_list #backup_vault_list} => Array<Types::BackupVaultListMember>
|
1626
1717
|
# * {Types::ListBackupVaultsOutput#next_token #next_token} => String
|
1627
1718
|
#
|
1719
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1720
|
+
#
|
1628
1721
|
# @example Request syntax with placeholder values
|
1629
1722
|
#
|
1630
1723
|
# resp = client.list_backup_vaults({
|
@@ -1679,8 +1772,6 @@ module Aws::Backup
|
|
1679
1772
|
# @option params [String] :by_resource_type
|
1680
1773
|
# Returns only backup jobs for the specified resources:
|
1681
1774
|
#
|
1682
|
-
# * `DynamoDB` for Amazon DynamoDB
|
1683
|
-
#
|
1684
1775
|
# * `EBS` for Amazon Elastic Block Store
|
1685
1776
|
#
|
1686
1777
|
# * `EFS` for Amazon Elastic File System
|
@@ -1692,13 +1783,15 @@ module Aws::Backup
|
|
1692
1783
|
# @option params [String] :by_destination_vault_arn
|
1693
1784
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
1694
1785
|
# vault to copy from; for example,
|
1695
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
1786
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1696
1787
|
#
|
1697
1788
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1698
1789
|
#
|
1699
1790
|
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
1700
1791
|
# * {Types::ListCopyJobsOutput#next_token #next_token} => String
|
1701
1792
|
#
|
1793
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1794
|
+
#
|
1702
1795
|
# @example Request syntax with placeholder values
|
1703
1796
|
#
|
1704
1797
|
# resp = client.list_copy_jobs({
|
@@ -1761,6 +1854,8 @@ module Aws::Backup
|
|
1761
1854
|
# * {Types::ListProtectedResourcesOutput#results #results} => Array<Types::ProtectedResource>
|
1762
1855
|
# * {Types::ListProtectedResourcesOutput#next_token #next_token} => String
|
1763
1856
|
#
|
1857
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1858
|
+
#
|
1764
1859
|
# @example Request syntax with placeholder values
|
1765
1860
|
#
|
1766
1861
|
# resp = client.list_protected_resources({
|
@@ -1826,6 +1921,8 @@ module Aws::Backup
|
|
1826
1921
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#next_token #next_token} => String
|
1827
1922
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByBackupVault>
|
1828
1923
|
#
|
1924
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1925
|
+
#
|
1829
1926
|
# @example Request syntax with placeholder values
|
1830
1927
|
#
|
1831
1928
|
# resp = client.list_recovery_points_by_backup_vault({
|
@@ -1895,6 +1992,8 @@ module Aws::Backup
|
|
1895
1992
|
# * {Types::ListRecoveryPointsByResourceOutput#next_token #next_token} => String
|
1896
1993
|
# * {Types::ListRecoveryPointsByResourceOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByResource>
|
1897
1994
|
#
|
1995
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1996
|
+
#
|
1898
1997
|
# @example Request syntax with placeholder values
|
1899
1998
|
#
|
1900
1999
|
# resp = client.list_recovery_points_by_resource({
|
@@ -1940,6 +2039,8 @@ module Aws::Backup
|
|
1940
2039
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
1941
2040
|
# * {Types::ListRestoreJobsOutput#next_token #next_token} => String
|
1942
2041
|
#
|
2042
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2043
|
+
#
|
1943
2044
|
# @example Request syntax with placeholder values
|
1944
2045
|
#
|
1945
2046
|
# resp = client.list_restore_jobs({
|
@@ -1975,6 +2076,10 @@ module Aws::Backup
|
|
1975
2076
|
# Returns a list of key-value pairs assigned to a target recovery point,
|
1976
2077
|
# backup plan, or backup vault.
|
1977
2078
|
#
|
2079
|
+
# <note markdown="1"> `ListTags` are currently only supported with Amazon EFS backups.
|
2080
|
+
#
|
2081
|
+
# </note>
|
2082
|
+
#
|
1978
2083
|
# @option params [required, String] :resource_arn
|
1979
2084
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
1980
2085
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -1994,6 +2099,8 @@ module Aws::Backup
|
|
1994
2099
|
# * {Types::ListTagsOutput#next_token #next_token} => String
|
1995
2100
|
# * {Types::ListTagsOutput#tags #tags} => Hash<String,String>
|
1996
2101
|
#
|
2102
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2103
|
+
#
|
1997
2104
|
# @example Request syntax with placeholder values
|
1998
2105
|
#
|
1999
2106
|
# resp = client.list_tags({
|
@@ -2106,11 +2213,13 @@ module Aws::Backup
|
|
2106
2213
|
# to `StartBackupJob`.
|
2107
2214
|
#
|
2108
2215
|
# @option params [Integer] :start_window_minutes
|
2109
|
-
#
|
2216
|
+
# A value in minutes after a backup is scheduled before a job will be
|
2217
|
+
# canceled if it doesn't start successfully. This value is optional.
|
2110
2218
|
#
|
2111
2219
|
# @option params [Integer] :complete_window_minutes
|
2112
|
-
#
|
2113
|
-
#
|
2220
|
+
# A value in minutes after a backup job is successfully started before
|
2221
|
+
# it must be completed or it will be canceled by AWS Backup. This value
|
2222
|
+
# is optional.
|
2114
2223
|
#
|
2115
2224
|
# @option params [Types::Lifecycle] :lifecycle
|
2116
2225
|
# The lifecycle defines when a protected resource is transitioned to
|
@@ -2178,7 +2287,7 @@ module Aws::Backup
|
|
2178
2287
|
# The name of a logical source container where backups are stored.
|
2179
2288
|
# Backup vaults are identified by names that are unique to the account
|
2180
2289
|
# used to create them and the AWS Region where they are created. They
|
2181
|
-
# consist of lowercase letters, numbers, and hyphens.
|
2290
|
+
# consist of lowercase letters, numbers, and hyphens.
|
2182
2291
|
#
|
2183
2292
|
# @option params [required, String] :destination_backup_vault_arn
|
2184
2293
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
@@ -2187,7 +2296,7 @@ module Aws::Backup
|
|
2187
2296
|
#
|
2188
2297
|
# @option params [required, String] :iam_role_arn
|
2189
2298
|
# Specifies the IAM role ARN used to copy the target recovery point; for
|
2190
|
-
# example, arn:aws:iam::123456789012:role/S3Access
|
2299
|
+
# example, `arn:aws:iam::123456789012:role/S3Access`.
|
2191
2300
|
#
|
2192
2301
|
# @option params [String] :idempotency_token
|
2193
2302
|
# A customer chosen string that can be used to distinguish between calls
|
@@ -2252,7 +2361,7 @@ module Aws::Backup
|
|
2252
2361
|
# resource name, required to restore a recovery point.
|
2253
2362
|
#
|
2254
2363
|
# You can get configuration metadata about a resource at the time it was
|
2255
|
-
# backed
|
2364
|
+
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
2256
2365
|
# values in addition to those provided by
|
2257
2366
|
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
2258
2367
|
# resource. For example, you might need to provide a new resource name
|
@@ -2552,6 +2661,36 @@ module Aws::Backup
|
|
2552
2661
|
req.send_request(options)
|
2553
2662
|
end
|
2554
2663
|
|
2664
|
+
# Updates the current service opt-in settings for the region. If the
|
2665
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
2666
|
+
# that service's resources in this region, when included in an
|
2667
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
2668
|
+
# false for a service, AWS Backup will not attempt to protect that
|
2669
|
+
# service's resources in this region.
|
2670
|
+
#
|
2671
|
+
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2672
|
+
# Updates the list of services along with the opt-in preferences for the
|
2673
|
+
# region.
|
2674
|
+
#
|
2675
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2676
|
+
#
|
2677
|
+
# @example Request syntax with placeholder values
|
2678
|
+
#
|
2679
|
+
# resp = client.update_region_settings({
|
2680
|
+
# resource_type_opt_in_preference: {
|
2681
|
+
# "ResourceType" => false,
|
2682
|
+
# },
|
2683
|
+
# })
|
2684
|
+
#
|
2685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings AWS API Documentation
|
2686
|
+
#
|
2687
|
+
# @overload update_region_settings(params = {})
|
2688
|
+
# @param [Hash] params ({})
|
2689
|
+
def update_region_settings(params = {}, options = {})
|
2690
|
+
req = build_request(:update_region_settings, params)
|
2691
|
+
req.send_request(options)
|
2692
|
+
end
|
2693
|
+
|
2555
2694
|
# @!endgroup
|
2556
2695
|
|
2557
2696
|
# @param params ({})
|
@@ -2565,7 +2704,7 @@ module Aws::Backup
|
|
2565
2704
|
params: params,
|
2566
2705
|
config: config)
|
2567
2706
|
context[:gem_name] = 'aws-sdk-backup'
|
2568
|
-
context[:gem_version] = '1.
|
2707
|
+
context[:gem_version] = '1.16.1'
|
2569
2708
|
Seahorse::Client::Request.new(handlers, context)
|
2570
2709
|
end
|
2571
2710
|
|
@@ -74,6 +74,8 @@ module Aws::Backup
|
|
74
74
|
DescribeProtectedResourceOutput = Shapes::StructureShape.new(name: 'DescribeProtectedResourceOutput')
|
75
75
|
DescribeRecoveryPointInput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointInput')
|
76
76
|
DescribeRecoveryPointOutput = Shapes::StructureShape.new(name: 'DescribeRecoveryPointOutput')
|
77
|
+
DescribeRegionSettingsInput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsInput')
|
78
|
+
DescribeRegionSettingsOutput = Shapes::StructureShape.new(name: 'DescribeRegionSettingsOutput')
|
77
79
|
DescribeRestoreJobInput = Shapes::StructureShape.new(name: 'DescribeRestoreJobInput')
|
78
80
|
DescribeRestoreJobOutput = Shapes::StructureShape.new(name: 'DescribeRestoreJobOutput')
|
79
81
|
ExportBackupPlanTemplateInput = Shapes::StructureShape.new(name: 'ExportBackupPlanTemplateInput')
|
@@ -97,6 +99,7 @@ module Aws::Backup
|
|
97
99
|
IAMRoleArn = Shapes::StringShape.new(name: 'IAMRoleArn')
|
98
100
|
InvalidParameterValueException = Shapes::StructureShape.new(name: 'InvalidParameterValueException')
|
99
101
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
102
|
+
IsEnabled = Shapes::BooleanShape.new(name: 'IsEnabled')
|
100
103
|
Lifecycle = Shapes::StructureShape.new(name: 'Lifecycle')
|
101
104
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
102
105
|
ListBackupJobsInput = Shapes::StructureShape.new(name: 'ListBackupJobsInput')
|
@@ -143,6 +146,7 @@ module Aws::Backup
|
|
143
146
|
ResourceArns = Shapes::ListShape.new(name: 'ResourceArns')
|
144
147
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
145
148
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
149
|
+
ResourceTypeOptInPreference = Shapes::MapShape.new(name: 'ResourceTypeOptInPreference')
|
146
150
|
ResourceTypes = Shapes::ListShape.new(name: 'ResourceTypes')
|
147
151
|
RestoreJobId = Shapes::StringShape.new(name: 'RestoreJobId')
|
148
152
|
RestoreJobStatus = Shapes::StringShape.new(name: 'RestoreJobStatus')
|
@@ -167,6 +171,7 @@ module Aws::Backup
|
|
167
171
|
UpdateBackupPlanOutput = Shapes::StructureShape.new(name: 'UpdateBackupPlanOutput')
|
168
172
|
UpdateRecoveryPointLifecycleInput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleInput')
|
169
173
|
UpdateRecoveryPointLifecycleOutput = Shapes::StructureShape.new(name: 'UpdateRecoveryPointLifecycleOutput')
|
174
|
+
UpdateRegionSettingsInput = Shapes::StructureShape.new(name: 'UpdateRegionSettingsInput')
|
170
175
|
WindowMinutes = Shapes::IntegerShape.new(name: 'WindowMinutes')
|
171
176
|
boolean = Shapes::BooleanShape.new(name: 'boolean')
|
172
177
|
long = Shapes::IntegerShape.new(name: 'long')
|
@@ -450,6 +455,11 @@ module Aws::Backup
|
|
450
455
|
DescribeRecoveryPointOutput.add_member(:last_restore_time, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastRestoreTime"))
|
451
456
|
DescribeRecoveryPointOutput.struct_class = Types::DescribeRecoveryPointOutput
|
452
457
|
|
458
|
+
DescribeRegionSettingsInput.struct_class = Types::DescribeRegionSettingsInput
|
459
|
+
|
460
|
+
DescribeRegionSettingsOutput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
461
|
+
DescribeRegionSettingsOutput.struct_class = Types::DescribeRegionSettingsOutput
|
462
|
+
|
453
463
|
DescribeRestoreJobInput.add_member(:restore_job_id, Shapes::ShapeRef.new(shape: RestoreJobId, required: true, location: "uri", location_name: "restoreJobId"))
|
454
464
|
DescribeRestoreJobInput.struct_class = Types::DescribeRestoreJobInput
|
455
465
|
|
@@ -750,6 +760,9 @@ module Aws::Backup
|
|
750
760
|
ResourceNotFoundException.add_member(:context, Shapes::ShapeRef.new(shape: string, location_name: "Context"))
|
751
761
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
752
762
|
|
763
|
+
ResourceTypeOptInPreference.key = Shapes::ShapeRef.new(shape: ResourceType)
|
764
|
+
ResourceTypeOptInPreference.value = Shapes::ShapeRef.new(shape: IsEnabled)
|
765
|
+
|
753
766
|
ResourceTypes.member = Shapes::ShapeRef.new(shape: ResourceType)
|
754
767
|
|
755
768
|
RestoreJobsList.member = Shapes::ShapeRef.new(shape: RestoreJobsListMember)
|
@@ -847,6 +860,9 @@ module Aws::Backup
|
|
847
860
|
UpdateRecoveryPointLifecycleOutput.add_member(:calculated_lifecycle, Shapes::ShapeRef.new(shape: CalculatedLifecycle, location_name: "CalculatedLifecycle"))
|
848
861
|
UpdateRecoveryPointLifecycleOutput.struct_class = Types::UpdateRecoveryPointLifecycleOutput
|
849
862
|
|
863
|
+
UpdateRegionSettingsInput.add_member(:resource_type_opt_in_preference, Shapes::ShapeRef.new(shape: ResourceTypeOptInPreference, location_name: "ResourceTypeOptInPreference"))
|
864
|
+
UpdateRegionSettingsInput.struct_class = Types::UpdateRegionSettingsInput
|
865
|
+
|
850
866
|
|
851
867
|
# @api private
|
852
868
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -1039,6 +1055,15 @@ module Aws::Backup
|
|
1039
1055
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1040
1056
|
end)
|
1041
1057
|
|
1058
|
+
api.add_operation(:describe_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1059
|
+
o.name = "DescribeRegionSettings"
|
1060
|
+
o.http_method = "GET"
|
1061
|
+
o.http_request_uri = "/account-settings"
|
1062
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeRegionSettingsInput)
|
1063
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeRegionSettingsOutput)
|
1064
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1065
|
+
end)
|
1066
|
+
|
1042
1067
|
api.add_operation(:describe_restore_job, Seahorse::Model::Operation.new.tap do |o|
|
1043
1068
|
o.name = "DescribeRestoreJob"
|
1044
1069
|
o.http_method = "GET"
|
@@ -1492,6 +1517,17 @@ module Aws::Backup
|
|
1492
1517
|
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1493
1518
|
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1494
1519
|
end)
|
1520
|
+
|
1521
|
+
api.add_operation(:update_region_settings, Seahorse::Model::Operation.new.tap do |o|
|
1522
|
+
o.name = "UpdateRegionSettings"
|
1523
|
+
o.http_method = "PUT"
|
1524
|
+
o.http_request_uri = "/account-settings"
|
1525
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateRegionSettingsInput)
|
1526
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1527
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
1528
|
+
o.errors << Shapes::ShapeRef.new(shape: MissingParameterValueException)
|
1529
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValueException)
|
1530
|
+
end)
|
1495
1531
|
end
|
1496
1532
|
|
1497
1533
|
end
|
@@ -6,6 +6,36 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::Backup
|
9
|
+
|
10
|
+
# When Backup returns an error response, the Ruby SDK constructs and raises an error.
|
11
|
+
# These errors all extend Aws::Backup::Errors::ServiceError < {Aws::Errors::ServiceError}
|
12
|
+
#
|
13
|
+
# You can rescue all Backup errors using ServiceError:
|
14
|
+
#
|
15
|
+
# begin
|
16
|
+
# # do stuff
|
17
|
+
# rescue Aws::Backup::Errors::ServiceError
|
18
|
+
# # rescues all Backup API errors
|
19
|
+
# end
|
20
|
+
#
|
21
|
+
#
|
22
|
+
# ## Request Context
|
23
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
24
|
+
# information about the request that generated the error.
|
25
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
26
|
+
#
|
27
|
+
# ## Error Classes
|
28
|
+
# * {AlreadyExistsException}
|
29
|
+
# * {DependencyFailureException}
|
30
|
+
# * {InvalidParameterValueException}
|
31
|
+
# * {InvalidRequestException}
|
32
|
+
# * {LimitExceededException}
|
33
|
+
# * {MissingParameterValueException}
|
34
|
+
# * {ResourceNotFoundException}
|
35
|
+
# * {ServiceUnavailableException}
|
36
|
+
#
|
37
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
38
|
+
# if they are not defined above.
|
9
39
|
module Errors
|
10
40
|
|
11
41
|
extend Aws::Errors::DynamicErrors
|
@@ -48,7 +78,6 @@ module Aws::Backup
|
|
48
78
|
def context
|
49
79
|
@data[:context]
|
50
80
|
end
|
51
|
-
|
52
81
|
end
|
53
82
|
|
54
83
|
class DependencyFailureException < ServiceError
|
@@ -79,7 +108,6 @@ module Aws::Backup
|
|
79
108
|
def context
|
80
109
|
@data[:context]
|
81
110
|
end
|
82
|
-
|
83
111
|
end
|
84
112
|
|
85
113
|
class InvalidParameterValueException < ServiceError
|
@@ -110,7 +138,6 @@ module Aws::Backup
|
|
110
138
|
def context
|
111
139
|
@data[:context]
|
112
140
|
end
|
113
|
-
|
114
141
|
end
|
115
142
|
|
116
143
|
class InvalidRequestException < ServiceError
|
@@ -141,7 +168,6 @@ module Aws::Backup
|
|
141
168
|
def context
|
142
169
|
@data[:context]
|
143
170
|
end
|
144
|
-
|
145
171
|
end
|
146
172
|
|
147
173
|
class LimitExceededException < ServiceError
|
@@ -172,7 +198,6 @@ module Aws::Backup
|
|
172
198
|
def context
|
173
199
|
@data[:context]
|
174
200
|
end
|
175
|
-
|
176
201
|
end
|
177
202
|
|
178
203
|
class MissingParameterValueException < ServiceError
|
@@ -203,7 +228,6 @@ module Aws::Backup
|
|
203
228
|
def context
|
204
229
|
@data[:context]
|
205
230
|
end
|
206
|
-
|
207
231
|
end
|
208
232
|
|
209
233
|
class ResourceNotFoundException < ServiceError
|
@@ -234,7 +258,6 @@ module Aws::Backup
|
|
234
258
|
def context
|
235
259
|
@data[:context]
|
236
260
|
end
|
237
|
-
|
238
261
|
end
|
239
262
|
|
240
263
|
class ServiceUnavailableException < ServiceError
|
@@ -265,7 +288,6 @@ module Aws::Backup
|
|
265
288
|
def context
|
266
289
|
@data[:context]
|
267
290
|
end
|
268
|
-
|
269
291
|
end
|
270
292
|
|
271
293
|
end
|
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -132,7 +132,7 @@ module Aws::Backup
|
|
132
132
|
# @return [Time]
|
133
133
|
#
|
134
134
|
# @!attribute [rw] resource_type
|
135
|
-
# The type of AWS resource to be backed
|
135
|
+
# The type of AWS resource to be backed up; for example, an Amazon
|
136
136
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
137
137
|
# Database Service (Amazon RDS) database.
|
138
138
|
# @return [String]
|
@@ -340,15 +340,14 @@ module Aws::Backup
|
|
340
340
|
# @return [String]
|
341
341
|
#
|
342
342
|
# @!attribute [rw] start_window_minutes
|
343
|
-
#
|
344
|
-
#
|
345
|
-
# successfully.
|
343
|
+
# A value in minutes after a backup is scheduled before a job will be
|
344
|
+
# canceled if it doesn't start successfully. This value is optional.
|
346
345
|
# @return [Integer]
|
347
346
|
#
|
348
347
|
# @!attribute [rw] completion_window_minutes
|
349
348
|
# A value in minutes after a backup job is successfully started before
|
350
|
-
# it must be completed or it
|
351
|
-
# optional.
|
349
|
+
# it must be completed or it will be canceled by AWS Backup. This
|
350
|
+
# value is optional.
|
352
351
|
# @return [Integer]
|
353
352
|
#
|
354
353
|
# @!attribute [rw] lifecycle
|
@@ -423,7 +422,7 @@ module Aws::Backup
|
|
423
422
|
# }
|
424
423
|
#
|
425
424
|
# @!attribute [rw] rule_name
|
426
|
-
#
|
425
|
+
# An optional display name for a backup rule.
|
427
426
|
# @return [String]
|
428
427
|
#
|
429
428
|
# @!attribute [rw] target_backup_vault_name
|
@@ -438,12 +437,14 @@ module Aws::Backup
|
|
438
437
|
# @return [String]
|
439
438
|
#
|
440
439
|
# @!attribute [rw] start_window_minutes
|
441
|
-
#
|
440
|
+
# A value in minutes after a backup is scheduled before a job will be
|
441
|
+
# canceled if it doesn't start successfully. This value is optional.
|
442
442
|
# @return [Integer]
|
443
443
|
#
|
444
444
|
# @!attribute [rw] completion_window_minutes
|
445
|
-
#
|
446
|
-
#
|
445
|
+
# A value in minutes after a backup job is successfully started before
|
446
|
+
# it must be completed or it will be canceled by AWS Backup. This
|
447
|
+
# value is optional.
|
447
448
|
# @return [Integer]
|
448
449
|
#
|
449
450
|
# @!attribute [rw] lifecycle
|
@@ -454,9 +455,9 @@ module Aws::Backup
|
|
454
455
|
#
|
455
456
|
# Backups transitioned to cold storage must be stored in cold storage
|
456
457
|
# for a minimum of 90 days. Therefore, the “expire after days” setting
|
457
|
-
# must be 90 days greater than the “transition to cold after days
|
458
|
-
# The “transition to cold after days” setting cannot be
|
459
|
-
# a backup has been transitioned to cold.
|
458
|
+
# must be 90 days greater than the “transition to cold after days”
|
459
|
+
# setting. The “transition to cold after days” setting cannot be
|
460
|
+
# changed after a backup has been transitioned to cold.
|
460
461
|
# @return [Types::Lifecycle]
|
461
462
|
#
|
462
463
|
# @!attribute [rw] recovery_point_tags
|
@@ -726,7 +727,7 @@ module Aws::Backup
|
|
726
727
|
# @!attribute [rw] destination_backup_vault_arn
|
727
728
|
# An Amazon Resource Name (ARN) that uniquely identifies the
|
728
729
|
# destination backup vault for the copied backup. For example,
|
729
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
730
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
730
731
|
# @return [String]
|
731
732
|
#
|
732
733
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyAction AWS API Documentation
|
@@ -740,37 +741,37 @@ module Aws::Backup
|
|
740
741
|
# Contains detailed information about a copy job.
|
741
742
|
#
|
742
743
|
# @!attribute [rw] copy_job_id
|
743
|
-
# Uniquely identifies a
|
744
|
+
# Uniquely identifies a copy job.
|
744
745
|
# @return [String]
|
745
746
|
#
|
746
747
|
# @!attribute [rw] source_backup_vault_arn
|
747
748
|
# An Amazon Resource Name (ARN) that uniquely identifies a source copy
|
748
749
|
# vault; for example,
|
749
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
750
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
750
751
|
# @return [String]
|
751
752
|
#
|
752
753
|
# @!attribute [rw] source_recovery_point_arn
|
753
754
|
# An ARN that uniquely identifies a source recovery point; for
|
754
755
|
# example,
|
755
|
-
# arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
|
756
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
756
757
|
# @return [String]
|
757
758
|
#
|
758
759
|
# @!attribute [rw] destination_backup_vault_arn
|
759
760
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
760
761
|
# copy vault; for example,
|
761
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
762
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
762
763
|
# @return [String]
|
763
764
|
#
|
764
765
|
# @!attribute [rw] destination_recovery_point_arn
|
765
766
|
# An ARN that uniquely identifies a destination recovery point; for
|
766
767
|
# example,
|
767
|
-
# arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
|
768
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
768
769
|
# @return [String]
|
769
770
|
#
|
770
771
|
# @!attribute [rw] resource_arn
|
771
|
-
# The
|
772
|
-
#
|
773
|
-
#
|
772
|
+
# The AWS resource to be copied; for example, an Amazon Elastic Block
|
773
|
+
# Store (Amazon EBS) volume or an Amazon Relational Database Service
|
774
|
+
# (Amazon RDS) database.
|
774
775
|
# @return [String]
|
775
776
|
#
|
776
777
|
# @!attribute [rw] creation_date
|
@@ -781,18 +782,18 @@ module Aws::Backup
|
|
781
782
|
# @return [Time]
|
782
783
|
#
|
783
784
|
# @!attribute [rw] completion_date
|
784
|
-
# The date and time a
|
785
|
-
#
|
786
|
-
#
|
787
|
-
#
|
785
|
+
# The date and time a copy job is completed, in Unix format and
|
786
|
+
# Coordinated Universal Time (UTC). The value of CompletionDate is
|
787
|
+
# accurate to milliseconds. For example, the value 1516925490.087
|
788
|
+
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
788
789
|
# @return [Time]
|
789
790
|
#
|
790
791
|
# @!attribute [rw] state
|
791
|
-
# The current state of a
|
792
|
+
# The current state of a copy job.
|
792
793
|
# @return [String]
|
793
794
|
#
|
794
795
|
# @!attribute [rw] status_message
|
795
|
-
# A detailed message explaining the status of the job
|
796
|
+
# A detailed message explaining the status of the job to copy a
|
796
797
|
# resource.
|
797
798
|
# @return [String]
|
798
799
|
#
|
@@ -802,7 +803,7 @@ module Aws::Backup
|
|
802
803
|
#
|
803
804
|
# @!attribute [rw] iam_role_arn
|
804
805
|
# Specifies the IAM role ARN used to copy the target recovery point;
|
805
|
-
# for example, arn:aws:iam::123456789012:role/S3Access
|
806
|
+
# for example, `arn:aws:iam::123456789012:role/S3Access`.
|
806
807
|
# @return [String]
|
807
808
|
#
|
808
809
|
# @!attribute [rw] created_by
|
@@ -920,7 +921,7 @@ module Aws::Backup
|
|
920
921
|
#
|
921
922
|
# @!attribute [rw] version_id
|
922
923
|
# Unique, randomly generated, Unicode, UTF-8 encoded strings that are
|
923
|
-
# at most
|
924
|
+
# at most 1,024 bytes long. They cannot be edited.
|
924
925
|
# @return [String]
|
925
926
|
#
|
926
927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation
|
@@ -1184,7 +1185,7 @@ module Aws::Backup
|
|
1184
1185
|
# @!attribute [rw] backup_vault_name
|
1185
1186
|
# The name of a logical container where backups are stored. Backup
|
1186
1187
|
# vaults are identified by names that are unique to the account used
|
1187
|
-
# to create them and
|
1188
|
+
# to create them and the AWS Region where they are created. They
|
1188
1189
|
# consist of lowercase letters, numbers, and hyphens.
|
1189
1190
|
# @return [String]
|
1190
1191
|
#
|
@@ -1359,7 +1360,7 @@ module Aws::Backup
|
|
1359
1360
|
# @return [Types::RecoveryPointCreator]
|
1360
1361
|
#
|
1361
1362
|
# @!attribute [rw] resource_type
|
1362
|
-
# The type of AWS resource to be backed
|
1363
|
+
# The type of AWS resource to be backed up; for example, an Amazon
|
1363
1364
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
1364
1365
|
# Database Service (Amazon RDS) database.
|
1365
1366
|
# @return [String]
|
@@ -1488,7 +1489,7 @@ module Aws::Backup
|
|
1488
1489
|
# }
|
1489
1490
|
#
|
1490
1491
|
# @!attribute [rw] copy_job_id
|
1491
|
-
# Uniquely identifies a
|
1492
|
+
# Uniquely identifies a copy job.
|
1492
1493
|
# @return [String]
|
1493
1494
|
#
|
1494
1495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJobInput AWS API Documentation
|
@@ -1716,6 +1717,24 @@ module Aws::Backup
|
|
1716
1717
|
include Aws::Structure
|
1717
1718
|
end
|
1718
1719
|
|
1720
|
+
# @api private
|
1721
|
+
#
|
1722
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettingsInput AWS API Documentation
|
1723
|
+
#
|
1724
|
+
class DescribeRegionSettingsInput < Aws::EmptyStructure; end
|
1725
|
+
|
1726
|
+
# @!attribute [rw] resource_type_opt_in_preference
|
1727
|
+
# Returns a list of all services along with the opt-in preferences in
|
1728
|
+
# the region.
|
1729
|
+
# @return [Hash<String,Boolean>]
|
1730
|
+
#
|
1731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettingsOutput AWS API Documentation
|
1732
|
+
#
|
1733
|
+
class DescribeRegionSettingsOutput < Struct.new(
|
1734
|
+
:resource_type_opt_in_preference)
|
1735
|
+
include Aws::Structure
|
1736
|
+
end
|
1737
|
+
|
1719
1738
|
# @note When making an API call, you may pass DescribeRestoreJobInput
|
1720
1739
|
# data as a hash:
|
1721
1740
|
#
|
@@ -2741,8 +2760,6 @@ module Aws::Backup
|
|
2741
2760
|
# @!attribute [rw] by_resource_type
|
2742
2761
|
# Returns only backup jobs for the specified resources:
|
2743
2762
|
#
|
2744
|
-
# * `DynamoDB` for Amazon DynamoDB
|
2745
|
-
#
|
2746
2763
|
# * `EBS` for Amazon Elastic Block Store
|
2747
2764
|
#
|
2748
2765
|
# * `EFS` for Amazon Elastic File System
|
@@ -2755,7 +2772,7 @@ module Aws::Backup
|
|
2755
2772
|
# @!attribute [rw] by_destination_vault_arn
|
2756
2773
|
# An Amazon Resource Name (ARN) that uniquely identifies a source
|
2757
2774
|
# backup vault to copy from; for example,
|
2758
|
-
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
|
2775
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
2759
2776
|
# @return [String]
|
2760
2777
|
#
|
2761
2778
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobsInput AWS API Documentation
|
@@ -3573,12 +3590,14 @@ module Aws::Backup
|
|
3573
3590
|
# @return [String]
|
3574
3591
|
#
|
3575
3592
|
# @!attribute [rw] start_window_minutes
|
3576
|
-
#
|
3593
|
+
# A value in minutes after a backup is scheduled before a job will be
|
3594
|
+
# canceled if it doesn't start successfully. This value is optional.
|
3577
3595
|
# @return [Integer]
|
3578
3596
|
#
|
3579
3597
|
# @!attribute [rw] complete_window_minutes
|
3580
|
-
#
|
3581
|
-
#
|
3598
|
+
# A value in minutes after a backup job is successfully started before
|
3599
|
+
# it must be completed or it will be canceled by AWS Backup. This
|
3600
|
+
# value is optional.
|
3582
3601
|
# @return [Integer]
|
3583
3602
|
#
|
3584
3603
|
# @!attribute [rw] lifecycle
|
@@ -3663,7 +3682,7 @@ module Aws::Backup
|
|
3663
3682
|
# The name of a logical source container where backups are stored.
|
3664
3683
|
# Backup vaults are identified by names that are unique to the account
|
3665
3684
|
# used to create them and the AWS Region where they are created. They
|
3666
|
-
# consist of lowercase letters, numbers, and hyphens.
|
3685
|
+
# consist of lowercase letters, numbers, and hyphens.
|
3667
3686
|
# @return [String]
|
3668
3687
|
#
|
3669
3688
|
# @!attribute [rw] destination_backup_vault_arn
|
@@ -3674,7 +3693,7 @@ module Aws::Backup
|
|
3674
3693
|
#
|
3675
3694
|
# @!attribute [rw] iam_role_arn
|
3676
3695
|
# Specifies the IAM role ARN used to copy the target recovery point;
|
3677
|
-
# for example, arn:aws:iam::123456789012:role/S3Access
|
3696
|
+
# for example, `arn:aws:iam::123456789012:role/S3Access`.
|
3678
3697
|
# @return [String]
|
3679
3698
|
#
|
3680
3699
|
# @!attribute [rw] idempotency_token
|
@@ -3708,14 +3727,14 @@ module Aws::Backup
|
|
3708
3727
|
end
|
3709
3728
|
|
3710
3729
|
# @!attribute [rw] copy_job_id
|
3711
|
-
# Uniquely identifies a
|
3730
|
+
# Uniquely identifies a copy job.
|
3712
3731
|
# @return [String]
|
3713
3732
|
#
|
3714
3733
|
# @!attribute [rw] creation_date
|
3715
|
-
# The date and time that a
|
3716
|
-
# Coordinated Universal Time (UTC). The value of CreationDate is
|
3734
|
+
# The date and time that a copy job is started, in Unix format and
|
3735
|
+
# Coordinated Universal Time (UTC). The value of `CreationDate` is
|
3717
3736
|
# accurate to milliseconds. For example, the value 1516925490.087
|
3718
|
-
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
3737
|
+
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
3719
3738
|
# @return [Time]
|
3720
3739
|
#
|
3721
3740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobOutput AWS API Documentation
|
@@ -3749,7 +3768,7 @@ module Aws::Backup
|
|
3749
3768
|
# resource name, required to restore a recovery point.
|
3750
3769
|
#
|
3751
3770
|
# You can get configuration metadata about a resource at the time it
|
3752
|
-
# was backed
|
3771
|
+
# was backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
3753
3772
|
# values in addition to those provided by
|
3754
3773
|
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
3755
3774
|
# resource. For example, you might need to provide a new resource name
|
@@ -4066,5 +4085,26 @@ module Aws::Backup
|
|
4066
4085
|
include Aws::Structure
|
4067
4086
|
end
|
4068
4087
|
|
4088
|
+
# @note When making an API call, you may pass UpdateRegionSettingsInput
|
4089
|
+
# data as a hash:
|
4090
|
+
#
|
4091
|
+
# {
|
4092
|
+
# resource_type_opt_in_preference: {
|
4093
|
+
# "ResourceType" => false,
|
4094
|
+
# },
|
4095
|
+
# }
|
4096
|
+
#
|
4097
|
+
# @!attribute [rw] resource_type_opt_in_preference
|
4098
|
+
# Updates the list of services along with the opt-in preferences for
|
4099
|
+
# the region.
|
4100
|
+
# @return [Hash<String,Boolean>]
|
4101
|
+
#
|
4102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettingsInput AWS API Documentation
|
4103
|
+
#
|
4104
|
+
class UpdateRegionSettingsInput < Struct.new(
|
4105
|
+
:resource_type_opt_in_preference)
|
4106
|
+
include Aws::Structure
|
4107
|
+
end
|
4108
|
+
|
4069
4109
|
end
|
4070
4110
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-backup
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.16.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.99.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.99.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
81
81
|
version: '0'
|
82
82
|
requirements: []
|
83
83
|
rubyforge_project:
|
84
|
-
rubygems_version: 2.
|
84
|
+
rubygems_version: 2.7.6.2
|
85
85
|
signing_key:
|
86
86
|
specification_version: 4
|
87
87
|
summary: AWS SDK for Ruby - AWS Backup
|