AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::MarketplaceMetering::Types::MeterUsageRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MeterUsageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  product_code: "ProductCode", # required
  timestamp: Time.now, # required
  usage_dimension: "UsageDimension", # required
  usage_quantity: 1,
  dry_run: false,
  usage_allocations: [
    {
      allocated_usage_quantity: 1, # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue", # required
        },
      ],
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#dry_runBoolean

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.

Returns:

  • (Boolean)

    Checks whether you have the permissions required for the action, but does not make the request.

#product_codeString

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.

Returns:

  • (String)

    Product code is used to uniquely identify a product in AWS Marketplace.

#timestampTime

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.

Returns:

  • (Time)

    Timestamp, in UTC, for which the usage is being reported.

#usage_allocationsArray<Types::UsageAllocation>

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

Returns:

#usage_dimensionString

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

Returns:

  • (String)

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

#usage_quantityInteger

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

Returns:

  • (Integer)

    Consumption value for the hour.