LakeFormationClient#
Index > LakeFormation > LakeFormationClient
Auto-generated documentation for LakeFormation type annotations stubs module mypy-boto3-lakeformation.
LakeFormationClient#
Type annotations and code completion for boto3.client("lakeformation").
boto3 documentation
# LakeFormationClient usage example
from boto3.session import Session
from mypy_boto3_lakeformation.client import LakeFormationClient
def get_lakeformation_client() -> LakeFormationClient:
return Session().client("lakeformation")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("lakeformation").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("lakeformation")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.AlreadyExistsException,
client.exceptions.ClientError,
client.exceptions.ConcurrentModificationException,
client.exceptions.EntityNotFoundException,
client.exceptions.ExpiredException,
client.exceptions.GlueEncryptionException,
client.exceptions.InternalServiceException,
client.exceptions.InvalidInputException,
client.exceptions.OperationTimeoutException,
client.exceptions.PermissionTypeMismatchException,
client.exceptions.ResourceNotReadyException,
client.exceptions.ResourceNumberLimitExceededException,
client.exceptions.StatisticsNotReadyYetException,
client.exceptions.ThrottledException,
client.exceptions.TransactionCanceledException,
client.exceptions.TransactionCommitInProgressException,
client.exceptions.TransactionCommittedException,
client.exceptions.WorkUnitsNotReadyYetException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_lakeformation.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
add_lf_tags_to_resource#
Attaches one or more LF-tags to an existing resource.
Type annotations and code completion for boto3.client("lakeformation").add_lf_tags_to_resource method.
boto3 documentation
# add_lf_tags_to_resource method definition
def add_lf_tags_to_resource(
self,
*,
Resource: ResourceTypeDef, # (1)
LFTags: Sequence[LFTagPairTypeDef], # (2)
CatalogId: str = ...,
) -> AddLFTagsToResourceResponseTypeDef: # (3)
...# add_lf_tags_to_resource method usage example with argument unpacking
kwargs: AddLFTagsToResourceRequestRequestTypeDef = { # (1)
"Resource": ...,
"LFTags": ...,
}
parent.add_lf_tags_to_resource(**kwargs)assume_decorated_role_with_saml#
Allows a caller to assume an IAM role decorated as the SAML user specified in the SAML assertion included in the request.
Type annotations and code completion for boto3.client("lakeformation").assume_decorated_role_with_saml method.
boto3 documentation
# assume_decorated_role_with_saml method definition
def assume_decorated_role_with_saml(
self,
*,
SAMLAssertion: str,
RoleArn: str,
PrincipalArn: str,
DurationSeconds: int = ...,
) -> AssumeDecoratedRoleWithSAMLResponseTypeDef: # (1)
...# assume_decorated_role_with_saml method usage example with argument unpacking
kwargs: AssumeDecoratedRoleWithSAMLRequestRequestTypeDef = { # (1)
"SAMLAssertion": ...,
"RoleArn": ...,
"PrincipalArn": ...,
}
parent.assume_decorated_role_with_saml(**kwargs)batch_grant_permissions#
Batch operation to grant permissions to the principal.
Type annotations and code completion for boto3.client("lakeformation").batch_grant_permissions method.
boto3 documentation
# batch_grant_permissions method definition
def batch_grant_permissions(
self,
*,
Entries: Sequence[BatchPermissionsRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchGrantPermissionsResponseTypeDef: # (2)
...# batch_grant_permissions method usage example with argument unpacking
kwargs: BatchGrantPermissionsRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.batch_grant_permissions(**kwargs)batch_revoke_permissions#
Batch operation to revoke permissions from the principal.
Type annotations and code completion for boto3.client("lakeformation").batch_revoke_permissions method.
boto3 documentation
# batch_revoke_permissions method definition
def batch_revoke_permissions(
self,
*,
Entries: Sequence[BatchPermissionsRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchRevokePermissionsResponseTypeDef: # (2)
...# batch_revoke_permissions method usage example with argument unpacking
kwargs: BatchRevokePermissionsRequestRequestTypeDef = { # (1)
"Entries": ...,
}
parent.batch_revoke_permissions(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("lakeformation").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_transaction#
Attempts to cancel the specified transaction.
Type annotations and code completion for boto3.client("lakeformation").cancel_transaction method.
boto3 documentation
# cancel_transaction method definition
def cancel_transaction(
self,
*,
TransactionId: str,
) -> Dict[str, Any]:
...# cancel_transaction method usage example with argument unpacking
kwargs: CancelTransactionRequestRequestTypeDef = { # (1)
"TransactionId": ...,
}
parent.cancel_transaction(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("lakeformation").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...commit_transaction#
Attempts to commit the specified transaction.
Type annotations and code completion for boto3.client("lakeformation").commit_transaction method.
boto3 documentation
# commit_transaction method definition
def commit_transaction(
self,
*,
TransactionId: str,
) -> CommitTransactionResponseTypeDef: # (1)
...# commit_transaction method usage example with argument unpacking
kwargs: CommitTransactionRequestRequestTypeDef = { # (1)
"TransactionId": ...,
}
parent.commit_transaction(**kwargs)create_data_cells_filter#
Creates a data cell filter to allow one to grant access to certain columns on certain rows.
Type annotations and code completion for boto3.client("lakeformation").create_data_cells_filter method.
boto3 documentation
# create_data_cells_filter method definition
def create_data_cells_filter(
self,
*,
TableData: DataCellsFilterTypeDef, # (1)
) -> Dict[str, Any]:
...# create_data_cells_filter method usage example with argument unpacking
kwargs: CreateDataCellsFilterRequestRequestTypeDef = { # (1)
"TableData": ...,
}
parent.create_data_cells_filter(**kwargs)create_lake_formation_identity_center_configuration#
Creates an IAM Identity Center connection with Lake Formation to allow IAM Identity Center users and groups to access Data Catalog resources.
Type annotations and code completion for boto3.client("lakeformation").create_lake_formation_identity_center_configuration method.
boto3 documentation
# create_lake_formation_identity_center_configuration method definition
def create_lake_formation_identity_center_configuration(
self,
*,
CatalogId: str = ...,
InstanceArn: str = ...,
ExternalFiltering: ExternalFilteringConfigurationTypeDef = ..., # (1)
) -> CreateLakeFormationIdentityCenterConfigurationResponseTypeDef: # (2)
...- See ExternalFilteringConfigurationTypeDef
- See CreateLakeFormationIdentityCenterConfigurationResponseTypeDef
# create_lake_formation_identity_center_configuration method usage example with argument unpacking
kwargs: CreateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.create_lake_formation_identity_center_configuration(**kwargs)create_lake_formation_opt_in#
Enforce Lake Formation permissions for the given databases, tables, and principals.
Type annotations and code completion for boto3.client("lakeformation").create_lake_formation_opt_in method.
boto3 documentation
# create_lake_formation_opt_in method definition
def create_lake_formation_opt_in(
self,
*,
Principal: DataLakePrincipalTypeDef, # (1)
Resource: ResourceTypeDef, # (2)
) -> Dict[str, Any]:
...# create_lake_formation_opt_in method usage example with argument unpacking
kwargs: CreateLakeFormationOptInRequestRequestTypeDef = { # (1)
"Principal": ...,
"Resource": ...,
}
parent.create_lake_formation_opt_in(**kwargs)create_lf_tag#
Creates an LF-tag with the specified name and values.
Type annotations and code completion for boto3.client("lakeformation").create_lf_tag method.
boto3 documentation
# create_lf_tag method definition
def create_lf_tag(
self,
*,
TagKey: str,
TagValues: Sequence[str],
CatalogId: str = ...,
) -> Dict[str, Any]:
...# create_lf_tag method usage example with argument unpacking
kwargs: CreateLFTagRequestRequestTypeDef = { # (1)
"TagKey": ...,
"TagValues": ...,
}
parent.create_lf_tag(**kwargs)delete_data_cells_filter#
Deletes a data cell filter.
Type annotations and code completion for boto3.client("lakeformation").delete_data_cells_filter method.
boto3 documentation
# delete_data_cells_filter method definition
def delete_data_cells_filter(
self,
*,
TableCatalogId: str = ...,
DatabaseName: str = ...,
TableName: str = ...,
Name: str = ...,
) -> Dict[str, Any]:
...# delete_data_cells_filter method usage example with argument unpacking
kwargs: DeleteDataCellsFilterRequestRequestTypeDef = { # (1)
"TableCatalogId": ...,
}
parent.delete_data_cells_filter(**kwargs)delete_lake_formation_identity_center_configuration#
Deletes an IAM Identity Center connection with Lake Formation.
Type annotations and code completion for boto3.client("lakeformation").delete_lake_formation_identity_center_configuration method.
boto3 documentation
# delete_lake_formation_identity_center_configuration method definition
def delete_lake_formation_identity_center_configuration(
self,
*,
CatalogId: str = ...,
) -> Dict[str, Any]:
...# delete_lake_formation_identity_center_configuration method usage example with argument unpacking
kwargs: DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.delete_lake_formation_identity_center_configuration(**kwargs)delete_lake_formation_opt_in#
Remove the Lake Formation permissions enforcement of the given databases, tables, and principals.
Type annotations and code completion for boto3.client("lakeformation").delete_lake_formation_opt_in method.