Skip to content

Create Forecast Export Job

forecastservice_create_forecast_export_job R Documentation

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

Description

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

\ForecastExportJobName\\ExportTimestamp\\PartNumber\

where 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 forecast export jobs, use the list_forecast_export_jobs 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_forecast_export_job operation.

Usage

forecastservice_create_forecast_export_job(ForecastExportJobName,
  ForecastArn, Destination, Tags, Format)

Arguments

ForecastExportJobName

[required] The name for the forecast export job.

ForecastArn

[required] The Amazon Resource Name (ARN) of the forecast that you want 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

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do not use ⁠aws:⁠, ⁠AWS:⁠, or any upper or lowercase combination of such as a prefix for keys as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

Format

The format of the exported data, CSV or PARQUET. The default value is CSV.

Value

A list with the following syntax: 

list(
  ForecastExportJobArn = "string"
)

Request syntax

svc$create_forecast_export_job(
  ForecastExportJobName = "string",
  ForecastArn = "string",
  Destination = list(
    S3Config = list(
      Path = "string",
      RoleArn = "string",
      KMSKeyArn = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Format = "string"
)