Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

  • CreationTime

  • LastModificationTime

  • Status

post/#X-Amz-Target=AmazonForecast.DescribeDataset

Headers

X-Amz-Target'AmazonForecast.DescribeDataset' required

Request body

DatasetArnstring required

The Amazon Resource Name (ARN) of the dataset.

Response

Success

DatasetArnstring

The Amazon Resource Name (ARN) of the dataset.

DatasetNamestring

The name of the dataset.

Domain'RETAIL' | 'CUSTOM' | 'INVENTORY_PLANNING' | 'EC2_CAPACITY' | 'WORK_FORCE' | 'WEB_TRAFFIC' | 'METRICS'

The domain associated with the dataset.

DatasetType'TARGET_TIME_SERIES' | 'RELATED_TIME_SERIES' | 'ITEM_METADATA'

The dataset type.

DataFrequencystring
<p>The frequency of data collection.</p> <p>Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.</p>
Statusstring
<p>The status of the dataset. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <p>The <code>UPDATE</code> states apply while data is imported to the dataset from a call to the <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation and reflect the status of the dataset import job. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>.</p> <note> <p>The <code>Status</code> of the dataset must be <code>ACTIVE</code> before you can import training data.</p> </note>
CreationTimestring date-time

When the dataset was created.

LastModificationTimestring date-time

When you create a dataset, <code>LastModificationTime</code> is the same as <code>CreationTime</code>. While data is being imported to the dataset, <code>LastModificationTime</code> is the current time of the <code>DescribeDataset</code> call. After a <a href="https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html">CreateDatasetImportJob</a> operation has finished, <code>LastModificationTime</code> is when the import job completed or failed.