MarketplaceMetering class
This reference provides descriptions of the low-level Marketplace Metering Service API.
Constructors
- MarketplaceMetering({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
batchMeterUsage(
{required List< UsageRecord> usageRecords, String? productCode}) → Future<BatchMeterUsageResult> -
Amazon Web Services Marketplace is introducing Concurrent Agreements,
enabling buyers to make multiple purchases per Amazon Web Services
account. Starting June 1, 2026, new SaaS products must use
CustomerAWSAccountId(instead ofCustomerIdentifier),LicenseArn(instead ofProductCode) to support this feature. Existing integrations will continue to work. Review the new integration for Concurrent Agreements here. -
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
meterUsage(
{required String productCode, required DateTime timestamp, required String usageDimension, String? clientToken, bool? dryRun, List< UsageAllocation> ? usageAllocations, int? usageQuantity}) → Future<MeterUsageResult> - As a seller, your software hosted in the buyer's Amazon Web Services account uses this API action to emit metering records directly to Amazon Web Services Marketplace. You must use the following buyer Amazon Web Services account credentials to sign the API request.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerUsage(
{required String productCode, required int publicKeyVersion, String? nonce}) → Future< RegisterUsageResult> -
Paid container software products sold through Amazon Web Services
Marketplace must integrate with the Amazon Web Services Marketplace
Metering Service and call the
RegisterUsageoperation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to callRegisterUsage, 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 ofRegisterUsage.RegisterUsageperforms two primary functions: metering and entitlement. -
resolveCustomer(
{required String registrationToken}) → Future< ResolveCustomerResult> -
ResolveCustomeris 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 their browser. The registration token is resolved through this API to obtain aCustomerIdentifieralong with theCustomerAWSAccountId,ProductCode, andLicenseArn. Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow theaws-marketplace:ResolveCustomeraction. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in the Service Authorization Reference. -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited