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

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

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 MeterUsageRequest data as a hash:

{
  product_code: "ProductCode", # required
  timestamp: Time.now, # required
  usage_dimension: "UsageDimension", # required
  usage_quantity: 1, # required
  dry_run: false, # 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.

Returns:

  • (Boolean)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 112

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run)
  include Aws::Structure
end

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


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 112

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run)
  include Aws::Structure
end

#timestampTime

Timestamp of the hour, recorded in UTC. The seconds and milliseconds portions of the timestamp will be ignored.

Returns:

  • (Time)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 112

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run)
  include Aws::Structure
end

#usage_dimensionString

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

Returns:

  • (String)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 112

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run)
  include Aws::Structure
end

#usage_quantityInteger

Consumption value for the hour.

Returns:

  • (Integer)


112
113
114
115
116
117
118
119
# File 'gems/aws-sdk-marketplacemetering/lib/aws-sdk-marketplacemetering/types.rb', line 112

class MeterUsageRequest < Struct.new(
  :product_code,
  :timestamp,
  :usage_dimension,
  :usage_quantity,
  :dry_run)
  include Aws::Structure
end