list_suite_runs

IoTDeviceAdvisor.Client.list_suite_runs(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_suite_runs(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string',
    maxResults=123,
    nextToken='string'
)

Parameters

• suiteDefinitionId (string) -- Lists the test suite runs of the specified test suite based on suite definition ID.
• suiteDefinitionVersion (string) -- Must be passed along with suiteDefinitionId . Lists the test suite runs of the specified test suite based on suite definition version.
• maxResults (integer) -- The maximum number of results to return at once.
• nextToken (string) -- A token to retrieve the next set of results.

Return type

dict

Returns

Response Syntax

{
    'suiteRunsList': [
        {
            'suiteDefinitionId': 'string',
            'suiteDefinitionVersion': 'string',
            'suiteDefinitionName': 'string',
            'suiteRunId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'startedAt': datetime(2015, 1, 1),
            'endAt': datetime(2015, 1, 1),
            'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
            'passed': 123,
            'failed': 123
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • suiteRunsList (list) --

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

    • (dict) --

      Information about the suite run.

      Requires permission to access the SuiteRunInformation action.

      • suiteDefinitionId (string) --

        Suite definition ID of the suite run.

      • suiteDefinitionVersion (string) --

        Suite definition version of the suite run.

      • suiteDefinitionName (string) --

        Suite definition name of the suite run.

      • suiteRunId (string) --

        Suite run ID of the suite run.

      • createdAt (datetime) --

        Date (in Unix epoch time) when the suite run was created.

      • startedAt (datetime) --

        Date (in Unix epoch time) when the suite run was started.

      • endAt (datetime) --

        Date (in Unix epoch time) when the suite run ended.

      • status (string) --

        Status of the suite run.

      • passed (integer) --

        Number of test cases that passed in the suite run.

      • failed (integer) --

        Number of test cases that failed in the suite run.

  • nextToken (string) --

    A token to retrieve the next set of results.

Exceptions

• IoTDeviceAdvisor.Client.exceptions.ValidationException
• IoTDeviceAdvisor.Client.exceptions.InternalServerException