Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

See also: AWS API Documentation

Request Syntax

response = client.list_suite_definitions(
  • maxResults (integer) -- The maximum number of results to return at once.
  • nextToken (string) -- A token used to get the next set of results.
Return type



Response Syntax

    'suiteDefinitionInformationList': [
            'suiteDefinitionId': 'string',
            'suiteDefinitionName': 'string',
            'defaultDevices': [
                    'thingArn': 'string',
                    'certificateArn': 'string'
            'intendedForQualification': True|False,
            'isLongDurationTest': True|False,
            'protocol': 'MqttV3_1_1'|'MqttV5',
            'createdAt': datetime(2015, 1, 1)
    'nextToken': 'string'

Response Structure

  • (dict) --

    • suiteDefinitionInformationList (list) --

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

      • (dict) --

        Information about the suite definition.

        • suiteDefinitionId (string) --

          Suite definition ID of the test suite.

        • suiteDefinitionName (string) --

          Suite name of the test suite.

        • defaultDevices (list) --

          Specifies the devices that are under test for the test suite.

          • (dict) --

            Information of a test device. A thing ARN or a certificate ARN is required.

            • thingArn (string) --

              Lists devices thing ARN.

            • certificateArn (string) --

              Lists devices certificate ARN.

        • intendedForQualification (boolean) --

          Specifies if the test suite is intended for qualification.

        • isLongDurationTest (boolean) --

          Verifies if the test suite is a long duration test.

        • protocol (string) --

          Gets the MQTT protocol that is configured in the suite definition.

        • createdAt (datetime) --

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

    • nextToken (string) --

      A token used to get the next set of results.


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