:doc:`CleanRoomsML <../../cleanroomsml>` / Client / get_training_dataset

********************
get_training_dataset
********************



.. py:method:: CleanRoomsML.Client.get_training_dataset(**kwargs)

  

  Returns information about a training dataset.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cleanroomsml-2023-09-06/GetTrainingDataset>`_  


  **Request Syntax**
  ::

    response = client.get_training_dataset(
        trainingDatasetArn='string'
    )
    
  :type trainingDatasetArn: string
  :param trainingDatasetArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the training dataset that you are interested in.

    

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

    
    ::

      {
          'createTime': datetime(2015, 1, 1),
          'updateTime': datetime(2015, 1, 1),
          'trainingDatasetArn': 'string',
          'name': 'string',
          'trainingData': [
              {
                  'type': 'INTERACTIONS',
                  'inputConfig': {
                      'schema': [
                          {
                              'columnName': 'string',
                              'columnTypes': [
                                  'USER_ID'|'ITEM_ID'|'TIMESTAMP'|'CATEGORICAL_FEATURE'|'NUMERICAL_FEATURE',
                              ]
                          },
                      ],
                      'dataSource': {
                          'glueDataSource': {
                              'tableName': 'string',
                              'databaseName': 'string',
                              'catalogId': 'string'
                          }
                      }
                  }
              },
          ],
          'status': 'ACTIVE',
          'roleArn': 'string',
          'tags': {
              'string': 'string'
          },
          'description': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **createTime** *(datetime) --* 

        The time at which the training dataset was created.

        
      

      - **updateTime** *(datetime) --* 

        The most recent time at which the training dataset was updated.

        
      

      - **trainingDatasetArn** *(string) --* 

        The Amazon Resource Name (ARN) of the training dataset.

        
      

      - **name** *(string) --* 

        The name of the training dataset.

        
      

      - **trainingData** *(list) --* 

        Metadata about the requested training data.

        
        

        - *(dict) --* 

          Defines where the training dataset is located, what type of data it contains, and how to access the data.

          
          

          - **type** *(string) --* 

            What type of information is found in the dataset.

            
          

          - **inputConfig** *(dict) --* 

            A DatasetInputConfig object that defines the data source and schema mapping.

            
            

            - **schema** *(list) --* 

              The schema information for the training data.

              
              

              - *(dict) --* 

                Metadata for a column.

                
                

                - **columnName** *(string) --* 

                  The name of a column.

                  
                

                - **columnTypes** *(list) --* 

                  The data type of column.

                  
                  

                  - *(string) --* 
              
            
          
            

            - **dataSource** *(dict) --* 

              A DataSource object that specifies the Glue data source for the training data.

              
              

              - **glueDataSource** *(dict) --* 

                A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.

                
                

                - **tableName** *(string) --* 

                  The Glue table that contains the training data.

                  
                

                - **databaseName** *(string) --* 

                  The Glue database that contains the training data.

                  
                

                - **catalogId** *(string) --* 

                  The Glue catalog that contains the training data.

                  
            
          
        
      
    
      

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

        The status of the training dataset.

        
      

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

        The IAM role used to read the training data.

        
      

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

        The tags that are assigned to this training dataset.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
      

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

        The description of the training dataset.

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

  
  *   :py:class:`CleanRoomsML.Client.exceptions.AccessDeniedException`

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

  