aws-sdk-marketplacemetering 1.19.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63c740894e05bfbb4ef7e82cb07fd245e4c9a2a8
-  data.tar.gz: 3a0b8c1404fb9cbf3b57103c2dedc81c0562c682
+SHA256:
+  metadata.gz: 466ba4076a016d4f29083a67433998289f2f2f501cd1c2e073a51b34d7126f4c
+  data.tar.gz: 57d55881ec931b96a50723ec2116a46d84dbe7524651997c18987fb0d2e44eed
 SHA512:
-  metadata.gz: 5e80bec81814416c61155fca87ba4fbc2aaa2fa4617f83bf0c2dd6a0b9106463b2be713e4f79c24d8d8bf1a2677e541bf4e652f90a219b765d77303684c68815
-  data.tar.gz: fed31d39cd6cc6d39de524383235ebd1b41579d139bc850dfc3762ba3eca4db982c90b8c70e30fe4bae4ef56cc4577ef5d0b88ce4d1d4e31d2448398030ce21d
+  metadata.gz: cf500b7dac16f0e4376e128ae59108d9d54cad031cb6549ad75c4a0bb08c67b51cf7a109bb70cc8d40934edc32f687fa3f8cbedc49a88f6d6576b617c5a1c5eb
+  data.tar.gz: 9b03c647dcbd6e7cf1896b34f4e2561619b55e64baab66b1a6c77547780f7f71cee60af4dbf74accdeb86784fb79e5c09582aa931c92d8389d61191867c1ef4b

data/lib/aws-sdk-marketplacemetering.rb

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

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

@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 Aws::Plugins::GlobalConfiguration.add_identifier(:marketplacemetering)
 
 module Aws::MarketplaceMetering
+  # An API client for MarketplaceMetering.  To construct a client, you need to configure a `:region` and `:credentials`.
+  #
+  #     client = Aws::MarketplaceMetering::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::MarketplaceMetering
     #   @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::MarketplaceMetering
     #     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::MarketplaceMetering
     #     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::MarketplaceMetering
     #   @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::MarketplaceMetering
     #     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::MarketplaceMetering
     #     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::MarketplaceMetering
     #     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::MarketplaceMetering
     #     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::MarketplaceMetering
     #     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`.
@@ -331,8 +385,8 @@ module Aws::MarketplaceMetering
     # API to emit metering records. For identical requests, the API is
     # idempotent. It simply returns the metering record ID.
     #
-    # MeterUsage is authenticated on the buyer's AWS account, generally
-    # when running from an EC2 instance on the AWS Marketplace.
+    # MeterUsage is authenticated on the buyer's AWS account using
+    # credentials from the EC2 instance, ECS task, or EKS pod.
     #
     # @option params [required, String] :product_code
     #   Product code is used to uniquely identify a product in AWS
@@ -386,10 +440,9 @@ module Aws::MarketplaceMetering
 
     # Paid container software products sold through AWS Marketplace must
     # integrate with the AWS Marketplace Metering Service and call the
-    # RegisterUsage operation for software entitlement and metering. Calling
-    # RegisterUsage from containers running outside of ECS is not currently
-    # supported. Free and BYOL products for ECS aren't required to call
-    # RegisterUsage, but you may choose to do so if you would like to
+    # RegisterUsage operation for software entitlement and metering. Free
+    # and BYOL products for Amazon ECS or Amazon EKS aren't required to
+    # call RegisterUsage, but you may choose to do so if you would like to
     # receive usage data in your seller reports. The sections below explain
     # the behavior of RegisterUsage. RegisterUsage performs two primary
     # functions: metering and entitlement.
@@ -401,22 +454,24 @@ module Aws::MarketplaceMetering
     #   to guard against unauthorized use at container startup, as such a
     #   CustomerNotSubscribedException/PlatformNotSupportedException will
     #   only be thrown on the initial call to RegisterUsage. Subsequent
-    #   calls from the same Amazon ECS task instance (e.g. task-id) will not
-    #   throw a CustomerNotSubscribedException, even if the customer
-    #   unsubscribes while the Amazon ECS task is still running.
+    #   calls from the same Amazon ECS task instance (e.g. task-id) or
+    #   Amazon EKS pod will not throw a CustomerNotSubscribedException, even
+    #   if the customer unsubscribes while the Amazon ECS task or Amazon EKS
+    #   pod is still running.
     #
     # * *Metering*\: RegisterUsage meters software use per ECS task, per
