Comprehend / Client / describe_dataset



Returns information about the dataset that you specify. For more information about datasets, see Flywheel overview in the Amazon Comprehend Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset(

DatasetArn (string) –


The ARN of the dataset.

Return type:



Response Syntax

    'DatasetProperties': {
        'DatasetArn': 'string',
        'DatasetName': 'string',
        'DatasetType': 'TRAIN'|'TEST',
        'DatasetS3Uri': 'string',
        'Description': 'string',
        'Status': 'CREATING'|'COMPLETED'|'FAILED',
        'Message': 'string',
        'NumberOfDocuments': 123,
        'CreationTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1)

Response Structure

  • (dict) –

    • DatasetProperties (dict) –

      The dataset properties.

      • DatasetArn (string) –

        The ARN of the dataset.

      • DatasetName (string) –

        The name of the dataset.

      • DatasetType (string) –

        The dataset type (training data or test data).

      • DatasetS3Uri (string) –

        The S3 URI where the dataset is stored.

      • Description (string) –

        Description of the dataset.

      • Status (string) –

        The dataset status. While the system creates the dataset, the status is CREATING. When the dataset is ready to use, the status changes to COMPLETED.

      • Message (string) –

        A description of the status of the dataset.

      • NumberOfDocuments (integer) –

        The number of documents in the dataset.

      • CreationTime (datetime) –

        Creation time of the dataset.

      • EndTime (datetime) –

        Time when the data from the dataset becomes available in the data lake.