AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a recipe.

A recipe contains three items:

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginDescribeRecipe and EndDescribeRecipe.

Namespace: Amazon.Personalize
Assembly: AWSSDK.Personalize.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<DescribeRecipeResponse> DescribeRecipeAsync(
         DescribeRecipeRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Personalize.Model.DescribeRecipeRequest

Container for the necessary parameters to execute the DescribeRecipe service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the DescribeRecipe service method, as returned by Personalize.

Exceptions

ExceptionCondition
InvalidInputException Provide a valid value for the field or parameter.
ResourceNotFoundException Could not find the specified resource.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also