libZSservicesZSamazonka-forecastqueryZSamazonka-forecastquery
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ForecastQuery.Lens

Description

 
Synopsis

Operations

QueryForecast

queryForecast_endDate :: Lens' QueryForecast (Maybe Text) Source #

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.

queryForecast_startDate :: Lens' QueryForecast (Maybe Text) Source #

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.

queryForecast_nextToken :: Lens' QueryForecast (Maybe Text) Source #

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.

queryForecast_forecastArn :: Lens' QueryForecast Text Source #

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

queryForecast_filters :: Lens' QueryForecast (HashMap Text Text) Source #

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.

Types

DataPoint

dataPoint_timestamp :: Lens' DataPoint (Maybe Text) Source #

The timestamp of the specific forecast.

Forecast

forecast_predictions :: Lens' Forecast (Maybe (HashMap Text [DataPoint])) Source #

The forecast.

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

  • p10
  • p50
  • p90