Skip to content

Examples#

Index > ForecastService > Examples

Auto-generated documentation for ForecastService type annotations stubs module types-boto3-forecast.

Client#

Implicit type annotations#

Can be used with types-boto3[forecast] package installed.

Write your ForecastService code as usual, type checking and code completion should work out of the box.

# ForecastServiceClient usage example

from boto3.session import Session


session = Session()

client = session.client("forecast")  # (1)
result = client.create_auto_predictor()  # (2)
  1. client: ForecastServiceClient
  2. result: CreateAutoPredictorResponseTypeDef 
# ListDatasetGroupsPaginator usage example

from boto3.session import Session


session = Session()
client = session.client("forecast")  # (1)

paginator = client.get_paginator("list_dataset_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ForecastServiceClient
  2. paginator: ListDatasetGroupsPaginator
  3. item: ListDatasetGroupsResponseTypeDef

Explicit type annotations#

With types-boto3-lite[forecast] or a standalone types_boto3_forecast package, you have to explicitly specify client: ForecastServiceClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# ForecastServiceClient usage example with type annotations

from boto3.session import Session

from types_boto3_forecast.client import ForecastServiceClient
from types_boto3_forecast.type_defs import CreateAutoPredictorResponseTypeDef
from types_boto3_forecast.type_defs import CreateAutoPredictorRequestRequestTypeDef


session = Session()

client: ForecastServiceClient = session.client("forecast")

kwargs: CreateAutoPredictorRequestRequestTypeDef = {...}
result: CreateAutoPredictorResponseTypeDef = client.create_auto_predictor(**kwargs)
# ListDatasetGroupsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_forecast.client import ForecastServiceClient
from types_boto3_forecast.paginator import ListDatasetGroupsPaginator
from types_boto3_forecast.type_defs import ListDatasetGroupsResponseTypeDef


session = Session()
client: ForecastServiceClient = session.client("forecast")

paginator: ListDatasetGroupsPaginator = client.get_paginator("list_dataset_groups")
for item in paginator.paginate(...):
    item: ListDatasetGroupsResponseTypeDef
    print(item)