ListTestCasesCommand

Lists test cases.

Example Syntax

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

import { AppTestClient, ListTestCasesCommand } from "@aws-sdk/client-apptest"; // ES Modules import
// const { AppTestClient, ListTestCasesCommand } = require("@aws-sdk/client-apptest"); // CommonJS import
const client = new AppTestClient(config);
const input = { // ListTestCasesRequest
  testCaseIds: [ // TestCaseIdList
    "STRING_VALUE",
  ],
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListTestCasesCommand(input);
const response = await client.send(command);
// { // ListTestCasesResponse
//   testCases: [ // TestCaseSummaryList // required
//     { // TestCaseSummary
//       testCaseId: "STRING_VALUE", // required
//       testCaseArn: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       statusReason: "STRING_VALUE",
//       latestVersion: Number("int"), // required
//       status: "Active" || "Deleting", // required
//       creationTime: new Date("TIMESTAMP"), // required
//       lastUpdateTime: new Date("TIMESTAMP"), // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListTestCasesCommand Input

See ListTestCasesCommandInput for more details

Parameter
Type
Description
maxResults
number | undefined

The maximum results of the test case.

nextToken
string | undefined

The next token of the test cases.

testCaseIds
string[] | undefined

The IDs of the test cases.

ListTestCasesCommand Output

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

The test cases in an application.

nextToken
string | undefined

The next token in test cases.

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.