aws-sdk-marketplacemetering 1.40.0 → 1.44.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d224a10ea4e6d73e3cdae529416d0ada3800ba7d037cc2650fcf2cdf9bca303f
4
- data.tar.gz: 4c74e9b4eba5121d4b2eca9b95c4edf11d33f773f4ed4930c010aff6a57cbcfb
3
+ metadata.gz: 663edbacaf09ef3c96ea1c3de661ef9a4602853ce730368740efd1e52cdcd088
4
+ data.tar.gz: 4bce5c2685e76242c7ea8d06aefa16bae3d82f1b4e149e55d71d626f61679e6e
5
5
  SHA512:
6
- metadata.gz: d805b96dbdd845ecbce321a66a663e20b011c05dd3da753d66955ba61f6cf326df88c59e6201371e450196dea32902467d1a22ad9409e6fec49ea1b0541bbd6f
7
- data.tar.gz: 59477e70a379a8a12a3e3c4c49183e734721b40eb4a732dbcd532959dcc49c3b493db3fbee682192a578e8a4e7d704857a0616c28dde7ba19572f3fe1fe219f8
6
+ metadata.gz: 81f3ada521a4cd33361130f2521543c78c8c0bd57566beb9cbf71694c7c7c107944ab97a31c7d93ea18fd73ddb3d365ebcba2200362ebac24e8bfe8bb7a7b4ed
7
+ data.tar.gz: bedff6dde617349df845bec043b85f971643d325e1fa9d2a4e12fe6345b825a096376d6442f49052a51eb884181ba575144f57953034b5940c759577ae425676
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.44.0 (2022-02-24)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.43.0 (2022-02-03)
10
+ ------------------
11
+
12
+ * Feature - Add CustomerAWSAccountId to ResolveCustomer API response and increase UsageAllocation limit to 2500.
13
+
14
+ 1.42.0 (2022-02-03)
15
+ ------------------
16
+
17
+ * Feature - Add CustomerAWSAccountId to ResolveCustomer API response and increase UsageAllocation limit to 2500.
18
+
19
+ 1.41.0 (2021-12-21)
20
+ ------------------
21
+
22
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
23
+
4
24
  1.40.0 (2021-11-30)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.40.0
1
+ 1.44.0
@@ -27,6 +27,9 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
29
  require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
+ require 'aws-sdk-core/plugins/defaults_mode.rb'
32
+ require 'aws-sdk-core/plugins/recursion_detection.rb'
30
33
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
34
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
32
35
 
@@ -73,6 +76,9 @@ module Aws::MarketplaceMetering
73
76
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
77
  add_plugin(Aws::Plugins::TransferEncoding)
75
78
  add_plugin(Aws::Plugins::HttpChecksum)
79
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
+ add_plugin(Aws::Plugins::DefaultsMode)
81
+ add_plugin(Aws::Plugins::RecursionDetection)
76
82
  add_plugin(Aws::Plugins::SignatureV4)
77
83
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
78
84
 
@@ -175,6 +181,10 @@ module Aws::MarketplaceMetering
175
181
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
176
182
  # a clock skew correction and retry requests with skewed client clocks.
177
183
  #
184
+ # @option options [String] :defaults_mode ("legacy")
185
+ # See {Aws::DefaultsModeConfiguration} for a list of the
186
+ # accepted modes and the configuration defaults that are included.
187
+ #
178
188
  # @option options [Boolean] :disable_host_prefix_injection (false)
179
189
  # Set to true to disable SDK automatically adding host prefix
180
190
  # to default service endpoint when available.
@@ -307,7 +317,7 @@ module Aws::MarketplaceMetering
307
317
  # seconds to wait when opening a HTTP session before raising a
308
318
  # `Timeout::Error`.
309
319
  #
310
- # @option options [Integer] :http_read_timeout (60) The default
320
+ # @option options [Float] :http_read_timeout (60) The default
311
321
  # number of seconds to wait for response data. This value can
312
322
  # safely be set per-request on the session.
313
323
  #
@@ -323,6 +333,9 @@ module Aws::MarketplaceMetering
323
333
  # disables this behaviour. This value can safely be set per
324
334
  # request on the session.
325
335
  #
336
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
337
+ # in seconds.
338
+ #
326
339
  # @option options [Boolean] :http_wire_trace (false) When `true`,
327
340
  # HTTP debug output will be sent to the `:logger`.
328
341
  #
@@ -348,27 +361,45 @@ module Aws::MarketplaceMetering
348
361
 
349
362
  # @!group API Operations
350
363
 
351
- # BatchMeterUsage is called from a SaaS application listed on the AWS
364
+ # `BatchMeterUsage` is called from a SaaS application listed on AWS
352
365
  # Marketplace to post metering records for a set of customers.
353
366
  #
354
367
  # For identical requests, the API is idempotent; requests can be retried
355
368
  # with the same records or a subset of the input records.
356
369
  #
357
- # Every request to BatchMeterUsage is for one product. If you need to
370
+ # Every request to `BatchMeterUsage` is for one product. If you need to
358
371
  # meter usage for multiple products, you must make multiple calls to
359
- # BatchMeterUsage.
372
+ # `BatchMeterUsage`.
373
+ #
374
+ # Usage records are expected to be submitted as quickly as possible
375
+ # after the event that is being recorded, and are not accepted more than
376
+ # 6 hours after the event.
360
377
  #
361
- # BatchMeterUsage can process up to 25 UsageRecords at a time.
378
+ # `BatchMeterUsage` can process up to 25 `UsageRecords` at a time.
362
379
  #
363
- # A UsageRecord can optionally include multiple usage allocations, to
364
- # provide customers with usagedata split into buckets by tags that you
380
+ # A `UsageRecord` can optionally include multiple usage allocations, to
381
+ # provide customers with usage data split into buckets by tags that you
365
382
  # define (or allow the customer to define).
366
383
  #
367
- # BatchMeterUsage requests must be less than 1MB in size.
384
+ # `BatchMeterUsage` returns a list of `UsageRecordResult` objects,
385
+ # showing the result for each `UsageRecord`, as well as a list of
386
+ # `UnprocessedRecords`, indicating errors in the service side that you
387
+ # should retry.
388
+ #
389
+ # `BatchMeterUsage` requests must be less than 1MB in size.
390
+ #
391
+ # <note markdown="1"> For an example of using `BatchMeterUsage`, see [ BatchMeterUsage code
392
+ # example][1] in the *AWS Marketplace Seller Guide*.
393
+ #
394
+ # </note>
395
+ #
396
+ #
397
+ #
398
+ # [1]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example
368
399
  #
369
400
  # @option params [required, Array<Types::UsageRecord>] :usage_records
370
- # The set of UsageRecords to submit. BatchMeterUsage accepts up to 25
371
- # UsageRecords at a time.
401
+ # The set of `UsageRecords` to submit. `BatchMeterUsage` accepts up to
402
+ # 25 `UsageRecords` at a time.
372
403
  #
373
404
  # @option params [required, String] :product_code
374
405
  # Product code is used to uniquely identify a product in AWS
@@ -442,13 +473,17 @@ module Aws::MarketplaceMetering
442
473
  # API to emit metering records. For identical requests, the API is
443
474
  # idempotent. It simply returns the metering record ID.
444
475
  #
445
- # MeterUsage is authenticated on the buyer's AWS account using
476
+ # `MeterUsage` is authenticated on the buyer's AWS account using
446
477
  # credentials from the EC2 instance, ECS task, or EKS pod.
447
478
  #
448
- # MeterUsage can optionally include multiple usage allocations, to
479
+ # `MeterUsage` can optionally include multiple usage allocations, to
449
480
  # provide customers with usage data split into buckets by tags that you
450
481
  # define (or allow the customer to define).
451
482
  #
483
+ # Usage records are expected to be submitted as quickly as possible
484
+ # after the event that is being recorded, and are not accepted more than
485
+ # 6 hours after the event.
486
+ #
452
487
  # @option params [required, String] :product_code
453
488
  # Product code is used to uniquely identify a product in AWS
454
489
  # Marketplace. The product code should be the same as the one used
@@ -457,7 +492,7 @@ module Aws::MarketplaceMetering
457
492
  # @option params [required, Time,DateTime,Date,Integer,String] :timestamp
458
493
  # Timestamp, in UTC, for which the usage is being reported. Your
459
494
  # application can meter usage for up to one hour in the past. Make sure
460
- # the timestamp value is not before the start of the software usage.
495
+ # the `timestamp` value is not before the start of the software usage.
461
496
  #
462
497
  # @option params [required, String] :usage_dimension
