aws-sdk-fsx 1.15.0 → 1.16.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
2
  SHA1:
3
- metadata.gz: 2d65127593453505228eb4ab9b59682baa219fed
4
- data.tar.gz: 2f87a84ed601fbd98f151fa7722a171a0ced2058
3
+ metadata.gz: 3ddf9ce069f00079956a2c42c0a9f6c428f9f74d
4
+ data.tar.gz: 94682f71561a6814b0f7d080c6fa92f1c958e835
5
5
  SHA512:
6
- metadata.gz: 04bc0f9a48aabc9f7e246ef86604d8cd4ffbb1b8209bf85e8e6371da38a8f226be6aa60da20e80cae3a5de7b18102fb5c35b0f4d605567dd8b9ff9164452dffe
7
- data.tar.gz: 1d4d4c2de67e5dbc7415a077fc548b043ccd73d42676814aa6896eecfbde16bd7c4c64182df2f983fa4e041266e34a5de56fcb1f6a78c5498d563e9dbd86a5fe
6
+ metadata.gz: ef34eaf2bba39cd04d13f4907c1f926a45c723288e5a49d37dce78dd8b2c4568e2018e22e142b7af7f3357552f96f4906fe608fe16615d53635c695b055b8dfb
7
+ data.tar.gz: 7ab1516ec6d03c546cd18062702a7e2e0e135270aa935cdd84cd5f11b8227e62617cfdbd4b735a801f20a12a940fdb71eabdfca71362a7ac77d8e0f80485754c
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-fsx/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # f_sx = Aws::FSx::Client.new
28
+ # resp = f_sx.cancel_data_repository_task(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon FSx all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon FSx 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::FSx::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon FSx API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-fsx/customizations'
42
45
  # @service
43
46
  module Aws::FSx
44
47
 
45
- GEM_VERSION = '1.15.0'
48
+ GEM_VERSION = '1.16.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:fsx)
31
31
 
32
32
  module Aws::FSx
33
+ # An API client for FSx. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::FSx::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
@@ -108,6 +120,12 @@ module Aws::FSx
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::FSx
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.
@@ -166,15 +188,29 @@ module Aws::FSx
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,26 @@ module Aws::FSx
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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -219,16 +270,16 @@ module Aws::FSx
219
270
  # requests through. Formatted like 'http://proxy.com:123'.
220
271
  #
221
272
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
273
+ # seconds to wait when opening a HTTP session before raising a
223
274
  # `Timeout::Error`.
224
275
  #
225
276
  # @option options [Integer] :http_read_timeout (60) The default
226
277
  # number of seconds to wait for response data. This value can
227
278
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
279
+ # per-request on the session yielded by {#session_for}.
229
280
  #
230
281
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
282
+ # seconds a connection is allowed to sit idle before it is
232
283
  # considered stale. Stale connections are closed and removed
233
284
  # from the pool before making a request.
234
285
  #
@@ -237,7 +288,7 @@ module Aws::FSx
237
288
  # request body. This option has no effect unless the request has
238
289
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
290
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
291
+ # request on the session yielded by {#session_for}.
241
292
  #
242
293
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
294
  # HTTP debug output will be sent to the `:logger`.
@@ -1979,7 +2030,7 @@ module Aws::FSx
1979
2030
  params: params,
1980
2031
  config: config)
1981
2032
  context[:gem_name] = 'aws-sdk-fsx'
1982
- context[:gem_version] = '1.15.0'
2033
+ context[:gem_version] = '1.16.0'
1983
2034
  Seahorse::Client::Request.new(handlers, context)
1984
2035
  end
1985
2036
 
@@ -6,6 +6,49 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::FSx
9
+
10
+ # When FSx returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::FSx::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all FSx errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::FSx::Errors::ServiceError
18
+ # # rescues all FSx 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
+ # * {ActiveDirectoryError}
29
+ # * {BackupInProgress}
30
+ # * {BackupNotFound}
31
+ # * {BackupRestoring}
32
+ # * {BadRequest}
33
+ # * {DataRepositoryTaskEnded}
34
+ # * {DataRepositoryTaskExecuting}
35
+ # * {DataRepositoryTaskNotFound}
36
+ # * {FileSystemNotFound}
37
+ # * {IncompatibleParameterError}
38
+ # * {InternalServerError}
39
+ # * {InvalidExportPath}
40
+ # * {InvalidImportPath}
41
+ # * {InvalidNetworkSettings}
42
+ # * {InvalidPerUnitStorageThroughput}
43
+ # * {MissingFileSystemConfiguration}
44
+ # * {NotServiceResourceError}
45
+ # * {ResourceDoesNotSupportTagging}
46
+ # * {ResourceNotFound}
47
+ # * {ServiceLimitExceeded}
48
+ # * {UnsupportedOperation}
49
+ #
50
+ # Additionally, error classes are dynamically generated for service errors based on the error code
51
+ # if they are not defined above.
9
52
  module Errors
10
53
 
11
54
  extend Aws::Errors::DynamicErrors
@@ -33,7 +76,6 @@ module Aws::FSx
33
76
  def message
34
77
  @message || @data[:message]
35
78
  end
36
-
37
79
  end
38
80
 
39
81
  class BackupInProgress < ServiceError
@@ -49,7 +91,6 @@ module Aws::FSx
49
91
  def message
50
92
  @message || @data[:message]
51
93
  end
52
-
53
94
  end
54
95
 
55
96
  class BackupNotFound < ServiceError
@@ -65,7 +106,6 @@ module Aws::FSx
65
106
  def message
66
107
  @message || @data[:message]
67
108
  end
68
-
69
109
  end
70
110
 
71
111
  class BackupRestoring < ServiceError
@@ -86,7 +126,6 @@ module Aws::FSx
86
126
  def file_system_id
87
127
  @data[:file_system_id]
88
128
  end
89
-
90
129
  end
91
130
 
92
131
  class BadRequest < ServiceError
@@ -102,7 +141,6 @@ module Aws::FSx
102
141
  def message
103
142
  @message || @data[:message]
104
143
  end
105
-
106
144
  end
107
145
 
108
146
  class DataRepositoryTaskEnded < ServiceError
@@ -118,7 +156,6 @@ module Aws::FSx
118
156
  def message
119
157
  @message || @data[:message]
120
158
  end
121
-
122
159
  end
123
160
 
124
161
  class DataRepositoryTaskExecuting < ServiceError
@@ -134,7 +171,6 @@ module Aws::FSx
134
171
  def message
135
172
  @message || @data[:message]
136
173
  end
137
-
138
174
  end
139
175
 
140
176
  class DataRepositoryTaskNotFound < ServiceError
@@ -150,7 +186,6 @@ module Aws::FSx
150
186
  def message
151
187
  @message || @data[:message]
152
188
  end
153
-
154
189
  end
155
190
 
156
191
  class FileSystemNotFound < ServiceError
@@ -166,7 +201,6 @@ module Aws::FSx
166
201
  def message
167
202
  @message || @data[:message]
168
203
  end
169
-
170
204
  end
171
205
 
172
206
  class IncompatibleParameterError < ServiceError
@@ -187,7 +221,6 @@ module Aws::FSx
187
221
  def message
188
222
  @message || @data[:message]
189
223
  end
190
-
191
224
  end
192
225
 
193
226
  class InternalServerError < ServiceError
@@ -203,7 +236,6 @@ module Aws::FSx
203
236
  def message
204
237
  @message || @data[:message]
205
238
  end
206
-
207
239
  end
208
240
 
209
241
  class InvalidExportPath < ServiceError
@@ -219,7 +251,6 @@ module Aws::FSx
219
251
  def message
220
252
  @message || @data[:message]
221
253
  end
222
-
223
254
  end
224
255
 
225
256
  class InvalidImportPath < ServiceError
@@ -235,7 +266,6 @@ module Aws::FSx
235
266
  def message
236
267
  @message || @data[:message]
237
268
  end
238
-
239
269
  end
240
270
 
241
271
  class InvalidNetworkSettings < ServiceError
@@ -261,7 +291,6 @@ module Aws::FSx
261
291
  def invalid_security_group_id
262
292
  @data[:invalid_security_group_id]
263
293
  end
264
-
265
294
  end
266
295
 
267
296
  class InvalidPerUnitStorageThroughput < ServiceError
@@ -277,7 +306,6 @@ module Aws::FSx
277
306
  def message
278
307
  @message || @data[:message]
279
308
  end
280
-
281
309
  end
282
310
 
283
311
  class MissingFileSystemConfiguration < ServiceError
@@ -293,7 +321,6 @@ module Aws::FSx
293
321
  def message
294
322
  @message || @data[:message]
295
323
  end
296
-
297
324
  end
298
325
 
299
326
  class NotServiceResourceError < ServiceError
@@ -314,7 +341,6 @@ module Aws::FSx
314
341
  def message
315
342
  @message || @data[:message]
316
343
  end
317
-
318
344
  end
319
345
 
320
346
  class ResourceDoesNotSupportTagging < ServiceError
@@ -335,7 +361,6 @@ module Aws::FSx
335
361
  def message
336
362
  @message || @data[:message]
337
363
  end
338
-
339
364
  end
340
365
 
341
366
  class ResourceNotFound < ServiceError
@@ -356,7 +381,6 @@ module Aws::FSx
356
381
  def message
357
382
  @message || @data[:message]
358
383
  end
359
-
360
384
  end
361
385
 
362
386
  class ServiceLimitExceeded < ServiceError
@@ -377,7 +401,6 @@ module Aws::FSx
377
401
  def message
378
402
  @message || @data[:message]
379
403
  end
380
-
381
404
  end
382
405
 
383
406
  class UnsupportedOperation < ServiceError
@@ -393,7 +416,6 @@ module Aws::FSx
393
416
  def message
394
417
  @message || @data[:message]
395
418
  end
396
-
397
419
  end
398
420
 
399
421
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::FSx
9
+ # This class provides a resource oriented interface for FSx.
10
+ # To create a resource object:
11
+ # resource = Aws::FSx::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::FSx::Client.new(region: 'us-west-2')
15
+ # resource = Aws::FSx::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-fsx
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.15.0
4
+ version: 1.16.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-24 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core