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> <c>ResolveCustomer</c> 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 <c>CustomerIdentifier</c> along with the <c>CustomerAWSAccountId</c> and <c>ProductCode</c>. <note><para> To successfully resolve the token, the API must be called from the account that was used to publish the SaaS application. For an example of using <c>ResolveCustomer</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example"> ResolveCustomer code example</a> in the <i>Amazon Web Services Marketplace Seller Guide</i>. </para></note><para> Permission is required for this operation. Your IAM role or user performing this operation requires a policy to allow the <c>aws-marketplace:ResolveCustomer</c> action. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsmarketplacemeteringservice.html">Actions, resources, and condition keys for Amazon Web Services Marketplace Metering Service</a> in the <i>Service Authorization Reference</i>. </para><para> For Amazon Web Services Regions that support <c>ResolveCustomer</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#resolvecustomer-region-support">ResolveCustomer Region support</a>. </para> </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 <c>CustomerIdentifier</c> along with the <c>CustomerAWSAccountId</c> and <c>ProductCode</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.GetMMCustomerMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSMarketplaceMetering.Model.ResolveCustomerResponse). Specifying the name of a property of type Amazon.AWSMarketplaceMetering.Model.ResolveCustomerResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet"> <summary> Paid container software products sold through Amazon Web Services Marketplace must integrate with the Amazon Web Services Marketplace Metering Service and call the <c>RegisterUsage</c> operation for software entitlement and metering. Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call <c>RegisterUsage</c>, 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 <c>RegisterUsage</c>. <c>RegisterUsage</c> performs two primary functions: metering and entitlement. <ul><li><para><i>Entitlement</i>: <c>RegisterUsage</c> allows you to verify that the customer running your paid software is subscribed to your product on Amazon Web Services Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with <c>RegisterUsage</c> is only required to guard against unauthorized use at container startup, as such a <c>CustomerNotSubscribedException</c> or <c>PlatformNotSupportedException</c> will only be thrown on the initial call to <c>RegisterUsage</c>. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) or Amazon EKS pod will not throw a <c>CustomerNotSubscribedException</c>, even if the customer unsubscribes while the Amazon ECS task or Amazon EKS pod is still running. </para></li><li><para><i>Metering</i>: <c>RegisterUsage</c> 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 for 10 tasks. Software metering is handled by the Amazon Web Services Marketplace metering control plane—your software is not required to perform metering-specific actions other than to call <c>RegisterUsage</c> to commence metering. The Amazon Web Services Marketplace metering control plane will also bill customers for running ECS tasks and Amazon EKS pods, regardless of the customer's subscription state, which removes the need for your software to run entitlement checks at runtime. For containers, <c>RegisterUsage</c> should be called immediately at launch. If you don’t register the container within the first 6 hours of the launch, Amazon Web Services Marketplace Metering Service doesn’t provide any metering guarantees for previous months. Metering will continue, however, for the current month forward until the container ends. <c>RegisterUsage</c> is for metering paid hourly container products. </para><para> For Amazon Web Services Regions that support <c>RegisterUsage</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#registerusage-region-support">RegisterUsage Region support</a>. </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 Amazon Web Services 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 Amazon Web Services Marketplace</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.RegisterMMUsageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse). Specifying the name of a property of type Amazon.AWSMarketplaceMetering.Model.RegisterUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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> 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. You must use the following buyer Amazon Web Services account credentials to sign the API request. <ul><li><para> For <b>Amazon EC2</b> deployments, your software must use the <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html">IAM role for Amazon EC2</a> to sign the API call for <c>MeterUsage</c> API operation. </para></li><li><para> For <b>Amazon EKS</b> deployments, your software must use <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">IAM roles for service accounts (IRSA)</a> to sign the API call for the <c>MeterUsage</c> API operation. Using <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html">EKS Pod Identity</a>, the node role, or long-term access keys is not supported. </para></li><li><para> For <b>Amazon ECS</b> deployments, your software must use <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">Amazon ECS task IAM</a> role to sign the API call for the <c>MeterUsage</c> API operation. Using the node role or long-term access keys are not supported. </para></li><li><para> For <b>Amazon Bedrock AgentCore Runtime</b> deployments, your software must use the <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/runtime-permissions.html#runtime-permissions-execution">AgentCore Runtime execution role</a> to sign the API call for the <c>MeterUsage</c> API operation. Long-term access keys are not supported. </para></li></ul><para> The handling of <c>MeterUsage</c> requests varies between Amazon Bedrock AgentCore Runtime and non-Amazon Bedrock AgentCore deployments. </para><ul><li><para> For <b>non-Amazon Bedrock AgentCore Runtime</b> deployments, you can only report usage once per hour for each dimension. For AMI-based products, this is per dimension and per EC2 instance. For container products, this is per dimension and per ECS task or EKS pod. You can't modify values after they're recorded. If you report usage before a current hour ends, you will be unable to report additional usage until the next hour begins. The <c>Timestamp</c> request parameter is rounded down to the hour and used to enforce this once-per-hour rule for idempotency. For requests that are identical after the <c>Timestamp</c> is rounded down, the API is idempotent and returns the metering record ID. </para></li><li><para> For <b>Amazon Bedrock AgentCore Runtime</b> deployments, you can report usage multiple times per hour for the same dimension. You do not need to aggregate metering records by the hour. You must include an idempotency token in the <c>ClientToken</c> request parameter. If using an Amazon SDK or the Amazon Web Services CLI, you must use the latest version which automatically includes an idempotency token in the <c>ClientToken</c> request parameter so that the request is processed successfully. The <c>Timestamp</c> request parameter is not rounded down to the hour and is not used for duplicate validation. Requests with duplicate <c>Timestamps</c> are aggregated as long as the <c>ClientToken</c> is unique. </para></li></ul><para> 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. </para><para> 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. </para><para> For Amazon Web Services Regions that support <c>MeterUsage</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#meterusage-region-support-ec2">MeterUsage Region support for Amazon EC2</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#meterusage-region-support-ecs-eks">MeterUsage Region support for Amazon ECS and Amazon EKS</a>. </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 <c>DryRunOperation</c>; otherwise, it returns <c>UnauthorizedException</c>. Defaults to <c>false</c> 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 Amazon Web Services 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 six hours in the past. Make sure the <c>timestamp</c> value is not before the start of the software usage.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.UsageAllocation"> <summary> <para> <para>The set of <c>UsageAllocations</c> to submit.</para><para>The sum of all <c>UsageAllocation</c> quantities must equal the <c>UsageQuantity</c> of the <c>MeterUsage</c> request, and each <c>UsageAllocation</c> must have a unique set of tags (include no tags).</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </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 <c>0</c> if not specified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.ClientToken"> <summary> <para> <para>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of value</a>.</para><para>If you don't provide this value, then Amazon Web Services generates a random one for you.</para><para>If you retry the operation with the same <c>ClientToken</c>, but with different parameters, the retry fails with an <c>IdempotencyConflictException</c> error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MeteringRecordId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSMarketplaceMetering.Model.MeterUsageResponse). Specifying the name of a property of type Amazon.AWSMarketplaceMetering.Model.MeterUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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> <important><para> The <c>CustomerIdentifier</c> and <c>CustomerAWSAccountID</c> are mutually exclusive parameters. You must use one or the other, but not both in the same API request. For new implementations, we recommend using the <c>CustomerAWSAccountID</c>. Your current integration will continue to work. When updating your implementation, consider migrating to <c>CustomerAWSAccountID</c> for improved integration. </para></important><para> To post metering records for customers, SaaS applications call <c>BatchMeterUsage</c>, which is used for metering SaaS flexible consumption pricing (FCP). Identical requests are idempotent and can be retried with the same records or a subset of records. Each <c>BatchMeterUsage</c> request is for only one product. If you want to meter usage for multiple products, you must make multiple <c>BatchMeterUsage</c> calls. </para><para> Usage records should be submitted in quick succession following a recorded event. Usage records aren't accepted 6 hours or more after an event. </para><para><c>BatchMeterUsage</c> can process up to 25 <c>UsageRecords</c> at a time, and each request must be less than 1 MB in size. Optionally, you can have multiple usage allocations for usage data that's split into buckets according to predefined tags. </para><para><c>BatchMeterUsage</c> returns a list of <c>UsageRecordResult</c> objects, which have each <c>UsageRecord</c>. It also returns a list of <c>UnprocessedRecords</c>, which indicate errors on the service side that should be retried. </para><para> For Amazon Web Services Regions that support <c>BatchMeterUsage</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#batchmeterusage-region-support">BatchMeterUsage Region support</a>. </para><note><para> For an example of <c>BatchMeterUsage</c>, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-batchmeterusage-example"> BatchMeterUsage code example</a> in the <i>Amazon Web Services Marketplace Seller Guide</i>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.ProductCode"> <summary> <para> <para>Product code is used to uniquely identify a product in Amazon Web Services Marketplace. The product code should be the same as the one used during the publishing of a new product.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.UsageRecord"> <summary> <para> <para>The set of <c>UsageRecords</c> to submit. <c>BatchMeterUsage</c> accepts up to 25 <c>UsageRecords</c> at a time.</para><para /> Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MM.SendMMMeteringDataBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AWSMarketplaceMetering.Model.BatchMeterUsageResponse). Specifying the name of a property of type Amazon.AWSMarketplaceMetering.Model.BatchMeterUsageResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </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> |