marketplacemetering/aws.sdk.kotlin.services.marketplacemetering

Package-level declarations

Types

MarketplaceMeteringClient

interface MarketplaceMeteringClient

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

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchMeterUsage

inline suspend fun MarketplaceMeteringClient.batchMeterUsage(crossinline block: BatchMeterUsageRequest.Builder.() -> Unit): BatchMeterUsageResponse

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 of CustomerIdentifier), LicenseArn (instead of ProductCode) to support this feature. Existing integrations will continue to work. Review the new integration for Concurrent Agreements here.

meterUsage

inline suspend fun MarketplaceMeteringClient.meterUsage(crossinline block: MeterUsageRequest.Builder.() -> Unit): MeterUsageResponse

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.

registerUsage

inline suspend fun MarketplaceMeteringClient.registerUsage(crossinline block: RegisterUsageRequest.Builder.() -> Unit): RegisterUsageResponse

Paid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services 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.

resolveCustomer

inline suspend fun MarketplaceMeteringClient.resolveCustomer(crossinline block: ResolveCustomerRequest.Builder.() -> Unit): ResolveCustomerResponse

ResolveCustomer is 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 a CustomerIdentifier along with the CustomerAWSAccountId, ProductCode, and LicenseArn.

withConfig

fun MarketplaceMeteringClient.withConfig(block: MarketplaceMeteringClient.Config.Builder.() -> Unit): MarketplaceMeteringClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.