Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ForecastQuery

Contents

Service Configuration
Errors
Waiters
Operations
- QueryForecast
Types
- DataPoint
- Forecast

Description

Derived from API version 2018-06-26 of the AWS service descriptions, licensed under Apache 2.0.

Provides APIs for creating and managing Amazon Forecast resources.

Synopsis

defaultService :: Service
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
data QueryForecast = QueryForecast' (Maybe Text) (Maybe Text) (Maybe Text) Text (HashMap Text Text)
newQueryForecast :: Text -> QueryForecast
data QueryForecastResponse = QueryForecastResponse' (Maybe Forecast) Int
newQueryForecastResponse :: Int -> QueryForecastResponse
data DataPoint = DataPoint' (Maybe Double) (Maybe Text)
newDataPoint :: DataPoint
data Forecast = Forecast' (Maybe (HashMap Text [DataPoint]))
newForecast :: Forecast

Service Configuration

defaultService :: Service Source #

API version 2018-06-26 of the Amazon Forecast Query Service SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by ForecastQuery.

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The token is not valid. Tokens expire after 24 hours.

InvalidInputException

_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The value is invalid or is too long.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

We can't find that resource. Check the information that you've provided and try again.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The limit on the number of requests per second has been exceeded.

ResourceInUseException

_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified resource is in use.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

QueryForecast

data QueryForecast Source #

See: newQueryForecast smart constructor.

Constructors

QueryForecast' (Maybe Text) (Maybe Text) (Maybe Text) Text (HashMap Text Text)

Instances

Instances details

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

newQueryForecast Source #

Arguments

:: Text	`$sel:forecastArn:QueryForecast'`
-> QueryForecast

Create a value of QueryForecast 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:QueryForecast', queryForecast_endDate - 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.

$sel:startDate:QueryForecast', queryForecast_startDate - 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.

$sel:nextToken:QueryForecast', queryForecast_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:forecastArn:QueryForecast', queryForecast_forecastArn - The Amazon Resource Name (ARN) of the forecast to query.

$sel:filters:QueryForecast', queryForecast_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 forecast, use the CreateForecastExportJob operation.

data QueryForecastResponse Source #

See: newQueryForecastResponse smart constructor.

Constructors

QueryForecastResponse' (Maybe Forecast) Int

Instances

Instances details

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

newQueryForecastResponse Source #

Arguments

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

Create a value of QueryForecastResponse 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:QueryForecastResponse', queryForecastResponse_forecast - The forecast.

$sel:httpStatus:QueryForecastResponse', queryForecastResponse_httpStatus - The response's http status code.

Types

DataPoint

data DataPoint Source #

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

See: newDataPoint smart constructor.

Constructors

DataPoint' (Maybe Double) (Maybe Text)

Instances

Instances details

Eq DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods (==) :: DataPoint -> DataPoint -> Bool # (/=) :: DataPoint -> DataPoint -> Bool #
Read DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods readsPrec :: Int -> ReadS DataPoint # readList :: ReadS [DataPoint] # readPrec :: ReadPrec DataPoint # readListPrec :: ReadPrec [DataPoint] #
Show DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods showsPrec :: Int -> DataPoint -> ShowS # show :: DataPoint -> String # showList :: [DataPoint] -> ShowS #
Generic DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Associated Types type Rep DataPoint :: Type -> Type # Methods from :: DataPoint -> Rep DataPoint x # to :: Rep DataPoint x -> DataPoint #
NFData DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods rnf :: DataPoint -> () #
Hashable DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods hashWithSalt :: Int -> DataPoint -> Int # hash :: DataPoint -> Int #
FromJSON DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint Methods parseJSON :: Value -> Parser DataPoint # parseJSONList :: Value -> Parser [DataPoint] #
type Rep DataPoint Source #
Instance details Defined in Amazonka.ForecastQuery.Types.DataPoint type Rep DataPoint = D1 ('MetaData "DataPoint" "Amazonka.ForecastQuery.Types.DataPoint" "libZSservicesZSamazonka-forecastqueryZSamazonka-forecastquery" 'False) (C1 ('MetaCons "DataPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newDataPoint :: DataPoint Source #

Create a value of DataPoint 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:value:DataPoint', dataPoint_value - The forecast value.

$sel:timestamp:DataPoint', dataPoint_timestamp - The timestamp of the specific forecast.

Forecast

data Forecast Source #

Provides information about a forecast. Returned as part of the QueryForecast response.

See: newForecast smart constructor.

Constructors

Forecast' (Maybe (HashMap Text [DataPoint]))

Instances

Instances details

Eq Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods (==) :: Forecast -> Forecast -> Bool # (/=) :: Forecast -> Forecast -> Bool #
Read Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods readsPrec :: Int -> ReadS Forecast # readList :: ReadS [Forecast] # readPrec :: ReadPrec Forecast # readListPrec :: ReadPrec [Forecast] #
Show Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods showsPrec :: Int -> Forecast -> ShowS # show :: Forecast -> String # showList :: [Forecast] -> ShowS #
Generic Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Associated Types type Rep Forecast :: Type -> Type # Methods from :: Forecast -> Rep Forecast x # to :: Rep Forecast x -> Forecast #
NFData Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods rnf :: Forecast -> () #
Hashable Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods hashWithSalt :: Int -> Forecast -> Int # hash :: Forecast -> Int #
FromJSON Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast Methods parseJSON :: Value -> Parser Forecast # parseJSONList :: Value -> Parser [Forecast] #
type Rep Forecast Source #
Instance details Defined in Amazonka.ForecastQuery.Types.Forecast type Rep Forecast = D1 ('MetaData "Forecast" "Amazonka.ForecastQuery.Types.Forecast" "libZSservicesZSamazonka-forecastqueryZSamazonka-forecastquery" 'False) (C1 ('MetaCons "Forecast'" 'PrefixI 'True) (S1 ('MetaSel ('Just "predictions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [DataPoint])))))

newForecast :: Forecast Source #

Create a value of Forecast 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:predictions:Forecast', forecast_predictions - The forecast.

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

p10
p50
p90