We are excited to announce our new API Documentation.
AWS SDK for JavaScript MarketplaceMetering Client for Node.js, Browser and React Native.
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 Marketplace metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
MeterUsage - Submits the metering record for an AWS
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
along with the CustomerAWSAccountId and
ProductCode.
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.
To install the this package, simply type add or install @aws-sdk/client-marketplace-metering using your favorite package manager:
npm install @aws-sdk/client-marketplace-meteringyarn add @aws-sdk/client-marketplace-meteringpnpm add @aws-sdk/client-marketplace-meteringThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the MarketplaceMeteringClient and
the commands you need, for example ResolveCustomerCommand:
// ES5 example
const { MarketplaceMeteringClient, ResolveCustomerCommand } = require("@aws-sdk/client-marketplace-metering");
// ES6+ example
import { MarketplaceMeteringClient, ResolveCustomerCommand } from "@aws-sdk/client-marketplace-metering";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new MarketplaceMeteringClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ResolveCustomerCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-marketplace-metering";
const client = new AWS.MarketplaceMetering({ region: "REGION" });
// async/await.
try {
const data = await client.resolveCustomer(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.resolveCustomer(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.resolveCustomer(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-marketplace-metering package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.