Amazon Forecast は、新規顧客では利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeForecast
CreateForecast オペレーションを使用して作成された予測を記述します。
重要
Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。詳細はこちら
このオペレーションは、CreateForecast
リクエストで提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。
-
DatasetGroupArn
- トレーニングデータを提供したデータセットグループ。 -
CreationTime
-
LastModificationTime
-
Status
-
Message
- エラーが発生した場合は、エラーに関する情報。
リクエストの構文
{
"ForecastArn": "string
"
}
リクエストパラメータ
リクエストは、 JSON形式の次のデータを受け入れます。
- ForecastArn
-
予測の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限:最大長は 256 です。
Pattern:
arn:([a-z\d-]+):forecast:.*:.*:.+
必須:はい
レスポンスの構文
{
"CreationTime": number,
"DatasetGroupArn": "string",
"EstimatedTimeRemainingInMinutes": number,
"ForecastArn": "string",
"ForecastName": "string",
"ForecastTypes": [ "string" ],
"LastModificationTime": number,
"Message": "string",
"PredictorArn": "string",
"Status": "string",
"TimeSeriesSelector": {
"TimeSeriesIdentifiers": {
"DataSource": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"Format": "string",
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
}
}
}
}
レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを返します。
以下のデータは、 サービスによって JSON 形式で返されます。
- CreationTime
-
予測作成タスクが作成された時点。
型: タイムスタンプ
- DatasetGroupArn
-
予測子ARNのトレーニングに使用されるデータを提供したデータセットグループの 。
型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+
- EstimatedTimeRemainingInMinutes
-
予測ジョブが完了するまでの推定残り時間 (分)。
型: 長整数
- ForecastArn
-
リクエストでARN指定された予測。
型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+
- ForecastName
-
予測の名前。
型: 文字列
長さの制限:最小長は 1 です。最大長は 63 です。
パターン:
^[a-zA-Z][a-zA-Z0-9_]*
- ForecastTypes
-
確率的予測が生成された分位数。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。
長さの制限: 最小長は 2 です。最大長は 4 です。
パターン:
(^0?\.\d\d?$|^mean$)
- LastModificationTime
-
リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。
-
CREATE_PENDING
(CreationTime
) -
CREATE_IN_PROGRESS
- 現在のタイムスタンプ。 -
CREATE_STOPPING
- 現在のタイムスタンプ。 -
CREATE_STOPPED
- ジョブが停止した時点。 -
ACTIVE
またはCREATE_FAILED
- ジョブが終了または失敗した時点。
型: タイムスタンプ
-
- Message
-
エラーが発生した場合は、エラーに関する情報メッセージ。
型: 文字列
- PredictorArn
-
予測の生成に使用されるARN予測子の 。
型: 文字列
長さの制限:最大長は 256 です。
パターン:
arn:([a-z\d-]+):forecast:.*:.*:.+
- Status
-
予測のステータス。含まれる状態は次のとおりです。
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
注記
予測をクエリまたはエクスポートする前に、予測の
Status
がACTIVE
となっている必要があります。型: 文字列
長さの制限:最大長は 256 です。
パターン:
^[a-zA-Z0-9\_]+$
-
- TimeSeriesSelector
-
予想に含める時系列。
型: TimeSeriesSelector オブジェクト
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード: 400
- ResourceNotFoundException
-
Amazon リソースネーム () を持つリソースが見つかりませんARN。を確認してARN、もう一度試してください。
HTTP ステータスコード: 400
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。