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

# ForecastServiceClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("forecast")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InvalidInputException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("forecast").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_auto_predictor

Creates an Amazon Forecast predictor.

Type annotations and code completion for boto3.client("forecast").create_auto_predictor method. boto3 documentation

# create_auto_predictor method definition

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)
    ...

1. See DataConfigTypeDef
2. See EncryptionConfigTypeDef
3. See OptimizationMetricType
4. See TagTypeDef
5. See MonitorConfigTypeDef
6. See TimeAlignmentBoundaryTypeDef
7. See CreateAutoPredictorResponseTypeDef

# create_auto_predictor method usage example with argument unpacking

kwargs: CreateAutoPredictorRequestRequestTypeDef = {  # (1)
    "PredictorName": ...,
}

parent.create_auto_predictor(**kwargs)

1. See CreateAutoPredictorRequestRequestTypeDef

create_dataset

Creates an Amazon Forecast dataset.

Type annotations and code completion for boto3.client("forecast").create_dataset method. boto3 documentation

# create_dataset method definition

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)
    ...

1. See DomainType
2. See DatasetTypeType
3. See SchemaTypeDef
4. See EncryptionConfigTypeDef
5. See TagTypeDef
6. See CreateDatasetResponseTypeDef

# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "DatasetName": ...,
    "Domain": ...,
    "DatasetType": ...,
    "Schema": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestRequestTypeDef

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

# create_dataset_group method definition

def create_dataset_group(
    self,
    *,
    DatasetGroupName: str,
    Domain: DomainType,  # (1)
    DatasetArns: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateDatasetGroupResponseTypeDef:  # (3)
    ...

1. See DomainType
2. See TagTypeDef
3. See CreateDatasetGroupResponseTypeDef

# create_dataset_group method usage example with argument unpacking

kwargs: CreateDatasetGroupRequestRequestTypeDef = {  # (1)
    "DatasetGroupName": ...,
    "Domain": ...,
}

parent.create_dataset_group(**kwargs)

1. See CreateDatasetGroupRequestRequestTypeDef

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

# create_dataset_import_job method definition

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)
    ...

1. See DataSourceTypeDef
2. See TagTypeDef
3. See ImportModeType
4. See CreateDatasetImportJobResponseTypeDef

# create_dataset_import_job method usage example with argument unpacking

kwargs: CreateDatasetImportJobRequestRequestTypeDef = {  # (1)
    "DatasetImportJobName": ...,
    "DatasetArn": ...,
    "DataSource": ...,
}

parent.create_dataset_import_job(**kwargs)

1. See CreateDatasetImportJobRequestRequestTypeDef

create_explainability

.

Type annotations and code completion for boto3.client("forecast").create_explainability method. boto3 documentation

# create_explainability method definition

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)
    ...

1. See ExplainabilityConfigTypeDef
2. See DataSourceTypeDef
3. See SchemaTypeDef
4. See TagTypeDef
5. See CreateExplainabilityResponseTypeDef

# create_explainability method usage example with argument unpacking

kwargs: CreateExplainabilityRequestRequestTypeDef = {  # (1)
    "ExplainabilityName": ...,
    "ResourceArn": ...,
    "ExplainabilityConfig": ...,
}

parent.create_explainability(**kwargs)

1. See CreateExplainabilityRequestRequestTypeDef

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

# create_explainability_export method definition

def create_explainability_export(
    self,
    *,
    ExplainabilityExportName: str,
    ExplainabilityArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    Format: str = ...,
) -> CreateExplainabilityExportResponseTypeDef:  # (3)
    ...

1. See DataDestinationTypeDef
2. See TagTypeDef
3. See CreateExplainabilityExportResponseTypeDef

# create_explainability_export method usage example with argument unpacking

kwargs: CreateExplainabilityExportRequestRequestTypeDef = {  # (1)
    "ExplainabilityExportName": ...,
    "ExplainabilityArn": ...,
    "Destination": ...,
}

parent.create_explainability_export(**kwargs)

1. See CreateExplainabilityExportRequestRequestTypeDef

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

# create_forecast method definition

