Creates a Device Advisor test suite.

Requires permission to access the CreateSuiteDefinition action.

See also: AWS API Documentation

Request Syntax

response = client.create_suite_definition(
        'suiteDefinitionName': 'string',
        'devices': [
                'thingArn': 'string',
                'certificateArn': 'string'
        'intendedForQualification': True|False,
        'isLongDurationTest': True|False,
        'rootGroup': 'string',
        'devicePermissionRoleArn': 'string',
        'protocol': 'MqttV3_1_1'|'MqttV5'
        'string': 'string'
  • suiteDefinitionConfiguration (dict) --


    Creates a Device Advisor test suite with suite definition configuration.

    • suiteDefinitionName (string) -- [REQUIRED]

      Gets the suite definition name. This is a required parameter.

    • devices (list) --

      Gets the devices configured.

      • (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) --

      Gets the tests intended for qualification in a suite.

    • isLongDurationTest (boolean) --

      Verifies if the test suite is a long duration test.

    • rootGroup (string) -- [REQUIRED]

      Gets the test suite root group. This is a required parameter.

    • devicePermissionRoleArn (string) -- [REQUIRED]

      Gets the device permission ARN. This is a required parameter.

    • protocol (string) --

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

  • tags (dict) --

    The tags to be attached to the suite definition.

    • (string) --
      • (string) --
Return type



Response Syntax

    'suiteDefinitionId': 'string',
    'suiteDefinitionArn': 'string',
    'suiteDefinitionName': 'string',
    'createdAt': datetime(2015, 1, 1)

Response Structure

  • (dict) --

    • suiteDefinitionId (string) --

      The UUID of the test suite created.

    • suiteDefinitionArn (string) --

      The Amazon Resource Name (ARN) of the test suite.

    • suiteDefinitionName (string) --

      The suite definition name of the test suite. This is a required parameter.

    • createdAt (datetime) --

      The timestamp of when the test suite was created.


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