AWS solutions documentation change

Service: solutions · 2025-11-22 · Documentation low

File: solutions/latest/distributed-load-testing-on-aws/distributed-load-testing-api.md

Summary

Added new API endpoints for stack information, test run management, and baseline management. Updated existing endpoints with new parameters and response fields including tags, total runs, and last run timestamp.

Security assessment

The changes primarily add new API functionality for test management and reporting. No security vulnerabilities or patches are mentioned. The 403/404 error codes indicate standard access controls but don't represent new security documentation.

Diff

diff --git a/solutions/latest/distributed-load-testing-on-aws/distributed-load-testing-api.md b/solutions/latest/distributed-load-testing-on-aws/distributed-load-testing-api.md
index 856154b66..b616a9d1a 100644
--- a//solutions/latest/distributed-load-testing-on-aws/distributed-load-testing-api.md
+++ b//solutions/latest/distributed-load-testing-on-aws/distributed-load-testing-api.md
@@ -5 +5 @@
-GET /scenariosPOST /scenariosOPTIONS /scenariosGET /scenarios/{testId}POST /scenarios/{testId}DELETE /scenarios/{testId}OPTIONS /scenarios/{testId}GET /tasksOPTIONS /tasksGET /regionsOPTIONS /regions
+GET /stack-infoGET /scenariosPOST /scenariosOPTIONS /scenariosGET /scenarios/{testId}POST /scenarios/{testId}DELETE /scenarios/{testId}OPTIONS /scenarios/{testId}GET /scenarios/{testId}/testrunsGET /scenarios/{testId}/testruns/{testRunId}DELETE /scenarios/{testId}/testruns/{testRunId}GET /scenarios/{testId}/baselinePUT /scenarios/{testId}/baselineDELETE /scenarios/{testId}/baselineGET /tasksOPTIONS /tasksGET /regionsOPTIONS /regions
@@ -20,0 +21,7 @@ For more information about `testScenario` and other parameters, refer to [scenar
+**Stack Info**
+
+  * GET /stack-info
+
+
+
+
@@ -39,0 +47,22 @@ For more information about `testScenario` and other parameters, refer to [scenar
+**Test Runs**
+
+  * GET /scenarios/{testId}/testruns
+
+  * GET /scenarios/{testId}/testruns/{testRunId}
+
+  * DELETE /scenarios/{testId}/testruns/{testRunId}
+
+
+
+
+**Baseline**
+
+  * GET /scenarios/{testId}/baseline
+
+  * PUT /scenarios/{testId}/baseline
+
+  * DELETE /scenarios/{testId}/baseline
+
+
+
+
@@ -58 +87,28 @@ For more information about `testScenario` and other parameters, refer to [scenar
-## `GET /scenarios`
+## GET /stack-info
+
+### Description
+
+The `GET /stack-info` operation retrieves information about the deployed stack including creation time, region, and version. This endpoint is used by the front-end.
+
+### Response
+
+**200 - Success**
+
+Name | Description  
+---|---  
+`created_time` |  ISO 8601 timestamp when the stack was created (for example, `2025-09-09T19:40:22Z`)  
+`region` |  AWS region where the stack is deployed (for example, `us-east-1`)  
+`version` |  Version of the deployed solution (for example, `v4.0.0`)  
+  
+**Error Responses**
+
+  * `403` \- Forbidden: Insufficient permissions to access stack information
+
+  * `404` \- Not found: Stack information not available
+
+  * `500` \- Internal server error
+
+
+
+
+## GET /scenarios
@@ -68 +124 @@ Name | Description
-`data` |  A list of scenarios including the ID, name, description, status, and run time for each test  
+`data` |  A list of scenarios including the ID, name, description, status, run time, tags, total runs, and last run for each test  
@@ -85,0 +142 @@ Name | Description
+`tags` |  An array of strings for categorizing tests. Optional field with a maximum length of 5 (for example, `["blue", "3.0", "critical"]`)  
@@ -121 +178 @@ The `GET /scenarios/{testId}` operation allows you to retrieve the details of a
-### Request parameter
+### Request parameters
@@ -134,0 +192,24 @@ Required: Yes
+`latest`
+    
+
+  * Query parameter to return only the latest test run. Default is `true`
+
+Type: Boolean
+
+Required: No
+
+
+
+
+`history`
+    
+
+  * Query parameter to include test run history in the response. Default is `true`. Set to `false` to exclude history
+
+Type: Boolean
+
+Required: No
+
+
+
+
@@ -143,0 +225 @@ Name | Description
+`tags` |  An array of strings for categorizing tests  
@@ -151 +233,3 @@ Name | Description
-`history` |  A list of final results of past tests  
+`history` |  A list of final results of past tests (excluded when `history=false`)  
+`totalRuns` |  The total number of test runs for this scenario  
+`lastRun` |  The timestamp of the last test run  
@@ -232,0 +317,393 @@ Name | Description
+## GET /scenarios/{testId}/testruns
+
+### Description
+
+The `GET /scenarios/{testId}/testruns` operation retrieves test run IDs for a specific test scenario, optionally filtered by time range. When `latest=true`, returns only the single most recent test run.
+
+### Request parameters
+
+`testId`
+    
+
+  * The test scenario ID
+
+Type: String
+
+Required: Yes
+
+
+
+
+`latest`
+    
+
+  * Return only the most recent test run ID
+
+Type: Boolean
+
+Default: `false`
+
+Required: No
+
+
+
+
+`start_timestamp`
+    
+
+  * ISO 8601 timestamp to filter test runs from (inclusive). For example, `2024-01-01T00:00:00Z`
+
+Type: String (date-time format)
+
+Required: No
+
+
+
+
+`end_timestamp`
+    
+
+  * ISO 8601 timestamp to filter test runs until (inclusive). For example, `2024-12-31T23:59:59Z`
+
+Type: String (date-time format)
+
+Required: No
+
+
+
+
+`limit`
+    
+
+  * Maximum number of test runs to return (ignored when `latest=true`)
+
+Type: Integer (minimum: 1, maximum: 100)
+
+Default: `20`
+
+Required: No
+
+
+
+
+`next_token`
+    
+
+  * Pagination token from previous response to get next page
+
+Type: String
+
+Required: No
+
+
+
+
+### Response
+
+**200 - Success**
+
+Name | Description  
+---|---  
+`testRuns` |  Array of test run objects, each containing `testRunId` (string) and `startTime` (ISO 8601 date-time)