GetSuiteRun
Gets information about a Device Advisor test suite run.
Requires permission to access the GetSuiteRun action.
Request Syntax
GET /suiteDefinitions/suiteDefinitionId/suiteRuns/suiteRunId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- suiteDefinitionId
-
Suite definition ID for the test suite run.
Length Constraints: Minimum length of 12. Maximum length of 36.
Required: Yes
- suiteRunId
-
Suite run ID for the test suite run.
Length Constraints: Minimum length of 12. Maximum length of 36.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"endTime": number,
"errorReason": "string",
"startTime": number,
"status": "string",
"suiteDefinitionId": "string",
"suiteDefinitionVersion": "string",
"suiteRunArn": "string",
"suiteRunConfiguration": {
"parallelRun": boolean,
"primaryDevice": {
"certificateArn": "string",
"deviceRoleArn": "string",
"thingArn": "string"
},
"selectedTestList": [ "string" ]
},
"suiteRunId": "string",
"tags": {
"string" : "string"
},
"testResult": {
"groups": [
{
"groupId": "string",
"groupName": "string",
"tests": [
{
"endTime": number,
"failure": "string",
"logUrl": "string",
"startTime": number,
"status": "string",
"testCaseDefinitionId": "string",
"testCaseDefinitionName": "string",
"testCaseRunId": "string",
"testScenarios": [
{
"failure": "string",
"status": "string",
"systemMessage": "string",
"testCaseScenarioId": "string",
"testCaseScenarioType": "string"
}
],
"warnings": "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.
- endTime
-
Date (in Unix epoch time) when the test suite run ended.
Type: Timestamp
- errorReason
-
Error reason for any test suite run failure.
Type: String
- startTime
-
Date (in Unix epoch time) when the test suite run started.
Type: Timestamp
- status
-
Status for the test suite run.
Type: String
Valid Values:
PASS | FAIL | CANCELED | PENDING | RUNNING | STOPPING | STOPPED | PASS_WITH_WARNINGS | ERROR - suiteDefinitionId
-
Suite definition ID for the test suite run.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 36.
- suiteDefinitionVersion
-
Suite definition version for the test suite run.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 255.
- suiteRunArn
-
The ARN of the suite run.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- suiteRunConfiguration
-
Suite run configuration for the test suite run.
Type: SuiteRunConfiguration object
- suiteRunId
-
Suite run ID for the test suite run.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 36.
-
The tags attached to the suite run.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Value Length Constraints: Minimum length of 1. Maximum length of 256.
- testResult
-
Test results for the test suite run.
Type: TestResult object
Errors
- InternalServerException
-
Sends an Internal Failure exception.
HTTP Status Code: 500
- ResourceNotFoundException
-
Sends a Resource Not Found exception.
HTTP Status Code: 404
- ValidationException
-
Sends a validation 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:
