QueryForecast - Amazon Forecast
リクエストの構文リクエストパラメータレスポンスの構文レスポンス要素エラーその他の参照資料

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

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

QueryForecast

指定された基準でフィルタリングされた、単一の項目の予測を取得します。

基準は、キーバリューペアです。キーは、TARGET_TIME_SERIES データセットからの item_id (もしくは同等の非タイムスタンプ、非ターゲットフィールド)、または FeaturizationConfig オブジェクトの一部として指定された予測ディメンションの 1 つです。

デフォルトでは、QueryForecast は、フィルタリングされた予測の完全な日付範囲を返します。特定の日付範囲をリクエストできます。

完全な予測を取得するには、 CreateForecastExportJobオペレーションを使用します。

注記

Amazon Forecast によって生成された予測は、予測子の作成に使用されたデータセットと同じタイムゾーンにあります。

リクエストの構文

{
   "EndDate": "string",
   "Filters": { 
      "string" : "string" 
   },
   "ForecastArn": "string",
   "NextToken": "string",
   "StartDate": "string"
}

リクエストパラメータ

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

EndDate

予測の終了日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T20:00:00。

タイプ: 文字列

必須: いいえ

Filters

予測の取得時に適用するフィルター条件。例えば、電力使用量データセットの client_21 についての予測を取得するには、次のように指定します。

{"item_id" : "client_21"}

完全な予測を取得するには、 CreateForecastExportJobオペレーションを使用します。

型: 文字列間のマッピング

マップエントリ: 項目の最大数は 50 です。

キーの長さの制限: 最大長は 256 です。

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

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

必須: はい

ForecastArn

クエリする予測の Amazon リソースネーム (ARN)。

型: 文字列

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

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

必須：はい

NextToken

前のリクエストの結果が切り捨てられた場合、レスポンスには NextToken が含まれます。次の結果セットを取得するには、次のリクエストでトークンを使用します。トークンの有効期間は 24 時間です。

型: 文字列

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

必須: いいえ

StartDate

予測の開始日。次の形式を使用して日付を指定します: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 の形式)。例: 2015-01-01T08:00:00。

タイプ: 文字列

必須: いいえ

レスポンスの構文

{
   "Forecast": { 
      "Predictions": { 
         "string" : [ 
            { 
               "Timestamp": "string",
               "Value": number
            }
         ]
      }
   }
}

レスポンス要素

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

サービスから以下のデータが JSON 形式で返されます。

Forecast

予測。

型: Forecast オブジェクト

エラー

InvalidInputException

値が無効であるか、長すぎます。

HTTP ステータスコード：400

InvalidNextTokenException

トークンが無効です。トークンの有効期間は 24 時間です。

HTTP ステータスコード：400

LimitExceededException

1 秒あたりのリクエスト数の上限を超えています。

HTTP ステータスコード：400

ResourceInUseException

指定されたリソースは使用中です。

HTTP ステータスコード：400

ResourceNotFoundException

そのリソースを見つけることができません。入力した情報を確認して、再試行してください。

HTTP ステータスコード：400

その他の参照資料

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