ListWhatIfForecasts - Amazon Forecast

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListWhatIfForecasts

返回使用 CreateWhatIfForecast 操作创建的假设分析预测列表。对于每个假设预测,此操作都会返回其属性的摘要,包括其亚马逊资源名称 () ARN。您可以通过在操作中使用假设预测ARN来检索完整的属性集。DescribeWhatIfForecast

重要

Amazon Forecast 不再向新买家开放。Amazon Forecast 的现有客户可以继续照常使用该服务。了解更多

请求语法

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

请求参数

该请求接受以下JSON格式的数据。

Filters

筛选条件数组。对于每个筛选条件,都要提供一个条件和一个匹配语句。条件为 ISIS_NOT,指定包括还是从列表中排除与语句匹配的假设分析预测导出作业。匹配语句包含一个键和一个值。

筛选条件属性

  • Condition - 适用的条件。有效值为 ISIS_NOT。要包括与语句匹配的预测导出作业,请指定 IS。要排除匹配的预测导出作业,请指定 IS_NOT

  • Key - 要筛选的参数的名称。有效值为 WhatIfForecastArnStatus

  • Value - 要匹配的值。

例如,要列出所有导出名为 Forecast 的预测electricityWhatIf的作业,请指定以下筛选条件:

"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]

类型:Filter 对象数组

必需:否

MaxResults

响应中需返回的项目数。

类型:整数

有效范围:最小值为 1。最大值为 100。

必需:否

NextToken

如果上一个请求的结果被截断,则响应将包含 NextToken。要检索下一个结果集,请在下一个请求中使用令牌。令牌在 24 小时后过期。

类型:字符串

长度限制:长度下限为 1。最大长度为 3000。

模式:.+

必需:否

响应语法

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

响应元素

如果操作成功,服务将发回 HTTP 200 响应。

以下数据由服务以JSON格式返回。

NextToken

如果上一个请求的结果被截断,则响应将包含 NextToken。要检索下一个结果集,请在下一个请求中使用令牌。令牌在 24 小时后过期。

类型:字符串

长度限制:长度下限为 1。最大长度为 3000。

模式:.+

WhatIfForecasts

描述匹配预测的 WhatIfForecasts 对象的数组。

类型:WhatIfForecastSummary 对象数组

错误

InvalidInputException

我们无法处理该请求,因为其包含无效值或超出有效范围的值。

HTTP状态码:400

InvalidNextTokenException

令牌无效。令牌在 24 小时后过期。

HTTP状态码:400

另请参阅

有关在特定语言API中使用它的更多信息 AWS SDKs,请参阅以下内容: