

# AWS Lake Formation API
<a name="aws-lake-formation-api"></a>

**Note**  
Updated [API Reference](https://docs.aws.amazon.com/lake-formation/latest/APIReference/Welcome.html) for the AWS Lake Formation service is now available.

**Contents**
+ [Permissions APIs](aws-lake-formation-api-aws-lake-formation-api-permissions.md)
  + [Operations](aws-lake-formation-api-aws-lake-formation-api-permissions.md#aws-lake-formation-api-aws-lake-formation-api-permissions-actions)
  + [Data Types](aws-lake-formation-api-aws-lake-formation-api-permissions.md#aws-lake-formation-api-aws-lake-formation-api-permissions-objects)
+ [Data lake settings APIs](aws-lake-formation-api-aws-lake-formation-api-settings.md)
  + [Operations](aws-lake-formation-api-aws-lake-formation-api-settings.md#aws-lake-formation-api-aws-lake-formation-api-settings-actions)
  + [Data Types](aws-lake-formation-api-aws-lake-formation-api-settings.md#aws-lake-formation-api-aws-lake-formation-api-settings-objects)
+ [IAM Identity Center integration APIs](aws-lake-formation-api-Identity-center-integ.md)
  + [Operations](aws-lake-formation-api-Identity-center-integ.md#aws-lake-formation-api-Identity-center-integ-actions)
  + [Data Types](aws-lake-formation-api-Identity-center-integ.md#aws-lake-formation-api-aws-lake-formation-api-settings-objects)
+ [Hybrid access mode APIs](aws-lake-formation-api-hybrid-access-mode.md)
  + [Operations](aws-lake-formation-api-hybrid-access-mode.md#aws-lake-formation-api-hybrid-access-mode-actions)
  + [Data Types](aws-lake-formation-api-hybrid-access-mode.md#aws-lake-formation-api-aws-lake-formation-api-permissions-objects)
+ [Credential vending APIs](aws-lake-formation-api-credential-vending.md)
  + [Operations](aws-lake-formation-api-credential-vending.md#aws-lake-formation-api-credential-vending-actions)
  + [Data Types](aws-lake-formation-api-credential-vending.md#aws-lake-formation-api-credential-vending-objects)
+ [Tagging APIs](aws-lake-formation-api-tagging-api.md)
  + [Operations](aws-lake-formation-api-tagging-api.md#aws-lake-formation-api-tagging-api-actions)
  + [Data Types](aws-lake-formation-api-tagging-api.md#aws-lake-formation-api-tagging-api-objects)
+ [Data filter APIs](aws-lake-formation-api-data-filter.md)
  + [Operations](aws-lake-formation-api-data-filter.md#aws-lake-formation-api-data-filter-actions)
  + [Data types](aws-lake-formation-api-data-filter.md#aws-lake-formation-api-data-filter-objects)
+ [Common data types](aws-lake-formation-api-aws-lake-formation-api-common.md)
  + [ErrorDetail structure](aws-lake-formation-api-aws-lake-formation-api-common.md#aws-lake-formation-api-aws-lake-formation-api-common-ErrorDetail)
  + [String patterns](aws-lake-formation-api-aws-lake-formation-api-common.md#aws-lake-formation-api-aws-lake-formation-api-common-_string-patterns)

# Permissions APIs
<a name="aws-lake-formation-api-aws-lake-formation-api-permissions"></a>

The Permissions API section describes operations and data types that are required for granting and revoking permissions in AWS Lake Formation. See [ Lake Formation API Reference Guide](https://docs.aws.amazon.com/lake-formation/latest/APIReference/Welcome.html) for all AWS Lake Formation API operations and data types.

## Operations
<a name="aws-lake-formation-api-aws-lake-formation-api-permissions-actions"></a>
+ [GrantPermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GrantPermissions.html)
+ [RevokePermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_RevokePermissions.html)
+ [BatchGrantPermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_BatchGrantPermissions.html)
+ [BatchRevokePermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_BatchRevokePermissions.html)
+ [GetEffectivePermissionsForPath](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetEffectivePermissionsForPath.html)
+ [ListPermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListPermissions.html)
+ [GetDataLakePrincipal](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetDataLakePrincipal.html)

## Data Types
<a name="aws-lake-formation-api-aws-lake-formation-api-permissions-objects"></a>
+ [Resource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_Resource.html)
+ [DatabaseResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DatabaseResource.html)
+ [TableResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_TableResource.html)
+ [TableWithColumnsResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_TableWithColumnsResource.html)
+ [DataCellsFilterResourcee](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataCellsFilterResource.html)
+ [DataLocationResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataLocationResource.html)
+ [DataLakePrincipal](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataLakePrincipal.html)
+ [PrincipalPermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_PrincipalPermissions.html)
+ [PrincipalResourcePermissions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_PrincipalResourcePermissions.html)
+ [DetailsMap](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DetailsMap.html)
+ [ColumnWildcard](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ColumnWildcard.html)
+ [BatchPermissionsRequestEntry](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_BatchPermissionsRequestEntry.html)
+ [BatchPermissionsFailureEntry](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_BatchPermissionsFailureEntry.html)

# Data lake settings APIs
<a name="aws-lake-formation-api-aws-lake-formation-api-settings"></a>

This section contains the Data lake settings API operations and data types for managing the data lake administrators.

## Operations
<a name="aws-lake-formation-api-aws-lake-formation-api-settings-actions"></a>
+ [GetDataLakeSettings](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetDataLakeSettings.html)
+ [PutDataLakeSettings](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_PutDataLakeSettings.html)

## Data Types
<a name="aws-lake-formation-api-aws-lake-formation-api-settings-objects"></a>
+ [DataLakeSettings](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataLakeSettings.html)

# IAM Identity Center integration APIs
<a name="aws-lake-formation-api-Identity-center-integ"></a>

This section contains the operations for creating and managing Lake Formation integration with IAM Identity Center.

## Operations
<a name="aws-lake-formation-api-Identity-center-integ-actions"></a>
+ [CreateLakeFormationIdentityCenterConfiguration](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_CreateLakeFormationIdentityCenterConfiguration.html)
+ [DeleteLakeFormationIdentityCenterConfiguration](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeleteLakeFormationIdentityCenterConfiguration.html)
+ [DescribeLakeFormationIdentityCenterConfiguration](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DescribeLakeFormationIdentityCenterConfiguration.html)
+ [UpdateLakeFormationIdentityCenterConfiguration](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_UpdateLakeFormationIdentityCenterConfiguration.html)

## Data Types
<a name="aws-lake-formation-api-aws-lake-formation-api-settings-objects"></a>
+ [ExternalFilteringConfiguration](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ExternalFilteringConfiguration.html)

# Hybrid access mode APIs
<a name="aws-lake-formation-api-hybrid-access-mode"></a>

The Hybrid access mode API section describes operations and data types that are required for setting up hybrid access mode in AWS Lake Formation. See [ Lake Formation API Reference Guide](https://docs.aws.amazon.com/lake-formation/latest/APIReference/Welcome.html) for all AWS Lake Formation API operations and data types.

## Operations
<a name="aws-lake-formation-api-hybrid-access-mode-actions"></a>
+ [CreateLakeFormationOptIn](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_CreateLakeFormationOptIn.html)
+ [DeleteLakeFormationOptIn](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeleteLakeFormationOptIn.html)
+ [ListLakeFormationOptIns](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListLakeFormationOptIns.html)

## Data Types
<a name="aws-lake-formation-api-aws-lake-formation-api-permissions-objects"></a>
+ [Resource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_Resource.html)
+ [DatabaseResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DatabaseResource.html)
+ [TableResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_TableResource.html)
+ [Resource Info](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ResourceInfo.html)
+ [LakeFormationOptInsInfo](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LakeFormationOptInsInfo.html)
+ [DataLocationResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataLocationResource.html)

# Credential vending APIs
<a name="aws-lake-formation-api-credential-vending"></a>

The Credential Vending API section describes the operations and data types related to working with the AWS Lake Formation service to vend credentials and to register and manage a data lake resource.

## Operations
<a name="aws-lake-formation-api-credential-vending-actions"></a>
+ [RegisterResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_RegisterResource.html)
+ [DeregisterResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeregisterResource.html)
+ [ListResources](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListResources.html)
+ [GetUnfilteredTableMetadata](https://docs.aws.amazon.com/glue/latest/webapi/API_GetUnfilteredTableMetadata.html)
+ [GetUnfilteredPartitionsMetadata](https://docs.aws.amazon.com/glue/latest/webapi/API_GetUnfilteredPartitionsMetadata.html)
+ [GetTemporaryGluePartitionCredentials](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetTemporaryGluePartitionCredentials.html)
+ [GetTemporaryGlueTableCredentials](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetTemporaryGlueTableCredentials.html)
+ [UpdateResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_UpdateResource.html)

## Data Types
<a name="aws-lake-formation-api-credential-vending-objects"></a>
+ [FilterCondition](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_FilterCondition.html)
+ [RowFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_RowFilter.html)
+ [ResourceInfo](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ResourceInfo.html)

# Tagging APIs
<a name="aws-lake-formation-api-tagging-api"></a>

The Tagging API section describes the operations and data types related to an authorization strategy that defines a permissions model on attributes or key-value pair tags.

## Operations
<a name="aws-lake-formation-api-tagging-api-actions"></a>
+ [GetLFTagExpression](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetLFTagExpression.html)
+ [ListLFTagExpressions](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListLFTagExpressions.html)
+ [DeleteLFTagExpression](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeleteLFTagExpression.html)
+ [UpdateLFTagExpression](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_UpdateLFTagExpression.html)
+ [CreateLFTagExpression](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_CreateLFTagExpression.html)
+ [AddLFTagsToResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_AddLFTagsToResource.html)
+ [RemoveLFTagsFromResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_RemoveLFTagsFromResource.html)
+ [GetResourceLFTags](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetResourceLFTags.html)
+ [ListLFTags](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListLFTags.html)
+ [CreateLFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_CreateLFTag.html)
+ [GetLFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetLFTag.html)
+ [UpdateLFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_UpdateLFTag.html)
+ [DeleteLFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeleteLFTag.html)
+ [SearchTablesByLFTags](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_SearchTablesByLFTags.html)
+ [SearchDatabasesByLFTags](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_SearchDatabasesByLFTags.html)

## Data Types
<a name="aws-lake-formation-api-tagging-api-objects"></a>
+ [LFTagKeyResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LFTagKeyResource.html)
+ [LFTagPolicyResource](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LFTagKeyResource.html)
+ [TaggedTable](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_TaggedTable.html)
+ [TaggedDatabase](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_TaggedDatabase.html)
+ [LFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LFTag.html)
+ [LFTagPair](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LFTagPair.html)
+ [LFTagError](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_LFTagError.html)
+ [ColumnLFTag](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ColumnLFTag.html)

# Data filter APIs
<a name="aws-lake-formation-api-data-filter"></a>

The Data Filter APIs describe how to manage data cell filters in AWS Lake Formation.

## Operations
<a name="aws-lake-formation-api-data-filter-actions"></a>
+ [CreateDataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_CreateDataCellsFilter.html)
+ [DeleteDataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DeleteDataCellsFilter.html)
+ [ListDataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_ListDataCellsFilter.html)
+ [GetDataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_GetDataCellsFilter.html)
+ [UpdateDataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_UpdateDataCellsFilter.html)

## Data types
<a name="aws-lake-formation-api-data-filter-objects"></a>
+ [DataCellsFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_DataCellsFilter.html)
+ [RowFilter](https://docs.aws.amazon.com/lake-formation/latest/APIReference/API_RowFilter.html)

# Common data types
<a name="aws-lake-formation-api-aws-lake-formation-api-common"></a>

The Common Data Types describes miscellaneous common data types in AWS Lake Formation.

## ErrorDetail structure
<a name="aws-lake-formation-api-aws-lake-formation-api-common-ErrorDetail"></a>

Contains details about an error.

**Fields**
+ `ErrorCode` – UTF-8 string, not less than 1 or more than 255 bytes long, matching the [Single-line string pattern](#aws-glue-api-regex-oneLine).

  The code associated with this error.
+ `ErrorMessage` – Description string, not more than 2048 bytes long, matching the [URI address multi-line string pattern](#aws-glue-api-regex-uri).

  A message describing the error.

## String patterns
<a name="aws-lake-formation-api-aws-lake-formation-api-common-_string-patterns"></a>

The API uses the following regular expressions to define what is valid content for various string parameters and members:
+ Single-line string pattern – "`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*`"
+ URI address multi-line string pattern – "`[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*`"
+ Custom string pattern \$13 – "`^\w+\.\w+\.\w+$`"
+ Custom string pattern \$14 – "`^\w+\.\w+$`"
+ Custom string pattern \$15 – "`arn:aws:iam::[0-9]*:role/.*`"
+ Custom string pattern \$16 – "`arn:aws:iam::[0-9]*:user/.*`"
+ Custom string pattern \$17 – "`arn:aws:iam::[0-9]*:group/.*`"
+ Custom string pattern \$18 – "`arn:aws:iam::[0-9]*:saml-provider/.*`"
+ Custom string pattern \$19 – "`^([\p{L}\p{Z}\p{N}_.:\/=+\-@%]*)$`"
+ Custom string pattern \$110 – "`^([\p{L}\p{Z}\p{N}_.:\*\/=+\-@%]*)$`"
+ Custom string pattern \$111 – "`[\p{L}\p{N}\p{P}]*`"