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 |
- Operations
- CreateAutoPredictor
- CreateDataset
- CreateDatasetGroup
- CreateDatasetImportJob
- CreateExplainability
- CreateExplainabilityExport
- CreateForecast
- CreateForecastExportJob
- CreateMonitor
- CreatePredictor
- CreatePredictorBacktestExportJob
- CreateWhatIfAnalysis
- CreateWhatIfForecast
- CreateWhatIfForecastExport
- DeleteDataset
- DeleteDatasetGroup
- DeleteDatasetImportJob
- DeleteExplainability
- DeleteExplainabilityExport
- DeleteForecast
- DeleteForecastExportJob
- DeleteMonitor
- DeletePredictor
- DeletePredictorBacktestExportJob
- DeleteResourceTree
- DeleteWhatIfAnalysis
- DeleteWhatIfForecast
- DeleteWhatIfForecastExport
- DescribeAutoPredictor
- DescribeDataset
- DescribeDatasetGroup
- DescribeDatasetImportJob
- DescribeExplainability
- DescribeExplainabilityExport
- DescribeForecast
- DescribeForecastExportJob
- DescribeMonitor
- DescribePredictor
- DescribePredictorBacktestExportJob
- DescribeWhatIfAnalysis
- DescribeWhatIfForecast
- DescribeWhatIfForecastExport
- GetAccuracyMetrics
- ListDatasetGroups
- ListDatasetImportJobs
- ListDatasets
- ListExplainabilities
- ListExplainabilityExports
- ListForecastExportJobs
- ListForecasts
- ListMonitorEvaluations
- ListMonitors
- ListPredictorBacktestExportJobs
- ListPredictors
- ListTagsForResource
- ListWhatIfAnalyses
- ListWhatIfForecastExports
- ListWhatIfForecasts
- ResumeResource
- StopResource
- TagResource
- UntagResource
- UpdateDatasetGroup
- Types
- 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
Synopsis
- createAutoPredictor_dataConfig :: Lens' CreateAutoPredictor (Maybe DataConfig)
- createAutoPredictor_encryptionConfig :: Lens' CreateAutoPredictor (Maybe EncryptionConfig)
- createAutoPredictor_explainPredictor :: Lens' CreateAutoPredictor (Maybe Bool)
- createAutoPredictor_forecastDimensions :: Lens' CreateAutoPredictor (Maybe (NonEmpty Text))
- createAutoPredictor_forecastFrequency :: Lens' CreateAutoPredictor (Maybe Text)
- createAutoPredictor_forecastHorizon :: Lens' CreateAutoPredictor (Maybe Int)
- createAutoPredictor_forecastTypes :: Lens' CreateAutoPredictor (Maybe (NonEmpty Text))
- createAutoPredictor_monitorConfig :: Lens' CreateAutoPredictor (Maybe MonitorConfig)
- createAutoPredictor_optimizationMetric :: Lens' CreateAutoPredictor (Maybe OptimizationMetric)
- createAutoPredictor_referencePredictorArn :: Lens' CreateAutoPredictor (Maybe Text)
- createAutoPredictor_tags :: Lens' CreateAutoPredictor (Maybe [Tag])
- createAutoPredictor_timeAlignmentBoundary :: Lens' CreateAutoPredictor (Maybe TimeAlignmentBoundary)
- createAutoPredictor_predictorName :: Lens' CreateAutoPredictor Text
- createAutoPredictorResponse_predictorArn :: Lens' CreateAutoPredictorResponse (Maybe Text)
- createAutoPredictorResponse_httpStatus :: Lens' CreateAutoPredictorResponse Int
- createDataset_dataFrequency :: Lens' CreateDataset (Maybe Text)
- createDataset_encryptionConfig :: Lens' CreateDataset (Maybe EncryptionConfig)
- createDataset_tags :: Lens' CreateDataset (Maybe [Tag])
- createDataset_datasetName :: Lens' CreateDataset Text
- createDataset_domain :: Lens' CreateDataset Domain
- createDataset_datasetType :: Lens' CreateDataset DatasetType
- createDataset_schema :: Lens' CreateDataset Schema
- createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
- createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int
- createDatasetGroup_datasetArns :: Lens' CreateDatasetGroup (Maybe [Text])
- createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag])
- createDatasetGroup_datasetGroupName :: Lens' CreateDatasetGroup Text
- createDatasetGroup_domain :: Lens' CreateDatasetGroup Domain
- createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text)
- createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int
- createDatasetImportJob_format :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_geolocationFormat :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag])
- createDatasetImportJob_timeZone :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_timestampFormat :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_useGeolocationForTimeZone :: Lens' CreateDatasetImportJob (Maybe Bool)
- createDatasetImportJob_datasetImportJobName :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource
- createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text)
- createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int
- createExplainability_dataSource :: Lens' CreateExplainability (Maybe DataSource)
- createExplainability_enableVisualization :: Lens' CreateExplainability (Maybe Bool)
- createExplainability_endDateTime :: Lens' CreateExplainability (Maybe Text)
- createExplainability_schema :: Lens' CreateExplainability (Maybe Schema)
- createExplainability_startDateTime :: Lens' CreateExplainability (Maybe Text)
- createExplainability_tags :: Lens' CreateExplainability (Maybe [Tag])
- createExplainability_explainabilityName :: Lens' CreateExplainability Text
- createExplainability_resourceArn :: Lens' CreateExplainability Text
- createExplainability_explainabilityConfig :: Lens' CreateExplainability ExplainabilityConfig
- createExplainabilityResponse_explainabilityArn :: Lens' CreateExplainabilityResponse (Maybe Text)
- createExplainabilityResponse_httpStatus :: Lens' CreateExplainabilityResponse Int
- createExplainabilityExport_format :: Lens' CreateExplainabilityExport (Maybe Text)
- createExplainabilityExport_tags :: Lens' CreateExplainabilityExport (Maybe [Tag])
- createExplainabilityExport_explainabilityExportName :: Lens' CreateExplainabilityExport Text
- createExplainabilityExport_explainabilityArn :: Lens' CreateExplainabilityExport Text
- createExplainabilityExport_destination :: Lens' CreateExplainabilityExport DataDestination
- createExplainabilityExportResponse_explainabilityExportArn :: Lens' CreateExplainabilityExportResponse (Maybe Text)
- createExplainabilityExportResponse_httpStatus :: Lens' CreateExplainabilityExportResponse Int
- createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text))
- createForecast_tags :: Lens' CreateForecast (Maybe [Tag])
- createForecast_timeSeriesSelector :: Lens' CreateForecast (Maybe TimeSeriesSelector)
- createForecast_forecastName :: Lens' CreateForecast Text
- createForecast_predictorArn :: Lens' CreateForecast Text
- createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text)
- createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int
- createForecastExportJob_format :: Lens' CreateForecastExportJob (Maybe Text)
- createForecastExportJob_tags :: Lens' CreateForecastExportJob (Maybe [Tag])
- createForecastExportJob_forecastExportJobName :: Lens' CreateForecastExportJob Text
- createForecastExportJob_forecastArn :: Lens' CreateForecastExportJob Text
- createForecastExportJob_destination :: Lens' CreateForecastExportJob DataDestination
- createForecastExportJobResponse_forecastExportJobArn :: Lens' CreateForecastExportJobResponse (Maybe Text)
- createForecastExportJobResponse_httpStatus :: Lens' CreateForecastExportJobResponse Int
- createMonitor_tags :: Lens' CreateMonitor (Maybe [Tag])
- createMonitor_monitorName :: Lens' CreateMonitor Text
- createMonitor_resourceArn :: Lens' CreateMonitor Text
- createMonitorResponse_monitorArn :: Lens' CreateMonitorResponse (Maybe Text)
- createMonitorResponse_httpStatus :: Lens' CreateMonitorResponse Int
- createPredictor_algorithmArn :: Lens' CreatePredictor (Maybe Text)
- createPredictor_autoMLOverrideStrategy :: Lens' CreatePredictor (Maybe AutoMLOverrideStrategy)
- createPredictor_encryptionConfig :: Lens' CreatePredictor (Maybe EncryptionConfig)
- createPredictor_evaluationParameters :: Lens' CreatePredictor (Maybe EvaluationParameters)
- createPredictor_forecastTypes :: Lens' CreatePredictor (Maybe (NonEmpty Text))
- createPredictor_hPOConfig :: Lens' CreatePredictor (Maybe HyperParameterTuningJobConfig)
- createPredictor_optimizationMetric :: Lens' CreatePredictor (Maybe OptimizationMetric)
- createPredictor_performAutoML :: Lens' CreatePredictor (Maybe Bool)
- createPredictor_performHPO :: Lens' CreatePredictor (Maybe Bool)
- createPredictor_tags :: Lens' CreatePredictor (Maybe [Tag])
- createPredictor_trainingParameters :: Lens' CreatePredictor (Maybe (HashMap Text Text))
- createPredictor_predictorName :: Lens' CreatePredictor Text
- createPredictor_forecastHorizon :: Lens' CreatePredictor Int
- createPredictor_inputDataConfig :: Lens' CreatePredictor InputDataConfig
- createPredictor_featurizationConfig :: Lens' CreatePredictor FeaturizationConfig
- createPredictorResponse_predictorArn :: Lens' CreatePredictorResponse (Maybe Text)
- createPredictorResponse_httpStatus :: Lens' CreatePredictorResponse Int
- createPredictorBacktestExportJob_format :: Lens' CreatePredictorBacktestExportJob (Maybe Text)
- createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag])
- createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination
- createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text)
- createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int
- createWhatIfAnalysis_tags :: Lens' CreateWhatIfAnalysis (Maybe [Tag])
- createWhatIfAnalysis_timeSeriesSelector :: Lens' CreateWhatIfAnalysis (Maybe TimeSeriesSelector)
- createWhatIfAnalysis_whatIfAnalysisName :: Lens' CreateWhatIfAnalysis Text
- createWhatIfAnalysis_forecastArn :: Lens' CreateWhatIfAnalysis Text
- createWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' CreateWhatIfAnalysisResponse (Maybe Text)
- createWhatIfAnalysisResponse_httpStatus :: Lens' CreateWhatIfAnalysisResponse Int
- createWhatIfForecast_tags :: Lens' CreateWhatIfForecast (Maybe [Tag])
- createWhatIfForecast_timeSeriesReplacementsDataSource :: Lens' CreateWhatIfForecast (Maybe TimeSeriesReplacementsDataSource)
- createWhatIfForecast_timeSeriesTransformations :: Lens' CreateWhatIfForecast (Maybe [TimeSeriesTransformation])
- createWhatIfForecast_whatIfForecastName :: Lens' CreateWhatIfForecast Text
- createWhatIfForecast_whatIfAnalysisArn :: Lens' CreateWhatIfForecast Text
- createWhatIfForecastResponse_whatIfForecastArn :: Lens' CreateWhatIfForecastResponse (Maybe Text)
- createWhatIfForecastResponse_httpStatus :: Lens' CreateWhatIfForecastResponse Int
- createWhatIfForecastExport_format :: Lens' CreateWhatIfForecastExport (Maybe Text)
- createWhatIfForecastExport_tags :: Lens' CreateWhatIfForecastExport (Maybe [Tag])
- createWhatIfForecastExport_whatIfForecastExportName :: Lens' CreateWhatIfForecastExport Text
- createWhatIfForecastExport_whatIfForecastArns :: Lens' CreateWhatIfForecastExport (NonEmpty Text)
- createWhatIfForecastExport_destination :: Lens' CreateWhatIfForecastExport DataDestination
- createWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' CreateWhatIfForecastExportResponse (Maybe Text)
- createWhatIfForecastExportResponse_httpStatus :: Lens' CreateWhatIfForecastExportResponse Int
- deleteDataset_datasetArn :: Lens' DeleteDataset Text
- deleteDatasetGroup_datasetGroupArn :: Lens' DeleteDatasetGroup Text
- deleteDatasetImportJob_datasetImportJobArn :: Lens' DeleteDatasetImportJob Text
- deleteExplainability_explainabilityArn :: Lens' DeleteExplainability Text
- deleteExplainabilityExport_explainabilityExportArn :: Lens' DeleteExplainabilityExport Text
- deleteForecast_forecastArn :: Lens' DeleteForecast Text
- deleteForecastExportJob_forecastExportJobArn :: Lens' DeleteForecastExportJob Text
- deleteMonitor_monitorArn :: Lens' DeleteMonitor Text
- deletePredictor_predictorArn :: Lens' DeletePredictor Text
- deletePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DeletePredictorBacktestExportJob Text
- deleteResourceTree_resourceArn :: Lens' DeleteResourceTree Text
- deleteWhatIfAnalysis_whatIfAnalysisArn :: Lens' DeleteWhatIfAnalysis Text
- deleteWhatIfForecast_whatIfForecastArn :: Lens' DeleteWhatIfForecast Text
- deleteWhatIfForecastExport_whatIfForecastExportArn :: Lens' DeleteWhatIfForecastExport Text
- describeAutoPredictor_predictorArn :: Lens' DescribeAutoPredictor Text
- describeAutoPredictorResponse_creationTime :: Lens' DescribeAutoPredictorResponse (Maybe UTCTime)
- describeAutoPredictorResponse_dataConfig :: Lens' DescribeAutoPredictorResponse (Maybe DataConfig)
- describeAutoPredictorResponse_datasetImportJobArns :: Lens' DescribeAutoPredictorResponse (Maybe [Text])
- describeAutoPredictorResponse_encryptionConfig :: Lens' DescribeAutoPredictorResponse (Maybe EncryptionConfig)
- describeAutoPredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeAutoPredictorResponse (Maybe Integer)
- describeAutoPredictorResponse_explainabilityInfo :: Lens' DescribeAutoPredictorResponse (Maybe ExplainabilityInfo)
- describeAutoPredictorResponse_forecastDimensions :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text))
- describeAutoPredictorResponse_forecastFrequency :: Lens' DescribeAutoPredictorResponse (Maybe Text)
- describeAutoPredictorResponse_forecastHorizon :: Lens' DescribeAutoPredictorResponse (Maybe Int)
- describeAutoPredictorResponse_forecastTypes :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text))
- describeAutoPredictorResponse_lastModificationTime :: Lens' DescribeAutoPredictorResponse (Maybe UTCTime)
- describeAutoPredictorResponse_message :: Lens' DescribeAutoPredictorResponse (Maybe Text)
- describeAutoPredictorResponse_monitorInfo :: Lens' DescribeAutoPredictorResponse (Maybe MonitorInfo)
- describeAutoPredictorResponse_optimizationMetric :: Lens' DescribeAutoPredictorResponse (Maybe OptimizationMetric)
- describeAutoPredictorResponse_predictorArn :: Lens' DescribeAutoPredictorResponse (Maybe Text)
- describeAutoPredictorResponse_predictorName :: Lens' DescribeAutoPredictorResponse (Maybe Text)
- describeAutoPredictorResponse_referencePredictorSummary :: Lens' DescribeAutoPredictorResponse (Maybe ReferencePredictorSummary)
- describeAutoPredictorResponse_status :: Lens' DescribeAutoPredictorResponse (Maybe Text)
- describeAutoPredictorResponse_timeAlignmentBoundary :: Lens' DescribeAutoPredictorResponse (Maybe TimeAlignmentBoundary)
- describeAutoPredictorResponse_httpStatus :: Lens' DescribeAutoPredictorResponse Int
- describeDataset_datasetArn :: Lens' DescribeDataset Text
- describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType)
- describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain)
- describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe EncryptionConfig)
- describeDatasetResponse_lastModificationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema)
- describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int
- describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text
- describeDatasetGroupResponse_creationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime)
- describeDatasetGroupResponse_datasetArns :: Lens' DescribeDatasetGroupResponse (Maybe [Text])
- describeDatasetGroupResponse_datasetGroupArn :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_datasetGroupName :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_domain :: Lens' DescribeDatasetGroupResponse (Maybe Domain)
- describeDatasetGroupResponse_lastModificationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime)
- describeDatasetGroupResponse_status :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_httpStatus :: Lens' DescribeDatasetGroupResponse Int
- describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text
- describeDatasetImportJobResponse_creationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime)
- describeDatasetImportJobResponse_dataSize :: Lens' DescribeDatasetImportJobResponse (Maybe Double)
- describeDatasetImportJobResponse_dataSource :: Lens' DescribeDatasetImportJobResponse (Maybe DataSource)
- describeDatasetImportJobResponse_datasetArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_datasetImportJobArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_datasetImportJobName :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeDatasetImportJobResponse (Maybe Integer)
- describeDatasetImportJobResponse_fieldStatistics :: Lens' DescribeDatasetImportJobResponse (Maybe (HashMap Text Statistics))
- describeDatasetImportJobResponse_format :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_geolocationFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_lastModificationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime)
- describeDatasetImportJobResponse_message :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_status :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_timeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_timestampFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_useGeolocationForTimeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Bool)
- describeDatasetImportJobResponse_httpStatus :: Lens' DescribeDatasetImportJobResponse Int
- describeExplainability_explainabilityArn :: Lens' DescribeExplainability Text
- describeExplainabilityResponse_creationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime)
- describeExplainabilityResponse_dataSource :: Lens' DescribeExplainabilityResponse (Maybe DataSource)
- describeExplainabilityResponse_enableVisualization :: Lens' DescribeExplainabilityResponse (Maybe Bool)
- describeExplainabilityResponse_endDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeExplainabilityResponse (Maybe Integer)
- describeExplainabilityResponse_explainabilityArn :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_explainabilityConfig :: Lens' DescribeExplainabilityResponse (Maybe ExplainabilityConfig)
- describeExplainabilityResponse_explainabilityName :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_lastModificationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime)
- describeExplainabilityResponse_message :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_resourceArn :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_schema :: Lens' DescribeExplainabilityResponse (Maybe Schema)
- describeExplainabilityResponse_startDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_status :: Lens' DescribeExplainabilityResponse (Maybe Text)
- describeExplainabilityResponse_httpStatus :: Lens' DescribeExplainabilityResponse Int
- describeExplainabilityExport_explainabilityExportArn :: Lens' DescribeExplainabilityExport Text
- describeExplainabilityExportResponse_creationTime :: Lens' DescribeExplainabilityExportResponse (Maybe UTCTime)
- describeExplainabilityExportResponse_destination :: Lens' DescribeExplainabilityExportResponse (Maybe DataDestination)
- describeExplainabilityExportResponse_explainabilityArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_explainabilityExportArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_explainabilityExportName :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_format :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_lastModificationTime :: Lens' DescribeExplainabilityExportResponse (Maybe UTCTime)
- describeExplainabilityExportResponse_message :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_status :: Lens' DescribeExplainabilityExportResponse (Maybe Text)
- describeExplainabilityExportResponse_httpStatus :: Lens' DescribeExplainabilityExportResponse Int
- describeForecast_forecastArn :: Lens' DescribeForecast Text
- describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime)
- describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer)
- describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_forecastTypes :: Lens' DescribeForecastResponse (Maybe (NonEmpty Text))
- describeForecastResponse_lastModificationTime :: Lens' DescribeForecastResponse (Maybe UTCTime)
- describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_predictorArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_timeSeriesSelector :: Lens' DescribeForecastResponse (Maybe TimeSeriesSelector)
- describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int
- describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text
- describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime)
- describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination)
- describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_format :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime)
- describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int
- describeMonitor_monitorArn :: Lens' DescribeMonitor Text
- describeMonitorResponse_baseline :: Lens' DescribeMonitorResponse (Maybe Baseline)
- describeMonitorResponse_creationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
- describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes :: Lens' DescribeMonitorResponse (Maybe Integer)
- describeMonitorResponse_lastEvaluationState :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_lastEvaluationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
- describeMonitorResponse_lastModificationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime)
- describeMonitorResponse_message :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_monitorArn :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_monitorName :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_resourceArn :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_status :: Lens' DescribeMonitorResponse (Maybe Text)
- describeMonitorResponse_httpStatus :: Lens' DescribeMonitorResponse Int
- describePredictor_predictorArn :: Lens' DescribePredictor Text
- describePredictorResponse_algorithmArn :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_autoMLAlgorithmArns :: Lens' DescribePredictorResponse (Maybe [Text])
- describePredictorResponse_autoMLOverrideStrategy :: Lens' DescribePredictorResponse (Maybe AutoMLOverrideStrategy)
- describePredictorResponse_creationTime :: Lens' DescribePredictorResponse (Maybe UTCTime)
- describePredictorResponse_datasetImportJobArns :: Lens' DescribePredictorResponse (Maybe [Text])
- describePredictorResponse_encryptionConfig :: Lens' DescribePredictorResponse (Maybe EncryptionConfig)
- describePredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribePredictorResponse (Maybe Integer)
- describePredictorResponse_evaluationParameters :: Lens' DescribePredictorResponse (Maybe EvaluationParameters)
- describePredictorResponse_featurizationConfig :: Lens' DescribePredictorResponse (Maybe FeaturizationConfig)
- describePredictorResponse_forecastHorizon :: Lens' DescribePredictorResponse (Maybe Int)
- describePredictorResponse_forecastTypes :: Lens' DescribePredictorResponse (Maybe (NonEmpty Text))
- describePredictorResponse_hPOConfig :: Lens' DescribePredictorResponse (Maybe HyperParameterTuningJobConfig)
- describePredictorResponse_inputDataConfig :: Lens' DescribePredictorResponse (Maybe InputDataConfig)
- describePredictorResponse_isAutoPredictor :: Lens' DescribePredictorResponse (Maybe Bool)
- describePredictorResponse_lastModificationTime :: Lens' DescribePredictorResponse (Maybe UTCTime)
- describePredictorResponse_message :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_optimizationMetric :: Lens' DescribePredictorResponse (Maybe OptimizationMetric)
- describePredictorResponse_performAutoML :: Lens' DescribePredictorResponse (Maybe Bool)
- describePredictorResponse_performHPO :: Lens' DescribePredictorResponse (Maybe Bool)
- describePredictorResponse_predictorArn :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_predictorExecutionDetails :: Lens' DescribePredictorResponse (Maybe PredictorExecutionDetails)
- describePredictorResponse_predictorName :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_status :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_trainingParameters :: Lens' DescribePredictorResponse (Maybe (HashMap Text Text))
- describePredictorResponse_httpStatus :: Lens' DescribePredictorResponse Int
- describePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJob Text
- describePredictorBacktestExportJobResponse_creationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime)
- describePredictorBacktestExportJobResponse_destination :: Lens' DescribePredictorBacktestExportJobResponse (Maybe DataDestination)
- describePredictorBacktestExportJobResponse_format :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_lastModificationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime)
- describePredictorBacktestExportJobResponse_message :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_predictorArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_predictorBacktestExportJobName :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_status :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_httpStatus :: Lens' DescribePredictorBacktestExportJobResponse Int
- describeWhatIfAnalysis_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysis Text
- describeWhatIfAnalysisResponse_creationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime)
- describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfAnalysisResponse (Maybe Integer)
- describeWhatIfAnalysisResponse_forecastArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_lastModificationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime)
- describeWhatIfAnalysisResponse_message :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_status :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_timeSeriesSelector :: Lens' DescribeWhatIfAnalysisResponse (Maybe TimeSeriesSelector)
- describeWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_whatIfAnalysisName :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text)
- describeWhatIfAnalysisResponse_httpStatus :: Lens' DescribeWhatIfAnalysisResponse Int
- describeWhatIfForecast_whatIfForecastArn :: Lens' DescribeWhatIfForecast Text
- describeWhatIfForecastResponse_creationTime :: Lens' DescribeWhatIfForecastResponse (Maybe UTCTime)
- describeWhatIfForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastResponse (Maybe Integer)
- describeWhatIfForecastResponse_forecastTypes :: Lens' DescribeWhatIfForecastResponse (Maybe (NonEmpty Text))
- describeWhatIfForecastResponse_lastModificationTime :: Lens' DescribeWhatIfForecastResponse (Maybe UTCTime)
- describeWhatIfForecastResponse_message :: Lens' DescribeWhatIfForecastResponse (Maybe Text)
- describeWhatIfForecastResponse_status :: Lens' DescribeWhatIfForecastResponse (Maybe Text)
- describeWhatIfForecastResponse_timeSeriesReplacementsDataSource :: Lens' DescribeWhatIfForecastResponse (Maybe TimeSeriesReplacementsDataSource)
- describeWhatIfForecastResponse_timeSeriesTransformations :: Lens' DescribeWhatIfForecastResponse (Maybe [TimeSeriesTransformation])
- describeWhatIfForecastResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text)
- describeWhatIfForecastResponse_whatIfForecastArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text)
- describeWhatIfForecastResponse_whatIfForecastName :: Lens' DescribeWhatIfForecastResponse (Maybe Text)
- describeWhatIfForecastResponse_httpStatus :: Lens' DescribeWhatIfForecastResponse Int
- describeWhatIfForecastExport_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExport Text
- describeWhatIfForecastExportResponse_creationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)
- describeWhatIfForecastExportResponse_destination :: Lens' DescribeWhatIfForecastExportResponse (Maybe DataDestination)
- describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastExportResponse (Maybe Integer)
- describeWhatIfForecastExportResponse_format :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_lastModificationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime)
- describeWhatIfForecastExportResponse_message :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_status :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_whatIfForecastArns :: Lens' DescribeWhatIfForecastExportResponse (Maybe [Text])
- describeWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_whatIfForecastExportName :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text)
- describeWhatIfForecastExportResponse_httpStatus :: Lens' DescribeWhatIfForecastExportResponse Int
- getAccuracyMetrics_predictorArn :: Lens' GetAccuracyMetrics Text
- getAccuracyMetricsResponse_autoMLOverrideStrategy :: Lens' GetAccuracyMetricsResponse (Maybe AutoMLOverrideStrategy)
- getAccuracyMetricsResponse_isAutoPredictor :: Lens' GetAccuracyMetricsResponse (Maybe Bool)
- getAccuracyMetricsResponse_optimizationMetric :: Lens' GetAccuracyMetricsResponse (Maybe OptimizationMetric)
- getAccuracyMetricsResponse_predictorEvaluationResults :: Lens' GetAccuracyMetricsResponse (Maybe [EvaluationResult])
- getAccuracyMetricsResponse_httpStatus :: Lens' GetAccuracyMetricsResponse Int
- listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural)
- listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text)
- listDatasetGroupsResponse_datasetGroups :: Lens' ListDatasetGroupsResponse (Maybe [DatasetGroupSummary])
- listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text)
- listDatasetGroupsResponse_httpStatus :: Lens' ListDatasetGroupsResponse Int
- listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (Maybe [Filter])
- listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural)
- listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text)
- listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary])
- listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text)
- listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int
- listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural)
- listDatasets_nextToken :: Lens' ListDatasets (Maybe Text)
- listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary])
- listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text)
- listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int
- listExplainabilities_filters :: Lens' ListExplainabilities (Maybe [Filter])
- listExplainabilities_maxResults :: Lens' ListExplainabilities (Maybe Natural)
- listExplainabilities_nextToken :: Lens' ListExplainabilities (Maybe Text)
- listExplainabilitiesResponse_explainabilities :: Lens' ListExplainabilitiesResponse (Maybe [ExplainabilitySummary])
- listExplainabilitiesResponse_nextToken :: Lens' ListExplainabilitiesResponse (Maybe Text)
- listExplainabilitiesResponse_httpStatus :: Lens' ListExplainabilitiesResponse Int
- listExplainabilityExports_filters :: Lens' ListExplainabilityExports (Maybe [Filter])
- listExplainabilityExports_maxResults :: Lens' ListExplainabilityExports (Maybe Natural)
- listExplainabilityExports_nextToken :: Lens' ListExplainabilityExports (Maybe Text)
- listExplainabilityExportsResponse_explainabilityExports :: Lens' ListExplainabilityExportsResponse (Maybe [ExplainabilityExportSummary])
- listExplainabilityExportsResponse_nextToken :: Lens' ListExplainabilityExportsResponse (Maybe Text)
- listExplainabilityExportsResponse_httpStatus :: Lens' ListExplainabilityExportsResponse Int
- listForecastExportJobs_filters :: Lens' ListForecastExportJobs (Maybe [Filter])
- listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural)
- listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (Maybe Text)
- listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary])
- listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text)
- listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int
- listForecasts_filters :: Lens' ListForecasts (Maybe [Filter])
- listForecasts_maxResults :: Lens' ListForecasts (Maybe Natural)
- listForecasts_nextToken :: Lens' ListForecasts (Maybe Text)
- listForecastsResponse_forecasts :: Lens' ListForecastsResponse (Maybe [ForecastSummary])
- listForecastsResponse_nextToken :: Lens' ListForecastsResponse (Maybe Text)
- listForecastsResponse_httpStatus :: Lens' ListForecastsResponse Int
- listMonitorEvaluations_filters :: Lens' ListMonitorEvaluations (Maybe [Filter])
- listMonitorEvaluations_maxResults :: Lens' ListMonitorEvaluations (Maybe Natural)
- listMonitorEvaluations_nextToken :: Lens' ListMonitorEvaluations (Maybe Text)
- listMonitorEvaluations_monitorArn :: Lens' ListMonitorEvaluations Text
- listMonitorEvaluationsResponse_nextToken :: Lens' ListMonitorEvaluationsResponse (Maybe Text)
- listMonitorEvaluationsResponse_predictorMonitorEvaluations :: Lens' ListMonitorEvaluationsResponse (Maybe [PredictorMonitorEvaluation])
- listMonitorEvaluationsResponse_httpStatus :: Lens' ListMonitorEvaluationsResponse Int
- listMonitors_filters :: Lens' ListMonitors (Maybe [Filter])
- listMonitors_maxResults :: Lens' ListMonitors (Maybe Natural)
- listMonitors_nextToken :: Lens' ListMonitors (Maybe Text)
- listMonitorsResponse_monitors :: Lens' ListMonitorsResponse (Maybe [MonitorSummary])
- listMonitorsResponse_nextToken :: Lens' ListMonitorsResponse (Maybe Text)
- listMonitorsResponse_httpStatus :: Lens' ListMonitorsResponse Int
- listPredictorBacktestExportJobs_filters :: Lens' ListPredictorBacktestExportJobs (Maybe [Filter])
- listPredictorBacktestExportJobs_maxResults :: Lens' ListPredictorBacktestExportJobs (Maybe Natural)
- listPredictorBacktestExportJobs_nextToken :: Lens' ListPredictorBacktestExportJobs (Maybe Text)
- listPredictorBacktestExportJobsResponse_nextToken :: Lens' ListPredictorBacktestExportJobsResponse (Maybe Text)
- listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs :: Lens' ListPredictorBacktestExportJobsResponse (Maybe [PredictorBacktestExportJobSummary])
- listPredictorBacktestExportJobsResponse_httpStatus :: Lens' ListPredictorBacktestExportJobsResponse Int
- listPredictors_filters :: Lens' ListPredictors (Maybe [Filter])
- listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural)
- listPredictors_nextToken :: Lens' ListPredictors (Maybe Text)
- listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text)
- listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary])
- listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- listWhatIfAnalyses_filters :: Lens' ListWhatIfAnalyses (Maybe [Filter])
- listWhatIfAnalyses_maxResults :: Lens' ListWhatIfAnalyses (Maybe Natural)
- listWhatIfAnalyses_nextToken :: Lens' ListWhatIfAnalyses (Maybe Text)
- listWhatIfAnalysesResponse_nextToken :: Lens' ListWhatIfAnalysesResponse (Maybe Text)
- listWhatIfAnalysesResponse_whatIfAnalyses :: Lens' ListWhatIfAnalysesResponse (Maybe [WhatIfAnalysisSummary])
- listWhatIfAnalysesResponse_httpStatus :: Lens' ListWhatIfAnalysesResponse Int
- listWhatIfForecastExports_filters :: Lens' ListWhatIfForecastExports (Maybe [Filter])
- listWhatIfForecastExports_maxResults :: Lens' ListWhatIfForecastExports (Maybe Natural)
- listWhatIfForecastExports_nextToken :: Lens' ListWhatIfForecastExports (Maybe Text)
- listWhatIfForecastExportsResponse_nextToken :: Lens' ListWhatIfForecastExportsResponse (Maybe Text)
- listWhatIfForecastExportsResponse_whatIfForecastExports :: Lens' ListWhatIfForecastExportsResponse (Maybe [WhatIfForecastExportSummary])
- listWhatIfForecastExportsResponse_httpStatus :: Lens' ListWhatIfForecastExportsResponse Int
- listWhatIfForecasts_filters :: Lens' ListWhatIfForecasts (Maybe [Filter])
- listWhatIfForecasts_maxResults :: Lens' ListWhatIfForecasts (Maybe Natural)
- listWhatIfForecasts_nextToken :: Lens' ListWhatIfForecasts (Maybe Text)
- listWhatIfForecastsResponse_nextToken :: Lens' ListWhatIfForecastsResponse (Maybe Text)
- listWhatIfForecastsResponse_whatIfForecasts :: Lens' ListWhatIfForecastsResponse (Maybe [WhatIfForecastSummary])
- listWhatIfForecastsResponse_httpStatus :: Lens' ListWhatIfForecastsResponse Int
- resumeResource_resourceArn :: Lens' ResumeResource Text
- stopResource_resourceArn :: Lens' StopResource Text
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateDatasetGroup_datasetGroupArn :: Lens' UpdateDatasetGroup Text
- updateDatasetGroup_datasetArns :: Lens' UpdateDatasetGroup [Text]
- updateDatasetGroupResponse_httpStatus :: Lens' UpdateDatasetGroupResponse Int
- action_attributeName :: Lens' Action Text
- action_operation :: Lens' Action Operation
- action_value :: Lens' Action Double
- additionalDataset_configuration :: Lens' AdditionalDataset (Maybe (HashMap Text (NonEmpty Text)))
- additionalDataset_name :: Lens' AdditionalDataset Text
- attributeConfig_attributeName :: Lens' AttributeConfig Text
- attributeConfig_transformations :: Lens' AttributeConfig (HashMap Text Text)
- baseline_predictorBaseline :: Lens' Baseline (Maybe PredictorBaseline)
- baselineMetric_name :: Lens' BaselineMetric (Maybe Text)
- baselineMetric_value :: Lens' BaselineMetric (Maybe Double)
- categoricalParameterRange_name :: Lens' CategoricalParameterRange Text
- categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text)
- continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe ScalingType)
- continuousParameterRange_name :: Lens' ContinuousParameterRange Text
- continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Double
- continuousParameterRange_minValue :: Lens' ContinuousParameterRange Double
- dataConfig_additionalDatasets :: Lens' DataConfig (Maybe (NonEmpty AdditionalDataset))
- dataConfig_attributeConfigs :: Lens' DataConfig (Maybe (NonEmpty AttributeConfig))
- dataConfig_datasetGroupArn :: Lens' DataConfig Text
- dataDestination_s3Config :: Lens' DataDestination S3Config
- dataSource_s3Config :: Lens' DataSource S3Config
- datasetGroupSummary_creationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_datasetGroupName :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_lastModificationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- 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)
- 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)
- encryptionConfig_roleArn :: Lens' EncryptionConfig Text
- encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text
- 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)
- evaluationParameters_backTestWindowOffset :: Lens' EvaluationParameters (Maybe Int)
- evaluationParameters_numberOfBacktestWindows :: Lens' EvaluationParameters (Maybe Int)
- evaluationResult_algorithmArn :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_testWindows :: Lens' EvaluationResult (Maybe [WindowSummary])
- explainabilityConfig_timeSeriesGranularity :: Lens' ExplainabilityConfig TimeSeriesGranularity
- explainabilityConfig_timePointGranularity :: Lens' ExplainabilityConfig TimePointGranularity
- 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)
- explainabilityInfo_explainabilityArn :: Lens' ExplainabilityInfo (Maybe Text)
- explainabilityInfo_status :: Lens' ExplainabilityInfo (Maybe Text)
- 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)
- featurization_featurizationPipeline :: Lens' Featurization (Maybe (NonEmpty FeaturizationMethod))
- featurization_attributeName :: Lens' Featurization Text
- featurizationConfig_featurizations :: Lens' FeaturizationConfig (Maybe (NonEmpty Featurization))
- featurizationConfig_forecastDimensions :: Lens' FeaturizationConfig (Maybe (NonEmpty Text))
- featurizationConfig_forecastFrequency :: Lens' FeaturizationConfig Text
- featurizationMethod_featurizationMethodParameters :: Lens' FeaturizationMethod (Maybe (HashMap Text Text))
- featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName
- filter_key :: Lens' Filter Text
- filter_value :: Lens' Filter Text
- filter_condition :: Lens' Filter FilterConditionString
- 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)
- 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)
- hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges)
- inputDataConfig_supplementaryFeatures :: Lens' InputDataConfig (Maybe (NonEmpty SupplementaryFeature))
- inputDataConfig_datasetGroupArn :: Lens' InputDataConfig Text
- integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType)
- integerParameterRange_name :: Lens' IntegerParameterRange Text
- integerParameterRange_maxValue :: Lens' IntegerParameterRange Int
- integerParameterRange_minValue :: Lens' IntegerParameterRange Int
- metricResult_metricName :: Lens' MetricResult (Maybe Text)
- metricResult_metricValue :: Lens' MetricResult (Maybe Double)
- metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double)
- metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric])
- metrics_rmse :: Lens' Metrics (Maybe Double)
- metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss])
- monitorConfig_monitorName :: Lens' MonitorConfig Text
- monitorDataSource_datasetImportJobArn :: Lens' MonitorDataSource (Maybe Text)
- monitorDataSource_forecastArn :: Lens' MonitorDataSource (Maybe Text)
- monitorDataSource_predictorArn :: Lens' MonitorDataSource (Maybe Text)
- monitorInfo_monitorArn :: Lens' MonitorInfo (Maybe Text)
- monitorInfo_status :: Lens' MonitorInfo (Maybe Text)
- 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)
- parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty CategoricalParameterRange))
- parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty ContinuousParameterRange))
- parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty IntegerParameterRange))
- 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)
- predictorBaseline_baselineMetrics :: Lens' PredictorBaseline (Maybe [BaselineMetric])
- predictorEvent_datetime :: Lens' PredictorEvent (Maybe UTCTime)
- predictorEvent_detail :: Lens' PredictorEvent (Maybe Text)
- predictorExecution_algorithmArn :: Lens' PredictorExecution (Maybe Text)
- predictorExecution_testWindows :: Lens' PredictorExecution (Maybe [TestWindowSummary])
- predictorExecutionDetails_predictorExecutions :: Lens' PredictorExecutionDetails (Maybe (NonEmpty PredictorExecution))
- 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)
- 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)
- referencePredictorSummary_arn :: Lens' ReferencePredictorSummary (Maybe Text)
- referencePredictorSummary_state :: Lens' ReferencePredictorSummary (Maybe State)
- s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text)
- s3Config_path :: Lens' S3Config Text
- s3Config_roleArn :: Lens' S3Config Text
- schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute))
- schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text)
- schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType)
- 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)
- supplementaryFeature_name :: Lens' SupplementaryFeature Text
- supplementaryFeature_value :: Lens' SupplementaryFeature Text
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- testWindowSummary_message :: Lens' TestWindowSummary (Maybe Text)
- testWindowSummary_status :: Lens' TestWindowSummary (Maybe Text)
- testWindowSummary_testWindowEnd :: Lens' TestWindowSummary (Maybe UTCTime)
- testWindowSummary_testWindowStart :: Lens' TestWindowSummary (Maybe UTCTime)
- timeAlignmentBoundary_dayOfMonth :: Lens' TimeAlignmentBoundary (Maybe Natural)
- timeAlignmentBoundary_dayOfWeek :: Lens' TimeAlignmentBoundary (Maybe DayOfWeek)
- timeAlignmentBoundary_hour :: Lens' TimeAlignmentBoundary (Maybe Natural)
- timeAlignmentBoundary_month :: Lens' TimeAlignmentBoundary (Maybe Month)
- timeSeriesCondition_attributeName :: Lens' TimeSeriesCondition Text
- timeSeriesCondition_attributeValue :: Lens' TimeSeriesCondition Text
- timeSeriesCondition_condition :: Lens' TimeSeriesCondition Condition
- timeSeriesIdentifiers_dataSource :: Lens' TimeSeriesIdentifiers (Maybe DataSource)
- timeSeriesIdentifiers_format :: Lens' TimeSeriesIdentifiers (Maybe Text)
- timeSeriesIdentifiers_schema :: Lens' TimeSeriesIdentifiers (Maybe Schema)
- timeSeriesReplacementsDataSource_format :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
- timeSeriesReplacementsDataSource_timestampFormat :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
- timeSeriesReplacementsDataSource_s3Config :: Lens' TimeSeriesReplacementsDataSource S3Config
- timeSeriesReplacementsDataSource_schema :: Lens' TimeSeriesReplacementsDataSource Schema
- timeSeriesSelector_timeSeriesIdentifiers :: Lens' TimeSeriesSelector (Maybe TimeSeriesIdentifiers)
- timeSeriesTransformation_action :: Lens' TimeSeriesTransformation (Maybe Action)
- timeSeriesTransformation_timeSeriesConditions :: Lens' TimeSeriesTransformation (Maybe [TimeSeriesCondition])
- weightedQuantileLoss_lossValue :: Lens' WeightedQuantileLoss (Maybe Double)
- weightedQuantileLoss_quantile :: Lens' WeightedQuantileLoss (Maybe Double)
- 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)
- 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)
- 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)
- 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)
Operations
CreateAutoPredictor
createAutoPredictor_dataConfig :: Lens' CreateAutoPredictor (Maybe DataConfig) Source #
The data configuration for your dataset group and any additional datasets.
createAutoPredictor_encryptionConfig :: Lens' CreateAutoPredictor (Maybe EncryptionConfig) Source #
Undocumented member.
createAutoPredictor_explainPredictor :: Lens' CreateAutoPredictor (Maybe Bool) Source #
Create an Explainability resource for the predictor.
createAutoPredictor_forecastDimensions :: Lens' CreateAutoPredictor (Maybe (NonEmpty Text)) Source #
An array of dimension (field) names that specify how to group the generated forecast.
For example, if you are generating forecasts for item sales across all
your stores, and your dataset contains a store_id
field, you would
specify store_id
as a dimension to group sales forecasts for each
store.
createAutoPredictor_forecastFrequency :: Lens' CreateAutoPredictor (Maybe 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.
createAutoPredictor_forecastHorizon :: Lens' CreateAutoPredictor (Maybe Int) Source #
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
The maximum forecast horizon is the lesser of 500 time-steps or 1/4 of the TARGET_TIME_SERIES dataset length. If you are retraining an existing AutoPredictor, then the maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
If you are upgrading to an AutoPredictor or retraining an existing AutoPredictor, you cannot update the forecast horizon parameter. You can meet this requirement by providing longer time-series in the dataset.
createAutoPredictor_forecastTypes :: Lens' CreateAutoPredictor (Maybe (NonEmpty Text)) Source #
The forecast types used to train a predictor. You can specify up to five
forecast types. Forecast types can be quantiles from 0.01 to 0.99, by
increments of 0.01 or higher. You can also specify the mean forecast
with mean
.
createAutoPredictor_monitorConfig :: Lens' CreateAutoPredictor (Maybe MonitorConfig) Source #
The configuration details for predictor monitoring. Provide a name for the monitor resource to enable predictor monitoring.
Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.
createAutoPredictor_optimizationMetric :: Lens' CreateAutoPredictor (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
createAutoPredictor_referencePredictorArn :: Lens' CreateAutoPredictor (Maybe Text) Source #
The ARN of the predictor to retrain or upgrade. This parameter is only used when retraining or upgrading a predictor. When creating a new predictor, do not specify a value for this parameter.
When upgrading or retraining a predictor, only specify values for the
ReferencePredictorArn
and PredictorName
. The value for
PredictorName
must be a unique predictor name.
createAutoPredictor_tags :: Lens' CreateAutoPredictor (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createAutoPredictor_timeAlignmentBoundary :: Lens' CreateAutoPredictor (Maybe TimeAlignmentBoundary) Source #
The time boundary Forecast uses to align and aggregate any data that doesn't align with your forecast frequency. Provide the unit of time and the time boundary as a key value pair. For more information on specifying a time boundary, see Specifying a Time Boundary. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
createAutoPredictor_predictorName :: Lens' CreateAutoPredictor Text Source #
A unique name for the predictor
createAutoPredictorResponse_predictorArn :: Lens' CreateAutoPredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor.
createAutoPredictorResponse_httpStatus :: Lens' CreateAutoPredictorResponse Int Source #
The response's http status code.
CreateDataset
createDataset_dataFrequency :: Lens' CreateDataset (Maybe Text) Source #
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.
createDataset_encryptionConfig :: Lens' CreateDataset (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
createDataset_tags :: Lens' CreateDataset (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDataset_datasetName :: Lens' CreateDataset Text Source #
A name for the dataset.
createDataset_domain :: Lens' CreateDataset Domain Source #
The domain associated with the dataset. When you add a dataset to a
dataset group, this value and the value specified for the Domain
parameter of the
CreateDatasetGroup
operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in the training data that you import to the dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires item_id
, timestamp
, and
demand
fields to be present in your data. For more information, see
Importing datasets.
createDataset_datasetType :: Lens' CreateDataset DatasetType Source #
The dataset type. Valid values depend on the chosen Domain
.
createDataset_schema :: Lens' CreateDataset Schema Source #
The schema for the dataset. The schema attributes and their order must
match the fields in your data. The dataset Domain
and DatasetType
that you choose determine the minimum required fields in your training
data. For information about the required fields for a specific dataset
domain and type, see
Dataset Domains and Dataset Types.
createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #
The response's http status code.
CreateDatasetGroup
createDatasetGroup_datasetArns :: Lens' CreateDatasetGroup (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDatasetGroup_datasetGroupName :: Lens' CreateDatasetGroup Text Source #
A name for the dataset group.
createDatasetGroup_domain :: Lens' CreateDatasetGroup Domain Source #
The domain associated with the dataset group. When you add a dataset to
a dataset group, this value and the value specified for the Domain
parameter of the
CreateDataset
operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in training data that you import to a dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires that item_id
, timestamp
,
and demand
fields are present in your data. For more information, see
Dataset groups.
createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int Source #
The response's http status code.
CreateDatasetImportJob
createDatasetImportJob_format :: Lens' CreateDatasetImportJob (Maybe Text) Source #
The format of the imported data, CSV or PARQUET. The default value is CSV.
createDatasetImportJob_geolocationFormat :: Lens' CreateDatasetImportJob (Maybe Text) Source #
The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:
LAT_LONG
- the latitude and longitude in decimal format (Example: 47.61_-122.33).CC_POSTALCODE
(US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).
createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDatasetImportJob_timeZone :: Lens' CreateDatasetImportJob (Maybe Text) Source #
A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.
Refer to the Joda-Time API for a complete list of valid time zone names.
createDatasetImportJob_timestampFormat :: Lens' CreateDatasetImportJob (Maybe Text) Source #
The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
createDatasetImportJob_useGeolocationForTimeZone :: Lens' CreateDatasetImportJob (Maybe Bool) Source #
Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.
createDatasetImportJob_datasetImportJobName :: Lens' CreateDatasetImportJob Text Source #
The name for the dataset import job. We recommend including the current
timestamp in the name, for example, 20190721DatasetImport
. This can
help you avoid getting a ResourceAlreadyExistsException
exception.
createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob 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
must include an AWS Key Management
Service (KMS) key and the IAM role must allow Amazon Forecast permission
to access the key. The KMS key and IAM role must match those specified
in the EncryptionConfig
parameter of the
CreateDataset
operation.
createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job.
createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int Source #
The response's http status code.
CreateExplainability
createExplainability_dataSource :: Lens' CreateExplainability (Maybe DataSource) Source #
Undocumented member.
createExplainability_enableVisualization :: Lens' CreateExplainability (Maybe Bool) Source #
Create an Explainability visualization that is viewable within the AWS console.
createExplainability_endDateTime :: Lens' CreateExplainability (Maybe Text) Source #
If TimePointGranularity
is set to SPECIFIC
, define the last time
point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
createExplainability_schema :: Lens' CreateExplainability (Maybe Schema) Source #
Undocumented member.
createExplainability_startDateTime :: Lens' CreateExplainability (Maybe Text) Source #
If TimePointGranularity
is set to SPECIFIC
, define the first point
for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
createExplainability_tags :: Lens' CreateExplainability (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createExplainability_explainabilityName :: Lens' CreateExplainability Text Source #
A unique name for the Explainability.
createExplainability_resourceArn :: Lens' CreateExplainability Text Source #
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.
createExplainability_explainabilityConfig :: Lens' CreateExplainability ExplainabilityConfig Source #
The configuration settings that define the granularity of time series and time points for the Explainability.
createExplainabilityResponse_explainabilityArn :: Lens' CreateExplainabilityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability.
createExplainabilityResponse_httpStatus :: Lens' CreateExplainabilityResponse Int Source #
The response's http status code.
CreateExplainabilityExport
createExplainabilityExport_format :: Lens' CreateExplainabilityExport (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
createExplainabilityExport_tags :: Lens' CreateExplainabilityExport (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createExplainabilityExport_explainabilityExportName :: Lens' CreateExplainabilityExport Text Source #
A unique name for the Explainability export.
createExplainabilityExport_explainabilityArn :: Lens' CreateExplainabilityExport Text Source #
The Amazon Resource Name (ARN) of the Explainability to export.
createExplainabilityExport_destination :: Lens' CreateExplainabilityExport DataDestination Source #
Undocumented member.
createExplainabilityExportResponse_explainabilityExportArn :: Lens' CreateExplainabilityExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the export.
createExplainabilityExportResponse_httpStatus :: Lens' CreateExplainabilityExportResponse Int Source #
The response's http status code.
CreateForecast
createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text)) Source #
The quantiles at which probabilistic forecasts are generated. __You can
currently specify up to 5 quantiles per forecast__. Accepted values
include 0.01 to 0.99
(increments of .01 only) and mean
. The mean
forecast is different from the median (0.50) when the distribution is
not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor
creation. If you didn't specify quantiles, the default values are
["0.1", "0.5", "0.9"]
.
createForecast_tags :: Lens' CreateForecast (Maybe [Tag]) Source #
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createForecast_timeSeriesSelector :: Lens' CreateForecast (Maybe TimeSeriesSelector) Source #
Defines the set of time series that are used to create the forecasts in
a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
DataSource
Format
Schema
createForecast_forecastName :: Lens' CreateForecast Text Source #
A name for the forecast.
createForecast_predictorArn :: Lens' CreateForecast Text Source #
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the forecast.
createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int Source #
The response's http status code.
CreateForecastExportJob
createForecastExportJob_format :: Lens' CreateForecastExportJob (Maybe Text) Source #
The format of the exported data, CSV or PARQUET. The default value is CSV.
createForecastExportJob_tags :: Lens' CreateForecastExportJob (Maybe [Tag]) Source #
The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createForecastExportJob_forecastExportJobName :: Lens' CreateForecastExportJob Text Source #
The name for the forecast export job.
createForecastExportJob_forecastArn :: Lens' CreateForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast that you want to export.
createForecastExportJob_destination :: Lens' CreateForecastExportJob DataDestination Source #
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
createForecastExportJobResponse_forecastExportJobArn :: Lens' CreateForecastExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the export job.
createForecastExportJobResponse_httpStatus :: Lens' CreateForecastExportJobResponse Int Source #
The response's http status code.
CreateMonitor
createMonitor_tags :: Lens' CreateMonitor (Maybe [Tag]) Source #
A list of tags to apply to the monitor resource.
createMonitor_monitorName :: Lens' CreateMonitor Text Source #
The name of the monitor resource.
createMonitor_resourceArn :: Lens' CreateMonitor Text Source #
The Amazon Resource Name (ARN) of the predictor to monitor.
createMonitorResponse_monitorArn :: Lens' CreateMonitorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the monitor resource.
createMonitorResponse_httpStatus :: Lens' CreateMonitorResponse Int Source #
The response's http status code.
CreatePredictor
createPredictor_algorithmArn :: Lens' CreatePredictor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm to use for model
training. Required if PerformAutoML
is not set to true
.
Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA
arn:aws:forecast:::algorithm/CNN-QR
arn:aws:forecast:::algorithm/Deep_AR_Plus
arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS
arn:aws:forecast:::algorithm/Prophet
createPredictor_autoMLOverrideStrategy :: Lens' CreatePredictor (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
Used to overide the default AutoML strategy, which is to optimize
predictor accuracy. To apply an AutoML strategy that minimizes training
time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
createPredictor_encryptionConfig :: Lens' CreatePredictor (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
createPredictor_evaluationParameters :: Lens' CreatePredictor (Maybe EvaluationParameters) Source #
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
createPredictor_forecastTypes :: Lens' CreatePredictor (Maybe (NonEmpty Text)) Source #
Specifies the forecast types used to train a predictor. You can specify
up to five forecast types. Forecast types can be quantiles from 0.01 to
0.99, by increments of 0.01 or higher. You can also specify the mean
forecast with mean
.
The default value is ["0.10", "0.50", "0.9"]
.
createPredictor_hPOConfig :: Lens' CreatePredictor (Maybe HyperParameterTuningJobConfig) Source #
Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.
If you included the HPOConfig
object, you must set PerformHPO
to
true.
createPredictor_optimizationMetric :: Lens' CreatePredictor (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
createPredictor_performAutoML :: Lens' CreatePredictor (Maybe Bool) Source #
Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.
The default value is false
. In this case, you are required to specify
an algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML.
This is a good option if you aren't sure which algorithm is suitable
for your training data. In this case, PerformHPO
must be false.
createPredictor_performHPO :: Lens' CreatePredictor (Maybe Bool) Source #
Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.
The default value is false
. In this case, Amazon Forecast uses default
hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,
optionally, supply the HyperParameterTuningJobConfig object. The tuning
job specifies a metric to optimize, which hyperparameters participate in
tuning, and the valid range for each tunable hyperparameter. In this
case, you are required to specify an algorithm and PerformAutoML
must
be false.
The following algorithms support HPO:
- DeepAR+
- CNN-QR
createPredictor_tags :: Lens' CreatePredictor (Maybe [Tag]) Source #
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createPredictor_trainingParameters :: Lens' CreatePredictor (Maybe (HashMap Text Text)) Source #
The hyperparameters to override for model training. The hyperparameters that you can override are listed in the individual algorithms. For the list of supported algorithms, see aws-forecast-choosing-recipes.
createPredictor_predictorName :: Lens' CreatePredictor Text Source #
A name for the predictor.
createPredictor_forecastHorizon :: Lens' CreatePredictor Int Source #
Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.
For example, if you configure a dataset for daily data collection (using
the DataFrequency
parameter of the CreateDataset operation) and set
the forecast horizon to 10, the model returns predictions for 10 days.
The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
createPredictor_inputDataConfig :: Lens' CreatePredictor InputDataConfig Source #
Describes the dataset group that contains the data to use to train the predictor.
createPredictor_featurizationConfig :: Lens' CreatePredictor FeaturizationConfig Source #
The featurization configuration.
createPredictorResponse_predictorArn :: Lens' CreatePredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor.
createPredictorResponse_httpStatus :: Lens' CreatePredictorResponse Int Source #
The response's http status code.
CreatePredictorBacktestExportJob
createPredictorBacktestExportJob_format :: Lens' CreatePredictorBacktestExportJob (Maybe Text) Source #
The format of the exported data, CSV or PARQUET. The default value is CSV.
createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text Source #
The name for the backtest export job.
createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor that you want to export.
createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination Source #
Undocumented member.
createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.
createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int Source #
The response's http status code.
CreateWhatIfAnalysis
createWhatIfAnalysis_tags :: Lens' CreateWhatIfAnalysis (Maybe [Tag]) Source #
A list of tags to apply to the what if forecast.
createWhatIfAnalysis_timeSeriesSelector :: Lens' CreateWhatIfAnalysis (Maybe TimeSeriesSelector) Source #
Defines the set of time series that are used in the what-if analysis
with a TimeSeriesIdentifiers
object. What-if analyses are performed
only for the time series in this object.
The TimeSeriesIdentifiers
object needs the following information:
DataSource
Format
Schema
createWhatIfAnalysis_whatIfAnalysisName :: Lens' CreateWhatIfAnalysis Text Source #
The name of the what-if analysis. Each name must be unique.
createWhatIfAnalysis_forecastArn :: Lens' CreateWhatIfAnalysis Text Source #
The Amazon Resource Name (ARN) of the baseline forecast.
createWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' CreateWhatIfAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis.
createWhatIfAnalysisResponse_httpStatus :: Lens' CreateWhatIfAnalysisResponse Int Source #
The response's http status code.
CreateWhatIfForecast
createWhatIfForecast_tags :: Lens' CreateWhatIfForecast (Maybe [Tag]) Source #
A list of tags to apply to the what if forecast.
createWhatIfForecast_timeSeriesReplacementsDataSource :: Lens' CreateWhatIfForecast (Maybe TimeSeriesReplacementsDataSource) Source #
The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.
This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.
Timestamps and item_ids not included in this dataset are not included in the what-if analysis.
createWhatIfForecast_timeSeriesTransformations :: Lens' CreateWhatIfForecast (Maybe [TimeSeriesTransformation]) Source #
The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.
createWhatIfForecast_whatIfForecastName :: Lens' CreateWhatIfForecast Text Source #
The name of the what-if forecast. Names must be unique within each what-if analysis.
createWhatIfForecast_whatIfAnalysisArn :: Lens' CreateWhatIfForecast Text Source #
The Amazon Resource Name (ARN) of the what-if analysis.
createWhatIfForecastResponse_whatIfForecastArn :: Lens' CreateWhatIfForecastResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
createWhatIfForecastResponse_httpStatus :: Lens' CreateWhatIfForecastResponse Int Source #
The response's http status code.
CreateWhatIfForecastExport
createWhatIfForecastExport_format :: Lens' CreateWhatIfForecastExport (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
createWhatIfForecastExport_tags :: Lens' CreateWhatIfForecastExport (Maybe [Tag]) Source #
A list of tags to apply to the what if forecast.
createWhatIfForecastExport_whatIfForecastExportName :: Lens' CreateWhatIfForecastExport Text Source #
The name of the what-if forecast to export.
createWhatIfForecastExport_whatIfForecastArns :: Lens' CreateWhatIfForecastExport (NonEmpty Text) Source #
The list of what-if forecast Amazon Resource Names (ARNs) to export.
createWhatIfForecastExport_destination :: Lens' CreateWhatIfForecastExport DataDestination Source #
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
createWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' CreateWhatIfForecastExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
createWhatIfForecastExportResponse_httpStatus :: Lens' CreateWhatIfForecastExportResponse Int Source #
The response's http status code.
DeleteDataset
deleteDataset_datasetArn :: Lens' DeleteDataset Text Source #
The Amazon Resource Name (ARN) of the dataset to delete.
DeleteDatasetGroup
deleteDatasetGroup_datasetGroupArn :: Lens' DeleteDatasetGroup Text Source #
The Amazon Resource Name (ARN) of the dataset group to delete.
DeleteDatasetImportJob
deleteDatasetImportJob_datasetImportJobArn :: Lens' DeleteDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the dataset import job to delete.
DeleteExplainability
deleteExplainability_explainabilityArn :: Lens' DeleteExplainability Text Source #
The Amazon Resource Name (ARN) of the Explainability resource to delete.
DeleteExplainabilityExport
deleteExplainabilityExport_explainabilityExportArn :: Lens' DeleteExplainabilityExport Text Source #
The Amazon Resource Name (ARN) of the Explainability export to delete.
DeleteForecast
deleteForecast_forecastArn :: Lens' DeleteForecast Text Source #
The Amazon Resource Name (ARN) of the forecast to delete.
DeleteForecastExportJob
deleteForecastExportJob_forecastExportJobArn :: Lens' DeleteForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast export job to delete.
DeleteMonitor
deleteMonitor_monitorArn :: Lens' DeleteMonitor Text Source #
The Amazon Resource Name (ARN) of the monitor resource to delete.
DeletePredictor
deletePredictor_predictorArn :: Lens' DeletePredictor Text Source #
The Amazon Resource Name (ARN) of the predictor to delete.
DeletePredictorBacktestExportJob
deletePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DeletePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor backtest export job to delete.
DeleteResourceTree
deleteResourceTree_resourceArn :: Lens' DeleteResourceTree Text Source #
The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted.
DeleteWhatIfAnalysis
deleteWhatIfAnalysis_whatIfAnalysisArn :: Lens' DeleteWhatIfAnalysis Text Source #
The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.
DeleteWhatIfForecast
deleteWhatIfForecast_whatIfForecastArn :: Lens' DeleteWhatIfForecast Text Source #
The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.
DeleteWhatIfForecastExport
deleteWhatIfForecastExport_whatIfForecastExportArn :: Lens' DeleteWhatIfForecastExport Text Source #
The Amazon Resource Name (ARN) of the what-if forecast export that you want to delete.
DescribeAutoPredictor
describeAutoPredictor_predictorArn :: Lens' DescribeAutoPredictor Text Source #
The Amazon Resource Name (ARN) of the predictor.
describeAutoPredictorResponse_creationTime :: Lens' DescribeAutoPredictorResponse (Maybe UTCTime) Source #
The timestamp of the CreateAutoPredictor request.
describeAutoPredictorResponse_dataConfig :: Lens' DescribeAutoPredictorResponse (Maybe DataConfig) Source #
The data configuration for your dataset group and any additional datasets.
describeAutoPredictorResponse_datasetImportJobArns :: Lens' DescribeAutoPredictorResponse (Maybe [Text]) Source #
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
describeAutoPredictorResponse_encryptionConfig :: Lens' DescribeAutoPredictorResponse (Maybe EncryptionConfig) Source #
Undocumented member.
describeAutoPredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeAutoPredictorResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the predictor training job to complete.
describeAutoPredictorResponse_explainabilityInfo :: Lens' DescribeAutoPredictorResponse (Maybe ExplainabilityInfo) Source #
Provides the status and ARN of the Predictor Explainability.
describeAutoPredictorResponse_forecastDimensions :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text)) Source #
An array of dimension (field) names that specify the attributes used to group your time series.
describeAutoPredictorResponse_forecastFrequency :: Lens' DescribeAutoPredictorResponse (Maybe 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.
describeAutoPredictorResponse_forecastHorizon :: Lens' DescribeAutoPredictorResponse (Maybe Int) Source #
The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
describeAutoPredictorResponse_forecastTypes :: Lens' DescribeAutoPredictorResponse (Maybe (NonEmpty Text)) Source #
The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
describeAutoPredictorResponse_lastModificationTime :: Lens' DescribeAutoPredictorResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeAutoPredictorResponse_message :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #
In the event of an error, a message detailing the cause of the error.
describeAutoPredictorResponse_monitorInfo :: Lens' DescribeAutoPredictorResponse (Maybe MonitorInfo) Source #
A object with the Amazon Resource Name (ARN) and status of the monitor resource.
describeAutoPredictorResponse_optimizationMetric :: Lens' DescribeAutoPredictorResponse (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
describeAutoPredictorResponse_predictorArn :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor
describeAutoPredictorResponse_predictorName :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #
The name of the predictor.
describeAutoPredictorResponse_referencePredictorSummary :: Lens' DescribeAutoPredictorResponse (Maybe ReferencePredictorSummary) Source #
The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
describeAutoPredictorResponse_status :: Lens' DescribeAutoPredictorResponse (Maybe Text) Source #
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
describeAutoPredictorResponse_timeAlignmentBoundary :: Lens' DescribeAutoPredictorResponse (Maybe TimeAlignmentBoundary) Source #
The time boundary Forecast uses when aggregating data.
describeAutoPredictorResponse_httpStatus :: Lens' DescribeAutoPredictorResponse Int Source #
The response's http status code.
DescribeDataset
describeDataset_datasetArn :: Lens' DescribeDataset Text Source #
The Amazon Resource Name (ARN) of the dataset.
describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #
When the dataset was created.
describeDatasetResponse_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.
describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The name of the dataset.
describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType) Source #
The dataset type.
describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain) Source #
The domain associated with the dataset.
describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe EncryptionConfig) Source #
The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
describeDatasetResponse_lastModificationTime :: Lens' DescribeDatasetResponse (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 DescribeDataset
call. After a
CreateDatasetImportJob
operation has finished, LastModificationTime
is when the import job
completed or failed.
describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema) Source #
An array of SchemaAttribute
objects that specify the dataset fields.
Each SchemaAttribute
specifies the name and data type of a field.
describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The status of the dataset. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply while data is imported to the dataset from a
call to the
CreateDatasetImportJob
operation and reflect the status of the dataset import job. For example,
when the import job status is CREATE_IN_PROGRESS
, the status of the
dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import
training data.
describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #
The response's http status code.
DescribeDatasetGroup
describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text Source #
The Amazon Resource Name (ARN) of the dataset group.
describeDatasetGroupResponse_creationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime) Source #
When the dataset group was created.
describeDatasetGroupResponse_datasetArns :: Lens' DescribeDatasetGroupResponse (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
describeDatasetGroupResponse_datasetGroupArn :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The ARN of the dataset group.
describeDatasetGroupResponse_datasetGroupName :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The name of the dataset group.
describeDatasetGroupResponse_domain :: Lens' DescribeDatasetGroupResponse (Maybe Domain) Source #
The domain associated with the dataset group.
describeDatasetGroupResponse_lastModificationTime :: Lens' DescribeDatasetGroupResponse (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 DescribeDatasetGroup
call.
describeDatasetGroupResponse_status :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The status of the dataset group. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply when you call the
UpdateDatasetGroup
operation.
The Status
of the dataset group must be ACTIVE
before you can use
the dataset group to create a predictor.
describeDatasetGroupResponse_httpStatus :: Lens' DescribeDatasetGroupResponse Int Source #
The response's http status code.
DescribeDatasetImportJob
describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the dataset import job.
describeDatasetImportJobResponse_creationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime) Source #
When the dataset import job was created.
describeDatasetImportJobResponse_dataSize :: Lens' DescribeDatasetImportJobResponse (Maybe Double) Source #
The size of the dataset in gigabytes (GB) after the import job has finished.
describeDatasetImportJobResponse_dataSource :: Lens' DescribeDatasetImportJobResponse (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.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
describeDatasetImportJobResponse_datasetArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
describeDatasetImportJobResponse_datasetImportJobArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The ARN of the dataset import job.
describeDatasetImportJobResponse_datasetImportJobName :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The name of the dataset import job.
describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeDatasetImportJobResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the dataset import job to complete.
describeDatasetImportJobResponse_fieldStatistics :: Lens' DescribeDatasetImportJobResponse (Maybe (HashMap Text Statistics)) Source #
Statistical information about each field in the input data.
describeDatasetImportJobResponse_format :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The format of the imported data, CSV or PARQUET.
describeDatasetImportJobResponse_geolocationFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The format of the geolocation attribute. Valid Values:"LAT_LONG"
and
"CC_POSTALCODE"
.
describeDatasetImportJobResponse_lastModificationTime :: Lens' DescribeDatasetImportJobResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeDatasetImportJobResponse_message :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeDatasetImportJobResponse_status :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
describeDatasetImportJobResponse_timeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The single time zone applied to every item in the dataset
describeDatasetImportJobResponse_timestampFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
describeDatasetImportJobResponse_useGeolocationForTimeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Bool) Source #
Whether TimeZone
is automatically derived from the geolocation
attribute.
describeDatasetImportJobResponse_httpStatus :: Lens' DescribeDatasetImportJobResponse Int Source #
The response's http status code.
DescribeExplainability
describeExplainability_explainabilityArn :: Lens' DescribeExplainability Text Source #
The Amazon Resource Name (ARN) of the Explaianability to describe.
describeExplainabilityResponse_creationTime :: Lens' DescribeExplainabilityResponse (Maybe UTCTime) Source #
When the Explainability resource was created.
describeExplainabilityResponse_dataSource :: Lens' DescribeExplainabilityResponse (Maybe DataSource) Source #
Undocumented member.
describeExplainabilityResponse_enableVisualization :: Lens' DescribeExplainabilityResponse (Maybe Bool) Source #
Whether the visualization was enabled for the Explainability resource.
describeExplainabilityResponse_endDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
If TimePointGranularity
is set to SPECIFIC
, the last time point in
the Explainability.
describeExplainabilityResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeExplainabilityResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the CreateExplainability job to complete.
describeExplainabilityResponse_explainabilityArn :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability.
describeExplainabilityResponse_explainabilityConfig :: Lens' DescribeExplainabilityResponse (Maybe ExplainabilityConfig) Source #
The configuration settings that define the granularity of time series and time points for the Explainability.
describeExplainabilityResponse_explainabilityName :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
The name of the Explainability.
describeExplainabilityResponse_lastModificationTime :: Lens' DescribeExplainabilityResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeExplainabilityResponse_message :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
If an error occurred, a message about the error.
describeExplainabilityResponse_resourceArn :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.
describeExplainabilityResponse_schema :: Lens' DescribeExplainabilityResponse (Maybe Schema) Source #
Undocumented member.
describeExplainabilityResponse_startDateTime :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
If TimePointGranularity
is set to SPECIFIC
, the first time point in
the Explainability.
describeExplainabilityResponse_status :: Lens' DescribeExplainabilityResponse (Maybe Text) Source #
The status of the Explainability resource. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
describeExplainabilityResponse_httpStatus :: Lens' DescribeExplainabilityResponse Int Source #
The response's http status code.
DescribeExplainabilityExport
describeExplainabilityExport_explainabilityExportArn :: Lens' DescribeExplainabilityExport Text Source #
The Amazon Resource Name (ARN) of the Explainability export.
describeExplainabilityExportResponse_creationTime :: Lens' DescribeExplainabilityExportResponse (Maybe UTCTime) Source #
When the Explainability export was created.
describeExplainabilityExportResponse_destination :: Lens' DescribeExplainabilityExportResponse (Maybe DataDestination) Source #
Undocumented member.
describeExplainabilityExportResponse_explainabilityArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability export.
describeExplainabilityExportResponse_explainabilityExportArn :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Explainability export.
describeExplainabilityExportResponse_explainabilityExportName :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
The name of the Explainability export.
describeExplainabilityExportResponse_format :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
describeExplainabilityExportResponse_lastModificationTime :: Lens' DescribeExplainabilityExportResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeExplainabilityExportResponse_message :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
Information about any errors that occurred during the export.
describeExplainabilityExportResponse_status :: Lens' DescribeExplainabilityExportResponse (Maybe Text) Source #
The status of the Explainability export. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
describeExplainabilityExportResponse_httpStatus :: Lens' DescribeExplainabilityExportResponse Int Source #
The response's http status code.
DescribeForecast
describeForecast_forecastArn :: Lens' DescribeForecast Text Source #
The Amazon Resource Name (ARN) of the forecast.
describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime) Source #
When the forecast creation task was created.
describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The ARN of the dataset group that provided the data used to train the predictor.
describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the forecast job to complete.
describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The forecast ARN as specified in the request.
describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text) Source #
The name of the forecast.
describeForecastResponse_forecastTypes :: Lens' DescribeForecastResponse (Maybe (NonEmpty Text)) Source #
The quantiles at which probabilistic forecasts were generated.
describeForecastResponse_lastModificationTime :: Lens' DescribeForecastResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeForecastResponse_predictorArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The ARN of the predictor used to generate the forecast.
describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text) Source #
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
describeForecastResponse_timeSeriesSelector :: Lens' DescribeForecastResponse (Maybe TimeSeriesSelector) Source #
The time series to include in the forecast.
describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int Source #
The response's http status code.
DescribeForecastExportJob
describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast export job.
describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime) Source #
When the forecast export job was created.
describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination) Source #
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the exported forecast.
describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The ARN of the forecast export job.
describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The name of the forecast export job.
describeForecastExportJobResponse_format :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int Source #
The response's http status code.
DescribeMonitor
describeMonitor_monitorArn :: Lens' DescribeMonitor Text Source #
The Amazon Resource Name (ARN) of the monitor resource to describe.
describeMonitorResponse_baseline :: Lens' DescribeMonitorResponse (Maybe Baseline) Source #
Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.
describeMonitorResponse_creationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #
The timestamp for when the monitor resource was created.
describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes :: Lens' DescribeMonitorResponse (Maybe Integer) Source #
The estimated number of minutes remaining before the monitor resource finishes its current evaluation.
describeMonitorResponse_lastEvaluationState :: Lens' DescribeMonitorResponse (Maybe Text) Source #
The state of the monitor's latest evaluation.
describeMonitorResponse_lastEvaluationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #
The timestamp of the latest evaluation completed by the monitor.
describeMonitorResponse_lastModificationTime :: Lens' DescribeMonitorResponse (Maybe UTCTime) Source #
The timestamp of the latest modification to the monitor.
describeMonitorResponse_message :: Lens' DescribeMonitorResponse (Maybe Text) Source #
An error message, if any, for the monitor.
describeMonitorResponse_monitorArn :: Lens' DescribeMonitorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the monitor resource described.
describeMonitorResponse_monitorName :: Lens' DescribeMonitorResponse (Maybe Text) Source #
The name of the monitor.
describeMonitorResponse_resourceArn :: Lens' DescribeMonitorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the auto predictor being monitored.
describeMonitorResponse_status :: Lens' DescribeMonitorResponse (Maybe Text) Source #
The status of the monitor resource.
describeMonitorResponse_httpStatus :: Lens' DescribeMonitorResponse Int Source #
The response's http status code.
DescribePredictor
describePredictor_predictorArn :: Lens' DescribePredictor Text Source #
The Amazon Resource Name (ARN) of the predictor that you want information about.
describePredictorResponse_algorithmArn :: Lens' DescribePredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm used for model training.
describePredictorResponse_autoMLAlgorithmArns :: Lens' DescribePredictorResponse (Maybe [Text]) Source #
When PerformAutoML
is specified, the ARN of the chosen algorithm.
describePredictorResponse_autoMLOverrideStrategy :: Lens' DescribePredictorResponse (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
describePredictorResponse_creationTime :: Lens' DescribePredictorResponse (Maybe UTCTime) Source #
When the model training task was created.
describePredictorResponse_datasetImportJobArns :: Lens' DescribePredictorResponse (Maybe [Text]) Source #
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
describePredictorResponse_encryptionConfig :: Lens' DescribePredictorResponse (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
describePredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribePredictorResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the predictor training job to complete.
describePredictorResponse_evaluationParameters :: Lens' DescribePredictorResponse (Maybe EvaluationParameters) Source #
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
describePredictorResponse_featurizationConfig :: Lens' DescribePredictorResponse (Maybe FeaturizationConfig) Source #
The featurization configuration.
describePredictorResponse_forecastHorizon :: Lens' DescribePredictorResponse (Maybe Int) Source #
The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
describePredictorResponse_forecastTypes :: Lens' DescribePredictorResponse (Maybe (NonEmpty Text)) Source #
The forecast types used during predictor training. Default value is
["0.1","0.5","0.9"]
describePredictorResponse_hPOConfig :: Lens' DescribePredictorResponse (Maybe HyperParameterTuningJobConfig) Source #
The hyperparameter override values for the algorithm.
describePredictorResponse_inputDataConfig :: Lens' DescribePredictorResponse (Maybe InputDataConfig) Source #
Describes the dataset group that contains the data to use to train the predictor.
describePredictorResponse_isAutoPredictor :: Lens' DescribePredictorResponse (Maybe Bool) Source #
Whether the predictor was created with CreateAutoPredictor.
describePredictorResponse_lastModificationTime :: Lens' DescribePredictorResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describePredictorResponse_message :: Lens' DescribePredictorResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describePredictorResponse_optimizationMetric :: Lens' DescribePredictorResponse (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
describePredictorResponse_performAutoML :: Lens' DescribePredictorResponse (Maybe Bool) Source #
Whether the predictor is set to perform AutoML.
describePredictorResponse_performHPO :: Lens' DescribePredictorResponse (Maybe Bool) Source #
Whether the predictor is set to perform hyperparameter optimization (HPO).
describePredictorResponse_predictorArn :: Lens' DescribePredictorResponse (Maybe Text) Source #
The ARN of the predictor.
describePredictorResponse_predictorExecutionDetails :: Lens' DescribePredictorResponse (Maybe PredictorExecutionDetails) Source #
Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.
describePredictorResponse_predictorName :: Lens' DescribePredictorResponse (Maybe Text) Source #
The name of the predictor.
describePredictorResponse_status :: Lens' DescribePredictorResponse (Maybe Text) Source #
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
describePredictorResponse_trainingParameters :: Lens' DescribePredictorResponse (Maybe (HashMap Text Text)) Source #
The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
describePredictorResponse_httpStatus :: Lens' DescribePredictorResponse Int Source #
The response's http status code.
DescribePredictorBacktestExportJob
describePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
describePredictorBacktestExportJobResponse_creationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime) Source #
When the predictor backtest export job was created.
describePredictorBacktestExportJobResponse_destination :: Lens' DescribePredictorBacktestExportJobResponse (Maybe DataDestination) Source #
Undocumented member.
describePredictorBacktestExportJobResponse_format :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
describePredictorBacktestExportJobResponse_lastModificationTime :: Lens' DescribePredictorBacktestExportJobResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describePredictorBacktestExportJobResponse_message :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
Information about any errors that may have occurred during the backtest export.
describePredictorBacktestExportJobResponse_predictorArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor.
describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
describePredictorBacktestExportJobResponse_predictorBacktestExportJobName :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The name of the predictor backtest export job.
describePredictorBacktestExportJobResponse_status :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
describePredictorBacktestExportJobResponse_httpStatus :: Lens' DescribePredictorBacktestExportJobResponse Int Source #
The response's http status code.
DescribeWhatIfAnalysis
describeWhatIfAnalysis_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysis Text Source #
The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.
describeWhatIfAnalysisResponse_creationTime :: Lens' DescribeWhatIfAnalysisResponse (Maybe UTCTime) Source #
When the what-if analysis was created.
describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfAnalysisResponse (Maybe Integer) Source #
The approximate time remaining to complete the what-if analysis, in minutes.
describeWhatIfAnalysisResponse_forecastArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
describeWhatIfAnalysisResponse_lastModificationTime :: Lens' DescribeWhatIfAnalysisResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeWhatIfAnalysisResponse_message :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeWhatIfAnalysisResponse_status :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The status of the what-if analysis. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the what-if analysis must be ACTIVE
before you can
access the analysis.
describeWhatIfAnalysisResponse_timeSeriesSelector :: Lens' DescribeWhatIfAnalysisResponse (Maybe TimeSeriesSelector) Source #
Undocumented member.
describeWhatIfAnalysisResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis.
describeWhatIfAnalysisResponse_whatIfAnalysisName :: Lens' DescribeWhatIfAnalysisResponse (Maybe Text) Source #
The name of the what-if analysis.
describeWhatIfAnalysisResponse_httpStatus :: Lens' DescribeWhatIfAnalysisResponse Int Source #
The response's http status code.
DescribeWhatIfForecast
describeWhatIfForecast_whatIfForecastArn :: Lens' DescribeWhatIfForecast Text Source #
The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.
describeWhatIfForecastResponse_creationTime :: Lens' DescribeWhatIfForecastResponse (Maybe UTCTime) Source #
When the what-if forecast was created.
describeWhatIfForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastResponse (Maybe Integer) Source #
The approximate time remaining to complete the what-if forecast, in minutes.
describeWhatIfForecastResponse_forecastTypes :: Lens' DescribeWhatIfForecastResponse (Maybe (NonEmpty Text)) Source #
The quantiles at which probabilistic forecasts are generated. You can
specify up to 5 quantiles per what-if forecast in the
CreateWhatIfForecast operation. If you didn't specify quantiles, the
default values are ["0.1", "0.5", "0.9"]
.
describeWhatIfForecastResponse_lastModificationTime :: Lens' DescribeWhatIfForecastResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeWhatIfForecastResponse_message :: Lens' DescribeWhatIfForecastResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeWhatIfForecastResponse_status :: Lens' DescribeWhatIfForecastResponse (Maybe Text) Source #
The status of the what-if forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the what-if forecast must be ACTIVE
before you can
access the forecast.
describeWhatIfForecastResponse_timeSeriesReplacementsDataSource :: Lens' DescribeWhatIfForecastResponse (Maybe TimeSeriesReplacementsDataSource) Source #
An array of S3Config
, Schema
, and Format
elements that describe
the replacement time series.
describeWhatIfForecastResponse_timeSeriesTransformations :: Lens' DescribeWhatIfForecastResponse (Maybe [TimeSeriesTransformation]) Source #
An array of Action
and TimeSeriesConditions
elements that describe
what transformations were applied to which time series.
describeWhatIfForecastResponse_whatIfAnalysisArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.
describeWhatIfForecastResponse_whatIfForecastArn :: Lens' DescribeWhatIfForecastResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast.
describeWhatIfForecastResponse_whatIfForecastName :: Lens' DescribeWhatIfForecastResponse (Maybe Text) Source #
The name of the what-if forecast.
describeWhatIfForecastResponse_httpStatus :: Lens' DescribeWhatIfForecastResponse Int Source #
The response's http status code.
DescribeWhatIfForecastExport
describeWhatIfForecastExport_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExport Text Source #
The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.
describeWhatIfForecastExportResponse_creationTime :: Lens' DescribeWhatIfForecastExportResponse (Maybe UTCTime) Source #
When the what-if forecast export was created.
describeWhatIfForecastExportResponse_destination :: Lens' DescribeWhatIfForecastExportResponse (Maybe DataDestination) Source #
Undocumented member.
describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeWhatIfForecastExportResponse (Maybe Integer) Source #
The approximate time remaining to complete the what-if forecast export, in minutes.
describeWhatIfForecastExportResponse_format :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The format of the exported data, CSV or PARQUET.
describeWhatIfForecastExportResponse_lastModificationTime :: Lens' DescribeWhatIfForecastExportResponse (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.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeWhatIfForecastExportResponse_message :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeWhatIfForecastExportResponse_status :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The status of the what-if forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the what-if forecast export must be ACTIVE
before you
can access the forecast export.
describeWhatIfForecastExportResponse_whatIfForecastArns :: Lens' DescribeWhatIfForecastExportResponse (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
describeWhatIfForecastExportResponse_whatIfForecastExportArn :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the what-if forecast export.
describeWhatIfForecastExportResponse_whatIfForecastExportName :: Lens' DescribeWhatIfForecastExportResponse (Maybe Text) Source #
The name of the what-if forecast export.
describeWhatIfForecastExportResponse_httpStatus :: Lens' DescribeWhatIfForecastExportResponse Int Source #
The response's http status code.
GetAccuracyMetrics
getAccuracyMetrics_predictorArn :: Lens' GetAccuracyMetrics Text Source #
The Amazon Resource Name (ARN) of the predictor to get metrics for.
getAccuracyMetricsResponse_autoMLOverrideStrategy :: Lens' GetAccuracyMetricsResponse (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
getAccuracyMetricsResponse_isAutoPredictor :: Lens' GetAccuracyMetricsResponse (Maybe Bool) Source #
Whether the predictor was created with CreateAutoPredictor.
getAccuracyMetricsResponse_optimizationMetric :: Lens' GetAccuracyMetricsResponse (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
getAccuracyMetricsResponse_predictorEvaluationResults :: Lens' GetAccuracyMetricsResponse (Maybe [EvaluationResult]) Source #
An array of results from evaluating the predictor.
getAccuracyMetricsResponse_httpStatus :: Lens' GetAccuracyMetricsResponse Int Source #
The response's http status code.
ListDatasetGroups
listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural) Source #
The number of items to return in the response.
listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasetGroupsResponse_datasetGroups :: Lens' ListDatasetGroupsResponse (Maybe [DatasetGroupSummary]) Source #
An array of objects that summarize each dataset group's properties.
listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetGroupsResponse_httpStatus :: Lens' ListDatasetGroupsResponse Int Source #
The response's http status code.
ListDatasetImportJobs
listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the datasets that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the datasets that match the statement, specifyIS
. To exclude matching datasets, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetArn
andStatus
.Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural) Source #
The number of items to return in the response.
listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary]) Source #
An array of objects that summarize each dataset import job's properties.
listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int Source #
The response's http status code.
ListDatasets
listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #
The number of items to return in the response.
listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary]) Source #
An array of objects that summarize each dataset's properties.
listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int Source #
The response's http status code.
ListExplainabilities
listExplainabilities_filters :: Lens' ListExplainabilities (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the resources that match the statement
from the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
.Key
- The name of the parameter to filter on. Valid values areResourceArn
andStatus
.Value
- The value to match.
listExplainabilities_maxResults :: Lens' ListExplainabilities (Maybe Natural) Source #
The number of items returned in the response.
listExplainabilities_nextToken :: Lens' ListExplainabilities (Maybe Text) Source #
If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
listExplainabilitiesResponse_explainabilities :: Lens' ListExplainabilitiesResponse (Maybe [ExplainabilitySummary]) Source #
An array of objects that summarize the properties of each Explainability resource.
listExplainabilitiesResponse_nextToken :: Lens' ListExplainabilitiesResponse (Maybe Text) Source #
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
listExplainabilitiesResponse_httpStatus :: Lens' ListExplainabilitiesResponse Int Source #
The response's http status code.
ListExplainabilityExports
listExplainabilityExports_filters :: Lens' ListExplainabilityExports (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude resources that match the statement from
the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
.Key
- The name of the parameter to filter on. Valid values areResourceArn
andStatus
.Value
- The value to match.
listExplainabilityExports_maxResults :: Lens' ListExplainabilityExports (Maybe Natural) Source #
The number of items to return in the response.
listExplainabilityExports_nextToken :: Lens' ListExplainabilityExports (Maybe Text) Source #
If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
listExplainabilityExportsResponse_explainabilityExports :: Lens' ListExplainabilityExportsResponse (Maybe [ExplainabilityExportSummary]) Source #
An array of objects that summarize the properties of each Explainability export.
listExplainabilityExportsResponse_nextToken :: Lens' ListExplainabilityExportsResponse (Maybe Text) Source #
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
listExplainabilityExportsResponse_httpStatus :: Lens' ListExplainabilityExportsResponse Int Source #
The response's http status code.
ListForecastExportJobs
listForecastExportJobs_filters :: Lens' ListForecastExportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecast export jobs that
match the statement from the list, respectively. The match statement
consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural) Source #
The number of items to return in the response.
listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary]) Source #
An array of objects that summarize each export job's properties.
listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int Source #
The response's http status code.
ListForecasts
listForecasts_filters :: Lens' ListForecasts (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecasts that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
listForecasts_maxResults :: Lens' ListForecasts (Maybe Natural) Source #
The number of items to return in the response.
listForecasts_nextToken :: Lens' ListForecasts (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listForecastsResponse_forecasts :: Lens' ListForecastsResponse (Maybe [ForecastSummary]) Source #
An array of objects that summarize each forecast's properties.
listForecastsResponse_nextToken :: Lens' ListForecastsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listForecastsResponse_httpStatus :: Lens' ListForecastsResponse Int Source #
The response's http status code.
ListMonitorEvaluations
listMonitorEvaluations_filters :: Lens' ListMonitorEvaluations (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the resources that match the statement
from the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
.Key
- The name of the parameter to filter on. The only valid value isEvaluationState
.Value
- The value to match. Valid values are onlySUCCESS
orFAILURE
.
For example, to list only successful monitor evaluations, you would specify:
"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]
listMonitorEvaluations_maxResults :: Lens' ListMonitorEvaluations (Maybe Natural) Source #
The maximum number of monitoring results to return.
listMonitorEvaluations_nextToken :: Lens' ListMonitorEvaluations (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listMonitorEvaluations_monitorArn :: Lens' ListMonitorEvaluations Text Source #
The Amazon Resource Name (ARN) of the monitor resource to get results from.
listMonitorEvaluationsResponse_nextToken :: Lens' ListMonitorEvaluationsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
listMonitorEvaluationsResponse_predictorMonitorEvaluations :: Lens' ListMonitorEvaluationsResponse (Maybe [PredictorMonitorEvaluation]) Source #
The monitoring results and predictor events collected by the monitor resource during different windows of time.
For information about monitoring see Viewing Monitoring Results. For more information about retrieving monitoring results see Viewing Monitoring Results.
listMonitorEvaluationsResponse_httpStatus :: Lens' ListMonitorEvaluationsResponse Int Source #
The response's http status code.
ListMonitors
listMonitors_filters :: Lens' ListMonitors (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the resources that match the statement
from the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
.Key
- The name of the parameter to filter on. The only valid value isStatus
.Value
- The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
listMonitors_maxResults :: Lens' ListMonitors (Maybe Natural) Source #
The maximum number of monitors to include in the response.
listMonitors_nextToken :: Lens' ListMonitors (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listMonitorsResponse_monitors :: Lens' ListMonitorsResponse (Maybe [MonitorSummary]) Source #
An array of objects that summarize each monitor's properties.
listMonitorsResponse_nextToken :: Lens' ListMonitorsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listMonitorsResponse_httpStatus :: Lens' ListMonitorsResponse Int Source #
The response's http status code.
ListPredictorBacktestExportJobs
listPredictorBacktestExportJobs_filters :: Lens' ListPredictorBacktestExportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the predictor backtest export jobs that
match the statement from the list. The match statement consists of a key
and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictor backtest export jobs that match the statement, specifyIS
. To exclude matching predictor backtest export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values arePredictorArn
andStatus
.Value
- The value to match.
listPredictorBacktestExportJobs_maxResults :: Lens' ListPredictorBacktestExportJobs (Maybe Natural) Source #
The number of items to return in the response.
listPredictorBacktestExportJobs_nextToken :: Lens' ListPredictorBacktestExportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
listPredictorBacktestExportJobsResponse_nextToken :: Lens' ListPredictorBacktestExportJobsResponse (Maybe Text) Source #
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs :: Lens' ListPredictorBacktestExportJobsResponse (Maybe [PredictorBacktestExportJobSummary]) Source #
An array of objects that summarize the properties of each predictor backtest export job.
listPredictorBacktestExportJobsResponse_httpStatus :: Lens' ListPredictorBacktestExportJobsResponse Int Source #
The response's http status code.
ListPredictors
listPredictors_filters :: Lens' ListPredictors (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the predictors that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictors that match the statement, specifyIS
. To exclude matching predictors, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
andStatus
.Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural) Source #
The number of items to return in the response.
listPredictors_nextToken :: Lens' ListPredictors (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary]) Source #
An array of objects that summarize each predictor's properties.
listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
The tags for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
ListWhatIfAnalyses
listWhatIfAnalyses_filters :: Lens' ListWhatIfAnalyses (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the what-if analysis jobs that
match the statement from the list, respectively. The match statement
consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the what-if analysis jobs that match the statement, specifyIS
. To exclude matching what-if analysis jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areWhatIfAnalysisArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWhatIf, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf" } ]
listWhatIfAnalyses_maxResults :: Lens' ListWhatIfAnalyses (Maybe Natural) Source #
The number of items to return in the response.
listWhatIfAnalyses_nextToken :: Lens' ListWhatIfAnalyses (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listWhatIfAnalysesResponse_nextToken :: Lens' ListWhatIfAnalysesResponse (Maybe Text) Source #
If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listWhatIfAnalysesResponse_whatIfAnalyses :: Lens' ListWhatIfAnalysesResponse (Maybe [WhatIfAnalysisSummary]) Source #
An array of WhatIfAnalysisSummary
objects that describe the matched
analyses.
listWhatIfAnalysesResponse_httpStatus :: Lens' ListWhatIfAnalysesResponse Int Source #
The response's http status code.
ListWhatIfForecastExports
listWhatIfForecastExports_filters :: Lens' ListWhatIfForecastExports (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the what-if forecast export jobs
that match the statement from the list, respectively. The match
statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areWhatIfForecastExportArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWIFExport, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport" } ]
listWhatIfForecastExports_maxResults :: Lens' ListWhatIfForecastExports (Maybe Natural) Source #
The number of items to return in the response.
listWhatIfForecastExports_nextToken :: Lens' ListWhatIfForecastExports (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
listWhatIfForecastExportsResponse_nextToken :: Lens' ListWhatIfForecastExportsResponse (Maybe Text) Source #
If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listWhatIfForecastExportsResponse_whatIfForecastExports :: Lens' ListWhatIfForecastExportsResponse (Maybe [WhatIfForecastExportSummary]) Source #
An array of WhatIfForecastExports
objects that describe the matched
forecast exports.
listWhatIfForecastExportsResponse_httpStatus :: Lens' ListWhatIfForecastExportsResponse Int Source #
The response's http status code.
ListWhatIfForecasts
listWhatIfForecasts_filters :: Lens' ListWhatIfForecasts (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the what-if forecast export jobs
that match the statement from the list, respectively. The match
statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areWhatIfForecastArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityWhatIfForecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast" } ]
listWhatIfForecasts_maxResults :: Lens' ListWhatIfForecasts (Maybe Natural) Source #
The number of items to return in the response.
listWhatIfForecasts_nextToken :: Lens' ListWhatIfForecasts (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
listWhatIfForecastsResponse_nextToken :: Lens' ListWhatIfForecastsResponse (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
listWhatIfForecastsResponse_whatIfForecasts :: Lens' ListWhatIfForecastsResponse (Maybe [WhatIfForecastSummary]) Source #
An array of WhatIfForecasts
objects that describe the matched
forecasts.
listWhatIfForecastsResponse_httpStatus :: Lens' ListWhatIfForecastsResponse Int Source #
The response's http status code.
ResumeResource
resumeResource_resourceArn :: Lens' ResumeResource Text Source #
The Amazon Resource Name (ARN) of the monitor resource to resume.
StopResource
stopResource_resourceArn :: Lens' StopResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource to stop. The
supported ARNs are DatasetImportJobArn
, PredictorArn
,
PredictorBacktestExportJobArn
, ForecastArn
, ForecastExportJobArn
,
ExplainabilityArn
, and ExplainabilityExportArn
.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
tagResource_tags :: Lens' TagResource [Tag] Source #
The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The keys of the tags to be removed.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateDatasetGroup
updateDatasetGroup_datasetGroupArn :: Lens' UpdateDatasetGroup Text Source #
The ARN of the dataset group.
updateDatasetGroup_datasetArns :: Lens' UpdateDatasetGroup [Text] Source #
An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.
updateDatasetGroupResponse_httpStatus :: Lens' UpdateDatasetGroupResponse Int Source #
The response's http status code.
Types
Action
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
- addsValue
to all rows ofAttributeName
.SUBTRACT
- subtractsValue
from all rows ofAttributeName
.MULTIPLY
- multiplies all rows ofAttributeName
byValue
.DIVIDE
- divides all rows ofAttributeName
byValue
.
AdditionalDataset
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
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
,max
frontfill
: nonemiddlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
middlefill
:zero
,value
,median
,mean
,min
,max
backfill
:zero
,value
,median
,mean
,min
,max
futurefill
:zero
,value
,median
,mean
,min
,max
To set a filling method to a specific value, set the fill parameter to
value
and define the value in a corresponding _value
parameter. For
example, to set backfilling to a value of 2, include the following:
"backfill": "value"
and "backfill_value":"2"
.
Baseline
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
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
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
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
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
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
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
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
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.ACTIVE
orCREATE_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_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DatasetSummary
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
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
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
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
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
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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ExplainabilityInfo
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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ExplainabilitySummary
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Featurization
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
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
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
,max
frontfill
: nonemiddlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
middlefill
:zero
,value
,median
,mean
,min
,max
backfill
:zero
,value
,median
,mean
,min
,max
futurefill
:zero
,value
,median
,mean
,min
,max
To set a filling method to a specific value, set the fill parameter to
value
and define the value in a corresponding _value
parameter. For
example, to set backfilling to a value of 2, include the following:
"backfill": "value"
and "backfill_value":"2"
.
featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName Source #
The name of the method. The "filling" method is the only supported method.
Filter
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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
ForecastSummary
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
HyperParameterTuningJobConfig
hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges) Source #
Specifies the ranges of valid values for the hyperparameters.
InputDataConfig
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
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
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
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
monitorConfig_monitorName :: Lens' MonitorConfig Text Source #
The name of the monitor resource.
MonitorDataSource
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
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_STOPPED
UPDATE_IN_PROGRESS
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
MonitorSummary
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.ACTIVE
orCREATE_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_STOPPED
UPDATE_IN_PROGRESS
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ParameterRanges
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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
PredictorBaseline
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
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
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
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
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
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.ACTIVE
orCREATE_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_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
ReferencePredictorSummary
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
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
schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute)) Source #
An array of attributes specifying the name and type of each field in a dataset.
SchemaAttribute
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
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
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
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
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
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
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
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
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
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
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
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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_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
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.ACTIVE
orCREATE_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_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_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
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.