AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 may choose to do so if you
would like to receive usage data in your seller reports. The sections below explain
the behavior of RegisterUsage. RegisterUsage performs two primary functions:
metering and entitlement.
Entitlement: RegisterUsage allows you to verify that the customer running
your paid software is subscribed to your product on AWS Marketplace, enabling you
to guard against unauthorized use. Your container image that integrates with RegisterUsage
is only required to guard against unauthorized use at container startup, as such a
CustomerNotSubscribedException or PlatformNotSupportedException will
only be thrown on the initial call to RegisterUsage. Subsequent calls from
the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw
a CustomerNotSubscribedException, even if the customer unsubscribes while the
Amazon ECS task or Amazon EKS pod is still running.
Metering: RegisterUsage meters software use per ECS task, per hour,
or per pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute
of usage applies to tasks that are short lived. For example, if a customer has a 10
node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, then
Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the customer
will be charged: (10 * hourly_rate). Metering for software use is automatically handled
by the AWS Marketplace Metering Control Plane -- your software is not required to
perform any metering specific actions, other than call RegisterUsage once for
metering of software use to commence. The AWS Marketplace Metering Control Plane will
also continue to bill customers for running ECS tasks and Amazon EKS pods, regardless
of the customers subscription state, removing the need for your software to perform
entitlement checks at runtime.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginRegisterUsage and EndRegisterUsage.
Namespace: Amazon.AWSMarketplaceMetering
Assembly: AWSSDK.AWSMarketplaceMetering.dll
Version: 3.x.y.z
public abstract Task<RegisterUsageResponse> RegisterUsageAsync( RegisterUsageRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the RegisterUsage service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| CustomerNotEntitledException | Exception thrown when the customer does not have a valid subscription for the product. |
| DisabledApiException | The API is disabled in the Region. |
| InternalServiceErrorException | An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums. |
| InvalidProductCodeException | The product code passed does not match the product code used for publishing the product. |
| InvalidPublicKeyVersionException | Public Key version is invalid. |
| InvalidRegionException | RegisterUsage must be called in the same AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage. |
| PlatformNotSupportedException | AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported. |
| ThrottlingException | The calls to the API are throttled. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5