ListSuiteRuns - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListSuiteRuns

Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

Requires permission to access the ListSuiteRuns action.

Request Syntax

GET /suiteRuns?maxResults=maxResults&nextToken=nextToken&suiteDefinitionId=suiteDefinitionId&suiteDefinitionVersion=suiteDefinitionVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

The maximum number of results to return at once.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

A token to retrieve the next set of results.

Length Constraints: Maximum length of 2000.

suiteDefinitionId

Lists the test suite runs of the specified test suite based on suite definition ID.

Length Constraints: Minimum length of 12. Maximum length of 36.

suiteDefinitionVersion

Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.

Length Constraints: Minimum length of 2. Maximum length of 255.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "suiteRunsList": [ { "createdAt": number, "endAt": number, "failed": number, "passed": number, "startedAt": number, "status": "string", "suiteDefinitionId": "string", "suiteDefinitionName": "string", "suiteDefinitionVersion": "string", "suiteRunId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

A token to retrieve the next set of results.

Type: String

Length Constraints: Maximum length of 2000.

suiteRunsList

An array of objects that provide summaries of information about the suite runs in the list.

Type: Array of SuiteRunInformation objects

Errors

InternalServerException

Sends an Internal Failure exception.

HTTP Status Code: 500

ValidationException

Sends a validation exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: