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

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

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

ListWhatIfForecasts

CreateWhatIfForecast オペレーションを使用して作成された What-If 予想のリストを返します。What-If 予想ごとに、このオペレーションは Amazon リソースネーム () を含むプロパティの概要を返しますARN。ARN DescribeWhatIfForecast オペレーションで What-If 予測を使用して、プロパティの完全なセットを取得できます。

重要

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

リクエストの構文

{
   "Filters": [ 
      { 
         "Condition": "string",
         "Key": "string",
         "Value": "string"
      }
   ],
   "MaxResults": number,
   "NextToken": "string"
}

リクエストパラメータ

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

Filters

フィルターの配列。各フィルターについて、条件および match ステートメントを指定します。条件は IS または IS_NOT のいずれかであり、それぞれについて、ステートメントに一致する What-If 予想エクスポートジョブをリストに含めるか除外するかを指定します。match ステートメントは、キーと値で構成されます。

フィルタープロパティ

  • Condition - 適用する条件。有効な値は、IS および IS_NOT です。ステートメントに一致する予測エクスポートジョブを含めるには、IS を指定します。一致する予測エクスポートジョブを除外するには、IS_NOT を指定します。

  • Key - フィルタリングするパラメータの名前。有効な値は、WhatIfForecastArn および Status です。

  • Value - 照合する値。

たとえば、electricityWhatIfForecast という名前の予測をエクスポートするすべてのジョブを一覧表示するには、次のフィルターを指定します。

"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]

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

必須：いいえ

MaxResults

レスポンスで返される項目の数。

型: 整数

有効範囲: 最小値 は 1 です。最大値は 100 です。

必須：いいえ

NextToken

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

型: 文字列

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

パターン: .+

必須：いいえ

レスポンスの構文

{
   "NextToken": "string",
   "WhatIfForecasts": [ 
      { 
         "CreationTime": number,
         "LastModificationTime": number,
         "Message": "string",
         "Status": "string",
         "WhatIfAnalysisArn": "string",
         "WhatIfForecastArn": "string",
         "WhatIfForecastName": "string"
      }
   ]
}

レスポンス要素

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

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

NextToken

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

型: 文字列

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

パターン: .+

WhatIfForecasts

一致した予想を記述する WhatIfForecasts オブジェクトの配列。

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

エラー

InvalidInputException

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

HTTP ステータスコード: 400

InvalidNextTokenException

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

HTTP ステータスコード: 400

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

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