Interface MarketplaceMeteringClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface MarketplaceMeteringClient
extends AwsClient

Service client for accessing AWSMarketplace Metering. This can be created using the static builder() method. 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default BatchMeterUsageResponse	batchMeterUsage(Consumer<BatchMeterUsageRequest.Builder> batchMeterUsageRequest)	BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers.
default BatchMeterUsageResponse	batchMeterUsage(BatchMeterUsageRequest batchMeterUsageRequest)	BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records for a set of customers.
static MarketplaceMeteringClientBuilder	builder()	Create a builder that can be used to configure and create a MarketplaceMeteringClient.
static MarketplaceMeteringClient	create()	Create a MarketplaceMeteringClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default MeterUsageResponse	meterUsage(Consumer<MeterUsageRequest.Builder> meterUsageRequest)	API to emit metering records.
default MeterUsageResponse	meterUsage(MeterUsageRequest meterUsageRequest)	API to emit metering records.
default RegisterUsageResponse	registerUsage(Consumer<RegisterUsageRequest.Builder> registerUsageRequest)	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.
default RegisterUsageResponse	registerUsage(RegisterUsageRequest registerUsageRequest)	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.
default ResolveCustomerResponse	resolveCustomer(Consumer<ResolveCustomerRequest.Builder> resolveCustomerRequest)	ResolveCustomer is called by a SaaS application during the registration process.
default ResolveCustomerResponse	resolveCustomer(ResolveCustomerRequest resolveCustomerRequest)	ResolveCustomer is called by a SaaS application during the registration process.
default MarketplaceMeteringServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

batchMeterUsage

default BatchMeterUsageResponse batchMeterUsage(BatchMeterUsageRequest batchMeterUsageRequest)
                                         throws InternalServiceErrorException,
InvalidProductCodeException,
InvalidUsageDimensionException,
InvalidTagException,
InvalidUsageAllocationsException,
InvalidCustomerIdentifierException,
TimestampOutOfBoundsException,
ThrottlingException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event.

BatchMeterUsage can process up to 25 UsageRecords at a time.

A UsageRecord can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).

BatchMeterUsage returns a list of UsageRecordResult objects, showing the result for each UsageRecord, as well as a list of UnprocessedRecords, indicating errors in the service side that you should retry.

BatchMeterUsage requests must be less than 1MB in size.

For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller Guide.

Parameters:

batchMeterUsageRequest - A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

Returns:

Result of the BatchMeterUsage operation returned by the service.

See Also:

• AWS API Documentation

batchMeterUsage

default BatchMeterUsageResponse batchMeterUsage(Consumer<BatchMeterUsageRequest.Builder> batchMeterUsageRequest)
                                         throws InternalServiceErrorException,
InvalidProductCodeException,
InvalidUsageDimensionException,
InvalidTagException,
InvalidUsageAllocationsException,
InvalidCustomerIdentifierException,
TimestampOutOfBoundsException,
ThrottlingException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event.

BatchMeterUsage can process up to 25 UsageRecords at a time.

A UsageRecord can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).

BatchMeterUsage returns a list of UsageRecordResult objects, showing the result for each UsageRecord, as well as a list of UnprocessedRecords, indicating errors in the service side that you should retry.

BatchMeterUsage requests must be less than 1MB in size.

For an example of using BatchMeterUsage, see BatchMeterUsage code example in the AWS Marketplace Seller Guide.

This is a convenience which creates an instance of the BatchMeterUsageRequest.Builder avoiding the need to create one manually via BatchMeterUsageRequest.builder()

Parameters:

batchMeterUsageRequest - A Consumer that will call methods on BatchMeterUsageRequest.Builder to create a request. A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

Returns:

Result of the BatchMeterUsage operation returned by the service.

See Also:

• AWS API Documentation

meterUsage

default MeterUsageResponse meterUsage(MeterUsageRequest meterUsageRequest)
                               throws InternalServiceErrorException,
InvalidProductCodeException,
InvalidUsageDimensionException,
InvalidTagException,
InvalidUsageAllocationsException,
InvalidEndpointRegionException,
TimestampOutOfBoundsException,
DuplicateRequestException,
ThrottlingException,
CustomerNotEntitledException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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

