:doc:`Personalize <../../personalize>` / Client / describe_dataset

****************
describe_dataset
****************



.. py:method:: Personalize.Client.describe_dataset(**kwargs)

  

  Describes the given dataset. For more information on datasets, see `CreateDataset <https://docs.aws.amazon.com/personalize/latest/dg/API_CreateDataset.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset>`_  


  **Request Syntax**
  ::

    response = client.describe_dataset(
        datasetArn='string'
    )
    
  :type datasetArn: string
  :param datasetArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the dataset to describe.

    

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

    
    ::

      {
          'dataset': {
              'name': 'string',
              'datasetArn': 'string',
              'datasetGroupArn': 'string',
              'datasetType': 'string',
              'schemaArn': 'string',
              'status': 'string',
              'creationDateTime': datetime(2015, 1, 1),
              'lastUpdatedDateTime': datetime(2015, 1, 1),
              'latestDatasetUpdate': {
                  'schemaArn': 'string',
                  'status': 'string',
                  'failureReason': 'string',
                  'creationDateTime': datetime(2015, 1, 1),
                  'lastUpdatedDateTime': datetime(2015, 1, 1)
              },
              'trackingId': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **dataset** *(dict) --* 

        A listing of the dataset's properties.

        
        

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

          The name of the dataset.

          
        

        - **datasetArn** *(string) --* 

          The Amazon Resource Name (ARN) of the dataset that you want metadata for.

          
        

        - **datasetGroupArn** *(string) --* 

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

          
        

        - **datasetType** *(string) --* 

          One of the following values:

           

          
          * Interactions
           
          * Items
           
          * Users
           
          * Actions
           
          * Action_Interactions
          

          
        

        - **schemaArn** *(string) --* 

          The ARN of the associated schema.

          
        

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

          The status of the dataset.

           

          A dataset can be in one of the following states:

           

          
          * CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
           
          * DELETE PENDING > DELETE IN_PROGRESS
          

          
        

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

          The creation date and time (in Unix time) of the dataset.

          
        

        - **lastUpdatedDateTime** *(datetime) --* 

          A time stamp that shows when the dataset was updated.

          
        

        - **latestDatasetUpdate** *(dict) --* 

          Describes the latest update to the dataset.

          
          

          - **schemaArn** *(string) --* 

            The Amazon Resource Name (ARN) of the schema that replaced the previous schema of the dataset.

            
          

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

            The status of the dataset update.

            
          

          - **failureReason** *(string) --* 

            If updating a dataset fails, provides the reason why.

            
          

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

            The creation date and time (in Unix time) of the dataset update.

            
          

          - **lastUpdatedDateTime** *(datetime) --* 

            The last update date and time (in Unix time) of the dataset.

            
      
        

        - **trackingId** *(string) --* 

          The ID of the event tracker for an Action interactions dataset. You specify the tracker's ID in the ``PutActionInteractions`` API operation. Amazon Personalize uses it to direct new data to the Action interactions dataset in your dataset group.

          
    
  
  **Exceptions**
  
  *   :py:class:`Personalize.Client.exceptions.InvalidInputException`

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

  