LakeFormation module#
Index > LakeFormation
Auto-generated documentation for LakeFormation type annotations stubs module mypy-boto3-lakeformation.
How to install#
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"))
- GetWorkUnitsPaginator
- ListDataCellsFilterPaginator
- ListLFTagsPaginator
- SearchDatabasesByLFTagsPaginator
- SearchTablesByLFTagsPaginator
Literals#
Type annotations for literals used in methods and schemas.
# ComparisonOperatorType usage example
from mypy_boto3_lakeformation.literals import ComparisonOperatorType
def get_value() -> ComparisonOperatorType:
return "BEGINS_WITH"
- ComparisonOperatorType
- DataLakeResourceTypeType
- FieldNameStringType
- GetWorkUnitsPaginatorName
- ListDataCellsFilterPaginatorName
- ListLFTagsPaginatorName
- OptimizerTypeType
- PermissionType
- PermissionTypeType
- QueryStateStringType
- ResourceShareTypeType
- ResourceTypeType
- SearchDatabasesByLFTagsPaginatorName
- SearchTablesByLFTagsPaginatorName
- TransactionStatusFilterType
- TransactionStatusType
- TransactionTypeType
- LakeFormationServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# LFTagPairTypeDef usage example
from mypy_boto3_lakeformation.type_defs import LFTagPairTypeDef
def get_value() -> LFTagPairTypeDef:
return {
"TagKey": ...,
"TagValues": ...,
}
- LFTagPairTypeDef
- AddObjectInputTypeDef
- AssumeDecoratedRoleWithSAMLRequestRequestTypeDef
- AssumeDecoratedRoleWithSAMLResponseTypeDef
- AuditContextTypeDef
- ErrorDetailTypeDef
- DataLakePrincipalTypeDef
- CancelTransactionRequestRequestTypeDef
- ColumnWildcardTypeDef
- CommitTransactionRequestRequestTypeDef
- CommitTransactionResponseTypeDef
- CreateLFTagRequestRequestTypeDef
- DataCellsFilterResourceTypeDef
- RowFilterTypeDef
- DataLocationResourceTypeDef
- DatabaseResourceTypeDef
- DeleteDataCellsFilterRequestRequestTypeDef
- DeleteLFTagRequestRequestTypeDef
- DeleteObjectInputTypeDef
- VirtualObjectTypeDef
- DeregisterResourceRequestRequestTypeDef
- DescribeResourceRequestRequestTypeDef
- ResourceInfoTypeDef
- DescribeTransactionRequestRequestTypeDef
- TransactionDescriptionTypeDef
- DetailsMapTypeDef
- ExecutionStatisticsTypeDef
- ExtendTransactionRequestRequestTypeDef
- FilterConditionTypeDef
- GetDataCellsFilterRequestRequestTypeDef
- GetDataLakeSettingsRequestRequestTypeDef
- GetEffectivePermissionsForPathRequestRequestTypeDef
- GetLFTagRequestRequestTypeDef
- GetLFTagResponseTypeDef
- GetQueryStateRequestRequestTypeDef
- GetQueryStateResponseTypeDef
- GetQueryStatisticsRequestRequestTypeDef
- PlanningStatisticsTypeDef
- GetTableObjectsRequestRequestTypeDef
- PartitionValueListTypeDef
- GetTemporaryGluePartitionCredentialsResponseTypeDef
- GetTemporaryGlueTableCredentialsResponseTypeDef
- GetWorkUnitResultsRequestRequestTypeDef
- GetWorkUnitResultsResponseTypeDef
- GetWorkUnitsRequestGetWorkUnitsPaginateTypeDef
- GetWorkUnitsRequestRequestTypeDef
- WorkUnitRangeTypeDef
- LFTagKeyResourceTypeDef
- LFTagTypeDef
- TableResourceTypeDef
- ListLFTagsRequestListLFTagsPaginateTypeDef
- ListLFTagsRequestRequestTypeDef
- ListTableStorageOptimizersRequestRequestTypeDef
- StorageOptimizerTypeDef
- ListTransactionsRequestRequestTypeDef
- PaginatorConfigTypeDef
- TableObjectTypeDef
- QueryPlanningContextTypeDef
- RegisterResourceRequestRequestTypeDef
- ResponseMetadataTypeDef
- StartQueryPlanningResponseTypeDef
- StartTransactionRequestRequestTypeDef
- StartTransactionResponseTypeDef
- UpdateLFTagRequestRequestTypeDef
- UpdateResourceRequestRequestTypeDef
- UpdateTableStorageOptimizerRequestRequestTypeDef
- UpdateTableStorageOptimizerResponseTypeDef
- ColumnLFTagTypeDef
- ListLFTagsResponseTypeDef
- GetTemporaryGlueTableCredentialsRequestRequestTypeDef
- LFTagErrorTypeDef
- PrincipalPermissionsTypeDef
- TableWithColumnsResourceTypeDef
- DataCellsFilterTypeDef
- TaggedDatabaseTypeDef
- WriteOperationTypeDef
- DeleteObjectsOnCancelRequestRequestTypeDef
- DescribeResourceResponseTypeDef
- ListResourcesResponseTypeDef
- DescribeTransactionResponseTypeDef
- ListTransactionsResponseTypeDef
- ListResourcesRequestRequestTypeDef
- GetQueryStatisticsResponseTypeDef
- GetTemporaryGluePartitionCredentialsRequestRequestTypeDef
- GetWorkUnitsResponseTypeDef
- LFTagPolicyResourceTypeDef
- SearchDatabasesByLFTagsRequestRequestTypeDef
- SearchDatabasesByLFTagsRequestSearchDatabasesByLFTagsPaginateTypeDef
- SearchTablesByLFTagsRequestRequestTypeDef
- SearchTablesByLFTagsRequestSearchTablesByLFTagsPaginateTypeDef
- ListDataCellsFilterRequestListDataCellsFilterPaginateTypeDef
- ListDataCellsFilterRequestRequestTypeDef
- ListTableStorageOptimizersResponseTypeDef
- PartitionObjectsTypeDef
- StartQueryPlanningRequestRequestTypeDef
- GetResourceLFTagsResponseTypeDef
- TaggedTableTypeDef
- AddLFTagsToResourceResponseTypeDef
- RemoveLFTagsFromResourceResponseTypeDef
- DataLakeSettingsTypeDef
- CreateDataCellsFilterRequestRequestTypeDef
- GetDataCellsFilterResponseTypeDef
- ListDataCellsFilterResponseTypeDef
- UpdateDataCellsFilterRequestRequestTypeDef
- SearchDatabasesByLFTagsResponseTypeDef
- UpdateTableObjectsRequestRequestTypeDef
- ResourceTypeDef
- GetTableObjectsResponseTypeDef
- SearchTablesByLFTagsResponseTypeDef
- GetDataLakeSettingsResponseTypeDef
- PutDataLakeSettingsRequestRequestTypeDef
- AddLFTagsToResourceRequestRequestTypeDef
- BatchPermissionsRequestEntryTypeDef
- GetResourceLFTagsRequestRequestTypeDef
- GrantPermissionsRequestRequestTypeDef
- ListPermissionsRequestRequestTypeDef
- PrincipalResourcePermissionsTypeDef
- RemoveLFTagsFromResourceRequestRequestTypeDef
- RevokePermissionsRequestRequestTypeDef
- BatchGrantPermissionsRequestRequestTypeDef
- BatchPermissionsFailureEntryTypeDef
- BatchRevokePermissionsRequestRequestTypeDef
- GetEffectivePermissionsForPathResponseTypeDef
- ListPermissionsResponseTypeDef
- BatchGrantPermissionsResponseTypeDef
- BatchRevokePermissionsResponseTypeDef