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

********************
get_suite_definition
********************



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

  

  Gets information about a Device Advisor test suite.

   

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


  **Request Syntax**
  ::

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

    Suite definition ID of the test suite to get.

    

  
  :type suiteDefinitionVersion: string
  :param suiteDefinitionVersion: 

    Suite definition version of the test suite to get.

    

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

    
    ::

      {
          'suiteDefinitionId': 'string',
          'suiteDefinitionArn': 'string',
          'suiteDefinitionVersion': 'string',
          'latestVersion': 'string',
          'suiteDefinitionConfiguration': {
              'suiteDefinitionName': 'string',
              'devices': [
                  {
                      'thingArn': 'string',
                      'certificateArn': 'string',
                      'deviceRoleArn': 'string'
                  },
              ],
              'intendedForQualification': True|False,
              'isLongDurationTest': True|False,
              'rootGroup': 'string',
              'devicePermissionRoleArn': 'string',
              'protocol': 'MqttV3_1_1'|'MqttV5'|'MqttV3_1_1_OverWebSocket'|'MqttV5_OverWebSocket'
          },
          'createdAt': datetime(2015, 1, 1),
          'lastModifiedAt': datetime(2015, 1, 1),
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Suite definition ID of the suite definition.

        
      

      - **suiteDefinitionArn** *(string) --* 

        The ARN of the suite definition.

        
      

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

        Suite definition version of the suite definition.

        
      

      - **latestVersion** *(string) --* 

        Latest suite definition version of the suite definition.

        
      

      - **suiteDefinitionConfiguration** *(dict) --* 

        Suite configuration of the suite definition.

        
        

        - **suiteDefinitionName** *(string) --* 

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

          
        

        - **devices** *(list) --* 

          Gets the devices configured.

          
          

          - *(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) --* 

          Gets the tests intended for qualification in a suite.

          
        

        - **isLongDurationTest** *(boolean) --* 

          Verifies if the test suite is a long duration test.

          
        

        - **rootGroup** *(string) --* 

          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.

          
        

        - **devicePermissionRoleArn** *(string) --* 

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

          
        

        - **protocol** *(string) --* 

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

          
    
      

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

        Date (in Unix epoch time) when the suite definition was created.

        
      

      - **lastModifiedAt** *(datetime) --* 

        Date (in Unix epoch time) when the suite definition was last modified.

        
      

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

        Tags attached to the suite definition.

        
        

        - *(string) --* 
          

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

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

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

  