DescribeDatasetCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ComprehendClient, DescribeDatasetCommand } from "@aws-sdk/client-comprehend"; // ES Modules import
// const { ComprehendClient, DescribeDatasetCommand } = require("@aws-sdk/client-comprehend"); // CommonJS import
const client = new ComprehendClient(config);
const input = { // DescribeDatasetRequest
  DatasetArn: "STRING_VALUE", // required
};
const command = new DescribeDatasetCommand(input);
const response = await client.send(command);
// { // DescribeDatasetResponse
//   DatasetProperties: { // DatasetProperties
//     DatasetArn: "STRING_VALUE",
//     DatasetName: "STRING_VALUE",
//     DatasetType: "TRAIN" || "TEST",
//     DatasetS3Uri: "STRING_VALUE",
//     Description: "STRING_VALUE",
//     Status: "CREATING" || "COMPLETED" || "FAILED",
//     Message: "STRING_VALUE",
//     NumberOfDocuments: Number("long"),
//     CreationTime: new Date("TIMESTAMP"),
//     EndTime: new Date("TIMESTAMP"),
//   },
// };

DescribeDatasetCommand Input

See DescribeDatasetCommandInput for more details

Parameter
Type
Description
DatasetArn
Required
string | undefined

The ARN of the dataset.

DescribeDatasetCommand Output

See DescribeDatasetCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DatasetProperties
DatasetProperties | undefined

The dataset properties.

Throws

Name
Fault
Details
InternalServerException
server

An internal server error occurred. Retry your request.

InvalidRequestException
client

The request is invalid.

ResourceNotFoundException
client

The specified resource ARN was not found. Check the ARN and try your request again.

TooManyRequestsException
client

The number of requests exceeds the limit. Resubmit your request later.

ComprehendServiceException
Base exception class for all service exceptions from Comprehend service.