Skip to content

Type definitions#

Index > LakeFormation > Type definitions

Auto-generated documentation for LakeFormation type annotations stubs module mypy-boto3-lakeformation.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

LFTagPairTypeDef#

# LFTagPairTypeDef definition

class LFTagPairTypeDef(TypedDict):
    TagKey: str,
    TagValues: Sequence[str],
    CatalogId: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

AddObjectInputTypeDef#

# AddObjectInputTypeDef definition

class AddObjectInputTypeDef(TypedDict):
    Uri: str,
    ETag: str,
    Size: int,
    PartitionValues: NotRequired[Sequence[str]],

AssumeDecoratedRoleWithSAMLRequestRequestTypeDef#

# AssumeDecoratedRoleWithSAMLRequestRequestTypeDef definition

class AssumeDecoratedRoleWithSAMLRequestRequestTypeDef(TypedDict):
    SAMLAssertion: str,
    RoleArn: str,
    PrincipalArn: str,
    DurationSeconds: NotRequired[int],

AuditContextTypeDef#

# AuditContextTypeDef definition

class AuditContextTypeDef(TypedDict):
    AdditionalAuditContext: NotRequired[str],

ErrorDetailTypeDef#

# ErrorDetailTypeDef definition

class ErrorDetailTypeDef(TypedDict):
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],

DataLakePrincipalTypeDef#

# DataLakePrincipalTypeDef definition

class DataLakePrincipalTypeDef(TypedDict):
    DataLakePrincipalIdentifier: NotRequired[str],

CancelTransactionRequestRequestTypeDef#

# CancelTransactionRequestRequestTypeDef definition

class CancelTransactionRequestRequestTypeDef(TypedDict):
    TransactionId: str,

LFTagPairPaginatorTypeDef#

# LFTagPairPaginatorTypeDef definition

class LFTagPairPaginatorTypeDef(TypedDict):
    TagKey: str,
    TagValues: List[str],
    CatalogId: NotRequired[str],

ColumnWildcardPaginatorTypeDef#

# ColumnWildcardPaginatorTypeDef definition

class ColumnWildcardPaginatorTypeDef(TypedDict):
    ExcludedColumnNames: NotRequired[List[str]],

ColumnWildcardTypeDef#

# ColumnWildcardTypeDef definition

class ColumnWildcardTypeDef(TypedDict):
    ExcludedColumnNames: NotRequired[Sequence[str]],

CommitTransactionRequestRequestTypeDef#

# CommitTransactionRequestRequestTypeDef definition

class CommitTransactionRequestRequestTypeDef(TypedDict):
    TransactionId: str,

CreateLFTagRequestRequestTypeDef#

# CreateLFTagRequestRequestTypeDef definition

class CreateLFTagRequestRequestTypeDef(TypedDict):
    TagKey: str,
    TagValues: Sequence[str],
    CatalogId: NotRequired[str],

ExternalFilteringConfigurationTypeDef#

# ExternalFilteringConfigurationTypeDef definition

class ExternalFilteringConfigurationTypeDef(TypedDict):
    Status: EnableStatusType,  # (1)
    AuthorizedTargets: Sequence[str],
  1. See EnableStatusType

RowFilterPaginatorTypeDef#

# RowFilterPaginatorTypeDef definition

class RowFilterPaginatorTypeDef(TypedDict):
    FilterExpression: NotRequired[str],
    AllRowsWildcard: NotRequired[Dict[str, Any]],

DataCellsFilterResourceTypeDef#

# DataCellsFilterResourceTypeDef definition

class DataCellsFilterResourceTypeDef(TypedDict):
    TableCatalogId: NotRequired[str],
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Name: NotRequired[str],

RowFilterTypeDef#

# RowFilterTypeDef definition

class RowFilterTypeDef(TypedDict):
    FilterExpression: NotRequired[str],
    AllRowsWildcard: NotRequired[Mapping[str, Any]],

DataLocationResourceTypeDef#

# DataLocationResourceTypeDef definition

class DataLocationResourceTypeDef(TypedDict):
    ResourceArn: str,
    CatalogId: NotRequired[str],

DatabaseResourceTypeDef#

# DatabaseResourceTypeDef definition

class DatabaseResourceTypeDef(TypedDict):
    Name: str,
    CatalogId: NotRequired[str],

DeleteDataCellsFilterRequestRequestTypeDef#

# DeleteDataCellsFilterRequestRequestTypeDef definition

class DeleteDataCellsFilterRequestRequestTypeDef(TypedDict):
    TableCatalogId: NotRequired[str],
    DatabaseName: NotRequired[str],
    TableName: NotRequired[str],
    Name: NotRequired[str],

DeleteLFTagRequestRequestTypeDef#

# DeleteLFTagRequestRequestTypeDef definition

class DeleteLFTagRequestRequestTypeDef(TypedDict):
    TagKey: str,
    CatalogId: NotRequired[str],

DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef#

# DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef definition

class DeleteLakeFormationIdentityCenterConfigurationRequestRequestTypeDef(TypedDict):
    CatalogId: NotRequired[str],

DeleteObjectInputTypeDef#

# DeleteObjectInputTypeDef definition

class DeleteObjectInputTypeDef(TypedDict):
    Uri: str,
    ETag: NotRequired[str],
    PartitionValues: NotRequired[Sequence[str]],

VirtualObjectTypeDef#

# VirtualObjectTypeDef definition

class VirtualObjectTypeDef(TypedDict):
    Uri: str,
    ETag: NotRequired[str],

DeregisterResourceRequestRequestTypeDef#

# DeregisterResourceRequestRequestTypeDef definition

class DeregisterResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef#

# DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef definition

class DescribeLakeFormationIdentityCenterConfigurationRequestRequestTypeDef(TypedDict):
    CatalogId: NotRequired[str],

DescribeResourceRequestRequestTypeDef#

# DescribeResourceRequestRequestTypeDef definition

class DescribeResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ResourceInfoTypeDef#

# ResourceInfoTypeDef definition

class ResourceInfoTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    RoleArn: NotRequired[str],
    LastModified: NotRequired[datetime],
    WithFederation: NotRequired[bool],
    HybridAccessEnabled: NotRequired[bool],

DescribeTransactionRequestRequestTypeDef#

# DescribeTransactionRequestRequestTypeDef definition

class DescribeTransactionRequestRequestTypeDef(TypedDict):
    TransactionId: str,

TransactionDescriptionTypeDef#

# TransactionDescriptionTypeDef definition

class TransactionDescriptionTypeDef(TypedDict):
    TransactionId: NotRequired[str],
    TransactionStatus: NotRequired[TransactionStatusType],  # (1)
    TransactionStartTime: NotRequired[datetime],
    TransactionEndTime: NotRequired[datetime],
  1. See TransactionStatusType

DetailsMapTypeDef#

# DetailsMapTypeDef definition

class DetailsMapTypeDef(TypedDict):
    ResourceShare: NotRequired[List[str]],

ExecutionStatisticsTypeDef#

# ExecutionStatisticsTypeDef definition

class ExecutionStatisticsTypeDef(TypedDict):
    AverageExecutionTimeMillis: NotRequired[int],
    DataScannedBytes: NotRequired[int],
    WorkUnitsExecutedCount: NotRequired[int],

ExtendTransactionRequestRequestTypeDef#

# ExtendTransactionRequestRequestTypeDef definition

class ExtendTransactionRequestRequestTypeDef(TypedDict):
    TransactionId: NotRequired[str],

FilterConditionTypeDef#

# FilterConditionTypeDef definition

class FilterConditionTypeDef(TypedDict):
    Field: NotRequired[FieldNameStringType],  # (1)
    ComparisonOperator: NotRequired[ComparisonOperatorType],  # (2)
    StringValueList: NotRequired[Sequence[str]],
  1. See FieldNameStringType
  2. See ComparisonOperatorType

GetDataCellsFilterRequestRequestTypeDef#

# GetDataCellsFilterRequestRequestTypeDef definition

class GetDataCellsFilterRequestRequestTypeDef(TypedDict):
    TableCatalogId: str,
    DatabaseName: str,
    TableName: str,
    Name: str,

GetDataLakeSettingsRequestRequestTypeDef#

# GetDataLakeSettingsRequestRequestTypeDef definition

class GetDataLakeSettingsRequestRequestTypeDef(TypedDict):
    CatalogId: NotRequired[str],

GetEffectivePermissionsForPathRequestRequestTypeDef#

# GetEffectivePermissionsForPathRequestRequestTypeDef definition

class GetEffectivePermissionsForPathRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    CatalogId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

GetLFTagRequestRequestTypeDef#

# GetLFTagRequestRequestTypeDef definition

class GetLFTagRequestRequestTypeDef(TypedDict):
    TagKey: str,
    CatalogId: NotRequired[str],

GetQueryStateRequestRequestTypeDef#

# GetQueryStateRequestRequestTypeDef definition

class GetQueryStateRequestRequestTypeDef(TypedDict):
    QueryId: str,

GetQueryStatisticsRequestRequestTypeDef#

# GetQueryStatisticsRequestRequestTypeDef definition

class GetQueryStatisticsRequestRequestTypeDef(TypedDict):
    QueryId: str,

PlanningStatisticsTypeDef#

# PlanningStatisticsTypeDef definition

class PlanningStatisticsTypeDef(TypedDict):
    EstimatedDataToScanBytes: NotRequired[int],
    PlanningTimeMillis: NotRequired[int],
    QueueTimeMillis: NotRequired[int],
    WorkUnitsGeneratedCount: NotRequired[int],

PartitionValueListTypeDef#

# PartitionValueListTypeDef definition

class PartitionValueListTypeDef(TypedDict):
    Values: Sequence[str],

GetWorkUnitResultsRequestRequestTypeDef#

# GetWorkUnitResultsRequestRequestTypeDef definition

class GetWorkUnitResultsRequestRequestTypeDef(TypedDict):
    QueryId: str,
    WorkUnitId: int,
    WorkUnitToken: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetWorkUnitsRequestRequestTypeDef#

# GetWorkUnitsRequestRequestTypeDef definition

class GetWorkUnitsRequestRequestTypeDef(TypedDict):
    QueryId: str,
    NextToken: NotRequired[str],
    PageSize: NotRequired[int],

WorkUnitRangeTypeDef#

# WorkUnitRangeTypeDef definition

class WorkUnitRangeTypeDef(TypedDict):
    WorkUnitIdMax: int,
    WorkUnitIdMin: int,
    WorkUnitToken: str,

LFTagKeyResourceTypeDef#

# LFTagKeyResourceTypeDef definition

class LFTagKeyResourceTypeDef(TypedDict):
    TagKey: str,
    TagValues: Sequence[str],
    CatalogId: NotRequired[str],

LFTagTypeDef#

# LFTagTypeDef definition

class LFTagTypeDef(TypedDict):
    TagKey: str,
    TagValues: Sequence[str],

TableResourceTypeDef#

# TableResourceTypeDef definition

class TableResourceTypeDef(TypedDict):
    DatabaseName: str,
    CatalogId: NotRequired[str],
    Name: NotRequired[str],
    TableWildcard: NotRequired[Mapping[str, Any]],

ListLFTagsRequestRequestTypeDef#

# ListLFTagsRequestRequestTypeDef definition

class ListLFTagsRequestRequestTypeDef(TypedDict):
    CatalogId: NotRequired[str],
    ResourceShareType: NotRequired[ResourceShareTypeType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ResourceShareTypeType

ListTableStorageOptimizersRequestRequestTypeDef#

# ListTableStorageOptimizersRequestRequestTypeDef definition

class ListTableStorageOptimizersRequestRequestTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    CatalogId: NotRequired[str],
    StorageOptimizerType: NotRequired[OptimizerTypeType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See OptimizerTypeType

StorageOptimizerTypeDef#

# StorageOptimizerTypeDef definition

class StorageOptimizerTypeDef(TypedDict):
    StorageOptimizerType: NotRequired[OptimizerTypeType],  # (1)
    Config: NotRequired[Dict[str, str]],
    ErrorMessage: NotRequired[str],
    Warnings: NotRequired[str],
    LastRunDetails: NotRequired[str],
  1. See OptimizerTypeType

ListTransactionsRequestRequestTypeDef#

# ListTransactionsRequestRequestTypeDef definition

class ListTransactionsRequestRequestTypeDef(TypedDict):
    CatalogId: NotRequired[str],
    StatusFilter: NotRequired[TransactionStatusFilterType],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TransactionStatusFilterType

TableObjectTypeDef#

# TableObjectTypeDef definition

class TableObjectTypeDef(TypedDict):
    Uri: NotRequired[str],
    ETag: NotRequired[str],
    Size: NotRequired[int],

RegisterResourceRequestRequestTypeDef#

# RegisterResourceRequestRequestTypeDef definition

class RegisterResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    UseServiceLinkedRole: NotRequired[bool],
    RoleArn: NotRequired[str],
    WithFederation: NotRequired[bool],
    HybridAccessEnabled: NotRequired[bool],

StartTransactionRequestRequestTypeDef#

# StartTransactionRequestRequestTypeDef definition

class StartTransactionRequestRequestTypeDef(TypedDict):
    TransactionType: NotRequired[TransactionTypeType],  # (1)
  1. See TransactionTypeType

UpdateLFTagRequestRequestTypeDef#

# UpdateLFTagRequestRequestTypeDef definition

class UpdateLFTagRequestRequestTypeDef(TypedDict):
    TagKey: str,
    CatalogId: NotRequired[str],
    TagValuesToDelete: NotRequired[Sequence[str]],
    TagValuesToAdd: NotRequired[Sequence[str]],

UpdateResourceRequestRequestTypeDef#

# UpdateResourceRequestRequestTypeDef definition

class UpdateResourceRequestRequestTypeDef(TypedDict):
    RoleArn: str,
    ResourceArn: str,
    WithFederation: NotRequired[bool],
    HybridAccessEnabled: NotRequired[bool],

UpdateTableStorageOptimizerRequestRequestTypeDef#

# UpdateTableStorageOptimizerRequestRequestTypeDef definition

class UpdateTableStorageOptimizerRequestRequestTypeDef(TypedDict):
    DatabaseName: str,
    TableName: str,
    StorageOptimizerConfig: Mapping[OptimizerTypeType, Mapping[str, str]],  # (1)
    CatalogId: NotRequired[str],
  1. See OptimizerTypeType

ColumnLFTagTypeDef#

# ColumnLFTagTypeDef definition

class ColumnLFTagTypeDef(TypedDict):
    Name: NotRequired[str],
    LFTags: NotRequired[List[LFTagPairTypeDef]],  # (1)
  1. See LFTagPairTypeDef

AssumeDecoratedRoleWithSAMLResponseTypeDef#

# AssumeDecoratedRoleWithSAMLResponseTypeDef definition

class AssumeDecoratedRoleWithSAMLResponseTypeDef(TypedDict):
    AccessKeyId: str,
    SecretAccessKey: str,
    SessionToken: str,
    Expiration: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CommitTransactionResponseTypeDef#

# CommitTransactionResponseTypeDef definition

class CommitTransactionResponseTypeDef(TypedDict):
    TransactionStatus: TransactionStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TransactionStatusType
  2. See ResponseMetadataTypeDef

CreateLakeFormationIdentityCenterConfigurationResponseTypeDef#

# CreateLakeFormationIdentityCenterConfigurationResponseTypeDef definition

class CreateLakeFormationIdentityCenterConfigurationResponseTypeDef(TypedDict):
    ApplicationArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetLFTagResponseTypeDef#

# GetLFTagResponseTypeDef definition

class GetLFTagResponseTypeDef(TypedDict):
    CatalogId: str,
    TagKey: str,
    TagValues: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetQueryStateResponseTypeDef#

# GetQueryStateResponseTypeDef definition

class GetQueryStateResponseTypeDef(TypedDict):
    Error: str,
    State: QueryStateStringType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryStateStringType
  2. See ResponseMetadataTypeDef

GetTemporaryGluePartitionCredentialsResponseTypeDef#

# GetTemporaryGluePartitionCredentialsResponseTypeDef definition

class GetTemporaryGluePartitionCredentialsResponseTypeDef(TypedDict):
    AccessKeyId: str,
    SecretAccessKey: str,
    SessionToken: str,
    Expiration: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetTemporaryGlueTableCredentialsResponseTypeDef#

# GetTemporaryGlueTableCredentialsResponseTypeDef definition

class GetTemporaryGlueTableCredentialsResponseTypeDef(TypedDict):
    AccessKeyId: str,
    SecretAccessKey: str,
    SessionToken: str,
    Expiration: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetWorkUnitResultsResponseTypeDef#

# GetWorkUnitResultsResponseTypeDef definition

class GetWorkUnitResultsResponseTypeDef(TypedDict):
    ResultStream: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListLFTagsResponseTypeDef#

# ListLFTagsResponseTypeDef definition

class ListLFTagsResponseTypeDef(TypedDict):
    LFTags: List[LFTagPairTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See