feat(client-marketplace-metering): Added ClientToken parameter to MeterUsage API for specifying idempotent requests.

Author: awstools

clients/client-marketplace-metering/package.json

@@ -56,6 +56,7 @@
     "@smithy/util-middleware": "^4.2.3",
     "@smithy/util-retry": "^4.2.3",
     "@smithy/util-utf8": "^4.2.0",
+    "@smithy/uuid": "^1.1.0",
     "tslib": "^2.6.2"
   },
   "devDependencies": {

clients/client-marketplace-metering/src/commands/BatchMeterUsageCommand.ts

@@ -34,7 +34,7 @@ export interface BatchMeterUsageCommandOutput extends BatchMeterUsageResult, __M
 /**
  * <important>
  *             <p>
- *                 The <code>CustomerIdentifier</code> parameter is scheduled for deprecation. Use <code>CustomerAWSAccountID</code> instead.</p>
+ *                 The <code>CustomerIdentifier</code> parameter is scheduled for deprecation on March 31, 2026. Use <code>CustomerAWSAccountID</code> instead.</p>
  *             <p>These parameters are mutually exclusive. You can't specify both <code>CustomerIdentifier</code> and <code>CustomerAWSAccountID</code> in the same request.
  *             </p>
  *          </important>

clients/client-marketplace-metering/src/commands/MeterUsageCommand.ts

@@ -43,8 +43,13 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea
  *             <code>MeterUsage</code> can optionally include multiple usage allocations, to provide
  *             customers with usage data split into buckets by tags that you define (or allow the
  *             customer to define).</p>
- *          <p>Usage records are expected to be submitted as quickly as possible after the event that
- *             is being recorded, and are not accepted more than 6 hours after the event.</p>
+ *          <p>Submit usage records to report events from the previous hour. If you submit records that
+ *             are greater than six hours after events occur, the records won’t be accepted. The timestamp
+ *             in your request determines when an event is recorded. You can only report usage once per hour
+ *             for each dimension. For AMI-based products, this is per dimension and per EC2 instance. For
+ *             container products, this is per dimension and per ECS task or EKS pod. You can’t modify values
+ *             after they’re recorded. If you report usage before the current hour ends, you will be unable to
+ *             report additional usage until the next hour begins.</p>
  *          <p>For Amazon Web Services Regions that support <code>MeterUsage</code>, see <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#meterusage-region-support-ec2">MeterUsage Region support for Amazon EC2</a> and <a href="https://docs.aws.amazon.com/marketplace/latest/APIReference/metering-regions.html#meterusage-region-support-ecs-eks">MeterUsage Region support for Amazon ECS and Amazon EKS</a>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -71,6 +76,7 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea
  *       ],
  *     },
  *   ],
+ *   ClientToken: "STRING_VALUE",
  * };
  * const command = new MeterUsageCommand(input);
  * const response = await client.send(command);
@@ -95,6 +101,9 @@ export interface MeterUsageCommandOutput extends MeterUsageResult, __MetadataBea
  *             pod for the given {<code>usageDimension</code>, <code>timestamp</code>} with a different
  *                 <code>usageQuantity</code>.</p>
  *
+ * @throws {@link IdempotencyConflictException} (client fault)
+ *  <p>The <code>ClientToken</code> is being used for multiple requests.</p>
+ *
  * @throws {@link InternalServiceErrorException} (server fault)
  *  <p>An internal error has occurred. Retry your request. If the problem persists, post a
  *             message with details on the Amazon Web Services forums.</p>

clients/client-marketplace-metering/src/endpoint/ruleset.ts

@@ -19,8 +19,8 @@ f="endpoint",
 g="tree",
 h="PartitionResult",
 i="stringEquals",
-j={[w]:true,"default":false,"type":"Boolean"},
-k={[w]:false,"type":"String"},
+j={[w]:true,"default":false,"type":"boolean"},
+k={[w]:false,"type":"string"},
 l={[z]:"Endpoint"},
 m={[x]:d,[y]:[{[z]:"UseFIPS"},true]},
 n={[x]:d,[y]:[{[z]:"UseDualStack"},true]},

clients/client-marketplace-metering/src/models/models_0.ts

@@ -55,7 +55,7 @@ export interface UsageAllocation {
 export interface UsageRecord {
   /**
    * <p>Timestamp, in UTC, for which the usage is being reported.</p>
-   *          <p>Your application can meter usage for up to one hour in the past. Make sure the
+   *          <p>Your application can meter usage for up to six hours in the past. Make sure the
    *                 <code>timestamp</code> value is not before the start of the software usage.</p>
    * @public
    */
@@ -454,6 +454,26 @@ export class DuplicateRequestException extends __BaseException {
   }
 }
 
+/**
+ * <p>The <code>ClientToken</code> is being used for multiple requests.</p>
+ * @public
+ */
+export class IdempotencyConflictException extends __BaseException {
+  readonly name: "IdempotencyConflictException" = "IdempotencyConflictException";
+  readonly $fault: "client" = "client";
+  /**
+   * @internal
+   */
+  constructor(opts: __ExceptionOptionType<IdempotencyConflictException, __BaseException>) {
+    super({
+      name: "IdempotencyConflictException",
+      $fault: "client",
+      ...opts,
+    });
+    Object.setPrototypeOf(this, IdempotencyConflictException.prototype);
+  }
+}
+
 /**
  * <p>The endpoint being called is in a Amazon Web Services Region different from your EC2 instance, ECS
  *             task, or EKS pod. The Region of the Metering Service endpoint and the Amazon Web Services Region of
@@ -526,6 +546,21 @@ export interface MeterUsageRequest {
    * @public
    */
   UsageAllocations?: UsageAllocation[] | undefined;
+
+  /**
+   * <p>Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency
+   *          of the request. This lets you safely retry the request without accidentally performing the
+   *          same operation a second time. Passing the same value to a later call to an operation
+   *          requires that you also pass the same value for all other parameters. We recommend that you
+   *          use a <a href="https://wikipedia.org/wiki/Universally_unique_identifier">UUID type of
+   *             value</a>.</p>
+   *          <p>If you don't provide this value, then Amazon Web Services generates a random one for
+   *          you.</p>
+   *          <p>If you retry the operation with the same <code>ClientToken</code>, but with different
+   *          parameters, the retry fails with an <code>IdempotencyConflictException</code> error.</p>
+   * @public
+   */
+  ClientToken?: string | undefined;
 }
 
 /**

clients/client-marketplace-metering/src/protocols/Aws_json1_1.ts

@@ -19,6 +19,7 @@ import {
   ResponseMetadata as __ResponseMetadata,
   SerdeContext as __SerdeContext,
 } from "@smithy/types";
+import { v4 as generateIdempotencyToken } from "@smithy/uuid";
 
 import { BatchMeterUsageCommandInput, BatchMeterUsageCommandOutput } from "../commands/BatchMeterUsageCommand";
 import { MeterUsageCommandInput, MeterUsageCommandOutput } from "../commands/MeterUsageCommand";
@@ -32,6 +33,7 @@ import {
   DisabledApiException,
   DuplicateRequestException,
   ExpiredTokenException,
+  IdempotencyConflictException,
   InternalServiceErrorException,
   InvalidCustomerIdentifierException,
   InvalidEndpointRegionException,
@@ -230,6 +232,9 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext):
     case "DuplicateRequestException":
     case "com.amazonaws.marketplacemetering#DuplicateRequestException":
       throw await de_DuplicateRequestExceptionRes(parsedOutput, context);
+    case "IdempotencyConflictException":
+    case "com.amazonaws.marketplacemetering#IdempotencyConflictException":
+      throw await de_IdempotencyConflictExceptionRes(parsedOutput, context);
     case "InvalidEndpointRegionException":
     case "com.amazonaws.marketplacemetering#InvalidEndpointRegionException":
       throw await de_InvalidEndpointRegionExceptionRes(parsedOutput, context);
@@ -322,6 +327,22 @@ const de_ExpiredTokenExceptionRes = async (
   return __decorateServiceException(exception, body);
 };
 
+/**
+ * deserializeAws_json1_1IdempotencyConflictExceptionRes
+ */
+const de_IdempotencyConflictExceptionRes = async (
+  parsedOutput: any,
+  context: __SerdeContext
+): Promise<IdempotencyConflictException> => {
+  const body = parsedOutput.body;
+  const deserialized: any = _json(body);
+  const exception = new IdempotencyConflictException({
+    $metadata: deserializeMetadata(parsedOutput),
+    ...deserialized,
+  });
+  return __decorateServiceException(exception, body);
+};
+
 /**
  * deserializeAws_json1_1InternalServiceErrorExceptionRes
  */
@@ -539,6 +560,7 @@ const se_BatchMeterUsageRequest = (input: BatchMeterUsageRequest, context: __Ser
  */
 const se_MeterUsageRequest = (input: MeterUsageRequest, context: __SerdeContext): any => {
   return take(input, {
+    ClientToken: [true, (_) => _ ?? generateIdempotencyToken()],
     DryRun: [],
     ProductCode: [],
     Timestamp: (_) => _.getTime() / 1_000,
@@ -603,6 +625,8 @@ const de_BatchMeterUsageResult = (output: any, context: __SerdeContext): BatchMe
 
 // de_ExpiredTokenException omitted.
 
+// de_IdempotencyConflictException omitted.
+
 // de_InternalServiceErrorException omitted.
 
 // de_InvalidCustomerIdentifierException omitted.