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

*************
get_suite_run
*************



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

  

  Gets information about a Device Advisor test suite run.

   

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


  **Request Syntax**
  ::

    response = client.get_suite_run(
        suiteDefinitionId='string',
        suiteRunId='string'
    )
    
  :type suiteDefinitionId: string
  :param suiteDefinitionId: **[REQUIRED]** 

    Suite definition ID for the test suite run.

    

  
  :type suiteRunId: string
  :param suiteRunId: **[REQUIRED]** 

    Suite run ID for the test suite run.

    

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

    
    ::

      {
          'suiteDefinitionId': 'string',
          'suiteDefinitionVersion': 'string',
          'suiteRunId': 'string',
          'suiteRunArn': 'string',
          'suiteRunConfiguration': {
              'primaryDevice': {
                  'thingArn': 'string',
                  'certificateArn': 'string',
                  'deviceRoleArn': 'string'
              },
              'selectedTestList': [
                  'string',
              ],
              'parallelRun': True|False
          },
          'testResult': {
              'groups': [
                  {
                      'groupId': 'string',
                      'groupName': 'string',
                      'tests': [
                          {
                              'testCaseRunId': 'string',
                              'testCaseDefinitionId': 'string',
                              'testCaseDefinitionName': 'string',
                              'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
                              'startTime': datetime(2015, 1, 1),
                              'endTime': datetime(2015, 1, 1),
                              'logUrl': 'string',
                              'warnings': 'string',
                              'failure': 'string',
                              'testScenarios': [
                                  {
                                      'testCaseScenarioId': 'string',
                                      'testCaseScenarioType': 'Advanced'|'Basic',
                                      'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
                                      'failure': 'string',
                                      'systemMessage': 'string'
                                  },
                              ]
                          },
                      ]
                  },
              ]
          },
          'startTime': datetime(2015, 1, 1),
          'endTime': datetime(2015, 1, 1),
          'status': 'PASS'|'FAIL'|'CANCELED'|'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'|'PASS_WITH_WARNINGS'|'ERROR',
          'errorReason': 'string',
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **suiteDefinitionId** *(string) --* 

        Suite definition ID for the test suite run.

        
      

      - **suiteDefinitionVersion** *(string) --* 

        Suite definition version for the test suite run.

        
      

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

        Suite run ID for the test suite run.

        
      

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

        The ARN of the suite run.

        
      

      - **suiteRunConfiguration** *(dict) --* 

        Suite run configuration for the test suite run.

        
        

        - **primaryDevice** *(dict) --* 

          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.

          
    
      

      - **testResult** *(dict) --* 

        Test results for the test suite run.

        
        

        - **groups** *(list) --* 

          Show each group of test results.

          
          

          - *(dict) --* 

            Show Group Result.

            
            

            - **groupId** *(string) --* 

              Group result ID.

              
            

            - **groupName** *(string) --* 

              Group Result Name.

              
            

            - **tests** *(list) --* 

              Tests under Group Result.

              
              

              - *(dict) --* 

                Provides the test case run.

                
                

                - **testCaseRunId** *(string) --* 

                  Provides the test case run ID.

                  
                

                - **testCaseDefinitionId** *(string) --* 

                  Provides the test case run definition ID.

                  
                

                - **testCaseDefinitionName** *(string) --* 

                  Provides the test case run definition name.

                  
                

                - **status** *(string) --* 

                  Provides the test case run status. Status is one of the following:

                   

                  
                  * ``PASS``: Test passed.
                   
                  * ``FAIL``: Test failed.
                   
                  * ``PENDING``: Test has not started running but is scheduled.
                   
                  * ``RUNNING``: Test is running.
                   
                  * ``STOPPING``: Test is performing cleanup steps. You will see this status only if you stop a suite run.
                   
                  * ``STOPPED`` Test is stopped. You will see this status only if you stop a suite run.
                   
                  * ``PASS_WITH_WARNINGS``: Test passed with warnings.
                   
                  * ``ERORR``: Test faced an error when running due to an internal issue.
                  

                  
                

                - **startTime** *(datetime) --* 

                  Provides test case run start time.

                  
                

                - **endTime** *(datetime) --* 

                  Provides test case run end time.

                  
                

                - **logUrl** *(string) --* 

                  Provides test case run log URL.

                  
                

                - **warnings** *(string) --* 

                  Provides test case run warnings.

                  
                

                - **failure** *(string) --* 

                  Provides test case run failure result.

                  
                

                - **testScenarios** *(list) --* 

                  Provides the test scenarios for the test case run.

                  
                  

                  - *(dict) --* 

                    Provides test case scenario.

                    
                    

                    - **testCaseScenarioId** *(string) --* 

                      Provides test case scenario ID.

                      
                    

                    - **testCaseScenarioType** *(string) --* 

                      Provides test case scenario type. Type is one of the following:

                       

                      
                      * Advanced
                       
                      * Basic
                      

                      
                    

                    - **status** *(string) --* 

                      Provides the test case scenario status. Status is one of the following:

                       

                      
                      * ``PASS``: Test passed.
                       
                      * ``FAIL``: Test failed.
                       
                      * ``PENDING``: Test has not started running but is scheduled.
                       
                      * ``RUNNING``: Test is running.
                       
                      * ``STOPPING``: Test is performing cleanup steps. You will see this status only if you stop a suite run.
                       
                      * ``STOPPED`` Test is stopped. You will see this status only if you stop a suite run.
                       
                      * ``PASS_WITH_WARNINGS``: Test passed with warnings.
                       
                      * ``ERORR``: Test faced an error when running due to an internal issue.
                      

                      
                    

                    - **failure** *(string) --* 

                      Provides test case scenario failure result.

                      
                    

                    - **systemMessage** *(string) --* 

                      Provides test case scenario system messages if any.

                      
                
              
            
          
        
      
    
      

      - **startTime** *(datetime) --* 

        Date (in Unix epoch time) when the test suite run started.

        
      

      - **endTime** *(datetime) --* 

        Date (in Unix epoch time) when the test suite run ended.

        
      

      - **status** *(string) --* 

        Status for the test suite run.

        
      

      - **errorReason** *(string) --* 

        Error reason for any test suite run failure.

        
      

      - **tags** *(dict) --* 

        The tags attached to the suite run.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`IoTDeviceAdvisor.Client.exceptions.ValidationException`

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

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

  