Class: AWS.MarketplaceMetering

Inherits:
AWS.Service show all
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.

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 collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

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

Service Reference:

Examples:

Calling the batchMeterUsage operation

var params = {
  ProductCode: 'STRING_VALUE', /* required */
  UsageRecords: [ /* required */
    {
      CustomerIdentifier: 'STRING_VALUE', /* required */
      Dimension: 'STRING_VALUE', /* required */
      Quantity: 0, /* required */
      Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
    },
    /* 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.

      • Timestamprequired — (Date)

        Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

        Your application can meter usage for up to one hour in the past.

      • CustomerIdentifierrequired — (String)

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

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

      • Quantityrequired — (Integer)

        The quantity of usage consumed by the customer for the given dimension and time.

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

          • Timestamprequired — (Date)

            Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

            Your application can meter usage for up to one hour in the past.

          • CustomerIdentifierrequired — (String)

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

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

          • Quantityrequired — (Integer)

            The quantity of usage consumed by the customer for the given dimension and time.

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

        • Timestamprequired — (Date)

          Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

          Your application can meter usage for up to one hour in the past.

        • CustomerIdentifierrequired — (String)

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

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

        • Quantityrequired — (Integer)

          The quantity of usage consumed by the customer for the given dimension and time.

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, generally when running from an EC2 instance on the AWS Marketplace.

Service Reference:

Examples:

Calling the meterUsage operation

var params = {
  DryRun: true || false, /* required */
  ProductCode: 'STRING_VALUE', /* required */
  Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  UsageDimension: 'STRING_VALUE', /* required */
  UsageQuantity: 0 /* required */
};
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 of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

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

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

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)

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:

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.