IoTDeviceAdvisor / Client / list_suite_definitions

list_suite_definitions#

IoTDeviceAdvisor.Client.list_suite_definitions(**kwargs)#

Lists the Device Advisor test suites you have created.

Requires permission to access the ListSuiteDefinitions action.

Request Syntax

response = client.list_suite_definitions(
    maxResults=123,
    nextToken='string'
)

Parameters:

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:

dict

Returns:

Response Syntax

{
    'suiteDefinitionInformationList': [
        {
            'suiteDefinitionId': 'string',
            'suiteDefinitionName': 'string',
            'defaultDevices': [
                {
                    'thingArn': 'string',
                    'certificateArn': 'string',
                    'deviceRoleArn': 'string'
                },
            ],
            'intendedForQualification': True|False,
            'isLongDurationTest': True|False,
            'protocol': 'MqttV3_1_1'|'MqttV5'|'MqttV3_1_1_OverWebSocket'|'MqttV5_OverWebSocket',
            '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, 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) –
      
      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.

Exceptions

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