Amazon Forecast は、新規のお客様は利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) 翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。 # DescribeWhatIfForecast [CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションを使用して作成された What-If 予想を記述します。 **重要** Amazon Forecast は新規顧客には利用できなくなりました。Amazon Forecast の既存のお客様は、通常どおりサービスを引き続き使用できます。[詳細はこちら](https://aws.amazon.com/blogs/machine-learning/transition-your-amazon-forecast-usage-to-amazon-sagemaker-canvas/) このオペレーションは、`CreateWhatIfForecast` リクエストで提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。 + `CreationTime` + `LastModificationTime` + `Message` - エラーが発生した場合は、エラーに関する情報。 + `Status` ## リクエストの構文 ``` { "WhatIfForecastArn": "string" } ``` ## リクエストパラメーターリクエストは以下のデータを JSON 形式で受け入れます。 ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_RequestSyntax) ** 関心がある What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` 必須: はい ## レスポンスの構文 ``` { "CreationTime": number, "EstimatedTimeRemainingInMinutes": number, "ForecastTypes": [ "string" ], "LastModificationTime": number, "Message": "string", "Status": "string", "TimeSeriesReplacementsDataSource": { "Format": "string", "S3Config": { "KMSKeyArn": "string", "Path": "string", "RoleArn": "string" }, "Schema": { "Attributes": [ { "AttributeName": "string", "AttributeType": "string" } ] }, "TimestampFormat": "string" }, "TimeSeriesTransformations": [ { "Action": { "AttributeName": "string", "Operation": "string", "Value": number }, "TimeSeriesConditions": [ { "AttributeName": "string", "AttributeValue": "string", "Condition": "string" } ] } ], "WhatIfAnalysisArn": "string", "WhatIfForecastArn": "string", "WhatIfForecastName": "string" } ``` ## レスポンス要素アクションが成功すると、サービスは HTTP 200 レスポンスを返します。サービスから以下のデータが JSON 形式で返されます。 ** [CreationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想が作成された日時。タイプ: タイムスタンプ ** [EstimatedTimeRemainingInMinutes](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想を完了するまでのおおよその残り時間 (分単位)。タイプ: Long ** [ForecastTypes](#API_DescribeWhatIfForecast_ResponseSyntax) ** 確率的予測が生成される分位数。[CreateWhatIfForecast](API_CreateWhatIfForecast.md) オペレーションでの What-If 予想ごとに最大 5 つの分位を指定できます。分位数を指定しなかった場合、デフォルト値は `["0.1", "0.5", "0.9"]` です。型: 文字列の配列配列メンバー: 最小数は 1 項目です。最大数は 20 項目です。長さの制限: 最小長は 2 です。最大長は 4 です。パターン: `(^0?\.\d\d?$|^mean$)` ** [LastModificationTime](#API_DescribeWhatIfForecast_ResponseSyntax) ** リソースの最終変更時刻。タイムスタンプは、ジョブのステータスによって異なります。 + `CREATE_PENDING` (`CreationTime`) + `CREATE_IN_PROGRESS` - 現在のタイムスタンプ。 + `CREATE_STOPPING` - 現在のタイムスタンプ。 + `CREATE_STOPPED` - ジョブが停止した時点。 + `ACTIVE` または `CREATE_FAILED` - ジョブが終了または失敗した時点。タイプ: タイムスタンプ ** [Message](#API_DescribeWhatIfForecast_ResponseSyntax) ** エラーが発生した場合は、エラーに関する情報メッセージ。タイプ: 文字列 ** [Status](#API_DescribeWhatIfForecast_ResponseSyntax) ** 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 です。パターン: `^[a-zA-Z0-9\_]+$` ** [TimeSeriesReplacementsDataSource](#API_DescribeWhatIfForecast_ResponseSyntax) ** 置換時系列を表す `S3Config`、`Schema`、`Format` 要素の配列。型: [TimeSeriesReplacementsDataSource](API_TimeSeriesReplacementsDataSource.md) オブジェクト ** [TimeSeriesTransformations](#API_DescribeWhatIfForecast_ResponseSyntax) ** どの時系列にどの変換が適用されたかを記述する `Action` および `TimeSeriesConditions` 要素の配列。型: [TimeSeriesTransformation](API_TimeSeriesTransformation.md) オブジェクトの配列配列メンバー: 最小数は 0 項目です。最大数は 30 項目です。 ** [WhatIfAnalysisArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** この What-If 予想を含む分析の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制約: 最大長は 256 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastArn](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想の Amazon リソースネーム (ARN)。タイプ: 文字列長さの制限: 最大長は 300 です。パターン: `arn:([a-z\d-]+):forecast:.*:.*:.+` ** [WhatIfForecastName](#API_DescribeWhatIfForecast_ResponseSyntax) ** What-If 予想の名前。タイプ: 文字列長さの制約: 最小長は 1 です。最大長は 63 です。パターン: `^[a-zA-Z][a-zA-Z0-9_]*` ## エラー ** InvalidInputException ** 無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。 HTTP ステータスコード: 400 ** ResourceNotFoundException ** その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。 HTTP ステータスコード: 400 ## 以下の資料も参照してください。言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。 + [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/forecast-2018-06-26/DescribeWhatIfForecast) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/forecast-2018-06-26/DescribeWhatIfForecast)