ForecastService module#
Index > ForecastService
Auto-generated documentation for ForecastService type annotations stubs module mypy-boto3-forecast.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
ForecastService
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ForecastService
.
From PyPI with pip#
Install boto3-stubs
for ForecastService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[forecast]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[forecast]'
# standalone installation
python -m pip install mypy-boto3-forecast
How to uninstall#
python -m pip uninstall -y mypy-boto3-forecast
Usage#
Code samples can be found in Examples.
ForecastServiceClient#
Type annotations and code completion for boto3.client("forecast")
as ForecastServiceClient
boto3 documentation
# ForecastServiceClient usage example
from boto3.session import Session
from mypy_boto3_forecast.client import ForecastServiceClient
def get_client() -> ForecastServiceClient:
return Session().client("forecast")
Paginators#
Type annotations and code completion for paginators
from boto3.client("forecast").get_paginator("...")
.
# ListDatasetGroupsPaginator usage example
from boto3.session import Session
from mypy_boto3_forecast.paginator import ListDatasetGroupsPaginator
def get_list_dataset_groups_paginator() -> ListDatasetGroupsPaginator:
return Session().client("forecast").get_paginator("list_dataset_groups"))
- ListDatasetGroupsPaginator
- ListDatasetImportJobsPaginator
- ListDatasetsPaginator
- ListExplainabilitiesPaginator
- ListExplainabilityExportsPaginator
- ListForecastExportJobsPaginator
- ListForecastsPaginator
- ListMonitorEvaluationsPaginator
- ListMonitorsPaginator
- ListPredictorBacktestExportJobsPaginator
- ListPredictorsPaginator
- ListWhatIfAnalysesPaginator
- ListWhatIfForecastExportsPaginator
- ListWhatIfForecastsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AttributeTypeType usage example
from mypy_boto3_forecast.literals import AttributeTypeType
def get_value() -> AttributeTypeType:
return "float"
- AttributeTypeType
- AutoMLOverrideStrategyType
- ConditionType
- DatasetTypeType
- DayOfWeekType
- DomainType
- EvaluationTypeType
- FeaturizationMethodNameType
- FilterConditionStringType
- ImportModeType
- ListDatasetGroupsPaginatorName
- ListDatasetImportJobsPaginatorName
- ListDatasetsPaginatorName
- ListExplainabilitiesPaginatorName
- ListExplainabilityExportsPaginatorName
- ListForecastExportJobsPaginatorName
- ListForecastsPaginatorName
- ListMonitorEvaluationsPaginatorName
- ListMonitorsPaginatorName
- ListPredictorBacktestExportJobsPaginatorName
- ListPredictorsPaginatorName
- ListWhatIfAnalysesPaginatorName
- ListWhatIfForecastExportsPaginatorName
- ListWhatIfForecastsPaginatorName
- MonthType
- OperationType
- OptimizationMetricType
- ScalingTypeType
- StateType
- TimePointGranularityType
- TimeSeriesGranularityType
- ForecastServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ActionTypeDef
- AdditionalDatasetOutputTypeDef
- AdditionalDatasetTypeDef
- AttributeConfigOutputTypeDef
- AttributeConfigTypeDef
- BaselineMetricTypeDef
- CategoricalParameterRangeOutputTypeDef
- CategoricalParameterRangeTypeDef
- ContinuousParameterRangeTypeDef
- EncryptionConfigTypeDef
- MonitorConfigTypeDef
- TagTypeDef
- TimeAlignmentBoundaryTypeDef
- ResponseMetadataTypeDef
- ExplainabilityConfigTypeDef
- EvaluationParametersTypeDef
- S3ConfigTypeDef
- DatasetGroupSummaryTypeDef
- DatasetSummaryTypeDef
- DeleteDatasetGroupRequestRequestTypeDef
- DeleteDatasetImportJobRequestRequestTypeDef
- DeleteDatasetRequestRequestTypeDef
- DeleteExplainabilityExportRequestRequestTypeDef
- DeleteExplainabilityRequestRequestTypeDef
- DeleteForecastExportJobRequestRequestTypeDef
- DeleteForecastRequestRequestTypeDef
- DeleteMonitorRequestRequestTypeDef
- DeletePredictorBacktestExportJobRequestRequestTypeDef
- DeletePredictorRequestRequestTypeDef
- DeleteResourceTreeRequestRequestTypeDef
- DeleteWhatIfAnalysisRequestRequestTypeDef
- DeleteWhatIfForecastExportRequestRequestTypeDef
- DeleteWhatIfForecastRequestRequestTypeDef
- DescribeAutoPredictorRequestRequestTypeDef
- ExplainabilityInfoTypeDef
- MonitorInfoTypeDef
- ReferencePredictorSummaryTypeDef
- DescribeDatasetGroupRequestRequestTypeDef
- DescribeDatasetImportJobRequestRequestTypeDef
- StatisticsTypeDef
- DescribeDatasetRequestRequestTypeDef
- DescribeExplainabilityExportRequestRequestTypeDef
- DescribeExplainabilityRequestRequestTypeDef
- DescribeForecastExportJobRequestRequestTypeDef
- DescribeForecastRequestRequestTypeDef
- DescribeMonitorRequestRequestTypeDef
- DescribePredictorBacktestExportJobRequestRequestTypeDef
- DescribePredictorRequestRequestTypeDef
- DescribeWhatIfAnalysisRequestRequestTypeDef
- DescribeWhatIfForecastExportRequestRequestTypeDef
- DescribeWhatIfForecastRequestRequestTypeDef
- ErrorMetricTypeDef
- FeaturizationMethodOutputTypeDef
- FeaturizationMethodTypeDef
- FilterTypeDef
- ForecastSummaryTypeDef
- GetAccuracyMetricsRequestRequestTypeDef
- SupplementaryFeatureTypeDef
- IntegerParameterRangeTypeDef
- PaginatorConfigTypeDef
- ListDatasetGroupsRequestRequestTypeDef
- ListDatasetsRequestRequestTypeDef
- MonitorSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- WhatIfAnalysisSummaryTypeDef
- WhatIfForecastSummaryTypeDef
- MetricResultTypeDef
- WeightedQuantileLossTypeDef
- MonitorDataSourceTypeDef
- PredictorEventTypeDef
- TestWindowSummaryTypeDef
- ResumeResourceRequestRequestTypeDef
- SchemaAttributeTypeDef
- StopResourceRequestRequestTypeDef
- TimeSeriesConditionTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateDatasetGroupRequestRequestTypeDef
- AdditionalDatasetUnionTypeDef
- DataConfigOutputTypeDef
- AttributeConfigUnionTypeDef
- PredictorBaselineTypeDef
- CategoricalParameterRangeUnionTypeDef
- CreateDatasetGroupRequestRequestTypeDef
- CreateMonitorRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- CreateAutoPredictorResponseTypeDef
- CreateDatasetGroupResponseTypeDef
- CreateDatasetImportJobResponseTypeDef
- CreateDatasetResponseTypeDef
- CreateExplainabilityExportResponseTypeDef
- CreateExplainabilityResponseTypeDef
- CreateForecastExportJobResponseTypeDef
- CreateForecastResponseTypeDef
- CreateMonitorResponseTypeDef
- CreatePredictorBacktestExportJobResponseTypeDef
- CreatePredictorResponseTypeDef
- CreateWhatIfAnalysisResponseTypeDef
- CreateWhatIfForecastExportResponseTypeDef
- CreateWhatIfForecastResponseTypeDef
- DescribeDatasetGroupResponseTypeDef
- EmptyResponseMetadataTypeDef
- ListTagsForResourceResponseTypeDef
- ExplainabilitySummaryTypeDef
- DataDestinationTypeDef
- DataSourceTypeDef
- ListDatasetGroupsResponseTypeDef
- ListDatasetsResponseTypeDef
- PredictorSummaryTypeDef
- FeaturizationOutputTypeDef
- FeaturizationMethodUnionTypeDef
- ListDatasetImportJobsRequestRequestTypeDef
- ListExplainabilitiesRequestRequestTypeDef
- ListExplainabilityExportsRequestRequestTypeDef
- ListForecastExportJobsRequestRequestTypeDef
- ListForecastsRequestRequestTypeDef
- ListMonitorEvaluationsRequestRequestTypeDef
- ListMonitorsRequestRequestTypeDef
- ListPredictorBacktestExportJobsRequestRequestTypeDef
- ListPredictorsRequestRequestTypeDef
- ListWhatIfAnalysesRequestRequestTypeDef
- ListWhatIfForecastExportsRequestRequestTypeDef
- ListWhatIfForecastsRequestRequestTypeDef
- ListForecastsResponseTypeDef
- InputDataConfigOutputTypeDef
- InputDataConfigTypeDef
- ParameterRangesOutputTypeDef
- ListDatasetGroupsRequestPaginateTypeDef
- ListDatasetImportJobsRequestPaginateTypeDef
- ListDatasetsRequestPaginateTypeDef
- ListExplainabilitiesRequestPaginateTypeDef
- ListExplainabilityExportsRequestPaginateTypeDef
- ListForecastExportJobsRequestPaginateTypeDef
- ListForecastsRequestPaginateTypeDef
- ListMonitorEvaluationsRequestPaginateTypeDef
- ListMonitorsRequestPaginateTypeDef
- ListPredictorBacktestExportJobsRequestPaginateTypeDef
- ListPredictorsRequestPaginateTypeDef
- ListWhatIfAnalysesRequestPaginateTypeDef
- ListWhatIfForecastExportsRequestPaginateTypeDef
- ListWhatIfForecastsRequestPaginateTypeDef
- ListMonitorsResponseTypeDef
- ListWhatIfAnalysesResponseTypeDef
- ListWhatIfForecastsResponseTypeDef
- MetricsTypeDef
- PredictorMonitorEvaluationTypeDef
- PredictorExecutionTypeDef
- SchemaOutputTypeDef
- SchemaTypeDef
- TimeSeriesTransformationOutputTypeDef
- TimeSeriesTransformationTypeDef
- DescribeAutoPredictorResponseTypeDef
- DataConfigTypeDef
- BaselineTypeDef
- ParameterRangesTypeDef
- ListExplainabilitiesResponseTypeDef
- CreateExplainabilityExportRequestRequestTypeDef
- CreateForecastExportJobRequestRequestTypeDef
- CreatePredictorBacktestExportJobRequestRequestTypeDef
- CreateWhatIfForecastExportRequestRequestTypeDef
- DescribeExplainabilityExportResponseTypeDef
- DescribeForecastExportJobResponseTypeDef
- DescribePredictorBacktestExportJobResponseTypeDef
- DescribeWhatIfForecastExportResponseTypeDef
- ExplainabilityExportSummaryTypeDef
- ForecastExportJobSummaryTypeDef
- PredictorBacktestExportJobSummaryTypeDef
- WhatIfForecastExportSummaryTypeDef
- CreateDatasetImportJobRequestRequestTypeDef
- DatasetImportJobSummaryTypeDef
- DescribeDatasetImportJobResponseTypeDef
- ListPredictorsResponseTypeDef
- FeaturizationConfigOutputTypeDef
- FeaturizationTypeDef
- HyperParameterTuningJobConfigOutputTypeDef
- WindowSummaryTypeDef
- ListMonitorEvaluationsResponseTypeDef
- PredictorExecutionDetailsTypeDef
- DescribeDatasetResponseTypeDef
- DescribeExplainabilityResponseTypeDef
- TimeSeriesIdentifiersOutputTypeDef
- TimeSeriesReplacementsDataSourceOutputTypeDef
- CreateDatasetRequestRequestTypeDef
- CreateExplainabilityRequestRequestTypeDef
- SchemaUnionTypeDef
- TimeSeriesTransformationUnionTypeDef
- CreateAutoPredictorRequestRequestTypeDef
- DescribeMonitorResponseTypeDef
- ParameterRangesUnionTypeDef
- ListExplainabilityExportsResponseTypeDef
- ListForecastExportJobsResponseTypeDef
- ListPredictorBacktestExportJobsResponseTypeDef
- ListWhatIfForecastExportsResponseTypeDef
- ListDatasetImportJobsResponseTypeDef
- FeaturizationUnionTypeDef
- EvaluationResultTypeDef
- DescribePredictorResponseTypeDef
- TimeSeriesSelectorOutputTypeDef
- DescribeWhatIfForecastResponseTypeDef
- TimeSeriesIdentifiersTypeDef
- TimeSeriesReplacementsDataSourceTypeDef
- HyperParameterTuningJobConfigTypeDef
- FeaturizationConfigTypeDef
- GetAccuracyMetricsResponseTypeDef
- DescribeForecastResponseTypeDef
- DescribeWhatIfAnalysisResponseTypeDef
- TimeSeriesIdentifiersUnionTypeDef
- CreateWhatIfForecastRequestRequestTypeDef
- CreatePredictorRequestRequestTypeDef
- TimeSeriesSelectorTypeDef
- CreateForecastRequestRequestTypeDef
- CreateWhatIfAnalysisRequestRequestTypeDef