Skip to content

Describe Dataset

comprehend_describe_dataset R Documentation

Returns information about the dataset that you specify

Description

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

Usage

comprehend_describe_dataset(DatasetArn)

Arguments

DatasetArn

[required] The ARN of the dataset.

Value

A list with the following syntax:

list(
  DatasetProperties = list(
    DatasetArn = "string",
    DatasetName = "string",
    DatasetType = "TRAIN"|"TEST",
    DatasetS3Uri = "string",
    Description = "string",
    Status = "CREATING"|"COMPLETED"|"FAILED",
    Message = "string",
    NumberOfDocuments = 123,
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$describe_dataset(
  DatasetArn = "string"
)