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