ListSuiteRuns - AWS IoT

ListSuiteRuns

Lists the 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.

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

MaxResults for list suite run API request.

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

nextToken

Next pagination token for list suite run request.

Length Constraints: Maximum length of 2000.

suiteDefinitionId

Lists the runs of the specified Device Advisor test suite based on suite definition Id.

Length Constraints: Fixed length of 36.

suiteDefinitionVersion

Lists the runs of the specified Device Advisor 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

Next pagination token for list suite run response.

Type: String

Length Constraints: Maximum length of 2000.

suiteRunsList

Lists the runs of the specified Device Advisor test suite.

Type: Array of SuiteRunInformation objects

Errors

InternalServerException

Sends Internal Failure Exception.

HTTP Status Code: 500

ValidationException

Sends invalid request exception.

HTTP Status Code: 400

See Also

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