ListWhatIfForecastExports - Amazon Forecast

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

ListWhatIfForecastExports

返回使用 CreateWhatIfForecastExport 操作创建的假设分析预测导出的列表。对于每个假设分析预测导出,该操作返回其属性摘要,包括 Amazon 资源名称(ARN)。您可以通过将假设分析预测导出 ARN 与 DescribeWhatIfForecastExport 操作结合使用,检索完整的属性集。

请求语法

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

请求参数

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

Filters

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

筛选条件属性

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

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

  • Value - 要匹配的值。

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

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

类型:Filter 对象数组

必需:否

MaxResults

响应中需返回的项目数。

类型:整数

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

必需:否

NextToken

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

类型:字符串

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

模式:.+

必需:否

响应语法

{ "NextToken": "string", "WhatIfForecastExports": [ { "CreationTime": number, "Destination": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "LastModificationTime": number, "Message": "string", "Status": "string", "WhatIfForecastArns": [ "string" ], "WhatIfForecastExportArn": "string", "WhatIfForecastExportName": "string" } ] }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

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

NextToken

如果响应被截断,Forecast 将返回该令牌。要检索下一个结果集,请在下一个请求中使用令牌。

类型:字符串

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

模式:.+

WhatIfForecastExports

描述匹配预测导出的 WhatIfForecastExports 对象的数组。

类型:WhatIfForecastExportSummary 对象数组

错误

InvalidInputException

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

HTTP 状态代码:400

InvalidNextTokenException

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

HTTP 状态代码:400

另请参阅

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