Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。進一步了解"
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
DescribeWhatIfForecast
描述使用 CreateWhatIfForecast操作建立的假設預測。
重要
Amazon Forecast 不再提供給新客戶。Amazon Forecast 的現有客戶可以繼續正常使用服務。進一步了解"
除了列出CreateWhatIfForecast
請求中提供的屬性之外,此操作還會列出下列屬性:
-
CreationTime
-
LastModificationTime
-
Message
- 如果發生錯誤,請提供錯誤的相關資訊。 -
Status
請求語法
{
"WhatIfForecastArn": "string
"
}
請求參數
請求接受採用 JSON 格式的下列資料。
- WhatIfForecastArn
-
您感興趣的假設預測的 Amazon Resource Name (ARN)。
類型:字串
長度限制:長度上限為 300。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
必要:是
回應語法
{
"CreationTime": number,
"EstimatedTimeRemainingInMinutes": number,
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"TimeSeriesReplacementsDataSource": {
"Format": "string",
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
},
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
},
"TimestampFormat": "string"
},
"TimeSeriesTransformations": [
{
"Action": {
"AttributeName": "string",
"Operation": "string",
"Value": number
},
"TimeSeriesConditions": [
{
"AttributeName": "string",
"AttributeValue": "string",
"Condition": "string"
}
]
}
],
"WhatIfAnalysisArn": "string",
"WhatIfForecastArn": "string",
"WhatIfForecastName": "string"
}
回應元素
如果動作成功,則服務傳回 HTTP 200 回應。
服務會傳回下列 JSON 格式的資料。
- CreationTime
-
建立假設預測時。
類型:Timestamp
- EstimatedTimeRemainingInMinutes
-
完成假設預測的剩餘大約時間,以分鐘為單位。
類型:Long
- ForecastTypes
-
產生概率預測的四分位數。您可以在 CreateWhatIfForecast操作中為每個假設預測指定最多五個四分位數。如果您未指定四分位數,預設值為
["0.1", "0.5", "0.9"]
。類型:字串陣列
陣列成員:項目數下限為 1。項目數上限為 20。
長度限制:長度下限為 2。長度上限為 4。
模式:
(^0?\.\d\d?$|^mean$)
- LastModificationTime
-
上次修改資源的時間。時間戳記取決於任務的狀態:
-
CREATE_PENDING
-CreationTime
。 -
CREATE_IN_PROGRESS
- 目前的時間戳記。 -
CREATE_STOPPING
- 目前的時間戳記。 -
CREATE_STOPPED
- 任務停止時。 -
ACTIVE
或CREATE_FAILED
- 任務完成或失敗時。
類型:Timestamp
-
- Message
-
如果發生錯誤,則會顯示有關錯誤的資訊訊息。
類型:字串
- Status
-
假設預測的狀態。狀態包括:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
注意
假設預測
Status
的 必須在您能夠存取預測ACTIVE
之前。類型:字串
長度限制:長度上限為 256。
模式:
^[a-zA-Z0-9\_]+$
-
- TimeSeriesReplacementsDataSource
-
描述取代時間序列的
S3Config
、Schema
和Format
元素陣列。 - TimeSeriesTransformations
-
Action
和TimeSeriesConditions
元素的陣列,描述套用哪些轉換到哪個時間序列。類型:TimeSeriesTransformation 物件陣列
陣列成員:項目數下限為 0。最多 30 個項目。
- WhatIfAnalysisArn
-
包含此預測之假設分析的 Amazon Resource Name (ARN)。
類型:字串
長度限制:長度上限為 256。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastArn
-
假設預測的 Amazon Resource Name (ARN)。
類型:字串
長度限制:長度上限為 300。
模式:
arn:([a-z\d-]+):forecast:.*:.*:.+
- WhatIfForecastName
-
假設預測的名稱。
類型:字串
長度限制:長度下限為 1。長度上限為 63。
模式:
^[a-zA-Z][a-zA-Z0-9_]*
錯誤
- InvalidInputException
-
我們無法處理請求,因為它包含無效值或超過有效範圍的值。
HTTP 狀態碼:400
- ResourceNotFoundException
-
我們找不到具有該 Amazon Resource Name (ARN) 的資源。請檢查 ARN,然後再試一次。
HTTP 狀態碼:400
另請參閱
如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊,請參閱下列內容: