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 and returns the metering record ID. This is used for metering flexible consumption pricing (FCP) Amazon Machine Images (AMI) and container products.
meter_usage
is authenticated on the buyer's Amazon Web Services
account using credentials from the Amazon EC2 instance, Amazon ECS task,
or Amazon 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.
For Amazon Web Services Regions that support meter_usage
, see
MeterUsage Region support for Amazon
EC2
and MeterUsage Region support for Amazon ECS and Amazon
EKS.
Usage¶
marketplacemetering_meter_usage(ProductCode, Timestamp, UsageDimension,
UsageQuantity, DryRun, UsageAllocations)
Arguments¶
ProductCode |
[required] Product code is used to uniquely identify a product in Amazon Web Services 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 six hours in the
past. Make sure the |
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 |
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 |
UsageAllocations |
The set of The sum of all |
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"
)
)
)
)
)