aws-sdk-efs 1.24.0 → 1.25.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: fbeda2dd0335afea17e75ddfd73af8d36519ea00
4
- data.tar.gz: a1fb190ec422ca905408aedc706fe0451715f3b7
3
+ metadata.gz: 6102c3ed35c6c5d155f166794b33b7b00640ae22
4
+ data.tar.gz: 053cd66fe9f4228a00cce84801a0a69d8f71a757
5
5
  SHA512:
6
- metadata.gz: c915c04c36c3bd3bd812f962604601ce45a2323ffd54b8356097fc17a7ffbf2dbcc7cffb0348345229d5391a22f98f42bb72fe5f3c0bdeaff2500805a401a5ee
7
- data.tar.gz: f920f1b44638f455b5bdf906facdf4fa87c2f2a73eded205c2b5ae7202c180984dc7d9ead448a19fcce9f4625cd36582e5ada8eba418f7f3f26f00ddeb8d7924
6
+ metadata.gz: 3cee14c7fecaeeaf4726509bddc9fe5431068111d6acec53bbfa7060349d6a4b81c688d63a7ece4e9d3dcd8b856e25cd44f20c07aac07ab9a29b9dea03ef3d72
7
+ data.tar.gz: b6fd827c8bc84b666664d705df8aa78c2644f786b7cb21e2dd9ff6ca85c313ccafce5ed375cdb117e3a8fac51025ba2b947cabc3aa97f4172d361767ad28a5fc
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-efs/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # efs = Aws::EFS::Client.new
28
+ # resp = efs.create_access_point(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Elastic File System all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Elastic File System 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::EFS::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Elastic File System API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-efs/customizations'
42
45
  # @service
43
46
  module Aws::EFS
44
47
 
45
- GEM_VERSION = '1.24.0'
48
+ GEM_VERSION = '1.25.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(:efs)
31
31
 
32
32
  module Aws::EFS
33
+ # An API client for EFS. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::EFS::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::EFS
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::EFS
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::EFS
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::EFS
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
  #
@@ -209,16 +260,16 @@ module Aws::EFS
209
260
  # requests through. Formatted like 'http://proxy.com:123'.
210
261
  #
211
262
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
263
+ # seconds to wait when opening a HTTP session before raising a
213
264
  # `Timeout::Error`.
214
265
  #
215
266
  # @option options [Integer] :http_read_timeout (60) The default
216
267
  # number of seconds to wait for response data. This value can
217
268
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
269
+ # per-request on the session yielded by {#session_for}.
219
270
  #
220
271
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
272
+ # seconds a connection is allowed to sit idle before it is
222
273
  # considered stale. Stale connections are closed and removed
223
274
  # from the pool before making a request.
224
275
  #
@@ -227,7 +278,7 @@ module Aws::EFS
227
278
  # request body. This option has no effect unless the request has
228
279
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
280
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
281
+ # request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
284
  # HTTP debug output will be sent to the `:logger`.
@@ -2017,7 +2068,7 @@ module Aws::EFS
2017
2068
  params: params,
2018
2069
  config: config)
2019
2070
  context[:gem_name] = 'aws-sdk-efs'
2020
- context[:gem_version] = '1.24.0'
2071
+ context[:gem_version] = '1.25.0'
2021
2072
  Seahorse::Client::Request.new(handlers, context)
2022
2073
  end
2023
2074
 
@@ -6,6 +6,54 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::EFS
9
+
10
+ # When EFS returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::EFS::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all EFS errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::EFS::Errors::ServiceError
18
+ # # rescues all EFS 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
+ # * {AccessPointAlreadyExists}
29
+ # * {AccessPointLimitExceeded}
30
+ # * {AccessPointNotFound}
31
+ # * {BadRequest}
32
+ # * {DependencyTimeout}
33
+ # * {FileSystemAlreadyExists}
34
+ # * {FileSystemInUse}
35
+ # * {FileSystemLimitExceeded}
36
+ # * {FileSystemNotFound}
37
+ # * {IncorrectFileSystemLifeCycleState}
38
+ # * {IncorrectMountTargetState}
39
+ # * {InsufficientThroughputCapacity}
40
+ # * {InternalServerError}
41
+ # * {InvalidPolicyException}
42
+ # * {IpAddressInUse}
43
+ # * {MountTargetConflict}
44
+ # * {MountTargetNotFound}
45
+ # * {NetworkInterfaceLimitExceeded}
46
+ # * {NoFreeAddressesInSubnet}
47
+ # * {PolicyNotFound}
48
+ # * {SecurityGroupLimitExceeded}
49
+ # * {SecurityGroupNotFound}
50
+ # * {SubnetNotFound}
51
+ # * {ThroughputLimitExceeded}
52
+ # * {TooManyRequests}
53
+ # * {UnsupportedAvailabilityZone}
54
+ #
55
+ # Additionally, error classes are dynamically generated for service errors based on the error code
56
+ # if they are not defined above.
9
57
  module Errors
10
58
 
11
59
  extend Aws::Errors::DynamicErrors
@@ -33,7 +81,6 @@ module Aws::EFS
33
81
  def access_point_id
34
82
  @data[:access_point_id]
35
83
  end
36
-
37
84
  end
38
85
 
39
86
  class AccessPointLimitExceeded < ServiceError
@@ -54,7 +101,6 @@ module Aws::EFS
54
101
  def message
55
102
  @message || @data[:message]
56
103
  end
57
-
58
104
  end
59
105
 
60
106
  class AccessPointNotFound < ServiceError
@@ -75,7 +121,6 @@ module Aws::EFS
75
121
  def message
76
122
  @message || @data[:message]
77
123
  end
78
-
79
124
  end
80
125
 
81
126
  class BadRequest < ServiceError
@@ -96,7 +141,6 @@ module Aws::EFS
96
141
  def message
97
142
  @message || @data[:message]
98
143
  end
99
-
100
144
  end
101
145
 
102
146
  class DependencyTimeout < ServiceError
@@ -117,7 +161,6 @@ module Aws::EFS
117
161
  def message
118
162
  @message || @data[:message]
119
163
  end
120
-
121
164
  end
122
165
 
123
166
  class FileSystemAlreadyExists < ServiceError
@@ -143,7 +186,6 @@ module Aws::EFS
143
186
  def file_system_id
144
187
  @data[:file_system_id]
145
188
  end
146
-
147
189
  end
148
190
 
149
191
  class FileSystemInUse < ServiceError
@@ -164,7 +206,6 @@ module Aws::EFS
164
206
  def message
165
207
  @message || @data[:message]
166
208
  end
167
-
168
209
  end
169
210
 
170
211
  class FileSystemLimitExceeded < ServiceError
@@ -185,7 +226,6 @@ module Aws::EFS
185
226
  def message
186
227
  @message || @data[:message]
187
228
  end
188
-
189
229
  end
190
230
 
191
231
  class FileSystemNotFound < ServiceError
@@ -206,7 +246,6 @@ module Aws::EFS
206
246
  def message
207
247
  @message || @data[:message]
208
248
  end
209
-
210
249
  end
211
250
 
212
251
  class IncorrectFileSystemLifeCycleState < ServiceError
@@ -227,7 +266,6 @@ module Aws::EFS
227
266
  def message
228
267
  @message || @data[:message]
229
268
  end
230
-
231
269
  end
232
270
 
233
271
  class IncorrectMountTargetState < ServiceError
@@ -248,7 +286,6 @@ module Aws::EFS
248
286
  def message
249
287
  @message || @data[:message]
250
288
  end
251
-
252
289
  end
253
290
 
254
291
  class InsufficientThroughputCapacity < ServiceError
@@ -269,7 +306,6 @@ module Aws::EFS
269
306
  def message
270
307
  @message || @data[:message]
271
308
  end
272
-
273
309
  end
274
310
 
275
311
  class InternalServerError < ServiceError
@@ -290,7 +326,6 @@ module Aws::EFS
290
326
  def message
291
327
  @message || @data[:message]
292
328
  end
293
-
294
329
  end
295
330
 
296
331
  class InvalidPolicyException < ServiceError
@@ -311,7 +346,6 @@ module Aws::EFS
311
346
  def message
312
347
  @message || @data[:message]
313
348
  end
314
-
315
349
  end
316
350
 
317
351
  class IpAddressInUse < ServiceError
@@ -332,7 +366,6 @@ module Aws::EFS
332
366
  def message
333
367
  @message || @data[:message]
334
368
  end
335
-
336
369
  end
337
370
 
338
371
  class MountTargetConflict < ServiceError
@@ -353,7 +386,6 @@ module Aws::EFS
353
386
  def message
354
387
  @message || @data[:message]
355
388
  end
356
-
357
389
  end
358
390
 
359
391
  class MountTargetNotFound < ServiceError
@@ -374,7 +406,6 @@ module Aws::EFS
374
406
  def message
375
407
  @message || @data[:message]
376
408
  end
377
-
378
409
  end
379
410
 
380
411
  class NetworkInterfaceLimitExceeded < ServiceError
@@ -395,7 +426,6 @@ module Aws::EFS
395
426
  def message
396
427
  @message || @data[:message]
397
428
  end
398
-
399
429
  end
400
430
 
401
431
  class NoFreeAddressesInSubnet < ServiceError
@@ -416,7 +446,6 @@ module Aws::EFS
416
446
  def message
417
447
  @message || @data[:message]
418
448
  end
419
-
420
449
  end
421
450
 
422
451
  class PolicyNotFound < ServiceError
@@ -437,7 +466,6 @@ module Aws::EFS
437
466
  def message
438
467
  @message || @data[:message]
439
468
  end
440
-
441
469
  end
442
470
 
443
471
  class SecurityGroupLimitExceeded < ServiceError
@@ -458,7 +486,6 @@ module Aws::EFS
458
486
  def message
459
487
  @message || @data[:message]
460
488
  end
461
-
462
489
  end
463
490
 
464
491
  class SecurityGroupNotFound < ServiceError
@@ -479,7 +506,6 @@ module Aws::EFS
479
506
  def message
480
507
  @message || @data[:message]
481
508
  end
482
-
483
509
  end
484
510
 
485
511
  class SubnetNotFound < ServiceError
@@ -500,7 +526,6 @@ module Aws::EFS
500
526
  def message
501
527
  @message || @data[:message]
502
528
  end
503
-
504
529
  end
505
530
 
506
531
  class ThroughputLimitExceeded < ServiceError
@@ -521,7 +546,6 @@ module Aws::EFS
521
546
  def message
522
547
  @message || @data[:message]
523
548
  end
524
-
525
549
  end
526
550
 
527
551
  class TooManyRequests < ServiceError
@@ -542,7 +566,6 @@ module Aws::EFS
542
566
  def message
543
567
  @message || @data[:message]
544
568
  end
545
-
546
569
  end
547
570
 
548
571
  class UnsupportedAvailabilityZone < ServiceError
@@ -563,7 +586,6 @@ module Aws::EFS
563
586
  def message
564
587
  @message || @data[:message]
565
588
  end
566
-
567
589
  end
568
590
 
569
591
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::EFS
9
+ # This class provides a resource oriented interface for EFS.
10
+ # To create a resource object:
11
+ # resource = Aws::EFS::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::EFS::Client.new(region: 'us-west-2')
15
+ # resource = Aws::EFS::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-efs
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.24.0
4
+ version: 1.25.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-01-13 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