Amazon Forecast は、新規顧客では利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribePredictor
注記
このオペレーションは、 で作成されたレガシー予測子に対してのみ有効です CreatePredictor。レガシー予測子を使用していない場合は、DescribeAutoPredictor を使用します。
CreatePredictor オペレーションを使用して作成された予測子を記述します。
重要
Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
このオペレーションは、CreatePredictor リクエストで提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。
-
DatasetImportJobArns- トレーニングデータのインポートに使用されるデータセットのインポートジョブ。 -
AutoMLAlgorithmArns- 評価されたアルゴリズム (AutoML が実行される場合)。 -
CreationTime -
LastModificationTime -
Status -
Message- エラーが発生した場合は、エラーに関する情報。
リクエストの構文
{
"PredictorArn": "string"
}リクエストパラメータ
リクエストは、 JSON形式の次のデータを受け入れます。
- PredictorArn
-
情報が必要な予測子の Amazon リソースネーム (ARN）。
型: 文字列
長さの制限：最大長は 256 です。
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+必須：はい
レスポンスの構文
{
"AlgorithmArn": "string",
"AutoMLAlgorithmArns": [ "string" ],
"AutoMLOverrideStrategy": "string",
"CreationTime": number,
"DatasetImportJobArns": [ "string" ],
"EncryptionConfig": {
"KMSKeyArn": "string",
"RoleArn": "string"
},
"EstimatedTimeRemainingInMinutes": number,
"EvaluationParameters": {
"BackTestWindowOffset": number,
"NumberOfBacktestWindows": number
},
"FeaturizationConfig": {
"Featurizations": [
{
"AttributeName": "string",
"FeaturizationPipeline": [
{
"FeaturizationMethodName": "string",
"FeaturizationMethodParameters": {
"string" : "string"
}
}
]
}
],
"ForecastDimensions": [ "string" ],
"ForecastFrequency": "string"
},
"ForecastHorizon": number,
"ForecastTypes": [ "string" ],
"HPOConfig": {
"ParameterRanges": {
"CategoricalParameterRanges": [
{
"Name": "string",
"Values": [ "string" ]
}
],
"ContinuousParameterRanges": [
{
"MaxValue": number,
"MinValue": number,
"Name": "string",
"ScalingType": "string"
}
],
"IntegerParameterRanges": [
{
"MaxValue": number,
"MinValue": number,
"Name": "string",
"ScalingType": "string"
}
]
}
},
"InputDataConfig": {
"DatasetGroupArn": "string",
"SupplementaryFeatures": [
{
"Name": "string",
"Value": "string"
}
]
},
"IsAutoPredictor": boolean,
"LastModificationTime": number,
"Message": "string",
"OptimizationMetric": "string",
"PerformAutoML": boolean,
"PerformHPO": boolean,
"PredictorArn": "string",
"PredictorExecutionDetails": {
"PredictorExecutions": [
{
"AlgorithmArn": "string",
"TestWindows": [
{
"Message": "string",
"Status": "string",
"TestWindowEnd": number,
"TestWindowStart": number
}
]
}
]
},
"PredictorName": "string",
"Status": "string",
"TrainingParameters": {
"string" : "string"
}
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを返します。
以下のデータは、 サービスによって JSON 形式で返されます。
- AlgorithmArn
-
モデルトレーニングに使用されるアルゴリズムの Amazon リソースネーム (ARN）。
型: 文字列
長さの制限：最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+ - AutoMLAlgorithmArns
-
PerformAutoMLが指定されている場合、選択したアルゴリズムARNの 。型: 文字列の配列
長さの制限：最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+ - AutoMLOverrideStrategy
-
注記
LatencyOptimizedAutoML 上書き戦略は、プライベートベータでのみ使用できます。アクセス権限の詳細については、 AWS サポートまたはアカウントマネージャーにお問い合わせください。予測子のトレーニングに使用する AutoML 戦略。
LatencyOptimizedが指定されていない限り、AutoML 戦略は予測子の精度を最適化します。このパラメータは、AutoML を使用してトレーニングした予測子についてのみ有効です。
型: 文字列
有効な値:
LatencyOptimized | AccuracyOptimized - CreationTime
-
モデルトレーニングタスクが作成された時点。
型: タイムスタンプ
- DatasetImportJobArns
-
予測子ARNsのトレーニングデータをインポートするために使用されるデータセットインポートジョブの の配列。
型: 文字列の配列
長さの制限：最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+ - EncryptionConfig
-
Amazon Forecast がキーにアクセスするために引き受けることができる AWS Key Management Service （KMS) キーと AWS Identity and Access Management （IAM) ロール。
型: EncryptionConfig オブジェクト
- EstimatedTimeRemainingInMinutes
-
予測子トレーニングジョブが完了するまでの推定残り時間 (分)。
型: 長整数
- EvaluationParameters
-
指定されたアルゴリズムのデフォルトの評価パラメータを上書きするために使用されます。Amazon Forecast は、データセットをトレーニングデータとテストデータに分割することで予測子を評価します。評価パラメータは、分割の実行方法と反復回数を定義します。
型: EvaluationParameters オブジェクト
- FeaturizationConfig
-
特徴量化の設定。
型: FeaturizationConfig オブジェクト
- ForecastHorizon
-
予測のタイムステップの数。予測期間は予測長とも呼ばれます。
型: 整数
- ForecastTypes
-
予測子のトレーニング中に使用される予測タイプ。デフォルト値は
["0.1","0.5","0.9"]です型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。
長さの制限: 最小長は 2 です。最大長は 4 です。
パターン:
(^0?\.\d\d?$|^mean$) - HPOConfig
-
アルゴリズム用のハイパーパラメータの上書き値。
型: HyperParameterTuningJobConfig オブジェクト
- InputDataConfig
-
予測子のトレーニングに使用するデータを含むデータセットグループを記述します。
型: InputDataConfig オブジェクト
- IsAutoPredictor
-
予測子が CreateAutoPredictor を使用して作成されたかどうか。
型: ブール値
- LastModificationTime
-
リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。
-
CREATE_PENDING(CreationTime) -
CREATE_IN_PROGRESS- 現在のタイムスタンプ。 -
CREATE_STOPPING- 現在のタイムスタンプ。 -
CREATE_STOPPED- ジョブが停止した時点。 -
ACTIVEまたはCREATE_FAILED- ジョブが終了または失敗した時点。
型: タイムスタンプ
-
- Message
-
エラーが発生した場合は、エラーに関する情報メッセージ。
型: 文字列
- OptimizationMetric
-
予測子を最適化するために使用される精度メトリクス。
型: 文字列
有効な値:
WAPE | RMSE | AverageWeightedQuantileLoss | MASE | MAPE - PerformAutoML
-
予測子が AutoML を実行するように設定されているかどうか。
型: ブール値
- PerformHPO
-
予測子がハイパーパラメータ最適化 (HPO) を実行するように設定されているかどうか。
型: ブール値
- PredictorArn
-
予測子ARNの 。
型: 文字列
長さの制限：最小長は 1 です。最大長は 63 です。
パターン:
^[a-zA-Z][a-zA-Z0-9_]* - PredictorExecutionDetails
-
予測子の精度を評価するために実行されたバックテストのステータスと結果の詳細。CreatePredictor オペレーションを呼び出すときに実行するバックテストの数を指定します。
型: PredictorExecutionDetails オブジェクト
- PredictorName
-
予測子の名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 63 です。
パターン:
^[a-zA-Z][a-zA-Z0-9_]* - Status
-
予測子のステータス。含まれる状態は次のとおりです。
-
ACTIVE -
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILED -
DELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED -
CREATE_STOPPING,CREATE_STOPPED
注記
予測子を使用して予測を作成する前に、予測子の
StatusがACTIVEとなっている必要があります。型: 文字列
長さの制限：最大長は 256 です。
-
- TrainingParameters
-
モデルトレーニング中に選択されたデフォルトのトレーニングパラメータまたは上書き。AutoML を実行するか、CNN-QR または DeepAR + HPOで を選択すると、選択したハイパーパラメータに最適化された値が返されます。詳細については、「Amazon Forecast アルゴリズム」を参照してください。
型: 文字列間のマッピング
マップエントリ: 最小数は 0 項目です。最大数は 100 項目です。
キーの長さの制限: 最大長は 256 です。
キーパターン:
^[a-zA-Z0-9\-\_\.\/\[\]\,\\]+$値の長さの制限: 最大長は 256 です。
値のパターン:
^[a-zA-Z0-9\-\_\.\/\[\]\,\"\\\s]+$
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
Amazon リソースネーム () を持つリソースが見つかりませんARN。を確認してARN、もう一度試してください。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
