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

Inherits:

Struct

• Object
• Struct
• Aws::MarketplaceMetering::Types::MeterUsageRequest

Defined in:

gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dry_run ⇒ Boolean

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

• #product_code ⇒ String

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

• #timestamp ⇒ Time

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

• #usage_allocations ⇒ Array<Types::UsageAllocation>

  The set of UsageAllocations to submit.

• #usage_dimension ⇒ String

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

• #usage_quantity ⇒ Integer

  Consumption value for the hour.

Instance Attribute Details

#dry_run ⇒ Boolean

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)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  SENSITIVE = []
  include Aws::Structure
end

#product_code ⇒ String

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)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  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)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  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 UsageQuantity of the MeterUsage request, and each UsageAllocation must have a unique set of tags (include no tags).

Returns:

• (Array<Types::UsageAllocation>)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  SENSITIVE = []
  include Aws::Structure
end

#usage_dimension ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  SENSITIVE = []
  include Aws::Structure
end

#usage_quantity ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 299

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run,
  :usage_allocations)
  SENSITIVE = []
  include Aws::Structure
end