Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Operations
- ListDatasetGroups
- CreateDatasetImportJob
- DescribeDataset
- ListForecasts
- ListTagsForResource
- StopResource
- DescribeDatasetImportJob
- DescribeForecastExportJob
- DescribePredictor
- DeleteDataset
- DescribeForecast
- CreateDataset
- DeleteForecastExportJob
- DeletePredictor
- ListDatasetImportJobs
- DeleteDatasetImportJob
- GetAccuracyMetrics
- DeleteDatasetGroup
- UpdateDatasetGroup
- CreateForecastExportJob
- CreatePredictor
- ListPredictorBacktestExportJobs
- DeletePredictorBacktestExportJob
- CreateForecast
- CreatePredictorBacktestExportJob
- DeleteForecast
- DeleteResourceTree
- DescribeDatasetGroup
- TagResource
- ListDatasets
- DescribePredictorBacktestExportJob
- UntagResource
- CreateDatasetGroup
- ListForecastExportJobs
- ListPredictors
- Types
- CategoricalParameterRange
- ContinuousParameterRange
- DataDestination
- DataSource
- DatasetGroupSummary
- DatasetImportJobSummary
- DatasetSummary
- EncryptionConfig
- ErrorMetric
- EvaluationParameters
- EvaluationResult
- Featurization
- FeaturizationConfig
- FeaturizationMethod
- Filter
- ForecastExportJobSummary
- ForecastSummary
- HyperParameterTuningJobConfig
- InputDataConfig
- IntegerParameterRange
- Metrics
- ParameterRanges
- PredictorBacktestExportJobSummary
- PredictorExecution
- PredictorExecutionDetails
- PredictorSummary
- S3Config
- Schema
- SchemaAttribute
- Statistics
- SupplementaryFeature
- Tag
- TestWindowSummary
- WeightedQuantileLoss
- WindowSummary
Synopsis
- listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text)
- listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural)
- listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text)
- listDatasetGroupsResponse_datasetGroups :: Lens' ListDatasetGroupsResponse (Maybe [DatasetGroupSummary])
- listDatasetGroupsResponse_httpStatus :: Lens' ListDatasetGroupsResponse Int
- createDatasetImportJob_timestampFormat :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_useGeolocationForTimeZone :: Lens' CreateDatasetImportJob (Maybe Bool)
- createDatasetImportJob_geolocationFormat :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_timeZone :: Lens' CreateDatasetImportJob (Maybe Text)
- createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag])
- createDatasetImportJob_datasetImportJobName :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text
- createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource
- createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text)
- createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int
- describeDataset_datasetArn :: Lens' DescribeDataset Text
- describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain)
- describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema)
- describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType)
- describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text)
- describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe EncryptionConfig)
- describeDatasetResponse_lastModificationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime)
- describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int
- listForecasts_filters :: Lens' ListForecasts (Maybe [Filter])
- listForecasts_nextToken :: Lens' ListForecasts (Maybe Text)
- listForecasts_maxResults :: Lens' ListForecasts (Maybe Natural)
- listForecastsResponse_forecasts :: Lens' ListForecastsResponse (Maybe [ForecastSummary])
- listForecastsResponse_nextToken :: Lens' ListForecastsResponse (Maybe Text)
- listForecastsResponse_httpStatus :: Lens' ListForecastsResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- stopResource_resourceArn :: Lens' StopResource Text
- describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text
- describeDatasetImportJobResponse_creationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime)
- describeDatasetImportJobResponse_status :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_datasetImportJobName :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_datasetArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_timestampFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_dataSize :: Lens' DescribeDatasetImportJobResponse (Maybe Double)
- describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeDatasetImportJobResponse (Maybe Integer)
- describeDatasetImportJobResponse_fieldStatistics :: Lens' DescribeDatasetImportJobResponse (Maybe (HashMap Text Statistics))
- describeDatasetImportJobResponse_dataSource :: Lens' DescribeDatasetImportJobResponse (Maybe DataSource)
- describeDatasetImportJobResponse_datasetImportJobArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_useGeolocationForTimeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Bool)
- describeDatasetImportJobResponse_message :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_geolocationFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_timeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Text)
- describeDatasetImportJobResponse_lastModificationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime)
- describeDatasetImportJobResponse_httpStatus :: Lens' DescribeDatasetImportJobResponse Int
- describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text
- describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime)
- describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination)
- describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text)
- describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime)
- describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int
- describePredictor_predictorArn :: Lens' DescribePredictor Text
- describePredictorResponse_creationTime :: Lens' DescribePredictorResponse (Maybe UTCTime)
- describePredictorResponse_forecastHorizon :: Lens' DescribePredictorResponse (Maybe Int)
- describePredictorResponse_status :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_performAutoML :: Lens' DescribePredictorResponse (Maybe Bool)
- describePredictorResponse_autoMLAlgorithmArns :: Lens' DescribePredictorResponse (Maybe [Text])
- describePredictorResponse_trainingParameters :: Lens' DescribePredictorResponse (Maybe (HashMap Text Text))
- describePredictorResponse_algorithmArn :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_hPOConfig :: Lens' DescribePredictorResponse (Maybe HyperParameterTuningJobConfig)
- describePredictorResponse_predictorArn :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_optimizationMetric :: Lens' DescribePredictorResponse (Maybe OptimizationMetric)
- describePredictorResponse_predictorExecutionDetails :: Lens' DescribePredictorResponse (Maybe PredictorExecutionDetails)
- describePredictorResponse_datasetImportJobArns :: Lens' DescribePredictorResponse (Maybe [Text])
- describePredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribePredictorResponse (Maybe Integer)
- describePredictorResponse_autoMLOverrideStrategy :: Lens' DescribePredictorResponse (Maybe AutoMLOverrideStrategy)
- describePredictorResponse_evaluationParameters :: Lens' DescribePredictorResponse (Maybe EvaluationParameters)
- describePredictorResponse_inputDataConfig :: Lens' DescribePredictorResponse (Maybe InputDataConfig)
- describePredictorResponse_predictorName :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_featurizationConfig :: Lens' DescribePredictorResponse (Maybe FeaturizationConfig)
- describePredictorResponse_encryptionConfig :: Lens' DescribePredictorResponse (Maybe EncryptionConfig)
- describePredictorResponse_forecastTypes :: Lens' DescribePredictorResponse (Maybe (NonEmpty Text))
- describePredictorResponse_message :: Lens' DescribePredictorResponse (Maybe Text)
- describePredictorResponse_performHPO :: Lens' DescribePredictorResponse (Maybe Bool)
- describePredictorResponse_lastModificationTime :: Lens' DescribePredictorResponse (Maybe UTCTime)
- describePredictorResponse_httpStatus :: Lens' DescribePredictorResponse Int
- deleteDataset_datasetArn :: Lens' DeleteDataset Text
- describeForecast_forecastArn :: Lens' DescribeForecast Text
- describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime)
- describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_predictorArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer)
- describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_forecastTypes :: Lens' DescribeForecastResponse (Maybe (NonEmpty Text))
- describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text)
- describeForecastResponse_lastModificationTime :: Lens' DescribeForecastResponse (Maybe UTCTime)
- describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int
- createDataset_dataFrequency :: Lens' CreateDataset (Maybe Text)
- createDataset_encryptionConfig :: Lens' CreateDataset (Maybe EncryptionConfig)
- createDataset_tags :: Lens' CreateDataset (Maybe [Tag])
- createDataset_datasetName :: Lens' CreateDataset Text
- createDataset_domain :: Lens' CreateDataset Domain
- createDataset_datasetType :: Lens' CreateDataset DatasetType
- createDataset_schema :: Lens' CreateDataset Schema
- createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text)
- createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int
- deleteForecastExportJob_forecastExportJobArn :: Lens' DeleteForecastExportJob Text
- deletePredictor_predictorArn :: Lens' DeletePredictor Text
- listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (Maybe [Filter])
- listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text)
- listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural)
- listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary])
- listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text)
- listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int
- deleteDatasetImportJob_datasetImportJobArn :: Lens' DeleteDatasetImportJob Text
- getAccuracyMetrics_predictorArn :: Lens' GetAccuracyMetrics Text
- getAccuracyMetricsResponse_predictorEvaluationResults :: Lens' GetAccuracyMetricsResponse (Maybe [EvaluationResult])
- getAccuracyMetricsResponse_optimizationMetric :: Lens' GetAccuracyMetricsResponse (Maybe OptimizationMetric)
- getAccuracyMetricsResponse_autoMLOverrideStrategy :: Lens' GetAccuracyMetricsResponse (Maybe AutoMLOverrideStrategy)
- getAccuracyMetricsResponse_httpStatus :: Lens' GetAccuracyMetricsResponse Int
- deleteDatasetGroup_datasetGroupArn :: Lens' DeleteDatasetGroup Text
- updateDatasetGroup_datasetGroupArn :: Lens' UpdateDatasetGroup Text
- updateDatasetGroup_datasetArns :: Lens' UpdateDatasetGroup [Text]
- updateDatasetGroupResponse_httpStatus :: Lens' UpdateDatasetGroupResponse Int
- createForecastExportJob_tags :: Lens' CreateForecastExportJob (Maybe [Tag])
- createForecastExportJob_forecastExportJobName :: Lens' CreateForecastExportJob Text
- createForecastExportJob_forecastArn :: Lens' CreateForecastExportJob Text
- createForecastExportJob_destination :: Lens' CreateForecastExportJob DataDestination
- createForecastExportJobResponse_forecastExportJobArn :: Lens' CreateForecastExportJobResponse (Maybe Text)
- createForecastExportJobResponse_httpStatus :: Lens' CreateForecastExportJobResponse Int
- createPredictor_performAutoML :: Lens' CreatePredictor (Maybe Bool)
- createPredictor_trainingParameters :: Lens' CreatePredictor (Maybe (HashMap Text Text))
- createPredictor_algorithmArn :: Lens' CreatePredictor (Maybe Text)
- createPredictor_hPOConfig :: Lens' CreatePredictor (Maybe HyperParameterTuningJobConfig)
- createPredictor_optimizationMetric :: Lens' CreatePredictor (Maybe OptimizationMetric)
- createPredictor_autoMLOverrideStrategy :: Lens' CreatePredictor (Maybe AutoMLOverrideStrategy)
- createPredictor_evaluationParameters :: Lens' CreatePredictor (Maybe EvaluationParameters)
- createPredictor_encryptionConfig :: Lens' CreatePredictor (Maybe EncryptionConfig)
- createPredictor_forecastTypes :: Lens' CreatePredictor (Maybe (NonEmpty Text))
- createPredictor_performHPO :: Lens' CreatePredictor (Maybe Bool)
- createPredictor_tags :: Lens' CreatePredictor (Maybe [Tag])
- createPredictor_predictorName :: Lens' CreatePredictor Text
- createPredictor_forecastHorizon :: Lens' CreatePredictor Int
- createPredictor_inputDataConfig :: Lens' CreatePredictor InputDataConfig
- createPredictor_featurizationConfig :: Lens' CreatePredictor FeaturizationConfig
- createPredictorResponse_predictorArn :: Lens' CreatePredictorResponse (Maybe Text)
- createPredictorResponse_httpStatus :: Lens' CreatePredictorResponse Int
- listPredictorBacktestExportJobs_filters :: Lens' ListPredictorBacktestExportJobs (Maybe [Filter])
- listPredictorBacktestExportJobs_nextToken :: Lens' ListPredictorBacktestExportJobs (Maybe Text)
- listPredictorBacktestExportJobs_maxResults :: Lens' ListPredictorBacktestExportJobs (Maybe Natural)
- listPredictorBacktestExportJobsResponse_nextToken :: Lens' ListPredictorBacktestExportJobsResponse (Maybe Text)
- listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs :: Lens' ListPredictorBacktestExportJobsResponse (Maybe [PredictorBacktestExportJobSummary])
- listPredictorBacktestExportJobsResponse_httpStatus :: Lens' ListPredictorBacktestExportJobsResponse Int
- deletePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DeletePredictorBacktestExportJob Text
- createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text))
- createForecast_tags :: Lens' CreateForecast (Maybe [Tag])
- createForecast_forecastName :: Lens' CreateForecast Text
- createForecast_predictorArn :: Lens' CreateForecast Text
- createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text)
- createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int
- createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag])
- createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text
- createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination
- createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text)
- createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int
- deleteForecast_forecastArn :: Lens' DeleteForecast Text
- deleteResourceTree_resourceArn :: Lens' DeleteResourceTree Text
- describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text
- describeDatasetGroupResponse_creationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime)
- describeDatasetGroupResponse_datasetArns :: Lens' DescribeDatasetGroupResponse (Maybe [Text])
- describeDatasetGroupResponse_status :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_domain :: Lens' DescribeDatasetGroupResponse (Maybe Domain)
- describeDatasetGroupResponse_datasetGroupName :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_datasetGroupArn :: Lens' DescribeDatasetGroupResponse (Maybe Text)
- describeDatasetGroupResponse_lastModificationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime)
- describeDatasetGroupResponse_httpStatus :: Lens' DescribeDatasetGroupResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- listDatasets_nextToken :: Lens' ListDatasets (Maybe Text)
- listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural)
- listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text)
- listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary])
- listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int
- describePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJob Text
- describePredictorBacktestExportJobResponse_creationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime)
- describePredictorBacktestExportJobResponse_status :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_destination :: Lens' DescribePredictorBacktestExportJobResponse (Maybe DataDestination)
- describePredictorBacktestExportJobResponse_predictorArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_message :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_predictorBacktestExportJobName :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text)
- describePredictorBacktestExportJobResponse_lastModificationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime)
- describePredictorBacktestExportJobResponse_httpStatus :: Lens' DescribePredictorBacktestExportJobResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- createDatasetGroup_datasetArns :: Lens' CreateDatasetGroup (Maybe [Text])
- createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag])
- createDatasetGroup_datasetGroupName :: Lens' CreateDatasetGroup Text
- createDatasetGroup_domain :: Lens' CreateDatasetGroup Domain
- createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text)
- createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int
- listForecastExportJobs_filters :: Lens' ListForecastExportJobs (Maybe [Filter])
- listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (Maybe Text)
- listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural)
- listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text)
- listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary])
- listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int
- listPredictors_filters :: Lens' ListPredictors (Maybe [Filter])
- listPredictors_nextToken :: Lens' ListPredictors (Maybe Text)
- listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural)
- listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text)
- listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary])
- listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int
- categoricalParameterRange_name :: Lens' CategoricalParameterRange Text
- categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text)
- continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe ScalingType)
- continuousParameterRange_name :: Lens' ContinuousParameterRange Text
- continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Double
- continuousParameterRange_minValue :: Lens' ContinuousParameterRange Double
- dataDestination_s3Config :: Lens' DataDestination S3Config
- dataSource_s3Config :: Lens' DataSource S3Config
- datasetGroupSummary_creationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetGroupSummary_datasetGroupName :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text)
- datasetGroupSummary_lastModificationTime :: Lens' DatasetGroupSummary (Maybe UTCTime)
- datasetImportJobSummary_creationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_datasetImportJobName :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_dataSource :: Lens' DatasetImportJobSummary (Maybe DataSource)
- datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_message :: Lens' DatasetImportJobSummary (Maybe Text)
- datasetImportJobSummary_lastModificationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime)
- datasetSummary_creationTime :: Lens' DatasetSummary (Maybe UTCTime)
- datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_domain :: Lens' DatasetSummary (Maybe Domain)
- datasetSummary_datasetType :: Lens' DatasetSummary (Maybe DatasetType)
- datasetSummary_datasetName :: Lens' DatasetSummary (Maybe Text)
- datasetSummary_lastModificationTime :: Lens' DatasetSummary (Maybe UTCTime)
- encryptionConfig_roleArn :: Lens' EncryptionConfig Text
- encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text
- errorMetric_mase :: Lens' ErrorMetric (Maybe Double)
- errorMetric_wape :: Lens' ErrorMetric (Maybe Double)
- errorMetric_mape :: Lens' ErrorMetric (Maybe Double)
- errorMetric_rmse :: Lens' ErrorMetric (Maybe Double)
- errorMetric_forecastType :: Lens' ErrorMetric (Maybe Text)
- evaluationParameters_backTestWindowOffset :: Lens' EvaluationParameters (Maybe Int)
- evaluationParameters_numberOfBacktestWindows :: Lens' EvaluationParameters (Maybe Int)
- evaluationResult_algorithmArn :: Lens' EvaluationResult (Maybe Text)
- evaluationResult_testWindows :: Lens' EvaluationResult (Maybe [WindowSummary])
- featurization_featurizationPipeline :: Lens' Featurization (Maybe (NonEmpty FeaturizationMethod))
- featurization_attributeName :: Lens' Featurization Text
- featurizationConfig_featurizations :: Lens' FeaturizationConfig (Maybe (NonEmpty Featurization))
- featurizationConfig_forecastDimensions :: Lens' FeaturizationConfig (Maybe (NonEmpty Text))
- featurizationConfig_forecastFrequency :: Lens' FeaturizationConfig Text
- featurizationMethod_featurizationMethodParameters :: Lens' FeaturizationMethod (Maybe (HashMap Text Text))
- featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName
- filter_key :: Lens' Filter Text
- filter_value :: Lens' Filter Text
- filter_condition :: Lens' Filter FilterConditionString
- forecastExportJobSummary_creationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)
- forecastExportJobSummary_status :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_destination :: Lens' ForecastExportJobSummary (Maybe DataDestination)
- forecastExportJobSummary_forecastExportJobArn :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_forecastExportJobName :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_message :: Lens' ForecastExportJobSummary (Maybe Text)
- forecastExportJobSummary_lastModificationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime)
- forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime)
- forecastSummary_status :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_message :: Lens' ForecastSummary (Maybe Text)
- forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime)
- hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges)
- inputDataConfig_supplementaryFeatures :: Lens' InputDataConfig (Maybe (NonEmpty SupplementaryFeature))
- inputDataConfig_datasetGroupArn :: Lens' InputDataConfig Text
- integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType)
- integerParameterRange_name :: Lens' IntegerParameterRange Text
- integerParameterRange_maxValue :: Lens' IntegerParameterRange Int
- integerParameterRange_minValue :: Lens' IntegerParameterRange Int
- metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric])
- metrics_rmse :: Lens' Metrics (Maybe Double)
- metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss])
- metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double)
- parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty CategoricalParameterRange))
- parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty IntegerParameterRange))
- parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty ContinuousParameterRange))
- predictorBacktestExportJobSummary_creationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime)
- predictorBacktestExportJobSummary_status :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_destination :: Lens' PredictorBacktestExportJobSummary (Maybe DataDestination)
- predictorBacktestExportJobSummary_predictorBacktestExportJobArn :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_message :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_predictorBacktestExportJobName :: Lens' PredictorBacktestExportJobSummary (Maybe Text)
- predictorBacktestExportJobSummary_lastModificationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime)
- predictorExecution_algorithmArn :: Lens' PredictorExecution (Maybe Text)
- predictorExecution_testWindows :: Lens' PredictorExecution (Maybe [TestWindowSummary])
- predictorExecutionDetails_predictorExecutions :: Lens' PredictorExecutionDetails (Maybe (NonEmpty PredictorExecution))
- predictorSummary_creationTime :: Lens' PredictorSummary (Maybe UTCTime)
- predictorSummary_status :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_predictorArn :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_predictorName :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_datasetGroupArn :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_message :: Lens' PredictorSummary (Maybe Text)
- predictorSummary_lastModificationTime :: Lens' PredictorSummary (Maybe UTCTime)
- s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text)
- s3Config_path :: Lens' S3Config Text
- s3Config_roleArn :: Lens' S3Config Text
- schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute))
- schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType)
- schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text)
- statistics_max :: Lens' Statistics (Maybe Text)
- statistics_countNullLong :: Lens' Statistics (Maybe Integer)
- statistics_countNan :: Lens' Statistics (Maybe Int)
- statistics_countNanLong :: Lens' Statistics (Maybe Integer)
- statistics_avg :: Lens' Statistics (Maybe Double)
- statistics_countNull :: Lens' Statistics (Maybe Int)
- statistics_count :: Lens' Statistics (Maybe Int)
- statistics_countLong :: Lens' Statistics (Maybe Integer)
- statistics_stddev :: Lens' Statistics (Maybe Double)
- statistics_min :: Lens' Statistics (Maybe Text)
- statistics_countDistinctLong :: Lens' Statistics (Maybe Integer)
- statistics_countDistinct :: Lens' Statistics (Maybe Int)
- supplementaryFeature_name :: Lens' SupplementaryFeature Text
- supplementaryFeature_value :: Lens' SupplementaryFeature Text
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- testWindowSummary_status :: Lens' TestWindowSummary (Maybe Text)
- testWindowSummary_testWindowEnd :: Lens' TestWindowSummary (Maybe UTCTime)
- testWindowSummary_testWindowStart :: Lens' TestWindowSummary (Maybe UTCTime)
- testWindowSummary_message :: Lens' TestWindowSummary (Maybe Text)
- weightedQuantileLoss_quantile :: Lens' WeightedQuantileLoss (Maybe Double)
- weightedQuantileLoss_lossValue :: Lens' WeightedQuantileLoss (Maybe Double)
- windowSummary_metrics :: Lens' WindowSummary (Maybe Metrics)
- windowSummary_testWindowEnd :: Lens' WindowSummary (Maybe UTCTime)
- windowSummary_evaluationType :: Lens' WindowSummary (Maybe EvaluationType)
- windowSummary_testWindowStart :: Lens' WindowSummary (Maybe UTCTime)
- windowSummary_itemCount :: Lens' WindowSummary (Maybe Int)
Operations
ListDatasetGroups
listDatasetGroups_nextToken :: Lens' ListDatasetGroups (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasetGroups_maxResults :: Lens' ListDatasetGroups (Maybe Natural) Source #
The number of items to return in the response.
listDatasetGroupsResponse_nextToken :: Lens' ListDatasetGroupsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetGroupsResponse_datasetGroups :: Lens' ListDatasetGroupsResponse (Maybe [DatasetGroupSummary]) Source #
An array of objects that summarize each dataset group's properties.
listDatasetGroupsResponse_httpStatus :: Lens' ListDatasetGroupsResponse Int Source #
The response's http status code.
CreateDatasetImportJob
createDatasetImportJob_timestampFormat :: Lens' CreateDatasetImportJob (Maybe Text) Source #
The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
createDatasetImportJob_useGeolocationForTimeZone :: Lens' CreateDatasetImportJob (Maybe Bool) Source #
Automatically derive time zone information from the geolocation attribute. This option is ideal for datasets that contain timestamps in multiple time zones and those timestamps are expressed in local time.
createDatasetImportJob_geolocationFormat :: Lens' CreateDatasetImportJob (Maybe Text) Source #
The format of the geolocation attribute. The geolocation attribute can be formatted in one of two ways:
LAT_LONG
- the latitude and longitude in decimal format (Example: 47.61_-122.33).CC_POSTALCODE
(US Only) - the country code (US), followed by the 5-digit ZIP code (Example: US_98121).
createDatasetImportJob_timeZone :: Lens' CreateDatasetImportJob (Maybe Text) Source #
A single time zone for every item in your dataset. This option is ideal for datasets with all timestamps within a single time zone, or if all timestamps are normalized to a single time zone.
Refer to the Joda-Time API for a complete list of valid time zone names.
createDatasetImportJob_tags :: Lens' CreateDatasetImportJob (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDatasetImportJob_datasetImportJobName :: Lens' CreateDatasetImportJob Text Source #
The name for the dataset import job. We recommend including the current
timestamp in the name, for example, 20190721DatasetImport
. This can
help you avoid getting a ResourceAlreadyExistsException
exception.
createDatasetImportJob_datasetArn :: Lens' CreateDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
createDatasetImportJob_dataSource :: Lens' CreateDatasetImportJob DataSource Source #
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
must include an AWS Key Management
Service (KMS) key and the IAM role must allow Amazon Forecast permission
to access the key. The KMS key and IAM role must match those specified
in the EncryptionConfig
parameter of the CreateDataset operation.
createDatasetImportJobResponse_datasetImportJobArn :: Lens' CreateDatasetImportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job.
createDatasetImportJobResponse_httpStatus :: Lens' CreateDatasetImportJobResponse Int Source #
The response's http status code.
DescribeDataset
describeDataset_datasetArn :: Lens' DescribeDataset Text Source #
The Amazon Resource Name (ARN) of the dataset.
describeDatasetResponse_creationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #
When the dataset was created.
describeDatasetResponse_status :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The status of the dataset. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply while data is imported to the dataset from a
call to the CreateDatasetImportJob operation and reflect the status of
the dataset import job. For example, when the import job status is
CREATE_IN_PROGRESS
, the status of the dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import
training data.
describeDatasetResponse_dataFrequency :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The frequency of data collection.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min" indicates every 30 minutes.
describeDatasetResponse_datasetArn :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
describeDatasetResponse_domain :: Lens' DescribeDatasetResponse (Maybe Domain) Source #
The domain associated with the dataset.
describeDatasetResponse_schema :: Lens' DescribeDatasetResponse (Maybe Schema) Source #
An array of SchemaAttribute
objects that specify the dataset fields.
Each SchemaAttribute
specifies the name and data type of a field.
describeDatasetResponse_datasetType :: Lens' DescribeDatasetResponse (Maybe DatasetType) Source #
The dataset type.
describeDatasetResponse_datasetName :: Lens' DescribeDatasetResponse (Maybe Text) Source #
The name of the dataset.
describeDatasetResponse_encryptionConfig :: Lens' DescribeDatasetResponse (Maybe EncryptionConfig) Source #
The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
describeDatasetResponse_lastModificationTime :: Lens' DescribeDatasetResponse (Maybe UTCTime) Source #
When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the DescribeDataset
call. After a CreateDatasetImportJob operation has finished,
LastModificationTime
is when the import job completed or failed.
describeDatasetResponse_httpStatus :: Lens' DescribeDatasetResponse Int Source #
The response's http status code.
ListForecasts
listForecasts_filters :: Lens' ListForecasts (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecasts that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecasts that match the statement, specifyIS
. To exclude matching forecasts, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
,PredictorArn
, andStatus
.Value
- The value to match.
For example, to list all forecasts whose status is not ACTIVE, you would specify:
"Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
listForecasts_nextToken :: Lens' ListForecasts (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listForecasts_maxResults :: Lens' ListForecasts (Maybe Natural) Source #
The number of items to return in the response.
listForecastsResponse_forecasts :: Lens' ListForecastsResponse (Maybe [ForecastSummary]) Source #
An array of objects that summarize each forecast's properties.
listForecastsResponse_nextToken :: Lens' ListForecastsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listForecastsResponse_httpStatus :: Lens' ListForecastsResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
The tags for the resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
StopResource
stopResource_resourceArn :: Lens' StopResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource to stop. The
supported ARNs are DatasetImportJobArn
, PredictorArn
,
PredictorBacktestExportJobArn
, ForecastArn
, and
ForecastExportJobArn
.
DescribeDatasetImportJob
describeDatasetImportJob_datasetImportJobArn :: Lens' DescribeDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the dataset import job.
describeDatasetImportJobResponse_creationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime) Source #
When the dataset import job was created.
describeDatasetImportJobResponse_status :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
describeDatasetImportJobResponse_datasetImportJobName :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The name of the dataset import job.
describeDatasetImportJobResponse_datasetArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
describeDatasetImportJobResponse_timestampFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The format of timestamps in the dataset. The format that you specify
depends on the DataFrequency
specified when the dataset was created.
The following formats are supported
"yyyy-MM-dd"
For the following data frequencies: Y, M, W, and D
"yyyy-MM-dd HH:mm:ss"
For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
describeDatasetImportJobResponse_dataSize :: Lens' DescribeDatasetImportJobResponse (Maybe Double) Source #
The size of the dataset in gigabytes (GB) after the import job has finished.
describeDatasetImportJobResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeDatasetImportJobResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the dataset import job to complete.
describeDatasetImportJobResponse_fieldStatistics :: Lens' DescribeDatasetImportJobResponse (Maybe (HashMap Text Statistics)) Source #
Statistical information about each field in the input data.
describeDatasetImportJobResponse_dataSource :: Lens' DescribeDatasetImportJobResponse (Maybe DataSource) Source #
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
describeDatasetImportJobResponse_datasetImportJobArn :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The ARN of the dataset import job.
describeDatasetImportJobResponse_useGeolocationForTimeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Bool) Source #
Whether TimeZone
is automatically derived from the geolocation
attribute.
describeDatasetImportJobResponse_message :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeDatasetImportJobResponse_geolocationFormat :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The format of the geolocation attribute. Valid Values:"LAT_LONG"
and
"CC_POSTALCODE"
.
describeDatasetImportJobResponse_timeZone :: Lens' DescribeDatasetImportJobResponse (Maybe Text) Source #
The single time zone applied to every item in the dataset
describeDatasetImportJobResponse_lastModificationTime :: Lens' DescribeDatasetImportJobResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeDatasetImportJobResponse_httpStatus :: Lens' DescribeDatasetImportJobResponse Int Source #
The response's http status code.
DescribeForecastExportJob
describeForecastExportJob_forecastExportJobArn :: Lens' DescribeForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast export job.
describeForecastExportJobResponse_creationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime) Source #
When the forecast export job was created.
describeForecastExportJobResponse_status :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
describeForecastExportJobResponse_destination :: Lens' DescribeForecastExportJobResponse (Maybe DataDestination) Source #
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
describeForecastExportJobResponse_forecastExportJobArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The ARN of the forecast export job.
describeForecastExportJobResponse_forecastArn :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the exported forecast.
describeForecastExportJobResponse_forecastExportJobName :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
The name of the forecast export job.
describeForecastExportJobResponse_message :: Lens' DescribeForecastExportJobResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeForecastExportJobResponse_lastModificationTime :: Lens' DescribeForecastExportJobResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeForecastExportJobResponse_httpStatus :: Lens' DescribeForecastExportJobResponse Int Source #
The response's http status code.
DescribePredictor
describePredictor_predictorArn :: Lens' DescribePredictor Text Source #
The Amazon Resource Name (ARN) of the predictor that you want information about.
describePredictorResponse_creationTime :: Lens' DescribePredictorResponse (Maybe UTCTime) Source #
When the model training task was created.
describePredictorResponse_forecastHorizon :: Lens' DescribePredictorResponse (Maybe Int) Source #
The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
describePredictorResponse_status :: Lens' DescribePredictorResponse (Maybe Text) Source #
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
describePredictorResponse_performAutoML :: Lens' DescribePredictorResponse (Maybe Bool) Source #
Whether the predictor is set to perform AutoML.
describePredictorResponse_autoMLAlgorithmArns :: Lens' DescribePredictorResponse (Maybe [Text]) Source #
When PerformAutoML
is specified, the ARN of the chosen algorithm.
describePredictorResponse_trainingParameters :: Lens' DescribePredictorResponse (Maybe (HashMap Text Text)) Source #
The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
describePredictorResponse_algorithmArn :: Lens' DescribePredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm used for model training.
describePredictorResponse_hPOConfig :: Lens' DescribePredictorResponse (Maybe HyperParameterTuningJobConfig) Source #
The hyperparameter override values for the algorithm.
describePredictorResponse_predictorArn :: Lens' DescribePredictorResponse (Maybe Text) Source #
The ARN of the predictor.
describePredictorResponse_optimizationMetric :: Lens' DescribePredictorResponse (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
describePredictorResponse_predictorExecutionDetails :: Lens' DescribePredictorResponse (Maybe PredictorExecutionDetails) Source #
Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.
describePredictorResponse_datasetImportJobArns :: Lens' DescribePredictorResponse (Maybe [Text]) Source #
An array of the ARNs of the dataset import jobs used to import training data for the predictor.
describePredictorResponse_estimatedTimeRemainingInMinutes :: Lens' DescribePredictorResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the predictor training job to complete.
describePredictorResponse_autoMLOverrideStrategy :: Lens' DescribePredictorResponse (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
describePredictorResponse_evaluationParameters :: Lens' DescribePredictorResponse (Maybe EvaluationParameters) Source #
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
describePredictorResponse_inputDataConfig :: Lens' DescribePredictorResponse (Maybe InputDataConfig) Source #
Describes the dataset group that contains the data to use to train the predictor.
describePredictorResponse_predictorName :: Lens' DescribePredictorResponse (Maybe Text) Source #
The name of the predictor.
describePredictorResponse_featurizationConfig :: Lens' DescribePredictorResponse (Maybe FeaturizationConfig) Source #
The featurization configuration.
describePredictorResponse_encryptionConfig :: Lens' DescribePredictorResponse (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
describePredictorResponse_forecastTypes :: Lens' DescribePredictorResponse (Maybe (NonEmpty Text)) Source #
The forecast types used during predictor training. Default value is
["0.1","0.5","0.9"]
describePredictorResponse_message :: Lens' DescribePredictorResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describePredictorResponse_performHPO :: Lens' DescribePredictorResponse (Maybe Bool) Source #
Whether the predictor is set to perform hyperparameter optimization (HPO).
describePredictorResponse_lastModificationTime :: Lens' DescribePredictorResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describePredictorResponse_httpStatus :: Lens' DescribePredictorResponse Int Source #
The response's http status code.
DeleteDataset
deleteDataset_datasetArn :: Lens' DeleteDataset Text Source #
The Amazon Resource Name (ARN) of the dataset to delete.
DescribeForecast
describeForecast_forecastArn :: Lens' DescribeForecast Text Source #
The Amazon Resource Name (ARN) of the forecast.
describeForecastResponse_creationTime :: Lens' DescribeForecastResponse (Maybe UTCTime) Source #
When the forecast creation task was created.
describeForecastResponse_status :: Lens' DescribeForecastResponse (Maybe Text) Source #
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
describeForecastResponse_predictorArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The ARN of the predictor used to generate the forecast.
describeForecastResponse_forecastArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The forecast ARN as specified in the request.
describeForecastResponse_estimatedTimeRemainingInMinutes :: Lens' DescribeForecastResponse (Maybe Integer) Source #
The estimated time remaining in minutes for the forecast job to complete.
describeForecastResponse_forecastName :: Lens' DescribeForecastResponse (Maybe Text) Source #
The name of the forecast.
describeForecastResponse_forecastTypes :: Lens' DescribeForecastResponse (Maybe (NonEmpty Text)) Source #
The quantiles at which probabilistic forecasts were generated.
describeForecastResponse_datasetGroupArn :: Lens' DescribeForecastResponse (Maybe Text) Source #
The ARN of the dataset group that provided the data used to train the predictor.
describeForecastResponse_message :: Lens' DescribeForecastResponse (Maybe Text) Source #
If an error occurred, an informational message about the error.
describeForecastResponse_lastModificationTime :: Lens' DescribeForecastResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describeForecastResponse_httpStatus :: Lens' DescribeForecastResponse Int Source #
The response's http status code.
CreateDataset
createDataset_dataFrequency :: Lens' CreateDataset (Maybe Text) Source #
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min" indicates every 15 minutes.
createDataset_encryptionConfig :: Lens' CreateDataset (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
createDataset_tags :: Lens' CreateDataset (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDataset_datasetName :: Lens' CreateDataset Text Source #
A name for the dataset.
createDataset_domain :: Lens' CreateDataset Domain Source #
The domain associated with the dataset. When you add a dataset to a
dataset group, this value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in the training data that you import to the dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires item_id
, timestamp
, and
demand
fields to be present in your data. For more information, see
howitworks-datasets-groups.
createDataset_datasetType :: Lens' CreateDataset DatasetType Source #
The dataset type. Valid values depend on the chosen Domain
.
createDataset_schema :: Lens' CreateDataset Schema Source #
The schema for the dataset. The schema attributes and their order must
match the fields in your data. The dataset Domain
and DatasetType
that you choose determine the minimum required fields in your training
data. For information about the required fields for a specific dataset
domain and type, see howitworks-domains-ds-types.
createDatasetResponse_datasetArn :: Lens' CreateDatasetResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #
The response's http status code.
DeleteForecastExportJob
deleteForecastExportJob_forecastExportJobArn :: Lens' DeleteForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast export job to delete.
DeletePredictor
deletePredictor_predictorArn :: Lens' DeletePredictor Text Source #
The Amazon Resource Name (ARN) of the predictor to delete.
ListDatasetImportJobs
listDatasetImportJobs_filters :: Lens' ListDatasetImportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the datasets that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the datasets that match the statement, specifyIS
. To exclude matching datasets, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetArn
andStatus
.Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
listDatasetImportJobs_nextToken :: Lens' ListDatasetImportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasetImportJobs_maxResults :: Lens' ListDatasetImportJobs (Maybe Natural) Source #
The number of items to return in the response.
listDatasetImportJobsResponse_datasetImportJobs :: Lens' ListDatasetImportJobsResponse (Maybe [DatasetImportJobSummary]) Source #
An array of objects that summarize each dataset import job's properties.
listDatasetImportJobsResponse_nextToken :: Lens' ListDatasetImportJobsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetImportJobsResponse_httpStatus :: Lens' ListDatasetImportJobsResponse Int Source #
The response's http status code.
DeleteDatasetImportJob
deleteDatasetImportJob_datasetImportJobArn :: Lens' DeleteDatasetImportJob Text Source #
The Amazon Resource Name (ARN) of the dataset import job to delete.
GetAccuracyMetrics
getAccuracyMetrics_predictorArn :: Lens' GetAccuracyMetrics Text Source #
The Amazon Resource Name (ARN) of the predictor to get metrics for.
getAccuracyMetricsResponse_predictorEvaluationResults :: Lens' GetAccuracyMetricsResponse (Maybe [EvaluationResult]) Source #
An array of results from evaluating the predictor.
getAccuracyMetricsResponse_optimizationMetric :: Lens' GetAccuracyMetricsResponse (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
getAccuracyMetricsResponse_autoMLOverrideStrategy :: Lens' GetAccuracyMetricsResponse (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
The AutoML strategy used to train the predictor. Unless
LatencyOptimized
is specified, the AutoML strategy optimizes predictor
accuracy.
This parameter is only valid for predictors trained using AutoML.
getAccuracyMetricsResponse_httpStatus :: Lens' GetAccuracyMetricsResponse Int Source #
The response's http status code.
DeleteDatasetGroup
deleteDatasetGroup_datasetGroupArn :: Lens' DeleteDatasetGroup Text Source #
The Amazon Resource Name (ARN) of the dataset group to delete.
UpdateDatasetGroup
updateDatasetGroup_datasetGroupArn :: Lens' UpdateDatasetGroup Text Source #
The ARN of the dataset group.
updateDatasetGroup_datasetArns :: Lens' UpdateDatasetGroup [Text] Source #
An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.
updateDatasetGroupResponse_httpStatus :: Lens' UpdateDatasetGroupResponse Int Source #
The response's http status code.
CreateForecastExportJob
createForecastExportJob_tags :: Lens' CreateForecastExportJob (Maybe [Tag]) Source #
The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createForecastExportJob_forecastExportJobName :: Lens' CreateForecastExportJob Text Source #
The name for the forecast export job.
createForecastExportJob_forecastArn :: Lens' CreateForecastExportJob Text Source #
The Amazon Resource Name (ARN) of the forecast that you want to export.
createForecastExportJob_destination :: Lens' CreateForecastExportJob DataDestination Source #
The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
If encryption is used, Destination
must include an AWS Key Management
Service (KMS) key. The IAM role must allow Amazon Forecast permission to
access the key.
createForecastExportJobResponse_forecastExportJobArn :: Lens' CreateForecastExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the export job.
createForecastExportJobResponse_httpStatus :: Lens' CreateForecastExportJobResponse Int Source #
The response's http status code.
CreatePredictor
createPredictor_performAutoML :: Lens' CreatePredictor (Maybe Bool) Source #
Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.
The default value is false
. In this case, you are required to specify
an algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML.
This is a good option if you aren't sure which algorithm is suitable
for your training data. In this case, PerformHPO
must be false.
createPredictor_trainingParameters :: Lens' CreatePredictor (Maybe (HashMap Text Text)) Source #
The hyperparameters to override for model training. The hyperparameters that you can override are listed in the individual algorithms. For the list of supported algorithms, see aws-forecast-choosing-recipes.
createPredictor_algorithmArn :: Lens' CreatePredictor (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm to use for model
training. Required if PerformAutoML
is not set to true
.
Supported algorithms:
arn:aws:forecast:::algorithm/ARIMA
arn:aws:forecast:::algorithm/CNN-QR
arn:aws:forecast:::algorithm/Deep_AR_Plus
arn:aws:forecast:::algorithm/ETS
arn:aws:forecast:::algorithm/NPTS
arn:aws:forecast:::algorithm/Prophet
createPredictor_hPOConfig :: Lens' CreatePredictor (Maybe HyperParameterTuningJobConfig) Source #
Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.
If you included the HPOConfig
object, you must set PerformHPO
to
true.
createPredictor_optimizationMetric :: Lens' CreatePredictor (Maybe OptimizationMetric) Source #
The accuracy metric used to optimize the predictor.
createPredictor_autoMLOverrideStrategy :: Lens' CreatePredictor (Maybe AutoMLOverrideStrategy) Source #
The LatencyOptimized
AutoML override strategy is only available in
private beta. Contact AWS Support or your account manager to learn more
about access privileges.
Used to overide the default AutoML strategy, which is to optimize
predictor accuracy. To apply an AutoML strategy that minimizes training
time, use LatencyOptimized
.
This parameter is only valid for predictors trained using AutoML.
createPredictor_evaluationParameters :: Lens' CreatePredictor (Maybe EvaluationParameters) Source #
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
createPredictor_encryptionConfig :: Lens' CreatePredictor (Maybe EncryptionConfig) Source #
An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
createPredictor_forecastTypes :: Lens' CreatePredictor (Maybe (NonEmpty Text)) Source #
Specifies the forecast types used to train a predictor. You can specify
up to five forecast types. Forecast types can be quantiles from 0.01 to
0.99, by increments of 0.01 or higher. You can also specify the mean
forecast with mean
.
The default value is ["0.10", "0.50", "0.9"]
.
createPredictor_performHPO :: Lens' CreatePredictor (Maybe Bool) Source #
Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.
The default value is false
. In this case, Amazon Forecast uses default
hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,
optionally, supply the HyperParameterTuningJobConfig object. The tuning
job specifies a metric to optimize, which hyperparameters participate in
tuning, and the valid range for each tunable hyperparameter. In this
case, you are required to specify an algorithm and PerformAutoML
must
be false.
The following algorithms support HPO:
- DeepAR+
- CNN-QR
createPredictor_tags :: Lens' CreatePredictor (Maybe [Tag]) Source #
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createPredictor_predictorName :: Lens' CreatePredictor Text Source #
A name for the predictor.
createPredictor_forecastHorizon :: Lens' CreatePredictor Int Source #
Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.
For example, if you configure a dataset for daily data collection (using
the DataFrequency
parameter of the CreateDataset operation) and set
the forecast horizon to 10, the model returns predictions for 10 days.
The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
createPredictor_inputDataConfig :: Lens' CreatePredictor InputDataConfig Source #
Describes the dataset group that contains the data to use to train the predictor.
createPredictor_featurizationConfig :: Lens' CreatePredictor FeaturizationConfig Source #
The featurization configuration.
createPredictorResponse_predictorArn :: Lens' CreatePredictorResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor.
createPredictorResponse_httpStatus :: Lens' CreatePredictorResponse Int Source #
The response's http status code.
ListPredictorBacktestExportJobs
listPredictorBacktestExportJobs_filters :: Lens' ListPredictorBacktestExportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, provide a condition and a match
statement. The condition is either IS
or IS_NOT
, which specifies
whether to include or exclude the predictor backtest export jobs that
match the statement from the list. The match statement consists of a key
and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictor backtest export jobs that match the statement, specifyIS
. To exclude matching predictor backtest export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values arePredictorArn
andStatus
.Value
- The value to match.
listPredictorBacktestExportJobs_nextToken :: Lens' ListPredictorBacktestExportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
listPredictorBacktestExportJobs_maxResults :: Lens' ListPredictorBacktestExportJobs (Maybe Natural) Source #
The number of items to return in the response.
listPredictorBacktestExportJobsResponse_nextToken :: Lens' ListPredictorBacktestExportJobsResponse (Maybe Text) Source #
Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.
listPredictorBacktestExportJobsResponse_predictorBacktestExportJobs :: Lens' ListPredictorBacktestExportJobsResponse (Maybe [PredictorBacktestExportJobSummary]) Source #
An array of objects that summarize the properties of each predictor backtest export job.
listPredictorBacktestExportJobsResponse_httpStatus :: Lens' ListPredictorBacktestExportJobsResponse Int Source #
The response's http status code.
DeletePredictorBacktestExportJob
deletePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DeletePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor backtest export job to delete.
CreateForecast
createForecast_forecastTypes :: Lens' CreateForecast (Maybe (NonEmpty Text)) Source #
The quantiles at which probabilistic forecasts are generated. __You can
currently specify up to 5 quantiles per forecast__. Accepted values
include 0.01 to 0.99
(increments of .01 only) and mean
. The mean
forecast is different from the median (0.50) when the distribution is
not symmetric (for example, Beta and Negative Binomial). The default
value is ["0.1", "0.5", "0.9"]
.
createForecast_tags :: Lens' CreateForecast (Maybe [Tag]) Source #
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createForecast_forecastName :: Lens' CreateForecast Text Source #
A name for the forecast.
createForecast_predictorArn :: Lens' CreateForecast Text Source #
The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
createForecastResponse_forecastArn :: Lens' CreateForecastResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the forecast.
createForecastResponse_httpStatus :: Lens' CreateForecastResponse Int Source #
The response's http status code.
CreatePredictorBacktestExportJob
createPredictorBacktestExportJob_tags :: Lens' CreatePredictorBacktestExportJob (Maybe [Tag]) Source #
Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.
The following restrictions apply to tags:
- For each resource, each tag key must be unique and each tag key must have one value.
- Maximum number of tags per resource: 50.
- Maximum key length: 128 Unicode characters in UTF-8.
- Maximum value length: 256 Unicode characters in UTF-8.
- Accepted characters: all letters and numbers, spaces representable in UTF-8, and + - = . _ : / @. If your tagging schema is used across other services and resources, the character restrictions of those services also apply.
- Key prefixes cannot include any upper or lowercase combination of
aws:
orAWS:
. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit. You cannot edit or delete tag keys with this prefix.
createPredictorBacktestExportJob_predictorBacktestExportJobName :: Lens' CreatePredictorBacktestExportJob Text Source #
The name for the backtest export job.
createPredictorBacktestExportJob_predictorArn :: Lens' CreatePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor that you want to export.
createPredictorBacktestExportJob_destination :: Lens' CreatePredictorBacktestExportJob DataDestination Source #
Undocumented member.
createPredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' CreatePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.
createPredictorBacktestExportJobResponse_httpStatus :: Lens' CreatePredictorBacktestExportJobResponse Int Source #
The response's http status code.
DeleteForecast
deleteForecast_forecastArn :: Lens' DeleteForecast Text Source #
The Amazon Resource Name (ARN) of the forecast to delete.
DeleteResourceTree
deleteResourceTree_resourceArn :: Lens' DeleteResourceTree Text Source #
The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted.
DescribeDatasetGroup
describeDatasetGroup_datasetGroupArn :: Lens' DescribeDatasetGroup Text Source #
The Amazon Resource Name (ARN) of the dataset group.
describeDatasetGroupResponse_creationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime) Source #
When the dataset group was created.
describeDatasetGroupResponse_datasetArns :: Lens' DescribeDatasetGroupResponse (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
describeDatasetGroupResponse_status :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The status of the dataset group. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
UPDATE_PENDING
,UPDATE_IN_PROGRESS
,UPDATE_FAILED
The UPDATE
states apply when you call the UpdateDatasetGroup
operation.
The Status
of the dataset group must be ACTIVE
before you can use
the dataset group to create a predictor.
describeDatasetGroupResponse_domain :: Lens' DescribeDatasetGroupResponse (Maybe Domain) Source #
The domain associated with the dataset group.
describeDatasetGroupResponse_datasetGroupName :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The name of the dataset group.
describeDatasetGroupResponse_datasetGroupArn :: Lens' DescribeDatasetGroupResponse (Maybe Text) Source #
The ARN of the dataset group.
describeDatasetGroupResponse_lastModificationTime :: Lens' DescribeDatasetGroupResponse (Maybe UTCTime) Source #
When the dataset group was created or last updated from a call to the
UpdateDatasetGroup operation. While the dataset group is being updated,
LastModificationTime
is the current time of the DescribeDatasetGroup
call.
describeDatasetGroupResponse_httpStatus :: Lens' DescribeDatasetGroupResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
tagResource_tags :: Lens' TagResource [Tag] Source #
The tags to add to the resource. A tag is an array of key-value pairs.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
ListDatasets
listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #
The number of items to return in the response.
listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [DatasetSummary]) Source #
An array of objects that summarize each dataset's properties.
listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int Source #
The response's http status code.
DescribePredictorBacktestExportJob
describePredictorBacktestExportJob_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJob Text Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
describePredictorBacktestExportJobResponse_creationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime) Source #
When the predictor backtest export job was created.
describePredictorBacktestExportJobResponse_status :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
describePredictorBacktestExportJobResponse_destination :: Lens' DescribePredictorBacktestExportJobResponse (Maybe DataDestination) Source #
Undocumented member.
describePredictorBacktestExportJobResponse_predictorArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor.
describePredictorBacktestExportJobResponse_predictorBacktestExportJobArn :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
describePredictorBacktestExportJobResponse_message :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
Information about any errors that may have occurred during the backtest export.
describePredictorBacktestExportJobResponse_predictorBacktestExportJobName :: Lens' DescribePredictorBacktestExportJobResponse (Maybe Text) Source #
The name of the predictor backtest export job.
describePredictorBacktestExportJobResponse_lastModificationTime :: Lens' DescribePredictorBacktestExportJobResponse (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
describePredictorBacktestExportJobResponse_httpStatus :: Lens' DescribePredictorBacktestExportJobResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The keys of the tags to be removed.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
CreateDatasetGroup
createDatasetGroup_datasetArns :: Lens' CreateDatasetGroup (Maybe [Text]) Source #
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
createDatasetGroup_tags :: Lens' CreateDatasetGroup (Maybe [Tag]) Source #
The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50.
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8.
- Maximum value length - 256 Unicode characters in UTF-8.
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value hasaws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix ofaws
do not count against your tags per resource limit.
createDatasetGroup_datasetGroupName :: Lens' CreateDatasetGroup Text Source #
A name for the dataset group.
createDatasetGroup_domain :: Lens' CreateDatasetGroup Domain Source #
The domain associated with the dataset group. When you add a dataset to
a dataset group, this value and the value specified for the Domain
parameter of the CreateDataset operation must match.
The Domain
and DatasetType
that you choose determine the fields that
must be present in training data that you import to a dataset. For
example, if you choose the RETAIL
domain and TARGET_TIME_SERIES
as
the DatasetType
, Amazon Forecast requires that item_id
, timestamp
,
and demand
fields are present in your data. For more information, see
howitworks-datasets-groups.
createDatasetGroupResponse_datasetGroupArn :: Lens' CreateDatasetGroupResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
createDatasetGroupResponse_httpStatus :: Lens' CreateDatasetGroupResponse Int Source #
The response's http status code.
ListForecastExportJobs
listForecastExportJobs_filters :: Lens' ListForecastExportJobs (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the forecast export jobs that
match the statement from the list, respectively. The match statement
consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the forecast export jobs that match the statement, specifyIS
. To exclude matching forecast export jobs, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areForecastArn
andStatus
.Value
- The value to match.
For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:
"Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
listForecastExportJobs_nextToken :: Lens' ListForecastExportJobs (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listForecastExportJobs_maxResults :: Lens' ListForecastExportJobs (Maybe Natural) Source #
The number of items to return in the response.
listForecastExportJobsResponse_nextToken :: Lens' ListForecastExportJobsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listForecastExportJobsResponse_forecastExportJobs :: Lens' ListForecastExportJobsResponse (Maybe [ForecastExportJobSummary]) Source #
An array of objects that summarize each export job's properties.
listForecastExportJobsResponse_httpStatus :: Lens' ListForecastExportJobsResponse Int Source #
The response's http status code.
ListPredictors
listPredictors_filters :: Lens' ListPredictors (Maybe [Filter]) Source #
An array of filters. For each filter, you provide a condition and a
match statement. The condition is either IS
or IS_NOT
, which
specifies whether to include or exclude the predictors that match the
statement from the list, respectively. The match statement consists of a
key and a value.
Filter properties
Condition
- The condition to apply. Valid values areIS
andIS_NOT
. To include the predictors that match the statement, specifyIS
. To exclude matching predictors, specifyIS_NOT
.Key
- The name of the parameter to filter on. Valid values areDatasetGroupArn
andStatus
.Value
- The value to match.
For example, to list all predictors whose status is ACTIVE, you would specify:
"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
listPredictors_nextToken :: Lens' ListPredictors (Maybe Text) Source #
If the result of the previous request was truncated, the response
includes a NextToken
. To retrieve the next set of results, use the
token in the next request. Tokens expire after 24 hours.
listPredictors_maxResults :: Lens' ListPredictors (Maybe Natural) Source #
The number of items to return in the response.
listPredictorsResponse_nextToken :: Lens' ListPredictorsResponse (Maybe Text) Source #
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.
listPredictorsResponse_predictors :: Lens' ListPredictorsResponse (Maybe [PredictorSummary]) Source #
An array of objects that summarize each predictor's properties.
listPredictorsResponse_httpStatus :: Lens' ListPredictorsResponse Int Source #
The response's http status code.
Types
CategoricalParameterRange
categoricalParameterRange_name :: Lens' CategoricalParameterRange Text Source #
The name of the categorical hyperparameter to tune.
categoricalParameterRange_values :: Lens' CategoricalParameterRange (NonEmpty Text) Source #
A list of the tunable categories for the hyperparameter.
ContinuousParameterRange
continuousParameterRange_scalingType :: Lens' ContinuousParameterRange (Maybe ScalingType) Source #
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- hyperparameter tuning searches the values in the hyperparameter
range by using a reverse logarithmic scale.
Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
continuousParameterRange_name :: Lens' ContinuousParameterRange Text Source #
The name of the hyperparameter to tune.
continuousParameterRange_maxValue :: Lens' ContinuousParameterRange Double Source #
The maximum tunable value of the hyperparameter.
continuousParameterRange_minValue :: Lens' ContinuousParameterRange Double Source #
The minimum tunable value of the hyperparameter.
DataDestination
dataDestination_s3Config :: Lens' DataDestination S3Config Source #
The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
DataSource
dataSource_s3Config :: Lens' DataSource S3Config Source #
The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.
DatasetGroupSummary
datasetGroupSummary_creationTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
When the dataset group was created.
datasetGroupSummary_datasetGroupName :: Lens' DatasetGroupSummary (Maybe Text) Source #
The name of the dataset group.
datasetGroupSummary_datasetGroupArn :: Lens' DatasetGroupSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group.
datasetGroupSummary_lastModificationTime :: Lens' DatasetGroupSummary (Maybe UTCTime) Source #
When the dataset group was created or last updated from a call to the
UpdateDatasetGroup operation. While the dataset group is being updated,
LastModificationTime
is the current time of the ListDatasetGroups
call.
DatasetImportJobSummary
datasetImportJobSummary_creationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
When the dataset import job was created.
datasetImportJobSummary_status :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
datasetImportJobSummary_datasetImportJobName :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The name of the dataset import job.
datasetImportJobSummary_dataSource :: Lens' DatasetImportJobSummary (Maybe DataSource) Source #
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
If encryption is used, DataSource
includes an AWS Key Management
Service (KMS) key.
datasetImportJobSummary_datasetImportJobArn :: Lens' DatasetImportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset import job.
datasetImportJobSummary_message :: Lens' DatasetImportJobSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
datasetImportJobSummary_lastModificationTime :: Lens' DatasetImportJobSummary (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
DatasetSummary
datasetSummary_creationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
When the dataset was created.
datasetSummary_datasetArn :: Lens' DatasetSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset.
datasetSummary_domain :: Lens' DatasetSummary (Maybe Domain) Source #
The domain associated with the dataset.
datasetSummary_datasetType :: Lens' DatasetSummary (Maybe DatasetType) Source #
The dataset type.
datasetSummary_datasetName :: Lens' DatasetSummary (Maybe Text) Source #
The name of the dataset.
datasetSummary_lastModificationTime :: Lens' DatasetSummary (Maybe UTCTime) Source #
When you create a dataset, LastModificationTime
is the same as
CreationTime
. While data is being imported to the dataset,
LastModificationTime
is the current time of the ListDatasets
call.
After a CreateDatasetImportJob operation has finished,
LastModificationTime
is when the import job completed or failed.
EncryptionConfig
encryptionConfig_roleArn :: Lens' EncryptionConfig Text Source #
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
encryptionConfig_kmsKeyArn :: Lens' EncryptionConfig Text Source #
The Amazon Resource Name (ARN) of the KMS key.
ErrorMetric
errorMetric_mase :: Lens' ErrorMetric (Maybe Double) Source #
The Mean Absolute Scaled Error (MASE)
errorMetric_wape :: Lens' ErrorMetric (Maybe Double) Source #
The weighted absolute percentage error (WAPE).
errorMetric_mape :: Lens' ErrorMetric (Maybe Double) Source #
The Mean Absolute Percentage Error (MAPE)
errorMetric_rmse :: Lens' ErrorMetric (Maybe Double) Source #
The root-mean-square error (RMSE).
errorMetric_forecastType :: Lens' ErrorMetric (Maybe Text) Source #
The Forecast type used to compute WAPE, MAPE, MASE, and RMSE.
EvaluationParameters
evaluationParameters_backTestWindowOffset :: Lens' EvaluationParameters (Maybe Int) Source #
The point from the end of the dataset where you want to split the data
for model training and testing (evaluation). Specify the value as the
number of data points. The default is the value of the forecast horizon.
BackTestWindowOffset
can be used to mimic a past virtual forecast
start date. This value must be greater than or equal to the forecast
horizon and less than half of the TARGET_TIME_SERIES dataset length.
ForecastHorizon
<= BackTestWindowOffset
< 1/2 *
TARGET_TIME_SERIES dataset length
evaluationParameters_numberOfBacktestWindows :: Lens' EvaluationParameters (Maybe Int) Source #
The number of times to split the input data. The default is 1. Valid values are 1 through 5.
EvaluationResult
evaluationResult_algorithmArn :: Lens' EvaluationResult (Maybe Text) Source #
The Amazon Resource Name (ARN) of the algorithm that was evaluated.
evaluationResult_testWindows :: Lens' EvaluationResult (Maybe [WindowSummary]) Source #
The array of test windows used for evaluating the algorithm. The
NumberOfBacktestWindows
from the EvaluationParameters object
determines the number of windows in the array.
Featurization
featurization_featurizationPipeline :: Lens' Featurization (Maybe (NonEmpty FeaturizationMethod)) Source #
An array of one FeaturizationMethod
object that specifies the feature
transformation method.
featurization_attributeName :: Lens' Featurization Text Source #
The name of the schema attribute that specifies the data field to be
featurized. Amazon Forecast supports the target field of the
TARGET_TIME_SERIES
and the RELATED_TIME_SERIES
datasets. For
example, for the RETAIL
domain, the target is demand
, and for the
CUSTOM
domain, the target is target_value
. For more information, see
howitworks-missing-values.
FeaturizationConfig
featurizationConfig_featurizations :: Lens' FeaturizationConfig (Maybe (NonEmpty Featurization)) Source #
An array of featurization (transformation) information for the fields of a dataset.
featurizationConfig_forecastDimensions :: Lens' FeaturizationConfig (Maybe (NonEmpty Text)) Source #
An array of dimension (field) names that specify how to group the generated forecast.
For example, suppose that you are generating a forecast for item sales
across all of your stores, and your dataset contains a store_id
field.
If you want the sales forecast for each item by store, you would specify
store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset
don't need to be specified in the CreatePredictor
request. All
forecast dimensions specified in the RELATED_TIME_SERIES
dataset must
be specified in the CreatePredictor
request.
featurizationConfig_forecastFrequency :: Lens' FeaturizationConfig Text Source #
The frequency of predictions in a forecast.
Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.
The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.
FeaturizationMethod
featurizationMethod_featurizationMethodParameters :: Lens' FeaturizationMethod (Maybe (HashMap Text Text)) Source #
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.
The following list shows the parameters and their valid values for the "filling" featurization method for a Target Time Series dataset. Bold signifies the default value.
aggregation
: sum,avg
,first
,min
,max
frontfill
: nonemiddlefill
: zero,nan
(not a number),value
,median
,mean
,min
,max
backfill
: zero,nan
,value
,median
,mean
,min
,max
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
middlefill
:zero
,value
,median
,mean
,min
,max
backfill
:zero
,value
,median
,mean
,min
,max
futurefill
:zero
,value
,median
,mean
,min
,max
To set a filling method to a specific value, set the fill parameter to
value
and define the value in a corresponding _value
parameter. For
example, to set backfilling to a value of 2, include the following:
"backfill": "value"
and "backfill_value":"2"
.
featurizationMethod_featurizationMethodName :: Lens' FeaturizationMethod FeaturizationMethodName Source #
The name of the method. The "filling" method is the only supported method.
Filter
filter_condition :: Lens' Filter FilterConditionString Source #
The condition to apply. To include the objects that match the statement,
specify IS
. To exclude matching objects, specify IS_NOT
.
ForecastExportJobSummary
forecastExportJobSummary_creationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime) Source #
When the forecast export job was created.
forecastExportJobSummary_status :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can
access the forecast in your S3 bucket.
forecastExportJobSummary_destination :: Lens' ForecastExportJobSummary (Maybe DataDestination) Source #
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
forecastExportJobSummary_forecastExportJobArn :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the forecast export job.
forecastExportJobSummary_forecastExportJobName :: Lens' ForecastExportJobSummary (Maybe Text) Source #
The name of the forecast export job.
forecastExportJobSummary_message :: Lens' ForecastExportJobSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
forecastExportJobSummary_lastModificationTime :: Lens' ForecastExportJobSummary (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
ForecastSummary
forecastSummary_creationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
When the forecast creation task was created.
forecastSummary_status :: Lens' ForecastSummary (Maybe Text) Source #
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or
export the forecast.
forecastSummary_predictorArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the predictor used to generate the forecast.
forecastSummary_forecastArn :: Lens' ForecastSummary (Maybe Text) Source #
The ARN of the forecast.
forecastSummary_forecastName :: Lens' ForecastSummary (Maybe Text) Source #
The name of the forecast.
forecastSummary_datasetGroupArn :: Lens' ForecastSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
forecastSummary_message :: Lens' ForecastSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
forecastSummary_lastModificationTime :: Lens' ForecastSummary (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
HyperParameterTuningJobConfig
hyperParameterTuningJobConfig_parameterRanges :: Lens' HyperParameterTuningJobConfig (Maybe ParameterRanges) Source #
Specifies the ranges of valid values for the hyperparameters.
InputDataConfig
inputDataConfig_supplementaryFeatures :: Lens' InputDataConfig (Maybe (NonEmpty SupplementaryFeature)) Source #
An array of supplementary features. The only supported feature is a holiday calendar.
inputDataConfig_datasetGroupArn :: Lens' InputDataConfig Text Source #
The Amazon Resource Name (ARN) of the dataset group.
IntegerParameterRange
integerParameterRange_scalingType :: Lens' IntegerParameterRange (Maybe ScalingType) Source #
The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
- Auto
- Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
- Linear
- Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
- Logarithmic
- Hyperparameter tuning searches the values in the hyperparameter
range by using a logarithmic scale.
Logarithmic scaling works only for ranges that have values greater than 0.
- ReverseLogarithmic
- Not supported for
IntegerParameterRange
.Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
integerParameterRange_name :: Lens' IntegerParameterRange Text Source #
The name of the hyperparameter to tune.
integerParameterRange_maxValue :: Lens' IntegerParameterRange Int Source #
The maximum tunable value of the hyperparameter.
integerParameterRange_minValue :: Lens' IntegerParameterRange Int Source #
The minimum tunable value of the hyperparameter.
Metrics
metrics_errorMetrics :: Lens' Metrics (Maybe [ErrorMetric]) Source #
Provides detailed error metrics for each forecast type. Metrics include root-mean square-error (RMSE), mean absolute percentage error (MAPE), mean absolute scaled error (MASE), and weighted average percentage error (WAPE).
metrics_weightedQuantileLosses :: Lens' Metrics (Maybe [WeightedQuantileLoss]) Source #
An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.
metrics_averageWeightedQuantileLoss :: Lens' Metrics (Maybe Double) Source #
The average value of all weighted quantile losses.
ParameterRanges
parameterRanges_categoricalParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty CategoricalParameterRange)) Source #
Specifies the tunable range for each categorical hyperparameter.
parameterRanges_integerParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty IntegerParameterRange)) Source #
Specifies the tunable range for each integer hyperparameter.
parameterRanges_continuousParameterRanges :: Lens' ParameterRanges (Maybe (NonEmpty ContinuousParameterRange)) Source #
Specifies the tunable range for each continuous hyperparameter.
PredictorBacktestExportJobSummary
predictorBacktestExportJobSummary_creationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime) Source #
When the predictor backtest export job was created.
predictorBacktestExportJobSummary_status :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
predictorBacktestExportJobSummary_destination :: Lens' PredictorBacktestExportJobSummary (Maybe DataDestination) Source #
Undocumented member.
predictorBacktestExportJobSummary_predictorBacktestExportJobArn :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the predictor backtest export job.
predictorBacktestExportJobSummary_message :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
Information about any errors that may have occurred during the backtest export.
predictorBacktestExportJobSummary_predictorBacktestExportJobName :: Lens' PredictorBacktestExportJobSummary (Maybe Text) Source #
The name of the predictor backtest export job.
predictorBacktestExportJobSummary_lastModificationTime :: Lens' PredictorBacktestExportJobSummary (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
PredictorExecution
predictorExecution_algorithmArn :: Lens' PredictorExecution (Maybe Text) Source #
The ARN of the algorithm used to test the predictor.
predictorExecution_testWindows :: Lens' PredictorExecution (Maybe [TestWindowSummary]) Source #
An array of test windows used to evaluate the algorithm. The
NumberOfBacktestWindows
from the object determines the number of
windows in the array.
PredictorExecutionDetails
predictorExecutionDetails_predictorExecutions :: Lens' PredictorExecutionDetails (Maybe (NonEmpty PredictorExecution)) Source #
An array of the backtests performed to evaluate the accuracy of the
predictor against a particular algorithm. The NumberOfBacktestWindows
from the object determines the number of windows in the array.
PredictorSummary
predictorSummary_creationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #
When the model training task was created.
predictorSummary_status :: Lens' PredictorSummary (Maybe Text) Source #
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
CREATE_STOPPING
,CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the
predictor to create a forecast.
predictorSummary_predictorArn :: Lens' PredictorSummary (Maybe Text) Source #
The ARN of the predictor.
predictorSummary_predictorName :: Lens' PredictorSummary (Maybe Text) Source #
The name of the predictor.
predictorSummary_datasetGroupArn :: Lens' PredictorSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
predictorSummary_message :: Lens' PredictorSummary (Maybe Text) Source #
If an error occurred, an informational message about the error.
predictorSummary_lastModificationTime :: Lens' PredictorSummary (Maybe UTCTime) Source #
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- TheCreationTime
.CREATE_IN_PROGRESS
- The current timestamp.CREATE_STOPPING
- The current timestamp.CREATE_STOPPED
- When the job stopped.ACTIVE
orCREATE_FAILED
- When the job finished or failed.
S3Config
s3Config_kmsKeyArn :: Lens' S3Config (Maybe Text) Source #
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
s3Config_path :: Lens' S3Config Text Source #
The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
s3Config_roleArn :: Lens' S3Config Text Source #
The ARN of the AWS Identity and Access Management (IAM) role that Amazon
Forecast can assume to access the Amazon S3 bucket or files. If you
provide a value for the KMSKeyArn
key, the role must allow access to
the key.
Passing a role across AWS accounts is not allowed. If you pass a role
that isn't in your account, you get an InvalidInputException
error.
Schema
schema_attributes :: Lens' Schema (Maybe (NonEmpty SchemaAttribute)) Source #
An array of attributes specifying the name and type of each field in a dataset.
SchemaAttribute
schemaAttribute_attributeType :: Lens' SchemaAttribute (Maybe AttributeType) Source #
The data type of the field.
schemaAttribute_attributeName :: Lens' SchemaAttribute (Maybe Text) Source #
The name of the dataset field.
Statistics
statistics_max :: Lens' Statistics (Maybe Text) Source #
For a numeric field, the maximum value in the field.
statistics_countNullLong :: Lens' Statistics (Maybe Integer) Source #
The number of null values in the field. CountNullLong
is used instead
of CountNull
if the value is greater than 2,147,483,647.
statistics_countNan :: Lens' Statistics (Maybe Int) Source #
The number of NAN (not a number) values in the field. If the response
value is -1, refer to CountNanLong
.
statistics_countNanLong :: Lens' Statistics (Maybe Integer) Source #
The number of NAN (not a number) values in the field. CountNanLong
is
used instead of CountNan
if the value is greater than 2,147,483,647.
statistics_avg :: Lens' Statistics (Maybe Double) Source #
For a numeric field, the average value in the field.
statistics_countNull :: Lens' Statistics (Maybe Int) Source #
The number of null values in the field. If the response value is -1,
refer to CountNullLong
.
statistics_count :: Lens' Statistics (Maybe Int) Source #
The number of values in the field. If the response value is -1, refer to
CountLong
.
statistics_countLong :: Lens' Statistics (Maybe Integer) Source #
The number of values in the field. CountLong
is used instead of
Count
if the value is greater than 2,147,483,647.
statistics_stddev :: Lens' Statistics (Maybe Double) Source #
For a numeric field, the standard deviation.
statistics_min :: Lens' Statistics (Maybe Text) Source #
For a numeric field, the minimum value in the field.
statistics_countDistinctLong :: Lens' Statistics (Maybe Integer) Source #
The number of distinct values in the field. CountDistinctLong
is used
instead of CountDistinct
if the value is greater than 2,147,483,647.
statistics_countDistinct :: Lens' Statistics (Maybe Int) Source #
The number of distinct values in the field. If the response value is -1,
refer to CountDistinctLong
.
SupplementaryFeature
supplementaryFeature_name :: Lens' SupplementaryFeature Text Source #
The name of the feature. Valid values: "holiday"
and "weather"
.
supplementaryFeature_value :: Lens' SupplementaryFeature Text Source #
Weather Index
To enable the Weather Index, set the value to "true"
Holidays
To enable Holidays, specify a country with one of the following two-letter country codes:
- "AL" - ALBANIA
- "AR" - ARGENTINA
- "AT" - AUSTRIA
- "AU" - AUSTRALIA
- "BA" - BOSNIA HERZEGOVINA
- "BE" - BELGIUM
- "BG" - BULGARIA
- "BO" - BOLIVIA
- "BR" - BRAZIL
- "BY" - BELARUS
- "CA" - CANADA
- "CL" - CHILE
- "CO" - COLOMBIA
- "CR" - COSTA RICA
- "HR" - CROATIA
- "CZ" - CZECH REPUBLIC
- "DK" - DENMARK
- "EC" - ECUADOR
- "EE" - ESTONIA
- "ET" - ETHIOPIA
- "FI" - FINLAND
- "FR" - FRANCE
- "DE" - GERMANY
- "GR" - GREECE
- "HU" - HUNGARY
- "IS" - ICELAND
- "IN" - INDIA
- "IE" - IRELAND
- "IT" - ITALY
- "JP" - JAPAN
- "KZ" - KAZAKHSTAN
- "KR" - KOREA
- "LV" - LATVIA
- "LI" - LIECHTENSTEIN
- "LT" - LITHUANIA
- "LU" - LUXEMBOURG
- "MK" - MACEDONIA
- "MT" - MALTA
- "MX" - MEXICO
- "MD" - MOLDOVA
- "ME" - MONTENEGRO
- "NL" - NETHERLANDS
- "NZ" - NEW ZEALAND
- "NI" - NICARAGUA
- "NG" - NIGERIA
- "NO" - NORWAY
- "PA" - PANAMA
- "PY" - PARAGUAY
- "PE" - PERU
- "PL" - POLAND
- "PT" - PORTUGAL
- "RO" - ROMANIA
- "RU" - RUSSIA
- "RS" - SERBIA
- "SK" - SLOVAKIA
- "SI" - SLOVENIA
- "ZA" - SOUTH AFRICA
- "ES" - SPAIN
- "SE" - SWEDEN
- "CH" - SWITZERLAND
- "UA" - UKRAINE
- "AE" - UNITED ARAB EMIRATES
- "US" - UNITED STATES
- "UK" - UNITED KINGDOM
- "UY" - URUGUAY
- "VE" - VENEZUELA
Tag
tag_key :: Lens' Tag Text Source #
One part of a key-value pair that makes up a tag. A key
is a general
label that acts like a category for more specific tag values.
tag_value :: Lens' Tag Text Source #
The optional part of a key-value pair that makes up a tag. A value
acts as a descriptor within a tag category (key).
TestWindowSummary
testWindowSummary_status :: Lens' TestWindowSummary (Maybe Text) Source #
The status of the test. Possible status values are:
ACTIVE
CREATE_IN_PROGRESS
CREATE_FAILED
testWindowSummary_testWindowEnd :: Lens' TestWindowSummary (Maybe UTCTime) Source #
The time at which the test ended.
testWindowSummary_testWindowStart :: Lens' TestWindowSummary (Maybe UTCTime) Source #
The time at which the test began.
testWindowSummary_message :: Lens' TestWindowSummary (Maybe Text) Source #
If the test failed, the reason why it failed.
WeightedQuantileLoss
weightedQuantileLoss_quantile :: Lens' WeightedQuantileLoss (Maybe Double) Source #
The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.
weightedQuantileLoss_lossValue :: Lens' WeightedQuantileLoss (Maybe Double) Source #
The difference between the predicted value and the actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.
WindowSummary
windowSummary_metrics :: Lens' WindowSummary (Maybe Metrics) Source #
Provides metrics used to evaluate the performance of a predictor.
windowSummary_testWindowEnd :: Lens' WindowSummary (Maybe UTCTime) Source #
The timestamp that defines the end of the window.
windowSummary_evaluationType :: Lens' WindowSummary (Maybe EvaluationType) Source #
The type of evaluation.
SUMMARY
- The average metrics across all windows.COMPUTED
- The metrics for the specified window.
windowSummary_testWindowStart :: Lens' WindowSummary (Maybe UTCTime) Source #
The timestamp that defines the start of the window.
windowSummary_itemCount :: Lens' WindowSummary (Maybe Int) Source #
The number of data points within the window.