software.amazon.awssdk.services.marketplacemetering

Interface MarketplaceMeteringClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface MarketplaceMeteringClient
extends SdkClient

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.

Submitting Metering Records

• MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance.

• 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 and Product Code.

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. Calling RegisterUsage from containers running outside of Amazon Elastic Container Service (Amazon ECR) isn't supported. Free and BYOL products for ECS 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 and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
default BatchMeterUsageResponse	batchMeterUsage(BatchMeterUsageRequest batchMeterUsageRequest) BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.
default BatchMeterUsageResponse	batchMeterUsage(Consumer<BatchMeterUsageRequest.Builder> batchMeterUsageRequest) BatchMeterUsage is called from a SaaS application listed on the 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.
static ServiceMetadata	serviceMetadata()

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

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

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.

batchMeterUsage

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

BatchMeterUsage is called from a SaaS application listed on the 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.

BatchMeterUsage can process up to 25 UsageRecords at a time.

Parameters:

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

Returns:

Result of the BatchMeterUsage operation returned by the service.

Throws:

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.

InvalidUsageDimensionException - The usage dimension does not match one of the UsageDimensions associated with products.

InvalidCustomerIdentifierException - You have metered usage for a CustomerIdentifier that does not exist.

TimestampOutOfBoundsException - The timestamp value passed in the meterUsage() is out of allowed range.

ThrottlingException - The calls to the API are throttled.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

batchMeterUsage

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

BatchMeterUsage is called from a SaaS application listed on the 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.

BatchMeterUsage can process up to 25 UsageRecords at a time.

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.

Throws:

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.

InvalidUsageDimensionException - The usage dimension does not match one of the UsageDimensions associated with products.

InvalidCustomerIdentifierException - You have metered usage for a CustomerIdentifier that does not exist.

TimestampOutOfBoundsException - The timestamp value passed in the meterUsage() is out of allowed range.

ThrottlingException - The calls to the API are throttled.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

meterUsage

default MeterUsageResponse meterUsage(MeterUsageRequest meterUsageRequest)
                               throws InternalServiceErrorException,
                                      InvalidProductCodeException,
                                      InvalidUsageDimensionException,
                                      InvalidEndpointRegionException,
                                      TimestampOutOfBoundsException,
                                      DuplicateRequestException,
                                      ThrottlingException,
                                      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, generally when running from an EC2 instance on the AWS Marketplace.

Parameters:

meterUsageRequest -

Returns:

Result of the MeterUsage operation returned by the service.

Throws:

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.

InvalidUsageDimensionException - The usage dimension does not match one of the UsageDimensions associated with products.

InvalidEndpointRegionException - The endpoint being called is in a Region different from your EC2 instance. The Region of the Metering Service endpoint and the Region of the EC2 instance must match.

TimestampOutOfBoundsException - The timestamp value passed in the meterUsage() is out of allowed range.

DuplicateRequestException - A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.

ThrottlingException - The calls to the API are throttled.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

meterUsage

default MeterUsageResponse meterUsage(Consumer<MeterUsageRequest.Builder> meterUsageRequest)
                               throws InternalServiceErrorException,
                                      InvalidProductCodeException,
                                      InvalidUsageDimensionException,
                                      InvalidEndpointRegionException,
                                      TimestampOutOfBoundsException,
                                      DuplicateRequestException,
                                      ThrottlingException,
                                      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, generally when running from an EC2 instance on the AWS Marketplace.

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.

Throws:

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.

InvalidUsageDimensionException - The usage dimension does not match one of the UsageDimensions associated with products.

InvalidEndpointRegionException - The endpoint being called is in a Region different from your EC2 instance. The Region of the Metering Service endpoint and the Region of the EC2 instance must match.

TimestampOutOfBoundsException - The timestamp value passed in the meterUsage() is out of allowed range.

DuplicateRequestException - A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.

ThrottlingException - The calls to the API are throttled.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS 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/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running.

• Metering: RegisterUsage meters software use per ECS task, per hour, 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 ECS cluster and creates an ECS service configured as a Daemon Set, then ECS 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, 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.

Throws:

InvalidProductCodeException - The product code passed does not match the product code used for publishing the product.

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.

InvalidPublicKeyVersionException - Public Key version is invalid.

PlatformNotSupportedException - AWS Marketplace does not support metering usage from the underlying platform. Currently, only Amazon ECS is supported.

CustomerNotEntitledException - Exception thrown when the customer does not have a valid subscription for the product.

ThrottlingException - The calls to the API are throttled.

InternalServiceErrorException - An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS 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/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running.

• Metering: RegisterUsage meters software use per ECS task, per hour, 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 ECS cluster and creates an ECS service configured as a Daemon Set, then ECS 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, 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.

Throws:

InvalidProductCodeException - The product code passed does not match the product code used for publishing the product.

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.

InvalidPublicKeyVersionException - Public Key version is invalid.

PlatformNotSupportedException - AWS Marketplace does not support metering usage from the underlying platform. Currently, only Amazon ECS is supported.

CustomerNotEntitledException - Exception thrown when the customer does not have a valid subscription for the product.

ThrottlingException - The calls to the API are throttled.

InternalServiceErrorException - An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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 and product code.

Parameters:

resolveCustomerRequest - Contains input to the ResolveCustomer operation.

Returns:

Result of the ResolveCustomer operation returned by the service.

Throws:

InvalidTokenException - Registration token is invalid.

ExpiredTokenException - The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

ThrottlingException - The calls to the API are throttled.

InternalServiceErrorException - An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

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 and product code.

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.

Throws:

InvalidTokenException - Registration token is invalid.

ExpiredTokenException - The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

ThrottlingException - The calls to the API are throttled.

InternalServiceErrorException - An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException - The API is disabled in the Region.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

MarketplaceMeteringException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()