DescribeDatasetImportJobCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ForecastClient, DescribeDatasetImportJobCommand } from "@aws-sdk/client-forecast"; // ES Modules import
// const { ForecastClient, DescribeDatasetImportJobCommand } = require("@aws-sdk/client-forecast"); // CommonJS import
const client = new ForecastClient(config);
const input = { // DescribeDatasetImportJobRequest
  DatasetImportJobArn: "STRING_VALUE", // required
};
const command = new DescribeDatasetImportJobCommand(input);
const response = await client.send(command);
// { // DescribeDatasetImportJobResponse
//   DatasetImportJobName: "STRING_VALUE",
//   DatasetImportJobArn: "STRING_VALUE",
//   DatasetArn: "STRING_VALUE",
//   TimestampFormat: "STRING_VALUE",
//   TimeZone: "STRING_VALUE",
//   UseGeolocationForTimeZone: true || false,
//   GeolocationFormat: "STRING_VALUE",
//   DataSource: { // DataSource
//     S3Config: { // S3Config
//       Path: "STRING_VALUE", // required
//       RoleArn: "STRING_VALUE", // required
//       KMSKeyArn: "STRING_VALUE",
//     },
//   },
//   EstimatedTimeRemainingInMinutes: Number("long"),
//   FieldStatistics: { // FieldStatistics
//     "<keys>": { // Statistics
//       Count: Number("int"),
//       CountDistinct: Number("int"),
//       CountNull: Number("int"),
//       CountNan: Number("int"),
//       Min: "STRING_VALUE",
//       Max: "STRING_VALUE",
//       Avg: Number("double"),
//       Stddev: Number("double"),
//       CountLong: Number("long"),
//       CountDistinctLong: Number("long"),
//       CountNullLong: Number("long"),
//       CountNanLong: Number("long"),
//     },
//   },
//   DataSize: Number("double"),
//   Status: "STRING_VALUE",
//   Message: "STRING_VALUE",
//   CreationTime: new Date("TIMESTAMP"),
//   LastModificationTime: new Date("TIMESTAMP"),
//   Format: "STRING_VALUE",
//   ImportMode: "FULL" || "INCREMENTAL",
// };

DescribeDatasetImportJobCommand Input

See DescribeDatasetImportJobCommandInput for more details

Parameter
Type
Description
DatasetImportJobArn
Required
string | undefined

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

DescribeDatasetImportJobCommand Output

See DescribeDatasetImportJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreationTime
Date | undefined

When the dataset import job was created.

DataSize
number | undefined

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

DataSource
DataSource | undefined

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.

If encryption is used, DataSource includes an Key Management Service (KMS) key.

DatasetArn
string | undefined

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

DatasetImportJobArn
string | undefined

The ARN of the dataset import job.

DatasetImportJobName
string | undefined

The name of the dataset import job.

EstimatedTimeRemainingInMinutes
number | undefined

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

FieldStatistics
Record<string, Statistics> | undefined

Statistical information about each field in the input data.

Format
string | undefined

The format of the imported data, CSV or PARQUET.

GeolocationFormat
string | undefined

The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE".

ImportMode
ImportMode | undefined

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

LastModificationTime
Date | undefined

The last time the resource was modified. The timestamp depends on the status of the job:

  • CREATE_PENDING - The CreationTime.

  • CREATE_IN_PROGRESS - The current timestamp.

  • CREATE_STOPPING - The current timestamp.

  • CREATE_STOPPED - When the job stopped.

  • ACTIVE or CREATE_FAILED - When the job finished or failed.

Message
string | undefined

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

Status
string | undefined

The status of the dataset import job. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

TimeZone
string | undefined

The single time zone applied to every item in the dataset

TimestampFormat
string | undefined

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • "yyyy-MM-dd"

    For the following data frequencies: Y, M, W, and D

  • "yyyy-MM-dd HH:mm:ss"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

UseGeolocationForTimeZone
boolean | undefined

Whether TimeZone is automatically derived from the geolocation attribute.

Throws

Name
Fault
Details
InvalidInputException
client

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

ResourceNotFoundException
client

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

ForecastServiceException
Base exception class for all service exceptions from Forecast service.