aws-sdk-ebs 1.0.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f86b5825f4b9775792cce2fb144e584d3714ffd
-  data.tar.gz: 397387f9bd9a71f79dd3e99f5b6dde1188db55d8
+SHA256:
+  metadata.gz: '0457688f01022802db9c652777675a77a80632d123abf4218049d2cfe6bea542'
+  data.tar.gz: 3109a3f509871cb0f53023c356ab8eccae85948ea4ebdb3a8b15c2ce697ba33b
 SHA512:
-  metadata.gz: 44ae1a753f8c00b62da9d66c23bf93a21e5e92ad954134b7643e8fd0d84f1c187c27c353806e091cd1d41bd089f38c26c7fd0fa1b80a23c03b04e259feb0cfb6
-  data.tar.gz: c4fe175e11404e63a75b99f5313223adb5b156c6687de490f8eec2590693444f46dea097ca624b19b32d2784796ed3b81cf8b6a238ad85ae328723e0b641fc08
+  metadata.gz: 281ba49f8ec5c0485c957baa542c2628d74c403b86ba2c7101082f0c081fbbdef048430aa8035ca256cd2e423df89df8da7a09bfd4582ab72726dc710da5f871
+  data.tar.gz: ff09f1a663fbcfc7dbfe5d57c590e1289acb0e78ef4df171562321c4a536e818d72ba02e6e9b76c550f4b5608787d7c2ddd33979a38f8c67e2a1f813588f928b

data/lib/aws-sdk-ebs.rb

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

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

@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
 require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
 require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
 require 'aws-sdk-core/plugins/transfer_encoding.rb'
+require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:ebs)
 
 module Aws::EBS
+  # An API client for EBS.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::EBS::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
@@ -57,6 +70,7 @@ module Aws::EBS
     add_plugin(Aws::Plugins::ClientMetricsPlugin)
     add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
     add_plugin(Aws::Plugins::TransferEncoding)
+    add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::RestJson)
 
@@ -93,7 +107,7 @@ module Aws::EBS
     #   @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 +122,12 @@ module Aws::EBS
     #     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 +152,10 @@ module Aws::EBS
     #     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 +163,7 @@ module Aws::EBS
     #   @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 or custom 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 +178,7 @@ module Aws::EBS
     #     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 +190,29 @@ module Aws::EBS
     #     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 +220,30 @@ module Aws::EBS
     #     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 +266,15 @@ module Aws::EBS
     #     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 +283,7 @@ module Aws::EBS
     #     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`.
@@ -262,14 +318,14 @@ module Aws::EBS
     # @option params [required, Integer] :block_index
     #   The block index of the block from which to get data.
     #
-    #   Obtain the `block index` by running the `list changed blocks` or `list
-    #   snapshot blocks` operations.
+    #   Obtain the `BlockIndex` by running the `ListChangedBlocks` or
+    #   `ListSnapshotBlocks` operations.
     #
     # @option params [required, String] :block_token
     #   The block token of the block from which to get data.
     #
-    #   Obtain the `block token` by running the `list changed blocks` or `list
-    #   snapshot blocks` operations.
+    #   Obtain the `BlockToken` by running the `ListChangedBlocks` or
+    #   `ListSnapshotBlocks` operations.
     #
     # @return [Types::GetSnapshotBlockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -309,9 +365,15 @@ module Aws::EBS
     # @option params [String] :first_snapshot_id
     #   The ID of the first snapshot to use for the comparison.
     #
+    #   The `FirstSnapshotID` parameter must be specified with a
+    #   `SecondSnapshotId` parameter; otherwise, an error occurs.
+    #
     # @option params [required, String] :second_snapshot_id
     #   The ID of the second snapshot to use for the comparison.
     #
+    #   The `SecondSnapshotId` parameter must be specified with a
+    #   `FirstSnapshotID` parameter; otherwise, an error occurs.
+    #
     # @option params [String] :next_token
     #   The token to request the next page of results.
     #
@@ -332,6 +394,8 @@ module Aws::EBS
     #   * {Types::ListChangedBlocksResponse#block_size #block_size} => Integer
     #   * {Types::ListChangedBlocksResponse#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_changed_blocks({
@@ -388,6 +452,8 @@ module Aws::EBS
     #   * {Types::ListSnapshotBlocksResponse#block_size #block_size} => Integer
     #   * {Types::ListSnapshotBlocksResponse#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_snapshot_blocks({
