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

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

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

ListForecasts

CreateForecast オペレーションを使用して作成された予測のリストを返します。このオペレーションは、予測ごとに、Amazon リソースネーム () を含むプロパティの概要を返しますARN。プロパティの完全なセットを取得するには、 DescribeForecastオペレーションARNで を指定します。Filter オブジェクトの配列を使用してリストをフィルタリングできます。

重要

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

リクエストの構文

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

リクエストパラメータ

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

Filters

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

フィルタープロパティ

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

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

  • Value - 照合する値。

例えば、ステータスが でないすべての予測を一覧表示するにはACTIVE、以下を指定します。

"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]

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

必須：いいえ

MaxResults

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

型: 整数

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

必須：いいえ

NextToken

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

型: 文字列

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

パターン: .+

必須：いいえ

レスポンスの構文

{
   "Forecasts": [ 
      { 
         "CreatedUsingAutoPredictor": boolean,
         "CreationTime": number,
         "DatasetGroupArn": "string",
         "ForecastArn": "string",
         "ForecastName": "string",
         "LastModificationTime": number,
         "Message": "string",
         "PredictorArn": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

レスポンス要素

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

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

Forecasts

各予測のプロパティを要約するオブジェクトの配列。

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

NextToken

レスポンスが切り捨てられた場合、Amazon Forecast はこのトークンを返します。次の結果セットを取得するには、次のリクエストでトークンを使用します。

型: 文字列

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

パターン: .+

エラー

InvalidInputException

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

HTTP ステータスコード: 400

InvalidNextTokenException

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

HTTP ステータスコード: 400

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

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