aws-sdk-marketplacemetering 1.41.0 → 1.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c33b0a03d23746ee4698b8a3483bab8c3e47300757c1a8f63a6106cb36cde78
-  data.tar.gz: 6a4134b843038f324d4ca40a6d9d7090ada545f8004bb7b280668fa4899210f9
+  metadata.gz: 755218de5f1b120c0a61502a01750666cc07a7a8edc5af7e7313b736c2eca2ad
+  data.tar.gz: e218f8d49b902ad28d5f2e03fa2247be1defe14c0f029f42ac1d9d7c330ddc6a
 SHA512:
-  metadata.gz: 0d2b49ad88021bb219302e4f47fe7bbde6e741fea8e19a45c5f92468fa95ac39a2907e32cae458101c9b17285d1754dac31d08007ba4456fe1c5205c46735a0d
-  data.tar.gz: 6fe1d3f2af003324f72ee09aa0f140ae1cd5cb189126a302e33b384ab75e74fdb96d3385168871a9f14eb3915fd2a5f32b2b24639ba9f263a220fcfcedf42978
+  metadata.gz: 4537f5d577576220eed7ffd66b645639055cd9d86e626e5d714b20f98f61aec470c483bfc397e62d6273b1ab02d631405c4f1ed6a5a14fb941b9429ea7976454
+  data.tar.gz: 96d8ddc4edc2d82e4904e945aca3420ac599ae08ab2fb1e7ab4f3798e9005aa67f71ea39e00da90befc671a1ed2c1fa3efbf889bdf10953f5efba9f7d5a0fd7f

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.43.0 (2022-02-03)
+------------------
+
+* Feature - Add CustomerAWSAccountId to ResolveCustomer API response and increase UsageAllocation limit to 2500.
+
+1.42.0 (2022-02-03)
+------------------
+
+* Feature - Add CustomerAWSAccountId to ResolveCustomer API response and increase UsageAllocation limit to 2500.
+
 1.41.0 (2021-12-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.41.0
+1.43.0

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

@@ -28,6 +28,7 @@ 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/defaults_mode.rb'
+require 'aws-sdk-core/plugins/recursion_detection.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
@@ -75,6 +76,7 @@ module Aws::MarketplaceMetering
     add_plugin(Aws::Plugins::TransferEncoding)
     add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::DefaultsMode)
+    add_plugin(Aws::Plugins::RecursionDetection)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
 
@@ -357,27 +359,45 @@ module Aws::MarketplaceMetering
 
     # @!group API Operations
 
-    # BatchMeterUsage is called from a SaaS application listed on the AWS
+    # `BatchMeterUsage` is called from a SaaS application listed on AWS
     # Marketplace to post metering records for a set of customers.
     #
     # For identical requests, the API is idempotent; requests can be retried
     # with the same records or a subset of the input records.
     #
-    # Every request to BatchMeterUsage is for one product. If you need to
+    # Every request to `BatchMeterUsage` is for one product. If you need to
     # meter usage for multiple products, you must make multiple calls to
-    # BatchMeterUsage.
+    # `BatchMeterUsage`.
     #
-    # BatchMeterUsage can process up to 25 UsageRecords at a time.
+    # Usage records are expected to be submitted as quickly as possible
+    # after the event that is being recorded, and are not accepted more than
+    # 6 hours after the event.
     #
-    # A UsageRecord can optionally include multiple usage allocations, to
-    # provide customers with usagedata split into buckets by tags that you
+    # `BatchMeterUsage` can process up to 25 `UsageRecords` at a time.
+    #
+    # A `UsageRecord` can optionally include multiple usage allocations, to
+    # provide customers with usage data split into buckets by tags that you
     # define (or allow the customer to define).
     #
-    # BatchMeterUsage requests must be less than 1MB in size.
+    # `BatchMeterUsage` returns a list of `UsageRecordResult` objects,
+    # showing the result for each `UsageRecord`, as well as a list of
+    # `UnprocessedRecords`, indicating errors in the service side that you
+    # should retry.
+    #
+    # `BatchMeterUsage` requests must be less than 1MB in size.
+    #
+    # <note markdown="1"> For an example of using `BatchMeterUsage`, see [ BatchMeterUsage code
+    # example][1] in the *AWS Marketplace Seller Guide*.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example
     #
     # @option params [required, Array<Types::UsageRecord>] :usage_records
-    #   The set of UsageRecords to submit. BatchMeterUsage accepts up to 25
-    #   UsageRecords at a time.
+    #   The set of `UsageRecords` to submit. `BatchMeterUsage` accepts up to
+    #   25 `UsageRecords` at a time.
     #
     # @option params [required, String] :product_code
     #   Product code is used to uniquely identify a product in AWS
@@ -451,13 +471,17 @@ 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 using
+    # `MeterUsage` is authenticated on the buyer's AWS account using
     # credentials from the EC2 instance, ECS task, or EKS pod.
     #
-    # MeterUsage can optionally include multiple usage allocations, to
+    # `MeterUsage` can optionally include multiple usage allocations, to
     # provide customers with usage data split into buckets by tags that you
     # define (or allow the customer to define).
     #
+    # Usage records are expected to be submitted as quickly as possible
+    # after the event that is being recorded, and are not accepted more than
+    # 6 hours after the event.
+    #
     # @option params [required, String] :product_code
     #   Product code is used to uniquely identify a product in AWS
     #   Marketplace. The product code should be the same as the one used
@@ -466,7 +490,7 @@ module Aws::MarketplaceMetering
     # @option params [required, Time,DateTime,Date,Integer,String] :timestamp
     #   Timestamp, in UTC, for which the usage is being reported. Your
     #   application can meter usage for up to one hour in the past. Make sure
-    #   the timestamp value is not before the start of the software usage.
+    #   the `timestamp` value is not before the start of the software usage.
     #
     # @option params [required, String] :usage_dimension
     #   It will be one of the fcp dimension name provided during the
@@ -478,15 +502,15 @@ module Aws::MarketplaceMetering
     # @option params [Boolean] :dry_run
     #   Checks whether you have the permissions required for the action, but
     #   does not make the request. If you have the permissions, the request
-    #   returns DryRunOperation; otherwise, it returns UnauthorizedException.
-    #   Defaults to `false` if not specified.
+    #   returns `DryRunOperation`; otherwise, it returns
+    #   `UnauthorizedException`. Defaults to `false` if not specified.
     #
     # @option params [Array<Types::UsageAllocation>] :usage_allocations
-    #   The set of UsageAllocations to submit.
+    #   The set of `UsageAllocations` to submit.
     #
-    #   The sum of all UsageAllocation quantities must equal the UsageQuantity
-    #   of the MeterUsage request, and each UsageAllocation must have a unique
-    #   set of tags (include no tags).
+    #   The sum of all `UsageAllocation` quantities must equal the
+    #   `UsageQuantity` of the `MeterUsage` request, and each
+    #   `UsageAllocation` must have a unique set of tags (include no tags).
     #
     # @return [Types::MeterUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -528,26 +552,26 @@ 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. Free
+    # `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
+    # 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
+    # the behavior of `RegisterUsage`. `RegisterUsage` performs two primary
     # functions: metering and entitlement.
     #
-    # * *Entitlement*\: RegisterUsage allows you to verify that the customer
-    #   running your paid software is subscribed to your product on AWS
-    #   Marketplace, enabling you to guard against unauthorized use. Your
-    #   container image that integrates with RegisterUsage is only required
-    #   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) 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
+    # * *Entitlement*\: `RegisterUsage` allows you to verify that the
+    #   customer running your paid software is subscribed to your product on
+    #   AWS Marketplace, enabling you to guard against unauthorized use.
+    #   Your container image that integrates with `RegisterUsage` is only
+    #   required to guard against unauthorized use at container startup, as
+    #   such a `CustomerNotSubscribedException` or
+    #   `PlatformNotSupportedException` will only be thrown on the initial
+    #   call to `RegisterUsage`. Subsequent 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, 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
@@ -556,7 +580,7 @@ module Aws::MarketplaceMetering
     #   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
+    #   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
@@ -602,22 +626,36 @@ module Aws::MarketplaceMetering
       req.send_request(options)
     end
 
-    # ResolveCustomer is called by a SaaS application during the
+    # `ResolveCustomer` is called by a SaaS application during the
     # registration process. When a buyer visits your website during the
     # registration process, the buyer submits a registration token through
     # their browser. The registration token is resolved through this API to
