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

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

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

Describes a dataset import job created using the [CreateDatasetImportJob](https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) operation.

In addition to listing the parameters provided in the `CreateDatasetImportJob` request, this operation includes the following properties:

*   `CreationTime`
    
*   `LastModificationTime`
    
*   `DataSize`
    
*   `FieldStatistics`
    
*   `Status`
    
*   `Message` - If an error occurred, information about the error.

## Headers

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

## Request body

- DescribeDatasetImportJobRequest
  - `DatasetImportJobArn` string, required — The Amazon Resource Name (ARN) of the dataset import job.

## Response `200`

Success

- DescribeDatasetImportJobResponse
  - `DatasetImportJobName` string — The name of the dataset import job.
  - `DatasetImportJobArn` string — The ARN of the dataset import job.
  - `DatasetArn` string — The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
  - `TimestampFormat` string — <p>The format of timestamps in the dataset. The format that you specify depends on the <code>DataFrequency</code> specified when the dataset was created. The following formats are supported</p> <ul> <li> <p>"yyyy-MM-dd"</p> <p>For the following data frequencies: Y, M, W, and D</p> </li> <li> <p>"yyyy-MM-dd HH:mm:ss"</p> <p>For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D</p> </li> </ul>
  - `TimeZone` string — The single time zone applied to every item in the dataset
  - `UseGeolocationForTimeZone` boolean — Whether <code>TimeZone</code> is automatically derived from the geolocation attribute.
  - `GeolocationFormat` string — The format of the geolocation attribute. Valid Values:<code>"LAT_LONG"</code> and <code>"CC_POSTALCODE"</code>.
  - `DataSource` object — <p>The location of the training data to import and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.</p> <p>If encryption is used, <code>DataSource</code> includes an Key Management Service (KMS) key.</p>
    - `S3Config` object, required — The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
      - `Path` string, required — The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
      - `RoleArn` string, required — <p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must allow access to the 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 — The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
  - `EstimatedTimeRemainingInMinutes` integer — The estimated time remaining in minutes for the dataset import job to complete.
  - `FieldStatistics` object — Statistical information about each field in the input data.
  - `DataSize` number, double — The size of the dataset in gigabytes (GB) after the import job has finished.
  - `Status` string — <p>The status of the dataset import job. 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>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul>
  - `Message` string — If an error occurred, an informational message about the error.
  - `CreationTime` string, date-time — When the dataset import job was created.
  - `LastModificationTime` string, date-time — <p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>
  - `Format` string — The format of the imported data, CSV or PARQUET.
  - `ImportMode` 'FULL' | 'INCREMENTAL' — The import mode of the dataset import job, FULL or INCREMENTAL.

## 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)