openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 33.3 kB

JSON

{"openapi":"3.0.0","info":{"version":"2016-01-14","x-release":"v4","title":"AWSMarketplace Metering","description":"<fullname>AWS Marketplace Metering Service</fullname> This reference provides descriptions of the low-level AWS Marketplace Metering Service API. AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions. For information on the permissions you need to use this API, see <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/iam-user-policy-for-aws-marketplace-actions.html\">AWS Marketplace metering and entitlement API permissions</a> in the AWS Marketplace Seller Guide. Submitting Metering Records <ul> <li> MeterUsage - Submits the metering record for an AWS Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a container running on EKS or ECS. </li> <li> BatchMeterUsage - Submits the metering record for a set of customers. <code>BatchMeterUsage</code> is called from a software-as-a-service (SaaS) application. </li> </ul> Accepting New Customers <ul> <li> ResolveCustomer - 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 the browser. The Registration Token is resolved through this API to obtain a <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>. </li> </ul> Entitlement and Metering for Paid Container Products <ul> <li> Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the <code>RegisterUsage</code> operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call <code>RegisterUsage</code>, but you can do so if you want to receive usage data in your seller reports. For more information on using the <code>RegisterUsage</code> operation, see <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html\">Container-Based Products</a>. </li> </ul> <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use Cloudtrail to verify that the SaaS metering records that you sent are accurate by searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>. You can also use CloudTrail to audit records over time. For more information, see the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html\">AWS CloudTrail User Guide</a>. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"meteringmarketplace","x-aws-signingName":"aws-marketplace","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/meteringmarketplace-2016-01-14.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/marketplace/"},"servers":[{"url":"http://metering.marketplace.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWSMarketplace Metering multi-region endpoint"},{"url":"https://metering.marketplace.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWSMarketplace Metering multi-region endpoint"},{"url":"http://metering.marketplace.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWSMarketplace Metering endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://metering.marketplace.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWSMarketplace Metering endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/#X-Amz-Target=AWSMPMeteringService.BatchMeterUsage":{"post":{"operationId":"BatchMeterUsage","description":" <code>BatchMeterUsage</code> is called from a SaaS application listed on 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 <code>BatchMeterUsage</code> is for one product. If you need to meter usage for multiple products, you must make multiple calls to <code>BatchMeterUsage</code>. Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event. <code>BatchMeterUsage</code> can process up to 25 <code>UsageRecords</code> at a time. A <code>UsageRecord</code> 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). <code>BatchMeterUsage</code> returns a list of <code>UsageRecordResult</code> objects, showing the result for each <code>UsageRecord</code>, as well as a list of <code>UnprocessedRecords</code>, indicating errors in the service side that you should retry. <code>BatchMeterUsage</code> requests must be less than 1MB in size. <note> For an example of using <code>BatchMeterUsage</code>, see <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example\"> BatchMeterUsage code example</a> in the AWS Marketplace Seller Guide. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchMeterUsageResult"}}}},"480":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"481":{"description":"InvalidProductCodeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidProductCodeException"}}}},"482":{"description":"InvalidUsageDimensionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidUsageDimensionException"}}}},"483":{"description":"InvalidTagException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidTagException"}}}},"484":{"description":"InvalidUsageAllocationsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidUsageAllocationsException"}}}},"485":{"description":"InvalidCustomerIdentifierException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidCustomerIdentifierException"}}}},"486":{"description":"TimestampOutOfBoundsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimestampOutOfBoundsException"}}}},"487":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"488":{"description":"DisabledApiException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledApiException"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchMeterUsageRequest"}}}},"parameters":[{"name":"X-Amz-Target","in":"header","required":true,"schema":{"type":"string","enum":["AWSMPMeteringService.BatchMeterUsage"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#X-Amz-Target=AWSMPMeteringService.MeterUsage":{"post":{"operationId":"MeterUsage","description":"API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID. <code>MeterUsage</code> is authenticated on the buyer's AWS account using credentials from the EC2 instance, ECS task, or EKS pod. <code>MeterUsage</code> 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). Usage records are expected to be submitted as quickly as possible after the event that is being recorded, and are not accepted more than 6 hours after the event.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeterUsageResult"}}}},"480":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"481":{"description":"InvalidProductCodeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidProductCodeException"}}}},"482":{"description":"InvalidUsageDimensionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidUsageDimensionException"}}}},"483":{"description":"InvalidTagException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidTagException"}}}},"484":{"description":"InvalidUsageAllocationsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidUsageAllocationsException"}}}},"485":{"description":"InvalidEndpointRegionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidEndpointRegionException"}}}},"486":{"description":"TimestampOutOfBoundsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimestampOutOfBoundsException"}}}},"487":{"description":"DuplicateRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DuplicateRequestException"}}}},"488":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"489":{"description":"CustomerNotEntitledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerNotEntitledException"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeterUsageRequest"}}}},"parameters":[{"name":"X-Amz-Target","in":"header","required":true,"schema":{"type":"string","enum":["AWSMPMeteringService.MeterUsage"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#X-Amz-Target=AWSMPMeteringService.RegisterUsage":{"post":{"operationId":"RegisterUsage","description":"Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the <code>RegisterUsage</code> operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call <code>RegisterUsage</code>, 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 <code>RegisterUsage</code>. <code>RegisterUsage</code> performs two primary functions: metering and entitlement. <ul> <li> Entitlement: <code>RegisterUsage</code> allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with <code>RegisterUsage</code> is only required to guard against unauthorized use at container startup, as such a <code>CustomerNotSubscribedException</code> or <code>PlatformNotSupportedException</code> will only be thrown on the initial call to <code>RegisterUsage</code>. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a <code>CustomerNotSubscribedException</code>, even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is still running. </li> <li> Metering: <code>RegisterUsage</code> meters software use per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a service configured as a Daemon Set, then Amazon ECS or Amazon EKS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call <code>RegisterUsage</code> once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks and Amazon EKS pods, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime. </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUsageResult"}}}},"480":{"description":"InvalidProductCodeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidProductCodeException"}}}},"481":{"description":"InvalidRegionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRegionException"}}}},"482":{"description":"InvalidPublicKeyVersionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidPublicKeyVersionException"}}}},"483":{"description":"PlatformNotSupportedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformNotSupportedException"}}}},"484":{"description":"CustomerNotEntitledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerNotEntitledException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"487":{"description":"DisabledApiException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledApiException"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUsageRequest"}}}},"parameters":[{"name":"X-Amz-Target","in":"header","required":true,"schema":{"type":"string","enum":["AWSMPMeteringService.RegisterUsage"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#X-Amz-Target=AWSMPMeteringService.ResolveCustomer":{"post":{"operationId":"ResolveCustomer","description":" <code>ResolveCustomer</code> 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 <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>. <note> The API needs to called from the seller account id used to publish the SaaS application to successfully resolve the token. For an example of using <code>ResolveCustomer</code>, see <a href=\"https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example\"> ResolveCustomer code example</a> in the AWS Marketplace Seller Guide. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveCustomerResult"}}}},"480":{"description":"InvalidTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidTokenException"}}}},"481":{"description":"ExpiredTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiredTokenException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"InternalServiceErrorException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceErrorException"}}}},"484":{"description":"DisabledApiException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisabledApiException"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveCustomerRequest"}}}},"parameters":[{"name":"X-Amz-Target","in":"header","required":true,"schema":{"type":"string","enum":["AWSMPMeteringService.ResolveCustomer"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","schema":{"type":"string"},"required":false},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","schema":{"type":"string"},"required":false},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","schema":{"type":"string"},"required":false}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"BatchMeterUsageResult":{"type":"object","properties":{"Results":{"allOf":[{"$ref":"#/components/schemas/UsageRecordResultList"},{"description":"Contains all <code>UsageRecords</code> processed by <code>BatchMeterUsage</code>. These records were either honored by AWS Marketplace Metering Service or were invalid. Invalid records should be fixed before being resubmitted."}]},"UnprocessedRecords":{"allOf":[{"$ref":"#/components/schemas/UsageRecordList"},{"description":"Contains all <code>UsageRecords</code> that were not processed by <code>BatchMeterUsage</code>. This is a list of <code>UsageRecords</code>. You can retry the failed request by making another <code>BatchMeterUsage</code> call with this list as input in the <code>BatchMeterUsageRequest</code>."}]}},"description":"Contains the <code>UsageRecords</code> processed by <code>BatchMeterUsage</code> and any records that have failed due to transient error."},"BatchMeterUsageRequest":{"type":"object","required":["UsageRecords","ProductCode"],"title":"BatchMeterUsageRequest","properties":{"UsageRecords":{"allOf":[{"$ref":"#/components/schemas/UsageRecordList"},{"description":"The set of <code>UsageRecords</code> to submit. <code>BatchMeterUsage</code> accepts up to 25 <code>UsageRecords</code> at a time."}]},"ProductCode":{"allOf":[{"$ref":"#/components/schemas/ProductCode"},{"description":"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."}]}},"description":"A <code>BatchMeterUsageRequest</code> contains <code>UsageRecords</code>, which indicate quantities of usage within your application."},"InternalServiceErrorException":{},"InvalidProductCodeException":{},"InvalidUsageDimensionException":{},"InvalidTagException":{},"InvalidUsageAllocationsException":{},"InvalidCustomerIdentifierException":{},"TimestampOutOfBoundsException":{},"ThrottlingException":{},"DisabledApiException":{},"MeterUsageResult":{"type":"object","properties":{"MeteringRecordId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"Metering record id."}]}}},"MeterUsageRequest":{"type":"object","required":["ProductCode","Timestamp","UsageDimension"],"title":"MeterUsageRequest","properties":{"ProductCode":{"allOf":[{"$ref":"#/components/schemas/ProductCode"},{"description":"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."}]},"Timestamp":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"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 <code>timestamp</code> value is not before the start of the software usage."}]},"UsageDimension":{"allOf":[{"$ref":"#/components/schemas/UsageDimension"},{"description":"It will be one of the fcp dimension name provided during the publishing of the product."}]},"UsageQuantity":{"allOf":[{"$ref":"#/components/schemas/UsageQuantity"},{"description":"Consumption value for the hour. Defaults to <code>0</code> if not specified."}]},"DryRun":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"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."}]},"UsageAllocations":{"allOf":[{"$ref":"#/components/schemas/UsageAllocations"},{"description":"The set of <code>UsageAllocations</code> to submit. 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)."}]}}},"InvalidEndpointRegionException":{},"DuplicateRequestException":{},"CustomerNotEntitledException":{},"RegisterUsageResult":{"type":"object","properties":{"PublicKeyRotationTimestamp":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"(Optional) Only included when public key version has expired"}]},"Signature":{"allOf":[{"$ref":"#/components/schemas/NonEmptyString"},{"description":"JWT Token"}]}}},"RegisterUsageRequest":{"type":"object","required":["ProductCode","PublicKeyVersion"],"title":"RegisterUsageRequest","properties":{"ProductCode":{"allOf":[{"$ref":"#/components/schemas/ProductCode"},{"description":"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."}]},"PublicKeyVersion":{"allOf":[{"$ref":"#/components/schemas/VersionInteger"},{"description":"Public Key Version provided by AWS Marketplace"}]},"Nonce":{"allOf":[{"$ref":"#/components/schemas/Nonce"},{"description":"(Optional) To scope down the registration to a specific running software instance and guard against replay attacks."}]}}},"InvalidRegionException":{},"InvalidPublicKeyVersionException":{},"PlatformNotSupportedException":{},"ResolveCustomerResult":{"type":"object","properties":{"CustomerIdentifier":{"allOf":[{"$ref":"#/components/schemas/CustomerIdentifier"},{"description":"The <code>CustomerIdentifier</code> is used to identify an individual customer in your application. Calls to <code>BatchMeterUsage</code> require <code>CustomerIdentifiers</code> for each <code>UsageRecord</code>."}]},"ProductCode":{"allOf":[{"$ref":"#/components/schemas/ProductCode"},{"description":"The product code is returned to confirm that the buyer is registering for your product. Subsequent <code>BatchMeterUsage</code> calls should be made using this product code."}]},"CustomerAWSAccountId":{"allOf":[{"$ref":"#/components/schemas/CustomerAWSAccountId"},{"description":"The <code>CustomerAWSAccountId</code> provides the AWS account ID associated with the <code>CustomerIdentifier</code> for the individual customer."}]}},"description":"The result of the <code>ResolveCustomer</code> operation. Contains the <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>."},"ResolveCustomerRequest":{"type":"object","required":["RegistrationToken"],"title":"ResolveCustomerRequest","properties":{"RegistrationToken":{"allOf":[{"$ref":"#/components/schemas/NonEmptyString"},{"description":"When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>."}]}},"description":"Contains input to the <code>ResolveCustomer</code> operation."},"InvalidTokenException":{},"ExpiredTokenException":{},"AllocatedUsageQuantity":{"type":"integer","minimum":0,"maximum":2147483647},"UsageRecordList":{"type":"array","items":{"$ref":"#/components/schemas/UsageRecord"},"minItems":0,"maxItems":25},"ProductCode":{"type":"string","pattern":"^[-a-zA-Z0-9/=:_.@]*$","minLength":1,"maxLength":255},"UsageRecordResultList":{"type":"array","items":{"$ref":"#/components/schemas/UsageRecordResult"}},"Boolean":{"type":"boolean"},"CustomerAWSAccountId":{"type":"string","pattern":"^[0-9]+$","minLength":1,"maxLength":255},"CustomerIdentifier":{"type":"string","pattern":"[\\s\\S]+","minLength":1,"maxLength":255},"Timestamp":{"type":"string","format":"date-time"},"UsageDimension":{"type":"string","pattern":"[\\s\\S]+","minLength":1,"maxLength":255},"UsageQuantity":{"type":"integer","minimum":0,"maximum":2147483647},"UsageAllocations":{"type":"array","items":{"$ref":"#/components/schemas/UsageAllocation"},"minItems":1,"maxItems":2500},"String":{"type":"string"},"NonEmptyString":{"type":"string","pattern":"[\\s\\S]+"},"Nonce":{"type":"string","pattern":"[\\s\\S]*","maxLength":255},"VersionInteger":{"type":"integer","minimum":1},"TagKey":{"type":"string","pattern":"^[a-zA-Z0-9+ -=._:\\/@]+$","minLength":1,"maxLength":100},"TagValue":{"type":"string","pattern":"^[a-zA-Z0-9+ -=._:\\/@]+$","minLength":1,"maxLength":256},"Tag":{"type":"object","required":["Key","Value"],"properties":{"Key":{"allOf":[{"$ref":"#/components/schemas/TagKey"},{"description":"One part of a key-value pair that makes up a <code>tag</code>. A <code>key</code> is a label that acts like a category for the specific tag values."}]},"Value":{"allOf":[{"$ref":"#/components/schemas/TagValue"},{"description":"One part of a key-value pair that makes up a <code>tag</code>. A <code>value</code> acts as a descriptor within a tag category (key). The value can be empty or null."}]}},"description":"Metadata assigned to an allocation. Each tag is made up of a <code>key</code> and a <code>value</code>."},"TagList":{"type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":5},"UsageAllocation":{"type":"object","required":["AllocatedUsageQuantity"],"properties":{"AllocatedUsageQuantity":{"allOf":[{"$ref":"#/components/schemas/AllocatedUsageQuantity"},{"description":"The total quantity allocated to this bucket of usage."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/TagList"},{"description":"The set of tags that define the bucket of usage. For the bucket of items with no tags, this parameter can be left out."}]}},"description":"Usage allocations allow you to split usage into buckets by tags. Each <code>UsageAllocation</code> indicates the usage quantity for a specific set of tags."},"UsageRecord":{"type":"object","required":["Timestamp","CustomerIdentifier","Dimension"],"properties":{"Timestamp":{"allOf":[{"$ref":"#/components/schemas/Timestamp"},{"description":"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 <code>timestamp</code> value is not before the start of the software usage."}]},"CustomerIdentifier":{"allOf":[{"$ref":"#/components/schemas/CustomerIdentifier"},{"description":"The <code>CustomerIdentifier</code> is obtained through the <code>ResolveCustomer</code> operation and represents an individual buyer in your application."}]},"Dimension":{"allOf":[{"$ref":"#/components/schemas/UsageDimension"},{"description":"During the process of registering a product on AWS Marketplace, dimensions are specified. These represent different units of value in your application."}]},"Quantity":{"allOf":[{"$ref":"#/components/schemas/UsageQuantity"},{"description":"The quantity of usage consumed by the customer for the given dimension and time. Defaults to <code>0</code> if not specified."}]},"UsageAllocations":{"allOf":[{"$ref":"#/components/schemas/UsageAllocations"},{"description":"The set of <code>UsageAllocations</code> to submit. The sum of all <code>UsageAllocation</code> quantities must equal the Quantity of the <code>UsageRecord</code>."}]}},"description":"A <code>UsageRecord</code> indicates a quantity of usage for a given product, customer, dimension and time. Multiple requests with the same <code>UsageRecords</code> as input will be de-duplicated to prevent double charges."},"UsageRecordResultStatus":{"type":"string","enum":["Success","CustomerNotSubscribed","DuplicateRecord"]},"UsageRecordResult":{"type":"object","properties":{"UsageRecord":{"allOf":[{"$ref":"#/components/schemas/UsageRecord"},{"description":"The <code>UsageRecord</code> that was part of the <code>BatchMeterUsage</code> request."}]},"MeteringRecordId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The <code>MeteringRecordId</code> is a unique identifier for this metering event."}]},"Status":{"allOf":[{"$ref":"#/components/schemas/UsageRecordResultStatus"},{"description":"The <code>UsageRecordResult</code> <code>Status</code> indicates the status of an individual <code>UsageRecord</code> processed by <code>BatchMeterUsage</code>. <ul> <li> Success- The <code>UsageRecord</code> was accepted and honored by <code>BatchMeterUsage</code>. </li> <li> CustomerNotSubscribed- The <code>CustomerIdentifier</code> specified is not able to use your product. The <code>UsageRecord</code> was not honored. There are three causes for this result: <ul> <li> The customer identifier is invalid. </li> <li> The customer identifier provided in the metering record does not have an active agreement or subscription with this product. Future <code>UsageRecords</code> for this customer will fail until the customer subscribes to your product. </li> <li> The customer's AWS account was suspended. </li> </ul> </li> <li> DuplicateRecord- Indicates that the <code>UsageRecord</code> was invalid and not honored. A previously metered <code>UsageRecord</code> had the same customer, dimension, and time, but a different quantity. </li> </ul>"}]}},"description":"A <code>UsageRecordResult</code> indicates the status of a given <code>UsageRecord</code> processed by <code>BatchMeterUsage</code>."}}},"security":[{"hmac":[]}]}