Skip to content

Create Predictor Backtest Export Job

forecastservice_create_predictor_backtest_export_job R Documentation

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations

Description

Exports backtest forecasts and accuracy metrics generated by the create_auto_predictor or create_predictor operations. Two folders containing CSV or Parquet files are exported to your specified S3 bucket.

The export file names will match the following conventions:

⁠<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv⁠

The \ExportTimestamp\ component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Amazon S3 bucket and 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.

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

Usage

forecastservice_create_predictor_backtest_export_job(
  PredictorBacktestExportJobName, PredictorArn, Destination, Tags, Format)

Arguments

PredictorBacktestExportJobName

[required] The name for the backtest export job.

PredictorArn

[required] The Amazon Resource Name (ARN) of the predictor that you want to export.

Destination

[required]

Tags

Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

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

  • Maximum number of tags per resource: 50.

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

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

  • Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.

  • Key prefixes cannot include any upper or lowercase combination of ⁠aws:⁠ or ⁠AWS:⁠. Values can have this prefix. If a tag value has aws as its prefix but the key does not, 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. You cannot edit or delete tag keys with this prefix.

Format

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

Value

A list with the following syntax: 

list(
  PredictorBacktestExportJobArn = "string"
)

Request syntax

svc$create_predictor_backtest_export_job(
  PredictorBacktestExportJobName = "string",
  PredictorArn = "string",
  Destination = list(
    S3Config = list(
      Path = "string",
      RoleArn = "string",
      KMSKeyArn = "string"
    )
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Format = "string"
)