Examples

Index > LakeFormation > Examples

Auto-generated documentation for LakeFormation type annotations stubs module mypy-boto3-lakeformation.

Client

Implicit type annotations

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

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

Client method usage example

# LakeFormationClient usage example

from boto3.session import Session


session = Session()

client = session.client("lakeformation")  # (1)
result = client.add_lf_tags_to_resource()  # (2)

1. client: LakeFormationClient
2. result: AddLFTagsToResourceResponseTypeDef

Paginator usage example

# GetWorkUnitsPaginator usage example

from boto3.session import Session


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

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

1. client: LakeFormationClient
2. paginator: GetWorkUnitsPaginator
3. item: GetWorkUnitsResponseTypeDef

Explicit type annotations

With boto3-stubs-lite[lakeformation] or a standalone mypy_boto3_lakeformation package, you have to explicitly specify client: LakeFormationClient 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

# LakeFormationClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_lakeformation.client import LakeFormationClient
from mypy_boto3_lakeformation.type_defs import AddLFTagsToResourceResponseTypeDef
from mypy_boto3_lakeformation.type_defs import AddLFTagsToResourceRequestTypeDef


session = Session()

client: LakeFormationClient = session.client("lakeformation")

kwargs: AddLFTagsToResourceRequestTypeDef = {...}
result: AddLFTagsToResourceResponseTypeDef = client.add_lf_tags_to_resource(**kwargs)

Paginator usage example

# GetWorkUnitsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_lakeformation.client import LakeFormationClient
from mypy_boto3_lakeformation.paginator import GetWorkUnitsPaginator
from mypy_boto3_lakeformation.type_defs import GetWorkUnitsResponseTypeDef


session = Session()
client: LakeFormationClient = session.client("lakeformation")

paginator: GetWorkUnitsPaginator = client.get_paginator("get_work_units")
for item in paginator.paginate(...):
    item: GetWorkUnitsResponseTypeDef
    print(item)