463
498
  # It will be one of the fcp dimension name provided during the
@@ -469,15 +504,15 @@ module Aws::MarketplaceMetering
469
504
  # @option params [Boolean] :dry_run
470
505
  # Checks whether you have the permissions required for the action, but
471
506
  # does not make the request. If you have the permissions, the request
472
- # returns DryRunOperation; otherwise, it returns UnauthorizedException.
473
- # Defaults to `false` if not specified.
507
+ # returns `DryRunOperation`; otherwise, it returns
508
+ # `UnauthorizedException`. Defaults to `false` if not specified.
474
509
  #
475
510
  # @option params [Array<Types::UsageAllocation>] :usage_allocations
476
- # The set of UsageAllocations to submit.
511
+ # The set of `UsageAllocations` to submit.
477
512
  #
478
- # The sum of all UsageAllocation quantities must equal the UsageQuantity
479
- # of the MeterUsage request, and each UsageAllocation must have a unique
480
- # set of tags (include no tags).
513
+ # The sum of all `UsageAllocation` quantities must equal the
514
+ # `UsageQuantity` of the `MeterUsage` request, and each
515
+ # `UsageAllocation` must have a unique set of tags (include no tags).
481
516
  #
482
517
  # @return [Types::MeterUsageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
483
518
  #
@@ -519,26 +554,26 @@ module Aws::MarketplaceMetering
519
554
 
520
555
  # Paid container software products sold through AWS Marketplace must
521
556
  # integrate with the AWS Marketplace Metering Service and call the
522
- # RegisterUsage operation for software entitlement and metering. Free
557
+ # `RegisterUsage` operation for software entitlement and metering. Free
523
558
  # and BYOL products for Amazon ECS or Amazon EKS aren't required to
524
- # call RegisterUsage, but you may choose to do so if you would like to
559
+ # call `RegisterUsage`, but you may choose to do so if you would like to
525
560
  # receive usage data in your seller reports. The sections below explain
526
- # the behavior of RegisterUsage. RegisterUsage performs two primary
561
+ # the behavior of `RegisterUsage`. `RegisterUsage` performs two primary
527
562
  # functions: metering and entitlement.
528
563
  #
529
- # * *Entitlement*\: RegisterUsage allows you to verify that the customer
530
- # running your paid software is subscribed to your product on AWS
531
- # Marketplace, enabling you to guard against unauthorized use. Your
532
- # container image that integrates with RegisterUsage is only required
533
- # to guard against unauthorized use at container startup, as such a
534
- # CustomerNotSubscribedException/PlatformNotSupportedException will
535
- # only be thrown on the initial call to RegisterUsage. Subsequent
536
- # calls from the same Amazon ECS task instance (e.g. task-id) or
537
- # Amazon EKS pod will not throw a CustomerNotSubscribedException, even
538
- # if the customer unsubscribes while the Amazon ECS task or Amazon EKS
539
- # pod is still running.
540
- #
541
- # * *Metering*\: RegisterUsage meters software use per ECS task, per
564
+ # * *Entitlement*\: `RegisterUsage` allows you to verify that the
565
+ # customer running your paid software is subscribed to your product on
566
+ # AWS Marketplace, enabling you to guard against unauthorized use.
567
+ # Your container image that integrates with `RegisterUsage` is only
568
+ # required to guard against unauthorized use at container startup, as
569
+ # such a `CustomerNotSubscribedException` or
570
+ # `PlatformNotSupportedException` will only be thrown on the initial
571
+ # call to `RegisterUsage`. Subsequent calls from the same Amazon ECS
572
+ # task instance (e.g. task-id) or Amazon EKS pod will not throw a
573
+ # `CustomerNotSubscribedException`, even if the customer unsubscribes
574
+ # while the Amazon ECS task or Amazon EKS pod is still running.
575
+ #
576
+ # * *Metering*\: `RegisterUsage` meters software use per ECS task, per
542
577
  # hour, or per pod for Amazon EKS with usage prorated to the second. A
543
578
  # minimum of 1 minute of usage applies to tasks that are short lived.
544
579
  # For example, if a customer has a 10 node Amazon ECS or Amazon EKS
@@ -547,7 +582,7 @@ module Aws::MarketplaceMetering
547
582
  # customer will be charged: (10 * hourly\_rate). Metering for
548
583
  # software use is automatically handled by the AWS Marketplace
549
584
  # Metering Control Plane -- your software is not required to perform
550
- # any metering specific actions, other than call RegisterUsage once
585
+ # any metering specific actions, other than call `RegisterUsage` once
551
586
  # for metering of software use to commence. The AWS Marketplace
552
587
  # Metering Control Plane will also continue to bill customers for
553
588
  # running ECS tasks and Amazon EKS pods, regardless of the customers
@@ -593,22 +628,36 @@ module Aws::MarketplaceMetering
593
628
  req.send_request(options)
594
629
  end
595
630
 
596
- # ResolveCustomer is called by a SaaS application during the
631
+ # `ResolveCustomer` is called by a SaaS application during the
597
632
  # registration process. When a buyer visits your website during the
598
633
  # registration process, the buyer submits a registration token through
599
634
  # their browser. The registration token is resolved through this API to
600
- # obtain a CustomerIdentifier and product code.
635
+ # obtain a `CustomerIdentifier` along with the `CustomerAWSAccountId`
636
+ # and `ProductCode`.
637
+ #
638
+ # <note markdown="1"> The API needs to called from the seller account id used to publish the
639
+ # SaaS application to successfully resolve the token.
640
+ #
641
+ # For an example of using `ResolveCustomer`, see [ ResolveCustomer code
642
+ # example][1] in the *AWS Marketplace Seller Guide*.
643
+ #
644
+ # </note>
645
+ #
646
+ #
647
+ #
648
+ # [1]: https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example
601
649
  #
602
650
  # @option params [required, String] :registration_token
603
651
  # When a buyer visits your website during the registration process, the
604
652
  # buyer submits a registration token through the browser. The
605
- # registration token is resolved to obtain a CustomerIdentifier and
606
- # product code.
653
+ # registration token is resolved to obtain a `CustomerIdentifier` along
654
+ # with the `CustomerAWSAccountId` and `ProductCode`.
607
655
  #
608
656
  # @return [Types::ResolveCustomerResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
609
657
  #
610
658
  # * {Types::ResolveCustomerResult#customer_identifier #customer_identifier} => String
611
659
  # * {Types::ResolveCustomerResult#product_code #product_code} => String
660
+ # * {Types::ResolveCustomerResult#customer_aws_account_id #customer_aws_account_id} => String
612
661
  #
613
662
  # @example Request syntax with placeholder values
614
663
  #
@@ -620,6 +669,7 @@ module Aws::MarketplaceMetering
620
669
  #
621
670
  # resp.customer_identifier #=> String
622
671
  # resp.product_code #=> String
672
+ # resp.customer_aws_account_id #=> String
623
673
  #
624
674
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomer AWS API Documentation
625
675
  #
@@ -643,7 +693,7 @@ module Aws::MarketplaceMetering
643
693
  params: params,
644
694
  config: config)
645
695
  context[:gem_name] = 'aws-sdk-marketplacemetering'
646
- context[:gem_version] = '1.40.0'
696
+ context[:gem_version] = '1.44.0'
647
697
  Seahorse::Client::Request.new(handlers, context)
648
698
  end
649
699
 
@@ -17,6 +17,7 @@ module Aws::MarketplaceMetering
17
17
  BatchMeterUsageRequest = Shapes::StructureShape.new(name: 'BatchMeterUsageRequest')
18
18
  BatchMeterUsageResult = Shapes::StructureShape.new(name: 'BatchMeterUsageResult')
19
19
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
20
+ CustomerAWSAccountId = Shapes::StringShape.new(name: 'CustomerAWSAccountId')
20
21
  CustomerIdentifier = Shapes::StringShape.new(name: 'CustomerIdentifier')
21
22
  CustomerNotEntitledException = Shapes::StructureShape.new(name: 'CustomerNotEntitledException')
22
23
  DisabledApiException = Shapes::StructureShape.new(name: 'DisabledApiException')
@@ -140,6 +141,7 @@ module Aws::MarketplaceMetering
140
141
 
141
142
  ResolveCustomerResult.add_member(:customer_identifier, Shapes::ShapeRef.new(shape: CustomerIdentifier, location_name: "CustomerIdentifier"))
142
143
  ResolveCustomerResult.add_member(:product_code, Shapes::ShapeRef.new(shape: ProductCode, location_name: "ProductCode"))
144
+ ResolveCustomerResult.add_member(:customer_aws_account_id, Shapes::ShapeRef.new(shape: CustomerAWSAccountId, location_name: "CustomerAWSAccountId"))
143
145
  ResolveCustomerResult.struct_class = Types::ResolveCustomerResult
144
146
 
145
147
  Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "Key"))
@@ -10,7 +10,7 @@
10
10
  module Aws::MarketplaceMetering
11
11
  module Types
12
12
 
13
- # A BatchMeterUsageRequest contains UsageRecords, which indicate
13
+ # A `BatchMeterUsageRequest` contains `UsageRecords`, which indicate
14
14
  # quantities of usage within your application.
15
15
  #
16
16
  # @note When making an API call, you may pass BatchMeterUsageRequest
@@ -40,8 +40,8 @@ module Aws::MarketplaceMetering
40
40
  # }
41
41
  #
42
42
  # @!attribute [rw] usage_records
43
- # The set of UsageRecords to submit. BatchMeterUsage accepts up to 25
44
- # UsageRecords at a time.
43
+ # The set of `UsageRecords` to submit. `BatchMeterUsage` accepts up to
44
+ # 25 `UsageRecords` at a time.
45
45
  # @return [Array<Types::UsageRecord>]
46
46
  #
47
47
  # @!attribute [rw] product_code
@@ -59,20 +59,21 @@ module Aws::MarketplaceMetering
59
59
  include Aws::Structure
60
60
  end
61
61
 
62
- # Contains the UsageRecords processed by BatchMeterUsage and any records
63
- # that have failed due to transient error.
62
+ # Contains the `UsageRecords` processed by `BatchMeterUsage` and any
63
+ # records that have failed due to transient error.
64
64
  #
65
65
  # @!attribute [rw] results
66
- # Contains all UsageRecords processed by BatchMeterUsage. These
66
+ # Contains all `UsageRecords` processed by `BatchMeterUsage`. These
67
67
  # records were either honored by AWS Marketplace Metering Service or
68
- # were invalid.
68
+ # were invalid. Invalid records should be fixed before being
69
+ # resubmitted.
69
70
  # @return [Array<Types::UsageRecordResult>]
70
71
  #
71
72
  # @!attribute [rw] unprocessed_records
72
- # Contains all UsageRecords that were not processed by
73
- # BatchMeterUsage. This is a list of UsageRecords. You can retry the
74
- # failed request by making another BatchMeterUsage call with this list
75
- # as input in the BatchMeterUsageRequest.
73
+ # Contains all `UsageRecords` that were not processed by
74
+ # `BatchMeterUsage`. This is a list of `UsageRecords`. You can retry
75
+ # the failed request by making another `BatchMeterUsage` call with
76
+ # this list as input in the `BatchMeterUsageRequest`.
76
77
  # @return [Array<Types::UsageRecord>]
77
78
  #
78
79
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/BatchMeterUsageResult AWS API Documentation
@@ -112,8 +113,8 @@ module Aws::MarketplaceMetering
112
113
  end
113
114
 
114
115
  # A metering record has already been emitted by the same EC2 instance,
115
- # ECS task, or EKS pod for the given \\\{usageDimension, timestamp\\}
116
- # with a different usageQuantity.
116
+ # ECS task, or EKS pod for the given \\\{`usageDimension`,
117
+ # `timestamp`\\} with a different `usageQuantity`.
117
118
  #
118
119
  # @!attribute [rw] message
119
120
  # @return [String]
@@ -158,7 +159,7 @@ module Aws::MarketplaceMetering
158
159
  include Aws::Structure
159
160
  end
160
161
 
161
- # You have metered usage for a CustomerIdentifier that does not exist.
162
+ # You have metered usage for a `CustomerIdentifier` that does not exist.
162
163
  #
163
164
  # @!attribute [rw] message
164
165
  # @return [String]
@@ -213,9 +214,9 @@ module Aws::MarketplaceMetering
213
214
  include Aws::Structure
214
215
  end
215
216
 
216
- # RegisterUsage must be called in the same AWS Region the ECS task was
217
+ # `RegisterUsage` must be called in the same AWS Region the ECS task was
217
218
  # launched in. This prevents a container from hardcoding a Region (e.g.
218
- # withRegion(“us-east-1”) when calling RegisterUsage.
219
+ # withRegion(“us-east-1”) when calling `RegisterUsage`.
219
220
  #
220
221
  # @!attribute [rw] message
