DescribeWhatIfAnalysis - Amazon Forecast

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

DescribeWhatIfAnalysis

描述使用作業建立的CreateWhatIfAnalysis假設分析。

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

  • CreationTime

  • LastModificationTime

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

  • Status

請求語法

{ "WhatIfAnalysisArn": "string" }

請求參數

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

WhatIfAnalysisArn

您感興趣的假設分析的 Amazon 資源名稱(ARN)。

類型:字串

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

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

必要:是

回應語法

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

回應元素

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

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

CreationTime

建立假設分析的時間。

類型:Timestamp

EstimatedTimeRemainingInMinutes

完成假設分析的剩餘時間 (以分鐘為單位)。

類型:Long

ForecastArn

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

類型:字串

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

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

LastModificationTime

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

  • CREATE_PENDING-該CreationTime.

  • CREATE_IN_PROGRESS-目前的時間戳記。

  • CREATE_STOPPING-目前的時間戳記。

  • CREATE_STOPPED-工作停止的時候

  • ACTIVECREATE_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\_]+$

TimeSeriesSelector

定義用於在TimeSeriesIdentifiers物件中建立預測的時間序列集。

TimeSeriesIdentifiers物件需要下列資訊:

  • DataSource

  • Format

  • Schema

類型:TimeSeriesSelector 物件

WhatIfAnalysisArn

假設分析的 Amazon 資源名稱(ARN)。

類型:字串

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

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

WhatIfAnalysisName

假設分析的名稱。

類型:字串

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

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

錯誤

InvalidInputException

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

HTTP 狀態碼:400

ResourceNotFoundException

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

HTTP 狀態碼:400

另請參閱

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