Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Retrieves a what-if forecast.
Synopsis
- data QueryWhatIfForecast = QueryWhatIfForecast' {}
- newQueryWhatIfForecast :: Text -> QueryWhatIfForecast
- queryWhatIfForecast_endDate :: Lens' QueryWhatIfForecast (Maybe Text)
- queryWhatIfForecast_nextToken :: Lens' QueryWhatIfForecast (Maybe Text)
- queryWhatIfForecast_startDate :: Lens' QueryWhatIfForecast (Maybe Text)
- queryWhatIfForecast_whatIfForecastArn :: Lens' QueryWhatIfForecast Text
- queryWhatIfForecast_filters :: Lens' QueryWhatIfForecast (HashMap Text Text)
- data QueryWhatIfForecastResponse = QueryWhatIfForecastResponse' {
- forecast :: Maybe Forecast
- httpStatus :: Int
- newQueryWhatIfForecastResponse :: Int -> QueryWhatIfForecastResponse
- queryWhatIfForecastResponse_forecast :: Lens' QueryWhatIfForecastResponse (Maybe Forecast)
- queryWhatIfForecastResponse_httpStatus :: Lens' QueryWhatIfForecastResponse Int
Creating a Request
data QueryWhatIfForecast Source #
See: newQueryWhatIfForecast
smart constructor.
QueryWhatIfForecast' | |
|
Instances
newQueryWhatIfForecast Source #
Create a value of QueryWhatIfForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endDate:QueryWhatIfForecast'
, queryWhatIfForecast_endDate
- The end date for the what-if forecast. Specify the date using this
format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
2015-01-01T20:00:00.
$sel:nextToken:QueryWhatIfForecast'
, queryWhatIfForecast_nextToken
- 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.
$sel:startDate:QueryWhatIfForecast'
, queryWhatIfForecast_startDate
- The start date for the what-if forecast. Specify the date using this
format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example,
2015-01-01T08:00:00.
$sel:whatIfForecastArn:QueryWhatIfForecast'
, queryWhatIfForecast_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast to query.
$sel:filters:QueryWhatIfForecast'
, queryWhatIfForecast_filters
- 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 what-if forecast, use the CreateForecastExportJob operation.
Request Lenses
queryWhatIfForecast_endDate :: Lens' QueryWhatIfForecast (Maybe Text) Source #
The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.
queryWhatIfForecast_nextToken :: Lens' QueryWhatIfForecast (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.
queryWhatIfForecast_startDate :: Lens' QueryWhatIfForecast (Maybe Text) Source #
The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.
queryWhatIfForecast_whatIfForecastArn :: Lens' QueryWhatIfForecast Text Source #
The Amazon Resource Name (ARN) of the what-if forecast to query.
queryWhatIfForecast_filters :: Lens' QueryWhatIfForecast (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 what-if forecast, use the CreateForecastExportJob operation.
Destructuring the Response
data QueryWhatIfForecastResponse Source #
See: newQueryWhatIfForecastResponse
smart constructor.
QueryWhatIfForecastResponse' | |
|
Instances
newQueryWhatIfForecastResponse Source #
Create a value of QueryWhatIfForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecast:QueryWhatIfForecastResponse'
, queryWhatIfForecastResponse_forecast
- Undocumented member.
$sel:httpStatus:QueryWhatIfForecastResponse'
, queryWhatIfForecastResponse_httpStatus
- The response's http status code.
Response Lenses
queryWhatIfForecastResponse_forecast :: Lens' QueryWhatIfForecastResponse (Maybe Forecast) Source #
Undocumented member.
queryWhatIfForecastResponse_httpStatus :: Lens' QueryWhatIfForecastResponse Int Source #
The response's http status code.