---
title: "GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}"
method: GET
path: "/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}"
---

# GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}

`GET /suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}`

Gets information about a Device Advisor test suite run.

Requires permission to access the [GetSuiteRun](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Path parameters

- `suiteDefinitionId` string, required
- `suiteRunId` string, required

## Response `200`

Success

- GetSuiteRunResponse
  - `suiteDefinitionId` string — Suite definition ID for the test suite run.
  - `suiteDefinitionVersion` string — Suite definition version for the test suite run.
  - `suiteRunId` string — Suite run ID for the test suite run.
  - `suiteRunArn` string — The ARN of the suite run.
  - `suiteRunConfiguration` object — Suite run configuration for the test suite run.
    - `primaryDevice` object, required — Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.
      - `thingArn` string — Lists devices thing ARN.
      - `certificateArn` string — Lists devices certificate ARN.
    - `selectedTestList` UUID[] — Sets test case list.
    - `parallelRun` boolean — TRUE if multiple test suites run in parallel.
  - `testResult` object — Test results for the test suite run.
    - `groups` GroupResult[] — Show each group of test results.
      - `groupId` string — Group result ID.
      - `groupName` string — Group Result Name.
      - `tests` TestCaseRun[] — Tests under Group Result.
        - `testCaseRunId` string — Provides the test case run ID.
        - `testCaseDefinitionId` string — Provides the test case run definition ID.
        - `testCaseDefinitionName` string — Provides the test case run definition name.
        - `status` 'PASS' | 'FAIL' | 'CANCELED' | 'PENDING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'PASS_WITH_WARNINGS' | 'ERROR' — <p>Provides the test case run status. Status is one of the following:</p> <ul> <li> <p> <code>PASS</code>: Test passed.</p> </li> <li> <p> <code>FAIL</code>: Test failed.</p> </li> <li> <p> <code>PENDING</code>: Test has not started running but is scheduled.</p> </li> <li> <p> <code>RUNNING</code>: Test is running.</p> </li> <li> <p> <code>STOPPING</code>: Test is performing cleanup steps. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>STOPPED</code> Test is stopped. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>PASS_WITH_WARNINGS</code>: Test passed with warnings.</p> </li> <li> <p> <code>ERORR</code>: Test faced an error when running due to an internal issue.</p> </li> </ul>
        - `startTime` string, date-time — Provides test case run start time.
        - `endTime` string, date-time — Provides test case run end time.
        - `logUrl` string — Provides test case run log URL.
        - `warnings` string — Provides test case run warnings.
        - `failure` string — Provides test case run failure result.
        - `testScenarios` TestCaseScenario[] — Provides the test scenarios for the test case run.
          - `testCaseScenarioId` string — Provides test case scenario ID.
          - `testCaseScenarioType` 'Advanced' | 'Basic' — <p>Provides test case scenario type. Type is one of the following:</p> <ul> <li> <p>Advanced</p> </li> <li> <p>Basic</p> </li> </ul>
          - `status` 'PASS' | 'FAIL' | 'CANCELED' | 'PENDING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'PASS_WITH_WARNINGS' | 'ERROR' — <p>Provides the test case scenario status. Status is one of the following:</p> <ul> <li> <p> <code>PASS</code>: Test passed.</p> </li> <li> <p> <code>FAIL</code>: Test failed.</p> </li> <li> <p> <code>PENDING</code>: Test has not started running but is scheduled.</p> </li> <li> <p> <code>RUNNING</code>: Test is running.</p> </li> <li> <p> <code>STOPPING</code>: Test is performing cleanup steps. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>STOPPED</code> Test is stopped. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>PASS_WITH_WARNINGS</code>: Test passed with warnings.</p> </li> <li> <p> <code>ERORR</code>: Test faced an error when running due to an internal issue.</p> </li> </ul>
          - `failure` string — Provides test case scenario failure result.
          - `systemMessage` string — 
  - `startTime` string, date-time — Date (in Unix epoch time) when the test suite run started.
  - `endTime` string, date-time — Date (in Unix epoch time) when the test suite run ended.
  - `status` 'PASS' | 'FAIL' | 'CANCELED' | 'PENDING' | 'RUNNING' | 'STOPPING' | 'STOPPED' | 'PASS_WITH_WARNINGS' | 'ERROR' — Status for the test suite run.
  - `errorReason` string — Error reason for any test suite run failure.
  - `tags` object — The tags attached to the suite run.

## Other responses

- `480` — ValidationException
- `481` — InternalServerException
- `482` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/iotdeviceadvisor.md) · [All operations](https://skmtc.net/aws/apis/iotdeviceadvisor/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotdeviceadvisor/versions/9a6cea03b52e/schema)