AWS Marketplace Metering Service
API Reference (API Version 2016-01-14)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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, generally when running from an EC2 instance on the AWS Marketplace.

Request Syntax

{ "DryRun": boolean, "ProductCode": "string", "Timestamp": number, "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.

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.

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


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.


A metering record has already been emitted by the same EC2 instance 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 Region different from your EC2 instance. The Region of the Metering Service endpoint and the Region of the EC2 instance 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 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: