Skip to content

Commit d69b927

Browse files
author
awstools
committed
feat(client-fis): This release adds support for additional error information on experiment failure. It adds the error code, location, and account id on relevant failures to the GetExperiment and ListExperiment API responses.
1 parent 26788b9 commit d69b927

File tree

11 files changed

+105
-5
lines changed

11 files changed

+105
-5
lines changed

‎clients/client-fis/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
AWS SDK for JavaScript Fis Client for Node.js, Browser and React Native.
88

9-
<p>Fault Injection Service is a managed service that enables you to perform fault injection
9+
<p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
1010
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>
1111

1212
## Installing

‎clients/client-fis/src/Fis.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ export interface Fis {
515515
}
516516

517517
/**
518-
* <p>Fault Injection Service is a managed service that enables you to perform fault injection
518+
* <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
519519
* 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>
520520
* @public
521521
*/

‎clients/client-fis/src/FisClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ export type FisClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHa
366366
export interface FisClientResolvedConfig extends FisClientResolvedConfigType {}
367367

368368
/**
369-
* <p>Fault Injection Service is a managed service that enables you to perform fault injection
369+
* <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
370370
* 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>
371371
* @public
372372
*/

‎clients/client-fis/src/commands/GetExperimentCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ export interface GetExperimentCommandOutput extends GetExperimentResponse, __Met
4949
* // state: { // ExperimentState
5050
* // status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
5151
* // reason: "STRING_VALUE",
52+
* // error: { // ExperimentError
53+
* // accountId: "STRING_VALUE",
54+
* // code: "STRING_VALUE",
55+
* // location: "STRING_VALUE",
56+
* // },
5257
* // },
5358
* // targets: { // ExperimentTargetMap
5459
* // "<keys>": { // ExperimentTarget

‎clients/client-fis/src/commands/ListExperimentsCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,11 @@ export interface ListExperimentsCommandOutput extends ListExperimentsResponse, _
5151
* // state: { // ExperimentState
5252
* // status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
5353
* // reason: "STRING_VALUE",
54+
* // error: { // ExperimentError
55+
* // accountId: "STRING_VALUE",
56+
* // code: "STRING_VALUE",
57+
* // location: "STRING_VALUE",
58+
* // },
5459
* // },
5560
* // creationTime: new Date("TIMESTAMP"),
5661
* // tags: { // TagMap

‎clients/client-fis/src/commands/StartExperimentCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,11 @@ export interface StartExperimentCommandOutput extends StartExperimentResponse, _
5656
* // state: { // ExperimentState
5757
* // status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
5858
* // reason: "STRING_VALUE",
59+
* // error: { // ExperimentError
60+
* // accountId: "STRING_VALUE",
61+
* // code: "STRING_VALUE",
62+
* // location: "STRING_VALUE",
63+
* // },
5964
* // },
6065
* // targets: { // ExperimentTargetMap
6166
* // "<keys>": { // ExperimentTarget

‎clients/client-fis/src/commands/StopExperimentCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ export interface StopExperimentCommandOutput extends StopExperimentResponse, __M
4949
* // state: { // ExperimentState
5050
* // status: "pending" || "initiating" || "running" || "completed" || "stopping" || "stopped" || "failed",
5151
* // reason: "STRING_VALUE",
52+
* // error: { // ExperimentError
53+
* // accountId: "STRING_VALUE",
54+
* // code: "STRING_VALUE",
55+
* // location: "STRING_VALUE",
56+
* // },
5257
* // },
5358
* // targets: { // ExperimentTargetMap
5459
* // "<keys>": { // ExperimentTarget

‎clients/client-fis/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>Fault Injection Service is a managed service that enables you to perform fault injection
4+
* <p>Amazon Web Services Fault Injection Service is a managed service that enables you to perform fault injection
55
* 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>
66
*
77
* @packageDocumentation

‎clients/client-fis/src/models/models_0.ts

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1074,6 +1074,30 @@ export interface ExperimentLogConfiguration {
10741074
logSchemaVersion?: number;
10751075
}
10761076

1077+
/**
1078+
* <p>Describes the error when an experiment has <code>failed</code>.</p>
1079+
* @public
1080+
*/
1081+
export interface ExperimentError {
1082+
/**
1083+
* <p>The Amazon Web Services Account ID where the experiment failure occurred.</p>
1084+
* @public
1085+
*/
1086+
accountId?: string;
1087+
1088+
/**
1089+
* <p>The error code for the failed experiment.</p>
1090+
* @public
1091+
*/
1092+
code?: string;
1093+
1094+
/**
1095+
* <p>Context for the section of the experiment template that failed.</p>
1096+
* @public
1097+
*/
1098+
location?: string;
1099+
}
1100+
10771101
/**
10781102
* @public
10791103
* @enum
@@ -1109,6 +1133,12 @@ export interface ExperimentState {
11091133
* @public
11101134
*/
11111135
reason?: string;
1136+
1137+
/**
1138+
* <p>The error information of the experiment when the action has <code>failed</code>.</p>
1139+
* @public
1140+
*/
1141+
error?: ExperimentError;
11121142
}
11131143

11141144
/**

‎clients/client-fis/src/protocols/Aws_restJson1.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1343,6 +1343,8 @@ const de_ExperimentActionMap = (output: any, context: __SerdeContext): Record<st
13431343

13441344
// de_ExperimentCloudWatchLogsLogConfiguration omitted.
13451345

1346+
// de_ExperimentError omitted.
1347+
13461348
// de_ExperimentLogConfiguration omitted.
13471349

13481350
// de_ExperimentOptions omitted.

‎codegen/sdk-codegen/aws-models/fis.json

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,48 @@
11831183
"com.amazonaws.fis#ExperimentEndTime": {
11841184
"type": "timestamp"
11851185
},
1186+
"com.amazonaws.fis#ExperimentError": {
1187+
"type": "structure",
1188+
"members": {
1189+
"accountId": {
1190+
"target": "com.amazonaws.fis#ExperimentErrorAccountId",
1191+
"traits": {
1192+
"smithy.api#documentation": "<p>The Amazon Web Services Account ID where the experiment failure occurred.</p>"
1193+
}
1194+
},
1195+
"code": {
1196+
"target": "com.amazonaws.fis#ExperimentErrorCode",
1197+
"traits": {
1198+
"smithy.api#documentation": "<p>The error code for the failed experiment.</p>"
1199+
}
1200+
},
1201+
"location": {
1202+
"target": "com.amazonaws.fis#ExperimentErrorLocation",
1203+
"traits": {
1204+
"smithy.api#documentation": "<p>Context for the section of the experiment template that failed.</p>"
1205+
}
1206+
}
1207+
},
1208+
"traits": {
1209+
"smithy.api#documentation": "<p>Describes the error when an experiment has <code>failed</code>.</p>"
1210+
}
1211+
},
1212+
"com.amazonaws.fis#ExperimentErrorAccountId": {
1213+
"type": "string"
1214+
},
1215+
"com.amazonaws.fis#ExperimentErrorCode": {
1216+
"type": "string",
1217+
"traits": {
1218+
"smithy.api#length": {
1219+
"min": 0,
1220+
"max": 128
1221+
},
1222+
"smithy.api#pattern": "^[\\S]+$"
1223+
}
1224+
},
1225+
"com.amazonaws.fis#ExperimentErrorLocation": {
1226+
"type": "string"
1227+
},
11861228
"com.amazonaws.fis#ExperimentId": {
11871229
"type": "string",
11881230
"traits": {
@@ -1282,6 +1324,12 @@
12821324
"traits": {
12831325
"smithy.api#documentation": "<p>The reason for the state.</p>"
12841326
}
1327+
},
1328+
"error": {
1329+
"target": "com.amazonaws.fis#ExperimentError",
1330+
"traits": {
1331+
"smithy.api#documentation": "<p>The error information of the experiment when the action has <code>failed</code>.</p>"
1332+
}
12851333
}
12861334
},
12871335
"traits": {
@@ -2338,7 +2386,7 @@
23382386
"name": "fis"
23392387
},
23402388
"aws.protocols#restJson1": {},
2341-
"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>",
2389+
"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>",
23422390
"smithy.api#title": "AWS Fault Injection Simulator",
23432391
"smithy.rules#endpointRuleSet": {
23442392
"version": "1.0",

0 commit comments

Comments
 (0)