221
222
  # @return [String]
@@ -268,7 +269,7 @@ module Aws::MarketplaceMetering
268
269
  include Aws::Structure
269
270
  end
270
271
 
271
- # The usage dimension does not match one of the UsageDimensions
272
+ # The usage dimension does not match one of the `UsageDimensions`
272
273
  # associated with products.
273
274
  #
274
275
  # @!attribute [rw] message
@@ -313,7 +314,7 @@ module Aws::MarketplaceMetering
313
314
  # @!attribute [rw] timestamp
314
315
  # Timestamp, in UTC, for which the usage is being reported. Your
315
316
  # application can meter usage for up to one hour in the past. Make
316
- # sure the timestamp value is not before the start of the software
317
+ # sure the `timestamp` value is not before the start of the software
317
318
  # usage.
318
319
  # @return [Time]
319
320
  #
@@ -329,16 +330,16 @@ module Aws::MarketplaceMetering
329
330
  # @!attribute [rw] dry_run
330
331
  # Checks whether you have the permissions required for the action, but
331
332
  # does not make the request. If you have the permissions, the request
332
- # returns DryRunOperation; otherwise, it returns
333
- # UnauthorizedException. Defaults to `false` if not specified.
333
+ # returns `DryRunOperation`; otherwise, it returns
334
+ # `UnauthorizedException`. Defaults to `false` if not specified.
334
335
  # @return [Boolean]
335
336
  #
336
337
  # @!attribute [rw] usage_allocations
337
- # The set of UsageAllocations to submit.
338
+ # The set of `UsageAllocations` to submit.
338
339
  #
339
- # The sum of all UsageAllocation quantities must equal the
340
- # UsageQuantity of the MeterUsage request, and each UsageAllocation
341
- # must have a unique set of tags (include no tags).
340
+ # The sum of all `UsageAllocation` quantities must equal the
341
+ # `UsageQuantity` of the `MeterUsage` request, and each
342
+ # `UsageAllocation` must have a unique set of tags (include no tags).
342
343
  # @return [Array<Types::UsageAllocation>]
343
344
  #
344
345
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/MeterUsageRequest AWS API Documentation
@@ -432,7 +433,7 @@ module Aws::MarketplaceMetering
432
433
  include Aws::Structure
433
434
  end
434
435
 
435
- # Contains input to the ResolveCustomer operation.
436
+ # Contains input to the `ResolveCustomer` operation.
436
437
  #
437
438
  # @note When making an API call, you may pass ResolveCustomerRequest
438
439
  # data as a hash:
@@ -444,8 +445,8 @@ module Aws::MarketplaceMetering
444
445
  # @!attribute [rw] registration_token
445
446
  # When a buyer visits your website during the registration process,
446
447
  # the buyer submits a registration token through the browser. The
447
- # registration token is resolved to obtain a CustomerIdentifier and
448
- # product code.
448
+ # registration token is resolved to obtain a `CustomerIdentifier`
449
+ # along with the `CustomerAWSAccountId` and `ProductCode`.
449
450
  # @return [String]
450
451
  #
451
452
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerRequest AWS API Documentation
@@ -456,32 +457,39 @@ module Aws::MarketplaceMetering
456
457
  include Aws::Structure
457
458
  end
458
459
 
459
- # The result of the ResolveCustomer operation. Contains the
460
- # CustomerIdentifier and product code.
460
+ # The result of the `ResolveCustomer` operation. Contains the
461
+ # `CustomerIdentifier` along with the `CustomerAWSAccountId` and
462
+ # `ProductCode`.
461
463
  #
462
464
  # @!attribute [rw] customer_identifier
463
- # The CustomerIdentifier is used to identify an individual customer in
464
- # your application. Calls to BatchMeterUsage require
465
- # CustomerIdentifiers for each UsageRecord.
465
+ # The `CustomerIdentifier` is used to identify an individual customer
466
+ # in your application. Calls to `BatchMeterUsage` require
467
+ # `CustomerIdentifiers` for each `UsageRecord`.
466
468
  # @return [String]
467
469
  #
468
470
  # @!attribute [rw] product_code
469
471
  # The product code is returned to confirm that the buyer is
470
- # registering for your product. Subsequent BatchMeterUsage calls
472
+ # registering for your product. Subsequent `BatchMeterUsage` calls
471
473
  # should be made using this product code.
