Post x amz targetamazonforecast.describedatasetimportjob

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes a dataset import job created using the CreateDatasetImportJob 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.

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

Headers

X-Amz-Target'AmazonForecast.DescribeDatasetImportJob' required

Request body

DatasetImportJobArnstring required

The Amazon Resource Name (ARN) of the dataset import job.

Response

Success

DatasetImportJobNamestring

The name of the dataset import job.

DatasetImportJobArnstring

The ARN of the dataset import job.

DatasetArnstring

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

TimestampFormatstring

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 <ul> <li> "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D </li> <li> "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D </li> </ul>

TimeZonestring

The single time zone applied to every item in the dataset

UseGeolocationForTimeZoneboolean

Whether <code>TimeZone</code> is automatically derived from the geolocation attribute.

GeolocationFormatstring

The format of the geolocation attribute. Valid Values:<code>"LAT_LONG"</code> and <code>"CC_POSTALCODE"</code>.

EstimatedTimeRemainingInMinutesinteger

The estimated time remaining in minutes for the dataset import job to complete.

FieldStatisticsobject

Statistical information about each field in the input data.

DataSizenumber double

The size of the dataset in gigabytes (GB) after the import job has finished.

Statusstring

The status of the dataset import job. States include: <ul> <li> <code>ACTIVE</code> </li> <li> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </li> <li> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </li> <li> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </li> </ul>

Messagestring

If an error occurred, an informational message about the error.

CreationTimestring date-time

When the dataset import job was created.

LastModificationTimestring date-time

The last time the resource was modified. The timestamp depends on the status of the job: <ul> <li> <code>CREATE_PENDING</code> - The <code>CreationTime</code>. </li> <li> <code>CREATE_IN_PROGRESS</code> - The current timestamp. </li> <li> <code>CREATE_STOPPING</code> - The current timestamp. </li> <li> <code>CREATE_STOPPED</code> - When the job stopped. </li> <li> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed. </li> </ul>

Formatstring

The format of the imported data, CSV or PARQUET.

ImportMode'FULL' | 'INCREMENTAL'

The import mode of the dataset import job, FULL or INCREMENTAL.