@aws-sdk/client-marketplace-metering 3.997.0 → 3.999.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/README.md CHANGED
@@ -67,7 +67,7 @@ Guide</a>.</p>
67
67
  <li>
68
68
  <p>Resolves the registration token that the buyer submits through the browser
69
69
  during the registration process. Obtains a <code>CustomerIdentifier</code> along
70
- with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
70
+ with the <code>CustomerAWSAccountId</code>, <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
71
71
  </li>
72
72
  <li>
73
73
  <p>Called from: SaaS application during the registration process</p>
@@ -159,16 +159,16 @@ using your favorite package manager:
159
159
 
160
160
  The AWS SDK is modulized by clients and commands.
161
161
  To send a request, you only need to import the `MarketplaceMeteringClient` and
162
- the commands you need, for example `ResolveCustomerCommand`:
162
+ the commands you need, for example `BatchMeterUsageCommand`:
163
163
 
164
164
  ```js
165
165
  // ES5 example
166
- const { MarketplaceMeteringClient, ResolveCustomerCommand } = require("@aws-sdk/client-marketplace-metering");
166
+ const { MarketplaceMeteringClient, BatchMeterUsageCommand } = require("@aws-sdk/client-marketplace-metering");
167
167
  ```
168
168
 
169
169
  ```ts
170
170
  // ES6+ example
171
- import { MarketplaceMeteringClient, ResolveCustomerCommand } from "@aws-sdk/client-marketplace-metering";
171
+ import { MarketplaceMeteringClient, BatchMeterUsageCommand } from "@aws-sdk/client-marketplace-metering";
172
172
  ```
173
173
 
174
174
  ### Usage
@@ -185,7 +185,7 @@ To send a request, you:
185
185
  const client = new MarketplaceMeteringClient({ region: "REGION" });
186
186
 
187
187
  const params = { /** input parameters */ };
188
- const command = new ResolveCustomerCommand(params);
188
+ const command = new BatchMeterUsageCommand(params);
189
189
  ```
190
190
 
191
191
  #### Async/await
@@ -264,7 +264,7 @@ const client = new AWS.MarketplaceMetering({ region: "REGION" });
264
264
 
265
265
  // async/await.
266
266
  try {
267
- const data = await client.resolveCustomer(params);
267
+ const data = await client.batchMeterUsage(params);
268
268
  // process data.
269
269
  } catch (error) {
270
270
  // error handling.
@@ -272,7 +272,7 @@ try {
272
272
 
273
273
  // Promises.
274
274
  client
275
- .resolveCustomer(params)
275
+ .batchMeterUsage(params)
276
276
  .then((data) => {
277
277
  // process data.
278
278
  })
@@ -281,7 +281,7 @@ client
281
281
  });
282
282
 
283
283
  // callbacks.
284
- client.resolveCustomer(params, (err, data) => {
284
+ client.batchMeterUsage(params, (err, data) => {
285
285
  // process err and data.
286
286
  });
287
287
  ```
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.InvalidTokenException = exports.ExpiredTokenException = exports.PlatformNotSupportedException = exports.InvalidRegionException = exports.InvalidPublicKeyVersionException = exports.InvalidEndpointRegionException = exports.IdempotencyConflictException = exports.DuplicateRequestException = exports.CustomerNotEntitledException = exports.TimestampOutOfBoundsException = exports.ThrottlingException = exports.InvalidUsageDimensionException = exports.InvalidUsageAllocationsException = exports.InvalidTagException = exports.InvalidProductCodeException = exports.InvalidCustomerIdentifierException = exports.InternalServiceErrorException = exports.DisabledApiException = void 0;
3
+ exports.InvalidTokenException = exports.ExpiredTokenException = exports.PlatformNotSupportedException = exports.InvalidRegionException = exports.InvalidPublicKeyVersionException = exports.InvalidEndpointRegionException = exports.IdempotencyConflictException = exports.DuplicateRequestException = exports.CustomerNotEntitledException = exports.TimestampOutOfBoundsException = exports.ThrottlingException = exports.InvalidUsageDimensionException = exports.InvalidUsageAllocationsException = exports.InvalidTagException = exports.InvalidProductCodeException = exports.InvalidLicenseException = exports.InvalidCustomerIdentifierException = exports.InternalServiceErrorException = exports.DisabledApiException = void 0;
4
4
  const MarketplaceMeteringServiceException_1 = require("./MarketplaceMeteringServiceException");
5
5
  class DisabledApiException extends MarketplaceMeteringServiceException_1.MarketplaceMeteringServiceException {
6
6
  name = "DisabledApiException";
@@ -41,6 +41,19 @@ class InvalidCustomerIdentifierException extends MarketplaceMeteringServiceExcep
41
41
  }
42
42
  }
43
43
  exports.InvalidCustomerIdentifierException = InvalidCustomerIdentifierException;
44
+ class InvalidLicenseException extends MarketplaceMeteringServiceException_1.MarketplaceMeteringServiceException {
45
+ name = "InvalidLicenseException";
46
+ $fault = "client";
47
+ constructor(opts) {
48
+ super({
49
+ name: "InvalidLicenseException",
50
+ $fault: "client",
51
+ ...opts,
52
+ });
53
+ Object.setPrototypeOf(this, InvalidLicenseException.prototype);
54
+ }
55
+ }
56
+ exports.InvalidLicenseException = InvalidLicenseException;
44
57
  class InvalidProductCodeException extends MarketplaceMeteringServiceException_1.MarketplaceMeteringServiceException {
45
58
  name = "InvalidProductCodeException";
46
59
  $fault = "client";
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ResolveCustomer$ = exports.RegisterUsage$ = exports.MeterUsage$ = exports.BatchMeterUsage$ = exports.UsageRecordResult$ = exports.UsageRecord$ = exports.UsageAllocation$ = exports.Tag$ = exports.ResolveCustomerResult$ = exports.ResolveCustomerRequest$ = exports.RegisterUsageResult$ = exports.RegisterUsageRequest$ = exports.MeterUsageResult$ = exports.MeterUsageRequest$ = exports.BatchMeterUsageResult$ = exports.BatchMeterUsageRequest$ = exports.errorTypeRegistries = exports.TimestampOutOfBoundsException$ = exports.ThrottlingException$ = exports.PlatformNotSupportedException$ = exports.InvalidUsageDimensionException$ = exports.InvalidUsageAllocationsException$ = exports.InvalidTokenException$ = exports.InvalidTagException$ = exports.InvalidRegionException$ = exports.InvalidPublicKeyVersionException$ = exports.InvalidProductCodeException$ = exports.InvalidEndpointRegionException$ = exports.InvalidCustomerIdentifierException$ = exports.InternalServiceErrorException$ = exports.IdempotencyConflictException$ = exports.ExpiredTokenException$ = exports.DuplicateRequestException$ = exports.DisabledApiException$ = exports.CustomerNotEntitledException$ = exports.MarketplaceMeteringServiceException$ = void 0;
3
+ exports.ResolveCustomer$ = exports.RegisterUsage$ = exports.MeterUsage$ = exports.BatchMeterUsage$ = exports.UsageRecordResult$ = exports.UsageRecord$ = exports.UsageAllocation$ = exports.Tag$ = exports.ResolveCustomerResult$ = exports.ResolveCustomerRequest$ = exports.RegisterUsageResult$ = exports.RegisterUsageRequest$ = exports.MeterUsageResult$ = exports.MeterUsageRequest$ = exports.BatchMeterUsageResult$ = exports.BatchMeterUsageRequest$ = exports.errorTypeRegistries = exports.TimestampOutOfBoundsException$ = exports.ThrottlingException$ = exports.PlatformNotSupportedException$ = exports.InvalidUsageDimensionException$ = exports.InvalidUsageAllocationsException$ = exports.InvalidTokenException$ = exports.InvalidTagException$ = exports.InvalidRegionException$ = exports.InvalidPublicKeyVersionException$ = exports.InvalidProductCodeException$ = exports.InvalidLicenseException$ = exports.InvalidEndpointRegionException$ = exports.InvalidCustomerIdentifierException$ = exports.InternalServiceErrorException$ = exports.IdempotencyConflictException$ = exports.ExpiredTokenException$ = exports.DuplicateRequestException$ = exports.DisabledApiException$ = exports.CustomerNotEntitledException$ = exports.MarketplaceMeteringServiceException$ = void 0;
4
4
  const _AUQ = "AllocatedUsageQuantity";
5
5
  const _BMU = "BatchMeterUsage";
6
6
  const _BMUR = "BatchMeterUsageRequest";
@@ -17,6 +17,7 @@ const _ETE = "ExpiredTokenException";
17
17
  const _ICE = "IdempotencyConflictException";
18
18
  const _ICIE = "InvalidCustomerIdentifierException";
19
19
  const _IERE = "InvalidEndpointRegionException";
20
+ const _ILE = "InvalidLicenseException";
20
21
  const _IPCE = "InvalidProductCodeException";
21
22
  const _IPKVE = "InvalidPublicKeyVersionException";
22
23
  const _IRE = "InvalidRegionException";
@@ -26,6 +27,7 @@ const _ITEn = "InvalidTokenException";
26
27
  const _IUAE = "InvalidUsageAllocationsException";
27
28
  const _IUDE = "InvalidUsageDimensionException";
28
29
  const _K = "Key";
30
+ const _LA = "LicenseArn";
29
31
  const _MRI = "MeteringRecordId";
30
32
  const _MU = "MeterUsage";
31
33
  const _MUR = "MeterUsageRequest";
@@ -125,6 +127,12 @@ exports.InvalidEndpointRegionException$ = [-3, n0, _IERE,
125
127
  [0]
126
128
  ];
127
129
  n0_registry.registerError(exports.InvalidEndpointRegionException$, errors_1.InvalidEndpointRegionException);
130
+ exports.InvalidLicenseException$ = [-3, n0, _ILE,
131
+ { [_e]: _c },
132
+ [_m],
133
+ [0]
134
+ ];
135
+ n0_registry.registerError(exports.InvalidLicenseException$, errors_1.InvalidLicenseException);
128
136
  exports.InvalidProductCodeException$ = [-3, n0, _IPCE,
129
137
  { [_e]: _c },
130
138
  [_m],
@@ -192,7 +200,7 @@ exports.errorTypeRegistries = [
192
200
  exports.BatchMeterUsageRequest$ = [3, n0, _BMUR,
193
201
  0,
194
202
  [_UR, _PC],
195
- [() => UsageRecordList, 0], 2
203
+ [() => UsageRecordList, 0], 1
196
204
  ];
197
205
  exports.BatchMeterUsageResult$ = [3, n0, _BMURa,
198
206
  0,
@@ -226,8 +234,8 @@ exports.ResolveCustomerRequest$ = [3, n0, _RCR,
226
234
  ];
227
235
  exports.ResolveCustomerResult$ = [3, n0, _RCRe,
228
236
  0,
229
- [_CI, _PC, _CAWSAI],
230
- [0, 0, 0]
237
+ [_CI, _PC, _CAWSAI, _LA],
238
+ [0, 0, 0, 0]
231
239
  ];
232
240
  exports.Tag$ = [3, n0, _Ta,
233
241
  0,
@@ -241,8 +249,8 @@ exports.UsageAllocation$ = [3, n0, _UAs,
241
249
  ];
242
250
  exports.UsageRecord$ = [3, n0, _URs,
243
251
  0,
244
- [_T, _D, _CI, _Q, _UA, _CAWSAI],
245
- [4, 0, 0, 1, () => UsageAllocations, 0], 2
252
+ [_T, _D, _CI, _Q, _UA, _CAWSAI, _LA],
253
+ [4, 0, 0, 1, () => UsageAllocations, 0, 0], 2
246
254
  ];
247
255
  exports.UsageRecordResult$ = [3, n0, _URR,
248
256
  0,
@@ -35,6 +35,18 @@ export class InvalidCustomerIdentifierException extends __BaseException {
35
35
  Object.setPrototypeOf(this, InvalidCustomerIdentifierException.prototype);
36
36
  }
37
37
  }
38
+ export class InvalidLicenseException extends __BaseException {
39
+ name = "InvalidLicenseException";
40
+ $fault = "client";
41
+ constructor(opts) {
42
+ super({
43
+ name: "InvalidLicenseException",
44
+ $fault: "client",
45
+ ...opts,
46
+ });
47
+ Object.setPrototypeOf(this, InvalidLicenseException.prototype);
48
+ }
49
+ }
38
50
  export class InvalidProductCodeException extends __BaseException {
39
51
  name = "InvalidProductCodeException";
40
52
  $fault = "client";
@@ -14,6 +14,7 @@ const _ETE = "ExpiredTokenException";
14
14
  const _ICE = "IdempotencyConflictException";
15
15
  const _ICIE = "InvalidCustomerIdentifierException";
16
16
  const _IERE = "InvalidEndpointRegionException";
17
+ const _ILE = "InvalidLicenseException";
17
18
  const _IPCE = "InvalidProductCodeException";
18
19
  const _IPKVE = "InvalidPublicKeyVersionException";
19
20
  const _IRE = "InvalidRegionException";
@@ -23,6 +24,7 @@ const _ITEn = "InvalidTokenException";
23
24
  const _IUAE = "InvalidUsageAllocationsException";
24
25
  const _IUDE = "InvalidUsageDimensionException";
25
26
  const _K = "Key";
27
+ const _LA = "LicenseArn";
26
28
  const _MRI = "MeteringRecordId";
27
29
  const _MU = "MeterUsage";
28
30
  const _MUR = "MeterUsageRequest";
@@ -68,7 +70,7 @@ const _s = "smithy.ts.sdk.synthetic.com.amazonaws.marketplacemetering";
68
70
  const _se = "server";
69
71
  const n0 = "com.amazonaws.marketplacemetering";
70
72
  import { TypeRegistry } from "@smithy/core/schema";
71
- import { CustomerNotEntitledException, DisabledApiException, DuplicateRequestException, ExpiredTokenException, IdempotencyConflictException, InternalServiceErrorException, InvalidCustomerIdentifierException, InvalidEndpointRegionException, InvalidProductCodeException, InvalidPublicKeyVersionException, InvalidRegionException, InvalidTagException, InvalidTokenException, InvalidUsageAllocationsException, InvalidUsageDimensionException, PlatformNotSupportedException, ThrottlingException, TimestampOutOfBoundsException, } from "../models/errors";
73
+ import { CustomerNotEntitledException, DisabledApiException, DuplicateRequestException, ExpiredTokenException, IdempotencyConflictException, InternalServiceErrorException, InvalidCustomerIdentifierException, InvalidEndpointRegionException, InvalidLicenseException, InvalidProductCodeException, InvalidPublicKeyVersionException, InvalidRegionException, InvalidTagException, InvalidTokenException, InvalidUsageAllocationsException, InvalidUsageDimensionException, PlatformNotSupportedException, ThrottlingException, TimestampOutOfBoundsException, } from "../models/errors";
72
74
  import { MarketplaceMeteringServiceException } from "../models/MarketplaceMeteringServiceException";
73
75
  const _s_registry = TypeRegistry.for(_s);
74
76
  export var MarketplaceMeteringServiceException$ = [-3, _s, "MarketplaceMeteringServiceException", 0, [], []];
@@ -122,6 +124,12 @@ export var InvalidEndpointRegionException$ = [-3, n0, _IERE,
122
124
  [0]
123
125
  ];
124
126
  n0_registry.registerError(InvalidEndpointRegionException$, InvalidEndpointRegionException);
127
+ export var InvalidLicenseException$ = [-3, n0, _ILE,
128
+ { [_e]: _c },
129
+ [_m],
130
+ [0]
131
+ ];
132
+ n0_registry.registerError(InvalidLicenseException$, InvalidLicenseException);
125
133
  export var InvalidProductCodeException$ = [-3, n0, _IPCE,
126
134
  { [_e]: _c },
127
135
  [_m],
@@ -189,7 +197,7 @@ export const errorTypeRegistries = [
189
197
  export var BatchMeterUsageRequest$ = [3, n0, _BMUR,
190
198
  0,
191
199
  [_UR, _PC],
192
- [() => UsageRecordList, 0], 2
200
+ [() => UsageRecordList, 0], 1
193
201
  ];
194
202
  export var BatchMeterUsageResult$ = [3, n0, _BMURa,
195
203
  0,
@@ -223,8 +231,8 @@ export var ResolveCustomerRequest$ = [3, n0, _RCR,
223
231
  ];
224
232
  export var ResolveCustomerResult$ = [3, n0, _RCRe,
225
233
  0,
226
- [_CI, _PC, _CAWSAI],
227
- [0, 0, 0]
234
+ [_CI, _PC, _CAWSAI, _LA],
235
+ [0, 0, 0, 0]
228
236
  ];
229
237
  export var Tag$ = [3, n0, _Ta,
230
238
  0,
@@ -238,8 +246,8 @@ export var UsageAllocation$ = [3, n0, _UAs,
238
246
  ];
239
247
  export var UsageRecord$ = [3, n0, _URs,
240
248
  0,
241
- [_T, _D, _CI, _Q, _UA, _CAWSAI],
242
- [4, 0, 0, 1, () => UsageAllocations, 0], 2
249
+ [_T, _D, _CI, _Q, _UA, _CAWSAI, _LA],
250
+ [4, 0, 0, 1, () => UsageAllocations, 0, 0], 2
243
251
  ];
244
252
  export var UsageRecordResult$ = [3, n0, _URR,
245
253
  0,
@@ -92,7 +92,7 @@ export interface MarketplaceMetering {
92
92
  * <li>
93
93
  * <p>Resolves the registration token that the buyer submits through the browser
94
94
  * during the registration process. Obtains a <code>CustomerIdentifier</code> along
95
- * with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
95
+ * with the <code>CustomerAWSAccountId</code>, <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
96
96
  * </li>
97
97
  * <li>
98
98
  * <p>Called from: SaaS application during the registration process</p>
@@ -234,7 +234,7 @@ export interface MarketplaceMeteringClientResolvedConfig extends MarketplaceMete
234
234
  * <li>
235
235
  * <p>Resolves the registration token that the buyer submits through the browser
236
236
  * during the registration process. Obtains a <code>CustomerIdentifier</code> along
237
- * with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
237
+ * with the <code>CustomerAWSAccountId</code>, <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
238
238
  * </li>
239
239
  * <li>
240
240
  * <p>Called from: SaaS application during the registration process</p>
@@ -28,10 +28,7 @@ declare const BatchMeterUsageCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <important>
31
- * <p>
32
- * The <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> are mutually exclusive parameters. You must use one or the other, but not both in the same API request.
33
- * For new implementations, we recommend using the <code>CustomerAWSAccountID</code>. Your current integration will continue to work. When updating your implementation, consider migrating to <code>CustomerAWSAccountID</code> for improved integration.
34
- * </p>
31
+ * <p>Amazon Web Services Marketplace is introducing Concurrent Agreements, enabling buyers to make multiple purchases per Amazon Web Services account. Starting June 1, 2026, new SaaS products must use <code>CustomerAWSAccountId</code> (instead of <code>CustomerIdentifier</code>), <code>LicenseArn</code> (instead of <code>ProductCode</code>) to support this feature. Existing integrations will continue to work. Review the new integration for Concurrent Agreements <a href="https://catalog.workshops.aws/mpseller/en-US/saas/integration-for-concurrent-agreements">here</a>.</p>
35
32
  * </important>
36
33
  * <p>To post metering records for customers, SaaS applications call
37
34
  * <code>BatchMeterUsage</code>, which is used for metering SaaS flexible
@@ -87,9 +84,10 @@ declare const BatchMeterUsageCommand_base: {
87
84
  * },
88
85
  * ],
89
86
  * CustomerAWSAccountId: "STRING_VALUE",
87
+ * LicenseArn: "STRING_VALUE",
90
88
  * },
91
89
  * ],
92
- * ProductCode: "STRING_VALUE", // required
90
+ * ProductCode: "STRING_VALUE",
93
91
  * };
94
92
  * const command = new BatchMeterUsageCommand(input);
95
93
  * const response = await client.send(command);
@@ -113,6 +111,7 @@ declare const BatchMeterUsageCommand_base: {
113
111
  * // },
114
112
  * // ],
115
113
  * // CustomerAWSAccountId: "STRING_VALUE",
114
+ * // LicenseArn: "STRING_VALUE",
116
115
  * // },
117
116
  * // MeteringRecordId: "STRING_VALUE",
118
117
  * // Status: "Success" || "CustomerNotSubscribed" || "DuplicateRecord",
@@ -136,6 +135,7 @@ declare const BatchMeterUsageCommand_base: {
136
135
  * // },
137
136
  * // ],
138
137
  * // CustomerAWSAccountId: "STRING_VALUE",
138
+ * // LicenseArn: "STRING_VALUE",
139
139
  * // },
140
140
  * // ],
141
141
  * // };
@@ -159,6 +159,9 @@ declare const BatchMeterUsageCommand_base: {
159
159
  * <p>You have metered usage for a <code>CustomerIdentifier</code> that does not
160
160
  * exist.</p>
161
161
  *
162
+ * @throws {@link InvalidLicenseException} (client fault)
163
+ * <p>Ensure the <code>LicenseArn</code> is valid, matches the customer, and usage is within the license activation period.</p>
164
+ *
162
165
  * @throws {@link InvalidProductCodeException} (client fault)
163
166
  * <p>The product code passed does not match the product code used for publishing the
164
167
  * product.</p>
@@ -32,7 +32,7 @@ declare const ResolveCustomerCommand_base: {
32
32
  * process. When a buyer visits your website during the registration process, the buyer
33
33
  * submits a registration token through their browser. The registration token is resolved
34
34
  * through this API to obtain a <code>CustomerIdentifier</code> along with the
35
- * <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
35
+ * <code>CustomerAWSAccountId</code>, <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
36
36
  * <note>
37
37
  * <p>To successfully resolve the token, the API must be called from the account that was used to publish the SaaS
38
38
  * application. 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>Amazon Web Services Marketplace Seller
@@ -61,6 +61,7 @@ declare const ResolveCustomerCommand_base: {
61
61
  * // CustomerIdentifier: "STRING_VALUE",
62
62
  * // ProductCode: "STRING_VALUE",
63
63
  * // CustomerAWSAccountId: "STRING_VALUE",
64
+ * // LicenseArn: "STRING_VALUE",
64
65
  * // };
65
66
  *
66
67
  * ```
@@ -60,7 +60,7 @@
60
60
  * <li>
61
61
  * <p>Resolves the registration token that the buyer submits through the browser
62
62
  * during the registration process. Obtains a <code>CustomerIdentifier</code> along
63
- * with the <code>CustomerAWSAccountId</code> and <code>ProductCode</code>.</p>
63
+ * with the <code>CustomerAWSAccountId</code>, <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
64
64
  * </li>
65
65
  * <li>
66
66
  * <p>Called from: SaaS application during the registration process</p>
@@ -38,6 +38,18 @@ export declare class InvalidCustomerIdentifierException extends __BaseException
38
38
  */
39
39
  constructor(opts: __ExceptionOptionType<InvalidCustomerIdentifierException, __BaseException>);
40
40
  }
41
+ /**
42
+ * <p>Ensure the <code>LicenseArn</code> is valid, matches the customer, and usage is within the license activation period.</p>
43
+ * @public
44
+ */
45
+ export declare class InvalidLicenseException extends __BaseException {
46
+ readonly name: "InvalidLicenseException";
47
+ readonly $fault: "client";
48
+ /**
49
+ * @internal
50
+ */
51
+ constructor(opts: __ExceptionOptionType<InvalidLicenseException, __BaseException>);
52
+ }
41
53
  /**
42
54
  * <p>The product code passed does not match the product code used for publishing the
43
55
  * product.</p>
@@ -79,12 +79,21 @@ export interface UsageRecord {
79
79
  */
80
80
  UsageAllocations?: UsageAllocation[] | undefined;
81
81
  /**
82
- * <p>
83
- * The <code>CustomerAWSAccountID</code> parameter specifies the AWS account ID of the buyer.
84
- * </p>
82
+ * <p>The <code>CustomerAWSAccountId</code> parameter specifies the AWS account ID of the buyer.</p>
83
+ * <note>
84
+ * <p>For existing integrations, to access your <code>CustomerIdentifier</code> to <code>CustomerAWSAccountId</code> mapping, see <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-account.html">Account Feeds</a>.</p>
85
+ * </note>
85
86
  * @public
86
87
  */
87
88
  CustomerAWSAccountId?: string | undefined;
89
+ /**
90
+ * <p>The <code>LicenseArn</code> is a unique identifier for a specific granted license. These are used for software purchased through Amazon Web Services Marketplace.</p>
91
+ * <note>
92
+ * <p>To access your <code>CustomerAWSAccountId</code> and <code>LicenseArn</code> mapping, visit <a href="https://docs.aws.amazon.com/marketplace/latest/userguide/data-feed-agreements.html">Agreements Feeds</a>.</p>
93
+ * </note>
94
+ * @public
95
+ */
96
+ LicenseArn?: string | undefined;
88
97
  }
89
98
  /**
90
99
  * <p>A <code>BatchMeterUsageRequest</code> contains <code>UsageRecords</code>, which
@@ -103,7 +112,7 @@ export interface BatchMeterUsageRequest {
103
112
  * be the same as the one used during the publishing of a new product.</p>
104
113
  * @public
105
114
  */
106
- ProductCode: string | undefined;
115
+ ProductCode?: string | undefined;
107
116
  }
108
117
  /**
109
118
  * <p>A <code>UsageRecordResult</code> indicates the status of a given
@@ -302,23 +311,22 @@ export interface ResolveCustomerRequest {
302
311
  /**
303
312
  * <p>When a buyer visits your website during the registration process, the buyer submits a
304
313
  * registration token through the browser. The registration token is resolved to obtain a
305
- * <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and
306
- * <code>ProductCode</code>.</p>
314
+ * <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code>,
315
+ * <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
307
316
  * @public
308
317
  */
309
318
  RegistrationToken: string | undefined;
310
319
  }
311
320
  /**
312
321
  * <p>The result of the <code>ResolveCustomer</code> operation. Contains the
313
- * <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code> and
314
- * <code>ProductCode</code>.</p>
322
+ * <code>CustomerIdentifier</code> along with the <code>CustomerAWSAccountId</code>,
323
+ * <code>ProductCode</code>, and <code>LicenseArn</code>.</p>
315
324
  * @public
316
325
  */
317
326
  export interface ResolveCustomerResult {
318
327
  /**
319
328
  * <p>The <code>CustomerIdentifier</code> is used to identify an individual customer in your
320
- * application. Calls to <code>BatchMeterUsage</code> require
321
- * <code>CustomerIdentifiers</code> for each <code>UsageRecord</code>.</p>
329
+ * application.</p>
322
330
  * @public
323
331
  */
324
332
  CustomerIdentifier?: string | undefined;
@@ -331,8 +339,17 @@ export interface ResolveCustomerResult {
331
339
  ProductCode?: string | undefined;
332
340
  /**
333
341
  * <p>The <code>CustomerAWSAccountId</code> provides the Amazon Web Services account ID associated with
334
- * the <code>CustomerIdentifier</code> for the individual customer.</p>
342
+ * the <code>CustomerIdentifier</code> for the individual customer. Calls to <code>BatchMeterUsage</code> require
343
+ * <code>CustomerAWSAccountId</code> for each <code>UsageRecord</code>.</p>
335
344
  * @public
336
345
  */
337
346
  CustomerAWSAccountId?: string | undefined;
347
+ /**
348
+ * <p>The <code>LicenseArn</code> is a unique identifier for a specific granted license. These are typically used for software purchased through Amazon Web Services Marketplace. Calls to <code>BatchMeterUsage</code> require <code>LicenseArn</code> for each <code>UsageRecord</code>.</p>
349
+ * <note>
350
+ * <p>Once you receive the <code>CustomerAWSAccountId</code> and <code>LicenseArn</code> in the response, store that for future purposes/API calls/integrations.</p>
351
+ * </note>
352
+ * @public
353
+ */
354
+ LicenseArn?: string | undefined;
338
355
  }
@@ -9,6 +9,7 @@ export declare var IdempotencyConflictException$: StaticErrorSchema;
9
9
  export declare var InternalServiceErrorException$: StaticErrorSchema;
10
10
  export declare var InvalidCustomerIdentifierException$: StaticErrorSchema;
11
11
  export declare var InvalidEndpointRegionException$: StaticErrorSchema;
12
+ export declare var InvalidLicenseException$: StaticErrorSchema;
12
13
  export declare var InvalidProductCodeException$: StaticErrorSchema;
13
14
  export declare var InvalidPublicKeyVersionException$: StaticErrorSchema;
14
15
  export declare var InvalidRegionException$: StaticErrorSchema;
@@ -24,6 +24,13 @@ export declare class InvalidCustomerIdentifierException extends __BaseException
24
24
  >
25
25
  );
26
26
  }
27
+ export declare class InvalidLicenseException extends __BaseException {
28
+ readonly name: "InvalidLicenseException";
29
+ readonly $fault: "client";
30
+ constructor(
31
+ opts: __ExceptionOptionType<InvalidLicenseException, __BaseException>
32
+ );
33
+ }
27
34
  export declare class InvalidProductCodeException extends __BaseException {
28
35
  readonly name: "InvalidProductCodeException";
29
36
  readonly $fault: "client";
@@ -14,10 +14,11 @@ export interface UsageRecord {
14
14
  Quantity?: number | undefined;
15
15
  UsageAllocations?: UsageAllocation[] | undefined;
16
16
  CustomerAWSAccountId?: string | undefined;
17
+ LicenseArn?: string | undefined;
17
18
  }
18
19
  export interface BatchMeterUsageRequest {
19
20
  UsageRecords: UsageRecord[] | undefined;
20
- ProductCode: string | undefined;
21
+ ProductCode?: string | undefined;
21
22
  }
22
23
  export interface UsageRecordResult {
23
24
  UsageRecord?: UsageRecord | undefined;
@@ -56,4 +57,5 @@ export interface ResolveCustomerResult {
56
57
  CustomerIdentifier?: string | undefined;
57
58
  ProductCode?: string | undefined;
58
59
  CustomerAWSAccountId?: string | undefined;
60
+ LicenseArn?: string | undefined;
59
61
  }
@@ -13,6 +13,7 @@ export declare var IdempotencyConflictException$: StaticErrorSchema;
13
13
  export declare var InternalServiceErrorException$: StaticErrorSchema;
14
14
  export declare var InvalidCustomerIdentifierException$: StaticErrorSchema;
15
15
  export declare var InvalidEndpointRegionException$: StaticErrorSchema;
16
+ export declare var InvalidLicenseException$: StaticErrorSchema;
16
17
  export declare var InvalidProductCodeException$: StaticErrorSchema;
17
18
  export declare var InvalidPublicKeyVersionException$: StaticErrorSchema;
18
19
  export declare var InvalidRegionException$: StaticErrorSchema;
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.997.0",
4
+ "version": "3.999.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-marketplace-metering",
@@ -21,41 +21,41 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "5.2.0",
23
23
  "@aws-crypto/sha256-js": "5.2.0",
24
- "@aws-sdk/core": "^3.973.13",
25
- "@aws-sdk/credential-provider-node": "^3.972.12",
26
- "@aws-sdk/middleware-host-header": "^3.972.4",
27
- "@aws-sdk/middleware-logger": "^3.972.4",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.4",
29
- "@aws-sdk/middleware-user-agent": "^3.972.13",
30
- "@aws-sdk/region-config-resolver": "^3.972.4",
31
- "@aws-sdk/types": "^3.973.2",
32
- "@aws-sdk/util-endpoints": "^3.996.1",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.4",
34
- "@aws-sdk/util-user-agent-node": "^3.972.12",
35
- "@smithy/config-resolver": "^4.4.7",
36
- "@smithy/core": "^3.23.4",
37
- "@smithy/fetch-http-handler": "^5.3.10",
38
- "@smithy/hash-node": "^4.2.9",
39
- "@smithy/invalid-dependency": "^4.2.9",
40
- "@smithy/middleware-content-length": "^4.2.9",
41
- "@smithy/middleware-endpoint": "^4.4.18",
42
- "@smithy/middleware-retry": "^4.4.35",
43
- "@smithy/middleware-serde": "^4.2.10",
44
- "@smithy/middleware-stack": "^4.2.9",
45
- "@smithy/node-config-provider": "^4.3.9",
46
- "@smithy/node-http-handler": "^4.4.11",
47
- "@smithy/protocol-http": "^5.3.9",
48
- "@smithy/smithy-client": "^4.11.7",
49
- "@smithy/types": "^4.12.1",
50
- "@smithy/url-parser": "^4.2.9",
24
+ "@aws-sdk/core": "^3.973.15",
25
+ "@aws-sdk/credential-provider-node": "^3.972.14",
26
+ "@aws-sdk/middleware-host-header": "^3.972.6",
27
+ "@aws-sdk/middleware-logger": "^3.972.6",
28
+ "@aws-sdk/middleware-recursion-detection": "^3.972.6",
29
+ "@aws-sdk/middleware-user-agent": "^3.972.15",
30
+ "@aws-sdk/region-config-resolver": "^3.972.6",
31
+ "@aws-sdk/types": "^3.973.4",
32
+ "@aws-sdk/util-endpoints": "^3.996.3",
33
+ "@aws-sdk/util-user-agent-browser": "^3.972.6",
34
+ "@aws-sdk/util-user-agent-node": "^3.973.0",
35
+ "@smithy/config-resolver": "^4.4.9",
36
+ "@smithy/core": "^3.23.6",
37
+ "@smithy/fetch-http-handler": "^5.3.11",
38
+ "@smithy/hash-node": "^4.2.10",
39
+ "@smithy/invalid-dependency": "^4.2.10",
40
+ "@smithy/middleware-content-length": "^4.2.10",
41
+ "@smithy/middleware-endpoint": "^4.4.20",
42
+ "@smithy/middleware-retry": "^4.4.37",
43
+ "@smithy/middleware-serde": "^4.2.11",
44
+ "@smithy/middleware-stack": "^4.2.10",
45
+ "@smithy/node-config-provider": "^4.3.10",
46
+ "@smithy/node-http-handler": "^4.4.12",
47
+ "@smithy/protocol-http": "^5.3.10",
48
+ "@smithy/smithy-client": "^4.12.0",
49
+ "@smithy/types": "^4.13.0",
50
+ "@smithy/url-parser": "^4.2.10",
51
51
  "@smithy/util-base64": "^4.3.1",
52
52
  "@smithy/util-body-length-browser": "^4.2.1",
53
53
  "@smithy/util-body-length-node": "^4.2.2",
54
- "@smithy/util-defaults-mode-browser": "^4.3.34",
55
- "@smithy/util-defaults-mode-node": "^4.2.37",
56
- "@smithy/util-endpoints": "^3.2.9",
57
- "@smithy/util-middleware": "^4.2.9",
58
- "@smithy/util-retry": "^4.2.9",
54
+ "@smithy/util-defaults-mode-browser": "^4.3.36",
55
+ "@smithy/util-defaults-mode-node": "^4.2.39",
56
+ "@smithy/util-endpoints": "^3.3.1",
57
+ "@smithy/util-middleware": "^4.2.10",
58
+ "@smithy/util-retry": "^4.2.10",
59
59
  "@smithy/util-utf8": "^4.2.1",
60
60
  "tslib": "^2.6.2"
61
61
  },