Amazon Forecast
Developer Guide

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

DescribeRecipe

Returns information about a recipe, including the name of the recipe and the algorithms that it provides. For each algorithm, DescribeRecipe returns the parameter configuration that controls how the algorithm is run.

Request Syntax

{ "RecipeName": "string" }

Request Parameters

The request accepts the following data in JSON format.

RecipeName

The name of the recipe.

Type: String

Length Constraints: Maximum length of 256.

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

Required: Yes

Response Syntax

{ "Recipe": { "Name": "string", "Train": [ { "BackTestWindowCount": number, "BackTestWindowOffset": number, "MetricsBuckets": [ "string" ], "TrainingInfo": { "AlgorithmName": "string", "ForceNew": "string", "HPOInfo": { "HPOConfig": { "HyperParameterTuningJobObjective": { "MetricName": "string", "Type": "string" }, "ParameterRanges": { "CategoricalParameterRanges": [ { "Name": "string", "Values": [ "string" ] } ], "ContinuousParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string" } ], "IntegerParameterRanges": [ { "MaxValue": "string", "MinValue": "string", "Name": "string" } ] }, "ResourceLimits": { "MaxNumberOfTrainingJobs": number, "MaxParallelTrainingJobs": number }, "StaticHyperParameters": { "string" : "string" }, "Strategy": "string" }, "PerformHPO": "string" }, "TrainedModelName": "string", "TrainingDataWindowBeginDate": "string", "TrainingDataWindowEndDate": "string", "TrainingParameters": { "string" : "string" } } } ] }, "RecipeArn": "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.

Recipe

A Recipe object describing the recipe.

Type: RecipeItem object

RecipeArn

The Amazon Resource Name (ARN) of the custom recipe.

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: