You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.MarketplaceMetering

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.MarketplaceMetering

Identifier:

marketplacemetering

API Version:

2016-01-14

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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

• MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance or a container running on EKS or ECS.

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

Entitlement and Metering for Paid Container Products

• 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 can do so if you want to receive usage data in your seller reports. For more information on using the RegisterUsage operation, see Container-Based 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 .

Sending a Request Using MarketplaceMetering

var marketplacemetering = new AWS.MarketplaceMetering();
marketplacemetering.batchMeterUsage(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MarketplaceMetering object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var marketplacemetering = new AWS.MarketplaceMetering({apiVersion: '2016-01-14'});

You can also set the API version globally in AWS.config.apiVersions using the marketplacemetering service identifier:

AWS.config.apiVersions = {
  marketplacemetering: '2016-01-14',
  // other service API versions
};

var marketplacemetering = new AWS.MarketplaceMetering();

Version:

• 2016-01-14

Constructor Summary

• new AWS.MarketplaceMetering(options = {}) ⇒ Object constructor

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

• batchMeterUsage(params = {}, callback) ⇒ AWS.Request

  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.

• meterUsage(params = {}, callback) ⇒ AWS.Request

  API to emit metering records.

• registerUsage(params = {}, callback) ⇒ AWS.Request

  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.

• resolveCustomer(params = {}, callback) ⇒ AWS.Request

  ResolveCustomer is called by a SaaS application during the registration process.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MarketplaceMetering(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MarketplaceMetering object

var marketplacemetering = new AWS.MarketplaceMetering({apiVersion: '2016-01-14'});

Options Hash (options):

• params (map) —

  An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

• endpoint (String|AWS.Endpoint) —

  The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

• accessKeyId (String) —

  your AWS access key ID.

• secretAccessKey (String) —

  your AWS secret access key.

• sessionToken (AWS.Credentials) —

  the optional AWS session token to sign requests with.

• credentials (AWS.Credentials) —

  the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

• credentialProvider (AWS.CredentialProviderChain) —

  the provider chain used to resolve credentials if no static credentials property is set.

• region (String) —

  the region to send service requests to. See AWS.MarketplaceMetering.region for more information.

• maxRetries (Integer) —

  the maximum amount of retries to attempt with a request. See AWS.MarketplaceMetering.maxRetries for more information.

• maxRedirects (Integer) —

  the maximum amount of redirects to follow with a request. See AWS.MarketplaceMetering.maxRedirects for more information.

• sslEnabled (Boolean) —

  whether to enable SSL for requests.

• paramValidation (Boolean|map) —

  whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

  • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
  • max [Boolean] — Validates that a value meets the max constraint.
  • pattern [Boolean] — Validates that a string value matches a regular expression.
  • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
• computeChecksums (Boolean) —

  whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

• convertResponseTypes (Boolean) —

  whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

• correctClockSkew (Boolean) —

  whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

• s3ForcePathStyle (Boolean) —

  whether to force path style URLs for S3 objects.

• s3BucketEndpoint (Boolean) —

  whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

• s3DisableBodySigning (Boolean) —

  whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

• s3UsEast1RegionalEndpoint ('legacy'|'regional') —

  when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

• s3UseArnRegion (Boolean) —

  whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

• retryDelayOptions (map) —

  A set of options to configure the retry delay on retryable errors. Currently supported options are:

  • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
  • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
• httpOptions (map) —

  A set of options to pass to the low-level HTTP request. Currently supported options are:

  • proxy [String] — the URL to proxy requests through
  • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
  • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
  • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
  • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
  • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
• apiVersion (String, Date) —

  a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

• apiVersions (map<String, String|Date>) —

  a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

• logger (#write, #log) —

  an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

• systemClockOffset (Number) —

  an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

• signatureVersion (String) —

  the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

• signatureCache (Boolean) —

  whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

• dynamoDbCrc32 (Boolean) —

  whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

• useAccelerateEndpoint (Boolean) —

  Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

• clientSideMonitoring (Boolean) —

  whether to collect and publish this client's performance metrics of all its API requests.

• endpointDiscoveryEnabled (Boolean|undefined) —

  whether to call operations with endpoints given by service dynamically. Setting this

• endpointCacheSize (Number) —

  the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

• hostPrefixEnabled (Boolean) —

  whether to marshal request parameters to the prefix of hostname. Defaults to true.

• stsRegionalEndpoints ('legacy'|'regional') —

  whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

• (AWS.Endpoint) —

  an Endpoint object representing the endpoint URL for service requests.

Method Details

batchMeterUsage(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• BatchMeterUsage

Examples:

Calling the batchMeterUsage operation

var params = {
  ProductCode: 'STRING_VALUE', /* required */
  UsageRecords: [ /* required */
    {
      CustomerIdentifier: 'STRING_VALUE', /* required */
      Dimension: 'STRING_VALUE', /* required */
      Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
      Quantity: 'NUMBER_VALUE',
      UsageAllocations: [
        {
          AllocatedUsageQuantity: 'NUMBER_VALUE', /* required */
          Tags: [
            {
              Key: 'STRING_VALUE', /* required */
              Value: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
marketplacemetering.batchMeterUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • UsageRecords — (Array<map>)

    The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

    • Timestamp — required — (Date)

      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 — required — (String)

      The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

    • Dimension — required — (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 — (Array<map>)

      The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

      • AllocatedUsageQuantity — required — (Integer)

        The total quantity allocated to this bucket of usage.

      • Tags — (Array<map>)

        The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

        • Key — required — (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 — required — (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.

  • ProductCode — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Results — (Array<map>)

      Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.

      • UsageRecord — (map)

        The UsageRecord that was part of the BatchMeterUsage request.

        • Timestamp — required — (Date)

          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 — required — (String)

          The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

        • Dimension — required — (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 — (Array<map>)

          The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

          • AllocatedUsageQuantity — required — (Integer)

            The total quantity allocated to this bucket of usage.

          • Tags — (Array<map>)

            The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

            • Key — required — (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 — required — (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.

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

        • CustomerNotSubscribed- The CustomerIdentifier specified is not subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.

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

        Possible values include:
        • "Success"
        • "CustomerNotSubscribed"
        • "DuplicateRecord"
    • UnprocessedRecords — (Array<map>)

      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.

      • Timestamp — required — (Date)

        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 — required — (String)

        The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

      • Dimension — required — (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 — (Array<map>)

        The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

        • AllocatedUsageQuantity — required — (Integer)

          The total quantity allocated to this bucket of usage.

        • Tags — (Array<map>)

          The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

          • Key — required — (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 — required — (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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

meterUsage(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

• MeterUsage

Examples:

Calling the meterUsage operation

var params = {
  ProductCode: 'STRING_VALUE', /* required */
  Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  UsageDimension: 'STRING_VALUE', /* required */
  DryRun: true || false,
  UsageAllocations: [
    {
      AllocatedUsageQuantity: 'NUMBER_VALUE', /* required */
      Tags: [
        {
          Key: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  UsageQuantity: 'NUMBER_VALUE'
};
marketplacemetering.meterUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProductCode — (String)

    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.

  • Timestamp — (Date)

    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.

  • UsageDimension — (String)

    It will be one of the fcp dimension name provided during the publishing of the product.

  • UsageQuantity — (Integer)

    Consumption value for the hour. Defaults to 0 if not specified.

  • DryRun — (Boolean)

    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.

  • UsageAllocations — (Array<map>)

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

    • AllocatedUsageQuantity — required — (Integer)

      The total quantity allocated to this bucket of usage.

    • Tags — (Array<map>)

      The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out.

      • Key — required — (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 — required — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MeteringRecordId — (String)

      Metering record id.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

registerUsage(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• RegisterUsage

Examples:

Calling the registerUsage operation

var params = {
  ProductCode: 'STRING_VALUE', /* required */
  PublicKeyVersion: 'NUMBER_VALUE', /* required */
  Nonce: 'STRING_VALUE'
};
marketplacemetering.registerUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ProductCode — (String)

    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.

  • PublicKeyVersion — (Integer)

    Public Key Version provided by AWS Marketplace

  • Nonce — (String)

    (Optional) To scope down the registration to a specific running software instance and guard against replay attacks.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • PublicKeyRotationTimestamp — (Date)

      (Optional) Only included when public key version has expired

    • Signature — (String)

      JWT Token

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

resolveCustomer(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

• ResolveCustomer

Examples:

Calling the resolveCustomer operation

var params = {
  RegistrationToken: 'STRING_VALUE' /* required */
};
marketplacemetering.resolveCustomer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • RegistrationToken — (String)

    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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CustomerIdentifier — (String)

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

    • ProductCode — (String)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.