ListTestRunTestCasesCommand

Lists test run test cases.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AppTestClient, ListTestRunTestCasesCommand } from "@aws-sdk/client-apptest"; // ES Modules import
// const { AppTestClient, ListTestRunTestCasesCommand } = require("@aws-sdk/client-apptest"); // CommonJS import
const client = new AppTestClient(config);
const input = { // ListTestRunTestCasesRequest
  testRunId: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListTestRunTestCasesCommand(input);
const response = await client.send(command);
// { // ListTestRunTestCasesResponse
//   testRunTestCases: [ // TestCaseRunSummaryList // required
//     { // TestCaseRunSummary
//       testCaseId: "STRING_VALUE", // required
//       testCaseVersion: Number("int"), // required
//       testRunId: "STRING_VALUE", // required
//       status: "Success" || "Running" || "Failed", // required
//       statusReason: "STRING_VALUE",
//       runStartTime: new Date("TIMESTAMP"), // required
//       runEndTime: new Date("TIMESTAMP"),
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListTestRunTestCasesCommand Input

Parameter
Type
Description
testRunId
Required
string | undefined

The test run ID of the test cases.

maxResults
number | undefined

The maximum number of test run test cases to return in one page of results.

nextToken
string | undefined

The token from a previous request to retrieve the next page of results.

ListTestRunTestCasesCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
testRunTestCases
Required
TestCaseRunSummary[] | undefined

The test run of the test cases.

nextToken
string | undefined

The token from a previous request to retrieve the next page of results.

Throws

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.