Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
CreateForecast
予測子のトレーニングに使用された TARGET_TIME_SERIES データセット内の各アイテムの予測を作成します。これは、推論として知られています。低レイテンシーで単一の項目の予測を取得するには、QueryForecast オペレーションを使用します。完全な予測を Amazon Simple Storage Service (Amazon S3) バケットにエクスポートするには、CreateForecastExportJob オペレーションを使用します。
重要
Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
予測の範囲は、CreatePredictor リクエストで指定した ForecastHorizon の値によって決まります。予測をクエリするときに、予測内の特定の日付範囲をリクエストできます。
すべての予測のリストを取得するには、ListForecasts オペレーションを使用します。
注記
Amazon Forecast によって生成された予測は、予測子の作成に使用されたデータセットと同じタイムゾーンにあります。
詳細については、「予測の生成」を参照してください。
注記
予測をクエリまたはエクスポートする前に、予測の Status が ACTIVE となっている必要があります。DescribeForecast オペレーションを使用して、ステータスを取得します。
デフォルトでは、予測子のトレーニングに使用されたデータセットグループ内の各項目 (item_id) の予想が含まれます。ただし、TimeSeriesSelector オブジェクトを使用して時系列のサブセットに関する予想を生成することはできます。入力データセットに含まれていない指定の時系列では、予想の作成はスキップされます。予想エクスポートファイルには、これらの時系列や予測値は含まれません。
リクエストの構文
{
"ForecastName": "string",
"ForecastTypes": [ "string" ],
"PredictorArn": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TimeSeriesSelector": {
"TimeSeriesIdentifiers": {
"DataSource": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"Format": "string",
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
}
}
}
}リクエストパラメーター
リクエストは以下のデータを JSON 形式で受け入れます。
- ForecastName
-
予測の名前。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 63 です。
パターン:
^[a-zA-Z][a-zA-Z0-9_]*必須: はい
- ForecastTypes
-
確率的予測が生成される分位数。現在、予測ごとに最大 5 つの分位数を指定できます。使用可能な値には、
0.01 to 0.99(.01 の増分のみ) およびmeanが含まれます。分布が対称でない場合 (例えば、ベータおよび負の二項)、平均予測は中央値 (0.50) とは異なります。デフォルトの分位数は、予測子の作成時に指定した分位数です。分位数を指定しなかった場合、デフォルト値は
["0.1", "0.5", "0.9"]です。型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。
長さの制限: 最小長は 2 です。最大長は 4 です。
パターン:
(^0?\.\d\d?$|^mean$)必須: いいえ
- PredictorArn
-
予測の生成に使用する予測子の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+必須: はい
- Tags
-
サービスに適用し、予測の分類と整理に役立つオプションのメタデータ。各タグはキーとオプションの値で構成され、どちらもお客様側が定義します。
タグには以下のベーシックな制限があります。
-
リソースあたりのタグの最大数は 50 です。
-
タグキーはリソースごとにそれぞれ一意である必要があります。また、各タグキーに設定できる値は 1 つのみです。
-
キーの最大長 - 128 文字 (Unicode) (UTF-8)。
-
値の最大長 - 256 文字 (Unicode) (UTF-8)。
-
複数の のサービス間およびリソース間でタグ付けスキーマを使用する場合、他のサービスにも許容される文字数に制限がある可能性があることに注意してください。一般的に使用が許可される文字は、UTF-8 で表現可能な文字、数字、スペース、および以下の文字です: +、-、=、.、_、:、/、@。
-
タグのキーと値では、大文字と小文字が区別されます。
-
aws:、AWS:、またはキーのプレフィックスなどの大文字または小文字の組み合わせは使用しないでください。 AWS 使用のために予約されています。このプレフィックスが含まれるタグキーを編集したり削除することはできません。値にはこのプレフィックスを付けることができます。タグ値にはawsがプレフィックスとして付されているが、キーには付されていない場合、Forecast は、それをユーザータグとみなし、タグ数の上限である 50 個を計算する際に算入します。awsのキープレフィックスのみを持つタグは、リソース制限あたりのタグに算入されません。
型: Tag オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 200 項目です。
必須: いいえ
-
- TimeSeriesSelector
-
TimeSeriesIdentifiersオブジェクト内の予想を作成するために使用される時系列のセットを定義します。TimeSeriesIdentifiersオブジェクトには次の情報が必要です。-
DataSource -
Format -
Schema
型: TimeSeriesSelector オブジェクト
必須: いいえ
-
レスポンスの構文
{
"ForecastArn": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- ForecastArn
-
予測の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード: 400
- LimitExceededException
-
アカウントあたりのリソース数の制限を超えました。
HTTP ステータスコード: 400
- ResourceAlreadyExistsException
-
この名前のリソースは既に存在します。別の名前で再試行してください。
HTTP ステータスコード: 400
- ResourceInUseException
-
指定されたリソースは使用中です。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
