API version 2016-01-14 of the Amazon Marketplace Metering SDK configuration.

Exception thrown when the customer does not have a valid subscription for the product.

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.

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.

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.

The product code passed does not match the product code used for publishing the product.

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.

The tag is invalid, or the number of tags is greater than 5.

Registration token is invalid.

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.

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.

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.

A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

See: newBatchMeterUsage smart constructor.

Create a value of BatchMeterUsage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:usageRecords:BatchMeterUsage', batchMeterUsage_usageRecords - The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

$sel:productCode:BatchMeterUsage', batchMeterUsage_productCode - 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.

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

See: newBatchMeterUsageResponse smart constructor.

Create a value of BatchMeterUsageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:results:BatchMeterUsageResponse', batchMeterUsageResponse_results - Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted.

$sel:unprocessedRecords:BatchMeterUsageResponse', batchMeterUsageResponse_unprocessedRecords - 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.

$sel:httpStatus:BatchMeterUsageResponse', batchMeterUsageResponse_httpStatus - The response's http status code.

See: newMeterUsage smart constructor.

Create a value of MeterUsage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dryRun:MeterUsage', meterUsage_dryRun - Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false if not specified.

MeterUsage, meterUsage_usageAllocations - 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).

$sel:usageQuantity:MeterUsage', meterUsage_usageQuantity - Consumption value for the hour. Defaults to 0 if not specified.

$sel:productCode:MeterUsage', meterUsage_productCode - 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.

MeterUsage, meterUsage_timestamp - 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.

$sel:usageDimension:MeterUsage', meterUsage_usageDimension - It will be one of the fcp dimension name provided during the publishing of the product.

See: newMeterUsageResponse smart constructor.

Create a value of MeterUsageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

MeterUsageResponse, meterUsageResponse_meteringRecordId - Metering record id.

$sel:httpStatus:MeterUsageResponse', meterUsageResponse_httpStatus - The response's http status code.

See: newRegisterUsage smart constructor.

Create a value of RegisterUsage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nonce:RegisterUsage', registerUsage_nonce - (Optional) To scope down the registration to a specific running software instance and guard against replay attacks.

$sel:productCode:RegisterUsage', registerUsage_productCode - 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.

$sel:publicKeyVersion:RegisterUsage', registerUsage_publicKeyVersion - Public Key Version provided by AWS Marketplace

See: newRegisterUsageResponse smart constructor.

Create a value of RegisterUsageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:publicKeyRotationTimestamp:RegisterUsageResponse', registerUsageResponse_publicKeyRotationTimestamp - (Optional) Only included when public key version has expired

$sel:signature:RegisterUsageResponse', registerUsageResponse_signature - JWT Token

$sel:httpStatus:RegisterUsageResponse', registerUsageResponse_httpStatus - The response's http status code.

Contains input to the ResolveCustomer operation.

See: newResolveCustomer smart constructor.

Create a value of ResolveCustomer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:registrationToken:ResolveCustomer', resolveCustomer_registrationToken - 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 along with the CustomerAWSAccountId and ProductCode.

The result of the ResolveCustomer operation. Contains the CustomerIdentifier along with the CustomerAWSAccountId and ProductCode.

See: newResolveCustomerResponse smart constructor.

Create a value of ResolveCustomerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customerAWSAccountId:ResolveCustomerResponse', resolveCustomerResponse_customerAWSAccountId - The CustomerAWSAccountId provides the AWS account ID associated with the CustomerIdentifier for the individual customer.

ResolveCustomerResponse, resolveCustomerResponse_customerIdentifier - The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

$sel:productCode:ResolveCustomerResponse', resolveCustomerResponse_productCode - 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.

$sel:httpStatus:ResolveCustomerResponse', resolveCustomerResponse_httpStatus - The response's http status code.

Metadata assigned to an allocation. Each tag is made up of a key and a value.

See: newTag smart constructor.

Create a value of Tag with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:key:Tag', tag_key - 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.

$sel:value:Tag', tag_value - 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.

Usage allocations allow you to split usage into buckets by tags.

Each UsageAllocation indicates the usage quantity for a specific set of tags.

See: newUsageAllocation smart constructor.

Create a value of UsageAllocation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tags:UsageAllocation', usageAllocation_tags - The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

$sel:allocatedUsageQuantity:UsageAllocation', usageAllocation_allocatedUsageQuantity - The total quantity allocated to this bucket of usage.

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 de-duplicated to prevent double charges.

See: newUsageRecord smart constructor.

Create a value of UsageRecord with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:quantity:UsageRecord', usageRecord_quantity - The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

$sel:usageAllocations:UsageRecord', usageRecord_usageAllocations - The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

$sel:timestamp:UsageRecord', usageRecord_timestamp - 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.

$sel:customerIdentifier:UsageRecord', usageRecord_customerIdentifier - The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

$sel:dimension:UsageRecord', usageRecord_dimension - During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application.

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

See: newUsageRecordResult smart constructor.

Create a value of UsageRecordResult with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:meteringRecordId:UsageRecordResult', usageRecordResult_meteringRecordId - The MeteringRecordId is a unique identifier for this metering event.

$sel:status:UsageRecordResult', usageRecordResult_status - The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

• Success- The UsageRecord was accepted and honored by BatchMeterUsage.

• CustomerNotSubscribed- The CustomerIdentifier specified is not able to use your product. The UsageRecord was not honored. There are three causes for this result:

  • The customer identifier is invalid.
  • The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future UsageRecords for this customer will fail until the customer subscribes to your product.
  • The customer's AWS account was suspended.
• DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

$sel:usageRecord:UsageRecordResult', usageRecordResult_usageRecord - The UsageRecord that was part of the BatchMeterUsage request.