-    # obtain a CustomerIdentifier and product code.
+    # obtain a `CustomerIdentifier` along with the `CustomerAWSAccountId`
+    # and `ProductCode`.
+    #
+    # <note markdown="1"> The API needs to called from the seller account id used to publish the
+    # SaaS application to successfully resolve the token.
+    #
+    #  For an example of using `ResolveCustomer`, see [ ResolveCustomer code
+    # example][1] in the *AWS Marketplace Seller Guide*.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example
     #
     # @option params [required, String] :registration_token
     #   When a buyer visits your website during the registration process, the
     #   buyer submits a registration token through the browser. The
-    #   registration token is resolved to obtain a CustomerIdentifier and
-    #   product code.
+    #   registration token is resolved to obtain a `CustomerIdentifier` along
+    #   with the `CustomerAWSAccountId` and `ProductCode`.
     #
     # @return [Types::ResolveCustomerResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::ResolveCustomerResult#customer_identifier #customer_identifier} => String
     #   * {Types::ResolveCustomerResult#product_code #product_code} => String
+    #   * {Types::ResolveCustomerResult#customer_aws_account_id #customer_aws_account_id} => String
     #
     # @example Request syntax with placeholder values
     #
@@ -629,6 +667,7 @@ module Aws::MarketplaceMetering
     #
     #   resp.customer_identifier #=> String
     #   resp.product_code #=> String
+    #   resp.customer_aws_account_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomer AWS API Documentation
     #
@@ -652,7 +691,7 @@ module Aws::MarketplaceMetering
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-marketplacemetering'
-      context[:gem_version] = '1.41.0'
+      context[:gem_version] = '1.43.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -17,6 +17,7 @@ module Aws::MarketplaceMetering
     BatchMeterUsageRequest = Shapes::StructureShape.new(name: 'BatchMeterUsageRequest')
     BatchMeterUsageResult = Shapes::StructureShape.new(name: 'BatchMeterUsageResult')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
+    CustomerAWSAccountId = Shapes::StringShape.new(name: 'CustomerAWSAccountId')
     CustomerIdentifier = Shapes::StringShape.new(name: 'CustomerIdentifier')
     CustomerNotEntitledException = Shapes::StructureShape.new(name: 'CustomerNotEntitledException')
     DisabledApiException = Shapes::StructureShape.new(name: 'DisabledApiException')
@@ -140,6 +141,7 @@ module Aws::MarketplaceMetering
 
     ResolveCustomerResult.add_member(:customer_identifier, Shapes::ShapeRef.new(shape: CustomerIdentifier, location_name: "CustomerIdentifier"))
     ResolveCustomerResult.add_member(:product_code, Shapes::ShapeRef.new(shape: ProductCode, location_name: "ProductCode"))
+    ResolveCustomerResult.add_member(:customer_aws_account_id, Shapes::ShapeRef.new(shape: CustomerAWSAccountId, location_name: "CustomerAWSAccountId"))
     ResolveCustomerResult.struct_class = Types::ResolveCustomerResult
 
     Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))

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

@@ -10,7 +10,7 @@
 module Aws::MarketplaceMetering
   module Types
 
-    # A BatchMeterUsageRequest contains UsageRecords, which indicate
+    # A `BatchMeterUsageRequest` contains `UsageRecords`, which indicate
     # quantities of usage within your application.
     #
     # @note When making an API call, you may pass BatchMeterUsageRequest
@@ -40,8 +40,8 @@ module Aws::MarketplaceMetering
     #       }
     #
     # @!attribute [rw] usage_records
-    #   The set of UsageRecords to submit. BatchMeterUsage accepts up to 25
-    #   UsageRecords at a time.
+    #   The set of `UsageRecords` to submit. `BatchMeterUsage` accepts up to
+    #   25 `UsageRecords` at a time.
     #   @return [Array<Types::UsageRecord>]
     #
     # @!attribute [rw] product_code
@@ -59,20 +59,21 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # Contains the UsageRecords processed by BatchMeterUsage and any records
-    # that have failed due to transient error.
+    # Contains the `UsageRecords` processed by `BatchMeterUsage` and any
+    # records that have failed due to transient error.
     #
     # @!attribute [rw] results