472
474
  # @return [String]
473
475
  #
476
+ # @!attribute [rw] customer_aws_account_id
477
+ # The `CustomerAWSAccountId` provides the AWS account ID associated
478
+ # with the `CustomerIdentifier` for the individual customer.
479
+ # @return [String]
480
+ #
474
481
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/ResolveCustomerResult AWS API Documentation
475
482
  #
476
483
  class ResolveCustomerResult < Struct.new(
477
484
  :customer_identifier,
478
- :product_code)
485
+ :product_code,
486
+ :customer_aws_account_id)
479
487
  SENSITIVE = []
480
488
  include Aws::Structure
481
489
  end
482
490
 
483
- # Metadata assigned to an allocation. Each tag is made up of a key and a
484
- # value.
491
+ # Metadata assigned to an allocation. Each tag is made up of a `key` and
492
+ # a `value`.
485
493
  #
486
494
  # @note When making an API call, you may pass Tag
487
495
  # data as a hash:
@@ -492,14 +500,14 @@ module Aws::MarketplaceMetering
492
500
  # }
493
501
  #
494
502
  # @!attribute [rw] key
495
- # One part of a key-value pair that makes up a tag. A key is a label
496
- # that acts like a category for the specific tag values.
503
+ # One part of a key-value pair that makes up a `tag`. A `key` is a
504
+ # label that acts like a category for the specific tag values.
497
505
  # @return [String]
498
506
  #
499
507
  # @!attribute [rw] value
500
- # One part of a key-value pair that makes up a tag. A value acts as a
501
- # descriptor within a tag category (key). The value can be empty or
502
- # null.
508
+ # One part of a key-value pair that makes up a `tag`. A `value` acts
509
+ # as a descriptor within a tag category (key). The value can be empty
510
+ # or null.
503
511
  # @return [String]
504
512
  #
505
513
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/Tag AWS API Documentation
@@ -524,9 +532,13 @@ module Aws::MarketplaceMetering
524
532
  include Aws::Structure
525
533
  end
526
534
 
527
- # The timestamp value passed in the meterUsage() is out of allowed
535
+ # The `timestamp` value passed in the `UsageRecord` is out of allowed
528
536
  # range.
529
537
  #
538
+ # For `BatchMeterUsage`, if any of the records are outside of the
539
+ # allowed range, the entire batch is not processed. You must remove
540
+ # invalid records and try again.
541
+ #
530
542
  # @!attribute [rw] message
531
543
  # @return [String]
532
544
  #
@@ -540,7 +552,7 @@ module Aws::MarketplaceMetering
540
552
 
541
553
  # Usage allocations allow you to split usage into buckets by tags.
542
554
  #
543
- # Each UsageAllocation indicates the usage quantity for a specific set
555
+ # Each `UsageAllocation` indicates the usage quantity for a specific set
544
556
  # of tags.
545
557
  #
546
558
  # @note When making an API call, you may pass UsageAllocation
@@ -574,11 +586,11 @@ module Aws::MarketplaceMetering
574
586
  include Aws::Structure
575
587
  end
576
588
 
577
- # A UsageRecord indicates a quantity of usage for a given product,
589
+ # A `UsageRecord` indicates a quantity of usage for a given product,
578
590
  # customer, dimension and time.
579
591
  #
580
- # Multiple requests with the same UsageRecords as input will be
581
- # deduplicated to prevent double charges.
592
+ # Multiple requests with the same `UsageRecords` as input will be
593
+ # de-duplicated to prevent double charges.
582
594
  #
583
595
  # @note When making an API call, you may pass UsageRecord
584
596
  # data as a hash:
@@ -605,19 +617,19 @@ module Aws::MarketplaceMetering
605
617
  # Timestamp, in UTC, for which the usage is being reported.
606
618
  #
607
619
  # Your application can meter usage for up to one hour in the past.
608
- # Make sure the timestamp value is not before the start of the
620
+ # Make sure the `timestamp` value is not before the start of the
609
621
  # software usage.
610
622
  # @return [Time]
611
623
  #
612
624
  # @!attribute [rw] customer_identifier
613
- # The CustomerIdentifier is obtained through the ResolveCustomer
625
+ # The `CustomerIdentifier` is obtained through the `ResolveCustomer`
614
626
  # operation and represents an individual buyer in your application.
615
627
  # @return [String]
616
628
  #
