@aws-sdk/client-marketplace-metering 3.405.0 → 3.409.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/MarketplaceMetering.d.ts +21 -21
- package/dist-types/MarketplaceMeteringClient.d.ts +21 -21
- package/dist-types/commands/BatchMeterUsageCommand.d.ts +11 -11
- package/dist-types/commands/MeterUsageCommand.d.ts +4 -4
- package/dist-types/commands/RegisterUsageCommand.d.ts +5 -5
- package/dist-types/commands/ResolveCustomerCommand.d.ts +2 -2
- package/dist-types/index.d.ts +21 -21
- package/dist-types/models/models_0.d.ts +19 -19
- package/package.json +12 -12
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
|
-
const
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
4
|
+
const t = "required", u = "fn", v = "argv", w = "ref";
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = "stringEquals", g = { [t]: false, "type": "String" }, h = { [t]: true, "default": false, "type": "Boolean" }, i = { [w]: "Endpoint" }, j = { [u]: "booleanEquals", [v]: [{ [w]: "UseFIPS" }, true] }, k = { [u]: "booleanEquals", [v]: [{ [w]: "UseDualStack" }, true] }, l = {}, m = { [u]: "booleanEquals", [v]: [true, { [u]: "getAttr", [v]: [{ [w]: e }, "supportsFIPS"] }] }, n = { [u]: "booleanEquals", [v]: [true, { [u]: "getAttr", [v]: [{ [w]: e }, "supportsDualStack"] }] }, o = { [u]: "getAttr", [v]: [{ [w]: e }, "name"] }, p = { "url": "https://metering.marketplace.{Region}.amazonaws.com", "properties": {}, "headers": {} }, q = [j], r = [k], s = [{ [w]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: g, UseDualStack: h, UseFIPS: h, Endpoint: g }, rules: [{ conditions: [{ [u]: a, [v]: [i] }], type: b, rules: [{ conditions: q, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: r, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: i, properties: l, headers: l }, type: d }] }, { conditions: [{ [u]: a, [v]: s }], type: b, rules: [{ conditions: [{ [u]: "aws.partition", [v]: s, assign: e }], type: b, rules: [{ conditions: [j, k], type: b, rules: [{ conditions: [m, n], type: b, rules: [{ endpoint: { url: "https://metering.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: q, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://metering.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: r, type: b, rules: [{ conditions: [n], type: b, rules: [{ endpoint: { url: "https://metering.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { conditions: [{ [u]: f, [v]: ["aws", o] }], endpoint: p, type: d }, { conditions: [{ [u]: f, [v]: ["aws-us-gov", o] }], endpoint: p, type: d }, { endpoint: { url: "https://metering.marketplace.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
const
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
1
|
+
const t = "required", u = "fn", v = "argv", w = "ref";
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = "stringEquals", g = { [t]: false, "type": "String" }, h = { [t]: true, "default": false, "type": "Boolean" }, i = { [w]: "Endpoint" }, j = { [u]: "booleanEquals", [v]: [{ [w]: "UseFIPS" }, true] }, k = { [u]: "booleanEquals", [v]: [{ [w]: "UseDualStack" }, true] }, l = {}, m = { [u]: "booleanEquals", [v]: [true, { [u]: "getAttr", [v]: [{ [w]: e }, "supportsFIPS"] }] }, n = { [u]: "booleanEquals", [v]: [true, { [u]: "getAttr", [v]: [{ [w]: e }, "supportsDualStack"] }] }, o = { [u]: "getAttr", [v]: [{ [w]: e }, "name"] }, p = { "url": "https://metering.marketplace.{Region}.amazonaws.com", "properties": {}, "headers": {} }, q = [j], r = [k], s = [{ [w]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: g, UseDualStack: h, UseFIPS: h, Endpoint: g }, rules: [{ conditions: [{ [u]: a, [v]: [i] }], type: b, rules: [{ conditions: q, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { conditions: r, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: i, properties: l, headers: l }, type: d }] }, { conditions: [{ [u]: a, [v]: s }], type: b, rules: [{ conditions: [{ [u]: "aws.partition", [v]: s, assign: e }], type: b, rules: [{ conditions: [j, k], type: b, rules: [{ conditions: [m, n], type: b, rules: [{ endpoint: { url: "https://metering.marketplace-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: q, type: b, rules: [{ conditions: [m], type: b, rules: [{ endpoint: { url: "https://metering.marketplace-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: r, type: b, rules: [{ conditions: [n], type: b, rules: [{ endpoint: { url: "https://metering.marketplace.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { conditions: [{ [u]: f, [v]: ["aws", o] }], endpoint: p, type: d }, { conditions: [{ [u]: f, [v]: ["aws-us-gov", o] }], endpoint: p, type: d }, { endpoint: { url: "https://metering.marketplace.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -33,37 +33,37 @@ export interface MarketplaceMetering {
|
|
|
33
33
|
/**
|
|
34
34
|
* @public
|
|
35
35
|
* <fullname>AWS Marketplace Metering Service</fullname>
|
|
36
|
-
*
|
|
36
|
+
* <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
|
|
37
37
|
* API.</p>
|
|
38
|
-
*
|
|
38
|
+
* <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
|
|
39
39
|
* dimensions.</p>
|
|
40
|
-
*
|
|
40
|
+
* <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
|
|
41
41
|
* <i>AWS Marketplace Seller Guide.</i>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* </p>
|
|
43
|
+
* <p>
|
|
44
44
|
* <b>Submitting Metering Records</b>
|
|
45
|
-
*
|
|
46
|
-
*
|
|
45
|
+
* </p>
|
|
46
|
+
* <ul>
|
|
47
47
|
* <li>
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* <p>
|
|
49
|
+
* <i>MeterUsage</i> - Submits the metering record for an AWS
|
|
50
50
|
* Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
|
|
51
51
|
* container running on EKS or ECS.</p>
|
|
52
52
|
* </li>
|
|
53
53
|
* <li>
|
|
54
|
-
*
|
|
55
|
-
*
|
|
54
|
+
* <p>
|
|
55
|
+
* <i>BatchMeterUsage</i> - Submits the metering record for a set of
|
|
56
56
|
* customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
|
|
57
57
|
* (SaaS) application.</p>
|
|
58
58
|
* </li>
|
|
59
59
|
* </ul>
|
|
60
|
-
*
|
|
60
|
+
* <p>
|
|
61
61
|
* <b>Accepting New Customers</b>
|
|
62
|
-
*
|
|
63
|
-
*
|
|
62
|
+
* </p>
|
|
63
|
+
* <ul>
|
|
64
64
|
* <li>
|
|
65
|
-
*
|
|
66
|
-
*
|
|
65
|
+
* <p>
|
|
66
|
+
* <i>ResolveCustomer</i> - Called by a SaaS application during the
|
|
67
67
|
* registration process. When a buyer visits your website during the registration
|
|
68
68
|
* process, the buyer submits a Registration Token through the browser. The
|
|
69
69
|
* Registration Token is resolved through this API to obtain a
|
|
@@ -73,12 +73,12 @@ export interface MarketplaceMetering {
|
|
|
73
73
|
* <code>ProductCode</code>.</p>
|
|
74
74
|
* </li>
|
|
75
75
|
* </ul>
|
|
76
|
-
*
|
|
76
|
+
* <p>
|
|
77
77
|
* <b>Entitlement and Metering for Paid Container Products</b>
|
|
78
|
-
*
|
|
79
|
-
*
|
|
78
|
+
* </p>
|
|
79
|
+
* <ul>
|
|
80
80
|
* <li>
|
|
81
|
-
*
|
|
81
|
+
* <p>Paid container software products sold through AWS Marketplace must integrate
|
|
82
82
|
* with the AWS Marketplace Metering Service and call the
|
|
83
83
|
* <code>RegisterUsage</code> operation for software entitlement and metering.
|
|
84
84
|
* Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
|
|
@@ -87,7 +87,7 @@ export interface MarketplaceMetering {
|
|
|
87
87
|
* <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
|
|
88
88
|
* </li>
|
|
89
89
|
* </ul>
|
|
90
|
-
*
|
|
90
|
+
* <p>
|
|
91
91
|
* <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
|
|
92
92
|
* Cloudtrail to verify that the SaaS metering records that you sent are accurate by
|
|
93
93
|
* searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
|
|
@@ -155,37 +155,37 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete
|
|
|
155
155
|
/**
|
|
156
156
|
* @public
|
|
157
157
|
* <fullname>AWS Marketplace Metering Service</fullname>
|
|
158
|
-
*
|
|
158
|
+
* <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
|
|
159
159
|
* API.</p>
|
|
160
|
-
*
|
|
160
|
+
* <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
|
|
161
161
|
* dimensions.</p>
|
|
162
|
-
*
|
|
162
|
+
* <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
|
|
163
163
|
* <i>AWS Marketplace Seller Guide.</i>
|
|
164
|
-
*
|
|
165
|
-
*
|
|
164
|
+
* </p>
|
|
165
|
+
* <p>
|
|
166
166
|
* <b>Submitting Metering Records</b>
|
|
167
|
-
*
|
|
168
|
-
*
|
|
167
|
+
* </p>
|
|
168
|
+
* <ul>
|
|
169
169
|
* <li>
|
|
170
|
-
*
|
|
171
|
-
*
|
|
170
|
+
* <p>
|
|
171
|
+
* <i>MeterUsage</i> - Submits the metering record for an AWS
|
|
172
172
|
* Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
|
|
173
173
|
* container running on EKS or ECS.</p>
|
|
174
174
|
* </li>
|
|
175
175
|
* <li>
|
|
176
|
-
*
|
|
177
|
-
*
|
|
176
|
+
* <p>
|
|
177
|
+
* <i>BatchMeterUsage</i> - Submits the metering record for a set of
|
|
178
178
|
* customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
|
|
179
179
|
* (SaaS) application.</p>
|
|
180
180
|
* </li>
|
|
181
181
|
* </ul>
|
|
182
|
-
*
|
|
182
|
+
* <p>
|
|
183
183
|
* <b>Accepting New Customers</b>
|
|
184
|
-
*
|
|
185
|
-
*
|
|
184
|
+
* </p>
|
|
185
|
+
* <ul>
|
|
186
186
|
* <li>
|
|
187
|
-
*
|
|
188
|
-
*
|
|
187
|
+
* <p>
|
|
188
|
+
* <i>ResolveCustomer</i> - Called by a SaaS application during the
|
|
189
189
|
* registration process. When a buyer visits your website during the registration
|
|
190
190
|
* process, the buyer submits a Registration Token through the browser. The
|
|
191
191
|
* Registration Token is resolved through this API to obtain a
|
|
@@ -195,12 +195,12 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete
|
|
|
195
195
|
* <code>ProductCode</code>.</p>
|
|
196
196
|
* </li>
|
|
197
197
|
* </ul>
|
|
198
|
-
*
|
|
198
|
+
* <p>
|
|
199
199
|
* <b>Entitlement and Metering for Paid Container Products</b>
|
|
200
|
-
*
|
|
201
|
-
*
|
|
200
|
+
* </p>
|
|
201
|
+
* <ul>
|
|
202
202
|
* <li>
|
|
203
|
-
*
|
|
203
|
+
* <p>Paid container software products sold through AWS Marketplace must integrate
|
|
204
204
|
* with the AWS Marketplace Metering Service and call the
|
|
205
205
|
* <code>RegisterUsage</code> operation for software entitlement and metering.
|
|
206
206
|
* Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
|
|
@@ -209,7 +209,7 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete
|
|
|
209
209
|
* <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
|
|
210
210
|
* </li>
|
|
211
211
|
* </ul>
|
|
212
|
-
*
|
|
212
|
+
* <p>
|
|
213
213
|
* <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
|
|
214
214
|
* Cloudtrail to verify that the SaaS metering records that you sent are accurate by
|
|
215
215
|
* searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
|
|
@@ -26,30 +26,30 @@ export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __M
|
|
|
26
26
|
* <p>
|
|
27
27
|
* <code>BatchMeterUsage</code> is called from a SaaS application listed on AWS
|
|
28
28
|
* Marketplace to post metering records for a set of customers.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>For identical requests, the API is idempotent; requests can be retried with the same
|
|
30
30
|
* records or a subset of the input records.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>Every request to <code>BatchMeterUsage</code> is for one product. If you need to meter
|
|
32
32
|
* usage for multiple products, you must make multiple calls to
|
|
33
33
|
* <code>BatchMeterUsage</code>.</p>
|
|
34
|
-
*
|
|
34
|
+
* <p>Usage records are expected to be submitted as quickly as possible after the event that
|
|
35
35
|
* is being recorded, and are not accepted more than 6 hours after the event.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <code>BatchMeterUsage</code> can process up to 25 <code>UsageRecords</code> at a
|
|
38
38
|
* time.</p>
|
|
39
|
-
*
|
|
39
|
+
* <p>A <code>UsageRecord</code> can optionally include multiple usage allocations, to
|
|
40
40
|
* provide customers with usage data split into buckets by tags that you define (or allow
|
|
41
41
|
* the customer to define).</p>
|
|
42
|
-
*
|
|
42
|
+
* <p>
|
|
43
43
|
* <code>BatchMeterUsage</code> returns a list of <code>UsageRecordResult</code> objects,
|
|
44
44
|
* showing the result for each <code>UsageRecord</code>, as well as a list of
|
|
45
45
|
* <code>UnprocessedRecords</code>, indicating errors in the service side that you
|
|
46
46
|
* should retry.</p>
|
|
47
|
-
*
|
|
47
|
+
* <p>
|
|
48
48
|
* <code>BatchMeterUsage</code> requests must be less than 1MB in size.</p>
|
|
49
|
-
*
|
|
49
|
+
* <note>
|
|
50
50
|
* <p>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 <i>AWS Marketplace Seller
|
|
51
51
|
* Guide</i>.</p>
|
|
52
|
-
*
|
|
52
|
+
* </note>
|
|
53
53
|
* @example
|
|
54
54
|
* Use a bare-bones client and the command you need to make an API call.
|
|
55
55
|
* ```javascript
|
|
@@ -101,7 +101,7 @@ export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __M
|
|
|
101
101
|
* // ],
|
|
102
102
|
* // },
|
|
103
103
|
* // MeteringRecordId: "STRING_VALUE",
|
|
104
|
-
* // Status: "
|
|
104
|
+
* // Status: "Success" || "CustomerNotSubscribed" || "DuplicateRecord",
|
|
105
105
|
* // },
|
|
106
106
|
* // ],
|
|
107
107
|
* // UnprocessedRecords: [ // UsageRecordList
|
|
@@ -165,7 +165,7 @@ export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __M
|
|
|
165
165
|
* @throws {@link TimestampOutOfBoundsException} (client fault)
|
|
166
166
|
* <p>The <code>timestamp</code> value passed in the <code>UsageRecord</code> is out of
|
|
167
167
|
* allowed range.</p>
|
|
168
|
-
*
|
|
168
|
+
* <p>For <code>BatchMeterUsage</code>, if any of the records are outside of the allowed
|
|
169
169
|
* range, the entire batch is not processed. You must remove invalid records and try
|
|
170
170
|
* again.</p>
|
|
171
171
|
*
|
|
@@ -25,14 +25,14 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>API to emit metering records. For identical requests, the API is idempotent. It simply
|
|
27
27
|
* returns the metering record ID.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>
|
|
29
29
|
* <code>MeterUsage</code> is authenticated on the buyer's AWS account using credentials
|
|
30
30
|
* from the EC2 instance, ECS task, or EKS pod.</p>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <code>MeterUsage</code> can optionally include multiple usage allocations, to provide
|
|
33
33
|
* customers with usage data split into buckets by tags that you define (or allow the
|
|
34
34
|
* customer to define).</p>
|
|
35
|
-
*
|
|
35
|
+
* <p>Usage records are expected to be submitted as quickly as possible after the event that
|
|
36
36
|
* is being recorded, and are not accepted more than 6 hours after the event.</p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -111,7 +111,7 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea
|
|
|
111
111
|
* @throws {@link TimestampOutOfBoundsException} (client fault)
|
|
112
112
|
* <p>The <code>timestamp</code> value passed in the <code>UsageRecord</code> is out of
|
|
113
113
|
* allowed range.</p>
|
|
114
|
-
*
|
|
114
|
+
* <p>For <code>BatchMeterUsage</code>, if any of the records are outside of the allowed
|
|
115
115
|
* range, the entire batch is not processed. You must remove invalid records and try
|
|
116
116
|
* again.</p>
|
|
117
117
|
*
|
|
@@ -30,10 +30,10 @@ export interface RegisterUsageCommandOutput extends RegisterUsageResult, __Metad
|
|
|
30
30
|
* would like to receive usage data in your seller reports. The sections below explain the
|
|
31
31
|
* behavior of <code>RegisterUsage</code>. <code>RegisterUsage</code> performs two primary
|
|
32
32
|
* functions: metering and entitlement.</p>
|
|
33
|
-
*
|
|
33
|
+
* <ul>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
36
|
-
*
|
|
35
|
+
* <p>
|
|
36
|
+
* <i>Entitlement</i>: <code>RegisterUsage</code> allows you to
|
|
37
37
|
* verify that the customer running your paid software is subscribed to your
|
|
38
38
|
* product on AWS Marketplace, enabling you to guard against unauthorized use. Your
|
|
39
39
|
* container image that integrates with <code>RegisterUsage</code> is only required
|
|
@@ -47,8 +47,8 @@ export interface RegisterUsageCommandOutput extends RegisterUsageResult, __Metad
|
|
|
47
47
|
* running.</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* <li>
|
|
50
|
-
*
|
|
51
|
-
*
|
|
50
|
+
* <p>
|
|
51
|
+
* <i>Metering</i>: <code>RegisterUsage</code> meters software use
|
|
52
52
|
* per ECS task, per hour, or per pod for Amazon EKS with usage prorated to the
|
|
53
53
|
* second. A minimum of 1 minute of usage applies to tasks that are short lived.
|
|
54
54
|
* For example, if a customer has a 10 node Amazon ECS or Amazon EKS cluster and a
|
|
@@ -31,12 +31,12 @@ export interface ResolveCustomerCommandOutput extends ResolveCustomerResult, __M
|
|
|
31
31
|
* along with the
|
|
32
32
|
* <code>CustomerAWSAccountId</code> and
|
|
33
33
|
* <code>ProductCode</code>.</p>
|
|
34
|
-
*
|
|
34
|
+
* <note>
|
|
35
35
|
* <p>The API needs to called from the seller account id used to publish the SaaS
|
|
36
36
|
* application to successfully resolve the token.</p>
|
|
37
37
|
* <p>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 <i>AWS Marketplace Seller
|
|
38
38
|
* Guide</i>.</p>
|
|
39
|
-
*
|
|
39
|
+
* </note>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
42
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,36 +1,36 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <fullname>AWS Marketplace Metering Service</fullname>
|
|
3
|
-
*
|
|
3
|
+
* <p>This reference provides descriptions of the low-level AWS Marketplace Metering Service
|
|
4
4
|
* API.</p>
|
|
5
|
-
*
|
|
5
|
+
* <p>AWS Marketplace sellers can use this API to submit usage data for custom usage
|
|
6
6
|
* dimensions.</p>
|
|
7
|
-
*
|
|
7
|
+
* <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
|
|
8
8
|
* <i>AWS Marketplace Seller Guide.</i>
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* </p>
|
|
10
|
+
* <p>
|
|
11
11
|
* <b>Submitting Metering Records</b>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* </p>
|
|
13
|
+
* <ul>
|
|
14
14
|
* <li>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <p>
|
|
16
|
+
* <i>MeterUsage</i> - Submits the metering record for an AWS
|
|
17
17
|
* Marketplace product. <code>MeterUsage</code> is called from an EC2 instance or a
|
|
18
18
|
* container running on EKS or ECS.</p>
|
|
19
19
|
* </li>
|
|
20
20
|
* <li>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
21
|
+
* <p>
|
|
22
|
+
* <i>BatchMeterUsage</i> - Submits the metering record for a set of
|
|
23
23
|
* customers. <code>BatchMeterUsage</code> is called from a software-as-a-service
|
|
24
24
|
* (SaaS) application.</p>
|
|
25
25
|
* </li>
|
|
26
26
|
* </ul>
|
|
27
|
-
*
|
|
27
|
+
* <p>
|
|
28
28
|
* <b>Accepting New Customers</b>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* </p>
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p>
|
|
33
|
+
* <i>ResolveCustomer</i> - Called by a SaaS application during the
|
|
34
34
|
* registration process. When a buyer visits your website during the registration
|
|
35
35
|
* process, the buyer submits a Registration Token through the browser. The
|
|
36
36
|
* Registration Token is resolved through this API to obtain a
|
|
@@ -40,12 +40,12 @@
|
|
|
40
40
|
* <code>ProductCode</code>.</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* </ul>
|
|
43
|
-
*
|
|
43
|
+
* <p>
|
|
44
44
|
* <b>Entitlement and Metering for Paid Container Products</b>
|
|
45
|
-
*
|
|
46
|
-
*
|
|
45
|
+
* </p>
|
|
46
|
+
* <ul>
|
|
47
47
|
* <li>
|
|
48
|
-
*
|
|
48
|
+
* <p>Paid container software products sold through AWS Marketplace must integrate
|
|
49
49
|
* with the AWS Marketplace Metering Service and call the
|
|
50
50
|
* <code>RegisterUsage</code> operation for software entitlement and metering.
|
|
51
51
|
* Free and BYOL products for Amazon ECS or Amazon EKS aren't required to call
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
* <code>RegisterUsage</code> operation, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/container-based-products.html">Container-Based Products</a>. </p>
|
|
55
55
|
* </li>
|
|
56
56
|
* </ul>
|
|
57
|
-
*
|
|
57
|
+
* <p>
|
|
58
58
|
* <code>BatchMeterUsage</code> API calls are captured by AWS CloudTrail. You can use
|
|
59
59
|
* Cloudtrail to verify that the SaaS metering records that you sent are accurate by
|
|
60
60
|
* searching for records with the <code>eventName</code> of <code>BatchMeterUsage</code>.
|
|
@@ -22,7 +22,7 @@ export interface Tag {
|
|
|
22
22
|
/**
|
|
23
23
|
* @public
|
|
24
24
|
* <p>Usage allocations allow you to split usage into buckets by tags.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>Each <code>UsageAllocation</code> indicates the usage quantity for a specific set of
|
|
26
26
|
* tags.</p>
|
|
27
27
|
*/
|
|
28
28
|
export interface UsageAllocation {
|
|
@@ -42,14 +42,14 @@ export interface UsageAllocation {
|
|
|
42
42
|
* @public
|
|
43
43
|
* <p>A <code>UsageRecord</code> indicates a quantity of usage for a given product,
|
|
44
44
|
* customer, dimension and time.</p>
|
|
45
|
-
*
|
|
45
|
+
* <p>Multiple requests with the same <code>UsageRecords</code> as input will be
|
|
46
46
|
* de-duplicated to prevent double charges.</p>
|
|
47
47
|
*/
|
|
48
48
|
export interface UsageRecord {
|
|
49
49
|
/**
|
|
50
50
|
* @public
|
|
51
51
|
* <p>Timestamp, in UTC, for which the usage is being reported.</p>
|
|
52
|
-
*
|
|
52
|
+
* <p>Your application can meter usage for up to one hour in the past. Make sure the
|
|
53
53
|
* <code>timestamp</code> value is not before the start of the software usage.</p>
|
|
54
54
|
*/
|
|
55
55
|
Timestamp: Date | undefined;
|
|
@@ -135,35 +135,35 @@ export interface UsageRecordResult {
|
|
|
135
135
|
* <p>The <code>UsageRecordResult</code>
|
|
136
136
|
* <code>Status</code> indicates the status of an individual <code>UsageRecord</code>
|
|
137
137
|
* processed by <code>BatchMeterUsage</code>.</p>
|
|
138
|
-
*
|
|
138
|
+
* <ul>
|
|
139
139
|
* <li>
|
|
140
|
-
*
|
|
141
|
-
*
|
|
140
|
+
* <p>
|
|
141
|
+
* <i>Success</i>- The <code>UsageRecord</code> was accepted and
|
|
142
142
|
* honored by <code>BatchMeterUsage</code>.</p>
|
|
143
143
|
* </li>
|
|
144
144
|
* <li>
|
|
145
|
-
*
|
|
146
|
-
*
|
|
145
|
+
* <p>
|
|
146
|
+
* <i>CustomerNotSubscribed</i>- The <code>CustomerIdentifier</code>
|
|
147
147
|
* specified is not able to use your product. The <code>UsageRecord</code> was not
|
|
148
148
|
* honored. There are three causes for this result:</p>
|
|
149
|
-
*
|
|
149
|
+
* <ul>
|
|
150
150
|
* <li>
|
|
151
|
-
*
|
|
152
|
-
*
|
|
151
|
+
* <p>The customer identifier is invalid.</p>
|
|
152
|
+
* </li>
|
|
153
153
|
* <li>
|
|
154
|
-
*
|
|
154
|
+
* <p>The customer identifier provided in the metering record does not have
|
|
155
155
|
* an active agreement or subscription with this product. Future
|
|
156
156
|
* <code>UsageRecords</code> for this customer will fail until the
|
|
157
157
|
* customer subscribes to your product.</p>
|
|
158
|
-
*
|
|
158
|
+
* </li>
|
|
159
159
|
* <li>
|
|
160
|
-
*
|
|
161
|
-
*
|
|
160
|
+
* <p>The customer's AWS account was suspended.</p>
|
|
161
|
+
* </li>
|
|
162
162
|
* </ul>
|
|
163
163
|
* </li>
|
|
164
164
|
* <li>
|
|
165
|
-
*
|
|
166
|
-
*
|
|
165
|
+
* <p>
|
|
166
|
+
* <i>DuplicateRecord</i>- Indicates that the
|
|
167
167
|
* <code>UsageRecord</code> was invalid and not honored. A previously metered
|
|
168
168
|
* <code>UsageRecord</code> had the same customer, dimension, and time, but a
|
|
169
169
|
* different quantity.</p>
|
|
@@ -299,7 +299,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
299
299
|
* @public
|
|
300
300
|
* <p>The <code>timestamp</code> value passed in the <code>UsageRecord</code> is out of
|
|
301
301
|
* allowed range.</p>
|
|
302
|
-
*
|
|
302
|
+
* <p>For <code>BatchMeterUsage</code>, if any of the records are outside of the allowed
|
|
303
303
|
* range, the entire batch is not processed. You must remove invalid records and try
|
|
304
304
|
* again.</p>
|
|
305
305
|
*/
|
|
@@ -391,7 +391,7 @@ export interface MeterUsageRequest {
|
|
|
391
391
|
/**
|
|
392
392
|
* @public
|
|
393
393
|
* <p>The set of <code>UsageAllocations</code> to submit.</p>
|
|
394
|
-
*
|
|
394
|
+
* <p>The sum of all <code>UsageAllocation</code> quantities must equal the
|
|
395
395
|
* <code>UsageQuantity</code> of the <code>MeterUsage</code> request, and each
|
|
396
396
|
* <code>UsageAllocation</code> must have a unique set of tags (include no
|
|
397
397
|
* tags).</p>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-marketplace-metering",
|
|
3
3
|
"description": "AWS SDK for JavaScript Marketplace Metering Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.409.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,17 +21,17 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-signing": "3.
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
31
|
-
"@aws-sdk/types": "3.
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.409.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.409.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.408.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.408.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.408.0",
|
|
29
|
+
"@aws-sdk/middleware-signing": "3.408.0",
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.408.0",
|
|
31
|
+
"@aws-sdk/types": "3.408.0",
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.408.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "3.408.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "3.408.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.5",
|
|
36
36
|
"@smithy/fetch-http-handler": "^2.0.5",
|
|
37
37
|
"@smithy/hash-node": "^2.0.5",
|