LakeFormation module#
Index > LakeFormation
Auto-generated documentation for LakeFormation type annotations stubs module types-boto3-lakeformation.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3
AWS SDK. - Add
LakeFormation
service. - 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 types-boto3
for LakeFormation
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[lakeformation]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[lakeformation]'
# standalone installation
python -m pip install types-boto3-lakeformation
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_boto3_lakeformation.paginator import GetWorkUnitsPaginator
def get_get_work_units_paginator() -> GetWorkUnitsPaginator:
return Session().client("lakeformation").get_paginator("get_work_units"))
- GetWorkUnitsPaginator
- ListDataCellsFilterPaginator
- ListLFTagExpressionsPaginator
- ListLFTagsPaginator
- SearchDatabasesByLFTagsPaginator
- SearchTablesByLFTagsPaginator
Literals#
Type annotations for literals used in methods and schema.
# ApplicationStatusType usage example
from types_boto3_lakeformation.literals import ApplicationStatusType
def get_value() -> ApplicationStatusType:
return "DISABLED"
- ApplicationStatusType
- ComparisonOperatorType
- DataLakeResourceTypeType
- EnableStatusType
- FieldNameStringType
- GetWorkUnitsPaginatorName
- ListDataCellsFilterPaginatorName
- ListLFTagExpressionsPaginatorName
- ListLFTagsPaginatorName
- OptimizerTypeType
- PermissionType
- PermissionTypeType
- QueryStateStringType
- ResourceShareTypeType
- ResourceTypeType
- SearchDatabasesByLFTagsPaginatorName
- SearchTablesByLFTagsPaginatorName
- TransactionStatusFilterType
- TransactionStatusType
- TransactionTypeType
- LakeFormationServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- ResponseMetadataTypeDef
- AddObjectInputTypeDef
- AssumeDecoratedRoleWithSAMLRequestRequestTypeDef
- AuditContextTypeDef
- ErrorDetailTypeDef
- DataLakePrincipalTypeDef
- CancelTransactionRequestRequestTypeDef
- CatalogResourceTypeDef
- LFTagPairOutputTypeDef
- ColumnWildcardOutputTypeDef
- ColumnWildcardTypeDef
- CommitTransactionRequestRequestTypeDef
- ConditionTypeDef
- CreateLFTagRequestRequestTypeDef
- ExternalFilteringConfigurationTypeDef
- RowFilterOutputTypeDef
- DataCellsFilterResourceTypeDef
- DataLocationResourceTypeDef
- DatabaseResourceTypeDef
- DeleteDataCellsFilterRequestRequestTypeDef
- DeleteLFTagExpressionRequestRequestTypeDef
- DeleteLFTagRequestRequestTypeDef
- DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef
- DeleteObjectInputTypeDef
- VirtualObjectTypeDef
- DeregisterResourceRequestRequestTypeDef
- DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef
- ExternalFilteringConfigurationOutputTypeDef
- DescribeResourceRequestRequestTypeDef
- ResourceInfoTypeDef
- DescribeTransactionRequestRequestTypeDef
- TransactionDescriptionTypeDef
- DetailsMapTypeDef
- ExecutionStatisticsTypeDef
- ExtendTransactionRequestRequestTypeDef
- FilterConditionTypeDef
- GetDataCellsFilterRequestRequestTypeDef
- GetDataLakeSettingsRequestRequestTypeDef
- GetEffectivePermissionsForPathRequestRequestTypeDef
- GetLFTagExpressionRequestRequestTypeDef
- LFTagOutputTypeDef
- GetLFTagRequestRequestTypeDef
- GetQueryStateRequestRequestTypeDef
- GetQueryStatisticsRequestRequestTypeDef
- PlanningStatisticsTypeDef
- TimestampTypeDef
- PartitionValueListTypeDef
- GetWorkUnitResultsRequestRequestTypeDef
- PaginatorConfigTypeDef
- GetWorkUnitsRequestRequestTypeDef
- WorkUnitRangeTypeDef
- LFTagExpressionResourceTypeDef
- LFTagKeyResourceOutputTypeDef
- LFTagKeyResourceTypeDef
- LFTagPairTypeDef
- LFTagTypeDef
- TableResourceTypeDef
- ListLFTagExpressionsRequestRequestTypeDef
- ListLFTagsRequestRequestTypeDef
- ListTableStorageOptimizersRequestRequestTypeDef
- StorageOptimizerTypeDef
- ListTransactionsRequestRequestTypeDef
- TableObjectTypeDef
- RegisterResourceRequestRequestTypeDef
- TableResourceOutputTypeDef
- RowFilterTypeDef
- StartTransactionRequestRequestTypeDef
- UpdateLFTagRequestRequestTypeDef
- UpdateResourceRequestRequestTypeDef
- UpdateTableStorageOptimizerRequestRequestTypeDef
- AssumeDecoratedRoleWithSAMLResponseTypeDef
- CommitTransactionResponseTypeDef
- CreateLakeFormationIdentityCenterConfigurationResponseTypeDef
- GetDataLakePrincipalResponseTypeDef
- GetLFTagResponseTypeDef
- GetQueryStateResponseTypeDef
- GetTemporaryGluePartitionCredentialsResponseTypeDef
- GetTemporaryGlueTableCredentialsResponseTypeDef
- GetWorkUnitResultsResponseTypeDef
- StartQueryPlanningResponseTypeDef
- StartTransactionResponseTypeDef
- UpdateTableStorageOptimizerResponseTypeDef
- PrincipalPermissionsOutputTypeDef
- PrincipalPermissionsTypeDef
- ColumnLFTagTypeDef
- LFTagErrorTypeDef
- ListLFTagsResponseTypeDef
- TableWithColumnsResourceOutputTypeDef
- ColumnWildcardUnionTypeDef
- CreateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef
- UpdateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef
- DataCellsFilterOutputTypeDef
- TaggedDatabaseTypeDef
- WriteOperationTypeDef
- DeleteObjectsOnCancelRequestRequestTypeDef
- DescribeLakeFormationIdentityCenterConfigurationResponseTypeDef
- DescribeResourceResponseTypeDef
- ListResourcesResponseTypeDef
- DescribeTransactionResponseTypeDef
- ListTransactionsResponseTypeDef
- ListResourcesRequestRequestTypeDef
- GetLFTagExpressionResponseTypeDef
- LFTagExpressionTypeDef
- LFTagPolicyResourceOutputTypeDef
- GetQueryStatisticsResponseTypeDef
- GetTableObjectsRequestRequestTypeDef
- QueryPlanningContextTypeDef
- QuerySessionContextTypeDef
- GetTemporaryGluePartitionCredentialsRequestRequestTypeDef
- GetWorkUnitsRequestPaginateTypeDef
- ListLFTagExpressionsRequestPaginateTypeDef
- ListLFTagsRequestPaginateTypeDef
- GetWorkUnitsResponseTypeDef
- LFTagKeyResourceUnionTypeDef
- LFTagPairUnionTypeDef
- LFTagUnionTypeDef
- SearchDatabasesByLFTagsRequestPaginateTypeDef
- SearchDatabasesByLFTagsRequestRequestTypeDef
- SearchTablesByLFTagsRequestPaginateTypeDef
- SearchTablesByLFTagsRequestRequestTypeDef
- UpdateLFTagExpressionRequestRequestTypeDef
- ListDataCellsFilterRequestPaginateTypeDef
- ListDataCellsFilterRequestRequestTypeDef
- ListTableStorageOptimizersResponseTypeDef
- PartitionObjectsTypeDef
- TableResourceUnionTypeDef
- RowFilterUnionTypeDef
- DataLakeSettingsOutputTypeDef
- PrincipalPermissionsUnionTypeDef
- GetResourceLFTagsResponseTypeDef
- TaggedTableTypeDef
- AddLFTagsToResourceResponseTypeDef
- RemoveLFTagsFromResourceResponseTypeDef
- TableWithColumnsResourceTypeDef
- GetDataCellsFilterResponseTypeDef
- ListDataCellsFilterResponseTypeDef
- SearchDatabasesByLFTagsResponseTypeDef
- UpdateTableObjectsRequestRequestTypeDef
- ListLFTagExpressionsResponseTypeDef
- ResourceOutputTypeDef
- StartQueryPlanningRequestRequestTypeDef
- GetTemporaryGlueTableCredentialsRequestRequestTypeDef
- CreateLFTagExpressionRequestRequestTypeDef
- LFTagPolicyResourceTypeDef
- GetTableObjectsResponseTypeDef
- DataCellsFilterTypeDef
- GetDataLakeSettingsResponseTypeDef
- DataLakeSettingsTypeDef
- SearchTablesByLFTagsResponseTypeDef
- TableWithColumnsResourceUnionTypeDef
- BatchPermissionsRequestEntryOutputTypeDef
- LakeFormationOptInsInfoTypeDef
- PrincipalResourcePermissionsTypeDef
- LFTagPolicyResourceUnionTypeDef
- CreateDataCellsFilterRequestRequestTypeDef
- UpdateDataCellsFilterRequestRequestTypeDef
- PutDataLakeSettingsRequestRequestTypeDef
- BatchPermissionsFailureEntryTypeDef
- ListLakeFormationOptInsResponseTypeDef
- GetEffectivePermissionsForPathResponseTypeDef
- ListPermissionsResponseTypeDef
- ResourceTypeDef
- BatchGrantPermissionsResponseTypeDef
- BatchRevokePermissionsResponseTypeDef
- AddLFTagsToResourceRequestRequestTypeDef
- CreateLakeFormationOptInRequestRequestTypeDef
- DeleteLakeFormationOptInRequestRequestTypeDef
- GetResourceLFTagsRequestRequestTypeDef
- GrantPermissionsRequestRequestTypeDef
- ListLakeFormationOptInsRequestRequestTypeDef
- ListPermissionsRequestRequestTypeDef
- RemoveLFTagsFromResourceRequestRequestTypeDef
- ResourceUnionTypeDef
- RevokePermissionsRequestRequestTypeDef
- BatchPermissionsRequestEntryTypeDef
- BatchPermissionsRequestEntryUnionTypeDef
- BatchRevokePermissionsRequestRequestTypeDef
- BatchGrantPermissionsRequestRequestTypeDef