617
629
  # @!attribute [rw] dimension
618
- # During the process of registering a product on AWS Marketplace, up
619
- # to eight dimensions are specified. These represent different units
620
- # of value in your application.
630
+ # During the process of registering a product on AWS Marketplace,
631
+ # dimensions are specified. These represent different units of value
632
+ # in your application.
621
633
  # @return [String]
622
634
  #
623
635
  # @!attribute [rw] quantity
@@ -626,9 +638,9 @@ module Aws::MarketplaceMetering
626
638
  # @return [Integer]
627
639
  #
628
640
  # @!attribute [rw] usage_allocations
629
- # The set of UsageAllocations to submit. The sum of all
630
- # UsageAllocation quantities must equal the Quantity of the
631
- # UsageRecord.
641
+ # The set of `UsageAllocations` to submit. The sum of all
642
+ # `UsageAllocation` quantities must equal the Quantity of the
643
+ # `UsageRecord`.
632
644
  # @return [Array<Types::UsageAllocation>]
633
645
  #
634
646
  # @see http://docs.aws.amazon.com/goto/WebAPI/meteringmarketplace-2016-01-14/UsageRecord AWS API Documentation
@@ -643,31 +655,40 @@ module Aws::MarketplaceMetering
643
655
  include Aws::Structure
644
656
  end
645
657
 
646
- # A UsageRecordResult indicates the status of a given UsageRecord
647
- # processed by BatchMeterUsage.
658
+ # A `UsageRecordResult` indicates the status of a given `UsageRecord`
659
+ # processed by `BatchMeterUsage`.
648
660
  #
649
661
  # @!attribute [rw] usage_record
650
- # The UsageRecord that was part of the BatchMeterUsage request.
662
+ # The `UsageRecord` that was part of the `BatchMeterUsage` request.
651
663
  # @return [Types::UsageRecord]
652
664
  #
653
665
  # @!attribute [rw] metering_record_id
654
- # The MeteringRecordId is a unique identifier for this metering event.
666
+ # The `MeteringRecordId` is a unique identifier for this metering
667
+ # event.
655
668
  # @return [String]
656
669
  #
657
670
  # @!attribute [rw] status
658
- # The UsageRecordResult Status indicates the status of an individual
659
- # UsageRecord processed by BatchMeterUsage.
671
+ # The `UsageRecordResult` `Status` indicates the status of an
672
+ # individual `UsageRecord` processed by `BatchMeterUsage`.
673
+ #
674
+ # * *Success*- The `UsageRecord` was accepted and honored by
675
+ # `BatchMeterUsage`.
676
+ #
677
+ # * *CustomerNotSubscribed*- The `CustomerIdentifier` specified is not
678
+ # able to use your product. The `UsageRecord` was not honored. There
679
+ # are three causes for this result:
680
+ #
681
+ # * The customer identifier is invalid.
660
682
  #
661
- # * *Success*- The UsageRecord was accepted and honored by
662
- # BatchMeterUsage.
683
+ # * The customer identifier provided in the metering record does not
684
+ # have an active agreement or subscription with this product.
685
+ # Future `UsageRecords` for this customer will fail until the
686
+ # customer subscribes to your product.
663
687
  #
664
- # * *CustomerNotSubscribed*- The CustomerIdentifier specified is not
665
- # subscribed to your product. The UsageRecord was not honored.
666
- # Future UsageRecords for this customer will fail until the customer
667
- # subscribes to your product.
688
+ # * The customer's AWS account was suspended.
668
689
  #
669
- # * *DuplicateRecord*- Indicates that the UsageRecord was invalid and
670
- # not honored. A previously metered UsageRecord had the same
690
+ # * *DuplicateRecord*- Indicates that the `UsageRecord` was invalid
691
+ # and not honored. A previously metered `UsageRecord` had the same
671
692
  # customer, dimension, and time, but a different quantity.
672
693
  # @return [String]
673
694
  #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-marketplacemetering/customizations'
48
48
  # @!group service
49
49
  module Aws::MarketplaceMetering
50
50
 
51
- GEM_VERSION = '1.40.0'
51
+ GEM_VERSION = '1.44.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-marketplacemetering
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.40.0
4
+ version: 1.44.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-11-30 00:00:00.000000000 Z
11
+ date: 2022-02-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.122.0
22
+ version: 3.127.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.122.0
32
+ version: 3.127.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement