---
title: "POST /#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysis"
method: POST
path: "/#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysis"
---

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

`POST /#X-Amz-Target=AmazonForecast.DescribeWhatIfAnalysis`

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`

## Headers

- `X-Amz-Target` 'AmazonForecast.DescribeWhatIfAnalysis', required

## Request body

- DescribeWhatIfAnalysisRequest
  - `WhatIfAnalysisArn` string, required — The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

## Response `200`

Success

- DescribeWhatIfAnalysisResponse
  - `WhatIfAnalysisName` string — The name of the what-if analysis.
  - `WhatIfAnalysisArn` string — The Amazon Resource Name (ARN) of the what-if analysis.
  - `ForecastArn` string — The Amazon Resource Name (ARN) of the what-if forecast.
  - `EstimatedTimeRemainingInMinutes` integer — The approximate time remaining to complete the what-if analysis, in minutes.
  - `Status` string — <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>
  - `Message` string — If an error occurred, an informational message about the error.
  - `CreationTime` string, date-time — When the what-if analysis was created.
  - `LastModificationTime` string, 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>
  - `TimeSeriesSelector` TimeSeriesSelector — <p>Defines the set of time series that are used to create the forecasts in a <code>TimeSeriesIdentifiers</code> object.</p> <p>The <code>TimeSeriesIdentifiers</code> object needs the following information:</p> <ul> <li> <p> <code>DataSource</code> </p> </li> <li> <p> <code>Format</code> </p> </li> <li> <p> <code>Schema</code> </p> </li> </ul>
    - `TimeSeriesIdentifiers` object — Details about the import file that contains the time series for which you want to create forecasts.
      - `DataSource` DataSource — The source of your data, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an Key Management Service (KMS) key.
        - `S3Config` object, required — The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
          - `Path` string, required — The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
          - `RoleArn` string, required — <p>The ARN of the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the <code>KMSKeyArn</code> key, the role must allow access to the key.</p> <p>Passing a role across Amazon Web Services accounts is not allowed. If you pass a role that isn't in your account, you get an <code>InvalidInputException</code> error.</p>
          - `KMSKeyArn` string — The Amazon Resource Name (ARN) of an Key Management Service (KMS) key.
      - `Schema` Schema — Defines the fields of a dataset.
        - `Attributes` SchemaAttribute[] — An array of attributes specifying the name and type of each field in a dataset.
          - `AttributeName` string — The name of the dataset field.
          - `AttributeType` 'string' | 'integer' | 'float' | 'timestamp' | 'geolocation' — <p>The data type of the field.</p> <p>For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).</p>
      - `Format` string — The format of the data, either CSV or PARQUET.

## Other responses

- `480` — InvalidInputException
- `481` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/forecast.md) · [All operations](https://skmtc.net/aws/apis/forecast/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/forecast/versions/3d1c872d2ac9/schema)