AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class BatchMeterUsageRequest

Container for the parameters to the BatchMeterUsage operation. 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.

Class BatchMeterUsageResponse

Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.

Class CustomerNotEntitledException

AWSMarketplaceMetering exception

Class DisabledApiException

AWSMarketplaceMetering exception

Class DuplicateRequestException

AWSMarketplaceMetering exception

Class ExpiredTokenException

AWSMarketplaceMetering exception

Class InternalServiceErrorException

AWSMarketplaceMetering exception

Class InvalidCustomerIdentifierException

AWSMarketplaceMetering exception

Class InvalidEndpointRegionException

AWSMarketplaceMetering exception

Class InvalidProductCodeException

AWSMarketplaceMetering exception

Class InvalidPublicKeyVersionException

AWSMarketplaceMetering exception

Class InvalidRegionException

AWSMarketplaceMetering exception

Class InvalidTokenException

AWSMarketplaceMetering exception

Class InvalidUsageDimensionException

AWSMarketplaceMetering exception

Class MeterUsageRequest

Container for the parameters to the MeterUsage operation. 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.

Class MeterUsageResponse

This is the response object from the MeterUsage operation.

Class PlatformNotSupportedException

AWSMarketplaceMetering exception

Class RegisterUsageRequest

Container for the parameters to the RegisterUsage operation. 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/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.

Class RegisterUsageResponse

This is the response object from the RegisterUsage operation.

Class ResolveCustomerRequest

Container for the parameters to the ResolveCustomer operation. 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.

Class ResolveCustomerResponse

The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.

Class ThrottlingException

AWSMarketplaceMetering exception

Class TimestampOutOfBoundsException

AWSMarketplaceMetering exception

Class UsageRecord

A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

Class UsageRecordResult

A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.