Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.Forecast
Contents
- Service Configuration
- Errors
- Waiters
- 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 (Paginated)
- ListDatasetImportJobs (Paginated)
- ListDatasets (Paginated)
- ListExplainabilities (Paginated)
- ListExplainabilityExports (Paginated)
- ListForecastExportJobs (Paginated)
- ListForecasts (Paginated)
- ListMonitorEvaluations (Paginated)
- ListMonitors (Paginated)
- ListPredictorBacktestExportJobs (Paginated)
- ListPredictors (Paginated)
- ListTagsForResource
- ListWhatIfAnalyses (Paginated)
- ListWhatIfForecastExports (Paginated)
- ListWhatIfForecasts (Paginated)
- ResumeResource
- StopResource
- TagResource
- UntagResource
- UpdateDatasetGroup
- Types
- AttributeType
- AutoMLOverrideStrategy
- Condition
- DatasetType
- DayOfWeek
- Domain
- EvaluationType
- FeaturizationMethodName
- FilterConditionString
- Month
- Operation
- OptimizationMetric
- ScalingType
- State
- TimePointGranularity
- TimeSeriesGranularity
- Action
- AdditionalDataset
- AttributeConfig
- Baseline
- BaselineMetric
- CategoricalParameterRange
- ContinuousParameterRange
- DataConfig
- DataDestination
- DataSource
- DatasetGroupSummary
- DatasetImportJobSummary
- DatasetSummary
- EncryptionConfig
- ErrorMetric
- EvaluationParameters
- EvaluationResult
- ExplainabilityConfig
- ExplainabilityExportSummary
- ExplainabilityInfo
- ExplainabilitySummary
- Featurization
- FeaturizationConfig
- FeaturizationMethod
- Filter
- ForecastExportJobSummary
- ForecastSummary
- HyperParameterTuningJobConfig
- InputDataConfig
- IntegerParameterRange
- MetricResult
- Metrics
- MonitorConfig
- MonitorDataSource
- MonitorInfo
- MonitorSummary
- ParameterRanges
- PredictorBacktestExportJobSummary
- PredictorBaseline
- PredictorEvent
- PredictorExecution
- PredictorExecutionDetails
- PredictorMonitorEvaluation
- PredictorSummary
- ReferencePredictorSummary
- S3Config
- Schema
- SchemaAttribute
- Statistics
- SupplementaryFeature
- Tag
- TestWindowSummary
- TimeAlignmentBoundary
- TimeSeriesCondition
- TimeSeriesIdentifiers
- TimeSeriesReplacementsDataSource
- TimeSeriesSelector
- TimeSeriesTransformation
- WeightedQuantileLoss
- WhatIfAnalysisSummary
- WhatIfForecastExportSummary
- WhatIfForecastSummary
- WindowSummary
Description
Derived from API version 2018-06-26
of the AWS service descriptions, licensed under Apache 2.0.
Provides APIs for creating and managing Amazon Forecast resources.
Synopsis
- defaultService :: Service
- _InvalidInputException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceAlreadyExistsException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- data CreateAutoPredictor = CreateAutoPredictor' (Maybe DataConfig) (Maybe EncryptionConfig) (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe MonitorConfig) (Maybe OptimizationMetric) (Maybe Text) (Maybe [Tag]) (Maybe TimeAlignmentBoundary) Text
- newCreateAutoPredictor :: Text -> CreateAutoPredictor
- data CreateAutoPredictorResponse = CreateAutoPredictorResponse' (Maybe Text) Int
- newCreateAutoPredictorResponse :: Int -> CreateAutoPredictorResponse
- data CreateDataset = CreateDataset' (Maybe Text) (Maybe EncryptionConfig) (Maybe [Tag]) Text Domain DatasetType Schema
- newCreateDataset :: Text -> Domain -> DatasetType -> Schema -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe Text) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data CreateDatasetGroup = CreateDatasetGroup' (Maybe [Text]) (Maybe [Tag]) Text Domain
- newCreateDatasetGroup :: Text -> Domain -> CreateDatasetGroup
- data CreateDatasetGroupResponse = CreateDatasetGroupResponse' (Maybe Text) Int
- newCreateDatasetGroupResponse :: Int -> CreateDatasetGroupResponse
- data CreateDatasetImportJob = CreateDatasetImportJob' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text DataSource
- newCreateDatasetImportJob :: Text -> Text -> DataSource -> CreateDatasetImportJob
- data CreateDatasetImportJobResponse = CreateDatasetImportJobResponse' (Maybe Text) Int
- newCreateDatasetImportJobResponse :: Int -> CreateDatasetImportJobResponse
- data CreateExplainability = CreateExplainability' (Maybe DataSource) (Maybe Bool) (Maybe Text) (Maybe Schema) (Maybe Text) (Maybe [Tag]) Text Text ExplainabilityConfig
- newCreateExplainability :: Text -> Text -> ExplainabilityConfig -> CreateExplainability
- data CreateExplainabilityResponse = CreateExplainabilityResponse' (Maybe Text) Int
- newCreateExplainabilityResponse :: Int -> CreateExplainabilityResponse
- data CreateExplainabilityExport = CreateExplainabilityExport' (Maybe Text) (Maybe [Tag]) Text Text DataDestination
- newCreateExplainabilityExport :: Text -> Text -> DataDestination -> CreateExplainabilityExport
- data CreateExplainabilityExportResponse = CreateExplainabilityExportResponse' (Maybe Text) Int
- newCreateExplainabilityExportResponse :: Int -> CreateExplainabilityExportResponse
- data CreateForecast = CreateForecast' (Maybe (NonEmpty Text)) (Maybe [Tag]) (Maybe TimeSeriesSelector) Text Text
- newCreateForecast :: Text -> Text -> CreateForecast
- data CreateForecastResponse = CreateForecastResponse' (Maybe Text) Int
- newCreateForecastResponse :: Int -> CreateForecastResponse
- data CreateForecastExportJob = CreateForecastExportJob' (Maybe Text) (Maybe [Tag]) Text Text DataDestination
- newCreateForecastExportJob :: Text -> Text -> DataDestination -> CreateForecastExportJob
- data CreateForecastExportJobResponse = CreateForecastExportJobResponse' (Maybe Text) Int
- newCreateForecastExportJobResponse :: Int -> CreateForecastExportJobResponse
- data CreateMonitor = CreateMonitor' (Maybe [Tag]) Text Text
- newCreateMonitor :: Text -> Text -> CreateMonitor
- data CreateMonitorResponse = CreateMonitorResponse' (Maybe Text) Int
- newCreateMonitorResponse :: Int -> CreateMonitorResponse
- data CreatePredictor = CreatePredictor' (Maybe Text) (Maybe AutoMLOverrideStrategy) (Maybe EncryptionConfig) (Maybe EvaluationParameters) (Maybe (NonEmpty Text)) (Maybe HyperParameterTuningJobConfig) (Maybe OptimizationMetric) (Maybe Bool) (Maybe Bool) (Maybe [Tag]) (Maybe (HashMap Text Text)) Text Int InputDataConfig FeaturizationConfig
- newCreatePredictor :: Text -> Int -> InputDataConfig -> FeaturizationConfig -> CreatePredictor
- data CreatePredictorResponse = CreatePredictorResponse' (Maybe Text) Int
- newCreatePredictorResponse :: Int -> CreatePredictorResponse
- data CreatePredictorBacktestExportJob = CreatePredictorBacktestExportJob' (Maybe Text) (Maybe [Tag]) Text Text DataDestination
- newCreatePredictorBacktestExportJob :: Text -> Text -> DataDestination -> CreatePredictorBacktestExportJob
- data CreatePredictorBacktestExportJobResponse = CreatePredictorBacktestExportJobResponse' (Maybe Text) Int
- newCreatePredictorBacktestExportJobResponse :: Int -> CreatePredictorBacktestExportJobResponse
- data CreateWhatIfAnalysis = CreateWhatIfAnalysis' (Maybe [Tag]) (Maybe TimeSeriesSelector) Text Text
- newCreateWhatIfAnalysis :: Text -> Text -> CreateWhatIfAnalysis
- data CreateWhatIfAnalysisResponse = CreateWhatIfAnalysisResponse' (Maybe Text) Int
- newCreateWhatIfAnalysisResponse :: Int -> CreateWhatIfAnalysisResponse
- data CreateWhatIfForecast = CreateWhatIfForecast' (Maybe [Tag]) (Maybe TimeSeriesReplacementsDataSource) (Maybe [TimeSeriesTransformation]) Text Text
- newCreateWhatIfForecast :: Text -> Text -> CreateWhatIfForecast
- data CreateWhatIfForecastResponse = CreateWhatIfForecastResponse' (Maybe Text) Int
- newCreateWhatIfForecastResponse :: Int -> CreateWhatIfForecastResponse
- data CreateWhatIfForecastExport = CreateWhatIfForecastExport' (Maybe Text) (Maybe [Tag]) Text (NonEmpty Text) DataDestination
- newCreateWhatIfForecastExport :: Text -> NonEmpty Text -> DataDestination -> CreateWhatIfForecastExport
- data CreateWhatIfForecastExportResponse = CreateWhatIfForecastExportResponse' (Maybe Text) Int
- newCreateWhatIfForecastExportResponse :: Int -> CreateWhatIfForecastExportResponse
- data DeleteDataset = DeleteDataset' Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' {
- newDeleteDatasetResponse :: DeleteDatasetResponse
- data DeleteDatasetGroup = DeleteDatasetGroup' Text
- newDeleteDatasetGroup :: Text -> DeleteDatasetGroup
- data DeleteDatasetGroupResponse = DeleteDatasetGroupResponse' {
- newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse
- data DeleteDatasetImportJob = DeleteDatasetImportJob' Text
- newDeleteDatasetImportJob :: Text -> DeleteDatasetImportJob
- data DeleteDatasetImportJobResponse = DeleteDatasetImportJobResponse' {
- newDeleteDatasetImportJobResponse :: DeleteDatasetImportJobResponse
- data DeleteExplainability = DeleteExplainability' Text
- newDeleteExplainability :: Text -> DeleteExplainability
- data DeleteExplainabilityResponse = DeleteExplainabilityResponse' {
- newDeleteExplainabilityResponse :: DeleteExplainabilityResponse
- data DeleteExplainabilityExport = DeleteExplainabilityExport' Text
- newDeleteExplainabilityExport :: Text -> DeleteExplainabilityExport
- data DeleteExplainabilityExportResponse = DeleteExplainabilityExportResponse' {
- newDeleteExplainabilityExportResponse :: DeleteExplainabilityExportResponse
- data DeleteForecast = DeleteForecast' Text
- newDeleteForecast :: Text -> DeleteForecast
- data DeleteForecastResponse = DeleteForecastResponse' {
- newDeleteForecastResponse :: DeleteForecastResponse
- data DeleteForecastExportJob = DeleteForecastExportJob' Text
- newDeleteForecastExportJob :: Text -> DeleteForecastExportJob
- data DeleteForecastExportJobResponse = DeleteForecastExportJobResponse' {
- newDeleteForecastExportJobResponse :: DeleteForecastExportJobResponse
- data DeleteMonitor = DeleteMonitor' Text
- newDeleteMonitor :: Text -> DeleteMonitor
- data DeleteMonitorResponse = DeleteMonitorResponse' {
- newDeleteMonitorResponse :: DeleteMonitorResponse
- data DeletePredictor = DeletePredictor' Text
- newDeletePredictor :: Text -> DeletePredictor
- data DeletePredictorResponse = DeletePredictorResponse' {
- newDeletePredictorResponse :: DeletePredictorResponse
- data DeletePredictorBacktestExportJob = DeletePredictorBacktestExportJob' Text
- newDeletePredictorBacktestExportJob :: Text -> DeletePredictorBacktestExportJob
- data DeletePredictorBacktestExportJobResponse = DeletePredictorBacktestExportJobResponse' {
- newDeletePredictorBacktestExportJobResponse :: DeletePredictorBacktestExportJobResponse
- data DeleteResourceTree = DeleteResourceTree' Text
- newDeleteResourceTree :: Text -> DeleteResourceTree
- data DeleteResourceTreeResponse = DeleteResourceTreeResponse' {
- newDeleteResourceTreeResponse :: DeleteResourceTreeResponse
- data DeleteWhatIfAnalysis = DeleteWhatIfAnalysis' Text
- newDeleteWhatIfAnalysis :: Text -> DeleteWhatIfAnalysis
- data DeleteWhatIfAnalysisResponse = DeleteWhatIfAnalysisResponse' {
- newDeleteWhatIfAnalysisResponse :: DeleteWhatIfAnalysisResponse
- data DeleteWhatIfForecast = DeleteWhatIfForecast' Text
- newDeleteWhatIfForecast :: Text -> DeleteWhatIfForecast
- data DeleteWhatIfForecastResponse = DeleteWhatIfForecastResponse' {
- newDeleteWhatIfForecastResponse :: DeleteWhatIfForecastResponse
- data DeleteWhatIfForecastExport = DeleteWhatIfForecastExport' Text
- newDeleteWhatIfForecastExport :: Text -> DeleteWhatIfForecastExport
- data DeleteWhatIfForecastExportResponse = DeleteWhatIfForecastExportResponse' {
- newDeleteWhatIfForecastExportResponse :: DeleteWhatIfForecastExportResponse
- data DescribeAutoPredictor = DescribeAutoPredictor' Text
- newDescribeAutoPredictor :: Text -> DescribeAutoPredictor
- data DescribeAutoPredictorResponse = DescribeAutoPredictorResponse' (Maybe POSIX) (Maybe DataConfig) (Maybe [Text]) (Maybe EncryptionConfig) (Maybe Integer) (Maybe ExplainabilityInfo) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe MonitorInfo) (Maybe OptimizationMetric) (Maybe Text) (Maybe Text) (Maybe ReferencePredictorSummary) (Maybe Text) (Maybe TimeAlignmentBoundary) Int
- newDescribeAutoPredictorResponse :: Int -> DescribeAutoPredictorResponse
- data DescribeDataset = DescribeDataset' Text
- newDescribeDataset :: Text -> DescribeDataset
- data DescribeDatasetResponse = DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetType) (Maybe Domain) (Maybe EncryptionConfig) (Maybe POSIX) (Maybe Schema) (Maybe Text) Int
- newDescribeDatasetResponse :: Int -> DescribeDatasetResponse
- data DescribeDatasetGroup = DescribeDatasetGroup' Text
- newDescribeDatasetGroup :: Text -> DescribeDatasetGroup
- data DescribeDatasetGroupResponse = DescribeDatasetGroupResponse' (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Domain) (Maybe POSIX) (Maybe Text) Int
- newDescribeDatasetGroupResponse :: Int -> DescribeDatasetGroupResponse
- data DescribeDatasetImportJob = DescribeDatasetImportJob' Text
- newDescribeDatasetImportJob :: Text -> DescribeDatasetImportJob
- data DescribeDatasetImportJobResponse = DescribeDatasetImportJobResponse' (Maybe POSIX) (Maybe Double) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap Text Statistics)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int
- newDescribeDatasetImportJobResponse :: Int -> DescribeDatasetImportJobResponse
- data DescribeExplainability = DescribeExplainability' Text
- newDescribeExplainability :: Text -> DescribeExplainability
- data DescribeExplainabilityResponse = DescribeExplainabilityResponse' (Maybe POSIX) (Maybe DataSource) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ExplainabilityConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Schema) (Maybe Text) (Maybe Text) Int
- newDescribeExplainabilityResponse :: Int -> DescribeExplainabilityResponse
- data DescribeExplainabilityExport = DescribeExplainabilityExport' Text
- newDescribeExplainabilityExport :: Text -> DescribeExplainabilityExport
- data DescribeExplainabilityExportResponse = DescribeExplainabilityExportResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDescribeExplainabilityExportResponse :: Int -> DescribeExplainabilityExportResponse
- data DescribeForecast = DescribeForecast' Text
- newDescribeForecast :: Text -> DescribeForecast
- data DescribeForecastResponse = DescribeForecastResponse' (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeSeriesSelector) Int
- newDescribeForecastResponse :: Int -> DescribeForecastResponse
- data DescribeForecastExportJob = DescribeForecastExportJob' Text
- newDescribeForecastExportJob :: Text -> DescribeForecastExportJob
- data DescribeForecastExportJobResponse = DescribeForecastExportJobResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDescribeForecastExportJobResponse :: Int -> DescribeForecastExportJobResponse
- data DescribeMonitor = DescribeMonitor' Text
- newDescribeMonitor :: Text -> DescribeMonitor
- data DescribeMonitorResponse = DescribeMonitorResponse' (Maybe Baseline) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeMonitorResponse :: Int -> DescribeMonitorResponse
- data DescribePredictor = DescribePredictor' Text
- newDescribePredictor :: Text -> DescribePredictor
- data DescribePredictorResponse = DescribePredictorResponse' (Maybe Text) (Maybe [Text]) (Maybe AutoMLOverrideStrategy) (Maybe POSIX) (Maybe [Text]) (Maybe EncryptionConfig) (Maybe Integer) (Maybe EvaluationParameters) (Maybe FeaturizationConfig) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe HyperParameterTuningJobConfig) (Maybe InputDataConfig) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe OptimizationMetric) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe PredictorExecutionDetails) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribePredictorResponse :: Int -> DescribePredictorResponse
- data DescribePredictorBacktestExportJob = DescribePredictorBacktestExportJob' Text
- newDescribePredictorBacktestExportJob :: Text -> DescribePredictorBacktestExportJob
- data DescribePredictorBacktestExportJobResponse = DescribePredictorBacktestExportJobResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribePredictorBacktestExportJobResponse :: Int -> DescribePredictorBacktestExportJobResponse
- data DescribeWhatIfAnalysis = DescribeWhatIfAnalysis' Text
- newDescribeWhatIfAnalysis :: Text -> DescribeWhatIfAnalysis
- data DescribeWhatIfAnalysisResponse = DescribeWhatIfAnalysisResponse' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe TimeSeriesSelector) (Maybe Text) (Maybe Text) Int
- newDescribeWhatIfAnalysisResponse :: Int -> DescribeWhatIfAnalysisResponse
- data DescribeWhatIfForecast = DescribeWhatIfForecast' Text
- newDescribeWhatIfForecast :: Text -> DescribeWhatIfForecast
- data DescribeWhatIfForecastResponse = DescribeWhatIfForecastResponse' (Maybe POSIX) (Maybe Integer) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe TimeSeriesReplacementsDataSource) (Maybe [TimeSeriesTransformation]) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newDescribeWhatIfForecastResponse :: Int -> DescribeWhatIfForecastResponse
- data DescribeWhatIfForecastExport = DescribeWhatIfForecastExport' Text
- newDescribeWhatIfForecastExport :: Text -> DescribeWhatIfForecastExport
- data DescribeWhatIfForecastExportResponse = DescribeWhatIfForecastExportResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) Int
- newDescribeWhatIfForecastExportResponse :: Int -> DescribeWhatIfForecastExportResponse
- data GetAccuracyMetrics = GetAccuracyMetrics' Text
- newGetAccuracyMetrics :: Text -> GetAccuracyMetrics
- data GetAccuracyMetricsResponse = GetAccuracyMetricsResponse' (Maybe AutoMLOverrideStrategy) (Maybe Bool) (Maybe OptimizationMetric) (Maybe [EvaluationResult]) Int
- newGetAccuracyMetricsResponse :: Int -> GetAccuracyMetricsResponse
- data ListDatasetGroups = ListDatasetGroups' (Maybe Natural) (Maybe Text)
- newListDatasetGroups :: ListDatasetGroups
- data ListDatasetGroupsResponse = ListDatasetGroupsResponse' (Maybe [DatasetGroupSummary]) (Maybe Text) Int
- newListDatasetGroupsResponse :: Int -> ListDatasetGroupsResponse
- data ListDatasetImportJobs = ListDatasetImportJobs' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListDatasetImportJobs :: ListDatasetImportJobs
- data ListDatasetImportJobsResponse = ListDatasetImportJobsResponse' (Maybe [DatasetImportJobSummary]) (Maybe Text) Int
- newListDatasetImportJobsResponse :: Int -> ListDatasetImportJobsResponse
- data ListDatasets = ListDatasets' (Maybe Natural) (Maybe Text)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe [DatasetSummary]) (Maybe Text) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data ListExplainabilities = ListExplainabilities' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListExplainabilities :: ListExplainabilities
- data ListExplainabilitiesResponse = ListExplainabilitiesResponse' (Maybe [ExplainabilitySummary]) (Maybe Text) Int
- newListExplainabilitiesResponse :: Int -> ListExplainabilitiesResponse
- data ListExplainabilityExports = ListExplainabilityExports' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListExplainabilityExports :: ListExplainabilityExports
- data ListExplainabilityExportsResponse = ListExplainabilityExportsResponse' (Maybe [ExplainabilityExportSummary]) (Maybe Text) Int
- newListExplainabilityExportsResponse :: Int -> ListExplainabilityExportsResponse
- data ListForecastExportJobs = ListForecastExportJobs' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListForecastExportJobs :: ListForecastExportJobs
- data ListForecastExportJobsResponse = ListForecastExportJobsResponse' (Maybe [ForecastExportJobSummary]) (Maybe Text) Int
- newListForecastExportJobsResponse :: Int -> ListForecastExportJobsResponse
- data ListForecasts = ListForecasts' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListForecasts :: ListForecasts
- data ListForecastsResponse = ListForecastsResponse' (Maybe [ForecastSummary]) (Maybe Text) Int
- newListForecastsResponse :: Int -> ListForecastsResponse
- data ListMonitorEvaluations = ListMonitorEvaluations' (Maybe [Filter]) (Maybe Natural) (Maybe Text) Text
- newListMonitorEvaluations :: Text -> ListMonitorEvaluations
- data ListMonitorEvaluationsResponse = ListMonitorEvaluationsResponse' (Maybe Text) (Maybe [PredictorMonitorEvaluation]) Int
- newListMonitorEvaluationsResponse :: Int -> ListMonitorEvaluationsResponse
- data ListMonitors = ListMonitors' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListMonitors :: ListMonitors
- data ListMonitorsResponse = ListMonitorsResponse' (Maybe [MonitorSummary]) (Maybe Text) Int
- newListMonitorsResponse :: Int -> ListMonitorsResponse
- data ListPredictorBacktestExportJobs = ListPredictorBacktestExportJobs' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListPredictorBacktestExportJobs :: ListPredictorBacktestExportJobs
- data ListPredictorBacktestExportJobsResponse = ListPredictorBacktestExportJobsResponse' (Maybe Text) (Maybe [PredictorBacktestExportJobSummary]) Int
- newListPredictorBacktestExportJobsResponse :: Int -> ListPredictorBacktestExportJobsResponse
- data ListPredictors = ListPredictors' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListPredictors :: ListPredictors
- data ListPredictorsResponse = ListPredictorsResponse' (Maybe Text) (Maybe [PredictorSummary]) Int
- newListPredictorsResponse :: Int -> ListPredictorsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWhatIfAnalyses = ListWhatIfAnalyses' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListWhatIfAnalyses :: ListWhatIfAnalyses
- data ListWhatIfAnalysesResponse = ListWhatIfAnalysesResponse' (Maybe Text) (Maybe [WhatIfAnalysisSummary]) Int
- newListWhatIfAnalysesResponse :: Int -> ListWhatIfAnalysesResponse
- data ListWhatIfForecastExports = ListWhatIfForecastExports' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListWhatIfForecastExports :: ListWhatIfForecastExports
- data ListWhatIfForecastExportsResponse = ListWhatIfForecastExportsResponse' (Maybe Text) (Maybe [WhatIfForecastExportSummary]) Int
- newListWhatIfForecastExportsResponse :: Int -> ListWhatIfForecastExportsResponse
- data ListWhatIfForecasts = ListWhatIfForecasts' (Maybe [Filter]) (Maybe Natural) (Maybe Text)
- newListWhatIfForecasts :: ListWhatIfForecasts
- data ListWhatIfForecastsResponse = ListWhatIfForecastsResponse' (Maybe Text) (Maybe [WhatIfForecastSummary]) Int
- newListWhatIfForecastsResponse :: Int -> ListWhatIfForecastsResponse
- data ResumeResource = ResumeResource' Text
- newResumeResource :: Text -> ResumeResource
- data ResumeResourceResponse = ResumeResourceResponse' {
- newResumeResourceResponse :: ResumeResourceResponse
- data StopResource = StopResource' Text
- newStopResource :: Text -> StopResource
- data StopResourceResponse = StopResourceResponse' {
- newStopResourceResponse :: StopResourceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Sensitive Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDatasetGroup = UpdateDatasetGroup' Text [Text]
- newUpdateDatasetGroup :: Text -> UpdateDatasetGroup
- data UpdateDatasetGroupResponse = UpdateDatasetGroupResponse' Int
- newUpdateDatasetGroupResponse :: Int -> UpdateDatasetGroupResponse
- newtype AttributeType where
- AttributeType' { }
- pattern AttributeType_Float :: AttributeType
- pattern AttributeType_Geolocation :: AttributeType
- pattern AttributeType_Integer :: AttributeType
- pattern AttributeType_String :: AttributeType
- pattern AttributeType_Timestamp :: AttributeType
- newtype AutoMLOverrideStrategy where
- newtype Condition where
- Condition' { }
- pattern Condition_EQUALS :: Condition
- pattern Condition_GREATER_THAN :: Condition
- pattern Condition_LESS_THAN :: Condition
- pattern Condition_NOT_EQUALS :: Condition
- newtype DatasetType where
- DatasetType' { }
- pattern DatasetType_ITEM_METADATA :: DatasetType
- pattern DatasetType_RELATED_TIME_SERIES :: DatasetType
- pattern DatasetType_TARGET_TIME_SERIES :: DatasetType
- newtype DayOfWeek where
- DayOfWeek' { }
- pattern DayOfWeek_FRIDAY :: DayOfWeek
- pattern DayOfWeek_MONDAY :: DayOfWeek
- pattern DayOfWeek_SATURDAY :: DayOfWeek
- pattern DayOfWeek_SUNDAY :: DayOfWeek
- pattern DayOfWeek_THURSDAY :: DayOfWeek
- pattern DayOfWeek_TUESDAY :: DayOfWeek
- pattern DayOfWeek_WEDNESDAY :: DayOfWeek
- newtype Domain where
- Domain' {
- fromDomain :: Text
- pattern Domain_CUSTOM :: Domain
- pattern Domain_EC2_CAPACITY :: Domain
- pattern Domain_INVENTORY_PLANNING :: Domain
- pattern Domain_METRICS :: Domain
- pattern Domain_RETAIL :: Domain
- pattern Domain_WEB_TRAFFIC :: Domain
- pattern Domain_WORK_FORCE :: Domain
- Domain' {
- newtype EvaluationType where
- EvaluationType' { }
- pattern EvaluationType_COMPUTED :: EvaluationType
- pattern EvaluationType_SUMMARY :: EvaluationType
- newtype FeaturizationMethodName where
- newtype FilterConditionString where
- newtype Month where
- Month' { }
- pattern Month_APRIL :: Month
- pattern Month_AUGUST :: Month
- pattern Month_DECEMBER :: Month
- pattern Month_FEBRUARY :: Month
- pattern Month_JANUARY :: Month
- pattern Month_JULY :: Month
- pattern Month_JUNE :: Month
- pattern Month_MARCH :: Month
- pattern Month_MAY :: Month
- pattern Month_NOVEMBER :: Month
- pattern Month_OCTOBER :: Month
- pattern Month_SEPTEMBER :: Month
- newtype Operation where
- Operation' { }
- pattern Operation_ADD :: Operation
- pattern Operation_DIVIDE :: Operation
- pattern Operation_MULTIPLY :: Operation
- pattern Operation_SUBTRACT :: Operation
- newtype OptimizationMetric where
- OptimizationMetric' { }
- pattern OptimizationMetric_AverageWeightedQuantileLoss :: OptimizationMetric
- pattern OptimizationMetric_MAPE :: OptimizationMetric
- pattern OptimizationMetric_MASE :: OptimizationMetric
- pattern OptimizationMetric_RMSE :: OptimizationMetric
- pattern OptimizationMetric_WAPE :: OptimizationMetric
- newtype ScalingType where
- ScalingType' { }
- pattern ScalingType_Auto :: ScalingType
- pattern ScalingType_Linear :: ScalingType
- pattern ScalingType_Logarithmic :: ScalingType
- pattern ScalingType_ReverseLogarithmic :: ScalingType
- newtype State where
- State' { }
- pattern State_Active :: State
- pattern State_Deleted :: State
- newtype TimePointGranularity where
- newtype TimeSeriesGranularity where
- data Action = Action' Text Operation Double
- newAction :: Text -> Operation -> Double -> Action
- data AdditionalDataset = AdditionalDataset' (Maybe (HashMap Text (NonEmpty Text))) Text
- newAdditionalDataset :: Text -> AdditionalDataset
- data AttributeConfig = AttributeConfig' Text (HashMap Text Text)
- newAttributeConfig :: Text -> AttributeConfig
- data Baseline = Baseline' (Maybe PredictorBaseline)
- newBaseline :: Baseline
- data BaselineMetric = BaselineMetric' (Maybe Text) (Maybe Double)
- newBaselineMetric :: BaselineMetric
- data CategoricalParameterRange = CategoricalParameterRange' Text (NonEmpty Text)
- newCategoricalParameterRange :: Text -> NonEmpty Text -> CategoricalParameterRange
- data ContinuousParameterRange = ContinuousParameterRange' (Maybe ScalingType) Text Double Double
- newContinuousParameterRange :: Text -> Double -> Double -> ContinuousParameterRange
- data DataConfig = DataConfig' (Maybe (NonEmpty AdditionalDataset)) (Maybe (NonEmpty AttributeConfig)) Text
- newDataConfig :: Text -> DataConfig
- data DataDestination = DataDestination' S3Config
- newDataDestination :: S3Config -> DataDestination
- data DataSource = DataSource' S3Config
- newDataSource :: S3Config -> DataSource
- data DatasetGroupSummary = DatasetGroupSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX)
- newDatasetGroupSummary :: DatasetGroupSummary
- data DatasetImportJobSummary = DatasetImportJobSummary' (Maybe POSIX) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newDatasetImportJobSummary :: DatasetImportJobSummary
- data DatasetSummary = DatasetSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DatasetType) (Maybe Domain) (Maybe POSIX)
- newDatasetSummary :: DatasetSummary
- data EncryptionConfig = EncryptionConfig' Text Text
- newEncryptionConfig :: Text -> Text -> EncryptionConfig
- data ErrorMetric = ErrorMetric' (Maybe Text) (Maybe Double) (Maybe Double) (Maybe Double) (Maybe Double)
- newErrorMetric :: ErrorMetric
- data EvaluationParameters = EvaluationParameters' (Maybe Int) (Maybe Int)
- newEvaluationParameters :: EvaluationParameters
- data EvaluationResult = EvaluationResult' (Maybe Text) (Maybe [WindowSummary])
- newEvaluationResult :: EvaluationResult
- data ExplainabilityConfig = ExplainabilityConfig' TimeSeriesGranularity TimePointGranularity
- newExplainabilityConfig :: TimeSeriesGranularity -> TimePointGranularity -> ExplainabilityConfig
- data ExplainabilityExportSummary = ExplainabilityExportSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newExplainabilityExportSummary :: ExplainabilityExportSummary
- data ExplainabilityInfo = ExplainabilityInfo' (Maybe Text) (Maybe Text)
- newExplainabilityInfo :: ExplainabilityInfo
- data ExplainabilitySummary = ExplainabilitySummary' (Maybe POSIX) (Maybe Text) (Maybe ExplainabilityConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newExplainabilitySummary :: ExplainabilitySummary
- data Featurization = Featurization' (Maybe (NonEmpty FeaturizationMethod)) Text
- newFeaturization :: Text -> Featurization
- data FeaturizationConfig = FeaturizationConfig' (Maybe (NonEmpty Featurization)) (Maybe (NonEmpty Text)) Text
- newFeaturizationConfig :: Text -> FeaturizationConfig
- data FeaturizationMethod = FeaturizationMethod' (Maybe (HashMap Text Text)) FeaturizationMethodName
- newFeaturizationMethod :: FeaturizationMethodName -> FeaturizationMethod
- data Filter = Filter' Text Text FilterConditionString
- newFilter :: Text -> Text -> FilterConditionString -> Filter
- data ForecastExportJobSummary = ForecastExportJobSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newForecastExportJobSummary :: ForecastExportJobSummary
- data ForecastSummary = ForecastSummary' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newForecastSummary :: ForecastSummary
- data HyperParameterTuningJobConfig = HyperParameterTuningJobConfig' (Maybe ParameterRanges)
- newHyperParameterTuningJobConfig :: HyperParameterTuningJobConfig
- data InputDataConfig = InputDataConfig' (Maybe (NonEmpty SupplementaryFeature)) Text
- newInputDataConfig :: Text -> InputDataConfig
- data IntegerParameterRange = IntegerParameterRange' (Maybe ScalingType) Text Int Int
- newIntegerParameterRange :: Text -> Int -> Int -> IntegerParameterRange
- data MetricResult = MetricResult' (Maybe Text) (Maybe Double)
- newMetricResult :: MetricResult
- data Metrics = Metrics' (Maybe Double) (Maybe [ErrorMetric]) (Maybe Double) (Maybe [WeightedQuantileLoss])
- newMetrics :: Metrics
- data MonitorConfig = MonitorConfig' Text
- newMonitorConfig :: Text -> MonitorConfig
- data MonitorDataSource = MonitorDataSource' (Maybe Text) (Maybe Text) (Maybe Text)
- newMonitorDataSource :: MonitorDataSource
- data MonitorInfo = MonitorInfo' (Maybe Text) (Maybe Text)
- newMonitorInfo :: MonitorInfo
- data MonitorSummary = MonitorSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newMonitorSummary :: MonitorSummary
- data ParameterRanges = ParameterRanges' (Maybe (NonEmpty CategoricalParameterRange)) (Maybe (NonEmpty ContinuousParameterRange)) (Maybe (NonEmpty IntegerParameterRange))
- newParameterRanges :: ParameterRanges
- data PredictorBacktestExportJobSummary = PredictorBacktestExportJobSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newPredictorBacktestExportJobSummary :: PredictorBacktestExportJobSummary
- data PredictorBaseline = PredictorBaseline' (Maybe [BaselineMetric])
- newPredictorBaseline :: PredictorBaseline
- data PredictorEvent = PredictorEvent' (Maybe POSIX) (Maybe Text)
- newPredictorEvent :: PredictorEvent
- data PredictorExecution = PredictorExecution' (Maybe Text) (Maybe [TestWindowSummary])
- newPredictorExecution :: PredictorExecution
- data PredictorExecutionDetails = PredictorExecutionDetails' (Maybe (NonEmpty PredictorExecution))
- newPredictorExecutionDetails :: PredictorExecutionDetails
- data PredictorMonitorEvaluation = PredictorMonitorEvaluation' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [MetricResult]) (Maybe Text) (Maybe MonitorDataSource) (Maybe Integer) (Maybe PredictorEvent) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newPredictorMonitorEvaluation :: PredictorMonitorEvaluation
- data PredictorSummary = PredictorSummary' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReferencePredictorSummary) (Maybe Text)
- newPredictorSummary :: PredictorSummary
- data ReferencePredictorSummary = ReferencePredictorSummary' (Maybe Text) (Maybe State)
- newReferencePredictorSummary :: ReferencePredictorSummary
- data S3Config = S3Config' (Maybe Text) Text Text
- newS3Config :: Text -> Text -> S3Config
- data Schema = Schema' (Maybe (NonEmpty SchemaAttribute))
- newSchema :: Schema
- data SchemaAttribute = SchemaAttribute' (Maybe Text) (Maybe AttributeType)
- newSchemaAttribute :: SchemaAttribute
- data Statistics = Statistics' (Maybe Double) (Maybe Int) (Maybe Int) (Maybe Integer) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Double)
- newStatistics :: Statistics
- data SupplementaryFeature = SupplementaryFeature' Text Text
- newSupplementaryFeature :: Text -> Text -> SupplementaryFeature
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
- data TestWindowSummary = TestWindowSummary' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe POSIX)
- newTestWindowSummary :: TestWindowSummary
- data TimeAlignmentBoundary = TimeAlignmentBoundary' (Maybe Natural) (Maybe DayOfWeek) (Maybe Natural) (Maybe Month)
- newTimeAlignmentBoundary :: TimeAlignmentBoundary
- data TimeSeriesCondition = TimeSeriesCondition' Text Text Condition
- newTimeSeriesCondition :: Text -> Text -> Condition -> TimeSeriesCondition
- data TimeSeriesIdentifiers = TimeSeriesIdentifiers' (Maybe DataSource) (Maybe Text) (Maybe Schema)
- newTimeSeriesIdentifiers :: TimeSeriesIdentifiers
- data TimeSeriesReplacementsDataSource = TimeSeriesReplacementsDataSource' (Maybe Text) (Maybe Text) S3Config Schema
- newTimeSeriesReplacementsDataSource :: S3Config -> Schema -> TimeSeriesReplacementsDataSource
- data TimeSeriesSelector = TimeSeriesSelector' (Maybe TimeSeriesIdentifiers)
- newTimeSeriesSelector :: TimeSeriesSelector
- data TimeSeriesTransformation = TimeSeriesTransformation' (Maybe Action) (Maybe [TimeSeriesCondition])
- newTimeSeriesTransformation :: TimeSeriesTransformation
- data WeightedQuantileLoss = WeightedQuantileLoss' (Maybe Double) (Maybe Double)
- newWeightedQuantileLoss :: WeightedQuantileLoss
- data WhatIfAnalysisSummary = WhatIfAnalysisSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newWhatIfAnalysisSummary :: WhatIfAnalysisSummary
- data WhatIfForecastExportSummary = WhatIfForecastExportSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text)
- newWhatIfForecastExportSummary :: WhatIfForecastExportSummary
- data WhatIfForecastSummary = WhatIfForecastSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newWhatIfForecastSummary :: WhatIfForecastSummary
- data WindowSummary = WindowSummary' (Maybe EvaluationType) (Maybe Int) (Maybe Metrics) (Maybe POSIX) (Maybe POSIX)
- newWindowSummary :: WindowSummary
Service Configuration
defaultService :: Service Source #
API version 2018-06-26
of the Amazon Forecast Service SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Forecast
.
InvalidInputException
_InvalidInputException :: AsError a => Fold a ServiceError Source #
We can't process the request because it includes an invalid value or a value that exceeds the valid range.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The token is not valid. Tokens expire after 24 hours.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The limit on the number of resources per account has been exceeded.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Fold a ServiceError Source #
There is already a resource with this name. Try again with a different name.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The specified resource is in use.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateAutoPredictor
data CreateAutoPredictor Source #
See: newCreateAutoPredictor
smart constructor.
Constructors
CreateAutoPredictor' (Maybe DataConfig) (Maybe EncryptionConfig) (Maybe Bool) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe MonitorConfig) (Maybe OptimizationMetric) (Maybe Text) (Maybe [Tag]) (Maybe TimeAlignmentBoundary) Text |
Instances
newCreateAutoPredictor Source #
Arguments
:: Text | |
-> CreateAutoPredictor |
Create a value of CreateAutoPredictor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataConfig:CreateAutoPredictor'
, createAutoPredictor_dataConfig
- The data configuration for your dataset group and any additional
datasets.
$sel:encryptionConfig:CreateAutoPredictor'
, createAutoPredictor_encryptionConfig
- Undocumented member.
$sel:explainPredictor:CreateAutoPredictor'
, createAutoPredictor_explainPredictor
- Create an Explainability resource for the predictor.
CreateAutoPredictor
, createAutoPredictor_forecastDimensions
- 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
, createAutoPredictor_forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
$sel:forecastHorizon:CreateAutoPredictor'
, createAutoPredictor_forecastHorizon
- 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.
$sel:forecastTypes:CreateAutoPredictor'
, createAutoPredictor_forecastTypes
- 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
.
$sel:monitorConfig:CreateAutoPredictor'
, createAutoPredictor_monitorConfig
- 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.
$sel:optimizationMetric:CreateAutoPredictor'
, createAutoPredictor_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:referencePredictorArn:CreateAutoPredictor'
, createAutoPredictor_referencePredictorArn
- 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.
$sel:tags:CreateAutoPredictor'
, createAutoPredictor_tags
- 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.
$sel:timeAlignmentBoundary:CreateAutoPredictor'
, createAutoPredictor_timeAlignmentBoundary
- 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
, createAutoPredictor_predictorName
- A unique name for the predictor
data CreateAutoPredictorResponse Source #
See: newCreateAutoPredictorResponse
smart constructor.
Constructors
CreateAutoPredictorResponse' (Maybe Text) Int |
Instances
newCreateAutoPredictorResponse Source #
Create a value of CreateAutoPredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAutoPredictorResponse
, createAutoPredictorResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
$sel:httpStatus:CreateAutoPredictorResponse'
, createAutoPredictorResponse_httpStatus
- The response's http status code.
CreateDataset
data CreateDataset Source #
See: newCreateDataset
smart constructor.
Constructors
CreateDataset' (Maybe Text) (Maybe EncryptionConfig) (Maybe [Tag]) Text Domain DatasetType Schema |
Instances
Arguments
:: Text | |
-> Domain | |
-> DatasetType | |
-> Schema | |
-> CreateDataset |
Create a value of CreateDataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataFrequency:CreateDataset'
, createDataset_dataFrequency
- The frequency of data collection. This parameter is required for
RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.
$sel:encryptionConfig:CreateDataset'
, createDataset_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:tags:CreateDataset'
, createDataset_tags
- The optional metadata that you apply to the dataset to help you
categorize and organize them. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
CreateDataset
, createDataset_datasetName
- A name for the dataset.
CreateDataset
, createDataset_domain
- The domain associated with the dataset. When you add a dataset to a
dataset group, this value and the value specified for the Domain
parameter of the
CreateDatasetGroup
operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in the training data that you import to the dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires item_id
, timestamp
, and
demand
fields to be present in your data. For more information, see
Importing datasets.
CreateDataset
, createDataset_datasetType
- The dataset type. Valid values depend on the chosen Domain
.
CreateDataset
, createDataset_schema
- The schema for the dataset. The schema attributes and their order must
match the fields in your data. The dataset Domain
and DatasetType
that you choose determine the minimum required fields in your training
data. For information about the required fields for a specific dataset
domain and type, see
Dataset Domains and Dataset Types.
data CreateDatasetResponse Source #
See: newCreateDatasetResponse
smart constructor.
Constructors
CreateDatasetResponse' (Maybe Text) Int |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDatasetResponse
, createDatasetResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:httpStatus:CreateDatasetResponse'
, createDatasetResponse_httpStatus
- The response's http status code.
CreateDatasetGroup
data CreateDatasetGroup Source #
See: newCreateDatasetGroup
smart constructor.
Instances
newCreateDatasetGroup Source #
Arguments
:: Text | |
-> Domain | |
-> CreateDatasetGroup |
Create a value of CreateDatasetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetArns:CreateDatasetGroup'
, createDatasetGroup_datasetArns
- An array of Amazon Resource Names (ARNs) of the datasets that you want
to include in the dataset group.
$sel:tags:CreateDatasetGroup'
, createDatasetGroup_tags
- The optional metadata that you apply to the dataset group to help you
categorize and organize them. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
CreateDatasetGroup
, createDatasetGroup_datasetGroupName
- A name for the dataset group.
CreateDatasetGroup
, createDatasetGroup_domain
- The domain associated with the dataset group. When you add a dataset to
a dataset group, this value and the value specified for the Domain
parameter of the
CreateDataset
operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in training data that you import to a dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires that item_id
, timestamp
,
and demand
fields are present in your data. For more information, see
Dataset groups.
data CreateDatasetGroupResponse Source #
See: newCreateDatasetGroupResponse
smart constructor.
Constructors
CreateDatasetGroupResponse' (Maybe Text) Int |
Instances
newCreateDatasetGroupResponse Source #
Create a value of CreateDatasetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDatasetGroupResponse
, createDatasetGroupResponse_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
$sel:httpStatus:CreateDatasetGroupResponse'
, createDatasetGroupResponse_httpStatus
- The response's http status code.
CreateDatasetImportJob
data CreateDatasetImportJob Source #
See: newCreateDatasetImportJob
smart constructor.
Constructors
CreateDatasetImportJob' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe Text) (Maybe Text) (Maybe Bool) Text Text DataSource |
Instances
newCreateDatasetImportJob Source #
Arguments
:: Text | |
-> Text | |
-> DataSource | |
-> CreateDatasetImportJob |
Create a value of CreateDatasetImportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDatasetImportJob
, createDatasetImportJob_format
- The format of the imported data, CSV or PARQUET. The default value is
CSV.
$sel:geolocationFormat:CreateDatasetImportJob'
, createDatasetImportJob_geolocationFormat
- The format of the geolocation attribute. The geolocation attribute can
be formatted in one of two ways:
LAT_LONG
- the latitude and longitude in decimal format (Example: 47.61_-122.33).CC_POSTALCODE
(US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).
$sel:tags:CreateDatasetImportJob'
, createDatasetImportJob_tags
- The optional metadata that you apply to the dataset import job to help
you categorize and organize them. Each tag consists of a key and an
optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
$sel:timeZone:CreateDatasetImportJob'
, createDatasetImportJob_timeZone
- A single time zone for every item in your dataset. This option is ideal
for datasets with all timestamps within a single time zone, or if all
timestamps are normalized to a single time zone.
Refer to the Joda-Time API for a complete list of valid time zone names.
CreateDatasetImportJob
, createDatasetImportJob_timestampFormat
- The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
$sel:useGeolocationForTimeZone:CreateDatasetImportJob'
, createDatasetImportJob_useGeolocationForTimeZone
- Automatically derive time zone information from the geolocation
attribute. This option is ideal for datasets that contain timestamps in
multiple time zones and those timestamps are expressed in local time.
CreateDatasetImportJob
, createDatasetImportJob_datasetImportJobName
- The name for the dataset import job. We recommend including the current
timestamp in the name, for example, 20190721DatasetImport
. This can
help you avoid getting a ResourceAlreadyExistsException
exception.
CreateDatasetImportJob
, createDatasetImportJob_datasetArn
- The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you
want to import data to.
CreateDatasetImportJob
, createDatasetImportJob_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
must include an AWS Key Management
Service (KMS) key and the IAM role must allow Amazon Forecast permission
to access the key. The KMS key and IAM role must match those specified
in the EncryptionConfig
parameter of the
CreateDataset
operation.
data CreateDatasetImportJobResponse Source #
See: newCreateDatasetImportJobResponse
smart constructor.
Constructors
CreateDatasetImportJobResponse' (Maybe Text) Int |
Instances
newCreateDatasetImportJobResponse Source #
Create a value of CreateDatasetImportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDatasetImportJobResponse
, createDatasetImportJobResponse_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
$sel:httpStatus:CreateDatasetImportJobResponse'
, createDatasetImportJobResponse_httpStatus
- The response's http status code.
CreateExplainability
data CreateExplainability Source #
See: newCreateExplainability
smart constructor.
Constructors
CreateExplainability' (Maybe DataSource) (Maybe Bool) (Maybe Text) (Maybe Schema) (Maybe Text) (Maybe [Tag]) Text Text ExplainabilityConfig |
Instances
newCreateExplainability Source #
Arguments
:: Text | |
-> Text | |
-> ExplainabilityConfig | |
-> CreateExplainability |
Create a value of CreateExplainability
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainability
, createExplainability_dataSource
- Undocumented member.
$sel:enableVisualization:CreateExplainability'
, createExplainability_enableVisualization
- Create an Explainability visualization that is viewable within the AWS
console.
$sel:endDateTime:CreateExplainability'
, createExplainability_endDateTime
- 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
, createExplainability_schema
- Undocumented member.
$sel:startDateTime:CreateExplainability'
, createExplainability_startDateTime
- 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)
$sel:tags:CreateExplainability'
, createExplainability_tags
- 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
, createExplainability_explainabilityName
- A unique name for the Explainability.
CreateExplainability
, createExplainability_resourceArn
- The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability.
CreateExplainability
, createExplainability_explainabilityConfig
- The configuration settings that define the granularity of time series
and time points for the Explainability.
data CreateExplainabilityResponse Source #
See: newCreateExplainabilityResponse
smart constructor.
Constructors
CreateExplainabilityResponse' (Maybe Text) Int |
Instances
newCreateExplainabilityResponse Source #
Create a value of CreateExplainabilityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainabilityResponse
, createExplainabilityResponse_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability.
$sel:httpStatus:CreateExplainabilityResponse'
, createExplainabilityResponse_httpStatus
- The response's http status code.
CreateExplainabilityExport
data CreateExplainabilityExport Source #
See: newCreateExplainabilityExport
smart constructor.
Constructors
CreateExplainabilityExport' (Maybe Text) (Maybe [Tag]) Text Text DataDestination |
Instances
newCreateExplainabilityExport Source #
Arguments
:: Text | |
-> Text | |
-> DataDestination | |
-> CreateExplainabilityExport |
Create a value of CreateExplainabilityExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainabilityExport
, createExplainabilityExport_format
- The format of the exported data, CSV or PARQUET.
$sel:tags:CreateExplainabilityExport'
, createExplainabilityExport_tags
- 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
, createExplainabilityExport_explainabilityExportName
- A unique name for the Explainability export.
CreateExplainabilityExport
, createExplainabilityExport_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability to export.
CreateExplainabilityExport
, createExplainabilityExport_destination
- Undocumented member.
data CreateExplainabilityExportResponse Source #
See: newCreateExplainabilityExportResponse
smart constructor.
Constructors
CreateExplainabilityExportResponse' (Maybe Text) Int |
Instances
newCreateExplainabilityExportResponse Source #
Arguments
:: Int | |
-> CreateExplainabilityExportResponse |
Create a value of CreateExplainabilityExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateExplainabilityExportResponse
, createExplainabilityExportResponse_explainabilityExportArn
- The Amazon Resource Name (ARN) of the export.
$sel:httpStatus:CreateExplainabilityExportResponse'
, createExplainabilityExportResponse_httpStatus
- The response's http status code.
CreateForecast
data CreateForecast Source #
See: newCreateForecast
smart constructor.
Constructors
CreateForecast' (Maybe (NonEmpty Text)) (Maybe [Tag]) (Maybe TimeSeriesSelector) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateForecast |
Create a value of CreateForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecastTypes:CreateForecast'
, createForecast_forecastTypes
- The quantiles at which probabilistic forecasts are generated. __You can
currently specify up to 5 quantiles per forecast__. Accepted values
include 0.01 to 0.99
(increments of .01 only) and mean
. The mean
forecast is different from the median (0.50) when the distribution is
not symmetric (for example, Beta and Negative Binomial).
The default quantiles are the quantiles you specified during predictor
creation. If you didn't specify quantiles, the default values are
["0.1", "0.5", "0.9"]
.
$sel:tags:CreateForecast'
, createForecast_tags
- The optional metadata that you apply to the forecast to help you
categorize and organize them. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
$sel:timeSeriesSelector:CreateForecast'
, createForecast_timeSeriesSelector
- Defines the set of time series that are used to create the forecasts in
a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
DataSource
Format
Schema
CreateForecast
, createForecast_forecastName
- A name for the forecast.
CreateForecast
, createForecast_predictorArn
- The Amazon Resource Name (ARN) of the predictor to use to generate the
forecast.
data CreateForecastResponse Source #
See: newCreateForecastResponse
smart constructor.
Constructors
CreateForecastResponse' (Maybe Text) Int |
Instances
newCreateForecastResponse Source #
Create a value of CreateForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateForecastResponse
, createForecastResponse_forecastArn
- The Amazon Resource Name (ARN) of the forecast.
$sel:httpStatus:CreateForecastResponse'
, createForecastResponse_httpStatus
- The response's http status code.
CreateForecastExportJob
data CreateForecastExportJob Source #
See: newCreateForecastExportJob
smart constructor.
Constructors
CreateForecastExportJob' (Maybe Text) (Maybe [Tag]) Text Text DataDestination |
Instances
newCreateForecastExportJob Source #
Arguments
:: Text | |
-> Text | |
-> DataDestination | |
-> CreateForecastExportJob |
Create a value of CreateForecastExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateForecastExportJob
, createForecastExportJob_format
- The format of the exported data, CSV or PARQUET. The default value is
CSV.
$sel:tags:CreateForecastExportJob'
, createForecastExportJob_tags
- The optional metadata that you apply to the forecast export job to help
you categorize and organize them. Each tag consists of a key and an
optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
CreateForecastExportJob
, createForecastExportJob_forecastExportJobName
- The name for the forecast export job.
CreateForecastExportJob
, createForecastExportJob_forecastArn
- The Amazon Resource Name (ARN) of the forecast that you want to export.
CreateForecastExportJob
, createForecastExportJob_destination
- The location where you want to save the forecast and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
data CreateForecastExportJobResponse Source #
See: newCreateForecastExportJobResponse
smart constructor.
Constructors
CreateForecastExportJobResponse' (Maybe Text) Int |
Instances
newCreateForecastExportJobResponse Source #
Create a value of CreateForecastExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateForecastExportJobResponse
, createForecastExportJobResponse_forecastExportJobArn
- The Amazon Resource Name (ARN) of the export job.
$sel:httpStatus:CreateForecastExportJobResponse'
, createForecastExportJobResponse_httpStatus
- The response's http status code.
CreateMonitor
data CreateMonitor Source #
See: newCreateMonitor
smart constructor.
Constructors
CreateMonitor' (Maybe [Tag]) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateMonitor |
Create a value of CreateMonitor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateMonitor'
, createMonitor_tags
- A list of
tags
to apply to the monitor resource.
CreateMonitor
, createMonitor_monitorName
- The name of the monitor resource.
CreateMonitor
, createMonitor_resourceArn
- The Amazon Resource Name (ARN) of the predictor to monitor.
data CreateMonitorResponse Source #
See: newCreateMonitorResponse
smart constructor.
Constructors
CreateMonitorResponse' (Maybe Text) Int |
Instances
newCreateMonitorResponse Source #
Create a value of CreateMonitorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateMonitorResponse
, createMonitorResponse_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource.
$sel:httpStatus:CreateMonitorResponse'
, createMonitorResponse_httpStatus
- The response's http status code.
CreatePredictor
data CreatePredictor Source #
See: newCreatePredictor
smart constructor.
Constructors
Instances
Arguments
:: Text | |
-> Int | |
-> InputDataConfig | |
-> FeaturizationConfig | |
-> CreatePredictor |
Create a value of CreatePredictor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreatePredictor
, createPredictor_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm to use for model
training. Required if PerformAutoML
is not set to true
.
Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA
arn:aws:forecast:::algorithm/CNN-QR
arn:aws:forecast:::algorithm/Deep_AR_Plus
arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS
arn:aws:forecast:::algorithm/Prophet
$sel:autoMLOverrideStrategy:CreatePredictor'
, createPredictor_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
Used to overide the default AutoML strategy, which is to optimize
predictor accuracy. To apply an AutoML strategy that minimizes training
time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
$sel:encryptionConfig:CreatePredictor'
, createPredictor_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:evaluationParameters:CreatePredictor'
, createPredictor_evaluationParameters
- Used to override the default evaluation parameters of the specified
algorithm. Amazon Forecast evaluates a predictor by splitting a dataset
into training data and testing data. The evaluation parameters define
how to perform the split and the number of iterations.
$sel:forecastTypes:CreatePredictor'
, createPredictor_forecastTypes
- Specifies the forecast types used to train a predictor. You can specify
up to five forecast types. Forecast types can be quantiles from 0.01 to
0.99, by increments of 0.01 or higher. You can also specify the mean
forecast with mean
.
The default value is ["0.10", "0.50", "0.9"]
.
$sel:hPOConfig:CreatePredictor'
, createPredictor_hPOConfig
- Provides hyperparameter override values for the algorithm. If you don't
provide this parameter, Amazon Forecast uses default values. The
individual algorithms specify which hyperparameters support
hyperparameter optimization (HPO). For more information, see
aws-forecast-choosing-recipes.
If you included the HPOConfig
object, you must set PerformHPO
to
true.
$sel:optimizationMetric:CreatePredictor'
, createPredictor_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:performAutoML:CreatePredictor'
, createPredictor_performAutoML
- Whether to perform AutoML. When Amazon Forecast performs AutoML, it
evaluates the algorithms it provides and chooses the best algorithm and
configuration for your training dataset.
The default value is false
. In this case, you are required to specify
an algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML.
This is a good option if you aren't sure which algorithm is suitable
for your training data. In this case, PerformHPO
must be false.
$sel:performHPO:CreatePredictor'
, createPredictor_performHPO
- Whether to perform hyperparameter optimization (HPO). HPO finds optimal
hyperparameter values for your training data. The process of performing
HPO is known as running a hyperparameter tuning job.
The default value is false
. In this case, Amazon Forecast uses default
hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,
optionally, supply the HyperParameterTuningJobConfig object. The tuning
job specifies a metric to optimize, which hyperparameters participate in
tuning, and the valid range for each tunable hyperparameter. In this
case, you are required to specify an algorithm and PerformAutoML
must
be false.
The following algorithms support HPO:
- DeepAR+
- CNN-QR
$sel:tags:CreatePredictor'
, createPredictor_tags
- The optional metadata that you apply to the predictor to help you
categorize and organize them. Each tag consists of a key and an optional
value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
$sel:trainingParameters:CreatePredictor'
, createPredictor_trainingParameters
- The hyperparameters to override for model training. The hyperparameters
that you can override are listed in the individual algorithms. For the
list of supported algorithms, see aws-forecast-choosing-recipes.
CreatePredictor
, createPredictor_predictorName
- A name for the predictor.
$sel:forecastHorizon:CreatePredictor'
, createPredictor_forecastHorizon
- Specifies the number of time-steps that the model is trained to predict.
The forecast horizon is also called the prediction length.
For example, if you configure a dataset for daily data collection (using
the DataFrequency
parameter of the CreateDataset operation) and set
the forecast horizon to 10, the model returns predictions for 10 days.
The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
$sel:inputDataConfig:CreatePredictor'
, createPredictor_inputDataConfig
- Describes the dataset group that contains the data to use to train the
predictor.
$sel:featurizationConfig:CreatePredictor'
, createPredictor_featurizationConfig
- The featurization configuration.
data CreatePredictorResponse Source #
See: newCreatePredictorResponse
smart constructor.
Constructors
CreatePredictorResponse' (Maybe Text) Int |
Instances
newCreatePredictorResponse Source #
Create a value of CreatePredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreatePredictorResponse
, createPredictorResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
$sel:httpStatus:CreatePredictorResponse'
, createPredictorResponse_httpStatus
- The response's http status code.
CreatePredictorBacktestExportJob
data CreatePredictorBacktestExportJob Source #
See: newCreatePredictorBacktestExportJob
smart constructor.
Constructors
CreatePredictorBacktestExportJob' (Maybe Text) (Maybe [Tag]) Text Text DataDestination |
Instances
newCreatePredictorBacktestExportJob Source #
Arguments
:: Text | |
-> Text | |
-> DataDestination | |
-> CreatePredictorBacktestExportJob |
Create a value of CreatePredictorBacktestExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreatePredictorBacktestExportJob
, createPredictorBacktestExportJob_format
- The format of the exported data, CSV or PARQUET. The default value is
CSV.
$sel:tags:CreatePredictorBacktestExportJob'
, createPredictorBacktestExportJob_tags
- Optional metadata to help you categorize and organize your backtests.
Each tag consists of a key and an optional value, both of which you
define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
CreatePredictorBacktestExportJob
, createPredictorBacktestExportJob_predictorBacktestExportJobName
- The name for the backtest export job.
CreatePredictorBacktestExportJob
, createPredictorBacktestExportJob_predictorArn
- The Amazon Resource Name (ARN) of the predictor that you want to export.
CreatePredictorBacktestExportJob
, createPredictorBacktestExportJob_destination
- Undocumented member.
data CreatePredictorBacktestExportJobResponse Source #
See: newCreatePredictorBacktestExportJobResponse
smart constructor.
Constructors
CreatePredictorBacktestExportJobResponse' (Maybe Text) Int |
Instances
newCreatePredictorBacktestExportJobResponse Source #
Arguments
:: Int | |
-> CreatePredictorBacktestExportJobResponse |
Create a value of CreatePredictorBacktestExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreatePredictorBacktestExportJobResponse
, createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job that
you want to export.
$sel:httpStatus:CreatePredictorBacktestExportJobResponse'
, createPredictorBacktestExportJobResponse_httpStatus
- The response's http status code.
CreateWhatIfAnalysis
data CreateWhatIfAnalysis Source #
See: newCreateWhatIfAnalysis
smart constructor.
Constructors
CreateWhatIfAnalysis' (Maybe [Tag]) (Maybe TimeSeriesSelector) Text Text |
Instances
newCreateWhatIfAnalysis Source #
Arguments
:: Text | |
-> Text | |
-> CreateWhatIfAnalysis |
Create a value of CreateWhatIfAnalysis
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateWhatIfAnalysis'
, createWhatIfAnalysis_tags
- A list of
tags
to apply to the what if forecast.
$sel:timeSeriesSelector:CreateWhatIfAnalysis'
, createWhatIfAnalysis_timeSeriesSelector
- 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
, createWhatIfAnalysis_whatIfAnalysisName
- The name of the what-if analysis. Each name must be unique.
CreateWhatIfAnalysis
, createWhatIfAnalysis_forecastArn
- The Amazon Resource Name (ARN) of the baseline forecast.
data CreateWhatIfAnalysisResponse Source #
See: newCreateWhatIfAnalysisResponse
smart constructor.
Constructors
CreateWhatIfAnalysisResponse' (Maybe Text) Int |
Instances
newCreateWhatIfAnalysisResponse Source #
Create a value of CreateWhatIfAnalysisResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWhatIfAnalysisResponse
, createWhatIfAnalysisResponse_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis.
$sel:httpStatus:CreateWhatIfAnalysisResponse'
, createWhatIfAnalysisResponse_httpStatus
- The response's http status code.
CreateWhatIfForecast
data CreateWhatIfForecast Source #
See: newCreateWhatIfForecast
smart constructor.
Constructors
CreateWhatIfForecast' (Maybe [Tag]) (Maybe TimeSeriesReplacementsDataSource) (Maybe [TimeSeriesTransformation]) Text Text |
Instances
newCreateWhatIfForecast Source #
Arguments
:: Text | |
-> Text | |
-> CreateWhatIfForecast |
Create a value of CreateWhatIfForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:CreateWhatIfForecast'
, createWhatIfForecast_tags
- A list of
tags
to apply to the what if forecast.
$sel:timeSeriesReplacementsDataSource:CreateWhatIfForecast'
, createWhatIfForecast_timeSeriesReplacementsDataSource
- 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.
$sel:timeSeriesTransformations:CreateWhatIfForecast'
, createWhatIfForecast_timeSeriesTransformations
- 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
, createWhatIfForecast_whatIfForecastName
- The name of the what-if forecast. Names must be unique within each
what-if analysis.
CreateWhatIfForecast
, createWhatIfForecast_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis.
data CreateWhatIfForecastResponse Source #
See: newCreateWhatIfForecastResponse
smart constructor.
Constructors
CreateWhatIfForecastResponse' (Maybe Text) Int |
Instances
newCreateWhatIfForecastResponse Source #
Create a value of CreateWhatIfForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWhatIfForecastResponse
, createWhatIfForecastResponse_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast.
$sel:httpStatus:CreateWhatIfForecastResponse'
, createWhatIfForecastResponse_httpStatus
- The response's http status code.
CreateWhatIfForecastExport
data CreateWhatIfForecastExport Source #
See: newCreateWhatIfForecastExport
smart constructor.
Constructors
CreateWhatIfForecastExport' (Maybe Text) (Maybe [Tag]) Text (NonEmpty Text) DataDestination |
Instances
newCreateWhatIfForecastExport Source #
Arguments
:: Text | |
-> NonEmpty Text | |
-> DataDestination | |
-> CreateWhatIfForecastExport |
Create a value of CreateWhatIfForecastExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWhatIfForecastExport
, createWhatIfForecastExport_format
- The format of the exported data, CSV or PARQUET.
$sel:tags:CreateWhatIfForecastExport'
, createWhatIfForecastExport_tags
- A list of
tags
to apply to the what if forecast.
CreateWhatIfForecastExport
, createWhatIfForecastExport_whatIfForecastExportName
- The name of the what-if forecast to export.
CreateWhatIfForecastExport
, createWhatIfForecastExport_whatIfForecastArns
- The list of what-if forecast Amazon Resource Names (ARNs) to export.
CreateWhatIfForecastExport
, createWhatIfForecastExport_destination
- The location where you want to save the forecast and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
data CreateWhatIfForecastExportResponse Source #
See: newCreateWhatIfForecastExportResponse
smart constructor.
Constructors
CreateWhatIfForecastExportResponse' (Maybe Text) Int |
Instances
newCreateWhatIfForecastExportResponse Source #
Arguments
:: Int | |
-> CreateWhatIfForecastExportResponse |
Create a value of CreateWhatIfForecastExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWhatIfForecastExportResponse
, createWhatIfForecastExportResponse_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast.
$sel:httpStatus:CreateWhatIfForecastExportResponse'
, createWhatIfForecastExportResponse_httpStatus
- The response's http status code.
DeleteDataset
data DeleteDataset Source #
See: newDeleteDataset
smart constructor.
Constructors
DeleteDataset' Text |
Instances
Arguments
:: Text | |
-> DeleteDataset |
Create a value of DeleteDataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDataset
, deleteDataset_datasetArn
- The Amazon Resource Name (ARN) of the dataset to delete.
data DeleteDatasetResponse Source #
See: newDeleteDatasetResponse
smart constructor.
Constructors
DeleteDatasetResponse' | |
Instances
newDeleteDatasetResponse :: DeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDatasetGroup
data DeleteDatasetGroup Source #
See: newDeleteDatasetGroup
smart constructor.
Constructors
DeleteDatasetGroup' Text |
Instances
newDeleteDatasetGroup Source #
Arguments
:: Text | |
-> DeleteDatasetGroup |
Create a value of DeleteDatasetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDatasetGroup
, deleteDatasetGroup_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group to delete.
data DeleteDatasetGroupResponse Source #
See: newDeleteDatasetGroupResponse
smart constructor.
Constructors
DeleteDatasetGroupResponse' | |
Instances
newDeleteDatasetGroupResponse :: DeleteDatasetGroupResponse Source #
Create a value of DeleteDatasetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDatasetImportJob
data DeleteDatasetImportJob Source #
See: newDeleteDatasetImportJob
smart constructor.
Constructors
DeleteDatasetImportJob' Text |
Instances
newDeleteDatasetImportJob Source #
Arguments
:: Text | |
-> DeleteDatasetImportJob |
Create a value of DeleteDatasetImportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDatasetImportJob
, deleteDatasetImportJob_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job to delete.
data DeleteDatasetImportJobResponse Source #
See: newDeleteDatasetImportJobResponse
smart constructor.
Constructors
DeleteDatasetImportJobResponse' | |
Instances
Generic DeleteDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteDatasetImportJob Associated Types type Rep DeleteDatasetImportJobResponse :: Type -> Type # | |
Read DeleteDatasetImportJobResponse Source # | |
Show DeleteDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteDatasetImportJob Methods showsPrec :: Int -> DeleteDatasetImportJobResponse -> ShowS # show :: DeleteDatasetImportJobResponse -> String # showList :: [DeleteDatasetImportJobResponse] -> ShowS # | |
NFData DeleteDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteDatasetImportJob Methods rnf :: DeleteDatasetImportJobResponse -> () # | |
Eq DeleteDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteDatasetImportJob | |
type Rep DeleteDatasetImportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteDatasetImportJob |
newDeleteDatasetImportJobResponse :: DeleteDatasetImportJobResponse Source #
Create a value of DeleteDatasetImportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteExplainability
data DeleteExplainability Source #
See: newDeleteExplainability
smart constructor.
Constructors
DeleteExplainability' Text |
Instances
newDeleteExplainability Source #
Arguments
:: Text | |
-> DeleteExplainability |
Create a value of DeleteExplainability
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteExplainability
, deleteExplainability_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability resource to delete.
data DeleteExplainabilityResponse Source #
See: newDeleteExplainabilityResponse
smart constructor.
Constructors
DeleteExplainabilityResponse' | |
Instances
Generic DeleteExplainabilityResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainability Associated Types type Rep DeleteExplainabilityResponse :: Type -> Type # | |
Read DeleteExplainabilityResponse Source # | |
Show DeleteExplainabilityResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainability Methods showsPrec :: Int -> DeleteExplainabilityResponse -> ShowS # show :: DeleteExplainabilityResponse -> String # showList :: [DeleteExplainabilityResponse] -> ShowS # | |
NFData DeleteExplainabilityResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainability Methods rnf :: DeleteExplainabilityResponse -> () # | |
Eq DeleteExplainabilityResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainability Methods (==) :: DeleteExplainabilityResponse -> DeleteExplainabilityResponse -> Bool # (/=) :: DeleteExplainabilityResponse -> DeleteExplainabilityResponse -> Bool # | |
type Rep DeleteExplainabilityResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainability |
newDeleteExplainabilityResponse :: DeleteExplainabilityResponse Source #
Create a value of DeleteExplainabilityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteExplainabilityExport
data DeleteExplainabilityExport Source #
See: newDeleteExplainabilityExport
smart constructor.
Constructors
DeleteExplainabilityExport' Text |
Instances
newDeleteExplainabilityExport Source #
Arguments
:: Text | |
-> DeleteExplainabilityExport |
Create a value of DeleteExplainabilityExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteExplainabilityExport
, deleteExplainabilityExport_explainabilityExportArn
- The Amazon Resource Name (ARN) of the Explainability export to delete.
data DeleteExplainabilityExportResponse Source #
See: newDeleteExplainabilityExportResponse
smart constructor.
Constructors
DeleteExplainabilityExportResponse' | |
Instances
Generic DeleteExplainabilityExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainabilityExport Associated Types type Rep DeleteExplainabilityExportResponse :: Type -> Type # | |
Read DeleteExplainabilityExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainabilityExport | |
Show DeleteExplainabilityExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainabilityExport Methods showsPrec :: Int -> DeleteExplainabilityExportResponse -> ShowS # | |
NFData DeleteExplainabilityExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainabilityExport Methods rnf :: DeleteExplainabilityExportResponse -> () # | |
Eq DeleteExplainabilityExportResponse Source # | |
type Rep DeleteExplainabilityExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteExplainabilityExport |
newDeleteExplainabilityExportResponse :: DeleteExplainabilityExportResponse Source #
Create a value of DeleteExplainabilityExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteForecast
data DeleteForecast Source #
See: newDeleteForecast
smart constructor.
Constructors
DeleteForecast' Text |
Instances
Arguments
:: Text | |
-> DeleteForecast |
Create a value of DeleteForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteForecast
, deleteForecast_forecastArn
- The Amazon Resource Name (ARN) of the forecast to delete.
data DeleteForecastResponse Source #
See: newDeleteForecastResponse
smart constructor.
Constructors
DeleteForecastResponse' | |
Instances
Generic DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast Associated Types type Rep DeleteForecastResponse :: Type -> Type # Methods from :: DeleteForecastResponse -> Rep DeleteForecastResponse x # to :: Rep DeleteForecastResponse x -> DeleteForecastResponse # | |
Read DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast | |
Show DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast Methods showsPrec :: Int -> DeleteForecastResponse -> ShowS # show :: DeleteForecastResponse -> String # showList :: [DeleteForecastResponse] -> ShowS # | |
NFData DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast Methods rnf :: DeleteForecastResponse -> () # | |
Eq DeleteForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecast Methods (==) :: DeleteForecastResponse -> DeleteForecastResponse -> Bool # (/=) :: DeleteForecastResponse -> DeleteForecastResponse -> Bool # | |
type Rep DeleteForecastResponse Source # | |
newDeleteForecastResponse :: DeleteForecastResponse Source #
Create a value of DeleteForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteForecastExportJob
data DeleteForecastExportJob Source #
See: newDeleteForecastExportJob
smart constructor.
Constructors
DeleteForecastExportJob' Text |
Instances
newDeleteForecastExportJob Source #
Arguments
:: Text | |
-> DeleteForecastExportJob |
Create a value of DeleteForecastExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteForecastExportJob
, deleteForecastExportJob_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job to delete.
data DeleteForecastExportJobResponse Source #
See: newDeleteForecastExportJobResponse
smart constructor.
Constructors
DeleteForecastExportJobResponse' | |
Instances
Generic DeleteForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecastExportJob Associated Types type Rep DeleteForecastExportJobResponse :: Type -> Type # | |
Read DeleteForecastExportJobResponse Source # | |
Show DeleteForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecastExportJob Methods showsPrec :: Int -> DeleteForecastExportJobResponse -> ShowS # | |
NFData DeleteForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecastExportJob Methods rnf :: DeleteForecastExportJobResponse -> () # | |
Eq DeleteForecastExportJobResponse Source # | |
type Rep DeleteForecastExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeleteForecastExportJob |
newDeleteForecastExportJobResponse :: DeleteForecastExportJobResponse Source #
Create a value of DeleteForecastExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteMonitor
data DeleteMonitor Source #
See: newDeleteMonitor
smart constructor.
Constructors
DeleteMonitor' Text |
Instances
Arguments
:: Text | |
-> DeleteMonitor |
Create a value of DeleteMonitor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteMonitor
, deleteMonitor_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource to delete.
data DeleteMonitorResponse Source #
See: newDeleteMonitorResponse
smart constructor.
Constructors
DeleteMonitorResponse' | |
Instances
newDeleteMonitorResponse :: DeleteMonitorResponse Source #
Create a value of DeleteMonitorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePredictor
data DeletePredictor Source #
See: newDeletePredictor
smart constructor.
Constructors
DeletePredictor' Text |
Instances
Arguments
:: Text | |
-> DeletePredictor |
Create a value of DeletePredictor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeletePredictor
, deletePredictor_predictorArn
- The Amazon Resource Name (ARN) of the predictor to delete.
data DeletePredictorResponse Source #
See: newDeletePredictorResponse
smart constructor.
Constructors
DeletePredictorResponse' | |
Instances
newDeletePredictorResponse :: DeletePredictorResponse Source #
Create a value of DeletePredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePredictorBacktestExportJob
data DeletePredictorBacktestExportJob Source #
See: newDeletePredictorBacktestExportJob
smart constructor.
Constructors
DeletePredictorBacktestExportJob' Text |
Instances
newDeletePredictorBacktestExportJob Source #
Create a value of DeletePredictorBacktestExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeletePredictorBacktestExportJob
, deletePredictorBacktestExportJob_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job to
delete.
data DeletePredictorBacktestExportJobResponse Source #
See: newDeletePredictorBacktestExportJobResponse
smart constructor.
Constructors
DeletePredictorBacktestExportJobResponse' | |
Instances
Generic DeletePredictorBacktestExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictorBacktestExportJob Associated Types type Rep DeletePredictorBacktestExportJobResponse :: Type -> Type # | |
Read DeletePredictorBacktestExportJobResponse Source # | |
Show DeletePredictorBacktestExportJobResponse Source # | |
NFData DeletePredictorBacktestExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictorBacktestExportJob Methods rnf :: DeletePredictorBacktestExportJobResponse -> () # | |
Eq DeletePredictorBacktestExportJobResponse Source # | |
type Rep DeletePredictorBacktestExportJobResponse Source # | |
Defined in Amazonka.Forecast.DeletePredictorBacktestExportJob type Rep DeletePredictorBacktestExportJobResponse = D1 ('MetaData "DeletePredictorBacktestExportJobResponse" "Amazonka.Forecast.DeletePredictorBacktestExportJob" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "DeletePredictorBacktestExportJobResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeletePredictorBacktestExportJobResponse :: DeletePredictorBacktestExportJobResponse Source #
Create a value of DeletePredictorBacktestExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteResourceTree
data DeleteResourceTree Source #
See: newDeleteResourceTree
smart constructor.
Constructors
DeleteResourceTree' Text |
Instances
newDeleteResourceTree Source #
Arguments
:: Text | |
-> DeleteResourceTree |
Create a value of DeleteResourceTree
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteResourceTree
, deleteResourceTree_resourceArn
- The Amazon Resource Name (ARN) of the parent resource to delete. All
child resources of the parent resource will also be deleted.
data DeleteResourceTreeResponse Source #
See: newDeleteResourceTreeResponse
smart constructor.
Constructors
DeleteResourceTreeResponse' | |
Instances
newDeleteResourceTreeResponse :: DeleteResourceTreeResponse Source #
Create a value of DeleteResourceTreeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteWhatIfAnalysis
data DeleteWhatIfAnalysis Source #
See: newDeleteWhatIfAnalysis
smart constructor.
Constructors
DeleteWhatIfAnalysis' Text |
Instances
newDeleteWhatIfAnalysis Source #
Arguments
:: Text | |
-> DeleteWhatIfAnalysis |
Create a value of DeleteWhatIfAnalysis
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWhatIfAnalysis
, deleteWhatIfAnalysis_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis that you want to
delete.
data DeleteWhatIfAnalysisResponse Source #
See: newDeleteWhatIfAnalysisResponse
smart constructor.
Constructors
DeleteWhatIfAnalysisResponse' | |
Instances
Generic DeleteWhatIfAnalysisResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfAnalysis Associated Types type Rep DeleteWhatIfAnalysisResponse :: Type -> Type # | |
Read DeleteWhatIfAnalysisResponse Source # | |
Show DeleteWhatIfAnalysisResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfAnalysis Methods showsPrec :: Int -> DeleteWhatIfAnalysisResponse -> ShowS # show :: DeleteWhatIfAnalysisResponse -> String # showList :: [DeleteWhatIfAnalysisResponse] -> ShowS # | |
NFData DeleteWhatIfAnalysisResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfAnalysis Methods rnf :: DeleteWhatIfAnalysisResponse -> () # | |
Eq DeleteWhatIfAnalysisResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfAnalysis Methods (==) :: DeleteWhatIfAnalysisResponse -> DeleteWhatIfAnalysisResponse -> Bool # (/=) :: DeleteWhatIfAnalysisResponse -> DeleteWhatIfAnalysisResponse -> Bool # | |
type Rep DeleteWhatIfAnalysisResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfAnalysis |
newDeleteWhatIfAnalysisResponse :: DeleteWhatIfAnalysisResponse Source #
Create a value of DeleteWhatIfAnalysisResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteWhatIfForecast
data DeleteWhatIfForecast Source #
See: newDeleteWhatIfForecast
smart constructor.
Constructors
DeleteWhatIfForecast' Text |
Instances
newDeleteWhatIfForecast Source #
Arguments
:: Text | |
-> DeleteWhatIfForecast |
Create a value of DeleteWhatIfForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWhatIfForecast
, deleteWhatIfForecast_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast that you want to
delete.
data DeleteWhatIfForecastResponse Source #
See: newDeleteWhatIfForecastResponse
smart constructor.
Constructors
DeleteWhatIfForecastResponse' | |
Instances
Generic DeleteWhatIfForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecast Associated Types type Rep DeleteWhatIfForecastResponse :: Type -> Type # | |
Read DeleteWhatIfForecastResponse Source # | |
Show DeleteWhatIfForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecast Methods showsPrec :: Int -> DeleteWhatIfForecastResponse -> ShowS # show :: DeleteWhatIfForecastResponse -> String # showList :: [DeleteWhatIfForecastResponse] -> ShowS # | |
NFData DeleteWhatIfForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecast Methods rnf :: DeleteWhatIfForecastResponse -> () # | |
Eq DeleteWhatIfForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecast Methods (==) :: DeleteWhatIfForecastResponse -> DeleteWhatIfForecastResponse -> Bool # (/=) :: DeleteWhatIfForecastResponse -> DeleteWhatIfForecastResponse -> Bool # | |
type Rep DeleteWhatIfForecastResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecast |
newDeleteWhatIfForecastResponse :: DeleteWhatIfForecastResponse Source #
Create a value of DeleteWhatIfForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteWhatIfForecastExport
data DeleteWhatIfForecastExport Source #
See: newDeleteWhatIfForecastExport
smart constructor.
Constructors
DeleteWhatIfForecastExport' Text |
Instances
newDeleteWhatIfForecastExport Source #
Arguments
:: Text | |
-> DeleteWhatIfForecastExport |
Create a value of DeleteWhatIfForecastExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWhatIfForecastExport
, deleteWhatIfForecastExport_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export that you
want to delete.
data DeleteWhatIfForecastExportResponse Source #
See: newDeleteWhatIfForecastExportResponse
smart constructor.
Constructors
DeleteWhatIfForecastExportResponse' | |
Instances
Generic DeleteWhatIfForecastExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecastExport Associated Types type Rep DeleteWhatIfForecastExportResponse :: Type -> Type # | |
Read DeleteWhatIfForecastExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecastExport | |
Show DeleteWhatIfForecastExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecastExport Methods showsPrec :: Int -> DeleteWhatIfForecastExportResponse -> ShowS # | |
NFData DeleteWhatIfForecastExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecastExport Methods rnf :: DeleteWhatIfForecastExportResponse -> () # | |
Eq DeleteWhatIfForecastExportResponse Source # | |
type Rep DeleteWhatIfForecastExportResponse Source # | |
Defined in Amazonka.Forecast.DeleteWhatIfForecastExport |
newDeleteWhatIfForecastExportResponse :: DeleteWhatIfForecastExportResponse Source #
Create a value of DeleteWhatIfForecastExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAutoPredictor
data DescribeAutoPredictor Source #
See: newDescribeAutoPredictor
smart constructor.
Constructors
DescribeAutoPredictor' Text |
Instances
newDescribeAutoPredictor Source #
Arguments
:: Text | |
-> DescribeAutoPredictor |
Create a value of DescribeAutoPredictor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAutoPredictor
, describeAutoPredictor_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
data DescribeAutoPredictorResponse Source #
See: newDescribeAutoPredictorResponse
smart constructor.
Constructors
DescribeAutoPredictorResponse' (Maybe POSIX) (Maybe DataConfig) (Maybe [Text]) (Maybe EncryptionConfig) (Maybe Integer) (Maybe ExplainabilityInfo) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe MonitorInfo) (Maybe OptimizationMetric) (Maybe Text) (Maybe Text) (Maybe ReferencePredictorSummary) (Maybe Text) (Maybe TimeAlignmentBoundary) Int |
Instances
newDescribeAutoPredictorResponse Source #
Create a value of DescribeAutoPredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_creationTime
- The timestamp of the CreateAutoPredictor request.
$sel:dataConfig:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_dataConfig
- The data configuration for your dataset group and any additional
datasets.
$sel:datasetImportJobArns:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training
data for the predictor.
$sel:encryptionConfig:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_encryptionConfig
- Undocumented member.
$sel:estimatedTimeRemainingInMinutes:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the predictor training job
to complete.
$sel:explainabilityInfo:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_explainabilityInfo
- Provides the status and ARN of the Predictor Explainability.
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_forecastDimensions
- An array of dimension (field) names that specify the attributes used to
group your time series.
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
$sel:forecastHorizon:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_forecastHorizon
- The number of time-steps that the model predicts. The forecast horizon
is also called the prediction length.
$sel:forecastTypes:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_forecastTypes
- The forecast types used during predictor training. Default value is
["0.1","0.5","0.9"].
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_message
- In the event of an error, a message detailing the cause of the error.
$sel:monitorInfo:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_monitorInfo
- A object with the Amazon Resource Name (ARN) and status of the monitor
resource.
$sel:optimizationMetric:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_optimizationMetric
- The accuracy metric used to optimize the predictor.
DescribeAutoPredictor
, describeAutoPredictorResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_predictorName
- The name of the predictor.
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_referencePredictorSummary
- The ARN and state of the reference predictor. This parameter is only
valid for retrained or upgraded predictors.
DescribeAutoPredictorResponse
, describeAutoPredictorResponse_status
- 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
$sel:timeAlignmentBoundary:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_timeAlignmentBoundary
- The time boundary Forecast uses when aggregating data.
$sel:httpStatus:DescribeAutoPredictorResponse'
, describeAutoPredictorResponse_httpStatus
- The response's http status code.
DescribeDataset
data DescribeDataset Source #
See: newDescribeDataset
smart constructor.
Constructors
DescribeDataset' Text |
Instances
Arguments
:: Text | |
-> DescribeDataset |
Create a value of DescribeDataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDataset
, describeDataset_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
data DescribeDatasetResponse Source #
See: newDescribeDatasetResponse
smart constructor.
Constructors
DescribeDatasetResponse' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetType) (Maybe Domain) (Maybe EncryptionConfig) (Maybe POSIX) (Maybe Schema) (Maybe Text) Int |
Instances
newDescribeDatasetResponse Source #
Create a value of DescribeDatasetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetResponse
, describeDatasetResponse_creationTime
- When the dataset was created.
$sel:dataFrequency:DescribeDatasetResponse'
, describeDatasetResponse_dataFrequency
- The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.
DescribeDataset
, describeDatasetResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
DescribeDatasetResponse
, describeDatasetResponse_datasetName
- The name of the dataset.
DescribeDatasetResponse
, describeDatasetResponse_datasetType
- The dataset type.
DescribeDatasetResponse
, describeDatasetResponse_domain
- The domain associated with the dataset.
$sel:encryptionConfig:DescribeDatasetResponse'
, describeDatasetResponse_encryptionConfig
- The AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
DescribeDatasetResponse
, describeDatasetResponse_lastModificationTime
- When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the DescribeDataset
call. After a
CreateDatasetImportJob
operation has finished, LastModificationTime
is when the import job
completed or failed.
DescribeDatasetResponse
, describeDatasetResponse_schema
- An array of SchemaAttribute
objects that specify the dataset fields.
Each SchemaAttribute
specifies the name and data type of a field.
DescribeDatasetResponse
, describeDatasetResponse_status
- The status of the dataset. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply while data is imported to the dataset from a
call to the
CreateDatasetImportJob
operation and reflect the status of the dataset import job. For example,
when the import job status is CREATE_IN_PROGRESS
, the status of the
dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import
training data.
$sel:httpStatus:DescribeDatasetResponse'
, describeDatasetResponse_httpStatus
- The response's http status code.
DescribeDatasetGroup
data DescribeDatasetGroup Source #
See: newDescribeDatasetGroup
smart constructor.
Constructors
DescribeDatasetGroup' Text |
Instances
newDescribeDatasetGroup Source #
Arguments
:: Text | |
-> DescribeDatasetGroup |
Create a value of DescribeDatasetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetGroup
, describeDatasetGroup_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
data DescribeDatasetGroupResponse Source #
See: newDescribeDatasetGroupResponse
smart constructor.
Constructors
DescribeDatasetGroupResponse' (Maybe POSIX) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Domain) (Maybe POSIX) (Maybe Text) Int |
Instances
newDescribeDatasetGroupResponse Source #
Create a value of DescribeDatasetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetGroupResponse
, describeDatasetGroupResponse_creationTime
- When the dataset group was created.
$sel:datasetArns:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_datasetArns
- An array of Amazon Resource Names (ARNs) of the datasets contained in
the dataset group.
DescribeDatasetGroup
, describeDatasetGroupResponse_datasetGroupArn
- The ARN of the dataset group.
DescribeDatasetGroupResponse
, describeDatasetGroupResponse_datasetGroupName
- The name of the dataset group.
DescribeDatasetGroupResponse
, describeDatasetGroupResponse_domain
- The domain associated with the dataset group.
DescribeDatasetGroupResponse
, describeDatasetGroupResponse_lastModificationTime
- When the dataset group was created or last updated from a call to the
UpdateDatasetGroup
operation. While the dataset group is being updated,
LastModificationTime
is the current time of the DescribeDatasetGroup
call.
DescribeDatasetGroupResponse
, describeDatasetGroupResponse_status
- The status of the dataset group. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply when you call the
UpdateDatasetGroup
operation.
The Status
of the dataset group must be ACTIVE
before you can use
the dataset group to create a predictor.
$sel:httpStatus:DescribeDatasetGroupResponse'
, describeDatasetGroupResponse_httpStatus
- The response's http status code.
DescribeDatasetImportJob
data DescribeDatasetImportJob Source #
See: newDescribeDatasetImportJob
smart constructor.
Constructors
DescribeDatasetImportJob' Text |
Instances
newDescribeDatasetImportJob Source #
Arguments
:: Text | |
-> DescribeDatasetImportJob |
Create a value of DescribeDatasetImportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetImportJob
, describeDatasetImportJob_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
data DescribeDatasetImportJobResponse Source #
See: newDescribeDatasetImportJobResponse
smart constructor.
Constructors
DescribeDatasetImportJobResponse' (Maybe POSIX) (Maybe Double) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe (HashMap Text Statistics)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) Int |
Instances
newDescribeDatasetImportJobResponse Source #
Create a value of DescribeDatasetImportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_creationTime
- When the dataset import job was created.
$sel:dataSize:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_dataSize
- The size of the dataset in gigabytes (GB) after the import job has
finished.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_datasetArn
- The Amazon Resource Name (ARN) of the dataset that the training data was
imported to.
DescribeDatasetImportJob
, describeDatasetImportJobResponse_datasetImportJobArn
- The ARN of the dataset import job.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_datasetImportJobName
- The name of the dataset import job.
$sel:estimatedTimeRemainingInMinutes:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the dataset import job to
complete.
$sel:fieldStatistics:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_fieldStatistics
- Statistical information about each field in the input data.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_format
- The format of the imported data, CSV or PARQUET.
$sel:geolocationFormat:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_geolocationFormat
- The format of the geolocation attribute. Valid Values:"LAT_LONG"
and
"CC_POSTALCODE"
.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_message
- If an error occurred, an informational message about the error.
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_status
- The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
$sel:timeZone:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_timeZone
- The single time zone applied to every item in the dataset
DescribeDatasetImportJobResponse
, describeDatasetImportJobResponse_timestampFormat
- The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
$sel:useGeolocationForTimeZone:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_useGeolocationForTimeZone
- Whether TimeZone
is automatically derived from the geolocation
attribute.
$sel:httpStatus:DescribeDatasetImportJobResponse'
, describeDatasetImportJobResponse_httpStatus
- The response's http status code.
DescribeExplainability
data DescribeExplainability Source #
See: newDescribeExplainability
smart constructor.
Constructors
DescribeExplainability' Text |
Instances
newDescribeExplainability Source #
Arguments
:: Text | |
-> DescribeExplainability |
Create a value of DescribeExplainability
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExplainability
, describeExplainability_explainabilityArn
- The Amazon Resource Name (ARN) of the Explaianability to describe.
data DescribeExplainabilityResponse Source #
See: newDescribeExplainabilityResponse
smart constructor.
Constructors
DescribeExplainabilityResponse' (Maybe POSIX) (Maybe DataSource) (Maybe Bool) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ExplainabilityConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Schema) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeExplainabilityResponse Source #
Create a value of DescribeExplainabilityResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExplainabilityResponse
, describeExplainabilityResponse_creationTime
- When the Explainability resource was created.
DescribeExplainabilityResponse
, describeExplainabilityResponse_dataSource
- Undocumented member.
$sel:enableVisualization:DescribeExplainabilityResponse'
, describeExplainabilityResponse_enableVisualization
- Whether the visualization was enabled for the Explainability resource.
$sel:endDateTime:DescribeExplainabilityResponse'
, describeExplainabilityResponse_endDateTime
- If TimePointGranularity
is set to SPECIFIC
, the last time point in
the Explainability.
$sel:estimatedTimeRemainingInMinutes:DescribeExplainabilityResponse'
, describeExplainabilityResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the CreateExplainability job
to complete.
DescribeExplainability
, describeExplainabilityResponse_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability.
DescribeExplainabilityResponse
, describeExplainabilityResponse_explainabilityConfig
- The configuration settings that define the granularity of time series
and time points for the Explainability.
DescribeExplainabilityResponse
, describeExplainabilityResponse_explainabilityName
- The name of the Explainability.
DescribeExplainabilityResponse
, describeExplainabilityResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeExplainabilityResponse
, describeExplainabilityResponse_message
- If an error occurred, a message about the error.
DescribeExplainabilityResponse
, describeExplainabilityResponse_resourceArn
- The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability resource.
DescribeExplainabilityResponse
, describeExplainabilityResponse_schema
- Undocumented member.
$sel:startDateTime:DescribeExplainabilityResponse'
, describeExplainabilityResponse_startDateTime
- If TimePointGranularity
is set to SPECIFIC
, the first time point in
the Explainability.
DescribeExplainabilityResponse
, describeExplainabilityResponse_status
- 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
$sel:httpStatus:DescribeExplainabilityResponse'
, describeExplainabilityResponse_httpStatus
- The response's http status code.
DescribeExplainabilityExport
data DescribeExplainabilityExport Source #
See: newDescribeExplainabilityExport
smart constructor.
Constructors
DescribeExplainabilityExport' Text |
Instances
newDescribeExplainabilityExport Source #
Arguments
:: Text | |
-> DescribeExplainabilityExport |
Create a value of DescribeExplainabilityExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExplainabilityExport
, describeExplainabilityExport_explainabilityExportArn
- The Amazon Resource Name (ARN) of the Explainability export.
data DescribeExplainabilityExportResponse Source #
See: newDescribeExplainabilityExportResponse
smart constructor.
Constructors
DescribeExplainabilityExportResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeExplainabilityExportResponse Source #
Arguments
:: Int | |
-> DescribeExplainabilityExportResponse |
Create a value of DescribeExplainabilityExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_creationTime
- When the Explainability export was created.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_destination
- Undocumented member.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability export.
DescribeExplainabilityExport
, describeExplainabilityExportResponse_explainabilityExportArn
- The Amazon Resource Name (ARN) of the Explainability export.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_explainabilityExportName
- The name of the Explainability export.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_format
- The format of the exported data, CSV or PARQUET.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_message
- Information about any errors that occurred during the export.
DescribeExplainabilityExportResponse
, describeExplainabilityExportResponse_status
- 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
$sel:httpStatus:DescribeExplainabilityExportResponse'
, describeExplainabilityExportResponse_httpStatus
- The response's http status code.
DescribeForecast
data DescribeForecast Source #
See: newDescribeForecast
smart constructor.
Constructors
DescribeForecast' Text |
Instances
Arguments
:: Text | |
-> DescribeForecast |
Create a value of DescribeForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeForecast
, describeForecast_forecastArn
- The Amazon Resource Name (ARN) of the forecast.
data DescribeForecastResponse Source #
See: newDescribeForecastResponse
smart constructor.
Constructors
DescribeForecastResponse' (Maybe POSIX) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe TimeSeriesSelector) Int |
Instances
newDescribeForecastResponse Source #
Create a value of DescribeForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeForecastResponse
, describeForecastResponse_creationTime
- When the forecast creation task was created.
DescribeForecastResponse
, describeForecastResponse_datasetGroupArn
- The ARN of the dataset group that provided the data used to train the
predictor.
$sel:estimatedTimeRemainingInMinutes:DescribeForecastResponse'
, describeForecastResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the forecast job to
complete.
DescribeForecast
, describeForecastResponse_forecastArn
- The forecast ARN as specified in the request.
DescribeForecastResponse
, describeForecastResponse_forecastName
- The name of the forecast.
$sel:forecastTypes:DescribeForecastResponse'
, describeForecastResponse_forecastTypes
- The quantiles at which probabilistic forecasts were generated.
DescribeForecastResponse
, describeForecastResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeForecastResponse
, describeForecastResponse_message
- If an error occurred, an informational message about the error.
DescribeForecastResponse
, describeForecastResponse_predictorArn
- The ARN of the predictor used to generate the forecast.
DescribeForecastResponse
, describeForecastResponse_status
- The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
$sel:timeSeriesSelector:DescribeForecastResponse'
, describeForecastResponse_timeSeriesSelector
- The time series to include in the forecast.
$sel:httpStatus:DescribeForecastResponse'
, describeForecastResponse_httpStatus
- The response's http status code.
DescribeForecastExportJob
data DescribeForecastExportJob Source #
See: newDescribeForecastExportJob
smart constructor.
Constructors
DescribeForecastExportJob' Text |
Instances
newDescribeForecastExportJob Source #
Arguments
:: Text | |
-> DescribeForecastExportJob |
Create a value of DescribeForecastExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeForecastExportJob
, describeForecastExportJob_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job.
data DescribeForecastExportJobResponse Source #
See: newDescribeForecastExportJobResponse
smart constructor.
Constructors
DescribeForecastExportJobResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeForecastExportJobResponse Source #
Arguments
:: Int | |
-> DescribeForecastExportJobResponse |
Create a value of DescribeForecastExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_creationTime
- When the forecast export job was created.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_destination
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_forecastArn
- The Amazon Resource Name (ARN) of the exported forecast.
DescribeForecastExportJob
, describeForecastExportJobResponse_forecastExportJobArn
- The ARN of the forecast export job.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_forecastExportJobName
- The name of the forecast export job.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_format
- The format of the exported data, CSV or PARQUET.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_message
- If an error occurred, an informational message about the error.
DescribeForecastExportJobResponse
, describeForecastExportJobResponse_status
- The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
$sel:httpStatus:DescribeForecastExportJobResponse'
, describeForecastExportJobResponse_httpStatus
- The response's http status code.
DescribeMonitor
data DescribeMonitor Source #
See: newDescribeMonitor
smart constructor.
Constructors
DescribeMonitor' Text |
Instances
Arguments
:: Text | |
-> DescribeMonitor |
Create a value of DescribeMonitor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeMonitor
, describeMonitor_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource to describe.
data DescribeMonitorResponse Source #
See: newDescribeMonitorResponse
smart constructor.
Constructors
DescribeMonitorResponse' (Maybe Baseline) (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeMonitorResponse Source #
Create a value of DescribeMonitorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:baseline:DescribeMonitorResponse'
, describeMonitorResponse_baseline
- Metrics you can use as a baseline for comparison purposes. Use these
values you interpret monitoring results for an auto predictor.
DescribeMonitorResponse
, describeMonitorResponse_creationTime
- The timestamp for when the monitor resource was created.
$sel:estimatedEvaluationTimeRemainingInMinutes:DescribeMonitorResponse'
, describeMonitorResponse_estimatedEvaluationTimeRemainingInMinutes
- The estimated number of minutes remaining before the monitor resource
finishes its current evaluation.
$sel:lastEvaluationState:DescribeMonitorResponse'
, describeMonitorResponse_lastEvaluationState
- The state of the monitor's latest evaluation.
$sel:lastEvaluationTime:DescribeMonitorResponse'
, describeMonitorResponse_lastEvaluationTime
- The timestamp of the latest evaluation completed by the monitor.
DescribeMonitorResponse
, describeMonitorResponse_lastModificationTime
- The timestamp of the latest modification to the monitor.
DescribeMonitorResponse
, describeMonitorResponse_message
- An error message, if any, for the monitor.
DescribeMonitor
, describeMonitorResponse_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource described.
DescribeMonitorResponse
, describeMonitorResponse_monitorName
- The name of the monitor.
DescribeMonitorResponse
, describeMonitorResponse_resourceArn
- The Amazon Resource Name (ARN) of the auto predictor being monitored.
DescribeMonitorResponse
, describeMonitorResponse_status
- The status of the monitor resource.
$sel:httpStatus:DescribeMonitorResponse'
, describeMonitorResponse_httpStatus
- The response's http status code.
DescribePredictor
data DescribePredictor Source #
See: newDescribePredictor
smart constructor.
Constructors
DescribePredictor' Text |
Instances
Arguments
:: Text | |
-> DescribePredictor |
Create a value of DescribePredictor
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePredictor
, describePredictor_predictorArn
- The Amazon Resource Name (ARN) of the predictor that you want
information about.
data DescribePredictorResponse Source #
See: newDescribePredictorResponse
smart constructor.
Constructors
DescribePredictorResponse' (Maybe Text) (Maybe [Text]) (Maybe AutoMLOverrideStrategy) (Maybe POSIX) (Maybe [Text]) (Maybe EncryptionConfig) (Maybe Integer) (Maybe EvaluationParameters) (Maybe FeaturizationConfig) (Maybe Int) (Maybe (NonEmpty Text)) (Maybe HyperParameterTuningJobConfig) (Maybe InputDataConfig) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe OptimizationMetric) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe PredictorExecutionDetails) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribePredictorResponse Source #
Create a value of DescribePredictorResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePredictorResponse
, describePredictorResponse_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm used for model training.
$sel:autoMLAlgorithmArns:DescribePredictorResponse'
, describePredictorResponse_autoMLAlgorithmArns
- When PerformAutoML
is specified, the ARN of the chosen algorithm.
$sel:autoMLOverrideStrategy:DescribePredictorResponse'
, describePredictorResponse_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
DescribePredictorResponse
, describePredictorResponse_creationTime
- When the model training task was created.
$sel:datasetImportJobArns:DescribePredictorResponse'
, describePredictorResponse_datasetImportJobArns
- An array of the ARNs of the dataset import jobs used to import training
data for the predictor.
$sel:encryptionConfig:DescribePredictorResponse'
, describePredictorResponse_encryptionConfig
- An AWS Key Management Service (KMS) key and the AWS Identity and Access
Management (IAM) role that Amazon Forecast can assume to access the key.
$sel:estimatedTimeRemainingInMinutes:DescribePredictorResponse'
, describePredictorResponse_estimatedTimeRemainingInMinutes
- The estimated time remaining in minutes for the predictor training job
to complete.
$sel:evaluationParameters:DescribePredictorResponse'
, describePredictorResponse_evaluationParameters
- Used to override the default evaluation parameters of the specified
algorithm. Amazon Forecast evaluates a predictor by splitting a dataset
into training data and testing data. The evaluation parameters define
how to perform the split and the number of iterations.
$sel:featurizationConfig:DescribePredictorResponse'
, describePredictorResponse_featurizationConfig
- The featurization configuration.
$sel:forecastHorizon:DescribePredictorResponse'
, describePredictorResponse_forecastHorizon
- The number of time-steps of the forecast. The forecast horizon is also
called the prediction length.
$sel:forecastTypes:DescribePredictorResponse'
, describePredictorResponse_forecastTypes
- The forecast types used during predictor training. Default value is
["0.1","0.5","0.9"]
$sel:hPOConfig:DescribePredictorResponse'
, describePredictorResponse_hPOConfig
- The hyperparameter override values for the algorithm.
$sel:inputDataConfig:DescribePredictorResponse'
, describePredictorResponse_inputDataConfig
- Describes the dataset group that contains the data to use to train the
predictor.
DescribePredictorResponse
, describePredictorResponse_isAutoPredictor
- Whether the predictor was created with CreateAutoPredictor.
DescribePredictorResponse
, describePredictorResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribePredictorResponse
, describePredictorResponse_message
- If an error occurred, an informational message about the error.
$sel:optimizationMetric:DescribePredictorResponse'
, describePredictorResponse_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:performAutoML:DescribePredictorResponse'
, describePredictorResponse_performAutoML
- Whether the predictor is set to perform AutoML.
$sel:performHPO:DescribePredictorResponse'
, describePredictorResponse_performHPO
- Whether the predictor is set to perform hyperparameter optimization
(HPO).
DescribePredictor
, describePredictorResponse_predictorArn
- The ARN of the predictor.
$sel:predictorExecutionDetails:DescribePredictorResponse'
, describePredictorResponse_predictorExecutionDetails
- Details on the the status and results of the backtests performed to
evaluate the accuracy of the predictor. You specify the number of
backtests to perform when you call the operation.
DescribePredictorResponse
, describePredictorResponse_predictorName
- The name of the predictor.
DescribePredictorResponse
, describePredictorResponse_status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
$sel:trainingParameters:DescribePredictorResponse'
, describePredictorResponse_trainingParameters
- The default training parameters or overrides selected during model
training. When running AutoML or choosing HPO with CNN-QR or DeepAR+,
the optimized values for the chosen hyperparameters are returned. For
more information, see aws-forecast-choosing-recipes.
$sel:httpStatus:DescribePredictorResponse'
, describePredictorResponse_httpStatus
- The response's http status code.
DescribePredictorBacktestExportJob
data DescribePredictorBacktestExportJob Source #
See: newDescribePredictorBacktestExportJob
smart constructor.
Constructors
DescribePredictorBacktestExportJob' Text |
Instances
newDescribePredictorBacktestExportJob Source #
Create a value of DescribePredictorBacktestExportJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePredictorBacktestExportJob
, describePredictorBacktestExportJob_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
data DescribePredictorBacktestExportJobResponse Source #
See: newDescribePredictorBacktestExportJobResponse
smart constructor.
Constructors
DescribePredictorBacktestExportJobResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribePredictorBacktestExportJobResponse Source #
Arguments
:: Int | |
-> DescribePredictorBacktestExportJobResponse |
Create a value of DescribePredictorBacktestExportJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_creationTime
- When the predictor backtest export job was created.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_destination
- Undocumented member.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_format
- The format of the exported data, CSV or PARQUET.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_message
- Information about any errors that may have occurred during the backtest
export.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_predictorArn
- The Amazon Resource Name (ARN) of the predictor.
DescribePredictorBacktestExportJob
, describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_predictorBacktestExportJobName
- The name of the predictor backtest export job.
DescribePredictorBacktestExportJobResponse
, describePredictorBacktestExportJobResponse_status
- The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
$sel:httpStatus:DescribePredictorBacktestExportJobResponse'
, describePredictorBacktestExportJobResponse_httpStatus
- The response's http status code.
DescribeWhatIfAnalysis
data DescribeWhatIfAnalysis Source #
See: newDescribeWhatIfAnalysis
smart constructor.
Constructors
DescribeWhatIfAnalysis' Text |
Instances
newDescribeWhatIfAnalysis Source #
Arguments
:: Text | |
-> DescribeWhatIfAnalysis |
Create a value of DescribeWhatIfAnalysis
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfAnalysis
, describeWhatIfAnalysis_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis that you are
interested in.
data DescribeWhatIfAnalysisResponse Source #
See: newDescribeWhatIfAnalysisResponse
smart constructor.
Constructors
DescribeWhatIfAnalysisResponse' (Maybe POSIX) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe TimeSeriesSelector) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeWhatIfAnalysisResponse Source #
Create a value of DescribeWhatIfAnalysisResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_creationTime
- When the what-if analysis was created.
$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_estimatedTimeRemainingInMinutes
- The approximate time remaining to complete the what-if analysis, in
minutes.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_forecastArn
- The Amazon Resource Name (ARN) of the what-if forecast.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_message
- If an error occurred, an informational message about the error.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_status
- 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.
$sel:timeSeriesSelector:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_timeSeriesSelector
- Undocumented member.
DescribeWhatIfAnalysis
, describeWhatIfAnalysisResponse_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis.
DescribeWhatIfAnalysisResponse
, describeWhatIfAnalysisResponse_whatIfAnalysisName
- The name of the what-if analysis.
$sel:httpStatus:DescribeWhatIfAnalysisResponse'
, describeWhatIfAnalysisResponse_httpStatus
- The response's http status code.
DescribeWhatIfForecast
data DescribeWhatIfForecast Source #
See: newDescribeWhatIfForecast
smart constructor.
Constructors
DescribeWhatIfForecast' Text |
Instances
newDescribeWhatIfForecast Source #
Arguments
:: Text | |
-> DescribeWhatIfForecast |
Create a value of DescribeWhatIfForecast
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfForecast
, describeWhatIfForecast_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast that you are
interested in.
data DescribeWhatIfForecastResponse Source #
See: newDescribeWhatIfForecastResponse
smart constructor.
Constructors
DescribeWhatIfForecastResponse' (Maybe POSIX) (Maybe Integer) (Maybe (NonEmpty Text)) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe TimeSeriesReplacementsDataSource) (Maybe [TimeSeriesTransformation]) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeWhatIfForecastResponse Source #
Create a value of DescribeWhatIfForecastResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfForecastResponse
, describeWhatIfForecastResponse_creationTime
- When the what-if forecast was created.
$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfForecastResponse'
, describeWhatIfForecastResponse_estimatedTimeRemainingInMinutes
- The approximate time remaining to complete the what-if forecast, in
minutes.
$sel:forecastTypes:DescribeWhatIfForecastResponse'
, describeWhatIfForecastResponse_forecastTypes
- 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
, describeWhatIfForecastResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeWhatIfForecastResponse
, describeWhatIfForecastResponse_message
- If an error occurred, an informational message about the error.
DescribeWhatIfForecastResponse
, describeWhatIfForecastResponse_status
- 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.
$sel:timeSeriesReplacementsDataSource:DescribeWhatIfForecastResponse'
, describeWhatIfForecastResponse_timeSeriesReplacementsDataSource
- An array of S3Config
, Schema
, and Format
elements that describe
the replacement time series.
$sel:timeSeriesTransformations:DescribeWhatIfForecastResponse'
, describeWhatIfForecastResponse_timeSeriesTransformations
- An array of Action
and TimeSeriesConditions
elements that describe
what transformations were applied to which time series.
DescribeWhatIfForecastResponse
, describeWhatIfForecastResponse_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis that contains
this forecast.
DescribeWhatIfForecast
, describeWhatIfForecastResponse_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast.
DescribeWhatIfForecastResponse
, describeWhatIfForecastResponse_whatIfForecastName
- The name of the what-if forecast.
$sel:httpStatus:DescribeWhatIfForecastResponse'
, describeWhatIfForecastResponse_httpStatus
- The response's http status code.
DescribeWhatIfForecastExport
data DescribeWhatIfForecastExport Source #
See: newDescribeWhatIfForecastExport
smart constructor.
Constructors
DescribeWhatIfForecastExport' Text |
Instances
newDescribeWhatIfForecastExport Source #
Arguments
:: Text | |
-> DescribeWhatIfForecastExport |
Create a value of DescribeWhatIfForecastExport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfForecastExport
, describeWhatIfForecastExport_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export that you
are interested in.
data DescribeWhatIfForecastExportResponse Source #
See: newDescribeWhatIfForecastExportResponse
smart constructor.
Constructors
DescribeWhatIfForecastExportResponse' (Maybe POSIX) (Maybe DataDestination) (Maybe Integer) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeWhatIfForecastExportResponse Source #
Arguments
:: Int | |
-> DescribeWhatIfForecastExportResponse |
Create a value of DescribeWhatIfForecastExportResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_creationTime
- When the what-if forecast export was created.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_destination
- Undocumented member.
$sel:estimatedTimeRemainingInMinutes:DescribeWhatIfForecastExportResponse'
, describeWhatIfForecastExportResponse_estimatedTimeRemainingInMinutes
- The approximate time remaining to complete the what-if forecast export,
in minutes.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_format
- The format of the exported data, CSV or PARQUET.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_message
- If an error occurred, an informational message about the error.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_status
- 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
, describeWhatIfForecastExportResponse_whatIfForecastArns
- An array of Amazon Resource Names (ARNs) that represent all of the
what-if forecasts exported in this resource.
DescribeWhatIfForecastExport
, describeWhatIfForecastExportResponse_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export.
DescribeWhatIfForecastExportResponse
, describeWhatIfForecastExportResponse_whatIfForecastExportName
- The name of the what-if forecast export.
$sel:httpStatus:DescribeWhatIfForecastExportResponse'
, describeWhatIfForecastExportResponse_httpStatus
- The response's http status code.
GetAccuracyMetrics
data GetAccuracyMetrics Source #
See: newGetAccuracyMetrics
smart constructor.
Constructors
GetAccuracyMetrics' Text |
Instances
newGetAccuracyMetrics Source #
Arguments
:: Text | |
-> GetAccuracyMetrics |
Create a value of GetAccuracyMetrics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetAccuracyMetrics
, getAccuracyMetrics_predictorArn
- The Amazon Resource Name (ARN) of the predictor to get metrics for.
data GetAccuracyMetricsResponse Source #
See: newGetAccuracyMetricsResponse
smart constructor.
Constructors
GetAccuracyMetricsResponse' (Maybe AutoMLOverrideStrategy) (Maybe Bool) (Maybe OptimizationMetric) (Maybe [EvaluationResult]) Int |
Instances
newGetAccuracyMetricsResponse Source #
Create a value of GetAccuracyMetricsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoMLOverrideStrategy:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_autoMLOverrideStrategy
- The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
GetAccuracyMetricsResponse
, getAccuracyMetricsResponse_isAutoPredictor
- Whether the predictor was created with CreateAutoPredictor.
$sel:optimizationMetric:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_optimizationMetric
- The accuracy metric used to optimize the predictor.
$sel:predictorEvaluationResults:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_predictorEvaluationResults
- An array of results from evaluating the predictor.
$sel:httpStatus:GetAccuracyMetricsResponse'
, getAccuracyMetricsResponse_httpStatus
- The response's http status code.
ListDatasetGroups (Paginated)
data ListDatasetGroups Source #
See: newListDatasetGroups
smart constructor.
Constructors
ListDatasetGroups' (Maybe Natural) (Maybe Text) |
Instances
newListDatasetGroups :: ListDatasetGroups Source #
Create a value of ListDatasetGroups
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDatasetGroups'
, listDatasetGroups_maxResults
- The number of items to return in the response.
ListDatasetGroups
, listDatasetGroups_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListDatasetGroupsResponse Source #
See: newListDatasetGroupsResponse
smart constructor.
Constructors
ListDatasetGroupsResponse' (Maybe [DatasetGroupSummary]) (Maybe Text) Int |
Instances
newListDatasetGroupsResponse Source #
Create a value of ListDatasetGroupsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetGroups:ListDatasetGroupsResponse'
, listDatasetGroupsResponse_datasetGroups
- An array of objects that summarize each dataset group's properties.
ListDatasetGroups
, listDatasetGroupsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListDatasetGroupsResponse'
, listDatasetGroupsResponse_httpStatus
- The response's http status code.
ListDatasetImportJobs (Paginated)
data ListDatasetImportJobs Source #
See: newListDatasetImportJobs
smart constructor.
Instances
newListDatasetImportJobs :: ListDatasetImportJobs Source #
Create a value of ListDatasetImportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListDatasetImportJobs'
, listDatasetImportJobs_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the datasets that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the datasets that match the statement, specifyIS
. To exclude matching datasets, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetArn
andStatus
.Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
$sel:maxResults:ListDatasetImportJobs'
, listDatasetImportJobs_maxResults
- The number of items to return in the response.
ListDatasetImportJobs
, listDatasetImportJobs_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListDatasetImportJobsResponse Source #
See: newListDatasetImportJobsResponse
smart constructor.
Constructors
ListDatasetImportJobsResponse' (Maybe [DatasetImportJobSummary]) (Maybe Text) Int |
Instances
newListDatasetImportJobsResponse Source #
Create a value of ListDatasetImportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetImportJobs:ListDatasetImportJobsResponse'
, listDatasetImportJobsResponse_datasetImportJobs
- An array of objects that summarize each dataset import job's
properties.
ListDatasetImportJobs
, listDatasetImportJobsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListDatasetImportJobsResponse'
, listDatasetImportJobsResponse_httpStatus
- The response's http status code.
ListDatasets (Paginated)
data ListDatasets Source #
See: newListDatasets
smart constructor.
Constructors
ListDatasets' (Maybe Natural) (Maybe Text) |
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDatasets'
, listDatasets_maxResults
- The number of items to return in the response.
ListDatasets
, listDatasets_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListDatasetsResponse Source #
See: newListDatasetsResponse
smart constructor.
Constructors
ListDatasetsResponse' (Maybe [DatasetSummary]) (Maybe Text) Int |
Instances
newListDatasetsResponse Source #
Arguments
:: Int | |
-> ListDatasetsResponse |
Create a value of ListDatasetsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasets:ListDatasetsResponse'
, listDatasetsResponse_datasets
- An array of objects that summarize each dataset's properties.
ListDatasets
, listDatasetsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListDatasetsResponse'
, listDatasetsResponse_httpStatus
- The response's http status code.
ListExplainabilities (Paginated)
data ListExplainabilities Source #
See: newListExplainabilities
smart constructor.
Instances
newListExplainabilities :: ListExplainabilities Source #
Create a value of ListExplainabilities
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListExplainabilities'
, listExplainabilities_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the 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.
$sel:maxResults:ListExplainabilities'
, listExplainabilities_maxResults
- The number of items returned in the response.
ListExplainabilities
, listExplainabilities_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken. To retrieve the next set of results, use the token
in the next request. Tokens expire after 24 hours.
data ListExplainabilitiesResponse Source #
See: newListExplainabilitiesResponse
smart constructor.
Constructors
ListExplainabilitiesResponse' (Maybe [ExplainabilitySummary]) (Maybe Text) Int |
Instances
newListExplainabilitiesResponse Source #
Create a value of ListExplainabilitiesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:explainabilities:ListExplainabilitiesResponse'
, listExplainabilitiesResponse_explainabilities
- An array of objects that summarize the properties of each Explainability
resource.
ListExplainabilities
, listExplainabilitiesResponse_nextToken
- Returns this token if the response is truncated. To retrieve the next
set of results, use the token in the next request.
$sel:httpStatus:ListExplainabilitiesResponse'
, listExplainabilitiesResponse_httpStatus
- The response's http status code.
ListExplainabilityExports (Paginated)
data ListExplainabilityExports Source #
See: newListExplainabilityExports
smart constructor.
Instances
newListExplainabilityExports :: ListExplainabilityExports Source #
Create a value of ListExplainabilityExports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListExplainabilityExports'
, listExplainabilityExports_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude 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.
$sel:maxResults:ListExplainabilityExports'
, listExplainabilityExports_maxResults
- The number of items to return in the response.
ListExplainabilityExports
, listExplainabilityExports_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken. To retrieve the next set of results, use the token
in the next request. Tokens expire after 24 hours.
data ListExplainabilityExportsResponse Source #
See: newListExplainabilityExportsResponse
smart constructor.
Constructors
ListExplainabilityExportsResponse' (Maybe [ExplainabilityExportSummary]) (Maybe Text) Int |
Instances
newListExplainabilityExportsResponse Source #
Arguments
:: Int | |
-> ListExplainabilityExportsResponse |
Create a value of ListExplainabilityExportsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:explainabilityExports:ListExplainabilityExportsResponse'
, listExplainabilityExportsResponse_explainabilityExports
- An array of objects that summarize the properties of each Explainability
export.
ListExplainabilityExports
, listExplainabilityExportsResponse_nextToken
- Returns this token if the response is truncated. To retrieve the next
set of results, use the token in the next request.
$sel:httpStatus:ListExplainabilityExportsResponse'
, listExplainabilityExportsResponse_httpStatus
- The response's http status code.
ListForecastExportJobs (Paginated)
data ListForecastExportJobs Source #
See: newListForecastExportJobs
smart constructor.
Instances
newListForecastExportJobs :: ListForecastExportJobs Source #
Create a value of ListForecastExportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListForecastExportJobs'
, listForecastExportJobs_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecast export jobs that
match the statement from the list, respectively. The match statement
consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
$sel:maxResults:ListForecastExportJobs'
, listForecastExportJobs_maxResults
- The number of items to return in the response.
ListForecastExportJobs
, listForecastExportJobs_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListForecastExportJobsResponse Source #
See: newListForecastExportJobsResponse
smart constructor.
Constructors
ListForecastExportJobsResponse' (Maybe [ForecastExportJobSummary]) (Maybe Text) Int |
Instances
newListForecastExportJobsResponse Source #
Create a value of ListForecastExportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecastExportJobs:ListForecastExportJobsResponse'
, listForecastExportJobsResponse_forecastExportJobs
- An array of objects that summarize each export job's properties.
ListForecastExportJobs
, listForecastExportJobsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListForecastExportJobsResponse'
, listForecastExportJobsResponse_httpStatus
- The response's http status code.
ListForecasts (Paginated)
data ListForecasts Source #
See: newListForecasts
smart constructor.
Instances
newListForecasts :: ListForecasts Source #
Create a value of ListForecasts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListForecasts'
, listForecasts_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecasts that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
$sel:maxResults:ListForecasts'
, listForecasts_maxResults
- The number of items to return in the response.
ListForecasts
, listForecasts_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListForecastsResponse Source #
See: newListForecastsResponse
smart constructor.
Constructors
ListForecastsResponse' (Maybe [ForecastSummary]) (Maybe Text) Int |
Instances
newListForecastsResponse Source #
Create a value of ListForecastsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecasts:ListForecastsResponse'
, listForecastsResponse_forecasts
- An array of objects that summarize each forecast's properties.
ListForecasts
, listForecastsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListForecastsResponse'
, listForecastsResponse_httpStatus
- The response's http status code.
ListMonitorEvaluations (Paginated)
data ListMonitorEvaluations Source #
See: newListMonitorEvaluations
smart constructor.
Instances
newListMonitorEvaluations Source #
Arguments
:: Text | |
-> ListMonitorEvaluations |
Create a value of ListMonitorEvaluations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListMonitorEvaluations'
, listMonitorEvaluations_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the 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" } ]
$sel:maxResults:ListMonitorEvaluations'
, listMonitorEvaluations_maxResults
- The maximum number of monitoring results to return.
ListMonitorEvaluations
, listMonitorEvaluations_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
ListMonitorEvaluations
, listMonitorEvaluations_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource to get results
from.
data ListMonitorEvaluationsResponse Source #
See: newListMonitorEvaluationsResponse
smart constructor.
Constructors
ListMonitorEvaluationsResponse' (Maybe Text) (Maybe [PredictorMonitorEvaluation]) Int |
Instances
newListMonitorEvaluationsResponse Source #
Create a value of ListMonitorEvaluationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMonitorEvaluations
, listMonitorEvaluationsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
Tokens expire after 24 hours.
$sel:predictorMonitorEvaluations:ListMonitorEvaluationsResponse'
, listMonitorEvaluationsResponse_predictorMonitorEvaluations
- 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.
$sel:httpStatus:ListMonitorEvaluationsResponse'
, listMonitorEvaluationsResponse_httpStatus
- The response's http status code.
ListMonitors (Paginated)
data ListMonitors Source #
See: newListMonitors
smart constructor.
Instances
newListMonitors :: ListMonitors Source #
Create a value of ListMonitors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListMonitors'
, listMonitors_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the 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" } ]
$sel:maxResults:ListMonitors'
, listMonitors_maxResults
- The maximum number of monitors to include in the response.
ListMonitors
, listMonitors_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListMonitorsResponse Source #
See: newListMonitorsResponse
smart constructor.
Constructors
ListMonitorsResponse' (Maybe [MonitorSummary]) (Maybe Text) Int |
Instances
newListMonitorsResponse Source #
Arguments
:: Int | |
-> ListMonitorsResponse |
Create a value of ListMonitorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:monitors:ListMonitorsResponse'
, listMonitorsResponse_monitors
- An array of objects that summarize each monitor's properties.
ListMonitors
, listMonitorsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:httpStatus:ListMonitorsResponse'
, listMonitorsResponse_httpStatus
- The response's http status code.
ListPredictorBacktestExportJobs (Paginated)
data ListPredictorBacktestExportJobs Source #
See: newListPredictorBacktestExportJobs
smart constructor.
Instances
newListPredictorBacktestExportJobs :: ListPredictorBacktestExportJobs Source #
Create a value of ListPredictorBacktestExportJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobs_filters
- An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the predictor backtest export jobs that
match the statement from the list. The match statement consists of a key
and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictor backtest export jobs that match the statement, specifyIS
. To exclude matching predictor backtest export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values arePredictorArn
andStatus
.Value
- The value to match.
$sel:maxResults:ListPredictorBacktestExportJobs'
, listPredictorBacktestExportJobs_maxResults
- The number of items to return in the response.
ListPredictorBacktestExportJobs
, listPredictorBacktestExportJobs_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken. To retrieve the next set of results, use the token
in the next request. Tokens expire after 24 hours.
data ListPredictorBacktestExportJobsResponse Source #
See: newListPredictorBacktestExportJobsResponse
smart constructor.
Constructors
ListPredictorBacktestExportJobsResponse' (Maybe Text) (Maybe [PredictorBacktestExportJobSummary]) Int |
Instances
newListPredictorBacktestExportJobsResponse Source #
Arguments
:: Int | |
-> ListPredictorBacktestExportJobsResponse |
Create a value of ListPredictorBacktestExportJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPredictorBacktestExportJobs
, listPredictorBacktestExportJobsResponse_nextToken
- Returns this token if the response is truncated. To retrieve the next
set of results, use the token in the next request.
$sel:predictorBacktestExportJobs:ListPredictorBacktestExportJobsResponse'
, listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs
- An array of objects that summarize the properties of each predictor
backtest export job.
$sel:httpStatus:ListPredictorBacktestExportJobsResponse'
, listPredictorBacktestExportJobsResponse_httpStatus
- The response's http status code.
ListPredictors (Paginated)
data ListPredictors Source #
See: newListPredictors
smart constructor.
Instances
newListPredictors :: ListPredictors Source #
Create a value of ListPredictors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListPredictors'
, listPredictors_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the predictors that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictors that match the statement, specifyIS
. To exclude matching predictors, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
andStatus
.Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
$sel:maxResults:ListPredictors'
, listPredictors_maxResults
- The number of items to return in the response.
ListPredictors
, listPredictors_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListPredictorsResponse Source #
See: newListPredictorsResponse
smart constructor.
Constructors
ListPredictorsResponse' (Maybe Text) (Maybe [PredictorSummary]) Int |
Instances
newListPredictorsResponse Source #
Create a value of ListPredictorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPredictors
, listPredictorsResponse_nextToken
- If the response is truncated, Amazon Forecast returns this token. To
retrieve the next set of results, use the token in the next request.
$sel:predictors:ListPredictorsResponse'
, listPredictorsResponse_predictors
- An array of objects that summarize each predictor's properties.
$sel:httpStatus:ListPredictorsResponse'
, listPredictorsResponse_httpStatus
- The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource
smart constructor.
Constructors
ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
:: Text | |
-> ListTagsForResource |
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResource
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse
smart constructor.
Constructors
ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tags:ListTagsForResourceResponse'
, listTagsForResourceResponse_tags
- The tags for the resource.
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWhatIfAnalyses (Paginated)
data ListWhatIfAnalyses Source #
See: newListWhatIfAnalyses
smart constructor.
Instances
newListWhatIfAnalyses :: ListWhatIfAnalyses Source #
Create a value of ListWhatIfAnalyses
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWhatIfAnalyses'
, listWhatIfAnalyses_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the 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" } ]
$sel:maxResults:ListWhatIfAnalyses'
, listWhatIfAnalyses_maxResults
- The number of items to return in the response.
ListWhatIfAnalyses
, listWhatIfAnalyses_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
data ListWhatIfAnalysesResponse Source #
See: newListWhatIfAnalysesResponse
smart constructor.
Constructors
ListWhatIfAnalysesResponse' (Maybe Text) (Maybe [WhatIfAnalysisSummary]) Int |
Instances
newListWhatIfAnalysesResponse Source #
Create a value of ListWhatIfAnalysesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWhatIfAnalyses
, listWhatIfAnalysesResponse_nextToken
- If the response is truncated, Forecast returns this token. To retrieve
the next set of results, use the token in the next request.
$sel:whatIfAnalyses:ListWhatIfAnalysesResponse'
, listWhatIfAnalysesResponse_whatIfAnalyses
- An array of WhatIfAnalysisSummary
objects that describe the matched
analyses.
$sel:httpStatus:ListWhatIfAnalysesResponse'
, listWhatIfAnalysesResponse_httpStatus
- The response's http status code.
ListWhatIfForecastExports (Paginated)
data ListWhatIfForecastExports Source #
See: newListWhatIfForecastExports
smart constructor.
Instances
newListWhatIfForecastExports :: ListWhatIfForecastExports Source #
Create a value of ListWhatIfForecastExports
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWhatIfForecastExports'
, listWhatIfForecastExports_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the 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" } ]
$sel:maxResults:ListWhatIfForecastExports'
, listWhatIfForecastExports_maxResults
- The number of items to return in the response.
ListWhatIfForecastExports
, listWhatIfForecastExports_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
data ListWhatIfForecastExportsResponse Source #
See: newListWhatIfForecastExportsResponse
smart constructor.
Constructors
ListWhatIfForecastExportsResponse' (Maybe Text) (Maybe [WhatIfForecastExportSummary]) Int |
Instances
newListWhatIfForecastExportsResponse Source #
Arguments
:: Int | |
-> ListWhatIfForecastExportsResponse |
Create a value of ListWhatIfForecastExportsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWhatIfForecastExports
, listWhatIfForecastExportsResponse_nextToken
- If the response is truncated, Forecast returns this token. To retrieve
the next set of results, use the token in the next request.
$sel:whatIfForecastExports:ListWhatIfForecastExportsResponse'
, listWhatIfForecastExportsResponse_whatIfForecastExports
- An array of WhatIfForecastExports
objects that describe the matched
forecast exports.
$sel:httpStatus:ListWhatIfForecastExportsResponse'
, listWhatIfForecastExportsResponse_httpStatus
- The response's http status code.
ListWhatIfForecasts (Paginated)
data ListWhatIfForecasts Source #
See: newListWhatIfForecasts
smart constructor.
Instances
newListWhatIfForecasts :: ListWhatIfForecasts Source #
Create a value of ListWhatIfForecasts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:ListWhatIfForecasts'
, listWhatIfForecasts_filters
- An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the 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" } ]
$sel:maxResults:ListWhatIfForecasts'
, listWhatIfForecasts_maxResults
- The number of items to return in the response.
ListWhatIfForecasts
, listWhatIfForecasts_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
data ListWhatIfForecastsResponse Source #
See: newListWhatIfForecastsResponse
smart constructor.
Constructors
ListWhatIfForecastsResponse' (Maybe Text) (Maybe [WhatIfForecastSummary]) Int |
Instances
newListWhatIfForecastsResponse Source #
Create a value of ListWhatIfForecastsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWhatIfForecasts
, listWhatIfForecastsResponse_nextToken
- If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next
request. Tokens expire after 24 hours.
$sel:whatIfForecasts:ListWhatIfForecastsResponse'
, listWhatIfForecastsResponse_whatIfForecasts
- An array of WhatIfForecasts
objects that describe the matched
forecasts.
$sel:httpStatus:ListWhatIfForecastsResponse'
, listWhatIfForecastsResponse_httpStatus
- The response's http status code.
ResumeResource
data ResumeResource Source #
See: newResumeResource
smart constructor.
Constructors
ResumeResource' Text |
Instances
Arguments
:: Text | |
-> ResumeResource |
Create a value of ResumeResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ResumeResource
, resumeResource_resourceArn
- The Amazon Resource Name (ARN) of the monitor resource to resume.
data ResumeResourceResponse Source #
See: newResumeResourceResponse
smart constructor.
Constructors
ResumeResourceResponse' | |
Instances
Generic ResumeResourceResponse Source # | |
Defined in Amazonka.Forecast.ResumeResource Associated Types type Rep ResumeResourceResponse :: Type -> Type # Methods from :: ResumeResourceResponse -> Rep ResumeResourceResponse x # to :: Rep ResumeResourceResponse x -> ResumeResourceResponse # | |
Read ResumeResourceResponse Source # | |
Defined in Amazonka.Forecast.ResumeResource | |
Show ResumeResourceResponse Source # | |
Defined in Amazonka.Forecast.ResumeResource Methods showsPrec :: Int -> ResumeResourceResponse -> ShowS # show :: ResumeResourceResponse -> String # showList :: [ResumeResourceResponse] -> ShowS # | |
NFData ResumeResourceResponse Source # | |
Defined in Amazonka.Forecast.ResumeResource Methods rnf :: ResumeResourceResponse -> () # | |
Eq ResumeResourceResponse Source # | |
Defined in Amazonka.Forecast.ResumeResource Methods (==) :: ResumeResourceResponse -> ResumeResourceResponse -> Bool # (/=) :: ResumeResourceResponse -> ResumeResourceResponse -> Bool # | |
type Rep ResumeResourceResponse Source # | |
newResumeResourceResponse :: ResumeResourceResponse Source #
Create a value of ResumeResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopResource
data StopResource Source #
See: newStopResource
smart constructor.
Constructors
StopResource' Text |
Instances
Arguments
:: Text | |
-> StopResource |
Create a value of StopResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopResource
, stopResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource to stop. The
supported ARNs are DatasetImportJobArn
, PredictorArn
,
PredictorBacktestExportJobArn
, ForecastArn
, ForecastExportJobArn
,
ExplainabilityArn
, and ExplainabilityExportArn
.
data StopResourceResponse Source #
See: newStopResourceResponse
smart constructor.
Constructors
StopResourceResponse' | |
Instances
newStopResourceResponse :: StopResourceResponse Source #
Create a value of StopResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text [Tag] |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
TagResource
, tagResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
$sel:tags:TagResource'
, tagResource_tags
- The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
:: Int | |
-> TagResourceResponse |
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Sensitive Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UntagResource
, untagResource_resourceArn
- The Amazon Resource Name (ARN) that identifies the resource for which to
list the tags.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The keys of the tags to be removed.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateDatasetGroup
data UpdateDatasetGroup Source #
See: newUpdateDatasetGroup
smart constructor.
Constructors
UpdateDatasetGroup' Text [Text] |
Instances
newUpdateDatasetGroup Source #
Arguments
:: Text | |
-> UpdateDatasetGroup |
Create a value of UpdateDatasetGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDatasetGroup
, updateDatasetGroup_datasetGroupArn
- The ARN of the dataset group.
$sel:datasetArns:UpdateDatasetGroup'
, updateDatasetGroup_datasetArns
- An array of the Amazon Resource Names (ARNs) of the datasets to add to
the dataset group.
data UpdateDatasetGroupResponse Source #
See: newUpdateDatasetGroupResponse
smart constructor.
Constructors
UpdateDatasetGroupResponse' Int |
Instances
newUpdateDatasetGroupResponse Source #
Create a value of UpdateDatasetGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDatasetGroupResponse'
, updateDatasetGroupResponse_httpStatus
- The response's http status code.
Types
AttributeType
newtype AttributeType Source #
Constructors
AttributeType' | |
Fields |
Bundled Patterns
pattern AttributeType_Float :: AttributeType | |
pattern AttributeType_Geolocation :: AttributeType | |
pattern AttributeType_Integer :: AttributeType | |
pattern AttributeType_String :: AttributeType | |
pattern AttributeType_Timestamp :: AttributeType |
Instances
AutoMLOverrideStrategy
newtype AutoMLOverrideStrategy Source #
Constructors
AutoMLOverrideStrategy' | |
Fields |
Bundled Patterns
pattern AutoMLOverrideStrategy_AccuracyOptimized :: AutoMLOverrideStrategy | |
pattern AutoMLOverrideStrategy_LatencyOptimized :: AutoMLOverrideStrategy |
Instances
Condition
Constructors
Condition' | |
Fields |
Bundled Patterns
pattern Condition_EQUALS :: Condition | |
pattern Condition_GREATER_THAN :: Condition | |
pattern Condition_LESS_THAN :: Condition | |
pattern Condition_NOT_EQUALS :: Condition |
Instances
DatasetType
newtype DatasetType Source #
Constructors
DatasetType' | |
Fields |
Bundled Patterns
pattern DatasetType_ITEM_METADATA :: DatasetType | |
pattern DatasetType_RELATED_TIME_SERIES :: DatasetType | |
pattern DatasetType_TARGET_TIME_SERIES :: DatasetType |
Instances
DayOfWeek
Constructors
DayOfWeek' | |
Fields |
Bundled Patterns
pattern DayOfWeek_FRIDAY :: DayOfWeek | |
pattern DayOfWeek_MONDAY :: DayOfWeek | |
pattern DayOfWeek_SATURDAY :: DayOfWeek | |
pattern DayOfWeek_SUNDAY :: DayOfWeek | |
pattern DayOfWeek_THURSDAY :: DayOfWeek | |
pattern DayOfWeek_TUESDAY :: DayOfWeek | |
pattern DayOfWeek_WEDNESDAY :: DayOfWeek |
Instances
Domain
Constructors
Domain' | |
Fields
|
Bundled Patterns
pattern Domain_CUSTOM :: Domain | |
pattern Domain_EC2_CAPACITY :: Domain | |
pattern Domain_INVENTORY_PLANNING :: Domain | |
pattern Domain_METRICS :: Domain | |
pattern Domain_RETAIL :: Domain | |
pattern Domain_WEB_TRAFFIC :: Domain | |
pattern Domain_WORK_FORCE :: Domain |
Instances
EvaluationType
newtype EvaluationType Source #
Constructors
EvaluationType' | |
Fields |
Bundled Patterns
pattern EvaluationType_COMPUTED :: EvaluationType | |
pattern EvaluationType_SUMMARY :: EvaluationType |
Instances
FeaturizationMethodName
newtype FeaturizationMethodName Source #
Constructors
FeaturizationMethodName' | |
Fields |
Bundled Patterns
pattern FeaturizationMethodName_Filling :: FeaturizationMethodName |
Instances
FilterConditionString
newtype FilterConditionString Source #
Constructors
FilterConditionString' | |
Fields |
Bundled Patterns
pattern FilterConditionString_IS :: FilterConditionString | |
pattern FilterConditionString_IS_NOT :: FilterConditionString |
Instances
Month
Bundled Patterns
pattern Month_APRIL :: Month | |
pattern Month_AUGUST :: Month | |
pattern Month_DECEMBER :: Month | |
pattern Month_FEBRUARY :: Month | |
pattern Month_JANUARY :: Month | |
pattern Month_JULY :: Month | |
pattern Month_JUNE :: Month | |
pattern Month_MARCH :: Month | |
pattern Month_MAY :: Month | |
pattern Month_NOVEMBER :: Month | |
pattern Month_OCTOBER :: Month | |
pattern Month_SEPTEMBER :: Month |
Instances
Operation
Constructors
Operation' | |
Fields |
Bundled Patterns
pattern Operation_ADD :: Operation | |
pattern Operation_DIVIDE :: Operation | |
pattern Operation_MULTIPLY :: Operation | |
pattern Operation_SUBTRACT :: Operation |
Instances
OptimizationMetric
newtype OptimizationMetric Source #
Constructors
OptimizationMetric' | |
Fields |
Bundled Patterns
pattern OptimizationMetric_AverageWeightedQuantileLoss :: OptimizationMetric | |
pattern OptimizationMetric_MAPE :: OptimizationMetric | |
pattern OptimizationMetric_MASE :: OptimizationMetric | |
pattern OptimizationMetric_RMSE :: OptimizationMetric | |
pattern OptimizationMetric_WAPE :: OptimizationMetric |
Instances
ScalingType
newtype ScalingType Source #
Constructors
ScalingType' | |
Fields |
Bundled Patterns
pattern ScalingType_Auto :: ScalingType | |
pattern ScalingType_Linear :: ScalingType | |
pattern ScalingType_Logarithmic :: ScalingType | |
pattern ScalingType_ReverseLogarithmic :: ScalingType |
Instances
State
Bundled Patterns
pattern State_Active :: State | |
pattern State_Deleted :: State |
Instances
TimePointGranularity
newtype TimePointGranularity Source #
Constructors
TimePointGranularity' | |
Fields |
Bundled Patterns
pattern TimePointGranularity_ALL :: TimePointGranularity | |
pattern TimePointGranularity_SPECIFIC :: TimePointGranularity |
Instances
TimeSeriesGranularity
newtype TimeSeriesGranularity Source #
Constructors
TimeSeriesGranularity' | |
Fields |
Bundled Patterns
pattern TimeSeriesGranularity_ALL :: TimeSeriesGranularity | |
pattern TimeSeriesGranularity_SPECIFIC :: TimeSeriesGranularity |
Instances
Action
Defines the modifications that you are making to an attribute for a
what-if forecast. For example, you can use this operation to create a
what-if forecast that investigates a 10% off sale on all shoes. To do
this, you specify "AttributeName": "shoes"
,
"Operation": "MULTIPLY"
, and "Value": "0.90"
. Pair this
operation with the TimeSeriesCondition operation within the
CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
define a subset of attribute items that are modified.
See: newAction
smart constructor.
Instances
FromJSON Action Source # | |
ToJSON Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
Generic Action Source # | |
Read Action Source # | |
Show Action Source # | |
NFData Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
Eq Action Source # | |
Hashable Action Source # | |
Defined in Amazonka.Forecast.Types.Action | |
type Rep Action Source # | |
Defined in Amazonka.Forecast.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.Forecast.Types.Action" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "operation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Operation) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))) |
Create a value of Action
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:Action'
, action_attributeName
- The related time series that you are modifying. This value is case
insensitive.
$sel:operation:Action'
, action_operation
- The operation that is applied to the provided attribute. Operations
include:
ADD
- addsValue
to all rows ofAttributeName
.SUBTRACT
- subtractsValue
from all rows ofAttributeName
.MULTIPLY
- multiplies all rows ofAttributeName
byValue
.DIVIDE
- divides all rows ofAttributeName
byValue
.
$sel:value:Action'
, action_value
- The value that is applied for the chosen Operation
.
AdditionalDataset
data AdditionalDataset Source #
Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.
Weather Index
The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.
Holidays
Holidays is a built-in dataset that incorporates national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.
See: newAdditionalDataset
smart constructor.
Instances
Arguments
:: Text | |
-> AdditionalDataset |
Create a value of AdditionalDataset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configuration:AdditionalDataset'
, additionalDataset_configuration
- Weather Index
To enable the Weather Index, do not specify a value for Configuration
.
Holidays
Holidays
To enable Holidays, set CountryCode
to one of the following two-letter
country codes:
- "AL" - ALBANIA
- "AR" - ARGENTINA
- "AT" - AUSTRIA
- "AU" - AUSTRALIA
- "BA" - BOSNIA HERZEGOVINA
- "BE" - BELGIUM
- "BG" - BULGARIA
- "BO" - BOLIVIA
- "BR" - BRAZIL
- "BY" - BELARUS
- "CA" - CANADA
- "CL" - CHILE
- "CO" - COLOMBIA
- "CR" - COSTA RICA
- "HR" - CROATIA
- "CZ" - CZECH REPUBLIC
- "DK" - DENMARK
- "EC" - ECUADOR
- "EE" - ESTONIA
- "ET" - ETHIOPIA
- "FI" - FINLAND
- "FR" - FRANCE
- "DE" - GERMANY
- "GR" - GREECE
- "HU" - HUNGARY
- "IS" - ICELAND
- "IN" - INDIA
- "IE" - IRELAND
- "IT" - ITALY
- "JP" - JAPAN
- "KZ" - KAZAKHSTAN
- "KR" - KOREA
- "LV" - LATVIA
- "LI" - LIECHTENSTEIN
- "LT" - LITHUANIA
- "LU" - LUXEMBOURG
- "MK" - MACEDONIA
- "MT" - MALTA
- "MX" - MEXICO
- "MD" - MOLDOVA
- "ME" - MONTENEGRO
- "NL" - NETHERLANDS
- "NZ" - NEW ZEALAND
- "NI" - NICARAGUA
- "NG" - NIGERIA
- "NO" - NORWAY
- "PA" - PANAMA
- "PY" - PARAGUAY
- "PE" - PERU
- "PL" - POLAND
- "PT" - PORTUGAL
- "RO" - ROMANIA
- "RU" - RUSSIA
- "RS" - SERBIA
- "SK" - SLOVAKIA
- "SI" - SLOVENIA
- "ZA" - SOUTH AFRICA
- "ES" - SPAIN
- "SE" - SWEDEN
- "CH" - SWITZERLAND
- "UA" - UKRAINE
- "AE" - UNITED ARAB EMIRATES
- "US" - UNITED STATES
- "UK" - UNITED KINGDOM
- "UY" - URUGUAY
- "VE" - VENEZUELA
$sel:name:AdditionalDataset'
, additionalDataset_name
- The name of the additional dataset. Valid names: "holiday"
and
"weather"
.
AttributeConfig
data AttributeConfig Source #
Provides information about the method used to transform attributes.
The following is an example using the RETAIL domain:
{
"AttributeName": "demand",
"Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}
}
See: newAttributeConfig
smart constructor.
Constructors
AttributeConfig' Text (HashMap Text Text) |
Instances
Arguments
:: Text | |
-> AttributeConfig |
Create a value of AttributeConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:AttributeConfig'
, attributeConfig_attributeName
- The name of the attribute as specified in the schema. Amazon Forecast
supports the target field of the target time series and the related time
series datasets. For example, for the RETAIL domain, the target is
demand
.
$sel:transformations:AttributeConfig'
, attributeConfig_transformations
- The method parameters (key-value pairs), which are a map of override
parameters. Specify these parameters to override the default values.
Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Default values are bolded.
aggregation
: sum,avg
,first
,min
,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
Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
See: newBaseline
smart constructor.
Constructors
Baseline' (Maybe PredictorBaseline) |
Instances
FromJSON Baseline Source # | |
Generic Baseline Source # | |
Read Baseline Source # | |
Show Baseline Source # | |
NFData Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline | |
Eq Baseline Source # | |
Hashable Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline | |
type Rep Baseline Source # | |
Defined in Amazonka.Forecast.Types.Baseline type Rep Baseline = D1 ('MetaData "Baseline" "Amazonka.Forecast.Types.Baseline" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Baseline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "predictorBaseline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PredictorBaseline)))) |
newBaseline :: Baseline Source #
Create a value of Baseline
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:predictorBaseline:Baseline'
, baseline_predictorBaseline
- The initial
accuracy metrics
for the predictor you are monitoring. Use these metrics as a baseline
for comparison purposes as you use your predictor and the metrics
change.
BaselineMetric
data BaselineMetric Source #
An individual metric that you can use for comparison as you evaluate your monitoring results.
See: newBaselineMetric
smart constructor.
Constructors
BaselineMetric' (Maybe Text) (Maybe Double) |
Instances
newBaselineMetric :: BaselineMetric Source #
Create a value of BaselineMetric
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:BaselineMetric'
, baselineMetric_name
- The name of the metric.
$sel:value:BaselineMetric'
, baselineMetric_value
- The value for the metric.
CategoricalParameterRange
data CategoricalParameterRange Source #
Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newCategoricalParameterRange
smart constructor.
Constructors
CategoricalParameterRange' Text (NonEmpty Text) |
Instances
newCategoricalParameterRange Source #
Arguments
:: Text | |
-> NonEmpty Text | |
-> CategoricalParameterRange |
Create a value of CategoricalParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:CategoricalParameterRange'
, categoricalParameterRange_name
- The name of the categorical hyperparameter to tune.
$sel:values:CategoricalParameterRange'
, categoricalParameterRange_values
- A list of the tunable categories for the hyperparameter.
ContinuousParameterRange
data ContinuousParameterRange Source #
Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newContinuousParameterRange
smart constructor.
Constructors
ContinuousParameterRange' (Maybe ScalingType) Text Double Double |
Instances
newContinuousParameterRange Source #
Arguments
:: Text | |
-> Double | |
-> Double | |
-> ContinuousParameterRange |
Create a value of ContinuousParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scalingType:ContinuousParameterRange'
, continuousParameterRange_scalingType
- The scale that hyperparameter tuning uses to search the hyperparameter
range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- hyperparameter tuning searches the values in the hyperparameter
range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
$sel:name:ContinuousParameterRange'
, continuousParameterRange_name
- The name of the hyperparameter to tune.
$sel:maxValue:ContinuousParameterRange'
, continuousParameterRange_maxValue
- The maximum tunable value of the hyperparameter.
$sel:minValue:ContinuousParameterRange'
, continuousParameterRange_minValue
- The minimum tunable value of the hyperparameter.
DataConfig
data DataConfig Source #
The data configuration for your dataset group and any additional datasets.
See: newDataConfig
smart constructor.
Constructors
DataConfig' (Maybe (NonEmpty AdditionalDataset)) (Maybe (NonEmpty AttributeConfig)) Text |
Instances
Arguments
:: Text | |
-> DataConfig |
Create a value of DataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:additionalDatasets:DataConfig'
, dataConfig_additionalDatasets
- Additional built-in datasets like Holidays and the Weather Index.
$sel:attributeConfigs:DataConfig'
, dataConfig_attributeConfigs
- Aggregation and filling options for attributes in your dataset group.
$sel:datasetGroupArn:DataConfig'
, dataConfig_datasetGroupArn
- The ARN of the dataset group used to train the predictor.
DataDestination
data DataDestination Source #
The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).
See: newDataDestination
smart constructor.
Constructors
DataDestination' S3Config |
Instances
Arguments
:: S3Config | |
-> DataDestination |
Create a value of DataDestination
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Config:DataDestination'
, dataDestination_s3Config
- The path to an Amazon Simple Storage Service (Amazon S3) bucket along
with the credentials to access the bucket.
DataSource
data DataSource Source #
The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key.
See: newDataSource
smart constructor.
Constructors
DataSource' S3Config |
Instances
Arguments
:: S3Config | |
-> DataSource |
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Config:DataSource'
, dataSource_s3Config
- The path to the data stored in an Amazon Simple Storage Service (Amazon
S3) bucket along with the credentials to access the data.
DatasetGroupSummary
data DatasetGroupSummary Source #
Provides a summary of the dataset group properties used in the
ListDatasetGroups
operation. To get the complete set of properties, call the
DescribeDatasetGroup
operation, and provide the DatasetGroupArn
.
See: newDatasetGroupSummary
smart constructor.
Instances
newDatasetGroupSummary :: DatasetGroupSummary Source #
Create a value of DatasetGroupSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatasetGroupSummary'
, datasetGroupSummary_creationTime
- When the dataset group was created.
$sel:datasetGroupArn:DatasetGroupSummary'
, datasetGroupSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
$sel:datasetGroupName:DatasetGroupSummary'
, datasetGroupSummary_datasetGroupName
- The name of the dataset group.
$sel:lastModificationTime:DatasetGroupSummary'
, datasetGroupSummary_lastModificationTime
- When the dataset group was created or last updated from a call to the
UpdateDatasetGroup
operation. While the dataset group is being updated,
LastModificationTime
is the current time of the ListDatasetGroups
call.
DatasetImportJobSummary
data DatasetImportJobSummary Source #
Provides a summary of the dataset import job properties used in the
ListDatasetImportJobs
operation. To get the complete set of properties, call the
DescribeDatasetImportJob
operation, and provide the DatasetImportJobArn
.
See: newDatasetImportJobSummary
smart constructor.
Constructors
DatasetImportJobSummary' (Maybe POSIX) (Maybe DataSource) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newDatasetImportJobSummary :: DatasetImportJobSummary Source #
Create a value of DatasetImportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatasetImportJobSummary'
, datasetImportJobSummary_creationTime
- When the dataset import job was created.
$sel:dataSource:DatasetImportJobSummary'
, datasetImportJobSummary_dataSource
- The location of the training data to import and an AWS Identity and
Access Management (IAM) role that Amazon Forecast can assume to access
the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
$sel:datasetImportJobArn:DatasetImportJobSummary'
, datasetImportJobSummary_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job.
$sel:datasetImportJobName:DatasetImportJobSummary'
, datasetImportJobSummary_datasetImportJobName
- The name of the dataset import job.
$sel:lastModificationTime:DatasetImportJobSummary'
, datasetImportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:DatasetImportJobSummary'
, datasetImportJobSummary_message
- If an error occurred, an informational message about the error.
$sel:status:DatasetImportJobSummary'
, datasetImportJobSummary_status
- The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DatasetSummary
data DatasetSummary Source #
Provides a summary of the dataset properties used in the
ListDatasets
operation. To get the complete set of properties, call the
DescribeDataset
operation, and provide the DatasetArn
.
See: newDatasetSummary
smart constructor.
Constructors
DatasetSummary' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe DatasetType) (Maybe Domain) (Maybe POSIX) |
Instances
newDatasetSummary :: DatasetSummary Source #
Create a value of DatasetSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:DatasetSummary'
, datasetSummary_creationTime
- When the dataset was created.
$sel:datasetArn:DatasetSummary'
, datasetSummary_datasetArn
- The Amazon Resource Name (ARN) of the dataset.
$sel:datasetName:DatasetSummary'
, datasetSummary_datasetName
- The name of the dataset.
$sel:datasetType:DatasetSummary'
, datasetSummary_datasetType
- The dataset type.
$sel:domain:DatasetSummary'
, datasetSummary_domain
- The domain associated with the dataset.
$sel:lastModificationTime:DatasetSummary'
, datasetSummary_lastModificationTime
- When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the ListDatasets
call.
After a
CreateDatasetImportJob
operation has finished, LastModificationTime
is when the import job
completed or failed.
EncryptionConfig
data EncryptionConfig Source #
An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.
See: newEncryptionConfig
smart constructor.
Constructors
EncryptionConfig' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> EncryptionConfig |
Create a value of EncryptionConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:roleArn:EncryptionConfig'
, encryptionConfig_roleArn
- The ARN of the IAM role that Amazon Forecast can assume to access the
AWS KMS key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
$sel:kmsKeyArn:EncryptionConfig'
, encryptionConfig_kmsKeyArn
- The Amazon Resource Name (ARN) of the KMS key.
ErrorMetric
data ErrorMetric Source #
Provides detailed error metrics to evaluate the performance of a predictor. This object is part of the Metrics object.
See: newErrorMetric
smart constructor.
Instances
newErrorMetric :: ErrorMetric Source #
Create a value of ErrorMetric
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:forecastType:ErrorMetric'
, errorMetric_forecastType
- The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
$sel:mape:ErrorMetric'
, errorMetric_mape
- The Mean Absolute Percentage Error (MAPE)
$sel:mase:ErrorMetric'
, errorMetric_mase
- The Mean Absolute Scaled Error (MASE)
$sel:rmse:ErrorMetric'
, errorMetric_rmse
- The root-mean-square error (RMSE).
$sel:wape:ErrorMetric'
, errorMetric_wape
- The weighted absolute percentage error (WAPE).
EvaluationParameters
data EvaluationParameters Source #
Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms but you can override them in the CreatePredictor request.
See: newEvaluationParameters
smart constructor.
Constructors
EvaluationParameters' (Maybe Int) (Maybe Int) |
Instances
newEvaluationParameters :: EvaluationParameters Source #
Create a value of EvaluationParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:backTestWindowOffset:EvaluationParameters'
, evaluationParameters_backTestWindowOffset
- The point from the end of the dataset where you want to split the data
for model training and testing (evaluation). Specify the value as the
number of data points. The default is the value of the forecast horizon.
BackTestWindowOffset
can be used to mimic a past virtual forecast
start date. This value must be greater than or equal to the forecast
horizon and less than half of the TARGET_TIME_SERIES dataset length.
ForecastHorizon
<= BackTestWindowOffset
< 1/2 *
TARGET_TIME_SERIES dataset length
$sel:numberOfBacktestWindows:EvaluationParameters'
, evaluationParameters_numberOfBacktestWindows
- The number of times to split the input data. The default is 1. Valid
values are 1 through 5.
EvaluationResult
data EvaluationResult Source #
The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.
See: newEvaluationResult
smart constructor.
Constructors
EvaluationResult' (Maybe Text) (Maybe [WindowSummary]) |
Instances
newEvaluationResult :: EvaluationResult Source #
Create a value of EvaluationResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmArn:EvaluationResult'
, evaluationResult_algorithmArn
- The Amazon Resource Name (ARN) of the algorithm that was evaluated.
$sel:testWindows:EvaluationResult'
, evaluationResult_testWindows
- The array of test windows used for evaluating the algorithm. The
NumberOfBacktestWindows
from the EvaluationParameters object
determines the number of windows in the array.
ExplainabilityConfig
data ExplainabilityConfig Source #
The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.
If you provide a predictor ARN for ResourceArn
, you must set both
TimePointGranularity
and TimeSeriesGranularity
to “ALL”. When
creating Predictor Explainability, Amazon Forecast considers all time
series and time points.
If you provide a forecast ARN for ResourceArn
, you can set
TimePointGranularity
and TimeSeriesGranularity
to either “ALL” or
“Specific”.
See: newExplainabilityConfig
smart constructor.
Instances
newExplainabilityConfig Source #
Arguments
:: TimeSeriesGranularity | |
-> TimePointGranularity | |
-> ExplainabilityConfig |
Create a value of ExplainabilityConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeSeriesGranularity:ExplainabilityConfig'
, explainabilityConfig_timeSeriesGranularity
- To create an Explainability for all time series in your datasets, use
ALL
. To create an Explainability for specific time series in your
datasets, use SPECIFIC
.
Specify time series by uploading a CSV or Parquet file to an Amazon S3 bucket and set the location within the DataDestination data type.
$sel:timePointGranularity:ExplainabilityConfig'
, explainabilityConfig_timePointGranularity
- To create an Explainability for all time points in your forecast
horizon, use ALL
. To create an Explainability for specific time points
in your forecast horizon, use SPECIFIC
.
Specify time points with the StartDateTime
and EndDateTime
parameters within the CreateExplainability operation.
ExplainabilityExportSummary
data ExplainabilityExportSummary Source #
Provides a summary of the Explainability export properties used in the
ListExplainabilityExports operation. To get a complete set of
properties, call the DescribeExplainabilityExport operation, and provide
the ExplainabilityExportArn
.
See: newExplainabilityExportSummary
smart constructor.
Constructors
ExplainabilityExportSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newExplainabilityExportSummary :: ExplainabilityExportSummary Source #
Create a value of ExplainabilityExportSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ExplainabilityExportSummary'
, explainabilityExportSummary_creationTime
- When the Explainability was created.
$sel:destination:ExplainabilityExportSummary'
, explainabilityExportSummary_destination
- Undocumented member.
$sel:explainabilityExportArn:ExplainabilityExportSummary'
, explainabilityExportSummary_explainabilityExportArn
- The Amazon Resource Name (ARN) of the Explainability export.
$sel:explainabilityExportName:ExplainabilityExportSummary'
, explainabilityExportSummary_explainabilityExportName
- The name of the Explainability export
$sel:lastModificationTime:ExplainabilityExportSummary'
, explainabilityExportSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:ExplainabilityExportSummary'
, explainabilityExportSummary_message
- Information about any errors that may have occurred during the
Explainability export.
$sel:status:ExplainabilityExportSummary'
, explainabilityExportSummary_status
- The status of the Explainability export. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ExplainabilityInfo
data ExplainabilityInfo Source #
Provides information about the Explainability resource.
See: newExplainabilityInfo
smart constructor.
Constructors
ExplainabilityInfo' (Maybe Text) (Maybe Text) |
Instances
newExplainabilityInfo :: ExplainabilityInfo Source #
Create a value of ExplainabilityInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:explainabilityArn:ExplainabilityInfo'
, explainabilityInfo_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability.
$sel:status:ExplainabilityInfo'
, explainabilityInfo_status
- The status of the Explainability. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ExplainabilitySummary
data ExplainabilitySummary Source #
Provides a summary of the Explainability properties used in the
ListExplainabilities operation. To get a complete set of properties,
call the DescribeExplainability operation, and provide the listed
ExplainabilityArn
.
See: newExplainabilitySummary
smart constructor.
Constructors
ExplainabilitySummary' (Maybe POSIX) (Maybe Text) (Maybe ExplainabilityConfig) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newExplainabilitySummary :: ExplainabilitySummary Source #
Create a value of ExplainabilitySummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ExplainabilitySummary'
, explainabilitySummary_creationTime
- When the Explainability was created.
$sel:explainabilityArn:ExplainabilitySummary'
, explainabilitySummary_explainabilityArn
- The Amazon Resource Name (ARN) of the Explainability.
$sel:explainabilityConfig:ExplainabilitySummary'
, explainabilitySummary_explainabilityConfig
- The configuration settings that define the granularity of time series
and time points for the Explainability.
$sel:explainabilityName:ExplainabilitySummary'
, explainabilitySummary_explainabilityName
- The name of the Explainability.
$sel:lastModificationTime:ExplainabilitySummary'
, explainabilitySummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:ExplainabilitySummary'
, explainabilitySummary_message
- Information about any errors that may have occurred during the
Explainability creation process.
$sel:resourceArn:ExplainabilitySummary'
, explainabilitySummary_resourceArn
- The Amazon Resource Name (ARN) of the Predictor or Forecast used to
create the Explainability.
$sel:status:ExplainabilitySummary'
, explainabilitySummary_status
- The status of the Explainability. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
Featurization
data Featurization Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.
Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.
For example:
{
"AttributeName": "demand",
FeaturizationPipeline [ {
"FeaturizationMethodName": "filling",
"FeaturizationMethodParameters": {"aggregation": "avg", "backfill": "nan"}
} ]
}
See: newFeaturization
smart constructor.
Constructors
Featurization' (Maybe (NonEmpty FeaturizationMethod)) Text |
Instances
Arguments
:: Text | |
-> Featurization |
Create a value of Featurization
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featurizationPipeline:Featurization'
, featurization_featurizationPipeline
- An array of one FeaturizationMethod
object that specifies the feature
transformation method.
$sel:attributeName:Featurization'
, featurization_attributeName
- The name of the schema attribute that specifies the data field to be
featurized. Amazon Forecast supports the target field of the
TARGET_TIME_SERIES
and the RELATED_TIME_SERIES
datasets. For
example, for the RETAIL
domain, the target is demand
, and for the
CUSTOM
domain, the target is target_value
. For more information, see
howitworks-missing-values.
FeaturizationConfig
data FeaturizationConfig Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AttributeConfig.
In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.
You define featurization using the FeaturizationConfig
object. You
specify an array of transformations, one for each field that you want to
featurize. You then include the FeaturizationConfig
object in your
CreatePredictor
request. Amazon Forecast applies the featurization to
the TARGET_TIME_SERIES
and RELATED_TIME_SERIES
datasets before model
training.
You can create multiple featurization configurations. For example, you
might call the CreatePredictor
operation twice by specifying different
featurization configurations.
See: newFeaturizationConfig
smart constructor.
Constructors
FeaturizationConfig' (Maybe (NonEmpty Featurization)) (Maybe (NonEmpty Text)) Text |
Instances
newFeaturizationConfig Source #
Create a value of FeaturizationConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featurizations:FeaturizationConfig'
, featurizationConfig_featurizations
- An array of featurization (transformation) information for the fields of
a dataset.
$sel:forecastDimensions:FeaturizationConfig'
, featurizationConfig_forecastDimensions
- An array of dimension (field) names that specify how to group the
generated forecast.
For example, suppose that you are generating a forecast for item sales
across all of your stores, and your dataset contains a store_id
field.
If you want the sales forecast for each item by store, you would specify
store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset
don't need to be specified in the CreatePredictor
request. All
forecast dimensions specified in the RELATED_TIME_SERIES
dataset must
be specified in the CreatePredictor
request.
$sel:forecastFrequency:FeaturizationConfig'
, featurizationConfig_forecastFrequency
- The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
FeaturizationMethod
data FeaturizationMethod Source #
Provides information about the method that featurizes (transforms) a
dataset field. The method is part of the FeaturizationPipeline
of the
Featurization object.
The following is an example of how you specify a FeaturizationMethod
object.
{
"FeaturizationMethodName": "filling",
"FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", "backfill": "zero"}
}
See: newFeaturizationMethod
smart constructor.
Constructors
FeaturizationMethod' (Maybe (HashMap Text Text)) FeaturizationMethodName |
Instances
newFeaturizationMethod Source #
Arguments
:: FeaturizationMethodName | |
-> FeaturizationMethod |
Create a value of FeaturizationMethod
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:featurizationMethodParameters:FeaturizationMethod'
, featurizationMethod_featurizationMethodParameters
- The method parameters (key-value pairs), which are a map of override
parameters. Specify these parameters to override the default values.
Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Bold signifies the default value.
aggregation
: sum,avg
,first
,min
,max
frontfill
: nonemiddlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
middlefill
:zero
,value
,median
,mean
,min
,max
backfill
:zero
,value
,median
,mean
,min
,max
futurefill
:zero
,value
,median
,mean
,min
,max
To set a filling method to a specific value, set the fill parameter to
value
and define the value in a corresponding _value
parameter. For
example, to set backfilling to a value of 2, include the following:
"backfill": "value"
and "backfill_value":"2"
.
$sel:featurizationMethodName:FeaturizationMethod'
, featurizationMethod_featurizationMethodName
- The name of the method. The "filling" method is the only supported
method.
Filter
Describes a filter for choosing a subset of objects. Each filter
consists of a condition and a match statement. The condition is either
IS
or IS_NOT
, which specifies whether to include or exclude the
objects that match the statement, respectively. The match statement
consists of a key and a value.
See: newFilter
smart constructor.
Constructors
Filter' Text Text FilterConditionString |
Instances
ToJSON Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
Generic Filter Source # | |
Read Filter Source # | |
Show Filter Source # | |
NFData Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
Eq Filter Source # | |
Hashable Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter | |
type Rep Filter Source # | |
Defined in Amazonka.Forecast.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.Forecast.Types.Filter" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "condition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FilterConditionString)))) |
Arguments
:: Text | |
-> Text | |
-> FilterConditionString | |
-> Filter |
Create a value of Filter
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Filter'
, filter_key
- The name of the parameter to filter on.
$sel:value:Filter'
, filter_value
- The value to match.
$sel:condition:Filter'
, filter_condition
- The condition to apply. To include the objects that match the statement,
specify IS
. To exclude matching objects, specify IS_NOT
.
ForecastExportJobSummary
data ForecastExportJobSummary Source #
Provides a summary of the forecast export job properties used in the
ListForecastExportJobs operation. To get the complete set of properties,
call the DescribeForecastExportJob operation, and provide the listed
ForecastExportJobArn
.
See: newForecastExportJobSummary
smart constructor.
Constructors
ForecastExportJobSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) |
Instances
newForecastExportJobSummary :: ForecastExportJobSummary Source #
Create a value of ForecastExportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:ForecastExportJobSummary'
, forecastExportJobSummary_creationTime
- When the forecast export job was created.
$sel:destination:ForecastExportJobSummary'
, forecastExportJobSummary_destination
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
$sel:forecastExportJobArn:ForecastExportJobSummary'
, forecastExportJobSummary_forecastExportJobArn
- The Amazon Resource Name (ARN) of the forecast export job.
$sel:forecastExportJobName:ForecastExportJobSummary'
, forecastExportJobSummary_forecastExportJobName
- The name of the forecast export job.
$sel:lastModificationTime:ForecastExportJobSummary'
, forecastExportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:ForecastExportJobSummary'
, forecastExportJobSummary_message
- If an error occurred, an informational message about the error.
$sel:status:ForecastExportJobSummary'
, forecastExportJobSummary_status
- The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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
data ForecastSummary Source #
Provides a summary of the forecast properties used in the ListForecasts
operation. To get the complete set of properties, call the
DescribeForecast operation, and provide the ForecastArn
that is listed
in the summary.
See: newForecastSummary
smart constructor.
Constructors
ForecastSummary' (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newForecastSummary :: ForecastSummary Source #
Create a value of ForecastSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdUsingAutoPredictor:ForecastSummary'
, forecastSummary_createdUsingAutoPredictor
- Whether the Forecast was created from an AutoPredictor.
$sel:creationTime:ForecastSummary'
, forecastSummary_creationTime
- When the forecast creation task was created.
$sel:datasetGroupArn:ForecastSummary'
, forecastSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that provided the
data used to train the predictor.
$sel:forecastArn:ForecastSummary'
, forecastSummary_forecastArn
- The ARN of the forecast.
$sel:forecastName:ForecastSummary'
, forecastSummary_forecastName
- The name of the forecast.
$sel:lastModificationTime:ForecastSummary'
, forecastSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:ForecastSummary'
, forecastSummary_message
- If an error occurred, an informational message about the error.
$sel:predictorArn:ForecastSummary'
, forecastSummary_predictorArn
- The ARN of the predictor used to generate the forecast.
$sel:status:ForecastSummary'
, forecastSummary_status
- The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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
data HyperParameterTuningJobConfig Source #
Configuration information for a hyperparameter tuning job. You specify this object in the CreatePredictor request.
A hyperparameter is a parameter that governs the model training process. You set hyperparameters before training starts, unlike model parameters, which are determined during training. The values of the hyperparameters effect which values are chosen for the model parameters.
In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter values that optimize a specified metric. Forecast accomplishes this by running many training jobs over a range of hyperparameter values. The optimum set of values depends on the algorithm, the training data, and the specified metric objective.
See: newHyperParameterTuningJobConfig
smart constructor.
Constructors
HyperParameterTuningJobConfig' (Maybe ParameterRanges) |
Instances
newHyperParameterTuningJobConfig :: HyperParameterTuningJobConfig Source #
Create a value of HyperParameterTuningJobConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:parameterRanges:HyperParameterTuningJobConfig'
, hyperParameterTuningJobConfig_parameterRanges
- Specifies the ranges of valid values for the hyperparameters.
InputDataConfig
data InputDataConfig Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see DataConfig.
The data used to train a predictor. The data includes a dataset group and any supplementary features. You specify this object in the CreatePredictor request.
See: newInputDataConfig
smart constructor.
Constructors
InputDataConfig' (Maybe (NonEmpty SupplementaryFeature)) Text |
Instances
Arguments
:: Text | |
-> InputDataConfig |
Create a value of InputDataConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:supplementaryFeatures:InputDataConfig'
, inputDataConfig_supplementaryFeatures
- An array of supplementary features. The only supported feature is a
holiday calendar.
$sel:datasetGroupArn:InputDataConfig'
, inputDataConfig_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group.
IntegerParameterRange
data IntegerParameterRange Source #
Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.
See: newIntegerParameterRange
smart constructor.
Constructors
IntegerParameterRange' (Maybe ScalingType) Text Int Int |
Instances
newIntegerParameterRange Source #
Arguments
:: Text | |
-> Int | |
-> Int | |
-> IntegerParameterRange |
Create a value of IntegerParameterRange
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:scalingType:IntegerParameterRange'
, integerParameterRange_scalingType
- The scale that hyperparameter tuning uses to search the hyperparameter
range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- Not supported for
IntegerParameterRange
.Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
$sel:name:IntegerParameterRange'
, integerParameterRange_name
- The name of the hyperparameter to tune.
$sel:maxValue:IntegerParameterRange'
, integerParameterRange_maxValue
- The maximum tunable value of the hyperparameter.
$sel:minValue:IntegerParameterRange'
, integerParameterRange_minValue
- The minimum tunable value of the hyperparameter.
MetricResult
data MetricResult Source #
An individual metric Forecast calculated when monitoring predictor usage. You can compare the value for this metric to the metric's value in the Baseline to see how your predictor's performance is changing.
For more information about metrics generated by Forecast see Evaluating Predictor Accuracy
See: newMetricResult
smart constructor.
Constructors
MetricResult' (Maybe Text) (Maybe Double) |
Instances
newMetricResult :: MetricResult Source #
Create a value of MetricResult
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricName:MetricResult'
, metricResult_metricName
- The name of the metric.
$sel:metricValue:MetricResult'
, metricResult_metricValue
- The value for the metric.
Metrics
Provides metrics that are used to evaluate the performance of a predictor. This object is part of the WindowSummary object.
See: newMetrics
smart constructor.
Constructors
Metrics' (Maybe Double) (Maybe [ErrorMetric]) (Maybe Double) (Maybe [WeightedQuantileLoss]) |
Instances
newMetrics :: Metrics Source #
Create a value of Metrics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:averageWeightedQuantileLoss:Metrics'
, metrics_averageWeightedQuantileLoss
- The average value of all weighted quantile losses.
$sel:errorMetrics:Metrics'
, metrics_errorMetrics
- Provides detailed error metrics for each forecast type. Metrics include
root-mean square-error (RMSE), mean absolute percentage error (MAPE),
mean absolute scaled error (MASE), and weighted average percentage error
(WAPE).
Metrics
, metrics_rmse
- The root-mean-square error (RMSE).
$sel:weightedQuantileLosses:Metrics'
, metrics_weightedQuantileLosses
- An array of weighted quantile losses. Quantiles divide a probability
distribution into regions of equal probability. The distribution in this
case is the loss function.
MonitorConfig
data MonitorConfig Source #
The configuration details for the predictor monitor.
See: newMonitorConfig
smart constructor.
Constructors
MonitorConfig' Text |
Instances
Arguments
:: Text | |
-> MonitorConfig |
Create a value of MonitorConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:monitorName:MonitorConfig'
, monitorConfig_monitorName
- The name of the monitor resource.
MonitorDataSource
data MonitorDataSource Source #
The source of the data the monitor used during the evaluation.
See: newMonitorDataSource
smart constructor.
Instances
newMonitorDataSource :: MonitorDataSource Source #
Create a value of MonitorDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetImportJobArn:MonitorDataSource'
, monitorDataSource_datasetImportJobArn
- The Amazon Resource Name (ARN) of the dataset import job used to import
the data that initiated the monitor evaluation.
$sel:forecastArn:MonitorDataSource'
, monitorDataSource_forecastArn
- The Amazon Resource Name (ARN) of the forecast the monitor used during
the evaluation.
$sel:predictorArn:MonitorDataSource'
, monitorDataSource_predictorArn
- The Amazon Resource Name (ARN) of the predictor resource you are
monitoring.
MonitorInfo
data MonitorInfo Source #
Provides information about the monitor resource.
See: newMonitorInfo
smart constructor.
Constructors
MonitorInfo' (Maybe Text) (Maybe Text) |
Instances
newMonitorInfo :: MonitorInfo Source #
Create a value of MonitorInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:monitorArn:MonitorInfo'
, monitorInfo_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource.
$sel:status:MonitorInfo'
, monitorInfo_status
- The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING
,ACTIVE_STOPPED
UPDATE_IN_PROGRESS
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
MonitorSummary
data MonitorSummary Source #
Provides a summary of the monitor properties used in the ListMonitors
operation. To get a complete set of properties, call the DescribeMonitor
operation, and provide the listed MonitorArn
.
See: newMonitorSummary
smart constructor.
Constructors
MonitorSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newMonitorSummary :: MonitorSummary Source #
Create a value of MonitorSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:MonitorSummary'
, monitorSummary_creationTime
- When the monitor resource was created.
$sel:lastModificationTime:MonitorSummary'
, monitorSummary_lastModificationTime
- The last time the monitor resource was modified. The timestamp depends
on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.STOPPED
- When the resource stopped.ACTIVE
orCREATE_FAILED
- When the monitor creation finished or failed.
$sel:monitorArn:MonitorSummary'
, monitorSummary_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource.
$sel:monitorName:MonitorSummary'
, monitorSummary_monitorName
- The name of the monitor resource.
$sel:resourceArn:MonitorSummary'
, monitorSummary_resourceArn
- The Amazon Resource Name (ARN) of the predictor being monitored.
$sel:status:MonitorSummary'
, monitorSummary_status
- The status of the monitor. States include:
ACTIVE
ACTIVE_STOPPING
,ACTIVE_STOPPED
UPDATE_IN_PROGRESS
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
ParameterRanges
data ParameterRanges Source #
Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the HyperParameterTuningJobConfig object.
See: newParameterRanges
smart constructor.
Constructors
ParameterRanges' (Maybe (NonEmpty CategoricalParameterRange)) (Maybe (NonEmpty ContinuousParameterRange)) (Maybe (NonEmpty IntegerParameterRange)) |
Instances
newParameterRanges :: ParameterRanges Source #
Create a value of ParameterRanges
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:categoricalParameterRanges:ParameterRanges'
, parameterRanges_categoricalParameterRanges
- Specifies the tunable range for each categorical hyperparameter.
$sel:continuousParameterRanges:ParameterRanges'
, parameterRanges_continuousParameterRanges
- Specifies the tunable range for each continuous hyperparameter.
$sel:integerParameterRanges:ParameterRanges'
, parameterRanges_integerParameterRanges
- Specifies the tunable range for each integer hyperparameter.
PredictorBacktestExportJobSummary
data PredictorBacktestExportJobSummary Source #
Provides a summary of the predictor backtest export job properties used
in the ListPredictorBacktestExportJobs operation. To get a complete set
of properties, call the DescribePredictorBacktestExportJob operation,
and provide the listed PredictorBacktestExportJobArn
.
See: newPredictorBacktestExportJobSummary
smart constructor.
Constructors
PredictorBacktestExportJobSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPredictorBacktestExportJobSummary :: PredictorBacktestExportJobSummary Source #
Create a value of PredictorBacktestExportJobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_creationTime
- When the predictor backtest export job was created.
$sel:destination:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_destination
- Undocumented member.
$sel:lastModificationTime:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_message
- Information about any errors that may have occurred during the backtest
export.
$sel:predictorBacktestExportJobArn:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_predictorBacktestExportJobArn
- The Amazon Resource Name (ARN) of the predictor backtest export job.
$sel:predictorBacktestExportJobName:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_predictorBacktestExportJobName
- The name of the predictor backtest export job.
$sel:status:PredictorBacktestExportJobSummary'
, predictorBacktestExportJobSummary_status
- The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
PredictorBaseline
data PredictorBaseline Source #
Metrics you can use as a baseline for comparison purposes. Use these metrics when you interpret monitoring results for an auto predictor.
See: newPredictorBaseline
smart constructor.
Constructors
PredictorBaseline' (Maybe [BaselineMetric]) |
Instances
newPredictorBaseline :: PredictorBaseline Source #
Create a value of PredictorBaseline
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:baselineMetrics:PredictorBaseline'
, predictorBaseline_baselineMetrics
- The initial
accuracy metrics
for the predictor. Use these metrics as a baseline for comparison
purposes as you use your predictor and the metrics change.
PredictorEvent
data PredictorEvent Source #
Provides details about a predictor event, such as a retraining.
See: newPredictorEvent
smart constructor.
Constructors
PredictorEvent' (Maybe POSIX) (Maybe Text) |
Instances
newPredictorEvent :: PredictorEvent Source #
Create a value of PredictorEvent
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datetime:PredictorEvent'
, predictorEvent_datetime
- The timestamp for when the event occurred.
$sel:detail:PredictorEvent'
, predictorEvent_detail
- The type of event. For example, Retrain
. A retraining event denotes
the timepoint when a predictor was retrained. Any monitor results from
before the Datetime
are from the previous predictor. Any new metrics
are for the newly retrained predictor.
PredictorExecution
data PredictorExecution Source #
The algorithm used to perform a backtest and the status of those tests.
See: newPredictorExecution
smart constructor.
Constructors
PredictorExecution' (Maybe Text) (Maybe [TestWindowSummary]) |
Instances
newPredictorExecution :: PredictorExecution Source #
Create a value of PredictorExecution
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:algorithmArn:PredictorExecution'
, predictorExecution_algorithmArn
- The ARN of the algorithm used to test the predictor.
$sel:testWindows:PredictorExecution'
, predictorExecution_testWindows
- An array of test windows used to evaluate the algorithm. The
NumberOfBacktestWindows
from the object determines the number of
windows in the array.
PredictorExecutionDetails
data PredictorExecutionDetails Source #
Contains details on the backtests performed to evaluate the accuracy of the predictor. The tests are returned in descending order of accuracy, with the most accurate backtest appearing first. You specify the number of backtests to perform when you call the operation.
See: newPredictorExecutionDetails
smart constructor.
Constructors
PredictorExecutionDetails' (Maybe (NonEmpty PredictorExecution)) |
Instances
newPredictorExecutionDetails :: PredictorExecutionDetails Source #
Create a value of PredictorExecutionDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:predictorExecutions:PredictorExecutionDetails'
, predictorExecutionDetails_predictorExecutions
- An array of the backtests performed to evaluate the accuracy of the
predictor against a particular algorithm. The NumberOfBacktestWindows
from the object determines the number of windows in the array.
PredictorMonitorEvaluation
data PredictorMonitorEvaluation Source #
Describes the results of a monitor evaluation.
See: newPredictorMonitorEvaluation
smart constructor.
Constructors
PredictorMonitorEvaluation' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [MetricResult]) (Maybe Text) (Maybe MonitorDataSource) (Maybe Integer) (Maybe PredictorEvent) (Maybe Text) (Maybe POSIX) (Maybe POSIX) |
Instances
newPredictorMonitorEvaluation :: PredictorMonitorEvaluation Source #
Create a value of PredictorMonitorEvaluation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationState:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_evaluationState
- The status of the monitor evaluation. The state can be SUCCESS
or
FAILURE
.
$sel:evaluationTime:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_evaluationTime
- The timestamp that indicates when the monitor evaluation was started.
$sel:message:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_message
- Information about any errors that may have occurred during the monitor
evaluation.
$sel:metricResults:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_metricResults
- A list of metrics Forecast calculated when monitoring a predictor. You
can compare the value for each metric in the list to the metric's value
in the Baseline to see how your predictor's performance is changing.
$sel:monitorArn:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_monitorArn
- The Amazon Resource Name (ARN) of the monitor resource.
$sel:monitorDataSource:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_monitorDataSource
- The source of the data the monitor resource used during the evaluation.
$sel:numItemsEvaluated:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_numItemsEvaluated
- The number of items considered during the evaluation.
$sel:predictorEvent:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_predictorEvent
- Provides details about a predictor event, such as a retraining.
$sel:resourceArn:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_resourceArn
- The Amazon Resource Name (ARN) of the resource to monitor.
$sel:windowEndDatetime:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_windowEndDatetime
- The timestamp that indicates the end of the window that is used for
monitor evaluation.
$sel:windowStartDatetime:PredictorMonitorEvaluation'
, predictorMonitorEvaluation_windowStartDatetime
- The timestamp that indicates the start of the window that is used for
monitor evaluation.
PredictorSummary
data PredictorSummary Source #
Provides a summary of the predictor properties that are used in the
ListPredictors operation. To get the complete set of properties, call
the DescribePredictor operation, and provide the listed PredictorArn
.
See: newPredictorSummary
smart constructor.
Constructors
PredictorSummary' (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReferencePredictorSummary) (Maybe Text) |
Instances
newPredictorSummary :: PredictorSummary Source #
Create a value of PredictorSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:PredictorSummary'
, predictorSummary_creationTime
- When the model training task was created.
$sel:datasetGroupArn:PredictorSummary'
, predictorSummary_datasetGroupArn
- The Amazon Resource Name (ARN) of the dataset group that contains the
data used to train the predictor.
$sel:isAutoPredictor:PredictorSummary'
, predictorSummary_isAutoPredictor
- Whether AutoPredictor was used to create the predictor.
$sel:lastModificationTime:PredictorSummary'
, predictorSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:PredictorSummary'
, predictorSummary_message
- If an error occurred, an informational message about the error.
$sel:predictorArn:PredictorSummary'
, predictorSummary_predictorArn
- The ARN of the predictor.
$sel:predictorName:PredictorSummary'
, predictorSummary_predictorName
- The name of the predictor.
$sel:referencePredictorSummary:PredictorSummary'
, predictorSummary_referencePredictorSummary
- A summary of the reference predictor used if the predictor was retrained
or upgraded.
$sel:status:PredictorSummary'
, predictorSummary_status
- The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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
data ReferencePredictorSummary Source #
Provides a summary of the reference predictor used when retraining or upgrading a predictor.
See: newReferencePredictorSummary
smart constructor.
Constructors
ReferencePredictorSummary' (Maybe Text) (Maybe State) |
Instances
newReferencePredictorSummary :: ReferencePredictorSummary Source #
Create a value of ReferencePredictorSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:ReferencePredictorSummary'
, referencePredictorSummary_arn
- The ARN of the reference predictor.
$sel:state:ReferencePredictorSummary'
, referencePredictorSummary_state
- Whether the reference predictor is Active
or Deleted
.
S3Config
The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.
See: newS3Config
smart constructor.
Instances
FromJSON S3Config Source # | |
ToJSON S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
Generic S3Config Source # | |
Read S3Config Source # | |
Show S3Config Source # | |
NFData S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
Eq S3Config Source # | |
Hashable S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config | |
type Rep S3Config Source # | |
Defined in Amazonka.Forecast.Types.S3Config type Rep S3Config = D1 ('MetaData "S3Config" "Amazonka.Forecast.Types.S3Config" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "S3Config'" 'PrefixI 'True) (S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
Create a value of S3Config
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:kmsKeyArn:S3Config'
, s3Config_kmsKeyArn
- The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS)
key.
$sel:path:S3Config'
, s3Config_path
- The path to an Amazon Simple Storage Service (Amazon S3) bucket or
file(s) in an Amazon S3 bucket.
$sel:roleArn:S3Config'
, s3Config_roleArn
- The ARN of the AWS Identity and Access Management (IAM) role that Amazon
Forecast can assume to access the Amazon S3 bucket or files. If you
provide a value for the KMSKeyArn
key, the role must allow access to
the key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
Schema
Defines the fields of a dataset.
See: newSchema
smart constructor.
Constructors
Schema' (Maybe (NonEmpty SchemaAttribute)) |
Instances
FromJSON Schema Source # | |
ToJSON Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
Generic Schema Source # | |
Read Schema Source # | |
Show Schema Source # | |
NFData Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
Eq Schema Source # | |
Hashable Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema | |
type Rep Schema Source # | |
Defined in Amazonka.Forecast.Types.Schema type Rep Schema = D1 ('MetaData "Schema" "Amazonka.Forecast.Types.Schema" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Schema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty SchemaAttribute))))) |
Create a value of Schema
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributes:Schema'
, schema_attributes
- An array of attributes specifying the name and type of each field in a
dataset.
SchemaAttribute
data SchemaAttribute Source #
An attribute of a schema, which defines a dataset field. A schema
attribute is required for every field in a dataset. The
Schema
object contains an array of SchemaAttribute
objects.
See: newSchemaAttribute
smart constructor.
Constructors
SchemaAttribute' (Maybe Text) (Maybe AttributeType) |
Instances
newSchemaAttribute :: SchemaAttribute Source #
Create a value of SchemaAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:SchemaAttribute'
, schemaAttribute_attributeName
- The name of the dataset field.
$sel:attributeType:SchemaAttribute'
, schemaAttribute_attributeType
- The data type of the field.
For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).
Statistics
data Statistics Source #
Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob operation.
See: newStatistics
smart constructor.
Constructors
Statistics' (Maybe Double) (Maybe Int) (Maybe Int) (Maybe Integer) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Int) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Double) |
Instances
newStatistics :: Statistics Source #
Create a value of Statistics
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:avg:Statistics'
, statistics_avg
- For a numeric field, the average value in the field.
$sel:count:Statistics'
, statistics_count
- The number of values in the field. If the response value is -1, refer to
CountLong
.
$sel:countDistinct:Statistics'
, statistics_countDistinct
- The number of distinct values in the field. If the response value is -1,
refer to CountDistinctLong
.
$sel:countDistinctLong:Statistics'
, statistics_countDistinctLong
- The number of distinct values in the field. CountDistinctLong
is used
instead of CountDistinct
if the value is greater than 2,147,483,647.
$sel:countLong:Statistics'
, statistics_countLong
- The number of values in the field. CountLong
is used instead of
Count
if the value is greater than 2,147,483,647.
$sel:countNan:Statistics'
, statistics_countNan
- The number of NAN (not a number) values in the field. If the response
value is -1, refer to CountNanLong
.
$sel:countNanLong:Statistics'
, statistics_countNanLong
- The number of NAN (not a number) values in the field. CountNanLong
is
used instead of CountNan
if the value is greater than 2,147,483,647.
$sel:countNull:Statistics'
, statistics_countNull
- The number of null values in the field. If the response value is -1,
refer to CountNullLong
.
$sel:countNullLong:Statistics'
, statistics_countNullLong
- The number of null values in the field. CountNullLong
is used instead
of CountNull
if the value is greater than 2,147,483,647.
$sel:max:Statistics'
, statistics_max
- For a numeric field, the maximum value in the field.
$sel:min:Statistics'
, statistics_min
- For a numeric field, the minimum value in the field.
$sel:stddev:Statistics'
, statistics_stddev
- For a numeric field, the standard deviation.
SupplementaryFeature
data SupplementaryFeature Source #
This object belongs to the CreatePredictor operation. If you created your predictor with CreateAutoPredictor, see AdditionalDataset.
Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in featurizations.
Weather Index
The Amazon Forecast Weather Index is a built-in featurization that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.
Holidays
Holidays is a built-in featurization that incorporates a feature-engineered dataset of national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.
See: newSupplementaryFeature
smart constructor.
Constructors
SupplementaryFeature' Text Text |
Instances
newSupplementaryFeature Source #
Arguments
:: Text | |
-> Text | |
-> SupplementaryFeature |
Create a value of SupplementaryFeature
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:SupplementaryFeature'
, supplementaryFeature_name
- The name of the feature. Valid values: "holiday"
and "weather"
.
$sel:value:SupplementaryFeature'
, supplementaryFeature_value
- Weather Index
To enable the Weather Index, set the value to "true"
Holidays
To enable Holidays, specify a country with one of the following two-letter country codes:
- "AL" - ALBANIA
- "AR" - ARGENTINA
- "AT" - AUSTRIA
- "AU" - AUSTRALIA
- "BA" - BOSNIA HERZEGOVINA
- "BE" - BELGIUM
- "BG" - BULGARIA
- "BO" - BOLIVIA
- "BR" - BRAZIL
- "BY" - BELARUS
- "CA" - CANADA
- "CL" - CHILE
- "CO" - COLOMBIA
- "CR" - COSTA RICA
- "HR" - CROATIA
- "CZ" - CZECH REPUBLIC
- "DK" - DENMARK
- "EC" - ECUADOR
- "EE" - ESTONIA
- "ET" - ETHIOPIA
- "FI" - FINLAND
- "FR" - FRANCE
- "DE" - GERMANY
- "GR" - GREECE
- "HU" - HUNGARY
- "IS" - ICELAND
- "IN" - INDIA
- "IE" - IRELAND
- "IT" - ITALY
- "JP" - JAPAN
- "KZ" - KAZAKHSTAN
- "KR" - KOREA
- "LV" - LATVIA
- "LI" - LIECHTENSTEIN
- "LT" - LITHUANIA
- "LU" - LUXEMBOURG
- "MK" - MACEDONIA
- "MT" - MALTA
- "MX" - MEXICO
- "MD" - MOLDOVA
- "ME" - MONTENEGRO
- "NL" - NETHERLANDS
- "NZ" - NEW ZEALAND
- "NI" - NICARAGUA
- "NG" - NIGERIA
- "NO" - NORWAY
- "PA" - PANAMA
- "PY" - PARAGUAY
- "PE" - PERU
- "PL" - POLAND
- "PT" - PORTUGAL
- "RO" - ROMANIA
- "RU" - RUSSIA
- "RS" - SERBIA
- "SK" - SLOVAKIA
- "SI" - SLOVENIA
- "ZA" - SOUTH AFRICA
- "ES" - SPAIN
- "SE" - SWEDEN
- "CH" - SWITZERLAND
- "UA" - UKRAINE
- "AE" - UNITED ARAB EMIRATES
- "US" - UNITED STATES
- "UK" - UNITED KINGDOM
- "UY" - URUGUAY
- "VE" - VENEZUELA
Tag
The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
See: newTag
smart constructor.
Instances
FromJSON Tag Source # | |
ToJSON Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
Generic Tag Source # | |
Show Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
Eq Tag Source # | |
Hashable Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.Forecast.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Forecast.Types.Tag" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:key:Tag'
, tag_key
- One part of a key-value pair that makes up a tag. A key
is a general
label that acts like a category for more specific tag values.
$sel:value:Tag'
, tag_value
- The optional part of a key-value pair that makes up a tag. A value
acts as a descriptor within a tag category (key).
TestWindowSummary
data TestWindowSummary Source #
The status, start time, and end time of a backtest, as well as a failure reason if applicable.
See: newTestWindowSummary
smart constructor.
Instances
newTestWindowSummary :: TestWindowSummary Source #
Create a value of TestWindowSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:message:TestWindowSummary'
, testWindowSummary_message
- If the test failed, the reason why it failed.
$sel:status:TestWindowSummary'
, testWindowSummary_status
- The status of the test. Possible status values are:
ACTIVE
CREATE_IN_PROGRESS
CREATE_FAILED
$sel:testWindowEnd:TestWindowSummary'
, testWindowSummary_testWindowEnd
- The time at which the test ended.
$sel:testWindowStart:TestWindowSummary'
, testWindowSummary_testWindowStart
- The time at which the test began.
TimeAlignmentBoundary
data TimeAlignmentBoundary Source #
The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.
For more information about aggregation, see Data Aggregation for Different Forecast Frequencies. For more information setting a custom time boundary, see Specifying a Time Boundary.
See: newTimeAlignmentBoundary
smart constructor.
Instances
newTimeAlignmentBoundary :: TimeAlignmentBoundary Source #
Create a value of TimeAlignmentBoundary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dayOfMonth:TimeAlignmentBoundary'
, timeAlignmentBoundary_dayOfMonth
- The day of the month to use for time alignment during aggregation.
$sel:dayOfWeek:TimeAlignmentBoundary'
, timeAlignmentBoundary_dayOfWeek
- The day of week to use for time alignment during aggregation. The day
must be in uppercase.
$sel:hour:TimeAlignmentBoundary'
, timeAlignmentBoundary_hour
- The hour of day to use for time alignment during aggregation.
$sel:month:TimeAlignmentBoundary'
, timeAlignmentBoundary_month
- The month to use for time alignment during aggregation. The month must
be in uppercase.
TimeSeriesCondition
data TimeSeriesCondition Source #
Creates a subset of items within an attribute that are modified. For
example, you can use this operation to create a subset of items that
cost $5 or less. To do this, you specify "AttributeName": "price"
,
"AttributeValue": "5"
, and "Condition": "LESS_THAN"
. Pair
this operation with the Action operation within the
CreateWhatIfForecastRequest$TimeSeriesTransformations operation to
define how the attribute is modified.
See: newTimeSeriesCondition
smart constructor.
Constructors
TimeSeriesCondition' Text Text Condition |
Instances
newTimeSeriesCondition Source #
Arguments
:: Text | |
-> Text | |
-> Condition | |
-> TimeSeriesCondition |
Create a value of TimeSeriesCondition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeName:TimeSeriesCondition'
, timeSeriesCondition_attributeName
- The item_id, dimension name, IM name, or timestamp that you are
modifying.
$sel:attributeValue:TimeSeriesCondition'
, timeSeriesCondition_attributeValue
- The value that is applied for the chosen Condition
.
$sel:condition:TimeSeriesCondition'
, timeSeriesCondition_condition
- The condition to apply. Valid values are EQUALS
, NOT_EQUALS
,
LESS_THAN
and GREATER_THAN
.
TimeSeriesIdentifiers
data TimeSeriesIdentifiers Source #
Details about the import file that contains the time series for which you want to create forecasts.
See: newTimeSeriesIdentifiers
smart constructor.
Constructors
TimeSeriesIdentifiers' (Maybe DataSource) (Maybe Text) (Maybe Schema) |
Instances
newTimeSeriesIdentifiers :: TimeSeriesIdentifiers Source #
Create a value of TimeSeriesIdentifiers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataSource:TimeSeriesIdentifiers'
, timeSeriesIdentifiers_dataSource
- Undocumented member.
$sel:format:TimeSeriesIdentifiers'
, timeSeriesIdentifiers_format
- The format of the data, either CSV or PARQUET.
$sel:schema:TimeSeriesIdentifiers'
, timeSeriesIdentifiers_schema
- Undocumented member.
TimeSeriesReplacementsDataSource
data TimeSeriesReplacementsDataSource Source #
A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.
See: newTimeSeriesReplacementsDataSource
smart constructor.
Instances
newTimeSeriesReplacementsDataSource Source #
Arguments
:: S3Config | |
-> Schema | |
-> TimeSeriesReplacementsDataSource |
Create a value of TimeSeriesReplacementsDataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:format:TimeSeriesReplacementsDataSource'
, timeSeriesReplacementsDataSource_format
- The format of the replacement data, CSV or PARQUET.
$sel:timestampFormat:TimeSeriesReplacementsDataSource'
, timeSeriesReplacementsDataSource_timestampFormat
- The timestamp format of the replacement data.
$sel:s3Config:TimeSeriesReplacementsDataSource'
, timeSeriesReplacementsDataSource_s3Config
- Undocumented member.
$sel:schema:TimeSeriesReplacementsDataSource'
, timeSeriesReplacementsDataSource_schema
- Undocumented member.
TimeSeriesSelector
data TimeSeriesSelector Source #
Defines the set of time series that are used to create the forecasts in
a TimeSeriesIdentifiers
object.
The TimeSeriesIdentifiers
object needs the following information:
DataSource
Format
Schema
See: newTimeSeriesSelector
smart constructor.
Constructors
TimeSeriesSelector' (Maybe TimeSeriesIdentifiers) |
Instances
newTimeSeriesSelector :: TimeSeriesSelector Source #
Create a value of TimeSeriesSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeSeriesIdentifiers:TimeSeriesSelector'
, timeSeriesSelector_timeSeriesIdentifiers
- Details about the import file that contains the time series for which
you want to create forecasts.
TimeSeriesTransformation
data TimeSeriesTransformation Source #
A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.
See: newTimeSeriesTransformation
smart constructor.
Constructors
TimeSeriesTransformation' (Maybe Action) (Maybe [TimeSeriesCondition]) |
Instances
newTimeSeriesTransformation :: TimeSeriesTransformation Source #
Create a value of TimeSeriesTransformation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:TimeSeriesTransformation'
, timeSeriesTransformation_action
- An array of actions that define a time series and how it is transformed.
These transformations create a new time series that is used for the
what-if analysis.
$sel:timeSeriesConditions:TimeSeriesTransformation'
, timeSeriesTransformation_timeSeriesConditions
- An array of conditions that define which members of the related time
series are transformed.
WeightedQuantileLoss
data WeightedQuantileLoss Source #
The weighted loss value for a quantile. This object is part of the Metrics object.
See: newWeightedQuantileLoss
smart constructor.
Constructors
WeightedQuantileLoss' (Maybe Double) (Maybe Double) |
Instances
newWeightedQuantileLoss :: WeightedQuantileLoss Source #
Create a value of WeightedQuantileLoss
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:lossValue:WeightedQuantileLoss'
, weightedQuantileLoss_lossValue
- The difference between the predicted value and the actual value over the
quantile, weighted (normalized) by dividing by the sum over all
quantiles.
$sel:quantile:WeightedQuantileLoss'
, weightedQuantileLoss_quantile
- The quantile. Quantiles divide a probability distribution into regions
of equal probability. For example, if the distribution was divided into
5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6,
and 0.8.
WhatIfAnalysisSummary
data WhatIfAnalysisSummary Source #
Provides a summary of the what-if analysis properties used in the
ListWhatIfAnalyses operation. To get the complete set of properties,
call the DescribeWhatIfAnalysis operation, and provide the
WhatIfAnalysisArn
that is listed in the summary.
See: newWhatIfAnalysisSummary
smart constructor.
Constructors
WhatIfAnalysisSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newWhatIfAnalysisSummary :: WhatIfAnalysisSummary Source #
Create a value of WhatIfAnalysisSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_creationTime
- When the what-if analysis was created.
$sel:forecastArn:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_forecastArn
- The Amazon Resource Name (ARN) of the baseline forecast that is being
used in this what-if analysis.
$sel:lastModificationTime:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_message
- If an error occurred, an informational message about the error.
$sel:status:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_status
- The status of the what-if analysis. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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.
$sel:whatIfAnalysisArn:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis.
$sel:whatIfAnalysisName:WhatIfAnalysisSummary'
, whatIfAnalysisSummary_whatIfAnalysisName
- The name of the what-if analysis.
WhatIfForecastExportSummary
data WhatIfForecastExportSummary Source #
Provides a summary of the what-if forecast export properties used in the
ListWhatIfForecastExports operation. To get the complete set of
properties, call the DescribeWhatIfForecastExport operation, and provide
the WhatIfForecastExportArn
that is listed in the summary.
See: newWhatIfForecastExportSummary
smart constructor.
Constructors
WhatIfForecastExportSummary' (Maybe POSIX) (Maybe DataDestination) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Text) (Maybe Text) |
Instances
newWhatIfForecastExportSummary :: WhatIfForecastExportSummary Source #
Create a value of WhatIfForecastExportSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_creationTime
- When the what-if forecast export was created.
$sel:destination:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_destination
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where
the forecast is exported.
$sel:lastModificationTime:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_message
- If an error occurred, an informational message about the error.
$sel:status:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_status
- The status of the what-if forecast export. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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.
$sel:whatIfForecastArns:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_whatIfForecastArns
- An array of Amazon Resource Names (ARNs) that define the what-if
forecasts included in the export.
$sel:whatIfForecastExportArn:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_whatIfForecastExportArn
- The Amazon Resource Name (ARN) of the what-if forecast export.
$sel:whatIfForecastExportName:WhatIfForecastExportSummary'
, whatIfForecastExportSummary_whatIfForecastExportName
- The what-if forecast export name.
WhatIfForecastSummary
data WhatIfForecastSummary Source #
Provides a summary of the what-if forecast properties used in the
ListWhatIfForecasts operation. To get the complete set of properties,
call the DescribeWhatIfForecast operation, and provide the
WhatIfForecastArn
that is listed in the summary.
See: newWhatIfForecastSummary
smart constructor.
Constructors
WhatIfForecastSummary' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newWhatIfForecastSummary :: WhatIfForecastSummary Source #
Create a value of WhatIfForecastSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTime:WhatIfForecastSummary'
, whatIfForecastSummary_creationTime
- When the what-if forecast was created.
$sel:lastModificationTime:WhatIfForecastSummary'
, whatIfForecastSummary_lastModificationTime
- The last time the resource was modified. The timestamp depends on the
status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
$sel:message:WhatIfForecastSummary'
, whatIfForecastSummary_message
- If an error occurred, an informational message about the error.
$sel:status:WhatIfForecastSummary'
, whatIfForecastSummary_status
- The status of the what-if forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_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.
$sel:whatIfAnalysisArn:WhatIfForecastSummary'
, whatIfForecastSummary_whatIfAnalysisArn
- The Amazon Resource Name (ARN) of the what-if analysis that contains
this what-if forecast.
$sel:whatIfForecastArn:WhatIfForecastSummary'
, whatIfForecastSummary_whatIfForecastArn
- The Amazon Resource Name (ARN) of the what-if forecast.
$sel:whatIfForecastName:WhatIfForecastSummary'
, whatIfForecastSummary_whatIfForecastName
- The name of the what-if forecast.
WindowSummary
data WindowSummary Source #
The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.
The TestWindowStart
and TestWindowEnd
parameters are determined by
the BackTestWindowOffset
parameter of the EvaluationParameters object.
See: newWindowSummary
smart constructor.
Constructors
WindowSummary' (Maybe EvaluationType) (Maybe Int) (Maybe Metrics) (Maybe POSIX) (Maybe POSIX) |
Instances
newWindowSummary :: WindowSummary Source #
Create a value of WindowSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:evaluationType:WindowSummary'
, windowSummary_evaluationType
- The type of evaluation.
SUMMARY
- The average metrics across all windows.COMPUTED
- The metrics for the specified window.
$sel:itemCount:WindowSummary'
, windowSummary_itemCount
- The number of data points within the window.
$sel:metrics:WindowSummary'
, windowSummary_metrics
- Provides metrics used to evaluate the performance of a predictor.
$sel:testWindowEnd:WindowSummary'
, windowSummary_testWindowEnd
- The timestamp that defines the end of the window.
$sel:testWindowStart:WindowSummary'
, windowSummary_testWindowStart
- The timestamp that defines the start of the window.