- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListTestRunStepsCommand
Lists test run steps.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppTestClient, ListTestRunStepsCommand } from "@aws-sdk/client-apptest"; // ES Modules import
// const { AppTestClient, ListTestRunStepsCommand } = require("@aws-sdk/client-apptest"); // CommonJS import
const client = new AppTestClient(config);
const input = { // ListTestRunStepsRequest
testRunId: "STRING_VALUE", // required
testCaseId: "STRING_VALUE",
testSuiteId: "STRING_VALUE",
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new ListTestRunStepsCommand(input);
const response = await client.send(command);
// { // ListTestRunStepsResponse
// testRunSteps: [ // TestRunStepSummaryList // required
// { // TestRunStepSummary
// stepName: "STRING_VALUE", // required
// testRunId: "STRING_VALUE", // required
// testCaseId: "STRING_VALUE",
// testCaseVersion: Number("int"),
// testSuiteId: "STRING_VALUE",
// testSuiteVersion: Number("int"),
// beforeStep: true || false,
// afterStep: true || false,
// status: "Success" || "Failed" || "Running", // required
// statusReason: "STRING_VALUE",
// runStartTime: new Date("TIMESTAMP"), // required
// runEndTime: new Date("TIMESTAMP"),
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListTestRunStepsCommand Input
See ListTestRunStepsCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
testRunId Required | string | undefined | The test run ID of the test run steps. |
maxResults | number | undefined | The maximum number of test run steps to return in one page of results. |
nextToken | string | undefined | The token from a previous step to retrieve the next page of results. |
testCaseId | string | undefined | The test case ID of the test run steps. |
testSuiteId | string | undefined | The test suite ID of the test run steps. |
ListTestRunStepsCommand Output
See ListTestRunStepsCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
testRunSteps Required | TestRunStepSummary[] | undefined | The test run steps of the response query. |
nextToken | string | undefined | The token from a previous request to retrieve the next page of results. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | The account or role doesn't have the right permissions to make the request. |
InternalServerException | server | An unexpected error occurred during the processing of the request. |
ResourceNotFoundException | client | The specified resource was not found. |
ThrottlingException | client | The number of requests made exceeds the limit. |
ValidationException | client | One or more parameter provided in the request is not valid. |
AppTestServiceException | Base exception class for all service exceptions from AppTest service. |