marketplacemetering/aws.sdk.kotlin.services.marketplacemetering/MarketplaceMeteringClient

MarketplaceMeteringClient

interface MarketplaceMeteringClient : SdkClient

AWS Marketplace Metering Service

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.

Properties

Link copied to clipboard
abstract override val config: MarketplaceMeteringClient.Config

MarketplaceMeteringClient's configuration

Functions

Link copied to clipboard
abstract suspend fun batchMeterUsage(input: BatchMeterUsageRequest): BatchMeterUsageResponse

BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers.

Link copied to clipboard
abstract suspend fun meterUsage(input: MeterUsageRequest): MeterUsageResponse

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

Link copied to clipboard
abstract suspend fun registerUsage(input: RegisterUsageRequest): RegisterUsageResponse

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.

Link copied to clipboard
abstract suspend fun resolveCustomer(input: ResolveCustomerRequest): 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 and ProductCode.

Inherited functions

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

BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard
inline suspend fun MarketplaceMeteringClient.meterUsage(crossinline block: MeterUsageRequest.Builder.() -> Unit): MeterUsageResponse

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

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

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.

Link copied to clipboard
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 and ProductCode.

Link copied to clipboard
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.