def create_forecast(
    self,
    *,
    ForecastName: str,
    PredictorArn: str,
    ForecastTypes: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
    TimeSeriesSelector: TimeSeriesSelectorTypeDef = ...,  # (2)
) -> CreateForecastResponseTypeDef:  # (3)
    ...

1. See TagTypeDef
2. See TimeSeriesSelectorTypeDef
3. See CreateForecastResponseTypeDef

# create_forecast method usage example with argument unpacking

kwargs: CreateForecastRequestRequestTypeDef = {  # (1)
    "ForecastName": ...,
    "PredictorArn": ...,
}

parent.create_forecast(**kwargs)

1. See CreateForecastRequestRequestTypeDef

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

# create_forecast_export_job method definition

def create_forecast_export_job(
    self,
    *,
    ForecastExportJobName: str,
    ForecastArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    Format: str = ...,
) -> CreateForecastExportJobResponseTypeDef:  # (3)
    ...

1. See DataDestinationTypeDef
2. See TagTypeDef
3. See CreateForecastExportJobResponseTypeDef

# create_forecast_export_job method usage example with argument unpacking

kwargs: CreateForecastExportJobRequestRequestTypeDef = {  # (1)
    "ForecastExportJobName": ...,
    "ForecastArn": ...,
    "Destination": ...,
}

parent.create_forecast_export_job(**kwargs)

1. See CreateForecastExportJobRequestRequestTypeDef

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

# create_monitor method definition

def create_monitor(
    self,
    *,
    MonitorName: str,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateMonitorResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See CreateMonitorResponseTypeDef

# create_monitor method usage example with argument unpacking

kwargs: CreateMonitorRequestRequestTypeDef = {  # (1)
    "MonitorName": ...,
    "ResourceArn": ...,
}

parent.create_monitor(**kwargs)

1. See CreateMonitorRequestRequestTypeDef

create_predictor

.

Type annotations and code completion for boto3.client("forecast").create_predictor method. boto3 documentation

# create_predictor method definition

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)
    ...

1. See InputDataConfigTypeDef
2. See FeaturizationConfigTypeDef
3. See AutoMLOverrideStrategyType
4. See EvaluationParametersTypeDef
5. See HyperParameterTuningJobConfigTypeDef
6. See EncryptionConfigTypeDef
7. See TagTypeDef
8. See OptimizationMetricType
9. See CreatePredictorResponseTypeDef

# create_predictor method usage example with argument unpacking

kwargs: CreatePredictorRequestRequestTypeDef = {  # (1)
    "PredictorName": ...,
    "ForecastHorizon": ...,
    "InputDataConfig": ...,
    "FeaturizationConfig": ...,
}

parent.create_predictor(**kwargs)

1. See CreatePredictorRequestRequestTypeDef

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

# create_predictor_backtest_export_job method definition

def create_predictor_backtest_export_job(
    self,
    *,
    PredictorBacktestExportJobName: str,
    PredictorArn: str,
    Destination: DataDestinationTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    Format: str = ...,
) -> CreatePredictorBacktestExportJobResponseTypeDef:  # (3)
    ...

1. See DataDestinationTypeDef
2. See TagTypeDef
3. See CreatePredictorBacktestExportJobResponseTypeDef

# create_predictor_backtest_export_job method usage example with argument unpacking

kwargs: CreatePredictorBacktestExportJobRequestRequestTypeDef = {  # (1)
    "PredictorBacktestExportJobName": ...,
    "PredictorArn": ...,
    "Destination": ...,
}

parent.create_predictor_backtest_export_job(**kwargs)

1. See CreatePredictorBacktestExportJobRequestRequestTypeDef

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

# create_what_if_analysis method definition

