Skip to content

Meter Usage

marketplacemetering_meter_usage R Documentation

API to emit metering records

Description

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

meter_usage is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod.

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

Usage

marketplacemetering_meter_usage(ProductCode, Timestamp, UsageDimension,
  UsageQuantity, DryRun, UsageAllocations)

Arguments

ProductCode

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

Timestamp

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

UsageDimension

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

UsageQuantity

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

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.

UsageAllocations

The set of UsageAllocations to submit.

The sum of all UsageAllocation quantities must equal the UsageQuantity of the meter_usage request, and each UsageAllocation must have a unique set of tags (include no tags).

Value

A list with the following syntax: 

list(
  MeteringRecordId = "string"
)

Request syntax

svc$meter_usage(
  ProductCode = "string",
  Timestamp = as.POSIXct(
    "2015-01-01"
  ),
  UsageDimension = "string",
  UsageQuantity = 123,
  DryRun = TRUE|FALSE,
  UsageAllocations = list(
    list(
      AllocatedUsageQuantity = 123,
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  )
)