predictor_backtest_export_jobs

Creates, updates, deletes, gets or lists a predictor_backtest_export_jobs resource.

Overview

Name	predictor_backtest_export_jobs
Type	Resource
Id	aws.forecast.predictor_backtest_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_predictor_backtest_export_job

Name	Datatype	Description
creation_time	string (date-time)	When the predictor backtest export job was created.
destination	object	The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
format	string	The format of the exported data, CSV or PARQUET. (pattern: <code>^CSV|PARQUET$</code>)
last_modification_time	string (date-time)	The last time the resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. CREATE_STOPPING - The current timestamp. CREATE_STOPPED - When the job stopped. ACTIVE or CREATE_FAILED - When the job finished or failed.
message	string	Information about any errors that may have occurred during the backtest export.
predictor_arn	string	The Amazon Resource Name (ARN) of the predictor. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
predictor_backtest_export_job_arn	string	The Amazon Resource Name (ARN) of the predictor backtest export job. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
predictor_backtest_export_job_name	string	The name of the predictor backtest export job. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
status	string	The status of the predictor backtest export job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

list_predictor_backtest_export_jobs

Name	Datatype	Description
creation_time	string (date-time)	When the predictor backtest export job was created.
destination	object	The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
last_modification_time	string (date-time)	The last time the resource was modified. The timestamp depends on the status of the job: CREATE_PENDING - The CreationTime. CREATE_IN_PROGRESS - The current timestamp. CREATE_STOPPING - The current timestamp. CREATE_STOPPED - When the job stopped. ACTIVE or CREATE_FAILED - When the job finished or failed.
message	string	Information about any errors that may have occurred during the backtest export.
predictor_backtest_export_job_arn	string	The Amazon Resource Name (ARN) of the predictor backtest export job. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
predictor_backtest_export_job_name	string	The name of the predictor backtest export job. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
status	string	The status of the predictor backtest export job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_predictor_backtest_export_job	select	region		Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation. In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message (if an error occurred)
list_predictor_backtest_export_jobs	select	region		Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.
create_predictor_backtest_export_job	insert	region, PredictorBacktestExportJobName, PredictorArn		Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor 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 DescribePredictorBacktestExportJob operation.
delete_predictor_backtest_export_job	delete	region		Deletes a predictor backtest export job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_predictor_backtest_export_job

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation. In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message (if an error occurred)

SELECT
creation_time,
destination,
format,
last_modification_time,
message,
predictor_arn,
predictor_backtest_export_job_arn,
predictor_backtest_export_job_name,
status
FROM aws.forecast.predictor_backtest_export_jobs
WHERE region = '{{ region }}' -- required
;

list_predictor_backtest_export_jobs

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects. To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

SELECT
creation_time,
destination,
last_modification_time,
message,
predictor_backtest_export_job_arn,
predictor_backtest_export_job_name,
status
FROM aws.forecast.predictor_backtest_export_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_predictor_backtest_export_job

Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor 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 DescribePredictorBacktestExportJob operation.

INSERT INTO aws.forecast.predictor_backtest_export_jobs (
PredictorBacktestExportJobName,
PredictorArn,
Destination,
Tags,
Format,
region
)
SELECT 
'{{ PredictorBacktestExportJobName }}' /* required */,
'{{ PredictorArn }}' /* required */,
'{{ Destination }}',
'{{ Tags }}',
'{{ Format }}',
'{{ region }}'
RETURNING
predictor_backtest_export_job_arn
;

Manifest

# Description fields are for documentation purposes
- name: predictor_backtest_export_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the predictor_backtest_export_jobs resource.
  - name: PredictorBacktestExportJobName
    value: "{{ PredictorBacktestExportJobName }}"
    description: |
      The name for the backtest export job.
  - name: PredictorArn
    value: "{{ PredictorArn }}"
    description: |
      The Amazon Resource Name (ARN) of the predictor that you want to export.
  - name: Destination
    description: |
      The destination for an export job. Provide an S3 path, an Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an Key Management Service (KMS) key (optional).
    value:
      S3Config:
        Path: "{{ Path }}"
        RoleArn: "{{ RoleArn }}"
        KMSKeyArn: "{{ KMSKeyArn }}"
  - name: Tags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Format
    value: "{{ Format }}"
    description: |
      The format of the exported data, CSV or PARQUET. The default value is CSV.

DELETE examples

delete_predictor_backtest_export_job

Deletes a predictor backtest export job.

DELETE FROM aws.forecast.predictor_backtest_export_jobs
WHERE region = '{{ region }}' --required
;