ForecastServiceClient
Index > ForecastService > ForecastServiceClient
Auto-generated documentation for ForecastService type annotations stubs module mypy-boto3-forecast.
ForecastServiceClient
Type annotations and code completion for boto3.client("forecast")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_forecast.client import ForecastServiceClient
def get_forecast_client() -> ForecastServiceClient:
return Session().client("forecast")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("forecast").exceptions
structure.
client = boto3.client("forecast")
try:
do_something(client)
except (
client.ClientError,
client.InvalidInputException,
client.InvalidNextTokenException,
client.LimitExceededException,
client.ResourceAlreadyExistsException,
client.ResourceInUseException,
client.ResourceNotFoundException,
) as e:
print(e)
from mypy_boto3_forecast.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("forecast").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("forecast").close
method.
boto3 documentation
create_auto_predictor
Creates an Amazon Forecast predictor.
Type annotations and code completion for boto3.client("forecast").create_auto_predictor
method.
boto3 documentation
def create_auto_predictor(
self,
*,
PredictorName: str,
ForecastHorizon: int = ...,
ForecastTypes: Sequence[str] = ...,
ForecastDimensions: Sequence[str] = ...,
ForecastFrequency: str = ...,
DataConfig: DataConfigTypeDef = ..., # (1)
EncryptionConfig: EncryptionConfigTypeDef = ..., # (2)
ReferencePredictorArn: str = ...,
OptimizationMetric: OptimizationMetricType = ..., # (3)
ExplainPredictor: bool = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
MonitorConfig: MonitorConfigTypeDef = ..., # (5)
TimeAlignmentBoundary: TimeAlignmentBoundaryTypeDef = ..., # (6)
) -> CreateAutoPredictorResponseTypeDef: # (7)
...
- See DataConfigTypeDef
- See EncryptionConfigTypeDef
- See OptimizationMetricType
- See TagTypeDef
- See MonitorConfigTypeDef
- See TimeAlignmentBoundaryTypeDef
- See CreateAutoPredictorResponseTypeDef
kwargs: CreateAutoPredictorRequestRequestTypeDef = { # (1)
"PredictorName": ...,
}
parent.create_auto_predictor(**kwargs)
create_dataset
Creates an Amazon Forecast dataset.
Type annotations and code completion for boto3.client("forecast").create_dataset
method.
boto3 documentation
def create_dataset(
self,
*,
DatasetName: str,
Domain: DomainType, # (1)
DatasetType: DatasetTypeType, # (2)
Schema: SchemaTypeDef, # (3)
DataFrequency: str = ...,
EncryptionConfig: EncryptionConfigTypeDef = ..., # (4)
Tags: Sequence[TagTypeDef] = ..., # (5)
) -> CreateDatasetResponseTypeDef: # (6)
...
- See DomainType
- See DatasetTypeType
- See SchemaTypeDef
- See EncryptionConfigTypeDef
- See TagTypeDef
- See CreateDatasetResponseTypeDef
kwargs: CreateDatasetRequestRequestTypeDef = { # (1)
"DatasetName": ...,
"Domain": ...,
"DatasetType": ...,
"Schema": ...,
}
parent.create_dataset(**kwargs)
create_dataset_group
Creates a dataset group, which holds a collection of related datasets.
Type annotations and code completion for boto3.client("forecast").create_dataset_group
method.
boto3 documentation
def create_dataset_group(
self,
*,
DatasetGroupName: str,
Domain: DomainType, # (1)
DatasetArns: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDatasetGroupResponseTypeDef: # (3)
...
- See DomainType
- See TagTypeDef
- See CreateDatasetGroupResponseTypeDef
kwargs: CreateDatasetGroupRequestRequestTypeDef = { # (1)
"DatasetGroupName": ...,
"Domain": ...,
}
parent.create_dataset_group(**kwargs)
create_dataset_import_job
Imports your training data to an Amazon Forecast dataset.
Type annotations and code completion for boto3.client("forecast").create_dataset_import_job
method.
boto3 documentation
def create_dataset_import_job(
self,
*,
DatasetImportJobName: str,
DatasetArn: str,
DataSource: DataSourceTypeDef, # (1)
TimestampFormat: str = ...,
TimeZone: str = ...,
UseGeolocationForTimeZone: bool = ...,
GeolocationFormat: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
Format: str = ...,
ImportMode: ImportModeType = ..., # (3)
) -> CreateDatasetImportJobResponseTypeDef: # (4)
...
kwargs: CreateDatasetImportJobRequestRequestTypeDef = { # (1)
"DatasetImportJobName": ...,
"DatasetArn": ...,
"DataSource": ...,
}
parent.create_dataset_import_job(**kwargs)
create_explainability
.
Type annotations and code completion for boto3.client("forecast").create_explainability
method.
boto3 documentation
def create_explainability(
self,
*,
ExplainabilityName: str,
ResourceArn: str,
ExplainabilityConfig: ExplainabilityConfigTypeDef, # (1)
DataSource: DataSourceTypeDef = ..., # (2)
Schema: SchemaTypeDef = ..., # (3)
EnableVisualization: bool = ...,
StartDateTime: str = ...,
EndDateTime: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> CreateExplainabilityResponseTypeDef: # (5)
...
- See ExplainabilityConfigTypeDef
- See DataSourceTypeDef
- See SchemaTypeDef
- See TagTypeDef
- See CreateExplainabilityResponseTypeDef
kwargs: CreateExplainabilityRequestRequestTypeDef = { # (1)
"ExplainabilityName": ...,
"ResourceArn": ...,
"ExplainabilityConfig": ...,
}
parent.create_explainability(**kwargs)
create_explainability_export
Exports an Explainability resource created by the CreateExplainability operation.
Type annotations and code completion for boto3.client("forecast").create_explainability_export
method.
boto3 documentation
def create_explainability_export(
self,
*,
ExplainabilityExportName: str,
ExplainabilityArn: str,
Destination: DataDestinationTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
Format: str = ...,
) -> CreateExplainabilityExportResponseTypeDef: # (3)
...
kwargs: CreateExplainabilityExportRequestRequestTypeDef = { # (1)
"ExplainabilityExportName": ...,
"ExplainabilityArn": ...,
"Destination": ...,
}
parent.create_explainability_export(**kwargs)
create_forecast
Creates a forecast for each item in the TARGET_TIME_SERIES
dataset that was
used to train the predictor.
Type annotations and code completion for boto3.client("forecast").create_forecast
method.
boto3 documentation
def create_forecast(
self,
*,
ForecastName: str,
PredictorArn: str,
ForecastTypes: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
TimeSeriesSelector: TimeSeriesSelectorTypeDef = ..., # (2)
) -> CreateForecastResponseTypeDef: # (3)
...
kwargs: CreateForecastRequestRequestTypeDef = { # (1)
"ForecastName": ...,
"PredictorArn": ...,
}
parent.create_forecast(**kwargs)
create_forecast_export_job
Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.
Type annotations and code completion for boto3.client("forecast").create_forecast_export_job
method.
boto3 documentation
def create_forecast_export_job(
self,
*,
ForecastExportJobName: str,
ForecastArn: str,
Destination: DataDestinationTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
Format: str = ...,
) -> CreateForecastExportJobResponseTypeDef: # (3)
...
kwargs: CreateForecastExportJobRequestRequestTypeDef = { # (1)
"ForecastExportJobName": ...,
"ForecastArn": ...,
"Destination": ...,
}
parent.create_forecast_export_job(**kwargs)
create_monitor
Creates a predictor monitor resource for an existing auto predictor.
Type annotations and code completion for boto3.client("forecast").create_monitor
method.
boto3 documentation
def create_monitor(
self,
*,
MonitorName: str,
ResourceArn: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateMonitorResponseTypeDef: # (2)
...
kwargs: CreateMonitorRequestRequestTypeDef = { # (1)
"MonitorName": ...,
"ResourceArn": ...,
}
parent.create_monitor(**kwargs)
create_predictor
.
Type annotations and code completion for boto3.client("forecast").create_predictor
method.
boto3 documentation
def create_predictor(
self,
*,
PredictorName: str,
ForecastHorizon: int,
InputDataConfig: InputDataConfigTypeDef, # (1)
FeaturizationConfig: FeaturizationConfigTypeDef, # (2)
AlgorithmArn: str = ...,
ForecastTypes: Sequence[str] = ...,
PerformAutoML: bool = ...,
AutoMLOverrideStrategy: AutoMLOverrideStrategyType = ..., # (3)
PerformHPO: bool = ...,
TrainingParameters: Mapping[str, str] = ...,
EvaluationParameters: EvaluationParametersTypeDef = ..., # (4)
HPOConfig: HyperParameterTuningJobConfigTypeDef = ..., # (5)
EncryptionConfig: EncryptionConfigTypeDef = ..., # (6)
Tags: Sequence[TagTypeDef] = ..., # (7)
OptimizationMetric: OptimizationMetricType = ..., # (8)
) -> CreatePredictorResponseTypeDef: # (9)
...
- See InputDataConfigTypeDef
- See FeaturizationConfigTypeDef
- See AutoMLOverrideStrategyType
- See EvaluationParametersTypeDef
- See HyperParameterTuningJobConfigTypeDef
- See EncryptionConfigTypeDef
- See TagTypeDef
- See OptimizationMetricType
- See CreatePredictorResponseTypeDef
kwargs: CreatePredictorRequestRequestTypeDef = { # (1)
"PredictorName": ...,
"ForecastHorizon": ...,
"InputDataConfig": ...,
"FeaturizationConfig": ...,
}
parent.create_predictor(**kwargs)
create_predictor_backtest_export_job
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations.
Type annotations and code completion for boto3.client("forecast").create_predictor_backtest_export_job
method.
boto3 documentation
def create_predictor_backtest_export_job(
self,
*,
PredictorBacktestExportJobName: str,
PredictorArn: str,
Destination: DataDestinationTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
Format: str = ...,
) -> CreatePredictorBacktestExportJobResponseTypeDef: # (3)
...
kwargs: CreatePredictorBacktestExportJobRequestRequestTypeDef = { # (1)
"PredictorBacktestExportJobName": ...,
"PredictorArn": ...,
"Destination": ...,
}
parent.create_predictor_backtest_export_job(**kwargs)
create_what_if_analysis
What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series.
Type annotations and code completion for boto3.client("forecast").create_what_if_analysis
method.
boto3 documentation
def create_what_if_analysis(
self,
*,
WhatIfAnalysisName: str,
ForecastArn: str,
TimeSeriesSelector: TimeSeriesSelectorTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateWhatIfAnalysisResponseTypeDef: # (3)
...
kwargs: CreateWhatIfAnalysisRequestRequestTypeDef = { # (1)
"WhatIfAnalysisName": ...,
"ForecastArn": ...,
}
parent.create_what_if_analysis(**kwargs)
create_what_if_forecast
A what-if forecast is a forecast that is created from a modified version of the baseline forecast.
Type annotations and code completion for boto3.client("forecast").create_what_if_forecast
method.
boto3 documentation
def create_what_if_forecast(
self,
*,
WhatIfForecastName: str,
WhatIfAnalysisArn: str,
TimeSeriesTransformations: Sequence[TimeSeriesTransformationTypeDef] = ..., # (1)
TimeSeriesReplacementsDataSource: TimeSeriesReplacementsDataSourceTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateWhatIfForecastResponseTypeDef: # (4)
...
- See TimeSeriesTransformationTypeDef
- See TimeSeriesReplacementsDataSourceTypeDef
- See TagTypeDef
- See CreateWhatIfForecastResponseTypeDef
kwargs: CreateWhatIfForecastRequestRequestTypeDef = { # (1)
"WhatIfForecastName": ...,
"WhatIfAnalysisArn": ...,
}
parent.create_what_if_forecast(**kwargs)
create_what_if_forecast_export
Exports a forecast created by the CreateWhatIfForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.
Type annotations and code completion for boto3.client("forecast").create_what_if_forecast_export
method.
boto3 documentation
def create_what_if_forecast_export(
self,
*,
WhatIfForecastExportName: str,
WhatIfForecastArns: Sequence[str],
Destination: DataDestinationTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
Format: str = ...,
) -> CreateWhatIfForecastExportResponseTypeDef: # (3)
...
kwargs: CreateWhatIfForecastExportRequestRequestTypeDef = { # (1)
"WhatIfForecastExportName": ...,
"WhatIfForecastArns": ...,
"Destination": ...,
}
parent.create_what_if_forecast_export(**kwargs)
delete_dataset
Deletes an Amazon Forecast dataset that was created using the CreateDataset_ operation.
Type annotations and code completion for boto3.client("forecast").delete_dataset
method.
boto3 documentation
def delete_dataset(
self,
*,
DatasetArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDatasetRequestRequestTypeDef = { # (1)
"DatasetArn": ...,
}
parent.delete_dataset(**kwargs)
delete_dataset_group
Deletes a dataset group created using the CreateDatasetGroup_ operation.
Type annotations and code completion for boto3.client("forecast").delete_dataset_group
method.
boto3 documentation
def delete_dataset_group(
self,
*,
DatasetGroupArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDatasetGroupRequestRequestTypeDef = { # (1)
"DatasetGroupArn": ...,
}
parent.delete_dataset_group(**kwargs)
delete_dataset_import_job
Deletes a dataset import job created using the CreateDatasetImportJob_ operation.
Type annotations and code completion for boto3.client("forecast").delete_dataset_import_job
method.
boto3 documentation
def delete_dataset_import_job(
self,
*,
DatasetImportJobArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDatasetImportJobRequestRequestTypeDef = { # (1)
"DatasetImportJobArn": ...,
}
parent.delete_dataset_import_job(**kwargs)
delete_explainability
Deletes an Explainability resource.
Type annotations and code completion for boto3.client("forecast").delete_explainability
method.
boto3 documentation
def delete_explainability(
self,
*,
ExplainabilityArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteExplainabilityRequestRequestTypeDef = { # (1)
"ExplainabilityArn": ...,
}
parent.delete_explainability(**kwargs)
delete_explainability_export
Deletes an Explainability export.
Type annotations and code completion for boto3.client("forecast").delete_explainability_export
method.
boto3 documentation
def delete_explainability_export(
self,
*,
ExplainabilityExportArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteExplainabilityExportRequestRequestTypeDef = { # (1)
"ExplainabilityExportArn": ...,
}
parent.delete_explainability_export(**kwargs)
delete_forecast
Deletes a forecast created using the CreateForecast operation.
Type annotations and code completion for boto3.client("forecast").delete_forecast
method.
boto3 documentation
def delete_forecast(
self,
*,
ForecastArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteForecastRequestRequestTypeDef = { # (1)
"ForecastArn": ...,
}
parent.delete_forecast(**kwargs)
delete_forecast_export_job
Deletes a forecast export job created using the CreateForecastExportJob operation.
Type annotations and code completion for boto3.client("forecast").delete_forecast_export_job
method.
boto3 documentation
def delete_forecast_export_job(
self,
*,
ForecastExportJobArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteForecastExportJobRequestRequestTypeDef = { # (1)
"ForecastExportJobArn": ...,
}
parent.delete_forecast_export_job(**kwargs)
delete_monitor
Deletes a monitor resource.
Type annotations and code completion for boto3.client("forecast").delete_monitor
method.
boto3 documentation
def delete_monitor(
self,
*,
MonitorArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteMonitorRequestRequestTypeDef = { # (1)
"MonitorArn": ...,
}
parent.delete_monitor(**kwargs)
delete_predictor
Deletes a predictor created using the DescribePredictor or CreatePredictor operations.
Type annotations and code completion for boto3.client("forecast").delete_predictor
method.
boto3 documentation
def delete_predictor(
self,
*,
PredictorArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePredictorRequestRequestTypeDef = { # (1)
"PredictorArn": ...,
}
parent.delete_predictor(**kwargs)
delete_predictor_backtest_export_job
Deletes a predictor backtest export job.
Type annotations and code completion for boto3.client("forecast").delete_predictor_backtest_export_job
method.
boto3 documentation
def delete_predictor_backtest_export_job(
self,
*,
PredictorBacktestExportJobArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePredictorBacktestExportJobRequestRequestTypeDef = { # (1)
"PredictorBacktestExportJobArn": ...,
}
parent.delete_predictor_backtest_export_job(**kwargs)
delete_resource_tree
Deletes an entire resource tree.
Type annotations and code completion for boto3.client("forecast").delete_resource_tree
method.
boto3 documentation
def delete_resource_tree(
self,
*,
ResourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteResourceTreeRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.delete_resource_tree(**kwargs)
delete_what_if_analysis
Deletes a what-if analysis created using the CreateWhatIfAnalysis operation.
Type annotations and code completion for boto3.client("forecast").delete_what_if_analysis
method.
boto3 documentation
def delete_what_if_analysis(
self,
*,
WhatIfAnalysisArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteWhatIfAnalysisRequestRequestTypeDef = { # (1)
"WhatIfAnalysisArn": ...,
}
parent.delete_what_if_analysis(**kwargs)
delete_what_if_forecast
Deletes a what-if forecast created using the CreateWhatIfForecast operation.
Type annotations and code completion for boto3.client("forecast").delete_what_if_forecast
method.
boto3 documentation
def delete_what_if_forecast(
self,
*,
WhatIfForecastArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteWhatIfForecastRequestRequestTypeDef = { # (1)
"WhatIfForecastArn": ...,
}
parent.delete_what_if_forecast(**kwargs)
delete_what_if_forecast_export
Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation.
Type annotations and code completion for boto3.client("forecast").delete_what_if_forecast_export
method.
boto3 documentation
def delete_what_if_forecast_export(
self,
*,
WhatIfForecastExportArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteWhatIfForecastExportRequestRequestTypeDef = { # (1)
"WhatIfForecastExportArn": ...,
}
parent.delete_what_if_forecast_export(**kwargs)
describe_auto_predictor
Describes a predictor created using the CreateAutoPredictor operation.
Type annotations and code completion for boto3.client("forecast").describe_auto_predictor
method.
boto3 documentation
def describe_auto_predictor(
self,
*,
PredictorArn: str,
) -> DescribeAutoPredictorResponseTypeDef: # (1)
...
kwargs: DescribeAutoPredictorRequestRequestTypeDef = { # (1)
"PredictorArn": ...,
}
parent.describe_auto_predictor(**kwargs)
describe_dataset
Describes an Amazon Forecast dataset created using the CreateDataset_ operation.
Type annotations and code completion for boto3.client("forecast").describe_dataset
method.
boto3 documentation
def describe_dataset(
self,
*,
DatasetArn: str,
) -> DescribeDatasetResponseTypeDef: # (1)
...
kwargs: DescribeDatasetRequestRequestTypeDef = { # (1)
"DatasetArn": ...,
}
parent.describe_dataset(**kwargs)
describe_dataset_group
Describes a dataset group created using the CreateDatasetGroup_ operation.
Type annotations and code completion for boto3.client("forecast").describe_dataset_group
method.
boto3 documentation
def describe_dataset_group(
self,
*,
DatasetGroupArn: str,
) -> DescribeDatasetGroupResponseTypeDef: # (1)
...
kwargs: DescribeDatasetGroupRequestRequestTypeDef = { # (1)
"DatasetGroupArn": ...,
}
parent.describe_dataset_group(**kwargs)
describe_dataset_import_job
Describes a dataset import job created using the CreateDatasetImportJob_ operation.
Type annotations and code completion for boto3.client("forecast").describe_dataset_import_job
method.
boto3 documentation
def describe_dataset_import_job(
self,
*,
DatasetImportJobArn: str,
) -> DescribeDatasetImportJobResponseTypeDef: # (1)
...
kwargs: DescribeDatasetImportJobRequestRequestTypeDef = { # (1)
"DatasetImportJobArn": ...,
}
parent.describe_dataset_import_job(**kwargs)
describe_explainability
Describes an Explainability resource created using the CreateExplainability operation.
Type annotations and code completion for boto3.client("forecast").describe_explainability
method.
boto3 documentation
def describe_explainability(
self,
*,
ExplainabilityArn: str,
) -> DescribeExplainabilityResponseTypeDef: # (1)
...
kwargs: DescribeExplainabilityRequestRequestTypeDef = { # (1)
"ExplainabilityArn": ...,
}
parent.describe_explainability(**kwargs)
describe_explainability_export
Describes an Explainability export created using the CreateExplainabilityExport operation.
Type annotations and code completion for boto3.client("forecast").describe_explainability_export
method.
boto3 documentation
def describe_explainability_export(
self,
*,
ExplainabilityExportArn: str,
) -> DescribeExplainabilityExportResponseTypeDef: # (1)
...
kwargs: DescribeExplainabilityExportRequestRequestTypeDef = { # (1)
"ExplainabilityExportArn": ...,
}
parent.describe_explainability_export(**kwargs)
describe_forecast
Describes a forecast created using the CreateForecast operation.
Type annotations and code completion for boto3.client("forecast").describe_forecast
method.
boto3 documentation
def describe_forecast(
self,
*,
ForecastArn: str,
) -> DescribeForecastResponseTypeDef: # (1)
...
kwargs: DescribeForecastRequestRequestTypeDef = { # (1)
"ForecastArn": ...,
}
parent.describe_forecast(**kwargs)
describe_forecast_export_job
Describes a forecast export job created using the CreateForecastExportJob operation.
Type annotations and code completion for boto3.client("forecast").describe_forecast_export_job
method.
boto3 documentation
def describe_forecast_export_job(
self,
*,
ForecastExportJobArn: str,
) -> DescribeForecastExportJobResponseTypeDef: # (1)
...
kwargs: DescribeForecastExportJobRequestRequestTypeDef = { # (1)
"ForecastExportJobArn": ...,
}
parent.describe_forecast_export_job(**kwargs)
describe_monitor
Describes a monitor resource.
Type annotations and code completion for boto3.client("forecast").describe_monitor
method.
boto3 documentation
def describe_monitor(
self,
*,
MonitorArn: str,
) -> DescribeMonitorResponseTypeDef: # (1)
...
kwargs: DescribeMonitorRequestRequestTypeDef = { # (1)
"MonitorArn": ...,
}
parent.describe_monitor(**kwargs)
describe_predictor
.
Type annotations and code completion for boto3.client("forecast").describe_predictor
method.
boto3 documentation
def describe_predictor(
self,
*,
PredictorArn: str,
) -> DescribePredictorResponseTypeDef: # (1)
...
kwargs: DescribePredictorRequestRequestTypeDef = { # (1)
"PredictorArn": ...,
}
parent.describe_predictor(**kwargs)
describe_predictor_backtest_export_job
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
Type annotations and code completion for boto3.client("forecast").describe_predictor_backtest_export_job
method.
boto3 documentation
def describe_predictor_backtest_export_job(
self,
*,
PredictorBacktestExportJobArn: str,
) -> DescribePredictorBacktestExportJobResponseTypeDef: # (1)
...
kwargs: DescribePredictorBacktestExportJobRequestRequestTypeDef = { # (1)
"PredictorBacktestExportJobArn": ...,
}
parent.describe_predictor_backtest_export_job(**kwargs)
describe_what_if_analysis
Describes the what-if analysis created using the CreateWhatIfAnalysis operation.
Type annotations and code completion for boto3.client("forecast").describe_what_if_analysis
method.
boto3 documentation
def describe_what_if_analysis(
self,
*,
WhatIfAnalysisArn: str,
) -> DescribeWhatIfAnalysisResponseTypeDef: # (1)
...
kwargs: DescribeWhatIfAnalysisRequestRequestTypeDef = { # (1)
"WhatIfAnalysisArn": ...,
}
parent.describe_what_if_analysis(**kwargs)
describe_what_if_forecast
Describes the what-if forecast created using the CreateWhatIfForecast operation.
Type annotations and code completion for boto3.client("forecast").describe_what_if_forecast
method.
boto3 documentation
def describe_what_if_forecast(
self,
*,
WhatIfForecastArn: str,
) -> DescribeWhatIfForecastResponseTypeDef: # (1)
...
kwargs: DescribeWhatIfForecastRequestRequestTypeDef = { # (1)
"WhatIfForecastArn": ...,
}
parent.describe_what_if_forecast(**kwargs)
describe_what_if_forecast_export
Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.
Type annotations and code completion for boto3.client("forecast").describe_what_if_forecast_export
method.
boto3 documentation
def describe_what_if_forecast_export(
self,
*,
WhatIfForecastExportArn: str,
) -> DescribeWhatIfForecastExportResponseTypeDef: # (1)
...
kwargs: DescribeWhatIfForecastExportRequestRequestTypeDef = { # (1)
"WhatIfForecastExportArn": ...,
}
parent.describe_what_if_forecast_export(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("forecast").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_accuracy_metrics
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation.
Type annotations and code completion for boto3.client("forecast").get_accuracy_metrics
method.
boto3 documentation
def get_accuracy_metrics(
self,
*,
PredictorArn: str,
) -> GetAccuracyMetricsResponseTypeDef: # (1)
...
kwargs: GetAccuracyMetricsRequestRequestTypeDef = { # (1)
"PredictorArn": ...,
}
parent.get_accuracy_metrics(**kwargs)
list_dataset_groups
Returns a list of dataset groups created using the CreateDatasetGroup_ operation.
Type annotations and code completion for boto3.client("forecast").list_dataset_groups
method.
boto3 documentation
def list_dataset_groups(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDatasetGroupsResponseTypeDef: # (1)
...
kwargs: ListDatasetGroupsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_dataset_groups(**kwargs)
list_dataset_import_jobs
Returns a list of dataset import jobs created using the CreateDatasetImportJob_ operation.
Type annotations and code completion for boto3.client("forecast").list_dataset_import_jobs
method.
boto3 documentation
def list_dataset_import_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListDatasetImportJobsResponseTypeDef: # (2)
...
kwargs: ListDatasetImportJobsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_dataset_import_jobs(**kwargs)
list_datasets
Returns a list of datasets created using the CreateDataset_ operation.
Type annotations and code completion for boto3.client("forecast").list_datasets
method.
boto3 documentation
def list_datasets(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDatasetsResponseTypeDef: # (1)
...
kwargs: ListDatasetsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_datasets(**kwargs)
list_explainabilities
Returns a list of Explainability resources created using the CreateExplainability operation.
Type annotations and code completion for boto3.client("forecast").list_explainabilities
method.
boto3 documentation
def list_explainabilities(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListExplainabilitiesResponseTypeDef: # (2)
...
kwargs: ListExplainabilitiesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_explainabilities(**kwargs)
list_explainability_exports
Returns a list of Explainability exports created using the CreateExplainabilityExport operation.
Type annotations and code completion for boto3.client("forecast").list_explainability_exports
method.
boto3 documentation
def list_explainability_exports(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListExplainabilityExportsResponseTypeDef: # (2)
...
kwargs: ListExplainabilityExportsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_explainability_exports(**kwargs)
list_forecast_export_jobs
Returns a list of forecast export jobs created using the CreateForecastExportJob operation.
Type annotations and code completion for boto3.client("forecast").list_forecast_export_jobs
method.
boto3 documentation
def list_forecast_export_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListForecastExportJobsResponseTypeDef: # (2)
...
kwargs: ListForecastExportJobsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_forecast_export_jobs(**kwargs)
list_forecasts
Returns a list of forecasts created using the CreateForecast operation.
Type annotations and code completion for boto3.client("forecast").list_forecasts
method.
boto3 documentation
def list_forecasts(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListForecastsResponseTypeDef: # (2)
...
kwargs: ListForecastsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_forecasts(**kwargs)
list_monitor_evaluations
Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.
Type annotations and code completion for boto3.client("forecast").list_monitor_evaluations
method.
boto3 documentation
def list_monitor_evaluations(
self,
*,
MonitorArn: str,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListMonitorEvaluationsResponseTypeDef: # (2)
...
kwargs: ListMonitorEvaluationsRequestRequestTypeDef = { # (1)
"MonitorArn": ...,
}
parent.list_monitor_evaluations(**kwargs)
list_monitors
Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation.
Type annotations and code completion for boto3.client("forecast").list_monitors
method.
boto3 documentation
def list_monitors(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListMonitorsResponseTypeDef: # (2)
...
kwargs: ListMonitorsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_monitors(**kwargs)
list_predictor_backtest_export_jobs
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation.
Type annotations and code completion for boto3.client("forecast").list_predictor_backtest_export_jobs
method.
boto3 documentation
def list_predictor_backtest_export_jobs(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListPredictorBacktestExportJobsResponseTypeDef: # (2)
...
kwargs: ListPredictorBacktestExportJobsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_predictor_backtest_export_jobs(**kwargs)
list_predictors
Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations.
Type annotations and code completion for boto3.client("forecast").list_predictors
method.
boto3 documentation
def list_predictors(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListPredictorsResponseTypeDef: # (2)
...
kwargs: ListPredictorsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_predictors(**kwargs)
list_tags_for_resource
Lists the tags for an Amazon Forecast resource.
Type annotations and code completion for boto3.client("forecast").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_what_if_analyses
Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation.
Type annotations and code completion for boto3.client("forecast").list_what_if_analyses
method.
boto3 documentation
def list_what_if_analyses(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListWhatIfAnalysesResponseTypeDef: # (2)
...
kwargs: ListWhatIfAnalysesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_what_if_analyses(**kwargs)
list_what_if_forecast_exports
Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation.
Type annotations and code completion for boto3.client("forecast").list_what_if_forecast_exports
method.
boto3 documentation
def list_what_if_forecast_exports(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListWhatIfForecastExportsResponseTypeDef: # (2)
...
kwargs: ListWhatIfForecastExportsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_what_if_forecast_exports(**kwargs)
list_what_if_forecasts
Returns a list of what-if forecasts created using the CreateWhatIfForecast operation.
Type annotations and code completion for boto3.client("forecast").list_what_if_forecasts
method.
boto3 documentation
def list_what_if_forecasts(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> ListWhatIfForecastsResponseTypeDef: # (2)
...
kwargs: ListWhatIfForecastsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_what_if_forecasts(**kwargs)
resume_resource
Resumes a stopped monitor resource.
Type annotations and code completion for boto3.client("forecast").resume_resource
method.
boto3 documentation
def resume_resource(
self,
*,
ResourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ResumeResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.resume_resource(**kwargs)
stop_resource
Stops a resource.
Type annotations and code completion for boto3.client("forecast").stop_resource
method.
boto3 documentation
def stop_resource(
self,
*,
ResourceArn: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.stop_resource(**kwargs)
tag_resource
Associates the specified tags to a resource with the specified resourceArn
.
Type annotations and code completion for boto3.client("forecast").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Deletes the specified tags from a resource.
Type annotations and code completion for boto3.client("forecast").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_dataset_group
Replaces the datasets in a dataset group with the specified datasets.
Type annotations and code completion for boto3.client("forecast").update_dataset_group
method.
boto3 documentation
def update_dataset_group(
self,
*,
DatasetGroupArn: str,
DatasetArns: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UpdateDatasetGroupRequestRequestTypeDef = { # (1)
"DatasetGroupArn": ...,
"DatasetArns": ...,
}
parent.update_dataset_group(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("forecast").get_paginator
method with overloads.
client.get_paginator("list_dataset_groups")
-> ListDatasetGroupsPaginatorclient.get_paginator("list_dataset_import_jobs")
-> ListDatasetImportJobsPaginatorclient.get_paginator("list_datasets")
-> ListDatasetsPaginatorclient.get_paginator("list_explainabilities")
-> ListExplainabilitiesPaginatorclient.get_paginator("list_explainability_exports")
-> ListExplainabilityExportsPaginatorclient.get_paginator("list_forecast_export_jobs")
-> ListForecastExportJobsPaginatorclient.get_paginator("list_forecasts")
-> ListForecastsPaginatorclient.get_paginator("list_monitor_evaluations")
-> ListMonitorEvaluationsPaginatorclient.get_paginator("list_monitors")
-> ListMonitorsPaginatorclient.get_paginator("list_predictor_backtest_export_jobs")
-> ListPredictorBacktestExportJobsPaginatorclient.get_paginator("list_predictors")
-> ListPredictorsPaginatorclient.get_paginator("list_what_if_analyses")
-> ListWhatIfAnalysesPaginatorclient.get_paginator("list_what_if_forecast_exports")
-> ListWhatIfForecastExportsPaginatorclient.get_paginator("list_what_if_forecasts")
-> ListWhatIfForecastsPaginator