com.amazonaws.services.marketplacemetering

Interface AWSMarketplaceMeteringAsync

All Superinterfaces:

AWSMarketplaceMetering

All Known Implementing Classes:

AbstractAWSMarketplaceMeteringAsync, AWSMarketplaceMeteringAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMarketplaceMeteringAsync
extends AWSMarketplaceMetering

Interface for accessing AWSMarketplace Metering asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSMarketplaceMeteringAsync instead.

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.

Field Summary

Fields inherited from interface com.amazonaws.services.marketplacemetering.AWSMarketplaceMetering

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<BatchMeterUsageResult>	batchMeterUsageAsync(BatchMeterUsageRequest batchMeterUsageRequest) BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.
Future<BatchMeterUsageResult>	batchMeterUsageAsync(BatchMeterUsageRequest batchMeterUsageRequest, AsyncHandler<BatchMeterUsageRequest,BatchMeterUsageResult> asyncHandler) BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.
Future<MeterUsageResult>	meterUsageAsync(MeterUsageRequest meterUsageRequest) API to emit metering records.
Future<MeterUsageResult>	meterUsageAsync(MeterUsageRequest meterUsageRequest, AsyncHandler<MeterUsageRequest,MeterUsageResult> asyncHandler) API to emit metering records.
Future<ResolveCustomerResult>	resolveCustomerAsync(ResolveCustomerRequest resolveCustomerRequest) ResolveCustomer is called by a SaaS application during the registration process.
Future<ResolveCustomerResult>	resolveCustomerAsync(ResolveCustomerRequest resolveCustomerRequest, AsyncHandler<ResolveCustomerRequest,ResolveCustomerResult> asyncHandler) ResolveCustomer is called by a SaaS application during the registration process.

Methods inherited from interface com.amazonaws.services.marketplacemetering.AWSMarketplaceMetering

batchMeterUsage, getCachedResponseMetadata, meterUsage, resolveCustomer, setEndpoint, setRegion, shutdown

Method Detail

batchMeterUsageAsync

Future<BatchMeterUsageResult> batchMeterUsageAsync(BatchMeterUsageRequest batchMeterUsageRequest)

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:

A Java Future containing the result of the BatchMeterUsage operation returned by the service.

See Also:

AWS API Documentation

batchMeterUsageAsync

Future<BatchMeterUsageResult> batchMeterUsageAsync(BatchMeterUsageRequest batchMeterUsageRequest,
                                                   AsyncHandler<BatchMeterUsageRequest,BatchMeterUsageResult> asyncHandler)

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchMeterUsage operation returned by the service.

See Also:

AWS API Documentation

meterUsageAsync

Future<MeterUsageResult> meterUsageAsync(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, generally when running from an EC2 instance on the AWS Marketplace.

Parameters:

meterUsageRequest -

Returns:

A Java Future containing the result of the MeterUsage operation returned by the service.

See Also:

AWS API Documentation

meterUsageAsync

Future<MeterUsageResult> meterUsageAsync(MeterUsageRequest meterUsageRequest,
                                         AsyncHandler<MeterUsageRequest,MeterUsageResult> asyncHandler)

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 -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the MeterUsage operation returned by the service.

See Also:

AWS API Documentation

resolveCustomerAsync

Future<ResolveCustomerResult> resolveCustomerAsync(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 and product code.

Parameters:

resolveCustomerRequest - Contains input to the ResolveCustomer operation.

Returns:

A Java Future containing the result of the ResolveCustomer operation returned by the service.

See Also:

AWS API Documentation

resolveCustomerAsync

Future<ResolveCustomerResult> resolveCustomerAsync(ResolveCustomerRequest resolveCustomerRequest,
                                                   AsyncHandler<ResolveCustomerRequest,ResolveCustomerResult> asyncHandler)

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.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ResolveCustomer operation returned by the service.

See Also:

AWS API Documentation