IoTDeviceAdvisor / Client / update_suite_definition

update_suite_definition#

IoTDeviceAdvisor.Client.update_suite_definition(**kwargs)#

Updates a Device Advisor test suite.

Requires permission to access the UpdateSuiteDefinition action.

See also: AWS API Documentation

Request Syntax

response = client.update_suite_definition(
    suiteDefinitionId='string',
    suiteDefinitionConfiguration={
        'suiteDefinitionName': 'string',
        'devices': [
            {
                'thingArn': 'string',
                'certificateArn': 'string',
                'deviceRoleArn': 'string'
            },
        ],
        'intendedForQualification': True|False,
        'isLongDurationTest': True|False,
        'rootGroup': 'string',
        'devicePermissionRoleArn': 'string',
        'protocol': 'MqttV3_1_1'|'MqttV5'|'MqttV3_1_1_OverWebSocket'|'MqttV5_OverWebSocket'
    }
)
Parameters:
  • suiteDefinitionId (string) –

    [REQUIRED]

    Suite definition ID of the test suite to be updated.

  • suiteDefinitionConfiguration (dict) –

    [REQUIRED]

    Updates 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, certificate ARN or device role ARN is required.

        • thingArn (string) –

          Lists device’s thing ARN.

        • certificateArn (string) –

          Lists device’s certificate ARN.

        • deviceRoleArn (string) –

          Lists device’s role 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.

Return type:

dict

Returns:

Response Syntax

{
    'suiteDefinitionId': 'string',
    'suiteDefinitionArn': 'string',
    'suiteDefinitionName': 'string',
    'suiteDefinitionVersion': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • suiteDefinitionId (string) –

      Suite definition ID of the updated test suite.

    • suiteDefinitionArn (string) –

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

    • suiteDefinitionName (string) –

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

    • suiteDefinitionVersion (string) –

      Suite definition version of the updated test suite.

    • createdAt (datetime) –

      Timestamp of when the test suite was created.

    • lastUpdatedAt (datetime) –

      Timestamp of when the test suite was updated.

Exceptions

  • IoTDeviceAdvisor.Client.exceptions.ValidationException

  • IoTDeviceAdvisor.Client.exceptions.InternalServerException