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.

DescribeForecastExportJob

Returns the status of a forecast export job that was created with the CreateForecastExportJob operation.

Request Syntax

{ "ForecastExportJobId": "string" }

Request Parameters

The request accepts the following data in JSON format.

ForecastExportJobId

The ID of the forecast export job that you want status for.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax

{ "ForecastExportArn": "string", "ForecastId": "string", "LastModificationTime": number, "Message": "string", "OutputPath": { "RoleArn": "string", "S3Uri": "string" }, "StartTime": number, "Status": "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.

ForecastExportArn

The Amazon Resource Name (ARN) of the forecast export job.

Type: String

Length Constraints: Maximum length of 256.

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

ForecastId

The ID of the Amazon Forecast forecast that is being exported.

Type: String

Length Constraints: Maximum length of 256.

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

LastModificationTime

The last modification time of the forecast export job.

Type: Timestamp

Message

If the job failed, the error message.

Type: String

OutputPath

The path to the S3 bucket where the output is stored.

Type: S3DataSource object

StartTime

The start time of the forecast export job.

Type: Timestamp

Status

The status of the job.

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: