QueryWhatIfForecast - Amazon Forecast

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

QueryWhatIfForecast

What-If 予想を取得します。

リクエストの構文

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

リクエストパラメータ

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

EndDate

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

タイプ: 文字列

必須: いいえ

Filters

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

{"item_id" : "client_21"}

What-If 予想をすべて取得するには、 CreateForecastExportJobオペレーションを使用します。

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

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

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

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

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

必須: はい

NextToken

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

型: 文字列

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

必須: いいえ

StartDate

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

タイプ: 文字列

必須: いいえ

WhatIfForecastArn

クエリする What-If 予想の Amazon リソースネーム (ARN)。

型: 文字列

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

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

必須:はい

レスポンスの構文

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

レスポンス要素

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

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

Forecast

予測に関する情報を提供します。QueryForecast レスポンスの一部として返されます。

型: Forecast オブジェクト

エラー

InvalidInputException

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

HTTP ステータスコード:400

InvalidNextTokenException

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

HTTP ステータスコード:400

LimitExceededException

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

HTTP ステータスコード:400

ResourceInUseException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード:400

その他の参照資料

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