@aws-sdk/client-marketplace-metering 3.378.0 → 3.382.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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -67,6 +67,7 @@
67
67
  */
68
68
  export * from "./MarketplaceMeteringClient";
69
69
  export * from "./MarketplaceMetering";
70
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
70
71
  export * from "./commands";
71
72
  export * from "./models";
72
73
  export { MarketplaceMeteringServiceException } from "./models/MarketplaceMeteringServiceException";
@@ -7,11 +7,13 @@ import { MarketplaceMeteringServiceException as __BaseException } from "./Market
7
7
  */
8
8
  export interface Tag {
9
9
  /**
10
+ * @public
10
11
  * <p>One part of a key-value pair that makes up a <code>tag</code>. A <code>key</code> is a
11
12
  * label that acts like a category for the specific tag values.</p>
12
13
  */
13
14
  Key: string | undefined;
14
15
  /**
16
+ * @public
15
17
  * <p>One part of a key-value pair that makes up a <code>tag</code>. A <code>value</code>
16
18
  * acts as a descriptor within a tag category (key). The value can be empty or null.</p>
17
19
  */
@@ -25,10 +27,12 @@ export interface Tag {
25
27
  */
26
28
  export interface UsageAllocation {
27
29
  /**
30
+ * @public
28
31
  * <p>The total quantity allocated to this bucket of usage.</p>
29
32
  */
30
33
  AllocatedUsageQuantity: number | undefined;
31
34
  /**
35
+ * @public
32
36
  * <p>The set of tags that define the bucket of usage. For the bucket of items with no tags,
33
37
  * this parameter can be left out.</p>
34
38
  */
@@ -43,28 +47,33 @@ export interface UsageAllocation {
43
47
  */
44
48
  export interface UsageRecord {
45
49
  /**
50
+ * @public
46
51
  * <p>Timestamp, in UTC, for which the usage is being reported.</p>
47
52
  * <p>Your application can meter usage for up to one hour in the past. Make sure the
48
53
  * <code>timestamp</code> value is not before the start of the software usage.</p>
49
54
  */
50
55
  Timestamp: Date | undefined;
51
56
  /**
57
+ * @public
52
58
  * <p>The <code>CustomerIdentifier</code> is obtained through the
53
59
  * <code>ResolveCustomer</code> operation and represents an individual buyer in your
54
60
  * application.</p>
55
61
  */
56
62
  CustomerIdentifier: string | undefined;
57
63
  /**
64
+ * @public
58
65
  * <p>During the process of registering a product on AWS Marketplace, dimensions are
59
66
  * specified. These represent different units of value in your application.</p>
60
67
  */
61
68
  Dimension: string | undefined;
62
69
  /**
70
+ * @public
63
71
  * <p>The quantity of usage consumed by the customer for the given dimension and time.
64
72
  * Defaults to <code>0</code> if not specified.</p>
65
73
  */
66
74
  Quantity?: number;
67
75
  /**
76
+ * @public
68
77
  * <p>The set of <code>UsageAllocations</code> to submit. The sum of all
69
78
  * <code>UsageAllocation</code> quantities must equal the Quantity of the
70
79
  * <code>UsageRecord</code>.</p>
@@ -78,11 +87,13 @@ export interface UsageRecord {
78
87
  */
79
88
  export interface BatchMeterUsageRequest {
80
89
  /**
90
+ * @public
81
91
  * <p>The set of <code>UsageRecords</code> to submit. <code>BatchMeterUsage</code> accepts
82
92
  * up to 25 <code>UsageRecords</code> at a time.</p>
83
93
  */
84
94
  UsageRecords: UsageRecord[] | undefined;
85
95
  /**
96
+ * @public
86
97
  * <p>Product code is used to uniquely identify a product in AWS Marketplace. The product
87
98
  * code should be the same as the one used during the publishing of a new product.</p>
88
99
  */
@@ -108,16 +119,19 @@ export type UsageRecordResultStatus = (typeof UsageRecordResultStatus)[keyof typ
108
119
  */
109
120
  export interface UsageRecordResult {
110
121
  /**
122
+ * @public
111
123
  * <p>The <code>UsageRecord</code> that was part of the <code>BatchMeterUsage</code>
112
124
  * request.</p>
113
125
  */
114
126
  UsageRecord?: UsageRecord;
115
127
  /**
128
+ * @public
116
129
  * <p>The <code>MeteringRecordId</code> is a unique identifier for this metering
117
130
  * event.</p>
118
131
  */
119
132
  MeteringRecordId?: string;
120
133
  /**
134
+ * @public
121
135
  * <p>The <code>UsageRecordResult</code>
122
136
  * <code>Status</code> indicates the status of an individual <code>UsageRecord</code>
123
137
  * processed by <code>BatchMeterUsage</code>.</p>
@@ -165,12 +179,14 @@ export interface UsageRecordResult {
165
179
  */
166
180
  export interface BatchMeterUsageResult {
167
181
  /**
182
+ * @public
168
183
  * <p>Contains all <code>UsageRecords</code> processed by <code>BatchMeterUsage</code>.
169
184
  * These records were either honored by AWS Marketplace Metering Service or were invalid.
170
185
  * Invalid records should be fixed before being resubmitted.</p>
171
186
  */
172
187
  Results?: UsageRecordResult[];
173
188
  /**
189
+ * @public
174
190
  * <p>Contains all <code>UsageRecords</code> that were not processed by
175
191
  * <code>BatchMeterUsage</code>. This is a list of <code>UsageRecords</code>. You can
176
192
  * retry the failed request by making another <code>BatchMeterUsage</code> call with this
@@ -341,26 +357,31 @@ export declare class InvalidEndpointRegionException extends __BaseException {
341
357
  */
342
358
  export interface MeterUsageRequest {
343
359
  /**
360
+ * @public
344
361
  * <p>Product code is used to uniquely identify a product in AWS Marketplace. The product
345
362
  * code should be the same as the one used during the publishing of a new product.</p>
346
363
  */
347
364
  ProductCode: string | undefined;
348
365
  /**
366
+ * @public
349
367
  * <p>Timestamp, in UTC, for which the usage is being reported. Your application can meter
350
368
  * usage for up to one hour in the past. Make sure the <code>timestamp</code> value is not
351
369
  * before the start of the software usage.</p>
352
370
  */
353
371
  Timestamp: Date | undefined;
354
372
  /**
373
+ * @public
355
374
  * <p>It will be one of the fcp dimension name provided during the publishing of the
356
375
  * product.</p>
357
376
  */
358
377
  UsageDimension: string | undefined;
359
378
  /**
379
+ * @public
360
380
  * <p>Consumption value for the hour. Defaults to <code>0</code> if not specified.</p>
361
381
  */
362
382
  UsageQuantity?: number;
363
383
  /**
384
+ * @public
364
385
  * <p>Checks whether you have the permissions required for the action, but does not make the
365
386
  * request. If you have the permissions, the request returns <code>DryRunOperation</code>;
366
387
  * otherwise, it returns <code>UnauthorizedException</code>. Defaults to <code>false</code>
@@ -368,6 +389,7 @@ export interface MeterUsageRequest {
368
389
  */
369
390
  DryRun?: boolean;
370
391
  /**
392
+ * @public
371
393
  * <p>The set of <code>UsageAllocations</code> to submit.</p>
372
394
  * <p>The sum of all <code>UsageAllocation</code> quantities must equal the
373
395
  * <code>UsageQuantity</code> of the <code>MeterUsage</code> request, and each
@@ -381,6 +403,7 @@ export interface MeterUsageRequest {
381
403
  */
382
404
  export interface MeterUsageResult {
383
405
  /**
406
+ * @public
384
407
  * <p>Metering record id.</p>
385
408
  */
386
409
  MeteringRecordId?: string;
@@ -430,15 +453,18 @@ export declare class PlatformNotSupportedException extends __BaseException {
430
453
  */
431
454
  export interface RegisterUsageRequest {
432
455
  /**
456
+ * @public
433
457
  * <p>Product code is used to uniquely identify a product in AWS Marketplace. The product
434
458
  * code should be the same as the one used during the publishing of a new product.</p>
435
459
  */
436
460
  ProductCode: string | undefined;
437
461
  /**
462
+ * @public
438
463
  * <p>Public Key Version provided by AWS Marketplace</p>
439
464
  */
440
465
  PublicKeyVersion: number | undefined;
441
466
  /**
467
+ * @public
442
468
  * <p>(Optional) To scope down the registration to a specific running software instance and
443
469
  * guard against replay attacks.</p>
444
470
  */
@@ -449,10 +475,12 @@ export interface RegisterUsageRequest {
449
475
  */
450
476
  export interface RegisterUsageResult {
451
477
  /**
478
+ * @public
452
479
  * <p>(Optional) Only included when public key version has expired</p>
453
480
  */
454
481
  PublicKeyRotationTimestamp?: Date;
455
482
  /**
483
+ * @public
456
484
  * <p>JWT Token</p>
457
485
  */
458
486
  Signature?: string;
@@ -491,6 +519,7 @@ export declare class InvalidTokenException extends __BaseException {
491
519
  */
492
520
  export interface ResolveCustomerRequest {
493
521
  /**
522
+ * @public
494
523
  * <p>When a buyer visits your website during the registration process, the buyer submits a
495
524
  * registration token through the browser. The registration token is resolved to obtain a
496
525
  * <code>CustomerIdentifier</code>
@@ -511,18 +540,21 @@ export interface ResolveCustomerRequest {
511
540
  */
512
541
  export interface ResolveCustomerResult {
513
542
  /**
543
+ * @public
514
544
  * <p>The <code>CustomerIdentifier</code> is used to identify an individual customer in your
515
545
  * application. Calls to <code>BatchMeterUsage</code> require
516
546
  * <code>CustomerIdentifiers</code> for each <code>UsageRecord</code>.</p>
517
547
  */
518
548
  CustomerIdentifier?: string;
519
549
  /**
550
+ * @public
520
551
  * <p>The product code is returned to confirm that the buyer is registering for your
521
552
  * product. Subsequent <code>BatchMeterUsage</code> calls should be made using this product
522
553
  * code.</p>
523
554
  */
524
555
  ProductCode?: string;
525
556
  /**
557
+ * @public
526
558
  * <p>The <code>CustomerAWSAccountId</code> provides the AWS account ID associated with the
527
559
  * <code>CustomerIdentifier</code> for the individual customer.</p>
528
560
  */
@@ -1,5 +1,6 @@
1
1
  export * from "./MarketplaceMeteringClient";
2
2
  export * from "./MarketplaceMetering";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./models";
5
6
  export { MarketplaceMeteringServiceException } from "./models/MarketplaceMeteringServiceException";
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.378.0",
4
+ "version": "3.382.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,15 +21,15 @@
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
+ "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",