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.

DescribeDeployedPredictor

Provides information about a deployed predictor. For information about deploying a predictor, see the DeployPredictor operation.

Request Syntax

{ "PredictorName": "string" }

Request Parameters

The request accepts the following data in JSON format.

PredictorName

The name of the predictor that you want information about.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax

{ "CompletionPercent": number, "CurrentlyDeployedVersionId": "string", "DeploymentInProgressVersionId": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "ScheduleExpression": "string", "StartTime": number, "Status": "string", "TargetCacheOffset": number }

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.

CompletionPercent

The progress of the current job.

Type: Integer

CurrentlyDeployedVersionId

The version ID of the predictor that is currently deployed. That is, the predictor version ID that Amazon Forecast used to run inference and generate the forecast.

Type: String

Length Constraints: Maximum length of 256.

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

DeploymentInProgressVersionId

The version ID of the predictor that is currently being deployed.

Type: String

Length Constraints: Maximum length of 256.

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

LastModificationTime

The last modification time of the deployed predictor.

Type: Timestamp

Message

If the deployment failed, the error message.

Type: String

PredictorArn

The Amazon Resource Name (ARN) of the predictor.

Type: String

Length Constraints: Maximum length of 256.

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

PredictorName

The name of the predictor.

Type: String

Length Constraints: Maximum length of 256.

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

ScheduleExpression

The schedule on which Amazon Forecast uses the predictor to run inference and generate forecasts.

Type: String

Length Constraints: Maximum length of 256.

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

StartTime

The start time of the deployed predictor.

Type: Timestamp

Status

The status of the deployment that is in progress.

Type: String

Length Constraints: Maximum length of 256.

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

TargetCacheOffset

The DescribeDeployedPredictor operation generates a forecast. Amazon Forecast then caches the forecast, for example, for visualization in the Amazon Forecast console. When visualizing the forecast, Amazon Forecast uses the TargetCacheOffset parameter to set the number of cached data points from the end of the target time series.

By default, Amazon Forecast caches the last target time series that is the size of the ForecastHorizon (which is set either in the recipe or overridden in the CreatePredictor operation that uses the recipe). For example, if ForecastHorizon is 30, Amazon Forecast caches the last 30 data points of the target time series.

Type: Integer

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: