QueryForecast - Amazon Forecast

Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用該服務。了解更多」

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

QueryForecast

擷取單一項目的預測,並依提供的條件篩選。

該條件是一個鍵值對。索引鍵是TARGET_TIME_SERIES資料集中的 item_id (或等效的非時間戳記、非目標欄位),或是指定為物件一部分的預測維度之一。FeaturizationConfig

依預設,會QueryForecast傳回已篩選之預測的完整日期範圍。您可以請求特定的日期範圍。

若要取得完整的預測,請使用該CreateForecastExportJob作業。

注意

Amazon 預測產生的預測與用於建立預測值的資料集位於相同的時區。

請求語法

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

請求參數

請求接受採用 JSON 格式的下列資料。

EndDate

預測的結束日期。使用以下格式指定日期:年-月-日-日:公釐:SS (ISO 8601 格式)。例如,2015-01-01T20: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個請求的結果被截斷,則響應包括. 若要擷取下一組結果,請在下一個要求中使用 Token。令牌在 24 小時後過期。

類型:字串

長度限制:長度下限為 1。最大長度為 3000

必要:否

StartDate

預測的開始日期。使用以下格式指定日期:年-月-日-日:公釐:SS (ISO 8601 格式)。例如,2015-01-01T08: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 的詳細資訊,請參閱下列內容: