Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/)

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

# ListWhatIfForecasts
<a name="API_ListWhatIfForecasts"></a>

[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想のリストを返します。このオペレーションは、各 What-If 予想について、Amazon リソースネーム (ARN) を含むプロパティの概要を返します。[DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) オペレーションで What-If 予想 ARN を使用すると、プロパティの完全なセットを取得できます。

**重要**  
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 

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

```
{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}
```

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

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

 ** [Filters](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-Filters"></a>
フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は `IS` または `IS_NOT` のいずれかであり、それぞれについて、ステートメントに一致する What-If 予想エクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。  
 **フィルタープロパティ**   
+  `Condition` - 適用する条件。有効な値は、`IS` および `IS_NOT` です。ステートメントに一致する予測エクスポートジョブを含めるには、`IS` を指定します。一致する予測エクスポートジョブを除外するには、`IS_NOT` を指定します。
+  `Key` - フィルタリングするパラメータの名前。有効な値は、`WhatIfForecastArn` および `Status` です。
+  `Value` - 照合する値。
例えば、electricityWhatIfForecast という名前の予想をエクスポートするすべてのジョブを一覧表示するには、次のフィルターを指定します。  
 `"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]`   
タイプ: [Filter](API_Filter.md) オブジェクトの配列  
必須: いいえ

 ** [MaxResults](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-MaxResults"></a>
レスポンスで返される項目の数。  
タイプ: 整数  
有効範囲: 最小値 は 1 です。最大値は 100 です。  
必須: いいえ

 ** [NextToken](#API_ListWhatIfForecasts_RequestSyntax) **   <a name="forecast-ListWhatIfForecasts-request-NextToken"></a>
前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 3000 です。  
パターン: `.+`   
必須: いいえ

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

```
{
   "NextToken": "string",
   "WhatIfForecasts": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfForecastArn": "string",
         "WhatIfForecastName": "string"
      }
   ]
}
```

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

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

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

 ** [NextToken](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-NextToken"></a>
前のリクエストの結果が切り捨てられた場合、レスポンスには `NextToken` が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。  
タイプ: 文字列  
長さの制約: 最小長は 1 です。最大長は 3000 です。  
パターン: `.+` 

 ** [WhatIfForecasts](#API_ListWhatIfForecasts_ResponseSyntax) **   <a name="forecast-ListWhatIfForecasts-response-WhatIfForecasts"></a>
一致した予想を記述する `WhatIfForecasts` オブジェクトの配列。  
型: [WhatIfForecastSummary](API_WhatIfForecastSummary.md) オブジェクトの配列

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

 ** InvalidInputException **   
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。  
HTTP ステータスコード: 400

 ** InvalidNextTokenException **   
トークンが無効です。トークンの有効期間は 24 時間です。  
HTTP ステータスコード: 400

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

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