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

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

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

Describes the what-if forecast created using the CreateWhatIfForecast operation.

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

*   `CreationTime`
    
*   `LastModificationTime`
    
*   `Message` - If an error occurred, information about the error.
    
*   `Status`

## Headers

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

## Request body

- DescribeWhatIfForecastRequest
  - `WhatIfForecastArn` string, required — The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

## Response `200`

Success

- DescribeWhatIfForecastResponse
  - `WhatIfForecastName` string — The name of the what-if forecast.
  - `WhatIfForecastArn` string — The Amazon Resource Name (ARN) of the what-if forecast.
  - `WhatIfAnalysisArn` string — The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
  - `EstimatedTimeRemainingInMinutes` integer — The approximate time remaining to complete the what-if forecast, in minutes.
  - `Status` string — <p>The status of the what-if forecast. 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 forecast must be <code>ACTIVE</code> before you can access the forecast.</p> </note>
  - `Message` string — If an error occurred, an informational message about the error.
  - `CreationTime` string, date-time — When the what-if forecast 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>
  - `TimeSeriesTransformations` TimeSeriesTransformation[] — An array of <code>Action</code> and <code>TimeSeriesConditions</code> elements that describe what transformations were applied to which time series.
    - `Action` object — An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.
      - `AttributeName` string, required — The related time series that you are modifying. This value is case insensitive.
      - `Operation` 'ADD' | 'SUBTRACT' | 'MULTIPLY' | 'DIVIDE', required — <p>The operation that is applied to the provided attribute. Operations include:</p> <ul> <li> <p> <code>ADD</code> - adds <code>Value</code> to all rows of <code>AttributeName</code>.</p> </li> <li> <p> <code>SUBTRACT</code> - subtracts <code>Value</code> from all rows of <code>AttributeName</code>.</p> </li> <li> <p> <code>MULTIPLY</code> - multiplies all rows of <code>AttributeName</code> by <code>Value</code>.</p> </li> <li> <p> <code>DIVIDE</code> - divides all rows of <code>AttributeName</code> by <code>Value</code>.</p> </li> </ul>
      - `Value` number, double, required — The value that is applied for the chosen <code>Operation</code>.
    - `TimeSeriesConditions` TimeSeriesCondition[] — An array of conditions that define which members of the related time series are transformed.
      - `AttributeName` string, required — The item_id, dimension name, IM name, or timestamp that you are modifying.
      - `AttributeValue` string, required — The value that is applied for the chosen <code>Condition</code>.
      - `Condition` 'EQUALS' | 'NOT_EQUALS' | 'LESS_THAN' | 'GREATER_THAN', required — The condition to apply. Valid values are <code>EQUALS</code>, <code>NOT_EQUALS</code>, <code>LESS_THAN</code> and <code>GREATER_THAN</code>.
  - `TimeSeriesReplacementsDataSource` object — An array of <code>S3Config</code>, <code>Schema</code>, and <code>Format</code> elements that describe the replacement time series.
    - `S3Config` S3Config, required — The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an Key Management Service (KMS) key. This object is part of the <a>DataSource</a> object that is submitted in the <a>CreateDatasetImportJob</a> request, and part of the <a>DataDestination</a> object.
      - `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, required — 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 replacement data, CSV or PARQUET.
    - `TimestampFormat` string — The timestamp format of the replacement data.
  - `ForecastTypes` ForecastType[] — The quantiles at which probabilistic forecasts are generated. You can specify up to five quantiles per what-if forecast in the <a>CreateWhatIfForecast</a> operation. If you didn't specify quantiles, the default values are <code>["0.1", "0.5", "0.9"]</code>.

## 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)