

 新客户不再可以使用亚马逊 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) 操作创建的假设分析预测列表。对于每个假设分析预测，该操作返回其属性摘要，包括 Amazon 资源名称（ARN）。您可以通过将假设分析预测 ARN 与 [DescribeWhatIfForecast](API_DescribeWhatIfForecast.md) 操作结合使用，检索完整的属性集。

**重要**  
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>
筛选条件数组。对于每个筛选条件，都要提供一个条件和一个匹配语句。条件为 `IS` 或 `IS_NOT`，指定包括还是从列表中排除与语句匹配的假设分析预测导出作业。匹配语句包含一个键和一个值。  
 **筛选条件属性**   
+  `Condition` - 适用的条件。有效值为 `IS` 和 `IS_NOT`。要包括与语句匹配的预测导出作业，请指定 `IS`。要排除匹配的预测导出作业，请指定 `IS_NOT`。
+  `Key` - 要筛选的参数的名称。有效值为 `WhatIfForecastArn` 和 `Status`。
+  `Value` - 要匹配的值。
例如，要列出导出名为*电力预测的所有作业 WhatIfForecast*，请指定以下过滤器：  
 `"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 SDK 中使用此 API 的更多信息，请参阅以下内容：
+  [AWS 命令行接口 V2 ](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS .NET V4 软件开发工具包 ](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 适用于 C\+\+ 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 适用于 Go 的 SDK 版本 ](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS Java V2 软件开发工具包 ](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS JavaScript V3 版 SDK ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS PHP V3 软件开发工具包 ](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS 适用于 Python (Boto3) 的 SDK](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/ListWhatIfForecasts) 
+  [AWS Ruby V3 软件开发工具包 ](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/ListWhatIfForecasts) 