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
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.
client = boto3.client("lakeformation")
try:
do_something(client)
except (
client.AccessDeniedException,
client.AlreadyExistsException,
client.ClientError,
client.ConcurrentModificationException,
client.EntityNotFoundException,
client.ExpiredException,
client.GlueEncryptionException,
client.InternalServiceException,
client.InvalidInputException,
client.OperationTimeoutException,
client.PermissionTypeMismatchException,
client.ResourceNotReadyException,
client.ResourceNumberLimitExceededException,
client.StatisticsNotReadyYetException,
client.ThrottledException,
client.TransactionCanceledException,
client.TransactionCommitInProgressException,
client.TransactionCommittedException,
client.WorkUnitsNotReadyYetException,
) as e:
print(e)
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
def add_lf_tags_to_resource(
self,
*,
Resource: ResourceTypeDef, # (1)
LFTags: Sequence[LFTagPairTypeDef], # (2)
CatalogId: str = ...,
) -> AddLFTagsToResourceResponseTypeDef: # (3)
...
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
def assume_decorated_role_with_saml(
self,
*,
SAMLAssertion: str,
RoleArn: str,
PrincipalArn: str,
DurationSeconds: int = ...,
) -> AssumeDecoratedRoleWithSAMLResponseTypeDef: # (1)
...
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
def batch_grant_permissions(
self,
*,
Entries: Sequence[BatchPermissionsRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchGrantPermissionsResponseTypeDef: # (2)
...
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
def batch_revoke_permissions(
self,
*,
Entries: Sequence[BatchPermissionsRequestEntryTypeDef], # (1)
CatalogId: str = ...,
) -> BatchRevokePermissionsResponseTypeDef: # (2)
...
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
cancel_transaction
Attempts to cancel the specified transaction.
Type annotations and code completion for boto3.client("lakeformation").cancel_transaction
method.
boto3 documentation
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
commit_transaction
Attempts to commit the specified transaction.
Type annotations and code completion for boto3.client("lakeformation").commit_transaction
method.
boto3 documentation
def commit_transaction(
self,
*,
TransactionId: str,
) -> CommitTransactionResponseTypeDef: # (1)
...
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
def create_data_cells_filter(
self,
*,
TableData: DataCellsFilterTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: CreateDataCellsFilterRequestRequestTypeDef = { # (1)
"TableData": ...,
}
parent.create_data_cells_filter(**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
def create_lf_tag(
self,
*,
TagKey: str,
TagValues: Sequence[str],
CatalogId: str = ...,
) -> Dict[str, Any]:
...
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
def delete_data_cells_filter(
self,
*,
TableCatalogId: str = ...,
DatabaseName: str = ...,
TableName: str = ...,
Name: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteDataCellsFilterRequestRequestTypeDef = { # (1)
"TableCatalogId": ...,
}
parent.delete_data_cells_filter(**kwargs)
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
def delete_lf_tag(
self,
*,
TagKey: str,
CatalogId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteLFTagRequestRequestTypeDef = { # (1)
"TagKey": ...,
}
parent.delete_lf_tag(**kwargs)
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
def delete_objects_on_cancel(
self,
*,
DatabaseName: str,
TableName: str,
TransactionId: str,
Objects: Sequence[VirtualObjectTypeDef], # (1)
CatalogId: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteObjectsOnCancelRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"TransactionId": ...,
"Objects": ...,
}
parent.delete_objects_on_cancel(**kwargs)
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
kwargs: DeregisterResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.deregister_resource(**kwargs)
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
def describe_resource(
self,
*,
ResourceArn: str,
) -> DescribeResourceResponseTypeDef: # (1)
...
kwargs: DescribeResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.describe_resource(**kwargs)
describe_transaction
Returns the details of a single transaction.
Type annotations and code completion for boto3.client("lakeformation").describe_transaction
method.
boto3 documentation
def describe_transaction(
self,
*,
TransactionId: str,
) -> DescribeTransactionResponseTypeDef: # (1)
...
kwargs: DescribeTransactionRequestRequestTypeDef = { # (1)
"TransactionId": ...,
}
parent.describe_transaction(**kwargs)
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
def extend_transaction(
self,
*,
TransactionId: str = ...,
) -> Dict[str, Any]:
...
kwargs: ExtendTransactionRequestRequestTypeDef = { # (1)
"TransactionId": ...,
}
parent.extend_transaction(**kwargs)
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
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
def get_data_cells_filter(
self,
*,
TableCatalogId: str,
DatabaseName: str,
TableName: str,
Name: str,
) -> GetDataCellsFilterResponseTypeDef: # (1)
...
kwargs: GetDataCellsFilterRequestRequestTypeDef = { # (1)
"TableCatalogId": ...,
"DatabaseName": ...,
"TableName": ...,
"Name": ...,
}
parent.get_data_cells_filter(**kwargs)
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
def get_data_lake_settings(
self,
*,
CatalogId: str = ...,
) -> GetDataLakeSettingsResponseTypeDef: # (1)
...
kwargs: GetDataLakeSettingsRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.get_data_lake_settings(**kwargs)
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
def get_effective_permissions_for_path(
self,
*,
ResourceArn: str,
CatalogId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> GetEffectivePermissionsForPathResponseTypeDef: # (1)
...
kwargs: GetEffectivePermissionsForPathRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.get_effective_permissions_for_path(**kwargs)
get_lf_tag
Returns an LF-tag definition.
Type annotations and code completion for boto3.client("lakeformation").get_lf_tag
method.
boto3 documentation
def get_lf_tag(
self,
*,
TagKey: str,
CatalogId: str = ...,
) -> GetLFTagResponseTypeDef: # (1)
...
kwargs: GetLFTagRequestRequestTypeDef = { # (1)
"TagKey": ...,
}
parent.get_lf_tag(**kwargs)
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
def get_query_state(
self,
*,
QueryId: str,
) -> GetQueryStateResponseTypeDef: # (1)
...
kwargs: GetQueryStateRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.get_query_state(**kwargs)
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
def get_query_statistics(
self,
*,
QueryId: str,
) -> GetQueryStatisticsResponseTypeDef: # (1)
...
kwargs: GetQueryStatisticsRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.get_query_statistics(**kwargs)
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
def get_resource_lf_tags(
self,
*,
Resource: ResourceTypeDef, # (1)
CatalogId: str = ...,
ShowAssignedLFTags: bool = ...,
) -> GetResourceLFTagsResponseTypeDef: # (2)
...
kwargs: GetResourceLFTagsRequestRequestTypeDef = { # (1)
"Resource": ...,
}
parent.get_resource_lf_tags(**kwargs)
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
def get_table_objects(
self,
*,
DatabaseName: str,
TableName: str,
CatalogId: str = ...,
TransactionId: str = ...,
QueryAsOfTime: Union[datetime, str] = ...,
PartitionPredicate: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> GetTableObjectsResponseTypeDef: # (1)
...
kwargs: GetTableObjectsRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.get_table_objects(**kwargs)
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
def get_temporary_glue_partition_credentials(
self,
*,
TableArn: str,
Partition: PartitionValueListTypeDef, # (1)
SupportedPermissionTypes: Sequence[PermissionTypeType], # (2)
Permissions: Sequence[PermissionType] = ..., # (3)
DurationSeconds: int = ...,
AuditContext: AuditContextTypeDef = ..., # (4)
) -> GetTemporaryGluePartitionCredentialsResponseTypeDef: # (5)
...
- See PartitionValueListTypeDef
- See PermissionTypeType
- See PermissionType
- See AuditContextTypeDef
- See GetTemporaryGluePartitionCredentialsResponseTypeDef
kwargs: GetTemporaryGluePartitionCredentialsRequestRequestTypeDef = { # (1)
"TableArn": ...,
"Partition": ...,
"SupportedPermissionTypes": ...,
}
parent.get_temporary_glue_partition_credentials(**kwargs)
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
def get_temporary_glue_table_credentials(
self,
*,
TableArn: str,
SupportedPermissionTypes: Sequence[PermissionTypeType], # (1)
Permissions: Sequence[PermissionType] = ..., # (2)
DurationSeconds: int = ...,
AuditContext: AuditContextTypeDef = ..., # (3)
) -> GetTemporaryGlueTableCredentialsResponseTypeDef: # (4)
...
- See PermissionTypeType
- See PermissionType
- See AuditContextTypeDef
- See GetTemporaryGlueTableCredentialsResponseTypeDef
kwargs: GetTemporaryGlueTableCredentialsRequestRequestTypeDef = { # (1)
"TableArn": ...,
"SupportedPermissionTypes": ...,
}
parent.get_temporary_glue_table_credentials(**kwargs)
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
def get_work_unit_results(
self,
*,
QueryId: str,
WorkUnitId: int,
WorkUnitToken: str,
) -> GetWorkUnitResultsResponseTypeDef: # (1)
...
kwargs: GetWorkUnitResultsRequestRequestTypeDef = { # (1)
"QueryId": ...,
"WorkUnitId": ...,
"WorkUnitToken": ...,
}
parent.get_work_unit_results(**kwargs)
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
def get_work_units(
self,
*,
QueryId: str,
NextToken: str = ...,
PageSize: int = ...,
) -> GetWorkUnitsResponseTypeDef: # (1)
...
kwargs: GetWorkUnitsRequestRequestTypeDef = { # (1)
"QueryId": ...,
}
parent.get_work_units(**kwargs)
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
def grant_permissions(
self,
*,
Principal: DataLakePrincipalTypeDef, # (1)
Resource: ResourceTypeDef, # (2)
Permissions: Sequence[PermissionType], # (3)
CatalogId: str = ...,
PermissionsWithGrantOption: Sequence[PermissionType] = ..., # (3)
) -> Dict[str, Any]:
...
- See DataLakePrincipalTypeDef
- See ResourceTypeDef
- See PermissionType
- See PermissionType
kwargs: GrantPermissionsRequestRequestTypeDef = { # (1)
"Principal": ...,
"Resource": ...,
"Permissions": ...,
}
parent.grant_permissions(**kwargs)
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
def list_data_cells_filter(
self,
*,
Table: TableResourceTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataCellsFilterResponseTypeDef: # (2)
...
kwargs: ListDataCellsFilterRequestRequestTypeDef = { # (1)
"Table": ...,
}
parent.list_data_cells_filter(**kwargs)
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
def list_lf_tags(
self,
*,
CatalogId: str = ...,
ResourceShareType: ResourceShareTypeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListLFTagsResponseTypeDef: # (2)
...
kwargs: ListLFTagsRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.list_lf_tags(**kwargs)
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
def list_permissions(
self,
*,
CatalogId: str = ...,
Principal: DataLakePrincipalTypeDef = ..., # (1)
ResourceType: DataLakeResourceTypeType = ..., # (2)
Resource: ResourceTypeDef = ..., # (3)
NextToken: str = ...,
MaxResults: int = ...,
IncludeRelated: str = ...,
) -> ListPermissionsResponseTypeDef: # (4)
...
- See DataLakePrincipalTypeDef
- See DataLakeResourceTypeType
- See ResourceTypeDef
- See ListPermissionsResponseTypeDef
kwargs: ListPermissionsRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.list_permissions(**kwargs)
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
def list_resources(
self,
*,
FilterConditionList: Sequence[FilterConditionTypeDef] = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListResourcesResponseTypeDef: # (2)
...
kwargs: ListResourcesRequestRequestTypeDef = { # (1)
"FilterConditionList": ...,
}
parent.list_resources(**kwargs)
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
def list_table_storage_optimizers(
self,
*,
DatabaseName: str,
TableName: str,
CatalogId: str = ...,
StorageOptimizerType: OptimizerTypeType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTableStorageOptimizersResponseTypeDef: # (2)
...
kwargs: ListTableStorageOptimizersRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
}
parent.list_table_storage_optimizers(**kwargs)
list_transactions
Returns metadata about transactions and their status.
Type annotations and code completion for boto3.client("lakeformation").list_transactions
method.
boto3 documentation
def list_transactions(
self,
*,
CatalogId: str = ...,
StatusFilter: TransactionStatusFilterType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListTransactionsResponseTypeDef: # (2)
...
kwargs: ListTransactionsRequestRequestTypeDef = { # (1)
"CatalogId": ...,
}
parent.list_transactions(**kwargs)
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
def put_data_lake_settings(
self,
*,
DataLakeSettings: DataLakeSettingsTypeDef, # (1)
CatalogId: str = ...,
) -> Dict[str, Any]:
...
kwargs: PutDataLakeSettingsRequestRequestTypeDef = { # (1)
"DataLakeSettings": ...,
}
parent.put_data_lake_settings(**kwargs)
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
def register_resource(
self,
*,
ResourceArn: str,
UseServiceLinkedRole: bool = ...,
RoleArn: str = ...,
) -> Dict[str, Any]:
...
kwargs: RegisterResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.register_resource(**kwargs)
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
def remove_lf_tags_from_resource(
self,
*,
Resource: ResourceTypeDef, # (1)
LFTags: Sequence[LFTagPairTypeDef], # (2)
CatalogId: str = ...,
) -> RemoveLFTagsFromResourceResponseTypeDef: # (3)
...
kwargs: RemoveLFTagsFromResourceRequestRequestTypeDef = { # (1)
"Resource": ...,
"LFTags": ...,
}
parent.remove_lf_tags_from_resource(**kwargs)
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
def revoke_permissions(
self,
*,
Principal: DataLakePrincipalTypeDef, # (1)
Resource: ResourceTypeDef, # (2)
Permissions: Sequence[PermissionType], # (3)
CatalogId: str = ...,
PermissionsWithGrantOption: Sequence[PermissionType] = ..., # (3)
) -> Dict[str, Any]:
...
- See DataLakePrincipalTypeDef
- See ResourceTypeDef
- See PermissionType
- See PermissionType
kwargs: RevokePermissionsRequestRequestTypeDef = { # (1)
"Principal": ...,
"Resource": ...,
"Permissions": ...,
}
parent.revoke_permissions(**kwargs)
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
def search_databases_by_lf_tags(
self,
*,
Expression: Sequence[LFTagTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
CatalogId: str = ...,
) -> SearchDatabasesByLFTagsResponseTypeDef: # (2)
...
kwargs: SearchDatabasesByLFTagsRequestRequestTypeDef = { # (1)
"Expression": ...,
}
parent.search_databases_by_lf_tags(**kwargs)
search_tables_by_lf_tags
This operation allows a search on TABLE
resources by LFTag
s.
Type annotations and code completion for boto3.client("lakeformation").search_tables_by_lf_tags
method.
boto3 documentation
def search_tables_by_lf_tags(
self,
*,
Expression: Sequence[LFTagTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
CatalogId: str = ...,
) -> SearchTablesByLFTagsResponseTypeDef: # (2)
...
kwargs: SearchTablesByLFTagsRequestRequestTypeDef = { # (1)
"Expression": ...,
}
parent.search_tables_by_lf_tags(**kwargs)
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
def start_query_planning(
self,
*,
QueryPlanningContext: QueryPlanningContextTypeDef, # (1)
QueryString: str,
) -> StartQueryPlanningResponseTypeDef: # (2)
...
kwargs: StartQueryPlanningRequestRequestTypeDef = { # (1)
"QueryPlanningContext": ...,
"QueryString": ...,
}
parent.start_query_planning(**kwargs)
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
def start_transaction(
self,
*,
TransactionType: TransactionTypeType = ..., # (1)
) -> StartTransactionResponseTypeDef: # (2)
...
kwargs: StartTransactionRequestRequestTypeDef = { # (1)
"TransactionType": ...,
}
parent.start_transaction(**kwargs)
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
def update_data_cells_filter(
self,
*,
TableData: DataCellsFilterTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: UpdateDataCellsFilterRequestRequestTypeDef = { # (1)
"TableData": ...,
}
parent.update_data_cells_filter(**kwargs)
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
def update_lf_tag(
self,
*,
TagKey: str,
CatalogId: str = ...,
TagValuesToDelete: Sequence[str] = ...,
TagValuesToAdd: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateLFTagRequestRequestTypeDef = { # (1)
"TagKey": ...,
}
parent.update_lf_tag(**kwargs)
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
def update_resource(
self,
*,
RoleArn: str,
ResourceArn: str,
) -> Dict[str, Any]:
...
kwargs: UpdateResourceRequestRequestTypeDef = { # (1)
"RoleArn": ...,
"ResourceArn": ...,
}
parent.update_resource(**kwargs)
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
def update_table_objects(
self,
*,
DatabaseName: str,
TableName: str,
WriteOperations: Sequence[WriteOperationTypeDef], # (1)
CatalogId: str = ...,
TransactionId: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateTableObjectsRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"WriteOperations": ...,
}
parent.update_table_objects(**kwargs)
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
def update_table_storage_optimizer(
self,
*,
DatabaseName: str,
TableName: str,
StorageOptimizerConfig: Mapping[OptimizerTypeType, Mapping[str, str]], # (1)
CatalogId: str = ...,
) -> UpdateTableStorageOptimizerResponseTypeDef: # (2)
...
kwargs: UpdateTableStorageOptimizerRequestRequestTypeDef = { # (1)
"DatabaseName": ...,
"TableName": ...,
"StorageOptimizerConfig": ...,
}
parent.update_table_storage_optimizer(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("lakeformation").get_paginator
method with overloads.
client.get_paginator("get_work_units")
-> GetWorkUnitsPaginatorclient.get_paginator("list_data_cells_filter")
-> ListDataCellsFilterPaginatorclient.get_paginator("list_lf_tags")
-> ListLFTagsPaginatorclient.get_paginator("search_databases_by_lf_tags")
-> SearchDatabasesByLFTagsPaginatorclient.get_paginator("search_tables_by_lf_tags")
-> SearchTablesByLFTagsPaginator