BatchMeterUsage

$result = $client->batchMeterUsage([/* ... */]);
$promise = $client->batchMeterUsageAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->batchMeterUsage([
    'ProductCode' => '<string>', // REQUIRED
    'UsageRecords' => [ // REQUIRED
        [
            'CustomerIdentifier' => '<string>', // REQUIRED
            'Dimension' => '<string>', // REQUIRED
            'Quantity' => <integer>,
            'Timestamp' => <integer || string || DateTime>, // REQUIRED
            'UsageAllocations' => [
                [
                    'AllocatedUsageQuantity' => <integer>, // REQUIRED
                    'Tags' => [
                        [
                            'Key' => '<string>', // REQUIRED
                            'Value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'Results' => [
        [
            'MeteringRecordId' => '<string>',
            'Status' => 'Success|CustomerNotSubscribed|DuplicateRecord',
            'UsageRecord' => [
                'CustomerIdentifier' => '<string>',
                'Dimension' => '<string>',
                'Quantity' => <integer>,
                'Timestamp' => <DateTime>,
                'UsageAllocations' => [
                    [
                        'AllocatedUsageQuantity' => <integer>,
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        // ...
    ],
    'UnprocessedRecords' => [
        [
            'CustomerIdentifier' => '<string>',
            'Dimension' => '<string>',
            'Quantity' => <integer>,
            'Timestamp' => <DateTime>,
            'UsageAllocations' => [
                [
                    'AllocatedUsageQuantity' => <integer>,
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

InternalServiceErrorException:

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

InvalidProductCodeException:

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

InvalidUsageDimensionException:

The usage dimension does not match one of the UsageDimensions associated with products.

InvalidTagException:

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

InvalidUsageAllocationsException:

The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

InvalidCustomerIdentifierException:

You have metered usage for a CustomerIdentifier that does not exist.

TimestampOutOfBoundsException:

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.

ThrottlingException:

The calls to the API are throttled.

DisabledApiException:

The API is disabled in the Region.

MeterUsage

$result = $client->meterUsage([/* ... */]);
$promise = $client->meterUsageAsync([/* ... */]);

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).

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.

Parameter Syntax

$result = $client->meterUsage([
    'DryRun' => true || false,
    'ProductCode' => '<string>', // REQUIRED
    'Timestamp' => <integer || string || DateTime>, // REQUIRED
    'UsageAllocations' => [
        [
            'AllocatedUsageQuantity' => <integer>, // REQUIRED
            'Tags' => [
                [
                    'Key' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        // ...
    ],
    'UsageDimension' => '<string>', // REQUIRED
    'UsageQuantity' => <integer>,
]);

Parameter Details

Result Syntax

[
    'MeteringRecordId' => '<string>',
]

Result Details

Errors

InternalServiceErrorException:

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

InvalidProductCodeException:

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

InvalidUsageDimensionException:

The usage dimension does not match one of the UsageDimensions associated with products.

InvalidTagException:

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

InvalidUsageAllocationsException:

The usage allocation objects are invalid, or the number of allocations is greater than 500 for a single usage record.

InvalidEndpointRegionException:

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.

TimestampOutOfBoundsException:

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.

DuplicateRequestException:

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.

ThrottlingException:

The calls to the API are throttled.

CustomerNotEntitledException:

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

RegisterUsage

$result = $client->registerUsage([/* ... */]);
$promise = $client->registerUsageAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->registerUsage([
    'Nonce' => '<string>',
    'ProductCode' => '<string>', // REQUIRED
    'PublicKeyVersion' => <integer>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'PublicKeyRotationTimestamp' => <DateTime>,
    'Signature' => '<string>',
]

Result Details

Errors

InvalidProductCodeException:

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

InvalidRegionException:

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.

InvalidPublicKeyVersionException:

Public Key version is invalid.

PlatformNotSupportedException:

AWS Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and AWS Fargate are supported.

CustomerNotEntitledException:

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

ThrottlingException:

The calls to the API are throttled.

InternalServiceErrorException:

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException:

The API is disabled in the Region.

ResolveCustomer

$result = $client->resolveCustomer([/* ... */]);
$promise = $client->resolveCustomerAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->resolveCustomer([
    'RegistrationToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CustomerAWSAccountId' => '<string>',
    'CustomerIdentifier' => '<string>',
    'ProductCode' => '<string>',
]

Result Details

Errors

InvalidTokenException:

Registration token is invalid.

ExpiredTokenException:

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.

ThrottlingException:

The calls to the API are throttled.

InternalServiceErrorException:

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

DisabledApiException:

The API is disabled in the Region.