forecasts

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

Overview

Name	forecasts
Type	Resource
Id	aws.forecast.forecasts

Fields

The following fields are returned by SELECT queries:

describe_forecast

Name	Datatype	Description
creation_time	string (date-time)	When the forecast creation task was created.
dataset_group_arn	string	The ARN of the dataset group that provided the data used to train the predictor. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
estimated_time_remaining_in_minutes	integer (int64)	The estimated time remaining in minutes for the forecast job to complete.
forecast_arn	string	The forecast ARN as specified in the request. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
forecast_name	string	The name of the forecast. (pattern: <code>^[a-zA-Z][a-zA-Z0-9_]*</code>)
forecast_types	array	The quantiles at which probabilistic forecasts were generated.
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.
predictor_arn	string	The ARN of the predictor used to generate the forecast. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
status	string	The status of the forecast. 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 must be ACTIVE before you can query or export the forecast. (pattern: <code>^[a-zA-Z0-9_]+$</code>)
time_series_selector	object	The time series to include in the forecast.

list_forecasts

Name	Datatype	Description
created_using_auto_predictor	boolean	Whether the Forecast was created from an AutoPredictor.
creation_time	string (date-time)	When the forecast creation task was created.
dataset_group_arn	string	The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor. (pattern: <code>^[a-zA-Z0-9_]+$</code>)
forecast_arn	string	The ARN of the forecast. (pattern: <code>arn:([a-z\d-]+):forecast:.:.:.+</code>)
forecast_name	string	The name of the forecast. (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.
predictor_arn	string	The ARN of the predictor used to generate the forecast. (pattern: <code>^[a-zA-Z0-9_]+$</code>)
status	string	The status of the forecast. 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 must be ACTIVE before you can query or export the forecast.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_forecast	select	region		Describes a forecast created using the CreateForecast operation. In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties: DatasetGroupArn - The dataset group that provided the training data. CreationTime LastModificationTime Status Message - If an error occurred, information about the error.
list_forecasts	select	region		Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.
create_forecast	insert	region, ForecastName, PredictorArn		Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation. The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast. To get a list of all your forecasts, use the ListForecasts operation. The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor. For more information, see howitworks-forecast. The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status. By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.
delete_forecast	delete	region		Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation. You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

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

Describes a forecast created using the CreateForecast operation. In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties: DatasetGroupArn - The dataset group that provided the training data. CreationTime LastModificationTime Status Message - If an error occurred, information about the error.

SELECT
creation_time,
dataset_group_arn,
estimated_time_remaining_in_minutes,
forecast_arn,
forecast_name,
forecast_types,
last_modification_time,
message,
predictor_arn,
status,
time_series_selector
FROM aws.forecast.forecasts
WHERE region = '{{ region }}' -- required
;

list_forecasts

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

SELECT
created_using_auto_predictor,
creation_time,
dataset_group_arn,
forecast_arn,
forecast_name,
last_modification_time,
message,
predictor_arn,
status
FROM aws.forecast.forecasts
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_forecast

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation. The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast. To get a list of all your forecasts, use the ListForecasts operation. The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor. For more information, see howitworks-forecast. The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status. By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

INSERT INTO aws.forecast.forecasts (
ForecastName,
PredictorArn,
ForecastTypes,
Tags,
TimeSeriesSelector,
region
)
SELECT 
'{{ ForecastName }}' /* required */,
'{{ PredictorArn }}' /* required */,
'{{ ForecastTypes }}',
'{{ Tags }}',
'{{ TimeSeriesSelector }}',
'{{ region }}'
RETURNING
forecast_arn
;

Manifest

# Description fields are for documentation purposes
- name: forecasts
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the forecasts resource.
  - name: ForecastName
    value: "{{ ForecastName }}"
    description: |
      A name for the forecast.
  - name: PredictorArn
    value: "{{ PredictorArn }}"
    description: |
      The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
  - name: ForecastTypes
    value:
      - "{{ ForecastTypes }}"
    description: |
      The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
  - name: Tags
    description: |
      The optional metadata that you apply to the forecast 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: TimeSeriesSelector
    description: |
      Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object. The TimeSeriesIdentifiers object needs the following information: DataSource Format Schema
    value:
      TimeSeriesIdentifiers:
        DataSource:
          S3Config:
            Path: "{{ Path }}"
            RoleArn: "{{ RoleArn }}"
            KMSKeyArn: "{{ KMSKeyArn }}"
        Schema:
          Attributes:
            - AttributeName: "{{ AttributeName }}"
              AttributeType: "{{ AttributeType }}"
        Format: "{{ Format }}"

DELETE examples

delete_forecast

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation. You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

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