forecast_export_jobs

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

Overview

Name	forecast_export_jobs
Type	Resource
Id	aws.forecast.forecast_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_forecast_export_job

Name	Datatype	Description
creation_time	string (date-time)	When the forecast 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).
forecast_arn	string	The Amazon Resource Name (ARN) of the exported forecast. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
forecast_export_job_arn	string	The ARN of the forecast export job. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
forecast_export_job_name	string	The name of the forecast export job. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
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	If an error occurred, an informational message about the error.
status	string	The status of the forecast export job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

list_forecast_export_jobs

Name	Datatype	Description
creation_time	string (date-time)	When the forecast 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).
forecast_export_job_arn	string	The Amazon Resource Name (ARN) of the forecast export job. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
forecast_export_job_name	string	The name of the forecast export job. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</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	If an error occurred, an informational message about the error.
status	string	The status of the forecast export job. States include: ACTIVE CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED CREATE_STOPPING, CREATE_STOPPED DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_forecast_export_job	select	region		Describes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message - If an error occurred, information about the error.
list_forecast_export_jobs	select	region		Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.
create_forecast_export_job	insert	region, ForecastExportJobName, ForecastArn		Exports a forecast created by the CreateForecast 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 ListForecastExportJobs 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 DescribeForecastExportJob operation.
delete_forecast_export_job	delete	region		Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

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_forecast_export_job

Describes a forecast export job created using the CreateForecastExportJob operation. In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties: CreationTime LastModificationTime Status Message - If an error occurred, information about the error.

SELECT
creation_time,
destination,
forecast_arn,
forecast_export_job_arn,
forecast_export_job_name,
format,
last_modification_time,
message,
status
FROM aws.forecast.forecast_export_jobs
WHERE region = '{{ region }}' -- required
;

list_forecast_export_jobs

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

SELECT
creation_time,
destination,
forecast_export_job_arn,
forecast_export_job_name,
last_modification_time,
message,
status
FROM aws.forecast.forecast_export_jobs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_forecast_export_job

Exports a forecast created by the CreateForecast 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 ListForecastExportJobs 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 DescribeForecastExportJob operation.

INSERT INTO aws.forecast.forecast_export_jobs (
ForecastExportJobName,
ForecastArn,
Destination,
Tags,
Format,
region
)
SELECT 
'{{ ForecastExportJobName }}' /* required */,
'{{ ForecastArn }}' /* required */,
'{{ Destination }}',
'{{ Tags }}',
'{{ Format }}',
'{{ region }}'
RETURNING
forecast_export_job_arn
;

Manifest

# Description fields are for documentation purposes
- name: forecast_export_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the forecast_export_jobs resource.
  - name: ForecastExportJobName
    value: "{{ ForecastExportJobName }}"
    description: |
      The name for the forecast export job.
  - name: ForecastArn
    value: "{{ ForecastArn }}"
    description: |
      The Amazon Resource Name (ARN) of the forecast 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: |
      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.
    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_forecast_export_job

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

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