Skip to content

Commit 540d2d0

Browse files
author
awstools
committed
feat(client-marketplace-metering): This release enhances the BatchMeterUsage API to support new field CustomerAWSAccountId in request and response and making CustomerIdentifier optional. CustomerAWSAccountId or CustomerIdentifier must be provided in request but not both.
1 parent b6b01de commit 540d2d0

File tree

11 files changed

+620
-290
lines changed

11 files changed

+620
-290
lines changed

‎clients/client-marketplace-metering/README.md

+113-38
Original file line numberDiff line numberDiff line change
@@ -6,71 +6,146 @@
66

77
AWS SDK for JavaScript MarketplaceMetering Client for Node.js, Browser and React Native.
88

9-
<fullname>AWS Marketplace Metering Service</fullname>
9+
<fullname>Amazon Web Services Marketplace Metering Service</fullname>
1010

11-
<p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
12-
API.</p>
13-
<p>AWS Marketplace sellers can use this API to submit usage data for custom usage
11+
<p>This reference provides descriptions of the low-level Marketplace Metering Service API.</p>
12+
<p>Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
1413
dimensions.</p>
15-
<p>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
16-
<i>AWS Marketplace Seller Guide.</i>
14+
<p>For information about the permissions that 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">Amazon Web Services Marketplace metering and entitlement API permissions</a> in the <i>Amazon Web Services Marketplace
15+
Seller Guide.</i>
1716
</p>
1817
<p>
19-
<b>Submitting Metering Records</b>
18+
<b>Submitting metering records</b>
19+
</p>
20+
<p>
21+
<i>MeterUsage</i>
2022
</p>
2123
<ul>
2224
<li>
23-
<p>
24-
<i>MeterUsage</i> - Submits the metering record for an AWS
25-
Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
26-
container running on EKS or ECS.</p>
25+
<p>Submits the metering record for an Amazon Web Services Marketplace product.</p>
26+
</li>
27+
<li>
28+
<p>Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
29+
Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)</p>
30+
</li>
31+
<li>
32+
<p>Supported product types: Amazon Machine Images (AMIs) and containers</p>
2733
</li>
2834
<li>
35+
<p>Vendor-metered tagging: Supported allocation tagging</p>
36+
</li>
37+
</ul>
2938
<p>
30-
<i>BatchMeterUsage</i> - Submits the metering record for a set of
31-
customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
32-
(SaaS) application.</p>
39+
<i>BatchMeterUsage</i>
40+
</p>
41+
<ul>
42+
<li>
43+
<p>Submits the metering record for a set of customers.
44+
<code>BatchMeterUsage</code> API calls are captured by CloudTrail. You can use
45+
CloudTrail to verify that the software as a subscription (SaaS) metering records that
46+
you sent are accurate by searching for records with the <code>eventName</code>
47+
of <code>BatchMeterUsage</code>. You can also use CloudTrail to audit records over
48+
time. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">CloudTrail User
49+
Guide</a>.</p>
50+
</li>
51+
<li>
52+
<p>Called from: SaaS applications</p>
53+
</li>
54+
<li>
55+
<p>Supported product type: SaaS</p>
56+
</li>
57+
<li>
58+
<p>Vendor-metered tagging: Supports allocation tagging</p>
3359
</li>
3460
</ul>
3561
<p>
36-
<b>Accepting New Customers</b>
62+
<b>Accepting new customers</b>
63+
</p>
64+
<p>
65+
<i>ResolveCustomer</i>
3766
</p>
3867
<ul>
3968
<li>
69+
<p>Resolves the registration token that the buyer submits through the browser
70+
during the registration process. Obtains a <code>CustomerIdentifier</code> along
71+
with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
72+
</li>
73+
<li>
74+
<p>Called from: SaaS application during the registration process</p>
75+
</li>
76+
<li>
77+
<p>Supported product type: SaaS</p>
78+
</li>
79+
<li>
80+
<p>Vendor-metered tagging: Not applicable</p>
81+
</li>
82+
</ul>
4083
<p>
41-
<i>ResolveCustomer</i> - Called by a SaaS application during the
42-
registration process. When a buyer visits your website during the registration
43-
process, the buyer submits a Registration Token through the browser. The
44-
Registration Token is resolved through this API to obtain a
45-
<code>CustomerIdentifier</code>
46-
47-
along with the <code>CustomerAWSAccountId</code> and
48-
<code>ProductCode</code>.</p>
49-
84+
<b>Entitlement and metering for paid container
85+
products</b>
86+
</p>
87+
<p>
88+
<i>RegisteredUsage</i>
89+
</p>
90+
<ul>
91+
<li>
92+
<p>Provides software entitlement and metering. Paid container software products
93+
sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
94+
<code>RegisterUsage</code> operation. Free and Bring Your Own License model
95+
(BYOL) products for Amazon ECS or Amazon EKS aren't required to call
96+
<code>RegisterUsage</code>. However, you can do so if you want to receive
97+
usage data in your seller reports. For more information about using the
98+
<code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
99+
</li>
100+
<li>
101+
<p>Called from: Paid container software products</p>
102+
</li>
103+
<li>
104+
<p>Supported product type: Containers</p>
105+
</li>
106+
<li>
107+
<p>Vendor-metered tagging: Not applicable</p>
50108
</li>
51109
</ul>
52110
<p>
53-
<b>Entitlement and Metering for Paid Container Products</b>
111+
<b>Entitlement custom metering for container
112+
products</b>
54113
</p>
55114
<ul>
56115
<li>
57-
<p>Paid container software products sold through AWS Marketplace must integrate
58-
with the AWS Marketplace Metering Service and call the
59-
<code>RegisterUsage</code> operation for software entitlement and metering.
60-
Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
61-
<code>RegisterUsage</code>, but you can do so if you want to receive usage
62-
data in your seller reports. For more information on using the
63-
<code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
116+
<p>MeterUsage API is available in GovCloud Regions but only supports AMI
117+
FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
118+
products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
119+
For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
120+
</li>
121+
<li>
122+
<p>Custom metering for container products are called using the
123+
MeterUsage API. The API is used for FCP AMI and FCP Container product
124+
metering.</p>
64125
</li>
65126
</ul>
66127
<p>
67-
<code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
68-
Cloudtrail to verify that the SaaS metering records that you sent are accurate by
69-
searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
70-
You can also use CloudTrail to audit records over time. For more information, see the
71-
<i>
72-
<a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">AWS CloudTrail User Guide</a>.</i>
128+
<b>Custom metering for Amazon EKS is available in 17
129+
Amazon Web Services Regions</b>
73130
</p>
131+
<ul>
132+
<li>
133+
<p>The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
134+
(FCP) products using MeterUsage API. Amazon ECS is supported in all
135+
Amazon Web Services Regions that MeterUsage API is available except for
136+
GovCloud.</p>
137+
</li>
138+
<li>
139+
<p>Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
140+
us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
141+
ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
142+
ca-central-1, sa-east-1.</p>
143+
<note>
144+
<p>For questions about adding Amazon Web Services Regions for metering, contact <a href="mailto://aws.amazon.com/marketplace/management/contact-us/">Amazon Web Services
145+
Marketplace Seller Operations</a>.</p>
146+
</note>
147+
</li>
148+
</ul>
74149

75150
## Installing
76151

‎clients/client-marketplace-metering/src/MarketplaceMetering.ts

+115-39
Original file line numberDiff line numberDiff line change
@@ -80,69 +80,145 @@ export interface MarketplaceMetering {
8080
}
8181

8282
/**
83-
* <fullname>AWS Marketplace Metering Service</fullname>
84-
* <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
85-
* API.</p>
86-
* <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
83+
* <fullname>Amazon Web Services Marketplace Metering Service</fullname>
84+
* <p>This reference provides descriptions of the low-level Marketplace Metering Service API.</p>
85+
* <p>Amazon Web Services Marketplace sellers can use this API to submit usage data for custom usage
8786
* dimensions.</p>
88-
* <p>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
89-
* <i>AWS Marketplace Seller Guide.</i>
87+
* <p>For information about the permissions that 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">Amazon Web Services Marketplace metering and entitlement API permissions</a> in the <i>Amazon Web Services Marketplace
88+
* Seller Guide.</i>
9089
* </p>
9190
* <p>
92-
* <b>Submitting Metering Records</b>
91+
* <b>Submitting metering records</b>
92+
* </p>
93+
* <p>
94+
* <i>MeterUsage</i>
95+
* </p>
96+
* <ul>
97+
* <li>
98+
* <p>Submits the metering record for an Amazon Web Services Marketplace product.</p>
99+
* </li>
100+
* <li>
101+
* <p>Called from: Amazon Elastic Compute Cloud (Amazon EC2) instance or a container running on either
102+
* Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Service (Amazon ECS)</p>
103+
* </li>
104+
* <li>
105+
* <p>Supported product types: Amazon Machine Images (AMIs) and containers</p>
106+
* </li>
107+
* <li>
108+
* <p>Vendor-metered tagging: Supported allocation tagging</p>
109+
* </li>
110+
* </ul>
111+
* <p>
112+
* <i>BatchMeterUsage</i>
113+
* </p>
114+
* <ul>
115+
* <li>
116+
* <p>Submits the metering record for a set of customers.
117+
* <code>BatchMeterUsage</code> API calls are captured by CloudTrail. You can use
118+
* CloudTrail to verify that the software as a subscription (SaaS) metering records that
119+
* you sent are accurate by searching for records with the <code>eventName</code>
120+
* of <code>BatchMeterUsage</code>. You can also use CloudTrail to audit records over
121+
* time. For more information, see the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">CloudTrail User
122+
* Guide</a>.</p>
123+
* </li>
124+
* <li>
125+
* <p>Called from: SaaS applications</p>
126+
* </li>
127+
* <li>
128+
* <p>Supported product type: SaaS</p>
129+
* </li>
130+
* <li>
131+
* <p>Vendor-metered tagging: Supports allocation tagging</p>
132+
* </li>
133+
* </ul>
134+
* <p>
135+
* <b>Accepting new customers</b>
136+
* </p>
137+
* <p>
138+
* <i>ResolveCustomer</i>
93139
* </p>
94140
* <ul>
95141
* <li>
96-
* <p>
97-
* <i>MeterUsage</i> - Submits the metering record for an AWS
98-
* Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
99-
* container running on EKS or ECS.</p>
142+
* <p>Resolves the registration token that the buyer submits through the browser
143+
* during the registration process. Obtains a <code>CustomerIdentifier</code> along
144+
* with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
145+
* </li>
146+
* <li>
147+
* <p>Called from: SaaS application during the registration process</p>
100148
* </li>
101149
* <li>
102-
* <p>
103-
* <i>BatchMeterUsage</i> - Submits the metering record for a set of
104-
* customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
105-
* (SaaS) application.</p>
150+
* <p>Supported product type: SaaS</p>
151+
* </li>
152+
* <li>
153+
* <p>Vendor-metered tagging: Not applicable</p>
106154
* </li>
107155
* </ul>
108156
* <p>
109-
* <b>Accepting New Customers</b>
157+
* <b>Entitlement and metering for paid container
158+
* products</b>
159+
* </p>
160+
* <p>
161+
* <i>RegisteredUsage</i>
110162
* </p>
111163
* <ul>
112164
* <li>
113-
* <p>
114-
* <i>ResolveCustomer</i> - Called by a SaaS application during the
115-
* registration process. When a buyer visits your website during the registration
116-
* process, the buyer submits a Registration Token through the browser. The
117-
* Registration Token is resolved through this API to obtain a
118-
* <code>CustomerIdentifier</code>
119-
*
120-
* along with the <code>CustomerAWSAccountId</code> and
121-
* <code>ProductCode</code>.</p>
165+
* <p>Provides software entitlement and metering. Paid container software products
166+
* sold through Amazon Web Services Marketplace must integrate with the Marketplace Metering Service and call the
167+
* <code>RegisterUsage</code> operation. Free and Bring Your Own License model
168+
* (BYOL) products for Amazon ECS or Amazon EKS aren't required to call
169+
* <code>RegisterUsage</code>. However, you can do so if you want to receive
170+
* usage data in your seller reports. For more information about using the
171+
* <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
172+
* </li>
173+
* <li>
174+
* <p>Called from: Paid container software products</p>
175+
* </li>
176+
* <li>
177+
* <p>Supported product type: Containers</p>
178+
* </li>
179+
* <li>
180+
* <p>Vendor-metered tagging: Not applicable</p>
122181
* </li>
123182
* </ul>
124183
* <p>
125-
* <b>Entitlement and Metering for Paid Container Products</b>
184+
* <b>Entitlement custom metering for container
185+
* products</b>
126186
* </p>
127187
* <ul>
128188
* <li>
129-
* <p>Paid container software products sold through AWS Marketplace must integrate
130-
* with the AWS Marketplace Metering Service and call the
131-
* <code>RegisterUsage</code> operation for software entitlement and metering.
132-
* Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
133-
* <code>RegisterUsage</code>, but you can do so if you want to receive usage
134-
* data in your seller reports. For more information on using the
135-
* <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
189+
* <p>MeterUsage API is available in GovCloud Regions but only supports AMI
190+
* FCP products in GovCloud Regions. Flexible Consumption Pricing (FCP) Container
191+
* products aren’t supported in GovCloud Regions: us-gov-west-1 and us-gov-east-1.
192+
* For more information, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-based products</a>.</p>
193+
* </li>
194+
* <li>
195+
* <p>Custom metering for container products are called using the
196+
* MeterUsage API. The API is used for FCP AMI and FCP Container product
197+
* metering.</p>
136198
* </li>
137199
* </ul>
138200
* <p>
139-
* <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
140-
* Cloudtrail to verify that the SaaS metering records that you sent are accurate by
141-
* searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
142-
* You can also use CloudTrail to audit records over time. For more information, see the
143-
* <i>
144-
* <a href="http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html">AWS CloudTrail User Guide</a>.</i>
201+
* <b>Custom metering for Amazon EKS is available in 17
202+
* Amazon Web Services Regions</b>
145203
* </p>
204+
* <ul>
205+
* <li>
206+
* <p>The metering service supports Amazon ECS and EKS for Flexible Consumption Pricing
207+
* (FCP) products using MeterUsage API. Amazon ECS is supported in all
208+
* Amazon Web Services Regions that MeterUsage API is available except for
209+
* GovCloud.</p>
210+
* </li>
211+
* <li>
212+
* <p>Amazon EKS is supported in the following: us-east-1, us-east-2, us-west-1,
213+
* us-west-2, eu-west-1, eu-central-1, eu-west-2, eu-west-3, eu-north-1, ap-east-1,
214+
* ap-southeast-1, ap-northeast-1, ap-southeast-2, ap-northeast-2, ap-south-1,
215+
* ca-central-1, sa-east-1.</p>
216+
* <note>
217+
* <p>For questions about adding Amazon Web Services Regions for metering, contact <a href="mailto://aws.amazon.com/marketplace/management/contact-us/">Amazon Web Services
218+
* Marketplace Seller Operations</a>.</p>
219+
* </note>
220+
* </li>
221+
* </ul>
146222
* @public
147223
*/
148224
export class MarketplaceMetering extends MarketplaceMeteringClient implements MarketplaceMetering {}

0 commit comments

Comments
 (0)