amazonka-forecastquery-2.0: Amazon Forecast Query Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ForecastQuery

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

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.

InvalidInputException

_InvalidInputException :: AsError a => Fold a ServiceError Source #

The value is invalid or is too long.

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #

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

LimitExceededException

_LimitExceededException :: AsError a => Fold a ServiceError Source #

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

ResourceInUseException

_ResourceInUseException :: AsError a => Fold a ServiceError Source #

The specified resource is in use.

ResourceNotFoundException

_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #

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

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.

Instances

Instances details
ToJSON QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

ToHeaders QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

ToPath QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

ToQuery QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

AWSRequest QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Associated Types

type AWSResponse QueryForecast #

Generic QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Associated Types

type Rep QueryForecast :: Type -> Type #

Read QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Show QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

NFData QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Methods

rnf :: QueryForecast -> () #

Eq QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Hashable QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

type AWSResponse QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

type Rep QueryForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

type Rep QueryForecast = D1 ('MetaData "QueryForecast" "Amazonka.ForecastQuery.QueryForecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "QueryForecast'" '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 "forecastArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))))

newQueryForecast Source #

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: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: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: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.

Instances

Instances details
Generic QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Associated Types

type Rep QueryForecastResponse :: Type -> Type #

Read QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Show QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

NFData QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

Methods

rnf :: QueryForecastResponse -> () #

Eq QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

type Rep QueryForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryForecast

type Rep QueryForecastResponse = D1 ('MetaData "QueryForecastResponse" "Amazonka.ForecastQuery.QueryForecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" '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 #

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.

QueryWhatIfForecast

data QueryWhatIfForecast Source #

See: newQueryWhatIfForecast smart constructor.

Instances

Instances details
ToJSON QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

ToHeaders QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

ToPath QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

ToQuery QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

AWSRequest QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Associated Types

type AWSResponse QueryWhatIfForecast #

Generic QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Associated Types

type Rep QueryWhatIfForecast :: Type -> Type #

Read QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Show QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

NFData QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Methods

rnf :: QueryWhatIfForecast -> () #

Eq QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Hashable QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

type AWSResponse QueryWhatIfForecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

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 #

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.

data QueryWhatIfForecastResponse Source #

See: newQueryWhatIfForecastResponse smart constructor.

Instances

Instances details
Generic QueryWhatIfForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Associated Types

type Rep QueryWhatIfForecastResponse :: Type -> Type #

Read QueryWhatIfForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Show QueryWhatIfForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

NFData QueryWhatIfForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

Eq QueryWhatIfForecastResponse Source # 
Instance details

Defined in Amazonka.ForecastQuery.QueryWhatIfForecast

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 #

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.

Types

DataPoint

data DataPoint Source #

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

See: newDataPoint smart constructor.

Constructors

DataPoint' (Maybe Text) (Maybe Double) 

Instances

Instances details
FromJSON DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

Generic DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

Associated Types

type Rep DataPoint :: Type -> Type #

Read DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

Show DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

NFData DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

Methods

rnf :: DataPoint -> () #

Eq DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

Hashable DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

type Rep DataPoint Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.DataPoint

type Rep DataPoint = D1 ('MetaData "DataPoint" "Amazonka.ForecastQuery.Types.DataPoint" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" 'False) (C1 ('MetaCons "DataPoint'" 'PrefixI 'True) (S1 ('MetaSel ('Just "timestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

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:timestamp:DataPoint', dataPoint_timestamp - The timestamp of the specific forecast.

$sel:value:DataPoint', dataPoint_value - The forecast value.

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
FromJSON Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

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 #

Read Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Show Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

NFData Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Methods

rnf :: Forecast -> () #

Eq Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Hashable Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

Methods

hashWithSalt :: Int -> Forecast -> Int #

hash :: Forecast -> Int #

type Rep Forecast Source # 
Instance details

Defined in Amazonka.ForecastQuery.Types.Forecast

type Rep Forecast = D1 ('MetaData "Forecast" "Amazonka.ForecastQuery.Types.Forecast" "amazonka-forecastquery-2.0-3Lqpl1IhCAMLRpShcclny5" '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

The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.