Skip to content

MeterUsageRequest

Source code in docs_src/capo_marketplace_metering/types/meter_usage_request.py
class MeterUsageRequest(TypedDict, closed=True):
    product_code: "capo_marketplace_metering.types.product_code.ProductCode"
    """<p>Product code is used to uniquely identify a product in Amazon Web Services Marketplace. The product code should be the same as the one used during the publishing of a new product.</p>"""
    timestamp: "capo_marketplace_metering.types.timestamp.Timestamp"
    """<p>Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to six hours in the past. Make sure the <code>timestamp</code> value is not before the start of the software usage.</p>"""
    usage_dimension: "capo_marketplace_metering.types.usage_dimension.UsageDimension"
    """<p>It will be one of the fcp dimension name provided during the publishing of the product.</p>"""
    usage_quantity: NotRequired[
        "capo_marketplace_metering.types.usage_quantity.UsageQuantity"
    ]
    """<p>Consumption value for the hour. Defaults to <code>0</code> if not specified.</p>"""
    dry_run: NotRequired["capo_marketplace_metering.types.boolean.Boolean"]
    """<p>Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns <code>DryRunOperation</code>; otherwise, it returns <code>UnauthorizedException</code>. Defaults to <code>false</code> if not specified.</p>"""
    usage_allocations: NotRequired[
        "capo_marketplace_metering.types.usage_allocations.UsageAllocations"
    ]
    """<p>The set of <code>UsageAllocations</code> to submit.</p> <p>The sum of all <code>UsageAllocation</code> quantities must equal the <code>UsageQuantity</code> of the <code>MeterUsage</code> request, and each <code>UsageAllocation</code> must have a unique set of tags (include no tags).</p>"""
    client_token: NotRequired[
        "capo_marketplace_metering.types.client_token.ClientToken"
    ]
    """<p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</p> <p>If you don't provide this value, then Amazon Web Services generates a random one for you.</p> <p>If you retry the operation with the same <code>ClientToken</code>, but with different parameters, the retry fails with an <code>IdempotencyConflictException</code> error.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotencyConflictException error.

dry_run instance-attribute

dry_run: NotRequired[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.

product_code instance-attribute

product_code: ProductCode

Product code is used to uniquely identify a product in Amazon Web Services Marketplace. The product code should be the same as the one used during the publishing of a new product.

timestamp instance-attribute

timestamp: Timestamp

Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to six hours in the past. Make sure the timestamp value is not before the start of the software usage.

usage_allocations instance-attribute

usage_allocations: NotRequired[UsageAllocations]

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

usage_dimension instance-attribute

usage_dimension: UsageDimension

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

usage_quantity instance-attribute

usage_quantity: NotRequired[UsageQuantity]

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