:doc:`IoTDeviceAdvisor <../../iotdeviceadvisor>` / Client / list_suite_definitions

**********************
list_suite_definitions
**********************



.. py:method:: IoTDeviceAdvisor.Client.list_suite_definitions(**kwargs)

  

  Lists the Device Advisor test suites you have created.

   

  Requires permission to access the `ListSuiteDefinitions <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotdeviceadvisor-2020-09-18/ListSuiteDefinitions>`_  


  **Request Syntax**
  ::

    response = client.list_suite_definitions(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at once.

    

  
  :type nextToken: string
  :param nextToken: 

    A token used to get the next set of results.

    

  
  
  :rtype: 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**
  
  *   :py:class:`IoTDeviceAdvisor.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTDeviceAdvisor.Client.exceptions.InternalServerException`

  