The CustomerIdentifier and CustomerAWSAccountID are mutually exclusive parameters. You must use one or the other, but not both in the same API request. For new implementations, we recommend using the CustomerAWSAccountID. Your current integration will continue to work. When updating your implementation, consider migrating to CustomerAWSAccountID for improved integration.
To post metering records for customers, SaaS applications call BatchMeterUsage, which is used for metering SaaS flexible consumption pricing (FCP). Identical requests are idempotent and can be retried with the same records or a subset of records. Each BatchMeterUsage request is for only one product. If you want to meter usage for multiple products, you must make multiple BatchMeterUsage calls.
Usage records should be submitted in quick succession following a recorded event. Usage records aren't accepted 6 hours or more after an event.
BatchMeterUsage can process up to 25 UsageRecords at a time, and each request must be less than 1 MB in size. Optionally, you can have multiple usage allocations for usage data that's split into buckets according to predefined tags.
BatchMeterUsage returns a list of UsageRecordResult objects, which have each UsageRecord. It also returns a list of UnprocessedRecords, which indicate errors on the service side that should be retried.
For Amazon Web Services Regions that support BatchMeterUsage, see BatchMeterUsage Region support.
For an example of BatchMeterUsage, see BatchMeterUsage code example in the Amazon Web Services Marketplace Seller Guide.
As 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 Marketplace. You must use the following buyer Amazon Web Services account credentials to sign the API request.
For Amazon EC2 deployments, your software must use the IAM role for Amazon EC2 to sign the API call for MeterUsage API operation.
For Amazon EKS deployments, your software must use IAM roles for service accounts (IRSA) to sign the API call for the MeterUsage API operation. Using EKS Pod Identity, the node role, or long-term access keys is not supported.
For Amazon ECS deployments, your software must use Amazon ECS task IAM role to sign the API call for the MeterUsage API operation. Using the node role or long-term access keys are not supported.
For Amazon Bedrock AgentCore Runtime deployments, your software must use the AgentCore Runtime execution role to sign the API call for the MeterUsage API operation. Long-term access keys are not supported.
The handling of MeterUsage requests varies between Amazon Bedrock AgentCore Runtime and non-Amazon Bedrock AgentCore deployments.
For non-Amazon Bedrock AgentCore Runtime deployments, you can only report usage once per hour for each dimension. For AMI-based products, this is per dimension and per EC2 instance. For container products, this is per dimension and per ECS task or EKS pod. You can't modify values after they're recorded. If you report usage before a current hour ends, you will be unable to report additional usage until the next hour begins. The Timestamp request parameter is rounded down to the hour and used to enforce this once-per-hour rule for idempotency. For requests that are identical after the Timestamp is rounded down, the API is idempotent and returns the metering record ID.
For Amazon Bedrock AgentCore Runtime deployments, you can report usage multiple times per hour for the same dimension. You do not need to aggregate metering records by the hour. You must include an idempotency token in the ClientToken request parameter. If using an Amazon SDK or the Amazon Web Services CLI, you must use the latest version which automatically includes an idempotency token in the ClientToken request parameter so that the request is processed successfully. The Timestamp request parameter is not rounded down to the hour and is not used for duplicate validation. Requests with duplicate Timestamps are aggregated as long as the ClientToken is unique.
If you submit records more than six hours after events occur, the records won't be accepted. The timestamp in your request determines when an event is recorded.
You 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.
For Amazon Web Services Regions that support MeterUsage, see MeterUsage Region support for Amazon EC2 and MeterUsage Region support for Amazon ECS and Amazon EKS.
Paid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services 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 Amazon Web Services 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 for 10 tasks. Software metering is handled by the Amazon Web Services Marketplace metering control plane—your software is not required to perform metering-specific actions other than to call RegisterUsage to commence metering. The Amazon Web Services Marketplace metering control plane will also bill customers for running ECS tasks and Amazon EKS pods, regardless of the customer's subscription state, which removes the need for your software to run entitlement checks at runtime. For containers, RegisterUsage should be called immediately at launch. If you don’t register the container within the first 6 hours of the launch, Amazon Web Services Marketplace Metering Service doesn’t provide any metering guarantees for previous months. Metering will continue, however, for the current month forward until the container ends. RegisterUsage is for metering paid hourly container products.
For Amazon Web Services Regions that support RegisterUsage, see RegisterUsage Region support.
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.
To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using ResolveCustomer, see ResolveCustomer code example in the Amazon Web Services Marketplace Seller Guide.
Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the aws-marketplace:ResolveCustomer action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference.
For Amazon Web Services Regions that support ResolveCustomer, see ResolveCustomer Region support.
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 Amazon Web Services 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 Amazon Web Services 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.
Exception thrown when the customer does not have a valid subscription for the product.
", "exception":true }, "DisabledApiException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The API is disabled in the Region.
", "exception":true }, "DuplicateRequestException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp} with a different usageQuantity.
The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.
", "exception":true }, "IdempotencyConflictException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The ClientToken is being used for multiple requests.
An internal error has occurred. Retry your request. If the problem persists, post a message with details on the Amazon Web Services forums.
", "exception":true, "fault":true }, "InvalidCustomerIdentifierException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"You have metered usage for a CustomerIdentifier that does not exist.
The endpoint being called is in a Amazon Web Services Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the Amazon Web Services Region of the resource must match.
", "exception":true }, "InvalidProductCodeException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The product code passed does not match the product code used for publishing the product.
", "exception":true }, "InvalidPublicKeyVersionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"Public Key version is invalid.
", "exception":true }, "InvalidRegionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":" RegisterUsage must be called in the same Amazon Web Services Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.
The tag is invalid, or the number of tags is greater than 5.
", "exception":true }, "InvalidTokenException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"Registration token is invalid.
", "exception":true }, "InvalidUsageAllocationsException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"Sum of allocated usage quantities is not equal to the usage quantity.
", "exception":true }, "InvalidUsageDimensionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The usage dimension does not match one of the UsageDimensions associated with products.
Product code is used to uniquely identify a product in Amazon Web Services 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 six hours 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).
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotencyConflictException error.
Metering record id.
" } } }, "NonEmptyString":{ "type":"string", "pattern":"[\\s\\S]+" }, "Nonce":{ "type":"string", "max":255, "pattern":"[\\s\\S]*" }, "PlatformNotSupportedException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"Amazon Web Services Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and Fargate are supported.
", "exception":true }, "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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 calls to the API are throttled.
", "exception":true }, "Timestamp":{"type":"timestamp"}, "TimestampOutOfBoundsException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The timestamp value passed in the UsageRecord is out of allowed range.
For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.
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 six hours 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 Amazon Web Services 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.
The CustomerAWSAccountID parameter specifies the AWS account ID of the buyer.
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 Amazon Web Services 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 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 subscription (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 and ProductCode.
Called from: SaaS application during the registration process
Supported product type: SaaS
Vendor-metered tagging: Not applicable
Entitlement and metering for paid container products
RegisteredUsage
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.