v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1463278347.3 KB

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

The <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your what-if forecast export jobs, use the ListWhatIfForecastExports operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeWhatIfForecastExport operation.

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

Headers

X-Amz-Target'AmazonForecast.CreateWhatIfForecastExport' required

Request body

WhatIfForecastExportNamestring required

The name of the what-if forecast to export.

WhatIfForecastArnsLongArn[] required

The list of what-if forecast Amazon Resource Names (ARNs) to export.

Formatstring

The format of the exported data, CSV or PARQUET.

Response

Success

WhatIfForecastExportArnstring

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