AWS.Tools.AWSMarketplaceMetering.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.AWSMarketplaceMetering</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MM.GetMMCustomerMetadataCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.GetMMCustomerMetadataCmdlet.RegistrationToken"> <summary> <para> <para>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 CustomerIdentifier and product code.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet"> <summary> 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. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS 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. <ul><li><para><i>Entitlement</i>: RegisterUsage 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 RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running. </para></li><li><para><i>Metering</i>: RegisterUsage meters software use per ECS task, per hour, 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 ECS cluster and creates an ECS service configured as a Daemon Set, then ECS 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 RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet.Nonce"> <summary> <para> <para>(Optional) To scope down the registration to a specific running software instance and guard against replay attacks.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet.ProductCode"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet.PublicKeyVersion"> <summary> <para> <para>Public Key Version provided by AWS Marketplace</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet"> <summary> API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID. <para> MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.DryRun"> <summary> <para> <para>Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to <code>false</code> if not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.ProductCode"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.Timestamp"> <summary> <para> <para>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 timestamp value is not before the start of the software usage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.UsageDimension"> <summary> <para> <para>It will be one of the fcp dimension name provided during the publishing of the product.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.UsageQuantity"> <summary> <para> <para>Consumption value for the hour. Defaults to <code>0</code> if not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet"> <summary> BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers. <para> For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records. </para><para> Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage. </para><para> BatchMeterUsage can process up to 25 UsageRecords at a time. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.ProductCode"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.UsageRecord"> <summary> <para> <para>The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |