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.Forecast.CreateForecast

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

By default, a forecast includes predictions for every item (item_id) in the dataset group that was used to train the predictor. However, you can use the TimeSeriesSelector object to generate a forecast on a subset of time series. Forecast creation is skipped for any time series that you specify that are not in the input dataset. The forecast export file will not contain these time series or their forecasted values.

Synopsis

data CreateForecast = CreateForecast' {
- forecastTypes :: Maybe (NonEmpty Text)
- tags :: Maybe [Tag]
- timeSeriesSelector :: Maybe TimeSeriesSelector
- forecastName :: Text
- predictorArn :: Text
}
newCreateForecast :: Text -> Text -> CreateForecast
createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text))
createForecast_tags :: Lens' CreateForecast (Maybe [Tag])
createForecast_timeSeriesSelector :: Lens' CreateForecast (Maybe TimeSeriesSelector)
createForecast_forecastName :: Lens' CreateForecast Text
createForecast_predictorArn :: Lens' CreateForecast Text
data CreateForecastResponse = CreateForecastResponse' {
- forecastArn :: Maybe Text
- httpStatus :: Int
}
newCreateForecastResponse :: Int -> CreateForecastResponse
createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text)
createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int

Creating a Request

data CreateForecast Source #

See: newCreateForecast smart constructor.

Constructors

CreateForecast'

Fields

forecastTypes :: Maybe (NonEmpty Text)
The quantiles at which probabilistic forecasts are generated. __You can currently specify up to 5 quantiles per forecast__. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].
tags :: Maybe [Tag]
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
timeSeriesSelector :: Maybe TimeSeriesSelector
Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.
The TimeSeriesIdentifiers object needs the following information:
- ```
DataSource
```
- ```
Format
```
- ```
Schema
```
forecastName :: Text
A name for the forecast.
predictorArn :: Text
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Instances

Instances details

ToJSON CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods toJSON :: CreateForecast -> Value # toEncoding :: CreateForecast -> Encoding # toJSONList :: [CreateForecast] -> Value # toEncodingList :: [CreateForecast] -> Encoding #
ToHeaders CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods toHeaders :: CreateForecast -> [Header] #
ToPath CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods toPath :: CreateForecast -> ByteString #
ToQuery CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods toQuery :: CreateForecast -> QueryString #
AWSRequest CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Associated Types type AWSResponse CreateForecast # Methods request :: (Service -> Service) -> CreateForecast -> Request CreateForecast # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateForecast -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateForecast))) #
Generic CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Associated Types type Rep CreateForecast :: Type -> Type # Methods from :: CreateForecast -> Rep CreateForecast x # to :: Rep CreateForecast x -> CreateForecast #
Show CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods showsPrec :: Int -> CreateForecast -> ShowS # show :: CreateForecast -> String # showList :: [CreateForecast] -> ShowS #
NFData CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods rnf :: CreateForecast -> () #
Eq CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods (==) :: CreateForecast -> CreateForecast -> Bool # (/=) :: CreateForecast -> CreateForecast -> Bool #
Hashable CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast Methods hashWithSalt :: Int -> CreateForecast -> Int # hash :: CreateForecast -> Int #
type AWSResponse CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast type AWSResponse CreateForecast = CreateForecastResponse
type Rep CreateForecast Source #
Instance details Defined in Amazonka.Forecast.CreateForecast type Rep CreateForecast = D1 ('MetaData "CreateForecast" "Amazonka.Forecast.CreateForecast" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "CreateForecast'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forecastTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "timeSeriesSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSeriesSelector)) :: (S1 ('MetaSel ('Just "forecastName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "predictorArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateForecast Source #

Arguments

:: Text	`CreateForecast`
-> Text	`CreateForecast`
-> CreateForecast

Create a value of CreateForecast 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:forecastTypes:CreateForecast', createForecast_forecastTypes - The quantiles at which probabilistic forecasts are generated. __You can currently specify up to 5 quantiles per forecast__. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).

The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

$sel:tags:CreateForecast', createForecast_tags - The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

$sel:timeSeriesSelector:CreateForecast', createForecast_timeSeriesSelector - Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

```
DataSource
```
```
Format
```
```
Schema
```

CreateForecast, createForecast_forecastName - A name for the forecast.

CreateForecast, createForecast_predictorArn - The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Request Lenses

createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text)) Source #

The quantiles at which probabilistic forecasts are generated. __You can currently specify up to 5 quantiles per forecast__. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial).

The default quantiles are the quantiles you specified during predictor creation. If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"].

createForecast_tags :: Lens' CreateForecast (Maybe [Tag]) Source #

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50.
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8.
Maximum value length - 256 Unicode characters in UTF-8.
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case sensitive.
Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

createForecast_timeSeriesSelector :: Lens' CreateForecast (Maybe TimeSeriesSelector) Source #

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

```
DataSource
```
```
Format
```
```
Schema
```

createForecast_forecastName :: Lens' CreateForecast Text Source #

A name for the forecast.

createForecast_predictorArn :: Lens' CreateForecast Text Source #

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

Destructuring the Response

data CreateForecastResponse Source #

See: newCreateForecastResponse smart constructor.

Constructors

CreateForecastResponse'
Fields forecastArn :: Maybe Text The Amazon Resource Name (ARN) of the forecast. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateForecastResponse Source #

Arguments

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

Create a value of CreateForecastResponse 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:

CreateForecastResponse, createForecastResponse_forecastArn - The Amazon Resource Name (ARN) of the forecast.

$sel:httpStatus:CreateForecastResponse', createForecastResponse_httpStatus - The response's http status code.

Response Lenses

createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the forecast.

createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int Source #

The response's http status code.