-    #   Contains all UsageRecords processed by BatchMeterUsage. These
+    #   Contains all `UsageRecords` processed by `BatchMeterUsage`. These
     #   records were either honored by AWS Marketplace Metering Service or
-    #   were invalid.
+    #   were invalid. Invalid records should be fixed before being
+    #   resubmitted.
     #   @return [Array<Types::UsageRecordResult>]
     #
     # @!attribute [rw] unprocessed_records
-    #   Contains all UsageRecords that were not processed by
-    #   BatchMeterUsage. This is a list of UsageRecords. You can retry the
-    #   failed request by making another BatchMeterUsage call with this list
-    #   as input in the BatchMeterUsageRequest.
+    #   Contains all `UsageRecords` that were not processed by
+    #   `BatchMeterUsage`. This is a list of `UsageRecords`. You can retry
+    #   the failed request by making another `BatchMeterUsage` call with
+    #   this list as input in the `BatchMeterUsageRequest`.
     #   @return [Array<Types::UsageRecord>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsageResult AWS API Documentation
@@ -112,8 +113,8 @@ module Aws::MarketplaceMetering
     end
 
     # 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.
+    # ECS task, or EKS pod for the given \\\{`usageDimension`,
+    # `timestamp`\\} with a different `usageQuantity`.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -158,7 +159,7 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # You have metered usage for a CustomerIdentifier that does not exist.
+    # You have metered usage for a `CustomerIdentifier` that does not exist.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -213,9 +214,9 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # RegisterUsage must be called in the same AWS Region the ECS task was
+    # `RegisterUsage` must be called in the same AWS Region the ECS task was
     # launched in. This prevents a container from hardcoding a Region (e.g.
-    # withRegion(“us-east-1”) when calling RegisterUsage.
+    # withRegion(“us-east-1”) when calling `RegisterUsage`.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -268,7 +269,7 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # The usage dimension does not match one of the UsageDimensions
+    # The usage dimension does not match one of the `UsageDimensions`
     # associated with products.
     #
     # @!attribute [rw] message
@@ -313,7 +314,7 @@ module Aws::MarketplaceMetering
     # @!attribute [rw] timestamp
     #   Timestamp, in UTC, for which the usage is being reported. Your
     #   application can meter usage for up to one hour in the past. Make
-    #   sure the timestamp value is not before the start of the software
+    #   sure the `timestamp` value is not before the start of the software
     #   usage.
     #   @return [Time]
     #
@@ -329,16 +330,16 @@ module Aws::MarketplaceMetering
     # @!attribute [rw] dry_run
     #   Checks whether you have the permissions required for the action, but
     #   does not make the request. If you have the permissions, the request
-    #   returns DryRunOperation; otherwise, it returns
-    #   UnauthorizedException. Defaults to `false` if not specified.
+    #   returns `DryRunOperation`; otherwise, it returns
+    #   `UnauthorizedException`. Defaults to `false` if not specified.
     #   @return [Boolean]
     #
     # @!attribute [rw] usage_allocations
-    #   The set of UsageAllocations to submit.
+    #   The set of `UsageAllocations` to submit.
     #
-    #   The sum of all UsageAllocation quantities must equal the
-    #   UsageQuantity of the MeterUsage request, and each UsageAllocation
-    #   must have a unique set of tags (include no tags).
+    #   The sum of all `UsageAllocation` quantities must equal the
+    #   `UsageQuantity` of the `MeterUsage` request, and each
+    #   `UsageAllocation` must have a unique set of tags (include no tags).
     #   @return [Array<Types::UsageAllocation>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsageRequest AWS API Documentation
@@ -432,7 +433,7 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # Contains input to the ResolveCustomer operation.
+    # Contains input to the `ResolveCustomer` operation.
     #
     # @note When making an API call, you may pass ResolveCustomerRequest
     #   data as a hash:
@@ -444,8 +445,8 @@ module Aws::MarketplaceMetering
     # @!attribute [rw] registration_token
     #   When a buyer visits your website during the registration process,
     #   the buyer submits a registration token through the browser. The
-    #   registration token is resolved to obtain a CustomerIdentifier and
-    #   product code.
+    #   registration token is resolved to obtain a `CustomerIdentifier`
+    #   along with the `CustomerAWSAccountId` and `ProductCode`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerRequest AWS API Documentation
@@ -456,32 +457,39 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # The result of the ResolveCustomer operation. Contains the
-    # CustomerIdentifier and product code.
+    # The result of the `ResolveCustomer` operation. Contains the
+    # `CustomerIdentifier` along with the `CustomerAWSAccountId` and
+    # `ProductCode`.
     #
     # @!attribute [rw] customer_identifier
-    #   The CustomerIdentifier is used to identify an individual customer in
-    #   your application. Calls to BatchMeterUsage require
-    #   CustomerIdentifiers for each UsageRecord.
+    #   The `CustomerIdentifier` is used to identify an individual customer
+    #   in your application. Calls to `BatchMeterUsage` require
+    #   `CustomerIdentifiers` for each `UsageRecord`.
     #   @return [String]
     #
     # @!attribute [rw] product_code
     #   The product code is returned to confirm that the buyer is
-    #   registering for your product. Subsequent BatchMeterUsage calls
+    #   registering for your product. Subsequent `BatchMeterUsage` calls
     #   should be made using this product code.
     #   @return [String]
     #
+    # @!attribute [rw] customer_aws_account_id
+    #   The `CustomerAWSAccountId` provides the AWS account ID associated
+    #   with the `CustomerIdentifier` for the individual customer.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerResult AWS API Documentation
     #
     class ResolveCustomerResult < Struct.new(
       :customer_identifier,
-      :product_code)
+      :product_code,
+      :customer_aws_account_id)
       SENSITIVE = []
       include Aws::Structure
     end
 
-    # Metadata assigned to an allocation. Each tag is made up of a key and a
-    # value.
+    # Metadata assigned to an allocation. Each tag is made up of a `key` and
+    # a `value`.
     #
     # @note When making an API call, you may pass Tag
     #   data as a hash:
@@ -492,14 +500,14 @@ module Aws::MarketplaceMetering
     #       }
     #
     # @!attribute [rw] key
-    #   One part of a key-value pair that makes up a tag. A key is a label
-    #   that acts like a category for the specific tag values.
+    #   One part of a key-value pair that makes up a `tag`. A `key` is a
+    #   label that acts like a category for the specific tag values.
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   One part of a key-value pair that makes up a tag. A value acts as a
-    #   descriptor within a tag category (key). The value can be empty or
-    #   null.
+    #   One part of a key-value pair that makes up a `tag`. A `value` acts
+    #   as a descriptor within a tag category (key). The value can be empty
+    #   or null.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/Tag AWS API Documentation
@@ -524,9 +532,13 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # The timestamp value passed in the meterUsage() is out of allowed
+    # The `timestamp` value passed in the `UsageRecord` is out of allowed
     # range.
     #
+    # For `BatchMeterUsage`, if any of the records are outside of the
+    # allowed range, the entire batch is not processed. You must remove
+    # invalid records and try again.
+    #
     # @!attribute [rw] message
     #   @return [String]
     #
@@ -540,7 +552,7 @@ module Aws::MarketplaceMetering
 
     # Usage allocations allow you to split usage into buckets by tags.
     #
-    # Each UsageAllocation indicates the usage quantity for a specific set
+    # Each `UsageAllocation` indicates the usage quantity for a specific set
     # of tags.
     #
     # @note When making an API call, you may pass UsageAllocation
@@ -574,11 +586,11 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # A UsageRecord indicates a quantity of usage for a given product,
+    # A `UsageRecord` indicates a quantity of usage for a given product,
     # customer, dimension and time.
     #
-    # Multiple requests with the same UsageRecords as input will be
-    # deduplicated to prevent double charges.
+    # Multiple requests with the same `UsageRecords` as input will be
+    # de-duplicated to prevent double charges.
     #
     # @note When making an API call, you may pass UsageRecord
     #   data as a hash:
@@ -605,19 +617,19 @@ module Aws::MarketplaceMetering
     #   Timestamp, in UTC, for which the usage is being reported.
     #
     #   Your application can meter usage for up to one hour in the past.
-    #   Make sure the timestamp value is not before the start of the
+    #   Make sure the `timestamp` value is not before the start of the
     #   software usage.
     #   @return [Time]
     #
     # @!attribute [rw] customer_identifier
