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

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

Overview

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 de-duplicated to prevent double charges.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#customer_aws_account_id ⇒ String

The CustomerAWSAccountId parameter specifies the AWS account ID of the buyer.

If you have an existing integration and need the CustomerAWSAccountId that corresponds to a CustomerIdentifier, contact AWS Marketplace Seller Operations to obtain the mapping. Do not request the CustomerAWSAccountId directly from buyers. We cannot verify that a buyer-provided account ID is authentic, which can result in incorrect metering or billing.

Returns:

  • (String) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

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

#customer_identifier ⇒ String

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

CustomerIdentifier is not supported for new SaaS product integrations. Use CustomerAWSAccountId to identify the buyer.

Returns:

  • (String) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

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

#dimension ⇒ String

During the process of registering a product on Amazon Web Services Marketplace, dimensions are specified. These represent different units of value in your application.

Returns:

  • (String) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

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

#license_arn ⇒ String

The LicenseArn is a unique identifier for a specific granted license. These are used for software purchased through Amazon Web Services Marketplace.

To access your CustomerAWSAccountId and LicenseArn mapping, visit Agreements Feeds.

Returns:

  • (String) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity,
  :usage_allocations,
  :customer_aws_account_id,
  :license_arn)
  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) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

class UsageRecord < Struct.new(
  :timestamp,
  :customer_identifier,
  :dimension,
  :quantity,
  :usage_allocations,
  :customer_aws_account_id,
  :license_arn)
  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 24 hours in the past. Make sure the timestamp value is not before the start of the software usage.

At the end of each billing cycle, you have a 6-hour grace period to submit usage records for the previous billing month before 06:00 UTC on the first day of the next month.

Returns:

  • (Time) 


670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

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

#usage_allocations ⇒ Array<Types::UsageAllocation>

The set of UsageAllocations to submit. The sum of all UsageAllocation quantities must equal the Quantity of the UsageRecord.

Returns:



670
671
672
673
674
675
676
677
678
679
680
 
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 670

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