[ aws . forecastquery ]

query-forecast

Description

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

To get the full forecast, use the CreateForecastExportJob operation.

Note

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  query-forecast
--forecast-arn <value>
[--start-date <value>]
[--end-date <value>]
--filters <value>
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--forecast-arn (string)

The Amazon Resource Name (ARN) of the forecast to query.

--start-date (string)

The start date for the forecast. Specify the date using this format: yyyy-MM-dd’T’HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

--end-date (string)

The end date for the forecast. Specify the date using this format: yyyy-MM-dd’T’HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

--filters (map)

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{"item_id" : "client_21"}

To get the full forecast, use the CreateForecastExportJob operation.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--next-token (string)

If the result of the previous request was truncated, the response includes a NextToken . To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Forecast -> (structure)

The forecast.

Predictions -> (map)

The forecast.

The string of the string-to-array map is one of the following values:

• p10

• p50

• p90

key -> (string)

value -> (list)

(structure)

The forecast value for a specific date. Part of the Forecast object.

Timestamp -> (string)

The timestamp of the specific forecast.

Value -> (double)

The forecast value.