DescribeWhatIfForecast - Amazon Forecast
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラー以下の資料も参照してください。

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribeWhatIfForecast

CreateWhatIfForecast オペレーションを使用して作成された What-If 予想を記述します。

重要

Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら

このオペレーションは、CreateWhatIfForecast リクエストで提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。

  • CreationTime

  • LastModificationTime

  • Message - エラーが発生した場合は、エラーに関する情報。

  • Status

リクエストの構文

{
   "WhatIfForecastArn": "string"
}

リクエストパラメータ

リクエストは、 JSON形式の次のデータを受け入れます。

WhatIfForecastArn

関心のある What-If 予想の Amazon リソースネーム (ARN）。

型: 文字列

長さの制限: 最大長は 300 です。

Pattern: 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"
}

レスポンス要素

アクションが成功すると、サービスは 200 HTTP レスポンスを返します。

以下のデータは、 サービスによって JSON 形式で返されます。

CreationTime

What-If 予想が作成された日時。

型: タイムスタンプ

EstimatedTimeRemainingInMinutes

What-If 予想を完了するまでのおおよその残り時間 (分単位)。

型: 長整数

ForecastTypes

確率的予測が生成される分位数。CreateWhatIfForecast オペレーションでの What-If 予想ごとに最大 5 つの分位を指定できます。分位数を指定しなかった場合、デフォルト値は ["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 - ジョブが終了または失敗した時点。

型: タイムスタンプ

Message

エラーが発生した場合は、エラーに関する情報メッセージ。

型: 文字列

Status

What-If 予想のステータス。含まれる状態は次のとおりです。

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • CREATE_STOPPING, CREATE_STOPPED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

注記

予想にアクセスするには、What-If 予想の Status が ACTIVE である必要があります。

型: 文字列

長さの制限：最大長は 256 です。

パターン: ^[a-zA-Z0-9\_]+$

TimeSeriesReplacementsDataSource

置換時系列を表す S3Config、Schema、Format 要素の配列。

型: TimeSeriesReplacementsDataSource オブジェクト

TimeSeriesTransformations

どの時系列にどの変換が適用されたかを記述する Action および TimeSeriesConditions 要素の配列。

型: TimeSeriesTransformation オブジェクトの配列

配列メンバー：最小数は 0 項目です。最大数は 30 項目です。

WhatIfAnalysisArn

この予測を含む What-If 分析の Amazon リソースネーム (ARN）。

型: 文字列

長さの制限：最大長は 256 です。

パターン: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastArn

What-If 予想の Amazon リソースネーム (ARN）。

型: 文字列

長さの制限: 最大長は 300 です。

パターン: arn:([a-z\d-]+):forecast:.*:.*:.+

WhatIfForecastName

What-If 予想の名前。

型: 文字列

長さの制限：最小長は 1 です。最大長は 63 です。

パターン: ^[a-zA-Z][a-zA-Z0-9_]*

エラー

InvalidInputException

無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。

HTTP ステータスコード: 400

ResourceNotFoundException

Amazon リソースネーム () を持つリソースが見つかりませんARN。を確認してARN、もう一度試してください。

HTTP ステータスコード: 400

以下の資料も参照してください。

言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。