SuiteDefinitionConfiguration - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SuiteDefinitionConfiguration

Gets the suite definition configuration.

Contents

devicePermissionRoleArn

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

rootGroup

Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if intendedForQualification is set to true, rootGroup can be an empty string. If intendedForQualification is false, rootGroup cannot be an empty string. If rootGroup is empty, and intendedForQualification is set to true, all the qualification tests are included, and the configuration is default.

For a qualification suite, the minimum length is 0, and the maximum is 2048. For a non-qualification suite, the minimum length is 1, and the maximum is 2048.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: Yes

suiteDefinitionName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

devices

Gets the devices configured.

Type: Array of DeviceUnderTest objects

Array Members: Minimum number of 0 items. Maximum number of 2 items.

Required: No

intendedForQualification

Gets the tests intended for qualification in a suite.

Type: Boolean

Required: No

isLongDurationTest

Verifies if the test suite is a long duration test.

Type: Boolean

Required: No

protocol

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

Type: String

Valid Values: MqttV3_1_1 | MqttV5 | MqttV3_1_1_OverWebSocket | MqttV5_OverWebSocket

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: