Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

DatasetProperties - Amazon Comprehend API Reference

DatasetProperties

Properties associated with the dataset.

Contents

CreationTime

Creation time of the dataset.

Type: Timestamp

Required: No

DatasetArn

The ARN of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:flywheel/[a-zA-Z0-9](-*[a-zA-Z0-9])*/dataset/[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

DatasetName

The name of the dataset.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*$

Required: No

DatasetS3Uri

The S3 URI where the dataset is stored.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?

Required: No

DatasetType

The dataset type (training data or test data).

Type: String

Valid Values: TRAIN | TEST

Required: No

Description

Description of the dataset.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$

Required: No

EndTime

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

Type: Timestamp

Required: No

Message

A description of the status of the dataset.

Type: String

Required: No

NumberOfDocuments

The number of documents in the dataset.

Type: Long

Required: No

Status

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.

Type: String

Valid Values: CREATING | COMPLETED | FAILED

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.