-    #   hour, with usage prorated to the second. A minimum of 1 minute of
-    #   usage applies to tasks that are short lived. For example, if a
-    #   customer has a 10 node ECS cluster and creates an ECS service
-    #   configured as a Daemon Set, then ECS will launch a task on all 10
-    #   cluster nodes and the customer will be charged: (10 *
-    #   hourly\_rate). Metering for software use is automatically handled by
-    #   the AWS Marketplace Metering Control Plane -- your software is not
-    #   required to perform any metering specific actions, other than call
-    #   RegisterUsage once for metering of software use to commence. The AWS
-    #   Marketplace Metering Control Plane will also continue to bill
-    #   customers for running ECS tasks, regardless of the customers
+    #   hour, or per pod for Amazon EKS with usage prorated to the second. A
+    #   minimum of 1 minute of usage applies to tasks that are short lived.
+    #   For example, if a customer has a 10 node Amazon ECS or Amazon EKS
+    #   cluster and a service configured as a Daemon Set, then Amazon ECS or
+    #   Amazon EKS will launch a task on all 10 cluster nodes and the
+    #   customer will be charged: (10 * hourly\_rate). Metering for
+    #   software use is automatically handled by the AWS Marketplace
+    #   Metering Control Plane -- your software is not required to perform
+    #   any metering specific actions, other than call RegisterUsage once
+    #   for metering of software use to commence. The AWS Marketplace
+    #   Metering Control Plane will also continue to bill customers for
+    #   running ECS tasks and Amazon EKS pods, regardless of the customers
     #   subscription state, removing the need for your software to perform
     #   entitlement checks at runtime.
     #
@@ -509,7 +564,7 @@ module Aws::MarketplaceMetering
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-marketplacemetering'
-      context[:gem_version] = '1.19.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -192,6 +192,7 @@ module Aws::MarketplaceMetering
         o.errors << Shapes::ShapeRef.new(shape: TimestampOutOfBoundsException)
         o.errors << Shapes::ShapeRef.new(shape: DuplicateRequestException)
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: CustomerNotEntitledException)
       end)
 
       api.add_operation(:register_usage, Seahorse::Model::Operation.new.tap do |o|

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

@@ -6,6 +6,43 @@
 # WARNING ABOUT GENERATED CODE
 
 module Aws::MarketplaceMetering
+
+  # When MarketplaceMetering returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::MarketplaceMetering::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all MarketplaceMetering errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::MarketplaceMetering::Errors::ServiceError
+  #       # rescues all MarketplaceMetering 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
+  # * {CustomerNotEntitledException}
+  # * {DisabledApiException}
+  # * {DuplicateRequestException}
+  # * {ExpiredTokenException}
+  # * {InternalServiceErrorException}
+  # * {InvalidCustomerIdentifierException}
+  # * {InvalidEndpointRegionException}
+  # * {InvalidProductCodeException}
+  # * {InvalidPublicKeyVersionException}
+  # * {InvalidRegionException}
+  # * {InvalidTokenException}
+  # * {InvalidUsageDimensionException}
+  # * {PlatformNotSupportedException}
+  # * {ThrottlingException}
+  # * {TimestampOutOfBoundsException}
+  #
+  # 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 +60,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class DisabledApiException < ServiceError
@@ -39,7 +75,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class DuplicateRequestException < ServiceError
@@ -55,7 +90,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class ExpiredTokenException < ServiceError
@@ -71,7 +105,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceErrorException < ServiceError
@@ -87,7 +120,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidCustomerIdentifierException < ServiceError
@@ -103,7 +135,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidEndpointRegionException < ServiceError
@@ -119,7 +150,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidProductCodeException < ServiceError
@@ -135,7 +165,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidPublicKeyVersionException < ServiceError
@@ -151,7 +180,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRegionException < ServiceError
@@ -167,7 +195,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidTokenException < ServiceError
@@ -183,7 +210,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidUsageDimensionException < ServiceError
@@ -199,7 +225,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class PlatformNotSupportedException < ServiceError
@@ -215,7 +240,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
@@ -231,7 +255,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
     class TimestampOutOfBoundsException < ServiceError
@@ -247,7 +270,6 @@ module Aws::MarketplaceMetering
       def message
         @message || @data[:message]
       end
-
     end
 
   end

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

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

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

@@ -94,9 +94,9 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # A metering record has already been emitted by the same EC2 instance
-    # for the given \\\{usageDimension, timestamp\\} with a different
-    # usageQuantity.
+    # A metering record has already been emitted by the same EC2 instance,
+    # ECS task, or EKS pod for the given \\\{usageDimension, timestamp\\}
+    # with a different usageQuantity.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -150,9 +150,9 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # The endpoint being called is in a Region different from your EC2
-    # instance. The Region of the Metering Service endpoint and the Region
-    # of the EC2 instance must match.
+    # The endpoint being called is in a AWS Region different from your EC2
+    # instance, ECS task, or EKS pod. The Region of the Metering Service
+    # endpoint and the AWS Region of the resource must match.
     #
     # @!attribute [rw] message
     #   @return [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-marketplacemetering
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 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 - AWSMarketplace Metering