@@ -429,7 +495,7 @@ module Aws::EBS
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-ebs'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.5.1'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,30 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::EBS
+
+  # When EBS returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::EBS::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all EBS errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::EBS::Errors::ServiceError
+  #       # rescues all EBS 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
+  # * {ResourceNotFoundException}
+  # * {ValidationException}
+  #
+  # 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 +47,6 @@ module Aws::EBS
       def message
         @message || @data[:message]
       end
-
     end
 
     class ValidationException < ServiceError
@@ -44,7 +67,6 @@ module Aws::EBS
       def reason
         @data[:reason]
       end
-
     end
 
   end

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

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

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

@@ -34,15 +34,15 @@ module Aws::EBS
     #   @return [Integer]
     #
     # @!attribute [rw] first_block_token
-    #   The block token for the block index of the `first snapshot ID`
-    #   specified in the `list changed blocks` operation. This value is
-    #   absent if the first snapshot does not have the changed block that is
-    #   on the second snapshot.
+    #   The block token for the block index of the `FirstSnapshotId`
+    #   specified in the `ListChangedBlocks` operation. This value is absent
+    #   if the first snapshot does not have the changed block that is on the
+    #   second snapshot.
     #   @return [String]
     #
     # @!attribute [rw] second_block_token
-    #   The block token for the block index of the `second snapshot ID`
-    #   specified in the `list changed blocks` operation.
+    #   The block token for the block index of the `SecondSnapshotId`
+    #   specified in the `ListChangedBlocks` operation.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/ChangedBlock AWS API Documentation
@@ -70,15 +70,15 @@ module Aws::EBS
     # @!attribute [rw] block_index
     #   The block index of the block from which to get data.
     #
-    #   Obtain the `block index` by running the `list changed blocks` or
-    #   `list snapshot blocks` operations.
+    #   Obtain the `BlockIndex` by running the `ListChangedBlocks` or
+    #   `ListSnapshotBlocks` operations.
     #   @return [Integer]
     #
     # @!attribute [rw] block_token
     #   The block token of the block from which to get data.
     #
-    #   Obtain the `block token` by running the `list changed blocks` or
-    #   `list snapshot blocks` operations.
+    #   Obtain the `BlockToken` by running the `ListChangedBlocks` or
+    #   `ListSnapshotBlocks` operations.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/ebs-2019-11-02/GetSnapshotBlockRequest AWS API Documentation
@@ -99,7 +99,7 @@ module Aws::EBS
     #   @return [IO]
     #
     # @!attribute [rw] checksum
-    #   The checksum generated for the block.
+    #   The checksum generated for the block, which is Base64 encoded.
     #   @return [String]
     #
     # @!attribute [rw] checksum_algorithm
@@ -130,10 +130,16 @@ module Aws::EBS
     #
     # @!attribute [rw] first_snapshot_id
     #   The ID of the first snapshot to use for the comparison.
+    #
+    #   The `FirstSnapshotID` parameter must be specified with a
+    #   `SecondSnapshotId` parameter; otherwise, an error occurs.
     #   @return [String]
     #
     # @!attribute [rw] second_snapshot_id
     #   The ID of the second snapshot to use for the comparison.
+    #
+    #   The `SecondSnapshotId` parameter must be specified with a
+    #   `FirstSnapshotID` parameter; otherwise, an error occurs.
     #   @return [String]
     #
     # @!attribute [rw] next_token
@@ -167,7 +173,7 @@ module Aws::EBS
     #   @return [Array<Types::ChangedBlock>]
     #
     # @!attribute [rw] expiry_time
-    #   The time when the `block token` expires.
+    #   The time when the `BlockToken` expires.
     #   @return [Time]
     #
     # @!attribute [rw] volume_size
@@ -238,7 +244,7 @@ module Aws::EBS
     #   @return [Array<Types::Block>]
     #
     # @!attribute [rw] expiry_time
-    #   The time when the `block token` expires.
+    #   The time when the `BlockToken` expires.
     #   @return [Time]
     #
     # @!attribute [rw] volume_size

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-ebs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-04 00:00:00.000000000 Z
+date: 2020-06-11 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.71.0
+        version: 3.99.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.71.0
+        version: 3.99.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 - Amazon EBS