Class: Aws::MarketplaceMetering::Types::UsageRecord

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb

Overview

Note:

When making an API call, you may pass UsageRecord data as a hash:

{
  timestamp: Time.now, # required
  customer_identifier: "CustomerIdentifier", # required
  dimension: "UsageDimension", # required
  quantity: 1,
}

A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_identifier ⇒ String

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

Returns:

  • (String) 


494
495
496
497
498
499
500
501
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 494

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity)
  SENSITIVE = []
  include Aws::Structure
end

#dimension ⇒ 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.

Returns:

  • (String) 


494
495
496
497
498
499
500
501
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 494

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity)
  SENSITIVE = []
  include Aws::Structure
end

#quantity ⇒ Integer

The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

Returns:

  • (Integer) 


494
495
496
497
498
499
500
501
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 494

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity)
  SENSITIVE = []
  include Aws::Structure
end

#timestamp ⇒ Time

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) 


494
495
496
497
498
499
500
501
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 494

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity)
  SENSITIVE = []
  include Aws::Structure
end