aws-sdk-dlm 1.24.0 → 1.29.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: f6dab7438c342541c31a8cbb32e9573ef0f6976f
4
- data.tar.gz: 79c8a589f6eedf0e63f8350150295dfee3bc7a48
2
+ SHA256:
3
+ metadata.gz: 35f4253e55afde6f004d04906ed1cbeeeb6e0f77dd08282831e1d6ad0eecef4a
4
+ data.tar.gz: c150d423868a4e89891d1e4a3c376d8d15c7bc5ba526737a4535cd644a42fe6d
5
5
  SHA512:
6
- metadata.gz: 0de2f225e88d97dc38514be8e0189573c090caef2e275da2de0d4a2e31015a8740e1c83618265cedd8bdeaa1cf6f14c44e4a9d80e782296517ba19f21bc27420
7
- data.tar.gz: 808124add4342c3a78e693072d56437e810ed366009f2a4bb482af2683c1310b0b54e71578c33d5be568e458f108824d9c1542bb42256dcb9f2a12595b5869d9
6
+ metadata.gz: d1a6cafdf1d8fce069925874342ffd8046eb0065cf505413a08830ff51e39a0b1155be958cc8b65886e4ebb93c06f6b1074c0754445554a5a546b28a2eabcbf8
7
+ data.tar.gz: 454e2792ffd4324081f94786af1a1d9e00076396d4ae0f12ed5ee8a741ebd7be2dcc1470b2ccd78d111b675017b803137bee6d2b393dbb81d4fc17f09eedb7ae
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-dlm/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # dlm = Aws::DLM::Client.new
28
+ # resp = dlm.create_lifecycle_policy(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Data Lifecycle Manager all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Data Lifecycle Manager 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::DLM::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Data Lifecycle Manager API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-dlm/customizations'
42
45
  # @service
43
46
  module Aws::DLM
44
47
 
45
- GEM_VERSION = '1.24.0'
48
+ GEM_VERSION = '1.29.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:dlm)
31
31
 
32
32
  module Aws::DLM
33
+ # An API client for DLM. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::DLM::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::DLM
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::DLM
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::DLM
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::DLM
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::DLM
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::DLM
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::DLM
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -209,16 +264,15 @@ module Aws::DLM
209
264
  # requests through. Formatted like 'http://proxy.com:123'.
210
265
  #
211
266
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
267
+ # seconds to wait when opening a HTTP session before raising a
213
268
  # `Timeout::Error`.
214
269
  #
215
270
  # @option options [Integer] :http_read_timeout (60) The default
216
271
  # 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}.
272
+ # safely be set per-request on the session.
219
273
  #
220
274
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
275
+ # seconds a connection is allowed to sit idle before it is
222
276
  # considered stale. Stale connections are closed and removed
223
277
  # from the pool before making a request.
224
278
  #
@@ -227,7 +281,7 @@ module Aws::DLM
227
281
  # request body. This option has no effect unless the request has
228
282
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
283
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
284
+ # request on the session.
231
285
  #
232
286
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
287
  # HTTP debug output will be sent to the `:logger`.
@@ -310,9 +364,10 @@ module Aws::DLM
310
364
  # },
311
365
  # ],
312
366
  # create_rule: {
313
- # interval: 1, # required
314
- # interval_unit: "HOURS", # required, accepts HOURS
367
+ # interval: 1,
368
+ # interval_unit: "HOURS", # accepts HOURS
315
369
  # times: ["Time"],
370
+ # cron_expression: "CronExpression",
316
371
  # },
317
372
  # retain_rule: {
318
373
  # count: 1,
@@ -486,6 +541,7 @@ module Aws::DLM
486
541
  # resp.policy.policy_details.schedules[0].create_rule.interval_unit #=> String, one of "HOURS"
487
542
  # resp.policy.policy_details.schedules[0].create_rule.times #=> Array
488
543
  # resp.policy.policy_details.schedules[0].create_rule.times[0] #=> String
544
+ # resp.policy.policy_details.schedules[0].create_rule.cron_expression #=> String
489
545
  # resp.policy.policy_details.schedules[0].retain_rule.count #=> Integer
490
546
  # resp.policy.policy_details.schedules[0].retain_rule.interval #=> Integer
491
547
  # resp.policy.policy_details.schedules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
@@ -652,9 +708,10 @@ module Aws::DLM
652
708
  # },
653
709
  # ],
654
710
  # create_rule: {
655
- # interval: 1, # required
656
- # interval_unit: "HOURS", # required, accepts HOURS
711
+ # interval: 1,
712
+ # interval_unit: "HOURS", # accepts HOURS
657
713
  # times: ["Time"],
714
+ # cron_expression: "CronExpression",
658
715
  # },
659
716
  # retain_rule: {
660
717
  # count: 1,
@@ -709,7 +766,7 @@ module Aws::DLM
709
766
  params: params,
710
767
  config: config)
711
768
  context[:gem_name] = 'aws-sdk-dlm'
712
- context[:gem_version] = '1.24.0'
769
+ context[:gem_version] = '1.29.0'
713
770
  Seahorse::Client::Request.new(handlers, context)
714
771
  end
715
772
 
@@ -20,6 +20,7 @@ module Aws::DLM
20
20
  CreateLifecyclePolicyRequest = Shapes::StructureShape.new(name: 'CreateLifecyclePolicyRequest')
21
21
  CreateLifecyclePolicyResponse = Shapes::StructureShape.new(name: 'CreateLifecyclePolicyResponse')
22
22
  CreateRule = Shapes::StructureShape.new(name: 'CreateRule')
23
+ CronExpression = Shapes::StringShape.new(name: 'CronExpression')
23
24
  CrossRegionCopyRetainRule = Shapes::StructureShape.new(name: 'CrossRegionCopyRetainRule')
24
25
  CrossRegionCopyRule = Shapes::StructureShape.new(name: 'CrossRegionCopyRule')
25
26
  CrossRegionCopyRules = Shapes::ListShape.new(name: 'CrossRegionCopyRules')
@@ -100,9 +101,10 @@ module Aws::DLM
100
101
  CreateLifecyclePolicyResponse.add_member(:policy_id, Shapes::ShapeRef.new(shape: PolicyId, location_name: "PolicyId"))
101
102
  CreateLifecyclePolicyResponse.struct_class = Types::CreateLifecyclePolicyResponse
102
103
 
103
- CreateRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, required: true, location_name: "Interval"))
104
- CreateRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: IntervalUnitValues, required: true, location_name: "IntervalUnit"))
104
+ CreateRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, location_name: "Interval"))
105
+ CreateRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: IntervalUnitValues, location_name: "IntervalUnit"))
105
106
  CreateRule.add_member(:times, Shapes::ShapeRef.new(shape: TimesList, location_name: "Times"))
107
+ CreateRule.add_member(:cron_expression, Shapes::ShapeRef.new(shape: CronExpression, location_name: "CronExpression"))
106
108
  CreateRule.struct_class = Types::CreateRule
107
109
 
108
110
  CrossRegionCopyRetainRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, location_name: "Interval"))
@@ -6,6 +6,32 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::DLM
9
+
10
+ # When DLM returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::DLM::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all DLM errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::DLM::Errors::ServiceError
18
+ # # rescues all DLM 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
+ # * {InternalServerException}
29
+ # * {InvalidRequestException}
30
+ # * {LimitExceededException}
31
+ # * {ResourceNotFoundException}
32
+ #
33
+ # Additionally, error classes are dynamically generated for service errors based on the error code
34
+ # if they are not defined above.
9
35
  module Errors
10
36
 
11
37
  extend Aws::Errors::DynamicErrors
@@ -28,7 +54,6 @@ module Aws::DLM
28
54
  def code
29
55
  @code || @data[:code]
30
56
  end
31
-
32
57
  end
33
58
 
34
59
  class InvalidRequestException < ServiceError
@@ -59,7 +84,6 @@ module Aws::DLM
59
84
  def mutually_exclusive_parameters
60
85
  @data[:mutually_exclusive_parameters]
61
86
  end
62
-
63
87
  end
64
88
 
65
89
  class LimitExceededException < ServiceError
@@ -85,7 +109,6 @@ module Aws::DLM
85
109
  def resource_type
86
110
  @data[:resource_type]
87
111
  end
88
-
89
112
  end
90
113
 
91
114
  class ResourceNotFoundException < ServiceError
@@ -116,7 +139,6 @@ module Aws::DLM
116
139
  def resource_ids
117
140
  @data[:resource_ids]
118
141
  end
119
-
120
142
  end
121
143
 
122
144
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::DLM
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
@@ -41,9 +41,10 @@ module Aws::DLM
41
41
  # },
42
42
  # ],
43
43
  # create_rule: {
44
- # interval: 1, # required
45
- # interval_unit: "HOURS", # required, accepts HOURS
44
+ # interval: 1,
45
+ # interval_unit: "HOURS", # accepts HOURS
46
46
  # times: ["Time"],
