aws-sdk-secretsmanager 1.31.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2400e7003ec12c2623801bc95dcaaa6767148433
-  data.tar.gz: dc96821b39e06500b48d3c8a6db1eff8fac2b755
+SHA256:
+  metadata.gz: 89dc81a4d48b5e1bb8a41414db6aafb4e565ad950d51ab257b73e24dedcb8493
+  data.tar.gz: 0b0e04fff3e2343bd7046809efcff96f17bae2dfc4eb307bf766a76457b7033d
 SHA512:
-  metadata.gz: 0ac329a831934d6645d636a5079fb4cf818dfe7385809290348c4d82c98d74a771b14818763f3bf6127473dabcfdb188753253ee55a06edf69d41aeb305d8c42
-  data.tar.gz: ec4c716b9a08b9215385bc69f7fd7ed2d2a931e113d90e3bfa55c9491bba8ad58faee5c4fd5b73c4b2e017f929e8e4a53a69549bb53e49fa199118de360af1a2
+  metadata.gz: 3d7f401317a50c0a8b442ea38ef7896fc1418844d906ad49b48e91616e3918f18db165a0ec5bbeafff1659d0400b490f4ac458db63ac6904ae900c9e3817aece
+  data.tar.gz: 9fa672d95620e8f7ea140b78f879a398bc495d9a01322ccf6093a77615073904abf071212a24e174d0cde32c1b2b9c77a9a8b35146bce52002ee7052616c881a

data/lib/aws-sdk-secretsmanager.rb

@@ -24,17 +24,20 @@ require_relative 'aws-sdk-secretsmanager/customizations'
 # methods each accept a hash of request parameters and return a response
 # structure.
 #
+#     secrets_manager = Aws::SecretsManager::Client.new
+#     resp = secrets_manager.cancel_rotate_secret(params)
+#
 # See {Client} for more information.
 #
 # # Errors
 #
-# Errors returned from AWS Secrets Manager all
-# extend {Errors::ServiceError}.
+# Errors returned from AWS Secrets Manager are defined in the
+# {Errors} module and all extend {Errors::ServiceError}.
 #
 #     begin
 #       # do stuff
 #     rescue Aws::SecretsManager::Errors::ServiceError
-#       # rescues all service API errors
+#       # rescues all AWS Secrets Manager API errors
 #     end
 #
 # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-secretsmanager/customizations'
 # @service
 module Aws::SecretsManager
 
-  GEM_VERSION = '1.31.0'
+  GEM_VERSION = '1.36.0'
 
 end

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:secretsmanager)
 
 module Aws::SecretsManager
+  # An API client for SecretsManager.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::SecretsManager::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::SecretsManager
     #   @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::SecretsManager
     #     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::SecretsManager
     #     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::SecretsManager
     #   @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::SecretsManager
     #     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::SecretsManager
     #     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::SecretsManager
     #     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
     #
@@ -219,16 +274,15 @@ module Aws::SecretsManager
     #     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.
     #
@@ -237,7 +291,7 @@ module Aws::SecretsManager
     #     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`.
@@ -1452,6 +1506,8 @@ module Aws::SecretsManager
     #   * {Types::ListSecretVersionIdsResponse#arn #arn} => String
     #   * {Types::ListSecretVersionIdsResponse#name #name} => 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 list all of the secret versions associated with a secret
     #
@@ -1572,6 +1628,8 @@ module Aws::SecretsManager
     #   * {Types::ListSecretsResponse#secret_list #secret_list} => Array&lt;Types::SecretListEntry&gt;
     #   * {Types::ListSecretsResponse#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 Example: To list the secrets in your account
     #
@@ -2917,7 +2975,7 @@ module Aws::SecretsManager
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-secretsmanager'
-      context[:gem_version] = '1.31.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,39 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SecretsManager
+
+  # When SecretsManager returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::SecretsManager::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all SecretsManager errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::SecretsManager::Errors::ServiceError
+  #       # rescues all SecretsManager 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
+  # * {DecryptionFailure}
+  # * {EncryptionFailure}
+  # * {InternalServiceError}
+  # * {InvalidNextTokenException}
+  # * {InvalidParameterException}
+  # * {InvalidRequestException}
+  # * {LimitExceededException}
+  # * {MalformedPolicyDocumentException}
+  # * {PreconditionNotMetException}
+  # * {ResourceExistsException}
+  # * {ResourceNotFoundException}
+  #
+  # 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
@@ -23,7 +56,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class EncryptionFailure < ServiceError
@@ -39,7 +71,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceError < ServiceError
@@ -55,7 +86,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidNextTokenException < ServiceError
@@ -71,7 +101,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidParameterException < ServiceError
@@ -87,7 +116,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
@@ -103,7 +131,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -119,7 +146,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class MalformedPolicyDocumentException < ServiceError
@@ -135,7 +161,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class PreconditionNotMetException < ServiceError
@@ -151,7 +176,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceExistsException < ServiceError
@@ -167,7 +191,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -183,7 +206,6 @@ module Aws::SecretsManager
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

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

@@ -593,6 +593,7 @@ module Aws::SecretsManager
     #   @return [Hash<String,Array<String>>]
     #
     # @!attribute [rw] owning_service
+    #   Returns the name of the service that created this secret.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/DescribeSecretResponse AWS API Documentation
@@ -1695,7 +1696,7 @@ module Aws::SecretsManager
     #   @return [String]
     #
     # @!attribute [rw] rotation_enabled
-    #   Indicated whether automatic, scheduled rotation is enabled for this
+    #   Indicates whether automatic, scheduled rotation is enabled for this
     #   secret.
     #   @return [Boolean]
     #
@@ -1751,6 +1752,7 @@ module Aws::SecretsManager
     #   @return [Hash<String,Array<String>>]
     #
     # @!attribute [rw] owning_service
+    #   Returns the name of the service that created the secret.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/secretsmanager-2017-10-17/SecretListEntry AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-secretsmanager
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-25 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.61.1
+        version: 3.71.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -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 - AWS Secrets Manager