Examples

Index > Personalize > Examples

Auto-generated documentation for Personalize type annotations stubs module mypy-boto3-personalize.

Client

Implicit type annotations

Can be used with boto3-stubs[personalize] package installed.

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

Client method usage example

# PersonalizeClient usage example

from boto3.session import Session


session = Session()

client = session.client("personalize")  # (1)
result = client.create_batch_inference_job()  # (2)

1. client: PersonalizeClient
2. result: CreateBatchInferenceJobResponseTypeDef

Paginator usage example

# ListBatchInferenceJobsPaginator usage example

from boto3.session import Session


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

paginator = client.get_paginator("list_batch_inference_jobs")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: PersonalizeClient
2. paginator: ListBatchInferenceJobsPaginator
3. item: ListBatchInferenceJobsResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[personalize] or a standalone mypy_boto3_personalize package, you have to explicitly specify client: PersonalizeClient 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.

Client method usage example

# PersonalizeClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_personalize.client import PersonalizeClient
from mypy_boto3_personalize.type_defs import CreateBatchInferenceJobResponseTypeDef
from mypy_boto3_personalize.type_defs import CreateBatchInferenceJobRequestTypeDef


session = Session()

client: PersonalizeClient = session.client("personalize")

kwargs: CreateBatchInferenceJobRequestTypeDef = {...}
result: CreateBatchInferenceJobResponseTypeDef = client.create_batch_inference_job(**kwargs)

Paginator usage example

# ListBatchInferenceJobsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_personalize.client import PersonalizeClient
from mypy_boto3_personalize.paginator import ListBatchInferenceJobsPaginator
from mypy_boto3_personalize.type_defs import ListBatchInferenceJobsResponseTypeDef


session = Session()
client: PersonalizeClient = session.client("personalize")

paginator: ListBatchInferenceJobsPaginator = client.get_paginator("list_batch_inference_jobs")
for item in paginator.paginate(...):
    item: ListBatchInferenceJobsResponseTypeDef
    print(item)