@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSMarketplaceMetering extends Object implements AWSMarketplaceMetering
AWSMarketplaceMetering. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchMeterUsageResult |
batchMeterUsage(BatchMeterUsageRequest request)
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 request)
API to emit metering records.
|
RegisterUsageResult |
registerUsage(RegisterUsageRequest request)
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 request)
ResolveCustomer is called by a SaaS application during the registration process. |
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://metering.marketplace.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AWSMarketplaceMetering.setEndpoint(String), sets the regional endpoint for this
client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
public void setEndpoint(String endpoint)
AWSMarketplaceMetering
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.
setEndpoint in interface AWSMarketplaceMeteringendpoint - 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.public void setRegion(Region region)
AWSMarketplaceMeteringAWSMarketplaceMetering.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.
setRegion in interface AWSMarketplaceMeteringregion - 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)public BatchMeterUsageResult batchMeterUsage(BatchMeterUsageRequest request)
AWSMarketplaceMetering
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.
batchMeterUsage in interface AWSMarketplaceMeteringrequest - A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of
usage within your application.public MeterUsageResult meterUsage(MeterUsageRequest request)
AWSMarketplaceMeteringAPI 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.
meterUsage in interface AWSMarketplaceMeteringpublic RegisterUsageResult registerUsage(RegisterUsageRequest request)
AWSMarketplaceMetering
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.
registerUsage in interface AWSMarketplaceMeteringpublic ResolveCustomerResult resolveCustomer(ResolveCustomerRequest request)
AWSMarketplaceMetering
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.
resolveCustomer in interface AWSMarketplaceMeteringrequest - Contains input to the ResolveCustomer operation.public void shutdown()
AWSMarketplaceMeteringshutdown in interface AWSMarketplaceMeteringpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSMarketplaceMeteringResponse 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.
getCachedResponseMetadata in interface AWSMarketplaceMeteringrequest - The originally executed request.