- 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.
ListTestSuitesCommand
Lists test suites.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { AppTestClient, ListTestSuitesCommand } from "@aws-sdk/client-apptest"; // ES Modules import
// const { AppTestClient, ListTestSuitesCommand } = require("@aws-sdk/client-apptest"); // CommonJS import
const client = new AppTestClient(config);
const input = { // ListTestSuitesRequest
testSuiteIds: [ // TestSuiteIdList
"STRING_VALUE",
],
nextToken: "STRING_VALUE",
maxResults: Number("int"),
};
const command = new ListTestSuitesCommand(input);
const response = await client.send(command);
// { // ListTestSuitesResponse
// testSuites: [ // TestSuiteList // required
// { // TestSuiteSummary
// testSuiteId: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// statusReason: "STRING_VALUE",
// latestVersion: Number("int"), // required
// testSuiteArn: "STRING_VALUE", // required
// status: "Creating" || "Updating" || "Active" || "Failed" || "Deleting", // required
// creationTime: new Date("TIMESTAMP"), // required
// lastUpdateTime: new Date("TIMESTAMP"), // required
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListTestSuitesCommand Input
See ListTestSuitesCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
maxResults | number | undefined | The maximum number of test suites to return in one page of results. |
nextToken | string | undefined | The token from a previous request to retrieve the next page of results. |
testSuiteIds | string[] | undefined | The suite ID of the test suites. |
ListTestSuitesCommand Output
See ListTestSuitesCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
testSuites Required | TestSuiteSummary[] | undefined | The test suites returned with the response query. |
nextToken | string | undefined | The token from a previous request to retrieve the next page of test suites 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. |