| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Forecast.Types
Contents
- Service Configuration
- Errors
- AttributeType
- AutoMLOverrideStrategy
- Condition
- DatasetType
- DayOfWeek
- Domain
- EvaluationType
- FeaturizationMethodName
- FilterConditionString
- Month
- Operation
- OptimizationMetric
- ScalingType
- State
- TimePointGranularity
- TimeSeriesGranularity
- Action
- AdditionalDataset
- AttributeConfig
- Baseline
- BaselineMetric
- CategoricalParameterRange
- ContinuousParameterRange
- DataConfig
- DataDestination
- DataSource
- DatasetGroupSummary
- DatasetImportJobSummary
- DatasetSummary
- EncryptionConfig
- ErrorMetric
- EvaluationParameters
- EvaluationResult
- ExplainabilityConfig
- ExplainabilityExportSummary
- ExplainabilityInfo
- ExplainabilitySummary
- Featurization
- FeaturizationConfig
- FeaturizationMethod
- Filter
- ForecastExportJobSummary
- ForecastSummary
- HyperParameterTuningJobConfig
- InputDataConfig
- IntegerParameterRange
- MetricResult
- Metrics
- MonitorConfig
- MonitorDataSource
- MonitorInfo
- MonitorSummary
- ParameterRanges
- PredictorBacktestExportJobSummary
- PredictorBaseline
- PredictorEvent
- PredictorExecution
- PredictorExecutionDetails
- PredictorMonitorEvaluation
- PredictorSummary
- ReferencePredictorSummary
- S3Config
- Schema
- SchemaAttribute
- Statistics
- SupplementaryFeature
- Tag
- TestWindowSummary
- TimeAlignmentBoundary
- TimeSeriesCondition
- TimeSeriesIdentifiers
- TimeSeriesReplacementsDataSource
- TimeSeriesSelector
- TimeSeriesTransformation
- WeightedQuantileLoss
- WhatIfAnalysisSummary
- WhatIfForecastExportSummary
- WhatIfForecastSummary
- WindowSummary
Description
Synopsis
- defaultService :: Service
- _InvalidInputException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- 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 Condition where
- Condition' { }
- pattern Condition_EQUALS :: Condition
- pattern Condition_GREATER_THAN :: Condition
- pattern Condition_LESS_THAN :: Condition
- pattern Condition_NOT_EQUALS :: Condition
- newtype DatasetType where
- DatasetType' { }
- pattern DatasetType_ITEM_METADATA :: DatasetType
- pattern DatasetType_RELATED_TIME_SERIES :: DatasetType
- pattern DatasetType_TARGET_TIME_SERIES :: DatasetType
- newtype DayOfWeek where
- DayOfWeek' { }
- pattern DayOfWeek_FRIDAY :: DayOfWeek
- pattern DayOfWeek_MONDAY :: DayOfWeek
- pattern DayOfWeek_SATURDAY :: DayOfWeek
- pattern DayOfWeek_SUNDAY :: DayOfWeek
- pattern DayOfWeek_THURSDAY :: DayOfWeek
- pattern DayOfWeek_TUESDAY :: DayOfWeek
- pattern DayOfWeek_WEDNESDAY :: DayOfWeek
- 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 Month where
- Month' { }
- pattern Month_APRIL :: Month
- pattern Month_AUGUST :: Month
- pattern Month_DECEMBER :: Month
- pattern Month_FEBRUARY :: Month
- pattern Month_JANUARY :: Month
- pattern Month_JULY :: Month
- pattern Month_JUNE :: Month
- pattern Month_MARCH :: Month
- pattern Month_MAY :: Month
- pattern Month_NOVEMBER :: Month
- pattern Month_OCTOBER :: Month
- pattern Month_SEPTEMBER :: Month
- newtype Operation where
- Operation' { }
- pattern Operation_ADD :: Operation
- pattern Operation_DIVIDE :: Operation
- pattern Operation_MULTIPLY :: Operation
- pattern Operation_SUBTRACT :: Operation
- 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
- newtype State where
- State' { }
- pattern State_Active :: State
- pattern State_Deleted :: State
- newtype TimePointGranularity where
- newtype TimeSeriesGranularity where
- data Action = Action' {}
- newAction :: Text -> Operation -> Double -> Action
- action_attributeName :: Lens' Action Text
- action_operation :: Lens' Action Operation
- action_value :: Lens' Action Double
- data AdditionalDataset = AdditionalDataset' {}
- newAdditionalDataset :: Text -> AdditionalDataset
- additionalDataset_configuration :: Lens' AdditionalDataset (Maybe (HashMap Text (NonEmpty Text)))
- additionalDataset_name :: Lens' AdditionalDataset Text
- data AttributeConfig = AttributeConfig' {}
- newAttributeConfig :: Text -> AttributeConfig
- attributeConfig_attributeName :: Lens' AttributeConfig Text
- attributeConfig_transformations :: Lens' AttributeConfig (HashMap Text Text)
- data Baseline = Baseline' {}
- newBaseline :: Baseline
- baseline_predictorBaseline :: Lens' Baseline (Maybe PredictorBaseline)
- data BaselineMetric = BaselineMetric' {}
- newBaselineMetric :: BaselineMetric
- baselineMetric_name :: Lens' BaselineMetric (Maybe Text)
- baselineMetric_value :: Lens' BaselineMetric (Maybe Double)
- data CategoricalParameterRange = CategoricalParameterRange' {}
- newCategoricalParameterRange :: Text -> NonEmpty Text -> CategoricalParameterRange
- categoricalParameterRange_name :: Lens' CategoricalParameterRange Text
- categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text)
- data ContinuousParameterRange = ContinuousParameterRange' {
- scalingType :: Maybe ScalingType
- name :: Text
- maxValue :: Double
- minValue :: Double
- newContinuousParameterRange :: Text -> Double -> Double -> ContinuousParameterRange
- continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe ScalingType)
- continuousParameterRange_name :: Lens' ContinuousParameterRange Text
- continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Double
- continuousParameterRange_minValue :: Lens' ContinuousParameterRange Double
- data DataConfig = DataConfig' {}
- newDataConfig :: Text -> DataConfig
- dataConfig_additionalDatasets :: Lens' DataConfig (Maybe (NonEmpty AdditionalDataset))
- dataConfig_attributeConfigs :: Lens' DataConfig (Maybe (NonEmpty AttributeConfig))
- dataConfig_datasetGroupArn :: Lens' DataConfig Text
- data DataDestination = DataDestination' {}
- newDataDestination :: S3Config -> DataDestination
- dataDestination_s3Config :: Lens' DataDestination S3Config
- data DataSource = DataSource' {}
- newDataSource :: S3Config -> DataSource
- dataSource_s3Config :: Lens' DataSource S3Config
- data DatasetGroupSummary = DatasetGroupSummary' {}
- newDatasetGroupSummary :: DatasetGroupSummary
- datasetGroupSummary_creationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_datasetGroupName :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_lastModificationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- data DatasetImportJobSummary = DatasetImportJobSummary' {}
- newDatasetImportJobSummary :: DatasetImportJobSummary
- datasetImportJobSummary_creationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- datasetImportJobSummary_dataSource :: Lens' DatasetImportJobSummary (Maybe DataSource)
- datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_datasetImportJobName :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_lastModificationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- datasetImportJobSummary_message :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text)
- data DatasetSummary = DatasetSummary' {}
- newDatasetSummary :: DatasetSummary
- datasetSummary_creationTime :: Lens' DatasetSummary (Maybe UTCTime)
- datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_datasetName :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_datasetType :: Lens' DatasetSummary (Maybe DatasetType)
- datasetSummary_domain :: Lens' DatasetSummary (Maybe Domain)
- datasetSummary_lastModificationTime :: Lens' DatasetSummary (Maybe UTCTime)
- data EncryptionConfig = EncryptionConfig' {}
- newEncryptionConfig :: Text -> Text -> EncryptionConfig
- encryptionConfig_roleArn :: Lens' EncryptionConfig Text
- encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text
- data ErrorMetric = ErrorMetric' {}
- newErrorMetric :: ErrorMetric
- errorMetric_forecastType :: Lens' ErrorMetric (Maybe Text)
- errorMetric_mape :: Lens' ErrorMetric (Maybe Double)
- errorMetric_mase :: Lens' ErrorMetric (Maybe Double)
- errorMetric_rmse :: Lens' ErrorMetric (Maybe Double)
- errorMetric_wape :: Lens' ErrorMetric (Maybe Double)
- data EvaluationParameters = EvaluationParameters' {}
- newEvaluationParameters :: EvaluationParameters
- evaluationParameters_backTestWindowOffset :: Lens' EvaluationParameters (Maybe Int)
- evaluationParameters_numberOfBacktestWindows :: Lens' EvaluationParameters (Maybe Int)
- data EvaluationResult = EvaluationResult' {}
- newEvaluationResult :: EvaluationResult
- evaluationResult_algorithmArn :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_testWindows :: Lens' EvaluationResult (Maybe [WindowSummary])
- data ExplainabilityConfig = ExplainabilityConfig' {}
- newExplainabilityConfig :: TimeSeriesGranularity -> TimePointGranularity -> ExplainabilityConfig
- explainabilityConfig_timeSeriesGranularity :: Lens' ExplainabilityConfig TimeSeriesGranularity
- explainabilityConfig_timePointGranularity :: Lens' ExplainabilityConfig TimePointGranularity
- data ExplainabilityExportSummary = ExplainabilityExportSummary' {}
- newExplainabilityExportSummary :: ExplainabilityExportSummary
- explainabilityExportSummary_creationTime :: Lens' ExplainabilityExportSummary (Maybe UTCTime)
- explainabilityExportSummary_destination :: Lens' ExplainabilityExportSummary (Maybe DataDestination)
- explainabilityExportSummary_explainabilityExportArn :: Lens' ExplainabilityExportSummary (Maybe Text)
- explainabilityExportSummary_explainabilityExportName :: Lens' ExplainabilityExportSummary (Maybe Text)
- explainabilityExportSummary_lastModificationTime :: Lens' ExplainabilityExportSummary (Maybe UTCTime)
- explainabilityExportSummary_message :: Lens' ExplainabilityExportSummary (Maybe Text)
- explainabilityExportSummary_status :: Lens' ExplainabilityExportSummary (Maybe Text)
- data ExplainabilityInfo = ExplainabilityInfo' {}
- newExplainabilityInfo :: ExplainabilityInfo
- explainabilityInfo_explainabilityArn :: Lens' ExplainabilityInfo (Maybe Text)
- explainabilityInfo_status :: Lens' ExplainabilityInfo (Maybe Text)
- data ExplainabilitySummary = ExplainabilitySummary' {}
- newExplainabilitySummary :: ExplainabilitySummary
- explainabilitySummary_creationTime :: Lens' ExplainabilitySummary (Maybe UTCTime)
- explainabilitySummary_explainabilityArn :: Lens' ExplainabilitySummary (Maybe Text)
- explainabilitySummary_explainabilityConfig :: Lens' ExplainabilitySummary (Maybe ExplainabilityConfig)
- explainabilitySummary_explainabilityName :: Lens' ExplainabilitySummary (Maybe Text)
- explainabilitySummary_lastModificationTime :: Lens' ExplainabilitySummary (Maybe UTCTime)
- explainabilitySummary_message :: Lens' ExplainabilitySummary (Maybe Text)
- explainabilitySummary_resourceArn :: Lens' ExplainabilitySummary (Maybe Text)
- explainabilitySummary_status :: Lens' ExplainabilitySummary (Maybe Text)
- data Featurization = Featurization' {}
- newFeaturization :: Text -> Featurization
- featurization_featurizationPipeline :: Lens' Featurization (Maybe (NonEmpty FeaturizationMethod))
- featurization_attributeName :: Lens' Featurization Text
- data FeaturizationConfig = FeaturizationConfig' {}
- newFeaturizationConfig :: Text -> FeaturizationConfig
- featurizationConfig_featurizations :: Lens' FeaturizationConfig (Maybe (NonEmpty Featurization))
- featurizationConfig_forecastDimensions :: Lens' FeaturizationConfig (Maybe (NonEmpty Text))
- featurizationConfig_forecastFrequency :: Lens' FeaturizationConfig Text
- data FeaturizationMethod = FeaturizationMethod' {}
- newFeaturizationMethod :: FeaturizationMethodName -> FeaturizationMethod
- featurizationMethod_featurizationMethodParameters :: Lens' FeaturizationMethod (Maybe (HashMap Text Text))
- featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName
- data Filter = Filter' {}
- newFilter :: Text -> Text -> FilterConditionString -> Filter
- filter_key :: Lens' Filter Text
- filter_value :: Lens' Filter Text
- filter_condition :: Lens' Filter FilterConditionString
- data ForecastExportJobSummary = ForecastExportJobSummary' {}
- newForecastExportJobSummary :: ForecastExportJobSummary
- forecastExportJobSummary_creationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)
- forecastExportJobSummary_destination :: Lens' ForecastExportJobSummary (Maybe DataDestination)
- forecastExportJobSummary_forecastExportJobArn :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_forecastExportJobName :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_lastModificationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)
- forecastExportJobSummary_message :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_status :: Lens' ForecastExportJobSummary (Maybe Text)
- data ForecastSummary = ForecastSummary' {}
- newForecastSummary :: ForecastSummary
- forecastSummary_createdUsingAutoPredictor :: Lens' ForecastSummary (Maybe Bool)
- forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime)
- forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime)
- forecastSummary_message :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_status :: Lens' ForecastSummary (Maybe Text)
- data HyperParameterTuningJobConfig = HyperParameterTuningJobConfig' {}
- newHyperParameterTuningJobConfig :: HyperParameterTuningJobConfig
- hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges)
- data InputDataConfig = InputDataConfig' {}
- newInputDataConfig :: Text -> InputDataConfig
- inputDataConfig_supplementaryFeatures :: Lens' InputDataConfig (Maybe (NonEmpty SupplementaryFeature))
- inputDataConfig_datasetGroupArn :: Lens' InputDataConfig Text
- data IntegerParameterRange = IntegerParameterRange' {
- scalingType :: Maybe ScalingType
- name :: Text
- maxValue :: Int
- minValue :: Int
- newIntegerParameterRange :: Text -> Int -> Int -> IntegerParameterRange
- integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType)
- integerParameterRange_name :: Lens' IntegerParameterRange Text
- integerParameterRange_maxValue :: Lens' IntegerParameterRange Int
- integerParameterRange_minValue :: Lens' IntegerParameterRange Int
- data MetricResult = MetricResult' {}
- newMetricResult :: MetricResult
- metricResult_metricName :: Lens' MetricResult (Maybe Text)
- metricResult_metricValue :: Lens' MetricResult (Maybe Double)
- data Metrics = Metrics' {}
- newMetrics :: Metrics
- metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double)
- metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric])
- metrics_rmse :: Lens' Metrics (Maybe Double)
- metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss])
- data MonitorConfig = MonitorConfig' {
- monitorName :: Text
- newMonitorConfig :: Text -> MonitorConfig
- monitorConfig_monitorName :: Lens' MonitorConfig Text
- data MonitorDataSource = MonitorDataSource' {}
- newMonitorDataSource :: MonitorDataSource
- monitorDataSource_datasetImportJobArn :: Lens' MonitorDataSource (Maybe Text)
- monitorDataSource_forecastArn :: Lens' MonitorDataSource (Maybe Text)
- monitorDataSource_predictorArn :: Lens' MonitorDataSource (Maybe Text)
- data MonitorInfo = MonitorInfo' {}
- newMonitorInfo :: MonitorInfo
- monitorInfo_monitorArn :: Lens' MonitorInfo (Maybe Text)
- monitorInfo_status :: Lens' MonitorInfo (Maybe Text)
- data MonitorSummary = MonitorSummary' {}
- newMonitorSummary :: MonitorSummary
- monitorSummary_creationTime :: Lens' MonitorSummary (Maybe UTCTime)
- monitorSummary_lastModificationTime :: Lens' MonitorSummary (Maybe UTCTime)
- monitorSummary_monitorArn :: Lens' MonitorSummary (Maybe Text)
- monitorSummary_monitorName :: Lens' MonitorSummary (Maybe Text)
- monitorSummary_resourceArn :: Lens' MonitorSummary (Maybe Text)
- monitorSummary_status :: Lens' MonitorSummary (Maybe Text)
- data ParameterRanges = ParameterRanges' {}
- newParameterRanges :: ParameterRanges
- parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty CategoricalParameterRange))
- parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty ContinuousParameterRange))
- parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty IntegerParameterRange))
- data PredictorBacktestExportJobSummary = PredictorBacktestExportJobSummary' {}
- newPredictorBacktestExportJobSummary :: PredictorBacktestExportJobSummary
- predictorBacktestExportJobSummary_creationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime)
- predictorBacktestExportJobSummary_destination :: Lens' PredictorBacktestExportJobSummary (Maybe DataDestination)
- predictorBacktestExportJobSummary_lastModificationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime)
- predictorBacktestExportJobSummary_message :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_predictorBacktestExportJobArn :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_predictorBacktestExportJobName :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_status :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- data PredictorBaseline = PredictorBaseline' {}
- newPredictorBaseline :: PredictorBaseline
- predictorBaseline_baselineMetrics :: Lens' PredictorBaseline (Maybe [BaselineMetric])
- data PredictorEvent = PredictorEvent' {}
- newPredictorEvent :: PredictorEvent
- predictorEvent_datetime :: Lens' PredictorEvent (Maybe UTCTime)
- predictorEvent_detail :: Lens' PredictorEvent (Maybe Text)
- data PredictorExecution = PredictorExecution' {}
- newPredictorExecution :: PredictorExecution
- predictorExecution_algorithmArn :: Lens' PredictorExecution (Maybe Text)
- predictorExecution_testWindows :: Lens' PredictorExecution (Maybe [TestWindowSummary])
- data PredictorExecutionDetails = PredictorExecutionDetails' {}
- newPredictorExecutionDetails :: PredictorExecutionDetails
- predictorExecutionDetails_predictorExecutions :: Lens' PredictorExecutionDetails (Maybe (NonEmpty PredictorExecution))
- data PredictorMonitorEvaluation = PredictorMonitorEvaluation' {
- evaluationState :: Maybe Text
- evaluationTime :: Maybe POSIX
- message :: Maybe Text
- metricResults :: Maybe [MetricResult]
- monitorArn :: Maybe Text
- monitorDataSource :: Maybe MonitorDataSource
- numItemsEvaluated :: Maybe Integer
- predictorEvent :: Maybe PredictorEvent
- resourceArn :: Maybe Text
- windowEndDatetime :: Maybe POSIX
- windowStartDatetime :: Maybe POSIX
- newPredictorMonitorEvaluation :: PredictorMonitorEvaluation
- predictorMonitorEvaluation_evaluationState :: Lens' PredictorMonitorEvaluation (Maybe Text)
- predictorMonitorEvaluation_evaluationTime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime)
- predictorMonitorEvaluation_message :: Lens' PredictorMonitorEvaluation (Maybe Text)
- predictorMonitorEvaluation_metricResults :: Lens' PredictorMonitorEvaluation (Maybe [MetricResult])
- predictorMonitorEvaluation_monitorArn :: Lens' PredictorMonitorEvaluation (Maybe Text)
- predictorMonitorEvaluation_monitorDataSource :: Lens' PredictorMonitorEvaluation (Maybe MonitorDataSource)
- predictorMonitorEvaluation_numItemsEvaluated :: Lens' PredictorMonitorEvaluation (Maybe Integer)
- predictorMonitorEvaluation_predictorEvent :: Lens' PredictorMonitorEvaluation (Maybe PredictorEvent)
- predictorMonitorEvaluation_resourceArn :: Lens' PredictorMonitorEvaluation (Maybe Text)
- predictorMonitorEvaluation_windowEndDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime)
- predictorMonitorEvaluation_windowStartDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime)
- data PredictorSummary = PredictorSummary' {}
- newPredictorSummary :: PredictorSummary
- predictorSummary_creationTime :: Lens' PredictorSummary (Maybe UTCTime)
- predictorSummary_datasetGroupArn :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_isAutoPredictor :: Lens' PredictorSummary (Maybe Bool)
- predictorSummary_lastModificationTime :: Lens' PredictorSummary (Maybe UTCTime)
- predictorSummary_message :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_predictorArn :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_predictorName :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_referencePredictorSummary :: Lens' PredictorSummary (Maybe ReferencePredictorSummary)
- predictorSummary_status :: Lens' PredictorSummary (Maybe Text)
- data ReferencePredictorSummary = ReferencePredictorSummary' {}
- newReferencePredictorSummary :: ReferencePredictorSummary
- referencePredictorSummary_arn :: Lens' ReferencePredictorSummary (Maybe Text)
- referencePredictorSummary_state :: Lens' ReferencePredictorSummary (Maybe State)
- data S3Config = S3Config' {}
- newS3Config :: Text -> Text -> S3Config
- s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text)
- s3Config_path :: Lens' S3Config Text
- s3Config_roleArn :: Lens' S3Config Text
- data Schema = Schema' {}
- newSchema :: Schema
- schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute))
- data SchemaAttribute = SchemaAttribute' {}
- newSchemaAttribute :: SchemaAttribute
- schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text)
- schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType)
- data Statistics = Statistics' {}
- newStatistics :: Statistics
- statistics_avg :: Lens' Statistics (Maybe Double)
- statistics_count :: Lens' Statistics (Maybe Int)
- statistics_countDistinct :: Lens' Statistics (Maybe Int)
- statistics_countDistinctLong :: Lens' Statistics (Maybe Integer)
- statistics_countLong :: Lens' Statistics (Maybe Integer)
- statistics_countNan :: Lens' Statistics (Maybe Int)
- statistics_countNanLong :: Lens' Statistics (Maybe Integer)
- statistics_countNull :: Lens' Statistics (Maybe Int)
- statistics_countNullLong :: Lens' Statistics (Maybe Integer)
- statistics_max :: Lens' Statistics (Maybe Text)
- statistics_min :: Lens' Statistics (Maybe Text)
- statistics_stddev :: Lens' Statistics (Maybe Double)
- data SupplementaryFeature = SupplementaryFeature' {}
- newSupplementaryFeature :: Text -> Text -> SupplementaryFeature
- supplementaryFeature_name :: Lens' SupplementaryFeature Text
- supplementaryFeature_value :: Lens' SupplementaryFeature Text
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- data TestWindowSummary = TestWindowSummary' {}
- newTestWindowSummary :: TestWindowSummary
- testWindowSummary_message :: Lens' TestWindowSummary (Maybe Text)
- testWindowSummary_status :: Lens' TestWindowSummary (Maybe Text)
- testWindowSummary_testWindowEnd :: Lens' TestWindowSummary (Maybe UTCTime)
- testWindowSummary_testWindowStart :: Lens' TestWindowSummary (Maybe UTCTime)
- data TimeAlignmentBoundary = TimeAlignmentBoundary' {}
- newTimeAlignmentBoundary :: TimeAlignmentBoundary
- timeAlignmentBoundary_dayOfMonth :: Lens' TimeAlignmentBoundary (Maybe Natural)
- timeAlignmentBoundary_dayOfWeek :: Lens' TimeAlignmentBoundary (Maybe DayOfWeek)
- timeAlignmentBoundary_hour :: Lens' TimeAlignmentBoundary (Maybe Natural)
- timeAlignmentBoundary_month :: Lens' TimeAlignmentBoundary (Maybe Month)
- data TimeSeriesCondition = TimeSeriesCondition' {}
- newTimeSeriesCondition :: Text -> Text -> Condition -> TimeSeriesCondition
- timeSeriesCondition_attributeName :: Lens' TimeSeriesCondition Text
- timeSeriesCondition_attributeValue :: Lens' TimeSeriesCondition Text
- timeSeriesCondition_condition :: Lens' TimeSeriesCondition Condition
- data TimeSeriesIdentifiers = TimeSeriesIdentifiers' {
- dataSource :: Maybe DataSource
- format :: Maybe Text
- schema :: Maybe Schema
- newTimeSeriesIdentifiers :: TimeSeriesIdentifiers
- timeSeriesIdentifiers_dataSource :: Lens' TimeSeriesIdentifiers (Maybe DataSource)
- timeSeriesIdentifiers_format :: Lens' TimeSeriesIdentifiers (Maybe Text)
- timeSeriesIdentifiers_schema :: Lens' TimeSeriesIdentifiers (Maybe Schema)
- data TimeSeriesReplacementsDataSource = TimeSeriesReplacementsDataSource' {}
- newTimeSeriesReplacementsDataSource :: S3Config -> Schema -> TimeSeriesReplacementsDataSource
- timeSeriesReplacementsDataSource_format :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
- timeSeriesReplacementsDataSource_timestampFormat :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
- timeSeriesReplacementsDataSource_s3Config :: Lens' TimeSeriesReplacementsDataSource S3Config
- timeSeriesReplacementsDataSource_schema :: Lens' TimeSeriesReplacementsDataSource Schema
- data TimeSeriesSelector = TimeSeriesSelector' {}
- newTimeSeriesSelector :: TimeSeriesSelector
- timeSeriesSelector_timeSeriesIdentifiers :: Lens' TimeSeriesSelector (Maybe TimeSeriesIdentifiers)
- data TimeSeriesTransformation = TimeSeriesTransformation' {}
- newTimeSeriesTransformation :: TimeSeriesTransformation
- timeSeriesTransformation_action :: Lens' TimeSeriesTransformation (Maybe Action)
- timeSeriesTransformation_timeSeriesConditions :: Lens' TimeSeriesTransformation (Maybe [TimeSeriesCondition])
- data WeightedQuantileLoss = WeightedQuantileLoss' {}
- newWeightedQuantileLoss :: WeightedQuantileLoss
- weightedQuantileLoss_lossValue :: Lens' WeightedQuantileLoss (Maybe Double)
- weightedQuantileLoss_quantile :: Lens' WeightedQuantileLoss (Maybe Double)
- data WhatIfAnalysisSummary = WhatIfAnalysisSummary' {}
- newWhatIfAnalysisSummary :: WhatIfAnalysisSummary
- whatIfAnalysisSummary_creationTime :: Lens' WhatIfAnalysisSummary (Maybe UTCTime)
- whatIfAnalysisSummary_forecastArn :: Lens' WhatIfAnalysisSummary (Maybe Text)
- whatIfAnalysisSummary_lastModificationTime :: Lens' WhatIfAnalysisSummary (Maybe UTCTime)
- whatIfAnalysisSummary_message :: Lens' WhatIfAnalysisSummary (Maybe Text)
- whatIfAnalysisSummary_status :: Lens' WhatIfAnalysisSummary (Maybe Text)
- whatIfAnalysisSummary_whatIfAnalysisArn :: Lens' WhatIfAnalysisSummary (Maybe Text)
- whatIfAnalysisSummary_whatIfAnalysisName :: Lens' WhatIfAnalysisSummary (Maybe Text)
- data WhatIfForecastExportSummary = WhatIfForecastExportSummary' {}
- newWhatIfForecastExportSummary :: WhatIfForecastExportSummary
- whatIfForecastExportSummary_creationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime)
- whatIfForecastExportSummary_destination :: Lens' WhatIfForecastExportSummary (Maybe DataDestination)
- whatIfForecastExportSummary_lastModificationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime)
- whatIfForecastExportSummary_message :: Lens' WhatIfForecastExportSummary (Maybe Text)
- whatIfForecastExportSummary_status :: Lens' WhatIfForecastExportSummary (Maybe Text)
- whatIfForecastExportSummary_whatIfForecastArns :: Lens' WhatIfForecastExportSummary (Maybe (NonEmpty Text))
- whatIfForecastExportSummary_whatIfForecastExportArn :: Lens' WhatIfForecastExportSummary (Maybe Text)
- whatIfForecastExportSummary_whatIfForecastExportName :: Lens' WhatIfForecastExportSummary (Maybe Text)
- data WhatIfForecastSummary = WhatIfForecastSummary' {}
- newWhatIfForecastSummary :: WhatIfForecastSummary
- whatIfForecastSummary_creationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime)
- whatIfForecastSummary_lastModificationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime)
- whatIfForecastSummary_message :: Lens' WhatIfForecastSummary (Maybe Text)
- whatIfForecastSummary_status :: Lens' WhatIfForecastSummary (Maybe Text)
- whatIfForecastSummary_whatIfAnalysisArn :: Lens' WhatIfForecastSummary (Maybe Text)
- whatIfForecastSummary_whatIfForecastArn :: Lens' WhatIfForecastSummary (Maybe Text)
- whatIfForecastSummary_whatIfForecastName :: Lens' WhatIfForecastSummary (Maybe Text)
- data WindowSummary = WindowSummary' {}
- newWindowSummary :: WindowSummary
- windowSummary_evaluationType :: Lens' WindowSummary (Maybe EvaluationType)
- windowSummary_itemCount :: Lens' WindowSummary (Maybe Int)
- windowSummary_metrics :: Lens' WindowSummary (Maybe Metrics)
- windowSummary_testWindowEnd :: Lens' WindowSummary (Maybe UTCTime)
- windowSummary_testWindowStart :: Lens' WindowSummary (Maybe UTCTime)
Service Configuration
defaultService :: Service Source #
API version 2018-06-26 of the Amazon Forecast Service SDK configuration.
Errors
_InvalidInputException :: AsError a => Fold a ServiceError Source #
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The token is not valid. Tokens expire after 24 hours.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The limit on the number of resources per account has been exceeded.
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
There is already a resource with this name. Try again with a different name.
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in use.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
AttributeType
newtype AttributeType Source #
Constructors
| AttributeType' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| AutoMLOverrideStrategy' | |
Fields | |
Bundled Patterns
| pattern AutoMLOverrideStrategy_AccuracyOptimized :: AutoMLOverrideStrategy | |
| pattern AutoMLOverrideStrategy_LatencyOptimized :: AutoMLOverrideStrategy |
Instances
Condition
Constructors
| Condition' | |
Fields | |
Bundled Patterns
| pattern Condition_EQUALS :: Condition | |
| pattern Condition_GREATER_THAN :: Condition | |
| pattern Condition_LESS_THAN :: Condition | |
| pattern Condition_NOT_EQUALS :: Condition |
Instances
DatasetType
newtype DatasetType Source #
Constructors
| DatasetType' | |
Fields | |
Bundled Patterns
| pattern DatasetType_ITEM_METADATA :: DatasetType | |
| pattern DatasetType_RELATED_TIME_SERIES :: DatasetType | |
| pattern DatasetType_TARGET_TIME_SERIES :: DatasetType |
Instances
DayOfWeek
Constructors
| DayOfWeek' | |
Fields | |
Bundled Patterns
| pattern DayOfWeek_FRIDAY :: DayOfWeek | |
| pattern DayOfWeek_MONDAY :: DayOfWeek | |
| pattern DayOfWeek_SATURDAY :: DayOfWeek | |
| pattern DayOfWeek_SUNDAY :: DayOfWeek | |
| pattern DayOfWeek_THURSDAY :: DayOfWeek | |
| pattern DayOfWeek_TUESDAY :: DayOfWeek | |
| pattern DayOfWeek_WEDNESDAY :: DayOfWeek |
Instances
Domain
Constructors
| Domain' | |
Fields
| |
Bundled Patterns
| 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 #
Constructors
| EvaluationType' | |
Fields | |
Bundled Patterns
| pattern EvaluationType_COMPUTED :: EvaluationType | |
| pattern EvaluationType_SUMMARY :: EvaluationType |
Instances
FeaturizationMethodName
newtype FeaturizationMethodName Source #
Constructors
| FeaturizationMethodName' | |
Fields | |
Bundled Patterns
| pattern FeaturizationMethodName_Filling :: FeaturizationMethodName |
Instances
FilterConditionString
newtype FilterConditionString Source #
Constructors
| FilterConditionString' | |
Fields | |
Bundled Patterns
| pattern FilterConditionString_IS :: FilterConditionString | |
| pattern FilterConditionString_IS_NOT :: FilterConditionString |
Instances
Month
Bundled Patterns
| pattern Month_APRIL :: Month | |
| pattern Month_AUGUST :: Month | |
| pattern Month_DECEMBER :: Month | |
| pattern Month_FEBRUARY :: Month | |
| pattern Month_JANUARY :: Month | |
| pattern Month_JULY :: Month | |
| pattern Month_JUNE :: Month | |
| pattern Month_MARCH :: Month | |
| pattern Month_MAY :: Month | |
| pattern Month_NOVEMBER :: Month | |
| pattern Month_OCTOBER :: Month | |
| pattern Month_SEPTEMBER :: Month |
Instances
Operation
Constructors
| Operation' | |
Fields | |
Bundled Patterns
| pattern Operation_ADD :: Operation | |
| pattern Operation_DIVIDE :: Operation | |
| pattern Operation_MULTIPLY :: Operation | |
| pattern Operation_SUBTRACT :: Operation |
Instances
OptimizationMetric
newtype OptimizationMetric Source #
Constructors
| OptimizationMetric' | |
Fields | |
Bundled Patterns
| 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 #
Constructors
| ScalingType' | |
Fields | |
Bundled Patterns
| pattern ScalingType_Auto :: ScalingType | |
| pattern ScalingType_Linear :: ScalingType | |
| pattern ScalingType_Logarithmic :: ScalingType | |
| pattern ScalingType_ReverseLogarithmic :: ScalingType |
Instances
State
Bundled Patterns
| pattern State_Active :: State | |
| pattern State_Deleted :: State |
Instances
TimePointGranularity
newtype TimePointGranularity Source #
Constructors
| TimePointGranularity' | |
Fields | |
Bundled Patterns
| pattern TimePointGranularity_ALL :: TimePointGranularity | |
| pattern TimePointGranularity_SPECIFIC :: TimePointGranularity |
Instances
TimeSeriesGranularity
newtype TimeSeriesGranularity Source #
Constructors
| TimeSeriesGranularity' | |
Fields | |
Bundled Patterns
| pattern TimeSeriesGranularity_ALL :: TimeSeriesGranularity | |
| pattern TimeSeriesGranularity_SPECIFIC :: TimeSeriesGranularity |
Instances
Action
Defines the modifications that you are making to an attribute for a
what-if forecast. For example, you can use this operation to create a
what-if forecast that investigates a 10% off sale on all shoes. To do
this, you specify "AttributeName": "shoes",
"Operation": "MULTIPLY", and "Value": "0.90". Pair this
operation with the TimeSeriesCondition operation within the
CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
define a subset of attribute items that are modified.
See: newAction smart constructor.
Constructors
| Action' | |
Fields
| |
Instances
| FromJSON Action Source # | |
| ToJSON Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
| Generic Action Source # | |
| Read Action Source # | |
| Show Action Source # | |
| NFData Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
| Eq Action Source # | |
| Hashable Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
| type Rep Action Source # | |
Defined in Amazonka.Forecast.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.Forecast.Types.Action" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Operation) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))) | |
Create a value of Action 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:attributeName:Action', action_attributeName - The related time series that you are modifying. This value is case
insensitive.
$sel:operation:Action', action_operation - The operation that is applied to the provided attribute. Operations
include:
ADD- addsValueto all rows ofAttributeName.SUBTRACT- subtractsValuefrom all rows ofAttributeName.MULTIPLY- multiplies all rows ofAttributeNamebyValue.DIVIDE- divides all rows ofAttributeNamebyValue.
$sel:value:Action', action_value - The value that is applied for the chosen Operation.
action_attributeName :: Lens' Action Text Source #
The related time series that you are modifying. This value is case insensitive.
action_operation :: Lens' Action Operation Source #
The operation that is applied to the provided attribute. Operations include:
ADD- addsValueto all rows ofAttributeName.SUBTRACT- subtractsValuefrom all rows ofAttributeName.MULTIPLY- multiplies all rows ofAttributeNamebyValue.DIVIDE- divides all rows ofAttributeNamebyValue.
AdditionalDataset
data AdditionalDataset Source #
Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.
Weather Index
The Amazon Forecast Weather Index is a built-in dataset 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 dataset that incorporates 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: newAdditionalDataset smart constructor.
Constructors
| AdditionalDataset' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AdditionalDataset |
Create a value of AdditionalDataset 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:configuration:AdditionalDataset', additionalDataset_configuration - Weather Index
To enable the Weather Index, do not specify a value for Configuration.
Holidays
Holidays
To enable Holidays, set CountryCode to 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
$sel:name:AdditionalDataset', additionalDataset_name - The name of the additional dataset. Valid names: "holiday" and
"weather".
additionalDataset_configuration :: Lens' AdditionalDataset (Maybe (HashMap Text (NonEmpty Text))) Source #
Weather Index
To enable the Weather Index, do not specify a value for Configuration.
Holidays
Holidays
To enable Holidays, set CountryCode to 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
additionalDataset_name :: Lens' AdditionalDataset Text Source #
The name of the additional dataset. Valid names: "holiday" and
"weather".
AttributeConfig
data AttributeConfig Source #
Provides information about the method used to transform attributes.
The following is an example using the RETAIL domain:
{"AttributeName": "demand",
"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}}
See: newAttributeConfig smart constructor.
Constructors
| AttributeConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AttributeConfig |
Create a value of AttributeConfig 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:attributeName:AttributeConfig', attributeConfig_attributeName - The name of the attribute as specified in the schema. 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.
$sel:transformations:AttributeConfig', attributeConfig_transformations - 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. Default values are bolded.
aggregation: sum,avg,first,min,maxfrontfill: nonemiddlefill: zero,nan(not a number),value,median,mean,min,maxbackfill: 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,maxbackfill:zero,value,median,mean,min,maxfuturefill: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".
attributeConfig_attributeName :: Lens' AttributeConfig Text Source #
The name of the attribute as specified in the schema. 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.
attributeConfig_transformations :: Lens' AttributeConfig (HashMap Text Text) Source #
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. Default values are bolded.
aggregation: sum,avg,first,min,maxfrontfill: nonemiddlefill: zero,nan(not a number),value,median,mean,min,maxbackfill: 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,maxbackfill:zero,value,median,mean,min,maxfuturefill: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".
Baseline
Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
See: newBaseline smart constructor.
Constructors
| Baseline' | |
Fields
| |
Instances
| FromJSON Baseline Source # | |
| Generic Baseline Source # | |
| Read Baseline Source # | |
| Show Baseline Source # | |
| NFData Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline | |
| Eq Baseline Source # | |
| Hashable Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline | |
| type Rep Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline type Rep Baseline = D1 ('MetaData "Baseline" "Amazonka.Forecast.Types.Baseline" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Baseline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "predictorBaseline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PredictorBaseline)))) | |
newBaseline :: Baseline Source #
Create a value of Baseline 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:predictorBaseline:Baseline', baseline_predictorBaseline - The initial
accuracy metrics
for the predictor you are monitoring. Use these metrics as a baseline
for comparison purposes as you use your predictor and the metrics
change.
baseline_predictorBaseline :: Lens' Baseline (Maybe PredictorBaseline) Source #
The initial accuracy metrics for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.
BaselineMetric
data BaselineMetric Source #
An individual metric that you can use for comparison as you evaluate your monitoring results.
See: newBaselineMetric smart constructor.
Constructors
| BaselineMetric' | |
Instances
newBaselineMetric :: BaselineMetric Source #
Create a value of BaselineMetric 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:BaselineMetric', baselineMetric_name - The name of the metric.
$sel:value:BaselineMetric', baselineMetric_value - The value for the metric.
baselineMetric_name :: Lens' BaselineMetric (Maybe Text) Source #
The name of the metric.
baselineMetric_value :: Lens' BaselineMetric (Maybe Double) Source #
The value for the metric.
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.
Constructors
| CategoricalParameterRange' | |
Instances
newCategoricalParameterRange Source #
Arguments
| :: Text | |
| -> NonEmpty Text | |
| -> CategoricalParameterRange |
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.
categoricalParameterRange_name :: Lens' CategoricalParameterRange Text Source #
The name of the categorical hyperparameter to tune.
categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text) Source #
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.
Constructors
| ContinuousParameterRange' | |
Fields
| |
Instances
newContinuousParameterRange Source #
Arguments
| :: 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.
continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe ScalingType) Source #
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:
continuousParameterRange_name :: Lens' ContinuousParameterRange Text Source #
The name of the hyperparameter to tune.
continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Double Source #
The maximum tunable value of the hyperparameter.
continuousParameterRange_minValue :: Lens' ContinuousParameterRange Double Source #
The minimum tunable value of the hyperparameter.
DataConfig
data DataConfig Source #
The data configuration for your dataset group and any additional datasets.
See: newDataConfig smart constructor.
Constructors
| DataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DataConfig |
Create a value of DataConfig 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:additionalDatasets:DataConfig', dataConfig_additionalDatasets - Additional built-in datasets like Holidays and the Weather Index.
$sel:attributeConfigs:DataConfig', dataConfig_attributeConfigs - Aggregation and filling options for attributes in your dataset group.
$sel:datasetGroupArn:DataConfig', dataConfig_datasetGroupArn - The ARN of the dataset group used to train the predictor.
dataConfig_additionalDatasets :: Lens' DataConfig (Maybe (NonEmpty AdditionalDataset)) Source #
Additional built-in datasets like Holidays and the Weather Index.
dataConfig_attributeConfigs :: Lens' DataConfig (Maybe (NonEmpty AttributeConfig)) Source #
Aggregation and filling options for attributes in your dataset group.
dataConfig_datasetGroupArn :: Lens' DataConfig Text Source #
The ARN of the dataset group used to train the predictor.
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.
Constructors
| DataDestination' | |
Instances
Arguments
| :: S3Config | |
| -> DataDestination |
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.
dataDestination_s3Config :: Lens' DataDestination S3Config Source #
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 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.
See: newDataSource smart constructor.
Constructors
| DataSource' | |
Instances
Arguments
| :: S3Config | |
| -> DataSource |
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 data stored in an Amazon Simple Storage Service (Amazon
S3) bucket along with the credentials to access the data.
dataSource_s3Config :: Lens' DataSource S3Config Source #
The path to the 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.
Constructors
| DatasetGroupSummary' | |
Fields
| |
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:datasetGroupArn:DatasetGroupSummary', datasetGroupSummary_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group.
$sel:datasetGroupName:DatasetGroupSummary', datasetGroupSummary_datasetGroupName - The name 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.
datasetGroupSummary_creationTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
When the dataset group was created.
datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
datasetGroupSummary_datasetGroupName :: Lens' DatasetGroupSummary (Maybe Text) Source #
The name of the dataset group.
datasetGroupSummary_lastModificationTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
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.
Constructors
| DatasetImportJobSummary' | |
Fields
| |
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: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:datasetImportJobName:DatasetImportJobSummary', datasetImportJobSummary_datasetImportJobName - The name of the dataset import job.
$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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:DatasetImportJobSummary', datasetImportJobSummary_message - If an error occurred, an informational message about the error.
$sel:status:DatasetImportJobSummary', datasetImportJobSummary_status - The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILEDCREATE_STOPPING,CREATE_STOPPED
datasetImportJobSummary_creationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
When the dataset import job was created.
datasetImportJobSummary_dataSource :: Lens' DatasetImportJobSummary (Maybe DataSource) Source #
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.
datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job.
datasetImportJobSummary_datasetImportJobName :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The name of the dataset import job.
datasetImportJobSummary_lastModificationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
datasetImportJobSummary_message :: Lens' DatasetImportJobSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILEDCREATE_STOPPING,CREATE_STOPPED
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.
Constructors
| DatasetSummary' | |
Fields
| |
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:datasetName:DatasetSummary', datasetSummary_datasetName - The name of the dataset.
$sel:datasetType:DatasetSummary', datasetSummary_datasetType - The dataset type.
$sel:domain:DatasetSummary', datasetSummary_domain - The domain associated with 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.
datasetSummary_creationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
When the dataset was created.
datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
datasetSummary_datasetName :: Lens' DatasetSummary (Maybe Text) Source #
The name of the dataset.
datasetSummary_datasetType :: Lens' DatasetSummary (Maybe DatasetType) Source #
The dataset type.
datasetSummary_domain :: Lens' DatasetSummary (Maybe Domain) Source #
The domain associated with the dataset.
datasetSummary_lastModificationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
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.
Constructors
| EncryptionConfig' | |
Fields | |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EncryptionConfig |
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.
encryptionConfig_roleArn :: Lens' EncryptionConfig Text Source #
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.
encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text Source #
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.
Constructors
| ErrorMetric' | |
Fields
| |
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:forecastType:ErrorMetric', errorMetric_forecastType - The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
$sel:mape:ErrorMetric', errorMetric_mape - The Mean Absolute Percentage Error (MAPE)
$sel:mase:ErrorMetric', errorMetric_mase - The Mean Absolute Scaled Error (MASE)
$sel:rmse:ErrorMetric', errorMetric_rmse - The root-mean-square error (RMSE).
$sel:wape:ErrorMetric', errorMetric_wape - The weighted absolute percentage error (WAPE).
errorMetric_forecastType :: Lens' ErrorMetric (Maybe Text) Source #
The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
errorMetric_mape :: Lens' ErrorMetric (Maybe Double) Source #
The Mean Absolute Percentage Error (MAPE)
errorMetric_mase :: Lens' ErrorMetric (Maybe Double) Source #
The Mean Absolute Scaled Error (MASE)
errorMetric_rmse :: Lens' ErrorMetric (Maybe Double) Source #
The root-mean-square error (RMSE).
errorMetric_wape :: Lens' ErrorMetric (Maybe Double) Source #
The weighted absolute percentage error (WAPE).
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.
Constructors
| EvaluationParameters' | |
Fields
| |
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.
evaluationParameters_backTestWindowOffset :: Lens' EvaluationParameters (Maybe Int) Source #
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
evaluationParameters_numberOfBacktestWindows :: Lens' EvaluationParameters (Maybe Int) Source #
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.
Constructors
| EvaluationResult' | |
Fields
| |
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.
evaluationResult_algorithmArn :: Lens' EvaluationResult (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm that was evaluated.
evaluationResult_testWindows :: Lens' EvaluationResult (Maybe [WindowSummary]) Source #
The array of test windows used for evaluating the algorithm. The
NumberOfBacktestWindows from the EvaluationParameters object
determines the number of windows in the array.
ExplainabilityConfig
data ExplainabilityConfig Source #
The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.
If you provide a predictor ARN for ResourceArn, you must set both
TimePointGranularity and TimeSeriesGranularity to “ALL”. When
creating Predictor Explainability, Amazon Forecast considers all time
series and time points.
If you provide a forecast ARN for ResourceArn, you can set
TimePointGranularity and TimeSeriesGranularity to either “ALL” or
“Specific”.
See: newExplainabilityConfig smart constructor.
Constructors
| ExplainabilityConfig' | |
Fields
| |
Instances
newExplainabilityConfig Source #
Arguments
| :: TimeSeriesGranularity | |
| -> TimePointGranularity | |
| -> ExplainabilityConfig |
Create a value of ExplainabilityConfig 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:timeSeriesGranularity:ExplainabilityConfig', explainabilityConfig_timeSeriesGranularity - To create an Explainability for all time series in your datasets, use
ALL. To create an Explainability for specific time series in your
datasets, use SPECIFIC.
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
$sel:timePointGranularity:ExplainabilityConfig', explainabilityConfig_timePointGranularity - To create an Explainability for all time points in your forecast
horizon, use ALL. To create an Explainability for specific time points
in your forecast horizon, use SPECIFIC.
Specify time points with the StartDateTime and EndDateTime
parameters within the CreateExplainability operation.
explainabilityConfig_timeSeriesGranularity :: Lens' ExplainabilityConfig TimeSeriesGranularity Source #
To create an Explainability for all time series in your datasets, use
ALL. To create an Explainability for specific time series in your
datasets, use SPECIFIC.
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
explainabilityConfig_timePointGranularity :: Lens' ExplainabilityConfig TimePointGranularity Source #
To create an Explainability for all time points in your forecast
horizon, use ALL. To create an Explainability for specific time points
in your forecast horizon, use SPECIFIC.
Specify time points with the StartDateTime and EndDateTime
parameters within the CreateExplainability operation.
ExplainabilityExportSummary
data ExplainabilityExportSummary Source #
Provides a summary of the Explainability export properties used in the
ListExplainabilityExports operation. To get a complete set of
properties, call the DescribeExplainabilityExport operation, and provide
the ExplainabilityExportArn.
See: newExplainabilityExportSummary smart constructor.
Constructors
| ExplainabilityExportSummary' | |
Fields
| |
Instances
newExplainabilityExportSummary :: ExplainabilityExportSummary Source #
Create a value of ExplainabilityExportSummary 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:ExplainabilityExportSummary', explainabilityExportSummary_creationTime - When the Explainability was created.
$sel:destination:ExplainabilityExportSummary', explainabilityExportSummary_destination - Undocumented member.
$sel:explainabilityExportArn:ExplainabilityExportSummary', explainabilityExportSummary_explainabilityExportArn - The Amazon Resource Name (ARN) of the Explainability export.
$sel:explainabilityExportName:ExplainabilityExportSummary', explainabilityExportSummary_explainabilityExportName - The name of the Explainability export
$sel:lastModificationTime:ExplainabilityExportSummary', explainabilityExportSummary_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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:ExplainabilityExportSummary', explainabilityExportSummary_message - Information about any errors that may have occurred during the
Explainability export.
$sel:status:ExplainabilityExportSummary', explainabilityExportSummary_status - The status of the Explainability export. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
explainabilityExportSummary_creationTime :: Lens' ExplainabilityExportSummary (Maybe UTCTime) Source #
When the Explainability was created.
explainabilityExportSummary_destination :: Lens' ExplainabilityExportSummary (Maybe DataDestination) Source #
Undocumented member.
explainabilityExportSummary_explainabilityExportArn :: Lens' ExplainabilityExportSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability export.
explainabilityExportSummary_explainabilityExportName :: Lens' ExplainabilityExportSummary (Maybe Text) Source #
The name of the Explainability export
explainabilityExportSummary_lastModificationTime :: Lens' ExplainabilityExportSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
explainabilityExportSummary_message :: Lens' ExplainabilityExportSummary (Maybe Text) Source #
Information about any errors that may have occurred during the Explainability export.
explainabilityExportSummary_status :: Lens' ExplainabilityExportSummary (Maybe Text) Source #
The status of the Explainability export. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
ExplainabilityInfo
data ExplainabilityInfo Source #
Provides information about the Explainability resource.
See: newExplainabilityInfo smart constructor.
Constructors
| ExplainabilityInfo' | |
Instances
newExplainabilityInfo :: ExplainabilityInfo Source #
Create a value of ExplainabilityInfo 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:explainabilityArn:ExplainabilityInfo', explainabilityInfo_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.
$sel:status:ExplainabilityInfo', explainabilityInfo_status - The status of the Explainability. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
explainabilityInfo_explainabilityArn :: Lens' ExplainabilityInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability.
explainabilityInfo_status :: Lens' ExplainabilityInfo (Maybe Text) Source #
The status of the Explainability. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
ExplainabilitySummary
data ExplainabilitySummary Source #
Provides a summary of the Explainability properties used in the
ListExplainabilities operation. To get a complete set of properties,
call the DescribeExplainability operation, and provide the listed
ExplainabilityArn.
See: newExplainabilitySummary smart constructor.
Constructors
| ExplainabilitySummary' | |
Fields
| |
Instances
newExplainabilitySummary :: ExplainabilitySummary Source #
Create a value of ExplainabilitySummary 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:ExplainabilitySummary', explainabilitySummary_creationTime - When the Explainability was created.
$sel:explainabilityArn:ExplainabilitySummary', explainabilitySummary_explainabilityArn - The Amazon Resource Name (ARN) of the Explainability.
$sel:explainabilityConfig:ExplainabilitySummary', explainabilitySummary_explainabilityConfig - The configuration settings that define the granularity of time series
and time points for the Explainability.
$sel:explainabilityName:ExplainabilitySummary', explainabilitySummary_explainabilityName - The name of the Explainability.
$sel:lastModificationTime:ExplainabilitySummary', explainabilitySummary_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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:ExplainabilitySummary', explainabilitySummary_message - Information about any errors that may have occurred during the
Explainability creation process.
$sel:resourceArn:ExplainabilitySummary', explainabilitySummary_resourceArn - The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability.
$sel:status:ExplainabilitySummary', explainabilitySummary_status - The status of the Explainability. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
explainabilitySummary_creationTime :: Lens' ExplainabilitySummary (Maybe UTCTime) Source #
When the Explainability was created.
explainabilitySummary_explainabilityArn :: Lens' ExplainabilitySummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability.
explainabilitySummary_explainabilityConfig :: Lens' ExplainabilitySummary (Maybe ExplainabilityConfig) Source #
The configuration settings that define the granularity of time series and time points for the Explainability.
explainabilitySummary_explainabilityName :: Lens' ExplainabilitySummary (Maybe Text) Source #
The name of the Explainability.
explainabilitySummary_lastModificationTime :: Lens' ExplainabilitySummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
explainabilitySummary_message :: Lens' ExplainabilitySummary (Maybe Text) Source #
Information about any errors that may have occurred during the Explainability creation process.
explainabilitySummary_resourceArn :: Lens' ExplainabilitySummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
explainabilitySummary_status :: Lens' ExplainabilitySummary (Maybe Text) Source #
The status of the Explainability. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
Featurization
data Featurization Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.
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.
Constructors
| Featurization' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Featurization |
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.
featurization_featurizationPipeline :: Lens' Featurization (Maybe (NonEmpty FeaturizationMethod)) Source #
An array of one FeaturizationMethod object that specifies the feature
transformation method.
featurization_attributeName :: Lens' Featurization Text Source #
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 #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.
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.
Constructors
| FeaturizationConfig' | |
Fields
| |
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.
featurizationConfig_featurizations :: Lens' FeaturizationConfig (Maybe (NonEmpty Featurization)) Source #
An array of featurization (transformation) information for the fields of a dataset.
featurizationConfig_forecastDimensions :: Lens' FeaturizationConfig (Maybe (NonEmpty Text)) Source #
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.
featurizationConfig_forecastFrequency :: Lens' FeaturizationConfig Text Source #
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.
Constructors
| FeaturizationMethod' | |
Fields
| |
Instances
newFeaturizationMethod Source #
Arguments
| :: FeaturizationMethodName | |
| -> FeaturizationMethod |
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,maxfrontfill: nonemiddlefill: zero,nan(not a number),value,median,mean,min,maxbackfill: 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,maxbackfill:zero,value,median,mean,min,maxfuturefill: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.
featurizationMethod_featurizationMethodParameters :: Lens' FeaturizationMethod (Maybe (HashMap Text Text)) Source #
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,maxfrontfill: nonemiddlefill: zero,nan(not a number),value,median,mean,min,maxbackfill: 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,maxbackfill:zero,value,median,mean,min,maxfuturefill: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".
featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName Source #
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.
Constructors
| Filter' | |
Instances
| ToJSON Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
| Generic Filter Source # | |
| Read Filter Source # | |
| Show Filter Source # | |
| NFData Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
| Eq Filter Source # | |
| Hashable 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" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" '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)))) | |
Arguments
| :: 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.
filter_condition :: Lens' Filter FilterConditionString Source #
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.
Constructors
| ForecastExportJobSummary' | |
Fields
| |
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: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: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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:ForecastExportJobSummary', forecastExportJobSummary_message - If an error occurred, an informational message about the error.
$sel:status:ForecastExportJobSummary', forecastExportJobSummary_status - The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_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.
forecastExportJobSummary_creationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime) Source #
When the forecast export job was created.
forecastExportJobSummary_destination :: Lens' ForecastExportJobSummary (Maybe DataDestination) Source #
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
forecastExportJobSummary_forecastExportJobArn :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the forecast export job.
forecastExportJobSummary_forecastExportJobName :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The name of the forecast export job.
forecastExportJobSummary_lastModificationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
forecastExportJobSummary_message :: Lens' ForecastExportJobSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
forecastExportJobSummary_status :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_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.
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.
Constructors
| ForecastSummary' | |
Fields
| |
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:createdUsingAutoPredictor:ForecastSummary', forecastSummary_createdUsingAutoPredictor - Whether the Forecast was created from an AutoPredictor.
$sel:creationTime:ForecastSummary', forecastSummary_creationTime - When the forecast creation task was created.
$sel:datasetGroupArn:ForecastSummary', forecastSummary_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that provided the
data used to train the predictor.
$sel:forecastArn:ForecastSummary', forecastSummary_forecastArn - The ARN of the forecast.
$sel:forecastName:ForecastSummary', forecastSummary_forecastName - The name of the forecast.
$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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:ForecastSummary', forecastSummary_message - If an error occurred, an informational message about the error.
$sel:predictorArn:ForecastSummary', forecastSummary_predictorArn - The ARN of the predictor used to generate the forecast.
$sel:status:ForecastSummary', forecastSummary_status - The status of the forecast. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the forecast must be ACTIVE before you can query or
export the forecast.
forecastSummary_createdUsingAutoPredictor :: Lens' ForecastSummary (Maybe Bool) Source #
Whether the Forecast was created from an AutoPredictor.
forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
When the forecast creation task was created.
forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the forecast.
forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text) Source #
The name of the forecast.
forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
forecastSummary_message :: Lens' ForecastSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the predictor used to generate the forecast.
forecastSummary_status :: Lens' ForecastSummary (Maybe Text) Source #
The status of the forecast. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the forecast must be ACTIVE before you can query or
export the forecast.
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.
Constructors
| HyperParameterTuningJobConfig' | |
Fields
| |
Instances
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.
hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges) Source #
Specifies the ranges of valid values for the hyperparameters.
InputDataConfig
data InputDataConfig Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see DataConfig.
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.
Constructors
| InputDataConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> InputDataConfig |
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.
inputDataConfig_supplementaryFeatures :: Lens' InputDataConfig (Maybe (NonEmpty SupplementaryFeature)) Source #
An array of supplementary features. The only supported feature is a holiday calendar.
inputDataConfig_datasetGroupArn :: Lens' InputDataConfig Text Source #
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.
Constructors
| IntegerParameterRange' | |
Fields
| |
Instances
newIntegerParameterRange Source #
Arguments
| :: 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.
integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType) Source #
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:
integerParameterRange_name :: Lens' IntegerParameterRange Text Source #
The name of the hyperparameter to tune.
integerParameterRange_maxValue :: Lens' IntegerParameterRange Int Source #
The maximum tunable value of the hyperparameter.
integerParameterRange_minValue :: Lens' IntegerParameterRange Int Source #
The minimum tunable value of the hyperparameter.
MetricResult
data MetricResult Source #
An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.
For more information about metrics generated by Forecast see Evaluating Predictor Accuracy
See: newMetricResult smart constructor.
Constructors
| MetricResult' | |
Fields
| |
Instances
newMetricResult :: MetricResult Source #
Create a value of MetricResult 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:metricName:MetricResult', metricResult_metricName - The name of the metric.
$sel:metricValue:MetricResult', metricResult_metricValue - The value for the metric.
metricResult_metricName :: Lens' MetricResult (Maybe Text) Source #
The name of the metric.
metricResult_metricValue :: Lens' MetricResult (Maybe Double) Source #
The value for the metric.
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.
Constructors
| Metrics' | |
Fields
| |
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:averageWeightedQuantileLoss:Metrics', metrics_averageWeightedQuantileLoss - The average value of all weighted quantile losses.
$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).
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.
metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double) Source #
The average value of all weighted quantile losses.
metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric]) Source #
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).
metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss]) Source #
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.
MonitorConfig
data MonitorConfig Source #
The configuration details for the predictor monitor.
See: newMonitorConfig smart constructor.
Constructors
| MonitorConfig' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> MonitorConfig |
Create a value of MonitorConfig 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:monitorName:MonitorConfig', monitorConfig_monitorName - The name of the monitor resource.
monitorConfig_monitorName :: Lens' MonitorConfig Text Source #
The name of the monitor resource.
MonitorDataSource
data MonitorDataSource Source #
The source of the data the monitor used during the evaluation.
See: newMonitorDataSource smart constructor.
Constructors
| MonitorDataSource' | |
Fields
| |
Instances
newMonitorDataSource :: MonitorDataSource Source #
Create a value of MonitorDataSource 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:MonitorDataSource', monitorDataSource_datasetImportJobArn - The Amazon Resource Name (ARN) of the dataset import job used to import
the data that initiated the monitor evaluation.
$sel:forecastArn:MonitorDataSource', monitorDataSource_forecastArn - The Amazon Resource Name (ARN) of the forecast the monitor used during
the evaluation.
$sel:predictorArn:MonitorDataSource', monitorDataSource_predictorArn - The Amazon Resource Name (ARN) of the predictor resource you are
monitoring.
monitorDataSource_datasetImportJobArn :: Lens' MonitorDataSource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job used to import the data that initiated the monitor evaluation.
monitorDataSource_forecastArn :: Lens' MonitorDataSource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the forecast the monitor used during the evaluation.
monitorDataSource_predictorArn :: Lens' MonitorDataSource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor resource you are monitoring.
MonitorInfo
data MonitorInfo Source #
Provides information about the monitor resource.
See: newMonitorInfo smart constructor.
Constructors
| MonitorInfo' | |
Fields | |
Instances
newMonitorInfo :: MonitorInfo Source #
Create a value of MonitorInfo 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:monitorArn:MonitorInfo', monitorInfo_monitorArn - The Amazon Resource Name (ARN) of the monitor resource.
$sel:status:MonitorInfo', monitorInfo_status - The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING,ACTIVE_STOPPEDUPDATE_IN_PROGRESS
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
monitorInfo_monitorArn :: Lens' MonitorInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) of the monitor resource.
monitorInfo_status :: Lens' MonitorInfo (Maybe Text) Source #
The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING,ACTIVE_STOPPEDUPDATE_IN_PROGRESS
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
MonitorSummary
data MonitorSummary Source #
Provides a summary of the monitor properties used in the ListMonitors
operation. To get a complete set of properties, call the DescribeMonitor
operation, and provide the listed MonitorArn.
See: newMonitorSummary smart constructor.
Constructors
| MonitorSummary' | |
Fields
| |
Instances
newMonitorSummary :: MonitorSummary Source #
Create a value of MonitorSummary 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:MonitorSummary', monitorSummary_creationTime - When the monitor resource was created.
$sel:lastModificationTime:MonitorSummary', monitorSummary_lastModificationTime - The last time the monitor resource was modified. The timestamp depends
on the status of the job:
CREATE_PENDING- TheCreationTime.CREATE_IN_PROGRESS- The current timestamp.STOPPED- When the resource stopped.ACTIVEorCREATE_FAILED- When the monitor creation finished or failed.
$sel:monitorArn:MonitorSummary', monitorSummary_monitorArn - The Amazon Resource Name (ARN) of the monitor resource.
$sel:monitorName:MonitorSummary', monitorSummary_monitorName - The name of the monitor resource.
$sel:resourceArn:MonitorSummary', monitorSummary_resourceArn - The Amazon Resource Name (ARN) of the predictor being monitored.
$sel:status:MonitorSummary', monitorSummary_status - The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING,ACTIVE_STOPPEDUPDATE_IN_PROGRESS
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
monitorSummary_creationTime :: Lens' MonitorSummary (Maybe UTCTime) Source #
When the monitor resource was created.
monitorSummary_lastModificationTime :: Lens' MonitorSummary (Maybe UTCTime) Source #
The last time the monitor resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING- TheCreationTime.CREATE_IN_PROGRESS- The current timestamp.STOPPED- When the resource stopped.ACTIVEorCREATE_FAILED- When the monitor creation finished or failed.
monitorSummary_monitorArn :: Lens' MonitorSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the monitor resource.
monitorSummary_monitorName :: Lens' MonitorSummary (Maybe Text) Source #
The name of the monitor resource.
monitorSummary_resourceArn :: Lens' MonitorSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor being monitored.
monitorSummary_status :: Lens' MonitorSummary (Maybe Text) Source #
The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING,ACTIVE_STOPPEDUPDATE_IN_PROGRESS
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
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.
Constructors
| ParameterRanges' | |
Fields
| |
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:continuousParameterRanges:ParameterRanges', parameterRanges_continuousParameterRanges - Specifies the tunable range for each continuous hyperparameter.
$sel:integerParameterRanges:ParameterRanges', parameterRanges_integerParameterRanges - Specifies the tunable range for each integer hyperparameter.
parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty CategoricalParameterRange)) Source #
Specifies the tunable range for each categorical hyperparameter.
parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty ContinuousParameterRange)) Source #
Specifies the tunable range for each continuous hyperparameter.
parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty IntegerParameterRange)) Source #
Specifies the tunable range for each integer 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.
Constructors
| PredictorBacktestExportJobSummary' | |
Fields
| |
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:destination:PredictorBacktestExportJobSummary', predictorBacktestExportJobSummary_destination - Undocumented member.
$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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:PredictorBacktestExportJobSummary', predictorBacktestExportJobSummary_message - Information about any errors that may have occurred during the backtest
export.
$sel:predictorBacktestExportJobArn:PredictorBacktestExportJobSummary', predictorBacktestExportJobSummary_predictorBacktestExportJobArn - The Amazon Resource Name (ARN) of the predictor backtest export job.
$sel:predictorBacktestExportJobName:PredictorBacktestExportJobSummary', predictorBacktestExportJobSummary_predictorBacktestExportJobName - The name of the predictor backtest export job.
$sel:status:PredictorBacktestExportJobSummary', predictorBacktestExportJobSummary_status - The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
predictorBacktestExportJobSummary_creationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime) Source #
When the predictor backtest export job was created.
predictorBacktestExportJobSummary_destination :: Lens' PredictorBacktestExportJobSummary (Maybe DataDestination) Source #
Undocumented member.
predictorBacktestExportJobSummary_lastModificationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
predictorBacktestExportJobSummary_message :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
Information about any errors that may have occurred during the backtest export.
predictorBacktestExportJobSummary_predictorBacktestExportJobArn :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
predictorBacktestExportJobSummary_predictorBacktestExportJobName :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The name of the predictor backtest export job.
predictorBacktestExportJobSummary_status :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
PredictorBaseline
data PredictorBaseline Source #
Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
See: newPredictorBaseline smart constructor.
Constructors
| PredictorBaseline' | |
Fields
| |
Instances
newPredictorBaseline :: PredictorBaseline Source #
Create a value of PredictorBaseline 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:baselineMetrics:PredictorBaseline', predictorBaseline_baselineMetrics - The initial
accuracy metrics
for the predictor. Use these metrics as a baseline for comparison
purposes as you use your predictor and the metrics change.
predictorBaseline_baselineMetrics :: Lens' PredictorBaseline (Maybe [BaselineMetric]) Source #
The initial accuracy metrics for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.
PredictorEvent
data PredictorEvent Source #
Provides details about a predictor event, such as a retraining.
See: newPredictorEvent smart constructor.
Constructors
| PredictorEvent' | |
Fields
| |
Instances
newPredictorEvent :: PredictorEvent Source #
Create a value of PredictorEvent 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:datetime:PredictorEvent', predictorEvent_datetime - The timestamp for when the event occurred.
$sel:detail:PredictorEvent', predictorEvent_detail - The type of event. For example, Retrain. A retraining event denotes
the timepoint when a predictor was retrained. Any monitor results from
before the Datetime are from the previous predictor. Any new metrics
are for the newly retrained predictor.
predictorEvent_datetime :: Lens' PredictorEvent (Maybe UTCTime) Source #
The timestamp for when the event occurred.
predictorEvent_detail :: Lens' PredictorEvent (Maybe Text) Source #
The type of event. For example, Retrain. A retraining event denotes
the timepoint when a predictor was retrained. Any monitor results from
before the Datetime are from the previous predictor. Any new metrics
are for the newly retrained predictor.
PredictorExecution
data PredictorExecution Source #
The algorithm used to perform a backtest and the status of those tests.
See: newPredictorExecution smart constructor.
Constructors
| PredictorExecution' | |
Fields
| |
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.
predictorExecution_algorithmArn :: Lens' PredictorExecution (Maybe Text) Source #
The ARN of the algorithm used to test the predictor.
predictorExecution_testWindows :: Lens' PredictorExecution (Maybe [TestWindowSummary]) Source #
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.
Constructors
| PredictorExecutionDetails' | |
Fields
| |
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.
predictorExecutionDetails_predictorExecutions :: Lens' PredictorExecutionDetails (Maybe (NonEmpty PredictorExecution)) Source #
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.
PredictorMonitorEvaluation
data PredictorMonitorEvaluation Source #
Describes the results of a monitor evaluation.
See: newPredictorMonitorEvaluation smart constructor.
Constructors
| PredictorMonitorEvaluation' | |
Fields
| |
Instances
newPredictorMonitorEvaluation :: PredictorMonitorEvaluation Source #
Create a value of PredictorMonitorEvaluation 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:evaluationState:PredictorMonitorEvaluation', predictorMonitorEvaluation_evaluationState - The status of the monitor evaluation. The state can be SUCCESS or
FAILURE.
$sel:evaluationTime:PredictorMonitorEvaluation', predictorMonitorEvaluation_evaluationTime - The timestamp that indicates when the monitor evaluation was started.
$sel:message:PredictorMonitorEvaluation', predictorMonitorEvaluation_message - Information about any errors that may have occurred during the monitor
evaluation.
$sel:metricResults:PredictorMonitorEvaluation', predictorMonitorEvaluation_metricResults - A list of metrics Forecast calculated when monitoring a predictor. You
can compare the value for each metric in the list to the metric's value
in the Baseline to see how your predictor's performance is changing.
$sel:monitorArn:PredictorMonitorEvaluation', predictorMonitorEvaluation_monitorArn - The Amazon Resource Name (ARN) of the monitor resource.
$sel:monitorDataSource:PredictorMonitorEvaluation', predictorMonitorEvaluation_monitorDataSource - The source of the data the monitor resource used during the evaluation.
$sel:numItemsEvaluated:PredictorMonitorEvaluation', predictorMonitorEvaluation_numItemsEvaluated - The number of items considered during the evaluation.
$sel:predictorEvent:PredictorMonitorEvaluation', predictorMonitorEvaluation_predictorEvent - Provides details about a predictor event, such as a retraining.
$sel:resourceArn:PredictorMonitorEvaluation', predictorMonitorEvaluation_resourceArn - The Amazon Resource Name (ARN) of the resource to monitor.
$sel:windowEndDatetime:PredictorMonitorEvaluation', predictorMonitorEvaluation_windowEndDatetime - The timestamp that indicates the end of the window that is used for
monitor evaluation.
$sel:windowStartDatetime:PredictorMonitorEvaluation', predictorMonitorEvaluation_windowStartDatetime - The timestamp that indicates the start of the window that is used for
monitor evaluation.
predictorMonitorEvaluation_evaluationState :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #
The status of the monitor evaluation. The state can be SUCCESS or
FAILURE.
predictorMonitorEvaluation_evaluationTime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #
The timestamp that indicates when the monitor evaluation was started.
predictorMonitorEvaluation_message :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #
Information about any errors that may have occurred during the monitor evaluation.
predictorMonitorEvaluation_metricResults :: Lens' PredictorMonitorEvaluation (Maybe [MetricResult]) Source #
A list of metrics Forecast calculated when monitoring a predictor. You can compare the value for each metric in the list to the metric's value in the Baseline to see how your predictor's performance is changing.
predictorMonitorEvaluation_monitorArn :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #
The Amazon Resource Name (ARN) of the monitor resource.
predictorMonitorEvaluation_monitorDataSource :: Lens' PredictorMonitorEvaluation (Maybe MonitorDataSource) Source #
The source of the data the monitor resource used during the evaluation.
predictorMonitorEvaluation_numItemsEvaluated :: Lens' PredictorMonitorEvaluation (Maybe Integer) Source #
The number of items considered during the evaluation.
predictorMonitorEvaluation_predictorEvent :: Lens' PredictorMonitorEvaluation (Maybe PredictorEvent) Source #
Provides details about a predictor event, such as a retraining.
predictorMonitorEvaluation_resourceArn :: Lens' PredictorMonitorEvaluation (Maybe Text) Source #
The Amazon Resource Name (ARN) of the resource to monitor.
predictorMonitorEvaluation_windowEndDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #
The timestamp that indicates the end of the window that is used for monitor evaluation.
predictorMonitorEvaluation_windowStartDatetime :: Lens' PredictorMonitorEvaluation (Maybe UTCTime) Source #
The timestamp that indicates the start of the window that is used for monitor evaluation.
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.
Constructors
| PredictorSummary' | |
Fields
| |
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:datasetGroupArn:PredictorSummary', predictorSummary_datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the
data used to train the predictor.
$sel:isAutoPredictor:PredictorSummary', predictorSummary_isAutoPredictor - Whether AutoPredictor was used to create the predictor.
$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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:PredictorSummary', predictorSummary_message - If an error occurred, an informational message about the error.
$sel:predictorArn:PredictorSummary', predictorSummary_predictorArn - The ARN of the predictor.
$sel:predictorName:PredictorSummary', predictorSummary_predictorName - The name of the predictor.
$sel:referencePredictorSummary:PredictorSummary', predictorSummary_referencePredictorSummary - A summary of the reference predictor used if the predictor was retrained
or upgraded.
$sel:status:PredictorSummary', predictorSummary_status - The status of the predictor. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILEDCREATE_STOPPING,CREATE_STOPPED
The Status of the predictor must be ACTIVE before you can use the
predictor to create a forecast.
predictorSummary_creationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #
When the model training task was created.
predictorSummary_datasetGroupArn :: Lens' PredictorSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
predictorSummary_isAutoPredictor :: Lens' PredictorSummary (Maybe Bool) Source #
Whether AutoPredictor was used to create the predictor.
predictorSummary_lastModificationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
predictorSummary_message :: Lens' PredictorSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
predictorSummary_predictorArn :: Lens' PredictorSummary (Maybe Text) Source #
The ARN of the predictor.
predictorSummary_predictorName :: Lens' PredictorSummary (Maybe Text) Source #
The name of the predictor.
predictorSummary_referencePredictorSummary :: Lens' PredictorSummary (Maybe ReferencePredictorSummary) Source #
A summary of the reference predictor used if the predictor was retrained or upgraded.
predictorSummary_status :: Lens' PredictorSummary (Maybe Text) Source #
The status of the predictor. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILEDCREATE_STOPPING,CREATE_STOPPED
The Status of the predictor must be ACTIVE before you can use the
predictor to create a forecast.
ReferencePredictorSummary
data ReferencePredictorSummary Source #
Provides a summary of the reference predictor used when retraining or upgrading a predictor.
See: newReferencePredictorSummary smart constructor.
Constructors
| ReferencePredictorSummary' | |
Instances
newReferencePredictorSummary :: ReferencePredictorSummary Source #
Create a value of ReferencePredictorSummary 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:arn:ReferencePredictorSummary', referencePredictorSummary_arn - The ARN of the reference predictor.
$sel:state:ReferencePredictorSummary', referencePredictorSummary_state - Whether the reference predictor is Active or Deleted.
referencePredictorSummary_arn :: Lens' ReferencePredictorSummary (Maybe Text) Source #
The ARN of the reference predictor.
referencePredictorSummary_state :: Lens' ReferencePredictorSummary (Maybe State) Source #
Whether the reference predictor is Active or Deleted.
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.
Constructors
| S3Config' | |
Fields
| |
Instances
| FromJSON S3Config Source # | |
| ToJSON S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
| Generic S3Config Source # | |
| Read S3Config Source # | |
| Show S3Config Source # | |
| NFData S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
| Eq S3Config Source # | |
| Hashable S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
| type Rep S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.Forecast.Types.S3Config" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" '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.
s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text) Source #
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
s3Config_path :: Lens' S3Config Text Source #
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
s3Config_roleArn :: Lens' S3Config Text Source #
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.
See: newSchema smart constructor.
Constructors
| Schema' | |
Fields
| |
Instances
| FromJSON Schema Source # | |
| ToJSON Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
| Generic Schema Source # | |
| Read Schema Source # | |
| Show Schema Source # | |
| NFData Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
| Eq Schema Source # | |
| Hashable Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
| type Rep Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema type Rep Schema = D1 ('MetaData "Schema" "Amazonka.Forecast.Types.Schema" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" '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.
schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute)) Source #
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.
Constructors
| SchemaAttribute' | |
Fields
| |
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:attributeName:SchemaAttribute', schemaAttribute_attributeName - The name of the dataset field.
$sel:attributeType:SchemaAttribute', schemaAttribute_attributeType - The data type of the field.
For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text) Source #
The name of the dataset field.
schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType) Source #
The data type of the field.
For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
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.
Constructors
| Statistics' | |
Fields
| |
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:avg:Statistics', statistics_avg - For a numeric field, the average value in the field.
$sel:count:Statistics', statistics_count - The number of values in the field. If the response value is -1, refer to
CountLong.
$sel:countDistinct:Statistics', statistics_countDistinct - The number of distinct values in the field. If the response value is -1,
refer to CountDistinctLong.
$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: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: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:countNull:Statistics', statistics_countNull - The number of null values in the field. If the response value is -1,
refer to CountNullLong.
$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:max:Statistics', statistics_max - For a numeric field, the maximum value in the field.
$sel:min:Statistics', statistics_min - For a numeric field, the minimum value in the field.
$sel:stddev:Statistics', statistics_stddev - For a numeric field, the standard deviation.
statistics_avg :: Lens' Statistics (Maybe Double) Source #
For a numeric field, the average value in the field.
statistics_count :: Lens' Statistics (Maybe Int) Source #
The number of values in the field. If the response value is -1, refer to
CountLong.
statistics_countDistinct :: Lens' Statistics (Maybe Int) Source #
The number of distinct values in the field. If the response value is -1,
refer to CountDistinctLong.
statistics_countDistinctLong :: Lens' Statistics (Maybe Integer) Source #
The number of distinct values in the field. CountDistinctLong is used
instead of CountDistinct if the value is greater than 2,147,483,647.
statistics_countLong :: Lens' Statistics (Maybe Integer) Source #
The number of values in the field. CountLong is used instead of
Count if the value is greater than 2,147,483,647.
statistics_countNan :: Lens' Statistics (Maybe Int) Source #
The number of NAN (not a number) values in the field. If the response
value is -1, refer to CountNanLong.
statistics_countNanLong :: Lens' Statistics (Maybe Integer) Source #
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.
statistics_countNull :: Lens' Statistics (Maybe Int) Source #
The number of null values in the field. If the response value is -1,
refer to CountNullLong.
statistics_countNullLong :: Lens' Statistics (Maybe Integer) Source #
The number of null values in the field. CountNullLong is used instead
of CountNull if the value is greater than 2,147,483,647.
statistics_max :: Lens' Statistics (Maybe Text) Source #
For a numeric field, the maximum value in the field.
statistics_min :: Lens' Statistics (Maybe Text) Source #
For a numeric field, the minimum value in the field.
statistics_stddev :: Lens' Statistics (Maybe Double) Source #
For a numeric field, the standard deviation.
SupplementaryFeature
data SupplementaryFeature Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.
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.
Constructors
| SupplementaryFeature' | |
Fields
| |
Instances
newSupplementaryFeature Source #
Arguments
| :: 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
supplementaryFeature_name :: Lens' SupplementaryFeature Text Source #
The name of the feature. Valid values: "holiday" and "weather".
supplementaryFeature_value :: Lens' SupplementaryFeature Text Source #
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 hasawsas its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofawsdo not count against your tags per resource limit.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
| Generic Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Forecast.Types.Tag" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" '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).
tag_key :: Lens' Tag Text Source #
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.
tag_value :: Lens' Tag Text Source #
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.
Constructors
| TestWindowSummary' | |
Fields | |
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:message:TestWindowSummary', testWindowSummary_message - If the test failed, the reason why it failed.
$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.
testWindowSummary_message :: Lens' TestWindowSummary (Maybe Text) Source #
If the test failed, the reason why it failed.
testWindowSummary_status :: Lens' TestWindowSummary (Maybe Text) Source #
The status of the test. Possible status values are:
ACTIVE
CREATE_IN_PROGRESS
CREATE_FAILED
testWindowSummary_testWindowEnd :: Lens' TestWindowSummary (Maybe UTCTime) Source #
The time at which the test ended.
testWindowSummary_testWindowStart :: Lens' TestWindowSummary (Maybe UTCTime) Source #
The time at which the test began.
TimeAlignmentBoundary
data TimeAlignmentBoundary Source #
The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
For more information about aggregation, see Data Aggregation for Different Forecast Frequencies. For more information setting a custom time boundary, see Specifying a Time Boundary.
See: newTimeAlignmentBoundary smart constructor.
Constructors
| TimeAlignmentBoundary' | |
Fields
| |
Instances
newTimeAlignmentBoundary :: TimeAlignmentBoundary Source #
Create a value of TimeAlignmentBoundary 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:dayOfMonth:TimeAlignmentBoundary', timeAlignmentBoundary_dayOfMonth - The day of the month to use for time alignment during aggregation.
$sel:dayOfWeek:TimeAlignmentBoundary', timeAlignmentBoundary_dayOfWeek - The day of week to use for time alignment during aggregation. The day
must be in uppercase.
$sel:hour:TimeAlignmentBoundary', timeAlignmentBoundary_hour - The hour of day to use for time alignment during aggregation.
$sel:month:TimeAlignmentBoundary', timeAlignmentBoundary_month - The month to use for time alignment during aggregation. The month must
be in uppercase.
timeAlignmentBoundary_dayOfMonth :: Lens' TimeAlignmentBoundary (Maybe Natural) Source #
The day of the month to use for time alignment during aggregation.
timeAlignmentBoundary_dayOfWeek :: Lens' TimeAlignmentBoundary (Maybe DayOfWeek) Source #
The day of week to use for time alignment during aggregation. The day must be in uppercase.
timeAlignmentBoundary_hour :: Lens' TimeAlignmentBoundary (Maybe Natural) Source #
The hour of day to use for time alignment during aggregation.
timeAlignmentBoundary_month :: Lens' TimeAlignmentBoundary (Maybe Month) Source #
The month to use for time alignment during aggregation. The month must be in uppercase.
TimeSeriesCondition
data TimeSeriesCondition Source #
Creates a subset of items within an attribute that are modified. For
example, you can use this operation to create a subset of items that
cost $5 or less. To do this, you specify "AttributeName": "price",
"AttributeValue": "5", and "Condition": "LESS_THAN". Pair
this operation with the Action operation within the
CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
define how the attribute is modified.
See: newTimeSeriesCondition smart constructor.
Constructors
| TimeSeriesCondition' | |
Fields
| |
Instances
newTimeSeriesCondition Source #
Arguments
| :: Text | |
| -> Text | |
| -> Condition | |
| -> TimeSeriesCondition |
Create a value of TimeSeriesCondition 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:attributeName:TimeSeriesCondition', timeSeriesCondition_attributeName - The item_id, dimension name, IM name, or timestamp that you are
modifying.
$sel:attributeValue:TimeSeriesCondition', timeSeriesCondition_attributeValue - The value that is applied for the chosen Condition.
$sel:condition:TimeSeriesCondition', timeSeriesCondition_condition - The condition to apply. Valid values are EQUALS, NOT_EQUALS,
LESS_THAN and GREATER_THAN.
timeSeriesCondition_attributeName :: Lens' TimeSeriesCondition Text Source #
The item_id, dimension name, IM name, or timestamp that you are modifying.
timeSeriesCondition_attributeValue :: Lens' TimeSeriesCondition Text Source #
The value that is applied for the chosen Condition.
timeSeriesCondition_condition :: Lens' TimeSeriesCondition Condition Source #
The condition to apply. Valid values are EQUALS, NOT_EQUALS,
LESS_THAN and GREATER_THAN.
TimeSeriesIdentifiers
data TimeSeriesIdentifiers Source #
Details about the import file that contains the time series for which you want to create forecasts.
See: newTimeSeriesIdentifiers smart constructor.
Constructors
| TimeSeriesIdentifiers' | |
Fields
| |
Instances
newTimeSeriesIdentifiers :: TimeSeriesIdentifiers Source #
Create a value of TimeSeriesIdentifiers 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:dataSource:TimeSeriesIdentifiers', timeSeriesIdentifiers_dataSource - Undocumented member.
$sel:format:TimeSeriesIdentifiers', timeSeriesIdentifiers_format - The format of the data, either CSV or PARQUET.
$sel:schema:TimeSeriesIdentifiers', timeSeriesIdentifiers_schema - Undocumented member.
timeSeriesIdentifiers_dataSource :: Lens' TimeSeriesIdentifiers (Maybe DataSource) Source #
Undocumented member.
timeSeriesIdentifiers_format :: Lens' TimeSeriesIdentifiers (Maybe Text) Source #
The format of the data, either CSV or PARQUET.
timeSeriesIdentifiers_schema :: Lens' TimeSeriesIdentifiers (Maybe Schema) Source #
Undocumented member.
TimeSeriesReplacementsDataSource
data TimeSeriesReplacementsDataSource Source #
A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.
See: newTimeSeriesReplacementsDataSource smart constructor.
Constructors
| TimeSeriesReplacementsDataSource' | |
Instances
newTimeSeriesReplacementsDataSource Source #
Arguments
| :: S3Config | |
| -> Schema | |
| -> TimeSeriesReplacementsDataSource |
Create a value of TimeSeriesReplacementsDataSource 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:format:TimeSeriesReplacementsDataSource', timeSeriesReplacementsDataSource_format - The format of the replacement data, CSV or PARQUET.
$sel:timestampFormat:TimeSeriesReplacementsDataSource', timeSeriesReplacementsDataSource_timestampFormat - The timestamp format of the replacement data.
$sel:s3Config:TimeSeriesReplacementsDataSource', timeSeriesReplacementsDataSource_s3Config - Undocumented member.
$sel:schema:TimeSeriesReplacementsDataSource', timeSeriesReplacementsDataSource_schema - Undocumented member.
timeSeriesReplacementsDataSource_format :: Lens' TimeSeriesReplacementsDataSource (Maybe Text) Source #
The format of the replacement data, CSV or PARQUET.
timeSeriesReplacementsDataSource_timestampFormat :: Lens' TimeSeriesReplacementsDataSource (Maybe Text) Source #
The timestamp format of the replacement data.
timeSeriesReplacementsDataSource_s3Config :: Lens' TimeSeriesReplacementsDataSource S3Config Source #
Undocumented member.
timeSeriesReplacementsDataSource_schema :: Lens' TimeSeriesReplacementsDataSource Schema Source #
Undocumented member.
TimeSeriesSelector
data TimeSeriesSelector Source #
Defines the set of time series that are used to create the forecasts in
a TimeSeriesIdentifiers object.
The TimeSeriesIdentifiers object needs the following information:
DataSource
Format
Schema
See: newTimeSeriesSelector smart constructor.
Constructors
| TimeSeriesSelector' | |
Fields
| |
Instances
newTimeSeriesSelector :: TimeSeriesSelector Source #
Create a value of TimeSeriesSelector 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:timeSeriesIdentifiers:TimeSeriesSelector', timeSeriesSelector_timeSeriesIdentifiers - Details about the import file that contains the time series for which
you want to create forecasts.
timeSeriesSelector_timeSeriesIdentifiers :: Lens' TimeSeriesSelector (Maybe TimeSeriesIdentifiers) Source #
Details about the import file that contains the time series for which you want to create forecasts.
TimeSeriesTransformation
data TimeSeriesTransformation Source #
A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.
See: newTimeSeriesTransformation smart constructor.
Constructors
| TimeSeriesTransformation' | |
Fields
| |
Instances
newTimeSeriesTransformation :: TimeSeriesTransformation Source #
Create a value of TimeSeriesTransformation 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:action:TimeSeriesTransformation', timeSeriesTransformation_action - An array of actions that define a time series and how it is transformed.
These transformations create a new time series that is used for the
what-if analysis.
$sel:timeSeriesConditions:TimeSeriesTransformation', timeSeriesTransformation_timeSeriesConditions - An array of conditions that define which members of the related time
series are transformed.
timeSeriesTransformation_action :: Lens' TimeSeriesTransformation (Maybe Action) Source #
An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.
timeSeriesTransformation_timeSeriesConditions :: Lens' TimeSeriesTransformation (Maybe [TimeSeriesCondition]) Source #
An array of conditions that define which members of the related time series are transformed.
WeightedQuantileLoss
data WeightedQuantileLoss Source #
The weighted loss value for a quantile. This object is part of the Metrics object.
See: newWeightedQuantileLoss smart constructor.
Constructors
| WeightedQuantileLoss' | |
Fields
| |
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: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.
$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.
weightedQuantileLoss_lossValue :: Lens' WeightedQuantileLoss (Maybe Double) Source #
The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.
weightedQuantileLoss_quantile :: Lens' WeightedQuantileLoss (Maybe Double) Source #
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.
WhatIfAnalysisSummary
data WhatIfAnalysisSummary Source #
Provides a summary of the what-if analysis properties used in the
ListWhatIfAnalyses operation. To get the complete set of properties,
call the DescribeWhatIfAnalysis operation, and provide the
WhatIfAnalysisArn that is listed in the summary.
See: newWhatIfAnalysisSummary smart constructor.
Constructors
| WhatIfAnalysisSummary' | |
Fields
| |
Instances
newWhatIfAnalysisSummary :: WhatIfAnalysisSummary Source #
Create a value of WhatIfAnalysisSummary 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:WhatIfAnalysisSummary', whatIfAnalysisSummary_creationTime - When the what-if analysis was created.
$sel:forecastArn:WhatIfAnalysisSummary', whatIfAnalysisSummary_forecastArn - The Amazon Resource Name (ARN) of the baseline forecast that is being
used in this what-if analysis.
$sel:lastModificationTime:WhatIfAnalysisSummary', whatIfAnalysisSummary_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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:WhatIfAnalysisSummary', whatIfAnalysisSummary_message - If an error occurred, an informational message about the error.
$sel:status:WhatIfAnalysisSummary', whatIfAnalysisSummary_status - The status of the what-if analysis. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
$sel:whatIfAnalysisArn:WhatIfAnalysisSummary', whatIfAnalysisSummary_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis.
$sel:whatIfAnalysisName:WhatIfAnalysisSummary', whatIfAnalysisSummary_whatIfAnalysisName - The name of the what-if analysis.
whatIfAnalysisSummary_creationTime :: Lens' WhatIfAnalysisSummary (Maybe UTCTime) Source #
When the what-if analysis was created.
whatIfAnalysisSummary_forecastArn :: Lens' WhatIfAnalysisSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.
whatIfAnalysisSummary_lastModificationTime :: Lens' WhatIfAnalysisSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
whatIfAnalysisSummary_message :: Lens' WhatIfAnalysisSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
whatIfAnalysisSummary_status :: Lens' WhatIfAnalysisSummary (Maybe Text) Source #
The status of the what-if analysis. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
whatIfAnalysisSummary_whatIfAnalysisArn :: Lens' WhatIfAnalysisSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis.
whatIfAnalysisSummary_whatIfAnalysisName :: Lens' WhatIfAnalysisSummary (Maybe Text) Source #
The name of the what-if analysis.
WhatIfForecastExportSummary
data WhatIfForecastExportSummary Source #
Provides a summary of the what-if forecast export properties used in the
ListWhatIfForecastExports operation. To get the complete set of
properties, call the DescribeWhatIfForecastExport operation, and provide
the WhatIfForecastExportArn that is listed in the summary.
See: newWhatIfForecastExportSummary smart constructor.
Constructors
| WhatIfForecastExportSummary' | |
Fields
| |
Instances
newWhatIfForecastExportSummary :: WhatIfForecastExportSummary Source #
Create a value of WhatIfForecastExportSummary 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:WhatIfForecastExportSummary', whatIfForecastExportSummary_creationTime - When the what-if forecast export was created.
$sel:destination:WhatIfForecastExportSummary', whatIfForecastExportSummary_destination - The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
$sel:lastModificationTime:WhatIfForecastExportSummary', whatIfForecastExportSummary_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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:WhatIfForecastExportSummary', whatIfForecastExportSummary_message - If an error occurred, an informational message about the error.
$sel:status:WhatIfForecastExportSummary', whatIfForecastExportSummary_status - The status of the what-if forecast export. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
$sel:whatIfForecastArns:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastArns - An array of Amazon Resource Names (ARNs) that define the what-if
forecasts included in the export.
$sel:whatIfForecastExportArn:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastExportArn - The Amazon Resource Name (ARN) of the what-if forecast export.
$sel:whatIfForecastExportName:WhatIfForecastExportSummary', whatIfForecastExportSummary_whatIfForecastExportName - The what-if forecast export name.
whatIfForecastExportSummary_creationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime) Source #
When the what-if forecast export was created.
whatIfForecastExportSummary_destination :: Lens' WhatIfForecastExportSummary (Maybe DataDestination) Source #
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
whatIfForecastExportSummary_lastModificationTime :: Lens' WhatIfForecastExportSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
whatIfForecastExportSummary_message :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
whatIfForecastExportSummary_status :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #
The status of the what-if forecast export. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
whatIfForecastExportSummary_whatIfForecastArns :: Lens' WhatIfForecastExportSummary (Maybe (NonEmpty Text)) Source #
An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
whatIfForecastExportSummary_whatIfForecastExportArn :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast export.
whatIfForecastExportSummary_whatIfForecastExportName :: Lens' WhatIfForecastExportSummary (Maybe Text) Source #
The what-if forecast export name.
WhatIfForecastSummary
data WhatIfForecastSummary Source #
Provides a summary of the what-if forecast properties used in the
ListWhatIfForecasts operation. To get the complete set of properties,
call the DescribeWhatIfForecast operation, and provide the
WhatIfForecastArn that is listed in the summary.
See: newWhatIfForecastSummary smart constructor.
Constructors
| WhatIfForecastSummary' | |
Fields
| |
Instances
newWhatIfForecastSummary :: WhatIfForecastSummary Source #
Create a value of WhatIfForecastSummary 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:WhatIfForecastSummary', whatIfForecastSummary_creationTime - When the what-if forecast was created.
$sel:lastModificationTime:WhatIfForecastSummary', whatIfForecastSummary_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.ACTIVEorCREATE_FAILED- When the job finished or failed.
$sel:message:WhatIfForecastSummary', whatIfForecastSummary_message - If an error occurred, an informational message about the error.
$sel:status:WhatIfForecastSummary', whatIfForecastSummary_status - The status of the what-if forecast. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
$sel:whatIfAnalysisArn:WhatIfForecastSummary', whatIfForecastSummary_whatIfAnalysisArn - The Amazon Resource Name (ARN) of the what-if analysis that contains
this what-if forecast.
$sel:whatIfForecastArn:WhatIfForecastSummary', whatIfForecastSummary_whatIfForecastArn - The Amazon Resource Name (ARN) of the what-if forecast.
$sel:whatIfForecastName:WhatIfForecastSummary', whatIfForecastSummary_whatIfForecastName - The name of the what-if forecast.
whatIfForecastSummary_creationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime) Source #
When the what-if forecast was created.
whatIfForecastSummary_lastModificationTime :: Lens' WhatIfForecastSummary (Maybe UTCTime) Source #
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.ACTIVEorCREATE_FAILED- When the job finished or failed.
whatIfForecastSummary_message :: Lens' WhatIfForecastSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
whatIfForecastSummary_status :: Lens' WhatIfForecastSummary (Maybe Text) Source #
The status of the what-if forecast. States include:
ACTIVE
CREATE_PENDING,CREATE_IN_PROGRESS,CREATE_FAILEDCREATE_STOPPING,CREATE_STOPPEDDELETE_PENDING,DELETE_IN_PROGRESS,DELETE_FAILED
The Status of the what-if analysis must be ACTIVE before you can
access the analysis.
whatIfForecastSummary_whatIfAnalysisArn :: Lens' WhatIfForecastSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.
whatIfForecastSummary_whatIfForecastArn :: Lens' WhatIfForecastSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
whatIfForecastSummary_whatIfForecastName :: Lens' WhatIfForecastSummary (Maybe Text) Source #
The name of the what-if forecast.
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.
Constructors
| WindowSummary' | |
Fields
| |
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:evaluationType:WindowSummary', windowSummary_evaluationType - The type of evaluation.
SUMMARY- The average metrics across all windows.COMPUTED- The metrics for the specified window.
$sel:itemCount:WindowSummary', windowSummary_itemCount - The number of data points within the window.
$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:testWindowStart:WindowSummary', windowSummary_testWindowStart - The timestamp that defines the start of the window.
windowSummary_evaluationType :: Lens' WindowSummary (Maybe EvaluationType) Source #
The type of evaluation.
SUMMARY- The average metrics across all windows.COMPUTED- The metrics for the specified window.
windowSummary_itemCount :: Lens' WindowSummary (Maybe Int) Source #
The number of data points within the window.
windowSummary_metrics :: Lens' WindowSummary (Maybe Metrics) Source #
Provides metrics used to evaluate the performance of a predictor.
windowSummary_testWindowEnd :: Lens' WindowSummary (Maybe UTCTime) Source #
The timestamp that defines the end of the window.
windowSummary_testWindowStart :: Lens' WindowSummary (Maybe UTCTime) Source #
The timestamp that defines the start of the window.