Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

In addition to listing the properties provided in the CreateWhatIfAnalysis request, this operation lists the following properties:

  • CreationTime

  • LastModificationTime

  • Message - If an error occurred, information about the error.

  • Status

post/#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysis

Headers

X-Amz-Target'AmazonForecast.DescribeWhatIfAnalysis' required

Request body

WhatIfAnalysisArnstring required

The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

Response

Success

WhatIfAnalysisNamestring

The name of the what-if analysis.

WhatIfAnalysisArnstring

The Amazon Resource Name (ARN) of the what-if analysis.

ForecastArnstring

The Amazon Resource Name (ARN) of the what-if forecast.

EstimatedTimeRemainingInMinutesinteger

The approximate time remaining to complete the what-if analysis, in minutes.

Statusstring
<p>The status of the what-if analysis. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the what-if analysis must be <code>ACTIVE</code> before you can access the analysis.</p> </note>
Messagestring

If an error occurred, an informational message about the error.

CreationTimestring date-time

When the what-if analysis was created.

LastModificationTimestring date-time
<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>