Skip to content

SuiteDefinitionConfiguration

Used by
Source code in docs_src/capo_iotdeviceadvisor/types/suite_definition_configuration.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class SuiteDefinitionConfiguration(TypedDict, closed=True):
    suite_definition_name: NotRequired[
        "capo_iotdeviceadvisor.types.suite_definition_name.SuiteDefinitionName"
    ]
    """<p>Gets the suite definition name. This is a required parameter.</p>"""
    devices: NotRequired[
        "capo_iotdeviceadvisor.types.device_under_test_list.DeviceUnderTestList"
    ]
    """<p>Gets the devices configured.</p>"""
    intended_for_qualification: NotRequired[
        "capo_iotdeviceadvisor.types.intended_for_qualification_boolean.IntendedForQualificationBoolean"
    ]
    """<p>Gets the tests intended for qualification in a suite.</p>"""
    is_long_duration_test: NotRequired[
        "capo_iotdeviceadvisor.types.is_long_duration_test_boolean.IsLongDurationTestBoolean"
    ]
    """<p>Verifies if the test suite is a long duration test.</p>"""
    root_group: NotRequired["capo_iotdeviceadvisor.types.root_group.RootGroup"]
    """<p>Gets the test suite root group. This is a required parameter. For updating or creating the latest qualification suite, if <code>intendedForQualification</code> is set to true, <code>rootGroup</code> can be an empty string. If <code>intendedForQualification</code> is false, <code>rootGroup</code> cannot be an empty string. If <code>rootGroup</code> is empty, and <code>intendedForQualification</code> is set to true, all the qualification tests are included, and the configuration is default.</p> <p> 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. </p>"""
    device_permission_role_arn: NotRequired[
        "capo_iotdeviceadvisor.types.amazon_resource_name.AmazonResourceName"
    ]
    """<p>Gets the device permission ARN. This is a required parameter.</p>"""
    protocol: NotRequired["capo_iotdeviceadvisor.types.protocol.Protocol"]
    """<p>Sets the MQTT protocol that is configured in the suite definition.</p>"""

device_permission_role_arn instance-attribute 

device_permission_role_arn: NotRequired[AmazonResourceName]

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

devices instance-attribute 

devices: NotRequired[DeviceUnderTestList]

Gets the devices configured.

intended_for_qualification instance-attribute 

intended_for_qualification: NotRequired[IntendedForQualificationBoolean]

Gets the tests intended for qualification in a suite.

is_long_duration_test instance-attribute 

is_long_duration_test: NotRequired[IsLongDurationTestBoolean]

Verifies if the test suite is a long duration test.

protocol instance-attribute 

protocol: NotRequired[Protocol]

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

root_group instance-attribute 

root_group: NotRequired[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.

suite_definition_name instance-attribute 

suite_definition_name: NotRequired[SuiteDefinitionName]

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