AWS IoT Core Device Advisor

2022/12/22 - AWS IoT Core Device Advisor - 1 updated api methods

Changes  This release adds the following new features: 1) Documentation updates for IoT Device Advisor APIs. 2) Updated required request parameters for IoT Device Advisor APIs. 3) Added new service feature: ability to provide the test endpoint when customer executing the StartSuiteRun API.

StartSuiteRun (updated) Link ΒΆ
Changes (response) 
{'endpoint': 'string'}

Starts a Device Advisor test suite run.

Requires permission to access the StartSuiteRun action.

See also: AWS API Documentation

Request Syntax

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

string

param suiteDefinitionId

[REQUIRED]

Suite definition ID of the test suite.

type suiteDefinitionVersion

string

param suiteDefinitionVersion

Suite definition version of the test suite.

type suiteRunConfiguration

dict

param suiteRunConfiguration

[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 devices thing ARN.

    • certificateArn (string) --

      Lists devices certificate ARN.

  • selectedTestList (list) --

    Sets test case list.

    • (string) --

  • parallelRun (boolean) --

    TRUE if multiple test suites run in parallel.

type tags

dict

param tags

The tags to be attached to the suite run.

  • (string) --

    • (string) --

rtype

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.