ListForecasts - Amazon Forecast

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

ListForecasts

傳回使用作業建立的預測清CreateForecast單。對於每個預測,此操作都會返回其屬性的摘要,包括其 Amazon 資源名稱 (ARN)。若要擷取完整的屬性集,請使用DescribeForecast作業指定 ARN。您可以使用Filter物件陣列來篩選清單。

請求語法

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

請求參數

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

Filters

過濾器的陣列。對於每個篩選器,您都會提供條件和 match 陳述式。條件為ISIS_NOT,指定是否分別從清單中包含或排除符合陳述式的預測。match 語句由一個鍵和一個值組成。

過濾器屬性

  • Condition-適用的條件。有效值為 ISIS_NOT。若要包含符合陳述式的預測,請指定IS。若要排除相符的預測,請指定IS_NOT

  • Key-要篩選的參數名稱。有效值為 DatasetGroupArnPredictorArnStatus

  • Value-要匹配的值。

例如,若要列出狀態非「有效」的所有預測,您可以指定:

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

類型:Filter 物件陣列

必要:否

MaxResults

要在回應中傳回的項目數。

類型:整數

有效範圍:最小值為 1。最大值為 100。

必要:否

NextToken

如果前一NextToken個請求的結果被截斷,則響應包括. 若要擷取下一組結果,請在下一個要求中使用 Token。令牌在 24 小時後過期。

類型:字串

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

模式:.+

必要:否

回應語法

{ "Forecasts": [ { "CreatedUsingAutoPredictor": boolean, "CreationTime": number, "DatasetGroupArn": "string", "ForecastArn": "string", "ForecastName": "string", "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string" } ], "NextToken": "string" }

回應元素

如果動作成功,則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

Forecasts

摘要每個預測屬性的物件陣列。

類型:ForecastSummary 物件陣列

NextToken

如果回應遭到截斷,Amazon Forecast 會傳回此權杖。若要擷取下一組結果,請在下一個要求中使用 Token。

類型:字串

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

模式:.+

錯誤

InvalidInputException

我們無法處理要求,因為它包含無效值或超出有效範圍的值。

HTTP 狀態碼:400

InvalidNextTokenException

令牌無效。令牌在 24 小時後過期。

HTTP 狀態碼:400

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: