aws-sdk-savingsplans 1.0.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12dfde1f322c0707c32509c14c3c87c2bc9cd42b
-  data.tar.gz: 44756d9117d1ca355f65fbc2f64557dd1d6b0327
+SHA256:
+  metadata.gz: d3a7bb6d119d992797767e2549df5d8c6c3ab139ff42e5a3e7a56a0dc047a030
+  data.tar.gz: 24e27009f80a7f19b7b5ed5ab50627c25e4cbec0fbe0bf603305f1ec04d40557
 SHA512:
-  metadata.gz: faca4a76f98d7dbd270cee59283bc9b8e84d3953bb8a268a92ef2b6433e7f6b1ddf00366b72fc1cbb363183744cd7d47b18a4a6552bae4edfe4e00657f6f110e
-  data.tar.gz: 67084e66b72d0685f8b13641c2f112b0127958efef45839a1e7e3e37a5a2db2ecb068f863806ad9eefd9b59d3d65dbdfad6cf72a5fa0451dac5e19c0763b2c14
+  metadata.gz: ba3c0fdadfa2f46af270bcf83dd949cfd293cc42ea16ea7d336df2983a64f2d6eedfb59977141645a0e1fa879f0acdee633978431b477e1f23bf29071313b019
+  data.tar.gz: a5c9d6b0c32483b741fbe324eddec5f4e01f260ed02ed92e2bc8414a7c908c3e5d4e92c464255da054ea37f75f7b9eb12d62d9006b601b80d6a578dffe489ac2

data/lib/aws-sdk-savingsplans.rb

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

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:savingsplans)
 
 module Aws::SavingsPlans
+  # An API client for SavingsPlans.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::SavingsPlans::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::SavingsPlans
     #   @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::SavingsPlans
     #     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::SavingsPlans
     #     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::SavingsPlans
     #   @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::SavingsPlans
     #     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::SavingsPlans
     #     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::SavingsPlans
     #     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::SavingsPlans
     #     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::SavingsPlans
     #     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`.
@@ -350,9 +404,9 @@ module Aws::SavingsPlans
     #   resp.search_results #=> Array
     #   resp.search_results[0].rate #=> String
     #   resp.search_results[0].currency #=> String, one of "CNY", "USD"
-    #   resp.search_results[0].unit #=> String, one of "Hrs"
-    #   resp.search_results[0].product_type #=> String, one of "EC2", "Fargate"
-    #   resp.search_results[0].service_code #=> String, one of "AmazonEC2", "AmazonECS"
+    #   resp.search_results[0].unit #=> String, one of "Hrs", "Lambda-GB-Second", "Request"
+    #   resp.search_results[0].product_type #=> String, one of "EC2", "Fargate", "Lambda"
+    #   resp.search_results[0].service_code #=> String, one of "AmazonEC2", "AmazonECS", "AWSLambda"
     #   resp.search_results[0].usage_type #=> String
     #   resp.search_results[0].operation #=> String
     #   resp.search_results[0].properties #=> Array
@@ -427,7 +481,7 @@ module Aws::SavingsPlans
     #   resp.savings_plans[0].savings_plan_type #=> String, one of "Compute", "EC2Instance"
     #   resp.savings_plans[0].payment_option #=> String, one of "All Upfront", "Partial Upfront", "No Upfront"
     #   resp.savings_plans[0].product_types #=> Array
-    #   resp.savings_plans[0].product_types[0] #=> String, one of "EC2", "Fargate"
+    #   resp.savings_plans[0].product_types[0] #=> String, one of "EC2", "Fargate", "Lambda"
     #   resp.savings_plans[0].currency #=> String, one of "CNY", "USD"
     #   resp.savings_plans[0].commitment #=> String
     #   resp.savings_plans[0].upfront_payment_amount #=> String
@@ -491,8 +545,8 @@ module Aws::SavingsPlans
     #     savings_plan_offering_ids: ["UUID"],
     #     savings_plan_payment_options: ["All Upfront"], # accepts All Upfront, Partial Upfront, No Upfront
     #     savings_plan_types: ["Compute"], # accepts Compute, EC2Instance
-    #     products: ["EC2"], # accepts EC2, Fargate
-    #     service_codes: ["AmazonEC2"], # accepts AmazonEC2, AmazonECS
+    #     products: ["EC2"], # accepts EC2, Fargate, Lambda
+    #     service_codes: ["AmazonEC2"], # accepts AmazonEC2, AmazonECS, AWSLambda
     #     usage_types: ["SavingsPlanRateUsageType"],
     #     operations: ["SavingsPlanRateOperation"],
     #     filters: [
