Amazon Forecast
Developer Guide

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

DescribePredictor

Returns information about a predictor that you created using the CreatePredictor operation.

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

Request Syntax

{ "PredictorName": "string", "VersionId": "string" }

Request Parameters

The request accepts the following data in JSON format.

PredictorName

The name of a predictor that you want information about.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

VersionId

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

Type: String

Length Constraints: Maximum length of 256.

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

Required: No

Response Syntax

{ "CompletionPercent": number, "DatasetGroup": "string", "ForecastHorizon": number, "ForecastParameters": { "string" : "string" }, "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "PredictorName": "string", "RecipeName": "string", "RecipeParameters": { "BackTestWindowCount": number, "BackTestWindowOffset": number, "DefaultTrainingSubsampleRatio": number, "GroupByForecastKeys": [ "string" ], "HolidayCalendarName": "string", "MetricsBuckets": [ "string" ] }, "ScheduleExpression": "string", "StartTime": number, "Status": "string", "TrainingParameters": { "string" : "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.

CompletionPercent

The progress of the current job.

Type: Integer

DatasetGroup

The name of the dataset group used for training the predictor.

Type: String

Length Constraints: Maximum length of 256.

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

ForecastHorizon

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

Type: Integer

ForecastParameters

The forecast parameters to override when running inference to generate a forecast.

Type: String to string map

Key Length Constraints: Maximum length of 256.

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

Value Length Constraints: Maximum length of 256.

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

LastModificationTime

The last predictor modification time stamp.

Type: Timestamp

Message

If the creation of the predictor 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\_]+$

RecipeName

The name of the recipe.

Type: String

Length Constraints: Maximum length of 256.

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

RecipeParameters

The recipe parameters used, if any.

Type: RecipeParameters object

ScheduleExpression

The model retraining schedule.

Type: String

Length Constraints: Maximum length of 256.

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

StartTime

The start time for model training.

Type: Timestamp

Status

The status of the predictor.

Type: String

Length Constraints: Maximum length of 256.

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

TrainingParameters

The training parameters to override for model training. The parameters that you can override are listed in the individual recipes in Choosing an Amazon Forecast Recipe.

Type: String to string map

Key Length Constraints: Maximum length of 256.

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

Value Length Constraints: Maximum length of 256.

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

VersionId

The version ID of the predictor.

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: