@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSMarketplaceMetering
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSMarketplaceMetering instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
BatchMeterUsageResult |
batchMeterUsage(BatchMeterUsageRequest batchMeterUsageRequest)
BatchMeterUsage is called from a SaaS application listed on AWS Marketplace to post metering records
for a set of customers. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
MeterUsageResult |
meterUsage(MeterUsageRequest meterUsageRequest)
API to emit metering records.
|
RegisterUsageResult |
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. |
ResolveCustomerResult |
resolveCustomer(ResolveCustomerRequest resolveCustomerRequest)
ResolveCustomer is called by a SaaS application during the registration process. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "metering.marketplace.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://metering.marketplace.us-east-1.amazonaws.com"). If the protocol is not
specified here, the default protocol from this client's ClientConfiguration will be used, which by
default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "metering.marketplace.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "https://metering.marketplace.us-east-1.amazonaws.com") of the region specific AWS endpoint this
client will communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)setEndpoint(String), sets the regional endpoint for this
client's service calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)BatchMeterUsageResult 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.
batchMeterUsageRequest - A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of
usage within your application.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.MeterUsageResult 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.
meterUsageRequest - 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.RegisterUsageResult 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.
registerUsageRequest - 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.ResolveCustomerResult 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.
resolveCustomerRequest - Contains input to the ResolveCustomer operation.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.