MeterUsage is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod.

MeterUsage can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).

Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event.

Parameters:

meterUsageRequest -

Returns:

Result of the MeterUsage operation returned by the service.

See Also:

• AWS API Documentation

meterUsage

default MeterUsageResponse meterUsage(Consumer<MeterUsageRequest.Builder> meterUsageRequest)
                               throws InternalServiceErrorException,
InvalidProductCodeException,
InvalidUsageDimensionException,
InvalidTagException,
InvalidUsageAllocationsException,
InvalidEndpointRegionException,
TimestampOutOfBoundsException,
DuplicateRequestException,
ThrottlingException,
CustomerNotEntitledException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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

MeterUsage is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod.

MeterUsage can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define (or allow the customer to define).

Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event.

This is a convenience which creates an instance of the MeterUsageRequest.Builder avoiding the need to create one manually via MeterUsageRequest.builder()

Parameters:

meterUsageRequest - A Consumer that will call methods on MeterUsageRequest.Builder to create a request.

Returns:

Result of the MeterUsage operation returned by the service.

See Also:

• AWS API Documentation

registerUsage

default RegisterUsageResponse registerUsage(RegisterUsageRequest registerUsageRequest)
                                     throws InvalidProductCodeException,
InvalidRegionException,
InvalidPublicKeyVersionException,
PlatformNotSupportedException,
CustomerNotEntitledException,
ThrottlingException,
InternalServiceErrorException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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.

Parameters:

registerUsageRequest -

Returns:

Result of the RegisterUsage operation returned by the service.

See Also:

• AWS API Documentation

registerUsage

default RegisterUsageResponse registerUsage(Consumer<RegisterUsageRequest.Builder> registerUsageRequest)
                                     throws InvalidProductCodeException,
InvalidRegionException,
InvalidPublicKeyVersionException,
PlatformNotSupportedException,
CustomerNotEntitledException,
ThrottlingException,
InternalServiceErrorException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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 a convenience which creates an instance of the RegisterUsageRequest.Builder avoiding the need to create one manually via RegisterUsageRequest.builder()

Parameters:

registerUsageRequest - A Consumer that will call methods on RegisterUsageRequest.Builder to create a request.

Returns:

Result of the RegisterUsage operation returned by the service.

See Also:

• AWS API Documentation

resolveCustomer

default ResolveCustomerResponse resolveCustomer(ResolveCustomerRequest resolveCustomerRequest)
                                         throws InvalidTokenException,
ExpiredTokenException,
ThrottlingException,
InternalServiceErrorException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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.

The API needs to called from the seller account id used to publish the SaaS application to successfully resolve the token.

For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller Guide.

Parameters:

resolveCustomerRequest - Contains input to the ResolveCustomer operation.

Returns:

Result of the ResolveCustomer operation returned by the service.

See Also:

• AWS API Documentation

resolveCustomer

default ResolveCustomerResponse resolveCustomer(Consumer<ResolveCustomerRequest.Builder> resolveCustomerRequest)
                                         throws InvalidTokenException,
ExpiredTokenException,
ThrottlingException,
InternalServiceErrorException,
DisabledApiException,
AwsServiceException,
SdkClientException,
MarketplaceMeteringException

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.

The API needs to called from the seller account id used to publish the SaaS application to successfully resolve the token.

For an example of using ResolveCustomer, see ResolveCustomer code example in the AWS Marketplace Seller Guide.

This is a convenience which creates an instance of the ResolveCustomerRequest.Builder avoiding the need to create one manually via ResolveCustomerRequest.builder()

Parameters:

resolveCustomerRequest - A Consumer that will call methods on ResolveCustomerRequest.Builder to create a request. Contains input to the ResolveCustomer operation.

Returns:

Result of the ResolveCustomer operation returned by the service.

See Also:

• AWS API Documentation

create

static MarketplaceMeteringClient create()

Create a MarketplaceMeteringClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MarketplaceMeteringClientBuilder builder()

Create a builder that can be used to configure and create a MarketplaceMeteringClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default MarketplaceMeteringServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration