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

*************************
start_test_set_generation
*************************



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

  

  The action to start the generation of test set.

  

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


  **Request Syntax**
  ::

    response = client.start_test_set_generation(
        testSetName='string',
        description='string',
        storageLocation={
            's3BucketName': 'string',
            's3Path': 'string',
            'kmsKeyArn': 'string'
        },
        generationDataSource={
            'conversationLogsDataSource': {
                'botId': 'string',
                'botAliasId': 'string',
                'localeId': 'string',
                'filter': {
                    'startTime': datetime(2015, 1, 1),
                    'endTime': datetime(2015, 1, 1),
                    'inputMode': 'Speech'|'Text'
                }
            }
        },
        roleArn='string',
        testSetTags={
            'string': 'string'
        }
    )
    
  :type testSetName: string
  :param testSetName: **[REQUIRED]** 

    The test set name for the test set generation request.

    

  
  :type description: string
  :param description: 

    The test set description for the test set generation request.

    

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

    The Amazon S3 storage location for the test set generation.

    

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

      The name of the Amazon S3 bucket in which the test set is stored.

      

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

      The path inside the Amazon S3 bucket where the test set is stored.

      

    
    - **kmsKeyArn** *(string) --* 

      The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.

      

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

    The data source for the test set generation.

    

  
    - **conversationLogsDataSource** *(dict) --* 

      Contains information about the bot from which the conversation logs are sourced.

      

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

        The bot Id from the conversation logs.

        

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

        The bot alias Id from the conversation logs.

        

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

        The locale Id of the conversation log.

        

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

        The filter for the data source of the conversation log.

        

      
        - **startTime** *(datetime) --* **[REQUIRED]** 

          The start time for the conversation log.

          

        
        - **endTime** *(datetime) --* **[REQUIRED]** 

          The end time for the conversation log.

          

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

          The selection to filter by input mode for the conversation logs.

          

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

    The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

    

  
  :type testSetTags: dict
  :param testSetTags: 

    A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the ``UpdateTestSet`` operation to update tags. To update tags, use the ``TagResource`` operation.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'testSetGenerationId': 'string',
          'creationDateTime': datetime(2015, 1, 1),
          'testSetGenerationStatus': 'Generating'|'Ready'|'Failed'|'Pending',
          'testSetName': 'string',
          'description': 'string',
          'storageLocation': {
              's3BucketName': 'string',
              's3Path': 'string',
              'kmsKeyArn': 'string'
          },
          'generationDataSource': {
              'conversationLogsDataSource': {
                  'botId': 'string',
                  'botAliasId': 'string',
                  'localeId': 'string',
                  'filter': {
                      'startTime': datetime(2015, 1, 1),
                      'endTime': datetime(2015, 1, 1),
                      'inputMode': 'Speech'|'Text'
                  }
              }
          },
          'roleArn': 'string',
          'testSetTags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **testSetGenerationId** *(string) --* 

        The unique identifier of the test set generation to describe.

        
      

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

        The creation date and time for the test set generation.

        
      

      - **testSetGenerationStatus** *(string) --* 

        The status for the test set generation.

        
      

      - **testSetName** *(string) --* 

        The test set name used for the test set generation.

        
      

      - **description** *(string) --* 

        The description used for the test set generation.

        
      

      - **storageLocation** *(dict) --* 

        The Amazon S3 storage location for the test set generation.

        
        

        - **s3BucketName** *(string) --* 

          The name of the Amazon S3 bucket in which the test set is stored.

          
        

        - **s3Path** *(string) --* 

          The path inside the Amazon S3 bucket where the test set is stored.

          
        

        - **kmsKeyArn** *(string) --* 

          The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting the test set.

          
    
      

      - **generationDataSource** *(dict) --* 

        The data source for the test set generation.

        
        

        - **conversationLogsDataSource** *(dict) --* 

          Contains information about the bot from which the conversation logs are sourced.

          
          

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

            The bot Id from the conversation logs.

            
          

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

            The bot alias Id from the conversation logs.

            
          

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

            The locale Id of the conversation log.

            
          

          - **filter** *(dict) --* 

            The filter for the data source of the conversation log.

            
            

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

              The start time for the conversation log.

              
            

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

              The end time for the conversation log.

              
            

            - **inputMode** *(string) --* 

              The selection to filter by input mode for the conversation logs.

              
        
      
    
      

      - **roleArn** *(string) --* 

        The roleARN used for any operation in the test set to access resources in the Amazon Web Services account.

        
      

      - **testSetTags** *(dict) --* 

        A list of tags that was used for the test set that is being generated.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`LexModelsV2.Client.exceptions.ThrottlingException`

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

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

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

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

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

  