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

Amazonka.ForecastQuery.QueryWhatIfForecast

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a what-if forecast.

Synopsis

data QueryWhatIfForecast = QueryWhatIfForecast' {
- endDate :: Maybe Text
- nextToken :: Maybe Text
- startDate :: Maybe Text
- whatIfForecastArn :: Text
- filters :: HashMap Text Text
}
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.

Constructors

QueryWhatIfForecast'

Fields

endDate :: Maybe Text
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.
nextToken :: Maybe Text
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.
startDate :: Maybe Text
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.
whatIfForecastArn :: Text
The Amazon Resource Name (ARN) of the what-if forecast to query.
filters :: HashMap Text Text
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.

Instances

Instances details

ToJSON QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods toJSON :: QueryWhatIfForecast -> Value # toEncoding :: QueryWhatIfForecast -> Encoding # toJSONList :: [QueryWhatIfForecast] -> Value # toEncodingList :: [QueryWhatIfForecast] -> Encoding #
ToHeaders QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods toHeaders :: QueryWhatIfForecast -> [Header] #
ToPath QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods toPath :: QueryWhatIfForecast -> ByteString #
ToQuery QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods toQuery :: QueryWhatIfForecast -> QueryString #
AWSRequest QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Associated Types type AWSResponse QueryWhatIfForecast # Methods request :: (Service -> Service) -> QueryWhatIfForecast -> Request QueryWhatIfForecast # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy QueryWhatIfForecast -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse QueryWhatIfForecast))) #
Generic QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Associated Types type Rep QueryWhatIfForecast :: Type -> Type # Methods from :: QueryWhatIfForecast -> Rep QueryWhatIfForecast x # to :: Rep QueryWhatIfForecast x -> QueryWhatIfForecast #
Read QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods readsPrec :: Int -> ReadS QueryWhatIfForecast # readList :: ReadS [QueryWhatIfForecast] # readPrec :: ReadPrec QueryWhatIfForecast # readListPrec :: ReadPrec [QueryWhatIfForecast] #
Show QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods showsPrec :: Int -> QueryWhatIfForecast -> ShowS # show :: QueryWhatIfForecast -> String # showList :: [QueryWhatIfForecast] -> ShowS #
NFData QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods rnf :: QueryWhatIfForecast -> () #
Eq QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods (==) :: QueryWhatIfForecast -> QueryWhatIfForecast -> Bool # (/=) :: QueryWhatIfForecast -> QueryWhatIfForecast -> Bool #
Hashable QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods hashWithSalt :: Int -> QueryWhatIfForecast -> Int # hash :: QueryWhatIfForecast -> Int #
type AWSResponse QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast type AWSResponse QueryWhatIfForecast = QueryWhatIfForecastResponse
type Rep QueryWhatIfForecast Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast type Rep QueryWhatIfForecast = D1 ('MetaData "QueryWhatIfForecast" "Amazonka.ForecastQuery.QueryWhatIfForecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "QueryWhatIfForecast'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "whatIfForecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))))

newQueryWhatIfForecast Source #

Arguments

:: Text	`$sel:whatIfForecastArn:QueryWhatIfForecast'`
-> QueryWhatIfForecast

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.

Constructors

QueryWhatIfForecastResponse'
Fields forecast :: Maybe Forecast httpStatus :: Int The response's http status code.

Instances

Instances details

Generic QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Associated Types type Rep QueryWhatIfForecastResponse :: Type -> Type # Methods from :: QueryWhatIfForecastResponse -> Rep QueryWhatIfForecastResponse x # to :: Rep QueryWhatIfForecastResponse x -> QueryWhatIfForecastResponse #
Read QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods readsPrec :: Int -> ReadS QueryWhatIfForecastResponse # readList :: ReadS [QueryWhatIfForecastResponse] # readPrec :: ReadPrec QueryWhatIfForecastResponse # readListPrec :: ReadPrec [QueryWhatIfForecastResponse] #
Show QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods showsPrec :: Int -> QueryWhatIfForecastResponse -> ShowS # show :: QueryWhatIfForecastResponse -> String # showList :: [QueryWhatIfForecastResponse] -> ShowS #
NFData QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods rnf :: QueryWhatIfForecastResponse -> () #
Eq QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast Methods (==) :: QueryWhatIfForecastResponse -> QueryWhatIfForecastResponse -> Bool # (/=) :: QueryWhatIfForecastResponse -> QueryWhatIfForecastResponse -> Bool #
type Rep QueryWhatIfForecastResponse Source #
Instance details Defined in Amazonka.ForecastQuery.QueryWhatIfForecast type Rep QueryWhatIfForecastResponse = D1 ('MetaData "QueryWhatIfForecastResponse" "Amazonka.ForecastQuery.QueryWhatIfForecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "QueryWhatIfForecastResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forecast") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Forecast)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newQueryWhatIfForecastResponse Source #

Arguments

:: Int	`$sel:httpStatus:QueryWhatIfForecastResponse'`
-> QueryWhatIfForecastResponse

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.