:doc:`LexModelsV2 <../../lexv2-models>` / Client / start_test_execution

********************
start_test_execution
********************



.. py:method:: LexModelsV2.Client.start_test_execution(**kwargs)

  

  The action to start test set execution.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartTestExecution>`_  


  **Request Syntax**
  ::

    response = client.start_test_execution(
        testSetId='string',
        target={
            'botAliasTarget': {
                'botId': 'string',
                'botAliasId': 'string',
                'localeId': 'string'
            }
        },
        apiMode='Streaming'|'NonStreaming',
        testExecutionModality='Text'|'Audio'
    )
    
  :type testSetId: string
  :param testSetId: **[REQUIRED]** 

    The test set Id for the test set execution.

    

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

    The target bot for the test set execution.

    

  
    - **botAliasTarget** *(dict) --* 

      Contains information about the bot alias used for the test execution.

      

    
      - **botId** *(string) --* **[REQUIRED]** 

        The bot Id of the bot alias used in the test set execution.

        

      
      - **botAliasId** *(string) --* **[REQUIRED]** 

        The bot alias Id of the bot alias used in the test set execution.

        

      
      - **localeId** *(string) --* **[REQUIRED]** 

        The locale Id of the bot alias used in the test set execution.

        

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

    Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Runtime API is used. Whereas, for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

    

  
  :type testExecutionModality: string
  :param testExecutionModality: 

    Indicates whether audio or text is used.

    

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

    
    ::

      {
          'testExecutionId': 'string',
          'creationDateTime': datetime(2015, 1, 1),
          'testSetId': 'string',
          'target': {
              'botAliasTarget': {
                  'botId': 'string',
                  'botAliasId': 'string',
                  'localeId': 'string'
              }
          },
          'apiMode': 'Streaming'|'NonStreaming',
          'testExecutionModality': 'Text'|'Audio'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **testExecutionId** *(string) --* 

        The unique identifier of the test set execution.

        
      

      - **creationDateTime** *(datetime) --* 

        The creation date and time for the test set execution.

        
      

      - **testSetId** *(string) --* 

        The test set Id for the test set execution.

        
      

      - **target** *(dict) --* 

        The target bot for the test set execution.

        
        

        - **botAliasTarget** *(dict) --* 

          Contains information about the bot alias used for the test execution.

          
          

          - **botId** *(string) --* 

            The bot Id of the bot alias used in the test set execution.

            
          

          - **botAliasId** *(string) --* 

            The bot alias Id of the bot alias used in the test set execution.

            
          

          - **localeId** *(string) --* 

            The locale Id of the bot alias used in the test set execution.

            
      
    
      

      - **apiMode** *(string) --* 

        Indicates whether we use streaming or non-streaming APIs for the test set execution. For streaming, StartConversation Amazon Lex Runtime API is used. Whereas for non-streaming, RecognizeUtterance and RecognizeText Amazon Lex Runtime API are used.

        
      

      - **testExecutionModality** *(string) --* 

        Indicates whether audio or text is used.

        
  
  **Exceptions**
  
  *   :py:class:`LexModelsV2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`LexModelsV2.Client.exceptions.ServiceQuotaExceededException`

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

  
  *   :py:class:`LexModelsV2.Client.exceptions.ValidationException`

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

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

  