{ "uuid": "b58bdb71-423a-4d5c-a76f-93d335f8de60", "lastMigration": 29, "name": "AWSMarketplace Metering", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "e55d8cc1-23e3-4d3f-aa86-5f5e2f937770", "documentation": "

BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

BatchMeterUsage can process up to 25 UsageRecords at a time.

A UsageRecord can optionally include multiple usage allocations, to provide customers with usagedata split into buckets by tags that you define (or allow the customer to define).

BatchMeterUsage requests must be less than 1MB in size.

", "method": "post", "endpoint": "#X-Amz-Target=AWSMPMeteringService.BatchMeterUsage", "responses": [ { "uuid": "026d26dd-8630-4279-a03d-9a0065d245bf", "body": "{\n \"Results\": [\n {\n \"UsageRecord\": {\n \"Timestamp\": \"{{faker 'date.recent' 365}}\",\n \"CustomerIdentifier\": \"\",\n \"Dimension\": \"\",\n \"Quantity\": {{faker 'number.int' max=99999}},\n \"UsageAllocations\": [\n {\n \"AllocatedUsageQuantity\": {{faker 'number.int' max=99999}},\n \"Tags\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ]\n },\n \"MeteringRecordId\": \"\",\n \"Status\": \"\"\n }\n ],\n \"UnprocessedRecords\": [\n {\n \"Timestamp\": \"{{faker 'date.recent' 365}}\",\n \"CustomerIdentifier\": \"\",\n \"Dimension\": \"\",\n \"Quantity\": {{faker 'number.int' max=99999}},\n \"UsageAllocations\": [\n {\n \"AllocatedUsageQuantity\": {{faker 'number.int' max=99999}},\n \"Tags\": [\n {\n \"Key\": \"\",\n \"Value\": \"\"\n }\n ]\n }\n ]\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "491a2479-b0e8-4f34-843d-204d0c08c87a", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InternalServiceErrorException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "940c289a-da73-494c-a8ea-15518742d6b2", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InvalidProductCodeException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "64bab3b7-77f8-4260-99dd-d17f75a7d985", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InvalidUsageDimensionException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "630a7f35-c770-4d3e-9e1d-34cb148bb428", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "InvalidTagException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fcf5dced-c12d-4b9a-9bf1-fa93a205084b", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "InvalidUsageAllocationsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "59f6841e-11f5-4cfb-9faa-714e9cb41104", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "InvalidCustomerIdentifierException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ccec89fa-7723-4d28-9d2c-8c8c80d1e2aa", "body": "\"\"", "latency": 0, "statusCode": 486, "label": "TimestampOutOfBoundsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "7e3a2af5-8b53-4213-a0a4-e302db39a465", "body": "\"\"", "latency": 0, "statusCode": 487, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "97aa996e-c3d8-4e53-8056-c89e54c1faaf", "body": "\"\"", "latency": 0, "statusCode": 488, "label": "DisabledApiException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9897b3f4-4f6e-4186-bce4-cdf6490a6536", "documentation": "

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

MeterUsage is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod.

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

", "method": "post", "endpoint": "#X-Amz-Target=AWSMPMeteringService.MeterUsage", "responses": [ { "uuid": "4059876d-3ab9-4493-92e0-306d6d3bfab2", "body": "{\n \"MeteringRecordId\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "69645b4a-ac3a-470b-90d1-f9233575f1d5", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InternalServiceErrorException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "6c3bdab5-d657-4421-9d90-3829179a8870", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InvalidProductCodeException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "ef8dde99-d2d7-40d9-a954-1df0693839e5", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InvalidUsageDimensionException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fbd5a370-c400-4a31-9b3a-2cc5ef3ce19e", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "InvalidTagException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8b1bb60e-5922-4c98-99f4-86af66b72dd1", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "InvalidUsageAllocationsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "76017fed-39bc-4a89-9f28-a3cb84678d5a", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "InvalidEndpointRegionException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "acc469e5-9e49-4e46-9c15-7c30daec59da", "body": "\"\"", "latency": 0, "statusCode": 486, "label": "TimestampOutOfBoundsException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "b94396e5-8a64-4b85-b9fa-74ad7d5fff66", "body": "\"\"", "latency": 0, "statusCode": 487, "label": "DuplicateRequestException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "4b8864ec-56ff-4ca1-b26f-86d792283d07", "body": "\"\"", "latency": 0, "statusCode": 488, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "434ed40d-b18e-4c22-8a37-572d121d1c1a", "body": "\"\"", "latency": 0, "statusCode": 489, "label": "CustomerNotEntitledException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2c058b3d-2c69-4219-8af0-21f4a6b48a6a", "documentation": "

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

", "method": "post", "endpoint": "#X-Amz-Target=AWSMPMeteringService.RegisterUsage", "responses": [ { "uuid": "abd54725-6cda-43da-a1ff-f4f30a5d019b", "body": "{\n \"PublicKeyRotationTimestamp\": \"{{faker 'date.recent' 365}}\",\n \"Signature\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "bbda0490-cc43-4d73-9018-702b551624d4", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidProductCodeException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9f30581f-c69e-44fd-9593-b2d20e0472eb", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "InvalidRegionException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "0928b49d-ad2e-49dd-ba20-c43275ac88ff", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "InvalidPublicKeyVersionException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a236a57d-3235-4bd2-8c85-8dabd3361cbd", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "PlatformNotSupportedException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "32e238d8-2914-45b5-99b1-aa320a56cb5f", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "CustomerNotEntitledException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "fa42db56-8c1b-4d73-bb48-7f7ae9cb8aed", "body": "\"\"", "latency": 0, "statusCode": 485, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "00d0ae0a-48de-4e70-92ad-3b037a2caa45", "body": "\"\"", "latency": 0, "statusCode": 486, "label": "InternalServiceErrorException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "cba06e82-5b25-4ba3-bec5-347690b9b0d9", "body": "\"\"", "latency": 0, "statusCode": 487, "label": "DisabledApiException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d56f948b-6661-40c0-94a0-247b82bf6dfb", "documentation": "ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier and product code.", "method": "post", "endpoint": "#X-Amz-Target=AWSMPMeteringService.ResolveCustomer", "responses": [ { "uuid": "b47dc423-b19b-4ffc-93ef-ab502896defb", "body": "{\n \"CustomerIdentifier\": \"\",\n \"ProductCode\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Success", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "6f64b96f-a3ea-43fc-93bf-8f9aa435bd60", "body": "\"\"", "latency": 0, "statusCode": 480, "label": "InvalidTokenException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "dfb17c24-1ec6-4aa7-bfcf-746ad3b0b88c", "body": "\"\"", "latency": 0, "statusCode": 481, "label": "ExpiredTokenException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "527f5da4-c4fb-464e-b6c8-2e4206f24d80", "body": "\"\"", "latency": 0, "statusCode": 482, "label": "ThrottlingException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "801e4065-adf7-4f31-bd41-f72932ee0a6d", "body": "\"\"", "latency": 0, "statusCode": 483, "label": "InternalServiceErrorException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1bf95964-8f0a-4bc5-98be-db522875cd08", "body": "\"\"", "latency": 0, "statusCode": 484, "label": "DisabledApiException", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "e55d8cc1-23e3-4d3f-aa86-5f5e2f937770" }, { "type": "route", "uuid": "9897b3f4-4f6e-4186-bce4-cdf6490a6536" }, { "type": "route", "uuid": "2c058b3d-2c69-4219-8af0-21f4a6b48a6a" }, { "type": "route", "uuid": "d56f948b-6661-40c0-94a0-247b82bf6dfb" } ] }