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)
    "SAMLA