Amazon Forecast
Developer Guide

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

As of 6/6/19, Amazon Forecast no longer supports the following recipes: DeepAR, MDN, MLP, MQRNN, RFQR, and SQF. You can continue to use predictors created with these recipes to generate forecasts. However, you can’t use these recipes to create new predictors or to update existing predictors with new data. In addition, AutoML no longer considers these recipes. We’ve made these changes to ensure that Forecast offers the highest level of accuracy and robustness. We continue to support the ARIMA, DeepAR+, ETS, NPTS, and Prophet recipes.

DescribeDataset

Returns metadata for an Amazon Forecast dataset created using the CreateDataset operation.

Request Syntax

{ "DatasetName": "string" }

Request Parameters

The request accepts the following data in JSON format.

DatasetName

The name of the dataset that you want metadata for.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax

{ "DataFormat": "string", "DataFrequency": "string", "DatasetArn": "string", "DatasetName": "string", "DatasetType": "string", "Domain": "string", "ScheduleExpression": "string", "Schema": { "Attributes": [ { "AggregationMethod": "string", "AttributeName": "string", "AttributeType": "string", "BackFillMethod": "string", "FeatureType": "string", "FillMethod": "string", "FillValue": "string", "FrontFillMethod": "string" } ] }, "Status": "string", "TimeStampFormat": "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.

DataFormat

The format of the data that you can import.

Type: String

Valid Values: CSV

DataFrequency

The frequency of data collection specified as a number and interval combination.

Valid interval are M (Month), W (Week), D (Day), H (Hour), min (Minute), and S (Second). For example, "5D" indicates every 5 days and "15min" indicates every 15 minutes.

Type: String

Length Constraints: Maximum length of 256.

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

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\_]+$

DatasetType

The dataset type.

Type: String

Valid Values: TARGET_TIME_SERIES | RELATED_TIME_SERIES | ITEM_METADATA

Domain

The dataset domain.

Type: String

Valid Values: RETAIL | CUSTOM | INVENTORY_PLANNING | EC2_CAPACITY | WORK_FORCE | WEB_TRAFFIC | METRICS

ScheduleExpression

The schedule for automated imports to the dataset.

Type: String

Length Constraints: Maximum length of 256.

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

Schema

Provides information about the dataset schema.

Type: Schema object

Status

The dataset status. It reflects status of any import jobs in progress.

Type: String

Length Constraints: Maximum length of 256.

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

TimeStampFormat

The format of timestamps in the dataset. For example, yyyy-MM-dd HH:mm:ss. For more information, see https://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[a-zA-Z0-9\-\:\.\,\'\s]+$

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: