QueryForecast - Amazon Forecast

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

QueryForecast

检索单个项目的预测,按提供的条件进行筛选。

标准是键值对。关键是item_id(或等效的非时间戳、非目标字段)TARGET_TIME_SERIES数据集,或者指定为FeaturizationConfig对象。

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

要获得完整的预测,请使用CreateForecastExportJoboperation.

注意

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

请求语法

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

请求参数

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

EndDate

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

类型: 字符串

必需 否

Filters

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

{"item_id" : "client_21"}

要获得完整的预测,请使用CreateForecastExportJoboperation.

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

地图条目:最多 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'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软件开发工具包中使用此 API 的更多信息,请参阅以下内容: