翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# DescribeRecipe
<a name="API_DescribeRecipe"></a>

レシピを説明を記述します。

レシピには 3 つのアイテムが含まれています。
+ モデルをトレーニングするアルゴリズム。
+ トレーニングを統制するハイパーパラメータ。
+ トレーニング前に入力データを変更するための特徴変換に関する情報。

Amazon Personalize は、事前定義された一連のレシピを提供します。[CreateSolution](https://docs.aws.amazon.com/personalize/latest/dg/API_CreateSolution.html) API を使用してソリューションを作成するときに、レシピを指定します。`CreateSolution` は、指定されたレシピのアルゴリズムとトレーニングデータセットを使用してモデルをトレーニングします。ソリューションをキャンペーンとしてデプロイすると、[GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API を使用してレコメンデーションを提供できます。

## リクエストの構文
<a name="API_DescribeRecipe_RequestSyntax"></a>

```
{
   "recipeArn": "string"
}
```

## リクエストパラメーター
<a name="API_DescribeRecipe_RequestParameters"></a>

リクエストは以下のデータを JSON 形式で受け入れます。

 ** [recipeArn](#API_DescribeRecipe_RequestSyntax) **   <a name="personalize-DescribeRecipe-request-recipeArn"></a>
記述するレシピの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
長さの制約: 最大長は 256 です。  
パターン: `arn:([a-z\d-]+):personalize:.*:.*:.+`   
必須: はい

## レスポンスの構文
<a name="API_DescribeRecipe_ResponseSyntax"></a>

```
{
   "recipe": { 
      "algorithmArn": "string",
      "creationDateTime": number,
      "description": "string",
      "featureTransformationArn": "string",
      "lastUpdatedDateTime": number,
      "name": "string",
      "recipeArn": "string",
      "recipeType": "string",
      "status": "string"
   }
}
```

## レスポンス要素
<a name="API_DescribeRecipe_ResponseElements"></a>

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

 ** [recipe](#API_DescribeRecipe_ResponseSyntax) **   <a name="personalize-DescribeRecipe-response-recipe"></a>
レシピを記述するオブジェクト。  
型: [Recipe](API_Recipe.md) オブジェクト

## エラー
<a name="API_DescribeRecipe_Errors"></a>

 ** InvalidInputException **   
フィールドまたはパラメータに有効な値を指定します。  
HTTP ステータスコード: 400

 ** ResourceNotFoundException **   
指定されたリソースが見つかりませんでした。  
HTTP ステータスコード: 400

## 以下の資料も参照してください。
<a name="API_DescribeRecipe_SeeAlso"></a>

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+  [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecipe) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe)