Skip to content

LakeFormation module#

Index > LakeFormation

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.2' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add LakeFormation service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and LakeFormation.

From PyPI with pip#

Install boto3-stubs for LakeFormation service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[lakeformation]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[lakeformation]'

# standalone installation
python -m pip install mypy-boto3-lakeformation

How to uninstall#

python -m pip uninstall -y mypy-boto3-lakeformation

Usage#

Code samples can be found in Examples.

LakeFormationClient#

Type annotations and code completion for boto3.client("lakeformation") as LakeFormationClient boto3 documentation

# LakeFormationClient usage example

from boto3.session import Session

from mypy_boto3_lakeformation.client import LakeFormationClient

def get_client() -> LakeFormationClient:
    return Session().client("lakeformation")

Paginators#

Type annotations and code completion for paginators from boto3.client("lakeformation").get_paginator("...").

# GetWorkUnitsPaginator usage example

from boto3.session import Session

from mypy_boto3_lakeformation.paginator import GetWorkUnitsPaginator

def get_get_work_units_paginator() -> GetWorkUnitsPaginator:
    return Session().client("lakeformation").get_paginator("get_work_units"))

Literals#

Type annotations for literals used in methods and schema.

# ApplicationStatusType usage example

from mypy_boto3_lakeformation.literals import ApplicationStatusType

def get_value() -> ApplicationStatusType:
    return "DISABLED"