QueryForecast - Amazon Forecast

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

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

QueryForecast

根据提供的标准进行筛选,检索单个项目的预测。

标准是一个键值对。键可以是来自 TARGET_TIME_SERIES 数据集的item_id(或同等的非时间戳、非目标字段),也可以是作为 FeaturizationConfig 对象一部分指定的预测维度之一。

默认情况下,QueryForecast 返回筛选预测的完整日期范围。您可以请求特定的日期范围。

要获得完整的预测,请使用CreateForecastExportJob操作。

注意

Amazon Forecast 生成的预测与用于创建预测器的数据集处于同一时区。

请求语法

{ "EndDate": "string", "Filters": { "string" : "string" }, "ForecastArn": "string", "NextToken": "string", "StartDate": "string" }

请求参数

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

EndDate

预测的结束日期。使用以下格式指定日期:yyyy-MM-dd'T'HH:mm:ss(ISO 8601 格式)。例如 2015-01-01T20:00:00。

类型:字符串

必需:否

Filters

检索预测时需要应用的筛选标准。例如,要获取用电量数据集中 client_21 的预测,请指定以下内容:

{"item_id" : "client_21"}

要获得完整的预测,请使用CreateForecastExportJob操作。

类型:字符串到字符串映射

映射条目:最多 50 项。

密钥长度限制:最大长度为 256。

键模式:^[a-zA-Z0-9\_\-]+$

值长度限制:最大长度为 256。

必需:是

ForecastArn

要查询的预测的 Amazon 资源名称(ARN)。

类型:字符串

长度约束:最大长度为 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

必需:是

NextToken

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

类型:字符串

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

必需:否

StartDate

预测的开始日期。使用以下格式指定日期:yyyy-MM-dd'T'HH:mm:ss(ISO 8601 格式)。例如 2015-01-01T08:00:00。

类型:字符串

必需:否

响应语法

{ "Forecast": { "Predictions": { "string" : [ { "Timestamp": "string", "Value": number } ] } } }

响应元素

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

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

Forecast

预测。

类型:Forecast 对象

错误

InvalidInputException

该值无效或过长。

HTTP 状态代码:400

InvalidNextTokenException

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

HTTP 状态代码:400

LimitExceededException

超出每秒请求次数的限制。

HTTP 状态代码:400

ResourceInUseException

指定的资源正在使用中。

HTTP 状态代码:400

ResourceNotFoundException

我们无法找到该资源。检查您提供的信息,然后重试。

HTTP 状态代码:400

另请参阅

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