Package software.amazon.awssdk.services.marketplacemetering

Interface MarketplaceMeteringAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface MarketplaceMeteringAsyncClient extends AwsClient
Service client for accessing AWSMarketplace Metering asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. 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 Details

  • Method Details

    • batchMeterUsage

      default CompletableFuture<BatchMeterUsageResponse> batchMeterUsage(BatchMeterUsageRequest batchMeterUsageRequest)

      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:
      A Java Future containing the result of the BatchMeterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidTagException The tag is invalid, or the number of tags is greater than 5.
      • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
      • InvalidCustomerIdentifierException You have metered usage for a CustomerIdentifier that does not exist.
      • TimestampOutOfBoundsException The timestamp value passed in the UsageRecord is out of allowed range.

        For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.

      • 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.
      See Also:

    • batchMeterUsage

      default CompletableFuture<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.

      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:
      A Java Future containing the result of the BatchMeterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidTagException The tag is invalid, or the number of tags is greater than 5.
      • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
      • InvalidCustomerIdentifierException You have metered usage for a CustomerIdentifier that does not exist.
      • TimestampOutOfBoundsException The timestamp value passed in the UsageRecord is out of allowed range.

        For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.

      • 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.
      See Also:

    • meterUsage

      default CompletableFuture<MeterUsageResponse> meterUsage(MeterUsageRequest meterUsageRequest)

      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:
      A Java Future containing the result of the MeterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidTagException The tag is invalid, or the number of tags is greater than 5.
      • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
      • InvalidEndpointRegionException The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS Region of the resource must match.
      • TimestampOutOfBoundsException The timestamp value passed in the UsageRecord is out of allowed range.

        For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.

      • DuplicateRequestException A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp with a different usageQuantity.
      • ThrottlingException The calls to the API are throttled.
      • CustomerNotEntitledException Exception thrown when the customer does not have a valid subscription for the product.
      • 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.
      See Also:

    • meterUsage

      default CompletableFuture<MeterUsageResponse> meterUsage(Consumer<MeterUsageRequest.Builder> meterUsageRequest)

      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:
      A Java Future containing the result of the MeterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • InvalidTagException The tag is invalid, or the number of tags is greater than 5.
      • InvalidUsageAllocationsException The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
      • InvalidEndpointRegionException The endpoint being called is in a AWS Region different from your EC2 instance, ECS task, or EKS pod. The Region of the Metering Service endpoint and the AWS Region of the resource must match.
      • TimestampOutOfBoundsException The timestamp value passed in the UsageRecord is out of allowed range.

        For BatchMeterUsage, if any of the records are outside of the allowed range, the entire batch is not processed. You must remove invalid records and try again.

      • DuplicateRequestException A metering record has already been emitted by the same EC2 instance, ECS task, or EKS pod for the given {usageDimension, timestamp with a different usageQuantity.
      • ThrottlingException The calls to the API are throttled.
      • CustomerNotEntitledException Exception thrown when the customer does not have a valid subscription for the product.
      • 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.
      See Also:

    • registerUsage

      default CompletableFuture<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. 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:
      A Java Future containing the result of the RegisterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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, Amazon ECS, Amazon EKS, and AWS Fargate are 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.
      See Also:

    • registerUsage

      default CompletableFuture<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. 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:
      A Java Future containing the result of the RegisterUsage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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, Amazon ECS, Amazon EKS, and AWS Fargate are 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.
      See Also:

    • resolveCustomer

      default CompletableFuture<ResolveCustomerResponse> resolveCustomer(ResolveCustomerRequest resolveCustomerRequest)

      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:
      A Java Future containing the result of the ResolveCustomer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • resolveCustomer

      default CompletableFuture<ResolveCustomerResponse> resolveCustomer(Consumer<ResolveCustomerRequest.Builder> resolveCustomerRequest)

      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:
      A Java Future containing the result of the ResolveCustomer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • 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

    • create

      static MarketplaceMeteringAsyncClient create()
      Create a MarketplaceMeteringAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static MarketplaceMeteringAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a MarketplaceMeteringAsyncClient.