feat(client-fis): This release adds support for previewing target res…

…ources before running a FIS experiment. It also adds resource ARNs for actions, experiments, and experiment templates to API responses.
aws · Mar 14, 2024 · 4620a92 · 4620a92
1 parent 7cde1da
commit 4620a92
Show file tree

Hide file tree

Showing 19 changed files with 251 additions and 39 deletions.
diff --git a/clients/client-fis/README.md b/clients/client-fis/README.md
@@ -6,8 +6,8 @@
 
 AWS SDK for JavaScript Fis Client for Node.js, Browser and React Native.
 
-<p>Fault Injection Simulator 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 Simulator User Guide</a>.</p>
+<p>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
@@ -512,8 +512,8 @@ export interface Fis {
 
 /**
  * @public
- * <p>Fault Injection Simulator 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 Simulator User Guide</a>.</p>
+ * <p>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>
  */
 export class Fis extends FisClient implements Fis {}
 createAggregatedClient(commands, Fis);
diff --git a/clients/client-fis/src/FisClient.ts b/clients/client-fis/src/FisClient.ts
@@ -367,8 +367,8 @@ export interface FisClientResolvedConfig extends FisClientResolvedConfigType {}
 
 /**
  * @public
- * <p>Fault Injection Simulator 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 Simulator User Guide</a>.</p>
+ * <p>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>
  */
 export class FisClient extends __Client<
   __HttpHandlerOptions,

diff --git a/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts b/clients/client-fis/src/commands/CreateExperimentTemplateCommand.ts
@@ -50,7 +50,7 @@ export interface CreateExperimentTemplateCommandOutput extends CreateExperimentT
  *             </li>
  *          </ul>
  *          <p>For more information, see <a href="https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html">experiment templates</a>
- *          in the <i>Fault Injection Simulator User Guide</i>.</p>
+ *          in the <i>Fault Injection Service User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -128,6 +128,7 @@ export interface CreateExperimentTemplateCommandOutput extends CreateExperimentT
  * // { // CreateExperimentTemplateResponse
  * //   experimentTemplate: { // ExperimentTemplate
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     description: "STRING_VALUE",
  * //     targets: { // ExperimentTemplateTargetMap
  * //       "<keys>": { // ExperimentTemplateTarget

diff --git a/clients/client-fis/src/commands/CreateTargetAccountConfigurationCommand.ts b/clients/client-fis/src/commands/CreateTargetAccountConfigurationCommand.ts
@@ -36,7 +36,7 @@ export interface CreateTargetAccountConfigurationCommandOutput
  * <p>Creates a target account configuration for the experiment template. A target account configuration
  *       is required when <code>accountTargeting</code> of <code>experimentOptions</code> is set to <code>multi-account</code>.
  *       For more information, see <a href="https://docs.aws.amazon.com/fis/latest/userguide/experiment-options.html">experiment options</a>
- *       in the <i>Fault Injection Simulator User Guide</i>.
+ *       in the <i>Fault Injection Service User Guide</i>.
  *       </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-fis/src/commands/DeleteExperimentTemplateCommand.ts b/clients/client-fis/src/commands/DeleteExperimentTemplateCommand.ts
@@ -43,6 +43,7 @@ export interface DeleteExperimentTemplateCommandOutput extends DeleteExperimentT
  * // { // DeleteExperimentTemplateResponse
  * //   experimentTemplate: { // ExperimentTemplate
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     description: "STRING_VALUE",
  * //     targets: { // ExperimentTemplateTargetMap
  * //       "<keys>": { // ExperimentTemplateTarget

diff --git a/clients/client-fis/src/commands/GetActionCommand.ts b/clients/client-fis/src/commands/GetActionCommand.ts
@@ -43,6 +43,7 @@ export interface GetActionCommandOutput extends GetActionResponse, __MetadataBea
  * // { // GetActionResponse
  * //   action: { // Action
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     description: "STRING_VALUE",
  * //     parameters: { // ActionParameterMap
  * //       "<keys>": { // ActionParameter

diff --git a/clients/client-fis/src/commands/GetExperimentCommand.ts b/clients/client-fis/src/commands/GetExperimentCommand.ts
@@ -43,6 +43,7 @@ export interface GetExperimentCommandOutput extends GetExperimentResponse, __Met
  * // { // GetExperimentResponse
  * //   experiment: { // Experiment
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     experimentTemplateId: "STRING_VALUE",
  * //     roleArn: "STRING_VALUE",
  * //     state: { // ExperimentState
@@ -118,6 +119,7 @@ export interface GetExperimentCommandOutput extends GetExperimentResponse, __Met
  * //     experimentOptions: { // ExperimentOptions
  * //       accountTargeting: "single-account" || "multi-account",
  * //       emptyTargetResolutionMode: "fail" || "skip",
+ * //       actionsMode: "skip-all" || "run-all",
  * //     },
  * //     targetAccountConfigurationsCount: Number("long"),
  * //   },

diff --git a/clients/client-fis/src/commands/GetExperimentTemplateCommand.ts b/clients/client-fis/src/commands/GetExperimentTemplateCommand.ts
@@ -43,6 +43,7 @@ export interface GetExperimentTemplateCommandOutput extends GetExperimentTemplat
  * // { // GetExperimentTemplateResponse
  * //   experimentTemplate: { // ExperimentTemplate
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     description: "STRING_VALUE",
  * //     targets: { // ExperimentTemplateTargetMap
  * //       "<keys>": { // ExperimentTemplateTarget

diff --git a/clients/client-fis/src/commands/ListActionsCommand.ts b/clients/client-fis/src/commands/ListActionsCommand.ts
@@ -45,6 +45,7 @@ export interface ListActionsCommandOutput extends ListActionsResponse, __Metadat
  * //   actions: [ // ActionSummaryList
  * //     { // ActionSummary
  * //       id: "STRING_VALUE",
+ * //       arn: "STRING_VALUE",
  * //       description: "STRING_VALUE",
  * //       targets: { // ActionTargetMap
  * //         "<keys>": { // ActionTarget

diff --git a/clients/client-fis/src/commands/ListExperimentTemplatesCommand.ts b/clients/client-fis/src/commands/ListExperimentTemplatesCommand.ts
@@ -45,6 +45,7 @@ export interface ListExperimentTemplatesCommandOutput extends ListExperimentTemp
  * //   experimentTemplates: [ // ExperimentTemplateSummaryList
  * //     { // ExperimentTemplateSummary
  * //       id: "STRING_VALUE",
+ * //       arn: "STRING_VALUE",
  * //       description: "STRING_VALUE",
  * //       creationTime: new Date("TIMESTAMP"),
  * //       lastUpdateTime: new Date("TIMESTAMP"),

diff --git a/clients/client-fis/src/commands/ListExperimentsCommand.ts b/clients/client-fis/src/commands/ListExperimentsCommand.ts
@@ -38,13 +38,15 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _
  * const input = { // ListExperimentsRequest
  *   maxResults: Number("int"),
  *   nextToken: "STRING_VALUE",
+ *   experimentTemplateId: "STRING_VALUE",
  * };
  * const command = new ListExperimentsCommand(input);
  * const response = await client.send(command);
  * // { // ListExperimentsResponse
  * //   experiments: [ // ExperimentSummaryList
  * //     { // ExperimentSummary
  * //       id: "STRING_VALUE",
+ * //       arn: "STRING_VALUE",
  * //       experimentTemplateId: "STRING_VALUE",
  * //       state: { // ExperimentState
  * //         status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
@@ -54,6 +56,11 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _
  * //       tags: { // TagMap
  * //         "<keys>": "STRING_VALUE",
  * //       },
+ * //       experimentOptions: { // ExperimentOptions
+ * //         accountTargeting: "single-account" || "multi-account",
+ * //         emptyTargetResolutionMode: "fail" || "skip",
+ * //         actionsMode: "skip-all" || "run-all",
+ * //       },
  * //     },
  * //   ],
  * //   nextToken: "STRING_VALUE",

diff --git a/clients/client-fis/src/commands/StartExperimentCommand.ts b/clients/client-fis/src/commands/StartExperimentCommand.ts
@@ -38,6 +38,9 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _
  * const input = { // StartExperimentRequest
  *   clientToken: "STRING_VALUE", // required
  *   experimentTemplateId: "STRING_VALUE", // required
+ *   experimentOptions: { // StartExperimentExperimentOptionsInput
+ *     actionsMode: "skip-all" || "run-all",
+ *   },
  *   tags: { // TagMap
  *     "<keys>": "STRING_VALUE",
  *   },
@@ -47,6 +50,7 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _
  * // { // StartExperimentResponse
  * //   experiment: { // Experiment
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     experimentTemplateId: "STRING_VALUE",
  * //     roleArn: "STRING_VALUE",
  * //     state: { // ExperimentState
@@ -122,6 +126,7 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _
  * //     experimentOptions: { // ExperimentOptions
  * //       accountTargeting: "single-account" || "multi-account",
  * //       emptyTargetResolutionMode: "fail" || "skip",
+ * //       actionsMode: "skip-all" || "run-all",
  * //     },
  * //     targetAccountConfigurationsCount: Number("long"),
  * //   },

diff --git a/clients/client-fis/src/commands/StopExperimentCommand.ts b/clients/client-fis/src/commands/StopExperimentCommand.ts
@@ -43,6 +43,7 @@ export interface StopExperimentCommandOutput extends StopExperimentResponse, __M
  * // { // StopExperimentResponse
  * //   experiment: { // Experiment
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     experimentTemplateId: "STRING_VALUE",
  * //     roleArn: "STRING_VALUE",
  * //     state: { // ExperimentState
@@ -118,6 +119,7 @@ export interface StopExperimentCommandOutput extends StopExperimentResponse, __M
  * //     experimentOptions: { // ExperimentOptions
  * //       accountTargeting: "single-account" || "multi-account",
  * //       emptyTargetResolutionMode: "fail" || "skip",
+ * //       actionsMode: "skip-all" || "run-all",
  * //     },
  * //     targetAccountConfigurationsCount: Number("long"),
  * //   },

diff --git a/clients/client-fis/src/commands/UpdateExperimentTemplateCommand.ts b/clients/client-fis/src/commands/UpdateExperimentTemplateCommand.ts
@@ -102,6 +102,7 @@ export interface UpdateExperimentTemplateCommandOutput extends UpdateExperimentT
  * // { // UpdateExperimentTemplateResponse
  * //   experimentTemplate: { // ExperimentTemplate
  * //     id: "STRING_VALUE",
+ * //     arn: "STRING_VALUE",
  * //     description: "STRING_VALUE",
  * //     targets: { // ExperimentTemplateTargetMap
  * //       "<keys>": { // ExperimentTemplateTarget

diff --git a/clients/client-fis/src/index.ts b/clients/client-fis/src/index.ts
@@ -1,8 +1,8 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>Fault Injection Simulator 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 Simulator User Guide</a>.</p>
+ * <p>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
  */