BatchMeterUsage is called from a SaaS application listed on the 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.
BatchMeterUsage can process up to 25 UsageRecords at a time.
" }, "MeterUsage":{ "name":"MeterUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"MeterUsageRequest"}, "output":{"shape":"MeterUsageResult"}, "errors":[ {"shape":"InternalServiceErrorException"}, {"shape":"InvalidProductCodeException"}, {"shape":"InvalidUsageDimensionException"}, {"shape":"InvalidEndpointRegionException"}, {"shape":"TimestampOutOfBoundsException"}, {"shape":"DuplicateRequestException"}, {"shape":"ThrottlingException"}, {"shape":"CustomerNotEntitledException"} ], "documentation":"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.
" }, "RegisterUsage":{ "name":"RegisterUsage", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RegisterUsageRequest"}, "output":{"shape":"RegisterUsageResult"}, "errors":[ {"shape":"InvalidProductCodeException"}, {"shape":"InvalidRegionException"}, {"shape":"InvalidPublicKeyVersionException"}, {"shape":"PlatformNotSupportedException"}, {"shape":"CustomerNotEntitledException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServiceErrorException"}, {"shape":"DisabledApiException"} ], "documentation":"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 with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/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: (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 call RegisterUsage 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 and product code.
" } }, "shapes":{ "BatchMeterUsageRequest":{ "type":"structure", "required":[ "UsageRecords", "ProductCode" ], "members":{ "UsageRecords":{ "shape":"UsageRecordList", "documentation":"The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
" }, "ProductCode":{ "shape":"ProductCode", "documentation":"Product code is used to uniquely identify a product in AWS 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.
" }, "BatchMeterUsageResult":{ "type":"structure", "members":{ "Results":{ "shape":"UsageRecordResultList", "documentation":"Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.
" }, "UnprocessedRecords":{ "shape":"UsageRecordList", "documentation":"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.
" } }, "documentation":"Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.
" }, "Boolean":{"type":"boolean"}, "CustomerIdentifier":{ "type":"string", "max":255, "min":1 }, "CustomerNotEntitledException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"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.
", "exception":true }, "ExpiredTokenException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"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 }, "InternalServiceErrorException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
", "exception":true, "fault":true }, "InvalidCustomerIdentifierException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"You have metered usage for a CustomerIdentifier that does not exist.
", "exception":true }, "InvalidEndpointRegionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS 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 AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.
", "exception":true }, "InvalidTokenException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"Registration token is invalid.
", "exception":true }, "InvalidUsageDimensionException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"The usage dimension does not match one of the UsageDimensions associated with products.
", "exception":true }, "MeterUsageRequest":{ "type":"structure", "required":[ "ProductCode", "Timestamp", "UsageDimension" ], "members":{ "ProductCode":{ "shape":"ProductCode", "documentation":"Product code is used to uniquely identify a product in AWS 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 one hour in the past. Make sure the timestamp value is not before the start of the software usage.
" }, "UsageDimension":{ "shape":"UsageDimension", "documentation":"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.
Metering record id.
" } } }, "NonEmptyString":{ "type":"string", "pattern":"\\S+" }, "Nonce":{ "type":"string", "max":255 }, "PlatformNotSupportedException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"AWS Marketplace does not support metering usage from the underlying platform. Currently, only Amazon ECS is supported.
", "exception":true }, "ProductCode":{ "type":"string", "max":255, "min":1 }, "RegisterUsageRequest":{ "type":"structure", "required":[ "ProductCode", "PublicKeyVersion" ], "members":{ "ProductCode":{ "shape":"ProductCode", "documentation":"Product code is used to uniquely identify a product in AWS 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 AWS 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 and product code.
" } }, "documentation":"Contains input to the ResolveCustomer operation.
" }, "ResolveCustomerResult":{ "type":"structure", "members":{ "CustomerIdentifier":{ "shape":"CustomerIdentifier", "documentation":"The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.
" }, "ProductCode":{ "shape":"ProductCode", "documentation":"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.
" } }, "documentation":"The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.
" }, "String":{"type":"string"}, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"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 meterUsage() is out of allowed range.
", "exception":true }, "UsageDimension":{ "type":"string", "max":255, "min":1 }, "UsageQuantity":{ "type":"integer", "max":2147483647, "min":0 }, "UsageRecord":{ "type":"structure", "required":[ "Timestamp", "CustomerIdentifier", "Dimension" ], "members":{ "Timestamp":{ "shape":"Timestamp", "documentation":"Timestamp, in UTC, for which the usage is being reported.
Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
" }, "CustomerIdentifier":{ "shape":"CustomerIdentifier", "documentation":"The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
" }, "Dimension":{ "shape":"UsageDimension", "documentation":"During the process of registering a product on AWS Marketplace, up to eight 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.
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 deduplicated to prevent double charges.
" }, "UsageRecordList":{ "type":"list", "member":{"shape":"UsageRecord"}, "max":25, "min":0 }, "UsageRecordResult":{ "type":"structure", "members":{ "UsageRecord":{ "shape":"UsageRecord", "documentation":"The UsageRecord that was part of the BatchMeterUsage request.
" }, "MeteringRecordId":{ "shape":"String", "documentation":"The MeteringRecordId is a unique identifier for this metering event.
" }, "Status":{ "shape":"UsageRecordResultStatus", "documentation":"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 subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.
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.
" }, "UsageRecordResultList":{ "type":"list", "member":{"shape":"UsageRecordResult"} }, "UsageRecordResultStatus":{ "type":"string", "enum":[ "Success", "CustomerNotSubscribed", "DuplicateRecord" ] }, "VersionInteger":{ "type":"integer", "min":1 }, "errorMessage":{"type":"string"} }, "documentation":"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 Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
MeterUsage- Submits the metering record for a 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 and Product Code.
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 call RegisterUsage, but you can do so if you want to receive usage data in your seller reports. For more information on using the RegisterUsage 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 .
" }