DatasetProperties ¶

class DatasetProperties(TypedDict, closed=True):
    dataset_arn: NotRequired[
        "capo_comprehend.types.comprehend_dataset_arn.ComprehendDatasetArn"
    ]
    """<p>The ARN of the dataset.</p>"""
    dataset_name: NotRequired[
        "capo_comprehend.types.comprehend_arn_name.ComprehendArnName"
    ]
    """<p>The name of the dataset.</p>"""
    dataset_type: NotRequired["capo_comprehend.types.dataset_type.DatasetType"]
    """<p>The dataset type (training data or test data).</p>"""
    dataset_s3_uri: NotRequired["capo_comprehend.types.s3_uri.S3Uri"]
    """<p>The S3 URI where the dataset is stored.</p>"""
    description: NotRequired["capo_comprehend.types.description.Description"]
    """<p>Description of the dataset.</p>"""
    status: NotRequired["capo_comprehend.types.dataset_status.DatasetStatus"]
    """<p>The dataset status. While the system creates the dataset, the status is <code>CREATING</code>. When the dataset is ready to use, the status changes to <code>COMPLETED</code>. </p>"""
    message: NotRequired["capo_comprehend.types.any_length_string.AnyLengthString"]
    """<p>A description of the status of the dataset.</p>"""
    number_of_documents: NotRequired[
        "capo_comprehend.types.number_of_documents.NumberOfDocuments"
    ]
    """<p>The number of documents in the dataset.</p>"""
    creation_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>Creation time of the dataset.</p>"""
    end_time: NotRequired["capo_comprehend.types.timestamp.Timestamp"]
    """<p>Time when the data from the dataset becomes available in the data lake.</p>"""