-    #   The CustomerIdentifier is obtained through the ResolveCustomer
+    #   The `CustomerIdentifier` is obtained through the `ResolveCustomer`
     #   operation and represents an individual buyer in your application.
     #   @return [String]
     #
     # @!attribute [rw] dimension
-    #   During the process of registering a product on AWS Marketplace, up
-    #   to eight dimensions are specified. These represent different units
-    #   of value in your application.
+    #   During the process of registering a product on AWS Marketplace,
+    #   dimensions are specified. These represent different units of value
+    #   in your application.
     #   @return [String]
     #
     # @!attribute [rw] quantity
@@ -626,9 +638,9 @@ module Aws::MarketplaceMetering
     #   @return [Integer]
     #
     # @!attribute [rw] usage_allocations
-    #   The set of UsageAllocations to submit. The sum of all
-    #   UsageAllocation quantities must equal the Quantity of the
-    #   UsageRecord.
+    #   The set of `UsageAllocations` to submit. The sum of all
+    #   `UsageAllocation` quantities must equal the Quantity of the
+    #   `UsageRecord`.
     #   @return [Array<Types::UsageAllocation>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/UsageRecord AWS API Documentation
@@ -643,31 +655,40 @@ module Aws::MarketplaceMetering
       include Aws::Structure
     end
 
-    # A UsageRecordResult indicates the status of a given UsageRecord
-    # processed by BatchMeterUsage.
+    # A `UsageRecordResult` indicates the status of a given `UsageRecord`
+    # processed by `BatchMeterUsage`.
     #
     # @!attribute [rw] usage_record
-    #   The UsageRecord that was part of the BatchMeterUsage request.
+    #   The `UsageRecord` that was part of the `BatchMeterUsage` request.
     #   @return [Types::UsageRecord]
     #
     # @!attribute [rw] metering_record_id
-    #   The MeteringRecordId is a unique identifier for this metering event.
+    #   The `MeteringRecordId` is a unique identifier for this metering
+    #   event.
     #   @return [String]
     #
     # @!attribute [rw] status
-    #   The UsageRecordResult Status indicates the status of an individual
-    #   UsageRecord processed by BatchMeterUsage.
+    #   The `UsageRecordResult` `Status` indicates the status of an
+    #   individual `UsageRecord` processed by `BatchMeterUsage`.
+    #
+    #   * *Success*- The `UsageRecord` was accepted and honored by
+    #     `BatchMeterUsage`.
+    #
+    #   * *CustomerNotSubscribed*- The `CustomerIdentifier` specified is not
+    #     able to use your product. The `UsageRecord` was not honored. There
+    #     are three causes for this result:
+    #
+    #     * The customer identifier is invalid.
     #
-    #   * *Success*- The UsageRecord was accepted and honored by
-    #     BatchMeterUsage.
+    #     * The customer identifier provided in the metering record does not
+    #       have an active agreement or subscription with this product.
+    #       Future `UsageRecords` for this customer will fail until the
+    #       customer subscribes to your product.
     #
-    #   * *CustomerNotSubscribed*- The CustomerIdentifier specified is not
-    #     subscribed to your product. The UsageRecord was not honored.
-    #     Future UsageRecords for this customer will fail until the customer
-    #     subscribes to your product.
+    #     * The customer's AWS account was suspended.
     #
-    #   * *DuplicateRecord*- Indicates that the UsageRecord was invalid and
-    #     not honored. A previously metered UsageRecord had the same
+    #   * *DuplicateRecord*- Indicates that the `UsageRecord` was invalid
+    #     and not honored. A previously metered `UsageRecord` had the same
     #     customer, dimension, and time, but a different quantity.
     #   @return [String]
     #

data/lib/aws-sdk-marketplacemetering.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-marketplacemetering/customizations'
 # @!group service
 module Aws::MarketplaceMetering
 
-  GEM_VERSION = '1.41.0'
+  GEM_VERSION = '1.43.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-marketplacemetering
 version: !ruby/object:Gem::Version
-  version: 1.41.0
+  version: 1.43.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-02-03 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.125.0
+        version: 3.126.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.125.0
+        version: 3.126.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement