本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
ListWhatIfForecasts
傳回使用作業建立的假設預測清單。CreateWhatIfForecast對於每個假設預測,此作業都會傳回其屬性的摘要,包括其 Amazon 資源名稱 (ARN)。您可以使用假設預測 ARN 搭配作業來擷取完整的屬性集。DescribeWhatIfForecast
請求語法
{
"Filters": [
{
"Condition": "string
",
"Key": "string
",
"Value": "string
"
}
],
"MaxResults": number
,
"NextToken": "string
"
}
請求參數
請求接受採用 JSON 格式的下列資料。
- Filters
-
過濾器的陣列。對於每個篩選器,您都會提供條件和 match 陳述式。條件為
IS
或IS_NOT
,指定分別包含或排除符合清單中陳述式的假設預測匯出工作。匹配語句由一個鍵和一個值。過濾器屬性
-
Condition
-適用的條件。有效值為IS
和IS_NOT
。若要包含符合陳述式的預測匯出工作,請指定IS
。若要排除相符的預測匯出工作,請指定IS_NOT
。 -
Key
-要篩選的參數名稱。有效值為WhatIfForecastArn
和Status
。 -
Value
-要匹配的值。
例如,若要列出匯出名electricityWhatIf為「Forecast」之預測的所有工作,請指定下列篩選:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]
類型:Filter 物件陣列
必要:否
-
- MaxResults
-
要在回應中傳回的項目數。
類型:整數
有效範圍:最小值為 1。最大值為 100。
必要:否
- NextToken
-
如果先前請求的結果被截斷,則響應包括.
NextToken
要檢索下一組結果,請在下一個令牌中使用令牌 請求。令牌在 24 小時後過期。類型:字串
長度限制:長度下限為 1。最大長度為 3000。
模式:
.+
必要:否
回應語法
{
"NextToken": "string",
"WhatIfForecasts": [
{
"CreationTime": number,
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"WhatIfAnalysisArn": "string",
"WhatIfForecastArn": "string",
"WhatIfForecastName": "string"
}
]
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- NextToken
-
如果先前請求的結果被截斷,則響應包括.
NextToken
要檢索下一組結果,請在下一個令牌中使用令牌 請求。令牌在 24 小時後過期。類型:字串
長度限制:長度下限為 1。最大長度為 3000。
模式:
.+
- WhatIfForecasts
-
描述匹配預測的
WhatIfForecasts
對象數組。類型:WhatIfForecastSummary 物件陣列
錯誤
- InvalidInputException
-
我們無法處理要求,因為它包含無效值或超出有效範圍的值。
HTTP 狀態碼:400
- InvalidNextTokenException
-
令牌無效。令牌在 24 小時後過期。
HTTP 狀態碼:400
另請參閱
如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊,請參閱下列內容: