aws-sdk-efs 1.24.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fbeda2dd0335afea17e75ddfd73af8d36519ea00
-  data.tar.gz: a1fb190ec422ca905408aedc706fe0451715f3b7
+SHA256:
+  metadata.gz: 90bbb01035dff2e6bcce551e3f397092b28e59fecf9fd84a922bbb45ce8eeba0
+  data.tar.gz: 8d43afc83f3564a23fd1e904218f7b39eb3581807a09b9b7296754a3902d4b59
 SHA512:
-  metadata.gz: c915c04c36c3bd3bd812f962604601ce45a2323ffd54b8356097fc17a7ffbf2dbcc7cffb0348345229d5391a22f98f42bb72fe5f3c0bdeaff2500805a401a5ee
-  data.tar.gz: f920f1b44638f455b5bdf906facdf4fa87c2f2a73eded205c2b5ae7202c180984dc7d9ead448a19fcce9f4625cd36582e5ada8eba418f7f3f26f00ddeb8d7924
+  metadata.gz: e0f464cdae1b0f54753872aa0411699ccff91d0b5c89d1a6f9e462e70a37bc9aabe84588559646ee855c5e156bbac4454c67c40608bdea543e0015d13f306249
+  data.tar.gz: a67405639825f5dd17fbe6a90db76ab6094a7287b48db0b2c4aa1ae30c5dfbcd31cd7322c97a8206ca39739f4a29888b30a75621f9c96043d7592ed94d463d18

data/lib/aws-sdk-efs.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-efs/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     efs = Aws::EFS::Client.new
+#     resp = efs.create_access_point(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from Amazon Elastic File System all
-# extend {Errors::ServiceError}.
+# Errors returned from Amazon Elastic File System are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::EFS::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all Amazon Elastic File System API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-efs/customizations'
 # @service
 module Aws::EFS
 
-  GEM_VERSION = '1.24.0'
+  GEM_VERSION = '1.29.0'
 
 end

data/lib/aws-sdk-efs/client.rb

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:efs)
 
 module Aws::EFS
+  # An API client for EFS.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::EFS::Client.new(
+  #       region: region_name,
+  #       credentials: credentials,
+  #       # ...
+  #     )
+  #
+  # For details on configuring region and credentials see
+  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+  #
+  # See {#initialize} for a full list of supported configuration options.
   class Client < Seahorse::Client::Base
 
     include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::EFS
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
     #     used to determine the service `:endpoint`. When not passed,
-    #     a default `:region` is search for in the following locations:
+    #     a default `:region` is searched for in the following locations:
     #
     #     * `Aws.config[:region]`
     #     * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::EFS
     #     When set to `true`, a thread polling for endpoints will be running in
     #     the background every 60 secs (default). Defaults to `false`.
     #
+    #   @option options [Boolean] :adaptive_retry_wait_to_fill (true)
+    #     Used only in `adaptive` retry mode.  When true, the request will sleep
+    #     until there is sufficent client side capacity to retry the request.
+    #     When false, the request will raise a `RetryCapacityNotAvailableError` and will
+    #     not retry instead of sleeping.
+    #
     #   @option options [Boolean] :client_side_monitoring (false)
     #     When `true`, client-side metrics will be collected for all API requests from
     #     this client.
@@ -132,6 +150,10 @@ module Aws::EFS
     #     When `true`, an attempt is made to coerce request parameters into
     #     the required types.
     #
+    #   @option options [Boolean] :correct_clock_skew (true)
+    #     Used only in `standard` and adaptive retry modes. Specifies whether to apply
+    #     a clock skew correction and retry requests with skewed client clocks.
+    #
     #   @option options [Boolean] :disable_host_prefix_injection (false)
     #     Set to true to disable SDK automatically adding host prefix
     #     to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::EFS
     #   @option options [String] :endpoint
     #     The client endpoint is normally constructed from the `:region`
     #     option. You should only configure an `:endpoint` when connecting
-    #     to test endpoints. This should be avalid HTTP(S) URI.
+    #     to test endpoints. This should be a valid HTTP(S) URI.
     #
     #   @option options [Integer] :endpoint_cache_max_entries (1000)
     #     Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::EFS
     #     requests fetching endpoints information. Defaults to 60 sec.
     #
     #   @option options [Boolean] :endpoint_discovery (false)
-    #     When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
+    #     When set to `true`, endpoint discovery will be enabled for operations when available.
     #
     #   @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
     #     The log formatter.
@@ -166,15 +188,29 @@ module Aws::EFS
     #     The Logger instance to send log messages to.  If this option
     #     is not set, logging will be disabled.
     #
+    #   @option options [Integer] :max_attempts (3)
+    #     An integer representing the maximum number attempts that will be made for
+    #     a single request, including the initial attempt.  For example,
+    #     setting this value to 5 will result in a request being retried up to
+    #     4 times. Used in `standard` and `adaptive` retry modes.
+    #
     #   @option options [String] :profile ("default")
     #     Used when loading credentials from the shared credentials file
     #     at HOME/.aws/credentials.  When not specified, 'default' is used.
     #
+    #   @option options [Proc] :retry_backoff
+    #     A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+    #     This option is only used in the `legacy` retry mode.
+    #
     #   @option options [Float] :retry_base_delay (0.3)
-    #     The base delay in seconds used by the default backoff function.
+    #     The base delay in seconds used by the default backoff function. This option
+    #     is only used in the `legacy` retry mode.
     #
     #   @option options [Symbol] :retry_jitter (:none)
-    #     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.
+    #     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. This option is only used
+    #     in the `legacy` retry mode.
     #
     #     @see https://www.awsarchitectureblog.com/2015/03/backoff.html
     #
@@ -182,11 +218,30 @@ module Aws::EFS
     #     The maximum number of times to retry failed requests.  Only
     #     ~ 500 level server errors and certain ~ 400 level client errors
     #     are retried.  Generally, these are throttling errors, data
-    #     checksum errors, networking errors, timeout errors and auth
-    #     errors from expired credentials.
+    #     checksum errors, networking errors, timeout errors, auth errors,
+    #     endpoint discovery, and errors from expired credentials.
+    #     This option is only used in the `legacy` retry mode.
     #
     #   @option options [Integer] :retry_max_delay (0)
-    #     The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+    #     The maximum number of seconds to delay between retries (0 for no limit)
+    #     used by the default backoff function. This option is only used in the
+    #     `legacy` retry mode.
+    #
+    #   @option options [String] :retry_mode ("legacy")
+    #     Specifies which retry algorithm to use. Values are:
+    #
+    #     * `legacy` - The pre-existing retry behavior.  This is default value if
+    #       no retry mode is provided.
+    #
+    #     * `standard` - A standardized set of retry rules across the AWS SDKs.
+    #       This includes support for retry quotas, which limit the number of
+    #       unsuccessful retries a client can make.
+    #
+    #     * `adaptive` - An experimental retry mode that includes all the
+    #       functionality of `standard` mode along with automatic client side
+    #       throttling.  This is a provisional mode that may change behavior
+    #       in the future.
+    #
     #
     #   @option options [String] :secret_access_key
     #
@@ -209,16 +264,15 @@ module Aws::EFS
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
     #   @option options [Float] :http_open_timeout (15) The number of
-    #     seconds to wait when opening a HTTP session before rasing a
+    #     seconds to wait when opening a HTTP session before raising a
     #     `Timeout::Error`.
     #
     #   @option options [Integer] :http_read_timeout (60) The default
     #     number of seconds to wait for response data.  This value can
-    #     safely be set
-    #     per-request on the session yeidled by {#session_for}.
+    #     safely be set per-request on the session.
     #
     #   @option options [Float] :http_idle_timeout (5) The number of
-    #     seconds a connection is allowed to sit idble before it is
+    #     seconds a connection is allowed to sit idle before it is
     #     considered stale.  Stale connections are closed and removed
     #     from the pool before making a request.
     #
@@ -227,7 +281,7 @@ module Aws::EFS
     #     request body.  This option has no effect unless the request has
     #     "Expect" header set to "100-continue".  Defaults to `nil` which
     #     disables this behaviour.  This value can safely be set per
-    #     request on the session yeidled by {#session_for}.
+    #     request on the session.
     #
     #   @option options [Boolean] :http_wire_trace (false) When `true`,
     #     HTTP debug output will be sent to the `:logger`.
@@ -474,6 +528,9 @@ module Aws::EFS
     #   If `KmsKeyId` is specified, the CreateFileSystemRequest$Encrypted
     #   parameter must be set to true.
     #
+    #   EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with
+    #   EFS file systems.
+    #
     # @option params [String] :throughput_mode
     #   The throughput mode for the file system to be created. There are two
     #   throughput modes to choose from for your file system: `bursting` and
@@ -1108,6 +1165,8 @@ module Aws::EFS
     #   * {Types::DescribeAccessPointsResponse#access_points #access_points} => Array&lt;Types::AccessPointDescription&gt;
     #   * {Types::DescribeAccessPointsResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_access_points({
@@ -1236,6 +1295,8 @@ module Aws::EFS
     #   * {Types::DescribeFileSystemsResponse#file_systems #file_systems} => Array&lt;Types::FileSystemDescription&gt;
     #   * {Types::DescribeFileSystemsResponse#next_marker #next_marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To describe an EFS file system
     #
@@ -1555,6 +1616,8 @@ module Aws::EFS
     #   * {Types::DescribeTagsResponse#tags #tags} => Array&lt;Types::Tag&gt;
     #   * {Types::DescribeTagsResponse#next_marker #next_marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     #
     # @example Example: To describe the tags for a file system
     #
@@ -1623,6 +1686,8 @@ module Aws::EFS
     #   * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
     #   * {Types::ListTagsForResourceResponse#next_token #next_token} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.list_tags_for_resource({
@@ -1707,15 +1772,14 @@ module Aws::EFS
     # system policy, which can be the default policy or an explicit policy
     # set or updated using this API operation. When an explicit policy is
     # set, it overrides the default policy. For more information about the
-    # default file system policy, see [Using Resource-based Policies with
-    # EFS][1].
+    # default file system policy, see [Default EFS File System Policy][1].
     #
     # This operation requires permissions for the
     # `elasticfilesystem:PutFileSystemPolicy` action.
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html
+    # [1]: https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy
     #
     # @option params [required, String] :file_system_id
     #   The ID of the EFS file system that you want to create or update the
@@ -1906,7 +1970,7 @@ module Aws::EFS
     # @option params [required, String] :resource_id
     #   Specifies the EFS resource that you want to remove tags from.
     #
-    # @option params [Array<String>] :tag_keys
+    # @option params [required, Array<String>] :tag_keys
     #   The keys of the key:value tag pairs that you want to remove from the
     #   specified EFS resource.
     #
@@ -1916,7 +1980,7 @@ module Aws::EFS
     #
     #   resp = client.untag_resource({
     #     resource_id: "ResourceId", # required
-    #     tag_keys: ["TagKey"],
+    #     tag_keys: ["TagKey"], # required
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/elasticfilesystem-2015-02-01/UntagResource AWS API Documentation
@@ -2017,7 +2081,7 @@ module Aws::EFS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-efs'
-      context[:gem_version] = '1.24.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-efs/client_api.rb

@@ -447,7 +447,7 @@ module Aws::EFS
     UnsupportedAvailabilityZone.struct_class = Types::UnsupportedAvailabilityZone
 
     UntagResourceRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location: "uri", location_name: "ResourceId"))
-    UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeys, location_name: "TagKeys"))
+    UntagResourceRequest.add_member(:tag_keys, Shapes::ShapeRef.new(shape: TagKeys, required: true, location: "querystring", location_name: "tagKeys"))
     UntagResourceRequest.struct_class = Types::UntagResourceRequest
 
     UpdateFileSystemRequest.add_member(:file_system_id, Shapes::ShapeRef.new(shape: FileSystemId, required: true, location: "uri", location_name: "FileSystemId"))

data/lib/aws-sdk-efs/errors.rb

@@ -6,6 +6,54 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::EFS
+
+  # When EFS returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::EFS::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all EFS errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::EFS::Errors::ServiceError
+  #       # rescues all EFS API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {AccessPointAlreadyExists}
+  # * {AccessPointLimitExceeded}
+  # * {AccessPointNotFound}
+  # * {BadRequest}
+  # * {DependencyTimeout}
+  # * {FileSystemAlreadyExists}
+  # * {FileSystemInUse}
+  # * {FileSystemLimitExceeded}
+  # * {FileSystemNotFound}
+  # * {IncorrectFileSystemLifeCycleState}
+  # * {IncorrectMountTargetState}
+  # * {InsufficientThroughputCapacity}
+  # * {InternalServerError}
+  # * {InvalidPolicyException}
+  # * {IpAddressInUse}
+  # * {MountTargetConflict}
+  # * {MountTargetNotFound}
+  # * {NetworkInterfaceLimitExceeded}
+  # * {NoFreeAddressesInSubnet}
+  # * {PolicyNotFound}
+  # * {SecurityGroupLimitExceeded}
+  # * {SecurityGroupNotFound}
+  # * {SubnetNotFound}
+  # * {ThroughputLimitExceeded}
+  # * {TooManyRequests}
+  # * {UnsupportedAvailabilityZone}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -33,7 +81,6 @@ module Aws::EFS
       def access_point_id
         @data[:access_point_id]
       end
-
     end
 
     class AccessPointLimitExceeded < ServiceError
@@ -54,7 +101,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class AccessPointNotFound < ServiceError
@@ -75,7 +121,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class BadRequest < ServiceError
@@ -96,7 +141,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class DependencyTimeout < ServiceError
@@ -117,7 +161,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class FileSystemAlreadyExists < ServiceError
@@ -143,7 +186,6 @@ module Aws::EFS
       def file_system_id
         @data[:file_system_id]
       end
-
     end
 
     class FileSystemInUse < ServiceError
@@ -164,7 +206,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class FileSystemLimitExceeded < ServiceError
@@ -185,7 +226,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class FileSystemNotFound < ServiceError
@@ -206,7 +246,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class IncorrectFileSystemLifeCycleState < ServiceError
@@ -227,7 +266,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class IncorrectMountTargetState < ServiceError
@@ -248,7 +286,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InsufficientThroughputCapacity < ServiceError
@@ -269,7 +306,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServerError < ServiceError
@@ -290,7 +326,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidPolicyException < ServiceError
@@ -311,7 +346,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class IpAddressInUse < ServiceError
@@ -332,7 +366,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class MountTargetConflict < ServiceError
@@ -353,7 +386,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class MountTargetNotFound < ServiceError
@@ -374,7 +406,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class NetworkInterfaceLimitExceeded < ServiceError
@@ -395,7 +426,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class NoFreeAddressesInSubnet < ServiceError
@@ -416,7 +446,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class PolicyNotFound < ServiceError
@@ -437,7 +466,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class SecurityGroupLimitExceeded < ServiceError
@@ -458,7 +486,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class SecurityGroupNotFound < ServiceError
@@ -479,7 +506,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class SubnetNotFound < ServiceError
@@ -500,7 +526,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThroughputLimitExceeded < ServiceError
@@ -521,7 +546,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyRequests < ServiceError
@@ -542,7 +566,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedAvailabilityZone < ServiceError
@@ -563,7 +586,6 @@ module Aws::EFS
       def message
         @message || @data[:message]
       end
-
     end
 
   end

data/lib/aws-sdk-efs/resource.rb

@@ -6,6 +6,7 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::EFS
+
   class Resource
 
     # @param options ({})

data/lib/aws-sdk-efs/types.rb

@@ -283,6 +283,9 @@ module Aws::EFS
     #
     #   If `KmsKeyId` is specified, the CreateFileSystemRequest$Encrypted
     #   parameter must be set to true.
+    #
+    #   EFS accepts only symmetric CMKs. You cannot use asymmetric CMKs with
+    #   EFS file systems.
     #   @return [String]
     #
     # @!attribute [rw] throughput_mode
@@ -1838,7 +1841,7 @@ module Aws::EFS
     #
     #       {
     #         resource_id: "ResourceId", # required
-    #         tag_keys: ["TagKey"],
+    #         tag_keys: ["TagKey"], # required
     #       }
     #
     # @!attribute [rw] resource_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-efs
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.29.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-13 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - EFS