Skip to content

Create What if Forecast Export

forecastservice_create_what_if_forecast_export R Documentation

Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket

Description

Exports a forecast created by the create_what_if_forecast 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 list_what_if_forecast_exports 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 describe_what_if_forecast_export operation.

Usage

forecastservice_create_what_if_forecast_export(WhatIfForecastExportName,
  WhatIfForecastArns, Destination, Tags, Format)

Arguments

WhatIfForecastExportName

[required] The name of the what-if forecast to export.

WhatIfForecastArns

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

Destination

[required] The location where you want to save the forecast and an Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

Tags

A list of tags to apply to the what if forecast.

Format

The format of the exported data, CSV or PARQUET.

Value

A list with the following syntax: 

list(
  WhatIfForecastExportArn = "string"
)

Request syntax

svc$create_what_if_forecast_export(
  WhatIfForecastExportName = "string",
  WhatIfForecastArns = list(
    "string"
  ),
  Destination = list(
    S3Config = list(
      Path = "string",
      RoleArn = "string",
      KMSKeyArn = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Format = "string"
)