Skip to content

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[LFTagPairUnionTypeDef],  # (2)
    CatalogId: str = ...,
) -> AddLFTagsToResourceResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeDef
  2. See LFTagPairTypeDef LFTagPairOutputTypeDef
  3. See AddLFTagsToResourceResponseTypeDef 
# add_lf_tags_to_resource method usage example with argument unpacking

kwargs: AddLFTagsToResourceRequestRequestTypeDef = {  # (1)
    "Resource": ...,
    "LFTags": ...,
}

parent.add_lf_tags_to_resource(**kwargs)
  1. See AddLFTagsToResourceRequestRequestTypeDef

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)
    ...
  1. See AssumeDecoratedRoleWithSAMLResponseTypeDef 
# assume_decorated_role_with_saml method usage example with argument unpacking

kwargs: AssumeDecoratedRoleWithSAMLRequestRequestTypeDef = {  # (1)
    "SAMLAssertion": ...,
    "RoleArn": ...,
    "PrincipalArn": ...,
}

parent.assume_decorated_role_with_saml(**kwargs)
  1. See AssumeDecoratedRoleWithSAMLRequestRequestTypeDef

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[BatchPermissionsRequestEntryUnionTypeDef],  # (1)
    CatalogId: str = ...,
) -> BatchGrantPermissionsResponseTypeDef:  # (2)
    ...
  1. See BatchPermissionsRequestEntryTypeDef BatchPermissionsRequestEntryOutputTypeDef
  2. See BatchGrantPermissionsResponseTypeDef 
# batch_grant_permissions method usage example with argument unpacking

kwargs: BatchGrantPermissionsRequestRequestTypeDef = {  # (1)
    "Entries": ...,
}

parent.batch_grant_permissions(**kwargs)
  1. See BatchGrantPermissionsRequestRequestTypeDef

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)
    ...
  1. See BatchPermissionsRequestEntryTypeDef
  2. See BatchRevokePermissionsResponseTypeDef 
# batch_revoke_permissions method usage example with argument unpacking

kwargs: BatchRevokePermissionsRequestRequestTypeDef = {  # (1)
    "Entries": ...,
}

parent.batch_revoke_permissions(**kwargs)
  1. See BatchRevokePermissionsRequestRequestTypeDef

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)
  1. See CancelTransactionRequestRequestTypeDef

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)
    ...
  1. See CommitTransactionResponseTypeDef 
# commit_transaction method usage example with argument unpacking

kwargs: CommitTransactionRequestRequestTypeDef = {  # (1)
    "TransactionId": ...,
}

parent.commit_transaction(**kwargs)
  1. See CommitTransactionRequestRequestTypeDef

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]:
    ...
  1. See DataCellsFilterTypeDef 
# create_data_cells_filter method usage example with argument unpacking

kwargs: CreateDataCellsFilterRequestRequestTypeDef = {  # (1)
    "TableData": ...,
}

parent.create_data_cells_filter(**kwargs)
  1. See CreateDataCellsFilterRequestRequestTypeDef

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)
    ShareRecipients: Sequence[DataLakePrincipalTypeDef] = ...,  # (2)
) -> CreateLakeFormationIdentityCenterConfigurationResponseTypeDef:  # (3)
    ...
  1. See ExternalFilteringConfigurationTypeDef
  2. See DataLakePrincipalTypeDef
  3. 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)
  1. See CreateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef

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]:
    ...
  1. See DataLakePrincipalTypeDef
  2. See ResourceTypeDef 
# create_lake_formation_opt_in method usage example with argument unpacking

kwargs: CreateLakeFormationOptInRequestRequestTypeDef = {  # (1)
    "Principal": ...,
    "Resource": ...,
}

parent.create_lake_formation_opt_in(**kwargs)
  1. See CreateLakeFormationOptInRequestRequestTypeDef

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)
  1. See CreateLFTagRequestRequestTypeDef

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)
  1. See DeleteDataCellsFilterRequestRequestTypeDef

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)
  1. See DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef

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. boto3 documentation

# delete_lake_formation_opt_in method definition

def delete_lake_formation_opt_in(
    self,
    *,
    Principal: DataLakePrincipalTypeDef,  # (1)
    Resource: ResourceTypeDef,  # (2)
) -> Dict[str, Any]:
    ...
  1. See DataLakePrincipalTypeDef
  2. See ResourceTypeDef 
# delete_lake_formation_opt_in method usage example with argument unpacking

kwargs: DeleteLakeFormationOptInRequestRequestTypeDef = {  # (1)
    "Principal": ...,
    "Resource": ...,
}

parent.delete_lake_formation_opt_in(**kwargs)
  1. See DeleteLakeFormationOptInRequestRequestTypeDef

delete_lf_tag#

Deletes the specified LF-tag given a key name.

Type annotations and code completion for boto3.client("lakeformation").delete_lf_tag method. boto3 documentation

# delete_lf_tag method definition

def delete_lf_tag(
    self,
    *,
    TagKey: str,
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_lf_tag method usage example with argument unpacking

kwargs: DeleteLFTagRequestRequestTypeDef = {  # (1)
    "TagKey": ...,
}

parent.delete_lf_tag(**kwargs)
  1. See DeleteLFTagRequestRequestTypeDef

delete_objects_on_cancel#

For a specific governed table, provides a list of Amazon S3 objects that will be written during the current transaction and that can be automatically deleted if the transaction is canceled.

Type annotations and code completion for boto3.client("lakeformation").delete_objects_on_cancel method. boto3 documentation

# delete_objects_on_cancel method definition

def delete_objects_on_cancel(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    TransactionId: str,
    Objects: Sequence[VirtualObjectTypeDef],  # (1)
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See VirtualObjectTypeDef 
# delete_objects_on_cancel method usage example with argument unpacking

kwargs: DeleteObjectsOnCancelRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "TransactionId": ...,
    "Objects": ...,
}

parent.delete_objects_on_cancel(**kwargs)
  1. See DeleteObjectsOnCancelRequestRequestTypeDef

deregister_resource#

Deregisters the resource as managed by the Data Catalog.

Type annotations and code completion for boto3.client("lakeformation").deregister_resource method. boto3 documentation

# deregister_resource method definition

def deregister_resource(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...
# deregister_resource method usage example with argument unpacking

kwargs: DeregisterResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.deregister_resource(**kwargs)
  1. See DeregisterResourceRequestRequestTypeDef

describe_lake_formation_identity_center_configuration#

Retrieves the instance ARN and application ARN for the connection.

Type annotations and code completion for boto3.client("lakeformation").describe_lake_formation_identity_center_configuration method. boto3 documentation

# describe_lake_formation_identity_center_configuration method definition

def describe_lake_formation_identity_center_configuration(
    self,
    *,
    CatalogId: str = ...,
) -> DescribeLakeFormationIdentityCenterConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeLakeFormationIdentityCenterConfigurationResponseTypeDef 
# describe_lake_formation_identity_center_configuration method usage example with argument unpacking

kwargs: DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.describe_lake_formation_identity_center_configuration(**kwargs)
  1. See DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef

describe_resource#

Retrieves the current data access role for the given resource registered in Lake Formation.

Type annotations and code completion for boto3.client("lakeformation").describe_resource method. boto3 documentation

# describe_resource method definition

def describe_resource(
    self,
    *,
    ResourceArn: str,
) -> DescribeResourceResponseTypeDef:  # (1)
    ...
  1. See DescribeResourceResponseTypeDef 
# describe_resource method usage example with argument unpacking

kwargs: DescribeResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.describe_resource(**kwargs)
  1. See DescribeResourceRequestRequestTypeDef

describe_transaction#

Returns the details of a single transaction.

Type annotations and code completion for boto3.client("lakeformation").describe_transaction method. boto3 documentation

# describe_transaction method definition

def describe_transaction(
    self,
    *,
    TransactionId: str,
) -> DescribeTransactionResponseTypeDef:  # (1)
    ...
  1. See DescribeTransactionResponseTypeDef 
# describe_transaction method usage example with argument unpacking

kwargs: DescribeTransactionRequestRequestTypeDef = {  # (1)
    "TransactionId": ...,
}

parent.describe_transaction(**kwargs)
  1. See DescribeTransactionRequestRequestTypeDef

extend_transaction#

Indicates to the service that the specified transaction is still active and should not be treated as idle and aborted.

Type annotations and code completion for boto3.client("lakeformation").extend_transaction method. boto3 documentation

# extend_transaction method definition

def extend_transaction(
    self,
    *,
    TransactionId: str = ...,
) -> Dict[str, Any]:
    ...
# extend_transaction method usage example with argument unpacking

kwargs: ExtendTransactionRequestRequestTypeDef = {  # (1)
    "TransactionId": ...,
}

parent.extend_transaction(**kwargs)
  1. See ExtendTransactionRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("lakeformation").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_data_cells_filter#

Returns a data cells filter.

Type annotations and code completion for boto3.client("lakeformation").get_data_cells_filter method. boto3 documentation

# get_data_cells_filter method definition

def get_data_cells_filter(
    self,
    *,
    TableCatalogId: str,
    DatabaseName: str,
    TableName: str,
    Name: str,
) -> GetDataCellsFilterResponseTypeDef:  # (1)
    ...
  1. See GetDataCellsFilterResponseTypeDef 
# get_data_cells_filter method usage example with argument unpacking

kwargs: GetDataCellsFilterRequestRequestTypeDef = {  # (1)
    "TableCatalogId": ...,
    "DatabaseName": ...,
    "TableName": ...,
    "Name": ...,
}

parent.get_data_cells_filter(**kwargs)
  1. See GetDataCellsFilterRequestRequestTypeDef

get_data_lake_principal#

Returns the identity of the invoking principal.

Type annotations and code completion for boto3.client("lakeformation").get_data_lake_principal method. boto3 documentation

# get_data_lake_principal method definition

def get_data_lake_principal(
    self,
) -> GetDataLakePrincipalResponseTypeDef:  # (1)
    ...
  1. See GetDataLakePrincipalResponseTypeDef

get_data_lake_settings#

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

Type annotations and code completion for boto3.client("lakeformation").get_data_lake_settings method. boto3 documentation

# get_data_lake_settings method definition

def get_data_lake_settings(
    self,
    *,
    CatalogId: str = ...,
) -> GetDataLakeSettingsResponseTypeDef:  # (1)
    ...
  1. See GetDataLakeSettingsResponseTypeDef 
# get_data_lake_settings method usage example with argument unpacking

kwargs: GetDataLakeSettingsRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.get_data_lake_settings(**kwargs)
  1. See GetDataLakeSettingsRequestRequestTypeDef

get_effective_permissions_for_path#

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3.

Type annotations and code completion for boto3.client("lakeformation").get_effective_permissions_for_path method. boto3 documentation

# get_effective_permissions_for_path method definition

def get_effective_permissions_for_path(
    self,
    *,
    ResourceArn: str,
    CatalogId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetEffectivePermissionsForPathResponseTypeDef:  # (1)
    ...
  1. See GetEffectivePermissionsForPathResponseTypeDef 
# get_effective_permissions_for_path method usage example with argument unpacking

kwargs: GetEffectivePermissionsForPathRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.get_effective_permissions_for_path(**kwargs)
  1. See GetEffectivePermissionsForPathRequestRequestTypeDef

get_lf_tag#

Returns an LF-tag definition.

Type annotations and code completion for boto3.client("lakeformation").get_lf_tag method. boto3 documentation

# get_lf_tag method definition

def get_lf_tag(
    self,
    *,
    TagKey: str,
    CatalogId: str = ...,
) -> GetLFTagResponseTypeDef:  # (1)
    ...
  1. See GetLFTagResponseTypeDef 
# get_lf_tag method usage example with argument unpacking

kwargs: GetLFTagRequestRequestTypeDef = {  # (1)
    "TagKey": ...,
}

parent.get_lf_tag(**kwargs)
  1. See GetLFTagRequestRequestTypeDef

get_query_state#

Returns the state of a query previously submitted.

Type annotations and code completion for boto3.client("lakeformation").get_query_state method. boto3 documentation

# get_query_state method definition

def get_query_state(
    self,
    *,
    QueryId: str,
) -> GetQueryStateResponseTypeDef:  # (1)
    ...
  1. See GetQueryStateResponseTypeDef 
# get_query_state method usage example with argument unpacking

kwargs: GetQueryStateRequestRequestTypeDef = {  # (1)
    "QueryId": ...,
}

parent.get_query_state(**kwargs)
  1. See GetQueryStateRequestRequestTypeDef

get_query_statistics#

Retrieves statistics on the planning and execution of a query.

Type annotations and code completion for boto3.client("lakeformation").get_query_statistics method. boto3 documentation

# get_query_statistics method definition

def get_query_statistics(
    self,
    *,
    QueryId: str,
) -> GetQueryStatisticsResponseTypeDef:  # (1)
    ...
  1. See GetQueryStatisticsResponseTypeDef 
# get_query_statistics method usage example with argument unpacking

kwargs: GetQueryStatisticsRequestRequestTypeDef = {  # (1)
    "QueryId": ...,
}

parent.get_query_statistics(**kwargs)
  1. See GetQueryStatisticsRequestRequestTypeDef

get_resource_lf_tags#

Returns the LF-tags applied to a resource.

Type annotations and code completion for boto3.client("lakeformation").get_resource_lf_tags method. boto3 documentation

# get_resource_lf_tags method definition

def get_resource_lf_tags(
    self,
    *,
    Resource: ResourceTypeDef,  # (1)
    CatalogId: str = ...,
    ShowAssignedLFTags: bool = ...,
) -> GetResourceLFTagsResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeDef
  2. See GetResourceLFTagsResponseTypeDef 
# get_resource_lf_tags method usage example with argument unpacking

kwargs: GetResourceLFTagsRequestRequestTypeDef = {  # (1)
    "Resource": ...,
}

parent.get_resource_lf_tags(**kwargs)
  1. See GetResourceLFTagsRequestRequestTypeDef

get_table_objects#

Returns the set of Amazon S3 objects that make up the specified governed table.

Type annotations and code completion for boto3.client("lakeformation").get_table_objects method. boto3 documentation

# get_table_objects method definition

def get_table_objects(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    CatalogId: str = ...,
    TransactionId: str = ...,
    QueryAsOfTime: TimestampTypeDef = ...,
    PartitionPredicate: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTableObjectsResponseTypeDef:  # (1)
    ...
  1. See GetTableObjectsResponseTypeDef 
# get_table_objects method usage example with argument unpacking

kwargs: GetTableObjectsRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

parent.get_table_objects(**kwargs)
  1. See GetTableObjectsRequestRequestTypeDef

get_temporary_glue_partition_credentials#

This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition.

Type annotations and code completion for boto3.client("lakeformation").get_temporary_glue_partition_credentials method. boto3 documentation

# get_temporary_glue_partition_credentials method definition

def get_temporary_glue_partition_credentials(
    self,
    *,
    TableArn: str,
    Partition: PartitionValueListTypeDef,  # (1)
    Permissions: Sequence[PermissionType] = ...,  # (2)
    DurationSeconds: int = ...,
    AuditContext: AuditContextTypeDef = ...,  # (3)
    SupportedPermissionTypes: Sequence[PermissionTypeType] = ...,  # (4)
) -> GetTemporaryGluePartitionCredentialsResponseTypeDef:  # (5)
    ...
  1. See PartitionValueListTypeDef
  2. See PermissionType
  3. See AuditContextTypeDef
  4. See PermissionTypeType
  5. See GetTemporaryGluePartitionCredentialsResponseTypeDef 
# get_temporary_glue_partition_credentials method usage example with argument unpacking

kwargs: GetTemporaryGluePartitionCredentialsRequestRequestTypeDef = {  # (1)
    "TableArn": ...,
    "Partition": ...,
}

parent.get_temporary_glue_partition_credentials(**kwargs)
  1. See GetTemporaryGluePartitionCredentialsRequestRequestTypeDef

get_temporary_glue_table_credentials#

Allows a caller in a secure environment to assume a role with permission to access Amazon S3.

Type annotations and code completion for boto3.client("lakeformation").get_temporary_glue_table_credentials method. boto3 documentation

# get_temporary_glue_table_credentials method definition

def get_temporary_glue_table_credentials(
    self,
    *,
    TableArn: str,
    Permissions: Sequence[PermissionType] = ...,  # (1)
    DurationSeconds: int = ...,
    AuditContext: AuditContextTypeDef = ...,  # (2)
    SupportedPermissionTypes: Sequence[PermissionTypeType] = ...,  # (3)
    S3Path: str = ...,
    QuerySessionContext: QuerySessionContextTypeDef = ...,  # (4)
) -> GetTemporaryGlueTableCredentialsResponseTypeDef:  # (5)
    ...
  1. See PermissionType
  2. See AuditContextTypeDef
  3. See PermissionTypeType
  4. See QuerySessionContextTypeDef
  5. See GetTemporaryGlueTableCredentialsResponseTypeDef 
# get_temporary_glue_table_credentials method usage example with argument unpacking

kwargs: GetTemporaryGlueTableCredentialsRequestRequestTypeDef = {  # (1)
    "TableArn": ...,
}

parent.get_temporary_glue_table_credentials(**kwargs)
  1. See GetTemporaryGlueTableCredentialsRequestRequestTypeDef

get_work_unit_results#

Returns the work units resulting from the query.

Type annotations and code completion for boto3.client("lakeformation").get_work_unit_results method. boto3 documentation

# get_work_unit_results method definition

def get_work_unit_results(
    self,
    *,
    QueryId: str,
    WorkUnitId: int,
    WorkUnitToken: str,
) -> GetWorkUnitResultsResponseTypeDef:  # (1)
    ...
  1. See GetWorkUnitResultsResponseTypeDef 
# get_work_unit_results method usage example with argument unpacking

kwargs: GetWorkUnitResultsRequestRequestTypeDef = {  # (1)
    "QueryId": ...,
    "WorkUnitId": ...,
    "WorkUnitToken": ...,
}

parent.get_work_unit_results(**kwargs)
  1. See GetWorkUnitResultsRequestRequestTypeDef

get_work_units#

Retrieves the work units generated by the StartQueryPlanning operation.

Type annotations and code completion for boto3.client("lakeformation").get_work_units method. boto3 documentation

# get_work_units method definition

def get_work_units(
    self,
    *,
    QueryId: str,
    NextToken: str = ...,
    PageSize: int = ...,
) -> GetWorkUnitsResponseTypeDef:  # (1)
    ...
  1. See GetWorkUnitsResponseTypeDef 
# get_work_units method usage example with argument unpacking

kwargs: GetWorkUnitsRequestRequestTypeDef = {  # (1)
    "QueryId": ...,
}

parent.get_work_units(**kwargs)
  1. See GetWorkUnitsRequestRequestTypeDef

grant_permissions#

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Type annotations and code completion for boto3.client("lakeformation").grant_permissions method. boto3 documentation

# grant_permissions method definition

def grant_permissions(
    self,
    *,
    Principal: DataLakePrincipalTypeDef,  # (1)
    Resource: ResourceTypeDef,  # (2)
    Permissions: Sequence[PermissionType],  # (3)
    CatalogId: str = ...,
    PermissionsWithGrantOption: Sequence[PermissionType] = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See DataLakePrincipalTypeDef
  2. See ResourceTypeDef
  3. See PermissionType
  4. See PermissionType 
# grant_permissions method usage example with argument unpacking

kwargs: GrantPermissionsRequestRequestTypeDef = {  # (1)
    "Principal": ...,
    "Resource": ...,
    "Permissions": ...,
}

parent.grant_permissions(**kwargs)
  1. See GrantPermissionsRequestRequestTypeDef

list_data_cells_filter#

Lists all the data cell filters on a table.

Type annotations and code completion for boto3.client("lakeformation").list_data_cells_filter method. boto3 documentation

# list_data_cells_filter method definition

def list_data_cells_filter(
    self,
    *,
    Table: TableResourceTypeDef = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataCellsFilterResponseTypeDef:  # (2)
    ...
  1. See TableResourceTypeDef
  2. See ListDataCellsFilterResponseTypeDef 
# list_data_cells_filter method usage example with argument unpacking

kwargs: ListDataCellsFilterRequestRequestTypeDef = {  # (1)
    "Table": ...,
}

parent.list_data_cells_filter(**kwargs)
  1. See ListDataCellsFilterRequestRequestTypeDef

list_lake_formation_opt_ins#

Retrieve the current list of resources and principals that are opt in to enforce Lake Formation permissions.

Type annotations and code completion for boto3.client("lakeformation").list_lake_formation_opt_ins method. boto3 documentation

# list_lake_formation_opt_ins method definition

def list_lake_formation_opt_ins(
    self,
    *,
    Principal: DataLakePrincipalTypeDef = ...,  # (1)
    Resource: ResourceTypeDef = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLakeFormationOptInsResponseTypeDef:  # (3)
    ...
  1. See DataLakePrincipalTypeDef
  2. See ResourceTypeDef
  3. See ListLakeFormationOptInsResponseTypeDef 
# list_lake_formation_opt_ins method usage example with argument unpacking

kwargs: ListLakeFormationOptInsRequestRequestTypeDef = {  # (1)
    "Principal": ...,
}

parent.list_lake_formation_opt_ins(**kwargs)
  1. See ListLakeFormationOptInsRequestRequestTypeDef

list_lf_tags#

Lists LF-tags that the requester has permission to view.

Type annotations and code completion for boto3.client("lakeformation").list_lf_tags method. boto3 documentation

# list_lf_tags method definition

def list_lf_tags(
    self,
    *,
    CatalogId: str = ...,
    ResourceShareType: ResourceShareTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLFTagsResponseTypeDef:  # (2)
    ...
  1. See ResourceShareTypeType
  2. See ListLFTagsResponseTypeDef 
# list_lf_tags method usage example with argument unpacking

kwargs: ListLFTagsRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.list_lf_tags(**kwargs)
  1. See ListLFTagsRequestRequestTypeDef

list_permissions#

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller.

Type annotations and code completion for boto3.client("lakeformation").list_permissions method. boto3 documentation

# list_permissions method definition

def list_permissions(
    self,
    *,
    CatalogId: str = ...,
    Principal: DataLakePrincipalTypeDef = ...,  # (1)
    ResourceType: DataLakeResourceTypeType = ...,  # (2)
    Resource: ResourceTypeDef = ...,  # (3)
    NextToken: str = ...,
    MaxResults: int = ...,
    IncludeRelated: str = ...,
) -> ListPermissionsResponseTypeDef:  # (4)
    ...
  1. See DataLakePrincipalTypeDef
  2. See DataLakeResourceTypeType
  3. See ResourceTypeDef
  4. See ListPermissionsResponseTypeDef 
# list_permissions method usage example with argument unpacking

kwargs: ListPermissionsRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.list_permissions(**kwargs)
  1. See ListPermissionsRequestRequestTypeDef

list_resources#

Lists the resources registered to be managed by the Data Catalog.

Type annotations and code completion for boto3.client("lakeformation").list_resources method. boto3 documentation

# list_resources method definition

def list_resources(
    self,
    *,
    FilterConditionList: Sequence[FilterConditionTypeDef] = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListResourcesResponseTypeDef:  # (2)
    ...
  1. See FilterConditionTypeDef
  2. See ListResourcesResponseTypeDef 
# list_resources method usage example with argument unpacking

kwargs: ListResourcesRequestRequestTypeDef = {  # (1)
    "FilterConditionList": ...,
}

parent.list_resources(**kwargs)
  1. See ListResourcesRequestRequestTypeDef

list_table_storage_optimizers#

Returns the configuration of all storage optimizers associated with a specified table.

Type annotations and code completion for boto3.client("lakeformation").list_table_storage_optimizers method. boto3 documentation

# list_table_storage_optimizers method definition

def list_table_storage_optimizers(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    CatalogId: str = ...,
    StorageOptimizerType: OptimizerTypeType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTableStorageOptimizersResponseTypeDef:  # (2)
    ...
  1. See OptimizerTypeType
  2. See ListTableStorageOptimizersResponseTypeDef 
# list_table_storage_optimizers method usage example with argument unpacking

kwargs: ListTableStorageOptimizersRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
}

parent.list_table_storage_optimizers(**kwargs)
  1. See ListTableStorageOptimizersRequestRequestTypeDef

list_transactions#

Returns metadata about transactions and their status.

Type annotations and code completion for boto3.client("lakeformation").list_transactions method. boto3 documentation

# list_transactions method definition

def list_transactions(
    self,
    *,
    CatalogId: str = ...,
    StatusFilter: TransactionStatusFilterType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTransactionsResponseTypeDef:  # (2)
    ...
  1. See TransactionStatusFilterType
  2. See ListTransactionsResponseTypeDef 
# list_transactions method usage example with argument unpacking

kwargs: ListTransactionsRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.list_transactions(**kwargs)
  1. See ListTransactionsRequestRequestTypeDef

put_data_lake_settings#

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation.

Type annotations and code completion for boto3.client("lakeformation").put_data_lake_settings method. boto3 documentation

# put_data_lake_settings method definition

def put_data_lake_settings(
    self,
    *,
    DataLakeSettings: DataLakeSettingsTypeDef,  # (1)
    CatalogId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See DataLakeSettingsTypeDef 
# put_data_lake_settings method usage example with argument unpacking

kwargs: PutDataLakeSettingsRequestRequestTypeDef = {  # (1)
    "DataLakeSettings": ...,
}

parent.put_data_lake_settings(**kwargs)
  1. See PutDataLakeSettingsRequestRequestTypeDef

register_resource#

Registers the resource as managed by the Data Catalog.

Type annotations and code completion for boto3.client("lakeformation").register_resource method. boto3 documentation

# register_resource method definition

def register_resource(
    self,
    *,
    ResourceArn: str,
    UseServiceLinkedRole: bool = ...,
    RoleArn: str = ...,
    WithFederation: bool = ...,
    HybridAccessEnabled: bool = ...,
) -> Dict[str, Any]:
    ...
# register_resource method usage example with argument unpacking

kwargs: RegisterResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.register_resource(**kwargs)
  1. See RegisterResourceRequestRequestTypeDef

remove_lf_tags_from_resource#

Removes an LF-tag from the resource.

Type annotations and code completion for boto3.client("lakeformation").remove_lf_tags_from_resource method. boto3 documentation

# remove_lf_tags_from_resource method definition

def remove_lf_tags_from_resource(
    self,
    *,
    Resource: ResourceTypeDef,  # (1)
    LFTags: Sequence[LFTagPairTypeDef],  # (2)
    CatalogId: str = ...,
) -> RemoveLFTagsFromResourceResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeDef
  2. See LFTagPairTypeDef
  3. See RemoveLFTagsFromResourceResponseTypeDef 
# remove_lf_tags_from_resource method usage example with argument unpacking

kwargs: RemoveLFTagsFromResourceRequestRequestTypeDef = {  # (1)
    "Resource": ...,
    "LFTags": ...,
}

parent.remove_lf_tags_from_resource(**kwargs)
  1. See RemoveLFTagsFromResourceRequestRequestTypeDef

revoke_permissions#

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

Type annotations and code completion for boto3.client("lakeformation").revoke_permissions method. boto3 documentation

# revoke_permissions method definition

def revoke_permissions(
    self,
    *,
    Principal: DataLakePrincipalTypeDef,  # (1)
    Resource: ResourceTypeDef,  # (2)
    Permissions: Sequence[PermissionType],  # (3)
    CatalogId: str = ...,
    PermissionsWithGrantOption: Sequence[PermissionType] = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See DataLakePrincipalTypeDef
  2. See ResourceTypeDef
  3. See PermissionType
  4. See PermissionType 
# revoke_permissions method usage example with argument unpacking

kwargs: RevokePermissionsRequestRequestTypeDef = {  # (1)
    "Principal": ...,
    "Resource": ...,
    "Permissions": ...,
}

parent.revoke_permissions(**kwargs)
  1. See RevokePermissionsRequestRequestTypeDef

search_databases_by_lf_tags#

This operation allows a search on DATABASE resources by TagCondition.

Type annotations and code completion for boto3.client("lakeformation").search_databases_by_lf_tags method. boto3 documentation

# search_databases_by_lf_tags method definition

def search_databases_by_lf_tags(
    self,
    *,
    Expression: Sequence[LFTagUnionTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    CatalogId: str = ...,
) -> SearchDatabasesByLFTagsResponseTypeDef:  # (2)
    ...
  1. See LFTagTypeDef LFTagOutputTypeDef
  2. See SearchDatabasesByLFTagsResponseTypeDef 
# search_databases_by_lf_tags method usage example with argument unpacking

kwargs: SearchDatabasesByLFTagsRequestRequestTypeDef = {  # (1)
    "Expression": ...,
}

parent.search_databases_by_lf_tags(**kwargs)
  1. See SearchDatabasesByLFTagsRequestRequestTypeDef

search_tables_by_lf_tags#

This operation allows a search on TABLE resources by LFTags.

Type annotations and code completion for boto3.client("lakeformation").search_tables_by_lf_tags method. boto3 documentation

# search_tables_by_lf_tags method definition

def search_tables_by_lf_tags(
    self,
    *,
    Expression: Sequence[LFTagTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    CatalogId: str = ...,
) -> SearchTablesByLFTagsResponseTypeDef:  # (2)
    ...
  1. See LFTagTypeDef
  2. See SearchTablesByLFTagsResponseTypeDef 
# search_tables_by_lf_tags method usage example with argument unpacking

kwargs: SearchTablesByLFTagsRequestRequestTypeDef = {  # (1)
    "Expression": ...,
}

parent.search_tables_by_lf_tags(**kwargs)
  1. See SearchTablesByLFTagsRequestRequestTypeDef

start_query_planning#

Submits a request to process a query statement.

Type annotations and code completion for boto3.client("lakeformation").start_query_planning method. boto3 documentation

# start_query_planning method definition

def start_query_planning(
    self,
    *,
    QueryPlanningContext: QueryPlanningContextTypeDef,  # (1)
    QueryString: str,
) -> StartQueryPlanningResponseTypeDef:  # (2)
    ...
  1. See QueryPlanningContextTypeDef
  2. See StartQueryPlanningResponseTypeDef 
# start_query_planning method usage example with argument unpacking

kwargs: StartQueryPlanningRequestRequestTypeDef = {  # (1)
    "QueryPlanningContext": ...,
    "QueryString": ...,
}

parent.start_query_planning(**kwargs)
  1. See StartQueryPlanningRequestRequestTypeDef

start_transaction#

Starts a new transaction and returns its transaction ID.

Type annotations and code completion for boto3.client("lakeformation").start_transaction method. boto3 documentation

# start_transaction method definition

def start_transaction(
    self,
    *,
    TransactionType: TransactionTypeType = ...,  # (1)
) -> StartTransactionResponseTypeDef:  # (2)
    ...
  1. See TransactionTypeType
  2. See StartTransactionResponseTypeDef 
# start_transaction method usage example with argument unpacking

kwargs: StartTransactionRequestRequestTypeDef = {  # (1)
    "TransactionType": ...,
}

parent.start_transaction(**kwargs)
  1. See StartTransactionRequestRequestTypeDef

update_data_cells_filter#

Updates a data cell filter.

Type annotations and code completion for boto3.client("lakeformation").update_data_cells_filter method. boto3 documentation

# update_data_cells_filter method definition

def update_data_cells_filter(
    self,
    *,
    TableData: DataCellsFilterTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See DataCellsFilterTypeDef 
# update_data_cells_filter method usage example with argument unpacking

kwargs: UpdateDataCellsFilterRequestRequestTypeDef = {  # (1)
    "TableData": ...,
}

parent.update_data_cells_filter(**kwargs)
  1. See UpdateDataCellsFilterRequestRequestTypeDef

update_lake_formation_identity_center_configuration#

Updates the IAM Identity Center connection parameters.

Type annotations and code completion for boto3.client("lakeformation").update_lake_formation_identity_center_configuration method. boto3 documentation

# update_lake_formation_identity_center_configuration method definition

def update_lake_formation_identity_center_configuration(
    self,
    *,
    CatalogId: str = ...,
    ShareRecipients: Sequence[DataLakePrincipalTypeDef] = ...,  # (1)
    ApplicationStatus: ApplicationStatusType = ...,  # (2)
    ExternalFiltering: ExternalFilteringConfigurationTypeDef = ...,  # (3)
) -> Dict[str, Any]:
    ...
  1. See DataLakePrincipalTypeDef
  2. See ApplicationStatusType
  3. See ExternalFilteringConfigurationTypeDef 
# update_lake_formation_identity_center_configuration method usage example with argument unpacking

kwargs: UpdateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef = {  # (1)
    "CatalogId": ...,
}

parent.update_lake_formation_identity_center_configuration(**kwargs)
  1. See UpdateLakeFormationIdentityCenterConfigurationRequestRequestTypeDef

update_lf_tag#

Updates the list of possible values for the specified LF-tag key.

Type annotations and code completion for boto3.client("lakeformation").update_lf_tag method. boto3 documentation

# update_lf_tag method definition

def update_lf_tag(
    self,
    *,
    TagKey: str,
    CatalogId: str = ...,
    TagValuesToDelete: Sequence[str] = ...,
    TagValuesToAdd: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
# update_lf_tag method usage example with argument unpacking

kwargs: UpdateLFTagRequestRequestTypeDef = {  # (1)
    "TagKey": ...,
}

parent.update_lf_tag(**kwargs)
  1. See UpdateLFTagRequestRequestTypeDef

update_resource#

Updates the data access role used for vending access to the given (registered) resource in Lake Formation.

Type annotations and code completion for boto3.client("lakeformation").update_resource method. boto3 documentation

# update_resource method definition

def update_resource(
    self,
    *,
    RoleArn: str,
    ResourceArn: str,
    WithFederation: bool = ...,
    HybridAccessEnabled: bool = ...,
) -> Dict[str, Any]:
    ...
# update_resource method usage example with argument unpacking

kwargs: UpdateResourceRequestRequestTypeDef = {  # (1)
    "RoleArn": ...,
    "ResourceArn": ...,
}

parent.update_resource(**kwargs)
  1. See UpdateResourceRequestRequestTypeDef

update_table_objects#

Updates the manifest of Amazon S3 objects that make up the specified governed table.

Type annotations and code completion for boto3.client("lakeformation").update_table_objects method. boto3 documentation

# update_table_objects method definition

def update_table_objects(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    WriteOperations: Sequence[WriteOperationTypeDef],  # (1)
    CatalogId: str = ...,
    TransactionId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See WriteOperationTypeDef 
# update_table_objects method usage example with argument unpacking

kwargs: UpdateTableObjectsRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "WriteOperations": ...,
}

parent.update_table_objects(**kwargs)
  1. See UpdateTableObjectsRequestRequestTypeDef

update_table_storage_optimizer#

Updates the configuration of the storage optimizers for a table.

Type annotations and code completion for boto3.client("lakeformation").update_table_storage_optimizer method. boto3 documentation

# update_table_storage_optimizer method definition

def update_table_storage_optimizer(
    self,
    *,
    DatabaseName: str,
    TableName: str,
    StorageOptimizerConfig: Mapping[OptimizerTypeType, Mapping[str, str]],  # (1)
    CatalogId: str = ...,
) -> UpdateTableStorageOptimizerResponseTypeDef:  # (2)
    ...
  1. See OptimizerTypeType
  2. See UpdateTableStorageOptimizerResponseTypeDef 
# update_table_storage_optimizer method usage example with argument unpacking

kwargs: UpdateTableStorageOptimizerRequestRequestTypeDef = {  # (1)
    "DatabaseName": ...,
    "TableName": ...,
    "StorageOptimizerConfig": ...,
}

parent.update_table_storage_optimizer(**kwargs)
  1. See UpdateTableStorageOptimizerRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("lakeformation").get_paginator method with overloads.