AWSMarketplace Metering
Amazon Web Services Marketplace Metering Service This reference provides descriptions of the low-level Marketplace Metering Service API. Amazon Web Services…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Amazon Web Services Marketplace Metering Service
This reference provides descriptions of the low-level Marketplace Metering Service API.
Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
dimensions.
For information about the permissions that you need to use this API, see Amazon Web Services Marketplace metering and entitlement API permissions in the Amazon Web Services Marketplace
Seller Guide.
Submitting metering records
MeterUsage
Submits the metering record for an Amazon Web Services Marketplace product.
Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)
Supported product types: Amazon Machine Images (AMIs) and containers
Vendor-metered tagging: Supported allocation tagging
BatchMeterUsage
Submits the metering record for a set of customers.
BatchMeterUsage API calls are captured by CloudTrail. You can use
CloudTrail to verify that the software as a service (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 CloudTrail User
Guide .
Called from: SaaS applications
Supported product type: SaaS
Vendor-metered tagging: Supports allocation tagging
Accepting new customers
ResolveCustomer
Resolves the registration token that the buyer submits through the browser
during the registration process. Obtains a CustomerIdentifier along
with the CustomerAWSAccountId , ProductCode , and LicenseArn .
Called from: SaaS application during the registration process
Supported product type: SaaS
Vendor-metered tagging: Not applicable
Entitlement and metering for paid container
products
RegisterUsage
Provides software entitlement and metering. Paid container software products
sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
RegisterUsage operation. Free and Bring Your Own License model
(BYOL) products for Amazon ECS or Amazon EKS aren't required to call
RegisterUsage . However, you can do so if you want to receive
usage data in your seller reports. For more information about using the
RegisterUsage operation, see Container-based products .
Called from: Paid container software products
Supported product type: Containers
Vendor-metered tagging: Not applicable
Entitlement custom metering for container
products
MeterUsage API is available in GovCloud Regions but only supports AMI
FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
For more information, see Container-based products .
Custom metering for container products are called using the
MeterUsage API. The API is used for FCP AMI and FCP Container product
metering.
Custom metering for Amazon EKS is available in 17
Amazon Web Services Regions
The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
(FCP) products using MeterUsage API. Amazon ECS is supported in all
Amazon Web Services Regions that MeterUsage API is available except for
GovCloud.
Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
ca-central-1, sa-east-1.
For questions about adding Amazon Web Services Regions for metering, contact Amazon Web Services
Marketplace Seller Operations .
Endpoints 4
- POSTBatch meter usage
/#X-Amz-Target=AWSMPMeteringService.BatchMeterUsageThe Amazon Web Services Marketplace AI Metering Agent Skill ( aws-marketplace-metering ) helps an AI coding agent integrate your SaaS product's usage… - POSTMeter usage
/#X-Amz-Target=AWSMPMeteringService.MeterUsageAs a seller, your software hosted in the buyer's Amazon Web Services account uses this API action to emit metering records directly to Amazon Web Services… - POSTRegister usage
/#X-Amz-Target=AWSMPMeteringService.RegisterUsagePaid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services Marketplace Metering Service and… - POSTResolve customer
/#X-Amz-Target=AWSMPMeteringService.ResolveCustomerResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer…
API details
- Base URL
https://metering.marketplace.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 4 operations on 4 pathsPOST 4
- Description format
- AWS Smithy model, API version
2016-01-14 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWSMarketplace Metering in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWSMarketplace Metering collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Batch meter usage” (POST /#X-Amz-Target=AWSMPMeteringService.BatchMeterUsage), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWSMarketplace Metering?
Amazon Web Services Marketplace Metering Service This reference provides descriptions of the low-level Marketplace Metering Service API. Amazon Web Services… It is listed under Developer tools and has 4 endpoints.
Who publishes the AWSMarketplace Metering?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWSMarketplace Metering?
Requests go to https://metering.marketplace.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWSMarketplace Metering?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWSMarketplace Metering have?
4 operations on 4 paths (4 POST).
Is forking the AWSMarketplace Metering free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.