47
+ # cron_expression: "CronExpression",
47
48
  # },
48
49
  # retain_rule: {
49
50
  # count: 1,
@@ -125,18 +126,22 @@ module Aws::DLM
125
126
 
126
127
  # Specifies when to create snapshots of EBS volumes.
127
128
  #
129
+ # You must specify either a Cron expression or an interval, interval
130
+ # unit, and start time. You cannot specify both.
131
+ #
128
132
  # @note When making an API call, you may pass CreateRule
129
133
  # data as a hash:
130
134
  #
131
135
  # {
132
- # interval: 1, # required
133
- # interval_unit: "HOURS", # required, accepts HOURS
136
+ # interval: 1,
137
+ # interval_unit: "HOURS", # accepts HOURS
134
138
  # times: ["Time"],
139
+ # cron_expression: "CronExpression",
135
140
  # }
136
141
  #
137
142
  # @!attribute [rw] interval
138
- # The interval between snapshots. The supported values are 2, 3, 4, 6,
139
- # 8, 12, and 24.
143
+ # The interval between snapshots. The supported values are 1, 2, 3, 4,
144
+ # 6, 8, 12, and 24.
140
145
  # @return [Integer]
141
146
  #
142
147
  # @!attribute [rw] interval_unit
@@ -148,15 +153,27 @@ module Aws::DLM
148
153
  # hh:mm.
149
154
  #
150
155
  # The operation occurs within a one-hour window following the
151
- # specified time.
156
+ # specified time. If you do not specify a time, Amazon DLM selects a
157
+ # time within the next 24 hours.
152
158
  # @return [Array<String>]
153
159
  #
160
+ # @!attribute [rw] cron_expression
161
+ # The schedule, as a Cron expression. The schedule interval must be
162
+ # between 1 hour and 1 year. For more information, see [Cron
163
+ # expressions][1] in the *Amazon CloudWatch User Guide*.
164
+ #
165
+ #
166
+ #
167
+ # [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
168
+ # @return [String]
169
+ #
154
170
  # @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateRule AWS API Documentation
155
171
  #
156
172
  class CreateRule < Struct.new(
157
173
  :interval,
158
174
  :interval_unit,
159
- :times)
175
+ :times,
176
+ :cron_expression)
160
177
  include Aws::Structure
161
178
  end
162
179
 
@@ -631,9 +648,10 @@ module Aws::DLM
631
648
  # },
632
649
  # ],
633
650
  # create_rule: {
634
- # interval: 1, # required
635
- # interval_unit: "HOURS", # required, accepts HOURS
651
+ # interval: 1,
652
+ # interval_unit: "HOURS", # accepts HOURS
636
653
  # times: ["Time"],
654
+ # cron_expression: "CronExpression",
637
655
  # },
638
656
  # retain_rule: {
639
657
  # count: 1,
@@ -671,7 +689,9 @@ module Aws::DLM
671
689
  # @return [String]
672
690
  #
673
691
  # @!attribute [rw] resource_types
674
- # The resource type.
692
+ # The resource type. Use VOLUME to create snapshots of individual
693
+ # volumes or use INSTANCE to create multi-volume snapshots from the
694
+ # volumes for an instance.
675
695
  # @return [Array<String>]
676
696
  #
677
697
  # @!attribute [rw] target_tags
@@ -779,9 +799,10 @@ module Aws::DLM
779
799
  # },
780
800
  # ],
781
801
  # create_rule: {
782
- # interval: 1, # required
783
- # interval_unit: "HOURS", # required, accepts HOURS
802
+ # interval: 1,
803
+ # interval_unit: "HOURS", # accepts HOURS
784
804
  # times: ["Time"],
805
+ # cron_expression: "CronExpression",
785
806
  # },
786
807
  # retain_rule: {
787
808
  # count: 1,
@@ -978,9 +999,10 @@ module Aws::DLM
978
999
  # },
979
1000
  # ],
980
1001
  # create_rule: {
981
- # interval: 1, # required
982
- # interval_unit: "HOURS", # required, accepts HOURS
1002
+ # interval: 1,
1003
+ # interval_unit: "HOURS", # accepts HOURS
983
1004
  # times: ["Time"],
1005
+ # cron_expression: "CronExpression",
984
1006
  # },
985
1007
  # retain_rule: {
986
1008
  # count: 1,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-dlm
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.24.0
4
+ version: 1.29.0
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-02-05 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -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.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon DLM