sqs-consumer 10.2.1 → 10.3.0

package/.github/workflows/annotate-test-reports.yml

@@ -0,0 +1,32 @@
+name: Annotate CI run with test results
+on:
+  workflow_run:
+    workflows:
+      - "Run Tests"
+    types:
+      - completed
+permissions:
+  actions: read
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  annotate:
+    name: Annotate CI run with test results
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion != 'cancelled' }}
+    strategy:
+       fail-fast: false
+       matrix:
+        node-version: [18.x, 20.x, 22.x]
+    timeout-minutes: 5
+    steps:
+      - name: Annotate CI run with test results
+        uses: dorny/test-reporter@v1
+        with:
+          artifact: test-reports-${{ matrix.node-version }}
+          name: Test Results (${{matrix.node-version}}
+          path: "test-results.json"
+          reporter: mocha-json
+          token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/pr-coverage.yml

@@ -0,0 +1,42 @@
+name: Comment PR Coverage
+on:
+  pull_request:
+    branches:
+      - 'main'
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  coverage_report:
+    name: Generate coverage report
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+
+      - name: Install Node Modules
+        run: npm ci
+
+      - name: Run Coverage Check
+        run: npm run lcov
+
+      - name: Setup LCOV
+        uses: hrishikesh-kadam/setup-lcov@v1
+
+      - name: Report code coverage
+        uses: zgosalvez/github-actions-report-lcov@v3
+        with:
+          coverage-files: coverage/lcov.info
+          minimum-coverage: 90
+          artifact-name: code-coverage-report
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          update-comment: true

package/.github/workflows/test.yml

@@ -8,6 +8,8 @@ on:
       - main
 permissions:
   contents: read
+  checks: write
+  pull-requests: write
 
 jobs:
   build:
@@ -34,7 +36,7 @@ jobs:
       - name: Run Tests and Linting
         run: npm run test
 
-      - uses: actions/upload-artifact@v3
+      - uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.node-version }}
           path: test/reports/

package/CHANGELOG.md

@@ -1,13 +1,12 @@
-## [10.2.1](https://github.com/bbc/sqs-consumer/compare/v10.2.0...v10.2.1) (2024-04-30)
+## [10.3.0](https://github.com/bbc/sqs-consumer/compare/v10.2.1...v10.3.0) (2024-05-08)
 
 
-### Bug Fixes
+### Features
 
