This reference provides descriptions of the low-level Marketplace Metering Service API.
\nAmazon Web Services Marketplace sellers can use this API to submit usage data for custom usage\ndimensions.
\nFor 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\nSeller Guide.\n
\n\nSubmitting metering records\n
\n\nMeterUsage\n
\nSubmits the metering record for an Amazon Web Services Marketplace product.
\nCalled from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either\nAmazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)
\nSupported product types: Amazon Machine Images (AMIs) and containers
\nVendor-metered tagging: Supported allocation tagging
\n\nBatchMeterUsage\n
\nSubmits the metering record for a set of customers.\nBatchMeterUsage API calls are captured by CloudTrail. You can use\nCloudTrail to verify that the software as a service (SaaS) metering records that\nyou sent are accurate by searching for records with the eventName\nof BatchMeterUsage. You can also use CloudTrail to audit records over\ntime. For more information, see the CloudTrail User\nGuide.
Called from: SaaS applications
\nSupported product type: SaaS
\nVendor-metered tagging: Supports allocation tagging
\n\nAccepting new customers\n
\n\nResolveCustomer\n
\nResolves the registration token that the buyer submits through the browser\nduring the registration process. Obtains a CustomerIdentifier along\nwith the CustomerAWSAccountId, ProductCode, and LicenseArn.
Called from: SaaS application during the registration process
\nSupported product type: SaaS
\nVendor-metered tagging: Not applicable
\n\nEntitlement and metering for paid container\nproducts\n
\n\nRegisterUsage\n
\nProvides software entitlement and metering. Paid container software products\nsold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the\nRegisterUsage operation. Free and Bring Your Own License model\n(BYOL) products for Amazon ECS or Amazon EKS aren't required to call\nRegisterUsage. However, you can do so if you want to receive\nusage data in your seller reports. For more information about using the\nRegisterUsage operation, see Container-based products.
Called from: Paid container software products
\nSupported product type: Containers
\nVendor-metered tagging: Not applicable
\n\nEntitlement custom metering for container\nproducts\n
\nMeterUsage API is available in GovCloud Regions but only supports AMI\nFCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container\nproducts aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.\nFor more information, see Container-based products.
\nCustom metering for container products are called using the\nMeterUsage API. The API is used for FCP AMI and FCP Container product\nmetering.
\n\nCustom metering for Amazon EKS is available in 17\nAmazon Web Services Regions\n
\nThe metering service supports Amazon ECS and EKS for Flexible Consumption Pricing\n(FCP) products using MeterUsage API. Amazon ECS is supported in all\nAmazon Web Services Regions that MeterUsage API is available except for\nGovCloud.
\nAmazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,\nus-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,\nap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,\nca-central-1, sa-east-1.
\nFor questions about adding Amazon Web Services Regions for metering, contact Amazon Web Services\nMarketplace Seller Operations.
\n