View Source AWS.MarketplaceMetering (aws-elixir v0.13.3)
AWS Marketplace Metering Service
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
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
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 theCustomerAWSAccountId
andProductCode
.
entitlement-and-metering-for-paid-container-products
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 callRegisterUsage
, but you can do so if you want to receive usage data in your seller reports. For more information on using theRegisterUsage
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.
Link to this section Summary
Functions
BatchMeterUsage
is called from a SaaS application listed on AWS Marketplace to
post metering records for a set of customers.
API to emit metering records.
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.
ResolveCustomer
is called by a SaaS application during the registration
process.
Link to this section Functions
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.
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 withRegisterUsage
is only required to guard against unauthorized use at container startup, as such aCustomerNotSubscribedException
orPlatformNotSupportedException
will only be thrown on the initial call toRegisterUsage
. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw aCustomerNotSubscribedException
, 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 callRegisterUsage
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.