feat(client-fis): This release adds support for additional error info…

…rmation on experiment failure. It adds the error code, location, and account id on relevant failures to the GetExperiment and ListExperiment API responses.
aws · Aug 13, 2024 · d69b927 · d69b927
1 parent 26788b9
commit d69b927
Show file tree

Hide file tree

Showing 11 changed files with 105 additions and 5 deletions.
diff --git a/clients/client-fis/README.md b/clients/client-fis/README.md
@@ -6,7 +6,7 @@
 
 AWS SDK for JavaScript Fis Client for Node.js, Browser and React Native.
 
-<p>Fault Injection Service is a managed service that enables you to perform fault injection
+<p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
 experiments on your Amazon Web Services workloads. For more information, see the <a href="https://docs.aws.amazon.com/fis/latest/userguide/">Fault Injection Service User Guide</a>.</p>
 
 ## Installing

diff --git a/clients/client-fis/src/Fis.ts b/clients/client-fis/src/Fis.ts
@@ -515,7 +515,7 @@ export interface Fis {
 }
 
 /**
- * <p>Fault Injection Service is a managed service that enables you to perform fault injection
+ * <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
  *            experiments on your Amazon Web Services workloads. For more information, see the <a href="https://docs.aws.amazon.com/fis/latest/userguide/">Fault Injection Service User Guide</a>.</p>
  * @public
  */

diff --git a/clients/client-fis/src/FisClient.ts b/clients/client-fis/src/FisClient.ts
@@ -366,7 +366,7 @@ export type FisClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
 export interface FisClientResolvedConfig extends FisClientResolvedConfigType {}
 
 /**
- * <p>Fault Injection Service is a managed service that enables you to perform fault injection
+ * <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
  *            experiments on your Amazon Web Services workloads. For more information, see the <a href="https://docs.aws.amazon.com/fis/latest/userguide/">Fault Injection Service User Guide</a>.</p>
  * @public
  */

diff --git a/clients/client-fis/src/commands/GetExperimentCommand.ts b/clients/client-fis/src/commands/GetExperimentCommand.ts
@@ -49,6 +49,11 @@ export interface GetExperimentCommandOutput extends GetExperimentResponse, __Met
  * //     state: { // ExperimentState
  * //       status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
  * //       reason: "STRING_VALUE",
+ * //       error: { // ExperimentError
+ * //         accountId: "STRING_VALUE",
+ * //         code: "STRING_VALUE",
+ * //         location: "STRING_VALUE",
+ * //       },
  * //     },
  * //     targets: { // ExperimentTargetMap
  * //       "<keys>": { // ExperimentTarget

diff --git a/clients/client-fis/src/commands/ListExperimentsCommand.ts b/clients/client-fis/src/commands/ListExperimentsCommand.ts
@@ -51,6 +51,11 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _
  * //       state: { // ExperimentState
  * //         status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
  * //         reason: "STRING_VALUE",
+ * //         error: { // ExperimentError
+ * //           accountId: "STRING_VALUE",
+ * //           code: "STRING_VALUE",
+ * //           location: "STRING_VALUE",
+ * //         },
  * //       },
  * //       creationTime: new Date("TIMESTAMP"),
  * //       tags: { // TagMap

diff --git a/clients/client-fis/src/commands/StartExperimentCommand.ts b/clients/client-fis/src/commands/StartExperimentCommand.ts
@@ -56,6 +56,11 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _
  * //     state: { // ExperimentState
  * //       status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
  * //       reason: "STRING_VALUE",
+ * //       error: { // ExperimentError
+ * //         accountId: "STRING_VALUE",
+ * //         code: "STRING_VALUE",
+ * //         location: "STRING_VALUE",
+ * //       },
  * //     },
  * //     targets: { // ExperimentTargetMap
  * //       "<keys>": { // ExperimentTarget

diff --git a/clients/client-fis/src/commands/StopExperimentCommand.ts b/clients/client-fis/src/commands/StopExperimentCommand.ts
@@ -49,6 +49,11 @@ export interface StopExperimentCommandOutput extends StopExperimentResponse, __M
  * //     state: { // ExperimentState
  * //       status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
  * //       reason: "STRING_VALUE",
+ * //       error: { // ExperimentError
+ * //         accountId: "STRING_VALUE",
+ * //         code: "STRING_VALUE",
+ * //         location: "STRING_VALUE",
+ * //       },
  * //     },
  * //     targets: { // ExperimentTargetMap
  * //       "<keys>": { // ExperimentTarget

diff --git a/clients/client-fis/src/index.ts b/clients/client-fis/src/index.ts
@@ -1,7 +1,7 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>Fault Injection Service is a managed service that enables you to perform fault injection
+ * <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
  *            experiments on your Amazon Web Services workloads. For more information, see the <a href="https://docs.aws.amazon.com/fis/latest/userguide/">Fault Injection Service User Guide</a>.</p>
  *
  * @packageDocumentation

diff --git a/clients/client-fis/src/models/models_0.ts b/clients/client-fis/src/models/models_0.ts
@@ -1074,6 +1074,30 @@ export interface ExperimentLogConfiguration {
   logSchemaVersion?: number;
 }
 
+/**
+ * <p>Describes the error when an experiment has <code>failed</code>.</p>
+ * @public
+ */
+export interface ExperimentError {
+  /**
+   * <p>The Amazon Web Services Account ID where the experiment failure occurred.</p>
+   * @public
+   */
+  accountId?: string;
+
+  /**
+   * <p>The error code for the failed experiment.</p>
+   * @public
+   */
+  code?: string;
+
+  /**
+   * <p>Context for the section of the experiment template that failed.</p>
+   * @public
+   */
+  location?: string;
+}
+
 /**
  * @public
  * @enum
@@ -1109,6 +1133,12 @@ export interface ExperimentState {
    * @public
    */
   reason?: string;
+
+  /**
+   * <p>The error information of the experiment when the action has <code>failed</code>.</p>
+   * @public
+   */
+  error?: ExperimentError;
 }
 
 /**

diff --git a/clients/client-fis/src/protocols/Aws_restJson1.ts b/clients/client-fis/src/protocols/Aws_restJson1.ts
@@ -1343,6 +1343,8 @@ const de_ExperimentActionMap = (output: any, context: __SerdeContext): Record<st
 
 // de_ExperimentCloudWatchLogsLogConfiguration omitted.
 
+// de_ExperimentError omitted.
+
 // de_ExperimentLogConfiguration omitted.
 
 // de_ExperimentOptions omitted.

diff --git a/codegen/sdk-codegen/aws-models/fis.json b/codegen/sdk-codegen/aws-models/fis.json
@@ -1183,6 +1183,48 @@
     "com.amazonaws.fis#ExperimentEndTime": {
       "type": "timestamp"
     },
+    "com.amazonaws.fis#ExperimentError": {
+      "type": "structure",
+      "members": {
+        "accountId": {
+          "target": "com.amazonaws.fis#ExperimentErrorAccountId",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Web Services Account ID where the experiment failure occurred.</p>"
+          }
+        },
+        "code": {
+          "target": "com.amazonaws.fis#ExperimentErrorCode",
+          "traits": {
+            "smithy.api#documentation": "<p>The error code for the failed experiment.</p>"
+          }
+        },
+        "location": {
+          "target": "com.amazonaws.fis#ExperimentErrorLocation",
+          "traits": {
+            "smithy.api#documentation": "<p>Context for the section of the experiment template that failed.</p>"
+          }
+        }
+      },
+      "traits": {
+        "smithy.api#documentation": "<p>Describes the error when an experiment has <code>failed</code>.</p>"
+      }
+    },
+    "com.amazonaws.fis#ExperimentErrorAccountId": {
+      "type": "string"
+    },
+    "com.amazonaws.fis#ExperimentErrorCode": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 0,
+          "max": 128
+        },
+        "smithy.api#pattern": "^[\\S]+$"
+      }
+    },
+    "com.amazonaws.fis#ExperimentErrorLocation": {
+      "type": "string"
+    },
     "com.amazonaws.fis#ExperimentId": {
       "type": "string",
       "traits": {
@@ -1282,6 +1324,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The reason for the state.</p>"
           }
+        },
+        "error": {
+          "target": "com.amazonaws.fis#ExperimentError",
+          "traits": {
+            "smithy.api#documentation": "<p>The error information of the experiment when the action has <code>failed</code>.</p>"
+          }
         }
       },
       "traits": {
@@ -2338,7 +2386,7 @@
           "name": "fis"
         },
         "aws.protocols#restJson1": {},
-        "smithy.api#documentation": "<p>Fault Injection Service is a managed service that enables you to perform fault injection \n           experiments on your Amazon Web Services workloads. For more information, see the <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/\">Fault Injection Service User Guide</a>.</p>",
+        "smithy.api#documentation": "<p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection \n           experiments on your Amazon Web Services workloads. For more information, see the <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/\">Fault Injection Service User Guide</a>.</p>",
         "smithy.api#title": "AWS Fault Injection Simulator",
         "smithy.rules#endpointRuleSet": {
           "version": "1.0",