@aws-sdk/client-marketplace-metering

Description

AWS SDK for JavaScript MarketplaceMetering Client for Node.js, Browser and React Native.

Amazon Web Services Marketplace Metering Service

This reference provides descriptions of the low-level Marketplace Metering Service API.

Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
dimensions.

For information about the permissions that you need to use this API, see Amazon Web Services Marketplace metering and entitlement API permissions in the Amazon Web Services Marketplace
Seller Guide.

Submitting metering records

MeterUsage

• 
  

  Submits the metering record for an Amazon Web Services Marketplace product.

  
  


• 
  

  Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
  Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)

  
  


• 
  

  Supported product types: Amazon Machine Images (AMIs) and containers

  
  


• 
  

  Vendor-metered tagging: Supported allocation tagging

  
  

BatchMeterUsage

• 
  

  Submits the metering record for a set of customers.
  BatchMeterUsage API calls are captured by CloudTrail. You can use
  CloudTrail to verify that the software as a subscription (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 CloudTrail User
  Guide.

  
  


• 
  

  Called from: SaaS applications

  
  


• 
  

  Supported product type: SaaS

  
  


• 
  

  Vendor-metered tagging: Supports allocation tagging

  
  

Accepting new customers

ResolveCustomer

• 
  

  Resolves the registration token that the buyer submits through the browser
  during the registration process. Obtains a CustomerIdentifier along
  with the CustomerAWSAccountId and ProductCode.

  
  


• 
  

  Called from: SaaS application during the registration process

  
  


• 
  

  Supported product type: SaaS

  
  


• 
  

  Vendor-metered tagging: Not applicable

  
  

Entitlement and metering for paid container
products

RegisteredUsage

• 
  

  Provides software entitlement and metering. Paid container software products
  sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
  RegisterUsage operation. Free and Bring Your Own License model
  (BYOL) products for Amazon ECS or Amazon EKS aren't required to call
  RegisterUsage. However, you can do so if you want to receive
  usage data in your seller reports. For more information about using the
  RegisterUsage operation, see Container-based products.

  
  


• 
  

  Called from: Paid container software products

  
  


• 
  

  Supported product type: Containers

  
  


• 
  

  Vendor-metered tagging: Not applicable

  
  

Entitlement custom metering for container
products

• 
  

  MeterUsage API is available in GovCloud Regions but only supports AMI
  FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
  products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
  For more information, see Container-based products.

  
  


• 
  

  Custom metering for container products are called using the
  MeterUsage API. The API is used for FCP AMI and FCP Container product
  metering.

  
  

Custom metering for Amazon EKS is available in 17
Amazon Web Services Regions

• 
  

  The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
  (FCP) products using MeterUsage API. Amazon ECS is supported in all
  Amazon Web Services Regions that MeterUsage API is available except for
  GovCloud.

  
  


• 
  

  Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
  us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
  ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
  ca-central-1, sa-east-1.

  
  
  

  For questions about adding Amazon Web Services Regions for metering, contact Amazon Web Services
  Marketplace Seller Operations.

  
  
  

Installing

To install this package, simply type add or install @aws-sdk/client-marketplace-metering
using your favorite package manager:
- npm install @aws-sdk/client-marketplace-metering
- yarn add @aws-sdk/client-marketplace-metering
- pnpm add @aws-sdk/client-marketplace-metering

Getting Started

$3

The 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:

``js
// ES5 example
const { MarketplaceMeteringClient, ResolveCustomerCommand } = require("@aws-sdk/client-marketplace-metering");
`

`ts
// ES6+ example
import { MarketplaceMeteringClient, ResolveCustomerCommand } from "@aws-sdk/client-marketplace-metering";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new MarketplaceMeteringClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ResolveCustomerCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// 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.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

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

`ts
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.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
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;
* }
*/
}
`

Getting Help

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.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

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.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

BatchMeterUsage

Command API Reference / Input / Output

MeterUsage

Command API Reference / Input / Output

RegisterUsage

Command API Reference / Input / Output

ResolveCustomer

Command API Reference / Input / Output