def create_what_if_analysis(
    self,
    *,
    WhatIfAnalysisName: str,
    ForecastArn: str,
    TimeSeriesSelector: TimeSeriesSelectorTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateWhatIfAnalysisResponseTypeDef:  # (3)
    ...

1. See TimeSeriesSelectorTypeDef
2. See TagTypeDef
3. See CreateWhatIfAnalysisResponseTypeDef

# create_what_if_analysis method usage example with argument unpacking

kwargs: CreateWhatIfAnalysisRequestRequestTypeDef = {  # (1)
    "WhatIfAnalysisName": ...,
    "ForecastArn": ...,
}

parent.create_what_if_analysis(**kwargs)

1. See CreateWhatIfAnalysisRequestRequestTypeDef

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

# create_what_if_forecast method definition

def create_what_if_forecast(
    self,
    *,
    WhatIfForecastName: str,
    WhatIfAnalysisArn: str,
    TimeSeriesTransformations: Sequence[TimeSeriesTransformationUnionTypeDef] = ...,  # (1)
    TimeSeriesReplacementsDataSource: TimeSeriesReplacementsDataSourceTypeDef = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateWhatIfForecastResponseTypeDef:  # (4)
    ...

1. See TimeSeriesTransformationTypeDef TimeSeriesTransformationOutputTypeDef
2. See TimeSeriesReplacementsDataSourceTypeDef
3. See TagTypeDef
4. See CreateWhatIfForecastResponseTypeDef

# create_what_if_forecast method usage example with argument unpacking

kwargs: CreateWhatIfForecastRequestRequestTypeDef = {  # (1)
    "WhatIfForecastName": ...,
    "WhatIfAnalysisArn": ...,
}

parent.create_what_if_forecast(**kwargs)

1. See CreateWhatIfForecastRequestRequestTypeDef

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

# create_what_if_forecast_export method definition

def create_what_if_forecast_export(
    self,
    *,
    WhatIfForecastExportName: str,
    WhatIfForecastArns: Sequence[str],
    Destination: DataDestinationTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    Format: str = ...,
) -> CreateWhatIfForecastExportResponseTypeDef:  # (3)
    ...

1. See DataDestinationTypeDef
2. See TagTypeDef
3. See CreateWhatIfForecastExportResponseTypeDef

# create_what_if_forecast_export method usage example with argument unpacking

kwargs: CreateWhatIfForecastExportRequestRequestTypeDef = {  # (1)
    "WhatIfForecastExportName": ...,
    "WhatIfForecastArns": ...,
    "Destination": ...,
}

parent.create_what_if_forecast_export(**kwargs)

1. See CreateWhatIfForecastExportRequestRequestTypeDef

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

# delete_dataset method definition

def delete_dataset(
    self,
    *,
    DatasetArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestRequestTypeDef

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

# delete_dataset_group method definition

def delete_dataset_group(
    self,
    *,
    DatasetGroupArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_dataset_group method usage example with argument unpacking

kwargs: DeleteDatasetGroupRequestRequestTypeDef = {  # (1)
    "DatasetGroupArn": ...,
}

parent.delete_dataset_group(**kwargs)

1. See DeleteDatasetGroupRequestRequestTypeDef

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

# delete_dataset_import_job method definition

def delete_dataset_import_job(
    self,
    *,
    DatasetImportJobArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_dataset_import_job method usage example with argument unpacking

kwargs: DeleteDatasetImportJobRequestRequestTypeDef = {  # (1)
    "DatasetImportJobArn": ...,
}

parent.delete_dataset_import_job(**kwargs)

1. See DeleteDatasetImportJobRequestRequestTypeDef

delete_explainability

Deletes an Explainability resource.

Type annotations and code completion for boto3.client("forecast").delete_explainability method. boto3 documentation

# delete_explainability method definition

def delete_explainability(
    self,
    *,
    ExplainabilityArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_explainability method usage example with argument unpacking

kwargs: DeleteExplainabilityRequestRequestTypeDef = {  # (1)
    "ExplainabilityArn": ...,
}

parent.delete_explainability(**kwargs)

1. See DeleteExplainabilityRequestRequestTypeDef

delete_explainability_export

Deletes an Explainability export.

Type annotations and code completion for boto3.client("forecast").delete_explainability_export method. boto3 documentation

# delete_explainability_export method definition

def delete_explainability_export(
    self,
    *,
    ExplainabilityExportArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_explainability_export method usage example with argument unpacking

kwargs: DeleteExplainabilityExportRequestRequestTypeDef = {  # (1)
    "ExplainabilityExportArn": ...,
}

parent.delete_explainability_export(**kwargs)

1. See DeleteExplainabilityExportRequestRequestTypeDef

delete_forecast

Deletes a forecast created using the CreateForecast operation.

Type annotations and code completion for boto3.client("forecast").delete_forecast method. boto3 documentation

# delete_forecast method definition

def delete_forecast(
    self,
    *,
    ForecastArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_forecast method usage example with argument unpacking

kwargs: DeleteForecastRequestRequestTypeDef = {  # (1)
    "ForecastArn": ...,
}

parent.delete_forecast(**kwargs)

1. See DeleteForecastRequestRequestTypeDef

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

# delete_forecast_export_job method definition

def delete_forecast_export_job(
    self,
    *,
    ForecastExportJobArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_forecast_export_job method usage example with argument unpacking

kwargs: DeleteForecastExportJobRequestRequestTypeDef = {  # (1)
    "ForecastExportJobArn": ...,
}

parent.delete_forecast_export_job(**kwargs)

1. See DeleteForecastExportJobRequestRequestTypeDef

delete_monitor

Deletes a monitor resource.

Type annotations and code completion for boto3.client("forecast").delete_monitor method. boto3 documentation

# delete_monitor method definition

def delete_monitor(
    self,
    *,
    MonitorArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_monitor method usage example with argument unpacking

kwargs: DeleteMonitorRequestRequestTypeDef = {  # (1)
    "MonitorArn": ...,
}

parent.delete_monitor(**kwargs)

1. See DeleteMonitorRequestRequestTypeDef

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

# delete_predictor method definition

def delete_predictor(
    self,
    *,
    PredictorArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_predictor method usage example with argument unpacking

kwargs: DeletePredictorRequestRequestTypeDef = {  # (1)
    "PredictorArn": ...,
}

parent.delete_predictor(**kwargs)

1. See DeletePredictorRequestRequestTypeDef

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

# delete_predictor_backtest_export_job method definition

def delete_predictor_backtest_export_job(
    self,
    *,
    PredictorBacktestExportJobArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_predictor_backtest_export_job method usage example with argument unpacking

kwargs: DeletePredictorBacktestExportJobRequestRequestTypeDef = {  # (1)
    "PredictorBacktestExportJobArn": ...,
}

parent.delete_predictor_backtest_export_job(**kwargs)

1. See DeletePredictorBacktestExportJobRequestRequestTypeDef

delete_resource_tree

Deletes an entire resource tree.

Type annotations and code completion for boto3.client("forecast").delete_resource_tree method. boto3 documentation

# delete_resource_tree method definition

def delete_resource_tree(
    self,
    *,
    ResourceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_resource_tree method usage example with argument unpacking

kwargs: DeleteResourceTreeRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_tree(**kwargs)

1. See DeleteResourceTreeRequestRequestTypeDef

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

# delete_what_if_analysis method definition

def delete_what_if_analysis(
    self,
    *,
    WhatIfAnalysisArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_what_if_analysis method usage example with argument unpacking

kwargs: DeleteWhatIfAnalysisRequestRequestTypeDef = {  # (1)
    "WhatIfAnalysisArn": ...,
}

parent.delete_what_if_analysis(**kwargs)

1. See DeleteWhatIfAnalysisRequestRequestTypeDef

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

# delete_what_if_forecast method definition

def delete_what_if_forecast(
    self,
    *,
    WhatIfForecastArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_what_if_forecast method usage example with argument unpacking

kwargs: DeleteWhatIfForecastRequestRequestTypeDef = {  # (1)
    "WhatIfForecastArn": ...,
}

parent.delete_what_if_forecast(**kwargs)

1. See DeleteWhatIfForecastRequestRequestTypeDef

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

# delete_what_if_forecast_export method definition

def delete_what_if_forecast_export(
    self,
    *,
    WhatIfForecastExportArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_what_if_forecast_export method usage example with argument unpacking

kwargs: DeleteWhatIfForecastExportRequestRequestTypeDef = {  # (1)
    "WhatIfForecastExportArn": ...,
}

parent.delete_what_if_forecast_export(**kwargs)

1. See DeleteWhatIfForecastExportRequestRequestTypeDef

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

# describe_auto_predictor method definition

def describe_auto_predictor(
    self,
    *,
    PredictorArn: str,
) -> DescribeAutoPredictorResponseTypeDef:  # (1)
    ...

1. See DescribeAutoPredictorResponseTypeDef

# describe_auto_predictor method usage example with argument unpacking

kwargs: DescribeAutoPredictorRequestRequestTypeDef = {  # (1)
    "PredictorArn": ...,
}

parent.describe_auto_predictor(**kwargs)

1. See DescribeAutoPredictorRequestRequestTypeDef

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

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    DatasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetResponseTypeDef

# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.describe_dataset(**kwargs)

1. See DescribeDatasetRequestRequestTypeDef

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

# describe_dataset_group method definition

def describe_dataset_group(
    self,
    *,
    DatasetGroupArn: str,
) -> DescribeDatasetGroupResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetGroupResponseTypeDef

# describe_dataset_group method usage example with argument unpacking

kwargs: DescribeDatasetGroupRequestRequestTypeDef = {  # (1)
    "DatasetGroupArn": ...,
}

parent.describe_dataset_group(**kwargs)

1. See DescribeDatasetGroupRequestRequestTypeDef

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

# describe_dataset_import_job method definition

def describe_dataset_import_job(
    self,
    *,
    DatasetImportJobArn: str,
) -> DescribeDatasetImportJobResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetImportJobResponseTypeDef

# describe_dataset_import_job method usage example with argument unpacking

kwargs: DescribeDatasetImportJobRequestRequestTypeDef = {  # (1)
    "DatasetImportJobArn": ...,
}

parent.describe_dataset_import_job(**kwargs)

1. See DescribeDatasetImportJobRequestRequestTypeDef

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

# describe_explainability method definition

def describe_explainability(
    self,
    *,
    ExplainabilityArn: str,
) -> DescribeExplainabilityResponseTypeDef:  # (1)
    ...

1. See DescribeExplainabilityResponseTypeDef

# describe_explainability method usage example with argument unpacking

kwargs: DescribeExplainabilityRequestRequestTypeDef = {  # (1)
    "ExplainabilityArn": ...,
}

parent.describe_explainability(**kwargs)

1. See DescribeExplainabilityRequestRequestTypeDef

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

# describe_explainability_export method definition

def describe_explainability_export(
    self,
    *,
    ExplainabilityExportArn: str,
) -> DescribeExplainabilityExportResponseTypeDef:  # (1)
    ...

1. See DescribeExplainabilityExportResponseTypeDef

# describe_explainability_export method usage example with argument unpacking

kwargs: DescribeExplainabilityExportRequestRequestTypeDef = {  # (1)
    "ExplainabilityExportArn": ...,
}

parent.describe_explainability_export(**kwargs)

1. See DescribeExplainabilityExportRequestRequestTypeDef

describe_forecast

Describes a forecast created using the CreateForecast operation.

Type annotations and code completion for boto3.client("forecast").describe_forecast method. boto3 documentation

# describe_forecast method definition

def describe_forecast(
    self,
    *,
    ForecastArn: str,
) -> DescribeForecastResponseTypeDef:  # (1)
    ...

1. See DescribeForecastResponseTypeDef

# describe_forecast method usage example with argument unpacking

kwargs: DescribeForecastRequestRequestTypeDef = {  # (1)
    "ForecastArn": ...,
}

parent.describe_forecast(**kwargs)

1. See DescribeForecastRequestRequestTypeDef

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

# describe_forecast_export_job method definition

def describe_forecast_export_job(
    self,
    *,
    ForecastExportJobArn: str,
) -> DescribeForecastExportJobResponseTypeDef:  # (1)
    ...

1. See DescribeForecastExportJobResponseTypeDef

# describe_forecast_export_job method usage example with argument unpacking

kwargs: DescribeForecastExportJobRequestRequestTypeDef = {  # (1)
    "ForecastExportJobArn": ...,
}

parent.describe_forecast_export_job(**kwargs)

1. See DescribeForecastExportJobRequestRequestTypeDef

describe_monitor

Describes a monitor resource.

Type annotations and code completion for boto3.client("forecast").describe_monitor method. boto3 documentation

# describe_monitor method definition

def describe_monitor(
    self,
    *,
    MonitorArn: str,
) -> DescribeMonitorResponseTypeDef:  # (1)
    ...

1. See DescribeMonitorResponseTypeDef

# describe_monitor method usage example with argument unpacking

kwargs: DescribeMonitorRequestRequestTypeDef = {  # (1)
    "MonitorArn": ...,
}

parent.describe_monitor(**kwargs)

1. See DescribeMonitorRequestRequestTypeDef

describe_predictor

.

Type annotations and code completion for boto3.client("forecast").describe_predictor method. boto3 documentation

# describe_predictor method definition

def describe_predictor(
    self,
    *,
    PredictorArn: str,
) -> DescribePredictorResponseTypeDef:  # (1)
    ...

1. See DescribePredictorResponseTypeDef

# describe_predictor method usage example with argument unpacking

kwargs: DescribePredictorRequestRequestTypeDef = {  # (1)
    "PredictorArn": ...,
}

parent.describe_predictor(**kwargs)

1. See DescribePredictorRequestRequestTypeDef

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

# describe_predictor_backtest_export_job method definition

def describe_predictor_backtest_export_job(
    self,
    *,
    PredictorBacktestExportJobArn: str,
) -> DescribePredictorBacktestExportJobResponseTypeDef:  # (1)
    ...

1. See DescribePredictorBacktestExportJobResponseTypeDef

# describe_predictor_backtest_export_job method usage example with argument unpacking

kwargs: DescribePredictorBacktestExportJobRequestRequestTypeDef = {  # (1)
    "PredictorBacktestExportJobArn": ...,
}

parent.describe_predictor_backtest_export_job(**kwargs)

1. See DescribePredictorBacktestExportJobRequestRequestTypeDef

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

# describe_what_if_analysis method definition

def describe_what_if_analysis(
    self,
    *,
    WhatIfAnalysisArn: str,
) -> DescribeWhatIfAnalysisResponseTypeDef:  # (1)
    ...

1. See DescribeWhatIfAnalysisResponseTypeDef

# describe_what_if_analysis method usage example with argument unpacking

kwargs: DescribeWhatIfAnalysisRequestRequestTypeDef = {  # (1)
    "WhatIfAnalysisArn": ...,
}

parent.describe_what_if_analysis(**kwargs)

1. See DescribeWhatIfAnalysisRequestRequestTypeDef

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

# describe_what_if_forecast method definition

def describe_what_if_forecast(
    self,
    *,
    WhatIfForecastArn: str,
) -> DescribeWhatIfForecastResponseTypeDef:  # (1)
    ...

1. See DescribeWhatIfForecastResponseTypeDef

# describe_what_if_forecast method usage example with argument unpacking

kwargs: DescribeWhatIfForecastRequestRequestTypeDef = {  # (1)
    "WhatIfForecastArn": ...,
}

parent.describe_what_if_forecast(**kwargs)

1. See DescribeWhatIfForecastRequestRequestTypeDef

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

# describe_what_if_forecast_export method definition

def describe_what_if_forecast_export(
    self,
    *,
    WhatIfForecastExportArn: str,
) -> DescribeWhatIfForecastExportResponseTypeDef:  # (1)
    ...

1. See DescribeWhatIfForecastExportResponseTypeDef

# describe_what_if_forecast_export method usage example with argument unpacking

kwargs: DescribeWhatIfForecastExportRequestRequestTypeDef = {  # (1)
    "WhatIfForecastExportArn": ...,
}

parent.describe_what_if_forecast_export(**kwargs)

1. See DescribeWhatIfForecastExportRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# get_accuracy_metrics method definition

def get_accuracy_metrics(
    self,
    *,
    PredictorArn: str,
) -> GetAccuracyMetricsResponseTypeDef:  # (1)
    ...

1. See GetAccuracyMetricsResponseTypeDef

# get_accuracy_metrics method usage example with argument unpacking

kwargs: GetAccuracyMetricsRequestRequestTypeDef = {  # (1)
    "PredictorArn": ...,
}

parent.get_accuracy_metrics(**kwargs)

1. See GetAccuracyMetricsRequestRequestTypeDef

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

# list_dataset_groups method definition

def list_dataset_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetGroupsResponseTypeDef:  # (1)
    ...

1. See ListDatasetGroupsResponseTypeDef

# list_dataset_groups method usage example with argument unpacking

kwargs: ListDatasetGroupsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_dataset_groups(**kwargs)

1. See ListDatasetGroupsRequestRequestTypeDef

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

# list_dataset_import_jobs method definition

def list_dataset_import_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListDatasetImportJobsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListDatasetImportJobsResponseTypeDef

# list_dataset_import_jobs method usage example with argument unpacking

kwargs: ListDatasetImportJobsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_dataset_import_jobs(**kwargs)

1. See ListDatasetImportJobsRequestRequestTypeDef

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

# list_datasets method definition

def list_datasets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetsResponseTypeDef:  # (1)
    ...

1. See ListDatasetsResponseTypeDef

# list_datasets method usage example with argument unpacking

kwargs: ListDatasetsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_datasets(**kwargs)

1. See ListDatasetsRequestRequestTypeDef

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

# list_explainabilities method definition

def list_explainabilities(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListExplainabilitiesResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListExplainabilitiesResponseTypeDef

# list_explainabilities method usage example with argument unpacking

kwargs: ListExplainabilitiesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_explainabilities(**kwargs)

1. See ListExplainabilitiesRequestRequestTypeDef

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

# list_explainability_exports method definition

def list_explainability_exports(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListExplainabilityExportsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListExplainabilityExportsResponseTypeDef

# list_explainability_exports method usage example with argument unpacking

kwargs: ListExplainabilityExportsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_explainability_exports(**kwargs)

1. See ListExplainabilityExportsRequestRequestTypeDef

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

# list_forecast_export_jobs method definition

def list_forecast_export_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListForecastExportJobsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListForecastExportJobsResponseTypeDef

# list_forecast_export_jobs method usage example with argument unpacking

kwargs: ListForecastExportJobsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_forecast_export_jobs(**kwargs)

1. See ListForecastExportJobsRequestRequestTypeDef

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

# list_forecasts method definition

def list_forecasts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListForecastsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListForecastsResponseTypeDef

# list_forecasts method usage example with argument unpacking

kwargs: ListForecastsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_forecasts(**kwargs)

1. See ListForecastsRequestRequestTypeDef

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

# list_monitor_evaluations method definition

def list_monitor_evaluations(
    self,
    *,
    MonitorArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListMonitorEvaluationsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListMonitorEvaluationsResponseTypeDef

# list_monitor_evaluations method usage example with argument unpacking

kwargs: ListMonitorEvaluationsRequestRequestTypeDef = {  # (1)
    "MonitorArn": ...,
}

parent.list_monitor_evaluations(**kwargs)

1. See ListMonitorEvaluationsRequestRequestTypeDef

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

# list_monitors method definition

def list_monitors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListMonitorsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListMonitorsResponseTypeDef

# list_monitors method usage example with argument unpacking

kwargs: ListMonitorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_monitors(**kwargs)

1. See ListMonitorsRequestRequestTypeDef

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

# list_predictor_backtest_export_jobs method definition

def list_predictor_backtest_export_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListPredictorBacktestExportJobsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListPredictorBacktestExportJobsResponseTypeDef

# list_predictor_backtest_export_jobs method usage example with argument unpacking

kwargs: ListPredictorBacktestExportJobsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_predictor_backtest_export_jobs(**kwargs)

1. See ListPredictorBacktestExportJobsRequestRequestTypeDef

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

# list_predictors method definition

def list_predictors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListPredictorsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListPredictorsResponseTypeDef

# list_predictors method usage example with argument unpacking

kwargs: ListPredictorsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_predictors(**kwargs)

1. See ListPredictorsRequestRequestTypeDef

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

# list_what_if_analyses method definition

def list_what_if_analyses(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWhatIfAnalysesResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListWhatIfAnalysesResponseTypeDef

# list_what_if_analyses method usage example with argument unpacking

kwargs: ListWhatIfAnalysesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_what_if_analyses(**kwargs)

1. See ListWhatIfAnalysesRequestRequestTypeDef

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

# list_what_if_forecast_exports method definition

def list_what_if_forecast_exports(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWhatIfForecastExportsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListWhatIfForecastExportsResponseTypeDef

# list_what_if_forecast_exports method usage example with argument unpacking

kwargs: ListWhatIfForecastExportsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_what_if_forecast_exports(**kwargs)

1. See ListWhatIfForecastExportsRequestRequestTypeDef

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

# list_what_if_forecasts method definition

def list_what_if_forecasts(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
) -> ListWhatIfForecastsResponseTypeDef:  # (2)
    ...

1. See FilterTypeDef
2. See ListWhatIfForecastsResponseTypeDef

# list_what_if_forecasts method usage example with argument unpacking

kwargs: ListWhatIfForecastsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_what_if_forecasts(**kwargs)

1. See ListWhatIfForecastsRequestRequestTypeDef

resume_resource

Resumes a stopped monitor resource.

Type annotations and code completion for boto3.client("forecast").resume_resource method. boto3 documentation

# resume_resource method definition

def resume_resource(
    self,
    *,
    ResourceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# resume_resource method usage example with argument unpacking

kwargs: ResumeResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.resume_resource(**kwargs)

1. See ResumeResourceRequestRequestTypeDef

stop_resource

Stops a resource.

Type annotations and code completion for boto3.client("forecast").stop_resource method. boto3 documentation

# stop_resource method definition

def stop_resource(
    self,
    *,
    ResourceArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# stop_resource method usage example with argument unpacking

kwargs: StopResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.stop_resource(**kwargs)

1. See StopResourceRequestRequestTypeDef

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes the specified tags from a resource.

Type annotations and code completion for boto3.client("forecast").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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

# update_dataset_group method definition

def update_dataset_group(
    self,
    *,
    DatasetGroupArn: str,
    DatasetArns: Sequence[str],
) -> Dict[str, Any]:
    ...

# update_dataset_group method usage example with argument unpacking

kwargs: UpdateDatasetGroupRequestRequestTypeDef = {  # (1)
    "DatasetGroupArn": ...,
    "DatasetArns": ...,
}

parent.update_dataset_group(**kwargs)

1. See UpdateDatasetGroupRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("forecast").get_paginator method with overloads.

• client.get_paginator("list_dataset_groups") -> ListDatasetGroupsPaginator
• client.get_paginator("list_dataset_import_jobs") -> ListDatasetImportJobsPaginator
• client.get_paginator("list_datasets") -> ListDatasetsPaginator
• client.get_paginator("list_explainabilities") -> ListExplainabilitiesPaginator
• client.get_paginator("list_explainability_exports") -> ListExplainabilityExportsPaginator
• client.get_paginator("list_forecast_export_jobs") -> ListForecastExportJobsPaginator
• client.get_paginator("list_forecasts") -> ListForecastsPaginator
• client.get_paginator("list_monitor_evaluations") -> ListMonitorEvaluationsPaginator
• client.get_paginator("list_monitors") -> ListMonitorsPaginator
• client.get_paginator("list_predictor_backtest_export_jobs") -> ListPredictorBacktestExportJobsPaginator
• client.get_paginator("list_predictors") -> ListPredictorsPaginator
• client.get_paginator("list_what_if_analyses") -> ListWhatIfAnalysesPaginator
• client.get_paginator("list_what_if_forecast_exports") -> ListWhatIfForecastExportsPaginator
• client.get_paginator("list_what_if_forecasts") -> ListWhatIfForecastsPaginator