MeterUsage - AWS Marketplace Metering Service


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.

MeterUsage 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).

Request Syntax

{ "DryRun": boolean, "ProductCode": "string", "Timestamp": number, "UsageAllocations": [ { "AllocatedUsageQuantity": number, "Tags": [ { "Key": "string", "Value": "string" } ] } ], "UsageDimension": "string", "UsageQuantity": number }

Request Parameters

The request accepts the following data in JSON format.


In the following list, the required parameters are described first.


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]+

Required: Yes


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.

Type: Timestamp

Required: Yes


It will be one of the fcp dimension name provided during the publishing of the product.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\s\S]+

Required: Yes


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.

Type: Boolean

Required: No


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).

Type: Array of UsageAllocation objects

Array Members: Minimum number of 1 item. Maximum number of 500 items.

Required: No


Consumption value for the hour. Defaults to 0 if not specified.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: No

Response Syntax

{ "MeteringRecordId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Metering record id.

Type: String


For information about the errors that are common to all actions, see Common Errors.


Exception thrown when the customer does not have a valid subscription for the product.

HTTP Status Code: 400


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.

HTTP Status Code: 400


An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

HTTP Status Code: 500


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.

HTTP Status Code: 400


The product code passed does not match the product code used for publishing the product.

HTTP Status Code: 400


The tag is invalid, or the number of tags is greater than 5.

HTTP Status Code: 400


The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

HTTP Status Code: 400


The usage dimension does not match one of the UsageDimensions associated with products.

HTTP Status Code: 400


The calls to the API are throttled.

HTTP Status Code: 400


The timestamp value passed in the meterUsage() is out of allowed range.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: