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 meter usage for multiple products, you must make multiple calls to BatchMeterUsage.
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.
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 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.
For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller Guide.
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 credentials from the EC2 instance, ECS task, or EKS pod.
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.
" }, "RegisterUsage": { "name": "RegisterUsage", "http": { "method": "POST", "requestUri": "/" }, "input": { "shape": "RegisterUsageRequest" }, "output": { "shape": "RegisterUsageResult" }, "errors": [ { "shape": "InvalidProductCodeException" }, { "shape": "InvalidRegionException" }, { "shape": "InvalidPublicKeyVersionException" }, { "shape": "PlatformNotSupportedException" }, { "shape": "CustomerNotEntitledException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" }, { "shape": "DisabledApiException" } ], "documentation": "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 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.
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 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.
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 along with the CustomerAWSAccountId and ProductCode.
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 in the AWS Marketplace Seller Guide.
The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
" } }, "documentation": "A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.
Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted.
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 the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.
Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
" }, "Timestamp": { "shape": "Timestamp", "documentation": "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.
It will be one of the fcp dimension name provided during the publishing of the product.
" }, "UsageQuantity": { "shape": "UsageQuantity", "documentation": "Consumption value for the hour. Defaults to 0 if not specified.
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.
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).
Metering record id.
" } } }, "NonEmptyString": { "type": "string", "pattern": "[\\s\\S]+" }, "Nonce": { "type": "string", "max": 255, "pattern": "[\\s\\S]*" }, "ProductCode": { "type": "string", "max": 255, "min": 1, "pattern": "^[-a-zA-Z0-9/=:_.@]*$" }, "RegisterUsageRequest": { "type": "structure", "required": [ "ProductCode", "PublicKeyVersion" ], "members": { "ProductCode": { "shape": "ProductCode", "documentation": "Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
" }, "PublicKeyVersion": { "shape": "VersionInteger", "documentation": "Public Key Version provided by AWS Marketplace
" }, "Nonce": { "shape": "Nonce", "documentation": "(Optional) To scope down the registration to a specific running software instance and guard against replay attacks.
" } } }, "RegisterUsageResult": { "type": "structure", "members": { "PublicKeyRotationTimestamp": { "shape": "Timestamp", "documentation": "(Optional) Only included when public key version has expired
" }, "Signature": { "shape": "NonEmptyString", "documentation": "JWT Token
" } } }, "ResolveCustomerRequest": { "type": "structure", "required": [ "RegistrationToken" ], "members": { "RegistrationToken": { "shape": "NonEmptyString", "documentation": "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 along with the CustomerAWSAccountId and ProductCode.
Contains input to the ResolveCustomer operation.
The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.
The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code.
The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.
The result of the ResolveCustomer operation. Contains the CustomerIdentifier along with the CustomerAWSAccountId and ProductCode.
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 value acts as a descriptor within a tag category (key). The value can be empty or null.
Metadata assigned to an allocation. Each tag is made up of a key and a value.
The total quantity allocated to this bucket of usage.
" }, "Tags": { "shape": "TagList", "documentation": "The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.
" } }, "documentation": "Usage allocations allow you to split usage into buckets by tags.
Each UsageAllocation indicates the usage quantity for a specific set of tags.
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 CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer 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.
" }, "Quantity": { "shape": "UsageQuantity", "documentation": "The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
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 de-duplicated to prevent double charges.
The UsageRecord that was part of the BatchMeterUsage request.
The MeteringRecordId is a unique identifier for this metering event.
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.
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.
The customer's AWS account was suspended.
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.
A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.
This reference provides descriptions of the low-level AWS Marketplace Metering Service API.
AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.
For information on the permissions you need to use this API, see AWS Marketplace metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
MeterUsage - Submits the metering record for an AWS Marketplace product. MeterUsage is called from an EC2 instance or a container running on EKS or ECS.
BatchMeterUsage - Submits the metering record for a set of customers. BatchMeterUsage is called from a software-as-a-service (SaaS) application.
Accepting New Customers
ResolveCustomer - 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 the browser. The Registration Token is resolved through this API to obtain a CustomerIdentifier along with the CustomerAWSAccountId and ProductCode.
Entitlement and Metering for Paid Container Products
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 and BYOL products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you can do so if you want to receive usage data in your seller reports. For more information on using the RegisterUsage operation, see Container-Based Products.
BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to verify that the SaaS metering records that you sent are accurate by searching for records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit records over time. For more information, see the AWS CloudTrail User Guide.