| 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.Forecast.CreateForecast
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.
Synopsis
- data CreateForecast = CreateForecast' {
- forecastTypes :: Maybe (NonEmpty Text)
- tags :: Maybe [Tag]
- forecastName :: Text
- predictorArn :: Text
- newCreateForecast :: Text -> Text -> CreateForecast
- createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text))
- createForecast_tags :: Lens' CreateForecast (Maybe [Tag])
- 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
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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
value is ["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 hasawsas 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 ofawsdo not count against your tags per resource limit.
$sel:forecastName:CreateForecast', createForecast_forecastName - A name for the forecast.
$sel:predictorArn: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
value is ["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 hasawsas 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 ofawsdo not count against your tags per resource limit.
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
| |
Instances
newCreateForecastResponse Source #
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:
$sel:forecastArn: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.