Amazon Forecast
Developer Guide

This is prerelease documentation for a service in preview release. It is subject to change.

DescribeDatasetImportJob

Returns information about a job that you created using the CreateDatasetImportJob operation to import training data to your Amazon Forecast dataset. It includes statistical information about each field in the input data.

For information about a specific data import job, specify both the dataset name and the version ID. If you don't provide a version ID, the operation uses the latest version ID.

Request Syntax

{ "DatasetName": "string", "VersionId": "string" }

Request Parameters

The request accepts the following data in JSON format.

DatasetName

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Required: Yes

VersionId

The version ID of the dataset that you want information about.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Required: No

Response Syntax

{ "DatasetArn": "string", "DatasetName": "string", "Delimiter": "string", "FieldStatistics": { "string" : { "Avg": number, "Count": number, "CountDistinct": number, "CountNan": number, "CountNull": number, "Max": "string", "Min": "string", "Stddev": number } }, "LastModificationTime": number, "Message": "string", "S3Uri": "string", "StartTime": number, "Status": "string", "VersionId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DatasetArn

The Amazon Resource Name (ARN) of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

DatasetName

The name of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Delimiter

The delimiter that separates the data elements in the input data. For example, a comma (,) or a pipe (|).

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_\*\?\,\|\^\-\/\#\s\(\)\+\\\\]+$

FieldStatistics

Statistical information about each field in the input data.

Type: String to Statistics object map

Key Length Constraints: Maximum length of 256.

Key Pattern: ^[a-zA-Z0-9\_]+$

LastModificationTime

The last modification time of the dataset import job.

Type: Timestamp

Message

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

Type: String

S3Uri

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the data that you want to import to your dataset is stored. For example:

s3://bucket-name/example-object.csv

Type: String

Length Constraints: Maximum length of 1024.

Pattern: ^[a-zA-Z0-9\-\_\.\/\:]+$

StartTime

The start time of the dataset import job.

Type: Timestamp

Status

The status of the dataset that is being refreshed: CREATING, ACTIVE, or FAILED.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

VersionId

The version ID of the dataset.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\_]+$

Errors

InternalServiceException

Request processing has failed due to some unknown error, exception, or failure.

HTTP Status Code: 400

InvalidInputException

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

HTTP Status Code: 400

ResourceAlreadyExistsException

There is already a resource with this name and characteristics. Try again with different settings.

HTTP Status Code: 400

ResourceNotFoundException

We can't find a resource with that name. Check the name and try again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: