Table of Contents
A low-level client representing AWSMarketplace Metering
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 Marketing metering and entitlement API permissions in the AWS Marketplace Seller Guide.
Submitting Metering Records
Accepting New Customers
Entitlement and Metering for Paid Container 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 * .
client = session.create_client('meteringmarketplace')
These are the available methods:
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.
A UsageRecord can optionally include multiple usage allocations, to provide customers with usagedata split into buckets by tags that you define (or allow the customer to define).
BatchMeterUsage requests must be less than 1MB in size.
See also: AWS API Documentation
Request Syntax
response = client.batch_meter_usage(
UsageRecords=[
{
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'Dimension': 'string',
'Quantity': 123,
'UsageAllocations': [
{
'AllocatedUsageQuantity': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
],
ProductCode='string'
)
[REQUIRED]
The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
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.
Timestamp, in UTC, for which the usage is being reported.
Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
Usage allocations allow you to split usage into buckets by tags.
Each UsageAllocation indicates the usage quantity for a specific set of tags.
The total quantity allocated to this bucket of usage.
The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.
Metadata assigned to an allocation. Each tag is made up of a key and a value.
One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.
One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
[REQUIRED]
Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
dict
Response Syntax
{
'Results': [
{
'UsageRecord': {
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'Dimension': 'string',
'Quantity': 123,
'UsageAllocations': [
{
'AllocatedUsageQuantity': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'MeteringRecordId': 'string',
'Status': 'Success'|'CustomerNotSubscribed'|'DuplicateRecord'
},
],
'UnprocessedRecords': [
{
'Timestamp': datetime(2015, 1, 1),
'CustomerIdentifier': 'string',
'Dimension': 'string',
'Quantity': 123,
'UsageAllocations': [
{
'AllocatedUsageQuantity': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
]
}
Response Structure
(dict) --
Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.
Results (list) --
Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.
(dict) --
A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.
UsageRecord (dict) --
The UsageRecord that was part of the BatchMeterUsage request.
Timestamp (datetime) --
Timestamp, in UTC, for which the usage is being reported.
Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
CustomerIdentifier (string) --
The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
Dimension (string) --
During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
Quantity (integer) --
The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
UsageAllocations (list) --
The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
(dict) --
Usage allocations allow you to split usage into buckets by tags.
Each UsageAllocation indicates the usage quantity for a specific set of tags.
AllocatedUsageQuantity (integer) --
The total quantity allocated to this bucket of usage.
Tags (list) --
The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.
(dict) --
Metadata assigned to an allocation. Each tag is made up of a key and a value.
Key (string) --
One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.
Value (string) --
One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
MeteringRecordId (string) --
The MeteringRecordId is a unique identifier for this metering event.
Status (string) --
The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.
UnprocessedRecords (list) --
Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.
(dict) --
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.
Timestamp (datetime) --
Timestamp, in UTC, for which the usage is being reported.
Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
CustomerIdentifier (string) --
The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.
Dimension (string) --
During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.
Quantity (integer) --
The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.
UsageAllocations (list) --
The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.
(dict) --
Usage allocations allow you to split usage into buckets by tags.
Each UsageAllocation indicates the usage quantity for a specific set of tags.
AllocatedUsageQuantity (integer) --
The total quantity allocated to this bucket of usage.
Tags (list) --
The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.
(dict) --
Metadata assigned to an allocation. Each tag is made up of a key and a value.
Key (string) --
One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.
Value (string) --
One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
Exceptions
Check if an operation can be paginated.
Create a paginator for an operation.
Returns an object that can wait for some condition.
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).
See also: AWS API Documentation
Request Syntax
response = client.meter_usage(
ProductCode='string',
Timestamp=datetime(2015, 1, 1),
UsageDimension='string',
UsageQuantity=123,
DryRun=True|False,
UsageAllocations=[
{
'AllocatedUsageQuantity': 123,
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
[REQUIRED]
Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.
[REQUIRED]
It will be one of the fcp dimension name provided during the publishing of the product.
The set of UsageAllocations to submit.
The sum of all UsageAllocation quantities must equal the UsageQuantity of the MeterUsage request, and each UsageAllocation must have a unique set of tags (include no tags).
Usage allocations allow you to split usage into buckets by tags.
Each UsageAllocation indicates the usage quantity for a specific set of tags.
The total quantity allocated to this bucket of usage.
The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.
Metadata assigned to an allocation. Each tag is made up of a key and a value.
One part of a key-value pair that makes up a tag. A key is a label that acts like a category for the specific tag values.
One part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key). The value can be empty or null.
dict
Response Syntax
{
'MeteringRecordId': 'string'
}
Response Structure
(dict) --
MeteringRecordId (string) --
Metering record id.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.register_usage(
ProductCode='string',
PublicKeyVersion=123,
Nonce='string'
)
[REQUIRED]
Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.
[REQUIRED]
Public Key Version provided by AWS Marketplace
dict
Response Syntax
{
'PublicKeyRotationTimestamp': datetime(2015, 1, 1),
'Signature': 'string'
}
Response Structure
(dict) --
PublicKeyRotationTimestamp (datetime) --
(Optional) Only included when public key version has expired
Signature (string) --
JWT Token
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.resolve_customer(
RegistrationToken='string'
)
[REQUIRED]
When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier and product code.
{
'CustomerIdentifier': 'string',
'ProductCode': 'string'
}
Response Structure
The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.
The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.
The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code.
Exceptions
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
Exception thrown when the customer does not have a valid subscription for the product.
Example
try:
...
except client.exceptions.CustomerNotEntitledException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Exception thrown when the customer does not have a valid subscription for the product.
The API is disabled in the Region.
Example
try:
...
except client.exceptions.DisabledApiException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The API is disabled in the Region.
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.
Example
try:
...
except client.exceptions.DuplicateRequestException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
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.
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.
Example
try:
...
except client.exceptions.ExpiredTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
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.
An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
Example
try:
...
except client.exceptions.InternalServiceErrorException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.
You have metered usage for a CustomerIdentifier that does not exist.
Example
try:
...
except client.exceptions.InvalidCustomerIdentifierException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
You have metered usage for a CustomerIdentifier that does not exist.
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.
Example
try:
...
except client.exceptions.InvalidEndpointRegionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
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.
The product code passed does not match the product code used for publishing the product.
Example
try:
...
except client.exceptions.InvalidProductCodeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The product code passed does not match the product code used for publishing the product.
Public Key version is invalid.
Example
try:
...
except client.exceptions.InvalidPublicKeyVersionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Public Key version is invalid.
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.
Example
try:
...
except client.exceptions.InvalidRegionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
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.
The tag is invalid, or the number of tags is greater than 5.
Example
try:
...
except client.exceptions.InvalidTagException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The tag is invalid, or the number of tags is greater than 5.
Registration token is invalid.
Example
try:
...
except client.exceptions.InvalidTokenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
Registration token is invalid.
The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
Example
try:
...
except client.exceptions.InvalidUsageAllocationsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.
The usage dimension does not match one of the UsageDimensions associated with products.
Example
try:
...
except client.exceptions.InvalidUsageDimensionException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The usage dimension does not match one of the UsageDimensions associated with products.
AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.
Example
try:
...
except client.exceptions.PlatformNotSupportedException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.
The calls to the API are throttled.
Example
try:
...
except client.exceptions.ThrottlingException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The calls to the API are throttled.
The timestamp value passed in the meterUsage() is out of allowed range.
Example
try:
...
except client.exceptions.TimestampOutOfBoundsException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The timestamp value passed in the meterUsage() is out of allowed range.
The available paginators are: