UsageRecord - AWS Marketplace Metering Service

UsageRecord

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.

Contents

Note

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

CustomerIdentifier

The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

Type: String

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

Pattern: [\s\S]+

Required: Yes

Dimension

During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

Type: String

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

Pattern: [\s\S]+

Required: Yes

Timestamp

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

Quantity

The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

Type: Integer

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

Required: No

UsageAllocations

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

Type: Array of UsageAllocation objects

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

Required: No

See Also

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