{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.marketplacemetering#AWSMPMeteringService": { "type": "service", "version": "2016-01-14", "operations": [ { "target": "com.amazonaws.marketplacemetering#BatchMeterUsage" }, { "target": "com.amazonaws.marketplacemetering#MeterUsage" }, { "target": "com.amazonaws.marketplacemetering#RegisterUsage" }, { "target": "com.amazonaws.marketplacemetering#ResolveCustomer" } ], "traits": { "aws.api#service": { "sdkId": "Marketplace Metering", "arnNamespace": "aws-marketplace", "cloudFormationName": "MarketplaceMetering", "cloudTrailEventSource": "marketplacemetering.amazonaws.com", "docId": "meteringmarketplace-2016-01-14", "endpointPrefix": "metering.marketplace" }, "aws.auth#sigv4": { "name": "aws-marketplace" }, "aws.protocols#awsJson1_1": {}, "smithy.api#documentation": "Amazon Web Services Marketplace Metering Service\n

This reference provides descriptions of the low-level Marketplace Metering Service API.

\n

Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage\n dimensions.

\n

For information about the permissions that you need to use this API, see Amazon Web Services Marketplace metering and entitlement API permissions in the Amazon Web Services Marketplace\n Seller Guide.\n

\n

\n Submitting metering records\n

\n

\n MeterUsage\n

\n \n

\n BatchMeterUsage\n

\n \n

\n Accepting new customers\n

\n

\n ResolveCustomer\n

\n \n

\n Entitlement and metering for paid container\n products\n

\n

\n RegisterUsage\n

\n \n

\n Entitlement custom metering for container\n products\n

\n \n

\n Custom metering for Amazon EKS is available in 17\n Amazon Web Services Regions\n

\n ", "smithy.api#title": "AWSMarketplace Metering", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://metering-marketplace.{Region}.amazonaws.eu", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://metering.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://metering.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://metering.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://metering.marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 17, "nodes": "/////wAAAAH/////AAAAAAAAABAAAAADAAAAAQAAAAQF9eENAAAAAgAAAAUF9eENAAAAAwAAAAwAAAAGAAAABQAAAAgAAAAHAAAABgX14QUF9eEMAAAABwX14QQAAAAJAAAACAX14QQAAAAKAAAACQX14QQAAAALAAAACgX14QoF9eELAAAABAAAAA4AAAANAAAABQX14QcF9eEJAAAABQAAAA8F9eEIAAAACgX14QYF9eEHAAAAAwX14QEAAAARAAAABQX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-cn" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-us-gov" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "endpoint": { "url": "https://metering-marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "stringEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "name" ] }, "aws-eusc" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "endpoint": { "url": "https://metering-marketplace.{Region}.amazonaws.eu", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://metering.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://metering.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://metering.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://metering.marketplace.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering-marketplace.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering-marketplace.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering-marketplace.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://metering-marketplace.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://metering.marketplace.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.marketplacemetering#AgreementId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9_/-]+$" } }, "com.amazonaws.marketplacemetering#AllocatedUsageQuantity": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 2147483647 } } }, "com.amazonaws.marketplacemetering#AllocatedUsageQuantityAsDecimalString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 17 }, "smithy.api#pattern": "^(0|[1-9][0-9]{0,9})(\\.[0-9]{1,6})?$" } }, "com.amazonaws.marketplacemetering#BatchMeterUsage": { "type": "operation", "input": { "target": "com.amazonaws.marketplacemetering#BatchMeterUsageRequest" }, "output": { "target": "com.amazonaws.marketplacemetering#BatchMeterUsageResult" }, "errors": [ { "target": "com.amazonaws.marketplacemetering#DisabledApiException" }, { "target": "com.amazonaws.marketplacemetering#InternalServiceErrorException" }, { "target": "com.amazonaws.marketplacemetering#InvalidCustomerIdentifierException" }, { "target": "com.amazonaws.marketplacemetering#InvalidLicenseException" }, { "target": "com.amazonaws.marketplacemetering#InvalidProductCodeException" }, { "target": "com.amazonaws.marketplacemetering#InvalidTagException" }, { "target": "com.amazonaws.marketplacemetering#InvalidUsageAllocationsException" }, { "target": "com.amazonaws.marketplacemetering#InvalidUsageDimensionException" }, { "target": "com.amazonaws.marketplacemetering#ThrottlingException" }, { "target": "com.amazonaws.marketplacemetering#TimestampOutOfBoundsException" } ], "traits": { "smithy.api#documentation": "\n

The Amazon Web Services Marketplace AI Metering Agent Skill (aws-marketplace-metering) helps an AI\n coding agent integrate your SaaS product's usage reporting with the\n BatchMeterUsage API. The skill is a curated package of instructions and\n reference material that guides your AI coding agent through building, deploying, and\n testing the metering integration. To get the skill on demand without checking it out\n locally, install the Amazon Web Services MCP Server in your coding agent; the agent then discovers and loads\n the skill at runtime. The skill source is also available on GitHub. For more information, see Get started with the Amazon Web Services Marketplace AI Metering Agent Skill on the Amazon Web Services Marketplace blog.

\n
\n \n

Amazon Web Services Marketplace is introducing Concurrent Agreements, enabling buyers to make multiple purchases per Amazon Web Services account. Starting June 1, 2026, new SaaS products must use CustomerAWSAccountId (instead of CustomerIdentifier), LicenseArn (instead of ProductCode) to support this feature. BatchMeterUsage does not support CustomerIdentifier for new integrations. Existing integrations continue to work. Review the new integration for Concurrent Agreements here. For additional implementation details, see BatchMeterUsage code example with LicenseArn in the Amazon Web Services Marketplace Seller Guide.

\n
\n

To post metering records for customers, SaaS applications call\n BatchMeterUsage, which is used for metering SaaS flexible\n consumption pricing (FCP). Identical requests are idempotent and can be\n retried with the same records or a subset of records. Each\n BatchMeterUsage request is for only one product. If you\n want to meter usage for multiple products, you must make multiple\n BatchMeterUsage calls.

\n

Usage records should be submitted in quick succession following a\n recorded event. Usage records aren't accepted 24 hours or more after an\n event. At the end of each billing cycle, a 6-hour grace period applies. We accept\n usage records for the previous billing month until 06:00 UTC on the first day of the\n next month. For example, you must submit March usage records before 06:00 UTC on\n April 1. On April 1 at 05:00 UTC, you can still submit records for March 31 (within the 6-hour grace period). After 06:00 UTC on April 1, March records are rejected regardless of the normal 24-hour submission window. After this grace period, we return a\n TimestampOutOfBoundsException error.

\n

\n BatchMeterUsage can process up to 25\n UsageRecords at a time, and each request must be less than\n 1 MB in size.

\n

\n Vendor-metered tagging\n

\n

\n BatchMeterUsage supports vendor-metered tagging. Optionally, you can\n split the usage in a UsageRecord into buckets by including\n UsageAllocations, where each UsageAllocation has a set of\n Tags that you define. Vendor-metered tagging doesn't change the price,\n dimensions, or the total usage that you report. It gives buyers a more granular view of\n their usage of your product so they can perform cost allocation in the Amazon Web Services Billing and\n Cost Management console. For more information, see Vendor-metered tagging and BatchMeterUsage with usage allocation tagging code example in the\n Amazon Web Services Marketplace Seller Guide.

\n

To report fractional usage, use QuantityAsDecimal instead of\n Quantity in each UsageRecord.

\n

\n BatchMeterUsage returns a list of\n UsageRecordResult objects, which have each\n UsageRecord. It also returns a list of\n UnprocessedRecords, which indicate errors on the service\n side that should be retried.

\n

For Amazon Web Services Regions that support BatchMeterUsage, see BatchMeterUsage Region support.\n

\n \n

For an example of BatchMeterUsage, see BatchMeterUsage code example in the Amazon Web Services Marketplace Seller\n Guide.

\n
" } }, "com.amazonaws.marketplacemetering#BatchMeterUsageRequest": { "type": "structure", "members": { "UsageRecords": { "target": "com.amazonaws.marketplacemetering#UsageRecordList", "traits": { "smithy.api#documentation": "

The set of UsageRecords to submit. BatchMeterUsage accepts\n up to 25 UsageRecords at a time.

", "smithy.api#required": {} } }, "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "

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

\n \n

\n ProductCode is required only for legacy integrations that use CustomerIdentifier. For new integrations using LicenseArn (Concurrent Agreements), do NOT include ProductCode at the request level. The LicenseArn in each UsageRecord identifies both the product and the specific agreement.

\n

Sending metering records with both ProductCode and LicenseArn for the same customer within the same hour will result in duplicate billing. If you are migrating from product-based metering to license-based metering, stop sending ProductCode before you start sending LicenseArn.

\n
" } } }, "traits": { "smithy.api#documentation": "

A BatchMeterUsageRequest contains UsageRecords, which\n indicate quantities of usage within your application.

", "smithy.api#input": {} } }, "com.amazonaws.marketplacemetering#BatchMeterUsageResult": { "type": "structure", "members": { "Results": { "target": "com.amazonaws.marketplacemetering#UsageRecordResultList", "traits": { "smithy.api#documentation": "

Contains all UsageRecords processed by BatchMeterUsage.\n These records were either honored by Amazon Web Services Marketplace Metering Service or were invalid. Invalid\n records should be fixed before being resubmitted.

" } }, "UnprocessedRecords": { "target": "com.amazonaws.marketplacemetering#UsageRecordList", "traits": { "smithy.api#documentation": "

Contains all UsageRecords that were not processed by\n BatchMeterUsage. This is a list of UsageRecords. You can\n retry the failed request by making another BatchMeterUsage call with this\n list as input in the BatchMeterUsageRequest.

" } } }, "traits": { "smithy.api#documentation": "

Contains the UsageRecords processed by BatchMeterUsage and\n any records that have failed due to transient error.

", "smithy.api#output": {} } }, "com.amazonaws.marketplacemetering#Boolean": { "type": "boolean" }, "com.amazonaws.marketplacemetering#ClientToken": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.marketplacemetering#CustomerAWSAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[0-9]+$" } }, "com.amazonaws.marketplacemetering#CustomerIdentifier": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.marketplacemetering#CustomerNotEntitledException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Exception thrown when the customer does not have a valid subscription for the\n product.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#DisabledApiException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The API is disabled in the Region.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#DuplicateRequestException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

A metering record has already been emitted by the same EC2 instance, ECS task, or EKS\n pod for the given {usageDimension, timestamp} with a different\n usageQuantity. Quantities are compared by value, so a whole-number and a\n decimal quantity with the same value (for example, 17 and\n 17.00) are not different.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#ExpiredTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The submitted registration token has expired. This can happen if the buyer's browser\n takes too long to redirect to your page, the buyer has resubmitted the registration\n token, or your application has held on to the registration token for too long. Your SaaS\n registration website should redeem this token as soon as it is submitted by the buyer's\n browser.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#IdempotencyConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The ClientToken is being used for multiple requests.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.marketplacemetering#InternalServiceErrorException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

An internal error has occurred. Retry your request. If the problem persists, post a\n message with details on the Amazon Web Services forums.

", "smithy.api#error": "server" } }, "com.amazonaws.marketplacemetering#InvalidCustomerIdentifierException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

You have metered usage for a CustomerIdentifier that does not\n exist.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidEndpointRegionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The endpoint being called is in a Amazon Web Services Region different from your EC2 instance, ECS\n task, or EKS pod. The Region of the Metering Service endpoint and the Amazon Web Services Region of\n the resource must match.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidLicenseException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Ensure the LicenseArn is valid, matches the customer, and usage is within the license activation period.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidProductCodeException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The product code passed does not match the product code used for publishing the\n product.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidPublicKeyVersionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Public Key version is invalid.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidRegionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

\n RegisterUsage must be called in the same Amazon Web Services Region the ECS task was\n launched in. This prevents a container from hardcoding a Region (e.g.\n withRegion(\u201cus-east-1\u201d) when calling RegisterUsage.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidTagException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The tag is invalid, or the number of tags is greater than 5.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Registration token is invalid.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidUsageAllocationsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Sum of allocated usage quantities is not equal to the usage quantity, or the\n allocations don't use the same type of quantity (whole number or decimal) as the usage\n quantity.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#InvalidUsageDimensionException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The usage dimension does not match one of the UsageDimensions associated\n with products.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#LicenseArn": { "type": "string", "traits": { "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" } }, "com.amazonaws.marketplacemetering#Metadata": { "type": "structure", "members": { "AgreementId": { "target": "com.amazonaws.marketplacemetering#AgreementId", "traits": { "smithy.api#documentation": "

The unique identifier of the Amazon Web Services Marketplace agreement the customer accepted. Use it to\n call Amazon Web Services Marketplace Agreement APIs.

" } } }, "traits": { "smithy.api#documentation": "

Metadata associated with a resolved customer. Includes the AgreementId of\n the Amazon Web Services Marketplace agreement the customer accepted.

" } }, "com.amazonaws.marketplacemetering#MeterUsage": { "type": "operation", "input": { "target": "com.amazonaws.marketplacemetering#MeterUsageRequest" }, "output": { "target": "com.amazonaws.marketplacemetering#MeterUsageResult" }, "errors": [ { "target": "com.amazonaws.marketplacemetering#CustomerNotEntitledException" }, { "target": "com.amazonaws.marketplacemetering#DuplicateRequestException" }, { "target": "com.amazonaws.marketplacemetering#IdempotencyConflictException" }, { "target": "com.amazonaws.marketplacemetering#InternalServiceErrorException" }, { "target": "com.amazonaws.marketplacemetering#InvalidEndpointRegionException" }, { "target": "com.amazonaws.marketplacemetering#InvalidProductCodeException" }, { "target": "com.amazonaws.marketplacemetering#InvalidTagException" }, { "target": "com.amazonaws.marketplacemetering#InvalidUsageAllocationsException" }, { "target": "com.amazonaws.marketplacemetering#InvalidUsageDimensionException" }, { "target": "com.amazonaws.marketplacemetering#ThrottlingException" }, { "target": "com.amazonaws.marketplacemetering#TimestampOutOfBoundsException" } ], "traits": { "smithy.api#documentation": "

As a seller, your software hosted in the buyer's Amazon Web Services account uses this API action to emit metering records directly to Amazon Web Services Marketplace. \n You must use the following buyer Amazon Web Services account credentials to sign the API request.

\n \n

The handling of MeterUsage requests varies between Amazon Bedrock AgentCore Runtime and non-Amazon Bedrock AgentCore deployments.

\n \n

If you submit records more than six hours after events occur, the records won't be accepted. The timestamp in your request determines when an event is recorded.

\n

To report fractional usage, use UsageQuantityAsDecimal instead of\n UsageQuantity.

\n

You can optionally include multiple usage allocations, to provide customers with usage data split into buckets by tags that you define or allow the customer to define.

\n

For Amazon Web Services Regions that support MeterUsage, see MeterUsage Region support for Amazon EC2 and MeterUsage Region support for Amazon ECS and Amazon EKS.

" } }, "com.amazonaws.marketplacemetering#MeterUsageRequest": { "type": "structure", "members": { "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Timestamp": { "target": "com.amazonaws.marketplacemetering#Timestamp", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "UsageDimension": { "target": "com.amazonaws.marketplacemetering#UsageDimension", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "UsageQuantity": { "target": "com.amazonaws.marketplacemetering#UsageQuantity", "traits": { "smithy.api#deprecated": { "since": "2026-10-20", "message": "Use UsageQuantityAsDecimal instead." }, "smithy.api#documentation": "

The consumption value for the hour, as a whole number. Defaults to 0 if neither\n UsageQuantity nor UsageQuantityAsDecimal is specified.

\n

Use UsageQuantityAsDecimal instead. You can't specify both\n UsageQuantity and UsageQuantityAsDecimal.

" } }, "UsageQuantityAsDecimal": { "target": "com.amazonaws.marketplacemetering#UsageQuantityAsDecimalString", "traits": { "smithy.api#documentation": "

The consumption value for the hour, as a decimal string. Use this instead of\n UsageQuantity to report fractional usage.

\n

A non-negative decimal number, for example 17.42.

\n

You can't specify both UsageQuantity and\n UsageQuantityAsDecimal. If you provide UsageAllocations,\n each allocation must use AllocatedUsageQuantityAsDecimal.

\n

Quantities are compared by value when checking for duplicate or retried requests, so\n 17, 17.0, and 17.00 are the same quantity,\n whether you send it in UsageQuantity or\n UsageQuantityAsDecimal.

" } }, "DryRun": { "target": "com.amazonaws.marketplacemetering#Boolean", "traits": { "smithy.api#documentation": "

Checks whether you have the permissions required for the action, but does not make the\n request. If you have the permissions, the request returns DryRunOperation;\n otherwise, it returns UnauthorizedException. Defaults to false\n if not specified.

" } }, "UsageAllocations": { "target": "com.amazonaws.marketplacemetering#UsageAllocations", "traits": { "smithy.api#documentation": "

The set of UsageAllocations to submit.

\n

The sum of all UsageAllocation quantities must equal the usage quantity\n of the MeterUsage request (UsageQuantity or\n UsageQuantityAsDecimal), and each UsageAllocation must have a\n unique set of tags (include no tags). Allocations must use the same type of quantity as\n the request: AllocatedUsageQuantity with UsageQuantity, or\n AllocatedUsageQuantityAsDecimal with\n UsageQuantityAsDecimal.

" } }, "ClientToken": { "target": "com.amazonaws.marketplacemetering#ClientToken", "traits": { "smithy.api#documentation": "

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

\n

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

\n

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

", "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacemetering#MeterUsageResult": { "type": "structure", "members": { "MeteringRecordId": { "target": "com.amazonaws.marketplacemetering#String", "traits": { "smithy.api#documentation": "

Metering record id.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacemetering#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.marketplacemetering#Nonce": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[\\s\\S]*$" } }, "com.amazonaws.marketplacemetering#PlatformNotSupportedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

Amazon Web Services Marketplace does not support metering usage from the underlying platform. Currently, Amazon ECS, Amazon EKS, and Fargate are supported.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#ProductCode": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[-a-zA-Z0-9/=:_.@]*$" } }, "com.amazonaws.marketplacemetering#RegisterUsage": { "type": "operation", "input": { "target": "com.amazonaws.marketplacemetering#RegisterUsageRequest" }, "output": { "target": "com.amazonaws.marketplacemetering#RegisterUsageResult" }, "errors": [ { "target": "com.amazonaws.marketplacemetering#CustomerNotEntitledException" }, { "target": "com.amazonaws.marketplacemetering#DisabledApiException" }, { "target": "com.amazonaws.marketplacemetering#InternalServiceErrorException" }, { "target": "com.amazonaws.marketplacemetering#InvalidProductCodeException" }, { "target": "com.amazonaws.marketplacemetering#InvalidPublicKeyVersionException" }, { "target": "com.amazonaws.marketplacemetering#InvalidRegionException" }, { "target": "com.amazonaws.marketplacemetering#PlatformNotSupportedException" }, { "target": "com.amazonaws.marketplacemetering#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

Paid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services Marketplace\n Metering Service and call the RegisterUsage operation for software\n entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call RegisterUsage, but you may choose to\n do so if you would like to receive usage data in your seller reports. The sections below\n explain the behavior of RegisterUsage. RegisterUsage performs\n two primary functions: metering and entitlement.

\n " } }, "com.amazonaws.marketplacemetering#RegisterUsageRequest": { "type": "structure", "members": { "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "PublicKeyVersion": { "target": "com.amazonaws.marketplacemetering#VersionInteger", "traits": { "smithy.api#documentation": "

Public Key Version provided by Amazon Web Services Marketplace

", "smithy.api#required": {} } }, "Nonce": { "target": "com.amazonaws.marketplacemetering#Nonce", "traits": { "smithy.api#documentation": "

(Optional) To scope down the registration to a specific running software instance and\n guard against replay attacks.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.marketplacemetering#RegisterUsageResult": { "type": "structure", "members": { "PublicKeyRotationTimestamp": { "target": "com.amazonaws.marketplacemetering#Timestamp", "traits": { "smithy.api#documentation": "

(Optional) Only included when public key version has expired

" } }, "Signature": { "target": "com.amazonaws.marketplacemetering#NonEmptyString", "traits": { "smithy.api#documentation": "

JWT Token

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.marketplacemetering#ResolveCustomer": { "type": "operation", "input": { "target": "com.amazonaws.marketplacemetering#ResolveCustomerRequest" }, "output": { "target": "com.amazonaws.marketplacemetering#ResolveCustomerResult" }, "errors": [ { "target": "com.amazonaws.marketplacemetering#DisabledApiException" }, { "target": "com.amazonaws.marketplacemetering#ExpiredTokenException" }, { "target": "com.amazonaws.marketplacemetering#InternalServiceErrorException" }, { "target": "com.amazonaws.marketplacemetering#InvalidTokenException" }, { "target": "com.amazonaws.marketplacemetering#ThrottlingException" } ], "traits": { "smithy.api#documentation": "

\n ResolveCustomer is called by a SaaS application during the registration\n process. When a buyer visits your website during the registration process, the buyer\n submits a registration token through their browser. The registration token is resolved\n through this API to obtain a CustomerIdentifier along with the\n CustomerAWSAccountId, ProductCode, and LicenseArn.

\n \n

For new SaaS product integrations, the CustomerIdentifier field is not populated in the ResolveCustomer API response. New integrations must use CustomerAWSAccountId and LicenseArn to identify customers. Existing integrations continue to work unchanged.

\n
\n \n

To successfully resolve the token, the API must be called from the account that was used to publish the SaaS\n application. For an example of using ResolveCustomer, see ResolveCustomer code example in the Amazon Web Services Marketplace Seller\n Guide.

\n
\n

Permission is required for this operation. Your IAM role or user performing this\n operation requires a policy to allow the aws-marketplace:ResolveCustomer\n action. For more information, see Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service in\n the Service Authorization Reference.

\n

For Amazon Web Services Regions that support ResolveCustomer, see ResolveCustomer Region support.\n

" } }, "com.amazonaws.marketplacemetering#ResolveCustomerRequest": { "type": "structure", "members": { "RegistrationToken": { "target": "com.amazonaws.marketplacemetering#NonEmptyString", "traits": { "smithy.api#documentation": "

When a buyer visits your website during the registration process, the buyer submits a\n registration token through the browser. The registration token is resolved to obtain a\n CustomerIdentifier along with the CustomerAWSAccountId,\n ProductCode, and LicenseArn.

\n \n

For new SaaS product integrations, the CustomerIdentifier field is not populated. Use CustomerAWSAccountId and LicenseArn for customer identification.

\n
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains input to the ResolveCustomer operation.

", "smithy.api#input": {} } }, "com.amazonaws.marketplacemetering#ResolveCustomerResult": { "type": "structure", "members": { "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { "smithy.api#documentation": "

The CustomerIdentifier is used to identify an individual customer in your\n application.

\n \n

For new SaaS product integrations, this field is not populated. Use CustomerAWSAccountId and LicenseArn to identify customers instead.

\n
" } }, "ProductCode": { "target": "com.amazonaws.marketplacemetering#ProductCode", "traits": { "smithy.api#documentation": "

The product code is returned to confirm that the buyer is registering for your\n product. Subsequent BatchMeterUsage calls should be made using this product\n code.

" } }, "CustomerAWSAccountId": { "target": "com.amazonaws.marketplacemetering#CustomerAWSAccountId", "traits": { "smithy.api#documentation": "

The CustomerAWSAccountId provides the Amazon Web Services account ID associated with\n the CustomerIdentifier for the individual customer. Calls to BatchMeterUsage require\n CustomerAWSAccountId for each UsageRecord.

" } }, "LicenseArn": { "target": "com.amazonaws.marketplacemetering#LicenseArn", "traits": { "smithy.api#documentation": "

The LicenseArn is a unique identifier for a specific granted license. These are typically used for software purchased through Amazon Web Services Marketplace. Calls to BatchMeterUsage require LicenseArn for each UsageRecord.

\n \n

Once you receive the CustomerAWSAccountId and LicenseArn in the response, store that for future purposes/API calls/integrations.

\n
" } }, "Metadata": { "target": "com.amazonaws.marketplacemetering#Metadata", "traits": { "smithy.api#documentation": "

The metadata associated with the resolved customer, including the\n AgreementId of the Amazon Web Services Marketplace agreement the customer accepted.

" } } }, "traits": { "smithy.api#documentation": "

The result of the ResolveCustomer operation. Contains the\n CustomerIdentifier along with the CustomerAWSAccountId,\n ProductCode, LicenseArn, and Metadata.

", "smithy.api#output": {} } }, "com.amazonaws.marketplacemetering#String": { "type": "string" }, "com.amazonaws.marketplacemetering#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.marketplacemetering#TagKey", "traits": { "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A key is a\n label that acts like a category for the specific tag values.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.marketplacemetering#TagValue", "traits": { "smithy.api#documentation": "

One part of a key-value pair that makes up a tag. A value\n acts as a descriptor within a tag category (key). The value can be empty or null.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Metadata assigned to an allocation. Each tag is made up of a key and a\n value.

" } }, "com.amazonaws.marketplacemetering#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[a-zA-Z0-9+ -=._:\\/@]+$" } }, "com.amazonaws.marketplacemetering#TagList": { "type": "list", "member": { "target": "com.amazonaws.marketplacemetering#Tag" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.marketplacemetering#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[a-zA-Z0-9+ -=._:\\/@]+$" } }, "com.amazonaws.marketplacemetering#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The calls to the API are throttled.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#Timestamp": { "type": "timestamp" }, "com.amazonaws.marketplacemetering#TimestampOutOfBoundsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.marketplacemetering#errorMessage" } }, "traits": { "smithy.api#documentation": "

The timestamp value passed in the UsageRecord is out of\n allowed range.

\n

For BatchMeterUsage, if any of the records are outside of the allowed\n range, the entire batch is not processed. You must remove invalid records and try\n again.

", "smithy.api#error": "client" } }, "com.amazonaws.marketplacemetering#UsageAllocation": { "type": "structure", "members": { "AllocatedUsageQuantity": { "target": "com.amazonaws.marketplacemetering#AllocatedUsageQuantity", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": 0, "smithy.api#deprecated": { "since": "2026-10-20", "message": "Use AllocatedUsageQuantityAsDecimal instead." }, "smithy.api#documentation": "

The total quantity allocated to this bucket of usage, as a whole number.

\n

Use AllocatedUsageQuantityAsDecimal instead. Each allocation must specify\n exactly one of AllocatedUsageQuantity or\n AllocatedUsageQuantityAsDecimal.

" } }, "AllocatedUsageQuantityAsDecimal": { "target": "com.amazonaws.marketplacemetering#AllocatedUsageQuantityAsDecimalString", "traits": { "smithy.api#documentation": "

The total quantity allocated to this bucket of usage, as a decimal string. Use this\n when the usage quantity of the request or usage record is specified as a decimal\n (UsageQuantityAsDecimal or QuantityAsDecimal).

\n

A non-negative decimal number, for example 17.42.

\n

Each allocation must specify exactly one of AllocatedUsageQuantity or\n AllocatedUsageQuantityAsDecimal.

" } }, "Tags": { "target": "com.amazonaws.marketplacemetering#TagList", "traits": { "smithy.api#documentation": "

The set of tags that define the bucket of usage. For the bucket of items with no tags,\n this parameter can be left out.

" } } }, "traits": { "smithy.api#documentation": "

Usage allocations allow you to split usage into buckets by tags.

\n

Each UsageAllocation indicates the usage quantity for a specific set of\n tags.

" } }, "com.amazonaws.marketplacemetering#UsageAllocations": { "type": "list", "member": { "target": "com.amazonaws.marketplacemetering#UsageAllocation" }, "traits": { "smithy.api#length": { "min": 1, "max": 2500 } } }, "com.amazonaws.marketplacemetering#UsageDimension": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[\\s\\S]+$" } }, "com.amazonaws.marketplacemetering#UsageQuantity": { "type": "integer", "traits": { "smithy.api#range": { "min": 0, "max": 2147483647 } } }, "com.amazonaws.marketplacemetering#UsageQuantityAsDecimalString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 17 }, "smithy.api#pattern": "^(0|[1-9][0-9]{0,9})(\\.[0-9]{1,6})?$" } }, "com.amazonaws.marketplacemetering#UsageRecord": { "type": "structure", "members": { "Timestamp": { "target": "com.amazonaws.marketplacemetering#Timestamp", "traits": { "smithy.api#documentation": "

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

\n

Your application can meter usage for up to 24 hours in the past. Make sure the\n timestamp value is not before the start of the software usage.

\n

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

", "smithy.api#required": {} } }, "CustomerIdentifier": { "target": "com.amazonaws.marketplacemetering#CustomerIdentifier", "traits": { "smithy.api#addedDefault": {}, "smithy.api#default": "", "smithy.api#documentation": "

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

\n \n

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

\n
" } }, "Dimension": { "target": "com.amazonaws.marketplacemetering#UsageDimension", "traits": { "smithy.api#documentation": "

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

", "smithy.api#required": {} } }, "Quantity": { "target": "com.amazonaws.marketplacemetering#UsageQuantity", "traits": { "smithy.api#deprecated": { "since": "2026-10-20", "message": "Use QuantityAsDecimal instead." }, "smithy.api#documentation": "

The quantity of usage consumed by the customer for the given dimension and time, as a\n whole number. Defaults to 0 if neither Quantity nor\n QuantityAsDecimal is specified.

\n

Use QuantityAsDecimal instead. You can't specify both\n Quantity and QuantityAsDecimal in a usage record.

" } }, "QuantityAsDecimal": { "target": "com.amazonaws.marketplacemetering#UsageQuantityAsDecimalString", "traits": { "smithy.api#documentation": "

The quantity of usage consumed by the customer for the given dimension and time, as a\n decimal string. Use this instead of Quantity to report fractional\n usage.

\n

A non-negative decimal number, for example 17.42.

\n

You can't specify both Quantity and QuantityAsDecimal in a\n usage record. If you provide UsageAllocations, each allocation must use\n AllocatedUsageQuantityAsDecimal. If any usage record fails these checks,\n the entire BatchMeterUsage request fails and no records are\n processed.

\n

Quantities are compared by value when checking for duplicate records, so\n 17, 17.0, and 17.00 are the same quantity,\n whether you send it in Quantity or QuantityAsDecimal.

" } }, "UsageAllocations": { "target": "com.amazonaws.marketplacemetering#UsageAllocations", "traits": { "smithy.api#documentation": "

The set of UsageAllocations to submit. The sum of all\n UsageAllocation quantities must equal the quantity of the\n UsageRecord (Quantity or QuantityAsDecimal).\n Allocations must use the same type of quantity as the usage record:\n AllocatedUsageQuantity with Quantity, or\n AllocatedUsageQuantityAsDecimal with\n QuantityAsDecimal.

" } }, "CustomerAWSAccountId": { "target": "com.amazonaws.marketplacemetering#CustomerAWSAccountId", "traits": { "smithy.api#documentation": "

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

\n \n

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.

\n
" } }, "LicenseArn": { "target": "com.amazonaws.marketplacemetering#LicenseArn", "traits": { "smithy.api#documentation": "

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

\n \n

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

\n
" } } }, "traits": { "smithy.api#documentation": "

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

\n

Multiple requests with the same UsageRecords as input will be\n de-duplicated to prevent double charges.

" } }, "com.amazonaws.marketplacemetering#UsageRecordList": { "type": "list", "member": { "target": "com.amazonaws.marketplacemetering#UsageRecord" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 } } }, "com.amazonaws.marketplacemetering#UsageRecordResult": { "type": "structure", "members": { "UsageRecord": { "target": "com.amazonaws.marketplacemetering#UsageRecord", "traits": { "smithy.api#documentation": "

The UsageRecord that was part of the BatchMeterUsage\n request.

" } }, "MeteringRecordId": { "target": "com.amazonaws.marketplacemetering#String", "traits": { "smithy.api#documentation": "

The MeteringRecordId is a unique identifier for this metering\n event.

" } }, "Status": { "target": "com.amazonaws.marketplacemetering#UsageRecordResultStatus", "traits": { "smithy.api#documentation": "

The UsageRecordResult\n Status indicates the status of an individual UsageRecord\n processed by BatchMeterUsage.

\n " } } }, "traits": { "smithy.api#documentation": "

A UsageRecordResult indicates the status of a given\n UsageRecord processed by BatchMeterUsage.

" } }, "com.amazonaws.marketplacemetering#UsageRecordResultList": { "type": "list", "member": { "target": "com.amazonaws.marketplacemetering#UsageRecordResult" } }, "com.amazonaws.marketplacemetering#UsageRecordResultStatus": { "type": "enum", "members": { "SUCCESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "Success" } }, "CUSTOMER_NOT_SUBSCRIBED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CustomerNotSubscribed" } }, "DUPLICATE_RECORD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DuplicateRecord" } } } }, "com.amazonaws.marketplacemetering#VersionInteger": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.marketplacemetering#errorMessage": { "type": "string" } } }