@@ -515,9 +569,9 @@ module Aws::SavingsPlans
     #   resp.search_results[0].savings_plan_offering.currency #=> String, one of "CNY", "USD"
     #   resp.search_results[0].savings_plan_offering.plan_description #=> String
     #   resp.search_results[0].rate #=> String
-    #   resp.search_results[0].unit #=> String, one of "Hrs"
-    #   resp.search_results[0].product_type #=> String, one of "EC2", "Fargate"
-    #   resp.search_results[0].service_code #=> String, one of "AmazonEC2", "AmazonECS"
+    #   resp.search_results[0].unit #=> String, one of "Hrs", "Lambda-GB-Second", "Request"
+    #   resp.search_results[0].product_type #=> String, one of "EC2", "Fargate", "Lambda"
+    #   resp.search_results[0].service_code #=> String, one of "AmazonEC2", "AmazonECS", "AWSLambda"
     #   resp.search_results[0].usage_type #=> String
     #   resp.search_results[0].operation #=> String
     #   resp.search_results[0].properties #=> Array
@@ -587,7 +641,7 @@ module Aws::SavingsPlans
     #   resp = client.describe_savings_plans_offerings({
     #     offering_ids: ["UUID"],
     #     payment_options: ["All Upfront"], # accepts All Upfront, Partial Upfront, No Upfront
-    #     product_type: "EC2", # accepts EC2, Fargate
+    #     product_type: "EC2", # accepts EC2, Fargate, Lambda
     #     plan_types: ["Compute"], # accepts Compute, EC2Instance
     #     durations: [1],
     #     currencies: ["CNY"], # accepts CNY, USD
@@ -610,7 +664,7 @@ module Aws::SavingsPlans
     #   resp.search_results #=> Array
     #   resp.search_results[0].offering_id #=> String
     #   resp.search_results[0].product_types #=> Array
-    #   resp.search_results[0].product_types[0] #=> String, one of "EC2", "Fargate"
+    #   resp.search_results[0].product_types[0] #=> String, one of "EC2", "Fargate", "Lambda"
     #   resp.search_results[0].plan_type #=> String, one of "Compute", "EC2Instance"
     #   resp.search_results[0].description #=> String
     #   resp.search_results[0].payment_option #=> String, one of "All Upfront", "Partial Upfront", "No Upfront"
@@ -730,7 +784,7 @@ module Aws::SavingsPlans
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-savingsplans'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.5.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -6,6 +6,32 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::SavingsPlans
+
+  # When SavingsPlans returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::SavingsPlans::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all SavingsPlans errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::SavingsPlans::Errors::ServiceError
+  #       # rescues all SavingsPlans 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
+  # * {InternalServerException}
+  # * {ResourceNotFoundException}
+  # * {ServiceQuotaExceededException}
+  # * {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 +49,6 @@ module Aws::SavingsPlans
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
@@ -39,7 +64,6 @@ module Aws::SavingsPlans
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServiceQuotaExceededException < ServiceError
@@ -55,7 +79,6 @@ module Aws::SavingsPlans
       def message
         @message || @data[:message]
       end
-
     end
 
     class ValidationException < ServiceError
@@ -71,7 +94,6 @@ module Aws::SavingsPlans
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

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

@@ -143,8 +143,8 @@ module Aws::SavingsPlans
     #         savings_plan_offering_ids: ["UUID"],
     #         savings_plan_payment_options: ["All Upfront"], # accepts All Upfront, Partial Upfront, No Upfront
     #         savings_plan_types: ["Compute"], # accepts Compute, EC2Instance
-    #         products: ["EC2"], # accepts EC2, Fargate
-    #         service_codes: ["AmazonEC2"], # accepts AmazonEC2, AmazonECS
+    #         products: ["EC2"], # accepts EC2, Fargate, Lambda
+    #         service_codes: ["AmazonEC2"], # accepts AmazonEC2, AmazonECS, AWSLambda
     #         usage_types: ["SavingsPlanRateUsageType"],
     #         operations: ["SavingsPlanRateOperation"],
     #         filters: [
@@ -238,7 +238,7 @@ module Aws::SavingsPlans
     #       {
     #         offering_ids: ["UUID"],
     #         payment_options: ["All Upfront"], # accepts All Upfront, Partial Upfront, No Upfront
-    #         product_type: "EC2", # accepts EC2, Fargate
+    #         product_type: "EC2", # accepts EC2, Fargate, Lambda
     #         plan_types: ["Compute"], # accepts Compute, EC2Instance
     #         durations: [1],
     #         currencies: ["CNY"], # accepts CNY, USD

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-savingsplans
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-06 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 - AWSSavingsPlans