---
title: "POST /#X-Amz-Target=AmazonForecast.DescribeDataset"
method: POST
path: "/#X-Amz-Target=AmazonForecast.DescribeDataset"
---

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

`POST /#X-Amz-Target=AmazonForecast.DescribeDataset`

Describes an Amazon Forecast dataset created using the [CreateDataset](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDataset.html) operation.

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

*   `CreationTime`
    
*   `LastModificationTime`
    
*   `Status`

## Headers

- `X-Amz-Target` 'AmazonForecast.DescribeDataset', required

## Request body

- DescribeDatasetRequest
  - `DatasetArn` string, required — The Amazon Resource Name (ARN) of the dataset.

## Response `200`

Success

- DescribeDatasetResponse
  - `DatasetArn` string — The Amazon Resource Name (ARN) of the dataset.
  - `DatasetName` string — 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.
  - `DataFrequency` string — <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>
  - `Schema` object — An array of <code>SchemaAttribute</code> objects that specify the dataset fields. Each <code>SchemaAttribute</code> specifies the name and data type of a field.
    - `Attributes` SchemaAttribute[] — An array of attributes specifying the name and type of each field in a dataset.
      - `AttributeName` string — The name of the dataset field.
      - `AttributeType` 'string' | 'integer' | 'float' | 'timestamp' | 'geolocation' — <p>The data type of the field.</p> <p>For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).</p>
  - `EncryptionConfig` object — The Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    - `RoleArn` string, required — <p>The ARN of the IAM role that Amazon Forecast can assume to access the KMS key.</p> <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an <code>InvalidInputException</code> error.</p>
    - `KMSKeyArn` string, required — The Amazon Resource Name (ARN) of the KMS key.
  - `Status` string — <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>
  - `CreationTime` string, date-time — When the dataset was created.
  - `LastModificationTime` string, 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.

## Other responses

- `480` — InvalidInputException
- `481` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/forecast.md) · [All operations](https://skmtc.net/aws/apis/forecast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/forecast/versions/3d1c872d2ac9/schema)