Expand description
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
andProductCode
.
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.
Crate Organization
The entry point for most customers will be Client
. Client
exposes one method for each API offered
by the service.
Some APIs require complex or nested arguments. These exist in model
.
Lastly, errors that can be returned by the service are contained within error
. Error
defines a meta
error encompassing all possible errors that can be returned by the service.
The other modules within this crate are not required for normal usage.