-* build exclusive type files ([65008eb](https://github.com/bbc/sqs-consumer/commit/65008ebaab8aecbe806b8e7ab9be809de58518a9))
-* default extension for cjs ([bd9855b](https://github.com/bbc/sqs-consumer/commit/bd9855babedee1ea6506d8fc2901228e1cd31468))
-* types extension for cjs ([8bc6239](https://github.com/bbc/sqs-consumer/commit/8bc62396badf30bcf508309110a782aa6f4b9d8c))
+* add the ability to extend errors from aws ([#496](https://github.com/bbc/sqs-consumer/issues/496)) ([f4b071b](https://github.com/bbc/sqs-consumer/commit/f4b071b05e6cee304fcf866fa813e791338359d2))
 
 
 ### Chores
 
-* updating repro links ([48f452e](https://github.com/bbc/sqs-consumer/commit/48f452ee935a563b3d0c1043b552947da84886ea))
+* enhance ci reports ([#497](https://github.com/bbc/sqs-consumer/issues/497)) ([eded17a](https://github.com/bbc/sqs-consumer/commit/eded17adc06fe8414b7ea0732dd5cac2cd00f7e2))
+* updating test-reporter ([645901d](https://github.com/bbc/sqs-consumer/commit/645901de5c60aa44dc45bc2ac5e5981581004b39))

package/dist/cjs/consumer.d.ts

@@ -29,6 +29,7 @@ export declare class Consumer extends TypedEventEmitter {
     private isPolling;
     private stopRequestedAtTimestamp;
     abortController: AbortController;
+    private extendedAWSErrors;
     constructor(options: ConsumerOptions);
     /**
      * Creates a new SQS consumer.

package/dist/cjs/consumer.js

@@ -36,6 +36,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
         this.pollingCompleteWaitTimeMs = options.pollingCompleteWaitTimeMs ?? 0;
         this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
         this.alwaysAcknowledge = options.alwaysAcknowledge ?? false;
+        this.extendedAWSErrors = options.extendedAWSErrors ?? false;
         this.sqs =
             options.sqs ||
                 new client_sqs_1.SQSClient({
@@ -214,7 +215,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
             return result;
         }
         catch (err) {
-            throw (0, errors_js_1.toSQSError)(err, `SQS receive message failed: ${err.message}`);
+            throw (0, errors_js_1.toSQSError)(err, `SQS receive message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
     /**
@@ -326,7 +327,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
             return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityCommand(input), this.sqsSendOptions);
         }
         catch (err) {
-            this.emit("error", (0, errors_js_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`), message);
+            this.emit("error", (0, errors_js_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`, this.extendedAWSErrors), message);
         }
     }
     /**
@@ -347,7 +348,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
             return await this.sqs.send(new client_sqs_1.ChangeMessageVisibilityBatchCommand(params), this.sqsSendOptions);
         }
         catch (err) {
-            this.emit("error", (0, errors_js_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`), messages);
+            this.emit("error", (0, errors_js_1.toSQSError)(err, `Error changing visibility timeout: ${err.message}`, this.extendedAWSErrors), messages);
         }
     }
     /**
@@ -426,7 +427,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
             await this.sqs.send(new client_sqs_1.DeleteMessageCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
-            throw (0, errors_js_1.toSQSError)(err, `SQS delete message failed: ${err.message}`);
+            throw (0, errors_js_1.toSQSError)(err, `SQS delete message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
     /**
@@ -454,7 +455,7 @@ class Consumer extends emitter_js_1.TypedEventEmitter {
             await this.sqs.send(new client_sqs_1.DeleteMessageBatchCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
-            throw (0, errors_js_1.toSQSError)(err, `SQS delete message failed: ${err.message}`);
+            throw (0, errors_js_1.toSQSError)(err, `SQS delete message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
 }

package/dist/cjs/errors.d.ts

@@ -5,7 +5,9 @@ declare class SQSError extends Error {
     service: string;
     time: Date;
     retryable: boolean;
-    fault: "client" | "server";
+    fault: AWSError["$fault"];
+    response?: AWSError["$response"];
+    metadata?: AWSError["$metadata"];
     constructor(message: string);
 }
 declare class TimeoutError extends Error {
@@ -28,7 +30,7 @@ declare function isConnectionError(err: Error): boolean;
  * @param err The error object that was received.
  * @param message The message to send with the error.
  */
-declare function toSQSError(err: AWSError, message: string): SQSError;
+declare function toSQSError(err: AWSError, message: string, extendedAWSErrors: boolean): SQSError;
 /**
  * Formats an Error to the StandardError type.
  * @param err The error object that was received.

package/dist/cjs/errors.js

@@ -53,7 +53,7 @@ exports.isConnectionError = isConnectionError;
  * @param err The error object that was received.
  * @param message The message to send with the error.
  */
-function toSQSError(err, message) {
+function toSQSError(err, message, extendedAWSErrors) {
     const sqsError = new SQSError(message);
     sqsError.code = err.name;
     sqsError.statusCode = err.$metadata?.httpStatusCode;
@@ -61,6 +61,10 @@ function toSQSError(err, message) {
     sqsError.service = err.$service;
     sqsError.fault = err.$fault;
     sqsError.time = new Date();
+    if (extendedAWSErrors) {
+        sqsError.response = err.$response;
+        sqsError.metadata = err.$metadata;
+    }
     return sqsError;
 }
 exports.toSQSError = toSQSError;

package/dist/cjs/types.d.ts

@@ -139,6 +139,11 @@ export interface ConsumerOptions {
      * example to add middlewares.
      */
     postReceiveMessageCallback?(): Promise<void>;
+    /**
+     * Set this to `true` if you want to receive additional information about the error
+     * that occurred from AWS, such as the response and metadata.
+     */
+    extendedAWSErrors?: boolean;
 }
 /**
  * A subset of the ConsumerOptions that can be updated at runtime.
@@ -222,7 +227,7 @@ export type AWSError = {
     /**
      * Name, eg. ConditionalCheckFailedException
      */
-    name: string;
+    readonly name: string;
     /**
      * Human-readable error response message
      */
@@ -234,7 +239,25 @@ export type AWSError = {
     /**
      * Whether the client or server are at fault.
      */
-    readonly $fault?: "client" | "server";
+    readonly $fault: "client" | "server";
+    /**
+     * Represents an HTTP message as received in reply to a request
+     */
+    readonly $response?: {
+        /**
+         * The status code of the HTTP response.
+         */
+        statusCode?: number;
+        /**
+         * The headers of the HTTP message.
+         */
+        headers: Record<string, string>;
+        /**
+         * The body of the HTTP message.
+         * Can be: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream
+         */
+        body?: any;
+    };
     /**
      * The service that encountered the exception.
      */
@@ -248,32 +271,32 @@ export type AWSError = {
          */
         readonly throttling?: boolean;
     };
-    $metadata?: {
+    readonly $metadata: {
         /**
          * The status code of the last HTTP response received for this operation.
          */
-        httpStatusCode?: number;
+        readonly httpStatusCode?: number;
         /**
          * A unique identifier for the last request sent for this operation. Often
          * requested by AWS service teams to aid in debugging.
          */
-        requestId?: string;
+        readonly requestId?: string;
         /**
          * A secondary identifier for the last request sent. Used for debugging.
          */
-        extendedRequestId?: string;
+        readonly extendedRequestId?: string;
         /**
          * A tertiary identifier for the last request sent. Used for debugging.
          */
-        cfId?: string;
+        readonly cfId?: string;
         /**
          * The number of times this operation was attempted.
          */
-        attempts?: number;
+        readonly attempts?: number;
         /**
          * The total amount of time (in milliseconds) that was spent waiting between
          * retry attempts.
          */
-        totalRetryDelay?: number;
+        readonly totalRetryDelay?: number;
     };
 };

package/dist/esm/consumer.d.ts

@@ -29,6 +29,7 @@ export declare class Consumer extends TypedEventEmitter {
     private isPolling;
     private stopRequestedAtTimestamp;
     abortController: AbortController;
+    private extendedAWSErrors;
     constructor(options: ConsumerOptions);
     /**
      * Creates a new SQS consumer.

package/dist/esm/consumer.js

@@ -33,6 +33,7 @@ export class Consumer extends TypedEventEmitter {
         this.pollingCompleteWaitTimeMs = options.pollingCompleteWaitTimeMs ?? 0;
         this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
         this.alwaysAcknowledge = options.alwaysAcknowledge ?? false;
+        this.extendedAWSErrors = options.extendedAWSErrors ?? false;
         this.sqs =
             options.sqs ||
                 new SQSClient({
@@ -211,7 +212,7 @@ export class Consumer extends TypedEventEmitter {
             return result;
         }
         catch (err) {
-            throw toSQSError(err, `SQS receive message failed: ${err.message}`);
+            throw toSQSError(err, `SQS receive message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
     /**
@@ -323,7 +324,7 @@ export class Consumer extends TypedEventEmitter {
             return await this.sqs.send(new ChangeMessageVisibilityCommand(input), this.sqsSendOptions);
         }
         catch (err) {
-            this.emit("error", toSQSError(err, `Error changing visibility timeout: ${err.message}`), message);
+            this.emit("error", toSQSError(err, `Error changing visibility timeout: ${err.message}`, this.extendedAWSErrors), message);
         }
     }
     /**
@@ -344,7 +345,7 @@ export class Consumer extends TypedEventEmitter {
             return await this.sqs.send(new ChangeMessageVisibilityBatchCommand(params), this.sqsSendOptions);
         }
         catch (err) {
-            this.emit("error", toSQSError(err, `Error changing visibility timeout: ${err.message}`), messages);
+            this.emit("error", toSQSError(err, `Error changing visibility timeout: ${err.message}`, this.extendedAWSErrors), messages);
         }
     }
     /**
@@ -423,7 +424,7 @@ export class Consumer extends TypedEventEmitter {
             await this.sqs.send(new DeleteMessageCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
-            throw toSQSError(err, `SQS delete message failed: ${err.message}`);
+            throw toSQSError(err, `SQS delete message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
     /**
@@ -451,7 +452,7 @@ export class Consumer extends TypedEventEmitter {
             await this.sqs.send(new DeleteMessageBatchCommand(deleteParams), this.sqsSendOptions);
         }
         catch (err) {
-            throw toSQSError(err, `SQS delete message failed: ${err.message}`);
+            throw toSQSError(err, `SQS delete message failed: ${err.message}`, this.extendedAWSErrors);
         }
     }
 }

package/dist/esm/errors.d.ts

@@ -5,7 +5,9 @@ declare class SQSError extends Error {
     service: string;
     time: Date;
     retryable: boolean;
-    fault: "client" | "server";
+    fault: AWSError["$fault"];
+    response?: AWSError["$response"];
+    metadata?: AWSError["$metadata"];
     constructor(message: string);
 }
 declare class TimeoutError extends Error {
@@ -28,7 +30,7 @@ declare function isConnectionError(err: Error): boolean;
  * @param err The error object that was received.
  * @param message The message to send with the error.
  */
-declare function toSQSError(err: AWSError, message: string): SQSError;
+declare function toSQSError(err: AWSError, message: string, extendedAWSErrors: boolean): SQSError;
 /**
  * Formats an Error to the StandardError type.
  * @param err The error object that was received.

package/dist/esm/errors.js

@@ -47,7 +47,7 @@ function isConnectionError(err) {
  * @param err The error object that was received.
  * @param message The message to send with the error.
  */
-function toSQSError(err, message) {
+function toSQSError(err, message, extendedAWSErrors) {
     const sqsError = new SQSError(message);
     sqsError.code = err.name;
     sqsError.statusCode = err.$metadata?.httpStatusCode;
@@ -55,6 +55,10 @@ function toSQSError(err, message) {
     sqsError.service = err.$service;
     sqsError.fault = err.$fault;
     sqsError.time = new Date();
+    if (extendedAWSErrors) {
+        sqsError.response = err.$response;
+        sqsError.metadata = err.$metadata;
+    }
     return sqsError;
 }
 /**

package/dist/esm/types.d.ts

@@ -139,6 +139,11 @@ export interface ConsumerOptions {
      * example to add middlewares.
      */
     postReceiveMessageCallback?(): Promise<void>;
+    /**
+     * Set this to `true` if you want to receive additional information about the error
+     * that occurred from AWS, such as the response and metadata.
+     */
+    extendedAWSErrors?: boolean;
 }
 /**
  * A subset of the ConsumerOptions that can be updated at runtime.
@@ -222,7 +227,7 @@ export type AWSError = {
     /**
      * Name, eg. ConditionalCheckFailedException
      */
-    name: string;
+    readonly name: string;
     /**
      * Human-readable error response message
      */
@@ -234,7 +239,25 @@ export type AWSError = {
     /**
      * Whether the client or server are at fault.
      */
-    readonly $fault?: "client" | "server";
+    readonly $fault: "client" | "server";
+    /**
+     * Represents an HTTP message as received in reply to a request
+     */
+    readonly $response?: {
+        /**
+         * The status code of the HTTP response.
+         */
+        statusCode?: number;
+        /**
+         * The headers of the HTTP message.
+         */
+        headers: Record<string, string>;
+        /**
+         * The body of the HTTP message.
+         * Can be: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream
+         */
+        body?: any;
+    };
     /**
      * The service that encountered the exception.
      */
@@ -248,32 +271,32 @@ export type AWSError = {
          */
         readonly throttling?: boolean;
     };
-    $metadata?: {
+    readonly $metadata: {
         /**
          * The status code of the last HTTP response received for this operation.
          */
-        httpStatusCode?: number;
+        readonly httpStatusCode?: number;
         /**
          * A unique identifier for the last request sent for this operation. Often
          * requested by AWS service teams to aid in debugging.
          */
-        requestId?: string;
+        readonly requestId?: string;
         /**
          * A secondary identifier for the last request sent. Used for debugging.
          */
-        extendedRequestId?: string;
+        readonly extendedRequestId?: string;
         /**
          * A tertiary identifier for the last request sent. Used for debugging.
          */
-        cfId?: string;
+        readonly cfId?: string;
         /**
          * The number of times this operation was attempted.
          */
-        attempts?: number;
+        readonly attempts?: number;
         /**
          * The total amount of time (in milliseconds) that was spent waiting between
          * retry attempts.
          */
-        totalRetryDelay?: number;
+        readonly totalRetryDelay?: number;
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqs-consumer",
-  "version": "10.2.1",
+  "version": "10.3.0",
   "description": "Build SQS-based Node applications without the boilerplate",
   "type": "module",
   "main": "dist/cjs/index.js",
@@ -27,7 +27,7 @@
     "build": "npm run clean && npm run compile && npm run add-package-jsons",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build",
-    "test:unit": "mocha --recursive --full-trace --exit",
+    "test:unit": "mocha --recursive --full-trace --exit --reporter json > test/reports/test-results.json",
     "pretest:integration:init": "npm run build",
     "test:integration:init": "sh ./test/scripts/initIntTests.sh",
     "test:integration": "npm run test:integration:init && cucumber-js --config ./test/config/cucumber.mjs",

package/src/consumer.ts

@@ -58,6 +58,7 @@ export class Consumer extends TypedEventEmitter {
   private isPolling = false;
   private stopRequestedAtTimestamp: number;
   public abortController: AbortController;
+  private extendedAWSErrors: boolean;
 
   constructor(options: ConsumerOptions) {
     super();
@@ -82,6 +83,7 @@ export class Consumer extends TypedEventEmitter {
     this.pollingCompleteWaitTimeMs = options.pollingCompleteWaitTimeMs ?? 0;
     this.shouldDeleteMessages = options.shouldDeleteMessages ?? true;
     this.alwaysAcknowledge = options.alwaysAcknowledge ?? false;
+    this.extendedAWSErrors = options.extendedAWSErrors ?? false;
     this.sqs =
       options.sqs ||
       new SQSClient({
@@ -297,7 +299,11 @@ export class Consumer extends TypedEventEmitter {
 
       return result;
     } catch (err) {
-      throw toSQSError(err, `SQS receive message failed: ${err.message}`);
+      throw toSQSError(
+        err,
+        `SQS receive message failed: ${err.message}`,
+        this.extendedAWSErrors,
+      );
     }
   }
 
@@ -439,7 +445,11 @@ export class Consumer extends TypedEventEmitter {
     } catch (err) {
       this.emit(
         "error",
-        toSQSError(err, `Error changing visibility timeout: ${err.message}`),
+        toSQSError(
+          err,
+          `Error changing visibility timeout: ${err.message}`,
+          this.extendedAWSErrors,
+        ),
         message,
       );
     }
@@ -470,7 +480,11 @@ export class Consumer extends TypedEventEmitter {
     } catch (err) {
       this.emit(
         "error",
-        toSQSError(err, `Error changing visibility timeout: ${err.message}`),
+        toSQSError(
+          err,
+          `Error changing visibility timeout: ${err.message}`,
+          this.extendedAWSErrors,
+        ),
         messages,
       );
     }
@@ -567,7 +581,11 @@ export class Consumer extends TypedEventEmitter {
         this.sqsSendOptions,
       );
     } catch (err) {
-      throw toSQSError(err, `SQS delete message failed: ${err.message}`);
+      throw toSQSError(
+        err,
+        `SQS delete message failed: ${err.message}`,
+        this.extendedAWSErrors,
+      );
     }
   }
 
@@ -601,7 +619,11 @@ export class Consumer extends TypedEventEmitter {
         this.sqsSendOptions,
       );
     } catch (err) {
-      throw toSQSError(err, `SQS delete message failed: ${err.message}`);
+      throw toSQSError(
+        err,
+        `SQS delete message failed: ${err.message}`,
+        this.extendedAWSErrors,
+      );
     }
   }
 }

package/src/errors.ts

@@ -6,7 +6,9 @@ class SQSError extends Error {
   service: string;
   time: Date;
   retryable: boolean;
-  fault: "client" | "server";
+  fault: AWSError["$fault"];
+  response?: AWSError["$response"];
+  metadata?: AWSError["$metadata"];
 
   constructor(message: string) {
     super(message);
@@ -67,7 +69,11 @@ function isConnectionError(err: Error): boolean {
  * @param err The error object that was received.
  * @param message The message to send with the error.
  */
-function toSQSError(err: AWSError, message: string): SQSError {
+function toSQSError(
+  err: AWSError,
+  message: string,
+  extendedAWSErrors: boolean,
+): SQSError {
   const sqsError = new SQSError(message);
   sqsError.code = err.name;
   sqsError.statusCode = err.$metadata?.httpStatusCode;
@@ -76,6 +82,11 @@ function toSQSError(err: AWSError, message: string): SQSError {
   sqsError.fault = err.$fault;
   sqsError.time = new Date();
 
+  if (extendedAWSErrors) {
+    sqsError.response = err.$response;
+    sqsError.metadata = err.$metadata;
+  }
+
   return sqsError;
 }
 

package/src/types.ts

@@ -140,6 +140,11 @@ export interface ConsumerOptions {
    * example to add middlewares.
    */
   postReceiveMessageCallback?(): Promise<void>;
+  /**
+   * Set this to `true` if you want to receive additional information about the error
+   * that occurred from AWS, such as the response and metadata.
+   */
+  extendedAWSErrors?: boolean;
 }
 
 /**
@@ -231,7 +236,7 @@ export type AWSError = {
   /**
    * Name, eg. ConditionalCheckFailedException
    */
-  name: string;
+  readonly name: string;
 
   /**
    * Human-readable error response message
@@ -246,7 +251,26 @@ export type AWSError = {
   /**
    * Whether the client or server are at fault.
    */
-  readonly $fault?: "client" | "server";
+  readonly $fault: "client" | "server";
+
+  /**
+   * Represents an HTTP message as received in reply to a request
+   */
+  readonly $response?: {
+    /**
+     * The status code of the HTTP response.
+     */
+    statusCode?: number;
+    /**
+     * The headers of the HTTP message.
+     */
+    headers: Record<string, string>;
+    /**
+     * The body of the HTTP message.
+     * Can be: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream
+     */
+    body?: any;
+  };
 
   /**
    * The service that encountered the exception.
@@ -263,37 +287,37 @@ export type AWSError = {
     readonly throttling?: boolean;
   };
 
-  $metadata?: {
+  readonly $metadata: {
     /**
      * The status code of the last HTTP response received for this operation.
      */
-    httpStatusCode?: number;
+    readonly httpStatusCode?: number;
 
     /**
      * A unique identifier for the last request sent for this operation. Often
      * requested by AWS service teams to aid in debugging.
      */
-    requestId?: string;
+    readonly requestId?: string;
 
     /**
      * A secondary identifier for the last request sent. Used for debugging.
      */
-    extendedRequestId?: string;
+    readonly extendedRequestId?: string;
 
     /**
      * A tertiary identifier for the last request sent. Used for debugging.
      */
-    cfId?: string;
+    readonly cfId?: string;
 
     /**
      * The number of times this operation was attempted.
      */
-    attempts?: number;
+    readonly attempts?: number;
 
     /**
      * The total amount of time (in milliseconds) that was spent waiting between
      * retry attempts.
      */
-    totalRetryDelay?: number;
+    readonly totalRetryDelay?: number;
   };
 };