Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-lakeformation

Description

Lake Formation

Defines the public endpoint for the Lake Formation service.

Installation

NPM

npm install @aws-sdk/client-lakeformation

Yarn

yarn add @aws-sdk/client-lakeformation

pnpm

pnpm add @aws-sdk/client-lakeformation

Types

Type Name	Type
AccessDeniedException	Class
AddLFTagsToResourceCommand	Class
AddLFTagsToResourceCommandInput	Interface
AddLFTagsToResourceCommandOutput	Interface
AddLFTagsToResourceRequest	Interface
AddLFTagsToResourceResponse	Interface
AddObjectInput	Interface
AllRowsWildcard	Interface
AlreadyExistsException	Class
ApplicationStatus	TypeAlias
ApplicationStatusenum	Variable
AssumeDecoratedRoleWithSAMLCommand	Class
AssumeDecoratedRoleWithSAMLCommandInput	Interface
AssumeDecoratedRoleWithSAMLCommandOutput	Interface
AssumeDecoratedRoleWithSAMLRequest	Interface
AssumeDecoratedRoleWithSAMLResponse	Interface
AuditContext	Interface
BatchGrantPermissionsCommand	Class
BatchGrantPermissionsCommandInput	Interface
BatchGrantPermissionsCommandOutput	Interface
BatchGrantPermissionsRequest	Interface
BatchGrantPermissionsResponse	Interface
BatchPermissionsFailureEntry	Interface
BatchPermissionsRequestEntry	Interface
BatchRevokePermissionsCommand	Class
BatchRevokePermissionsCommandInput	Interface
BatchRevokePermissionsCommandOutput	Interface
BatchRevokePermissionsRequest	Interface
BatchRevokePermissionsResponse	Interface
CancelTransactionCommand	Class
CancelTransactionCommandInput	Interface
CancelTransactionCommandOutput	Interface
CancelTransactionRequest	Interface
CancelTransactionResponse	Interface
CatalogResource	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ColumnLFTag	Interface
ColumnWildcard	Interface
CommitTransactionCommand	Class
CommitTransactionCommandInput	Interface
CommitTransactionCommandOutput	Interface
CommitTransactionRequest	Interface
CommitTransactionResponse	Interface
ComparisonOperator	TypeAlias
ComparisonOperatorenum	Variable
ConcurrentModificationException	Class
Condition	Interface
CreateDataCellsFilterCommand	Class
CreateDataCellsFilterCommandInput	Interface
CreateDataCellsFilterCommandOutput	Interface
CreateDataCellsFilterRequest	Interface
CreateDataCellsFilterResponse	Interface
CreateLakeFormationIdentityCenterConfigurationCommand	Class
CreateLakeFormationIdentityCenterConfigurationCommandInput	Interface
CreateLakeFormationIdentityCenterConfigurationCommandOutput	Interface
CreateLakeFormationIdentityCenterConfigurationRequest	Interface
CreateLakeFormationIdentityCenterConfigurationResponse	Interface
CreateLakeFormationOptInCommand	Class
CreateLakeFormationOptInCommandInput	Interface
CreateLakeFormationOptInCommandOutput	Interface
CreateLakeFormationOptInRequest	Interface
CreateLakeFormationOptInResponse	Interface
CreateLFTagCommand	Class
CreateLFTagCommandInput	Interface
CreateLFTagCommandOutput	Interface
CreateLFTagExpressionCommand	Class
CreateLFTagExpressionCommandInput	Interface
CreateLFTagExpressionCommandOutput	Interface
CreateLFTagExpressionRequest	Interface
CreateLFTagExpressionResponse	Interface
CreateLFTagRequest	Interface
CreateLFTagResponse	Interface
DatabaseResource	Interface
DataCellsFilter	Interface
DataCellsFilterResource	Interface
DataLakePrincipal	Interface
DataLakeResourceType	TypeAlias
DataLakeResourceTypeenum	Variable
DataLakeSettings	Interface
DataLocationResource	Interface
DeleteDataCellsFilterCommand	Class
DeleteDataCellsFilterCommandInput	Interface
DeleteDataCellsFilterCommandOutput	Interface
DeleteDataCellsFilterRequest	Interface
DeleteDataCellsFilterResponse	Interface
DeleteLakeFormationIdentityCenterConfigurationCommand	Class
DeleteLakeFormationIdentityCenterConfigurationCommandInput	Interface
DeleteLakeFormationIdentityCenterConfigurationCommandOutput	Interface
DeleteLakeFormationIdentityCenterConfigurationRequest	Interface
DeleteLakeFormationIdentityCenterConfigurationResponse	Interface
DeleteLakeFormationOptInCommand	Class
DeleteLakeFormationOptInCommandInput	Interface
DeleteLakeFormationOptInCommandOutput	Interface
DeleteLakeFormationOptInRequest	Interface
DeleteLakeFormationOptInResponse	Interface
DeleteLFTagCommand	Class
DeleteLFTagCommandInput	Interface
DeleteLFTagCommandOutput	Interface
DeleteLFTagExpressionCommand	Class
DeleteLFTagExpressionCommandInput	Interface
DeleteLFTagExpressionCommandOutput	Interface
DeleteLFTagExpressionRequest	Interface
DeleteLFTagExpressionResponse	Interface
DeleteLFTagRequest	Interface
DeleteLFTagResponse	Interface
DeleteObjectInput	Interface
DeleteObjectsOnCancelCommand	Class
DeleteObjectsOnCancelCommandInput	Interface
DeleteObjectsOnCancelCommandOutput	Interface
DeleteObjectsOnCancelRequest	Interface
DeleteObjectsOnCancelResponse	Interface
DeregisterResourceCommand	Class
DeregisterResourceCommandInput	Interface
DeregisterResourceCommandOutput	Interface
DeregisterResourceRequest	Interface
DeregisterResourceResponse	Interface
DescribeLakeFormationIdentityCenterConfigurationCommand	Class
DescribeLakeFormationIdentityCenterConfigurationCommandInput	Interface
DescribeLakeFormationIdentityCenterConfigurationCommandOutput	Interface
DescribeLakeFormationIdentityCenterConfigurationRequest	Interface
DescribeLakeFormationIdentityCenterConfigurationResponse	Interface
DescribeResourceCommand	Class
DescribeResourceCommandInput	Interface
DescribeResourceCommandOutput	Interface
DescribeResourceRequest	Interface
DescribeResourceResponse	Interface
DescribeTransactionCommand	Class
DescribeTransactionCommandInput	Interface
DescribeTransactionCommandOutput	Interface
DescribeTransactionRequest	Interface
DescribeTransactionResponse	Interface
DetailsMap	Interface
EnableStatus	TypeAlias
EnableStatusenum	Variable
EntityNotFoundException	Class
ErrorDetail	Interface
ExecutionStatistics	Interface
ExpiredException	Class
ExtendTransactionCommand	Class
ExtendTransactionCommandInput	Interface
ExtendTransactionCommandOutput	Interface
ExtendTransactionRequest	Interface
ExtendTransactionResponse	Interface
ExternalFilteringConfiguration	Interface
FieldNameString	TypeAlias
FieldNameStringenum	Variable
FilterCondition	Interface
GetDataCellsFilterCommand	Class
GetDataCellsFilterCommandInput	Interface
GetDataCellsFilterCommandOutput	Interface
GetDataCellsFilterRequest	Interface
GetDataCellsFilterResponse	Interface
GetDataLakePrincipalCommand	Class
GetDataLakePrincipalCommandInput	Interface
GetDataLakePrincipalCommandOutput	Interface
GetDataLakePrincipalRequest	Interface
GetDataLakePrincipalResponse	Interface
GetDataLakeSettingsCommand	Class
GetDataLakeSettingsCommandInput	Interface
GetDataLakeSettingsCommandOutput	Interface
GetDataLakeSettingsRequest	Interface
GetDataLakeSettingsResponse	Interface
GetEffectivePermissionsForPathCommand	Class
GetEffectivePermissionsForPathCommandInput	Interface
GetEffectivePermissionsForPathCommandOutput	Interface
GetEffectivePermissionsForPathRequest	Interface
GetEffectivePermissionsForPathResponse	Interface
GetLFTagCommand	Class
GetLFTagCommandInput	Interface
GetLFTagCommandOutput	Interface
GetLFTagExpressionCommand	Class
GetLFTagExpressionCommandInput	Interface
GetLFTagExpressionCommandOutput	Interface
GetLFTagExpressionRequest	Interface
GetLFTagExpressionResponse	Interface
GetLFTagRequest	Interface
GetLFTagResponse	Interface
GetQueryStateCommand	Class
GetQueryStateCommandInput	Interface
GetQueryStateCommandOutput	Interface
GetQueryStateRequest	Interface
GetQueryStateResponse	Interface
GetQueryStatisticsCommand	Class
GetQueryStatisticsCommandInput	Interface
GetQueryStatisticsCommandOutput	Interface
GetQueryStatisticsRequest	Interface
GetQueryStatisticsResponse	Interface
GetResourceLFTagsCommand	Class
GetResourceLFTagsCommandInput	Interface
GetResourceLFTagsCommandOutput	Interface
GetResourceLFTagsRequest	Interface
GetResourceLFTagsResponse	Interface
GetTableObjectsCommand	Class
GetTableObjectsCommandInput	Interface
GetTableObjectsCommandOutput	Interface
GetTableObjectsRequest	Interface
GetTableObjectsResponse	Interface
GetTemporaryGluePartitionCredentialsCommand	Class
GetTemporaryGluePartitionCredentialsCommandInput	Interface
GetTemporaryGluePartitionCredentialsCommandOutput	Interface
GetTemporaryGluePartitionCredentialsRequest	Interface
GetTemporaryGluePartitionCredentialsResponse	Interface
GetTemporaryGlueTableCredentialsCommand	Class
GetTemporaryGlueTableCredentialsCommandInput	Interface
GetTemporaryGlueTableCredentialsCommandOutput	Interface
GetTemporaryGlueTableCredentialsRequest	Interface
GetTemporaryGlueTableCredentialsResponse	Interface
GetWorkUnitResultsCommand	Class
GetWorkUnitResultsCommandInput	Interface
GetWorkUnitResultsCommandOutput	Interface
GetWorkUnitResultsRequest	Interface
GetWorkUnitResultsResponse	Interface
GetWorkUnitsCommand	Class
GetWorkUnitsCommandInput	Interface
GetWorkUnitsCommandOutput	Interface
GetWorkUnitsRequest	Interface
GetWorkUnitsResponse	Interface
GlueEncryptionException	Class
GrantPermissionsCommand	Class
GrantPermissionsCommandInput	Interface
GrantPermissionsCommandOutput	Interface
GrantPermissionsRequest	Interface
GrantPermissionsResponse	Interface
InternalServiceException	Class
InvalidInputException	Class
LakeFormation	Class
LakeFormation	Interface
LakeFormationClient	Class
LakeFormationClientConfig	Interface
LakeFormationClientConfigType	TypeAlias
LakeFormationClientResolvedConfig	Interface
LakeFormationClientResolvedConfigType	TypeAlias
LakeFormationOptInsInfo	Interface
LakeFormationPaginationConfiguration	Interface
LakeFormationServiceException	Class
LFTag	Interface
LFTagError	Interface
LFTagExpression	Interface
LFTagExpressionResource	Interface
LFTagKeyResource	Interface
LFTagPair	Interface
LFTagPolicyResource	Interface
ListDataCellsFilterCommand	Class
ListDataCellsFilterCommandInput	Interface
ListDataCellsFilterCommandOutput	Interface
ListDataCellsFilterRequest	Interface
ListDataCellsFilterResponse	Interface
ListLakeFormationOptInsCommand	Class
ListLakeFormationOptInsCommandInput	Interface
ListLakeFormationOptInsCommandOutput	Interface
ListLakeFormationOptInsRequest	Interface
ListLakeFormationOptInsResponse	Interface
ListLFTagExpressionsCommand	Class
ListLFTagExpressionsCommandInput	Interface
ListLFTagExpressionsCommandOutput	Interface
ListLFTagExpressionsRequest	Interface
ListLFTagExpressionsResponse	Interface
ListLFTagsCommand	Class
ListLFTagsCommandInput	Interface
ListLFTagsCommandOutput	Interface
ListLFTagsRequest	Interface
ListLFTagsResponse	Interface
ListPermissionsCommand	Class
ListPermissionsCommandInput	Interface
ListPermissionsCommandOutput	Interface
ListPermissionsRequest	Interface
ListPermissionsResponse	Interface
ListResourcesCommand	Class
ListResourcesCommandInput	Interface
ListResourcesCommandOutput	Interface
ListResourcesRequest	Interface
ListResourcesResponse	Interface
ListTableStorageOptimizersCommand	Class
ListTableStorageOptimizersCommandInput	Interface
ListTableStorageOptimizersCommandOutput	Interface
ListTableStorageOptimizersRequest	Interface
ListTableStorageOptimizersResponse	Interface
ListTransactionsCommand	Class
ListTransactionsCommandInput	Interface
ListTransactionsCommandOutput	Interface
ListTransactionsRequest	Interface
ListTransactionsResponse	Interface
OperationTimeoutException	Class
OptimizerType	TypeAlias
OptimizerTypeenum	Variable
paginateGetEffectivePermissionsForPath	Variable
paginateGetTableObjects	Variable
paginateGetWorkUnits	Variable
paginateListDataCellsFilter	Variable
paginateListLakeFormationOptIns	Variable
paginateListLFTagExpressions	Variable
paginateListLFTags	Variable
paginateListPermissions	Variable
paginateListResources	Variable
paginateListTableStorageOptimizers	Variable
paginateListTransactions	Variable
paginateSearchDatabasesByLFTags	Variable
paginateSearchTablesByLFTags	Variable
PartitionObjects	Interface
PartitionValueList	Interface
Permission	TypeAlias
Permissionenum	Variable
PermissionType	TypeAlias
PermissionTypeenum	Variable
PermissionTypeMismatchException	Class
PlanningStatistics	Interface
PrincipalPermissions	Interface
PrincipalResourcePermissions	Interface
PutDataLakeSettingsCommand	Class
PutDataLakeSettingsCommandInput	Interface
PutDataLakeSettingsCommandOutput	Interface
PutDataLakeSettingsRequest	Interface
PutDataLakeSettingsResponse	Interface
QueryPlanningContext	Interface
QuerySessionContext	Interface
QueryStateString	TypeAlias
QueryStateStringenum	Variable
RegisterResourceCommand	Class
RegisterResourceCommandInput	Interface
RegisterResourceCommandOutput	Interface
RegisterResourceRequest	Interface
RegisterResourceResponse	Interface
RemoveLFTagsFromResourceCommand	Class
RemoveLFTagsFromResourceCommandInput	Interface
RemoveLFTagsFromResourceCommandOutput	Interface
RemoveLFTagsFromResourceRequest	Interface
RemoveLFTagsFromResourceResponse	Interface
Resource	Interface
ResourceInfo	Interface
ResourceNotReadyException	Class
ResourceNumberLimitExceededException	Class
ResourceShareType	TypeAlias
ResourceShareTypeenum	Variable
ResourceType	TypeAlias
ResourceTypeenum	Variable
RevokePermissionsCommand	Class
RevokePermissionsCommandInput	Interface
RevokePermissionsCommandOutput	Interface
RevokePermissionsRequest	Interface
RevokePermissionsResponse	Interface
RowFilter	Interface
RuntimeExtension	Interface
SearchDatabasesByLFTagsCommand	Class
SearchDatabasesByLFTagsCommandInput	Interface
SearchDatabasesByLFTagsCommandOutput	Interface
SearchDatabasesByLFTagsRequest	Interface
SearchDatabasesByLFTagsResponse	Interface
SearchTablesByLFTagsCommand	Class
SearchTablesByLFTagsCommandInput	Interface
SearchTablesByLFTagsCommandOutput	Interface
SearchTablesByLFTagsRequest	Interface
SearchTablesByLFTagsResponse	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
StartQueryPlanningCommand	Class
StartQueryPlanningCommandInput	Interface
StartQueryPlanningCommandOutput	Interface
StartQueryPlanningRequest	Interface
StartQueryPlanningResponse	Interface
StartTransactionCommand	Class
StartTransactionCommandInput	Interface
StartTransactionCommandOutput	Interface
StartTransactionRequest	Interface
StartTransactionResponse	Interface
StatisticsNotReadyYetException	Class
StorageOptimizer	Interface
TableObject	Interface
TableResource	Interface
TableWildcard	Interface
TableWithColumnsResource	Interface
TaggedDatabase	Interface
TaggedTable	Interface
ThrottledException	Class
TransactionCanceledException	Class
TransactionCommitInProgressException	Class
TransactionCommittedException	Class
TransactionDescription	Interface
TransactionStatus	TypeAlias
TransactionStatusenum	Variable
TransactionStatusFilter	TypeAlias
TransactionStatusFilterenum	Variable
TransactionType	TypeAlias
TransactionTypeenum	Variable
UpdateDataCellsFilterCommand	Class
UpdateDataCellsFilterCommandInput	Interface
UpdateDataCellsFilterCommandOutput	Interface
UpdateDataCellsFilterRequest	Interface
UpdateDataCellsFilterResponse	Interface
UpdateLakeFormationIdentityCenterConfigurationCommand	Class
UpdateLakeFormationIdentityCenterConfigurationCommandInput	Interface
UpdateLakeFormationIdentityCenterConfigurationCommandOutput	Interface
UpdateLakeFormationIdentityCenterConfigurationRequest	Interface
UpdateLakeFormationIdentityCenterConfigurationResponse	Interface
UpdateLFTagCommand	Class
UpdateLFTagCommandInput	Interface
UpdateLFTagCommandOutput	Interface
UpdateLFTagExpressionCommand	Class
UpdateLFTagExpressionCommandInput	Interface
UpdateLFTagExpressionCommandOutput	Interface
UpdateLFTagExpressionRequest	Interface
UpdateLFTagExpressionResponse	Interface
UpdateLFTagRequest	Interface
UpdateLFTagResponse	Interface
UpdateResourceCommand	Class
UpdateResourceCommandInput	Interface
UpdateResourceCommandOutput	Interface
UpdateResourceRequest	Interface
UpdateResourceResponse	Interface
UpdateTableObjectsCommand	Class
UpdateTableObjectsCommandInput	Interface
UpdateTableObjectsCommandOutput	Interface
UpdateTableObjectsRequest	Interface
UpdateTableObjectsResponse	Interface
UpdateTableStorageOptimizerCommand	Class
UpdateTableStorageOptimizerCommandInput	Interface
UpdateTableStorageOptimizerCommandOutput	Interface
UpdateTableStorageOptimizerRequest	Interface
UpdateTableStorageOptimizerResponse	Interface
VirtualObject	Interface
WorkUnitRange	Interface
WorkUnitsNotReadyYetException	Class
WriteOperation	Interface

Getting Started

References

@aws-sdk/client-lakeformation

Description

Installation

Types

Table of Contents

Search