IoTDeviceAdvisor / Client / start_suite_run

start_suite_run#

IoTDeviceAdvisor.Client.start_suite_run(**kwargs)#

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

See also: AWS API Documentation

Request Syntax

response = client.start_suite_run(
    suiteDefinitionId='string',
    suiteDefinitionVersion='string',
    suiteRunConfiguration={
        'primaryDevice': {
            'thingArn': 'string',
            'certificateArn': 'string',
            'deviceRoleArn': 'string'
        },
        'selectedTestList': [
            'string',
        ],
        'parallelRun': True|False
    },
    tags={
        'string': 'string'
    }
)
Parameters:

  • suiteDefinitionId (string) –

    [REQUIRED]

    Suite definition ID of the test suite.

  • suiteDefinitionVersion (string) – Suite definition version of the test suite.

  • suiteRunConfiguration (dict) –

    [REQUIRED]

    Suite run configuration.

    • primaryDevice (dict) – [REQUIRED]

      Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.

      • thingArn (string) –

        Lists device’s thing ARN.

      • certificateArn (string) –

        Lists device’s certificate ARN.

      • deviceRoleArn (string) –

        Lists device’s role ARN.

    • selectedTestList (list) –

      Sets test case list.

      • (string) –

    • parallelRun (boolean) –

      TRUE if multiple test suites run in parallel.

  • tags (dict) –

    The tags to be attached to the suite run.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'suiteRunId': 'string',
    'suiteRunArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'endpoint': 'string'
}

Response Structure

  • (dict) –

    • suiteRunId (string) –

      Suite Run ID of the started suite run.

    • suiteRunArn (string) –

      Amazon Resource Name (ARN) of the started suite run.

    • createdAt (datetime) –

      Starts a Device Advisor test suite run based on suite create time.

    • endpoint (string) –

      The response of an Device Advisor test endpoint.

Exceptions