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 |
- Service Configuration
- Errors
- Waiters
- Operations
- ListDatasetGroups (Paginated)
- CreateDatasetImportJob
- DescribeDataset
- ListForecasts (Paginated)
- ListTagsForResource
- StopResource
- DescribeDatasetImportJob
- DescribeForecastExportJob
- DescribePredictor
- DeleteDataset
- DescribeForecast
- CreateDataset
- DeleteForecastExportJob
- DeletePredictor
- ListDatasetImportJobs (Paginated)
- DeleteDatasetImportJob
- GetAccuracyMetrics
- DeleteDatasetGroup
- UpdateDatasetGroup
- CreateForecastExportJob
- CreatePredictor
- ListPredictorBacktestExportJobs (Paginated)
- DeletePredictorBacktestExportJob
- CreateForecast
- CreatePredictorBacktestExportJob
- DeleteForecast
- DeleteResourceTree
- DescribeDatasetGroup
- TagResource
- ListDatasets (Paginated)
- DescribePredictorBacktestExportJob
- UntagResource
- CreateDatasetGroup
- ListForecastExportJobs (Paginated)
- ListPredictors (Paginated)
- Types
- AttributeType
- AutoMLOverrideStrategy
- DatasetType
- Domain
- EvaluationType
- FeaturizationMethodName
- FilterConditionString
- OptimizationMetric
- ScalingType
- CategoricalParameterRange
- ContinuousParameterRange
- DataDestination
- DataSource
- DatasetGroupSummary
- DatasetImportJobSummary
- DatasetSummary
- EncryptionConfig
- ErrorMetric
- EvaluationParameters
- EvaluationResult
- Featurization
- FeaturizationConfig
- FeaturizationMethod
- Filter
- ForecastExportJobSummary
- ForecastSummary
- HyperParameterTuningJobConfig
- InputDataConfig
- IntegerParameterRange
- Metrics
- ParameterRanges
- PredictorBacktestExportJobSummary
- PredictorExecution
- PredictorExecutionDetails
- PredictorSummary
- S3Config
- Schema
- SchemaAttribute
- Statistics
- SupplementaryFeature
- Tag
- TestWindowSummary
- WeightedQuantileLoss
- WindowSummary
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
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _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 ListDatasetGroups = ListDatasetGroups' (Maybe Text) (Maybe Natural)
- newListDatasetGroups :: ListDatasetGroups
- data ListDatasetGroupsResponse = ListDatasetGroupsResponse' (Maybe Text) (Maybe [DatasetGroupSummary]) Int
- newListDatasetGroupsResponse :: Int -> ListDatasetGroupsResponse
- data CreateDatasetImportJob = CreateDatasetImportJob' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text DataSource
- newCreateDatasetImportJob :: Text -> Text -> DataSource -> CreateDatasetImportJob
- data CreateDatasetImportJobResponse = CreateDatasetImportJobResponse' (Maybe Text) Int
- newCreateDatasetImportJobResponse :: Int -> CreateDatasetImportJobResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Domain) (Maybe Schema) (Maybe DatasetType) (Maybe Text) (Maybe EncryptionConfig) (Maybe POSIX) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data ListForecasts = ListForecasts' (Maybe [Filter]) (Maybe Text) (Maybe Natural)
- newListForecasts :: ListForecasts
- data ListForecastsResponse = ListForecastsResponse' (Maybe [ForecastSummary]) (Maybe Text) Int
- newListForecastsResponse :: Int -> ListForecastsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data StopResource = StopResource' Text
- newStopResource :: Text -> StopResource
- data StopResourceResponse = StopResourceResponse' {
- newStopResourceResponse :: StopResourceResponse
- data DescribeDatasetImportJob = DescribeDatasetImportJob' Text
- newDescribeDatasetImportJob :: Text -> DescribeDatasetImportJob
- data DescribeDatasetImportJobResponse = DescribeDatasetImportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe (HashMap Text Statistics)) (Maybe DataSource) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeDatasetImportJobResponse :: Int -> DescribeDatasetImportJobResponse
- data DescribeForecastExportJob = DescribeForecastExportJob' Text
- newDescribeForecastExportJob :: Text -> DescribeForecastExportJob
- data DescribeForecastExportJobResponse = DescribeForecastExportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeForecastExportJobResponse :: Int -> DescribeForecastExportJobResponse
- data DescribePredictor = DescribePredictor' Text
- newDescribePredictor :: Text -> DescribePredictor
- data DescribePredictorResponse = DescribePredictorResponse' (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe HyperParameterTuningJobConfig) (Maybe Text) (Maybe OptimizationMetric) (Maybe PredictorExecutionDetails) (Maybe [Text]) (Maybe Integer) (Maybe AutoMLOverrideStrategy) (Maybe EvaluationParameters) (Maybe InputDataConfig) (Maybe Text) (Maybe FeaturizationConfig) (Maybe EncryptionConfig) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Bool) (Maybe POSIX) Int
- newDescribePredictorResponse :: Int -> DescribePredictorResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' {
- newDeleteDatasetResponse :: DeleteDatasetResponse
- data DescribeForecast = DescribeForecast' Text
- newDescribeForecast :: Text -> DescribeForecast
- data DescribeForecastResponse = DescribeForecastResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeForecastResponse :: Int -> DescribeForecastResponse
- data CreateDataset = CreateDataset' (Maybe Text) (Maybe EncryptionConfig) (Maybe [Tag]) Text Domain DatasetType Schema
- newCreateDataset :: Text -> Domain -> DatasetType -> Schema -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe Text) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data DeleteForecastExportJob = DeleteForecastExportJob' Text
- newDeleteForecastExportJob :: Text -> DeleteForecastExportJob
- data DeleteForecastExportJobResponse = DeleteForecastExportJobResponse' {
- newDeleteForecastExportJobResponse :: DeleteForecastExportJobResponse
- data DeletePredictor = DeletePredictor' Text
- newDeletePredictor :: Text -> DeletePredictor
- data DeletePredictorResponse = DeletePredictorResponse' {
- newDeletePredictorResponse :: DeletePredictorResponse
- data ListDatasetImportJobs = ListDatasetImportJobs' (Maybe [Filter]) (Maybe Text) (Maybe Natural)
- newListDatasetImportJobs :: ListDatasetImportJobs
- data ListDatasetImportJobsResponse = ListDatasetImportJobsResponse' (Maybe [DatasetImportJobSummary]) (Maybe Text) Int
- newListDatasetImportJobsResponse :: Int -> ListDatasetImportJobsResponse
- data DeleteDatasetImportJob = DeleteDatasetImportJob' Text
- newDeleteDatasetImportJob :: Text -> DeleteDatasetImportJob
- data DeleteDatasetImportJobResponse = DeleteDatasetImportJobResponse' {
- newDeleteDatasetImportJobResponse :: DeleteDatasetImportJobResponse
- data GetAccuracyMetrics = GetAccuracyMetrics' Text
- newGetAccuracyMetrics :: Text -> GetAccuracyMetrics
- data GetAccuracyMetricsResponse = GetAccuracyMetricsResponse' (Maybe [EvaluationResult]) (Maybe OptimizationMetric) (Maybe AutoMLOverrideStrategy) Int
- newGetAccuracyMetricsResponse :: Int -> GetAccuracyMetricsResponse
- data DeleteDatasetGroup = DeleteDatasetGroup' Text
- newDeleteDatasetGroup :: Text -> DeleteDatasetGroup
- data DeleteDatasetGroupResponse = DeleteDatasetGroupResponse' {
- newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse
- data UpdateDatasetGroup = UpdateDatasetGroup' Text [Text]
- newUpdateDatasetGroup :: Text -> UpdateDatasetGroup
- data UpdateDatasetGroupResponse = UpdateDatasetGroupResponse' Int
- newUpdateDatasetGroupResponse :: Int -> UpdateDatasetGroupResponse
- data CreateForecastExportJob = CreateForecastExportJob' (Maybe [Tag]) Text Text DataDestination
- newCreateForecastExportJob :: Text -> Text -> DataDestination -> CreateForecastExportJob
- data CreateForecastExportJobResponse = CreateForecastExportJobResponse' (Maybe Text) Int
- newCreateForecastExportJobResponse :: Int -> CreateForecastExportJobResponse
- data CreatePredictor = CreatePredictor' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe HyperParameterTuningJobConfig) (Maybe OptimizationMetric) (Maybe AutoMLOverrideStrategy) (Maybe EvaluationParameters) (Maybe EncryptionConfig) (Maybe (NonEmpty Text)) (Maybe Bool) (Maybe [Tag]) Text Int InputDataConfig FeaturizationConfig
- newCreatePredictor :: Text -> Int -> InputDataConfig -> FeaturizationConfig -> CreatePredictor
- data CreatePredictorResponse = CreatePredictorResponse' (Maybe Text) Int
- newCreatePredictorResponse :: Int -> CreatePredictorResponse
- data ListPredictorBacktestExportJobs = ListPredictorBacktestExportJobs' (Maybe [Filter]) (Maybe Text) (Maybe Natural)
- newListPredictorBacktestExportJobs :: ListPredictorBacktestExportJobs
- data ListPredictorBacktestExportJobsResponse = ListPredictorBacktestExportJobsResponse' (Maybe Text) (Maybe [PredictorBacktestExportJobSummary]) Int
- newListPredictorBacktestExportJobsResponse :: Int -> ListPredictorBacktestExportJobsResponse
- data DeletePredictorBacktestExportJob = DeletePredictorBacktestExportJob' Text
- newDeletePredictorBacktestExportJob :: Text -> DeletePredictorBacktestExportJob
- data DeletePredictorBacktestExportJobResponse = DeletePredictorBacktestExportJobResponse' {
- newDeletePredictorBacktestExportJobResponse :: DeletePredictorBacktestExportJobResponse
- data CreateForecast = CreateForecast' (Maybe (NonEmpty Text)) (Maybe [Tag]) Text Text
- newCreateForecast :: Text -> Text -> CreateForecast
- data CreateForecastResponse = CreateForecastResponse' (Maybe Text) Int
- newCreateForecastResponse :: Int -> CreateForecastResponse
- data CreatePredictorBacktestExportJob = CreatePredictorBacktestExportJob' (Maybe [Tag]) Text Text DataDestination
- newCreatePredictorBacktestExportJob :: Text -> Text -> DataDestination -> CreatePredictorBacktestExportJob
- data CreatePredictorBacktestExportJobResponse = CreatePredictorBacktestExportJobResponse' (Maybe Text) Int
- newCreatePredictorBacktestExportJobResponse :: Int -> CreatePredictorBacktestExportJobResponse
- data DeleteForecast = DeleteForecast' Text
- newDeleteForecast :: Text -> DeleteForecast
- data DeleteForecastResponse = DeleteForecastResponse' {
- newDeleteForecastResponse :: DeleteForecastResponse
- data DeleteResourceTree = DeleteResourceTree' Text
- newDeleteResourceTree :: Text -> DeleteResourceTree
- data DeleteResourceTreeResponse = DeleteResourceTreeResponse' {
- newDeleteResourceTreeResponse :: DeleteResourceTreeResponse
- data DescribeDatasetGroup = DescribeDatasetGroup' Text
- newDescribeDatasetGroup :: Text -> DescribeDatasetGroup
- data DescribeDatasetGroupResponse = DescribeDatasetGroupResponse' (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe Domain) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribeDatasetGroupResponse :: Int -> DescribeDatasetGroupResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListDatasets = ListDatasets' (Maybe Text) (Maybe Natural)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe Text) (Maybe [DatasetSummary]) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data DescribePredictorBacktestExportJob = DescribePredictorBacktestExportJob' Text
- newDescribePredictorBacktestExportJob :: Text -> DescribePredictorBacktestExportJob
- data DescribePredictorBacktestExportJobResponse = DescribePredictorBacktestExportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int
- newDescribePredictorBacktestExportJobResponse :: Int -> DescribePredictorBacktestExportJobResponse
- data UntagResource = UntagResource' Text [Sensitive Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data CreateDatasetGroup = CreateDatasetGroup' (Maybe [Text]) (Maybe [Tag]) Text Domain
- newCreateDatasetGroup :: Text -> Domain -> CreateDatasetGroup
- data CreateDatasetGroupResponse = CreateDatasetGroupResponse' (Maybe Text) Int
- newCreateDatasetGroupResponse :: Int -> CreateDatasetGroupResponse
- data ListForecastExportJobs = ListForecastExportJobs' (Maybe [Filter]) (Maybe Text) (Maybe Natural)
- newListForecastExportJobs :: ListForecastExportJobs
- data ListForecastExportJobsResponse = ListForecastExportJobsResponse' (Maybe Text) (Maybe [ForecastExportJobSummary]) Int
- newListForecastExportJobsResponse :: Int -> ListForecastExportJobsResponse
- data ListPredictors = ListPredictors' (Maybe [Filter]) (Maybe Text) (Maybe Natural)
- newListPredictors :: ListPredictors
- data ListPredictorsResponse = ListPredictorsResponse' (Maybe Text) (Maybe [PredictorSummary]) Int
- newListPredictorsResponse :: Int -> ListPredictorsResponse
- newtype AttributeType where
- AttributeType' { }
- pattern AttributeType_Float :: AttributeType
- pattern AttributeType_Geolocation :: AttributeType
- pattern AttributeType_Integer :: AttributeType
- pattern AttributeType_String :: AttributeType
- pattern AttributeType_Timestamp :: AttributeType
- newtype AutoMLOverrideStrategy where
- newtype DatasetType where
- DatasetType' { }
- pattern DatasetType_ITEM_METADATA :: DatasetType
- pattern DatasetType_RELATED_TIME_SERIES :: DatasetType
- pattern DatasetType_TARGET_TIME_SERIES :: DatasetType
- newtype Domain where
- Domain' {
- fromDomain :: Text
- pattern Domain_CUSTOM :: Domain
- pattern Domain_EC2_CAPACITY :: Domain
- pattern Domain_INVENTORY_PLANNING :: Domain
- pattern Domain_METRICS :: Domain
- pattern Domain_RETAIL :: Domain
- pattern Domain_WEB_TRAFFIC :: Domain
- pattern Domain_WORK_FORCE :: Domain
- Domain' {
- newtype EvaluationType where
- EvaluationType' { }
- pattern EvaluationType_COMPUTED :: EvaluationType
- pattern EvaluationType_SUMMARY :: EvaluationType
- newtype FeaturizationMethodName where
- newtype FilterConditionString where
- newtype OptimizationMetric where
- OptimizationMetric' { }
- pattern OptimizationMetric_AverageWeightedQuantileLoss :: OptimizationMetric
- pattern OptimizationMetric_MAPE :: OptimizationMetric
- pattern OptimizationMetric_MASE :: OptimizationMetric
- pattern OptimizationMetric_RMSE :: OptimizationMetric
- pattern OptimizationMetric_WAPE :: OptimizationMetric
- newtype ScalingType where
- ScalingType' { }
- pattern ScalingType_Auto :: ScalingType
- pattern ScalingType_Linear :: ScalingType
- pattern ScalingType_Logarithmic :: ScalingType
- pattern ScalingType_ReverseLogarithmic :: ScalingType
- data CategoricalParameterRange = CategoricalParameterRange' Text (NonEmpty Text)
- newCategoricalParameterRange :: Text -> NonEmpty Text -> CategoricalParameterRange
- data ContinuousParameterRange = ContinuousParameterRange' (Maybe ScalingType) Text Double Double
- newContinuousParameterRange :: Text -> Double -> Double -> ContinuousParameterRange
- data DataDestination = DataDestination' S3Config
- newDataDestination :: S3Config -> DataDestination
- data DataSource = DataSource' S3Config
- newDataSource :: S3Config -> DataSource
- data DatasetGroupSummary = DatasetGroupSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetGroupSummary :: DatasetGroupSummary
- data DatasetImportJobSummary = DatasetImportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetImportJobSummary :: DatasetImportJobSummary
- data DatasetSummary = DatasetSummary' (Maybe POSIX) (Maybe Text) (Maybe Domain) (Maybe DatasetType) (Maybe Text) (Maybe POSIX)
- newDatasetSummary :: DatasetSummary
- data EncryptionConfig = EncryptionConfig' Text Text
- newEncryptionConfig :: Text -> Text -> EncryptionConfig
- data ErrorMetric = ErrorMetric' (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Text)
- newErrorMetric :: ErrorMetric
- data EvaluationParameters = EvaluationParameters' (Maybe Int) (Maybe Int)
- newEvaluationParameters :: EvaluationParameters
- data EvaluationResult = EvaluationResult' (Maybe Text) (Maybe [WindowSummary])
- newEvaluationResult :: EvaluationResult
- data Featurization = Featurization' (Maybe (NonEmpty FeaturizationMethod)) Text
- newFeaturization :: Text -> Featurization
- data FeaturizationConfig = FeaturizationConfig' (Maybe (NonEmpty Featurization)) (Maybe (NonEmpty Text)) Text
- newFeaturizationConfig :: Text -> FeaturizationConfig
- data FeaturizationMethod = FeaturizationMethod' (Maybe (HashMap Text Text)) FeaturizationMethodName
- newFeaturizationMethod :: FeaturizationMethodName -> FeaturizationMethod
- data Filter = Filter' Text Text FilterConditionString
- newFilter :: Text -> Text -> FilterConditionString -> Filter
- data ForecastExportJobSummary = ForecastExportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newForecastExportJobSummary :: ForecastExportJobSummary
- data ForecastSummary = ForecastSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newForecastSummary :: ForecastSummary
- data HyperParameterTuningJobConfig = HyperParameterTuningJobConfig' (Maybe ParameterRanges)
- newHyperParameterTuningJobConfig :: HyperParameterTuningJobConfig
- data InputDataConfig = InputDataConfig' (Maybe (NonEmpty SupplementaryFeature)) Text
- newInputDataConfig :: Text -> InputDataConfig
- data IntegerParameterRange = IntegerParameterRange' (Maybe ScalingType) Text Int Int
- newIntegerParameterRange :: Text -> Int -> Int -> IntegerParameterRange
- data Metrics = Metrics' (Maybe [ErrorMetric]) (Maybe Double) (Maybe [WeightedQuantileLoss]) (Maybe Double)
- newMetrics :: Metrics
- data ParameterRanges = ParameterRanges' (Maybe (NonEmpty CategoricalParameterRange)) (Maybe (NonEmpty IntegerParameterRange)) (Maybe (NonEmpty ContinuousParameterRange))
- newParameterRanges :: ParameterRanges
- data PredictorBacktestExportJobSummary = PredictorBacktestExportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newPredictorBacktestExportJobSummary :: PredictorBacktestExportJobSummary
- data PredictorExecution = PredictorExecution' (Maybe Text) (Maybe [TestWindowSummary])
- newPredictorExecution :: PredictorExecution
- data PredictorExecutionDetails = PredictorExecutionDetails' (Maybe (NonEmpty PredictorExecution))
- newPredictorExecutionDetails :: PredictorExecutionDetails
- data PredictorSummary = PredictorSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newPredictorSummary :: PredictorSummary
- data S3Config = S3Config' (Maybe Text) Text Text
- newS3Config :: Text -> Text -> S3Config
- data Schema = Schema' (Maybe (NonEmpty SchemaAttribute))
- newSchema :: Schema
- data SchemaAttribute = SchemaAttribute' (Maybe AttributeType) (Maybe Text)
- newSchemaAttribute :: SchemaAttribute
- data Statistics = Statistics' (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Double) (Maybe Int) (Maybe Int) (Maybe Integer) (Maybe Double) (Maybe Text) (Maybe Integer) (Maybe Int)
- newStatistics :: Statistics
- data SupplementaryFeature = SupplementaryFeature' Text Text
- newSupplementaryFeature :: Text -> Text -> SupplementaryFeature
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
- data TestWindowSummary = TestWindowSummary' (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text)
- newTestWindowSummary :: TestWindowSummary
- data WeightedQuantileLoss = WeightedQuantileLoss' (Maybe Double) (Maybe Double)
- newWeightedQuantileLoss :: WeightedQuantileLoss
- data WindowSummary = WindowSummary' (Maybe Metrics) (Maybe POSIX) (Maybe EvaluationType) (Maybe POSIX) (Maybe Int)
- newWindowSummary :: WindowSummary
Service Configuration
defaultService :: Service Source #
API version 2018-06-26
of the Amazon Forecast 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 Forecast
.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is already a resource with this name. Try again with a different name.
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 #
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit on the number of resources per account 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.
ListDatasetGroups (Paginated)
data ListDatasetGroups Source #
See: newListDatasetGroups
smart constructor.
Instances
newListDatasetGroups :: ListDatasetGroups Source #
Create a value of ListDatasetGroups
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:nextToken:ListDatasetGroups'
, listDatasetGroups_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:maxResults:ListDatasetGroups'
, listDatasetGroups_maxResults
- The number of items to return in the response.
data ListDatasetGroupsResponse Source #
See: newListDatasetGroupsResponse
smart constructor.
Instances
newListDatasetGroupsResponse Source #
Create a value of ListDatasetGroupsResponse
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:nextToken:ListDatasetGroups'
, listDatasetGroupsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:datasetGroups:ListDatasetGroupsResponse'
, listDatasetGroupsResponse_datasetGroups
- An array of objects that summarize each dataset group's properties.
$sel:httpStatus:ListDatasetGroupsResponse'
, listDatasetGroupsResponse_httpStatus
- The response's http status code.
CreateDatasetImportJob
data CreateDatasetImportJob Source #
See: newCreateDatasetImportJob
smart constructor.
CreateDatasetImportJob' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe [Tag]) Text Text DataSource |
Instances
newCreateDatasetImportJob Source #
:: Text | |
-> Text | |
-> DataSource | |
-> CreateDatasetImportJob |
Create a value of CreateDatasetImportJob
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:timestampFormat:CreateDatasetImportJob'
, createDatasetImportJob_timestampFormat
- The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
$sel:useGeolocationForTimeZone:CreateDatasetImportJob'
, createDatasetImportJob_useGeolocationForTimeZone
- Automatically derive time zone information from the geolocation
attribute. This option is ideal for datasets that contain timestamps in
multiple time zones and those timestamps are expressed in local time.
$sel:geolocationFormat:CreateDatasetImportJob'
, createDatasetImportJob_geolocationFormat
- The format of the geolocation attribute. The geolocation attribute can
be formatted in one of two ways:
LAT_LONG
- the latitude and longitude in decimal format (Example: 47.61_-122.33).CC_POSTALCODE
(US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).
$sel:timeZone:CreateDatasetImportJob'
, createDatasetImportJob_timeZone
- A single time zone for every item in your dataset. This option is ideal
for datasets with all timestamps within a single time zone, or if all
timestamps are normalized to a single time zone.
Refer to the Joda-Time API for a complete list of valid time zone names.
$sel:tags:CreateDatasetImportJob'
, createDatasetImportJob_tags
- The optional metadata that you apply to the dataset import job 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 hasaws
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 ofaws
do not count against your tags per resource limit.
$sel:datasetImportJobName:CreateDatasetImportJob'
, createDatasetImportJob_datasetImportJobName
- The name for the dataset import job. We recommend including the current
timestamp in the name, for example, 20190721DatasetImport
. This can
help you avoid getting a ResourceAlreadyExistsException
exception.
$sel:datasetArn:CreateDatasetImportJob'
, createDatasetImportJob_datasetArn
- The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
want to import data to.
$sel:dataSource:CreateDatasetImportJob'
, createDatasetImportJob_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
must include an AWS Key Management
Service (KMS) key and the IAM role must allow Amazon Forecast permission
to access the key. The KMS key and IAM role must match those specified
in the EncryptionConfig
parameter of the CreateDataset operation.
data CreateDatasetImportJobResponse Source #
See: newCreateDatasetImportJobResponse
smart constructor.
Instances
Eq CreateDatasetImportJobResponse Source # | |
Read CreateDatasetImportJobResponse Source # | |
Show CreateDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateDatasetImportJob | |
Generic CreateDatasetImportJobResponse Source # | |
NFData CreateDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateDatasetImportJob rnf :: CreateDatasetImportJobResponse -> () # | |
type Rep CreateDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateDatasetImportJob type Rep CreateDatasetImportJobResponse = D1 ('MetaData "CreateDatasetImportJobResponse" "Amazonka.Forecast.CreateDatasetImportJob" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "CreateDatasetImportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "datasetImportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateDatasetImportJobResponse Source #
Create a value of CreateDatasetImportJobResponse
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:datasetImportJobArn:CreateDatasetImportJobResponse'
, createDatasetImportJobResponse_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
$sel:httpStatus:CreateDatasetImportJobResponse'
, createDatasetImportJobResponse_httpStatus
- The response's http status code.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset
smart constructor.
Instances
Create a value of DescribeDataset
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:datasetArn:DescribeDataset'
, describeDataset_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse
smart constructor.
DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Domain) (Maybe Schema) (Maybe DatasetType) (Maybe Text) (Maybe EncryptionConfig) (Maybe POSIX) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse
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:creationTime:DescribeDatasetResponse'
, describeDatasetResponse_creationTime
- When the dataset was created.
$sel:status:DescribeDatasetResponse'
, describeDatasetResponse_status
- The status of the dataset. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply while data is imported to the dataset from a
call to the CreateDatasetImportJob operation and reflect the status of
the dataset import job. For example, when the import job status is
CREATE_IN_PROGRESS
, the status of the dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import
training data.
$sel:dataFrequency:DescribeDatasetResponse'
, describeDatasetResponse_dataFrequency
- The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.
$sel:datasetArn:DescribeDataset'
, describeDatasetResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:domain:DescribeDatasetResponse'
, describeDatasetResponse_domain
- The domain associated with the dataset.
$sel:schema:DescribeDatasetResponse'
, describeDatasetResponse_schema
- An array of SchemaAttribute
objects that specify the dataset fields.
Each SchemaAttribute
specifies the name and data type of a field.
$sel:datasetType:DescribeDatasetResponse'
, describeDatasetResponse_datasetType
- The dataset type.
$sel:datasetName:DescribeDatasetResponse'
, describeDatasetResponse_datasetName
- The name of the dataset.
$sel:encryptionConfig:DescribeDatasetResponse'
, describeDatasetResponse_encryptionConfig
- The AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:lastModificationTime:DescribeDatasetResponse'
, describeDatasetResponse_lastModificationTime
- When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the DescribeDataset
call. After a CreateDatasetImportJob operation has finished,
LastModificationTime
is when the import job completed or failed.
$sel:httpStatus:DescribeDatasetResponse'
, describeDatasetResponse_httpStatus
- The response's http status code.
ListForecasts (Paginated)
data ListForecasts Source #
See: newListForecasts
smart constructor.
Instances
newListForecasts :: ListForecasts Source #
Create a value of ListForecasts
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:filters:ListForecasts'
, listForecasts_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecasts that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
$sel:nextToken:ListForecasts'
, listForecasts_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:maxResults:ListForecasts'
, listForecasts_maxResults
- The number of items to return in the response.
data ListForecastsResponse Source #
See: newListForecastsResponse
smart constructor.
Instances
newListForecastsResponse Source #
Create a value of ListForecastsResponse
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:forecasts:ListForecastsResponse'
, listForecastsResponse_forecasts
- An array of objects that summarize each forecast's properties.
$sel:nextToken:ListForecasts'
, listForecastsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListForecastsResponse'
, listForecastsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
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:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the supported resources are Forecast dataset
groups, datasets, dataset import jobs, predictors, forecasts, and
forecast export jobs.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
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:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags for the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
StopResource
data StopResource Source #
See: newStopResource
smart constructor.
Instances
Create a value of StopResource
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:resourceArn:StopResource'
, stopResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource to stop. The
supported ARNs are DatasetImportJobArn
, PredictorArn
,
PredictorBacktestExportJobArn
, ForecastArn
, and
ForecastExportJobArn
.
data StopResourceResponse Source #
See: newStopResourceResponse
smart constructor.
Instances
Eq StopResourceResponse Source # | |
Defined in Amazonka.Forecast.StopResource (==) :: StopResourceResponse -> StopResourceResponse -> Bool # (/=) :: StopResourceResponse -> StopResourceResponse -> Bool # | |
Read StopResourceResponse Source # | |
Show StopResourceResponse Source # | |
Defined in Amazonka.Forecast.StopResource showsPrec :: Int -> StopResourceResponse -> ShowS # show :: StopResourceResponse -> String # showList :: [StopResourceResponse] -> ShowS # | |
Generic StopResourceResponse Source # | |
Defined in Amazonka.Forecast.StopResource type Rep StopResourceResponse :: Type -> Type # from :: StopResourceResponse -> Rep StopResourceResponse x # to :: Rep StopResourceResponse x -> StopResourceResponse # | |
NFData StopResourceResponse Source # | |
Defined in Amazonka.Forecast.StopResource rnf :: StopResourceResponse -> () # | |
type Rep StopResourceResponse Source # | |
newStopResourceResponse :: StopResourceResponse Source #
Create a value of StopResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDatasetImportJob
data DescribeDatasetImportJob Source #
See: newDescribeDatasetImportJob
smart constructor.
Instances
newDescribeDatasetImportJob Source #
Create a value of DescribeDatasetImportJob
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:datasetImportJobArn:DescribeDatasetImportJob'
, describeDatasetImportJob_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
data DescribeDatasetImportJobResponse Source #
See: newDescribeDatasetImportJobResponse
smart constructor.
DescribeDatasetImportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Double) (Maybe Integer) (Maybe (HashMap Text Statistics)) (Maybe DataSource) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribeDatasetImportJobResponse Source #
Create a value of DescribeDatasetImportJobResponse
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:creationTime:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_creationTime
- When the dataset import job was created.
$sel:status:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_status
- The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
$sel:datasetImportJobName:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_datasetImportJobName
- The name of the dataset import job.
$sel:datasetArn:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset that the training data was
imported to.
$sel:timestampFormat:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_timestampFormat
- The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
$sel:dataSize:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_dataSize
- The size of the dataset in gigabytes (GB) after the import job has
finished.
$sel:estimatedTimeRemainingInMinutes:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the dataset import job to
complete.
$sel:fieldStatistics:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_fieldStatistics
- Statistical information about each field in the input data.
$sel:dataSource:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
$sel:datasetImportJobArn:DescribeDatasetImportJob'
, describeDatasetImportJobResponse_datasetImportJobArn
- The ARN of the dataset import job.
$sel:useGeolocationForTimeZone:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_useGeolocationForTimeZone
- Whether TimeZone
is automatically derived from the geolocation
attribute.
$sel:message:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_message
- If an error occurred, an informational message about the error.
$sel:geolocationFormat:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_geolocationFormat
- The format of the geolocation attribute. Valid Values:"LAT_LONG"
and
"CC_POSTALCODE"
.
$sel:timeZone:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_timeZone
- The single time zone applied to every item in the dataset
$sel:lastModificationTime:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:httpStatus:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_httpStatus
- The response's http status code.
DescribeForecastExportJob
data DescribeForecastExportJob Source #
See: newDescribeForecastExportJob
smart constructor.
Instances
newDescribeForecastExportJob Source #
Create a value of DescribeForecastExportJob
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:forecastExportJobArn:DescribeForecastExportJob'
, describeForecastExportJob_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job.
data DescribeForecastExportJobResponse Source #
See: newDescribeForecastExportJobResponse
smart constructor.
DescribeForecastExportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribeForecastExportJobResponse Source #
Create a value of DescribeForecastExportJobResponse
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:creationTime:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_creationTime
- When the forecast export job was created.
$sel:status:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_status
- The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
$sel:destination:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_destination
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
$sel:forecastExportJobArn:DescribeForecastExportJob'
, describeForecastExportJobResponse_forecastExportJobArn
- The ARN of the forecast export job.
$sel:forecastArn:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_forecastArn
- The Amazon Resource Name (ARN) of the exported forecast.
$sel:forecastExportJobName:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_forecastExportJobName
- The name of the forecast export job.
$sel:message:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:httpStatus:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_httpStatus
- The response's http status code.
DescribePredictor
data DescribePredictor Source #
See: newDescribePredictor
smart constructor.
Instances
Create a value of DescribePredictor
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:predictorArn:DescribePredictor'
, describePredictor_predictorArn
- The Amazon Resource Name (ARN) of the predictor that you want
information about.
data DescribePredictorResponse Source #
See: newDescribePredictorResponse
smart constructor.
DescribePredictorResponse' (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe HyperParameterTuningJobConfig) (Maybe Text) (Maybe OptimizationMetric) (Maybe PredictorExecutionDetails) (Maybe [Text]) (Maybe Integer) (Maybe AutoMLOverrideStrategy) (Maybe EvaluationParameters) (Maybe InputDataConfig) (Maybe Text) (Maybe FeaturizationConfig) (Maybe EncryptionConfig) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Bool) (Maybe POSIX) Int |
Instances
newDescribePredictorResponse Source #
Create a value of DescribePredictorResponse
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:creationTime:DescribePredictorResponse'
, describePredictorResponse_creationTime
- When the model training task was created.
$sel:forecastHorizon:DescribePredictorResponse'
, describePredictorResponse_forecastHorizon
- The number of time-steps of the forecast. The forecast horizon is also
called the prediction length.
$sel:status:DescribePredictorResponse'
, describePredictorResponse_status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
$sel:performAutoML:DescribePredictorResponse'
, describePredictorResponse_performAutoML
- Whether the predictor is set to perform AutoML.
$sel:autoMLAlgorithmArns:DescribePredictorResponse'
, describePredictorResponse_autoMLAlgorithmArns
- When PerformAutoML
is specified, the ARN of the chosen algorithm.
$sel:trainingParameters:DescribePredictorResponse'
, describePredictorResponse_trainingParameters
- The default training parameters or overrides selected during model
training. When running AutoML or choosing HPO with CNN-QR or DeepAR+,
the optimized values for the chosen hyperparameters are returned. For
more information, see aws-forecast-choosing-recipes.
$sel:algorithmArn:DescribePredictorResponse'
, describePredictorResponse_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm used for model training.
$sel:hPOConfig:DescribePredictorResponse'
, describePredictorResponse_hPOConfig
- The hyperparameter override values for the algorithm.
$sel:predictorArn:DescribePredictor'
, describePredictorResponse_predictorArn
- The ARN of the predictor.
$sel:optimizationMetric:DescribePredictorResponse'
, describePredictorResponse_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:predictorExecutionDetails:DescribePredictorResponse'
, describePredictorResponse_predictorExecutionDetails
- Details on the the status and results of the backtests performed to
evaluate the accuracy of the predictor. You specify the number of
backtests to perform when you call the operation.
$sel:datasetImportJobArns:DescribePredictorResponse'
, describePredictorResponse_datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training
data for the predictor.
$sel:estimatedTimeRemainingInMinutes:DescribePredictorResponse'
, describePredictorResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the predictor training job
to complete.
$sel:autoMLOverrideStrategy:DescribePredictorResponse'
, describePredictorResponse_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
$sel:evaluationParameters:DescribePredictorResponse'
, describePredictorResponse_evaluationParameters
- Used to override the default evaluation parameters of the specified
algorithm. Amazon Forecast evaluates a predictor by splitting a dataset
into training data and testing data. The evaluation parameters define
how to perform the split and the number of iterations.
$sel:inputDataConfig:DescribePredictorResponse'
, describePredictorResponse_inputDataConfig
- Describes the dataset group that contains the data to use to train the
predictor.
$sel:predictorName:DescribePredictorResponse'
, describePredictorResponse_predictorName
- The name of the predictor.
$sel:featurizationConfig:DescribePredictorResponse'
, describePredictorResponse_featurizationConfig
- The featurization configuration.
$sel:encryptionConfig:DescribePredictorResponse'
, describePredictorResponse_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:forecastTypes:DescribePredictorResponse'
, describePredictorResponse_forecastTypes
- The forecast types used during predictor training. Default value is
["0.1","0.5","0.9"]
$sel:message:DescribePredictorResponse'
, describePredictorResponse_message
- If an error occurred, an informational message about the error.
$sel:performHPO:DescribePredictorResponse'
, describePredictorResponse_performHPO
- Whether the predictor is set to perform hyperparameter optimization
(HPO).
$sel:lastModificationTime:DescribePredictorResponse'
, describePredictorResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:httpStatus:DescribePredictorResponse'
, describePredictorResponse_httpStatus
- The response's http status code.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset
smart constructor.
Instances
Create a value of DeleteDataset
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:datasetArn:DeleteDataset'
, deleteDataset_datasetArn
- The Amazon Resource Name (ARN) of the dataset to delete.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse
smart constructor.
Instances
Eq DeleteDatasetResponse Source # | |
Defined in Amazonka.Forecast.DeleteDataset (==) :: DeleteDatasetResponse -> DeleteDatasetResponse -> Bool # (/=) :: DeleteDatasetResponse -> DeleteDatasetResponse -> Bool # | |
Read DeleteDatasetResponse Source # | |
Show DeleteDatasetResponse Source # | |
Defined in Amazonka.Forecast.DeleteDataset showsPrec :: Int -> DeleteDatasetResponse -> ShowS # show :: DeleteDatasetResponse -> String # showList :: [DeleteDatasetResponse] -> ShowS # | |
Generic DeleteDatasetResponse Source # | |
Defined in Amazonka.Forecast.DeleteDataset type Rep DeleteDatasetResponse :: Type -> Type # | |
NFData DeleteDatasetResponse Source # | |
Defined in Amazonka.Forecast.DeleteDataset rnf :: DeleteDatasetResponse -> () # | |
type Rep DeleteDatasetResponse Source # | |
newDeleteDatasetResponse :: DeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeForecast
data DescribeForecast Source #
See: newDescribeForecast
smart constructor.
Instances
Create a value of DescribeForecast
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:DescribeForecast'
, describeForecast_forecastArn
- The Amazon Resource Name (ARN) of the forecast.
data DescribeForecastResponse Source #
See: newDescribeForecastResponse
smart constructor.
DescribeForecastResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribeForecastResponse Source #
Create a value of DescribeForecastResponse
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:creationTime:DescribeForecastResponse'
, describeForecastResponse_creationTime
- When the forecast creation task was created.
$sel:status:DescribeForecastResponse'
, describeForecastResponse_status
- The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
$sel:predictorArn:DescribeForecastResponse'
, describeForecastResponse_predictorArn
- The ARN of the predictor used to generate the forecast.
$sel:forecastArn:DescribeForecast'
, describeForecastResponse_forecastArn
- The forecast ARN as specified in the request.
$sel:estimatedTimeRemainingInMinutes:DescribeForecastResponse'
, describeForecastResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the forecast job to
complete.
$sel:forecastName:DescribeForecastResponse'
, describeForecastResponse_forecastName
- The name of the forecast.
$sel:forecastTypes:DescribeForecastResponse'
, describeForecastResponse_forecastTypes
- The quantiles at which probabilistic forecasts were generated.
$sel:datasetGroupArn:DescribeForecastResponse'
, describeForecastResponse_datasetGroupArn
- The ARN of the dataset group that provided the data used to train the
predictor.
$sel:message:DescribeForecastResponse'
, describeForecastResponse_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:DescribeForecastResponse'
, describeForecastResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:httpStatus:DescribeForecastResponse'
, describeForecastResponse_httpStatus
- The response's http status code.
CreateDataset
data CreateDataset Source #
See: newCreateDataset
smart constructor.
Instances
:: Text | |
-> Domain | |
-> DatasetType | |
-> Schema | |
-> CreateDataset |
Create a value of CreateDataset
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:dataFrequency:CreateDataset'
, createDataset_dataFrequency
- The frequency of data collection. This parameter is required for
RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.
$sel:encryptionConfig:CreateDataset'
, createDataset_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:tags:CreateDataset'
, createDataset_tags
- The optional metadata that you apply to the dataset 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 hasaws
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 ofaws
do not count against your tags per resource limit.
$sel:datasetName:CreateDataset'
, createDataset_datasetName
- A name for the dataset.
$sel:domain:CreateDataset'
, createDataset_domain
- The domain associated with the dataset. When you add a dataset to a
dataset group, this value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in the training data that you import to the dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires item_id
, timestamp
, and
demand
fields to be present in your data. For more information, see
howitworks-datasets-groups.
$sel:datasetType:CreateDataset'
, createDataset_datasetType
- The dataset type. Valid values depend on the chosen Domain
.
$sel:schema:CreateDataset'
, createDataset_schema
- The schema for the dataset. The schema attributes and their order must
match the fields in your data. The dataset Domain
and DatasetType
that you choose determine the minimum required fields in your training
data. For information about the required fields for a specific dataset
domain and type, see howitworks-domains-ds-types.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse
smart constructor.
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse
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:datasetArn:CreateDatasetResponse'
, createDatasetResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:httpStatus:CreateDatasetResponse'
, createDatasetResponse_httpStatus
- The response's http status code.
DeleteForecastExportJob
data DeleteForecastExportJob Source #
See: newDeleteForecastExportJob
smart constructor.
Instances
newDeleteForecastExportJob Source #
Create a value of DeleteForecastExportJob
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:forecastExportJobArn:DeleteForecastExportJob'
, deleteForecastExportJob_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job to delete.
data DeleteForecastExportJobResponse Source #
See: newDeleteForecastExportJobResponse
smart constructor.
Instances
newDeleteForecastExportJobResponse :: DeleteForecastExportJobResponse Source #
Create a value of DeleteForecastExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePredictor
data DeletePredictor Source #
See: newDeletePredictor
smart constructor.
Instances
Create a value of DeletePredictor
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:predictorArn:DeletePredictor'
, deletePredictor_predictorArn
- The Amazon Resource Name (ARN) of the predictor to delete.
data DeletePredictorResponse Source #
See: newDeletePredictorResponse
smart constructor.
Instances
Eq DeletePredictorResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictor | |
Read DeletePredictorResponse Source # | |
Show DeletePredictorResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictor showsPrec :: Int -> DeletePredictorResponse -> ShowS # show :: DeletePredictorResponse -> String # showList :: [DeletePredictorResponse] -> ShowS # | |
Generic DeletePredictorResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictor type Rep DeletePredictorResponse :: Type -> Type # | |
NFData DeletePredictorResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictor rnf :: DeletePredictorResponse -> () # | |
type Rep DeletePredictorResponse Source # | |
newDeletePredictorResponse :: DeletePredictorResponse Source #
Create a value of DeletePredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDatasetImportJobs (Paginated)
data ListDatasetImportJobs Source #
See: newListDatasetImportJobs
smart constructor.
Instances
newListDatasetImportJobs :: ListDatasetImportJobs Source #
Create a value of ListDatasetImportJobs
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:filters:ListDatasetImportJobs'
, listDatasetImportJobs_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the datasets that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the datasets that match the statement, specifyIS
. To exclude matching datasets, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetArn
andStatus
.Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
$sel:nextToken:ListDatasetImportJobs'
, listDatasetImportJobs_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:maxResults:ListDatasetImportJobs'
, listDatasetImportJobs_maxResults
- The number of items to return in the response.
data ListDatasetImportJobsResponse Source #
See: newListDatasetImportJobsResponse
smart constructor.
Instances
newListDatasetImportJobsResponse Source #
Create a value of ListDatasetImportJobsResponse
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:datasetImportJobs:ListDatasetImportJobsResponse'
, listDatasetImportJobsResponse_datasetImportJobs
- An array of objects that summarize each dataset import job's
properties.
$sel:nextToken:ListDatasetImportJobs'
, listDatasetImportJobsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListDatasetImportJobsResponse'
, listDatasetImportJobsResponse_httpStatus
- The response's http status code.
DeleteDatasetImportJob
data DeleteDatasetImportJob Source #
See: newDeleteDatasetImportJob
smart constructor.
Instances
newDeleteDatasetImportJob Source #
Create a value of DeleteDatasetImportJob
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:datasetImportJobArn:DeleteDatasetImportJob'
, deleteDatasetImportJob_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job to delete.
data DeleteDatasetImportJobResponse Source #
See: newDeleteDatasetImportJobResponse
smart constructor.
Instances
newDeleteDatasetImportJobResponse :: DeleteDatasetImportJobResponse Source #
Create a value of DeleteDatasetImportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetAccuracyMetrics
data GetAccuracyMetrics Source #
See: newGetAccuracyMetrics
smart constructor.
Instances
newGetAccuracyMetrics Source #
Create a value of GetAccuracyMetrics
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:predictorArn:GetAccuracyMetrics'
, getAccuracyMetrics_predictorArn
- The Amazon Resource Name (ARN) of the predictor to get metrics for.
data GetAccuracyMetricsResponse Source #
See: newGetAccuracyMetricsResponse
smart constructor.
GetAccuracyMetricsResponse' (Maybe [EvaluationResult]) (Maybe OptimizationMetric) (Maybe AutoMLOverrideStrategy) Int |
Instances
newGetAccuracyMetricsResponse Source #
Create a value of GetAccuracyMetricsResponse
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:predictorEvaluationResults:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_predictorEvaluationResults
- An array of results from evaluating the predictor.
$sel:optimizationMetric:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:autoMLOverrideStrategy:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
$sel:httpStatus:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_httpStatus
- The response's http status code.
DeleteDatasetGroup
data DeleteDatasetGroup Source #
See: newDeleteDatasetGroup
smart constructor.
Instances
newDeleteDatasetGroup Source #
Create a value of DeleteDatasetGroup
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:datasetGroupArn:DeleteDatasetGroup'
, deleteDatasetGroup_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group to delete.
data DeleteDatasetGroupResponse Source #
See: newDeleteDatasetGroupResponse
smart constructor.
Instances
newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse Source #
Create a value of DeleteDatasetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateDatasetGroup
data UpdateDatasetGroup Source #
See: newUpdateDatasetGroup
smart constructor.
Instances
newUpdateDatasetGroup Source #
Create a value of UpdateDatasetGroup
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:datasetGroupArn:UpdateDatasetGroup'
, updateDatasetGroup_datasetGroupArn
- The ARN of the dataset group.
$sel:datasetArns:UpdateDatasetGroup'
, updateDatasetGroup_datasetArns
- An array of the Amazon Resource Names (ARNs) of the datasets to add to
the dataset group.
data UpdateDatasetGroupResponse Source #
See: newUpdateDatasetGroupResponse
smart constructor.
Instances
newUpdateDatasetGroupResponse Source #
Create a value of UpdateDatasetGroupResponse
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:httpStatus:UpdateDatasetGroupResponse'
, updateDatasetGroupResponse_httpStatus
- The response's http status code.
CreateForecastExportJob
data CreateForecastExportJob Source #
See: newCreateForecastExportJob
smart constructor.
Instances
newCreateForecastExportJob Source #
:: Text | |
-> Text | |
-> DataDestination | |
-> CreateForecastExportJob |
Create a value of CreateForecastExportJob
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:tags:CreateForecastExportJob'
, createForecastExportJob_tags
- The optional metadata that you apply to the forecast export job 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 hasaws
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 ofaws
do not count against your tags per resource limit.
$sel:forecastExportJobName:CreateForecastExportJob'
, createForecastExportJob_forecastExportJobName
- The name for the forecast export job.
$sel:forecastArn:CreateForecastExportJob'
, createForecastExportJob_forecastArn
- The Amazon Resource Name (ARN) of the forecast that you want to export.
$sel:destination:CreateForecastExportJob'
, createForecastExportJob_destination
- The location where you want to save the forecast and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
data CreateForecastExportJobResponse Source #
See: newCreateForecastExportJobResponse
smart constructor.
Instances
Eq CreateForecastExportJobResponse Source # | |
Read CreateForecastExportJobResponse Source # | |
Show CreateForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateForecastExportJob | |
Generic CreateForecastExportJobResponse Source # | |
NFData CreateForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateForecastExportJob rnf :: CreateForecastExportJobResponse -> () # | |
type Rep CreateForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.CreateForecastExportJob type Rep CreateForecastExportJobResponse = D1 ('MetaData "CreateForecastExportJobResponse" "Amazonka.Forecast.CreateForecastExportJob" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "CreateForecastExportJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forecastExportJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newCreateForecastExportJobResponse Source #
Create a value of CreateForecastExportJobResponse
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:forecastExportJobArn:CreateForecastExportJobResponse'
, createForecastExportJobResponse_forecastExportJobArn
- The Amazon Resource Name (ARN) of the export job.
$sel:httpStatus:CreateForecastExportJobResponse'
, createForecastExportJobResponse_httpStatus
- The response's http status code.
CreatePredictor
data CreatePredictor Source #
See: newCreatePredictor
smart constructor.
Instances
:: Text | |
-> Int | |
-> InputDataConfig | |
-> FeaturizationConfig | |
-> CreatePredictor |
Create a value of CreatePredictor
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:performAutoML:CreatePredictor'
, createPredictor_performAutoML
- Whether to perform AutoML. When Amazon Forecast performs AutoML, it
evaluates the algorithms it provides and chooses the best algorithm and
configuration for your training dataset.
The default value is false
. In this case, you are required to specify
an algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML.
This is a good option if you aren't sure which algorithm is suitable
for your training data. In this case, PerformHPO
must be false.
$sel:trainingParameters:CreatePredictor'
, createPredictor_trainingParameters
- The hyperparameters to override for model training. The hyperparameters
that you can override are listed in the individual algorithms. For the
list of supported algorithms, see aws-forecast-choosing-recipes.
$sel:algorithmArn:CreatePredictor'
, createPredictor_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm to use for model
training. Required if PerformAutoML
is not set to true
.
Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA
arn:aws:forecast:::algorithm/CNN-QR
arn:aws:forecast:::algorithm/Deep_AR_Plus
arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS
arn:aws:forecast:::algorithm/Prophet
$sel:hPOConfig:CreatePredictor'
, createPredictor_hPOConfig
- Provides hyperparameter override values for the algorithm. If you don't
provide this parameter, Amazon Forecast uses default values. The
individual algorithms specify which hyperparameters support
hyperparameter optimization (HPO). For more information, see
aws-forecast-choosing-recipes.
If you included the HPOConfig
object, you must set PerformHPO
to
true.
$sel:optimizationMetric:CreatePredictor'
, createPredictor_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:autoMLOverrideStrategy:CreatePredictor'
, createPredictor_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
Used to overide the default AutoML strategy, which is to optimize
predictor accuracy. To apply an AutoML strategy that minimizes training
time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
$sel:evaluationParameters:CreatePredictor'
, createPredictor_evaluationParameters
- Used to override the default evaluation parameters of the specified
algorithm. Amazon Forecast evaluates a predictor by splitting a dataset
into training data and testing data. The evaluation parameters define
how to perform the split and the number of iterations.
$sel:encryptionConfig:CreatePredictor'
, createPredictor_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:forecastTypes:CreatePredictor'
, createPredictor_forecastTypes
- Specifies the forecast types used to train a predictor. You can specify
up to five forecast types. Forecast types can be quantiles from 0.01 to
0.99, by increments of 0.01 or higher. You can also specify the mean
forecast with mean
.
The default value is ["0.10", "0.50", "0.9"]
.
$sel:performHPO:CreatePredictor'
, createPredictor_performHPO
- Whether to perform hyperparameter optimization (HPO). HPO finds optimal
hyperparameter values for your training data. The process of performing
HPO is known as running a hyperparameter tuning job.
The default value is false
. In this case, Amazon Forecast uses default
hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,
optionally, supply the HyperParameterTuningJobConfig object. The tuning
job specifies a metric to optimize, which hyperparameters participate in
tuning, and the valid range for each tunable hyperparameter. In this
case, you are required to specify an algorithm and PerformAutoML
must
be false.
The following algorithms support HPO:
- DeepAR+
- CNN-QR
$sel:tags:CreatePredictor'
, createPredictor_tags
- The optional metadata that you apply to the predictor 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 hasaws
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 ofaws
do not count against your tags per resource limit.
$sel:predictorName:CreatePredictor'
, createPredictor_predictorName
- A name for the predictor.
$sel:forecastHorizon:CreatePredictor'
, createPredictor_forecastHorizon
- Specifies the number of time-steps that the model is trained to predict.
The forecast horizon is also called the prediction length.
For example, if you configure a dataset for daily data collection (using
the DataFrequency
parameter of the CreateDataset operation) and set
the forecast horizon to 10, the model returns predictions for 10 days.
The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
$sel:inputDataConfig:CreatePredictor'
, createPredictor_inputDataConfig
- Describes the dataset group that contains the data to use to train the
predictor.
$sel:featurizationConfig:CreatePredictor'
, createPredictor_featurizationConfig
- The featurization configuration.
data CreatePredictorResponse Source #
See: newCreatePredictorResponse
smart constructor.
Instances
newCreatePredictorResponse Source #
Create a value of CreatePredictorResponse
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:predictorArn:CreatePredictorResponse'
, createPredictorResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
$sel:httpStatus:CreatePredictorResponse'
, createPredictorResponse_httpStatus
- The response's http status code.
ListPredictorBacktestExportJobs (Paginated)
data ListPredictorBacktestExportJobs Source #
See: newListPredictorBacktestExportJobs
smart constructor.
Instances
newListPredictorBacktestExportJobs :: ListPredictorBacktestExportJobs Source #
Create a value of ListPredictorBacktestExportJobs
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:filters:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobs_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the predictor backtest export jobs that
match the statement from the list. The match statement consists of a key
and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictor backtest export jobs that match the statement, specifyIS
. To exclude matching predictor backtest export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values arePredictorArn
andStatus
.Value
- The value to match.
$sel:nextToken:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobs_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:maxResults:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobs_maxResults
- The number of items to return in the response.
data ListPredictorBacktestExportJobsResponse Source #
See: newListPredictorBacktestExportJobsResponse
smart constructor.
ListPredictorBacktestExportJobsResponse' (Maybe Text) (Maybe [PredictorBacktestExportJobSummary]) Int |
Instances
newListPredictorBacktestExportJobsResponse Source #
Create a value of ListPredictorBacktestExportJobsResponse
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:nextToken:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobsResponse_nextToken
- Returns this token if the response is truncated. To retrieve the next
set of results, use the token in the next request.
$sel:predictorBacktestExportJobs:ListPredictorBacktestExportJobsResponse'
, listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs
- An array of objects that summarize the properties of each predictor
backtest export job.
$sel:httpStatus:ListPredictorBacktestExportJobsResponse'
, listPredictorBacktestExportJobsResponse_httpStatus
- The response's http status code.
DeletePredictorBacktestExportJob
data DeletePredictorBacktestExportJob Source #
See: newDeletePredictorBacktestExportJob
smart constructor.
Instances
newDeletePredictorBacktestExportJob Source #
:: Text |
|
-> DeletePredictorBacktestExportJob |
Create a value of DeletePredictorBacktestExportJob
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:predictorBacktestExportJobArn:DeletePredictorBacktestExportJob'
, deletePredictorBacktestExportJob_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job to
delete.
data DeletePredictorBacktestExportJobResponse Source #
See: newDeletePredictorBacktestExportJobResponse
smart constructor.
Instances
Eq DeletePredictorBacktestExportJobResponse Source # | |
Read DeletePredictorBacktestExportJobResponse Source # | |
Show DeletePredictorBacktestExportJobResponse Source # | |
Generic DeletePredictorBacktestExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictorBacktestExportJob type Rep DeletePredictorBacktestExportJobResponse :: Type -> Type # | |
NFData DeletePredictorBacktestExportJobResponse Source # | |
type Rep DeletePredictorBacktestExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictorBacktestExportJob type Rep DeletePredictorBacktestExportJobResponse = D1 ('MetaData "DeletePredictorBacktestExportJobResponse" "Amazonka.Forecast.DeletePredictorBacktestExportJob" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "DeletePredictorBacktestExportJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeletePredictorBacktestExportJobResponse :: DeletePredictorBacktestExportJobResponse Source #
Create a value of DeletePredictorBacktestExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateForecast
data CreateForecast Source #
See: newCreateForecast
smart constructor.
Instances
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 hasaws
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 ofaws
do 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.
data CreateForecastResponse Source #
See: newCreateForecastResponse
smart constructor.
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.
CreatePredictorBacktestExportJob
data CreatePredictorBacktestExportJob Source #
See: newCreatePredictorBacktestExportJob
smart constructor.
Instances
newCreatePredictorBacktestExportJob Source #
:: Text |
|
-> Text | |
-> DataDestination | |
-> CreatePredictorBacktestExportJob |
Create a value of CreatePredictorBacktestExportJob
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:tags:CreatePredictorBacktestExportJob'
, createPredictorBacktestExportJob_tags
- Optional metadata to help you categorize and organize your backtests.
Each tag consists of a key and an optional value, both of which you
define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
$sel:predictorBacktestExportJobName:CreatePredictorBacktestExportJob'
, createPredictorBacktestExportJob_predictorBacktestExportJobName
- The name for the backtest export job.
$sel:predictorArn:CreatePredictorBacktestExportJob'
, createPredictorBacktestExportJob_predictorArn
- The Amazon Resource Name (ARN) of the predictor that you want to export.
$sel:destination:CreatePredictorBacktestExportJob'
, createPredictorBacktestExportJob_destination
- Undocumented member.
data CreatePredictorBacktestExportJobResponse Source #
See: newCreatePredictorBacktestExportJobResponse
smart constructor.
Instances
newCreatePredictorBacktestExportJobResponse Source #
Create a value of CreatePredictorBacktestExportJobResponse
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:predictorBacktestExportJobArn:CreatePredictorBacktestExportJobResponse'
, createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job that
you want to export.
$sel:httpStatus:CreatePredictorBacktestExportJobResponse'
, createPredictorBacktestExportJobResponse_httpStatus
- The response's http status code.
DeleteForecast
data DeleteForecast Source #
See: newDeleteForecast
smart constructor.
Instances
Create a value of DeleteForecast
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:DeleteForecast'
, deleteForecast_forecastArn
- The Amazon Resource Name (ARN) of the forecast to delete.
data DeleteForecastResponse Source #
See: newDeleteForecastResponse
smart constructor.
Instances
Eq DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast | |
Read DeleteForecastResponse Source # | |
Show DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast showsPrec :: Int -> DeleteForecastResponse -> ShowS # show :: DeleteForecastResponse -> String # showList :: [DeleteForecastResponse] -> ShowS # | |
Generic DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast type Rep DeleteForecastResponse :: Type -> Type # | |
NFData DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast rnf :: DeleteForecastResponse -> () # | |
type Rep DeleteForecastResponse Source # | |
newDeleteForecastResponse :: DeleteForecastResponse Source #
Create a value of DeleteForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteResourceTree
data DeleteResourceTree Source #
See: newDeleteResourceTree
smart constructor.
Instances
newDeleteResourceTree Source #
Create a value of DeleteResourceTree
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:resourceArn:DeleteResourceTree'
, deleteResourceTree_resourceArn
- The Amazon Resource Name (ARN) of the parent resource to delete. All
child resources of the parent resource will also be deleted.
data DeleteResourceTreeResponse Source #
See: newDeleteResourceTreeResponse
smart constructor.
Instances
newDeleteResourceTreeResponse :: DeleteResourceTreeResponse Source #
Create a value of DeleteResourceTreeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDatasetGroup
data DescribeDatasetGroup Source #
See: newDescribeDatasetGroup
smart constructor.
Instances
newDescribeDatasetGroup Source #
Create a value of DescribeDatasetGroup
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:datasetGroupArn:DescribeDatasetGroup'
, describeDatasetGroup_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
data DescribeDatasetGroupResponse Source #
See: newDescribeDatasetGroupResponse
smart constructor.
DescribeDatasetGroupResponse' (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe Domain) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribeDatasetGroupResponse Source #
Create a value of DescribeDatasetGroupResponse
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:creationTime:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_creationTime
- When the dataset group was created.
$sel:datasetArns:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_datasetArns
- An array of Amazon Resource Names (ARNs) of the datasets contained in
the dataset group.
$sel:status:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_status
- The status of the dataset group. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply when you call the UpdateDatasetGroup
operation.
The Status
of the dataset group must be ACTIVE
before you can use
the dataset group to create a predictor.
$sel:domain:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_domain
- The domain associated with the dataset group.
$sel:datasetGroupName:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_datasetGroupName
- The name of the dataset group.
$sel:datasetGroupArn:DescribeDatasetGroup'
, describeDatasetGroupResponse_datasetGroupArn
- The ARN of the dataset group.
$sel:lastModificationTime:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_lastModificationTime
- When the dataset group was created or last updated from a call to the
UpdateDatasetGroup operation. While the dataset group is being updated,
LastModificationTime
is the current time of the DescribeDatasetGroup
call.
$sel:httpStatus:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_httpStatus
- The response's http status code.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the supported resources are Forecast dataset
groups, datasets, dataset import jobs, predictors, forecasts, and
forecast export jobs.
$sel:tags:TagResource'
, tagResource_tags
- The tags to add to the resource. A tag is an array of key-value pairs.
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 hasaws
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 ofaws
do not count against your tags per resource limit.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets
smart constructor.
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets
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:nextToken:ListDatasets'
, listDatasets_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:maxResults:ListDatasets'
, listDatasets_maxResults
- The number of items to return in the response.
data ListDatasetsResponse Source #
See: newListDatasetsResponse
smart constructor.
Instances
newListDatasetsResponse Source #
Create a value of ListDatasetsResponse
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:nextToken:ListDatasets'
, listDatasetsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:datasets:ListDatasetsResponse'
, listDatasetsResponse_datasets
- An array of objects that summarize each dataset's properties.
$sel:httpStatus:ListDatasetsResponse'
, listDatasetsResponse_httpStatus
- The response's http status code.
DescribePredictorBacktestExportJob
data DescribePredictorBacktestExportJob Source #
See: newDescribePredictorBacktestExportJob
smart constructor.
Instances
newDescribePredictorBacktestExportJob Source #
:: Text |
|
-> DescribePredictorBacktestExportJob |
Create a value of DescribePredictorBacktestExportJob
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:predictorBacktestExportJobArn:DescribePredictorBacktestExportJob'
, describePredictorBacktestExportJob_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
data DescribePredictorBacktestExportJobResponse Source #
See: newDescribePredictorBacktestExportJobResponse
smart constructor.
DescribePredictorBacktestExportJobResponse' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) Int |
Instances
newDescribePredictorBacktestExportJobResponse Source #
Create a value of DescribePredictorBacktestExportJobResponse
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:creationTime:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_creationTime
- When the predictor backtest export job was created.
$sel:status:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_status
- The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
$sel:destination:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_destination
- Undocumented member.
$sel:predictorArn:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
$sel:predictorBacktestExportJobArn:DescribePredictorBacktestExportJob'
, describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
$sel:message:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_message
- Information about any errors that may have occurred during the backtest
export.
$sel:predictorBacktestExportJobName:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_predictorBacktestExportJobName
- The name of the predictor backtest export job.
$sel:lastModificationTime:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:httpStatus:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags. Currently, the supported resources are Forecast dataset
groups, datasets, dataset import jobs, predictors, forecasts, and
forecast exports.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The keys of the tags to be removed.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
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:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
CreateDatasetGroup
data CreateDatasetGroup Source #
See: newCreateDatasetGroup
smart constructor.
Instances
newCreateDatasetGroup Source #
:: Text | |
-> Domain | |
-> CreateDatasetGroup |
Create a value of CreateDatasetGroup
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:datasetArns:CreateDatasetGroup'
, createDatasetGroup_datasetArns
- An array of Amazon Resource Names (ARNs) of the datasets that you want
to include in the dataset group.
$sel:tags:CreateDatasetGroup'
, createDatasetGroup_tags
- The optional metadata that you apply to the dataset group 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 hasaws
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 ofaws
do not count against your tags per resource limit.
$sel:datasetGroupName:CreateDatasetGroup'
, createDatasetGroup_datasetGroupName
- A name for the dataset group.
$sel:domain:CreateDatasetGroup'
, createDatasetGroup_domain
- The domain associated with the dataset group. When you add a dataset to
a dataset group, this value and the value specified for the Domain
parameter of the CreateDataset operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in training data that you import to a dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires that item_id
, timestamp
,
and demand
fields are present in your data. For more information, see
howitworks-datasets-groups.
data CreateDatasetGroupResponse Source #
See: newCreateDatasetGroupResponse
smart constructor.
Instances
newCreateDatasetGroupResponse Source #
Create a value of CreateDatasetGroupResponse
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:datasetGroupArn:CreateDatasetGroupResponse'
, createDatasetGroupResponse_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
$sel:httpStatus:CreateDatasetGroupResponse'
, createDatasetGroupResponse_httpStatus
- The response's http status code.
ListForecastExportJobs (Paginated)
data ListForecastExportJobs Source #
See: newListForecastExportJobs
smart constructor.
Instances
newListForecastExportJobs :: ListForecastExportJobs Source #
Create a value of ListForecastExportJobs
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:filters:ListForecastExportJobs'
, listForecastExportJobs_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecast export jobs that
match the statement from the list, respectively. The match statement
consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
$sel:nextToken:ListForecastExportJobs'
, listForecastExportJobs_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:maxResults:ListForecastExportJobs'
, listForecastExportJobs_maxResults
- The number of items to return in the response.
data ListForecastExportJobsResponse Source #
See: newListForecastExportJobsResponse
smart constructor.
Instances
newListForecastExportJobsResponse Source #
Create a value of ListForecastExportJobsResponse
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:nextToken:ListForecastExportJobs'
, listForecastExportJobsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:forecastExportJobs:ListForecastExportJobsResponse'
, listForecastExportJobsResponse_forecastExportJobs
- An array of objects that summarize each export job's properties.
$sel:httpStatus:ListForecastExportJobsResponse'
, listForecastExportJobsResponse_httpStatus
- The response's http status code.
ListPredictors (Paginated)
data ListPredictors Source #
See: newListPredictors
smart constructor.
Instances
newListPredictors :: ListPredictors Source #
Create a value of ListPredictors
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:filters:ListPredictors'
, listPredictors_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the predictors that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictors that match the statement, specifyIS
. To exclude matching predictors, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
andStatus
.Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
$sel:nextToken:ListPredictors'
, listPredictors_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:maxResults:ListPredictors'
, listPredictors_maxResults
- The number of items to return in the response.
data ListPredictorsResponse Source #
See: newListPredictorsResponse
smart constructor.
Instances
newListPredictorsResponse Source #
Create a value of ListPredictorsResponse
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:nextToken:ListPredictors'
, listPredictorsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:predictors:ListPredictorsResponse'
, listPredictorsResponse_predictors
- An array of objects that summarize each predictor's properties.
$sel:httpStatus:ListPredictorsResponse'
, listPredictorsResponse_httpStatus
- The response's http status code.
Types
AttributeType
newtype AttributeType Source #
pattern AttributeType_Float :: AttributeType | |
pattern AttributeType_Geolocation :: AttributeType | |
pattern AttributeType_Integer :: AttributeType | |
pattern AttributeType_String :: AttributeType | |
pattern AttributeType_Timestamp :: AttributeType |
Instances
AutoMLOverrideStrategy
newtype AutoMLOverrideStrategy Source #
Instances
DatasetType
newtype DatasetType Source #
pattern DatasetType_ITEM_METADATA :: DatasetType | |
pattern DatasetType_RELATED_TIME_SERIES :: DatasetType | |
pattern DatasetType_TARGET_TIME_SERIES :: DatasetType |
Instances
Domain
pattern Domain_CUSTOM :: Domain | |
pattern Domain_EC2_CAPACITY :: Domain | |
pattern Domain_INVENTORY_PLANNING :: Domain | |
pattern Domain_METRICS :: Domain | |
pattern Domain_RETAIL :: Domain | |
pattern Domain_WEB_TRAFFIC :: Domain | |
pattern Domain_WORK_FORCE :: Domain |
Instances
EvaluationType
newtype EvaluationType Source #
pattern EvaluationType_COMPUTED :: EvaluationType | |
pattern EvaluationType_SUMMARY :: EvaluationType |
Instances
FeaturizationMethodName
newtype FeaturizationMethodName Source #
Instances
FilterConditionString
newtype FilterConditionString Source #
pattern FilterConditionString_IS :: FilterConditionString | |
pattern FilterConditionString_IS_NOT :: FilterConditionString |
Instances
OptimizationMetric
newtype OptimizationMetric Source #
pattern OptimizationMetric_AverageWeightedQuantileLoss :: OptimizationMetric | |
pattern OptimizationMetric_MAPE :: OptimizationMetric | |
pattern OptimizationMetric_MASE :: OptimizationMetric | |
pattern OptimizationMetric_RMSE :: OptimizationMetric | |
pattern OptimizationMetric_WAPE :: OptimizationMetric |
Instances
ScalingType
newtype ScalingType Source #
pattern ScalingType_Auto :: ScalingType | |
pattern ScalingType_Linear :: ScalingType | |
pattern ScalingType_Logarithmic :: ScalingType | |
pattern ScalingType_ReverseLogarithmic :: ScalingType |
Instances
CategoricalParameterRange
data CategoricalParameterRange Source #
Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newCategoricalParameterRange
smart constructor.
Instances
newCategoricalParameterRange Source #
Create a value of CategoricalParameterRange
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:name:CategoricalParameterRange'
, categoricalParameterRange_name
- The name of the categorical hyperparameter to tune.
$sel:values:CategoricalParameterRange'
, categoricalParameterRange_values
- A list of the tunable categories for the hyperparameter.
ContinuousParameterRange
data ContinuousParameterRange Source #
Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newContinuousParameterRange
smart constructor.
Instances
newContinuousParameterRange Source #
:: Text | |
-> Double | |
-> Double | |
-> ContinuousParameterRange |
Create a value of ContinuousParameterRange
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:scalingType:ContinuousParameterRange'
, continuousParameterRange_scalingType
- The scale that hyperparameter tuning uses to search the hyperparameter
range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- hyperparameter tuning searches the values in the hyperparameter
range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
$sel:name:ContinuousParameterRange'
, continuousParameterRange_name
- The name of the hyperparameter to tune.
$sel:maxValue:ContinuousParameterRange'
, continuousParameterRange_maxValue
- The maximum tunable value of the hyperparameter.
$sel:minValue:ContinuousParameterRange'
, continuousParameterRange_minValue
- The minimum tunable value of the hyperparameter.
DataDestination
data DataDestination Source #
The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
See: newDataDestination
smart constructor.
Instances
Create a value of DataDestination
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:s3Config:DataDestination'
, dataDestination_s3Config
- The path to an Amazon Simple Storage Service (Amazon S3) bucket along
with the credentials to access the bucket.
DataSource
data DataSource Source #
The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob request.
See: newDataSource
smart constructor.
Instances
Create a value of DataSource
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:s3Config:DataSource'
, dataSource_s3Config
- The path to the training data stored in an Amazon Simple Storage Service
(Amazon S3) bucket along with the credentials to access the data.
DatasetGroupSummary
data DatasetGroupSummary Source #
Provides a summary of the dataset group properties used in the
ListDatasetGroups operation. To get the complete set of properties, call
the DescribeDatasetGroup operation, and provide the DatasetGroupArn
.
See: newDatasetGroupSummary
smart constructor.
Instances
newDatasetGroupSummary :: DatasetGroupSummary Source #
Create a value of DatasetGroupSummary
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:creationTime:DatasetGroupSummary'
, datasetGroupSummary_creationTime
- When the dataset group was created.
$sel:datasetGroupName:DatasetGroupSummary'
, datasetGroupSummary_datasetGroupName
- The name of the dataset group.
$sel:datasetGroupArn:DatasetGroupSummary'
, datasetGroupSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
$sel:lastModificationTime:DatasetGroupSummary'
, datasetGroupSummary_lastModificationTime
- When the dataset group was created or last updated from a call to the
UpdateDatasetGroup operation. While the dataset group is being updated,
LastModificationTime
is the current time of the ListDatasetGroups
call.
DatasetImportJobSummary
data DatasetImportJobSummary Source #
Provides a summary of the dataset import job properties used in the
ListDatasetImportJobs operation. To get the complete set of properties,
call the DescribeDatasetImportJob operation, and provide the
DatasetImportJobArn
.
See: newDatasetImportJobSummary
smart constructor.
DatasetImportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newDatasetImportJobSummary :: DatasetImportJobSummary Source #
Create a value of DatasetImportJobSummary
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:creationTime:DatasetImportJobSummary'
, datasetImportJobSummary_creationTime
- When the dataset import job was created.
$sel:status:DatasetImportJobSummary'
, datasetImportJobSummary_status
- The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
$sel:datasetImportJobName:DatasetImportJobSummary'
, datasetImportJobSummary_datasetImportJobName
- The name of the dataset import job.
$sel:dataSource:DatasetImportJobSummary'
, datasetImportJobSummary_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
$sel:datasetImportJobArn:DatasetImportJobSummary'
, datasetImportJobSummary_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
$sel:message:DatasetImportJobSummary'
, datasetImportJobSummary_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:DatasetImportJobSummary'
, datasetImportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DatasetSummary
data DatasetSummary Source #
Provides a summary of the dataset properties used in the ListDatasets
operation. To get the complete set of properties, call the
DescribeDataset operation, and provide the DatasetArn
.
See: newDatasetSummary
smart constructor.
DatasetSummary' (Maybe POSIX) (Maybe Text) (Maybe Domain) (Maybe DatasetType) (Maybe Text) (Maybe POSIX) |
Instances
newDatasetSummary :: DatasetSummary Source #
Create a value of DatasetSummary
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:creationTime:DatasetSummary'
, datasetSummary_creationTime
- When the dataset was created.
$sel:datasetArn:DatasetSummary'
, datasetSummary_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:domain:DatasetSummary'
, datasetSummary_domain
- The domain associated with the dataset.
$sel:datasetType:DatasetSummary'
, datasetSummary_datasetType
- The dataset type.
$sel:datasetName:DatasetSummary'
, datasetSummary_datasetName
- The name of the dataset.
$sel:lastModificationTime:DatasetSummary'
, datasetSummary_lastModificationTime
- When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the ListDatasets
call.
After a CreateDatasetImportJob operation has finished,
LastModificationTime
is when the import job completed or failed.
EncryptionConfig
data EncryptionConfig Source #
An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
See: newEncryptionConfig
smart constructor.
Instances
Create a value of EncryptionConfig
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:roleArn:EncryptionConfig'
, encryptionConfig_roleArn
- The ARN of the IAM role that Amazon Forecast can assume to access the
AWS KMS key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
$sel:kmsKeyArn:EncryptionConfig'
, encryptionConfig_kmsKeyArn
- The Amazon Resource Name (ARN) of the KMS key.
ErrorMetric
data ErrorMetric Source #
Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.
See: newErrorMetric
smart constructor.
Instances
newErrorMetric :: ErrorMetric Source #
Create a value of ErrorMetric
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:mase:ErrorMetric'
, errorMetric_mase
- The Mean Absolute Scaled Error (MASE)
$sel:wape:ErrorMetric'
, errorMetric_wape
- The weighted absolute percentage error (WAPE).
$sel:mape:ErrorMetric'
, errorMetric_mape
- The Mean Absolute Percentage Error (MAPE)
$sel:rmse:ErrorMetric'
, errorMetric_rmse
- The root-mean-square error (RMSE).
$sel:forecastType:ErrorMetric'
, errorMetric_forecastType
- The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
EvaluationParameters
data EvaluationParameters Source #
Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the CreatePredictor request.
See: newEvaluationParameters
smart constructor.
Instances
newEvaluationParameters :: EvaluationParameters Source #
Create a value of EvaluationParameters
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:backTestWindowOffset:EvaluationParameters'
, evaluationParameters_backTestWindowOffset
- The point from the end of the dataset where you want to split the data
for model training and testing (evaluation). Specify the value as the
number of data points. The default is the value of the forecast horizon.
BackTestWindowOffset
can be used to mimic a past virtual forecast
start date. This value must be greater than or equal to the forecast
horizon and less than half of the TARGET_TIME_SERIES dataset length.
ForecastHorizon
<= BackTestWindowOffset
< 1/2 *
TARGET_TIME_SERIES dataset length
$sel:numberOfBacktestWindows:EvaluationParameters'
, evaluationParameters_numberOfBacktestWindows
- The number of times to split the input data. The default is 1. Valid
values are 1 through 5.
EvaluationResult
data EvaluationResult Source #
The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.
See: newEvaluationResult
smart constructor.
Instances
newEvaluationResult :: EvaluationResult Source #
Create a value of EvaluationResult
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:algorithmArn:EvaluationResult'
, evaluationResult_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm that was evaluated.
$sel:testWindows:EvaluationResult'
, evaluationResult_testWindows
- The array of test windows used for evaluating the algorithm. The
NumberOfBacktestWindows
from the EvaluationParameters object
determines the number of windows in the array.
Featurization
data Featurization Source #
Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.
For example:
{
"AttributeName": "demand",
FeaturizationPipeline [ {
"FeaturizationMethodName": "filling",
"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}
} ]
}
See: newFeaturization
smart constructor.
Instances
Create a value of Featurization
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:featurizationPipeline:Featurization'
, featurization_featurizationPipeline
- An array of one FeaturizationMethod
object that specifies the feature
transformation method.
$sel:attributeName:Featurization'
, featurization_attributeName
- The name of the schema attribute that specifies the data field to be
featurized. Amazon Forecast supports the target field of the
TARGET_TIME_SERIES
and the RELATED_TIME_SERIES
datasets. For
example, for the RETAIL
domain, the target is demand
, and for the
CUSTOM
domain, the target is target_value
. For more information, see
howitworks-missing-values.
FeaturizationConfig
data FeaturizationConfig Source #
In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.
You define featurization using the FeaturizationConfig
object. You
specify an array of transformations, one for each field that you want to
featurize. You then include the FeaturizationConfig
object in your
CreatePredictor
request. Amazon Forecast applies the featurization to
the TARGET_TIME_SERIES
and RELATED_TIME_SERIES
datasets before model
training.
You can create multiple featurization configurations. For example, you
might call the CreatePredictor
operation twice by specifying different
featurization configurations.
See: newFeaturizationConfig
smart constructor.
Instances
newFeaturizationConfig Source #
Create a value of FeaturizationConfig
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:featurizations:FeaturizationConfig'
, featurizationConfig_featurizations
- An array of featurization (transformation) information for the fields of
a dataset.
$sel:forecastDimensions:FeaturizationConfig'
, featurizationConfig_forecastDimensions
- An array of dimension (field) names that specify how to group the
generated forecast.
For example, suppose that you are generating a forecast for item sales
across all of your stores, and your dataset contains a store_id
field.
If you want the sales forecast for each item by store, you would specify
store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset
don't need to be specified in the CreatePredictor
request. All
forecast dimensions specified in the RELATED_TIME_SERIES
dataset must
be specified in the CreatePredictor
request.
$sel:forecastFrequency:FeaturizationConfig'
, featurizationConfig_forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
FeaturizationMethod
data FeaturizationMethod Source #
Provides information about the method that featurizes (transforms) a
dataset field. The method is part of the FeaturizationPipeline
of the
Featurization object.
The following is an example of how you specify a FeaturizationMethod
object.
{
"FeaturizationMethodName": "filling",
"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}
}
See: newFeaturizationMethod
smart constructor.
Instances
newFeaturizationMethod Source #
Create a value of FeaturizationMethod
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:featurizationMethodParameters:FeaturizationMethod'
, featurizationMethod_featurizationMethodParameters
- The method parameters (key-value pairs), which are a map of override
parameters. Specify these parameters to override the default values.
Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Bold signifies the default value.
aggregation
: sum,avg
,first
,min
,max
frontfill
: nonemiddlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
middlefill
:zero
,value
,median
,mean
,min
,max
backfill
:zero
,value
,median
,mean
,min
,max
futurefill
:zero
,value
,median
,mean
,min
,max
To set a filling method to a specific value, set the fill parameter to
value
and define the value in a corresponding _value
parameter. For
example, to set backfilling to a value of 2, include the following:
"backfill": "value"
and "backfill_value":"2"
.
$sel:featurizationMethodName:FeaturizationMethod'
, featurizationMethod_featurizationMethodName
- The name of the method. The "filling" method is the only supported
method.
Filter
Describes a filter for choosing a subset of objects. Each filter
consists of a condition and a match statement. The condition is either
IS
or IS_NOT
, which specifies whether to include or exclude the
objects that match the statement, respectively. The match statement
consists of a key and a value.
See: newFilter
smart constructor.
Instances
Eq Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
Generic Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
Hashable Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
ToJSON Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Forecast.Types.Filter" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterConditionString)))) |
:: Text | |
-> Text | |
-> FilterConditionString | |
-> Filter |
Create a value of Filter
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:key:Filter'
, filter_key
- The name of the parameter to filter on.
$sel:value:Filter'
, filter_value
- The value to match.
$sel:condition:Filter'
, filter_condition
- The condition to apply. To include the objects that match the statement,
specify IS
. To exclude matching objects, specify IS_NOT
.
ForecastExportJobSummary
data ForecastExportJobSummary Source #
Provides a summary of the forecast export job properties used in the
ListForecastExportJobs operation. To get the complete set of properties,
call the DescribeForecastExportJob operation, and provide the listed
ForecastExportJobArn
.
See: newForecastExportJobSummary
smart constructor.
ForecastExportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newForecastExportJobSummary :: ForecastExportJobSummary Source #
Create a value of ForecastExportJobSummary
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:creationTime:ForecastExportJobSummary'
, forecastExportJobSummary_creationTime
- When the forecast export job was created.
$sel:status:ForecastExportJobSummary'
, forecastExportJobSummary_status
- The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
$sel:destination:ForecastExportJobSummary'
, forecastExportJobSummary_destination
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
$sel:forecastExportJobArn:ForecastExportJobSummary'
, forecastExportJobSummary_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job.
$sel:forecastExportJobName:ForecastExportJobSummary'
, forecastExportJobSummary_forecastExportJobName
- The name of the forecast export job.
$sel:message:ForecastExportJobSummary'
, forecastExportJobSummary_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:ForecastExportJobSummary'
, forecastExportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
ForecastSummary
data ForecastSummary Source #
Provides a summary of the forecast properties used in the ListForecasts
operation. To get the complete set of properties, call the
DescribeForecast operation, and provide the ForecastArn
that is listed
in the summary.
See: newForecastSummary
smart constructor.
ForecastSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newForecastSummary :: ForecastSummary Source #
Create a value of ForecastSummary
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:creationTime:ForecastSummary'
, forecastSummary_creationTime
- When the forecast creation task was created.
$sel:status:ForecastSummary'
, forecastSummary_status
- The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
$sel:predictorArn:ForecastSummary'
, forecastSummary_predictorArn
- The ARN of the predictor used to generate the forecast.
$sel:forecastArn:ForecastSummary'
, forecastSummary_forecastArn
- The ARN of the forecast.
$sel:forecastName:ForecastSummary'
, forecastSummary_forecastName
- The name of the forecast.
$sel:datasetGroupArn:ForecastSummary'
, forecastSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that provided the
data used to train the predictor.
$sel:message:ForecastSummary'
, forecastSummary_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:ForecastSummary'
, forecastSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
HyperParameterTuningJobConfig
data HyperParameterTuningJobConfig Source #
Configuration information for a hyperparameter tuning job. You specify this object in the CreatePredictor request.
A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.
In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.
See: newHyperParameterTuningJobConfig
smart constructor.
Instances
Eq HyperParameterTuningJobConfig Source # | |
Read HyperParameterTuningJobConfig Source # | |
Show HyperParameterTuningJobConfig Source # | |
Generic HyperParameterTuningJobConfig Source # | |
NFData HyperParameterTuningJobConfig Source # | |
Defined in Amazonka.Forecast.Types.HyperParameterTuningJobConfig rnf :: HyperParameterTuningJobConfig -> () # | |
Hashable HyperParameterTuningJobConfig Source # | |
ToJSON HyperParameterTuningJobConfig Source # | |
FromJSON HyperParameterTuningJobConfig Source # | |
type Rep HyperParameterTuningJobConfig Source # | |
Defined in Amazonka.Forecast.Types.HyperParameterTuningJobConfig type Rep HyperParameterTuningJobConfig = D1 ('MetaData "HyperParameterTuningJobConfig" "Amazonka.Forecast.Types.HyperParameterTuningJobConfig" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "HyperParameterTuningJobConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameterRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ParameterRanges)))) |
newHyperParameterTuningJobConfig :: HyperParameterTuningJobConfig Source #
Create a value of HyperParameterTuningJobConfig
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:parameterRanges:HyperParameterTuningJobConfig'
, hyperParameterTuningJobConfig_parameterRanges
- Specifies the ranges of valid values for the hyperparameters.
InputDataConfig
data InputDataConfig Source #
The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.
See: newInputDataConfig
smart constructor.
Instances
Create a value of InputDataConfig
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:supplementaryFeatures:InputDataConfig'
, inputDataConfig_supplementaryFeatures
- An array of supplementary features. The only supported feature is a
holiday calendar.
$sel:datasetGroupArn:InputDataConfig'
, inputDataConfig_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
IntegerParameterRange
data IntegerParameterRange Source #
Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newIntegerParameterRange
smart constructor.
Instances
newIntegerParameterRange Source #
:: Text | |
-> Int | |
-> Int | |
-> IntegerParameterRange |
Create a value of IntegerParameterRange
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:scalingType:IntegerParameterRange'
, integerParameterRange_scalingType
- The scale that hyperparameter tuning uses to search the hyperparameter
range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- Not supported for
IntegerParameterRange
.Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
$sel:name:IntegerParameterRange'
, integerParameterRange_name
- The name of the hyperparameter to tune.
$sel:maxValue:IntegerParameterRange'
, integerParameterRange_maxValue
- The maximum tunable value of the hyperparameter.
$sel:minValue:IntegerParameterRange'
, integerParameterRange_minValue
- The minimum tunable value of the hyperparameter.
Metrics
Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.
See: newMetrics
smart constructor.
Metrics' (Maybe [ErrorMetric]) (Maybe Double) (Maybe [WeightedQuantileLoss]) (Maybe Double) |
Instances
newMetrics :: Metrics Source #
Create a value of Metrics
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:errorMetrics:Metrics'
, metrics_errorMetrics
- Provides detailed error metrics for each forecast type. Metrics include
root-mean square-error (RMSE), mean absolute percentage error (MAPE),
mean absolute scaled error (MASE), and weighted average percentage error
(WAPE).
$sel:rmse:Metrics'
, metrics_rmse
- The root-mean-square error (RMSE).
$sel:weightedQuantileLosses:Metrics'
, metrics_weightedQuantileLosses
- An array of weighted quantile losses. Quantiles divide a probability
distribution into regions of equal probability. The distribution in this
case is the loss function.
$sel:averageWeightedQuantileLoss:Metrics'
, metrics_averageWeightedQuantileLoss
- The average value of all weighted quantile losses.
ParameterRanges
data ParameterRanges Source #
Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the HyperParameterTuningJobConfig object.
See: newParameterRanges
smart constructor.
ParameterRanges' (Maybe (NonEmpty CategoricalParameterRange)) (Maybe (NonEmpty IntegerParameterRange)) (Maybe (NonEmpty ContinuousParameterRange)) |
Instances
newParameterRanges :: ParameterRanges Source #
Create a value of ParameterRanges
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:categoricalParameterRanges:ParameterRanges'
, parameterRanges_categoricalParameterRanges
- Specifies the tunable range for each categorical hyperparameter.
$sel:integerParameterRanges:ParameterRanges'
, parameterRanges_integerParameterRanges
- Specifies the tunable range for each integer hyperparameter.
$sel:continuousParameterRanges:ParameterRanges'
, parameterRanges_continuousParameterRanges
- Specifies the tunable range for each continuous hyperparameter.
PredictorBacktestExportJobSummary
data PredictorBacktestExportJobSummary Source #
Provides a summary of the predictor backtest export job properties used
in the ListPredictorBacktestExportJobs operation. To get a complete set
of properties, call the DescribePredictorBacktestExportJob operation,
and provide the listed PredictorBacktestExportJobArn
.
See: newPredictorBacktestExportJobSummary
smart constructor.
PredictorBacktestExportJobSummary' (Maybe POSIX) (Maybe Text) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newPredictorBacktestExportJobSummary :: PredictorBacktestExportJobSummary Source #
Create a value of PredictorBacktestExportJobSummary
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:creationTime:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_creationTime
- When the predictor backtest export job was created.
$sel:status:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_status
- The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
$sel:destination:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_destination
- Undocumented member.
$sel:predictorBacktestExportJobArn:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
$sel:message:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_message
- Information about any errors that may have occurred during the backtest
export.
$sel:predictorBacktestExportJobName:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_predictorBacktestExportJobName
- The name of the predictor backtest export job.
$sel:lastModificationTime:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
PredictorExecution
data PredictorExecution Source #
The algorithm used to perform a backtest and the status of those tests.
See: newPredictorExecution
smart constructor.
Instances
newPredictorExecution :: PredictorExecution Source #
Create a value of PredictorExecution
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:algorithmArn:PredictorExecution'
, predictorExecution_algorithmArn
- The ARN of the algorithm used to test the predictor.
$sel:testWindows:PredictorExecution'
, predictorExecution_testWindows
- An array of test windows used to evaluate the algorithm. The
NumberOfBacktestWindows
from the object determines the number of
windows in the array.
PredictorExecutionDetails
data PredictorExecutionDetails Source #
Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.
See: newPredictorExecutionDetails
smart constructor.
Instances
newPredictorExecutionDetails :: PredictorExecutionDetails Source #
Create a value of PredictorExecutionDetails
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:predictorExecutions:PredictorExecutionDetails'
, predictorExecutionDetails_predictorExecutions
- An array of the backtests performed to evaluate the accuracy of the
predictor against a particular algorithm. The NumberOfBacktestWindows
from the object determines the number of windows in the array.
PredictorSummary
data PredictorSummary Source #
Provides a summary of the predictor properties that are used in the
ListPredictors operation. To get the complete set of properties, call
the DescribePredictor operation, and provide the listed PredictorArn
.
See: newPredictorSummary
smart constructor.
PredictorSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) |
Instances
newPredictorSummary :: PredictorSummary Source #
Create a value of PredictorSummary
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:creationTime:PredictorSummary'
, predictorSummary_creationTime
- When the model training task was created.
$sel:status:PredictorSummary'
, predictorSummary_status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
$sel:predictorArn:PredictorSummary'
, predictorSummary_predictorArn
- The ARN of the predictor.
$sel:predictorName:PredictorSummary'
, predictorSummary_predictorName
- The name of the predictor.
$sel:datasetGroupArn:PredictorSummary'
, predictorSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that contains the
data used to train the predictor.
$sel:message:PredictorSummary'
, predictorSummary_message
- If an error occurred, an informational message about the error.
$sel:lastModificationTime:PredictorSummary'
, predictorSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
S3Config
The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.
See: newS3Config
smart constructor.
Instances
Eq S3Config Source # | |
Read S3Config Source # | |
Show S3Config Source # | |
Generic S3Config Source # | |
NFData S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
Hashable S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
ToJSON S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
FromJSON S3Config Source # | |
type Rep S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.Forecast.Types.S3Config" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "S3Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
Create a value of S3Config
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:kmsKeyArn:S3Config'
, s3Config_kmsKeyArn
- The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS)
key.
$sel:path:S3Config'
, s3Config_path
- The path to an Amazon Simple Storage Service (Amazon S3) bucket or
file(s) in an Amazon S3 bucket.
$sel:roleArn:S3Config'
, s3Config_roleArn
- The ARN of the AWS Identity and Access Management (IAM) role that Amazon
Forecast can assume to access the Amazon S3 bucket or files. If you
provide a value for the KMSKeyArn
key, the role must allow access to
the key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
Schema
Defines the fields of a dataset. You specify this object in the CreateDataset request.
See: newSchema
smart constructor.
Instances
Eq Schema Source # | |
Read Schema Source # | |
Show Schema Source # | |
Generic Schema Source # | |
NFData Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
Hashable Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
ToJSON Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
FromJSON Schema Source # | |
type Rep Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema type Rep Schema = D1 ('MetaData "Schema" "Amazonka.Forecast.Types.Schema" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "Schema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SchemaAttribute))))) |
Create a value of Schema
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:attributes:Schema'
, schema_attributes
- An array of attributes specifying the name and type of each field in a
dataset.
SchemaAttribute
data SchemaAttribute Source #
An attribute of a schema, which defines a dataset field. A schema
attribute is required for every field in a dataset. The Schema object
contains an array of SchemaAttribute
objects.
See: newSchemaAttribute
smart constructor.
Instances
newSchemaAttribute :: SchemaAttribute Source #
Create a value of SchemaAttribute
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:attributeType:SchemaAttribute'
, schemaAttribute_attributeType
- The data type of the field.
$sel:attributeName:SchemaAttribute'
, schemaAttribute_attributeName
- The name of the dataset field.
Statistics
data Statistics Source #
Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob operation.
See: newStatistics
smart constructor.
Statistics' (Maybe Text) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Double) (Maybe Int) (Maybe Int) (Maybe Integer) (Maybe Double) (Maybe Text) (Maybe Integer) (Maybe Int) |
Instances
newStatistics :: Statistics Source #
Create a value of Statistics
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:max:Statistics'
, statistics_max
- For a numeric field, the maximum value in the field.
$sel:countNullLong:Statistics'
, statistics_countNullLong
- The number of null values in the field. CountNullLong
is used instead
of CountNull
if the value is greater than 2,147,483,647.
$sel:countNan:Statistics'
, statistics_countNan
- The number of NAN (not a number) values in the field. If the response
value is -1, refer to CountNanLong
.
$sel:countNanLong:Statistics'
, statistics_countNanLong
- The number of NAN (not a number) values in the field. CountNanLong
is
used instead of CountNan
if the value is greater than 2,147,483,647.
$sel:avg:Statistics'
, statistics_avg
- For a numeric field, the average value in the field.
$sel:countNull:Statistics'
, statistics_countNull
- The number of null values in the field. If the response value is -1,
refer to CountNullLong
.
$sel:count:Statistics'
, statistics_count
- The number of values in the field. If the response value is -1, refer to
CountLong
.
$sel:countLong:Statistics'
, statistics_countLong
- The number of values in the field. CountLong
is used instead of
Count
if the value is greater than 2,147,483,647.
$sel:stddev:Statistics'
, statistics_stddev
- For a numeric field, the standard deviation.
$sel:min:Statistics'
, statistics_min
- For a numeric field, the minimum value in the field.
$sel:countDistinctLong:Statistics'
, statistics_countDistinctLong
- The number of distinct values in the field. CountDistinctLong
is used
instead of CountDistinct
if the value is greater than 2,147,483,647.
$sel:countDistinct:Statistics'
, statistics_countDistinct
- The number of distinct values in the field. If the response value is -1,
refer to CountDistinctLong
.
SupplementaryFeature
data SupplementaryFeature Source #
Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.
Weather Index
The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.
Holidays
Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.
See: newSupplementaryFeature
smart constructor.
Instances
newSupplementaryFeature Source #
:: Text | |
-> Text | |
-> SupplementaryFeature |
Create a value of SupplementaryFeature
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:name:SupplementaryFeature'
, supplementaryFeature_name
- The name of the feature. Valid values: "holiday"
and "weather"
.
$sel:value:SupplementaryFeature'
, supplementaryFeature_value
- Weather Index
To enable the Weather Index, set the value to "true"
Holidays
To enable Holidays, specify a country with one of the following two-letter country codes:
- "AL" - ALBANIA
- "AR" - ARGENTINA
- "AT" - AUSTRIA
- "AU" - AUSTRALIA
- "BA" - BOSNIA HERZEGOVINA
- "BE" - BELGIUM
- "BG" - BULGARIA
- "BO" - BOLIVIA
- "BR" - BRAZIL
- "BY" - BELARUS
- "CA" - CANADA
- "CL" - CHILE
- "CO" - COLOMBIA
- "CR" - COSTA RICA
- "HR" - CROATIA
- "CZ" - CZECH REPUBLIC
- "DK" - DENMARK
- "EC" - ECUADOR
- "EE" - ESTONIA
- "ET" - ETHIOPIA
- "FI" - FINLAND
- "FR" - FRANCE
- "DE" - GERMANY
- "GR" - GREECE
- "HU" - HUNGARY
- "IS" - ICELAND
- "IN" - INDIA
- "IE" - IRELAND
- "IT" - ITALY
- "JP" - JAPAN
- "KZ" - KAZAKHSTAN
- "KR" - KOREA
- "LV" - LATVIA
- "LI" - LIECHTENSTEIN
- "LT" - LITHUANIA
- "LU" - LUXEMBOURG
- "MK" - MACEDONIA
- "MT" - MALTA
- "MX" - MEXICO
- "MD" - MOLDOVA
- "ME" - MONTENEGRO
- "NL" - NETHERLANDS
- "NZ" - NEW ZEALAND
- "NI" - NICARAGUA
- "NG" - NIGERIA
- "NO" - NORWAY
- "PA" - PANAMA
- "PY" - PARAGUAY
- "PE" - PERU
- "PL" - POLAND
- "PT" - PORTUGAL
- "RO" - ROMANIA
- "RU" - RUSSIA
- "RS" - SERBIA
- "SK" - SLOVAKIA
- "SI" - SLOVENIA
- "ZA" - SOUTH AFRICA
- "ES" - SPAIN
- "SE" - SWEDEN
- "CH" - SWITZERLAND
- "UA" - UKRAINE
- "AE" - UNITED ARAB EMIRATES
- "US" - UNITED STATES
- "UK" - UNITED KINGDOM
- "UY" - URUGUAY
- "VE" - VENEZUELA
Tag
The optional metadata that you apply to a resource 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 hasaws
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 ofaws
do not count against your tags per resource limit.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Forecast.Types.Tag" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) |
Create a value of Tag
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:key:Tag'
, tag_key
- One part of a key-value pair that makes up a tag. A key
is a general
label that acts like a category for more specific tag values.
$sel:value:Tag'
, tag_value
- The optional part of a key-value pair that makes up a tag. A value
acts as a descriptor within a tag category (key).
TestWindowSummary
data TestWindowSummary Source #
The status, start time, and end time of a backtest, as well as a failure reason if applicable.
See: newTestWindowSummary
smart constructor.
Instances
newTestWindowSummary :: TestWindowSummary Source #
Create a value of TestWindowSummary
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:status:TestWindowSummary'
, testWindowSummary_status
- The status of the test. Possible status values are:
ACTIVE
CREATE_IN_PROGRESS
CREATE_FAILED
$sel:testWindowEnd:TestWindowSummary'
, testWindowSummary_testWindowEnd
- The time at which the test ended.
$sel:testWindowStart:TestWindowSummary'
, testWindowSummary_testWindowStart
- The time at which the test began.
$sel:message:TestWindowSummary'
, testWindowSummary_message
- If the test failed, the reason why it failed.
WeightedQuantileLoss
data WeightedQuantileLoss Source #
The weighted loss value for a quantile. This object is part of the Metrics object.
See: newWeightedQuantileLoss
smart constructor.
Instances
newWeightedQuantileLoss :: WeightedQuantileLoss Source #
Create a value of WeightedQuantileLoss
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:quantile:WeightedQuantileLoss'
, weightedQuantileLoss_quantile
- The quantile. Quantiles divide a probability distribution into regions
of equal probability. For example, if the distribution was divided into
5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6,
and 0.8.
$sel:lossValue:WeightedQuantileLoss'
, weightedQuantileLoss_lossValue
- The difference between the predicted value and the actual value over the
quantile, weighted (normalized) by dividing by the sum over all
quantiles.
WindowSummary
data WindowSummary Source #
The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.
The TestWindowStart
and TestWindowEnd
parameters are determined by
the BackTestWindowOffset
parameter of the EvaluationParameters object.
See: newWindowSummary
smart constructor.
Instances
newWindowSummary :: WindowSummary Source #
Create a value of WindowSummary
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:metrics:WindowSummary'
, windowSummary_metrics
- Provides metrics used to evaluate the performance of a predictor.
$sel:testWindowEnd:WindowSummary'
, windowSummary_testWindowEnd
- The timestamp that defines the end of the window.
$sel:evaluationType:WindowSummary'
, windowSummary_evaluationType
- The type of evaluation.
SUMMARY
- The average metrics across all windows.COMPUTED
- The metrics for the specified window.
$sel:testWindowStart:WindowSummary'
, windowSummary_testWindowStart
- The timestamp that defines the start of the window.
$sel:itemCount:WindowSummary'
, windowSummary_itemCount
- The number of data points within the window.