DescribeForecast - Amazon Forecast

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

DescribeForecast

描述使用CreateForecast作業建立的預測。

除了列出CreateForecast要求中提供的屬性之外,此作業還會列出下列屬性:

  • DatasetGroupArn-提供訓練資料的資料集群組。

  • CreationTime

  • LastModificationTime

  • Status

  • Message-如果發生錯誤,請提供有關錯誤的資訊。

請求語法

{ "ForecastArn": "string" }

請求參數

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

ForecastArn

預測的 Amazon 資源名稱(ARN)。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

必要:是

回應語法

{ "CreationTime": number, "DatasetGroupArn": "string", "EstimatedTimeRemainingInMinutes": number, "ForecastArn": "string", "ForecastName": "string", "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "PredictorArn": "string", "Status": "string", "TimeSeriesSelector": { "TimeSeriesIdentifiers": { "DataSource": { "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" } }, "Format": "string", "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] } } } }

回應元素

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

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

CreationTime

建立預測建立任務的時間。

類型:Timestamp

DatasetGroupArn

提供用來訓練預測值之資料的資料集群組的 ARN。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

EstimatedTimeRemainingInMinutes

預測工作完成的預估剩餘時間 (以分鐘為單位)。

類型:Long

ForecastArn

在請求中指定的預測 ARN。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

ForecastName

預測的名稱。

類型:字串

長度限制:長度下限為 1。長度上限為 63。

模式:^[a-zA-Z][a-zA-Z0-9_]*

ForecastTypes

產生概率預測的分位數。

類型:字串陣列

陣列成員:項目數下限為 1。項目數上限為 20。

長度約束:最小長度為 2。長度上限為 4。

模式:(^0?\.\d\d?$|^mean$)

LastModificationTime

上次修改資源的時間。時間戳記取決於工作的狀態:

  • CREATE_PENDING-該CreationTime.

  • CREATE_IN_PROGRESS-當前時間戳。

  • CREATE_STOPPING-當前時間戳。

  • CREATE_STOPPED-工作停止的時候

  • ACTIVECREATE_FAILED-工作完成或失敗時。

類型:Timestamp

Message

如果發生錯誤,則會顯示有關錯誤的資訊訊息。

類型:字串

PredictorArn

用來產生預測之預測值的 ARN。

類型:字串

長度限制:長度上限為 256。

模式:arn:([a-z\d-]+):forecast:.*:.*:.+

Status

預測的狀態。各州包括:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

注意

預測必須是您ACTIVE才能查詢或匯出預測。Status

類型:字串

長度限制:長度上限為 256。

模式:^[a-zA-Z0-9\_]+$

TimeSeriesSelector

要納入預測的時間序列。

類型:TimeSeriesSelector 物件

錯誤

InvalidInputException

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

HTTP 狀態碼:400

ResourceNotFoundException

我們找不到具有該 Amazon 資源名稱(ARN)的資源。請檢查 ARN,然後再試一次。

HTTP 狀態碼:400

另請參閱

如需在語言特定的 AWS 開發套件之一中使用此 API 的詳細資訊,請參閱下列說明: