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

***************
start_suite_run
***************



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

  

  Starts a Device Advisor test suite run.

   

  Requires permission to access the `StartSuiteRun <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/StartSuiteRun>`_  


  **Request Syntax**
  ::

    response = client.start_suite_run(
        suiteDefinitionId='string',
        suiteDefinitionVersion='string',
        suiteRunConfiguration={
            'primaryDevice': {
                'thingArn': 'string',
                'certificateArn': 'string',
                'deviceRoleArn': 'string'
            },
            'selectedTestList': [
                'string',
            ],
            'parallelRun': True|False
        },
        tags={
            'string': 'string'
        }
    )
    
  :type suiteDefinitionId: string
  :param suiteDefinitionId: **[REQUIRED]** 

    Suite definition ID of the test suite.

    

  
  :type suiteDefinitionVersion: string
  :param suiteDefinitionVersion: 

    Suite definition version of the test suite.

    

  
  :type suiteRunConfiguration: dict
  :param suiteRunConfiguration: **[REQUIRED]** 

    Suite run configuration.

    

  
    - **primaryDevice** *(dict) --* **[REQUIRED]** 

      Sets the primary device for the test suite run. This requires a thing ARN or a certificate ARN.

      

    
      - **thingArn** *(string) --* 

        Lists device's thing ARN.

        

      
      - **certificateArn** *(string) --* 

        Lists device's certificate ARN.

        

      
      - **deviceRoleArn** *(string) --* 

        Lists device's role ARN.

        

      
    
    - **selectedTestList** *(list) --* 

      Sets test case list.

      

    
      - *(string) --* 

      
  
    - **parallelRun** *(boolean) --* 

      TRUE if multiple test suites run in parallel.

      

    
  
  :type tags: dict
  :param tags: 

    The tags to be attached to the suite run.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'suiteRunId': 'string',
          'suiteRunArn': 'string',
          'createdAt': datetime(2015, 1, 1),
          'endpoint': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **suiteRunId** *(string) --* 

        Suite Run ID of the started suite run.

        
      

      - **suiteRunArn** *(string) --* 

        Amazon Resource Name (ARN) of the started suite run.

        
      

      - **createdAt** *(datetime) --* 

        Starts a Device Advisor test suite run based on suite create time.

        
      

      - **endpoint** *(string) --* 

        The response of an Device Advisor test endpoint.

        
  
  **Exceptions**
  
  *   :py:class:`IoTDeviceAdvisor.Client.exceptions.ValidationException`

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

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

  