翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeWhatIfAnalysis
CreateWhatIfAnalysis オペレーションを使用して作成された What-If 分析について説明します。
このオペレーションは、CreateWhatIfAnalysis リクエストで提供されたプロパティの一覧表示に加えて、次のプロパティを一覧表示します。
-
CreationTime -
LastModificationTime -
Message- エラーが発生した場合は、エラーに関する情報。 -
Status
リクエストの構文
{
"WhatIfAnalysisArn": "string"
}リクエストパラメータ
リクエストは以下の JSON 形式のデータを受け入れます。
- WhatIfAnalysisArn
-
関心がある What-If 分析の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+必須：はい
レスポンスの構文
{
"CreationTime": number,
"EstimatedTimeRemainingInMinutes": number,
"ForecastArn": "string",
"LastModificationTime": number,
"Message": "string",
"Status": "string",
"TimeSeriesSelector": {
"TimeSeriesIdentifiers": {
"DataSource": {
"S3Config": {
"KMSKeyArn": "string",
"Path": "string",
"RoleArn": "string"
}
},
"Format": "string",
"Schema": {
"Attributes": [
{
"AttributeName": "string",
"AttributeType": "string"
}
]
}
}
},
"WhatIfAnalysisArn": "string",
"WhatIfAnalysisName": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- CreationTime
-
What-If 分析が作成された日時。
型: タイムスタンプ
- EstimatedTimeRemainingInMinutes
-
What-If 分析が完了するまでのおおよその残り時間 (分単位)。
型: 長整数
- ForecastArn
-
What-If 予想の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+ - 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 です。
パターン：
^[a-zA-Z0-9\_]+$ -
- TimeSeriesSelector
-
TimeSeriesIdentifiersオブジェクト内の予想を作成するために使用される時系列のセットを定義します。TimeSeriesIdentifiersオブジェクトには次の情報が必要です。-
DataSource -
Format -
Schema
タイプ：TimeSeriesSelector オブジェクト
-
- WhatIfAnalysisArn
-
What-If 分析の Amazon リソースネーム (ARN)。
型: 文字列
長さの制限：最大長は 256 です。
パターン：
arn:([a-z\d-]+):forecast:.*:.*:.+ - WhatIfAnalysisName
-
What-If 分析の名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 63 です。
パターン：
^[a-zA-Z][a-zA-Z0-9_]*
エラー
- InvalidInputException
-
無効な値または有効な範囲を超える値が含まれているため、リクエストを処理できません。
HTTP ステータスコード：400
- ResourceNotFoundException
-
その Amazon リソースネーム (ARN) を持つリソースが見つかりません。ARN を確認して、もう一度お試しください。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
